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