]> git.mxchange.org Git - friendica.git/blob - src/App.php
Improve comparison in App->loadDatabase()
[friendica.git] / src / App.php
1 <?php
2 /**
3  * @file src/App.php
4  */
5 namespace Friendica;
6
7 use Friendica\Core\Config;
8 use Friendica\Core\L10n;
9 use Friendica\Core\PConfig;
10 use Friendica\Core\System;
11 use Friendica\Database\DBM;
12 use dba;
13
14 use Detection\MobileDetect;
15
16 use Exception;
17
18 require_once 'boot.php';
19 require_once 'include/dba.php';
20 require_once 'include/text.php';
21
22 /**
23  *
24  * class: App
25  *
26  * @brief Our main application structure for the life of this page.
27  *
28  * Primarily deals with the URL that got us here
29  * and tries to make some sense of it, and
30  * stores our page contents and config storage
31  * and anything else that might need to be passed around
32  * before we spit the page out.
33  *
34  */
35 class App
36 {
37         const MODE_LOCALCONFIGPRESENT = 1;
38         const MODE_DBAVAILABLE = 2;
39         const MODE_DBCONFIGAVAILABLE = 4;
40         const MODE_MAINTENANCEDISABLED = 8;
41
42         /**
43          * @deprecated since version 2008.08 Use App->isInstallMode() instead to check for install mode.
44          */
45         const MODE_INSTALL = 0;
46
47         /**
48          * @deprecated since version 2008.08 Use the precise mode constant to check for a specific capability instead.
49          */
50         const MODE_NORMAL = App::MODE_LOCALCONFIGPRESENT | App::MODE_DBAVAILABLE | App::MODE_DBCONFIGAVAILABLE | App::MODE_MAINTENANCEDISABLED;
51
52         public $module_loaded = false;
53         public $module_class = null;
54         public $query_string = '';
55         public $config = [];
56         public $page = [];
57         public $pager = [];
58         public $page_offset;
59         public $profile;
60         public $profile_uid;
61         public $user;
62         public $cid;
63         public $contact;
64         public $contacts;
65         public $page_contact;
66         public $content;
67         public $data = [];
68         public $error = false;
69         public $cmd = '';
70         public $argv;
71         public $argc;
72         public $module;
73         public $mode = App::MODE_INSTALL;
74         public $strings;
75         public $basepath;
76         public $urlpath;
77         public $hooks = [];
78         public $timezone;
79         public $interactive = true;
80         public $addons;
81         public $addons_admin = [];
82         public $apps = [];
83         public $identities;
84         public $is_mobile = false;
85         public $is_tablet = false;
86         public $is_friendica_app;
87         public $performance = [];
88         public $callstack = [];
89         public $theme_info = [];
90         public $backend = true;
91         public $nav_sel;
92         public $category;
93         // Allow themes to control internal parameters
94         // by changing App values in theme.php
95
96         public $sourcename = '';
97         public $videowidth = 425;
98         public $videoheight = 350;
99         public $force_max_items = 0;
100         public $theme_events_in_profile = true;
101
102         /**
103          * @brief An array for all theme-controllable parameters
104          *
105          * Mostly unimplemented yet. Only options 'template_engine' and
106          * beyond are used.
107          */
108         public $theme = [
109                 'sourcename' => '',
110                 'videowidth' => 425,
111                 'videoheight' => 350,
112                 'force_max_items' => 0,
113                 'stylesheet' => '',
114                 'template_engine' => 'smarty3',
115         ];
116
117         /**
118          * @brief An array of registered template engines ('name'=>'class name')
119          */
120         public $template_engines = [];
121
122         /**
123          * @brief An array of instanced template engines ('name'=>'instance')
124          */
125         public $template_engine_instance = [];
126         public $process_id;
127         public $queue;
128         private $ldelim = [
129                 'internal' => '',
130                 'smarty3' => '{{'
131         ];
132         private $rdelim = [
133                 'internal' => '',
134                 'smarty3' => '}}'
135         ];
136         private $scheme;
137         private $hostname;
138         private $curl_code;
139         private $curl_content_type;
140         private $curl_headers;
141
142         /**
143          * @brief App constructor.
144          *
145          * @param string $basepath Path to the app base folder
146          */
147         public function __construct($basepath)
148         {
149                 if (!static::directory_usable($basepath, false)) {
150                         throw new Exception('Basepath ' . $basepath . ' isn\'t usable.');
151                 }
152
153                 BaseObject::setApp($this);
154
155                 $this->basepath = rtrim($basepath, DIRECTORY_SEPARATOR);
156
157                 // The order of the following calls is important to ensure proper initialization
158                 $this->loadConfigFiles();
159
160                 $this->loadDatabase();
161
162                 $this->determineMode();
163
164                 $this->determineUrlPath();
165
166                 Config::load();
167
168                 if ($this->mode & self::MODE_DBAVAILABLE) {
169                         Core\Addon::loadHooks();
170
171                         $this->loadAddonConfig();
172                 }
173
174                 $this->loadDefaultTimezone();
175
176                 $this->performance['start'] = microtime(true);
177                 $this->performance['database'] = 0;
178                 $this->performance['database_write'] = 0;
179                 $this->performance['cache'] = 0;
180                 $this->performance['cache_write'] = 0;
181                 $this->performance['network'] = 0;
182                 $this->performance['file'] = 0;
183                 $this->performance['rendering'] = 0;
184                 $this->performance['parser'] = 0;
185                 $this->performance['marktime'] = 0;
186                 $this->performance['markstart'] = microtime(true);
187
188                 $this->callstack['database'] = [];
189                 $this->callstack['database_write'] = [];
190                 $this->callstack['cache'] = [];
191                 $this->callstack['cache_write'] = [];
192                 $this->callstack['network'] = [];
193                 $this->callstack['file'] = [];
194                 $this->callstack['rendering'] = [];
195                 $this->callstack['parser'] = [];
196
197                 $this->page = [
198                         'aside' => '',
199                         'bottom' => '',
200                         'content' => '',
201                         'end' => '',
202                         'footer' => '',
203                         'htmlhead' => '',
204                         'nav' => '',
205                         'page_title' => '',
206                         'right_aside' => '',
207                         'template' => '',
208                         'title' => ''
209                 ];
210
211                 $this->process_id = System::processID('log');
212
213                 set_time_limit(0);
214
215                 // This has to be quite large to deal with embedded private photos
216                 ini_set('pcre.backtrack_limit', 500000);
217
218                 $this->scheme = 'http';
219
220                 if ((x($_SERVER, 'HTTPS') && $_SERVER['HTTPS']) ||
221                         (x($_SERVER, 'HTTP_FORWARDED') && preg_match('/proto=https/', $_SERVER['HTTP_FORWARDED'])) ||
222                         (x($_SERVER, 'HTTP_X_FORWARDED_PROTO') && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
223                         (x($_SERVER, 'HTTP_X_FORWARDED_SSL') && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
224                         (x($_SERVER, 'FRONT_END_HTTPS') && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
225                         (x($_SERVER, 'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
226                 ) {
227                         $this->scheme = 'https';
228                 }
229
230                 if (x($_SERVER, 'SERVER_NAME')) {
231                         $this->hostname = $_SERVER['SERVER_NAME'];
232
233                         if (x($_SERVER, 'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
234                                 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
235                         }
236                 }
237
238                 set_include_path(
239                         get_include_path() . PATH_SEPARATOR
240                         . $this->basepath . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
241                         . $this->basepath . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
242                         . $this->basepath);
243
244                 if ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 9) === 'pagename=') {
245                         $this->query_string = substr($_SERVER['QUERY_STRING'], 9);
246                 } elseif ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 2) === 'q=') {
247                         $this->query_string = substr($_SERVER['QUERY_STRING'], 2);
248                 }
249
250                 // removing trailing / - maybe a nginx problem
251                 $this->query_string = ltrim($this->query_string, '/');
252
253                 if (!empty($_GET['pagename'])) {
254                         $this->cmd = trim($_GET['pagename'], '/\\');
255                 } elseif (!empty($_GET['q'])) {
256                         $this->cmd = trim($_GET['q'], '/\\');
257                 }
258
259                 // fix query_string
260                 $this->query_string = str_replace($this->cmd . '&', $this->cmd . '?', $this->query_string);
261
262                 // unix style "homedir"
263                 if (substr($this->cmd, 0, 1) === '~') {
264                         $this->cmd = 'profile/' . substr($this->cmd, 1);
265                 }
266
267                 // Diaspora style profile url
268                 if (substr($this->cmd, 0, 2) === 'u/') {
269                         $this->cmd = 'profile/' . substr($this->cmd, 2);
270                 }
271
272                 /*
273                  * Break the URL path into C style argc/argv style arguments for our
274                  * modules. Given "http://example.com/module/arg1/arg2", $this->argc
275                  * will be 3 (integer) and $this->argv will contain:
276                  *   [0] => 'module'
277                  *   [1] => 'arg1'
278                  *   [2] => 'arg2'
279                  *
280                  *
281                  * There will always be one argument. If provided a naked domain
282                  * URL, $this->argv[0] is set to "home".
283                  */
284
285                 $this->argv = explode('/', $this->cmd);
286                 $this->argc = count($this->argv);
287                 if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
288                         $this->module = str_replace('.', '_', $this->argv[0]);
289                         $this->module = str_replace('-', '_', $this->module);
290                 } else {
291                         $this->argc = 1;
292                         $this->argv = ['home'];
293                         $this->module = 'home';
294                 }
295
296                 // See if there is any page number information, and initialise pagination
297                 $this->pager['page'] = ((x($_GET, 'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
298                 $this->pager['itemspage'] = 50;
299                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
300
301                 if ($this->pager['start'] < 0) {
302                         $this->pager['start'] = 0;
303                 }
304                 $this->pager['total'] = 0;
305
306                 // Detect mobile devices
307                 $mobile_detect = new MobileDetect();
308                 $this->is_mobile = $mobile_detect->isMobile();
309                 $this->is_tablet = $mobile_detect->isTablet();
310
311                 // Friendica-Client
312                 $this->is_friendica_app = isset($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)';
313
314                 // Register template engines
315                 $this->register_template_engine('Friendica\Render\FriendicaSmartyEngine');
316         }
317
318         /**
319          * Load the configuration files
320          *
321          * First loads the default value for all the configuration keys, then the legacy configuration files, then the
322          * expected local.ini.php
323          */
324         private function loadConfigFiles()
325         {
326                 $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'defaults.ini.php');
327
328                 // Legacy .htconfig.php support
329                 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
330                         $a = $this;
331                         include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
332                 }
333
334                 // Legacy .htconfig.php support
335                 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
336                         $a = $this;
337
338                         include $this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php';
339                         unset($db_host, $db_user, $db_pass, $db_data);
340
341                         if (isset($default_timezone)) {
342                                 $this->setConfigValue('system', 'default_timezone', $default_timezone);
343                                 unset($default_timezone);
344                         }
345
346                         if (isset($pidfile)) {
347                                 $this->setConfigValue('system', 'pidfile', $pidfile);
348                                 unset($pidfile);
349                         }
350                 }
351
352                 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')) {
353                         $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php');
354                 }
355         }
356
357         /**
358          * Tries to load the specified configuration file into the App->config array.
359          * Overwrites previously set values.
360          *
361          * The config format is INI and the template for configuration files is the following:
362          *
363          * <?php return <<<INI
364          *
365          * [section]
366          * key = value
367          *
368          * INI;
369          * // Keep this line
370          *
371          * @param type $filepath
372          * @throws Exception
373          */
374         public function loadConfigFile($filepath)
375         {
376                 if (!file_exists($filepath)) {
377                         throw new Exception('Error parsing non-existent config file ' . $filepath);
378                 }
379
380                 $contents = include($filepath);
381
382                 $config = parse_ini_string($contents, true, INI_SCANNER_TYPED);
383
384                 if ($config === false) {
385                         throw new Exception('Error parsing config file ' . $filepath);
386                 }
387
388                 foreach($config as $category => $values) {
389                         foreach($values as $key => $value) {
390                                 $this->setConfigValue($category, $key, $value);
391                         }
392                 }
393         }
394
395         /**
396          * Loads addons configuration files
397          *
398          * First loads all activated addons default configuration throught the load_config hook, then load the local.ini.php
399          * again to overwrite potential local addon configuration.
400          */
401         private function loadAddonConfig()
402         {
403                 // Loads addons default config
404                 Core\Addon::callHooks('load_config');
405
406                 // Load the local config file again in case there are overwritten addon config
407                 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')) {
408                         $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php');
409                 }
410         }
411
412         /**
413          * Loads the default timezone
414          *
415          * Include support for legacy $default_timezone
416          *
417          * @global string $default_timezone
418          */
419         private function loadDefaultTimezone()
420         {
421                 if ($this->getConfigValue('system', 'default_timezone')) {
422                         $this->timezone = $this->getConfigValue('system', 'default_timezone');
423                 } else {
424                         global $default_timezone;
425                         $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
426                 }
427
428                 if ($this->timezone) {
429                         date_default_timezone_set($this->timezone);
430                 }
431         }
432
433         /**
434          * Figure out if we are running at the top of a domain or in a sub-directory and adjust accordingly
435          */
436         private function determineUrlPath()
437         {
438                 $this->urlpath = $this->getConfigValue('system', 'urlpath');
439
440                 /* SCRIPT_URL gives /path/to/friendica/module/parameter
441                  * QUERY_STRING gives pagename=module/parameter
442                  *
443                  * To get /path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
444                  */
445                 if (!empty($_SERVER['SCRIPT_URL']) && !empty($_SERVER['QUERY_STRING'])) {
446                         $path = trim(dirname($_SERVER['SCRIPT_URL'], substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
447
448                         if ($path && $path != $this->urlpath) {
449                                 $this->urlpath = $path;
450                         }
451                 }
452         }
453
454         /**
455          * Sets the App mode
456          *
457          * - App::MODE_INSTALL    : Either the database connection can't be established or the config table doesn't exist
458          * - App::MODE_MAINTENANCE: The maintenance mode has been set
459          * - App::MODE_NORMAL     : Normal run with all features enabled
460          *
461          * @return type
462          */
463         private function determineMode()
464         {
465                 $this->mode = 0;
466
467                 if (!file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')
468                         && !file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
469                         return;
470                 }
471
472                 $this->mode |= App::MODE_LOCALCONFIGPRESENT;
473
474                 if (!\dba::connected()) {
475                         return;
476                 }
477
478                 $this->mode |= App::MODE_DBAVAILABLE;
479
480                 if (\dba::fetch_first("SHOW TABLES LIKE 'config'") === false) {
481                         return;
482                 }
483
484                 $this->mode |= App::MODE_DBCONFIGAVAILABLE;
485
486                 if (Config::get('system', 'maintenance')) {
487                         return;
488                 }
489
490                 $this->mode |= App::MODE_MAINTENANCEDISABLED;
491         }
492
493         public function loadDatabase()
494         {
495                 if (\dba::connected()) {
496                         return;
497                 }
498
499                 $db_host = $this->getConfigValue('database', 'hostname');
500                 $db_user = $this->getConfigValue('database', 'username');
501                 $db_pass = $this->getConfigValue('database', 'password');
502                 $db_data = $this->getConfigValue('database', 'database');
503                 $charset = $this->getConfigValue('database', 'charset');
504
505                 // Use environment variables for mysql if they are set beforehand
506                 if (!empty(getenv('MYSQL_HOST'))
507                         && (!empty(getenv('MYSQL_USERNAME')) || !empty(getenv('MYSQL_USER')))
508                         && getenv('MYSQL_PASSWORD') !== false
509                         && !empty(getenv('MYSQL_DATABASE')))
510                 {
511                         $db_host = getenv('MYSQL_HOST');
512                         if (!empty(getenv('MYSQL_PORT'))) {
513                                 $db_host .= ':' . getenv('MYSQL_PORT');
514                         }
515                         if (!empty(getenv('MYSQL_USERNAME'))) {
516                                 $db_user = getenv('MYSQL_USERNAME');
517                         } else {
518                                 $db_user = getenv('MYSQL_USER');
519                         }
520                         $db_pass = (string) getenv('MYSQL_PASSWORD');
521                         $db_data = getenv('MYSQL_DATABASE');
522                 } elseif (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
523                         $a = new \stdClass();
524                         include $this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php';
525                         $charset = isset($a->config["system"]["db_charset"]) ? $a->config["system"]["db_charset"] : $charset;
526
527                         unset($a);
528                 }
529
530                 $stamp1 = microtime(true);
531
532                 \dba::connect($db_host, $db_user, $db_pass, $db_data, $charset);
533                 unset($db_host, $db_user, $db_pass, $db_data, $charset);
534
535                 $this->save_timestamp($stamp1, "network");
536         }
537
538         /**
539          * Install mode is when the local config file is missing or the DB schema hasn't been installed yet.
540          *
541          * @return bool
542          */
543         public function isInstallMode()
544         {
545                 return !($this->mode & App::MODE_LOCALCONFIGPRESENT) || !($this->mode & App::MODE_DBCONFIGAVAILABLE);
546         }
547
548         /**
549          * @brief Returns the base filesystem path of the App
550          *
551          * It first checks for the internal variable, then for DOCUMENT_ROOT and
552          * finally for PWD
553          *
554          * @return string
555          */
556         public function get_basepath()
557         {
558                 $basepath = $this->basepath;
559
560                 if (!$basepath) {
561                         $basepath = Config::get('system', 'basepath');
562                 }
563
564                 if (!$basepath && x($_SERVER, 'DOCUMENT_ROOT')) {
565                         $basepath = $_SERVER['DOCUMENT_ROOT'];
566                 }
567
568                 if (!$basepath && x($_SERVER, 'PWD')) {
569                         $basepath = $_SERVER['PWD'];
570                 }
571
572                 return self::realpath($basepath);
573         }
574
575         /**
576          * @brief Returns a normalized file path
577          *
578          * This is a wrapper for the "realpath" function.
579          * That function cannot detect the real path when some folders aren't readable.
580          * Since this could happen with some hosters we need to handle this.
581          *
582          * @param string $path The path that is about to be normalized
583          * @return string normalized path - when possible
584          */
585         public static function realpath($path)
586         {
587                 $normalized = realpath($path);
588
589                 if (!is_bool($normalized)) {
590                         return $normalized;
591                 } else {
592                         return $path;
593                 }
594         }
595
596         public function get_scheme()
597         {
598                 return $this->scheme;
599         }
600
601         /**
602          * @brief Retrieves the Friendica instance base URL
603          *
604          * This function assembles the base URL from multiple parts:
605          * - Protocol is determined either by the request or a combination of
606          * system.ssl_policy and the $ssl parameter.
607          * - Host name is determined either by system.hostname or inferred from request
608          * - Path is inferred from SCRIPT_NAME
609          *
610          * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
611          *
612          * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
613          * @return string Friendica server base URL
614          */
615         public function get_baseurl($ssl = false)
616         {
617                 $scheme = $this->scheme;
618
619                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
620                         $scheme = 'https';
621                 }
622
623                 //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
624                 //      (and also the login link). Anything seen by an outsider will have it turned off.
625
626                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
627                         if ($ssl) {
628                                 $scheme = 'https';
629                         } else {
630                                 $scheme = 'http';
631                         }
632                 }
633
634                 if (Config::get('config', 'hostname') != '') {
635                         $this->hostname = Config::get('config', 'hostname');
636                 }
637
638                 return $scheme . '://' . $this->hostname . (!empty($this->urlpath) ? '/' . $this->urlpath : '' );
639         }
640
641         /**
642          * @brief Initializes the baseurl components
643          *
644          * Clears the baseurl cache to prevent inconsistencies
645          *
646          * @param string $url
647          */
648         public function set_baseurl($url)
649         {
650                 $parsed = @parse_url($url);
651                 $hostname = '';
652
653                 if (x($parsed)) {
654                         if (!empty($parsed['scheme'])) {
655                                 $this->scheme = $parsed['scheme'];
656                         }
657
658                         if (!empty($parsed['host'])) {
659                                 $hostname = $parsed['host'];
660                         }
661
662                         if (x($parsed, 'port')) {
663                                 $hostname .= ':' . $parsed['port'];
664                         }
665                         if (x($parsed, 'path')) {
666                                 $this->urlpath = trim($parsed['path'], '\\/');
667                         }
668
669                         if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
670                                 include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
671                         }
672
673                         if (Config::get('config', 'hostname') != '') {
674                                 $this->hostname = Config::get('config', 'hostname');
675                         }
676
677                         if (!isset($this->hostname) || ($this->hostname == '')) {
678                                 $this->hostname = $hostname;
679                         }
680                 }
681         }
682
683         public function get_hostname()
684         {
685                 if (Config::get('config', 'hostname') != '') {
686                         $this->hostname = Config::get('config', 'hostname');
687                 }
688
689                 return $this->hostname;
690         }
691
692         public function get_path()
693         {
694                 return $this->urlpath;
695         }
696
697         public function set_pager_total($n)
698         {
699                 $this->pager['total'] = intval($n);
700         }
701
702         public function set_pager_itemspage($n)
703         {
704                 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
705                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
706         }
707
708         public function set_pager_page($n)
709         {
710                 $this->pager['page'] = $n;
711                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
712         }
713
714         public function init_pagehead()
715         {
716                 $interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000);
717
718                 // If the update is 'deactivated' set it to the highest integer number (~24 days)
719                 if ($interval < 0) {
720                         $interval = 2147483647;
721                 }
722
723                 if ($interval < 10000) {
724                         $interval = 40000;
725                 }
726
727                 // compose the page title from the sitename and the
728                 // current module called
729                 if (!$this->module == '') {
730                         $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
731                 } else {
732                         $this->page['title'] = $this->config['sitename'];
733                 }
734
735                 /* put the head template at the beginning of page['htmlhead']
736                  * since the code added by the modules frequently depends on it
737                  * being first
738                  */
739                 if (!isset($this->page['htmlhead'])) {
740                         $this->page['htmlhead'] = '';
741                 }
742
743                 // If we're using Smarty, then doing replace_macros() will replace
744                 // any unrecognized variables with a blank string. Since we delay
745                 // replacing $stylesheet until later, we need to replace it now
746                 // with another variable name
747                 if ($this->theme['template_engine'] === 'smarty3') {
748                         $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
749                 } else {
750                         $stylesheet = '$stylesheet';
751                 }
752
753                 $shortcut_icon = Config::get('system', 'shortcut_icon');
754                 if ($shortcut_icon == '') {
755                         $shortcut_icon = 'images/friendica-32.png';
756                 }
757
758                 $touch_icon = Config::get('system', 'touch_icon');
759                 if ($touch_icon == '') {
760                         $touch_icon = 'images/friendica-128.png';
761                 }
762
763                 // get data wich is needed for infinite scroll on the network page
764                 $invinite_scroll = infinite_scroll_data($this->module);
765
766                 $tpl = get_markup_template('head.tpl');
767                 $this->page['htmlhead'] = replace_macros($tpl, [
768                         '$baseurl'         => $this->get_baseurl(),
769                         '$local_user'      => local_user(),
770                         '$generator'       => 'Friendica' . ' ' . FRIENDICA_VERSION,
771                         '$delitem'         => L10n::t('Delete this item?'),
772                         '$showmore'        => L10n::t('show more'),
773                         '$showfewer'       => L10n::t('show fewer'),
774                         '$update_interval' => $interval,
775                         '$shortcut_icon'   => $shortcut_icon,
776                         '$touch_icon'      => $touch_icon,
777                         '$stylesheet'      => $stylesheet,
778                         '$infinite_scroll' => $invinite_scroll,
779                         '$block_public'    => intval(Config::get('system', 'block_public')),
780                 ]) . $this->page['htmlhead'];
781         }
782
783         public function init_page_end()
784         {
785                 if (!isset($this->page['end'])) {
786                         $this->page['end'] = '';
787                 }
788                 $tpl = get_markup_template('end.tpl');
789                 $this->page['end'] = replace_macros($tpl, [
790                         '$baseurl' => $this->get_baseurl()
791                 ]) . $this->page['end'];
792         }
793
794         public function set_curl_code($code)
795         {
796                 $this->curl_code = $code;
797         }
798
799         public function get_curl_code()
800         {
801                 return $this->curl_code;
802         }
803
804         public function set_curl_content_type($content_type)
805         {
806                 $this->curl_content_type = $content_type;
807         }
808
809         public function get_curl_content_type()
810         {
811                 return $this->curl_content_type;
812         }
813
814         public function set_curl_headers($headers)
815         {
816                 $this->curl_headers = $headers;
817         }
818
819         public function get_curl_headers()
820         {
821                 return $this->curl_headers;
822         }
823
824         /**
825          * @brief Removes the base url from an url. This avoids some mixed content problems.
826          *
827          * @param string $orig_url
828          *
829          * @return string The cleaned url
830          */
831         public function remove_baseurl($orig_url)
832         {
833                 // Remove the hostname from the url if it is an internal link
834                 $nurl = normalise_link($orig_url);
835                 $base = normalise_link($this->get_baseurl());
836                 $url = str_replace($base . '/', '', $nurl);
837
838                 // if it is an external link return the orignal value
839                 if ($url == normalise_link($orig_url)) {
840                         return $orig_url;
841                 } else {
842                         return $url;
843                 }
844         }
845
846         /**
847          * @brief Register template engine class
848          *
849          * @param string $class
850          */
851         private function register_template_engine($class)
852         {
853                 $v = get_class_vars($class);
854                 if (x($v, 'name')) {
855                         $name = $v['name'];
856                         $this->template_engines[$name] = $class;
857                 } else {
858                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
859                         die();
860                 }
861         }
862
863         /**
864          * @brief Return template engine instance.
865          *
866          * If $name is not defined, return engine defined by theme,
867          * or default
868          *
869          * @return object Template Engine instance
870          */
871         public function template_engine()
872         {
873                 $template_engine = 'smarty3';
874                 if (x($this->theme, 'template_engine')) {
875                         $template_engine = $this->theme['template_engine'];
876                 }
877
878                 if (isset($this->template_engines[$template_engine])) {
879                         if (isset($this->template_engine_instance[$template_engine])) {
880                                 return $this->template_engine_instance[$template_engine];
881                         } else {
882                                 $class = $this->template_engines[$template_engine];
883                                 $obj = new $class;
884                                 $this->template_engine_instance[$template_engine] = $obj;
885                                 return $obj;
886                         }
887                 }
888
889                 echo "template engine <tt>$template_engine</tt> is not registered!\n";
890                 killme();
891         }
892
893         /**
894          * @brief Returns the active template engine.
895          *
896          * @return string
897          */
898         public function get_template_engine()
899         {
900                 return $this->theme['template_engine'];
901         }
902
903         public function set_template_engine($engine = 'smarty3')
904         {
905                 $this->theme['template_engine'] = $engine;
906         }
907
908         public function get_template_ldelim($engine = 'smarty3')
909         {
910                 return $this->ldelim[$engine];
911         }
912
913         public function get_template_rdelim($engine = 'smarty3')
914         {
915                 return $this->rdelim[$engine];
916         }
917
918         public function save_timestamp($stamp, $value)
919         {
920                 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
921                         return;
922                 }
923
924                 $duration = (float) (microtime(true) - $stamp);
925
926                 if (!isset($this->performance[$value])) {
927                         // Prevent ugly E_NOTICE
928                         $this->performance[$value] = 0;
929                 }
930
931                 $this->performance[$value] += (float) $duration;
932                 $this->performance['marktime'] += (float) $duration;
933
934                 $callstack = System::callstack();
935
936                 if (!isset($this->callstack[$value][$callstack])) {
937                         // Prevent ugly E_NOTICE
938                         $this->callstack[$value][$callstack] = 0;
939                 }
940
941                 $this->callstack[$value][$callstack] += (float) $duration;
942         }
943
944         public function get_useragent()
945         {
946                 return
947                         FRIENDICA_PLATFORM . " '" .
948                         FRIENDICA_CODENAME . "' " .
949                         FRIENDICA_VERSION . '-' .
950                         DB_UPDATE_VERSION . '; ' .
951                         $this->get_baseurl();
952         }
953
954         public function is_friendica_app()
955         {
956                 return $this->is_friendica_app;
957         }
958
959         /**
960          * @brief Checks if the site is called via a backend process
961          *
962          * This isn't a perfect solution. But we need this check very early.
963          * So we cannot wait until the modules are loaded.
964          *
965          * @return bool Is it a known backend?
966          */
967         public function is_backend()
968         {
969                 static $backends = [
970                         '_well_known',
971                         'api',
972                         'dfrn_notify',
973                         'fetch',
974                         'hcard',
975                         'hostxrd',
976                         'nodeinfo',
977                         'noscrape',
978                         'p',
979                         'poco',
980                         'post',
981                         'proxy',
982                         'pubsub',
983                         'pubsubhubbub',
984                         'receive',
985                         'rsd_xml',
986                         'salmon',
987                         'statistics_json',
988                         'xrd',
989                 ];
990
991                 // Check if current module is in backend or backend flag is set
992                 return (in_array($this->module, $backends) || $this->backend);
993         }
994
995         /**
996          * @brief Checks if the maximum number of database processes is reached
997          *
998          * @return bool Is the limit reached?
999          */
1000         public function isMaxProcessesReached()
1001         {
1002                 // Deactivated, needs more investigating if this check really makes sense
1003                 return false;
1004
1005                 /*
1006                  * Commented out to suppress static analyzer issues
1007                  *
1008                 if ($this->is_backend()) {
1009                         $process = 'backend';
1010                         $max_processes = Config::get('system', 'max_processes_backend');
1011                         if (intval($max_processes) == 0) {
1012                                 $max_processes = 5;
1013                         }
1014                 } else {
1015                         $process = 'frontend';
1016                         $max_processes = Config::get('system', 'max_processes_frontend');
1017                         if (intval($max_processes) == 0) {
1018                                 $max_processes = 20;
1019                         }
1020                 }
1021
1022                 $processlist = DBM::processlist();
1023                 if ($processlist['list'] != '') {
1024                         logger('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], LOGGER_DEBUG);
1025
1026                         if ($processlist['amount'] > $max_processes) {
1027                                 logger('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', LOGGER_DEBUG);
1028                                 return true;
1029                         }
1030                 }
1031                 return false;
1032                  */
1033         }
1034
1035         /**
1036          * @brief Checks if the minimal memory is reached
1037          *
1038          * @return bool Is the memory limit reached?
1039          */
1040         public function min_memory_reached()
1041         {
1042                 $min_memory = Config::get('system', 'min_memory', 0);
1043                 if ($min_memory == 0) {
1044                         return false;
1045                 }
1046
1047                 if (!is_readable('/proc/meminfo')) {
1048                         return false;
1049                 }
1050
1051                 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
1052
1053                 $meminfo = [];
1054                 foreach ($memdata as $line) {
1055                         list($key, $val) = explode(':', $line);
1056                         $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
1057                         $meminfo[$key] = (int) ($meminfo[$key] / 1024);
1058                 }
1059
1060                 if (!isset($meminfo['MemAvailable']) || !isset($meminfo['MemFree'])) {
1061                         return false;
1062                 }
1063
1064                 $free = $meminfo['MemAvailable'] + $meminfo['MemFree'];
1065
1066                 $reached = ($free < $min_memory);
1067
1068                 if ($reached) {
1069                         logger('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, LOGGER_DEBUG);
1070                 }
1071
1072                 return $reached;
1073         }
1074
1075         /**
1076          * @brief Checks if the maximum load is reached
1077          *
1078          * @return bool Is the load reached?
1079          */
1080         public function isMaxLoadReached()
1081         {
1082                 if ($this->is_backend()) {
1083                         $process = 'backend';
1084                         $maxsysload = intval(Config::get('system', 'maxloadavg'));
1085                         if ($maxsysload < 1) {
1086                                 $maxsysload = 50;
1087                         }
1088                 } else {
1089                         $process = 'frontend';
1090                         $maxsysload = intval(Config::get('system', 'maxloadavg_frontend'));
1091                         if ($maxsysload < 1) {
1092                                 $maxsysload = 50;
1093                         }
1094                 }
1095
1096                 $load = current_load();
1097                 if ($load) {
1098                         if (intval($load) > $maxsysload) {
1099                                 logger('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
1100                                 return true;
1101                         }
1102                 }
1103                 return false;
1104         }
1105
1106         public function proc_run($args)
1107         {
1108                 if (!function_exists('proc_open')) {
1109                         return;
1110                 }
1111
1112                 array_unshift($args, $this->getConfigValue('config', 'php_path', 'php'));
1113
1114                 for ($x = 0; $x < count($args); $x ++) {
1115                         $args[$x] = escapeshellarg($args[$x]);
1116                 }
1117
1118                 $cmdline = implode(' ', $args);
1119
1120                 if ($this->min_memory_reached()) {
1121                         return;
1122                 }
1123
1124                 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
1125                         $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->get_basepath());
1126                 } else {
1127                         $resource = proc_open($cmdline . ' &', [], $foo, $this->get_basepath());
1128                 }
1129                 if (!is_resource($resource)) {
1130                         logger('We got no resource for command ' . $cmdline, LOGGER_DEBUG);
1131                         return;
1132                 }
1133                 proc_close($resource);
1134         }
1135
1136         /**
1137          * @brief Returns the system user that is executing the script
1138          *
1139          * This mostly returns something like "www-data".
1140          *
1141          * @return string system username
1142          */
1143         private static function systemuser()
1144         {
1145                 if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
1146                         return '';
1147                 }
1148
1149                 $processUser = posix_getpwuid(posix_geteuid());
1150                 return $processUser['name'];
1151         }
1152
1153         /**
1154          * @brief Checks if a given directory is usable for the system
1155          *
1156          * @return boolean the directory is usable
1157          */
1158         public static function directory_usable($directory, $check_writable = true)
1159         {
1160                 if ($directory == '') {
1161                         logger('Directory is empty. This shouldn\'t happen.', LOGGER_DEBUG);
1162                         return false;
1163                 }
1164
1165                 if (!file_exists($directory)) {
1166                         logger('Path "' . $directory . '" does not exist for user ' . self::systemuser(), LOGGER_DEBUG);
1167                         return false;
1168                 }
1169
1170                 if (is_file($directory)) {
1171                         logger('Path "' . $directory . '" is a file for user ' . self::systemuser(), LOGGER_DEBUG);
1172                         return false;
1173                 }
1174
1175                 if (!is_dir($directory)) {
1176                         logger('Path "' . $directory . '" is not a directory for user ' . self::systemuser(), LOGGER_DEBUG);
1177                         return false;
1178                 }
1179
1180                 if ($check_writable && !is_writable($directory)) {
1181                         logger('Path "' . $directory . '" is not writable for user ' . self::systemuser(), LOGGER_DEBUG);
1182                         return false;
1183                 }
1184
1185                 return true;
1186         }
1187
1188         /**
1189          * @param string $cat     Config category
1190          * @param string $k       Config key
1191          * @param mixed  $default Default value if it isn't set
1192          */
1193         public function getConfigValue($cat, $k, $default = null)
1194         {
1195                 $return = $default;
1196
1197                 if ($cat === 'config') {
1198                         if (isset($this->config[$k])) {
1199                                 $return = $this->config[$k];
1200                         }
1201                 } else {
1202                         if (isset($this->config[$cat][$k])) {
1203                                 $return = $this->config[$cat][$k];
1204                         }
1205                 }
1206
1207                 return $return;
1208         }
1209
1210         /**
1211          * Sets a value in the config cache. Accepts raw output from the config table
1212          *
1213          * @param string $cat Config category
1214          * @param string $k   Config key
1215          * @param mixed  $v   Value to set
1216          */
1217         public function setConfigValue($cat, $k, $v)
1218         {
1219                 // Only arrays are serialized in database, so we have to unserialize sparingly
1220                 $value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
1221
1222                 if ($cat === 'config') {
1223                         $this->config[$k] = $value;
1224                 } else {
1225                         if (!isset($this->config[$cat])) {
1226                                 $this->config[$cat] = [];
1227                         }
1228
1229                         $this->config[$cat][$k] = $value;
1230                 }
1231         }
1232
1233         /**
1234          * Deletes a value from the config cache
1235          *
1236          * @param string $cat Config category
1237          * @param string $k   Config key
1238          */
1239         public function deleteConfigValue($cat, $k)
1240         {
1241                 if ($cat === 'config') {
1242                         if (isset($this->config[$k])) {
1243                                 unset($this->config[$k]);
1244                         }
1245                 } else {
1246                         if (isset($this->config[$cat][$k])) {
1247                                 unset($this->config[$cat][$k]);
1248                         }
1249                 }
1250         }
1251
1252
1253         /**
1254          * Retrieves a value from the user config cache
1255          *
1256          * @param int    $uid     User Id
1257          * @param string $cat     Config category
1258          * @param string $k       Config key
1259          * @param mixed  $default Default value if key isn't set
1260          */
1261         public function getPConfigValue($uid, $cat, $k, $default = null)
1262         {
1263                 $return = $default;
1264
1265                 if (isset($this->config[$uid][$cat][$k])) {
1266                         $return = $this->config[$uid][$cat][$k];
1267                 }
1268
1269                 return $return;
1270         }
1271
1272         /**
1273          * Sets a value in the user config cache
1274          *
1275          * Accepts raw output from the pconfig table
1276          *
1277          * @param int    $uid User Id
1278          * @param string $cat Config category
1279          * @param string $k   Config key
1280          * @param mixed  $v   Value to set
1281          */
1282         public function setPConfigValue($uid, $cat, $k, $v)
1283         {
1284                 // Only arrays are serialized in database, so we have to unserialize sparingly
1285                 $value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
1286
1287                 if (!isset($this->config[$uid])) {
1288                         $this->config[$uid] = [];
1289                 }
1290
1291                 if (!isset($this->config[$uid][$cat])) {
1292                         $this->config[$uid][$cat] = [];
1293                 }
1294
1295                 $this->config[$uid][$cat][$k] = $value;
1296         }
1297
1298         /**
1299          * Deletes a value from the user config cache
1300          *
1301          * @param int    $uid User Id
1302          * @param string $cat Config category
1303          * @param string $k   Config key
1304          */
1305         public function deletePConfigValue($uid, $cat, $k)
1306         {
1307                 if (isset($this->config[$uid][$cat][$k])) {
1308                         unset($this->config[$uid][$cat][$k]);
1309                 }
1310         }
1311
1312         /**
1313          * Generates the site's default sender email address
1314          *
1315          * @return string
1316          */
1317         public function getSenderEmailAddress()
1318         {
1319                 $sender_email = Config::get('config', 'sender_email');
1320                 if (empty($sender_email)) {
1321                         $hostname = $this->get_hostname();
1322                         if (strpos($hostname, ':')) {
1323                                 $hostname = substr($hostname, 0, strpos($hostname, ':'));
1324                         }
1325
1326                         $sender_email = 'noreply@' . $hostname;
1327                 }
1328
1329                 return $sender_email;
1330         }
1331
1332         /**
1333          * Returns the current theme name.
1334          *
1335          * @return string
1336          */
1337         public function getCurrentTheme()
1338         {
1339                 if ($this->isInstallMode()) {
1340                         return '';
1341                 }
1342
1343                 //// @TODO Compute the current theme only once (this behavior has
1344                 /// already been implemented, but it didn't work well -
1345                 /// https://github.com/friendica/friendica/issues/5092)
1346                 $this->computeCurrentTheme();
1347
1348                 return $this->current_theme;
1349         }
1350
1351         /**
1352          * Computes the current theme name based on the node settings, the user settings and the device type
1353          *
1354          * @throws Exception
1355          */
1356         private function computeCurrentTheme()
1357         {
1358                 $system_theme = Config::get('system', 'theme');
1359                 if (!$system_theme) {
1360                         throw new Exception(L10n::t('No system theme config value set.'));
1361                 }
1362
1363                 // Sane default
1364                 $this->current_theme = $system_theme;
1365
1366                 $allowed_themes = explode(',', Config::get('system', 'allowed_themes', $system_theme));
1367
1368                 $page_theme = null;
1369                 // Find the theme that belongs to the user whose stuff we are looking at
1370                 if ($this->profile_uid && ($this->profile_uid != local_user())) {
1371                         // Allow folks to override user themes and always use their own on their own site.
1372                         // This works only if the user is on the same server
1373                         $user = dba::selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
1374                         if (DBM::is_result($user) && !PConfig::get(local_user(), 'system', 'always_my_theme')) {
1375                                 $page_theme = $user['theme'];
1376                         }
1377                 }
1378
1379                 if (!empty($_SESSION)) {
1380                         $user_theme = defaults($_SESSION, 'theme', $system_theme);
1381                 } else {
1382                         $user_theme = $system_theme;
1383                 }
1384
1385                 // Specific mobile theme override
1386                 if (($this->is_mobile || $this->is_tablet) && defaults($_SESSION, 'show-mobile', true)) {
1387                         $system_mobile_theme = Config::get('system', 'mobile-theme');
1388                         $user_mobile_theme = defaults($_SESSION, 'mobile-theme', $system_mobile_theme);
1389
1390                         // --- means same mobile theme as desktop
1391                         if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
1392                                 $user_theme = $user_mobile_theme;
1393                         }
1394                 }
1395
1396                 if ($page_theme) {
1397                         $theme_name = $page_theme;
1398                 } else {
1399                         $theme_name = $user_theme;
1400                 }
1401
1402                 if ($theme_name
1403                         && in_array($theme_name, $allowed_themes)
1404                         && (file_exists('view/theme/' . $theme_name . '/style.css')
1405                         || file_exists('view/theme/' . $theme_name . '/style.php'))
1406                 ) {
1407                         $this->current_theme = $theme_name;
1408                 }
1409         }
1410
1411         /**
1412          * @brief Return full URL to theme which is currently in effect.
1413          *
1414          * Provide a sane default if nothing is chosen or the specified theme does not exist.
1415          *
1416          * @return string
1417          */
1418         public function getCurrentThemeStylesheetPath()
1419         {
1420                 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
1421         }
1422 }