]> git.wh0rd.org - tt-rss.git/blobdiff - classes/pluginhost.php
add pluginhost HOOK_HEADLINES_BEFORE (refs #814)
[tt-rss.git] / classes / pluginhost.php
index 7dabd42a81d9c21bfd9f9f37e1dfd964761f121e..1ad7afd60f1081201e13381a705a48b020ed05e2 100644 (file)
@@ -1,13 +1,19 @@
 <?php
 class PluginHost {
-       private $link;
+       private $dbh;
        private $hooks = array();
        private $plugins = array();
        private $handlers = array();
        private $commands = array();
        private $storage = array();
+       private $feeds = array();
+       private $api_methods = array();
        private $owner_uid;
        private $debug;
+       private $last_registered;
+       private static $instance;
+
+       const API_VERSION = 2;
 
        const HOOK_ARTICLE_BUTTON = 1;
        const HOOK_ARTICLE_FILTER = 2;
@@ -23,17 +29,40 @@ class PluginHost {
        const HOOK_FEED_FETCHED = 12;
        const HOOK_SANITIZE = 13;
        const HOOK_RENDER_ARTICLE_API = 14;
+       const HOOK_TOOLBAR_BUTTON = 15;
+       const HOOK_ACTION_ITEM = 16;
+       const HOOK_HEADLINE_TOOLBAR_BUTTON = 17;
+       const HOOK_HOTKEY_INFO = 18;
+       const HOOK_ARTICLE_LEFT_BUTTON = 19;
+       const HOOK_PREFS_EDIT_FEED = 20;
+       const HOOK_PREFS_SAVE_FEED = 21;
+       const HOOK_FETCH_FEED = 22;
+       const HOOK_QUERY_HEADLINES = 23;
+       const HOOK_HOUSE_KEEPING = 24;
+       const HOOK_SEARCH = 25;
+       const HOOK_FORMAT_ENCLOSURES = 26;
+       const HOOK_SUBSCRIBE_FEED = 27;
+       const HOOK_HEADLINES_BEFORE = 28;
 
        const KIND_ALL = 1;
        const KIND_SYSTEM = 2;
        const KIND_USER = 3;
 
-       function __construct($link) {
-               $this->link = $link;
+       function __construct() {
+               $this->dbh = Db::get();
+
+               $this->storage = array();
+       }
+
+       private function __clone() {
+               //
+       }
 
-               $this->storage = $_SESSION["plugin_storage"];
+       public static function getInstance() {
+               if (self::$instance == null)
+                       self::$instance = new self();
 
-               if (!$this->storage) $this->storage = array();
+               return self::$instance;
        }
 
        private function register_plugin($name, $plugin) {
@@ -41,8 +70,23 @@ class PluginHost {
                $this->plugins[$name] = $plugin;
        }
 
+       // needed for compatibility with API 1
        function get_link() {
-               return $this->link;
+               return false;
+       }
+
+       function get_dbh() {
+               return $this->dbh;
+       }
+
+       function get_plugin_names() {
+               $names = array();
+
+               foreach ($this->plugins as $p) {
+                       array_push($names, get_class($p));
+               }
+
+               return $names;
        }
 
        function get_plugins() {
@@ -69,7 +113,7 @@ class PluginHost {
 
        function del_hook($type, $sender) {
                if (is_array($this->hooks[$type])) {
-                       $key = array_Search($this->hooks[$type], $sender);
+                       $key = array_Search($sender, $this->hooks[$type]);
                        if ($key !== FALSE) {
                                unset($this->hooks[$type][$key]);
                        }
@@ -96,6 +140,9 @@ class PluginHost {
                foreach ($plugins as $class) {
                        $class = trim($class);
                        $class_file = strtolower(basename($class));
+
+                       if (!is_dir(dirname(__FILE__)."/../plugins/$class_file")) continue;
+
                        $file = dirname(__FILE__)."/../plugins/$class_file/init.php";
 
                        if (!isset($this->plugins[$class])) {
@@ -104,6 +151,15 @@ class PluginHost {
                                if (class_exists($class) && is_subclass_of($class, "Plugin")) {
                                        $plugin = new $class($this);
 
+                                       $plugin_api = $plugin->api_version();
+
+                                       if ($plugin_api < PluginHost::API_VERSION) {
+                                               user_error("Plugin $class is not compatible with current API version (need: " . PluginHost::API_VERSION . ", got: $plugin_api)", E_USER_WARNING);
+                                               continue;
+                                       }
+
+                                       $this->last_registered = $class;
+
                                        switch ($kind) {
                                        case $this::KIND_SYSTEM:
                                                if ($this->is_system($plugin)) {
@@ -147,7 +203,7 @@ class PluginHost {
                }
        }
 
-       function del_handler($handler, $method) {
+       function del_handler($handler, $method, $sender) {
                $handler = str_replace("-", "_", strtolower($handler));
                $method = strtolower($method);
 
@@ -171,10 +227,12 @@ class PluginHost {
                return false;
        }
 
-       function add_command($command, $description, $sender) {
+       function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
                $command = str_replace("-", "_", strtolower($command));
 
                $this->commands[$command] = array("description" => $description,
+                       "suffix" => $suffix,
+                       "arghelp" => $arghelp,
                        "class" => $sender);
        }
 
@@ -210,45 +268,42 @@ class PluginHost {
        }
 
        function load_data($force = false) {
-               if ($this->owner_uid && (!$_SESSION["plugin_storage"] || $force))  {
-                       $plugin = db_escape_string($plugin);
-
-                       $result = db_query($this->link, "SELECT name, content FROM ttrss_plugin_storage
+               if ($this->owner_uid)  {
+                       $result = $this->dbh->query("SELECT name, content FROM ttrss_plugin_storage
                                WHERE owner_uid = '".$this->owner_uid."'");
 
-                       while ($line = db_fetch_assoc($result)) {
+                       while ($line = $this->dbh->fetch_assoc($result)) {
                                $this->storage[$line["name"]] = unserialize($line["content"]);
                        }
-
-                       $_SESSION["plugin_storage"] = $this->storage;
                }
        }
 
        private function save_data($plugin) {
                if ($this->owner_uid) {
-                       $plugin = db_escape_string($plugin);
+                       $plugin = $this->dbh->escape_string($plugin);
 
-                       db_query($this->link, "BEGIN");
+                       $this->dbh->query("BEGIN");
 
-                       $result = db_query($this->link,"SELECT id FROM ttrss_plugin_storage WHERE
+                       $result = $this->dbh->query("SELECT id FROM ttrss_plugin_storage WHERE
                                owner_uid= '".$this->owner_uid."' AND name = '$plugin'");
 
                        if (!isset($this->storage[$plugin]))
                                $this->storage[$plugin] = array();
 
-                       $content = db_escape_string(serialize($this->storage[$plugin]));
+                       $content = $this->dbh->escape_string(serialize($this->storage[$plugin]),
+                               false);
 
-                       if (db_num_rows($result) != 0) {
-                               db_query($this->link, "UPDATE ttrss_plugin_storage SET content = '$content'
+                       if ($this->dbh->num_rows($result) != 0) {
+                               $this->dbh->query("UPDATE ttrss_plugin_storage SET content = '$content'
                                        WHERE owner_uid= '".$this->owner_uid."' AND name = '$plugin'");
 
                        } else {
-                               db_query($this->link, "INSERT INTO ttrss_plugin_storage
+                               $this->dbh->query("INSERT INTO ttrss_plugin_storage
                                        (name,owner_uid,content) VALUES
                                        ('$plugin','".$this->owner_uid."','$content')");
                        }
 
-                       db_query($this->link, "COMMIT");
+                       $this->dbh->query("COMMIT");
                }
        }
 
@@ -260,8 +315,6 @@ class PluginHost {
 
                $this->storage[$idx][$name] = $value;
 
-               $_SESSION["plugin_storage"] = $this->storage;
-
                if ($sync) $this->save_data(get_class($sender));
        }
 
@@ -287,10 +340,8 @@ class PluginHost {
 
                        unset($this->storage[$idx]);
 
-                       db_query($this->link, "DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
+                       $this->dbh->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
                                AND owner_uid = " . $this->owner_uid);
-
-                       $_SESSION["plugin_storage"] = $this->storage;
                }
        }
 
@@ -301,5 +352,52 @@ class PluginHost {
        function get_debug() {
                return $this->debug;
        }
+
+       // Plugin feed functions are *EXPERIMENTAL*!
+
+       // cat_id: only -1 is supported (Special)
+       function add_feed($cat_id, $title, $icon, $sender) {
+               if (!$this->feeds[$cat_id]) $this->feeds[$cat_id] = array();
+
+               $id = count($this->feeds[$cat_id]);
+
+               array_push($this->feeds[$cat_id],
+                       array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
+
+               return $id;
+       }
+
+       function get_feeds($cat_id) {
+               return $this->feeds[$cat_id];
+       }
+
+       // convert feed_id (e.g. -129) to pfeed_id first
+       function get_feed_handler($pfeed_id) {
+               foreach ($this->feeds as $cat) {
+                       foreach ($cat as $feed) {
+                               if ($feed['id'] == $pfeed_id) {
+                                       return $feed['sender'];
+                               }
+                       }
+               }
+       }
+
+       static function pfeed_to_feed_id($label) {
+               return PLUGIN_FEED_BASE_INDEX - 1 - abs($label);
+       }
+
+       static function feed_to_pfeed_id($feed) {
+               return PLUGIN_FEED_BASE_INDEX - 1 + abs($feed);
+       }
+
+       function add_api_method($name, $sender) {
+               if ($this->is_system($sender)) {
+                       $this->api_methods[strtolower($name)] = $sender;
+               }
+       }
+
+       function get_api_method($name) {
+               return $this->api_methods[$name];
+       }
 }
 ?>