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