]>
Commit | Line | Data |
---|---|---|
19c73507 AD |
1 | <?php |
2 | class PluginHost { | |
6322ac79 | 3 | private $dbh; |
19c73507 AD |
4 | private $hooks = array(); |
5 | private $plugins = array(); | |
8dcb2b47 | 6 | private $handlers = array(); |
73f28fe9 | 7 | private $commands = array(); |
d8a1d2a2 | 8 | private $storage = array(); |
a413f53e | 9 | private $feeds = array(); |
79f9bef7 | 10 | private $api_methods = array(); |
b8774453 | 11 | private $plugin_actions = array(); |
d8a1d2a2 | 12 | private $owner_uid; |
be178857 | 13 | private $debug; |
726bd48e | 14 | private $last_registered; |
1ffe3391 | 15 | private static $instance; |
19c73507 | 16 | |
106a3de9 | 17 | const API_VERSION = 2; |
ddf28801 | 18 | |
5914f319 AD |
19 | // Hooks marked with *1 are run in global context and available |
20 | // to plugins loaded in config.php only | |
21 | ||
19c73507 AD |
22 | const HOOK_ARTICLE_BUTTON = 1; |
23 | const HOOK_ARTICLE_FILTER = 2; | |
6065f3ad | 24 | const HOOK_PREFS_TAB = 3; |
699daf58 | 25 | const HOOK_PREFS_TAB_SECTION = 4; |
6cbe53c9 | 26 | const HOOK_PREFS_TABS = 5; |
4412b877 | 27 | const HOOK_FEED_PARSED = 6; |
5914f319 | 28 | const HOOK_UPDATE_TASK = 7; // *1 |
0f28f81f | 29 | const HOOK_AUTH_USER = 8; |
e218c5f5 | 30 | const HOOK_HOTKEY_MAP = 9; |
84d952f1 AD |
31 | const HOOK_RENDER_ARTICLE = 10; |
32 | const HOOK_RENDER_ARTICLE_CDM = 11; | |
017401dd | 33 | const HOOK_FEED_FETCHED = 12; |
e9b86f0a | 34 | const HOOK_SANITIZE = 13; |
b6604c96 | 35 | const HOOK_RENDER_ARTICLE_API = 14; |
ceb78471 AD |
36 | const HOOK_TOOLBAR_BUTTON = 15; |
37 | const HOOK_ACTION_ITEM = 16; | |
38 | const HOOK_HEADLINE_TOOLBAR_BUTTON = 17; | |
47854200 | 39 | const HOOK_HOTKEY_INFO = 18; |
ccb2b8dd | 40 | const HOOK_ARTICLE_LEFT_BUTTON = 19; |
057177eb | 41 | const HOOK_PREFS_EDIT_FEED = 20; |
8cefe38a | 42 | const HOOK_PREFS_SAVE_FEED = 21; |
ee65bef4 | 43 | const HOOK_FETCH_FEED = 22; |
891e36f5 | 44 | const HOOK_QUERY_HEADLINES = 23; |
5914f319 | 45 | const HOOK_HOUSE_KEEPING = 24; // *1 |
baaf4c30 | 46 | const HOOK_SEARCH = 25; |
2bb11658 | 47 | const HOOK_FORMAT_ENCLOSURES = 26; |
01465325 | 48 | const HOOK_SUBSCRIBE_FEED = 27; |
7eb87b80 | 49 | const HOOK_HEADLINES_BEFORE = 28; |
945346cb | 50 | const HOOK_RENDER_ENCLOSURE = 29; |
b8774453 | 51 | const HOOK_ARTICLE_FILTER_ACTION = 30; |
399678a1 | 52 | const HOOK_ARTICLE_EXPORT_FEED = 31; |
6293d371 | 53 | const HOOK_MAIN_TOOLBAR_BUTTON = 32; |
58210301 | 54 | const HOOK_ENCLOSURE_ENTRY = 33; |
e50a6479 AD |
55 | const HOOK_FORMAT_ARTICLE = 34; |
56 | const HOOK_FORMAT_ARTICLE_CDM = 35; | |
bec5ba93 | 57 | const HOOK_FEED_BASIC_INFO = 36; |
19c73507 | 58 | |
d2a421e3 AD |
59 | const KIND_ALL = 1; |
60 | const KIND_SYSTEM = 2; | |
61 | const KIND_USER = 3; | |
62 | ||
48ed517e | 63 | function __construct() { |
1ffe3391 | 64 | $this->dbh = Db::get(); |
d8a1d2a2 | 65 | |
d48398e6 | 66 | $this->storage = array(); |
19c73507 AD |
67 | } |
68 | ||
1ffe3391 AD |
69 | private function __clone() { |
70 | // | |
71 | } | |
72 | ||
73 | public static function getInstance() { | |
74 | if (self::$instance == null) | |
75 | self::$instance = new self(); | |
76 | ||
77 | return self::$instance; | |
78 | } | |
79 | ||
19c73507 AD |
80 | private function register_plugin($name, $plugin) { |
81 | //array_push($this->plugins, $plugin); | |
82 | $this->plugins[$name] = $plugin; | |
83 | } | |
84 | ||
106a3de9 | 85 | // needed for compatibility with API 1 |
726bd48e | 86 | function get_link() { |
106a3de9 | 87 | return false; |
726bd48e AD |
88 | } |
89 | ||
6322ac79 AD |
90 | function get_dbh() { |
91 | return $this->dbh; | |
19c73507 AD |
92 | } |
93 | ||
84e36b61 AD |
94 | function get_plugin_names() { |
95 | $names = array(); | |
96 | ||
97 | foreach ($this->plugins as $p) { | |
98 | array_push($names, get_class($p)); | |
99 | } | |
100 | ||
101 | return $names; | |
102 | } | |
103 | ||
19c73507 AD |
104 | function get_plugins() { |
105 | return $this->plugins; | |
106 | } | |
107 | ||
108 | function get_plugin($name) { | |
b8774453 | 109 | return $this->plugins[strtolower($name)]; |
19c73507 AD |
110 | } |
111 | ||
6065f3ad AD |
112 | function run_hooks($type, $method, $args) { |
113 | foreach ($this->get_hooks($type) as $hook) { | |
114 | $hook->$method($args); | |
115 | } | |
116 | } | |
117 | ||
19c73507 AD |
118 | function add_hook($type, $sender) { |
119 | if (!is_array($this->hooks[$type])) { | |
120 | $this->hooks[$type] = array(); | |
121 | } | |
122 | ||
123 | array_push($this->hooks[$type], $sender); | |
124 | } | |
125 | ||
126 | function del_hook($type, $sender) { | |
127 | if (is_array($this->hooks[$type])) { | |
a96bb3d8 | 128 | $key = array_Search($sender, $this->hooks[$type]); |
19c73507 AD |
129 | if ($key !== FALSE) { |
130 | unset($this->hooks[$type][$key]); | |
131 | } | |
132 | } | |
133 | } | |
134 | ||
135 | function get_hooks($type) { | |
19b3992b AD |
136 | if (isset($this->hooks[$type])) { |
137 | return $this->hooks[$type]; | |
138 | } else { | |
139 | return array(); | |
140 | } | |
19c73507 | 141 | } |
583f163f | 142 | function load_all($kind, $owner_uid = false, $skip_init = false) { |
7c0a2ab2 | 143 | |
ca5d39e8 AD |
144 | $plugins = array_merge(glob("plugins/*"), glob("plugins.local/*")); |
145 | $plugins = array_filter($plugins, "is_dir"); | |
146 | $plugins = array_map("basename", $plugins); | |
7c0a2ab2 AD |
147 | |
148 | asort($plugins); | |
149 | ||
583f163f | 150 | $this->load(join(",", $plugins), $kind, $owner_uid, $skip_init); |
7a866114 | 151 | } |
19c73507 | 152 | |
583f163f | 153 | function load($classlist, $kind, $owner_uid = false, $skip_init = false) { |
19c73507 AD |
154 | $plugins = explode(",", $classlist); |
155 | ||
d8a1d2a2 AD |
156 | $this->owner_uid = (int) $owner_uid; |
157 | ||
19c73507 AD |
158 | foreach ($plugins as $class) { |
159 | $class = trim($class); | |
8dcb2b47 | 160 | $class_file = strtolower(basename($class)); |
b8c7f835 | 161 | |
7c0a2ab2 AD |
162 | if (!is_dir(__DIR__."/../plugins/$class_file") && |
163 | !is_dir(__DIR__."/../plugins.local/$class_file")) continue; | |
164 | ||
165 | // try system plugin directory first | |
166 | $file = __DIR__ . "/../plugins/$class_file/init.php"; | |
b8c7f835 | 167 | |
7c0a2ab2 AD |
168 | if (!file_exists($file)) { |
169 | $file = __DIR__ . "/../plugins.local/$class_file/init.php"; | |
170 | } | |
19c73507 | 171 | |
de612e7a AD |
172 | if (!isset($this->plugins[$class])) { |
173 | if (file_exists($file)) require_once $file; | |
19c73507 | 174 | |
de612e7a AD |
175 | if (class_exists($class) && is_subclass_of($class, "Plugin")) { |
176 | $plugin = new $class($this); | |
19c73507 | 177 | |
ddf28801 AD |
178 | $plugin_api = $plugin->api_version(); |
179 | ||
180 | if ($plugin_api < PluginHost::API_VERSION) { | |
181 | user_error("Plugin $class is not compatible with current API version (need: " . PluginHost::API_VERSION . ", got: $plugin_api)", E_USER_WARNING); | |
182 | continue; | |
183 | } | |
184 | ||
726bd48e AD |
185 | $this->last_registered = $class; |
186 | ||
d2a421e3 AD |
187 | switch ($kind) { |
188 | case $this::KIND_SYSTEM: | |
189 | if ($this->is_system($plugin)) { | |
583f163f | 190 | if (!$skip_init) $plugin->init($this); |
d2a421e3 AD |
191 | $this->register_plugin($class, $plugin); |
192 | } | |
193 | break; | |
194 | case $this::KIND_USER: | |
195 | if (!$this->is_system($plugin)) { | |
583f163f | 196 | if (!$skip_init) $plugin->init($this); |
d2a421e3 AD |
197 | $this->register_plugin($class, $plugin); |
198 | } | |
199 | break; | |
200 | case $this::KIND_ALL: | |
583f163f | 201 | if (!$skip_init) $plugin->init($this); |
d2a421e3 AD |
202 | $this->register_plugin($class, $plugin); |
203 | break; | |
204 | } | |
de612e7a | 205 | } |
19c73507 AD |
206 | } |
207 | } | |
208 | } | |
209 | ||
de612e7a | 210 | function is_system($plugin) { |
d2a421e3 | 211 | $about = $plugin->about(); |
de612e7a AD |
212 | |
213 | return @$about[3]; | |
214 | } | |
215 | ||
216 | // only system plugins are allowed to modify routing | |
8dcb2b47 | 217 | function add_handler($handler, $method, $sender) { |
6cbe53c9 | 218 | $handler = str_replace("-", "_", strtolower($handler)); |
8dcb2b47 AD |
219 | $method = strtolower($method); |
220 | ||
de612e7a AD |
221 | if ($this->is_system($sender)) { |
222 | if (!is_array($this->handlers[$handler])) { | |
223 | $this->handlers[$handler] = array(); | |
224 | } | |
8dcb2b47 | 225 | |
de612e7a AD |
226 | $this->handlers[$handler][$method] = $sender; |
227 | } | |
8dcb2b47 AD |
228 | } |
229 | ||
6f7798b6 | 230 | function del_handler($handler, $method, $sender) { |
6cbe53c9 | 231 | $handler = str_replace("-", "_", strtolower($handler)); |
8dcb2b47 AD |
232 | $method = strtolower($method); |
233 | ||
de612e7a AD |
234 | if ($this->is_system($sender)) { |
235 | unset($this->handlers[$handler][$method]); | |
236 | } | |
8dcb2b47 AD |
237 | } |
238 | ||
239 | function lookup_handler($handler, $method) { | |
6cbe53c9 | 240 | $handler = str_replace("-", "_", strtolower($handler)); |
8dcb2b47 AD |
241 | $method = strtolower($method); |
242 | ||
243 | if (is_array($this->handlers[$handler])) { | |
6cbe53c9 AD |
244 | if (isset($this->handlers[$handler]["*"])) { |
245 | return $this->handlers[$handler]["*"]; | |
246 | } else { | |
247 | return $this->handlers[$handler][$method]; | |
248 | } | |
8dcb2b47 AD |
249 | } |
250 | ||
251 | return false; | |
252 | } | |
73f28fe9 | 253 | |
4cf0f9a9 | 254 | function add_command($command, $description, $sender, $suffix = "", $arghelp = "") { |
764555ff | 255 | $command = str_replace("-", "_", strtolower($command)); |
73f28fe9 | 256 | |
d2a421e3 | 257 | $this->commands[$command] = array("description" => $description, |
4cf0f9a9 AD |
258 | "suffix" => $suffix, |
259 | "arghelp" => $arghelp, | |
d2a421e3 | 260 | "class" => $sender); |
73f28fe9 AD |
261 | } |
262 | ||
263 | function del_command($command) { | |
264 | $command = "-" . strtolower($command); | |
265 | ||
d2a421e3 | 266 | unset($this->commands[$command]); |
73f28fe9 AD |
267 | } |
268 | ||
269 | function lookup_command($command) { | |
270 | $command = "-" . strtolower($command); | |
271 | ||
272 | if (is_array($this->commands[$command])) { | |
273 | return $this->commands[$command]["class"]; | |
274 | } else { | |
275 | return false; | |
276 | } | |
277 | ||
278 | return false; | |
279 | } | |
280 | ||
281 | function get_commands() { | |
282 | return $this->commands; | |
283 | } | |
284 | ||
285 | function run_commands($args) { | |
286 | foreach ($this->get_commands() as $command => $data) { | |
764555ff | 287 | if (isset($args[$command])) { |
73f28fe9 AD |
288 | $command = str_replace("-", "", $command); |
289 | $data["class"]->$command($args); | |
290 | } | |
291 | } | |
292 | } | |
293 | ||
7b55001e | 294 | function load_data() { |
d48398e6 | 295 | if ($this->owner_uid) { |
d9c85e0f | 296 | $result = $this->dbh->query("SELECT name, content FROM ttrss_plugin_storage |
d8a1d2a2 AD |
297 | WHERE owner_uid = '".$this->owner_uid."'"); |
298 | ||
d9c85e0f | 299 | while ($line = $this->dbh->fetch_assoc($result)) { |
d8a1d2a2 AD |
300 | $this->storage[$line["name"]] = unserialize($line["content"]); |
301 | } | |
d8a1d2a2 AD |
302 | } |
303 | } | |
304 | ||
305 | private function save_data($plugin) { | |
306 | if ($this->owner_uid) { | |
d9c85e0f | 307 | $plugin = $this->dbh->escape_string($plugin); |
d8a1d2a2 | 308 | |
d9c85e0f | 309 | $this->dbh->query("BEGIN"); |
d8a1d2a2 | 310 | |
d9c85e0f | 311 | $result = $this->dbh->query("SELECT id FROM ttrss_plugin_storage WHERE |
d8a1d2a2 AD |
312 | owner_uid= '".$this->owner_uid."' AND name = '$plugin'"); |
313 | ||
314 | if (!isset($this->storage[$plugin])) | |
315 | $this->storage[$plugin] = array(); | |
316 | ||
14c84904 AD |
317 | $content = $this->dbh->escape_string(serialize($this->storage[$plugin]), |
318 | false); | |
d8a1d2a2 | 319 | |
d9c85e0f AD |
320 | if ($this->dbh->num_rows($result) != 0) { |
321 | $this->dbh->query("UPDATE ttrss_plugin_storage SET content = '$content' | |
d8a1d2a2 AD |
322 | WHERE owner_uid= '".$this->owner_uid."' AND name = '$plugin'"); |
323 | ||
324 | } else { | |
d9c85e0f | 325 | $this->dbh->query("INSERT INTO ttrss_plugin_storage |
d8a1d2a2 AD |
326 | (name,owner_uid,content) VALUES |
327 | ('$plugin','".$this->owner_uid."','$content')"); | |
328 | } | |
329 | ||
d9c85e0f | 330 | $this->dbh->query("COMMIT"); |
d8a1d2a2 AD |
331 | } |
332 | } | |
333 | ||
334 | function set($sender, $name, $value, $sync = true) { | |
335 | $idx = get_class($sender); | |
336 | ||
337 | if (!isset($this->storage[$idx])) | |
338 | $this->storage[$idx] = array(); | |
339 | ||
340 | $this->storage[$idx][$name] = $value; | |
341 | ||
d8a1d2a2 AD |
342 | if ($sync) $this->save_data(get_class($sender)); |
343 | } | |
344 | ||
5d9abb1e | 345 | function get($sender, $name, $default_value = false) { |
d8a1d2a2 AD |
346 | $idx = get_class($sender); |
347 | ||
348 | if (isset($this->storage[$idx][$name])) { | |
349 | return $this->storage[$idx][$name]; | |
350 | } else { | |
351 | return $default_value; | |
352 | } | |
353 | } | |
354 | ||
355 | function get_all($sender) { | |
356 | $idx = get_class($sender); | |
357 | ||
358 | return $this->storage[$idx]; | |
359 | } | |
5d9abb1e AD |
360 | |
361 | function clear_data($sender) { | |
362 | if ($this->owner_uid) { | |
363 | $idx = get_class($sender); | |
364 | ||
365 | unset($this->storage[$idx]); | |
366 | ||
d9c85e0f | 367 | $this->dbh->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx' |
5d9abb1e | 368 | AND owner_uid = " . $this->owner_uid); |
5d9abb1e AD |
369 | } |
370 | } | |
be178857 AD |
371 | |
372 | function set_debug($debug) { | |
373 | $this->debug = $debug; | |
374 | } | |
375 | ||
376 | function get_debug() { | |
377 | return $this->debug; | |
378 | } | |
a413f53e AD |
379 | |
380 | // Plugin feed functions are *EXPERIMENTAL*! | |
381 | ||
382 | // cat_id: only -1 is supported (Special) | |
383 | function add_feed($cat_id, $title, $icon, $sender) { | |
384 | if (!$this->feeds[$cat_id]) $this->feeds[$cat_id] = array(); | |
385 | ||
386 | $id = count($this->feeds[$cat_id]); | |
387 | ||
388 | array_push($this->feeds[$cat_id], | |
389 | array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon)); | |
390 | ||
391 | return $id; | |
392 | } | |
393 | ||
394 | function get_feeds($cat_id) { | |
395 | return $this->feeds[$cat_id]; | |
396 | } | |
397 | ||
398 | // convert feed_id (e.g. -129) to pfeed_id first | |
399 | function get_feed_handler($pfeed_id) { | |
400 | foreach ($this->feeds as $cat) { | |
401 | foreach ($cat as $feed) { | |
402 | if ($feed['id'] == $pfeed_id) { | |
403 | return $feed['sender']; | |
404 | } | |
405 | } | |
406 | } | |
407 | } | |
408 | ||
409 | static function pfeed_to_feed_id($label) { | |
410 | return PLUGIN_FEED_BASE_INDEX - 1 - abs($label); | |
411 | } | |
412 | ||
413 | static function feed_to_pfeed_id($feed) { | |
414 | return PLUGIN_FEED_BASE_INDEX - 1 + abs($feed); | |
415 | } | |
416 | ||
79f9bef7 AD |
417 | function add_api_method($name, $sender) { |
418 | if ($this->is_system($sender)) { | |
419 | $this->api_methods[strtolower($name)] = $sender; | |
420 | } | |
421 | } | |
422 | ||
423 | function get_api_method($name) { | |
424 | return $this->api_methods[$name]; | |
425 | } | |
b8774453 AD |
426 | |
427 | function add_filter_action($sender, $action_name, $action_desc) { | |
428 | $sender_class = get_class($sender); | |
429 | ||
430 | if (!isset($this->plugin_actions[$sender_class])) | |
431 | $this->plugin_actions[$sender_class] = array(); | |
432 | ||
433 | array_push($this->plugin_actions[$sender_class], | |
434 | array("action" => $action_name, "description" => $action_desc, "sender" => $sender)); | |
435 | } | |
436 | ||
437 | function get_filter_actions() { | |
438 | return $this->plugin_actions; | |
439 | } | |
bec5ba93 | 440 | } |