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