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;
39 const KIND_SYSTEM
= 2;
42 function __construct() {
43 $this->dbh
= Db
::get();
44 $this->storage
= $_SESSION["plugin_storage"];
46 if (!$this->storage
) $this->storage
= array();
49 private function __clone() {
53 public static function getInstance() {
54 if (self
::$instance == null)
55 self
::$instance = new self();
57 return self
::$instance;
60 private function register_plugin($name, $plugin) {
61 //array_push($this->plugins, $plugin);
62 $this->plugins
[$name] = $plugin;
65 // needed for compatibility with API 1
74 function get_plugins() {
75 return $this->plugins
;
78 function get_plugin($name) {
79 return $this->plugins
[$name];
82 function run_hooks($type, $method, $args) {
83 foreach ($this->get_hooks($type) as $hook) {
84 $hook->$method($args);
88 function add_hook($type, $sender) {
89 if (!is_array($this->hooks
[$type])) {
90 $this->hooks
[$type] = array();
93 array_push($this->hooks
[$type], $sender);
96 function del_hook($type, $sender) {
97 if (is_array($this->hooks
[$type])) {
98 $key = array_Search($this->hooks
[$type], $sender);
100 unset($this->hooks
[$type][$key]);
105 function get_hooks($type) {
106 if (isset($this->hooks
[$type])) {
107 return $this->hooks
[$type];
112 function load_all($kind, $owner_uid = false) {
113 $plugins = array_map("basename", glob("plugins/*"));
114 $this->load(join(",", $plugins), $kind, $owner_uid);
117 function load($classlist, $kind, $owner_uid = false) {
118 $plugins = explode(",", $classlist);
120 $this->owner_uid
= (int) $owner_uid;
122 foreach ($plugins as $class) {
123 $class = trim($class);
124 $class_file = strtolower(basename($class));
126 if (!is_dir(dirname(__FILE__
)."/../plugins/$class_file")) continue;
128 $file = dirname(__FILE__
)."/../plugins/$class_file/init.php";
130 if (!isset($this->plugins
[$class])) {
131 if (file_exists($file)) require_once $file;
133 if (class_exists($class) && is_subclass_of($class, "Plugin")) {
134 $plugin = new $class($this);
136 $plugin_api = $plugin->api_version();
138 if ($plugin_api < PluginHost
::API_VERSION
) {
139 user_error("Plugin $class is not compatible with current API version (need: " . PluginHost
::API_VERSION
. ", got: $plugin_api)", E_USER_WARNING
);
143 $this->last_registered
= $class;
146 case $this::KIND_SYSTEM
:
147 if ($this->is_system($plugin)) {
148 $plugin->init($this);
149 $this->register_plugin($class, $plugin);
152 case $this::KIND_USER
:
153 if (!$this->is_system($plugin)) {
154 $plugin->init($this);
155 $this->register_plugin($class, $plugin);
158 case $this::KIND_ALL
:
159 $plugin->init($this);
160 $this->register_plugin($class, $plugin);
168 function is_system($plugin) {
169 $about = $plugin->about();
174 // only system plugins are allowed to modify routing
175 function add_handler($handler, $method, $sender) {
176 $handler = str_replace("-", "_", strtolower($handler));
177 $method = strtolower($method);
179 if ($this->is_system($sender)) {
180 if (!is_array($this->handlers
[$handler])) {
181 $this->handlers
[$handler] = array();
184 $this->handlers
[$handler][$method] = $sender;
188 function del_handler($handler, $method) {
189 $handler = str_replace("-", "_", strtolower($handler));
190 $method = strtolower($method);
192 if ($this->is_system($sender)) {
193 unset($this->handlers
[$handler][$method]);
197 function lookup_handler($handler, $method) {
198 $handler = str_replace("-", "_", strtolower($handler));
199 $method = strtolower($method);
201 if (is_array($this->handlers
[$handler])) {
202 if (isset($this->handlers
[$handler]["*"])) {
203 return $this->handlers
[$handler]["*"];
205 return $this->handlers
[$handler][$method];
212 function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
213 $command = str_replace("-", "_", strtolower($command));
215 $this->commands
[$command] = array("description" => $description,
217 "arghelp" => $arghelp,
221 function del_command($command) {
222 $command = "-" . strtolower($command);
224 unset($this->commands
[$command]);
227 function lookup_command($command) {
228 $command = "-" . strtolower($command);
230 if (is_array($this->commands
[$command])) {
231 return $this->commands
[$command]["class"];
239 function get_commands() {
240 return $this->commands
;
243 function run_commands($args) {
244 foreach ($this->get_commands() as $command => $data) {
245 if (isset($args[$command])) {
246 $command = str_replace("-", "", $command);
247 $data["class"]->$command($args);
252 function load_data($force = false) {
253 if ($this->owner_uid
&& (!$_SESSION["plugin_storage"] ||
$force)) {
254 $plugin = $this->dbh
->escape_string($plugin);
256 $result = $this->dbh
->query("SELECT name, content FROM ttrss_plugin_storage
257 WHERE owner_uid = '".$this->owner_uid
."'");
259 while ($line = $this->dbh
->fetch_assoc($result)) {
260 $this->storage
[$line["name"]] = unserialize($line["content"]);
263 $_SESSION["plugin_storage"] = $this->storage
;
267 private function save_data($plugin) {
268 if ($this->owner_uid
) {
269 $plugin = $this->dbh
->escape_string($plugin);
271 $this->dbh
->query("BEGIN");
273 $result = $this->dbh
->query("SELECT id FROM ttrss_plugin_storage WHERE
274 owner_uid= '".$this->owner_uid
."' AND name = '$plugin'");
276 if (!isset($this->storage
[$plugin]))
277 $this->storage
[$plugin] = array();
279 $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 $_SESSION["plugin_storage"] = $this->storage
;
305 if ($sync) $this->save_data(get_class($sender));
308 function get($sender, $name, $default_value = false) {
309 $idx = get_class($sender);
311 if (isset($this->storage
[$idx][$name])) {
312 return $this->storage
[$idx][$name];
314 return $default_value;
318 function get_all($sender) {
319 $idx = get_class($sender);
321 return $this->storage
[$idx];
324 function clear_data($sender) {
325 if ($this->owner_uid
) {
326 $idx = get_class($sender);
328 unset($this->storage
[$idx]);
330 $this->dbh
->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
331 AND owner_uid = " . $this->owner_uid
);
333 $_SESSION["plugin_storage"] = $this->storage
;
337 function set_debug($debug) {
338 $this->debug
= $debug;
341 function get_debug() {
345 // Plugin feed functions are *EXPERIMENTAL*!
347 // cat_id: only -1 is supported (Special)
348 function add_feed($cat_id, $title, $icon, $sender) {
349 if (!$this->feeds
[$cat_id]) $this->feeds
[$cat_id] = array();
351 $id = count($this->feeds
[$cat_id]);
353 array_push($this->feeds
[$cat_id],
354 array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
359 function get_feeds($cat_id) {
360 return $this->feeds
[$cat_id];
363 // convert feed_id (e.g. -129) to pfeed_id first
364 function get_feed_handler($pfeed_id) {
365 foreach ($this->feeds
as $cat) {
366 foreach ($cat as $feed) {
367 if ($feed['id'] == $pfeed_id) {
368 return $feed['sender'];
374 static function pfeed_to_feed_id($label) {
375 return PLUGIN_FEED_BASE_INDEX
- 1 - abs($label);
378 static function feed_to_pfeed_id($feed) {
379 return PLUGIN_FEED_BASE_INDEX
- 1 +
abs($feed);
382 function add_api_method($name, $sender) {
383 if ($this->is_system($sender)) {
384 $this->api_methods
[strtolower($name)] = $sender;
388 function get_api_method($name) {
389 return $this->api_methods
[$name];