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