7 use Detection\MobileDetect;
11 use Friendica\Core\Config\Cache\IConfigCache;
12 use Friendica\Core\Config\Configuration;
13 use Friendica\Core\Theme;
14 use Friendica\Database\DBA;
15 use Friendica\Model\Profile;
16 use Friendica\Network\HTTPException\InternalServerErrorException;
17 use Friendica\Util\Config\ConfigFileLoader;
18 use Friendica\Util\HTTPSignature;
19 use Friendica\Util\Profiler;
20 use Friendica\Util\Strings;
21 use Psr\Log\LoggerInterface;
27 * @brief Our main application structure for the life of this page.
29 * Primarily deals with the URL that got us here
30 * and tries to make some sense of it, and
31 * stores our page contents and config storage
32 * and anything else that might need to be passed around
33 * before we spit the page out.
38 public $module_loaded = false;
39 public $module_class = null;
40 public $query_string = '';
51 public $error = false;
57 public $interactive = true;
59 public $is_mobile = false;
60 public $is_tablet = false;
61 public $theme_info = [];
63 // Allow themes to control internal parameters
64 // by changing App values in theme.php
66 public $sourcename = '';
67 public $videowidth = 425;
68 public $videoheight = 350;
69 public $force_max_items = 0;
70 public $theme_events_in_profile = true;
72 public $stylesheets = [];
73 public $footerScripts = [];
76 * @var App\Mode The Mode of the Application
81 * @var string The App URL path
86 * @var bool true, if the call is from the Friendica APP, otherwise false
88 private $isFriendicaApp;
91 * @var bool true, if the call is from an backend node (f.e. worker)
96 * @var string The name of the current theme
98 private $currentTheme;
101 * @var bool check if request was an AJAX (xmlhttprequest) request
108 public $mobileDetect;
111 * @var Configuration The config
116 * @var LoggerInterface The logger
121 * @var Profiler The profiler of this app
126 * Returns the current config cache of this node
128 * @return IConfigCache
130 public function getConfigCache()
132 return $this->config->getCache();
136 * The basepath of this app
140 public function getBasePath()
142 return $this->config->get('system', 'basepath');
146 * The Logger of this app
148 * @return LoggerInterface
150 public function getLogger()
152 return $this->logger;
156 * The profiler of this app
160 public function getProfiler()
162 return $this->profiler;
166 * Returns the Mode of the Application
168 * @return App\Mode The Application Mode
170 public function getMode()
176 * Register a stylesheet file path to be included in the <head> tag of every page.
177 * Inclusion is done in App->initHead().
178 * The path can be absolute or relative to the Friendica installation base folder.
182 * @param string $path
183 * @throws InternalServerErrorException
185 public function registerStylesheet($path)
187 if (mb_strpos($path, $this->getBasePath() . DIRECTORY_SEPARATOR) === 0) {
188 $path = mb_substr($path, mb_strlen($this->getBasePath() . DIRECTORY_SEPARATOR));
191 $this->stylesheets[] = trim($path, '/');
195 * Register a javascript file path to be included in the <footer> tag of every page.
196 * Inclusion is done in App->initFooter().
197 * The path can be absolute or relative to the Friendica installation base folder.
201 * @param string $path
202 * @throws InternalServerErrorException
204 public function registerFooterScript($path)
206 $url = str_replace($this->getBasePath() . DIRECTORY_SEPARATOR, '', $path);
208 $this->footerScripts[] = trim($url, '/');
216 * @brief App constructor.
218 * @param Configuration $config The Configuration
219 * @param App\Mode $mode The mode of this Friendica app
220 * @param LoggerInterface $logger The current app logger
221 * @param Profiler $profiler The profiler of this application
222 * @param bool $isBackend Whether it is used for backend or frontend (Default true=backend)
224 * @throws Exception if the Basepath is not usable
226 public function __construct(Configuration $config, App\Mode $mode, LoggerInterface $logger, Profiler $profiler, $isBackend = true)
228 BaseObject::setApp($this);
230 $this->logger = $logger;
231 $this->config = $config;
232 $this->profiler = $profiler;
235 $this->checkBackend($isBackend);
236 $this->checkFriendicaApp();
238 $this->profiler->reset();
244 // This has to be quite large to deal with embedded private photos
245 ini_set('pcre.backtrack_limit', 500000);
247 $this->scheme = 'http';
249 if (!empty($_SERVER['HTTPS']) ||
250 !empty($_SERVER['HTTP_FORWARDED']) && preg_match('/proto=https/', $_SERVER['HTTP_FORWARDED']) ||
251 !empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' ||
252 !empty($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on' ||
253 !empty($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on' ||
254 !empty($_SERVER['SERVER_PORT']) && (intval($_SERVER['SERVER_PORT']) == 443) // XXX: reasonable assumption, but isn't this hardcoding too much?
256 $this->scheme = 'https';
259 if (!empty($_SERVER['SERVER_NAME'])) {
260 $this->hostname = $_SERVER['SERVER_NAME'];
262 if (!empty($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
263 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
268 get_include_path() . PATH_SEPARATOR
269 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
270 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
271 . $this->getBasePath());
273 if (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'pagename=') === 0) {
274 $this->query_string = substr($_SERVER['QUERY_STRING'], 9);
275 } elseif (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'q=') === 0) {
276 $this->query_string = substr($_SERVER['QUERY_STRING'], 2);
279 // removing trailing / - maybe a nginx problem
280 $this->query_string = ltrim($this->query_string, '/');
282 if (!empty($_GET['pagename'])) {
283 $this->cmd = trim($_GET['pagename'], '/\\');
284 } elseif (!empty($_GET['q'])) {
285 $this->cmd = trim($_GET['q'], '/\\');
289 $this->query_string = str_replace($this->cmd . '&', $this->cmd . '?', $this->query_string);
291 // unix style "homedir"
292 if (substr($this->cmd, 0, 1) === '~') {
293 $this->cmd = 'profile/' . substr($this->cmd, 1);
296 // Diaspora style profile url
297 if (substr($this->cmd, 0, 2) === 'u/') {
298 $this->cmd = 'profile/' . substr($this->cmd, 2);
302 * Break the URL path into C style argc/argv style arguments for our
303 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
304 * will be 3 (integer) and $this->argv will contain:
310 * There will always be one argument. If provided a naked domain
311 * URL, $this->argv[0] is set to "home".
314 $this->argv = explode('/', $this->cmd);
315 $this->argc = count($this->argv);
316 if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
317 $this->module = str_replace('.', '_', $this->argv[0]);
318 $this->module = str_replace('-', '_', $this->module);
321 $this->argv = ['home'];
322 $this->module = 'home';
325 // Detect mobile devices
326 $mobile_detect = new MobileDetect();
328 $this->mobileDetect = $mobile_detect;
330 $this->is_mobile = $mobile_detect->isMobile();
331 $this->is_tablet = $mobile_detect->isTablet();
333 $this->isAjax = strtolower(defaults($_SERVER, 'HTTP_X_REQUESTED_WITH', '')) == 'xmlhttprequest';
335 // Register template engines
336 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
340 * Reloads the whole app instance
342 public function reload()
344 $this->determineURLPath();
346 $this->getMode()->determine($this->getBasePath());
348 if ($this->getMode()->has(App\Mode::DBAVAILABLE)) {
349 $loader = new ConfigFileLoader($this->getBasePath(), $this->getMode());
350 $this->config->getCache()->load($loader->loadCoreConfig('addon'), true);
352 $this->profiler->update(
353 $this->config->get('system', 'profiler', false),
354 $this->config->get('rendertime', 'callstack', false));
356 Core\Hook::loadHooks();
357 $loader = new ConfigFileLoader($this->getBasePath(), $this->mode);
358 Core\Hook::callAll('load_config', $loader);
361 $this->loadDefaultTimezone();
367 * Loads the default timezone
369 * Include support for legacy $default_timezone
371 * @global string $default_timezone
373 private function loadDefaultTimezone()
375 if ($this->config->get('system', 'default_timezone')) {
376 $this->timezone = $this->config->get('system', 'default_timezone');
378 global $default_timezone;
379 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
382 if ($this->timezone) {
383 date_default_timezone_set($this->timezone);
388 * Figure out if we are running at the top of a domain or in a sub-directory and adjust accordingly
390 private function determineURLPath()
393 * The automatic path detection in this function is currently deactivated,
394 * see issue https://github.com/friendica/friendica/issues/6679
396 * The problem is that the function seems to be confused with some url.
397 * These then confuses the detection which changes the url path.
400 /* Relative script path to the web server root
401 * Not all of those $_SERVER properties can be present, so we do by inverse priority order
404 $relative_script_path = '';
405 $relative_script_path = defaults($_SERVER, 'REDIRECT_URL' , $relative_script_path);
406 $relative_script_path = defaults($_SERVER, 'REDIRECT_URI' , $relative_script_path);
407 $relative_script_path = defaults($_SERVER, 'REDIRECT_SCRIPT_URL', $relative_script_path);
408 $relative_script_path = defaults($_SERVER, 'SCRIPT_URL' , $relative_script_path);
409 $relative_script_path = defaults($_SERVER, 'REQUEST_URI' , $relative_script_path);
411 $this->urlPath = $this->config->get('system', 'urlpath');
413 /* $relative_script_path gives /relative/path/to/friendica/module/parameter
414 * QUERY_STRING gives pagename=module/parameter
416 * To get /relative/path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
419 if (!empty($relative_script_path)) {
421 if (!empty($_SERVER['QUERY_STRING'])) {
422 $path = trim(rdirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
425 $path = trim($relative_script_path, '/');
428 if ($path && $path != $this->urlPath) {
429 $this->urlPath = $path;
435 public function getScheme()
437 return $this->scheme;
441 * @brief Retrieves the Friendica instance base URL
443 * This function assembles the base URL from multiple parts:
444 * - Protocol is determined either by the request or a combination of
445 * system.ssl_policy and the $ssl parameter.
446 * - Host name is determined either by system.hostname or inferred from request
447 * - Path is inferred from SCRIPT_NAME
449 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
451 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
452 * @return string Friendica server base URL
453 * @throws InternalServerErrorException
455 public function getBaseURL($ssl = false)
457 $scheme = $this->scheme;
459 if ($this->config->get('system', 'ssl_policy') == SSL_POLICY_FULL) {
463 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
464 // (and also the login link). Anything seen by an outsider will have it turned off.
466 if ($this->config->get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
474 if ($this->config->get('config', 'hostname') != '') {
475 $this->hostname = $this->config->get('config', 'hostname');
478 return $scheme . '://' . $this->hostname . (!empty($this->getURLPath()) ? '/' . $this->getURLPath() : '' );
482 * @brief Initializes the baseurl components
484 * Clears the baseurl cache to prevent inconsistencies
487 * @throws InternalServerErrorException
489 public function setBaseURL($url)
491 $parsed = @parse_url($url);
494 if (!empty($parsed)) {
495 if (!empty($parsed['scheme'])) {
496 $this->scheme = $parsed['scheme'];
499 if (!empty($parsed['host'])) {
500 $hostname = $parsed['host'];
503 if (!empty($parsed['port'])) {
504 $hostname .= ':' . $parsed['port'];
506 if (!empty($parsed['path'])) {
507 $this->urlPath = trim($parsed['path'], '\\/');
510 if (file_exists($this->getBasePath() . '/.htpreconfig.php')) {
511 include $this->getBasePath() . '/.htpreconfig.php';
514 if ($this->config->get('config', 'hostname') != '') {
515 $this->hostname = $this->config->get('config', 'hostname');
518 if (!isset($this->hostname) || ($this->hostname == '')) {
519 $this->hostname = $hostname;
524 public function getHostName()
526 if ($this->config->get('config', 'hostname') != '') {
527 $this->hostname = $this->config->get('config', 'hostname');
530 return $this->hostname;
533 public function getURLPath()
535 return $this->urlPath;
539 * Initializes App->page['htmlhead'].
544 * - Registered stylesheets (through App->registerStylesheet())
545 * - Infinite scroll data
546 * - head.tpl template
548 public function initHead()
550 $interval = ((local_user()) ? Core\PConfig::get(local_user(), 'system', 'update_interval') : 40000);
552 // If the update is 'deactivated' set it to the highest integer number (~24 days)
554 $interval = 2147483647;
557 if ($interval < 10000) {
561 // Default title: current module called
562 if (empty($this->page['title']) && $this->module) {
563 $this->page['title'] = ucfirst($this->module);
566 // Prepend the sitename to the page title
567 $this->page['title'] = $this->config->get('config', 'sitename', '') . (!empty($this->page['title']) ? ' | ' . $this->page['title'] : '');
569 if (!empty(Core\Renderer::$theme['stylesheet'])) {
570 $stylesheet = Core\Renderer::$theme['stylesheet'];
572 $stylesheet = $this->getCurrentThemeStylesheetPath();
575 $this->registerStylesheet($stylesheet);
577 $shortcut_icon = $this->config->get('system', 'shortcut_icon');
578 if ($shortcut_icon == '') {
579 $shortcut_icon = 'images/friendica-32.png';
582 $touch_icon = $this->config->get('system', 'touch_icon');
583 if ($touch_icon == '') {
584 $touch_icon = 'images/friendica-128.png';
587 Core\Hook::callAll('head', $this->page['htmlhead']);
589 $tpl = Core\Renderer::getMarkupTemplate('head.tpl');
590 /* put the head template at the beginning of page['htmlhead']
591 * since the code added by the modules frequently depends on it
594 $this->page['htmlhead'] = Core\Renderer::replaceMacros($tpl, [
595 '$baseurl' => $this->getBaseURL(),
596 '$local_user' => local_user(),
597 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
598 '$delitem' => Core\L10n::t('Delete this item?'),
599 '$update_interval' => $interval,
600 '$shortcut_icon' => $shortcut_icon,
601 '$touch_icon' => $touch_icon,
602 '$block_public' => intval($this->config->get('system', 'block_public')),
603 '$stylesheets' => $this->stylesheets,
604 ]) . $this->page['htmlhead'];
608 * Initializes App->page['footer'].
611 * - Javascript homebase
612 * - Mobile toggle link
613 * - Registered footer scripts (through App->registerFooterScript())
614 * - footer.tpl template
616 public function initFooter()
618 // If you're just visiting, let javascript take you home
619 if (!empty($_SESSION['visitor_home'])) {
620 $homebase = $_SESSION['visitor_home'];
621 } elseif (local_user()) {
622 $homebase = 'profile/' . $this->user['nickname'];
625 if (isset($homebase)) {
626 $this->page['footer'] .= '<script>var homebase="' . $homebase . '";</script>' . "\n";
630 * Add a "toggle mobile" link if we're using a mobile device
632 if ($this->is_mobile || $this->is_tablet) {
633 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
634 $link = 'toggle_mobile?address=' . urlencode(curPageURL());
636 $link = 'toggle_mobile?off=1&address=' . urlencode(curPageURL());
638 $this->page['footer'] .= Core\Renderer::replaceMacros(Core\Renderer::getMarkupTemplate("toggle_mobile_footer.tpl"), [
639 '$toggle_link' => $link,
640 '$toggle_text' => Core\L10n::t('toggle mobile')
644 Core\Hook::callAll('footer', $this->page['footer']);
646 $tpl = Core\Renderer::getMarkupTemplate('footer.tpl');
647 $this->page['footer'] = Core\Renderer::replaceMacros($tpl, [
648 '$baseurl' => $this->getBaseURL(),
649 '$footerScripts' => $this->footerScripts,
650 ]) . $this->page['footer'];
654 * @brief Removes the base url from an url. This avoids some mixed content problems.
656 * @param string $origURL
658 * @return string The cleaned url
659 * @throws InternalServerErrorException
661 public function removeBaseURL($origURL)
663 // Remove the hostname from the url if it is an internal link
664 $nurl = Util\Strings::normaliseLink($origURL);
665 $base = Util\Strings::normaliseLink($this->getBaseURL());
666 $url = str_replace($base . '/', '', $nurl);
668 // if it is an external link return the orignal value
669 if ($url == Util\Strings::normaliseLink($origURL)) {
677 * Returns the current UserAgent as a String
679 * @return string the UserAgent as a String
680 * @throws InternalServerErrorException
682 public function getUserAgent()
685 FRIENDICA_PLATFORM . " '" .
686 FRIENDICA_CODENAME . "' " .
687 FRIENDICA_VERSION . '-' .
688 DB_UPDATE_VERSION . '; ' .
693 * Checks, if the call is from the Friendica App
696 * The friendica client has problems with the GUID in the notify. this is some workaround
698 private function checkFriendicaApp()
701 $this->isFriendicaApp = isset($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)';
705 * Is the call via the Friendica app? (not a "normale" call)
707 * @return bool true if it's from the Friendica app
709 public function isFriendicaApp()
711 return $this->isFriendicaApp;
715 * @brief Checks if the site is called via a backend process
717 * This isn't a perfect solution. But we need this check very early.
718 * So we cannot wait until the modules are loaded.
720 * @param string $backend true, if the backend flag was set during App initialization
723 private function checkBackend($backend) {
747 // Check if current module is in backend or backend flag is set
748 $this->isBackend = (in_array($this->module, $backends) || $backend || $this->isBackend);
752 * Returns true, if the call is from a backend node (f.e. from a worker)
754 * @return bool Is it a known backend?
756 public function isBackend()
758 return $this->isBackend;
762 * @brief Checks if the maximum number of database processes is reached
764 * @return bool Is the limit reached?
766 public function isMaxProcessesReached()
768 // Deactivated, needs more investigating if this check really makes sense
772 * Commented out to suppress static analyzer issues
774 if ($this->is_backend()) {
775 $process = 'backend';
776 $max_processes = $this->config->get('system', 'max_processes_backend');
777 if (intval($max_processes) == 0) {
781 $process = 'frontend';
782 $max_processes = $this->config->get('system', 'max_processes_frontend');
783 if (intval($max_processes) == 0) {
788 $processlist = DBA::processlist();
789 if ($processlist['list'] != '') {
790 Core\Logger::log('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], Core\Logger::DEBUG);
792 if ($processlist['amount'] > $max_processes) {
793 Core\Logger::log('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', Core\Logger::DEBUG);
802 * @brief Checks if the minimal memory is reached
804 * @return bool Is the memory limit reached?
805 * @throws InternalServerErrorException
807 public function isMinMemoryReached()
809 $min_memory = $this->config->get('system', 'min_memory', 0);
810 if ($min_memory == 0) {
814 if (!is_readable('/proc/meminfo')) {
818 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
821 foreach ($memdata as $line) {
822 $data = explode(':', $line);
823 if (count($data) != 2) {
826 list($key, $val) = $data;
827 $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
828 $meminfo[$key] = (int) ($meminfo[$key] / 1024);
831 if (!isset($meminfo['MemFree'])) {
835 $free = $meminfo['MemFree'];
837 $reached = ($free < $min_memory);
840 Core\Logger::log('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, Core\Logger::DEBUG);
847 * @brief Checks if the maximum load is reached
849 * @return bool Is the load reached?
850 * @throws InternalServerErrorException
852 public function isMaxLoadReached()
854 if ($this->isBackend()) {
855 $process = 'backend';
856 $maxsysload = intval($this->config->get('system', 'maxloadavg'));
857 if ($maxsysload < 1) {
861 $process = 'frontend';
862 $maxsysload = intval($this->config->get('system', 'maxloadavg_frontend'));
863 if ($maxsysload < 1) {
868 $load = Core\System::currentLoad();
870 if (intval($load) > $maxsysload) {
871 Core\Logger::log('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
879 * Executes a child process with 'proc_open'
881 * @param string $command The command to execute
882 * @param array $args Arguments to pass to the command ( [ 'key' => value, 'key2' => value2, ... ]
883 * @throws InternalServerErrorException
885 public function proc_run($command, $args)
887 if (!function_exists('proc_open')) {
891 $cmdline = $this->config->get('config', 'php_path', 'php') . ' ' . escapeshellarg($command);
893 foreach ($args as $key => $value) {
894 if (!is_null($value) && is_bool($value) && !$value) {
898 $cmdline .= ' --' . $key;
899 if (!is_null($value) && !is_bool($value)) {
900 $cmdline .= ' ' . $value;
904 if ($this->isMinMemoryReached()) {
908 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
909 $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->getBasePath());
911 $resource = proc_open($cmdline . ' &', [], $foo, $this->getBasePath());
913 if (!is_resource($resource)) {
914 Core\Logger::log('We got no resource for command ' . $cmdline, Core\Logger::DEBUG);
917 proc_close($resource);
921 * Generates the site's default sender email address
924 * @throws InternalServerErrorException
926 public function getSenderEmailAddress()
928 $sender_email = $this->config->get('config', 'sender_email');
929 if (empty($sender_email)) {
930 $hostname = $this->getHostName();
931 if (strpos($hostname, ':')) {
932 $hostname = substr($hostname, 0, strpos($hostname, ':'));
935 $sender_email = 'noreply@' . $hostname;
938 return $sender_email;
942 * Returns the current theme name.
944 * @return string the name of the current theme
945 * @throws InternalServerErrorException
947 public function getCurrentTheme()
949 if ($this->getMode()->isInstall()) {
953 if (!$this->currentTheme) {
954 $this->computeCurrentTheme();
957 return $this->currentTheme;
960 public function setCurrentTheme($theme)
962 $this->currentTheme = $theme;
966 * Computes the current theme name based on the node settings, the user settings and the device type
970 private function computeCurrentTheme()
972 $system_theme = $this->config->get('system', 'theme');
973 if (!$system_theme) {
974 throw new Exception(Core\L10n::t('No system theme config value set.'));
978 $this->currentTheme = $system_theme;
981 // Find the theme that belongs to the user whose stuff we are looking at
982 if ($this->profile_uid && ($this->profile_uid != local_user())) {
983 // Allow folks to override user themes and always use their own on their own site.
984 // This works only if the user is on the same server
985 $user = DBA::selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
986 if (DBA::isResult($user) && !Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
987 $page_theme = $user['theme'];
991 $user_theme = Core\Session::get('theme', $system_theme);
993 // Specific mobile theme override
994 if (($this->is_mobile || $this->is_tablet) && Core\Session::get('show-mobile', true)) {
995 $system_mobile_theme = $this->config->get('system', 'mobile-theme');
996 $user_mobile_theme = Core\Session::get('mobile-theme', $system_mobile_theme);
998 // --- means same mobile theme as desktop
999 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
1000 $user_theme = $user_mobile_theme;
1005 $theme_name = $page_theme;
1007 $theme_name = $user_theme;
1010 $theme_name = Strings::sanitizeFilePathItem($theme_name);
1012 && in_array($theme_name, Theme::getAllowedList())
1013 && (file_exists('view/theme/' . $theme_name . '/style.css')
1014 || file_exists('view/theme/' . $theme_name . '/style.php'))
1016 $this->currentTheme = $theme_name;
1021 * @brief Return full URL to theme which is currently in effect.
1023 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1026 * @throws InternalServerErrorException
1028 public function getCurrentThemeStylesheetPath()
1030 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
1034 * Check if request was an AJAX (xmlhttprequest) request.
1036 * @return boolean true if it was an AJAX request
1038 public function isAjax()
1040 return $this->isAjax;
1044 * Returns the value of a argv key
1045 * TODO there are a lot of $a->argv usages in combination with defaults() which can be replaced with this method
1047 * @param int $position the position of the argument
1048 * @param mixed $default the default value if not found
1050 * @return mixed returns the value of the argument
1052 public function getArgumentValue($position, $default = '')
1054 if (array_key_exists($position, $this->argv)) {
1055 return $this->argv[$position];
1062 * Sets the base url for use in cmdline programs which don't have
1063 * $_SERVER variables
1065 public function checkURL()
1067 $url = $this->config->get('system', 'url');
1069 // if the url isn't set or the stored url is radically different
1070 // than the currently visited url, store the current value accordingly.
1071 // "Radically different" ignores common variations such as http vs https
1072 // and www.example.com vs example.com.
1073 // We will only change the url to an ip address if there is no existing setting
1075 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()))) {
1076 $this->config->set('system', 'url', $this->getBaseURL());
1081 * Frontend App script
1083 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
1084 * request and a representation of the response.
1086 * This probably should change to limit the size of this monster method.
1088 public function runFrontend()
1090 // Missing DB connection: ERROR
1091 if ($this->getMode()->has(App\Mode::LOCALCONFIGPRESENT) && !$this->getMode()->has(App\Mode::DBAVAILABLE)) {
1092 Core\System::httpExit(500, ['title' => 'Error 500 - Internal Server Error', 'description' => 'Apologies but the website is unavailable at the moment.']);
1095 // Max Load Average reached: ERROR
1096 if ($this->isMaxProcessesReached() || $this->isMaxLoadReached()) {
1097 header('Retry-After: 120');
1098 header('Refresh: 120; url=' . $this->getBaseURL() . "/" . $this->query_string);
1100 Core\System::httpExit(503, ['title' => 'Error 503 - Service Temporarily Unavailable', 'description' => 'Core\System is currently overloaded. Please try again later.']);
1103 if (strstr($this->query_string, '.well-known/host-meta') && ($this->query_string != '.well-known/host-meta')) {
1104 Core\System::httpExit(404);
1107 if (!$this->getMode()->isInstall()) {
1108 // Force SSL redirection
1109 if ($this->config->get('system', 'force_ssl') && ($this->getScheme() == "http")
1110 && intval($this->config->get('system', 'ssl_policy')) == SSL_POLICY_FULL
1111 && strpos($this->getBaseURL(), 'https://') === 0
1112 && $_SERVER['REQUEST_METHOD'] == 'GET') {
1113 header('HTTP/1.1 302 Moved Temporarily');
1114 header('Location: ' . $this->getBaseURL() . '/' . $this->query_string);
1118 Core\Session::init();
1119 Core\Hook::callAll('init_1');
1122 // Exclude the backend processes from the session management
1123 if (!$this->isBackend()) {
1124 $stamp1 = microtime(true);
1126 $this->profiler->saveTimestamp($stamp1, 'parser', Core\System::callstack());
1127 Core\L10n::setSessionVariable();
1128 Core\L10n::setLangFromSession();
1131 Core\Worker::executeIfIdle();
1134 if ($this->getMode()->isNormal()) {
1135 $requester = HTTPSignature::getSigner('', $_SERVER);
1136 if (!empty($requester)) {
1137 Profile::addVisitorCookieForHandle($requester);
1142 if (!empty($_GET['zrl']) && $this->getMode()->isNormal()) {
1143 $this->query_string = Model\Profile::stripZrls($this->query_string);
1144 if (!local_user()) {
1145 // Only continue when the given profile link seems valid
1146 // Valid profile links contain a path with "/profile/" and no query parameters
1147 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
1148 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
1149 if (defaults($_SESSION, "visitor_home", "") != $_GET["zrl"]) {
1150 $_SESSION['my_url'] = $_GET['zrl'];
1151 $_SESSION['authenticated'] = 0;
1153 Model\Profile::zrlInit($this);
1155 // Someone came with an invalid parameter, maybe as a DDoS attempt
1156 // We simply stop processing here
1157 Core\Logger::log("Invalid ZRL parameter " . $_GET['zrl'], Core\Logger::DEBUG);
1158 Core\System::httpExit(403, ['title' => '403 Forbidden']);
1163 if (!empty($_GET['owt']) && $this->getMode()->isNormal()) {
1164 $token = $_GET['owt'];
1165 $this->query_string = Model\Profile::stripQueryParam($this->query_string, 'owt');
1166 Model\Profile::openWebAuthInit($token);
1169 Module\Login::sessionAuth();
1171 if (empty($_SESSION['authenticated'])) {
1172 header('X-Account-Management-Status: none');
1175 $_SESSION['sysmsg'] = defaults($_SESSION, 'sysmsg' , []);
1176 $_SESSION['sysmsg_info'] = defaults($_SESSION, 'sysmsg_info' , []);
1177 $_SESSION['last_updated'] = defaults($_SESSION, 'last_updated', []);
1180 * check_config() is responsible for running update scripts. These automatically
1181 * update the DB schema whenever we push a new one out. It also checks to see if
1182 * any addons have been added or removed and reacts accordingly.
1185 // in install mode, any url loads install module
1186 // but we need "view" module for stylesheet
1187 if ($this->getMode()->isInstall() && $this->module != 'view') {
1188 $this->module = 'install';
1189 } elseif (!$this->getMode()->has(App\Mode::MAINTENANCEDISABLED) && $this->module != 'view') {
1190 $this->module = 'maintenance';
1193 Core\Update::check($this->getBasePath(), false, $this->getMode());
1194 Core\Addon::loadAddons();
1195 Core\Hook::loadHooks();
1206 'right_aside' => '',
1211 if (strlen($this->module)) {
1212 // Compatibility with the Android Diaspora client
1213 if ($this->module == 'stream') {
1214 $this->internalRedirect('network?f=&order=post');
1217 if ($this->module == 'conversations') {
1218 $this->internalRedirect('message');
1221 if ($this->module == 'commented') {
1222 $this->internalRedirect('network?f=&order=comment');
1225 if ($this->module == 'liked') {
1226 $this->internalRedirect('network?f=&order=comment');
1229 if ($this->module == 'activity') {
1230 $this->internalRedirect('network/?f=&conv=1');
1233 if (($this->module == 'status_messages') && ($this->cmd == 'status_messages/new')) {
1234 $this->internalRedirect('bookmarklet');
1237 if (($this->module == 'user') && ($this->cmd == 'user/edit')) {
1238 $this->internalRedirect('settings');
1241 if (($this->module == 'tag_followings') && ($this->cmd == 'tag_followings/manage')) {
1242 $this->internalRedirect('search');
1245 // Compatibility with the Firefox App
1246 if (($this->module == "users") && ($this->cmd == "users/sign_in")) {
1247 $this->module = "login";
1250 $privateapps = $this->config->get('config', 'private_addons', false);
1251 if (Core\Addon::isEnabled($this->module) && file_exists("addon/{$this->module}/{$this->module}.php")) {
1252 //Check if module is an app and if public access to apps is allowed or not
1253 if ((!local_user()) && Core\Hook::isAddonApp($this->module) && $privateapps) {
1254 info(Core\L10n::t("You must be logged in to use addons. "));
1256 include_once "addon/{$this->module}/{$this->module}.php";
1257 if (function_exists($this->module . '_module')) {
1258 LegacyModule::setModuleFile("addon/{$this->module}/{$this->module}.php");
1259 $this->module_class = 'Friendica\\LegacyModule';
1260 $this->module_loaded = true;
1265 // Controller class routing
1266 if (! $this->module_loaded && class_exists('Friendica\\Module\\' . ucfirst($this->module))) {
1267 $this->module_class = 'Friendica\\Module\\' . ucfirst($this->module);
1268 $this->module_loaded = true;
1271 /* If not, next look for a 'standard' program module in the 'mod' directory
1272 * We emulate a Module class through the LegacyModule class
1274 if (! $this->module_loaded && file_exists("mod/{$this->module}.php")) {
1275 LegacyModule::setModuleFile("mod/{$this->module}.php");
1276 $this->module_class = 'Friendica\\LegacyModule';
1277 $this->module_loaded = true;
1280 /* The URL provided does not resolve to a valid module.
1282 * On Dreamhost sites, quite often things go wrong for no apparent reason and they send us to '/internal_error.html'.
1283 * We don't like doing this, but as it occasionally accounts for 10-20% or more of all site traffic -
1284 * 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
1285 * this will often succeed and eventually do the right thing.
1287 * Otherwise we are going to emit a 404 not found.
1289 if (! $this->module_loaded) {
1290 // Stupid browser tried to pre-fetch our Javascript img template. Don't log the event or return anything - just quietly exit.
1291 if (!empty($_SERVER['QUERY_STRING']) && preg_match('/{[0-9]}/', $_SERVER['QUERY_STRING']) !== 0) {
1295 if (!empty($_SERVER['QUERY_STRING']) && ($_SERVER['QUERY_STRING'] === 'q=internal_error.html') && isset($dreamhost_error_hack)) {
1296 Core\Logger::log('index.php: dreamhost_error_hack invoked. Original URI =' . $_SERVER['REQUEST_URI']);
1297 $this->internalRedirect($_SERVER['REQUEST_URI']);
1300 Core\Logger::log('index.php: page not found: ' . $_SERVER['REQUEST_URI'] . ' ADDRESS: ' . $_SERVER['REMOTE_ADDR'] . ' QUERY: ' . $_SERVER['QUERY_STRING'], Core\Logger::DEBUG);
1302 header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . Core\L10n::t('Not Found'));
1303 $tpl = Core\Renderer::getMarkupTemplate("404.tpl");
1304 $this->page['content'] = Core\Renderer::replaceMacros($tpl, [
1305 '$message' => Core\L10n::t('Page not found.')
1312 // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
1313 if ($this->module_loaded) {
1314 $this->page['page_title'] = $this->module;
1317 Core\Hook::callAll($this->module . '_mod_init', $placeholder);
1319 call_user_func([$this->module_class, 'init']);
1321 // "rawContent" is especially meant for technical endpoints.
1322 // This endpoint doesn't need any theme initialization or other comparable stuff.
1323 if (!$this->error) {
1324 call_user_func([$this->module_class, 'rawContent']);
1328 // Load current theme info after module has been initialized as theme could have been set in module
1329 $theme_info_file = 'view/theme/' . $this->getCurrentTheme() . '/theme.php';
1330 if (file_exists($theme_info_file)) {
1331 require_once $theme_info_file;
1334 if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_init')) {
1335 $func = str_replace('-', '_', $this->getCurrentTheme()) . '_init';
1339 if ($this->module_loaded) {
1340 if (! $this->error && $_SERVER['REQUEST_METHOD'] === 'POST') {
1341 Core\Hook::callAll($this->module . '_mod_post', $_POST);
1342 call_user_func([$this->module_class, 'post']);
1345 if (! $this->error) {
1346 Core\Hook::callAll($this->module . '_mod_afterpost', $placeholder);
1347 call_user_func([$this->module_class, 'afterpost']);
1350 if (! $this->error) {
1351 $arr = ['content' => $content];
1352 Core\Hook::callAll($this->module . '_mod_content', $arr);
1353 $content = $arr['content'];
1354 $arr = ['content' => call_user_func([$this->module_class, 'content'])];
1355 Core\Hook::callAll($this->module . '_mod_aftercontent', $arr);
1356 $content .= $arr['content'];
1360 // initialise content region
1361 if ($this->getMode()->isNormal()) {
1362 Core\Hook::callAll('page_content_top', $this->page['content']);
1365 $this->page['content'] .= $content;
1367 /* Create the page head after setting the language
1368 * and getting any auth credentials.
1370 * Moved initHead() and initFooter() to after
1371 * all the module functions have executed so that all
1372 * theme choices made by the modules can take effect.
1376 /* Build the page ending -- this is stuff that goes right before
1377 * the closing </body> tag
1379 $this->initFooter();
1381 /* now that we've been through the module content, see if the page reported
1382 * a permission problem and if so, a 403 response would seem to be in order.
1384 if (stristr(implode("", $_SESSION['sysmsg']), Core\L10n::t('Permission denied'))) {
1385 header($_SERVER["SERVER_PROTOCOL"] . ' 403 ' . Core\L10n::t('Permission denied.'));
1388 // Report anything which needs to be communicated in the notification area (before the main body)
1389 Core\Hook::callAll('page_end', $this->page['content']);
1391 // Add the navigation (menu) template
1392 if ($this->module != 'install' && $this->module != 'maintenance') {
1393 $this->page['htmlhead'] .= Core\Renderer::replaceMacros(Core\Renderer::getMarkupTemplate('nav_head.tpl'), []);
1394 $this->page['nav'] = Content\Nav::build($this);
1397 // Build the page - now that we have all the components
1398 if (isset($_GET["mode"]) && (($_GET["mode"] == "raw") || ($_GET["mode"] == "minimal"))) {
1399 $doc = new DOMDocument();
1401 $target = new DOMDocument();
1402 $target->loadXML("<root></root>");
1404 $content = mb_convert_encoding($this->page["content"], 'HTML-ENTITIES', "UTF-8");
1406 /// @TODO one day, kill those error-surpressing @ stuff, or PHP should ban it
1407 @$doc->loadHTML($content);
1409 $xpath = new DOMXPath($doc);
1411 $list = $xpath->query("//*[contains(@id,'tread-wrapper-')]"); /* */
1413 foreach ($list as $item) {
1414 $item = $target->importNode($item, true);
1416 // And then append it to the target
1417 $target->documentElement->appendChild($item);
1420 if ($_GET["mode"] == "raw") {
1421 header("Content-type: text/html; charset=utf-8");
1423 echo substr($target->saveHTML(), 6, -8);
1429 $page = $this->page;
1430 $profile = $this->profile;
1432 header("X-Friendica-Version: " . FRIENDICA_VERSION);
1433 header("Content-type: text/html; charset=utf-8");
1435 if ($this->config->get('system', 'hsts') && ($this->config->get('system', 'ssl_policy') == SSL_POLICY_FULL)) {
1436 header("Strict-Transport-Security: max-age=31536000");
1439 // Some security stuff
1440 header('X-Content-Type-Options: nosniff');
1441 header('X-XSS-Protection: 1; mode=block');
1442 header('X-Permitted-Cross-Domain-Policies: none');
1443 header('X-Frame-Options: sameorigin');
1445 // Things like embedded OSM maps don't work, when this is enabled
1446 // 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'");
1448 /* We use $_GET["mode"] for special page templates. So we will check if we have
1449 * to load another page template than the default one.
1450 * The page templates are located in /view/php/ or in the theme directory.
1452 if (isset($_GET["mode"])) {
1453 $template = Core\Theme::getPathForFile($_GET["mode"] . '.php');
1456 // If there is no page template use the default page template
1457 if (empty($template)) {
1458 $template = Core\Theme::getPathForFile("default.php");
1461 // Theme templates expect $a as an App instance
1464 // Used as is in view/php/default.php
1465 $lang = Core\L10n::getCurrentLang();
1467 /// @TODO Looks unsafe (remote-inclusion), is maybe not but Core\Theme::getPathForFile() uses file_exists() but does not escape anything
1468 require_once $template;
1472 * Redirects to another module relative to the current Friendica base.
1473 * If you want to redirect to a external URL, use System::externalRedirectTo()
1475 * @param string $toUrl The destination URL (Default is empty, which is the default page of the Friendica node)
1476 * @param bool $ssl if true, base URL will try to get called with https:// (works just for relative paths)
1478 * @throws InternalServerErrorException In Case the given URL is not relative to the Friendica node
1480 public function internalRedirect($toUrl = '', $ssl = false)
1482 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
1483 throw new InternalServerErrorException("'$toUrl is not a relative path, please use System::externalRedirectTo");
1486 $redirectTo = $this->getBaseURL($ssl) . '/' . ltrim($toUrl, '/');
1487 Core\System::externalRedirect($redirectTo);
1491 * Automatically redirects to relative or absolute URL
1492 * Should only be used if it isn't clear if the URL is either internal or external
1494 * @param string $toUrl The target URL
1495 * @throws InternalServerErrorException
1497 public function redirect($toUrl)
1499 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
1500 Core\System::externalRedirect($toUrl);
1502 $this->internalRedirect($toUrl);