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