include/plugin.php

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