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