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