]>
Commit | Line | Data |
---|---|---|
19c73507 AD |
1 | <?php |
2 | class PluginHost { | |
8af94f12 | 3 | private $pdo; |
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; |
8b73bd28 | 58 | const HOOK_SEND_LOCAL_FILE = 37; |
53955264 | 59 | const HOOK_UNSUBSCRIBE_FEED = 38; |
19c73507 | 60 | |
d2a421e3 AD |
61 | const KIND_ALL = 1; |
62 | const KIND_SYSTEM = 2; | |
63 | const KIND_USER = 3; | |
64 | ||
48ed517e | 65 | function __construct() { |
8af94f12 | 66 | $this->pdo = Db::pdo(); |
d8a1d2a2 | 67 | |
d48398e6 | 68 | $this->storage = array(); |
19c73507 AD |
69 | } |
70 | ||
1ffe3391 AD |
71 | private function __clone() { |
72 | // | |
73 | } | |
74 | ||
75 | public static function getInstance() { | |
76 | if (self::$instance == null) | |
77 | self::$instance = new self(); | |
78 | ||
79 | return self::$instance; | |
80 | } | |
81 | ||
19c73507 AD |
82 | private function register_plugin($name, $plugin) { |
83 | //array_push($this->plugins, $plugin); | |
84 | $this->plugins[$name] = $plugin; | |
85 | } | |
86 | ||
106a3de9 | 87 | // needed for compatibility with API 1 |
726bd48e | 88 | function get_link() { |
106a3de9 | 89 | return false; |
726bd48e AD |
90 | } |
91 | ||
6322ac79 | 92 | function get_dbh() { |
df5d2a06 | 93 | return Db::get(); |
19c73507 AD |
94 | } |
95 | ||
8af94f12 AD |
96 | function get_pdo() { |
97 | return $this->pdo; | |
98 | } | |
99 | ||
84e36b61 AD |
100 | function get_plugin_names() { |
101 | $names = array(); | |
102 | ||
103 | foreach ($this->plugins as $p) { | |
104 | array_push($names, get_class($p)); | |
105 | } | |
106 | ||
107 | return $names; | |
108 | } | |
109 | ||
19c73507 AD |
110 | function get_plugins() { |
111 | return $this->plugins; | |
112 | } | |
113 | ||
114 | function get_plugin($name) { | |
b8774453 | 115 | return $this->plugins[strtolower($name)]; |
19c73507 AD |
116 | } |
117 | ||
6065f3ad AD |
118 | function run_hooks($type, $method, $args) { |
119 | foreach ($this->get_hooks($type) as $hook) { | |
120 | $hook->$method($args); | |
121 | } | |
122 | } | |
123 | ||
19c73507 AD |
124 | function add_hook($type, $sender) { |
125 | if (!is_array($this->hooks[$type])) { | |
126 | $this->hooks[$type] = array(); | |
127 | } | |
128 | ||
129 | array_push($this->hooks[$type], $sender); | |
130 | } | |
131 | ||
132 | function del_hook($type, $sender) { | |
133 | if (is_array($this->hooks[$type])) { | |
a96bb3d8 | 134 | $key = array_Search($sender, $this->hooks[$type]); |
19c73507 AD |
135 | if ($key !== FALSE) { |
136 | unset($this->hooks[$type][$key]); | |
137 | } | |
138 | } | |
139 | } | |
140 | ||
141 | function get_hooks($type) { | |
19b3992b AD |
142 | if (isset($this->hooks[$type])) { |
143 | return $this->hooks[$type]; | |
144 | } else { | |
145 | return array(); | |
146 | } | |
19c73507 | 147 | } |
583f163f | 148 | function load_all($kind, $owner_uid = false, $skip_init = false) { |
7c0a2ab2 | 149 | |
ca5d39e8 AD |
150 | $plugins = array_merge(glob("plugins/*"), glob("plugins.local/*")); |
151 | $plugins = array_filter($plugins, "is_dir"); | |
152 | $plugins = array_map("basename", $plugins); | |
7c0a2ab2 AD |
153 | |
154 | asort($plugins); | |
155 | ||
583f163f | 156 | $this->load(join(",", $plugins), $kind, $owner_uid, $skip_init); |
7a866114 | 157 | } |
19c73507 | 158 | |
583f163f | 159 | function load($classlist, $kind, $owner_uid = false, $skip_init = false) { |
19c73507 AD |
160 | $plugins = explode(",", $classlist); |
161 | ||
d8a1d2a2 AD |
162 | $this->owner_uid = (int) $owner_uid; |
163 | ||
19c73507 AD |
164 | foreach ($plugins as $class) { |
165 | $class = trim($class); | |
8dcb2b47 | 166 | $class_file = strtolower(basename($class)); |
b8c7f835 | 167 | |
7c0a2ab2 AD |
168 | if (!is_dir(__DIR__."/../plugins/$class_file") && |
169 | !is_dir(__DIR__."/../plugins.local/$class_file")) continue; | |
170 | ||
171 | // try system plugin directory first | |
172 | $file = __DIR__ . "/../plugins/$class_file/init.php"; | |
32c0c07c | 173 | $vendor_dir = __DIR__ . "/../plugins/$class_file/vendor"; |
b8c7f835 | 174 | |
7c0a2ab2 AD |
175 | if (!file_exists($file)) { |
176 | $file = __DIR__ . "/../plugins.local/$class_file/init.php"; | |
32c0c07c | 177 | $vendor_dir = __DIR__ . "/../plugins.local/$class_file/vendor"; |
7c0a2ab2 | 178 | } |
19c73507 | 179 | |
de612e7a AD |
180 | if (!isset($this->plugins[$class])) { |
181 | if (file_exists($file)) require_once $file; | |
19c73507 | 182 | |
de612e7a | 183 | if (class_exists($class) && is_subclass_of($class, "Plugin")) { |
32c0c07c AD |
184 | |
185 | // register plugin autoloader if necessary, for namespaced classes ONLY | |
186 | // layout corresponds to tt-rss main /vendor/author/Package/Class.php | |
187 | ||
188 | if (file_exists($vendor_dir)) { | |
189 | spl_autoload_register(function($class) use ($vendor_dir) { | |
190 | ||
191 | if (strpos($class, '\\') !== FALSE) { | |
192 | list ($namespace, $class_name) = explode('\\', $class, 2); | |
193 | ||
194 | if ($namespace && $class_name) { | |
195 | $class_file = "$vendor_dir/$namespace/" . str_replace('\\', '/', $class_name) . ".php"; | |
196 | ||
197 | if (file_exists($class_file)) | |
198 | require_once $class_file; | |
199 | } | |
200 | } | |
201 | }); | |
202 | } | |
203 | ||
de612e7a | 204 | $plugin = new $class($this); |
19c73507 | 205 | |
ddf28801 AD |
206 | $plugin_api = $plugin->api_version(); |
207 | ||
208 | if ($plugin_api < PluginHost::API_VERSION) { | |
209 | user_error("Plugin $class is not compatible with current API version (need: " . PluginHost::API_VERSION . ", got: $plugin_api)", E_USER_WARNING); | |
210 | continue; | |
211 | } | |
212 | ||
726bd48e AD |
213 | $this->last_registered = $class; |
214 | ||
d2a421e3 AD |
215 | switch ($kind) { |
216 | case $this::KIND_SYSTEM: | |
217 | if ($this->is_system($plugin)) { | |
583f163f | 218 | if (!$skip_init) $plugin->init($this); |
d2a421e3 AD |
219 | $this->register_plugin($class, $plugin); |
220 | } | |
221 | break; | |
222 | case $this::KIND_USER: | |
223 | if (!$this->is_system($plugin)) { | |
583f163f | 224 | if (!$skip_init) $plugin->init($this); |
d2a421e3 AD |
225 | $this->register_plugin($class, $plugin); |
226 | } | |
227 | break; | |
228 | case $this::KIND_ALL: | |
583f163f | 229 | if (!$skip_init) $plugin->init($this); |
d2a421e3 AD |
230 | $this->register_plugin($class, $plugin); |
231 | break; | |
232 | } | |
de612e7a | 233 | } |
19c73507 AD |
234 | } |
235 | } | |
236 | } | |
237 | ||
de612e7a | 238 | function is_system($plugin) { |
d2a421e3 | 239 | $about = $plugin->about(); |
de612e7a AD |
240 | |
241 | return @$about[3]; | |
242 | } | |
243 | ||
244 | // only system plugins are allowed to modify routing | |
8dcb2b47 | 245 | function add_handler($handler, $method, $sender) { |
6cbe53c9 | 246 | $handler = str_replace("-", "_", strtolower($handler)); |
8dcb2b47 AD |
247 | $method = strtolower($method); |
248 | ||
de612e7a AD |
249 | if ($this->is_system($sender)) { |
250 | if (!is_array($this->handlers[$handler])) { | |
251 | $this->handlers[$handler] = array(); | |
252 | } | |
8dcb2b47 | 253 | |
de612e7a AD |
254 | $this->handlers[$handler][$method] = $sender; |
255 | } | |
8dcb2b47 AD |
256 | } |
257 | ||
6f7798b6 | 258 | function del_handler($handler, $method, $sender) { |
6cbe53c9 | 259 | $handler = str_replace("-", "_", strtolower($handler)); |
8dcb2b47 AD |
260 | $method = strtolower($method); |
261 | ||
de612e7a AD |
262 | if ($this->is_system($sender)) { |
263 | unset($this->handlers[$handler][$method]); | |
264 | } | |
8dcb2b47 AD |
265 | } |
266 | ||
267 | function lookup_handler($handler, $method) { | |
6cbe53c9 | 268 | $handler = str_replace("-", "_", strtolower($handler)); |
8dcb2b47 AD |
269 | $method = strtolower($method); |
270 | ||
271 | if (is_array($this->handlers[$handler])) { | |
6cbe53c9 AD |
272 | if (isset($this->handlers[$handler]["*"])) { |
273 | return $this->handlers[$handler]["*"]; | |
274 | } else { | |
275 | return $this->handlers[$handler][$method]; | |
276 | } | |
8dcb2b47 AD |
277 | } |
278 | ||
279 | return false; | |
280 | } | |
73f28fe9 | 281 | |
4cf0f9a9 | 282 | function add_command($command, $description, $sender, $suffix = "", $arghelp = "") { |
764555ff | 283 | $command = str_replace("-", "_", strtolower($command)); |
73f28fe9 | 284 | |
d2a421e3 | 285 | $this->commands[$command] = array("description" => $description, |
4cf0f9a9 AD |
286 | "suffix" => $suffix, |
287 | "arghelp" => $arghelp, | |
d2a421e3 | 288 | "class" => $sender); |
73f28fe9 AD |
289 | } |
290 | ||
291 | function del_command($command) { | |
292 | $command = "-" . strtolower($command); | |
293 | ||
d2a421e3 | 294 | unset($this->commands[$command]); |
73f28fe9 AD |
295 | } |
296 | ||
297 | function lookup_command($command) { | |
298 | $command = "-" . strtolower($command); | |
299 | ||
300 | if (is_array($this->commands[$command])) { | |
301 | return $this->commands[$command]["class"]; | |
302 | } else { | |
303 | return false; | |
304 | } | |
73f28fe9 AD |
305 | } |
306 | ||
307 | function get_commands() { | |
308 | return $this->commands; | |
309 | } | |
310 | ||
311 | function run_commands($args) { | |
312 | foreach ($this->get_commands() as $command => $data) { | |
764555ff | 313 | if (isset($args[$command])) { |
73f28fe9 AD |
314 | $command = str_replace("-", "", $command); |
315 | $data["class"]->$command($args); | |
316 | } | |
317 | } | |
318 | } | |
319 | ||
7b55001e | 320 | function load_data() { |
d48398e6 | 321 | if ($this->owner_uid) { |
8af94f12 AD |
322 | $sth = $this->pdo->prepare("SELECT name, content FROM ttrss_plugin_storage |
323 | WHERE owner_uid = ?"); | |
324 | $sth->execute([$this->owner_uid]); | |
d8a1d2a2 | 325 | |
8af94f12 | 326 | while ($line = $sth->fetch()) { |
d8a1d2a2 AD |
327 | $this->storage[$line["name"]] = unserialize($line["content"]); |
328 | } | |
d8a1d2a2 AD |
329 | } |
330 | } | |
331 | ||
332 | private function save_data($plugin) { | |
333 | if ($this->owner_uid) { | |
8af94f12 | 334 | $this->pdo->beginTransaction(); |
d8a1d2a2 | 335 | |
8af94f12 AD |
336 | $sth = $this->pdo->prepare("SELECT id FROM ttrss_plugin_storage WHERE |
337 | owner_uid= ? AND name = ?"); | |
338 | $sth->execute([$this->owner_uid, $plugin]); | |
d8a1d2a2 AD |
339 | |
340 | if (!isset($this->storage[$plugin])) | |
341 | $this->storage[$plugin] = array(); | |
342 | ||
f8108cc2 | 343 | $content = serialize($this->storage[$plugin]); |
d8a1d2a2 | 344 | |
8af94f12 AD |
345 | if ($sth->fetch()) { |
346 | $sth = $this->pdo->prepare("UPDATE ttrss_plugin_storage SET content = ? | |
347 | WHERE owner_uid= ? AND name = ?"); | |
f8108cc2 | 348 | $sth->execute([(string)$content, $this->owner_uid, $plugin]); |
d8a1d2a2 AD |
349 | |
350 | } else { | |
8af94f12 | 351 | $sth = $this->pdo->prepare("INSERT INTO ttrss_plugin_storage |
d8a1d2a2 | 352 | (name,owner_uid,content) VALUES |
8af94f12 | 353 | (?, ?, ?)"); |
f8108cc2 | 354 | $sth->execute([$plugin, $this->owner_uid, (string)$content]); |
d8a1d2a2 AD |
355 | } |
356 | ||
8af94f12 | 357 | $this->pdo->commit(); |
d8a1d2a2 AD |
358 | } |
359 | } | |
360 | ||
361 | function set($sender, $name, $value, $sync = true) { | |
362 | $idx = get_class($sender); | |
363 | ||
364 | if (!isset($this->storage[$idx])) | |
365 | $this->storage[$idx] = array(); | |
366 | ||
367 | $this->storage[$idx][$name] = $value; | |
368 | ||
d8a1d2a2 AD |
369 | if ($sync) $this->save_data(get_class($sender)); |
370 | } | |
371 | ||
5d9abb1e | 372 | function get($sender, $name, $default_value = false) { |
d8a1d2a2 AD |
373 | $idx = get_class($sender); |
374 | ||
375 | if (isset($this->storage[$idx][$name])) { | |
376 | return $this->storage[$idx][$name]; | |
377 | } else { | |
378 | return $default_value; | |
379 | } | |
380 | } | |
381 | ||
382 | function get_all($sender) { | |
383 | $idx = get_class($sender); | |
384 | ||
6fb5f17b AD |
385 | $data = $this->storage[$idx]; |
386 | ||
387 | return $data ? $data : []; | |
d8a1d2a2 | 388 | } |
5d9abb1e AD |
389 | |
390 | function clear_data($sender) { | |
391 | if ($this->owner_uid) { | |
392 | $idx = get_class($sender); | |
393 | ||
394 | unset($this->storage[$idx]); | |
395 | ||
8af94f12 AD |
396 | $sth = $this->pdo->prepare("DELETE FROM ttrss_plugin_storage WHERE name = ? |
397 | AND owner_uid = ?"); | |
398 | $sth->execute([$idx, $this->owner_uid]); | |
5d9abb1e AD |
399 | } |
400 | } | |
be178857 AD |
401 | |
402 | function set_debug($debug) { | |
403 | $this->debug = $debug; | |
404 | } | |
405 | ||
406 | function get_debug() { | |
407 | return $this->debug; | |
408 | } | |
a413f53e AD |
409 | |
410 | // Plugin feed functions are *EXPERIMENTAL*! | |
411 | ||
412 | // cat_id: only -1 is supported (Special) | |
413 | function add_feed($cat_id, $title, $icon, $sender) { | |
414 | if (!$this->feeds[$cat_id]) $this->feeds[$cat_id] = array(); | |
415 | ||
416 | $id = count($this->feeds[$cat_id]); | |
417 | ||
418 | array_push($this->feeds[$cat_id], | |
419 | array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon)); | |
420 | ||
421 | return $id; | |
422 | } | |
423 | ||
424 | function get_feeds($cat_id) { | |
425 | return $this->feeds[$cat_id]; | |
426 | } | |
427 | ||
428 | // convert feed_id (e.g. -129) to pfeed_id first | |
429 | function get_feed_handler($pfeed_id) { | |
430 | foreach ($this->feeds as $cat) { | |
431 | foreach ($cat as $feed) { | |
432 | if ($feed['id'] == $pfeed_id) { | |
433 | return $feed['sender']; | |
434 | } | |
435 | } | |
436 | } | |
437 | } | |
438 | ||
439 | static function pfeed_to_feed_id($label) { | |
440 | return PLUGIN_FEED_BASE_INDEX - 1 - abs($label); | |
441 | } | |
442 | ||
443 | static function feed_to_pfeed_id($feed) { | |
444 | return PLUGIN_FEED_BASE_INDEX - 1 + abs($feed); | |
445 | } | |
446 | ||
79f9bef7 AD |
447 | function add_api_method($name, $sender) { |
448 | if ($this->is_system($sender)) { | |
449 | $this->api_methods[strtolower($name)] = $sender; | |
450 | } | |
451 | } | |
452 | ||
453 | function get_api_method($name) { | |
454 | return $this->api_methods[$name]; | |
455 | } | |
b8774453 AD |
456 | |
457 | function add_filter_action($sender, $action_name, $action_desc) { | |
458 | $sender_class = get_class($sender); | |
459 | ||
460 | if (!isset($this->plugin_actions[$sender_class])) | |
461 | $this->plugin_actions[$sender_class] = array(); | |
462 | ||
463 | array_push($this->plugin_actions[$sender_class], | |
464 | array("action" => $action_name, "description" => $action_desc, "sender" => $sender)); | |
465 | } | |
466 | ||
467 | function get_filter_actions() { | |
468 | return $this->plugin_actions; | |
469 | } | |
bec5ba93 | 470 | } |