7 use Detection\MobileDetect;
11 use Friendica\Core\Config\ConfigCache;
12 use Friendica\Core\Config\ConfigCacheLoader;
13 use Friendica\Database\DBA;
14 use Friendica\Factory\ConfigFactory;
15 use Friendica\Network\HTTPException\InternalServerErrorException;
16 use Psr\Log\LoggerInterface;
22 * @brief Our main application structure for the life of this page.
24 * Primarily deals with the URL that got us here
25 * and tries to make some sense of it, and
26 * stores our page contents and config storage
27 * and anything else that might need to be passed around
28 * before we spit the page out.
33 public $module_loaded = false;
34 public $module_class = null;
35 public $query_string = '';
46 public $error = false;
52 public $interactive = true;
54 public $is_mobile = false;
55 public $is_tablet = false;
56 public $performance = [];
57 public $callstack = [];
58 public $theme_info = [];
60 // Allow themes to control internal parameters
61 // by changing App values in theme.php
63 public $sourcename = '';
64 public $videowidth = 425;
65 public $videoheight = 350;
66 public $force_max_items = 0;
67 public $theme_events_in_profile = true;
69 public $stylesheets = [];
70 public $footerScripts = [];
73 * @var App\Mode The Mode of the Application
78 * @var string The App base path
83 * @var string The App URL path
88 * @var bool true, if the call is from the Friendica APP, otherwise false
90 private $isFriendicaApp;
93 * @var bool true, if the call is from an backend node (f.e. worker)
98 * @var string The name of the current theme
100 private $currentTheme;
103 * @var bool check if request was an AJAX (xmlhttprequest) request
110 public $mobileDetect;
113 * @var LoggerInterface The current logger of this App
118 * @var ConfigCache The cached config
123 * Returns the current config cache of this node
125 * @return ConfigCache
127 public function getConfig()
129 return $this->config;
133 * The basepath of this app
137 public function getBasePath()
139 return $this->basePath;
143 * Register a stylesheet file path to be included in the <head> tag of every page.
144 * Inclusion is done in App->initHead().
145 * The path can be absolute or relative to the Friendica installation base folder.
149 * @param string $path
150 * @throws InternalServerErrorException
152 public function registerStylesheet($path)
154 $url = str_replace($this->basePath . DIRECTORY_SEPARATOR, '', $path);
156 $this->stylesheets[] = trim($url, '/');
160 * Register a javascript file path to be included in the <footer> tag of every page.
161 * Inclusion is done in App->initFooter().
162 * The path can be absolute or relative to the Friendica installation base folder.
166 * @param string $path
167 * @throws InternalServerErrorException
169 public function registerFooterScript($path)
171 $url = str_replace($this->basePath . DIRECTORY_SEPARATOR, '', $path);
173 $this->footerScripts[] = trim($url, '/');
182 * @brief App constructor.
184 * @param ConfigCache $config The Cached Config
185 * @param LoggerInterface $logger Logger of this application
186 * @param bool $isBackend Whether it is used for backend or frontend (Default true=backend)
188 * @throws Exception if the Basepath is not usable
190 public function __construct(ConfigCache $config, LoggerInterface $logger, $isBackend = true)
192 $this->config = $config;
193 $this->logger = $logger;
194 $this->basePath = $this->config->get('system', 'basepath');
196 if (!Core\System::isDirectoryUsable($this->basePath, false)) {
197 throw new Exception('Basepath ' . $this->basePath . ' isn\'t usable.');
199 $this->basePath = rtrim($this->basePath, DIRECTORY_SEPARATOR);
201 BaseObject::setApp($this);
203 $this->checkBackend($isBackend);
204 $this->checkFriendicaApp();
206 $this->performance['start'] = microtime(true);
207 $this->performance['database'] = 0;
208 $this->performance['database_write'] = 0;
209 $this->performance['cache'] = 0;
210 $this->performance['cache_write'] = 0;
211 $this->performance['network'] = 0;
212 $this->performance['file'] = 0;
213 $this->performance['rendering'] = 0;
214 $this->performance['parser'] = 0;
215 $this->performance['marktime'] = 0;
216 $this->performance['markstart'] = microtime(true);
218 $this->callstack['database'] = [];
219 $this->callstack['database_write'] = [];
220 $this->callstack['cache'] = [];
221 $this->callstack['cache_write'] = [];
222 $this->callstack['network'] = [];
223 $this->callstack['file'] = [];
224 $this->callstack['rendering'] = [];
225 $this->callstack['parser'] = [];
227 $this->mode = new App\Mode($this->basePath);
233 // This has to be quite large to deal with embedded private photos
234 ini_set('pcre.backtrack_limit', 500000);
236 $this->scheme = 'http';
238 if (!empty($_SERVER['HTTPS']) ||
239 !empty($_SERVER['HTTP_FORWARDED']) && preg_match('/proto=https/', $_SERVER['HTTP_FORWARDED']) ||
240 !empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' ||
241 !empty($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on' ||
242 !empty($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on' ||
243 !empty($_SERVER['SERVER_PORT']) && (intval($_SERVER['SERVER_PORT']) == 443) // XXX: reasonable assumption, but isn't this hardcoding too much?
245 $this->scheme = 'https';
248 if (!empty($_SERVER['SERVER_NAME'])) {
249 $this->hostname = $_SERVER['SERVER_NAME'];
251 if (!empty($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
252 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
257 get_include_path() . PATH_SEPARATOR
258 . $this->basePath . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
259 . $this->basePath . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
262 if (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'pagename=') === 0) {
263 $this->query_string = substr($_SERVER['QUERY_STRING'], 9);
264 } elseif (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'q=') === 0) {
265 $this->query_string = substr($_SERVER['QUERY_STRING'], 2);
268 // removing trailing / - maybe a nginx problem
269 $this->query_string = ltrim($this->query_string, '/');
271 if (!empty($_GET['pagename'])) {
272 $this->cmd = trim($_GET['pagename'], '/\\');
273 } elseif (!empty($_GET['q'])) {
274 $this->cmd = trim($_GET['q'], '/\\');
278 $this->query_string = str_replace($this->cmd . '&', $this->cmd . '?', $this->query_string);
280 // unix style "homedir"
281 if (substr($this->cmd, 0, 1) === '~') {
282 $this->cmd = 'profile/' . substr($this->cmd, 1);
285 // Diaspora style profile url
286 if (substr($this->cmd, 0, 2) === 'u/') {
287 $this->cmd = 'profile/' . substr($this->cmd, 2);
291 * Break the URL path into C style argc/argv style arguments for our
292 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
293 * will be 3 (integer) and $this->argv will contain:
299 * There will always be one argument. If provided a naked domain
300 * URL, $this->argv[0] is set to "home".
303 $this->argv = explode('/', $this->cmd);
304 $this->argc = count($this->argv);
305 if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
306 $this->module = str_replace('.', '_', $this->argv[0]);
307 $this->module = str_replace('-', '_', $this->module);
310 $this->argv = ['home'];
311 $this->module = 'home';
314 // Detect mobile devices
315 $mobile_detect = new MobileDetect();
317 $this->mobileDetect = $mobile_detect;
319 $this->is_mobile = $mobile_detect->isMobile();
320 $this->is_tablet = $mobile_detect->isTablet();
322 $this->isAjax = strtolower(defaults($_SERVER, 'HTTP_X_REQUESTED_WITH', '')) == 'xmlhttprequest';
324 // Register template engines
325 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
329 * Returns the Mode of the Application
331 * @return App\Mode The Application Mode
333 * @throws InternalServerErrorException when the mode isn't created
335 public function getMode()
337 if (empty($this->mode)) {
338 throw new InternalServerErrorException('Mode of the Application is not defined');
345 * Returns the Logger of the Application
347 * @return LoggerInterface The Logger
348 * @throws InternalServerErrorException when the logger isn't created
350 public function getLogger()
352 if (empty($this->logger)) {
353 throw new InternalServerErrorException('Logger of the Application is not defined');
356 return $this->logger;
360 * Reloads the whole app instance
362 public function reload()
364 Core\Config::init($this->config);
365 Core\PConfig::init($this->config);
367 $this->loadDatabase();
369 $this->getMode()->determine($this->basePath);
371 $this->determineURLPath();
373 if ($this->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
374 $adapterType = $this->config->get('system', 'config_adapter');
375 $adapter = ConfigFactory::createConfig($adapterType, $this->config);
376 Core\Config::setAdapter($adapter);
377 $adapterP = ConfigFactory::createPConfig($adapterType, $this->config);
378 Core\PConfig::setAdapter($adapterP);
382 // again because DB-config could change the config
383 $this->getMode()->determine($this->basePath);
385 if ($this->getMode()->has(App\Mode::DBAVAILABLE)) {
386 Core\Hook::loadHooks();
387 $loader = new ConfigCacheLoader($this->basePath);
388 Core\Hook::callAll('load_config', $loader);
389 $this->config->loadConfigArray($loader->loadCoreConfig('addon'), true);
392 $this->loadDefaultTimezone();
396 $this->process_id = Core\System::processID('log');
398 Core\Logger::setLogger($this->logger);
402 * Loads the default timezone
404 * Include support for legacy $default_timezone
406 * @global string $default_timezone
408 private function loadDefaultTimezone()
410 if ($this->config->get('system', 'default_timezone')) {
411 $this->timezone = $this->config->get('system', 'default_timezone');
413 global $default_timezone;
414 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
417 if ($this->timezone) {
418 date_default_timezone_set($this->timezone);
423 * Figure out if we are running at the top of a domain or in a sub-directory and adjust accordingly
425 private function determineURLPath()
427 /* Relative script path to the web server root
428 * Not all of those $_SERVER properties can be present, so we do by inverse priority order
430 $relative_script_path = '';
431 $relative_script_path = defaults($_SERVER, 'REDIRECT_URL' , $relative_script_path);
432 $relative_script_path = defaults($_SERVER, 'REDIRECT_URI' , $relative_script_path);
433 $relative_script_path = defaults($_SERVER, 'REDIRECT_SCRIPT_URL', $relative_script_path);
434 $relative_script_path = defaults($_SERVER, 'SCRIPT_URL' , $relative_script_path);
435 $relative_script_path = defaults($_SERVER, 'REQUEST_URI' , $relative_script_path);
437 $this->urlPath = $this->config->get('system', 'urlpath');
439 /* $relative_script_path gives /relative/path/to/friendica/module/parameter
440 * QUERY_STRING gives pagename=module/parameter
442 * To get /relative/path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
444 if (!empty($relative_script_path)) {
446 if (!empty($_SERVER['QUERY_STRING'])) {
447 $path = trim(rdirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
450 $path = trim($relative_script_path, '/');
453 if ($path && $path != $this->urlPath) {
454 $this->urlPath = $path;
459 public function loadDatabase()
461 if (DBA::connected()) {
465 $db_host = $this->config->get('database', 'hostname');
466 $db_user = $this->config->get('database', 'username');
467 $db_pass = $this->config->get('database', 'password');
468 $db_data = $this->config->get('database', 'database');
469 $charset = $this->config->get('database', 'charset');
471 // Use environment variables for mysql if they are set beforehand
472 if (!empty(getenv('MYSQL_HOST'))
473 && !empty(getenv('MYSQL_USERNAME') || !empty(getenv('MYSQL_USER')))
474 && getenv('MYSQL_PASSWORD') !== false
475 && !empty(getenv('MYSQL_DATABASE')))
477 $db_host = getenv('MYSQL_HOST');
478 if (!empty(getenv('MYSQL_PORT'))) {
479 $db_host .= ':' . getenv('MYSQL_PORT');
481 if (!empty(getenv('MYSQL_USERNAME'))) {
482 $db_user = getenv('MYSQL_USERNAME');
484 $db_user = getenv('MYSQL_USER');
486 $db_pass = (string) getenv('MYSQL_PASSWORD');
487 $db_data = getenv('MYSQL_DATABASE');
490 $stamp1 = microtime(true);
492 if (DBA::connect($this->config, $db_host, $db_user, $db_pass, $db_data, $charset)) {
493 // Loads DB_UPDATE_VERSION constant
494 Database\DBStructure::definition($this->basePath, false);
497 unset($db_host, $db_user, $db_pass, $db_data, $charset);
499 $this->saveTimestamp($stamp1, 'network');
502 public function getScheme()
504 return $this->scheme;
508 * @brief Retrieves the Friendica instance base URL
510 * This function assembles the base URL from multiple parts:
511 * - Protocol is determined either by the request or a combination of
512 * system.ssl_policy and the $ssl parameter.
513 * - Host name is determined either by system.hostname or inferred from request
514 * - Path is inferred from SCRIPT_NAME
516 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
518 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
519 * @return string Friendica server base URL
520 * @throws InternalServerErrorException
522 public function getBaseURL($ssl = false)
524 $scheme = $this->scheme;
526 if (Core\Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
530 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
531 // (and also the login link). Anything seen by an outsider will have it turned off.
533 if (Core\Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
541 if (Core\Config::get('config', 'hostname') != '') {
542 $this->hostname = Core\Config::get('config', 'hostname');
545 return $scheme . '://' . $this->hostname . (!empty($this->getURLPath()) ? '/' . $this->getURLPath() : '' );
549 * @brief Initializes the baseurl components
551 * Clears the baseurl cache to prevent inconsistencies
554 * @throws InternalServerErrorException
556 public function setBaseURL($url)
558 $parsed = @parse_url($url);
561 if (!empty($parsed)) {
562 if (!empty($parsed['scheme'])) {
563 $this->scheme = $parsed['scheme'];
566 if (!empty($parsed['host'])) {
567 $hostname = $parsed['host'];
570 if (!empty($parsed['port'])) {
571 $hostname .= ':' . $parsed['port'];
573 if (!empty($parsed['path'])) {
574 $this->urlPath = trim($parsed['path'], '\\/');
577 if (file_exists($this->basePath . '/.htpreconfig.php')) {
578 include $this->basePath . '/.htpreconfig.php';
581 if (Core\Config::get('config', 'hostname') != '') {
582 $this->hostname = Core\Config::get('config', 'hostname');
585 if (!isset($this->hostname) || ($this->hostname == '')) {
586 $this->hostname = $hostname;
591 public function getHostName()
593 if (Core\Config::get('config', 'hostname') != '') {
594 $this->hostname = Core\Config::get('config', 'hostname');
597 return $this->hostname;
600 public function getURLPath()
602 return $this->urlPath;
606 * Initializes App->page['htmlhead'].
611 * - Registered stylesheets (through App->registerStylesheet())
612 * - Infinite scroll data
613 * - head.tpl template
615 public function initHead()
617 $interval = ((local_user()) ? Core\PConfig::get(local_user(), 'system', 'update_interval') : 40000);
619 // If the update is 'deactivated' set it to the highest integer number (~24 days)
621 $interval = 2147483647;
624 if ($interval < 10000) {
628 // compose the page title from the sitename and the
629 // current module called
630 if (!$this->module == '') {
631 $this->page['title'] = $this->config->get('config', 'sitename') . ' (' . $this->module . ')';
633 $this->page['title'] = $this->config->get('config', 'sitename');
636 if (!empty(Core\Renderer::$theme['stylesheet'])) {
637 $stylesheet = Core\Renderer::$theme['stylesheet'];
639 $stylesheet = $this->getCurrentThemeStylesheetPath();
642 $this->registerStylesheet($stylesheet);
644 $shortcut_icon = Core\Config::get('system', 'shortcut_icon');
645 if ($shortcut_icon == '') {
646 $shortcut_icon = 'images/friendica-32.png';
649 $touch_icon = Core\Config::get('system', 'touch_icon');
650 if ($touch_icon == '') {
651 $touch_icon = 'images/friendica-128.png';
654 Core\Hook::callAll('head', $this->page['htmlhead']);
656 $tpl = Core\Renderer::getMarkupTemplate('head.tpl');
657 /* put the head template at the beginning of page['htmlhead']
658 * since the code added by the modules frequently depends on it
661 $this->page['htmlhead'] = Core\Renderer::replaceMacros($tpl, [
662 '$baseurl' => $this->getBaseURL(),
663 '$local_user' => local_user(),
664 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
665 '$delitem' => Core\L10n::t('Delete this item?'),
666 '$update_interval' => $interval,
667 '$shortcut_icon' => $shortcut_icon,
668 '$touch_icon' => $touch_icon,
669 '$block_public' => intval(Core\Config::get('system', 'block_public')),
670 '$stylesheets' => $this->stylesheets,
671 ]) . $this->page['htmlhead'];
675 * Initializes App->page['footer'].
678 * - Javascript homebase
679 * - Mobile toggle link
680 * - Registered footer scripts (through App->registerFooterScript())
681 * - footer.tpl template
683 public function initFooter()
685 // If you're just visiting, let javascript take you home
686 if (!empty($_SESSION['visitor_home'])) {
687 $homebase = $_SESSION['visitor_home'];
688 } elseif (local_user()) {
689 $homebase = 'profile/' . $this->user['nickname'];
692 if (isset($homebase)) {
693 $this->page['footer'] .= '<script>var homebase="' . $homebase . '";</script>' . "\n";
697 * Add a "toggle mobile" link if we're using a mobile device
699 if ($this->is_mobile || $this->is_tablet) {
700 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
701 $link = 'toggle_mobile?address=' . urlencode(curPageURL());
703 $link = 'toggle_mobile?off=1&address=' . urlencode(curPageURL());
705 $this->page['footer'] .= Core\Renderer::replaceMacros(Core\Renderer::getMarkupTemplate("toggle_mobile_footer.tpl"), [
706 '$toggle_link' => $link,
707 '$toggle_text' => Core\L10n::t('toggle mobile')
711 Core\Hook::callAll('footer', $this->page['footer']);
713 $tpl = Core\Renderer::getMarkupTemplate('footer.tpl');
714 $this->page['footer'] = Core\Renderer::replaceMacros($tpl, [
715 '$baseurl' => $this->getBaseURL(),
716 '$footerScripts' => $this->footerScripts,
717 ]) . $this->page['footer'];
721 * @brief Removes the base url from an url. This avoids some mixed content problems.
723 * @param string $origURL
725 * @return string The cleaned url
726 * @throws InternalServerErrorException
728 public function removeBaseURL($origURL)
730 // Remove the hostname from the url if it is an internal link
731 $nurl = Util\Strings::normaliseLink($origURL);
732 $base = Util\Strings::normaliseLink($this->getBaseURL());
733 $url = str_replace($base . '/', '', $nurl);
735 // if it is an external link return the orignal value
736 if ($url == Util\Strings::normaliseLink($origURL)) {
744 * Saves a timestamp for a value - f.e. a call
745 * Necessary for profiling Friendica
747 * @param int $timestamp the Timestamp
748 * @param string $value A value to profile
750 public function saveTimestamp($timestamp, $value)
752 $profiler = $this->config->get('system', 'profiler');
754 if (!isset($profiler) || !$profiler) {
758 $duration = (float) (microtime(true) - $timestamp);
760 if (!isset($this->performance[$value])) {
761 // Prevent ugly E_NOTICE
762 $this->performance[$value] = 0;
765 $this->performance[$value] += (float) $duration;
766 $this->performance['marktime'] += (float) $duration;
768 $callstack = Core\System::callstack();
770 if (!isset($this->callstack[$value][$callstack])) {
771 // Prevent ugly E_NOTICE
772 $this->callstack[$value][$callstack] = 0;
775 $this->callstack[$value][$callstack] += (float) $duration;
779 * Returns the current UserAgent as a String
781 * @return string the UserAgent as a String
782 * @throws InternalServerErrorException
784 public function getUserAgent()
787 FRIENDICA_PLATFORM . " '" .
788 FRIENDICA_CODENAME . "' " .
789 FRIENDICA_VERSION . '-' .
790 DB_UPDATE_VERSION . '; ' .
795 * Checks, if the call is from the Friendica App
798 * The friendica client has problems with the GUID in the notify. this is some workaround
800 private function checkFriendicaApp()
803 $this->isFriendicaApp = isset($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)';
807 * Is the call via the Friendica app? (not a "normale" call)
809 * @return bool true if it's from the Friendica app
811 public function isFriendicaApp()
813 return $this->isFriendicaApp;
817 * @brief Checks if the site is called via a backend process
819 * This isn't a perfect solution. But we need this check very early.
820 * So we cannot wait until the modules are loaded.
822 * @param string $backend true, if the backend flag was set during App initialization
825 private function checkBackend($backend) {
848 // Check if current module is in backend or backend flag is set
849 $this->isBackend = (in_array($this->module, $backends) || $backend || $this->isBackend);
853 * Returns true, if the call is from a backend node (f.e. from a worker)
855 * @return bool Is it a known backend?
857 public function isBackend()
859 return $this->isBackend;
863 * @brief Checks if the maximum number of database processes is reached
865 * @return bool Is the limit reached?
867 public function isMaxProcessesReached()
869 // Deactivated, needs more investigating if this check really makes sense
873 * Commented out to suppress static analyzer issues
875 if ($this->is_backend()) {
876 $process = 'backend';
877 $max_processes = Core\Config::get('system', 'max_processes_backend');
878 if (intval($max_processes) == 0) {
882 $process = 'frontend';
883 $max_processes = Core\Config::get('system', 'max_processes_frontend');
884 if (intval($max_processes) == 0) {
889 $processlist = DBA::processlist();
890 if ($processlist['list'] != '') {
891 Core\Logger::log('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], Core\Logger::DEBUG);
893 if ($processlist['amount'] > $max_processes) {
894 Core\Logger::log('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', Core\Logger::DEBUG);
903 * @brief Checks if the minimal memory is reached
905 * @return bool Is the memory limit reached?
906 * @throws InternalServerErrorException
908 public function isMinMemoryReached()
910 $min_memory = Core\Config::get('system', 'min_memory', 0);
911 if ($min_memory == 0) {
915 if (!is_readable('/proc/meminfo')) {
919 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
922 foreach ($memdata as $line) {
923 $data = explode(':', $line);
924 if (count($data) != 2) {
927 list($key, $val) = $data;
928 $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
929 $meminfo[$key] = (int) ($meminfo[$key] / 1024);
932 if (!isset($meminfo['MemFree'])) {
936 $free = $meminfo['MemFree'];
938 $reached = ($free < $min_memory);
941 Core\Logger::log('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, Core\Logger::DEBUG);
948 * @brief Checks if the maximum load is reached
950 * @return bool Is the load reached?
951 * @throws InternalServerErrorException
953 public function isMaxLoadReached()
955 if ($this->isBackend()) {
956 $process = 'backend';
957 $maxsysload = intval(Core\Config::get('system', 'maxloadavg'));
958 if ($maxsysload < 1) {
962 $process = 'frontend';
963 $maxsysload = intval(Core\Config::get('system', 'maxloadavg_frontend'));
964 if ($maxsysload < 1) {
969 $load = Core\System::currentLoad();
971 if (intval($load) > $maxsysload) {
972 Core\Logger::log('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
980 * Executes a child process with 'proc_open'
982 * @param string $command The command to execute
983 * @param array $args Arguments to pass to the command ( [ 'key' => value, 'key2' => value2, ... ]
984 * @throws InternalServerErrorException
986 public function proc_run($command, $args)
988 if (!function_exists('proc_open')) {
992 $cmdline = $this->config->get('config', 'php_path', 'php') . ' ' . escapeshellarg($command);
994 foreach ($args as $key => $value) {
995 if (!is_null($value) && is_bool($value) && !$value) {
999 $cmdline .= ' --' . $key;
1000 if (!is_null($value) && !is_bool($value)) {
1001 $cmdline .= ' ' . $value;
1005 if ($this->isMinMemoryReached()) {
1009 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
1010 $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->basePath);
1012 $resource = proc_open($cmdline . ' &', [], $foo, $this->basePath);
1014 if (!is_resource($resource)) {
1015 Core\Logger::log('We got no resource for command ' . $cmdline, Core\Logger::DEBUG);
1018 proc_close($resource);
1022 * Generates the site's default sender email address
1025 * @throws InternalServerErrorException
1027 public function getSenderEmailAddress()
1029 $sender_email = Core\Config::get('config', 'sender_email');
1030 if (empty($sender_email)) {
1031 $hostname = $this->getHostName();
1032 if (strpos($hostname, ':')) {
1033 $hostname = substr($hostname, 0, strpos($hostname, ':'));
1036 $sender_email = 'noreply@' . $hostname;
1039 return $sender_email;
1043 * Returns the current theme name.
1045 * @return string the name of the current theme
1046 * @throws InternalServerErrorException
1048 public function getCurrentTheme()
1050 if ($this->getMode()->isInstall()) {
1054 if (!$this->currentTheme) {
1055 $this->computeCurrentTheme();
1058 return $this->currentTheme;
1061 public function setCurrentTheme($theme)
1063 $this->currentTheme = $theme;
1067 * Computes the current theme name based on the node settings, the user settings and the device type
1071 private function computeCurrentTheme()
1073 $system_theme = Core\Config::get('system', 'theme');
1074 if (!$system_theme) {
1075 throw new Exception(Core\L10n::t('No system theme config value set.'));
1079 $this->currentTheme = $system_theme;
1081 $allowed_themes = explode(',', Core\Config::get('system', 'allowed_themes', $system_theme));
1084 // Find the theme that belongs to the user whose stuff we are looking at
1085 if ($this->profile_uid && ($this->profile_uid != local_user())) {
1086 // Allow folks to override user themes and always use their own on their own site.
1087 // This works only if the user is on the same server
1088 $user = DBA::selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
1089 if (DBA::isResult($user) && !Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
1090 $page_theme = $user['theme'];
1094 $user_theme = Core\Session::get('theme', $system_theme);
1096 // Specific mobile theme override
1097 if (($this->is_mobile || $this->is_tablet) && Core\Session::get('show-mobile', true)) {
1098 $system_mobile_theme = Core\Config::get('system', 'mobile-theme');
1099 $user_mobile_theme = Core\Session::get('mobile-theme', $system_mobile_theme);
1101 // --- means same mobile theme as desktop
1102 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
1103 $user_theme = $user_mobile_theme;
1108 $theme_name = $page_theme;
1110 $theme_name = $user_theme;
1114 && in_array($theme_name, $allowed_themes)
1115 && (file_exists('view/theme/' . $theme_name . '/style.css')
1116 || file_exists('view/theme/' . $theme_name . '/style.php'))
1118 $this->currentTheme = $theme_name;
1123 * @brief Return full URL to theme which is currently in effect.
1125 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1128 * @throws InternalServerErrorException
1130 public function getCurrentThemeStylesheetPath()
1132 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
1136 * Check if request was an AJAX (xmlhttprequest) request.
1138 * @return boolean true if it was an AJAX request
1140 public function isAjax()
1142 return $this->isAjax;
1146 * Returns the value of a argv key
1147 * TODO there are a lot of $a->argv usages in combination with defaults() which can be replaced with this method
1149 * @param int $position the position of the argument
1150 * @param mixed $default the default value if not found
1152 * @return mixed returns the value of the argument
1154 public function getArgumentValue($position, $default = '')
1156 if (array_key_exists($position, $this->argv)) {
1157 return $this->argv[$position];
1164 * Sets the base url for use in cmdline programs which don't have
1165 * $_SERVER variables
1167 public function checkURL()
1169 $url = Core\Config::get('system', 'url');
1171 // if the url isn't set or the stored url is radically different
1172 // than the currently visited url, store the current value accordingly.
1173 // "Radically different" ignores common variations such as http vs https
1174 // and www.example.com vs example.com.
1175 // We will only change the url to an ip address if there is no existing setting
1177 if (empty($url) || (!Util\Strings::compareLink($url, $this->getBaseURL())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $this->getHostName()))) {
1178 Core\Config::set('system', 'url', $this->getBaseURL());
1183 * Frontend App script
1185 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
1186 * request and a representation of the response.
1188 * This probably should change to limit the size of this monster method.
1190 public function runFrontend()
1192 // Missing DB connection: ERROR
1193 if ($this->getMode()->has(App\Mode::LOCALCONFIGPRESENT) && !$this->getMode()->has(App\Mode::DBAVAILABLE)) {
1194 Core\System::httpExit(500, ['title' => 'Error 500 - Internal Server Error', 'description' => 'Apologies but the website is unavailable at the moment.']);
1197 // Max Load Average reached: ERROR
1198 if ($this->isMaxProcessesReached() || $this->isMaxLoadReached()) {
1199 header('Retry-After: 120');
1200 header('Refresh: 120; url=' . $this->getBaseURL() . "/" . $this->query_string);
1202 Core\System::httpExit(503, ['title' => 'Error 503 - Service Temporarily Unavailable', 'description' => 'Core\System is currently overloaded. Please try again later.']);
1205 if (strstr($this->query_string, '.well-known/host-meta') && ($this->query_string != '.well-known/host-meta')) {
1206 Core\System::httpExit(404);
1209 if (!$this->getMode()->isInstall()) {
1210 // Force SSL redirection
1211 if (Core\Config::get('system', 'force_ssl') && ($this->getScheme() == "http")
1212 && intval(Core\Config::get('system', 'ssl_policy')) == SSL_POLICY_FULL
1213 && strpos($this->getBaseURL(), 'https://') === 0
1214 && $_SERVER['REQUEST_METHOD'] == 'GET') {
1215 header('HTTP/1.1 302 Moved Temporarily');
1216 header('Location: ' . $this->getBaseURL() . '/' . $this->query_string);
1220 Core\Session::init();
1221 Core\Hook::callAll('init_1');
1224 // Exclude the backend processes from the session management
1225 if (!$this->isBackend()) {
1226 $stamp1 = microtime(true);
1228 $this->saveTimestamp($stamp1, 'parser');
1229 Core\L10n::setSessionVariable();
1230 Core\L10n::setLangFromSession();
1233 Core\Worker::executeIfIdle();
1237 if (!empty($_GET['zrl']) && $this->getMode()->isNormal()) {
1238 $this->query_string = Model\Profile::stripZrls($this->query_string);
1239 if (!local_user()) {
1240 // Only continue when the given profile link seems valid
1241 // Valid profile links contain a path with "/profile/" and no query parameters
1242 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
1243 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
1244 if (defaults($_SESSION, "visitor_home", "") != $_GET["zrl"]) {
1245 $_SESSION['my_url'] = $_GET['zrl'];
1246 $_SESSION['authenticated'] = 0;
1248 Model\Profile::zrlInit($this);
1250 // Someone came with an invalid parameter, maybe as a DDoS attempt
1251 // We simply stop processing here
1252 Core\Logger::log("Invalid ZRL parameter " . $_GET['zrl'], Core\Logger::DEBUG);
1253 Core\System::httpExit(403, ['title' => '403 Forbidden']);
1258 if (!empty($_GET['owt']) && $this->getMode()->isNormal()) {
1259 $token = $_GET['owt'];
1260 $this->query_string = Model\Profile::stripQueryParam($this->query_string, 'owt');
1261 Model\Profile::openWebAuthInit($token);
1264 Module\Login::sessionAuth();
1266 if (empty($_SESSION['authenticated'])) {
1267 header('X-Account-Management-Status: none');
1270 $_SESSION['sysmsg'] = defaults($_SESSION, 'sysmsg' , []);
1271 $_SESSION['sysmsg_info'] = defaults($_SESSION, 'sysmsg_info' , []);
1272 $_SESSION['last_updated'] = defaults($_SESSION, 'last_updated', []);
1275 * check_config() is responsible for running update scripts. These automatically
1276 * update the DB schema whenever we push a new one out. It also checks to see if
1277 * any addons have been added or removed and reacts accordingly.
1280 // in install mode, any url loads install module
1281 // but we need "view" module for stylesheet
1282 if ($this->getMode()->isInstall() && $this->module != 'view') {
1283 $this->module = 'install';
1284 } elseif (!$this->getMode()->has(App\Mode::MAINTENANCEDISABLED) && $this->module != 'view') {
1285 $this->module = 'maintenance';
1288 Core\Update::check($this->basePath, false);
1289 Core\Addon::loadAddons();
1290 Core\Hook::loadHooks();
1301 'right_aside' => '',
1306 if (strlen($this->module)) {
1307 // Compatibility with the Android Diaspora client
1308 if ($this->module == 'stream') {
1309 $this->internalRedirect('network?f=&order=post');
1312 if ($this->module == 'conversations') {
1313 $this->internalRedirect('message');
1316 if ($this->module == 'commented') {
1317 $this->internalRedirect('network?f=&order=comment');
1320 if ($this->module == 'liked') {
1321 $this->internalRedirect('network?f=&order=comment');
1324 if ($this->module == 'activity') {
1325 $this->internalRedirect('network/?f=&conv=1');
1328 if (($this->module == 'status_messages') && ($this->cmd == 'status_messages/new')) {
1329 $this->internalRedirect('bookmarklet');
1332 if (($this->module == 'user') && ($this->cmd == 'user/edit')) {
1333 $this->internalRedirect('settings');
1336 if (($this->module == 'tag_followings') && ($this->cmd == 'tag_followings/manage')) {
1337 $this->internalRedirect('search');
1340 // Compatibility with the Firefox App
1341 if (($this->module == "users") && ($this->cmd == "users/sign_in")) {
1342 $this->module = "login";
1345 $privateapps = Core\Config::get('config', 'private_addons', false);
1346 if (Core\Addon::isEnabled($this->module) && file_exists("addon/{$this->module}/{$this->module}.php")) {
1347 //Check if module is an app and if public access to apps is allowed or not
1348 if ((!local_user()) && Core\Hook::isAddonApp($this->module) && $privateapps) {
1349 info(Core\L10n::t("You must be logged in to use addons. "));
1351 include_once "addon/{$this->module}/{$this->module}.php";
1352 if (function_exists($this->module . '_module')) {
1353 LegacyModule::setModuleFile("addon/{$this->module}/{$this->module}.php");
1354 $this->module_class = 'Friendica\\LegacyModule';
1355 $this->module_loaded = true;
1360 // Controller class routing
1361 if (! $this->module_loaded && class_exists('Friendica\\Module\\' . ucfirst($this->module))) {
1362 $this->module_class = 'Friendica\\Module\\' . ucfirst($this->module);
1363 $this->module_loaded = true;
1366 /* If not, next look for a 'standard' program module in the 'mod' directory
1367 * We emulate a Module class through the LegacyModule class
1369 if (! $this->module_loaded && file_exists("mod/{$this->module}.php")) {
1370 LegacyModule::setModuleFile("mod/{$this->module}.php");
1371 $this->module_class = 'Friendica\\LegacyModule';
1372 $this->module_loaded = true;
1375 /* The URL provided does not resolve to a valid module.
1377 * On Dreamhost sites, quite often things go wrong for no apparent reason and they send us to '/internal_error.html'.
1378 * We don't like doing this, but as it occasionally accounts for 10-20% or more of all site traffic -
1379 * we are going to trap this and redirect back to the requested page. As long as you don't have a critical error on your page
1380 * this will often succeed and eventually do the right thing.
1382 * Otherwise we are going to emit a 404 not found.
1384 if (! $this->module_loaded) {
1385 // Stupid browser tried to pre-fetch our Javascript img template. Don't log the event or return anything - just quietly exit.
1386 if (!empty($_SERVER['QUERY_STRING']) && preg_match('/{[0-9]}/', $_SERVER['QUERY_STRING']) !== 0) {
1390 if (!empty($_SERVER['QUERY_STRING']) && ($_SERVER['QUERY_STRING'] === 'q=internal_error.html') && isset($dreamhost_error_hack)) {
1391 Core\Logger::log('index.php: dreamhost_error_hack invoked. Original URI =' . $_SERVER['REQUEST_URI']);
1392 $this->internalRedirect($_SERVER['REQUEST_URI']);
1395 Core\Logger::log('index.php: page not found: ' . $_SERVER['REQUEST_URI'] . ' ADDRESS: ' . $_SERVER['REMOTE_ADDR'] . ' QUERY: ' . $_SERVER['QUERY_STRING'], Core\Logger::DEBUG);
1397 header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . Core\L10n::t('Not Found'));
1398 $tpl = Core\Renderer::getMarkupTemplate("404.tpl");
1399 $this->page['content'] = Core\Renderer::replaceMacros($tpl, [
1400 '$message' => Core\L10n::t('Page not found.')
1407 // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
1408 if ($this->module_loaded) {
1409 $this->page['page_title'] = $this->module;
1412 Core\Hook::callAll($this->module . '_mod_init', $placeholder);
1414 call_user_func([$this->module_class, 'init']);
1416 // "rawContent" is especially meant for technical endpoints.
1417 // This endpoint doesn't need any theme initialization or other comparable stuff.
1418 if (!$this->error) {
1419 call_user_func([$this->module_class, 'rawContent']);
1423 // Load current theme info after module has been initialized as theme could have been set in module
1424 $theme_info_file = 'view/theme/' . $this->getCurrentTheme() . '/theme.php';
1425 if (file_exists($theme_info_file)) {
1426 require_once $theme_info_file;
1429 if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_init')) {
1430 $func = str_replace('-', '_', $this->getCurrentTheme()) . '_init';
1434 if ($this->module_loaded) {
1435 if (! $this->error && $_SERVER['REQUEST_METHOD'] === 'POST') {
1436 Core\Hook::callAll($this->module . '_mod_post', $_POST);
1437 call_user_func([$this->module_class, 'post']);
1440 if (! $this->error) {
1441 Core\Hook::callAll($this->module . '_mod_afterpost', $placeholder);
1442 call_user_func([$this->module_class, 'afterpost']);
1445 if (! $this->error) {
1446 $arr = ['content' => $content];
1447 Core\Hook::callAll($this->module . '_mod_content', $arr);
1448 $content = $arr['content'];
1449 $arr = ['content' => call_user_func([$this->module_class, 'content'])];
1450 Core\Hook::callAll($this->module . '_mod_aftercontent', $arr);
1451 $content .= $arr['content'];
1455 // initialise content region
1456 if ($this->getMode()->isNormal()) {
1457 Core\Hook::callAll('page_content_top', $this->page['content']);
1460 $this->page['content'] .= $content;
1462 /* Create the page head after setting the language
1463 * and getting any auth credentials.
1465 * Moved initHead() and initFooter() to after
1466 * all the module functions have executed so that all
1467 * theme choices made by the modules can take effect.
1471 /* Build the page ending -- this is stuff that goes right before
1472 * the closing </body> tag
1474 $this->initFooter();
1476 /* now that we've been through the module content, see if the page reported
1477 * a permission problem and if so, a 403 response would seem to be in order.
1479 if (stristr(implode("", $_SESSION['sysmsg']), Core\L10n::t('Permission denied'))) {
1480 header($_SERVER["SERVER_PROTOCOL"] . ' 403 ' . Core\L10n::t('Permission denied.'));
1483 // Report anything which needs to be communicated in the notification area (before the main body)
1484 Core\Hook::callAll('page_end', $this->page['content']);
1486 // Add the navigation (menu) template
1487 if ($this->module != 'install' && $this->module != 'maintenance') {
1488 $this->page['htmlhead'] .= Core\Renderer::replaceMacros(Core\Renderer::getMarkupTemplate('nav_head.tpl'), []);
1489 $this->page['nav'] = Content\Nav::build($this);
1492 // Build the page - now that we have all the components
1493 if (isset($_GET["mode"]) && (($_GET["mode"] == "raw") || ($_GET["mode"] == "minimal"))) {
1494 $doc = new DOMDocument();
1496 $target = new DOMDocument();
1497 $target->loadXML("<root></root>");
1499 $content = mb_convert_encoding($this->page["content"], 'HTML-ENTITIES', "UTF-8");
1501 /// @TODO one day, kill those error-surpressing @ stuff, or PHP should ban it
1502 @$doc->loadHTML($content);
1504 $xpath = new DOMXPath($doc);
1506 $list = $xpath->query("//*[contains(@id,'tread-wrapper-')]"); /* */
1508 foreach ($list as $item) {
1509 $item = $target->importNode($item, true);
1511 // And then append it to the target
1512 $target->documentElement->appendChild($item);
1515 if ($_GET["mode"] == "raw") {
1516 header("Content-type: text/html; charset=utf-8");
1518 echo substr($target->saveHTML(), 6, -8);
1524 $page = $this->page;
1525 $profile = $this->profile;
1527 header("X-Friendica-Version: " . FRIENDICA_VERSION);
1528 header("Content-type: text/html; charset=utf-8");
1530 if (Core\Config::get('system', 'hsts') && (Core\Config::get('system', 'ssl_policy') == SSL_POLICY_FULL)) {
1531 header("Strict-Transport-Security: max-age=31536000");
1534 // Some security stuff
1535 header('X-Content-Type-Options: nosniff');
1536 header('X-XSS-Protection: 1; mode=block');
1537 header('X-Permitted-Cross-Domain-Policies: none');
1538 header('X-Frame-Options: sameorigin');
1540 // Things like embedded OSM maps don't work, when this is enabled
1541 // header("Content-Security-Policy: default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; connect-src 'self'; style-src 'self' 'unsafe-inline'; font-src 'self'; img-src 'self' https: data:; media-src 'self' https:; child-src 'self' https:; object-src 'none'");
1543 /* We use $_GET["mode"] for special page templates. So we will check if we have
1544 * to load another page template than the default one.
1545 * The page templates are located in /view/php/ or in the theme directory.
1547 if (isset($_GET["mode"])) {
1548 $template = Core\Theme::getPathForFile($_GET["mode"] . '.php');
1551 // If there is no page template use the default page template
1552 if (empty($template)) {
1553 $template = Core\Theme::getPathForFile("default.php");
1556 // Theme templates expect $a as an App instance
1559 // Used as is in view/php/default.php
1560 $lang = Core\L10n::getCurrentLang();
1562 /// @TODO Looks unsafe (remote-inclusion), is maybe not but Core\Theme::getPathForFile() uses file_exists() but does not escape anything
1563 require_once $template;
1567 * Redirects to another module relative to the current Friendica base.
1568 * If you want to redirect to a external URL, use System::externalRedirectTo()
1570 * @param string $toUrl The destination URL (Default is empty, which is the default page of the Friendica node)
1571 * @param bool $ssl if true, base URL will try to get called with https:// (works just for relative paths)
1573 * @throws InternalServerErrorException In Case the given URL is not relative to the Friendica node
1575 public function internalRedirect($toUrl = '', $ssl = false)
1577 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
1578 throw new InternalServerErrorException("'$toUrl is not a relative path, please use System::externalRedirectTo");
1581 $redirectTo = $this->getBaseURL($ssl) . '/' . ltrim($toUrl, '/');
1582 Core\System::externalRedirect($redirectTo);
1586 * Automatically redirects to relative or absolute URL
1587 * Should only be used if it isn't clear if the URL is either internal or external
1589 * @param string $toUrl The target URL
1590 * @throws InternalServerErrorException
1592 public function redirect($toUrl)
1594 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
1595 Core\System::externalRedirect($toUrl);
1597 $this->internalRedirect($toUrl);