7 use Detection\MobileDetect;
11 use Friendica\Core\Config\Cache\IConfigCache;
12 use Friendica\Core\Config\Configuration;
13 use Friendica\Database\DBA;
14 use Friendica\Model\Profile;
15 use Friendica\Network\HTTPException\InternalServerErrorException;
16 use Friendica\Util\Config\ConfigFileLoader;
17 use Friendica\Util\HTTPSignature;
18 use Friendica\Util\Profiler;
19 use Psr\Log\LoggerInterface;
25 * @brief Our main application structure for the life of this page.
27 * Primarily deals with the URL that got us here
28 * and tries to make some sense of it, and
29 * stores our page contents and config storage
30 * and anything else that might need to be passed around
31 * before we spit the page out.
36 public $module_loaded = false;
37 public $module_class = null;
38 public $query_string = '';
49 public $error = false;
55 public $interactive = true;
57 public $is_mobile = false;
58 public $is_tablet = false;
59 public $theme_info = [];
61 // Allow themes to control internal parameters
62 // by changing App values in theme.php
64 public $sourcename = '';
65 public $videowidth = 425;
66 public $videoheight = 350;
67 public $force_max_items = 0;
68 public $theme_events_in_profile = true;
70 public $stylesheets = [];
71 public $footerScripts = [];
74 * @var App\Mode The Mode of the Application
79 * @var string The App URL path
84 * @var bool true, if the call is from the Friendica APP, otherwise false
86 private $isFriendicaApp;
89 * @var bool true, if the call is from an backend node (f.e. worker)
94 * @var string The name of the current theme
96 private $currentTheme;
99 * @var bool check if request was an AJAX (xmlhttprequest) request
106 public $mobileDetect;
109 * @var Configuration The config
114 * @var LoggerInterface The logger
119 * @var Profiler The profiler of this app
124 * Returns the current config cache of this node
126 * @return IConfigCache
128 public function getConfigCache()
130 return $this->config->getCache();
134 * The basepath of this app
138 public function getBasePath()
140 return $this->config->get('system', 'basepath');
144 * The Logger of this app
146 * @return LoggerInterface
148 public function getLogger()
150 return $this->logger;
154 * The profiler of this app
158 public function getProfiler()
160 return $this->profiler;
164 * Returns the Mode of the Application
166 * @return App\Mode The Application Mode
168 public function getMode()
174 * Register a stylesheet file path to be included in the <head> tag of every page.
175 * Inclusion is done in App->initHead().
176 * The path can be absolute or relative to the Friendica installation base folder.
180 * @param string $path
181 * @throws InternalServerErrorException
183 public function registerStylesheet($path)
185 $url = str_replace($this->getBasePath() . DIRECTORY_SEPARATOR, '', $path);
187 $this->stylesheets[] = trim($url, '/');
191 * Register a javascript file path to be included in the <footer> tag of every page.
192 * Inclusion is done in App->initFooter().
193 * The path can be absolute or relative to the Friendica installation base folder.
197 * @param string $path
198 * @throws InternalServerErrorException
200 public function registerFooterScript($path)
202 $url = str_replace($this->getBasePath() . DIRECTORY_SEPARATOR, '', $path);
204 $this->footerScripts[] = trim($url, '/');
212 * @brief App constructor.
214 * @param Configuration $config The Configuration
215 * @param App\Mode $mode The mode of this Friendica app
216 * @param LoggerInterface $logger The current app logger
217 * @param Profiler $profiler The profiler of this application
218 * @param bool $isBackend Whether it is used for backend or frontend (Default true=backend)
220 * @throws Exception if the Basepath is not usable
222 public function __construct(Configuration $config, App\Mode $mode, LoggerInterface $logger, Profiler $profiler, $isBackend = true)
224 BaseObject::setApp($this);
226 $this->logger = $logger;
227 $this->config = $config;
228 $this->profiler = $profiler;
231 $this->checkBackend($isBackend);
232 $this->checkFriendicaApp();
234 $this->profiler->reset();
240 // This has to be quite large to deal with embedded private photos
241 ini_set('pcre.backtrack_limit', 500000);
243 $this->scheme = 'http';
245 if (!empty($_SERVER['HTTPS']) ||
246 !empty($_SERVER['HTTP_FORWARDED']) && preg_match('/proto=https/', $_SERVER['HTTP_FORWARDED']) ||
247 !empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' ||
248 !empty($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on' ||
249 !empty($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on' ||
250 !empty($_SERVER['SERVER_PORT']) && (intval($_SERVER['SERVER_PORT']) == 443) // XXX: reasonable assumption, but isn't this hardcoding too much?
252 $this->scheme = 'https';
255 if (!empty($_SERVER['SERVER_NAME'])) {
256 $this->hostname = $_SERVER['SERVER_NAME'];
258 if (!empty($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
259 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
264 get_include_path() . PATH_SEPARATOR
265 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
266 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
267 . $this->getBasePath());
269 if (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'pagename=') === 0) {
270 $this->query_string = substr($_SERVER['QUERY_STRING'], 9);
271 } elseif (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'q=') === 0) {
272 $this->query_string = substr($_SERVER['QUERY_STRING'], 2);
275 // removing trailing / - maybe a nginx problem
276 $this->query_string = ltrim($this->query_string, '/');
278 if (!empty($_GET['pagename'])) {
279 $this->cmd = trim($_GET['pagename'], '/\\');
280 } elseif (!empty($_GET['q'])) {
281 $this->cmd = trim($_GET['q'], '/\\');
285 $this->query_string = str_replace($this->cmd . '&', $this->cmd . '?', $this->query_string);
287 // unix style "homedir"
288 if (substr($this->cmd, 0, 1) === '~') {
289 $this->cmd = 'profile/' . substr($this->cmd, 1);
292 // Diaspora style profile url
293 if (substr($this->cmd, 0, 2) === 'u/') {
294 $this->cmd = 'profile/' . substr($this->cmd, 2);
298 * Break the URL path into C style argc/argv style arguments for our
299 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
300 * will be 3 (integer) and $this->argv will contain:
306 * There will always be one argument. If provided a naked domain
307 * URL, $this->argv[0] is set to "home".
310 $this->argv = explode('/', $this->cmd);
311 $this->argc = count($this->argv);
312 if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
313 $this->module = str_replace('.', '_', $this->argv[0]);
314 $this->module = str_replace('-', '_', $this->module);
317 $this->argv = ['home'];
318 $this->module = 'home';
321 // Detect mobile devices
322 $mobile_detect = new MobileDetect();
324 $this->mobileDetect = $mobile_detect;
326 $this->is_mobile = $mobile_detect->isMobile();
327 $this->is_tablet = $mobile_detect->isTablet();
329 $this->isAjax = strtolower(defaults($_SERVER, 'HTTP_X_REQUESTED_WITH', '')) == 'xmlhttprequest';
331 // Register template engines
332 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
336 * Reloads the whole app instance
338 public function reload()
340 $this->determineURLPath();
342 $this->getMode()->determine($this->getBasePath());
344 if ($this->getMode()->has(App\Mode::DBAVAILABLE)) {
345 $loader = new ConfigFileLoader($this->getBasePath(), $this->getMode());
346 $this->config->getCache()->load($loader->loadCoreConfig('addon'), true);
348 $this->profiler->update(
349 $this->config->get('system', 'profiler', false),
350 $this->config->get('rendertime', 'callstack', false));
352 Core\Hook::loadHooks();
353 $loader = new ConfigFileLoader($this->getBasePath(), $this->mode);
354 Core\Hook::callAll('load_config', $loader);
357 $this->loadDefaultTimezone();
363 * Loads the default timezone
365 * Include support for legacy $default_timezone
367 * @global string $default_timezone
369 private function loadDefaultTimezone()
371 if ($this->config->get('system', 'default_timezone')) {
372 $this->timezone = $this->config->get('system', 'default_timezone');
374 global $default_timezone;
375 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
378 if ($this->timezone) {
379 date_default_timezone_set($this->timezone);
384 * Figure out if we are running at the top of a domain or in a sub-directory and adjust accordingly
386 private function determineURLPath()
389 * The automatic path detection in this function is currently deactivated,
390 * see issue https://github.com/friendica/friendica/issues/6679
392 * The problem is that the function seems to be confused with some url.
393 * These then confuses the detection which changes the url path.
396 /* Relative script path to the web server root
397 * Not all of those $_SERVER properties can be present, so we do by inverse priority order
400 $relative_script_path = '';
401 $relative_script_path = defaults($_SERVER, 'REDIRECT_URL' , $relative_script_path);
402 $relative_script_path = defaults($_SERVER, 'REDIRECT_URI' , $relative_script_path);
403 $relative_script_path = defaults($_SERVER, 'REDIRECT_SCRIPT_URL', $relative_script_path);
404 $relative_script_path = defaults($_SERVER, 'SCRIPT_URL' , $relative_script_path);
405 $relative_script_path = defaults($_SERVER, 'REQUEST_URI' , $relative_script_path);
407 $this->urlPath = $this->config->get('system', 'urlpath');
409 /* $relative_script_path gives /relative/path/to/friendica/module/parameter
410 * QUERY_STRING gives pagename=module/parameter
412 * To get /relative/path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
415 if (!empty($relative_script_path)) {
417 if (!empty($_SERVER['QUERY_STRING'])) {
418 $path = trim(rdirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
421 $path = trim($relative_script_path, '/');
424 if ($path && $path != $this->urlPath) {
425 $this->urlPath = $path;
431 public function getScheme()
433 return $this->scheme;
437 * @brief Retrieves the Friendica instance base URL
439 * This function assembles the base URL from multiple parts:
440 * - Protocol is determined either by the request or a combination of
441 * system.ssl_policy and the $ssl parameter.
442 * - Host name is determined either by system.hostname or inferred from request
443 * - Path is inferred from SCRIPT_NAME
445 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
447 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
448 * @return string Friendica server base URL
449 * @throws InternalServerErrorException
451 public function getBaseURL($ssl = false)
453 $scheme = $this->scheme;
455 if ($this->config->get('system', 'ssl_policy') == SSL_POLICY_FULL) {
459 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
460 // (and also the login link). Anything seen by an outsider will have it turned off.
462 if ($this->config->get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
470 if ($this->config->get('config', 'hostname') != '') {
471 $this->hostname = $this->config->get('config', 'hostname');
474 return $scheme . '://' . $this->hostname . (!empty($this->getURLPath()) ? '/' . $this->getURLPath() : '' );
478 * @brief Initializes the baseurl components
480 * Clears the baseurl cache to prevent inconsistencies
483 * @throws InternalServerErrorException
485 public function setBaseURL($url)
487 $parsed = @parse_url($url);
490 if (!empty($parsed)) {
491 if (!empty($parsed['scheme'])) {
492 $this->scheme = $parsed['scheme'];
495 if (!empty($parsed['host'])) {
496 $hostname = $parsed['host'];
499 if (!empty($parsed['port'])) {
500 $hostname .= ':' . $parsed['port'];
502 if (!empty($parsed['path'])) {
503 $this->urlPath = trim($parsed['path'], '\\/');
506 if (file_exists($this->getBasePath() . '/.htpreconfig.php')) {
507 include $this->getBasePath() . '/.htpreconfig.php';
510 if ($this->config->get('config', 'hostname') != '') {
511 $this->hostname = $this->config->get('config', 'hostname');
514 if (!isset($this->hostname) || ($this->hostname == '')) {
515 $this->hostname = $hostname;
520 public function getHostName()
522 if ($this->config->get('config', 'hostname') != '') {
523 $this->hostname = $this->config->get('config', 'hostname');
526 return $this->hostname;
529 public function getURLPath()
531 return $this->urlPath;
535 * Initializes App->page['htmlhead'].
540 * - Registered stylesheets (through App->registerStylesheet())
541 * - Infinite scroll data
542 * - head.tpl template
544 public function initHead()
546 $interval = ((local_user()) ? Core\PConfig::get(local_user(), 'system', 'update_interval') : 40000);
548 // If the update is 'deactivated' set it to the highest integer number (~24 days)
550 $interval = 2147483647;
553 if ($interval < 10000) {
557 // Default title: current module called
558 if (empty($this->page['title']) && $this->module) {
559 $this->page['title'] = ucfirst($this->module);
562 // Prepend the sitename to the page title
563 $this->page['title'] = $this->config->get('config', 'sitename', '') . (!empty($this->page['title']) ? ' | ' . $this->page['title'] : '');
565 if (!empty(Core\Renderer::$theme['stylesheet'])) {
566 $stylesheet = Core\Renderer::$theme['stylesheet'];
568 $stylesheet = $this->getCurrentThemeStylesheetPath();
571 $this->registerStylesheet($stylesheet);
573 $shortcut_icon = $this->config->get('system', 'shortcut_icon');
574 if ($shortcut_icon == '') {
575 $shortcut_icon = 'images/friendica-32.png';
578 $touch_icon = $this->config->get('system', 'touch_icon');
579 if ($touch_icon == '') {
580 $touch_icon = 'images/friendica-128.png';
583 Core\Hook::callAll('head', $this->page['htmlhead']);
585 $tpl = Core\Renderer::getMarkupTemplate('head.tpl');
586 /* put the head template at the beginning of page['htmlhead']
587 * since the code added by the modules frequently depends on it
590 $this->page['htmlhead'] = Core\Renderer::replaceMacros($tpl, [
591 '$baseurl' => $this->getBaseURL(),
592 '$local_user' => local_user(),
593 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
594 '$delitem' => Core\L10n::t('Delete this item?'),
595 '$update_interval' => $interval,
596 '$shortcut_icon' => $shortcut_icon,
597 '$touch_icon' => $touch_icon,
598 '$block_public' => intval($this->config->get('system', 'block_public')),
599 '$stylesheets' => $this->stylesheets,
600 ]) . $this->page['htmlhead'];
604 * Initializes App->page['footer'].
607 * - Javascript homebase
608 * - Mobile toggle link
609 * - Registered footer scripts (through App->registerFooterScript())
610 * - footer.tpl template
612 public function initFooter()
614 // If you're just visiting, let javascript take you home
615 if (!empty($_SESSION['visitor_home'])) {
616 $homebase = $_SESSION['visitor_home'];
617 } elseif (local_user()) {
618 $homebase = 'profile/' . $this->user['nickname'];
621 if (isset($homebase)) {
622 $this->page['footer'] .= '<script>var homebase="' . $homebase . '";</script>' . "\n";
626 * Add a "toggle mobile" link if we're using a mobile device
628 if ($this->is_mobile || $this->is_tablet) {
629 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
630 $link = 'toggle_mobile?address=' . urlencode(curPageURL());
632 $link = 'toggle_mobile?off=1&address=' . urlencode(curPageURL());
634 $this->page['footer'] .= Core\Renderer::replaceMacros(Core\Renderer::getMarkupTemplate("toggle_mobile_footer.tpl"), [
635 '$toggle_link' => $link,
636 '$toggle_text' => Core\L10n::t('toggle mobile')
640 Core\Hook::callAll('footer', $this->page['footer']);
642 $tpl = Core\Renderer::getMarkupTemplate('footer.tpl');
643 $this->page['footer'] = Core\Renderer::replaceMacros($tpl, [
644 '$baseurl' => $this->getBaseURL(),
645 '$footerScripts' => $this->footerScripts,
646 ]) . $this->page['footer'];
650 * @brief Removes the base url from an url. This avoids some mixed content problems.
652 * @param string $origURL
654 * @return string The cleaned url
655 * @throws InternalServerErrorException
657 public function removeBaseURL($origURL)
659 // Remove the hostname from the url if it is an internal link
660 $nurl = Util\Strings::normaliseLink($origURL);
661 $base = Util\Strings::normaliseLink($this->getBaseURL());
662 $url = str_replace($base . '/', '', $nurl);
664 // if it is an external link return the orignal value
665 if ($url == Util\Strings::normaliseLink($origURL)) {
673 * Returns the current UserAgent as a String
675 * @return string the UserAgent as a String
676 * @throws InternalServerErrorException
678 public function getUserAgent()
681 FRIENDICA_PLATFORM . " '" .
682 FRIENDICA_CODENAME . "' " .
683 FRIENDICA_VERSION . '-' .
684 DB_UPDATE_VERSION . '; ' .
689 * Checks, if the call is from the Friendica App
692 * The friendica client has problems with the GUID in the notify. this is some workaround
694 private function checkFriendicaApp()
697 $this->isFriendicaApp = isset($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)';
701 * Is the call via the Friendica app? (not a "normale" call)
703 * @return bool true if it's from the Friendica app
705 public function isFriendicaApp()
707 return $this->isFriendicaApp;
711 * @brief Checks if the site is called via a backend process
713 * This isn't a perfect solution. But we need this check very early.
714 * So we cannot wait until the modules are loaded.
716 * @param string $backend true, if the backend flag was set during App initialization
719 private function checkBackend($backend) {
742 // Check if current module is in backend or backend flag is set
743 $this->isBackend = (in_array($this->module, $backends) || $backend || $this->isBackend);
747 * Returns true, if the call is from a backend node (f.e. from a worker)
749 * @return bool Is it a known backend?
751 public function isBackend()
753 return $this->isBackend;
757 * @brief Checks if the maximum number of database processes is reached
759 * @return bool Is the limit reached?
761 public function isMaxProcessesReached()
763 // Deactivated, needs more investigating if this check really makes sense
767 * Commented out to suppress static analyzer issues
769 if ($this->is_backend()) {
770 $process = 'backend';
771 $max_processes = $this->config->get('system', 'max_processes_backend');
772 if (intval($max_processes) == 0) {
776 $process = 'frontend';
777 $max_processes = $this->config->get('system', 'max_processes_frontend');
778 if (intval($max_processes) == 0) {
783 $processlist = DBA::processlist();
784 if ($processlist['list'] != '') {
785 Core\Logger::log('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], Core\Logger::DEBUG);
787 if ($processlist['amount'] > $max_processes) {
788 Core\Logger::log('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', Core\Logger::DEBUG);
797 * @brief Checks if the minimal memory is reached
799 * @return bool Is the memory limit reached?
800 * @throws InternalServerErrorException
802 public function isMinMemoryReached()
804 $min_memory = $this->config->get('system', 'min_memory', 0);
805 if ($min_memory == 0) {
809 if (!is_readable('/proc/meminfo')) {
813 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
816 foreach ($memdata as $line) {
817 $data = explode(':', $line);
818 if (count($data) != 2) {
821 list($key, $val) = $data;
822 $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
823 $meminfo[$key] = (int) ($meminfo[$key] / 1024);
826 if (!isset($meminfo['MemFree'])) {
830 $free = $meminfo['MemFree'];
832 $reached = ($free < $min_memory);
835 Core\Logger::log('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, Core\Logger::DEBUG);
842 * @brief Checks if the maximum load is reached
844 * @return bool Is the load reached?
845 * @throws InternalServerErrorException
847 public function isMaxLoadReached()
849 if ($this->isBackend()) {
850 $process = 'backend';
851 $maxsysload = intval($this->config->get('system', 'maxloadavg'));
852 if ($maxsysload < 1) {
856 $process = 'frontend';
857 $maxsysload = intval($this->config->get('system', 'maxloadavg_frontend'));
858 if ($maxsysload < 1) {
863 $load = Core\System::currentLoad();
865 if (intval($load) > $maxsysload) {
866 Core\Logger::log('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
874 * Executes a child process with 'proc_open'
876 * @param string $command The command to execute
877 * @param array $args Arguments to pass to the command ( [ 'key' => value, 'key2' => value2, ... ]
878 * @throws InternalServerErrorException
880 public function proc_run($command, $args)
882 if (!function_exists('proc_open')) {
886 $cmdline = $this->config->get('config', 'php_path', 'php') . ' ' . escapeshellarg($command);
888 foreach ($args as $key => $value) {
889 if (!is_null($value) && is_bool($value) && !$value) {
893 $cmdline .= ' --' . $key;
894 if (!is_null($value) && !is_bool($value)) {
895 $cmdline .= ' ' . $value;
899 if ($this->isMinMemoryReached()) {
903 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
904 $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->getBasePath());
906 $resource = proc_open($cmdline . ' &', [], $foo, $this->getBasePath());
908 if (!is_resource($resource)) {
909 Core\Logger::log('We got no resource for command ' . $cmdline, Core\Logger::DEBUG);
912 proc_close($resource);
916 * Generates the site's default sender email address
919 * @throws InternalServerErrorException
921 public function getSenderEmailAddress()
923 $sender_email = $this->config->get('config', 'sender_email');
924 if (empty($sender_email)) {
925 $hostname = $this->getHostName();
926 if (strpos($hostname, ':')) {
927 $hostname = substr($hostname, 0, strpos($hostname, ':'));
930 $sender_email = 'noreply@' . $hostname;
933 return $sender_email;
937 * Returns the current theme name.
939 * @return string the name of the current theme
940 * @throws InternalServerErrorException
942 public function getCurrentTheme()
944 if ($this->getMode()->isInstall()) {
948 if (!$this->currentTheme) {
949 $this->computeCurrentTheme();
952 return $this->currentTheme;
955 public function setCurrentTheme($theme)
957 $this->currentTheme = $theme;
961 * Computes the current theme name based on the node settings, the user settings and the device type
965 private function computeCurrentTheme()
967 $system_theme = $this->config->get('system', 'theme');
968 if (!$system_theme) {
969 throw new Exception(Core\L10n::t('No system theme config value set.'));
973 $this->currentTheme = $system_theme;
975 $allowed_themes = explode(',', $this->config->get('system', 'allowed_themes', $system_theme));
978 // Find the theme that belongs to the user whose stuff we are looking at
979 if ($this->profile_uid && ($this->profile_uid != local_user())) {
980 // Allow folks to override user themes and always use their own on their own site.
981 // This works only if the user is on the same server
982 $user = DBA::selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
983 if (DBA::isResult($user) && !Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
984 $page_theme = $user['theme'];
988 $user_theme = Core\Session::get('theme', $system_theme);
990 // Specific mobile theme override
991 if (($this->is_mobile || $this->is_tablet) && Core\Session::get('show-mobile', true)) {
992 $system_mobile_theme = $this->config->get('system', 'mobile-theme');
993 $user_mobile_theme = Core\Session::get('mobile-theme', $system_mobile_theme);
995 // --- means same mobile theme as desktop
996 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
997 $user_theme = $user_mobile_theme;
1002 $theme_name = $page_theme;
1004 $theme_name = $user_theme;
1008 && in_array($theme_name, $allowed_themes)
1009 && (file_exists('view/theme/' . $theme_name . '/style.css')
1010 || file_exists('view/theme/' . $theme_name . '/style.php'))
1012 $this->currentTheme = $theme_name;
1017 * @brief Return full URL to theme which is currently in effect.
1019 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1022 * @throws InternalServerErrorException
1024 public function getCurrentThemeStylesheetPath()
1026 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
1030 * Check if request was an AJAX (xmlhttprequest) request.
1032 * @return boolean true if it was an AJAX request
1034 public function isAjax()
1036 return $this->isAjax;
1040 * Returns the value of a argv key
1041 * TODO there are a lot of $a->argv usages in combination with defaults() which can be replaced with this method
1043 * @param int $position the position of the argument
1044 * @param mixed $default the default value if not found
1046 * @return mixed returns the value of the argument
1048 public function getArgumentValue($position, $default = '')
1050 if (array_key_exists($position, $this->argv)) {
1051 return $this->argv[$position];
1058 * Sets the base url for use in cmdline programs which don't have
1059 * $_SERVER variables
1061 public function checkURL()
1063 $url = $this->config->get('system', 'url');
1065 // if the url isn't set or the stored url is radically different
1066 // than the currently visited url, store the current value accordingly.
1067 // "Radically different" ignores common variations such as http vs https
1068 // and www.example.com vs example.com.
1069 // We will only change the url to an ip address if there is no existing setting
1071 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()))) {
1072 $this->config->set('system', 'url', $this->getBaseURL());
1077 * Frontend App script
1079 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
1080 * request and a representation of the response.
1082 * This probably should change to limit the size of this monster method.
1084 public function runFrontend()
1086 // Missing DB connection: ERROR
1087 if ($this->getMode()->has(App\Mode::LOCALCONFIGPRESENT) && !$this->getMode()->has(App\Mode::DBAVAILABLE)) {
1088 Core\System::httpExit(500, ['title' => 'Error 500 - Internal Server Error', 'description' => 'Apologies but the website is unavailable at the moment.']);
1091 // Max Load Average reached: ERROR
1092 if ($this->isMaxProcessesReached() || $this->isMaxLoadReached()) {
1093 header('Retry-After: 120');
1094 header('Refresh: 120; url=' . $this->getBaseURL() . "/" . $this->query_string);
1096 Core\System::httpExit(503, ['title' => 'Error 503 - Service Temporarily Unavailable', 'description' => 'Core\System is currently overloaded. Please try again later.']);
1099 if (strstr($this->query_string, '.well-known/host-meta') && ($this->query_string != '.well-known/host-meta')) {
1100 Core\System::httpExit(404);
1103 if (!$this->getMode()->isInstall()) {
1104 // Force SSL redirection
1105 if ($this->config->get('system', 'force_ssl') && ($this->getScheme() == "http")
1106 && intval($this->config->get('system', 'ssl_policy')) == SSL_POLICY_FULL
1107 && strpos($this->getBaseURL(), 'https://') === 0
1108 && $_SERVER['REQUEST_METHOD'] == 'GET') {
1109 header('HTTP/1.1 302 Moved Temporarily');
1110 header('Location: ' . $this->getBaseURL() . '/' . $this->query_string);
1114 Core\Session::init();
1115 Core\Hook::callAll('init_1');
1118 // Exclude the backend processes from the session management
1119 if (!$this->isBackend()) {
1120 $stamp1 = microtime(true);
1122 $this->profiler->saveTimestamp($stamp1, 'parser', Core\System::callstack());
1123 Core\L10n::setSessionVariable();
1124 Core\L10n::setLangFromSession();
1127 Core\Worker::executeIfIdle();
1130 if ($this->getMode()->isNormal()) {
1131 $requester = HTTPSignature::getSigner('', $_SERVER);
1132 if (!empty($requester)) {
1133 Profile::addVisitorCookieForHandle($requester);
1138 if (!empty($_GET['zrl']) && $this->getMode()->isNormal()) {
1139 $this->query_string = Model\Profile::stripZrls($this->query_string);
1140 if (!local_user()) {
1141 // Only continue when the given profile link seems valid
1142 // Valid profile links contain a path with "/profile/" and no query parameters
1143 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
1144 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
1145 if (defaults($_SESSION, "visitor_home", "") != $_GET["zrl"]) {
1146 $_SESSION['my_url'] = $_GET['zrl'];
1147 $_SESSION['authenticated'] = 0;
1149 Model\Profile::zrlInit($this);
1151 // Someone came with an invalid parameter, maybe as a DDoS attempt
1152 // We simply stop processing here
1153 Core\Logger::log("Invalid ZRL parameter " . $_GET['zrl'], Core\Logger::DEBUG);
1154 Core\System::httpExit(403, ['title' => '403 Forbidden']);
1159 if (!empty($_GET['owt']) && $this->getMode()->isNormal()) {
1160 $token = $_GET['owt'];
1161 $this->query_string = Model\Profile::stripQueryParam($this->query_string, 'owt');
1162 Model\Profile::openWebAuthInit($token);
1165 Module\Login::sessionAuth();
1167 if (empty($_SESSION['authenticated'])) {
1168 header('X-Account-Management-Status: none');
1171 $_SESSION['sysmsg'] = defaults($_SESSION, 'sysmsg' , []);
1172 $_SESSION['sysmsg_info'] = defaults($_SESSION, 'sysmsg_info' , []);
1173 $_SESSION['last_updated'] = defaults($_SESSION, 'last_updated', []);
1176 * check_config() is responsible for running update scripts. These automatically
1177 * update the DB schema whenever we push a new one out. It also checks to see if
1178 * any addons have been added or removed and reacts accordingly.
1181 // in install mode, any url loads install module
1182 // but we need "view" module for stylesheet
1183 if ($this->getMode()->isInstall() && $this->module != 'view') {
1184 $this->module = 'install';
1185 } elseif (!$this->getMode()->has(App\Mode::MAINTENANCEDISABLED) && $this->module != 'view') {
1186 $this->module = 'maintenance';
1189 Core\Update::check($this->getBasePath(), false);
1190 Core\Addon::loadAddons();
1191 Core\Hook::loadHooks();
1202 'right_aside' => '',
1207 if (strlen($this->module)) {
1208 // Compatibility with the Android Diaspora client
1209 if ($this->module == 'stream') {
1210 $this->internalRedirect('network?f=&order=post');
1213 if ($this->module == 'conversations') {
1214 $this->internalRedirect('message');
1217 if ($this->module == 'commented') {
1218 $this->internalRedirect('network?f=&order=comment');
1221 if ($this->module == 'liked') {
1222 $this->internalRedirect('network?f=&order=comment');
1225 if ($this->module == 'activity') {
1226 $this->internalRedirect('network/?f=&conv=1');
1229 if (($this->module == 'status_messages') && ($this->cmd == 'status_messages/new')) {
1230 $this->internalRedirect('bookmarklet');
1233 if (($this->module == 'user') && ($this->cmd == 'user/edit')) {
1234 $this->internalRedirect('settings');
1237 if (($this->module == 'tag_followings') && ($this->cmd == 'tag_followings/manage')) {
1238 $this->internalRedirect('search');
1241 // Compatibility with the Firefox App
1242 if (($this->module == "users") && ($this->cmd == "users/sign_in")) {
1243 $this->module = "login";
1246 $privateapps = $this->config->get('config', 'private_addons', false);
1247 if (Core\Addon::isEnabled($this->module) && file_exists("addon/{$this->module}/{$this->module}.php")) {
1248 //Check if module is an app and if public access to apps is allowed or not
1249 if ((!local_user()) && Core\Hook::isAddonApp($this->module) && $privateapps) {
1250 info(Core\L10n::t("You must be logged in to use addons. "));
1252 include_once "addon/{$this->module}/{$this->module}.php";
1253 if (function_exists($this->module . '_module')) {
1254 LegacyModule::setModuleFile("addon/{$this->module}/{$this->module}.php");
1255 $this->module_class = 'Friendica\\LegacyModule';
1256 $this->module_loaded = true;
1261 // Controller class routing
1262 if (! $this->module_loaded && class_exists('Friendica\\Module\\' . ucfirst($this->module))) {
1263 $this->module_class = 'Friendica\\Module\\' . ucfirst($this->module);
1264 $this->module_loaded = true;
1267 /* If not, next look for a 'standard' program module in the 'mod' directory
1268 * We emulate a Module class through the LegacyModule class
1270 if (! $this->module_loaded && file_exists("mod/{$this->module}.php")) {
1271 LegacyModule::setModuleFile("mod/{$this->module}.php");
1272 $this->module_class = 'Friendica\\LegacyModule';
1273 $this->module_loaded = true;
1276 /* The URL provided does not resolve to a valid module.
1278 * On Dreamhost sites, quite often things go wrong for no apparent reason and they send us to '/internal_error.html'.
1279 * We don't like doing this, but as it occasionally accounts for 10-20% or more of all site traffic -
1280 * 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
1281 * this will often succeed and eventually do the right thing.
1283 * Otherwise we are going to emit a 404 not found.
1285 if (! $this->module_loaded) {
1286 // Stupid browser tried to pre-fetch our Javascript img template. Don't log the event or return anything - just quietly exit.
1287 if (!empty($_SERVER['QUERY_STRING']) && preg_match('/{[0-9]}/', $_SERVER['QUERY_STRING']) !== 0) {
1291 if (!empty($_SERVER['QUERY_STRING']) && ($_SERVER['QUERY_STRING'] === 'q=internal_error.html') && isset($dreamhost_error_hack)) {
1292 Core\Logger::log('index.php: dreamhost_error_hack invoked. Original URI =' . $_SERVER['REQUEST_URI']);
1293 $this->internalRedirect($_SERVER['REQUEST_URI']);
1296 Core\Logger::log('index.php: page not found: ' . $_SERVER['REQUEST_URI'] . ' ADDRESS: ' . $_SERVER['REMOTE_ADDR'] . ' QUERY: ' . $_SERVER['QUERY_STRING'], Core\Logger::DEBUG);
1298 header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . Core\L10n::t('Not Found'));
1299 $tpl = Core\Renderer::getMarkupTemplate("404.tpl");
1300 $this->page['content'] = Core\Renderer::replaceMacros($tpl, [
1301 '$message' => Core\L10n::t('Page not found.')
1308 // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
1309 if ($this->module_loaded) {
1310 $this->page['page_title'] = $this->module;
1313 Core\Hook::callAll($this->module . '_mod_init', $placeholder);
1315 call_user_func([$this->module_class, 'init']);
1317 // "rawContent" is especially meant for technical endpoints.
1318 // This endpoint doesn't need any theme initialization or other comparable stuff.
1319 if (!$this->error) {
1320 call_user_func([$this->module_class, 'rawContent']);
1324 // Load current theme info after module has been initialized as theme could have been set in module
1325 $theme_info_file = 'view/theme/' . $this->getCurrentTheme() . '/theme.php';
1326 if (file_exists($theme_info_file)) {
1327 require_once $theme_info_file;
1330 if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_init')) {
1331 $func = str_replace('-', '_', $this->getCurrentTheme()) . '_init';
1335 if ($this->module_loaded) {
1336 if (! $this->error && $_SERVER['REQUEST_METHOD'] === 'POST') {
1337 Core\Hook::callAll($this->module . '_mod_post', $_POST);
1338 call_user_func([$this->module_class, 'post']);
1341 if (! $this->error) {
1342 Core\Hook::callAll($this->module . '_mod_afterpost', $placeholder);
1343 call_user_func([$this->module_class, 'afterpost']);
1346 if (! $this->error) {
1347 $arr = ['content' => $content];
1348 Core\Hook::callAll($this->module . '_mod_content', $arr);
1349 $content = $arr['content'];
1350 $arr = ['content' => call_user_func([$this->module_class, 'content'])];
1351 Core\Hook::callAll($this->module . '_mod_aftercontent', $arr);
1352 $content .= $arr['content'];
1356 // initialise content region
1357 if ($this->getMode()->isNormal()) {
1358 Core\Hook::callAll('page_content_top', $this->page['content']);
1361 $this->page['content'] .= $content;
1363 /* Create the page head after setting the language
1364 * and getting any auth credentials.
1366 * Moved initHead() and initFooter() to after
1367 * all the module functions have executed so that all
1368 * theme choices made by the modules can take effect.
1372 /* Build the page ending -- this is stuff that goes right before
1373 * the closing </body> tag
1375 $this->initFooter();
1377 /* now that we've been through the module content, see if the page reported
1378 * a permission problem and if so, a 403 response would seem to be in order.
1380 if (stristr(implode("", $_SESSION['sysmsg']), Core\L10n::t('Permission denied'))) {
1381 header($_SERVER["SERVER_PROTOCOL"] . ' 403 ' . Core\L10n::t('Permission denied.'));
1384 // Report anything which needs to be communicated in the notification area (before the main body)
1385 Core\Hook::callAll('page_end', $this->page['content']);
1387 // Add the navigation (menu) template
1388 if ($this->module != 'install' && $this->module != 'maintenance') {
1389 $this->page['htmlhead'] .= Core\Renderer::replaceMacros(Core\Renderer::getMarkupTemplate('nav_head.tpl'), []);
1390 $this->page['nav'] = Content\Nav::build($this);
1393 // Build the page - now that we have all the components
1394 if (isset($_GET["mode"]) && (($_GET["mode"] == "raw") || ($_GET["mode"] == "minimal"))) {
1395 $doc = new DOMDocument();
1397 $target = new DOMDocument();
1398 $target->loadXML("<root></root>");
1400 $content = mb_convert_encoding($this->page["content"], 'HTML-ENTITIES', "UTF-8");
1402 /// @TODO one day, kill those error-surpressing @ stuff, or PHP should ban it
1403 @$doc->loadHTML($content);
1405 $xpath = new DOMXPath($doc);
1407 $list = $xpath->query("//*[contains(@id,'tread-wrapper-')]"); /* */
1409 foreach ($list as $item) {
1410 $item = $target->importNode($item, true);
1412 // And then append it to the target
1413 $target->documentElement->appendChild($item);
1416 if ($_GET["mode"] == "raw") {
1417 header("Content-type: text/html; charset=utf-8");
1419 echo substr($target->saveHTML(), 6, -8);
1425 $page = $this->page;
1426 $profile = $this->profile;
1428 header("X-Friendica-Version: " . FRIENDICA_VERSION);
1429 header("Content-type: text/html; charset=utf-8");
1431 if ($this->config->get('system', 'hsts') && ($this->config->get('system', 'ssl_policy') == SSL_POLICY_FULL)) {
1432 header("Strict-Transport-Security: max-age=31536000");
1435 // Some security stuff
1436 header('X-Content-Type-Options: nosniff');
1437 header('X-XSS-Protection: 1; mode=block');
1438 header('X-Permitted-Cross-Domain-Policies: none');
1439 header('X-Frame-Options: sameorigin');
1441 // Things like embedded OSM maps don't work, when this is enabled
1442 // 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'");
1444 /* We use $_GET["mode"] for special page templates. So we will check if we have
1445 * to load another page template than the default one.
1446 * The page templates are located in /view/php/ or in the theme directory.
1448 if (isset($_GET["mode"])) {
1449 $template = Core\Theme::getPathForFile($_GET["mode"] . '.php');
1452 // If there is no page template use the default page template
1453 if (empty($template)) {
1454 $template = Core\Theme::getPathForFile("default.php");
1457 // Theme templates expect $a as an App instance
1460 // Used as is in view/php/default.php
1461 $lang = Core\L10n::getCurrentLang();
1463 /// @TODO Looks unsafe (remote-inclusion), is maybe not but Core\Theme::getPathForFile() uses file_exists() but does not escape anything
1464 require_once $template;
1468 * Redirects to another module relative to the current Friendica base.
1469 * If you want to redirect to a external URL, use System::externalRedirectTo()
1471 * @param string $toUrl The destination URL (Default is empty, which is the default page of the Friendica node)
1472 * @param bool $ssl if true, base URL will try to get called with https:// (works just for relative paths)
1474 * @throws InternalServerErrorException In Case the given URL is not relative to the Friendica node
1476 public function internalRedirect($toUrl = '', $ssl = false)
1478 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
1479 throw new InternalServerErrorException("'$toUrl is not a relative path, please use System::externalRedirectTo");
1482 $redirectTo = $this->getBaseURL($ssl) . '/' . ltrim($toUrl, '/');
1483 Core\System::externalRedirect($redirectTo);
1487 * Automatically redirects to relative or absolute URL
1488 * Should only be used if it isn't clear if the URL is either internal or external
1490 * @param string $toUrl The target URL
1491 * @throws InternalServerErrorException
1493 public function redirect($toUrl)
1495 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
1496 Core\System::externalRedirect($toUrl);
1498 $this->internalRedirect($toUrl);