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