]> git.mxchange.org Git - friendica.git/blob - include/plugin.php
Several improvements for performance measuring
[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         $a = get_app();
162
163         if((is_array($a->hooks)) && (array_key_exists($name,$a->hooks))) {
164                 foreach($a->hooks[$name] as $hook) {
165                         @include_once($hook[0]);
166                         if(function_exists($hook[1])) {
167                                 $func = $hook[1];
168                                 $func($a,$data);
169                         }
170                         else {
171                                 // remove orphan hooks
172                                 q("delete from hook where hook = '%s' and file = '$s' and function = '%s' limit 1",
173                                         dbesc($name),
174                                         dbesc($hook[0]),
175                                         dbesc($hook[1])
176                                 );
177                         }
178                 }
179         }
180
181 }}
182
183
184 /*
185  * parse plugin comment in search of plugin infos.
186  * like
187  *      
188  *       * Name: Plugin
189  *   * Description: A plugin which plugs in
190  *       * Version: 1.2.3
191  *   * Author: John <profile url>
192  *   * Author: Jane <email>
193  *   *
194  */
195
196 if (! function_exists('get_plugin_info')){
197 function get_plugin_info($plugin){
198         $info=Array(
199                 'name' => $plugin,
200                 'description' => "",
201                 'author' => array(),
202                 'version' => ""
203         );
204
205         if (!is_file("addon/$plugin/$plugin.php")) return $info;
206
207         $stamp1 = microtime(true);
208         $f = file_get_contents("addon/$plugin/$plugin.php");
209         $a->save_timestamp($stamp1, "file");
210
211         $r = preg_match("|/\*.*\*/|msU", $f, $m);
212
213         if ($r){
214                 $ll = explode("\n", $m[0]);
215                 foreach( $ll as $l ) {
216                         $l = trim($l,"\t\n\r */");
217                         if ($l!=""){
218                                 list($k,$v) = array_map("trim", explode(":",$l,2));
219                                 $k= strtolower($k);
220                                 if ($k=="author"){
221                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
222                                         if ($r) {
223                                                 $info['author'][] = array('name'=>$m[1], 'link'=>$m[2]);
224                                         } else {
225                                                 $info['author'][] = array('name'=>$v);
226                                         }
227                                 } else {
228                                         if (array_key_exists($k,$info)){
229                                                 $info[$k]=$v;
230                                         }
231                                 }
232                                 
233                         }
234                 }
235                 
236         }
237         return $info;
238 }}
239
240
241 /*
242  * parse theme comment in search of theme infos.
243  * like
244  *      
245  *       * Name: My Theme
246  *   * Description: My Cool Theme
247  *       * Version: 1.2.3
248  *   * Author: John <profile url>
249  *   * Maintainer: Jane <profile url>
250  *   *
251  */
252
253 if (! function_exists('get_theme_info')){
254 function get_theme_info($theme){
255         $info=Array(
256                 'name' => $theme,
257                 'description' => "",
258                 'author' => array(),
259                 'maintainer' => array(),
260                 'version' => "",
261                 'credits' => "",
262                 'experimental' => false,
263                 'unsupported' => false
264         );
265
266         if(file_exists("view/theme/$theme/experimental"))
267                 $info['experimental'] = true;
268         if(file_exists("view/theme/$theme/unsupported"))
269                 $info['unsupported'] = true;
270
271         if (!is_file("view/theme/$theme/theme.php")) return $info;
272
273         $stamp1 = microtime(true);
274         $f = file_get_contents("view/theme/$theme/theme.php");
275         $a->save_timestamp($stamp1, "file");
276
277         $r = preg_match("|/\*.*\*/|msU", $f, $m);
278
279         if ($r){
280                 $ll = explode("\n", $m[0]);
281                 foreach( $ll as $l ) {
282                         $l = trim($l,"\t\n\r */");
283                         if ($l!=""){
284                                 list($k,$v) = array_map("trim", explode(":",$l,2));
285                                 $k= strtolower($k);
286                                 if ($k=="author"){
287
288                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
289                                         if ($r) {
290                                                 $info['author'][] = array('name'=>$m[1], 'link'=>$m[2]);
291                                         } else {
292                                                 $info['author'][] = array('name'=>$v);
293                                         }
294                                 }
295                                 elseif ($k=="maintainer"){
296                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
297                                         if ($r) {
298                                                 $info['maintainer'][] = array('name'=>$m[1], 'link'=>$m[2]);
299                                         } else {
300                                                 $info['maintainer'][] = array('name'=>$v);
301                                         }
302                                 } else {
303                                         if (array_key_exists($k,$info)){
304                                                 $info[$k]=$v;
305                                         }
306                                 }
307                                 
308                         }
309                 }
310                 
311         }
312         return $info;
313 }}
314
315
316 function get_theme_screenshot($theme) {
317         $a = get_app();
318         $exts = array('.png','.jpg');
319         foreach($exts as $ext) {
320                 if(file_exists('view/theme/' . $theme . '/screenshot' . $ext))
321                         return($a->get_baseurl() . '/view/theme/' . $theme . '/screenshot' . $ext);
322         }
323         return($a->get_baseurl() . '/images/blank.png');
324 }
325
326
327 // check service_class restrictions. If there are no service_classes defined, everything is allowed.
328 // if $usage is supplied, we check against a maximum count and return true if the current usage is 
329 // less than the subscriber plan allows. Otherwise we return boolean true or false if the property
330 // is allowed (or not) in this subscriber plan. An unset property for this service plan means 
331 // the property is allowed, so it is only necessary to provide negative properties for each plan, 
332 // or what the subscriber is not allowed to do. 
333
334
335 function service_class_allows($uid,$property,$usage = false) {
336
337         if($uid == local_user()) {
338                 $service_class = $a->user['service_class'];
339         }
340         else {
341                 $r = q("select service_class from user where uid = %d limit 1",
342                         intval($uid)
343                 );
344                 if($r !== false and count($r)) {
345                         $service_class = $r[0]['service_class'];
346                 }
347         }
348         if(! x($service_class))
349                 return true; // everything is allowed
350
351         $arr = get_config('service_class',$service_class);
352         if(! is_array($arr) || (! count($arr)))
353                 return true;
354
355         if($usage === false)
356                 return ((x($arr[$property])) ? (bool) $arr['property'] : true);
357         else {
358                 if(! array_key_exists($property,$arr))
359                         return true;
360                 return (((intval($usage)) < intval($arr[$property])) ? true : false);
361         }
362 }
363
364
365 function service_class_fetch($uid,$property) {
366
367         if($uid == local_user()) {
368                 $service_class = $a->user['service_class'];
369         }
370         else {
371                 $r = q("select service_class from user where uid = %d limit 1",
372                         intval($uid)
373                 );
374                 if($r !== false and count($r)) {
375                         $service_class = $r[0]['service_class'];
376                 }
377         }
378         if(! x($service_class))
379                 return false; // everything is allowed
380
381         $arr = get_config('service_class',$service_class);
382         if(! is_array($arr) || (! count($arr)))
383                 return false;
384
385         return((array_key_exists($property,$arr)) ? $arr[$property] : false);
386
387 }
388
389 function upgrade_link($bbcode = false) {
390         $l = get_config('service_class','upgrade_link');
391         if(! $l)
392                 return '';
393         if($bbcode)
394                 $t = sprintf('[url=%s]' . t('Click here to upgrade.') . '[/url]', $l);
395         else
396                 $t = sprintf('<a href="%s">' . t('Click here to upgrade.') . '</div>', $l);
397         return $t;
398 }
399
400 function upgrade_message($bbcode = false) {
401         $x = upgrade_link($bbcode);
402         return t('This action exceeds the limits set by your subscription plan.') . (($x) ? ' ' . $x : '') ;
403 }
404
405 function upgrade_bool_message($bbcode = false) {
406         $x = upgrade_link($bbcode);
407         return t('This action is not available under your subscription plan.') . (($x) ? ' ' . $x : '') ;
408 }