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