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();
13 private $last_registered;
14 private static $instance;
16 const API_VERSION
= 2;
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;
41 const KIND_SYSTEM
= 2;
44 function __construct() {
45 $this->dbh
= Db
::get();
47 $this->storage
= array();
50 private function __clone() {
54 public static function getInstance() {
55 if (self
::$instance == null)
56 self
::$instance = new self();
58 return self
::$instance;
61 private function register_plugin($name, $plugin) {
62 //array_push($this->plugins, $plugin);
63 $this->plugins
[$name] = $plugin;
66 // needed for compatibility with API 1
75 function get_plugins() {
76 return $this->plugins
;
79 function get_plugin($name) {
80 return $this->plugins
[$name];
83 function run_hooks($type, $method, $args) {
84 foreach ($this->get_hooks($type) as $hook) {
85 $hook->$method($args);
89 function add_hook($type, $sender) {
90 if (!is_array($this->hooks
[$type])) {
91 $this->hooks
[$type] = array();
94 array_push($this->hooks
[$type], $sender);
97 function del_hook($type, $sender) {
98 if (is_array($this->hooks
[$type])) {
99 $key = array_Search($this->hooks
[$type], $sender);
100 if ($key !== FALSE) {
101 unset($this->hooks
[$type][$key]);
106 function get_hooks($type) {
107 if (isset($this->hooks
[$type])) {
108 return $this->hooks
[$type];
113 function load_all($kind, $owner_uid = false) {
114 $plugins = array_map("basename", glob("plugins/*"));
115 $this->load(join(",", $plugins), $kind, $owner_uid);
118 function load($classlist, $kind, $owner_uid = false) {
119 $plugins = explode(",", $classlist);
121 $this->owner_uid
= (int) $owner_uid;
123 foreach ($plugins as $class) {
124 $class = trim($class);
125 $class_file = strtolower(basename($class));
127 if (!is_dir(dirname(__FILE__
)."/../plugins/$class_file")) continue;
129 $file = dirname(__FILE__
)."/../plugins/$class_file/init.php";
131 if (!isset($this->plugins
[$class])) {
132 if (file_exists($file)) require_once $file;
134 if (class_exists($class) && is_subclass_of($class, "Plugin")) {
135 $plugin = new $class($this);
137 $plugin_api = $plugin->api_version();
139 if ($plugin_api < PluginHost
::API_VERSION
) {
140 user_error("Plugin $class is not compatible with current API version (need: " . PluginHost
::API_VERSION
. ", got: $plugin_api)", E_USER_WARNING
);
144 $this->last_registered
= $class;
147 case $this::KIND_SYSTEM
:
148 if ($this->is_system($plugin)) {
149 $plugin->init($this);
150 $this->register_plugin($class, $plugin);
153 case $this::KIND_USER
:
154 if (!$this->is_system($plugin)) {
155 $plugin->init($this);
156 $this->register_plugin($class, $plugin);
159 case $this::KIND_ALL
:
160 $plugin->init($this);
161 $this->register_plugin($class, $plugin);
169 function is_system($plugin) {
170 $about = $plugin->about();
175 // only system plugins are allowed to modify routing
176 function add_handler($handler, $method, $sender) {
177 $handler = str_replace("-", "_", strtolower($handler));
178 $method = strtolower($method);
180 if ($this->is_system($sender)) {
181 if (!is_array($this->handlers
[$handler])) {
182 $this->handlers
[$handler] = array();
185 $this->handlers
[$handler][$method] = $sender;
189 function del_handler($handler, $method, $sender) {
190 $handler = str_replace("-", "_", strtolower($handler));
191 $method = strtolower($method);
193 if ($this->is_system($sender)) {
194 unset($this->handlers
[$handler][$method]);
198 function lookup_handler($handler, $method) {
199 $handler = str_replace("-", "_", strtolower($handler));
200 $method = strtolower($method);
202 if (is_array($this->handlers
[$handler])) {
203 if (isset($this->handlers
[$handler]["*"])) {
204 return $this->handlers
[$handler]["*"];
206 return $this->handlers
[$handler][$method];
213 function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
214 $command = str_replace("-", "_", strtolower($command));
216 $this->commands
[$command] = array("description" => $description,
218 "arghelp" => $arghelp,
222 function del_command($command) {
223 $command = "-" . strtolower($command);
225 unset($this->commands
[$command]);
228 function lookup_command($command) {
229 $command = "-" . strtolower($command);
231 if (is_array($this->commands
[$command])) {
232 return $this->commands
[$command]["class"];
240 function get_commands() {
241 return $this->commands
;
244 function run_commands($args) {
245 foreach ($this->get_commands() as $command => $data) {
246 if (isset($args[$command])) {
247 $command = str_replace("-", "", $command);
248 $data["class"]->$command($args);
253 function load_data($force = false) {
254 if ($this->owner_uid
) {
255 $result = $this->dbh
->query("SELECT name, content FROM ttrss_plugin_storage
256 WHERE owner_uid = '".$this->owner_uid
."'");
258 while ($line = $this->dbh
->fetch_assoc($result)) {
259 $this->storage
[$line["name"]] = unserialize($line["content"]);
264 private function save_data($plugin) {
265 if ($this->owner_uid
) {
266 $plugin = $this->dbh
->escape_string($plugin);
268 $this->dbh
->query("BEGIN");
270 $result = $this->dbh
->query("SELECT id FROM ttrss_plugin_storage WHERE
271 owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
273 if (!isset($this->storage
[$plugin]))
274 $this->storage
[$plugin] = array();
276 $content = $this->dbh
->escape_string(serialize($this->storage
[$plugin]));
278 if ($this->dbh
->num_rows($result) != 0) {
279 $this->dbh
->query("UPDATE ttrss_plugin_storage SET content = '$content'
280 WHERE owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
283 $this->dbh
->query("INSERT INTO ttrss_plugin_storage
284 (name,owner_uid,content) VALUES
285 ('$plugin','".$this->owner_uid
."','$content')");
288 $this->dbh
->query("COMMIT");
292 function set($sender, $name, $value, $sync = true) {
293 $idx = get_class($sender);
295 if (!isset($this->storage
[$idx]))
296 $this->storage
[$idx] = array();
298 $this->storage
[$idx][$name] = $value;
300 if ($sync) $this->save_data(get_class($sender));
303 function get($sender, $name, $default_value = false) {
304 $idx = get_class($sender);
306 if (isset($this->storage
[$idx][$name])) {
307 return $this->storage
[$idx][$name];
309 return $default_value;
313 function get_all($sender) {
314 $idx = get_class($sender);
316 return $this->storage
[$idx];
319 function clear_data($sender) {
320 if ($this->owner_uid
) {
321 $idx = get_class($sender);
323 unset($this->storage
[$idx]);
325 $this->dbh
->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
326 AND owner_uid = " . $this->owner_uid
);
330 function set_debug($debug) {
331 $this->debug
= $debug;
334 function get_debug() {
338 // Plugin feed functions are *EXPERIMENTAL*!
340 // cat_id: only -1 is supported (Special)
341 function add_feed($cat_id, $title, $icon, $sender) {
342 if (!$this->feeds
[$cat_id]) $this->feeds
[$cat_id] = array();
344 $id = count($this->feeds
[$cat_id]);
346 array_push($this->feeds
[$cat_id],
347 array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
352 function get_feeds($cat_id) {
353 return $this->feeds
[$cat_id];
356 // convert feed_id (e.g. -129) to pfeed_id first
357 function get_feed_handler($pfeed_id) {
358 foreach ($this->feeds
as $cat) {
359 foreach ($cat as $feed) {
360 if ($feed['id'] == $pfeed_id) {
361 return $feed['sender'];
367 static function pfeed_to_feed_id($label) {
368 return PLUGIN_FEED_BASE_INDEX
- 1 - abs($label);
371 static function feed_to_pfeed_id($feed) {
372 return PLUGIN_FEED_BASE_INDEX
- 1 +
abs($feed);
375 function add_api_method($name, $sender) {
376 if ($this->is_system($sender)) {
377 $this->api_methods
[strtolower($name)] = $sender;
381 function get_api_method($name) {
382 return $this->api_methods
[$name];