]> git.mxchange.org Git - friendica.git/blob - include/plugin.php
Merge remote-tracking branch 'upstream/develop' into 1612-spool
[friendica.git] / include / plugin.php
1 <?php
2 /**
3  * @file include/plugin.php
4  * 
5  * @brief Some functions to handle addons and themes.
6  */
7
8
9 /**
10  * @brief uninstalls an addon.
11  *
12  * @param string $plugin name of the addon
13  * @return boolean
14  */
15 if (! function_exists('uninstall_plugin')){
16 function uninstall_plugin($plugin){
17         logger("Addons: uninstalling " . $plugin);
18         q("DELETE FROM `addon` WHERE `name` = '%s' ",
19                 dbesc($plugin)
20         );
21
22         @include_once('addon/' . $plugin . '/' . $plugin . '.php');
23         if(function_exists($plugin . '_uninstall')) {
24                 $func = $plugin . '_uninstall';
25                 $func();
26         }
27 }}
28
29 /**
30  * @brief installs an addon.
31  *
32  * @param string $plugin name of the addon
33  * @return bool
34  */
35 if (! function_exists('install_plugin')){
36 function install_plugin($plugin) {
37         // silently fail if plugin was removed
38
39         if(! file_exists('addon/' . $plugin . '/' . $plugin . '.php'))
40                 return false;
41         logger("Addons: installing " . $plugin);
42         $t = @filemtime('addon/' . $plugin . '/' . $plugin . '.php');
43         @include_once('addon/' . $plugin . '/' . $plugin . '.php');
44         if(function_exists($plugin . '_install')) {
45                 $func = $plugin . '_install';
46                 $func();
47
48                 $plugin_admin = (function_exists($plugin."_plugin_admin")?1:0);
49
50                 $r = q("INSERT INTO `addon` (`name`, `installed`, `timestamp`, `plugin_admin`) VALUES ( '%s', 1, %d , %d ) ",
51                         dbesc($plugin),
52                         intval($t),
53                         $plugin_admin
54                 );
55
56                 // we can add the following with the previous SQL
57                 // once most site tables have been updated.
58                 // This way the system won't fall over dead during the update.
59
60                 if(file_exists('addon/' . $plugin . '/.hidden')) {
61                         q("UPDATE `addon` SET `hidden` = 1 WHERE `name` = '%s'",
62                                 dbesc($plugin)
63                         );
64                 }
65                 return true;
66         }
67         else {
68                 logger("Addons: FAILED installing " . $plugin);
69                 return false;
70         }
71
72 }}
73
74 // reload all updated plugins
75
76 if(! function_exists('reload_plugins')) {
77 function reload_plugins() {
78         $plugins = get_config('system','addon');
79         if(strlen($plugins)) {
80
81                 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
82                 if(count($r))
83                         $installed = $r;
84                 else
85                         $installed = array();
86
87                 $parr = explode(',',$plugins);
88
89                 if(count($parr)) {
90                         foreach($parr as $pl) {
91
92                                 $pl = trim($pl);
93
94                                 $fname = 'addon/' . $pl . '/' . $pl . '.php';
95
96                                 if(file_exists($fname)) {
97                                         $t = @filemtime($fname);
98                                         foreach($installed as $i) {
99                                                 if(($i['name'] == $pl) && ($i['timestamp'] != $t)) {
100                                                         logger('Reloading plugin: ' . $i['name']);
101                                                         @include_once($fname);
102
103                                                         if(function_exists($pl . '_uninstall')) {
104                                                                 $func = $pl . '_uninstall';
105                                                                 $func();
106                                                         }
107                                                         if(function_exists($pl . '_install')) {
108                                                                 $func = $pl . '_install';
109                                                                 $func();
110                                                         }
111                                                         q("UPDATE `addon` SET `timestamp` = %d WHERE `id` = %d",
112                                                                 intval($t),
113                                                                 intval($i['id'])
114                                                         );
115                                                 }
116                                         }
117                                 }
118                         }
119                 }
120         }
121
122 }}
123
124 /**
125  * @brief check if addon is enabled
126  *
127  * @param string $plugin
128  * @return boolean
129  */
130 function plugin_enabled($plugin) {
131         $r = q("SELECT * FROM `addon` WHERE `installed` = 1 AND `name` = '%s'", $plugin);
132         return((bool)(count($r) > 0));
133 }
134
135
136 /**
137  * @brief registers a hook.
138  *
139  * @param string $hook the name of the hook
140  * @param string $file the name of the file that hooks into
141  * @param string $function the name of the function that the hook will call
142  * @param int $priority A priority (defaults to 0)
143  * @return mixed|bool
144  */
145 if(! function_exists('register_hook')) {
146 function register_hook($hook,$file,$function,$priority=0) {
147
148         $r = q("SELECT * FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s' LIMIT 1",
149                 dbesc($hook),
150                 dbesc($file),
151                 dbesc($function)
152         );
153         if(count($r))
154                 return true;
155
156         $r = q("INSERT INTO `hook` (`hook`, `file`, `function`, `priority`) VALUES ( '%s', '%s', '%s', '%s' ) ",
157                 dbesc($hook),
158                 dbesc($file),
159                 dbesc($function),
160                 dbesc($priority)
161         );
162         return $r;
163 }}
164
165 /**
166  * @brief unregisters a hook.
167  * 
168  * @param string $hook the name of the hook
169  * @param string $file the name of the file that hooks into
170  * @param string $function the name of the function that the hook called
171  * @return array
172  */
173 if(! function_exists('unregister_hook')) {
174 function unregister_hook($hook,$file,$function) {
175
176         $r = q("DELETE FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s'",
177                 dbesc($hook),
178                 dbesc($file),
179                 dbesc($function)
180         );
181         return $r;
182 }}
183
184
185 if(! function_exists('load_hooks')) {
186 function load_hooks() {
187         $a = get_app();
188         $a->hooks = array();
189         $r = q("SELECT * FROM `hook` WHERE 1 ORDER BY `priority` DESC, `file`");
190         if(count($r)) {
191                 foreach($r as $rr) {
192                         if(! array_key_exists($rr['hook'],$a->hooks))
193                                 $a->hooks[$rr['hook']] = array();
194                         $a->hooks[$rr['hook']][] = array($rr['file'],$rr['function']);
195                 }
196         }
197 }}
198
199 /**
200  * @brief Calls a hook.
201  *
202  * Use this function when you want to be able to allow a hook to manipulate
203  * the provided data.
204  *
205  * @param string $name of the hook to call
206  * @param string|array &$data to transmit to the callback handler
207  */
208 function call_hooks($name, &$data = null) {
209         $stamp1 = microtime(true);
210
211         $a = get_app();
212
213         if (is_array($a->hooks) && array_key_exists($name, $a->hooks))
214                 foreach ($a->hooks[$name] as $hook)
215                         call_single_hook($a, $name, $hook, $data);
216 }
217
218 /**
219  * @brief Calls a single hook.
220  *
221  * @param string $name of the hook to call
222  * @param array $hook Hook data
223  * @param string|array &$data to transmit to the callback handler
224  */
225 function call_single_hook($a, $name, $hook, &$data = null) {
226         // Don't run a theme's hook if the user isn't using the theme
227         if (strpos($hook[0], 'view/theme/') !== false && strpos($hook[0], 'view/theme/'.current_theme()) === false)
228                 return;
229
230         @include_once($hook[0]);
231         if (function_exists($hook[1])) {
232                 $func = $hook[1];
233                 $func($a, $data);
234         } else {
235                 // remove orphan hooks
236                 q("DELETE FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s'",
237                         dbesc($name),
238                         dbesc($hook[0]),
239                         dbesc($hook[1])
240                 );
241         }
242 }
243
244 //check if an app_menu hook exist for plugin $name.
245 //Return true if the plugin is an app
246 if(! function_exists('plugin_is_app')) {
247 function plugin_is_app($name) {
248         $a = get_app();
249
250         if(is_array($a->hooks) && (array_key_exists('app_menu',$a->hooks))) {
251                 foreach($a->hooks['app_menu'] as $hook) {
252                         if($hook[0] == 'addon/'.$name.'/'.$name.'.php')
253                                 return true;
254                 }
255         }
256
257         return false;
258 }}
259
260 /**
261  * @brief Parse plugin comment in search of plugin infos.
262  *
263  * like
264  * \code
265  *...* Name: Plugin
266  *   * Description: A plugin which plugs in
267  * . * Version: 1.2.3
268  *   * Author: John <profile url>
269  *   * Author: Jane <email>
270  *   *
271  *  *\endcode
272  * @param string $plugin the name of the plugin
273  * @return array with the plugin information
274  */
275
276 if (! function_exists('get_plugin_info')){
277 function get_plugin_info($plugin){
278
279         $a = get_app();
280
281         $info=Array(
282                 'name' => $plugin,
283                 'description' => "",
284                 'author' => array(),
285                 'version' => "",
286                 'status' => ""
287         );
288
289         if (!is_file("addon/$plugin/$plugin.php")) return $info;
290
291         $stamp1 = microtime(true);
292         $f = file_get_contents("addon/$plugin/$plugin.php");
293         $a->save_timestamp($stamp1, "file");
294
295         $r = preg_match("|/\*.*\*/|msU", $f, $m);
296
297         if ($r){
298                 $ll = explode("\n", $m[0]);
299                 foreach( $ll as $l ) {
300                         $l = trim($l,"\t\n\r */");
301                         if ($l!=""){
302                                 list($k,$v) = array_map("trim", explode(":",$l,2));
303                                 $k= strtolower($k);
304                                 if ($k=="author"){
305                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
306                                         if ($r) {
307                                                 $info['author'][] = array('name'=>$m[1], 'link'=>$m[2]);
308                                         } else {
309                                                 $info['author'][] = array('name'=>$v);
310                                         }
311                                 } else {
312                                         if (array_key_exists($k,$info)){
313                                                 $info[$k]=$v;
314                                         }
315                                 }
316
317                         }
318                 }
319
320         }
321         return $info;
322 }}
323
324
325 /**
326  * @brief Parse theme comment in search of theme infos.
327  * 
328  * like
329  * \code
330  * ..* Name: My Theme
331  *   * Description: My Cool Theme
332  * . * Version: 1.2.3
333  *   * Author: John <profile url>
334  *   * Maintainer: Jane <profile url>
335  *   *
336  * \endcode
337  * @param string $theme the name of the theme
338  * @return array
339  */
340
341 if (! function_exists('get_theme_info')){
342 function get_theme_info($theme){
343         $info=Array(
344                 'name' => $theme,
345                 'description' => "",
346                 'author' => array(),
347                 'maintainer' => array(),
348                 'version' => "",
349                 'credits' => "",
350                 'experimental' => false,
351                 'unsupported' => false
352         );
353
354         if(file_exists("view/theme/$theme/experimental"))
355                 $info['experimental'] = true;
356         if(file_exists("view/theme/$theme/unsupported"))
357                 $info['unsupported'] = true;
358
359         if (!is_file("view/theme/$theme/theme.php")) return $info;
360
361         $a = get_app();
362         $stamp1 = microtime(true);
363         $f = file_get_contents("view/theme/$theme/theme.php");
364         $a->save_timestamp($stamp1, "file");
365
366         $r = preg_match("|/\*.*\*/|msU", $f, $m);
367
368         if ($r){
369                 $ll = explode("\n", $m[0]);
370                 foreach( $ll as $l ) {
371                         $l = trim($l,"\t\n\r */");
372                         if ($l!=""){
373                                 list($k,$v) = array_map("trim", explode(":",$l,2));
374                                 $k= strtolower($k);
375                                 if ($k=="author"){
376
377                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
378                                         if ($r) {
379                                                 $info['author'][] = array('name'=>$m[1], 'link'=>$m[2]);
380                                         } else {
381                                                 $info['author'][] = array('name'=>$v);
382                                         }
383                                 }
384                                 elseif ($k=="maintainer"){
385                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
386                                         if ($r) {
387                                                 $info['maintainer'][] = array('name'=>$m[1], 'link'=>$m[2]);
388                                         } else {
389                                                 $info['maintainer'][] = array('name'=>$v);
390                                         }
391                                 } else {
392                                         if (array_key_exists($k,$info)){
393                                                 $info[$k]=$v;
394                                         }
395                                 }
396
397                         }
398                 }
399
400         }
401         return $info;
402 }}
403
404 /**
405  * @brief Returns the theme's screenshot.
406  *
407  * The screenshot is expected as view/theme/$theme/screenshot.[png|jpg].
408  *
409  * @param sring $theme The name of the theme
410  * @return string
411  */
412 function get_theme_screenshot($theme) {
413         $a = get_app();
414         $exts = array('.png','.jpg');
415         foreach($exts as $ext) {
416                 if(file_exists('view/theme/' . $theme . '/screenshot' . $ext))
417                         return($a->get_baseurl() . '/view/theme/' . $theme . '/screenshot' . $ext);
418         }
419         return($a->get_baseurl() . '/images/blank.png');
420 }
421
422 // install and uninstall theme
423 if (! function_exists('uninstall_theme')){
424 function uninstall_theme($theme){
425         logger("Addons: uninstalling theme " . $theme);
426
427         @include_once("view/theme/$theme/theme.php");
428         if(function_exists("{$theme}_uninstall")) {
429                 $func = "{$theme}_uninstall";
430                 $func();
431         }
432 }}
433
434 if (! function_exists('install_theme')){
435 function install_theme($theme) {
436         // silently fail if theme was removed
437
438         if(! file_exists("view/theme/$theme/theme.php"))
439                 return false;
440
441         logger("Addons: installing theme $theme");
442
443         @include_once("view/theme/$theme/theme.php");
444
445         if(function_exists("{$theme}_install")) {
446                 $func = "{$theme}_install";
447                 $func();
448                 return true;
449         }
450         else {
451                 logger("Addons: FAILED installing theme $theme");
452                 return false;
453         }
454
455 }}
456
457
458
459 // check service_class restrictions. If there are no service_classes defined, everything is allowed.
460 // if $usage is supplied, we check against a maximum count and return true if the current usage is
461 // less than the subscriber plan allows. Otherwise we return boolean true or false if the property
462 // is allowed (or not) in this subscriber plan. An unset property for this service plan means
463 // the property is allowed, so it is only necessary to provide negative properties for each plan,
464 // or what the subscriber is not allowed to do.
465
466
467 function service_class_allows($uid,$property,$usage = false) {
468
469         if($uid == local_user()) {
470                 $service_class = $a->user['service_class'];
471         }
472         else {
473                 $r = q("SELECT `service_class` FROM `user` WHERE `uid` = %d LIMIT 1",
474                         intval($uid)
475                 );
476                 if($r !== false and count($r)) {
477                         $service_class = $r[0]['service_class'];
478                 }
479         }
480         if(! x($service_class))
481                 return true; // everything is allowed
482
483         $arr = get_config('service_class',$service_class);
484         if(! is_array($arr) || (! count($arr)))
485                 return true;
486
487         if($usage === false)
488                 return ((x($arr[$property])) ? (bool) $arr['property'] : true);
489         else {
490                 if(! array_key_exists($property,$arr))
491                         return true;
492                 return (((intval($usage)) < intval($arr[$property])) ? true : false);
493         }
494 }
495
496
497 function service_class_fetch($uid,$property) {
498
499         if($uid == local_user()) {
500                 $service_class = $a->user['service_class'];
501         }
502         else {
503                 $r = q("SELECT `service_class` FROM `user` WHERE `uid` = %d LIMIT 1",
504                         intval($uid)
505                 );
506                 if($r !== false and count($r)) {
507                         $service_class = $r[0]['service_class'];
508                 }
509         }
510         if(! x($service_class))
511                 return false; // everything is allowed
512
513         $arr = get_config('service_class',$service_class);
514         if(! is_array($arr) || (! count($arr)))
515                 return false;
516
517         return((array_key_exists($property,$arr)) ? $arr[$property] : false);
518
519 }
520
521 function upgrade_link($bbcode = false) {
522         $l = get_config('service_class','upgrade_link');
523         if(! $l)
524                 return '';
525         if($bbcode)
526                 $t = sprintf('[url=%s]' . t('Click here to upgrade.') . '[/url]', $l);
527         else
528                 $t = sprintf('<a href="%s">' . t('Click here to upgrade.') . '</div>', $l);
529         return $t;
530 }
531
532 function upgrade_message($bbcode = false) {
533         $x = upgrade_link($bbcode);
534         return t('This action exceeds the limits set by your subscription plan.') . (($x) ? ' ' . $x : '') ;
535 }
536
537 function upgrade_bool_message($bbcode = false) {
538         $x = upgrade_link($bbcode);
539         return t('This action is not available under your subscription plan.') . (($x) ? ' ' . $x : '') ;
540 }
541
542 /**
543  * @brief Get the full path to relevant theme files by filename
544  * 
545  * This function search in the theme directory (and if not present in global theme directory)
546  * if there is a directory with the file extension and  for a file with the given
547  * filename. 
548  * 
549  * @param string $file Filename
550  * @param string $root Full root path
551  * @return string Path to the file or empty string if the file isn't found
552  */
553 function theme_include($file, $root = '') {
554         // Make sure $root ends with a slash / if it's not blank
555         if($root !== '' && $root[strlen($root)-1] !== '/')
556                 $root = $root . '/';
557         $theme_info = $a->theme_info;
558         if(is_array($theme_info) AND array_key_exists('extends',$theme_info))
559                 $parent = $theme_info['extends'];
560         else
561                 $parent = 'NOPATH';
562         $theme = current_theme();
563         $thname = $theme;
564         $ext = substr($file,strrpos($file,'.')+1);
565         $paths = array(
566                 "{$root}view/theme/$thname/$ext/$file",
567                 "{$root}view/theme/$parent/$ext/$file",
568                 "{$root}view/$ext/$file",
569         );
570         foreach($paths as $p) {
571                 // strpos() is faster than strstr when checking if one string is in another (http://php.net/manual/en/function.strstr.php)
572                 if(strpos($p,'NOPATH') !== false)
573                         continue;
574                 if(file_exists($p))
575                         return $p;
576         }
577         return '';
578 }