classes/pluginhost.php

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