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