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;
52 const HOOK_ARTICLE_EXPORT_FEED
= 31;
53 const HOOK_MAIN_TOOLBAR_BUTTON
= 32;
54 const HOOK_ENCLOSURE_ENTRY
= 33;
55 const HOOK_FORMAT_ARTICLE
= 34;
56 const HOOK_FORMAT_ARTICLE_CDM
= 35;
57 const HOOK_FEED_BASIC_INFO
= 36;
60 const KIND_SYSTEM
= 2;
63 function __construct() {
64 $this->dbh
= Db
::get();
66 $this->storage
= array();
69 private function __clone() {
73 public static function getInstance() {
74 if (self
::$instance == null)
75 self
::$instance = new self();
77 return self
::$instance;
80 private function register_plugin($name, $plugin) {
81 //array_push($this->plugins, $plugin);
82 $this->plugins
[$name] = $plugin;
85 // needed for compatibility with API 1
94 function get_plugin_names() {
97 foreach ($this->plugins
as $p) {
98 array_push($names, get_class($p));
104 function get_plugins() {
105 return $this->plugins
;
108 function get_plugin($name) {
109 return $this->plugins
[strtolower($name)];
112 function run_hooks($type, $method, $args) {
113 foreach ($this->get_hooks($type) as $hook) {
114 $hook->$method($args);
118 function add_hook($type, $sender) {
119 if (!is_array($this->hooks
[$type])) {
120 $this->hooks
[$type] = array();
123 array_push($this->hooks
[$type], $sender);
126 function del_hook($type, $sender) {
127 if (is_array($this->hooks
[$type])) {
128 $key = array_Search($sender, $this->hooks
[$type]);
129 if ($key !== FALSE) {
130 unset($this->hooks
[$type][$key]);
135 function get_hooks($type) {
136 if (isset($this->hooks
[$type])) {
137 return $this->hooks
[$type];
142 function load_all($kind, $owner_uid = false, $skip_init = false) {
144 $plugins = array_merge(glob("plugins/*"), glob("plugins.local/*"));
145 $plugins = array_filter($plugins, "is_dir");
146 $plugins = array_map("basename", $plugins);
150 $this->load(join(",", $plugins), $kind, $owner_uid, $skip_init);
153 function load($classlist, $kind, $owner_uid = false, $skip_init = false) {
154 $plugins = explode(",", $classlist);
156 $this->owner_uid
= (int) $owner_uid;
158 foreach ($plugins as $class) {
159 $class = trim($class);
160 $class_file = strtolower(basename($class));
162 if (!is_dir(__DIR__
."/../plugins/$class_file") &&
163 !is_dir(__DIR__
."/../plugins.local/$class_file")) continue;
165 // try system plugin directory first
166 $file = __DIR__
. "/../plugins/$class_file/init.php";
168 if (!file_exists($file)) {
169 $file = __DIR__
. "/../plugins.local/$class_file/init.php";
172 if (!isset($this->plugins
[$class])) {
173 if (file_exists($file)) require_once $file;
175 if (class_exists($class) && is_subclass_of($class, "Plugin")) {
176 $plugin = new $class($this);
178 $plugin_api = $plugin->api_version();
180 if ($plugin_api < PluginHost
::API_VERSION
) {
181 user_error("Plugin $class is not compatible with current API version (need: " . PluginHost
::API_VERSION
. ", got: $plugin_api)", E_USER_WARNING
);
185 $this->last_registered
= $class;
188 case $this::KIND_SYSTEM
:
189 if ($this->is_system($plugin)) {
190 if (!$skip_init) $plugin->init($this);
191 $this->register_plugin($class, $plugin);
194 case $this::KIND_USER
:
195 if (!$this->is_system($plugin)) {
196 if (!$skip_init) $plugin->init($this);
197 $this->register_plugin($class, $plugin);
200 case $this::KIND_ALL
:
201 if (!$skip_init) $plugin->init($this);
202 $this->register_plugin($class, $plugin);
210 function is_system($plugin) {
211 $about = $plugin->about();
216 // only system plugins are allowed to modify routing
217 function add_handler($handler, $method, $sender) {
218 $handler = str_replace("-", "_", strtolower($handler));
219 $method = strtolower($method);
221 if ($this->is_system($sender)) {
222 if (!is_array($this->handlers
[$handler])) {
223 $this->handlers
[$handler] = array();
226 $this->handlers
[$handler][$method] = $sender;
230 function del_handler($handler, $method, $sender) {
231 $handler = str_replace("-", "_", strtolower($handler));
232 $method = strtolower($method);
234 if ($this->is_system($sender)) {
235 unset($this->handlers
[$handler][$method]);
239 function lookup_handler($handler, $method) {
240 $handler = str_replace("-", "_", strtolower($handler));
241 $method = strtolower($method);
243 if (is_array($this->handlers
[$handler])) {
244 if (isset($this->handlers
[$handler]["*"])) {
245 return $this->handlers
[$handler]["*"];
247 return $this->handlers
[$handler][$method];
254 function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
255 $command = str_replace("-", "_", strtolower($command));
257 $this->commands
[$command] = array("description" => $description,
259 "arghelp" => $arghelp,
263 function del_command($command) {
264 $command = "-" . strtolower($command);
266 unset($this->commands
[$command]);
269 function lookup_command($command) {
270 $command = "-" . strtolower($command);
272 if (is_array($this->commands
[$command])) {
273 return $this->commands
[$command]["class"];
281 function get_commands() {
282 return $this->commands
;
285 function run_commands($args) {
286 foreach ($this->get_commands() as $command => $data) {
287 if (isset($args[$command])) {
288 $command = str_replace("-", "", $command);
289 $data["class"]->$command($args);
294 function load_data() {
295 if ($this->owner_uid
) {
296 $result = $this->dbh
->query("SELECT name, content FROM ttrss_plugin_storage
297 WHERE owner_uid = '".$this->owner_uid
."'");
299 while ($line = $this->dbh
->fetch_assoc($result)) {
300 $this->storage
[$line["name"]] = unserialize($line["content"]);
305 private function save_data($plugin) {
306 if ($this->owner_uid
) {
307 $plugin = $this->dbh
->escape_string($plugin);
309 $this->dbh
->query("BEGIN");
311 $result = $this->dbh
->query("SELECT id FROM ttrss_plugin_storage WHERE
312 owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
314 if (!isset($this->storage
[$plugin]))
315 $this->storage
[$plugin] = array();
317 $content = $this->dbh
->escape_string(serialize($this->storage
[$plugin]),
320 if ($this->dbh
->num_rows($result) != 0) {
321 $this->dbh
->query("UPDATE ttrss_plugin_storage SET content = '$content'
322 WHERE owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
325 $this->dbh
->query("INSERT INTO ttrss_plugin_storage
326 (name,owner_uid,content) VALUES
327 ('$plugin','".$this->owner_uid
."','$content')");
330 $this->dbh
->query("COMMIT");
334 function set($sender, $name, $value, $sync = true) {
335 $idx = get_class($sender);
337 if (!isset($this->storage
[$idx]))
338 $this->storage
[$idx] = array();
340 $this->storage
[$idx][$name] = $value;
342 if ($sync) $this->save_data(get_class($sender));
345 function get($sender, $name, $default_value = false) {
346 $idx = get_class($sender);
348 if (isset($this->storage
[$idx][$name])) {
349 return $this->storage
[$idx][$name];
351 return $default_value;
355 function get_all($sender) {
356 $idx = get_class($sender);
358 return $this->storage
[$idx];
361 function clear_data($sender) {
362 if ($this->owner_uid
) {
363 $idx = get_class($sender);
365 unset($this->storage
[$idx]);
367 $this->dbh
->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
368 AND owner_uid = " . $this->owner_uid
);
372 function set_debug($debug) {
373 $this->debug
= $debug;
376 function get_debug() {
380 // Plugin feed functions are *EXPERIMENTAL*!
382 // cat_id: only -1 is supported (Special)
383 function add_feed($cat_id, $title, $icon, $sender) {
384 if (!$this->feeds
[$cat_id]) $this->feeds
[$cat_id] = array();
386 $id = count($this->feeds
[$cat_id]);
388 array_push($this->feeds
[$cat_id],
389 array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
394 function get_feeds($cat_id) {
395 return $this->feeds
[$cat_id];
398 // convert feed_id (e.g. -129) to pfeed_id first
399 function get_feed_handler($pfeed_id) {
400 foreach ($this->feeds
as $cat) {
401 foreach ($cat as $feed) {
402 if ($feed['id'] == $pfeed_id) {
403 return $feed['sender'];
409 static function pfeed_to_feed_id($label) {
410 return PLUGIN_FEED_BASE_INDEX
- 1 - abs($label);
413 static function feed_to_pfeed_id($feed) {
414 return PLUGIN_FEED_BASE_INDEX
- 1 +
abs($feed);
417 function add_api_method($name, $sender) {
418 if ($this->is_system($sender)) {
419 $this->api_methods
[strtolower($name)] = $sender;
423 function get_api_method($name) {
424 return $this->api_methods
[$name];
427 function add_filter_action($sender, $action_name, $action_desc) {
428 $sender_class = get_class($sender);
430 if (!isset($this->plugin_actions
[$sender_class]))
431 $this->plugin_actions
[$sender_class] = array();
433 array_push($this->plugin_actions
[$sender_class],
434 array("action" => $action_name, "description" => $action_desc, "sender" => $sender));
437 function get_filter_actions() {
438 return $this->plugin_actions
;