]>
Commit | Line | Data |
---|---|---|
1 | <?php | |
2 | class PluginHost { | |
3 | private $pdo; | |
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(); | |
11 | private $plugin_actions = array(); | |
12 | private $owner_uid; | |
13 | private $last_registered; | |
14 | private static $instance; | |
15 | ||
16 | const API_VERSION = 2; | |
17 | ||
18 | // Hooks marked with *1 are run in global context and available | |
19 | // to plugins loaded in config.php only | |
20 | ||
21 | const HOOK_ARTICLE_BUTTON = 1; | |
22 | const HOOK_ARTICLE_FILTER = 2; | |
23 | const HOOK_PREFS_TAB = 3; | |
24 | const HOOK_PREFS_TAB_SECTION = 4; | |
25 | const HOOK_PREFS_TABS = 5; | |
26 | const HOOK_FEED_PARSED = 6; | |
27 | const HOOK_UPDATE_TASK = 7; // *1 | |
28 | const HOOK_AUTH_USER = 8; | |
29 | const HOOK_HOTKEY_MAP = 9; | |
30 | const HOOK_RENDER_ARTICLE = 10; | |
31 | const HOOK_RENDER_ARTICLE_CDM = 11; | |
32 | const HOOK_FEED_FETCHED = 12; | |
33 | const HOOK_SANITIZE = 13; | |
34 | const HOOK_RENDER_ARTICLE_API = 14; | |
35 | const HOOK_TOOLBAR_BUTTON = 15; | |
36 | const HOOK_ACTION_ITEM = 16; | |
37 | const HOOK_HEADLINE_TOOLBAR_BUTTON = 17; | |
38 | const HOOK_HOTKEY_INFO = 18; | |
39 | const HOOK_ARTICLE_LEFT_BUTTON = 19; | |
40 | const HOOK_PREFS_EDIT_FEED = 20; | |
41 | const HOOK_PREFS_SAVE_FEED = 21; | |
42 | const HOOK_FETCH_FEED = 22; | |
43 | const HOOK_QUERY_HEADLINES = 23; | |
44 | const HOOK_HOUSE_KEEPING = 24; // *1 | |
45 | const HOOK_SEARCH = 25; | |
46 | const HOOK_FORMAT_ENCLOSURES = 26; | |
47 | const HOOK_SUBSCRIBE_FEED = 27; | |
48 | const HOOK_HEADLINES_BEFORE = 28; | |
49 | const HOOK_RENDER_ENCLOSURE = 29; | |
50 | const HOOK_ARTICLE_FILTER_ACTION = 30; | |
51 | const HOOK_ARTICLE_EXPORT_FEED = 31; | |
52 | const HOOK_MAIN_TOOLBAR_BUTTON = 32; | |
53 | const HOOK_ENCLOSURE_ENTRY = 33; | |
54 | const HOOK_FORMAT_ARTICLE = 34; | |
55 | const HOOK_FORMAT_ARTICLE_CDM = 35; | |
56 | const HOOK_FEED_BASIC_INFO = 36; | |
57 | const HOOK_SEND_LOCAL_FILE = 37; | |
58 | const HOOK_UNSUBSCRIBE_FEED = 38; | |
59 | const HOOK_SEND_MAIL = 39; | |
60 | ||
61 | const KIND_ALL = 1; | |
62 | const KIND_SYSTEM = 2; | |
63 | const KIND_USER = 3; | |
64 | ||
65 | function __construct() { | |
66 | $this->pdo = Db::pdo(); | |
67 | ||
68 | $this->storage = array(); | |
69 | } | |
70 | ||
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 | ||
82 | private function register_plugin($name, $plugin) { | |
83 | //array_push($this->plugins, $plugin); | |
84 | $this->plugins[$name] = $plugin; | |
85 | } | |
86 | ||
87 | // needed for compatibility with API 1 | |
88 | function get_link() { | |
89 | return false; | |
90 | } | |
91 | ||
92 | function get_dbh() { | |
93 | return Db::get(); | |
94 | } | |
95 | ||
96 | function get_pdo() { | |
97 | return $this->pdo; | |
98 | } | |
99 | ||
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 | ||
110 | function get_plugins() { | |
111 | return $this->plugins; | |
112 | } | |
113 | ||
114 | function get_plugin($name) { | |
115 | return $this->plugins[strtolower($name)]; | |
116 | } | |
117 | ||
118 | function run_hooks($type, $method, $args) { | |
119 | foreach ($this->get_hooks($type) as $hook) { | |
120 | $hook->$method($args); | |
121 | } | |
122 | } | |
123 | ||
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])) { | |
134 | $key = array_Search($sender, $this->hooks[$type]); | |
135 | if ($key !== FALSE) { | |
136 | unset($this->hooks[$type][$key]); | |
137 | } | |
138 | } | |
139 | } | |
140 | ||
141 | function get_hooks($type) { | |
142 | if (isset($this->hooks[$type])) { | |
143 | return $this->hooks[$type]; | |
144 | } else { | |
145 | return array(); | |
146 | } | |
147 | } | |
148 | function load_all($kind, $owner_uid = false, $skip_init = false) { | |
149 | ||
150 | $plugins = array_merge(glob("plugins/*"), glob("plugins.local/*")); | |
151 | $plugins = array_filter($plugins, "is_dir"); | |
152 | $plugins = array_map("basename", $plugins); | |
153 | ||
154 | asort($plugins); | |
155 | ||
156 | $this->load(join(",", $plugins), $kind, $owner_uid, $skip_init); | |
157 | } | |
158 | ||
159 | function load($classlist, $kind, $owner_uid = false, $skip_init = false) { | |
160 | $plugins = explode(",", $classlist); | |
161 | ||
162 | $this->owner_uid = (int) $owner_uid; | |
163 | ||
164 | foreach ($plugins as $class) { | |
165 | $class = trim($class); | |
166 | $class_file = strtolower(basename($class)); | |
167 | ||
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"; | |
173 | $vendor_dir = __DIR__ . "/../plugins/$class_file/vendor"; | |
174 | ||
175 | if (!file_exists($file)) { | |
176 | $file = __DIR__ . "/../plugins.local/$class_file/init.php"; | |
177 | $vendor_dir = __DIR__ . "/../plugins.local/$class_file/vendor"; | |
178 | } | |
179 | ||
180 | if (!isset($this->plugins[$class])) { | |
181 | if (file_exists($file)) require_once $file; | |
182 | ||
183 | if (class_exists($class) && is_subclass_of($class, "Plugin")) { | |
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 | ||
204 | $plugin = new $class($this); | |
205 | ||
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 | ||
213 | $this->last_registered = $class; | |
214 | ||
215 | switch ($kind) { | |
216 | case $this::KIND_SYSTEM: | |
217 | if ($this->is_system($plugin)) { | |
218 | if (!$skip_init) $plugin->init($this); | |
219 | $this->register_plugin($class, $plugin); | |
220 | } | |
221 | break; | |
222 | case $this::KIND_USER: | |
223 | if (!$this->is_system($plugin)) { | |
224 | if (!$skip_init) $plugin->init($this); | |
225 | $this->register_plugin($class, $plugin); | |
226 | } | |
227 | break; | |
228 | case $this::KIND_ALL: | |
229 | if (!$skip_init) $plugin->init($this); | |
230 | $this->register_plugin($class, $plugin); | |
231 | break; | |
232 | } | |
233 | } | |
234 | } | |
235 | } | |
236 | } | |
237 | ||
238 | function is_system($plugin) { | |
239 | $about = $plugin->about(); | |
240 | ||
241 | return @$about[3]; | |
242 | } | |
243 | ||
244 | // only system plugins are allowed to modify routing | |
245 | function add_handler($handler, $method, $sender) { | |
246 | $handler = str_replace("-", "_", strtolower($handler)); | |
247 | $method = strtolower($method); | |
248 | ||
249 | if ($this->is_system($sender)) { | |
250 | if (!is_array($this->handlers[$handler])) { | |
251 | $this->handlers[$handler] = array(); | |
252 | } | |
253 | ||
254 | $this->handlers[$handler][$method] = $sender; | |
255 | } | |
256 | } | |
257 | ||
258 | function del_handler($handler, $method, $sender) { | |
259 | $handler = str_replace("-", "_", strtolower($handler)); | |
260 | $method = strtolower($method); | |
261 | ||
262 | if ($this->is_system($sender)) { | |
263 | unset($this->handlers[$handler][$method]); | |
264 | } | |
265 | } | |
266 | ||
267 | function lookup_handler($handler, $method) { | |
268 | $handler = str_replace("-", "_", strtolower($handler)); | |
269 | $method = strtolower($method); | |
270 | ||
271 | if (is_array($this->handlers[$handler])) { | |
272 | if (isset($this->handlers[$handler]["*"])) { | |
273 | return $this->handlers[$handler]["*"]; | |
274 | } else { | |
275 | return $this->handlers[$handler][$method]; | |
276 | } | |
277 | } | |
278 | ||
279 | return false; | |
280 | } | |
281 | ||
282 | function add_command($command, $description, $sender, $suffix = "", $arghelp = "") { | |
283 | $command = str_replace("-", "_", strtolower($command)); | |
284 | ||
285 | $this->commands[$command] = array("description" => $description, | |
286 | "suffix" => $suffix, | |
287 | "arghelp" => $arghelp, | |
288 | "class" => $sender); | |
289 | } | |
290 | ||
291 | function del_command($command) { | |
292 | $command = "-" . strtolower($command); | |
293 | ||
294 | unset($this->commands[$command]); | |
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 | } | |
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) { | |
313 | if (isset($args[$command])) { | |
314 | $command = str_replace("-", "", $command); | |
315 | $data["class"]->$command($args); | |
316 | } | |
317 | } | |
318 | } | |
319 | ||
320 | function load_data() { | |
321 | if ($this->owner_uid) { | |
322 | $sth = $this->pdo->prepare("SELECT name, content FROM ttrss_plugin_storage | |
323 | WHERE owner_uid = ?"); | |
324 | $sth->execute([$this->owner_uid]); | |
325 | ||
326 | while ($line = $sth->fetch()) { | |
327 | $this->storage[$line["name"]] = unserialize($line["content"]); | |
328 | } | |
329 | } | |
330 | } | |
331 | ||
332 | private function save_data($plugin) { | |
333 | if ($this->owner_uid) { | |
334 | $this->pdo->beginTransaction(); | |
335 | ||
336 | $sth = $this->pdo->prepare("SELECT id FROM ttrss_plugin_storage WHERE | |
337 | owner_uid= ? AND name = ?"); | |
338 | $sth->execute([$this->owner_uid, $plugin]); | |
339 | ||
340 | if (!isset($this->storage[$plugin])) | |
341 | $this->storage[$plugin] = array(); | |
342 | ||
343 | $content = serialize($this->storage[$plugin]); | |
344 | ||
345 | if ($sth->fetch()) { | |
346 | $sth = $this->pdo->prepare("UPDATE ttrss_plugin_storage SET content = ? | |
347 | WHERE owner_uid= ? AND name = ?"); | |
348 | $sth->execute([(string)$content, $this->owner_uid, $plugin]); | |
349 | ||
350 | } else { | |
351 | $sth = $this->pdo->prepare("INSERT INTO ttrss_plugin_storage | |
352 | (name,owner_uid,content) VALUES | |
353 | (?, ?, ?)"); | |
354 | $sth->execute([$plugin, $this->owner_uid, (string)$content]); | |
355 | } | |
356 | ||
357 | $this->pdo->commit(); | |
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 | ||
369 | if ($sync) $this->save_data(get_class($sender)); | |
370 | } | |
371 | ||
372 | function get($sender, $name, $default_value = false) { | |
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 | ||
385 | $data = $this->storage[$idx]; | |
386 | ||
387 | return $data ? $data : []; | |
388 | } | |
389 | ||
390 | function clear_data($sender) { | |
391 | if ($this->owner_uid) { | |
392 | $idx = get_class($sender); | |
393 | ||
394 | unset($this->storage[$idx]); | |
395 | ||
396 | $sth = $this->pdo->prepare("DELETE FROM ttrss_plugin_storage WHERE name = ? | |
397 | AND owner_uid = ?"); | |
398 | $sth->execute([$idx, $this->owner_uid]); | |
399 | } | |
400 | } | |
401 | ||
402 | // Plugin feed functions are *EXPERIMENTAL*! | |
403 | ||
404 | // cat_id: only -1 is supported (Special) | |
405 | function add_feed($cat_id, $title, $icon, $sender) { | |
406 | if (!$this->feeds[$cat_id]) $this->feeds[$cat_id] = array(); | |
407 | ||
408 | $id = count($this->feeds[$cat_id]); | |
409 | ||
410 | array_push($this->feeds[$cat_id], | |
411 | array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon)); | |
412 | ||
413 | return $id; | |
414 | } | |
415 | ||
416 | function get_feeds($cat_id) { | |
417 | return $this->feeds[$cat_id]; | |
418 | } | |
419 | ||
420 | // convert feed_id (e.g. -129) to pfeed_id first | |
421 | function get_feed_handler($pfeed_id) { | |
422 | foreach ($this->feeds as $cat) { | |
423 | foreach ($cat as $feed) { | |
424 | if ($feed['id'] == $pfeed_id) { | |
425 | return $feed['sender']; | |
426 | } | |
427 | } | |
428 | } | |
429 | } | |
430 | ||
431 | static function pfeed_to_feed_id($label) { | |
432 | return PLUGIN_FEED_BASE_INDEX - 1 - abs($label); | |
433 | } | |
434 | ||
435 | static function feed_to_pfeed_id($feed) { | |
436 | return PLUGIN_FEED_BASE_INDEX - 1 + abs($feed); | |
437 | } | |
438 | ||
439 | function add_api_method($name, $sender) { | |
440 | if ($this->is_system($sender)) { | |
441 | $this->api_methods[strtolower($name)] = $sender; | |
442 | } | |
443 | } | |
444 | ||
445 | function get_api_method($name) { | |
446 | return $this->api_methods[$name]; | |
447 | } | |
448 | ||
449 | function add_filter_action($sender, $action_name, $action_desc) { | |
450 | $sender_class = get_class($sender); | |
451 | ||
452 | if (!isset($this->plugin_actions[$sender_class])) | |
453 | $this->plugin_actions[$sender_class] = array(); | |
454 | ||
455 | array_push($this->plugin_actions[$sender_class], | |
456 | array("action" => $action_name, "description" => $action_desc, "sender" => $sender)); | |
457 | } | |
458 | ||
459 | function get_filter_actions() { | |
460 | return $this->plugin_actions; | |
461 | } | |
462 | } |