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