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