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;
14 use Detection\MobileDetect;
18 require_once 'boot.php';
19 require_once 'include/dba.php';
20 require_once 'include/text.php';
26 * @brief Our main application structure for the life of this page.
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.
37 const MODE_LOCALCONFIGPRESENT = 1;
38 const MODE_DBAVAILABLE = 2;
39 const MODE_DBCONFIGAVAILABLE = 4;
40 const MODE_MAINTENANCEDISABLED = 8;
43 * @deprecated since version 2008.08 Use App->isInstallMode() instead to check for install mode.
45 const MODE_INSTALL = 0;
48 * @deprecated since version 2008.08 Use the precise mode constant to check for a specific capability instead.
50 const MODE_NORMAL = App::MODE_LOCALCONFIGPRESENT | App::MODE_DBAVAILABLE | App::MODE_DBCONFIGAVAILABLE | App::MODE_MAINTENANCEDISABLED;
52 public $module_loaded = false;
53 public $module_class = null;
54 public $query_string = '';
68 public $error = false;
73 public $mode = App::MODE_INSTALL;
79 public $interactive = true;
81 public $addons_admin = [];
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;
93 // Allow themes to control internal parameters
94 // by changing App values in theme.php
96 public $sourcename = '';
97 public $videowidth = 425;
98 public $videoheight = 350;
99 public $force_max_items = 0;
100 public $theme_events_in_profile = true;
103 * @brief An array for all theme-controllable parameters
105 * Mostly unimplemented yet. Only options 'template_engine' and
111 'videoheight' => 350,
112 'force_max_items' => 0,
114 'template_engine' => 'smarty3',
118 * @brief An array of registered template engines ('name'=>'class name')
120 public $template_engines = [];
123 * @brief An array of instanced template engines ('name'=>'instance')
125 public $template_engine_instance = [];
139 private $curl_content_type;
140 private $curl_headers;
143 * @brief App constructor.
145 * @param string $basepath Path to the app base folder
147 public function __construct($basepath)
149 if (!static::directory_usable($basepath, false)) {
150 throw new Exception('Basepath ' . $basepath . ' isn\'t usable.');
153 BaseObject::setApp($this);
155 $this->basepath = rtrim($basepath, DIRECTORY_SEPARATOR);
157 // The order of the following calls is important to ensure proper initialization
158 $this->loadConfigFiles();
160 $this->loadDatabase();
162 $this->determineMode();
164 $this->determineUrlPath();
168 if ($this->mode & self::MODE_DBAVAILABLE) {
169 Core\Addon::loadHooks();
171 $this->loadAddonConfig();
174 $this->loadDefaultTimezone();
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);
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'] = [];
211 $this->process_id = System::processID('log');
215 // This has to be quite large to deal with embedded private photos
216 ini_set('pcre.backtrack_limit', 500000);
218 $this->scheme = 'http';
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?
227 $this->scheme = 'https';
230 if (x($_SERVER, 'SERVER_NAME')) {
231 $this->hostname = $_SERVER['SERVER_NAME'];
233 if (x($_SERVER, 'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
234 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
239 get_include_path() . PATH_SEPARATOR
240 . $this->basepath . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
241 . $this->basepath . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
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);
250 // removing trailing / - maybe a nginx problem
251 $this->query_string = ltrim($this->query_string, '/');
253 if (!empty($_GET['pagename'])) {
254 $this->cmd = trim($_GET['pagename'], '/\\');
255 } elseif (!empty($_GET['q'])) {
256 $this->cmd = trim($_GET['q'], '/\\');
260 $this->query_string = str_replace($this->cmd . '&', $this->cmd . '?', $this->query_string);
262 // unix style "homedir"
263 if (substr($this->cmd, 0, 1) === '~') {
264 $this->cmd = 'profile/' . substr($this->cmd, 1);
267 // Diaspora style profile url
268 if (substr($this->cmd, 0, 2) === 'u/') {
269 $this->cmd = 'profile/' . substr($this->cmd, 2);
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:
281 * There will always be one argument. If provided a naked domain
282 * URL, $this->argv[0] is set to "home".
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);
292 $this->argv = ['home'];
293 $this->module = 'home';
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'];
301 if ($this->pager['start'] < 0) {
302 $this->pager['start'] = 0;
304 $this->pager['total'] = 0;
306 // Detect mobile devices
307 $mobile_detect = new MobileDetect();
308 $this->is_mobile = $mobile_detect->isMobile();
309 $this->is_tablet = $mobile_detect->isTablet();
312 $this->is_friendica_app = isset($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)';
314 // Register template engines
315 $this->register_template_engine('Friendica\Render\FriendicaSmartyEngine');
319 * Load the configuration files
321 * First loads the default value for all the configuration keys, then the legacy configuration files, then the
322 * expected local.ini.php
324 private function loadConfigFiles()
326 $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'defaults.ini.php');
328 // Legacy .htconfig.php support
329 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
331 include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
334 // Legacy .htconfig.php support
335 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
338 include $this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php';
339 unset($db_host, $db_user, $db_pass, $db_data);
341 if (isset($default_timezone)) {
342 $this->setConfigValue('system', 'default_timezone', $default_timezone);
343 unset($default_timezone);
346 if (isset($pidfile)) {
347 $this->setConfigValue('system', 'pidfile', $pidfile);
352 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')) {
353 $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php');
358 * Tries to load the specified configuration file into the App->config array.
359 * Overwrites previously set values.
361 * The config format is INI and the template for configuration files is the following:
363 * <?php return <<<INI
371 * @param type $filepath
374 public function loadConfigFile($filepath)
376 if (!file_exists($filepath)) {
377 throw new Exception('Error parsing non-existent config file ' . $filepath);
380 $contents = include($filepath);
382 $config = parse_ini_string($contents, true, INI_SCANNER_TYPED);
384 if ($config === false) {
385 throw new Exception('Error parsing config file ' . $filepath);
388 foreach($config as $category => $values) {
389 foreach($values as $key => $value) {
390 $this->setConfigValue($category, $key, $value);
396 * Loads addons configuration files
398 * First loads all activated addons default configuration throught the load_config hook, then load the local.ini.php
399 * again to overwrite potential local addon configuration.
401 private function loadAddonConfig()
403 // Loads addons default config
404 Core\Addon::callHooks('load_config');
406 // Load the local config file again in case there are overwritten addon config
407 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')) {
408 $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php');
413 * Loads the default timezone
415 * Include support for legacy $default_timezone
417 * @global string $default_timezone
419 private function loadDefaultTimezone()
421 if ($this->getConfigValue('system', 'default_timezone')) {
422 $this->timezone = $this->getConfigValue('system', 'default_timezone');
424 global $default_timezone;
425 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
428 if ($this->timezone) {
429 date_default_timezone_set($this->timezone);
434 * Figure out if we are running at the top of a domain or in a sub-directory and adjust accordingly
436 private function determineUrlPath()
438 $this->urlpath = $this->getConfigValue('system', 'urlpath');
440 /* SCRIPT_URL gives /path/to/friendica/module/parameter
441 * QUERY_STRING gives pagename=module/parameter
443 * To get /path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
445 if (!empty($_SERVER['SCRIPT_URL']) && !empty($_SERVER['QUERY_STRING'])) {
446 $path = trim(dirname($_SERVER['SCRIPT_URL'], substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
448 if ($path && $path != $this->urlpath) {
449 $this->urlpath = $path;
457 * - App::MODE_INSTALL : Either the database connection can't be established or the config table doesn't exist
458 * - App::MODE_MAINTENANCE: The maintenance mode has been set
459 * - App::MODE_NORMAL : Normal run with all features enabled
463 private function determineMode()
467 if (!file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')
468 && !file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
472 $this->mode |= App::MODE_LOCALCONFIGPRESENT;
474 if (!\dba::connected()) {
478 $this->mode |= App::MODE_DBAVAILABLE;
480 if (\dba::fetch_first("SHOW TABLES LIKE 'config'") === false) {
484 $this->mode |= App::MODE_DBCONFIGAVAILABLE;
486 if (Config::get('system', 'maintenance')) {
490 $this->mode |= App::MODE_MAINTENANCEDISABLED;
493 public function loadDatabase()
495 if (\dba::connected()) {
499 $db_host = $this->getConfigValue('database', 'hostname');
500 $db_user = $this->getConfigValue('database', 'username');
501 $db_pass = $this->getConfigValue('database', 'password');
502 $db_data = $this->getConfigValue('database', 'database');
503 $charset = $this->getConfigValue('database', 'charset');
505 // Use environment variables for mysql if they are set beforehand
506 if (!empty(getenv('MYSQL_HOST'))
507 && !empty(getenv('MYSQL_PORT'))
508 && (!empty(getenv('MYSQL_USERNAME')) || !empty(getenv('MYSQL_USER')))
509 && !empty(getenv('MYSQL_PASSWORD'))
510 && !empty(getenv('MYSQL_DATABASE')))
512 $db_host = getenv('MYSQL_HOST') . ':' . getenv('MYSQL_PORT');
514 if (!empty(getenv('MYSQL_USERNAME'))) {
515 $db_user = getenv('MYSQL_USERNAME');
516 } elseif (!empty(getenv('MYSQL_USER'))) {
517 $db_user = getenv('MYSQL_USER');
520 $db_pass = getenv('MYSQL_PASSWORD');
521 $db_data = getenv('MYSQL_DATABASE');
522 }elseif (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
523 $a = new \stdClass();
524 include $this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php';
525 $charset = isset($a->config["system"]["db_charset"]) ? $a->config["system"]["db_charset"] : $charset;
530 $stamp1 = microtime(true);
532 \dba::connect($db_host, $db_user, $db_pass, $db_data, $charset);
533 unset($db_host, $db_user, $db_pass, $db_data, $charset);
535 $this->save_timestamp($stamp1, "network");
539 * Install mode is when the local config file is missing or the DB schema hasn't been installed yet.
543 public function isInstallMode()
545 return !($this->mode & App::MODE_LOCALCONFIGPRESENT) || !($this->mode & App::MODE_DBCONFIGAVAILABLE);
549 * @brief Returns the base filesystem path of the App
551 * It first checks for the internal variable, then for DOCUMENT_ROOT and
556 public function get_basepath()
558 $basepath = $this->basepath;
561 $basepath = Config::get('system', 'basepath');
564 if (!$basepath && x($_SERVER, 'DOCUMENT_ROOT')) {
565 $basepath = $_SERVER['DOCUMENT_ROOT'];
568 if (!$basepath && x($_SERVER, 'PWD')) {
569 $basepath = $_SERVER['PWD'];
572 return self::realpath($basepath);
576 * @brief Returns a normalized file path
578 * This is a wrapper for the "realpath" function.
579 * That function cannot detect the real path when some folders aren't readable.
580 * Since this could happen with some hosters we need to handle this.
582 * @param string $path The path that is about to be normalized
583 * @return string normalized path - when possible
585 public static function realpath($path)
587 $normalized = realpath($path);
589 if (!is_bool($normalized)) {
596 public function get_scheme()
598 return $this->scheme;
602 * @brief Retrieves the Friendica instance base URL
604 * This function assembles the base URL from multiple parts:
605 * - Protocol is determined either by the request or a combination of
606 * system.ssl_policy and the $ssl parameter.
607 * - Host name is determined either by system.hostname or inferred from request
608 * - Path is inferred from SCRIPT_NAME
610 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
612 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
613 * @return string Friendica server base URL
615 public function get_baseurl($ssl = false)
617 $scheme = $this->scheme;
619 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
623 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
624 // (and also the login link). Anything seen by an outsider will have it turned off.
626 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
634 if (Config::get('config', 'hostname') != '') {
635 $this->hostname = Config::get('config', 'hostname');
638 return $scheme . '://' . $this->hostname . (!empty($this->urlpath) ? '/' . $this->urlpath : '' );
642 * @brief Initializes the baseurl components
644 * Clears the baseurl cache to prevent inconsistencies
648 public function set_baseurl($url)
650 $parsed = @parse_url($url);
654 if (!empty($parsed['scheme'])) {
655 $this->scheme = $parsed['scheme'];
658 if (!empty($parsed['host'])) {
659 $hostname = $parsed['host'];
662 if (x($parsed, 'port')) {
663 $hostname .= ':' . $parsed['port'];
665 if (x($parsed, 'path')) {
666 $this->urlpath = trim($parsed['path'], '\\/');
669 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
670 include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
673 if (Config::get('config', 'hostname') != '') {
674 $this->hostname = Config::get('config', 'hostname');
677 if (!isset($this->hostname) || ($this->hostname == '')) {
678 $this->hostname = $hostname;
683 public function get_hostname()
685 if (Config::get('config', 'hostname') != '') {
686 $this->hostname = Config::get('config', 'hostname');
689 return $this->hostname;
692 public function get_path()
694 return $this->urlpath;
697 public function set_pager_total($n)
699 $this->pager['total'] = intval($n);
702 public function set_pager_itemspage($n)
704 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
705 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
708 public function set_pager_page($n)
710 $this->pager['page'] = $n;
711 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
714 public function init_pagehead()
716 $interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000);
718 // If the update is 'deactivated' set it to the highest integer number (~24 days)
720 $interval = 2147483647;
723 if ($interval < 10000) {
727 // compose the page title from the sitename and the
728 // current module called
729 if (!$this->module == '') {
730 $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
732 $this->page['title'] = $this->config['sitename'];
735 /* put the head template at the beginning of page['htmlhead']
736 * since the code added by the modules frequently depends on it
739 if (!isset($this->page['htmlhead'])) {
740 $this->page['htmlhead'] = '';
743 // If we're using Smarty, then doing replace_macros() will replace
744 // any unrecognized variables with a blank string. Since we delay
745 // replacing $stylesheet until later, we need to replace it now
746 // with another variable name
747 if ($this->theme['template_engine'] === 'smarty3') {
748 $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
750 $stylesheet = '$stylesheet';
753 $shortcut_icon = Config::get('system', 'shortcut_icon');
754 if ($shortcut_icon == '') {
755 $shortcut_icon = 'images/friendica-32.png';
758 $touch_icon = Config::get('system', 'touch_icon');
759 if ($touch_icon == '') {
760 $touch_icon = 'images/friendica-128.png';
763 // get data wich is needed for infinite scroll on the network page
764 $invinite_scroll = infinite_scroll_data($this->module);
766 $tpl = get_markup_template('head.tpl');
767 $this->page['htmlhead'] = replace_macros($tpl, [
768 '$baseurl' => $this->get_baseurl(),
769 '$local_user' => local_user(),
770 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
771 '$delitem' => L10n::t('Delete this item?'),
772 '$showmore' => L10n::t('show more'),
773 '$showfewer' => L10n::t('show fewer'),
774 '$update_interval' => $interval,
775 '$shortcut_icon' => $shortcut_icon,
776 '$touch_icon' => $touch_icon,
777 '$stylesheet' => $stylesheet,
778 '$infinite_scroll' => $invinite_scroll,
779 '$block_public' => intval(Config::get('system', 'block_public')),
780 ]) . $this->page['htmlhead'];
783 public function init_page_end()
785 if (!isset($this->page['end'])) {
786 $this->page['end'] = '';
788 $tpl = get_markup_template('end.tpl');
789 $this->page['end'] = replace_macros($tpl, [
790 '$baseurl' => $this->get_baseurl()
791 ]) . $this->page['end'];
794 public function set_curl_code($code)
796 $this->curl_code = $code;
799 public function get_curl_code()
801 return $this->curl_code;
804 public function set_curl_content_type($content_type)
806 $this->curl_content_type = $content_type;
809 public function get_curl_content_type()
811 return $this->curl_content_type;
814 public function set_curl_headers($headers)
816 $this->curl_headers = $headers;
819 public function get_curl_headers()
821 return $this->curl_headers;
825 * @brief Removes the base url from an url. This avoids some mixed content problems.
827 * @param string $orig_url
829 * @return string The cleaned url
831 public function remove_baseurl($orig_url)
833 // Remove the hostname from the url if it is an internal link
834 $nurl = normalise_link($orig_url);
835 $base = normalise_link($this->get_baseurl());
836 $url = str_replace($base . '/', '', $nurl);
838 // if it is an external link return the orignal value
839 if ($url == normalise_link($orig_url)) {
847 * @brief Register template engine class
849 * @param string $class
851 private function register_template_engine($class)
853 $v = get_class_vars($class);
856 $this->template_engines[$name] = $class;
858 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
864 * @brief Return template engine instance.
866 * If $name is not defined, return engine defined by theme,
869 * @return object Template Engine instance
871 public function template_engine()
873 $template_engine = 'smarty3';
874 if (x($this->theme, 'template_engine')) {
875 $template_engine = $this->theme['template_engine'];
878 if (isset($this->template_engines[$template_engine])) {
879 if (isset($this->template_engine_instance[$template_engine])) {
880 return $this->template_engine_instance[$template_engine];
882 $class = $this->template_engines[$template_engine];
884 $this->template_engine_instance[$template_engine] = $obj;
889 echo "template engine <tt>$template_engine</tt> is not registered!\n";
894 * @brief Returns the active template engine.
898 public function get_template_engine()
900 return $this->theme['template_engine'];
903 public function set_template_engine($engine = 'smarty3')
905 $this->theme['template_engine'] = $engine;
908 public function get_template_ldelim($engine = 'smarty3')
910 return $this->ldelim[$engine];
913 public function get_template_rdelim($engine = 'smarty3')
915 return $this->rdelim[$engine];
918 public function save_timestamp($stamp, $value)
920 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
924 $duration = (float) (microtime(true) - $stamp);
926 if (!isset($this->performance[$value])) {
927 // Prevent ugly E_NOTICE
928 $this->performance[$value] = 0;
931 $this->performance[$value] += (float) $duration;
932 $this->performance['marktime'] += (float) $duration;
934 $callstack = System::callstack();
936 if (!isset($this->callstack[$value][$callstack])) {
937 // Prevent ugly E_NOTICE
938 $this->callstack[$value][$callstack] = 0;
941 $this->callstack[$value][$callstack] += (float) $duration;
944 public function get_useragent()
947 FRIENDICA_PLATFORM . " '" .
948 FRIENDICA_CODENAME . "' " .
949 FRIENDICA_VERSION . '-' .
950 DB_UPDATE_VERSION . '; ' .
951 $this->get_baseurl();
954 public function is_friendica_app()
956 return $this->is_friendica_app;
960 * @brief Checks if the site is called via a backend process
962 * This isn't a perfect solution. But we need this check very early.
963 * So we cannot wait until the modules are loaded.
965 * @return bool Is it a known backend?
967 public function is_backend()
991 // Check if current module is in backend or backend flag is set
992 return (in_array($this->module, $backends) || $this->backend);
996 * @brief Checks if the maximum number of database processes is reached
998 * @return bool Is the limit reached?
1000 public function isMaxProcessesReached()
1002 // Deactivated, needs more investigating if this check really makes sense
1006 * Commented out to suppress static analyzer issues
1008 if ($this->is_backend()) {
1009 $process = 'backend';
1010 $max_processes = Config::get('system', 'max_processes_backend');
1011 if (intval($max_processes) == 0) {
1015 $process = 'frontend';
1016 $max_processes = Config::get('system', 'max_processes_frontend');
1017 if (intval($max_processes) == 0) {
1018 $max_processes = 20;
1022 $processlist = DBM::processlist();
1023 if ($processlist['list'] != '') {
1024 logger('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], LOGGER_DEBUG);
1026 if ($processlist['amount'] > $max_processes) {
1027 logger('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', LOGGER_DEBUG);
1036 * @brief Checks if the minimal memory is reached
1038 * @return bool Is the memory limit reached?
1040 public function min_memory_reached()
1042 $min_memory = Config::get('system', 'min_memory', 0);
1043 if ($min_memory == 0) {
1047 if (!is_readable('/proc/meminfo')) {
1051 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
1054 foreach ($memdata as $line) {
1055 list($key, $val) = explode(':', $line);
1056 $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
1057 $meminfo[$key] = (int) ($meminfo[$key] / 1024);
1060 if (!isset($meminfo['MemAvailable']) || !isset($meminfo['MemFree'])) {
1064 $free = $meminfo['MemAvailable'] + $meminfo['MemFree'];
1066 $reached = ($free < $min_memory);
1069 logger('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, LOGGER_DEBUG);
1076 * @brief Checks if the maximum load is reached
1078 * @return bool Is the load reached?
1080 public function isMaxLoadReached()
1082 if ($this->is_backend()) {
1083 $process = 'backend';
1084 $maxsysload = intval(Config::get('system', 'maxloadavg'));
1085 if ($maxsysload < 1) {
1089 $process = 'frontend';
1090 $maxsysload = intval(Config::get('system', 'maxloadavg_frontend'));
1091 if ($maxsysload < 1) {
1096 $load = current_load();
1098 if (intval($load) > $maxsysload) {
1099 logger('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
1106 public function proc_run($args)
1108 if (!function_exists('proc_open')) {
1112 array_unshift($args, $this->getConfigValue('config', 'php_path', 'php'));
1114 for ($x = 0; $x < count($args); $x ++) {
1115 $args[$x] = escapeshellarg($args[$x]);
1118 $cmdline = implode(' ', $args);
1120 if ($this->min_memory_reached()) {
1124 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
1125 $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->get_basepath());
1127 $resource = proc_open($cmdline . ' &', [], $foo, $this->get_basepath());
1129 if (!is_resource($resource)) {
1130 logger('We got no resource for command ' . $cmdline, LOGGER_DEBUG);
1133 proc_close($resource);
1137 * @brief Returns the system user that is executing the script
1139 * This mostly returns something like "www-data".
1141 * @return string system username
1143 private static function systemuser()
1145 if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
1149 $processUser = posix_getpwuid(posix_geteuid());
1150 return $processUser['name'];
1154 * @brief Checks if a given directory is usable for the system
1156 * @return boolean the directory is usable
1158 public static function directory_usable($directory, $check_writable = true)
1160 if ($directory == '') {
1161 logger('Directory is empty. This shouldn\'t happen.', LOGGER_DEBUG);
1165 if (!file_exists($directory)) {
1166 logger('Path "' . $directory . '" does not exist for user ' . self::systemuser(), LOGGER_DEBUG);
1170 if (is_file($directory)) {
1171 logger('Path "' . $directory . '" is a file for user ' . self::systemuser(), LOGGER_DEBUG);
1175 if (!is_dir($directory)) {
1176 logger('Path "' . $directory . '" is not a directory for user ' . self::systemuser(), LOGGER_DEBUG);
1180 if ($check_writable && !is_writable($directory)) {
1181 logger('Path "' . $directory . '" is not writable for user ' . self::systemuser(), LOGGER_DEBUG);
1189 * @param string $cat Config category
1190 * @param string $k Config key
1191 * @param mixed $default Default value if it isn't set
1193 public function getConfigValue($cat, $k, $default = null)
1197 if ($cat === 'config') {
1198 if (isset($this->config[$k])) {
1199 $return = $this->config[$k];
1202 if (isset($this->config[$cat][$k])) {
1203 $return = $this->config[$cat][$k];
1211 * Sets a value in the config cache. Accepts raw output from the config table
1213 * @param string $cat Config category
1214 * @param string $k Config key
1215 * @param mixed $v Value to set
1217 public function setConfigValue($cat, $k, $v)
1219 // Only arrays are serialized in database, so we have to unserialize sparingly
1220 $value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
1222 if ($cat === 'config') {
1223 $this->config[$k] = $value;
1225 if (!isset($this->config[$cat])) {
1226 $this->config[$cat] = [];
1229 $this->config[$cat][$k] = $value;
1234 * Deletes a value from the config cache
1236 * @param string $cat Config category
1237 * @param string $k Config key
1239 public function deleteConfigValue($cat, $k)
1241 if ($cat === 'config') {
1242 if (isset($this->config[$k])) {
1243 unset($this->config[$k]);
1246 if (isset($this->config[$cat][$k])) {
1247 unset($this->config[$cat][$k]);
1254 * Retrieves a value from the user config cache
1256 * @param int $uid User Id
1257 * @param string $cat Config category
1258 * @param string $k Config key
1259 * @param mixed $default Default value if key isn't set
1261 public function getPConfigValue($uid, $cat, $k, $default = null)
1265 if (isset($this->config[$uid][$cat][$k])) {
1266 $return = $this->config[$uid][$cat][$k];
1273 * Sets a value in the user config cache
1275 * Accepts raw output from the pconfig table
1277 * @param int $uid User Id
1278 * @param string $cat Config category
1279 * @param string $k Config key
1280 * @param mixed $v Value to set
1282 public function setPConfigValue($uid, $cat, $k, $v)
1284 // Only arrays are serialized in database, so we have to unserialize sparingly
1285 $value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
1287 if (!isset($this->config[$uid])) {
1288 $this->config[$uid] = [];
1291 if (!isset($this->config[$uid][$cat])) {
1292 $this->config[$uid][$cat] = [];
1295 $this->config[$uid][$cat][$k] = $value;
1299 * Deletes a value from the user config cache
1301 * @param int $uid User Id
1302 * @param string $cat Config category
1303 * @param string $k Config key
1305 public function deletePConfigValue($uid, $cat, $k)
1307 if (isset($this->config[$uid][$cat][$k])) {
1308 unset($this->config[$uid][$cat][$k]);
1313 * Generates the site's default sender email address
1317 public function getSenderEmailAddress()
1319 $sender_email = Config::get('config', 'sender_email');
1320 if (empty($sender_email)) {
1321 $hostname = $this->get_hostname();
1322 if (strpos($hostname, ':')) {
1323 $hostname = substr($hostname, 0, strpos($hostname, ':'));
1326 $sender_email = 'noreply@' . $hostname;
1329 return $sender_email;
1333 * Returns the current theme name.
1337 public function getCurrentTheme()
1339 if ($this->isInstallMode()) {
1343 //// @TODO Compute the current theme only once (this behavior has
1344 /// already been implemented, but it didn't work well -
1345 /// https://github.com/friendica/friendica/issues/5092)
1346 $this->computeCurrentTheme();
1348 return $this->current_theme;
1352 * Computes the current theme name based on the node settings, the user settings and the device type
1356 private function computeCurrentTheme()
1358 $system_theme = Config::get('system', 'theme');
1359 if (!$system_theme) {
1360 throw new Exception(L10n::t('No system theme config value set.'));
1364 $this->current_theme = $system_theme;
1366 $allowed_themes = explode(',', Config::get('system', 'allowed_themes', $system_theme));
1369 // Find the theme that belongs to the user whose stuff we are looking at
1370 if ($this->profile_uid && ($this->profile_uid != local_user())) {
1371 // Allow folks to override user themes and always use their own on their own site.
1372 // This works only if the user is on the same server
1373 $user = dba::selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
1374 if (DBM::is_result($user) && !PConfig::get(local_user(), 'system', 'always_my_theme')) {
1375 $page_theme = $user['theme'];
1379 if (!empty($_SESSION)) {
1380 $user_theme = defaults($_SESSION, 'theme', $system_theme);
1382 $user_theme = $system_theme;
1385 // Specific mobile theme override
1386 if (($this->is_mobile || $this->is_tablet) && defaults($_SESSION, 'show-mobile', true)) {
1387 $system_mobile_theme = Config::get('system', 'mobile-theme');
1388 $user_mobile_theme = defaults($_SESSION, 'mobile-theme', $system_mobile_theme);
1390 // --- means same mobile theme as desktop
1391 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
1392 $user_theme = $user_mobile_theme;
1397 $theme_name = $page_theme;
1399 $theme_name = $user_theme;
1403 && in_array($theme_name, $allowed_themes)
1404 && (file_exists('view/theme/' . $theme_name . '/style.css')
1405 || file_exists('view/theme/' . $theme_name . '/style.php'))
1407 $this->current_theme = $theme_name;
1412 * @brief Return full URL to theme which is currently in effect.
1414 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1418 public function getCurrentThemeStylesheetPath()
1420 return Core\Theme::getStylesheetPath($this->getCurrentTheme());