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