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