]> git.mxchange.org Git - friendica.git/blob - include/plugin.php
Merge pull request #621 from annando/master
[friendica.git] / include / plugin.php
1 <?php
2
3
4 // install and uninstall plugin
5 if (! function_exists('uninstall_plugin')){
6 function uninstall_plugin($plugin){
7         logger("Addons: uninstalling " . $plugin);
8         q("DELETE FROM `addon` WHERE `name` = '%s' ",
9                 dbesc($plugin)
10         );
11
12         @include_once('addon/' . $plugin . '/' . $plugin . '.php');
13         if(function_exists($plugin . '_uninstall')) {
14                 $func = $plugin . '_uninstall';
15                 $func();
16         }
17 }}
18
19 if (! function_exists('install_plugin')){
20 function install_plugin($plugin) {
21         // silently fail if plugin was removed
22
23         if(! file_exists('addon/' . $plugin . '/' . $plugin . '.php'))
24                 return false;
25         logger("Addons: installing " . $plugin);
26         $t = @filemtime('addon/' . $plugin . '/' . $plugin . '.php');
27         @include_once('addon/' . $plugin . '/' . $plugin . '.php');
28         if(function_exists($plugin . '_install')) {
29                 $func = $plugin . '_install';
30                 $func();
31
32                 $plugin_admin = (function_exists($plugin."_plugin_admin")?1:0);
33
34                 $r = q("INSERT INTO `addon` (`name`, `installed`, `timestamp`, `plugin_admin`) VALUES ( '%s', 1, %d , %d ) ",
35                         dbesc($plugin),
36                         intval($t),
37                         $plugin_admin
38                 );
39
40                 // we can add the following with the previous SQL
41                 // once most site tables have been updated.
42                 // This way the system won't fall over dead during the update.
43
44                 if(file_exists('addon/' . $plugin . '/.hidden')) {
45                         q("update addon set hidden = 1 where name = '%s' limit 1",
46                                 dbesc($plugin)
47                         );
48                 }
49                 return true;
50         }
51         else {
52                 logger("Addons: FAILED installing " . $plugin);
53                 return false;
54         }
55
56 }}
57
58 // reload all updated plugins
59
60 if(! function_exists('reload_plugins')) {
61 function reload_plugins() {
62         $plugins = get_config('system','addon');
63         if(strlen($plugins)) {
64
65                 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
66                 if(count($r))
67                         $installed = $r;
68                 else
69                         $installed = array();
70
71                 $parr = explode(',',$plugins);
72
73                 if(count($parr)) {
74                         foreach($parr as $pl) {
75
76                                 $pl = trim($pl);
77
78                                 $fname = 'addon/' . $pl . '/' . $pl . '.php';
79
80                                 if(file_exists($fname)) {
81                                         $t = @filemtime($fname);
82                                         foreach($installed as $i) {
83                                                 if(($i['name'] == $pl) && ($i['timestamp'] != $t)) {    
84                                                         logger('Reloading plugin: ' . $i['name']);
85                                                         @include_once($fname);
86
87                                                         if(function_exists($pl . '_uninstall')) {
88                                                                 $func = $pl . '_uninstall';
89                                                                 $func();
90                                                         }
91                                                         if(function_exists($pl . '_install')) {
92                                                                 $func = $pl . '_install';
93                                                                 $func();
94                                                         }
95                                                         q("UPDATE `addon` SET `timestamp` = %d WHERE `id` = %d LIMIT 1",
96                                                                 intval($t),
97                                                                 intval($i['id'])
98                                                         );
99                                                 }
100                                         }
101                                 }
102                         }
103                 }
104         }
105
106 }}
107                                 
108
109
110
111
112 if(! function_exists('register_hook')) {
113 function register_hook($hook,$file,$function,$priority=0) {
114
115         $r = q("SELECT * FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s' LIMIT 1",
116                 dbesc($hook),
117                 dbesc($file),
118                 dbesc($function)
119         );
120         if(count($r))
121                 return true;
122
123         $r = q("INSERT INTO `hook` (`hook`, `file`, `function`, `priority`) VALUES ( '%s', '%s', '%s', '%s' ) ",
124                 dbesc($hook),
125                 dbesc($file),
126                 dbesc($function),
127                 dbesc($priority)
128         );
129         return $r;
130 }}
131
132 if(! function_exists('unregister_hook')) {
133 function unregister_hook($hook,$file,$function) {
134
135         $r = q("DELETE FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s' LIMIT 1",
136                 dbesc($hook),
137                 dbesc($file),
138                 dbesc($function)
139         );
140         return $r;
141 }}
142
143
144 if(! function_exists('load_hooks')) {
145 function load_hooks() {
146         $a = get_app();
147         $a->hooks = array();
148         $r = q("SELECT * FROM `hook` WHERE 1 ORDER BY `priority` DESC");
149         if(count($r)) {
150                 foreach($r as $rr) {
151                         if(! array_key_exists($rr['hook'],$a->hooks))
152                                 $a->hooks[$rr['hook']] = array();
153                         $a->hooks[$rr['hook']][] = array($rr['file'],$rr['function']);
154                 }
155         }
156 }}
157
158
159 if(! function_exists('call_hooks')) {
160 function call_hooks($name, &$data = null) {
161         $stamp1 = microtime(true);
162
163         $a = get_app();
164
165         if((is_array($a->hooks)) && (array_key_exists($name,$a->hooks))) {
166                 foreach($a->hooks[$name] as $hook) {
167                         // Don't run a theme's hook if the user isn't using the theme
168                         if(strpos($hook[0], 'view/theme/') !== false && strpos($hook[0], 'view/theme/'.current_theme()) === false)
169                                 continue;
170
171                         @include_once($hook[0]);
172                         if(function_exists($hook[1])) {
173                                 $func = $hook[1];
174                                 $func($a,$data);
175                         }
176                         else {
177                                 // remove orphan hooks
178                                 q("delete from hook where hook = '%s' and file = '%s' and function = '%s' limit 1",
179                                         dbesc($name),
180                                         dbesc($hook[0]),
181                                         dbesc($hook[1])
182                                 );
183                         }
184                 }
185         }
186 }}
187
188
189 /*
190  * parse plugin comment in search of plugin infos.
191  * like
192  *      
193  *       * Name: Plugin
194  *   * Description: A plugin which plugs in
195  *       * Version: 1.2.3
196  *   * Author: John <profile url>
197  *   * Author: Jane <email>
198  *   *
199  */
200
201 if (! function_exists('get_plugin_info')){
202 function get_plugin_info($plugin){
203
204         $a = get_app();
205
206         $info=Array(
207                 'name' => $plugin,
208                 'description' => "",
209                 'author' => array(),
210                 'version' => ""
211         );
212
213         if (!is_file("addon/$plugin/$plugin.php")) return $info;
214
215         $stamp1 = microtime(true);
216         $f = file_get_contents("addon/$plugin/$plugin.php");
217         $a->save_timestamp($stamp1, "file");
218
219         $r = preg_match("|/\*.*\*/|msU", $f, $m);
220
221         if ($r){
222                 $ll = explode("\n", $m[0]);
223                 foreach( $ll as $l ) {
224                         $l = trim($l,"\t\n\r */");
225                         if ($l!=""){
226                                 list($k,$v) = array_map("trim", explode(":",$l,2));
227                                 $k= strtolower($k);
228                                 if ($k=="author"){
229                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
230                                         if ($r) {
231                                                 $info['author'][] = array('name'=>$m[1], 'link'=>$m[2]);
232                                         } else {
233                                                 $info['author'][] = array('name'=>$v);
234                                         }
235                                 } else {
236                                         if (array_key_exists($k,$info)){
237                                                 $info[$k]=$v;
238                                         }
239                                 }
240
241                         }
242                 }
243
244         }
245         return $info;
246 }}
247
248
249 /*
250  * parse theme comment in search of theme infos.
251  * like
252  *
253  *       * Name: My Theme
254  *   * Description: My Cool Theme
255  *       * Version: 1.2.3
256  *   * Author: John <profile url>
257  *   * Maintainer: Jane <profile url>
258  *   *
259  */
260
261 if (! function_exists('get_theme_info')){
262 function get_theme_info($theme){
263         $info=Array(
264                 'name' => $theme,
265                 'description' => "",
266                 'author' => array(),
267                 'maintainer' => array(),
268                 'version' => "",
269                 'credits' => "",
270                 'experimental' => false,
271                 'unsupported' => false
272         );
273
274         if(file_exists("view/theme/$theme/experimental"))
275                 $info['experimental'] = true;
276         if(file_exists("view/theme/$theme/unsupported"))
277                 $info['unsupported'] = true;
278
279         if (!is_file("view/theme/$theme/theme.php")) return $info;
280
281         $a = get_app();
282         $stamp1 = microtime(true);
283         $f = file_get_contents("view/theme/$theme/theme.php");
284         $a->save_timestamp($stamp1, "file");
285
286         $r = preg_match("|/\*.*\*/|msU", $f, $m);
287
288         if ($r){
289                 $ll = explode("\n", $m[0]);
290                 foreach( $ll as $l ) {
291                         $l = trim($l,"\t\n\r */");
292                         if ($l!=""){
293                                 list($k,$v) = array_map("trim", explode(":",$l,2));
294                                 $k= strtolower($k);
295                                 if ($k=="author"){
296
297                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
298                                         if ($r) {
299                                                 $info['author'][] = array('name'=>$m[1], 'link'=>$m[2]);
300                                         } else {
301                                                 $info['author'][] = array('name'=>$v);
302                                         }
303                                 }
304                                 elseif ($k=="maintainer"){
305                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
306                                         if ($r) {
307                                                 $info['maintainer'][] = array('name'=>$m[1], 'link'=>$m[2]);
308                                         } else {
309                                                 $info['maintainer'][] = 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 function get_theme_screenshot($theme) {
326         $a = get_app();
327         $exts = array('.png','.jpg');
328         foreach($exts as $ext) {
329                 if(file_exists('view/theme/' . $theme . '/screenshot' . $ext))
330                         return($a->get_baseurl() . '/view/theme/' . $theme . '/screenshot' . $ext);
331         }
332         return($a->get_baseurl() . '/images/blank.png');
333 }
334
335 // install and uninstall theme
336 if (! function_exists('uninstall_theme')){
337 function uninstall_theme($theme){
338         logger("Addons: uninstalling theme " . $theme);
339     
340         @include_once("view/theme/$theme/theme.php");
341         if(function_exists("{$theme}_uninstall")) {
342                 $func = "{$theme}_uninstall";
343                 $func();
344         }
345 }}
346
347 if (! function_exists('install_theme')){
348 function install_theme($theme) {
349         // silently fail if theme was removed
350
351         if(! file_exists("view/theme/$theme/theme.php"))
352                 return false;
353
354         logger("Addons: installing theme $theme");
355
356         @include_once("view/theme/$theme/theme.php");
357
358         if(function_exists("{$theme}_install")) {
359                 $func = "{$theme}_install";
360                 $func();
361                 return true;
362         }
363         else {
364                 logger("Addons: FAILED installing theme $theme");
365                 return false;
366         }
367
368 }}
369
370
371
372 // check service_class restrictions. If there are no service_classes defined, everything is allowed.
373 // if $usage is supplied, we check against a maximum count and return true if the current usage is 
374 // less than the subscriber plan allows. Otherwise we return boolean true or false if the property
375 // is allowed (or not) in this subscriber plan. An unset property for this service plan means 
376 // the property is allowed, so it is only necessary to provide negative properties for each plan, 
377 // or what the subscriber is not allowed to do. 
378
379
380 function service_class_allows($uid,$property,$usage = false) {
381
382         if($uid == local_user()) {
383                 $service_class = $a->user['service_class'];
384         }
385         else {
386                 $r = q("select service_class from user where uid = %d limit 1",
387                         intval($uid)
388                 );
389                 if($r !== false and count($r)) {
390                         $service_class = $r[0]['service_class'];
391                 }
392         }
393         if(! x($service_class))
394                 return true; // everything is allowed
395
396         $arr = get_config('service_class',$service_class);
397         if(! is_array($arr) || (! count($arr)))
398                 return true;
399
400         if($usage === false)
401                 return ((x($arr[$property])) ? (bool) $arr['property'] : true);
402         else {
403                 if(! array_key_exists($property,$arr))
404                         return true;
405                 return (((intval($usage)) < intval($arr[$property])) ? true : false);
406         }
407 }
408
409
410 function service_class_fetch($uid,$property) {
411
412         if($uid == local_user()) {
413                 $service_class = $a->user['service_class'];
414         }
415         else {
416                 $r = q("select service_class from user where uid = %d limit 1",
417                         intval($uid)
418                 );
419                 if($r !== false and count($r)) {
420                         $service_class = $r[0]['service_class'];
421                 }
422         }
423         if(! x($service_class))
424                 return false; // everything is allowed
425
426         $arr = get_config('service_class',$service_class);
427         if(! is_array($arr) || (! count($arr)))
428                 return false;
429
430         return((array_key_exists($property,$arr)) ? $arr[$property] : false);
431
432 }
433
434 function upgrade_link($bbcode = false) {
435         $l = get_config('service_class','upgrade_link');
436         if(! $l)
437                 return '';
438         if($bbcode)
439                 $t = sprintf('[url=%s]' . t('Click here to upgrade.') . '[/url]', $l);
440         else
441                 $t = sprintf('<a href="%s">' . t('Click here to upgrade.') . '</div>', $l);
442         return $t;
443 }
444
445 function upgrade_message($bbcode = false) {
446         $x = upgrade_link($bbcode);
447         return t('This action exceeds the limits set by your subscription plan.') . (($x) ? ' ' . $x : '') ;
448 }
449
450 function upgrade_bool_message($bbcode = false) {
451         $x = upgrade_link($bbcode);
452         return t('This action is not available under your subscription plan.') . (($x) ? ' ' . $x : '') ;
453 }