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;
39 const HOOK_FETCH_FEED
= 22;
40 const HOOK_QUERY_HEADLINES
= 23;
41 const HOOK_HOUSE_KEEPING
= 24;
42 const HOOK_SEARCH
= 25;
43 const HOOK_FORMAT_ENCLOSURES
= 26;
44 const HOOK_SUBSCRIBE_FEED
= 27;
45 const HOOK_HEADLINES_BEFORE
= 28;
48 const KIND_SYSTEM
= 2;
51 function __construct() {
52 $this->dbh
= Db
::get();
54 $this->storage
= array();
57 private function __clone() {
61 public static function getInstance() {
62 if (self
::$instance == null)
63 self
::$instance = new self();
65 return self
::$instance;
68 private function register_plugin($name, $plugin) {
69 //array_push($this->plugins, $plugin);
70 $this->plugins
[$name] = $plugin;
73 // needed for compatibility with API 1
82 function get_plugin_names() {
85 foreach ($this->plugins
as $p) {
86 array_push($names, get_class($p));
92 function get_plugins() {
93 return $this->plugins
;
96 function get_plugin($name) {
97 return $this->plugins
[$name];
100 function run_hooks($type, $method, $args) {
101 foreach ($this->get_hooks($type) as $hook) {
102 $hook->$method($args);
106 function add_hook($type, $sender) {
107 if (!is_array($this->hooks
[$type])) {
108 $this->hooks
[$type] = array();
111 array_push($this->hooks
[$type], $sender);
114 function del_hook($type, $sender) {
115 if (is_array($this->hooks
[$type])) {
116 $key = array_Search($sender, $this->hooks
[$type]);
117 if ($key !== FALSE) {
118 unset($this->hooks
[$type][$key]);
123 function get_hooks($type) {
124 if (isset($this->hooks
[$type])) {
125 return $this->hooks
[$type];
130 function load_all($kind, $owner_uid = false) {
131 $plugins = array_map("basename", glob("plugins/*"));
132 $this->load(join(",", $plugins), $kind, $owner_uid);
135 function load($classlist, $kind, $owner_uid = false) {
136 $plugins = explode(",", $classlist);
138 $this->owner_uid
= (int) $owner_uid;
140 foreach ($plugins as $class) {
141 $class = trim($class);
142 $class_file = strtolower(basename($class));
144 if (!is_dir(dirname(__FILE__
)."/../plugins/$class_file")) continue;
146 $file = dirname(__FILE__
)."/../plugins/$class_file/init.php";
148 if (!isset($this->plugins
[$class])) {
149 if (file_exists($file)) require_once $file;
151 if (class_exists($class) && is_subclass_of($class, "Plugin")) {
152 $plugin = new $class($this);
154 $plugin_api = $plugin->api_version();
156 if ($plugin_api < PluginHost
::API_VERSION
) {
157 user_error("Plugin $class is not compatible with current API version (need: " . PluginHost
::API_VERSION
. ", got: $plugin_api)", E_USER_WARNING
);
161 $this->last_registered
= $class;
164 case $this::KIND_SYSTEM
:
165 if ($this->is_system($plugin)) {
166 $plugin->init($this);
167 $this->register_plugin($class, $plugin);
170 case $this::KIND_USER
:
171 if (!$this->is_system($plugin)) {
172 $plugin->init($this);
173 $this->register_plugin($class, $plugin);
176 case $this::KIND_ALL
:
177 $plugin->init($this);
178 $this->register_plugin($class, $plugin);
186 function is_system($plugin) {
187 $about = $plugin->about();
192 // only system plugins are allowed to modify routing
193 function add_handler($handler, $method, $sender) {
194 $handler = str_replace("-", "_", strtolower($handler));
195 $method = strtolower($method);
197 if ($this->is_system($sender)) {
198 if (!is_array($this->handlers
[$handler])) {
199 $this->handlers
[$handler] = array();
202 $this->handlers
[$handler][$method] = $sender;
206 function del_handler($handler, $method, $sender) {
207 $handler = str_replace("-", "_", strtolower($handler));
208 $method = strtolower($method);
210 if ($this->is_system($sender)) {
211 unset($this->handlers
[$handler][$method]);
215 function lookup_handler($handler, $method) {
216 $handler = str_replace("-", "_", strtolower($handler));
217 $method = strtolower($method);
219 if (is_array($this->handlers
[$handler])) {
220 if (isset($this->handlers
[$handler]["*"])) {
221 return $this->handlers
[$handler]["*"];
223 return $this->handlers
[$handler][$method];
230 function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
231 $command = str_replace("-", "_", strtolower($command));
233 $this->commands
[$command] = array("description" => $description,
235 "arghelp" => $arghelp,
239 function del_command($command) {
240 $command = "-" . strtolower($command);
242 unset($this->commands
[$command]);
245 function lookup_command($command) {
246 $command = "-" . strtolower($command);
248 if (is_array($this->commands
[$command])) {
249 return $this->commands
[$command]["class"];
257 function get_commands() {
258 return $this->commands
;
261 function run_commands($args) {
262 foreach ($this->get_commands() as $command => $data) {
263 if (isset($args[$command])) {
264 $command = str_replace("-", "", $command);
265 $data["class"]->$command($args);
270 function load_data($force = false) {
271 if ($this->owner_uid
) {
272 $result = $this->dbh
->query("SELECT name, content FROM ttrss_plugin_storage
273 WHERE owner_uid = '".$this->owner_uid
."'");
275 while ($line = $this->dbh
->fetch_assoc($result)) {
276 $this->storage
[$line["name"]] = unserialize($line["content"]);
281 private function save_data($plugin) {
282 if ($this->owner_uid
) {
283 $plugin = $this->dbh
->escape_string($plugin);
285 $this->dbh
->query("BEGIN");
287 $result = $this->dbh
->query("SELECT id FROM ttrss_plugin_storage WHERE
288 owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
290 if (!isset($this->storage
[$plugin]))
291 $this->storage
[$plugin] = array();
293 $content = $this->dbh
->escape_string(serialize($this->storage
[$plugin]),
296 if ($this->dbh
->num_rows($result) != 0) {
297 $this->dbh
->query("UPDATE ttrss_plugin_storage SET content = '$content'
298 WHERE owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
301 $this->dbh
->query("INSERT INTO ttrss_plugin_storage
302 (name,owner_uid,content) VALUES
303 ('$plugin','".$this->owner_uid
."','$content')");
306 $this->dbh
->query("COMMIT");
310 function set($sender, $name, $value, $sync = true) {
311 $idx = get_class($sender);
313 if (!isset($this->storage
[$idx]))
314 $this->storage
[$idx] = array();
316 $this->storage
[$idx][$name] = $value;
318 if ($sync) $this->save_data(get_class($sender));
321 function get($sender, $name, $default_value = false) {
322 $idx = get_class($sender);
324 if (isset($this->storage
[$idx][$name])) {
325 return $this->storage
[$idx][$name];
327 return $default_value;
331 function get_all($sender) {
332 $idx = get_class($sender);
334 return $this->storage
[$idx];
337 function clear_data($sender) {
338 if ($this->owner_uid
) {
339 $idx = get_class($sender);
341 unset($this->storage
[$idx]);
343 $this->dbh
->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
344 AND owner_uid = " . $this->owner_uid
);
348 function set_debug($debug) {
349 $this->debug
= $debug;
352 function get_debug() {
356 // Plugin feed functions are *EXPERIMENTAL*!
358 // cat_id: only -1 is supported (Special)
359 function add_feed($cat_id, $title, $icon, $sender) {
360 if (!$this->feeds
[$cat_id]) $this->feeds
[$cat_id] = array();
362 $id = count($this->feeds
[$cat_id]);
364 array_push($this->feeds
[$cat_id],
365 array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
370 function get_feeds($cat_id) {
371 return $this->feeds
[$cat_id];
374 // convert feed_id (e.g. -129) to pfeed_id first
375 function get_feed_handler($pfeed_id) {
376 foreach ($this->feeds
as $cat) {
377 foreach ($cat as $feed) {
378 if ($feed['id'] == $pfeed_id) {
379 return $feed['sender'];
385 static function pfeed_to_feed_id($label) {
386 return PLUGIN_FEED_BASE_INDEX
- 1 - abs($label);
389 static function feed_to_pfeed_id($feed) {
390 return PLUGIN_FEED_BASE_INDEX
- 1 +
abs($feed);
393 function add_api_method($name, $sender) {
394 if ($this->is_system($sender)) {
395 $this->api_methods
[strtolower($name)] = $sender;
399 function get_api_method($name) {
400 return $this->api_methods
[$name];