]> git.mxchange.org Git - friendica.git/blob - src/App.php
6dce64af474d36fed0daba8abc500f802d4904dc
[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 . 'config.ini.php');
327                 $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'settings.ini.php');
328
329                 // Legacy .htconfig.php support
330                 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
331                         $a = $this;
332                         include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
333                 }
334
335                 // Legacy .htconfig.php support
336                 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
337                         $a = $this;
338
339                         include $this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php';
340                         unset($db_host, $db_user, $db_pass, $db_data);
341
342                         if (isset($default_timezone)) {
343                                 $this->setConfigValue('system', 'default_timezone', $default_timezone);
344                                 unset($default_timezone);
345                         }
346
347                         if (isset($pidfile)) {
348                                 $this->setConfigValue('system', 'pidfile', $pidfile);
349                                 unset($pidfile);
350                         }
351                 }
352
353                 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')) {
354                         $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php');
355                 }
356         }
357
358         /**
359          * Tries to load the specified configuration file into the App->config array.
360          * Overwrites previously set values.
361          *
362          * The config format is INI and the template for configuration files is the following:
363          *
364          * <?php return <<<INI
365          *
366          * [section]
367          * key = value
368          *
369          * INI;
370          * // Keep this line
371          *
372          * @param type $filepath
373          * @throws Exception
374          */
375         public function loadConfigFile($filepath)
376         {
377                 if (!file_exists($filepath)) {
378                         throw new Exception('Error parsing non-existent config file ' . $filepath);
379                 }
380
381                 $contents = include($filepath);
382
383                 $config = parse_ini_string($contents, true, INI_SCANNER_TYPED);
384
385                 if ($config === false) {
386                         throw new Exception('Error parsing config file ' . $filepath);
387                 }
388
389                 foreach ($config as $category => $values) {
390                         foreach ($values as $key => $value) {
391                                 $this->setConfigValue($category, $key, $value);
392                         }
393                 }
394         }
395
396         /**
397          * Loads addons configuration files
398          *
399          * First loads all activated addons default configuration throught the load_config hook, then load the local.ini.php
400          * again to overwrite potential local addon configuration.
401          */
402         private function loadAddonConfig()
403         {
404                 // Loads addons default config
405                 Core\Addon::callHooks('load_config');
406
407                 // Load the local addon config file to overwritten default addon config values
408                 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php')) {
409                         $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php');
410                 }
411         }
412
413         /**
414          * Loads the default timezone
415          *
416          * Include support for legacy $default_timezone
417          *
418          * @global string $default_timezone
419          */
420         private function loadDefaultTimezone()
421         {
422                 if ($this->getConfigValue('system', 'default_timezone')) {
423                         $this->timezone = $this->getConfigValue('system', 'default_timezone');
424                 } else {
425                         global $default_timezone;
426                         $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
427                 }
428
429                 if ($this->timezone) {
430                         date_default_timezone_set($this->timezone);
431                 }
432         }
433
434         /**
435          * Figure out if we are running at the top of a domain or in a sub-directory and adjust accordingly
436          */
437         private function determineUrlPath()
438         {
439                 $this->urlpath = $this->getConfigValue('system', 'urlpath');
440
441                 /* SCRIPT_URL gives /path/to/friendica/module/parameter
442                  * QUERY_STRING gives pagename=module/parameter
443                  *
444                  * To get /path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
445                  */
446                 if (!empty($_SERVER['SCRIPT_URL'])) {
447                         // Module
448                         if (!empty($_SERVER['QUERY_STRING'])) {
449                                 $path = trim(dirname($_SERVER['SCRIPT_URL'], substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
450                         } else {
451                                 // Root page
452                                 $path = trim($_SERVER['SCRIPT_URL'], '/');
453                         }
454
455                         if ($path && $path != $this->urlpath) {
456                                 $this->urlpath = $path;
457                         }
458                 }
459         }
460
461         /**
462          * Sets the App mode
463          *
464          * - App::MODE_INSTALL    : Either the database connection can't be established or the config table doesn't exist
465          * - App::MODE_MAINTENANCE: The maintenance mode has been set
466          * - App::MODE_NORMAL     : Normal run with all features enabled
467          *
468          * @return type
469          */
470         private function determineMode()
471         {
472                 $this->mode = 0;
473
474                 if (!file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')
475                         && !file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
476                         return;
477                 }
478
479                 $this->mode |= App::MODE_LOCALCONFIGPRESENT;
480
481                 if (!\dba::connected()) {
482                         return;
483                 }
484
485                 $this->mode |= App::MODE_DBAVAILABLE;
486
487                 if (\dba::fetch_first("SHOW TABLES LIKE 'config'") === false) {
488                         return;
489                 }
490
491                 $this->mode |= App::MODE_DBCONFIGAVAILABLE;
492
493                 if (Config::get('system', 'maintenance')) {
494                         return;
495                 }
496
497                 $this->mode |= App::MODE_MAINTENANCEDISABLED;
498         }
499
500         public function loadDatabase()
501         {
502                 if (\dba::connected()) {
503                         return;
504                 }
505
506                 $db_host = $this->getConfigValue('database', 'hostname');
507                 $db_user = $this->getConfigValue('database', 'username');
508                 $db_pass = $this->getConfigValue('database', 'password');
509                 $db_data = $this->getConfigValue('database', 'database');
510                 $charset = $this->getConfigValue('database', 'charset');
511
512                 // Use environment variables for mysql if they are set beforehand
513                 if (!empty(getenv('MYSQL_HOST'))
514                         && (!empty(getenv('MYSQL_USERNAME')) || !empty(getenv('MYSQL_USER')))
515                         && getenv('MYSQL_PASSWORD') !== false
516                         && !empty(getenv('MYSQL_DATABASE')))
517                 {
518                         $db_host = getenv('MYSQL_HOST');
519                         if (!empty(getenv('MYSQL_PORT'))) {
520                                 $db_host .= ':' . getenv('MYSQL_PORT');
521                         }
522                         if (!empty(getenv('MYSQL_USERNAME'))) {
523                                 $db_user = getenv('MYSQL_USERNAME');
524                         } else {
525                                 $db_user = getenv('MYSQL_USER');
526                         }
527                         $db_pass = (string) getenv('MYSQL_PASSWORD');
528                         $db_data = getenv('MYSQL_DATABASE');
529                 } elseif (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
530                         $a = new \stdClass();
531                         include $this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php';
532                         $charset = isset($a->config["system"]["db_charset"]) ? $a->config["system"]["db_charset"] : $charset;
533
534                         unset($a);
535                 }
536
537                 $stamp1 = microtime(true);
538
539                 \dba::connect($db_host, $db_user, $db_pass, $db_data, $charset);
540                 unset($db_host, $db_user, $db_pass, $db_data, $charset);
541
542                 $this->save_timestamp($stamp1, "network");
543         }
544
545         /**
546          * Install mode is when the local config file is missing or the DB schema hasn't been installed yet.
547          *
548          * @return bool
549          */
550         public function isInstallMode()
551         {
552                 return !($this->mode & App::MODE_LOCALCONFIGPRESENT) || !($this->mode & App::MODE_DBCONFIGAVAILABLE);
553         }
554
555         /**
556          * @brief Returns the base filesystem path of the App
557          *
558          * It first checks for the internal variable, then for DOCUMENT_ROOT and
559          * finally for PWD
560          *
561          * @return string
562          */
563         public function get_basepath()
564         {
565                 $basepath = $this->basepath;
566
567                 if (!$basepath) {
568                         $basepath = Config::get('system', 'basepath');
569                 }
570
571                 if (!$basepath && x($_SERVER, 'DOCUMENT_ROOT')) {
572                         $basepath = $_SERVER['DOCUMENT_ROOT'];
573                 }
574
575                 if (!$basepath && x($_SERVER, 'PWD')) {
576                         $basepath = $_SERVER['PWD'];
577                 }
578
579                 return self::realpath($basepath);
580         }
581
582         /**
583          * @brief Returns a normalized file path
584          *
585          * This is a wrapper for the "realpath" function.
586          * That function cannot detect the real path when some folders aren't readable.
587          * Since this could happen with some hosters we need to handle this.
588          *
589          * @param string $path The path that is about to be normalized
590          * @return string normalized path - when possible
591          */
592         public static function realpath($path)
593         {
594                 $normalized = realpath($path);
595
596                 if (!is_bool($normalized)) {
597                         return $normalized;
598                 } else {
599                         return $path;
600                 }
601         }
602
603         public function get_scheme()
604         {
605                 return $this->scheme;
606         }
607
608         /**
609          * @brief Retrieves the Friendica instance base URL
610          *
611          * This function assembles the base URL from multiple parts:
612          * - Protocol is determined either by the request or a combination of
613          * system.ssl_policy and the $ssl parameter.
614          * - Host name is determined either by system.hostname or inferred from request
615          * - Path is inferred from SCRIPT_NAME
616          *
617          * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
618          *
619          * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
620          * @return string Friendica server base URL
621          */
622         public function get_baseurl($ssl = false)
623         {
624                 $scheme = $this->scheme;
625
626                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
627                         $scheme = 'https';
628                 }
629
630                 //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
631                 //      (and also the login link). Anything seen by an outsider will have it turned off.
632
633                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
634                         if ($ssl) {
635                                 $scheme = 'https';
636                         } else {
637                                 $scheme = 'http';
638                         }
639                 }
640
641                 if (Config::get('config', 'hostname') != '') {
642                         $this->hostname = Config::get('config', 'hostname');
643                 }
644
645                 return $scheme . '://' . $this->hostname . (!empty($this->urlpath) ? '/' . $this->urlpath : '' );
646         }
647
648         /**
649          * @brief Initializes the baseurl components
650          *
651          * Clears the baseurl cache to prevent inconsistencies
652          *
653          * @param string $url
654          */
655         public function set_baseurl($url)
656         {
657                 $parsed = @parse_url($url);
658                 $hostname = '';
659
660                 if (x($parsed)) {
661                         if (!empty($parsed['scheme'])) {
662                                 $this->scheme = $parsed['scheme'];
663                         }
664
665                         if (!empty($parsed['host'])) {
666                                 $hostname = $parsed['host'];
667                         }
668
669                         if (x($parsed, 'port')) {
670                                 $hostname .= ':' . $parsed['port'];
671                         }
672                         if (x($parsed, 'path')) {
673                                 $this->urlpath = trim($parsed['path'], '\\/');
674                         }
675
676                         if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
677                                 include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
678                         }
679
680                         if (Config::get('config', 'hostname') != '') {
681                                 $this->hostname = Config::get('config', 'hostname');
682                         }
683
684                         if (!isset($this->hostname) || ($this->hostname == '')) {
685                                 $this->hostname = $hostname;
686                         }
687                 }
688         }
689
690         public function get_hostname()
691         {
692                 if (Config::get('config', 'hostname') != '') {
693                         $this->hostname = Config::get('config', 'hostname');
694                 }
695
696                 return $this->hostname;
697         }
698
699         public function get_path()
700         {
701                 return $this->urlpath;
702         }
703
704         public function set_pager_total($n)
705         {
706                 $this->pager['total'] = intval($n);
707         }
708
709         public function set_pager_itemspage($n)
710         {
711                 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
712                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
713         }
714
715         public function set_pager_page($n)
716         {
717                 $this->pager['page'] = $n;
718                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
719         }
720
721         public function init_pagehead()
722         {
723                 $interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000);
724
725                 // If the update is 'deactivated' set it to the highest integer number (~24 days)
726                 if ($interval < 0) {
727                         $interval = 2147483647;
728                 }
729
730                 if ($interval < 10000) {
731                         $interval = 40000;
732                 }
733
734                 // compose the page title from the sitename and the
735                 // current module called
736                 if (!$this->module == '') {
737                         $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
738                 } else {
739                         $this->page['title'] = $this->config['sitename'];
740                 }
741
742                 /* put the head template at the beginning of page['htmlhead']
743                  * since the code added by the modules frequently depends on it
744                  * being first
745                  */
746                 if (!isset($this->page['htmlhead'])) {
747                         $this->page['htmlhead'] = '';
748                 }
749
750                 // If we're using Smarty, then doing replace_macros() will replace
751                 // any unrecognized variables with a blank string. Since we delay
752                 // replacing $stylesheet until later, we need to replace it now
753                 // with another variable name
754                 if ($this->theme['template_engine'] === 'smarty3') {
755                         $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
756                 } else {
757                         $stylesheet = '$stylesheet';
758                 }
759
760                 $shortcut_icon = Config::get('system', 'shortcut_icon');
761                 if ($shortcut_icon == '') {
762                         $shortcut_icon = 'images/friendica-32.png';
763                 }
764
765                 $touch_icon = Config::get('system', 'touch_icon');
766                 if ($touch_icon == '') {
767                         $touch_icon = 'images/friendica-128.png';
768                 }
769
770                 // get data wich is needed for infinite scroll on the network page
771                 $invinite_scroll = infinite_scroll_data($this->module);
772
773                 $tpl = get_markup_template('head.tpl');
774                 $this->page['htmlhead'] = replace_macros($tpl, [
775                         '$baseurl'         => $this->get_baseurl(),
776                         '$local_user'      => local_user(),
777                         '$generator'       => 'Friendica' . ' ' . FRIENDICA_VERSION,
778                         '$delitem'         => L10n::t('Delete this item?'),
779                         '$showmore'        => L10n::t('show more'),
780                         '$showfewer'       => L10n::t('show fewer'),
781                         '$update_interval' => $interval,
782                         '$shortcut_icon'   => $shortcut_icon,
783                         '$touch_icon'      => $touch_icon,
784                         '$stylesheet'      => $stylesheet,
785                         '$infinite_scroll' => $invinite_scroll,
786                         '$block_public'    => intval(Config::get('system', 'block_public')),
787                 ]) . $this->page['htmlhead'];
788         }
789
790         public function init_page_end()
791         {
792                 if (!isset($this->page['end'])) {
793                         $this->page['end'] = '';
794                 }
795                 $tpl = get_markup_template('end.tpl');
796                 $this->page['end'] = replace_macros($tpl, [
797                         '$baseurl' => $this->get_baseurl()
798                 ]) . $this->page['end'];
799         }
800
801         public function set_curl_code($code)
802         {
803                 $this->curl_code = $code;
804         }
805
806         public function get_curl_code()
807         {
808                 return $this->curl_code;
809         }
810
811         public function set_curl_content_type($content_type)
812         {
813                 $this->curl_content_type = $content_type;
814         }
815
816         public function get_curl_content_type()
817         {
818                 return $this->curl_content_type;
819         }
820
821         public function set_curl_headers($headers)
822         {
823                 $this->curl_headers = $headers;
824         }
825
826         public function get_curl_headers()
827         {
828                 return $this->curl_headers;
829         }
830
831         /**
832          * @brief Removes the base url from an url. This avoids some mixed content problems.
833          *
834          * @param string $orig_url
835          *
836          * @return string The cleaned url
837          */
838         public function remove_baseurl($orig_url)
839         {
840                 // Remove the hostname from the url if it is an internal link
841                 $nurl = normalise_link($orig_url);
842                 $base = normalise_link($this->get_baseurl());
843                 $url = str_replace($base . '/', '', $nurl);
844
845                 // if it is an external link return the orignal value
846                 if ($url == normalise_link($orig_url)) {
847                         return $orig_url;
848                 } else {
849                         return $url;
850                 }
851         }
852
853         /**
854          * @brief Register template engine class
855          *
856          * @param string $class
857          */
858         private function register_template_engine($class)
859         {
860                 $v = get_class_vars($class);
861                 if (x($v, 'name')) {
862                         $name = $v['name'];
863                         $this->template_engines[$name] = $class;
864                 } else {
865                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
866                         die();
867                 }
868         }
869
870         /**
871          * @brief Return template engine instance.
872          *
873          * If $name is not defined, return engine defined by theme,
874          * or default
875          *
876          * @return object Template Engine instance
877          */
878         public function template_engine()
879         {
880                 $template_engine = 'smarty3';
881                 if (x($this->theme, 'template_engine')) {
882                         $template_engine = $this->theme['template_engine'];
883                 }
884
885                 if (isset($this->template_engines[$template_engine])) {
886                         if (isset($this->template_engine_instance[$template_engine])) {
887                                 return $this->template_engine_instance[$template_engine];
888                         } else {
889                                 $class = $this->template_engines[$template_engine];
890                                 $obj = new $class;
891                                 $this->template_engine_instance[$template_engine] = $obj;
892                                 return $obj;
893                         }
894                 }
895
896                 echo "template engine <tt>$template_engine</tt> is not registered!\n";
897                 killme();
898         }
899
900         /**
901          * @brief Returns the active template engine.
902          *
903          * @return string
904          */
905         public function get_template_engine()
906         {
907                 return $this->theme['template_engine'];
908         }
909
910         public function set_template_engine($engine = 'smarty3')
911         {
912                 $this->theme['template_engine'] = $engine;
913         }
914
915         public function get_template_ldelim($engine = 'smarty3')
916         {
917                 return $this->ldelim[$engine];
918         }
919
920         public function get_template_rdelim($engine = 'smarty3')
921         {
922                 return $this->rdelim[$engine];
923         }
924
925         public function save_timestamp($stamp, $value)
926         {
927                 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
928                         return;
929                 }
930
931                 $duration = (float) (microtime(true) - $stamp);
932
933                 if (!isset($this->performance[$value])) {
934                         // Prevent ugly E_NOTICE
935                         $this->performance[$value] = 0;
936                 }
937
938                 $this->performance[$value] += (float) $duration;
939                 $this->performance['marktime'] += (float) $duration;
940
941                 $callstack = System::callstack();
942
943                 if (!isset($this->callstack[$value][$callstack])) {
944                         // Prevent ugly E_NOTICE
945                         $this->callstack[$value][$callstack] = 0;
946                 }
947
948                 $this->callstack[$value][$callstack] += (float) $duration;
949         }
950
951         public function get_useragent()
952         {
953                 return
954                         FRIENDICA_PLATFORM . " '" .
955                         FRIENDICA_CODENAME . "' " .
956                         FRIENDICA_VERSION . '-' .
957                         DB_UPDATE_VERSION . '; ' .
958                         $this->get_baseurl();
959         }
960
961         public function is_friendica_app()
962         {
963                 return $this->is_friendica_app;
964         }
965
966         /**
967          * @brief Checks if the site is called via a backend process
968          *
969          * This isn't a perfect solution. But we need this check very early.
970          * So we cannot wait until the modules are loaded.
971          *
972          * @return bool Is it a known backend?
973          */
974         public function is_backend()
975         {
976                 static $backends = [
977                         '_well_known',
978                         'api',
979                         'dfrn_notify',
980                         'fetch',
981                         'hcard',
982                         'hostxrd',
983                         'nodeinfo',
984                         'noscrape',
985                         'p',
986                         'poco',
987                         'post',
988                         'proxy',
989                         'pubsub',
990                         'pubsubhubbub',
991                         'receive',
992                         'rsd_xml',
993                         'salmon',
994                         'statistics_json',
995                         'xrd',
996                 ];
997
998                 // Check if current module is in backend or backend flag is set
999                 return (in_array($this->module, $backends) || $this->backend);
1000         }
1001
1002         /**
1003          * @brief Checks if the maximum number of database processes is reached
1004          *
1005          * @return bool Is the limit reached?
1006          */
1007         public function isMaxProcessesReached()
1008         {
1009                 // Deactivated, needs more investigating if this check really makes sense
1010                 return false;
1011
1012                 /*
1013                  * Commented out to suppress static analyzer issues
1014                  *
1015                 if ($this->is_backend()) {
1016                         $process = 'backend';
1017                         $max_processes = Config::get('system', 'max_processes_backend');
1018                         if (intval($max_processes) == 0) {
1019                                 $max_processes = 5;
1020                         }
1021                 } else {
1022                         $process = 'frontend';
1023                         $max_processes = Config::get('system', 'max_processes_frontend');
1024                         if (intval($max_processes) == 0) {
1025                                 $max_processes = 20;
1026                         }
1027                 }
1028
1029                 $processlist = DBM::processlist();
1030                 if ($processlist['list'] != '') {
1031                         logger('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], LOGGER_DEBUG);
1032
1033                         if ($processlist['amount'] > $max_processes) {
1034                                 logger('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', LOGGER_DEBUG);
1035                                 return true;
1036                         }
1037                 }
1038                 return false;
1039                  */
1040         }
1041
1042         /**
1043          * @brief Checks if the minimal memory is reached
1044          *
1045          * @return bool Is the memory limit reached?
1046          */
1047         public function min_memory_reached()
1048         {
1049                 $min_memory = Config::get('system', 'min_memory', 0);
1050                 if ($min_memory == 0) {
1051                         return false;
1052                 }
1053
1054                 if (!is_readable('/proc/meminfo')) {
1055                         return false;
1056                 }
1057
1058                 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
1059
1060                 $meminfo = [];
1061                 foreach ($memdata as $line) {
1062                         list($key, $val) = explode(':', $line);
1063                         $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
1064                         $meminfo[$key] = (int) ($meminfo[$key] / 1024);
1065                 }
1066
1067                 if (!isset($meminfo['MemAvailable']) || !isset($meminfo['MemFree'])) {
1068                         return false;
1069                 }
1070
1071                 $free = $meminfo['MemAvailable'] + $meminfo['MemFree'];
1072
1073                 $reached = ($free < $min_memory);
1074
1075                 if ($reached) {
1076                         logger('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, LOGGER_DEBUG);
1077                 }
1078
1079                 return $reached;
1080         }
1081
1082         /**
1083          * @brief Checks if the maximum load is reached
1084          *
1085          * @return bool Is the load reached?
1086          */
1087         public function isMaxLoadReached()
1088         {
1089                 if ($this->is_backend()) {
1090                         $process = 'backend';
1091                         $maxsysload = intval(Config::get('system', 'maxloadavg'));
1092                         if ($maxsysload < 1) {
1093                                 $maxsysload = 50;
1094                         }
1095                 } else {
1096                         $process = 'frontend';
1097                         $maxsysload = intval(Config::get('system', 'maxloadavg_frontend'));
1098                         if ($maxsysload < 1) {
1099                                 $maxsysload = 50;
1100                         }
1101                 }
1102
1103                 $load = current_load();
1104                 if ($load) {
1105                         if (intval($load) > $maxsysload) {
1106                                 logger('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
1107                                 return true;
1108                         }
1109                 }
1110                 return false;
1111         }
1112
1113         public function proc_run($args)
1114         {
1115                 if (!function_exists('proc_open')) {
1116                         return;
1117                 }
1118
1119                 array_unshift($args, $this->getConfigValue('config', 'php_path', 'php'));
1120
1121                 for ($x = 0; $x < count($args); $x ++) {
1122                         $args[$x] = escapeshellarg($args[$x]);
1123                 }
1124
1125                 $cmdline = implode(' ', $args);
1126
1127                 if ($this->min_memory_reached()) {
1128                         return;
1129                 }
1130
1131                 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
1132                         $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->get_basepath());
1133                 } else {
1134                         $resource = proc_open($cmdline . ' &', [], $foo, $this->get_basepath());
1135                 }
1136                 if (!is_resource($resource)) {
1137                         logger('We got no resource for command ' . $cmdline, LOGGER_DEBUG);
1138                         return;
1139                 }
1140                 proc_close($resource);
1141         }
1142
1143         /**
1144          * @brief Returns the system user that is executing the script
1145          *
1146          * This mostly returns something like "www-data".
1147          *
1148          * @return string system username
1149          */
1150         private static function systemuser()
1151         {
1152                 if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
1153                         return '';
1154                 }
1155
1156                 $processUser = posix_getpwuid(posix_geteuid());
1157                 return $processUser['name'];
1158         }
1159
1160         /**
1161          * @brief Checks if a given directory is usable for the system
1162          *
1163          * @return boolean the directory is usable
1164          */
1165         public static function directory_usable($directory, $check_writable = true)
1166         {
1167                 if ($directory == '') {
1168                         logger('Directory is empty. This shouldn\'t happen.', LOGGER_DEBUG);
1169                         return false;
1170                 }
1171
1172                 if (!file_exists($directory)) {
1173                         logger('Path "' . $directory . '" does not exist for user ' . self::systemuser(), LOGGER_DEBUG);
1174                         return false;
1175                 }
1176
1177                 if (is_file($directory)) {
1178                         logger('Path "' . $directory . '" is a file for user ' . self::systemuser(), LOGGER_DEBUG);
1179                         return false;
1180                 }
1181
1182                 if (!is_dir($directory)) {
1183                         logger('Path "' . $directory . '" is not a directory for user ' . self::systemuser(), LOGGER_DEBUG);
1184                         return false;
1185                 }
1186
1187                 if ($check_writable && !is_writable($directory)) {
1188                         logger('Path "' . $directory . '" is not writable for user ' . self::systemuser(), LOGGER_DEBUG);
1189                         return false;
1190                 }
1191
1192                 return true;
1193         }
1194
1195         /**
1196          * @param string $cat     Config category
1197          * @param string $k       Config key
1198          * @param mixed  $default Default value if it isn't set
1199          */
1200         public function getConfigValue($cat, $k, $default = null)
1201         {
1202                 $return = $default;
1203
1204                 if ($cat === 'config') {
1205                         if (isset($this->config[$k])) {
1206                                 $return = $this->config[$k];
1207                         }
1208                 } else {
1209                         if (isset($this->config[$cat][$k])) {
1210                                 $return = $this->config[$cat][$k];
1211                         }
1212                 }
1213
1214                 return $return;
1215         }
1216
1217         /**
1218          * Sets a value in the config cache. Accepts raw output from the config table
1219          *
1220          * @param string $cat Config category
1221          * @param string $k   Config key
1222          * @param mixed  $v   Value to set
1223          */
1224         public function setConfigValue($cat, $k, $v)
1225         {
1226                 // Only arrays are serialized in database, so we have to unserialize sparingly
1227                 $value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
1228
1229                 if ($cat === 'config') {
1230                         $this->config[$k] = $value;
1231                 } else {
1232                         if (!isset($this->config[$cat])) {
1233                                 $this->config[$cat] = [];
1234                         }
1235
1236                         $this->config[$cat][$k] = $value;
1237                 }
1238         }
1239
1240         /**
1241          * Deletes a value from the config cache
1242          *
1243          * @param string $cat Config category
1244          * @param string $k   Config key
1245          */
1246         public function deleteConfigValue($cat, $k)
1247         {
1248                 if ($cat === 'config') {
1249                         if (isset($this->config[$k])) {
1250                                 unset($this->config[$k]);
1251                         }
1252                 } else {
1253                         if (isset($this->config[$cat][$k])) {
1254                                 unset($this->config[$cat][$k]);
1255                         }
1256                 }
1257         }
1258
1259
1260         /**
1261          * Retrieves a value from the user config cache
1262          *
1263          * @param int    $uid     User Id
1264          * @param string $cat     Config category
1265          * @param string $k       Config key
1266          * @param mixed  $default Default value if key isn't set
1267          */
1268         public function getPConfigValue($uid, $cat, $k, $default = null)
1269         {
1270                 $return = $default;
1271
1272                 if (isset($this->config[$uid][$cat][$k])) {
1273                         $return = $this->config[$uid][$cat][$k];
1274                 }
1275
1276                 return $return;
1277         }
1278
1279         /**
1280          * Sets a value in the user config cache
1281          *
1282          * Accepts raw output from the pconfig table
1283          *
1284          * @param int    $uid User Id
1285          * @param string $cat Config category
1286          * @param string $k   Config key
1287          * @param mixed  $v   Value to set
1288          */
1289         public function setPConfigValue($uid, $cat, $k, $v)
1290         {
1291                 // Only arrays are serialized in database, so we have to unserialize sparingly
1292                 $value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
1293
1294                 if (!isset($this->config[$uid])) {
1295                         $this->config[$uid] = [];
1296                 }
1297
1298                 if (!isset($this->config[$uid][$cat])) {
1299                         $this->config[$uid][$cat] = [];
1300                 }
1301
1302                 $this->config[$uid][$cat][$k] = $value;
1303         }
1304
1305         /**
1306          * Deletes a value from the user config cache
1307          *
1308          * @param int    $uid User Id
1309          * @param string $cat Config category
1310          * @param string $k   Config key
1311          */
1312         public function deletePConfigValue($uid, $cat, $k)
1313         {
1314                 if (isset($this->config[$uid][$cat][$k])) {
1315                         unset($this->config[$uid][$cat][$k]);
1316                 }
1317         }
1318
1319         /**
1320          * Generates the site's default sender email address
1321          *
1322          * @return string
1323          */
1324         public function getSenderEmailAddress()
1325         {
1326                 $sender_email = Config::get('config', 'sender_email');
1327                 if (empty($sender_email)) {
1328                         $hostname = $this->get_hostname();
1329                         if (strpos($hostname, ':')) {
1330                                 $hostname = substr($hostname, 0, strpos($hostname, ':'));
1331                         }
1332
1333                         $sender_email = 'noreply@' . $hostname;
1334                 }
1335
1336                 return $sender_email;
1337         }
1338
1339         /**
1340          * Returns the current theme name.
1341          *
1342          * @return string
1343          */
1344         public function getCurrentTheme()
1345         {
1346                 if ($this->isInstallMode()) {
1347                         return '';
1348                 }
1349
1350                 //// @TODO Compute the current theme only once (this behavior has
1351                 /// already been implemented, but it didn't work well -
1352                 /// https://github.com/friendica/friendica/issues/5092)
1353                 $this->computeCurrentTheme();
1354
1355                 return $this->current_theme;
1356         }
1357
1358         /**
1359          * Computes the current theme name based on the node settings, the user settings and the device type
1360          *
1361          * @throws Exception
1362          */
1363         private function computeCurrentTheme()
1364         {
1365                 $system_theme = Config::get('system', 'theme');
1366                 if (!$system_theme) {
1367                         throw new Exception(L10n::t('No system theme config value set.'));
1368                 }
1369
1370                 // Sane default
1371                 $this->current_theme = $system_theme;
1372
1373                 $allowed_themes = explode(',', Config::get('system', 'allowed_themes', $system_theme));
1374
1375                 $page_theme = null;
1376                 // Find the theme that belongs to the user whose stuff we are looking at
1377                 if ($this->profile_uid && ($this->profile_uid != local_user())) {
1378                         // Allow folks to override user themes and always use their own on their own site.
1379                         // This works only if the user is on the same server
1380                         $user = dba::selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
1381                         if (DBM::is_result($user) && !PConfig::get(local_user(), 'system', 'always_my_theme')) {
1382                                 $page_theme = $user['theme'];
1383                         }
1384                 }
1385
1386                 if (!empty($_SESSION)) {
1387                         $user_theme = defaults($_SESSION, 'theme', $system_theme);
1388                 } else {
1389                         $user_theme = $system_theme;
1390                 }
1391
1392                 // Specific mobile theme override
1393                 if (($this->is_mobile || $this->is_tablet) && defaults($_SESSION, 'show-mobile', true)) {
1394                         $system_mobile_theme = Config::get('system', 'mobile-theme');
1395                         $user_mobile_theme = defaults($_SESSION, 'mobile-theme', $system_mobile_theme);
1396
1397                         // --- means same mobile theme as desktop
1398                         if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
1399                                 $user_theme = $user_mobile_theme;
1400                         }
1401                 }
1402
1403                 if ($page_theme) {
1404                         $theme_name = $page_theme;
1405                 } else {
1406                         $theme_name = $user_theme;
1407                 }
1408
1409                 if ($theme_name
1410                         && in_array($theme_name, $allowed_themes)
1411                         && (file_exists('view/theme/' . $theme_name . '/style.css')
1412                         || file_exists('view/theme/' . $theme_name . '/style.php'))
1413                 ) {
1414                         $this->current_theme = $theme_name;
1415                 }
1416         }
1417
1418         /**
1419          * @brief Return full URL to theme which is currently in effect.
1420          *
1421          * Provide a sane default if nothing is chosen or the specified theme does not exist.
1422          *
1423          * @return string
1424          */
1425         public function getCurrentThemeStylesheetPath()
1426         {
1427                 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
1428         }
1429 }