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;
46 const HOOK_RENDER_ENCLOSURE
= 29;
49 const KIND_SYSTEM
= 2;
52 function __construct() {
53 $this->dbh
= Db
::get();
55 $this->storage
= array();
58 private function __clone() {
62 public static function getInstance() {
63 if (self
::$instance == null)
64 self
::$instance = new self();
66 return self
::$instance;
69 private function register_plugin($name, $plugin) {
70 //array_push($this->plugins, $plugin);
71 $this->plugins
[$name] = $plugin;
74 // needed for compatibility with API 1
83 function get_plugin_names() {
86 foreach ($this->plugins
as $p) {
87 array_push($names, get_class($p));
93 function get_plugins() {
94 return $this->plugins
;
97 function get_plugin($name) {
98 return $this->plugins
[$name];
101 function run_hooks($type, $method, $args) {
102 foreach ($this->get_hooks($type) as $hook) {
103 $hook->$method($args);
107 function add_hook($type, $sender) {
108 if (!is_array($this->hooks
[$type])) {
109 $this->hooks
[$type] = array();
112 array_push($this->hooks
[$type], $sender);
115 function del_hook($type, $sender) {
116 if (is_array($this->hooks
[$type])) {
117 $key = array_Search($sender, $this->hooks
[$type]);
118 if ($key !== FALSE) {
119 unset($this->hooks
[$type][$key]);
124 function get_hooks($type) {
125 if (isset($this->hooks
[$type])) {
126 return $this->hooks
[$type];
131 function load_all($kind, $owner_uid = false) {
132 $plugins = array_map("basename", array_filter(glob("plugins/*"), "is_dir"));
134 if (is_dir("plugins.local")) {
135 $plugins = array_merge($plugins, array_map("basename",
136 array_filter(glob("plugins.local/*"), "is_dir")));
141 $this->load(join(",", $plugins), $kind, $owner_uid);
144 function load($classlist, $kind, $owner_uid = false) {
145 $plugins = explode(",", $classlist);
147 $this->owner_uid
= (int) $owner_uid;
149 foreach ($plugins as $class) {
150 $class = trim($class);
151 $class_file = strtolower(basename($class));
153 if (!is_dir(__DIR__
."/../plugins/$class_file") &&
154 !is_dir(__DIR__
."/../plugins.local/$class_file")) continue;
156 // try system plugin directory first
157 $file = __DIR__
. "/../plugins/$class_file/init.php";
159 if (!file_exists($file)) {
160 $file = __DIR__
. "/../plugins.local/$class_file/init.php";
163 if (!isset($this->plugins
[$class])) {
164 if (file_exists($file)) require_once $file;
166 if (class_exists($class) && is_subclass_of($class, "Plugin")) {
167 $plugin = new $class($this);
169 $plugin_api = $plugin->api_version();
171 if ($plugin_api < PluginHost
::API_VERSION
) {
172 user_error("Plugin $class is not compatible with current API version (need: " . PluginHost
::API_VERSION
. ", got: $plugin_api)", E_USER_WARNING
);
176 $this->last_registered
= $class;
179 case $this::KIND_SYSTEM
:
180 if ($this->is_system($plugin)) {
181 $plugin->init($this);
182 $this->register_plugin($class, $plugin);
185 case $this::KIND_USER
:
186 if (!$this->is_system($plugin)) {
187 $plugin->init($this);
188 $this->register_plugin($class, $plugin);
191 case $this::KIND_ALL
:
192 $plugin->init($this);
193 $this->register_plugin($class, $plugin);
201 function is_system($plugin) {
202 $about = $plugin->about();
207 // only system plugins are allowed to modify routing
208 function add_handler($handler, $method, $sender) {
209 $handler = str_replace("-", "_", strtolower($handler));
210 $method = strtolower($method);
212 if ($this->is_system($sender)) {
213 if (!is_array($this->handlers
[$handler])) {
214 $this->handlers
[$handler] = array();
217 $this->handlers
[$handler][$method] = $sender;
221 function del_handler($handler, $method, $sender) {
222 $handler = str_replace("-", "_", strtolower($handler));
223 $method = strtolower($method);
225 if ($this->is_system($sender)) {
226 unset($this->handlers
[$handler][$method]);
230 function lookup_handler($handler, $method) {
231 $handler = str_replace("-", "_", strtolower($handler));
232 $method = strtolower($method);
234 if (is_array($this->handlers
[$handler])) {
235 if (isset($this->handlers
[$handler]["*"])) {
236 return $this->handlers
[$handler]["*"];
238 return $this->handlers
[$handler][$method];
245 function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
246 $command = str_replace("-", "_", strtolower($command));
248 $this->commands
[$command] = array("description" => $description,
250 "arghelp" => $arghelp,
254 function del_command($command) {
255 $command = "-" . strtolower($command);
257 unset($this->commands
[$command]);
260 function lookup_command($command) {
261 $command = "-" . strtolower($command);
263 if (is_array($this->commands
[$command])) {
264 return $this->commands
[$command]["class"];
272 function get_commands() {
273 return $this->commands
;
276 function run_commands($args) {
277 foreach ($this->get_commands() as $command => $data) {
278 if (isset($args[$command])) {
279 $command = str_replace("-", "", $command);
280 $data["class"]->$command($args);
285 function load_data($force = false) {
286 if ($this->owner_uid
) {
287 $result = $this->dbh
->query("SELECT name, content FROM ttrss_plugin_storage
288 WHERE owner_uid = '".$this->owner_uid
."'");
290 while ($line = $this->dbh
->fetch_assoc($result)) {
291 $this->storage
[$line["name"]] = unserialize($line["content"]);
296 private function save_data($plugin) {
297 if ($this->owner_uid
) {
298 $plugin = $this->dbh
->escape_string($plugin);
300 $this->dbh
->query("BEGIN");
302 $result = $this->dbh
->query("SELECT id FROM ttrss_plugin_storage WHERE
303 owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
305 if (!isset($this->storage
[$plugin]))
306 $this->storage
[$plugin] = array();
308 $content = $this->dbh
->escape_string(serialize($this->storage
[$plugin]),
311 if ($this->dbh
->num_rows($result) != 0) {
312 $this->dbh
->query("UPDATE ttrss_plugin_storage SET content = '$content'
313 WHERE owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
316 $this->dbh
->query("INSERT INTO ttrss_plugin_storage
317 (name,owner_uid,content) VALUES
318 ('$plugin','".$this->owner_uid
."','$content')");
321 $this->dbh
->query("COMMIT");
325 function set($sender, $name, $value, $sync = true) {
326 $idx = get_class($sender);
328 if (!isset($this->storage
[$idx]))
329 $this->storage
[$idx] = array();
331 $this->storage
[$idx][$name] = $value;
333 if ($sync) $this->save_data(get_class($sender));
336 function get($sender, $name, $default_value = false) {
337 $idx = get_class($sender);
339 if (isset($this->storage
[$idx][$name])) {
340 return $this->storage
[$idx][$name];
342 return $default_value;
346 function get_all($sender) {
347 $idx = get_class($sender);
349 return $this->storage
[$idx];
352 function clear_data($sender) {
353 if ($this->owner_uid
) {
354 $idx = get_class($sender);
356 unset($this->storage
[$idx]);
358 $this->dbh
->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
359 AND owner_uid = " . $this->owner_uid
);
363 function set_debug($debug) {
364 $this->debug
= $debug;
367 function get_debug() {
371 // Plugin feed functions are *EXPERIMENTAL*!
373 // cat_id: only -1 is supported (Special)
374 function add_feed($cat_id, $title, $icon, $sender) {
375 if (!$this->feeds
[$cat_id]) $this->feeds
[$cat_id] = array();
377 $id = count($this->feeds
[$cat_id]);
379 array_push($this->feeds
[$cat_id],
380 array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
385 function get_feeds($cat_id) {
386 return $this->feeds
[$cat_id];
389 // convert feed_id (e.g. -129) to pfeed_id first
390 function get_feed_handler($pfeed_id) {
391 foreach ($this->feeds
as $cat) {
392 foreach ($cat as $feed) {
393 if ($feed['id'] == $pfeed_id) {
394 return $feed['sender'];
400 static function pfeed_to_feed_id($label) {
401 return PLUGIN_FEED_BASE_INDEX
- 1 - abs($label);
404 static function feed_to_pfeed_id($feed) {
405 return PLUGIN_FEED_BASE_INDEX
- 1 +
abs($feed);
408 function add_api_method($name, $sender) {
409 if ($this->is_system($sender)) {
410 $this->api_methods
[strtolower($name)] = $sender;
414 function get_api_method($name) {
415 return $this->api_methods
[$name];