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;
45 const KIND_SYSTEM
= 2;
48 function __construct() {
49 $this->dbh
= Db
::get();
51 $this->storage
= array();
54 private function __clone() {
58 public static function getInstance() {
59 if (self
::$instance == null)
60 self
::$instance = new self();
62 return self
::$instance;
65 private function register_plugin($name, $plugin) {
66 //array_push($this->plugins, $plugin);
67 $this->plugins
[$name] = $plugin;
70 // needed for compatibility with API 1
79 function get_plugin_names() {
82 foreach ($this->plugins
as $p) {
83 array_push($names, get_class($p));
89 function get_plugins() {
90 return $this->plugins
;
93 function get_plugin($name) {
94 return $this->plugins
[$name];
97 function run_hooks($type, $method, $args) {
98 foreach ($this->get_hooks($type) as $hook) {
99 $hook->$method($args);
103 function add_hook($type, $sender) {
104 if (!is_array($this->hooks
[$type])) {
105 $this->hooks
[$type] = array();
108 array_push($this->hooks
[$type], $sender);
111 function del_hook($type, $sender) {
112 if (is_array($this->hooks
[$type])) {
113 $key = array_Search($sender, $this->hooks
[$type]);
114 if ($key !== FALSE) {
115 unset($this->hooks
[$type][$key]);
120 function get_hooks($type) {
121 if (isset($this->hooks
[$type])) {
122 return $this->hooks
[$type];
127 function load_all($kind, $owner_uid = false) {
128 $plugins = array_map("basename", glob("plugins/*"));
129 $this->load(join(",", $plugins), $kind, $owner_uid);
132 function load($classlist, $kind, $owner_uid = false) {
133 $plugins = explode(",", $classlist);
135 $this->owner_uid
= (int) $owner_uid;
137 foreach ($plugins as $class) {
138 $class = trim($class);
139 $class_file = strtolower(basename($class));
141 if (!is_dir(dirname(__FILE__
)."/../plugins/$class_file")) continue;
143 $file = dirname(__FILE__
)."/../plugins/$class_file/init.php";
145 if (!isset($this->plugins
[$class])) {
146 if (file_exists($file)) require_once $file;
148 if (class_exists($class) && is_subclass_of($class, "Plugin")) {
149 $plugin = new $class($this);
151 $plugin_api = $plugin->api_version();
153 if ($plugin_api < PluginHost
::API_VERSION
) {
154 user_error("Plugin $class is not compatible with current API version (need: " . PluginHost
::API_VERSION
. ", got: $plugin_api)", E_USER_WARNING
);
158 $this->last_registered
= $class;
161 case $this::KIND_SYSTEM
:
162 if ($this->is_system($plugin)) {
163 $plugin->init($this);
164 $this->register_plugin($class, $plugin);
167 case $this::KIND_USER
:
168 if (!$this->is_system($plugin)) {
169 $plugin->init($this);
170 $this->register_plugin($class, $plugin);
173 case $this::KIND_ALL
:
174 $plugin->init($this);
175 $this->register_plugin($class, $plugin);
183 function is_system($plugin) {
184 $about = $plugin->about();
189 // only system plugins are allowed to modify routing
190 function add_handler($handler, $method, $sender) {
191 $handler = str_replace("-", "_", strtolower($handler));
192 $method = strtolower($method);
194 if ($this->is_system($sender)) {
195 if (!is_array($this->handlers
[$handler])) {
196 $this->handlers
[$handler] = array();
199 $this->handlers
[$handler][$method] = $sender;
203 function del_handler($handler, $method, $sender) {
204 $handler = str_replace("-", "_", strtolower($handler));
205 $method = strtolower($method);
207 if ($this->is_system($sender)) {
208 unset($this->handlers
[$handler][$method]);
212 function lookup_handler($handler, $method) {
213 $handler = str_replace("-", "_", strtolower($handler));
214 $method = strtolower($method);
216 if (is_array($this->handlers
[$handler])) {
217 if (isset($this->handlers
[$handler]["*"])) {
218 return $this->handlers
[$handler]["*"];
220 return $this->handlers
[$handler][$method];
227 function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
228 $command = str_replace("-", "_", strtolower($command));
230 $this->commands
[$command] = array("description" => $description,
232 "arghelp" => $arghelp,
236 function del_command($command) {
237 $command = "-" . strtolower($command);
239 unset($this->commands
[$command]);
242 function lookup_command($command) {
243 $command = "-" . strtolower($command);
245 if (is_array($this->commands
[$command])) {
246 return $this->commands
[$command]["class"];
254 function get_commands() {
255 return $this->commands
;
258 function run_commands($args) {
259 foreach ($this->get_commands() as $command => $data) {
260 if (isset($args[$command])) {
261 $command = str_replace("-", "", $command);
262 $data["class"]->$command($args);
267 function load_data($force = false) {
268 if ($this->owner_uid
) {
269 $result = $this->dbh
->query("SELECT name, content FROM ttrss_plugin_storage
270 WHERE owner_uid = '".$this->owner_uid
."'");
272 while ($line = $this->dbh
->fetch_assoc($result)) {
273 $this->storage
[$line["name"]] = unserialize($line["content"]);
278 private function save_data($plugin) {
279 if ($this->owner_uid
) {
280 $plugin = $this->dbh
->escape_string($plugin);
282 $this->dbh
->query("BEGIN");
284 $result = $this->dbh
->query("SELECT id FROM ttrss_plugin_storage WHERE
285 owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
287 if (!isset($this->storage
[$plugin]))
288 $this->storage
[$plugin] = array();
290 $content = $this->dbh
->escape_string(serialize($this->storage
[$plugin]),
293 if ($this->dbh
->num_rows($result) != 0) {
294 $this->dbh
->query("UPDATE ttrss_plugin_storage SET content = '$content'
295 WHERE owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
298 $this->dbh
->query("INSERT INTO ttrss_plugin_storage
299 (name,owner_uid,content) VALUES
300 ('$plugin','".$this->owner_uid
."','$content')");
303 $this->dbh
->query("COMMIT");
307 function set($sender, $name, $value, $sync = true) {
308 $idx = get_class($sender);
310 if (!isset($this->storage
[$idx]))
311 $this->storage
[$idx] = array();
313 $this->storage
[$idx][$name] = $value;
315 if ($sync) $this->save_data(get_class($sender));
318 function get($sender, $name, $default_value = false) {
319 $idx = get_class($sender);
321 if (isset($this->storage
[$idx][$name])) {
322 return $this->storage
[$idx][$name];
324 return $default_value;
328 function get_all($sender) {
329 $idx = get_class($sender);
331 return $this->storage
[$idx];
334 function clear_data($sender) {
335 if ($this->owner_uid
) {
336 $idx = get_class($sender);
338 unset($this->storage
[$idx]);
340 $this->dbh
->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
341 AND owner_uid = " . $this->owner_uid
);
345 function set_debug($debug) {
346 $this->debug
= $debug;
349 function get_debug() {
353 // Plugin feed functions are *EXPERIMENTAL*!
355 // cat_id: only -1 is supported (Special)
356 function add_feed($cat_id, $title, $icon, $sender) {
357 if (!$this->feeds
[$cat_id]) $this->feeds
[$cat_id] = array();
359 $id = count($this->feeds
[$cat_id]);
361 array_push($this->feeds
[$cat_id],
362 array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
367 function get_feeds($cat_id) {
368 return $this->feeds
[$cat_id];
371 // convert feed_id (e.g. -129) to pfeed_id first
372 function get_feed_handler($pfeed_id) {
373 foreach ($this->feeds
as $cat) {
374 foreach ($cat as $feed) {
375 if ($feed['id'] == $pfeed_id) {
376 return $feed['sender'];
382 static function pfeed_to_feed_id($label) {
383 return PLUGIN_FEED_BASE_INDEX
- 1 - abs($label);
386 static function feed_to_pfeed_id($feed) {
387 return PLUGIN_FEED_BASE_INDEX
- 1 +
abs($feed);
390 function add_api_method($name, $sender) {
391 if ($this->is_system($sender)) {
392 $this->api_methods
[strtolower($name)] = $sender;
396 function get_api_method($name) {
397 return $this->api_methods
[$name];