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;
43 const KIND_SYSTEM
= 2;
46 function __construct() {
47 $this->dbh
= Db
::get();
49 $this->storage
= array();
52 private function __clone() {
56 public static function getInstance() {
57 if (self
::$instance == null)
58 self
::$instance = new self();
60 return self
::$instance;
63 private function register_plugin($name, $plugin) {
64 //array_push($this->plugins, $plugin);
65 $this->plugins
[$name] = $plugin;
68 // needed for compatibility with API 1
77 function get_plugins() {
78 return $this->plugins
;
81 function get_plugin($name) {
82 return $this->plugins
[$name];
85 function run_hooks($type, $method, $args) {
86 foreach ($this->get_hooks($type) as $hook) {
87 $hook->$method($args);
91 function add_hook($type, $sender) {
92 if (!is_array($this->hooks
[$type])) {
93 $this->hooks
[$type] = array();
96 array_push($this->hooks
[$type], $sender);
99 function del_hook($type, $sender) {
100 if (is_array($this->hooks
[$type])) {
101 $key = array_Search($this->hooks
[$type], $sender);
102 if ($key !== FALSE) {
103 unset($this->hooks
[$type][$key]);
108 function get_hooks($type) {
109 if (isset($this->hooks
[$type])) {
110 return $this->hooks
[$type];
115 function load_all($kind, $owner_uid = false) {
116 $plugins = array_map("basename", glob("plugins/*"));
117 $this->load(join(",", $plugins), $kind, $owner_uid);
120 function load($classlist, $kind, $owner_uid = false) {
121 $plugins = explode(",", $classlist);
123 $this->owner_uid
= (int) $owner_uid;
125 foreach ($plugins as $class) {
126 $class = trim($class);
127 $class_file = strtolower(basename($class));
129 if (!is_dir(dirname(__FILE__
)."/../plugins/$class_file")) continue;
131 $file = dirname(__FILE__
)."/../plugins/$class_file/init.php";
133 if (!isset($this->plugins
[$class])) {
134 if (file_exists($file)) require_once $file;
136 if (class_exists($class) && is_subclass_of($class, "Plugin")) {
137 $plugin = new $class($this);
139 $plugin_api = $plugin->api_version();
141 if ($plugin_api < PluginHost
::API_VERSION
) {
142 user_error("Plugin $class is not compatible with current API version (need: " . PluginHost
::API_VERSION
. ", got: $plugin_api)", E_USER_WARNING
);
146 $this->last_registered
= $class;
149 case $this::KIND_SYSTEM
:
150 if ($this->is_system($plugin)) {
151 $plugin->init($this);
152 $this->register_plugin($class, $plugin);
155 case $this::KIND_USER
:
156 if (!$this->is_system($plugin)) {
157 $plugin->init($this);
158 $this->register_plugin($class, $plugin);
161 case $this::KIND_ALL
:
162 $plugin->init($this);
163 $this->register_plugin($class, $plugin);
171 function is_system($plugin) {
172 $about = $plugin->about();
177 // only system plugins are allowed to modify routing
178 function add_handler($handler, $method, $sender) {
179 $handler = str_replace("-", "_", strtolower($handler));
180 $method = strtolower($method);
182 if ($this->is_system($sender)) {
183 if (!is_array($this->handlers
[$handler])) {
184 $this->handlers
[$handler] = array();
187 $this->handlers
[$handler][$method] = $sender;
191 function del_handler($handler, $method, $sender) {
192 $handler = str_replace("-", "_", strtolower($handler));
193 $method = strtolower($method);
195 if ($this->is_system($sender)) {
196 unset($this->handlers
[$handler][$method]);
200 function lookup_handler($handler, $method) {
201 $handler = str_replace("-", "_", strtolower($handler));
202 $method = strtolower($method);
204 if (is_array($this->handlers
[$handler])) {
205 if (isset($this->handlers
[$handler]["*"])) {
206 return $this->handlers
[$handler]["*"];
208 return $this->handlers
[$handler][$method];
215 function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
216 $command = str_replace("-", "_", strtolower($command));
218 $this->commands
[$command] = array("description" => $description,
220 "arghelp" => $arghelp,
224 function del_command($command) {
225 $command = "-" . strtolower($command);
227 unset($this->commands
[$command]);
230 function lookup_command($command) {
231 $command = "-" . strtolower($command);
233 if (is_array($this->commands
[$command])) {
234 return $this->commands
[$command]["class"];
242 function get_commands() {
243 return $this->commands
;
246 function run_commands($args) {
247 foreach ($this->get_commands() as $command => $data) {
248 if (isset($args[$command])) {
249 $command = str_replace("-", "", $command);
250 $data["class"]->$command($args);
255 function load_data($force = false) {
256 if ($this->owner_uid
) {
257 $result = $this->dbh
->query("SELECT name, content FROM ttrss_plugin_storage
258 WHERE owner_uid = '".$this->owner_uid
."'");
260 while ($line = $this->dbh
->fetch_assoc($result)) {
261 $this->storage
[$line["name"]] = unserialize($line["content"]);
266 private function save_data($plugin) {
267 if ($this->owner_uid
) {
268 $plugin = $this->dbh
->escape_string($plugin);
270 $this->dbh
->query("BEGIN");
272 $result = $this->dbh
->query("SELECT id FROM ttrss_plugin_storage WHERE
273 owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
275 if (!isset($this->storage
[$plugin]))
276 $this->storage
[$plugin] = array();
278 $content = $this->dbh
->escape_string(serialize($this->storage
[$plugin]),
281 if ($this->dbh
->num_rows($result) != 0) {
282 $this->dbh
->query("UPDATE ttrss_plugin_storage SET content = '$content'
283 WHERE owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
286 $this->dbh
->query("INSERT INTO ttrss_plugin_storage
287 (name,owner_uid,content) VALUES
288 ('$plugin','".$this->owner_uid
."','$content')");
291 $this->dbh
->query("COMMIT");
295 function set($sender, $name, $value, $sync = true) {
296 $idx = get_class($sender);
298 if (!isset($this->storage
[$idx]))
299 $this->storage
[$idx] = array();
301 $this->storage
[$idx][$name] = $value;
303 if ($sync) $this->save_data(get_class($sender));
306 function get($sender, $name, $default_value = false) {
307 $idx = get_class($sender);
309 if (isset($this->storage
[$idx][$name])) {
310 return $this->storage
[$idx][$name];
312 return $default_value;
316 function get_all($sender) {
317 $idx = get_class($sender);
319 return $this->storage
[$idx];
322 function clear_data($sender) {
323 if ($this->owner_uid
) {
324 $idx = get_class($sender);
326 unset($this->storage
[$idx]);
328 $this->dbh
->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
329 AND owner_uid = " . $this->owner_uid
);
333 function set_debug($debug) {
334 $this->debug
= $debug;
337 function get_debug() {
341 // Plugin feed functions are *EXPERIMENTAL*!
343 // cat_id: only -1 is supported (Special)
344 function add_feed($cat_id, $title, $icon, $sender) {
345 if (!$this->feeds
[$cat_id]) $this->feeds
[$cat_id] = array();
347 $id = count($this->feeds
[$cat_id]);
349 array_push($this->feeds
[$cat_id],
350 array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
355 function get_feeds($cat_id) {
356 return $this->feeds
[$cat_id];
359 // convert feed_id (e.g. -129) to pfeed_id first
360 function get_feed_handler($pfeed_id) {
361 foreach ($this->feeds
as $cat) {
362 foreach ($cat as $feed) {
363 if ($feed['id'] == $pfeed_id) {
364 return $feed['sender'];
370 static function pfeed_to_feed_id($label) {
371 return PLUGIN_FEED_BASE_INDEX
- 1 - abs($label);
374 static function feed_to_pfeed_id($feed) {
375 return PLUGIN_FEED_BASE_INDEX
- 1 +
abs($feed);
378 function add_api_method($name, $sender) {
379 if ($this->is_system($sender)) {
380 $this->api_methods
[strtolower($name)] = $sender;
384 function get_api_method($name) {
385 return $this->api_methods
[$name];