src/App.php

   1 <?php
   2 /**
   3  * @file src/App.php
   4  */
   5 namespace Friendica;
   6
   7 use Friendica\Core\Cache;
   8 use Friendica\Core\Config;
   9 use Friendica\Core\L10n;
  10 use Friendica\Core\PConfig;
  11 use Friendica\Core\System;
  12
  13 use Detection\MobileDetect;
  14
  15 use Exception;
  16
  17 require_once 'boot.php';
  18 require_once 'include/text.php';
  19
  20 /**
  21  *
  22  * class: App
  23  *
  24  * @brief Our main application structure for the life of this page.
  25  *
  26  * Primarily deals with the URL that got us here
  27  * and tries to make some sense of it, and
  28  * stores our page contents and config storage
  29  * and anything else that might need to be passed around
  30  * before we spit the page out.
  31  *
  32  */
  33 class App
  34 {
  35         public $module_loaded = false;
  36         public $module_class = null;
  37         public $query_string;
  38         public $config;
  39         public $page;
  40         public $page_offset;
  41         public $profile;
  42         public $profile_uid;
  43         public $user;
  44         public $cid;
  45         public $contact;
  46         public $contacts;
  47         public $page_contact;
  48         public $content;
  49         public $data = [];
  50         public $error = false;
  51         public $cmd;
  52         public $argv;
  53         public $argc;
  54         public $module;
  55         public $pager;
  56         public $strings;
  57         public $basepath;
  58         public $path;
  59         public $hooks;
  60         public $timezone;
  61         public $interactive = true;
  62         public $addons;
  63         public $addons_admin = [];
  64         public $apps = [];
  65         public $identities;
  66         public $is_mobile = false;
  67         public $is_tablet = false;
  68         public $is_friendica_app;
  69         public $performance = [];
  70         public $callstack = [];
  71         public $theme_info = [];
  72         public $backend = true;
  73         public $nav_sel;
  74         public $category;
  75         // Allow themes to control internal parameters
  76         // by changing App values in theme.php
  77
  78         public $sourcename = '';
  79         public $videowidth = 425;
  80         public $videoheight = 350;
  81         public $force_max_items = 0;
  82         public $theme_events_in_profile = true;
  83
  84         /**
  85          * @brief An array for all theme-controllable parameters
  86          *
  87          * Mostly unimplemented yet. Only options 'template_engine' and
  88          * beyond are used.
  89          */
  90         public $theme = [
  91                 'sourcename' => '',
  92                 'videowidth' => 425,
  93                 'videoheight' => 350,
  94                 'force_max_items' => 0,
  95                 'stylesheet' => '',
  96                 'template_engine' => 'smarty3',
  97         ];
  98
  99         /**
 100          * @brief An array of registered template engines ('name'=>'class name')
 101          */
 102         public $template_engines = [];
 103
 104         /**
 105          * @brief An array of instanced template engines ('name'=>'instance')
 106          */
 107         public $template_engine_instance = [];
 108         public $process_id;
 109         public $queue;
 110         private $ldelim = [
 111                 'internal' => '',
 112                 'smarty3' => '{{'
 113         ];
 114         private $rdelim = [
 115                 'internal' => '',
 116                 'smarty3' => '}}'
 117         ];
 118         private $scheme;
 119         private $hostname;
 120         private $curl_code;
 121         private $curl_content_type;
 122         private $curl_headers;
 123         private static $a;
 124
 125         /**
 126          * @brief App constructor.
 127          *
 128          * @param string $basepath Path to the app base folder
 129          */
 130         public function __construct($basepath)
 131         {
 132                 global $default_timezone;
 133
 134                 if (!static::directory_usable($basepath, false)) {
 135                         throw new Exception('Basepath ' . $basepath . ' isn\'t usable.');
 136                 }
 137
 138                 $this->basepath = rtrim($basepath, DIRECTORY_SEPARATOR);
 139
 140                 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
 141                         include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
 142                 }
 143
 144                 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
 145
 146                 date_default_timezone_set($this->timezone);
 147
 148                 $this->performance['start'] = microtime(true);
 149                 $this->performance['database'] = 0;
 150                 $this->performance['database_write'] = 0;
 151                 $this->performance['network'] = 0;
 152                 $this->performance['file'] = 0;
 153                 $this->performance['rendering'] = 0;
 154                 $this->performance['parser'] = 0;
 155                 $this->performance['marktime'] = 0;
 156                 $this->performance['markstart'] = microtime(true);
 157
 158                 $this->callstack['database'] = [];
 159                 $this->callstack['database_write'] = [];
 160                 $this->callstack['network'] = [];
 161                 $this->callstack['file'] = [];
 162                 $this->callstack['rendering'] = [];
 163                 $this->callstack['parser'] = [];
 164
 165                 $this->config = [];
 166                 $this->page = [];
 167                 $this->pager = [];
 168
 169                 $this->query_string = '';
 170
 171                 $this->process_id = uniqid('log', true);
 172
 173                 startup();
 174
 175                 $this->scheme = 'http';
 176
 177                 if ((x($_SERVER, 'HTTPS') && $_SERVER['HTTPS']) ||
 178                         (x($_SERVER, 'HTTP_FORWARDED') && preg_match('/proto=https/', $_SERVER['HTTP_FORWARDED'])) ||
 179                         (x($_SERVER, 'HTTP_X_FORWARDED_PROTO') && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
 180                         (x($_SERVER, 'HTTP_X_FORWARDED_SSL') && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
 181                         (x($_SERVER, 'FRONT_END_HTTPS') && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
 182                         (x($_SERVER, 'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
 183                 ) {
 184                         $this->scheme = 'https';
 185                 }
 186
 187                 if (x($_SERVER, 'SERVER_NAME')) {
 188                         $this->hostname = $_SERVER['SERVER_NAME'];
 189
 190                         if (x($_SERVER, 'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
 191                                 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
 192                         }
 193                         /*
 194                          * Figure out if we are running at the top of a domain
 195                          * or in a sub-directory and adjust accordingly
 196                          */
 197
 198                         /// @TODO This kind of escaping breaks syntax-highlightning on CoolEdit (Midnight Commander)
 199                         $path = trim(dirname($_SERVER['SCRIPT_NAME']), '/\\');
 200                         if (isset($path) && strlen($path) && ($path != $this->path)) {
 201                                 $this->path = $path;
 202                         }
 203                 }
 204
 205                 set_include_path(
 206                         get_include_path() . PATH_SEPARATOR
 207                         . $this->basepath . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
 208                         . $this->basepath . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
 209                         . $this->basepath);
 210
 211
 212                 if (is_array($_SERVER['argv']) && $_SERVER['argc'] > 1 && substr(end($_SERVER['argv']), 0, 4) == 'http') {
 213                         $this->set_baseurl(array_pop($_SERVER['argv']));
 214                         $_SERVER['argc'] --;
 215                 }
 216
 217                 if ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 9) === 'pagename=') {
 218                         $this->query_string = substr($_SERVER['QUERY_STRING'], 9);
 219
 220                         // removing trailing / - maybe a nginx problem
 221                         $this->query_string = ltrim($this->query_string, '/');
 222                 } elseif ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 2) === 'q=') {
 223                         $this->query_string = substr($_SERVER['QUERY_STRING'], 2);
 224
 225                         // removing trailing / - maybe a nginx problem
 226                         $this->query_string = ltrim($this->query_string, '/');
 227                 }
 228
 229                 if (x($_GET, 'pagename')) {
 230                         $this->cmd = trim($_GET['pagename'], '/\\');
 231                 } elseif (x($_GET, 'q')) {
 232                         $this->cmd = trim($_GET['q'], '/\\');
 233                 }
 234
 235                 // fix query_string
 236                 $this->query_string = str_replace($this->cmd . '&', $this->cmd . '?', $this->query_string);
 237
 238                 // unix style "homedir"
 239                 if (substr($this->cmd, 0, 1) === '~') {
 240                         $this->cmd = 'profile/' . substr($this->cmd, 1);
 241                 }
 242
 243                 // Diaspora style profile url
 244                 if (substr($this->cmd, 0, 2) === 'u/') {
 245                         $this->cmd = 'profile/' . substr($this->cmd, 2);
 246                 }
 247
 248                 /*
 249                  * Break the URL path into C style argc/argv style arguments for our
 250                  * modules. Given "http://example.com/module/arg1/arg2", $this->argc
 251                  * will be 3 (integer) and $this->argv will contain:
 252                  *   [0] => 'module'
 253                  *   [1] => 'arg1'
 254                  *   [2] => 'arg2'
 255                  *
 256                  *
 257                  * There will always be one argument. If provided a naked domain
 258                  * URL, $this->argv[0] is set to "home".
 259                  */
 260
 261                 $this->argv = explode('/', $this->cmd);
 262                 $this->argc = count($this->argv);
 263                 if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
 264                         $this->module = str_replace('.', '_', $this->argv[0]);
 265                         $this->module = str_replace('-', '_', $this->module);
 266                 } else {
 267                         $this->argc = 1;
 268                         $this->argv = ['home'];
 269                         $this->module = 'home';
 270                 }
 271
 272                 // See if there is any page number information, and initialise pagination
 273                 $this->pager['page'] = ((x($_GET, 'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
 274                 $this->pager['itemspage'] = 50;
 275                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 276
 277                 if ($this->pager['start'] < 0) {
 278                         $this->pager['start'] = 0;
 279                 }
 280                 $this->pager['total'] = 0;
 281
 282                 // Detect mobile devices
 283                 $mobile_detect = new MobileDetect();
 284                 $this->is_mobile = $mobile_detect->isMobile();
 285                 $this->is_tablet = $mobile_detect->isTablet();
 286
 287                 // Friendica-Client
 288                 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)');
 289
 290                 // Register template engines
 291                 $this->register_template_engine('Friendica\Render\FriendicaSmartyEngine');
 292
 293                 self::$a = $this;
 294         }
 295
 296         /**
 297          * @brief Returns the base filesystem path of the App
 298          *
 299          * It first checks for the internal variable, then for DOCUMENT_ROOT and
 300          * finally for PWD
 301          *
 302          * @return string
 303          */
 304         public function get_basepath()
 305         {
 306                 $basepath = $this->basepath;
 307
 308                 if (!$basepath) {
 309                         $basepath = Config::get('system', 'basepath');
 310                 }
 311
 312                 if (!$basepath && x($_SERVER, 'DOCUMENT_ROOT')) {
 313                         $basepath = $_SERVER['DOCUMENT_ROOT'];
 314                 }
 315
 316                 if (!$basepath && x($_SERVER, 'PWD')) {
 317                         $basepath = $_SERVER['PWD'];
 318                 }
 319
 320                 return self::realpath($basepath);
 321         }
 322
 323         /**
 324          * @brief Returns a normalized file path
 325          *
 326          * This is a wrapper for the "realpath" function.
 327          * That function cannot detect the real path when some folders aren't readable.
 328          * Since this could happen with some hosters we need to handle this.
 329          *
 330          * @param string $path The path that is about to be normalized
 331          * @return string normalized path - when possible
 332          */
 333         public static function realpath($path)
 334         {
 335                 $normalized = realpath($path);
 336
 337                 if (!is_bool($normalized)) {
 338                         return $normalized;
 339                 } else {
 340                         return $path;
 341                 }
 342         }
 343
 344         public function get_scheme()
 345         {
 346                 return $this->scheme;
 347         }
 348
 349         /**
 350          * @brief Retrieves the Friendica instance base URL
 351          *
 352          * This function assembles the base URL from multiple parts:
 353          * - Protocol is determined either by the request or a combination of
 354          * system.ssl_policy and the $ssl parameter.
 355          * - Host name is determined either by system.hostname or inferred from request
 356          * - Path is inferred from SCRIPT_NAME
 357          *
 358          * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
 359          *
 360          * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
 361          * @return string Friendica server base URL
 362          */
 363         public function get_baseurl($ssl = false)
 364         {
 365                 $scheme = $this->scheme;
 366
 367                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
 368                         $scheme = 'https';
 369                 }
 370
 371                 //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
 372                 //      (and also the login link). Anything seen by an outsider will have it turned off.
 373
 374                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
 375                         if ($ssl) {
 376                                 $scheme = 'https';
 377                         } else {
 378                                 $scheme = 'http';
 379                         }
 380                 }
 381
 382                 if (Config::get('config', 'hostname') != '') {
 383                         $this->hostname = Config::get('config', 'hostname');
 384                 }
 385
 386                 return $scheme . '://' . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
 387         }
 388
 389         /**
 390          * @brief Initializes the baseurl components
 391          *
 392          * Clears the baseurl cache to prevent inconsistencies
 393          *
 394          * @param string $url
 395          */
 396         public function set_baseurl($url)
 397         {
 398                 $parsed = @parse_url($url);
 399
 400                 if (x($parsed)) {
 401                         $this->scheme = $parsed['scheme'];
 402
 403                         $hostname = $parsed['host'];
 404                         if (x($parsed, 'port')) {
 405                                 $hostname .= ':' . $parsed['port'];
 406                         }
 407                         if (x($parsed, 'path')) {
 408                                 $this->path = trim($parsed['path'], '\\/');
 409                         }
 410
 411                         if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
 412                                 include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
 413                         }
 414
 415                         if (Config::get('config', 'hostname') != '') {
 416                                 $this->hostname = Config::get('config', 'hostname');
 417                         }
 418
 419                         if (!isset($this->hostname) || ( $this->hostname == '')) {
 420                                 $this->hostname = $hostname;
 421                         }
 422                 }
 423         }
 424
 425         public function get_hostname()
 426         {
 427                 if (Config::get('config', 'hostname') != '') {
 428                         $this->hostname = Config::get('config', 'hostname');
 429                 }
 430
 431                 return $this->hostname;
 432         }
 433
 434         public function get_path()
 435         {
 436                 return $this->path;
 437         }
 438
 439         public function set_pager_total($n)
 440         {
 441                 $this->pager['total'] = intval($n);
 442         }
 443
 444         public function set_pager_itemspage($n)
 445         {
 446                 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
 447                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 448         }
 449
 450         public function set_pager_page($n)
 451         {
 452                 $this->pager['page'] = $n;
 453                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 454         }
 455
 456         public function init_pagehead()
 457         {
 458                 $interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000);
 459
 460                 // If the update is 'deactivated' set it to the highest integer number (~24 days)
 461                 if ($interval < 0) {
 462                         $interval = 2147483647;
 463                 }
 464
 465                 if ($interval < 10000) {
 466                         $interval = 40000;
 467                 }
 468
 469                 // compose the page title from the sitename and the
 470                 // current module called
 471                 if (!$this->module == '') {
 472                         $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
 473                 } else {
 474                         $this->page['title'] = $this->config['sitename'];
 475                 }
 476
 477                 /* put the head template at the beginning of page['htmlhead']
 478                  * since the code added by the modules frequently depends on it
 479                  * being first
 480                  */
 481                 if (!isset($this->page['htmlhead'])) {
 482                         $this->page['htmlhead'] = '';
 483                 }
 484
 485                 // If we're using Smarty, then doing replace_macros() will replace
 486                 // any unrecognized variables with a blank string. Since we delay
 487                 // replacing $stylesheet until later, we need to replace it now
 488                 // with another variable name
 489                 if ($this->theme['template_engine'] === 'smarty3') {
 490                         $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
 491                 } else {
 492                         $stylesheet = '$stylesheet';
 493                 }
 494
 495                 $shortcut_icon = Config::get('system', 'shortcut_icon');
 496                 if ($shortcut_icon == '') {
 497                         $shortcut_icon = 'images/friendica-32.png';
 498                 }
 499
 500                 $touch_icon = Config::get('system', 'touch_icon');
 501                 if ($touch_icon == '') {
 502                         $touch_icon = 'images/friendica-128.png';
 503                 }
 504
 505                 // get data wich is needed for infinite scroll on the network page
 506                 $invinite_scroll = infinite_scroll_data($this->module);
 507
 508                 $tpl = get_markup_template('head.tpl');
 509                 $this->page['htmlhead'] = replace_macros($tpl, [
 510                         '$baseurl'         => $this->get_baseurl(),
 511                         '$local_user'      => local_user(),
 512                         '$generator'       => 'Friendica' . ' ' . FRIENDICA_VERSION,
 513                         '$delitem'         => L10n::t('Delete this item?'),
 514                         '$showmore'        => L10n::t('show more'),
 515                         '$showfewer'       => L10n::t('show fewer'),
 516                         '$update_interval' => $interval,
 517                         '$shortcut_icon'   => $shortcut_icon,
 518                         '$touch_icon'      => $touch_icon,
 519                         '$stylesheet'      => $stylesheet,
 520                         '$infinite_scroll' => $invinite_scroll,
 521                 ]) . $this->page['htmlhead'];
 522         }
 523
 524         public function init_page_end()
 525         {
 526                 if (!isset($this->page['end'])) {
 527                         $this->page['end'] = '';
 528                 }
 529                 $tpl = get_markup_template('end.tpl');
 530                 $this->page['end'] = replace_macros($tpl, [
 531                         '$baseurl' => $this->get_baseurl()
 532                 ]) . $this->page['end'];
 533         }
 534
 535         public function set_curl_code($code)
 536         {
 537                 $this->curl_code = $code;
 538         }
 539
 540         public function get_curl_code()
 541         {
 542                 return $this->curl_code;
 543         }
 544
 545         public function set_curl_content_type($content_type)
 546         {
 547                 $this->curl_content_type = $content_type;
 548         }
 549
 550         public function get_curl_content_type()
 551         {
 552                 return $this->curl_content_type;
 553         }
 554
 555         public function set_curl_headers($headers)
 556         {
 557                 $this->curl_headers = $headers;
 558         }
 559
 560         public function get_curl_headers()
 561         {
 562                 return $this->curl_headers;
 563         }
 564
 565         /**
 566          * @brief Removes the base url from an url. This avoids some mixed content problems.
 567          *
 568          * @param string $orig_url
 569          *
 570          * @return string The cleaned url
 571          */
 572         public function remove_baseurl($orig_url)
 573         {
 574                 // Remove the hostname from the url if it is an internal link
 575                 $nurl = normalise_link($orig_url);
 576                 $base = normalise_link($this->get_baseurl());
 577                 $url = str_replace($base . '/', '', $nurl);
 578
 579                 // if it is an external link return the orignal value
 580                 if ($url == normalise_link($orig_url)) {
 581                         return $orig_url;
 582                 } else {
 583                         return $url;
 584                 }
 585         }
 586
 587         /**
 588          * @brief Register template engine class
 589          *
 590          * @param string $class
 591          */
 592         private function register_template_engine($class)
 593         {
 594                 $v = get_class_vars($class);
 595                 if (x($v, 'name')) {
 596                         $name = $v['name'];
 597                         $this->template_engines[$name] = $class;
 598                 } else {
 599                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
 600                         die();
 601                 }
 602         }
 603
 604         /**
 605          * @brief Return template engine instance.
 606          *
 607          * If $name is not defined, return engine defined by theme,
 608          * or default
 609          *
 610          * @return object Template Engine instance
 611          */
 612         public function template_engine()
 613         {
 614                 $template_engine = 'smarty3';
 615                 if (x($this->theme, 'template_engine')) {
 616                         $template_engine = $this->theme['template_engine'];
 617                 }
 618
 619                 if (isset($this->template_engines[$template_engine])) {
 620                         if (isset($this->template_engine_instance[$template_engine])) {
 621                                 return $this->template_engine_instance[$template_engine];
 622                         } else {
 623                                 $class = $this->template_engines[$template_engine];
 624                                 $obj = new $class;
 625                                 $this->template_engine_instance[$template_engine] = $obj;
 626                                 return $obj;
 627                         }
 628                 }
 629
 630                 echo "template engine <tt>$template_engine</tt> is not registered!\n";
 631                 killme();
 632         }
 633
 634         /**
 635          * @brief Returns the active template engine.
 636          *
 637          * @return string
 638          */
 639         public function get_template_engine()
 640         {
 641                 return $this->theme['template_engine'];
 642         }
 643
 644         public function set_template_engine($engine = 'smarty3')
 645         {
 646                 $this->theme['template_engine'] = $engine;
 647         }
 648
 649         public function get_template_ldelim($engine = 'smarty3')
 650         {
 651                 return $this->ldelim[$engine];
 652         }
 653
 654         public function get_template_rdelim($engine = 'smarty3')
 655         {
 656                 return $this->rdelim[$engine];
 657         }
 658
 659         public function save_timestamp($stamp, $value)
 660         {
 661                 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
 662                         return;
 663                 }
 664
 665                 $duration = (float) (microtime(true) - $stamp);
 666
 667                 if (!isset($this->performance[$value])) {
 668                         // Prevent ugly E_NOTICE
 669                         $this->performance[$value] = 0;
 670                 }
 671
 672                 $this->performance[$value] += (float) $duration;
 673                 $this->performance['marktime'] += (float) $duration;
 674
 675                 $callstack = System::callstack();
 676
 677                 if (!isset($this->callstack[$value][$callstack])) {
 678                         // Prevent ugly E_NOTICE
 679                         $this->callstack[$value][$callstack] = 0;
 680                 }
 681
 682                 $this->callstack[$value][$callstack] += (float) $duration;
 683         }
 684
 685         public function get_useragent()
 686         {
 687                 return
 688                         FRIENDICA_PLATFORM . " '" .
 689                         FRIENDICA_CODENAME . "' " .
 690                         FRIENDICA_VERSION . '-' .
 691                         DB_UPDATE_VERSION . '; ' .
 692                         $this->get_baseurl();
 693         }
 694
 695         public function is_friendica_app()
 696         {
 697                 return $this->is_friendica_app;
 698         }
 699
 700         /**
 701          * @brief Checks if the site is called via a backend process
 702          *
 703          * This isn't a perfect solution. But we need this check very early.
 704          * So we cannot wait until the modules are loaded.
 705          *
 706          * @return bool Is it a known backend?
 707          */
 708         public function is_backend()
 709         {
 710                 static $backends = [
 711                         '_well_known',
 712                         'api',
 713                         'dfrn_notify',
 714                         'fetch',
 715                         'hcard',
 716                         'hostxrd',
 717                         'nodeinfo',
 718                         'noscrape',
 719                         'p',
 720                         'poco',
 721                         'post',
 722                         'proxy',
 723                         'pubsub',
 724                         'pubsubhubbub',
 725                         'receive',
 726                         'rsd_xml',
 727                         'salmon',
 728                         'statistics_json',
 729                         'xrd',
 730                 ];
 731
 732                 // Check if current module is in backend or backend flag is set
 733                 return (in_array($this->module, $backends) || $this->backend);
 734         }
 735
 736         /**
 737          * @brief Checks if the maximum number of database processes is reached
 738          *
 739          * @return bool Is the limit reached?
 740          */
 741         public function max_processes_reached()
 742         {
 743                 // Deactivated, needs more investigating if this check really makes sense
 744                 return false;
 745
 746                 /*
 747                  * Commented out to suppress static analyzer issues
 748                  *
 749                 if ($this->is_backend()) {
 750                         $process = 'backend';
 751                         $max_processes = Config::get('system', 'max_processes_backend');
 752                         if (intval($max_processes) == 0) {
 753                                 $max_processes = 5;
 754                         }
 755                 } else {
 756                         $process = 'frontend';
 757                         $max_processes = Config::get('system', 'max_processes_frontend');
 758                         if (intval($max_processes) == 0) {
 759                                 $max_processes = 20;
 760                         }
 761                 }
 762
 763                 $processlist = DBM::processlist();
 764                 if ($processlist['list'] != '') {
 765                         logger('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], LOGGER_DEBUG);
 766
 767                         if ($processlist['amount'] > $max_processes) {
 768                                 logger('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', LOGGER_DEBUG);
 769                                 return true;
 770                         }
 771                 }
 772                 return false;
 773                  */
 774         }
 775
 776         /**
 777          * @brief Checks if the minimal memory is reached
 778          *
 779          * @return bool Is the memory limit reached?
 780          */
 781         public function min_memory_reached()
 782         {
 783                 $min_memory = Config::get('system', 'min_memory', 0);
 784                 if ($min_memory == 0) {
 785                         return false;
 786                 }
 787
 788                 if (!is_readable('/proc/meminfo')) {
 789                         return false;
 790                 }
 791
 792                 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
 793
 794                 $meminfo = [];
 795                 foreach ($memdata as $line) {
 796                         list($key, $val) = explode(':', $line);
 797                         $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
 798                         $meminfo[$key] = (int) ($meminfo[$key] / 1024);
 799                 }
 800
 801                 if (!isset($meminfo['MemAvailable']) || !isset($meminfo['MemFree'])) {
 802                         return false;
 803                 }
 804
 805                 $free = $meminfo['MemAvailable'] + $meminfo['MemFree'];
 806
 807                 $reached = ($free < $min_memory);
 808
 809                 if ($reached) {
 810                         logger('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, LOGGER_DEBUG);
 811                 }
 812
 813                 return $reached;
 814         }
 815
 816         /**
 817          * @brief Checks if the maximum load is reached
 818          *
 819          * @return bool Is the load reached?
 820          */
 821         public function maxload_reached()
 822         {
 823                 if ($this->is_backend()) {
 824                         $process = 'backend';
 825                         $maxsysload = intval(Config::get('system', 'maxloadavg'));
 826                         if ($maxsysload < 1) {
 827                                 $maxsysload = 50;
 828                         }
 829                 } else {
 830                         $process = 'frontend';
 831                         $maxsysload = intval(Config::get('system', 'maxloadavg_frontend'));
 832                         if ($maxsysload < 1) {
 833                                 $maxsysload = 50;
 834                         }
 835                 }
 836
 837                 $load = current_load();
 838                 if ($load) {
 839                         if (intval($load) > $maxsysload) {
 840                                 logger('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
 841                                 return true;
 842                         }
 843                 }
 844                 return false;
 845         }
 846
 847         public function proc_run($args)
 848         {
 849                 if (!function_exists('proc_open')) {
 850                         return;
 851                 }
 852
 853                 // If the last worker fork was less than 2 seconds before then don't fork another one.
 854                 // This should prevent the forking of masses of workers.
 855                 $cachekey = 'app:proc_run:started';
 856                 $result = Cache::get($cachekey);
 857
 858                 if (!is_null($result) && ( time() - $result) < 2) {
 859                         return;
 860                 }
 861
 862                 // Set the timestamp of the last proc_run
 863                 Cache::set($cachekey, time(), CACHE_MINUTE);
 864
 865                 array_unshift($args, ((x($this->config, 'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php'));
 866
 867                 // add baseurl to args. cli scripts can't construct it
 868                 $args[] = $this->get_baseurl();
 869
 870                 for ($x = 0; $x < count($args); $x ++) {
 871                         $args[$x] = escapeshellarg($args[$x]);
 872                 }
 873
 874                 $cmdline = implode(' ', $args);
 875
 876                 if ($this->min_memory_reached()) {
 877                         return;
 878                 }
 879
 880                 if (Config::get('system', 'proc_windows')) {
 881                         $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->get_basepath());
 882                 } else {
 883                         $resource = proc_open($cmdline . ' &', [], $foo, $this->get_basepath());
 884                 }
 885                 if (!is_resource($resource)) {
 886                         logger('We got no resource for command ' . $cmdline, LOGGER_DEBUG);
 887                         return;
 888                 }
 889                 proc_close($resource);
 890         }
 891
 892         /**
 893          * @brief Returns the system user that is executing the script
 894          *
 895          * This mostly returns something like "www-data".
 896          *
 897          * @return string system username
 898          */
 899         private static function systemuser()
 900         {
 901                 if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
 902                         return '';
 903                 }
 904
 905                 $processUser = posix_getpwuid(posix_geteuid());
 906                 return $processUser['name'];
 907         }
 908
 909         /**
 910          * @brief Checks if a given directory is usable for the system
 911          *
 912          * @return boolean the directory is usable
 913          */
 914         public static function directory_usable($directory, $check_writable = true)
 915         {
 916                 if ($directory == '') {
 917                         logger('Directory is empty. This shouldn\'t happen.', LOGGER_DEBUG);
 918                         return false;
 919                 }
 920
 921                 if (!file_exists($directory)) {
 922                         logger('Path "' . $directory . '" does not exist for user ' . self::systemuser(), LOGGER_DEBUG);
 923                         return false;
 924                 }
 925
 926                 if (is_file($directory)) {
 927                         logger('Path "' . $directory . '" is a file for user ' . self::systemuser(), LOGGER_DEBUG);
 928                         return false;
 929                 }
 930
 931                 if (!is_dir($directory)) {
 932                         logger('Path "' . $directory . '" is not a directory for user ' . self::systemuser(), LOGGER_DEBUG);
 933                         return false;
 934                 }
 935
 936                 if ($check_writable && !is_writable($directory)) {
 937                         logger('Path "' . $directory . '" is not writable for user ' . self::systemuser(), LOGGER_DEBUG);
 938                         return false;
 939                 }
 940
 941                 return true;
 942         }
 943 }