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
 133                 $plugins = array_merge(glob("plugins/*"), glob("plugins.local/*"));
 134                 $plugins = array_filter($plugins, "is_dir");
 135                 $plugins = array_map("basename", $plugins);
 136
 137                 asort($plugins);
 138
 139                 $this->load(join(",", $plugins), $kind, $owner_uid);
 140         }
 141
 142         function load($classlist, $kind, $owner_uid = false) {
 143                 $plugins = explode(",", $classlist);
 144
 145                 $this->owner_uid = (int) $owner_uid;
 146
 147                 foreach ($plugins as $class) {
 148                         $class = trim($class);
 149                         $class_file = strtolower(basename($class));
 150
 151                         if (!is_dir(__DIR__."/../plugins/$class_file") &&
 152                                         !is_dir(__DIR__."/../plugins.local/$class_file")) continue;
 153
 154                         // try system plugin directory first
 155                         $file = __DIR__ . "/../plugins/$class_file/init.php";
 156
 157                         if (!file_exists($file)) {
 158                                 $file = __DIR__ . "/../plugins.local/$class_file/init.php";
 159                         }
 160
 161                         if (!isset($this->plugins[$class])) {
 162                                 if (file_exists($file)) require_once $file;
 163
 164                                 if (class_exists($class) && is_subclass_of($class, "Plugin")) {
 165                                         $plugin = new $class($this);
 166
 167                                         $plugin_api = $plugin->api_version();
 168
 169                                         if ($plugin_api < PluginHost::API_VERSION) {
 170                                                 user_error("Plugin $class is not compatible with current API version (need: " . PluginHost::API_VERSION . ", got: $plugin_api)", E_USER_WARNING);
 171                                                 continue;
 172                                         }
 173
 174                                         $this->last_registered = $class;
 175
 176                                         switch ($kind) {
 177                                         case $this::KIND_SYSTEM:
 178                                                 if ($this->is_system($plugin)) {
 179                                                         $plugin->init($this);
 180                                                         $this->register_plugin($class, $plugin);
 181                                                 }
 182                                                 break;
 183                                         case $this::KIND_USER:
 184                                                 if (!$this->is_system($plugin)) {
 185                                                         $plugin->init($this);
 186                                                         $this->register_plugin($class, $plugin);
 187                                                 }
 188                                                 break;
 189                                         case $this::KIND_ALL:
 190                                                 $plugin->init($this);
 191                                                 $this->register_plugin($class, $plugin);
 192                                                 break;
 193                                         }
 194                                 }
 195                         }
 196                 }
 197         }
 198
 199         function is_system($plugin) {
 200                 $about = $plugin->about();
 201
 202                 return @$about[3];
 203         }
 204
 205         // only system plugins are allowed to modify routing
 206         function add_handler($handler, $method, $sender) {
 207                 $handler = str_replace("-", "_", strtolower($handler));
 208                 $method = strtolower($method);
 209
 210                 if ($this->is_system($sender)) {
 211                         if (!is_array($this->handlers[$handler])) {
 212                                 $this->handlers[$handler] = array();
 213                         }
 214
 215                         $this->handlers[$handler][$method] = $sender;
 216                 }
 217         }
 218
 219         function del_handler($handler, $method, $sender) {
 220                 $handler = str_replace("-", "_", strtolower($handler));
 221                 $method = strtolower($method);
 222
 223                 if ($this->is_system($sender)) {
 224                         unset($this->handlers[$handler][$method]);
 225                 }
 226         }
 227
 228         function lookup_handler($handler, $method) {
 229                 $handler = str_replace("-", "_", strtolower($handler));
 230                 $method = strtolower($method);
 231
 232                 if (is_array($this->handlers[$handler])) {
 233                         if (isset($this->handlers[$handler]["*"])) {
 234                                 return $this->handlers[$handler]["*"];
 235                         } else {
 236                                 return $this->handlers[$handler][$method];
 237                         }
 238                 }
 239
 240                 return false;
 241         }
 242
 243         function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
 244                 $command = str_replace("-", "_", strtolower($command));
 245
 246                 $this->commands[$command] = array("description" => $description,
 247                         "suffix" => $suffix,
 248                         "arghelp" => $arghelp,
 249                         "class" => $sender);
 250         }
 251
 252         function del_command($command) {
 253                 $command = "-" . strtolower($command);
 254
 255                 unset($this->commands[$command]);
 256         }
 257
 258         function lookup_command($command) {
 259                 $command = "-" . strtolower($command);
 260
 261                 if (is_array($this->commands[$command])) {
 262                         return $this->commands[$command]["class"];
 263                 } else {
 264                         return false;
 265                 }
 266
 267                 return false;
 268         }
 269
 270         function get_commands() {
 271                 return $this->commands;
 272         }
 273
 274         function run_commands($args) {
 275                 foreach ($this->get_commands() as $command => $data) {
 276                         if (isset($args[$command])) {
 277                                 $command = str_replace("-", "", $command);
 278                                 $data["class"]->$command($args);
 279                         }
 280                 }
 281         }
 282
 283         function load_data($force = false) {
 284                 if ($this->owner_uid)  {
 285                         $result = $this->dbh->query("SELECT name, content FROM ttrss_plugin_storage
 286                                 WHERE owner_uid = '".$this->owner_uid."'");
 287
 288                         while ($line = $this->dbh->fetch_assoc($result)) {
 289                                 $this->storage[$line["name"]] = unserialize($line["content"]);
 290                         }
 291                 }
 292         }
 293
 294         private function save_data($plugin) {
 295                 if ($this->owner_uid) {
 296                         $plugin = $this->dbh->escape_string($plugin);
 297
 298                         $this->dbh->query("BEGIN");
 299
 300                         $result = $this->dbh->query("SELECT id FROM ttrss_plugin_storage WHERE
 301                                 owner_uid= '".$this->owner_uid."' AND name = '$plugin'");
 302
 303                         if (!isset($this->storage[$plugin]))
 304                                 $this->storage[$plugin] = array();
 305
 306                         $content = $this->dbh->escape_string(serialize($this->storage[$plugin]),
 307                                 false);
 308
 309                         if ($this->dbh->num_rows($result) != 0) {
 310                                 $this->dbh->query("UPDATE ttrss_plugin_storage SET content = '$content'
 311                                         WHERE owner_uid= '".$this->owner_uid."' AND name = '$plugin'");
 312
 313                         } else {
 314                                 $this->dbh->query("INSERT INTO ttrss_plugin_storage
 315                                         (name,owner_uid,content) VALUES
 316                                         ('$plugin','".$this->owner_uid."','$content')");
 317                         }
 318
 319                         $this->dbh->query("COMMIT");
 320                 }
 321         }
 322
 323         function set($sender, $name, $value, $sync = true) {
 324                 $idx = get_class($sender);
 325
 326                 if (!isset($this->storage[$idx]))
 327                         $this->storage[$idx] = array();
 328
 329                 $this->storage[$idx][$name] = $value;
 330
 331                 if ($sync) $this->save_data(get_class($sender));
 332         }
 333
 334         function get($sender, $name, $default_value = false) {
 335                 $idx = get_class($sender);
 336
 337                 if (isset($this->storage[$idx][$name])) {
 338                         return $this->storage[$idx][$name];
 339                 } else {
 340                         return $default_value;
 341                 }
 342         }
 343
 344         function get_all($sender) {
 345                 $idx = get_class($sender);
 346
 347                 return $this->storage[$idx];
 348         }
 349
 350         function clear_data($sender) {
 351                 if ($this->owner_uid) {
 352                         $idx = get_class($sender);
 353
 354                         unset($this->storage[$idx]);
 355
 356                         $this->dbh->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
 357                                 AND owner_uid = " . $this->owner_uid);
 358                 }
 359         }
 360
 361         function set_debug($debug) {
 362                 $this->debug = $debug;
 363         }
 364
 365         function get_debug() {
 366                 return $this->debug;
 367         }
 368
 369         // Plugin feed functions are *EXPERIMENTAL*!
 370
 371         // cat_id: only -1 is supported (Special)
 372         function add_feed($cat_id, $title, $icon, $sender) {
 373                 if (!$this->feeds[$cat_id]) $this->feeds[$cat_id] = array();
 374
 375                 $id = count($this->feeds[$cat_id]);
 376
 377                 array_push($this->feeds[$cat_id],
 378                         array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
 379
 380                 return $id;
 381         }
 382
 383         function get_feeds($cat_id) {
 384                 return $this->feeds[$cat_id];
 385         }
 386
 387         // convert feed_id (e.g. -129) to pfeed_id first
 388         function get_feed_handler($pfeed_id) {
 389                 foreach ($this->feeds as $cat) {
 390                         foreach ($cat as $feed) {
 391                                 if ($feed['id'] == $pfeed_id) {
 392                                         return $feed['sender'];
 393                                 }
 394                         }
 395                 }
 396         }
 397
 398         static function pfeed_to_feed_id($label) {
 399                 return PLUGIN_FEED_BASE_INDEX - 1 - abs($label);
 400         }
 401
 402         static function feed_to_pfeed_id($feed) {
 403                 return PLUGIN_FEED_BASE_INDEX - 1 + abs($feed);
 404         }
 405
 406         function add_api_method($name, $sender) {
 407                 if ($this->is_system($sender)) {
 408                         $this->api_methods[strtolower($name)] = $sender;
 409                 }
 410         }
 411
 412         function get_api_method($name) {
 413                 return $this->api_methods[$name];
 414         }
 415 }
 416 ?>