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