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 //check if an app_menu hook exist for plugin $name.
 189 //Return true if the plugin is an app
 190 if(! function_exists('plugin_is_app')) {
 191 function plugin_is_app($name) {
 192         $a = get_app();
 193
 194         if(is_array($a->hooks) && (array_key_exists('app_menu',$a->hooks))) {
 195                 foreach($a->hooks['app_menu'] as $hook) {
 196                         if($hook[0] == 'addon/'.$name.'/'.$name.'.php')
 197                                 return true;
 198                 }
 199         }
 200
 201         return false;
 202 }}
 203
 204 /*
 205  * parse plugin comment in search of plugin infos.
 206  * like
 207  *
 208  *       * Name: Plugin
 209  *   * Description: A plugin which plugs in
 210  *       * Version: 1.2.3
 211  *   * Author: John <profile url>
 212  *   * Author: Jane <email>
 213  *   *
 214  */
 215
 216 if (! function_exists('get_plugin_info')){
 217 function get_plugin_info($plugin){
 218
 219         $a = get_app();
 220
 221         $info=Array(
 222                 'name' => $plugin,
 223                 'description' => "",
 224                 'author' => array(),
 225                 'version' => ""
 226         );
 227
 228         if (!is_file("addon/$plugin/$plugin.php")) return $info;
 229
 230         $stamp1 = microtime(true);
 231         $f = file_get_contents("addon/$plugin/$plugin.php");
 232         $a->save_timestamp($stamp1, "file");
 233
 234         $r = preg_match("|/\*.*\*/|msU", $f, $m);
 235
 236         if ($r){
 237                 $ll = explode("\n", $m[0]);
 238                 foreach( $ll as $l ) {
 239                         $l = trim($l,"\t\n\r */");
 240                         if ($l!=""){
 241                                 list($k,$v) = array_map("trim", explode(":",$l,2));
 242                                 $k= strtolower($k);
 243                                 if ($k=="author"){
 244                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
 245                                         if ($r) {
 246                                                 $info['author'][] = array('name'=>$m[1], 'link'=>$m[2]);
 247                                         } else {
 248                                                 $info['author'][] = array('name'=>$v);
 249                                         }
 250                                 } else {
 251                                         if (array_key_exists($k,$info)){
 252                                                 $info[$k]=$v;
 253                                         }
 254                                 }
 255
 256                         }
 257                 }
 258
 259         }
 260         return $info;
 261 }}
 262
 263
 264 /*
 265  * parse theme comment in search of theme infos.
 266  * like
 267  *
 268  *       * Name: My Theme
 269  *   * Description: My Cool Theme
 270  *       * Version: 1.2.3
 271  *   * Author: John <profile url>
 272  *   * Maintainer: Jane <profile url>
 273  *   *
 274  */
 275
 276 if (! function_exists('get_theme_info')){
 277 function get_theme_info($theme){
 278         $info=Array(
 279                 'name' => $theme,
 280                 'description' => "",
 281                 'author' => array(),
 282                 'maintainer' => array(),
 283                 'version' => "",
 284                 'credits' => "",
 285                 'experimental' => false,
 286                 'unsupported' => false
 287         );
 288
 289         if(file_exists("view/theme/$theme/experimental"))
 290                 $info['experimental'] = true;
 291         if(file_exists("view/theme/$theme/unsupported"))
 292                 $info['unsupported'] = true;
 293
 294         if (!is_file("view/theme/$theme/theme.php")) return $info;
 295
 296         $a = get_app();
 297         $stamp1 = microtime(true);
 298         $f = file_get_contents("view/theme/$theme/theme.php");
 299         $a->save_timestamp($stamp1, "file");
 300
 301         $r = preg_match("|/\*.*\*/|msU", $f, $m);
 302
 303         if ($r){
 304                 $ll = explode("\n", $m[0]);
 305                 foreach( $ll as $l ) {
 306                         $l = trim($l,"\t\n\r */");
 307                         if ($l!=""){
 308                                 list($k,$v) = array_map("trim", explode(":",$l,2));
 309                                 $k= strtolower($k);
 310                                 if ($k=="author"){
 311
 312                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
 313                                         if ($r) {
 314                                                 $info['author'][] = array('name'=>$m[1], 'link'=>$m[2]);
 315                                         } else {
 316                                                 $info['author'][] = array('name'=>$v);
 317                                         }
 318                                 }
 319                                 elseif ($k=="maintainer"){
 320                                         $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
 321                                         if ($r) {
 322                                                 $info['maintainer'][] = array('name'=>$m[1], 'link'=>$m[2]);
 323                                         } else {
 324                                                 $info['maintainer'][] = array('name'=>$v);
 325                                         }
 326                                 } else {
 327                                         if (array_key_exists($k,$info)){
 328                                                 $info[$k]=$v;
 329                                         }
 330                                 }
 331
 332                         }
 333                 }
 334
 335         }
 336         return $info;
 337 }}
 338
 339
 340 function get_theme_screenshot($theme) {
 341         $a = get_app();
 342         $exts = array('.png','.jpg');
 343         foreach($exts as $ext) {
 344                 if(file_exists('view/theme/' . $theme . '/screenshot' . $ext))
 345                         return($a->get_baseurl() . '/view/theme/' . $theme . '/screenshot' . $ext);
 346         }
 347         return($a->get_baseurl() . '/images/blank.png');
 348 }
 349
 350 // install and uninstall theme
 351 if (! function_exists('uninstall_theme')){
 352 function uninstall_theme($theme){
 353         logger("Addons: uninstalling theme " . $theme);
 354
 355         @include_once("view/theme/$theme/theme.php");
 356         if(function_exists("{$theme}_uninstall")) {
 357                 $func = "{$theme}_uninstall";
 358                 $func();
 359         }
 360 }}
 361
 362 if (! function_exists('install_theme')){
 363 function install_theme($theme) {
 364         // silently fail if theme was removed
 365
 366         if(! file_exists("view/theme/$theme/theme.php"))
 367                 return false;
 368
 369         logger("Addons: installing theme $theme");
 370
 371         @include_once("view/theme/$theme/theme.php");
 372
 373         if(function_exists("{$theme}_install")) {
 374                 $func = "{$theme}_install";
 375                 $func();
 376                 return true;
 377         }
 378         else {
 379                 logger("Addons: FAILED installing theme $theme");
 380                 return false;
 381         }
 382
 383 }}
 384
 385
 386
 387 // check service_class restrictions. If there are no service_classes defined, everything is allowed.
 388 // if $usage is supplied, we check against a maximum count and return true if the current usage is
 389 // less than the subscriber plan allows. Otherwise we return boolean true or false if the property
 390 // is allowed (or not) in this subscriber plan. An unset property for this service plan means
 391 // the property is allowed, so it is only necessary to provide negative properties for each plan,
 392 // or what the subscriber is not allowed to do.
 393
 394
 395 function service_class_allows($uid,$property,$usage = false) {
 396
 397         if($uid == local_user()) {
 398                 $service_class = $a->user['service_class'];
 399         }
 400         else {
 401                 $r = q("select service_class from user where uid = %d limit 1",
 402                         intval($uid)
 403                 );
 404                 if($r !== false and count($r)) {
 405                         $service_class = $r[0]['service_class'];
 406                 }
 407         }
 408         if(! x($service_class))
 409                 return true; // everything is allowed
 410
 411         $arr = get_config('service_class',$service_class);
 412         if(! is_array($arr) || (! count($arr)))
 413                 return true;
 414
 415         if($usage === false)
 416                 return ((x($arr[$property])) ? (bool) $arr['property'] : true);
 417         else {
 418                 if(! array_key_exists($property,$arr))
 419                         return true;
 420                 return (((intval($usage)) < intval($arr[$property])) ? true : false);
 421         }
 422 }
 423
 424
 425 function service_class_fetch($uid,$property) {
 426
 427         if($uid == local_user()) {
 428                 $service_class = $a->user['service_class'];
 429         }
 430         else {
 431                 $r = q("select service_class from user where uid = %d limit 1",
 432                         intval($uid)
 433                 );
 434                 if($r !== false and count($r)) {
 435                         $service_class = $r[0]['service_class'];
 436                 }
 437         }
 438         if(! x($service_class))
 439                 return false; // everything is allowed
 440
 441         $arr = get_config('service_class',$service_class);
 442         if(! is_array($arr) || (! count($arr)))
 443                 return false;
 444
 445         return((array_key_exists($property,$arr)) ? $arr[$property] : false);
 446
 447 }
 448
 449 function upgrade_link($bbcode = false) {
 450         $l = get_config('service_class','upgrade_link');
 451         if(! $l)
 452                 return '';
 453         if($bbcode)
 454                 $t = sprintf('[url=%s]' . t('Click here to upgrade.') . '[/url]', $l);
 455         else
 456                 $t = sprintf('<a href="%s">' . t('Click here to upgrade.') . '</div>', $l);
 457         return $t;
 458 }
 459
 460 function upgrade_message($bbcode = false) {
 461         $x = upgrade_link($bbcode);
 462         return t('This action exceeds the limits set by your subscription plan.') . (($x) ? ' ' . $x : '') ;
 463 }
 464
 465 function upgrade_bool_message($bbcode = false) {
 466         $x = upgrade_link($bbcode);
 467         return t('This action is not available under your subscription plan.') . (($x) ? ' ' . $x : '') ;
 468 }