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