classes/pluginhost.php

   1 <?php
   2 class PluginHost {
   3         private $dbh;
   4         private $hooks = array();
   5         private $plugins = array();
   6         private $handlers = array();
   7         private $commands = array();
   8         private $storage = array();
   9         private $feeds = array();
  10         private $api_methods = array();
  11         private $owner_uid;
  12         private $debug;
  13         private $last_registered;
  14         private static $instance;
  15
  16         const API_VERSION = 2;
  17
  18         const HOOK_ARTICLE_BUTTON = 1;
  19         const HOOK_ARTICLE_FILTER = 2;
  20         const HOOK_PREFS_TAB = 3;
  21         const HOOK_PREFS_TAB_SECTION = 4;
  22         const HOOK_PREFS_TABS = 5;
  23         const HOOK_FEED_PARSED = 6;
  24         const HOOK_UPDATE_TASK = 7;
  25         const HOOK_AUTH_USER = 8;
  26         const HOOK_HOTKEY_MAP = 9;
  27         const HOOK_RENDER_ARTICLE = 10;
  28         const HOOK_RENDER_ARTICLE_CDM = 11;
  29         const HOOK_FEED_FETCHED = 12;
  30         const HOOK_SANITIZE = 13;
  31         const HOOK_RENDER_ARTICLE_API = 14;
  32         const HOOK_TOOLBAR_BUTTON = 15;
  33         const HOOK_ACTION_ITEM = 16;
  34         const HOOK_HEADLINE_TOOLBAR_BUTTON = 17;
  35         const HOOK_HOTKEY_INFO = 18;
  36         const HOOK_ARTICLE_LEFT_BUTTON = 19;
  37         const HOOK_PREFS_EDIT_FEED = 20;
  38         const HOOK_PREFS_SAVE_FEED = 21;
  39
  40         const KIND_ALL = 1;
  41         const KIND_SYSTEM = 2;
  42         const KIND_USER = 3;
  43
  44         function __construct() {
  45                 $this->dbh = Db::get();
  46
  47                 $this->storage = array();
  48         }
  49
  50         private function __clone() {
  51                 //
  52         }
  53
  54         public static function getInstance() {
  55                 if (self::$instance == null)
  56                         self::$instance = new self();
  57
  58                 return self::$instance;
  59         }
  60
  61         private function register_plugin($name, $plugin) {
  62                 //array_push($this->plugins, $plugin);
  63                 $this->plugins[$name] = $plugin;
  64         }
  65
  66         // needed for compatibility with API 1
  67         function get_link() {
  68                 return false;
  69         }
  70
  71         function get_dbh() {
  72                 return $this->dbh;
  73         }
  74
  75         function get_plugins() {
  76                 return $this->plugins;
  77         }
  78
  79         function get_plugin($name) {
  80                 return $this->plugins[$name];
  81         }
  82
  83         function run_hooks($type, $method, $args) {
  84                 foreach ($this->get_hooks($type) as $hook) {
  85                         $hook->$method($args);
  86                 }
  87         }
  88
  89         function add_hook($type, $sender) {
  90                 if (!is_array($this->hooks[$type])) {
  91                         $this->hooks[$type] = array();
  92                 }
  93
  94                 array_push($this->hooks[$type], $sender);
  95         }
  96
  97         function del_hook($type, $sender) {
  98                 if (is_array($this->hooks[$type])) {
  99                         $key = array_Search($this->hooks[$type], $sender);
 100                         if ($key !== FALSE) {
 101                                 unset($this->hooks[$type][$key]);
 102                         }
 103                 }
 104         }
 105
 106         function get_hooks($type) {
 107                 if (isset($this->hooks[$type])) {
 108                         return $this->hooks[$type];
 109                 } else {
 110                         return array();
 111                 }
 112         }
 113         function load_all($kind, $owner_uid = false) {
 114                 $plugins = array_map("basename", glob("plugins/*"));
 115                 $this->load(join(",", $plugins), $kind, $owner_uid);
 116         }
 117
 118         function load($classlist, $kind, $owner_uid = false) {
 119                 $plugins = explode(",", $classlist);
 120
 121                 $this->owner_uid = (int) $owner_uid;
 122
 123                 foreach ($plugins as $class) {
 124                         $class = trim($class);
 125                         $class_file = strtolower(basename($class));
 126
 127                         if (!is_dir(dirname(__FILE__)."/../plugins/$class_file")) continue;
 128
 129                         $file = dirname(__FILE__)."/../plugins/$class_file/init.php";
 130
 131                         if (!isset($this->plugins[$class])) {
 132                                 if (file_exists($file)) require_once $file;
 133
 134                                 if (class_exists($class) && is_subclass_of($class, "Plugin")) {
 135                                         $plugin = new $class($this);
 136
 137                                         $plugin_api = $plugin->api_version();
 138
 139                                         if ($plugin_api < PluginHost::API_VERSION) {
 140                                                 user_error("Plugin $class is not compatible with current API version (need: " . PluginHost::API_VERSION . ", got: $plugin_api)", E_USER_WARNING);
 141                                                 continue;
 142                                         }
 143
 144                                         $this->last_registered = $class;
 145
 146                                         switch ($kind) {
 147                                         case $this::KIND_SYSTEM:
 148                                                 if ($this->is_system($plugin)) {
 149                                                         $plugin->init($this);
 150                                                         $this->register_plugin($class, $plugin);
 151                                                 }
 152                                                 break;
 153                                         case $this::KIND_USER:
 154                                                 if (!$this->is_system($plugin)) {
 155                                                         $plugin->init($this);
 156                                                         $this->register_plugin($class, $plugin);
 157                                                 }
 158                                                 break;
 159                                         case $this::KIND_ALL:
 160                                                 $plugin->init($this);
 161                                                 $this->register_plugin($class, $plugin);
 162                                                 break;
 163                                         }
 164                                 }
 165                         }
 166                 }
 167         }
 168
 169         function is_system($plugin) {
 170                 $about = $plugin->about();
 171
 172                 return @$about[3];
 173         }
 174
 175         // only system plugins are allowed to modify routing
 176         function add_handler($handler, $method, $sender) {
 177                 $handler = str_replace("-", "_", strtolower($handler));
 178                 $method = strtolower($method);
 179
 180                 if ($this->is_system($sender)) {
 181                         if (!is_array($this->handlers[$handler])) {
 182                                 $this->handlers[$handler] = array();
 183                         }
 184
 185                         $this->handlers[$handler][$method] = $sender;
 186                 }
 187         }
 188
 189         function del_handler($handler, $method) {
 190                 $handler = str_replace("-", "_", strtolower($handler));
 191                 $method = strtolower($method);
 192
 193                 if ($this->is_system($sender)) {
 194                         unset($this->handlers[$handler][$method]);
 195                 }
 196         }
 197
 198         function lookup_handler($handler, $method) {
 199                 $handler = str_replace("-", "_", strtolower($handler));
 200                 $method = strtolower($method);
 201
 202                 if (is_array($this->handlers[$handler])) {
 203                         if (isset($this->handlers[$handler]["*"])) {
 204                                 return $this->handlers[$handler]["*"];
 205                         } else {
 206                                 return $this->handlers[$handler][$method];
 207                         }
 208                 }
 209
 210                 return false;
 211         }
 212
 213         function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
 214                 $command = str_replace("-", "_", strtolower($command));
 215
 216                 $this->commands[$command] = array("description" => $description,
 217                         "suffix" => $suffix,
 218                         "arghelp" => $arghelp,
 219                         "class" => $sender);
 220         }
 221
 222         function del_command($command) {
 223                 $command = "-" . strtolower($command);
 224
 225                 unset($this->commands[$command]);
 226         }
 227
 228         function lookup_command($command) {
 229                 $command = "-" . strtolower($command);
 230
 231                 if (is_array($this->commands[$command])) {
 232                         return $this->commands[$command]["class"];
 233                 } else {
 234                         return false;
 235                 }
 236
 237                 return false;
 238         }
 239
 240         function get_commands() {
 241                 return $this->commands;
 242         }
 243
 244         function run_commands($args) {
 245                 foreach ($this->get_commands() as $command => $data) {
 246                         if (isset($args[$command])) {
 247                                 $command = str_replace("-", "", $command);
 248                                 $data["class"]->$command($args);
 249                         }
 250                 }
 251         }
 252
 253         function load_data($force = false) {
 254                 if ($this->owner_uid)  {
 255                         $plugin = $this->dbh->escape_string($plugin);
 256
 257                         $result = $this->dbh->query("SELECT name, content FROM ttrss_plugin_storage
 258                                 WHERE owner_uid = '".$this->owner_uid."'");
 259
 260                         while ($line = $this->dbh->fetch_assoc($result)) {
 261                                 $this->storage[$line["name"]] = unserialize($line["content"]);
 262                         }
 263                 }
 264         }
 265
 266         private function save_data($plugin) {
 267                 if ($this->owner_uid) {
 268                         $plugin = $this->dbh->escape_string($plugin);
 269
 270                         $this->dbh->query("BEGIN");
 271
 272                         $result = $this->dbh->query("SELECT id FROM ttrss_plugin_storage WHERE
 273                                 owner_uid= '".$this->owner_uid."' AND name = '$plugin'");
 274
 275                         if (!isset($this->storage[$plugin]))
 276                                 $this->storage[$plugin] = array();
 277
 278                         $content = $this->dbh->escape_string(serialize($this->storage[$plugin]));
 279
 280                         if ($this->dbh->num_rows($result) != 0) {
 281                                 $this->dbh->query("UPDATE ttrss_plugin_storage SET content = '$content'
 282                                         WHERE owner_uid= '".$this->owner_uid."' AND name = '$plugin'");
 283
 284                         } else {
 285                                 $this->dbh->query("INSERT INTO ttrss_plugin_storage
 286                                         (name,owner_uid,content) VALUES
 287                                         ('$plugin','".$this->owner_uid."','$content')");
 288                         }
 289
 290                         $this->dbh->query("COMMIT");
 291                 }
 292         }
 293
 294         function set($sender, $name, $value, $sync = true) {
 295                 $idx = get_class($sender);
 296
 297                 if (!isset($this->storage[$idx]))
 298                         $this->storage[$idx] = array();
 299
 300                 $this->storage[$idx][$name] = $value;
 301
 302                 if ($sync) $this->save_data(get_class($sender));
 303         }
 304
 305         function get($sender, $name, $default_value = false) {
 306                 $idx = get_class($sender);
 307
 308                 if (isset($this->storage[$idx][$name])) {
 309                         return $this->storage[$idx][$name];
 310                 } else {
 311                         return $default_value;
 312                 }
 313         }
 314
 315         function get_all($sender) {
 316                 $idx = get_class($sender);
 317
 318                 return $this->storage[$idx];
 319         }
 320
 321         function clear_data($sender) {
 322                 if ($this->owner_uid) {
 323                         $idx = get_class($sender);
 324
 325                         unset($this->storage[$idx]);
 326
 327                         $this->dbh->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
 328                                 AND owner_uid = " . $this->owner_uid);
 329                 }
 330         }
 331
 332         function set_debug($debug) {
 333                 $this->debug = $debug;
 334         }
 335
 336         function get_debug() {
 337                 return $this->debug;
 338         }
 339
 340         // Plugin feed functions are *EXPERIMENTAL*!
 341
 342         // cat_id: only -1 is supported (Special)
 343         function add_feed($cat_id, $title, $icon, $sender) {
 344                 if (!$this->feeds[$cat_id]) $this->feeds[$cat_id] = array();
 345
 346                 $id = count($this->feeds[$cat_id]);
 347
 348                 array_push($this->feeds[$cat_id],
 349                         array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
 350
 351                 return $id;
 352         }
 353
 354         function get_feeds($cat_id) {
 355                 return $this->feeds[$cat_id];
 356         }
 357
 358         // convert feed_id (e.g. -129) to pfeed_id first
 359         function get_feed_handler($pfeed_id) {
 360                 foreach ($this->feeds as $cat) {
 361                         foreach ($cat as $feed) {
 362                                 if ($feed['id'] == $pfeed_id) {
 363                                         return $feed['sender'];
 364                                 }
 365                         }
 366                 }
 367         }
 368
 369         static function pfeed_to_feed_id($label) {
 370                 return PLUGIN_FEED_BASE_INDEX - 1 - abs($label);
 371         }
 372
 373         static function feed_to_pfeed_id($feed) {
 374                 return PLUGIN_FEED_BASE_INDEX - 1 + abs($feed);
 375         }
 376
 377         function add_api_method($name, $sender) {
 378                 if ($this->is_system($sender)) {
 379                         $this->api_methods[strtolower($name)] = $sender;
 380                 }
 381         }
 382
 383         function get_api_method($name) {
 384                 return $this->api_methods[$name];
 385         }
 386 }
 387 ?>