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