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 $plugin_actions = array();
14 private $last_registered;
15 private static $instance;
17 const API_VERSION
= 2;
19 // Hooks marked with *1 are run in global context and available
20 // to plugins loaded in config.php only
22 const HOOK_ARTICLE_BUTTON
= 1;
23 const HOOK_ARTICLE_FILTER
= 2;
24 const HOOK_PREFS_TAB
= 3;
25 const HOOK_PREFS_TAB_SECTION
= 4;
26 const HOOK_PREFS_TABS
= 5;
27 const HOOK_FEED_PARSED
= 6;
28 const HOOK_UPDATE_TASK
= 7; // *1
29 const HOOK_AUTH_USER
= 8;
30 const HOOK_HOTKEY_MAP
= 9;
31 const HOOK_RENDER_ARTICLE
= 10;
32 const HOOK_RENDER_ARTICLE_CDM
= 11;
33 const HOOK_FEED_FETCHED
= 12;
34 const HOOK_SANITIZE
= 13;
35 const HOOK_RENDER_ARTICLE_API
= 14;
36 const HOOK_TOOLBAR_BUTTON
= 15;
37 const HOOK_ACTION_ITEM
= 16;
38 const HOOK_HEADLINE_TOOLBAR_BUTTON
= 17;
39 const HOOK_HOTKEY_INFO
= 18;
40 const HOOK_ARTICLE_LEFT_BUTTON
= 19;
41 const HOOK_PREFS_EDIT_FEED
= 20;
42 const HOOK_PREFS_SAVE_FEED
= 21;
43 const HOOK_FETCH_FEED
= 22;
44 const HOOK_QUERY_HEADLINES
= 23;
45 const HOOK_HOUSE_KEEPING
= 24; // *1
46 const HOOK_SEARCH
= 25;
47 const HOOK_FORMAT_ENCLOSURES
= 26;
48 const HOOK_SUBSCRIBE_FEED
= 27;
49 const HOOK_HEADLINES_BEFORE
= 28;
50 const HOOK_RENDER_ENCLOSURE
= 29;
51 const HOOK_ARTICLE_FILTER_ACTION
= 30;
54 const KIND_SYSTEM
= 2;
57 function __construct() {
58 $this->dbh
= Db
::get();
60 $this->storage
= array();
63 private function __clone() {
67 public static function getInstance() {
68 if (self
::$instance == null)
69 self
::$instance = new self();
71 return self
::$instance;
74 private function register_plugin($name, $plugin) {
75 //array_push($this->plugins, $plugin);
76 $this->plugins
[$name] = $plugin;
79 // needed for compatibility with API 1
88 function get_plugin_names() {
91 foreach ($this->plugins
as $p) {
92 array_push($names, get_class($p));
98 function get_plugins() {
99 return $this->plugins
;
102 function get_plugin($name) {
103 return $this->plugins
[strtolower($name)];
106 function run_hooks($type, $method, $args) {
107 foreach ($this->get_hooks($type) as $hook) {
108 $hook->$method($args);
112 function add_hook($type, $sender) {
113 if (!is_array($this->hooks
[$type])) {
114 $this->hooks
[$type] = array();
117 array_push($this->hooks
[$type], $sender);
120 function del_hook($type, $sender) {
121 if (is_array($this->hooks
[$type])) {
122 $key = array_Search($sender, $this->hooks
[$type]);
123 if ($key !== FALSE) {
124 unset($this->hooks
[$type][$key]);
129 function get_hooks($type) {
130 if (isset($this->hooks
[$type])) {
131 return $this->hooks
[$type];
136 function load_all($kind, $owner_uid = false) {
138 $plugins = array_merge(glob("plugins/*"), glob("plugins.local/*"));
139 $plugins = array_filter($plugins, "is_dir");
140 $plugins = array_map("basename", $plugins);
144 $this->load(join(",", $plugins), $kind, $owner_uid);
147 function load($classlist, $kind, $owner_uid = false) {
148 $plugins = explode(",", $classlist);
150 $this->owner_uid
= (int) $owner_uid;
152 foreach ($plugins as $class) {
153 $class = trim($class);
154 $class_file = strtolower(basename($class));
156 if (!is_dir(__DIR__
."/../plugins/$class_file") &&
157 !is_dir(__DIR__
."/../plugins.local/$class_file")) continue;
159 // try system plugin directory first
160 $file = __DIR__
. "/../plugins/$class_file/init.php";
162 if (!file_exists($file)) {
163 $file = __DIR__
. "/../plugins.local/$class_file/init.php";
166 if (!isset($this->plugins
[$class])) {
167 if (file_exists($file)) require_once $file;
169 if (class_exists($class) && is_subclass_of($class, "Plugin")) {
170 $plugin = new $class($this);
172 $plugin_api = $plugin->api_version();
174 if ($plugin_api < PluginHost
::API_VERSION
) {
175 user_error("Plugin $class is not compatible with current API version (need: " . PluginHost
::API_VERSION
. ", got: $plugin_api)", E_USER_WARNING
);
179 $this->last_registered
= $class;
182 case $this::KIND_SYSTEM
:
183 if ($this->is_system($plugin)) {
184 $plugin->init($this);
185 $this->register_plugin($class, $plugin);
188 case $this::KIND_USER
:
189 if (!$this->is_system($plugin)) {
190 $plugin->init($this);
191 $this->register_plugin($class, $plugin);
194 case $this::KIND_ALL
:
195 $plugin->init($this);
196 $this->register_plugin($class, $plugin);
204 function is_system($plugin) {
205 $about = $plugin->about();
210 // only system plugins are allowed to modify routing
211 function add_handler($handler, $method, $sender) {
212 $handler = str_replace("-", "_", strtolower($handler));
213 $method = strtolower($method);
215 if ($this->is_system($sender)) {
216 if (!is_array($this->handlers
[$handler])) {
217 $this->handlers
[$handler] = array();
220 $this->handlers
[$handler][$method] = $sender;
224 function del_handler($handler, $method, $sender) {
225 $handler = str_replace("-", "_", strtolower($handler));
226 $method = strtolower($method);
228 if ($this->is_system($sender)) {
229 unset($this->handlers
[$handler][$method]);
233 function lookup_handler($handler, $method) {
234 $handler = str_replace("-", "_", strtolower($handler));
235 $method = strtolower($method);
237 if (is_array($this->handlers
[$handler])) {
238 if (isset($this->handlers
[$handler]["*"])) {
239 return $this->handlers
[$handler]["*"];
241 return $this->handlers
[$handler][$method];
248 function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
249 $command = str_replace("-", "_", strtolower($command));
251 $this->commands
[$command] = array("description" => $description,
253 "arghelp" => $arghelp,
257 function del_command($command) {
258 $command = "-" . strtolower($command);
260 unset($this->commands
[$command]);
263 function lookup_command($command) {
264 $command = "-" . strtolower($command);
266 if (is_array($this->commands
[$command])) {
267 return $this->commands
[$command]["class"];
275 function get_commands() {
276 return $this->commands
;
279 function run_commands($args) {
280 foreach ($this->get_commands() as $command => $data) {
281 if (isset($args[$command])) {
282 $command = str_replace("-", "", $command);
283 $data["class"]->$command($args);
288 function load_data($force = false) {
289 if ($this->owner_uid
) {
290 $result = $this->dbh
->query("SELECT name, content FROM ttrss_plugin_storage
291 WHERE owner_uid = '".$this->owner_uid
."'");
293 while ($line = $this->dbh
->fetch_assoc($result)) {
294 $this->storage
[$line["name"]] = unserialize($line["content"]);
299 private function save_data($plugin) {
300 if ($this->owner_uid
) {
301 $plugin = $this->dbh
->escape_string($plugin);
303 $this->dbh
->query("BEGIN");
305 $result = $this->dbh
->query("SELECT id FROM ttrss_plugin_storage WHERE
306 owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
308 if (!isset($this->storage
[$plugin]))
309 $this->storage
[$plugin] = array();
311 $content = $this->dbh
->escape_string(serialize($this->storage
[$plugin]),
314 if ($this->dbh
->num_rows($result) != 0) {
315 $this->dbh
->query("UPDATE ttrss_plugin_storage SET content = '$content'
316 WHERE owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
319 $this->dbh
->query("INSERT INTO ttrss_plugin_storage
320 (name,owner_uid,content) VALUES
321 ('$plugin','".$this->owner_uid
."','$content')");
324 $this->dbh
->query("COMMIT");
328 function set($sender, $name, $value, $sync = true) {
329 $idx = get_class($sender);
331 if (!isset($this->storage
[$idx]))
332 $this->storage
[$idx] = array();
334 $this->storage
[$idx][$name] = $value;
336 if ($sync) $this->save_data(get_class($sender));
339 function get($sender, $name, $default_value = false) {
340 $idx = get_class($sender);
342 if (isset($this->storage
[$idx][$name])) {
343 return $this->storage
[$idx][$name];
345 return $default_value;
349 function get_all($sender) {
350 $idx = get_class($sender);
352 return $this->storage
[$idx];
355 function clear_data($sender) {
356 if ($this->owner_uid
) {
357 $idx = get_class($sender);
359 unset($this->storage
[$idx]);
361 $this->dbh
->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
362 AND owner_uid = " . $this->owner_uid
);
366 function set_debug($debug) {
367 $this->debug
= $debug;
370 function get_debug() {
374 // Plugin feed functions are *EXPERIMENTAL*!
376 // cat_id: only -1 is supported (Special)
377 function add_feed($cat_id, $title, $icon, $sender) {
378 if (!$this->feeds
[$cat_id]) $this->feeds
[$cat_id] = array();
380 $id = count($this->feeds
[$cat_id]);
382 array_push($this->feeds
[$cat_id],
383 array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
388 function get_feeds($cat_id) {
389 return $this->feeds
[$cat_id];
392 // convert feed_id (e.g. -129) to pfeed_id first
393 function get_feed_handler($pfeed_id) {
394 foreach ($this->feeds
as $cat) {
395 foreach ($cat as $feed) {
396 if ($feed['id'] == $pfeed_id) {
397 return $feed['sender'];
403 static function pfeed_to_feed_id($label) {
404 return PLUGIN_FEED_BASE_INDEX
- 1 - abs($label);
407 static function feed_to_pfeed_id($feed) {
408 return PLUGIN_FEED_BASE_INDEX
- 1 +
abs($feed);
411 function add_api_method($name, $sender) {
412 if ($this->is_system($sender)) {
413 $this->api_methods
[strtolower($name)] = $sender;
417 function get_api_method($name) {
418 return $this->api_methods
[$name];
421 function add_filter_action($sender, $action_name, $action_desc) {
422 $sender_class = get_class($sender);
424 if (!isset($this->plugin_actions
[$sender_class]))
425 $this->plugin_actions
[$sender_class] = array();
427 array_push($this->plugin_actions
[$sender_class],
428 array("action" => $action_name, "description" => $action_desc, "sender" => $sender));
431 function get_filter_actions() {
432 return $this->plugin_actions
;