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 Friendica\Util\Profiler;
17 use Psr\Log\LoggerInterface;
23 * @brief Our main application structure for the life of this page.
25 * Primarily deals with the URL that got us here
26 * and tries to make some sense of it, and
27 * stores our page contents and config storage
28 * and anything else that might need to be passed around
29 * before we spit the page out.
34 public $module_loaded = false;
35 public $module_class = null;
36 public $query_string = '';
47 public $error = false;
53 public $interactive = true;
55 public $is_mobile = false;
56 public $is_tablet = false;
57 public $theme_info = [];
59 // Allow themes to control internal parameters
60 // by changing App values in theme.php
62 public $sourcename = '';
63 public $videowidth = 425;
64 public $videoheight = 350;
65 public $force_max_items = 0;
66 public $theme_events_in_profile = true;
68 public $stylesheets = [];
69 public $footerScripts = [];
72 * @var App\Mode The Mode of the Application
77 * @var string The App base path
82 * @var string The App URL path
87 * @var bool true, if the call is from the Friendica APP, otherwise false
89 private $isFriendicaApp;
92 * @var bool true, if the call is from an backend node (f.e. worker)
97 * @var string The name of the current theme
99 private $currentTheme;
102 * @var bool check if request was an AJAX (xmlhttprequest) request
109 public $mobileDetect;
112 * @var LoggerInterface The current logger of this App
117 * @var ConfigCache The cached config
122 * @var Profiler The profiler of this app
127 * Returns the current config cache of this node
129 * @return ConfigCache
131 public function getConfig()
133 return $this->config;
137 * The basepath of this app
141 public function getBasePath()
143 return $this->basePath;
147 * The profiler of this app
151 public function getProfiler()
153 return $this->profiler;
157 * Register a stylesheet file path to be included in the <head> tag of every page.
158 * Inclusion is done in App->initHead().
159 * The path can be absolute or relative to the Friendica installation base folder.
163 * @param string $path
164 * @throws InternalServerErrorException
166 public function registerStylesheet($path)
168 $url = str_replace($this->basePath . DIRECTORY_SEPARATOR, '', $path);
170 $this->stylesheets[] = trim($url, '/');
174 * Register a javascript file path to be included in the <footer> tag of every page.
175 * Inclusion is done in App->initFooter().
176 * The path can be absolute or relative to the Friendica installation base folder.
180 * @param string $path
181 * @throws InternalServerErrorException
183 public function registerFooterScript($path)
185 $url = str_replace($this->basePath . DIRECTORY_SEPARATOR, '', $path);
187 $this->footerScripts[] = trim($url, '/');
196 * @brief App constructor.
198 * @param ConfigCache $config The Cached Config
199 * @param LoggerInterface $logger Logger of this application
200 * @param Profiler $profiler The profiler of this application
201 * @param bool $isBackend Whether it is used for backend or frontend (Default true=backend)
203 * @throws Exception if the Basepath is not usable
205 public function __construct(ConfigCache $config, LoggerInterface $logger, Profiler $profiler, $isBackend = true)
207 $this->config = $config;
208 $this->logger = $logger;
209 $this->profiler = $profiler;
210 $this->basePath = $this->config->get('system', 'basepath');
212 if (!Core\System::isDirectoryUsable($this->basePath, false)) {
213 throw new Exception('Basepath ' . $this->basePath . ' isn\'t usable.');
215 $this->basePath = rtrim($this->basePath, DIRECTORY_SEPARATOR);
217 BaseObject::setApp($this);
219 $this->checkBackend($isBackend);
220 $this->checkFriendicaApp();
222 $this->profiler->reset();
224 $this->mode = new App\Mode($this->basePath);
230 // This has to be quite large to deal with embedded private photos
231 ini_set('pcre.backtrack_limit', 500000);
233 $this->scheme = 'http';
235 if (!empty($_SERVER['HTTPS']) ||
236 !empty($_SERVER['HTTP_FORWARDED']) && preg_match('/proto=https/', $_SERVER['HTTP_FORWARDED']) ||
237 !empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' ||
238 !empty($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on' ||
239 !empty($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on' ||
240 !empty($_SERVER['SERVER_PORT']) && (intval($_SERVER['SERVER_PORT']) == 443) // XXX: reasonable assumption, but isn't this hardcoding too much?
242 $this->scheme = 'https';
245 if (!empty($_SERVER['SERVER_NAME'])) {
246 $this->hostname = $_SERVER['SERVER_NAME'];
248 if (!empty($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
249 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
254 get_include_path() . PATH_SEPARATOR
255 . $this->basePath . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
256 . $this->basePath . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
259 if (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'pagename=') === 0) {
260 $this->query_string = substr($_SERVER['QUERY_STRING'], 9);
261 } elseif (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'q=') === 0) {
262 $this->query_string = substr($_SERVER['QUERY_STRING'], 2);
265 // removing trailing / - maybe a nginx problem
266 $this->query_string = ltrim($this->query_string, '/');
268 if (!empty($_GET['pagename'])) {
269 $this->cmd = trim($_GET['pagename'], '/\\');
270 } elseif (!empty($_GET['q'])) {
271 $this->cmd = trim($_GET['q'], '/\\');
275 $this->query_string = str_replace($this->cmd . '&', $this->cmd . '?', $this->query_string);
277 // unix style "homedir"
278 if (substr($this->cmd, 0, 1) === '~') {
279 $this->cmd = 'profile/' . substr($this->cmd, 1);
282 // Diaspora style profile url
283 if (substr($this->cmd, 0, 2) === 'u/') {
284 $this->cmd = 'profile/' . substr($this->cmd, 2);
288 * Break the URL path into C style argc/argv style arguments for our
289 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
290 * will be 3 (integer) and $this->argv will contain:
296 * There will always be one argument. If provided a naked domain
297 * URL, $this->argv[0] is set to "home".
300 $this->argv = explode('/', $this->cmd);
301 $this->argc = count($this->argv);
302 if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
303 $this->module = str_replace('.', '_', $this->argv[0]);
304 $this->module = str_replace('-', '_', $this->module);
307 $this->argv = ['home'];
308 $this->module = 'home';
311 // Detect mobile devices
312 $mobile_detect = new MobileDetect();
314 $this->mobileDetect = $mobile_detect;
316 $this->is_mobile = $mobile_detect->isMobile();
317 $this->is_tablet = $mobile_detect->isTablet();
319 $this->isAjax = strtolower(defaults($_SERVER, 'HTTP_X_REQUESTED_WITH', '')) == 'xmlhttprequest';
321 // Register template engines
322 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
326 * Returns the Mode of the Application
328 * @return App\Mode The Application Mode
330 * @throws InternalServerErrorException when the mode isn't created
332 public function getMode()
334 if (empty($this->mode)) {
335 throw new InternalServerErrorException('Mode of the Application is not defined');
342 * Returns the Logger of the Application
344 * @return LoggerInterface The Logger
345 * @throws InternalServerErrorException when the logger isn't created
347 public function getLogger()
349 if (empty($this->logger)) {
350 throw new InternalServerErrorException('Logger of the Application is not defined');
353 return $this->logger;
357 * Reloads the whole app instance
359 public function reload()
361 Core\Config::init($this->config);
362 Core\PConfig::init($this->config);
364 $this->loadDatabase();
366 $this->getMode()->determine($this->basePath);
368 $this->determineURLPath();
370 if ($this->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
371 $adapterType = $this->config->get('system', 'config_adapter');
372 $adapter = ConfigFactory::createConfig($adapterType, $this->config);
373 Core\Config::setAdapter($adapter);
374 $adapterP = ConfigFactory::createPConfig($adapterType, $this->config);
375 Core\PConfig::setAdapter($adapterP);
379 // again because DB-config could change the config
380 $this->getMode()->determine($this->basePath);
382 if ($this->getMode()->has(App\Mode::DBAVAILABLE)) {
383 Core\Hook::loadHooks();
384 $loader = new ConfigCacheLoader($this->basePath);
385 Core\Hook::callAll('load_config', $loader);
386 $this->config->loadConfigArray($loader->loadCoreConfig('addon'), true);
389 $this->loadDefaultTimezone();
393 $this->process_id = Core\System::processID('log');
395 Core\Logger::setLogger($this->logger);
399 * Loads the default timezone
401 * Include support for legacy $default_timezone
403 * @global string $default_timezone
405 private function loadDefaultTimezone()
407 if ($this->config->get('system', 'default_timezone')) {
408 $this->timezone = $this->config->get('system', 'default_timezone');
410 global $default_timezone;
411 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
414 if ($this->timezone) {
415 date_default_timezone_set($this->timezone);
420 * Figure out if we are running at the top of a domain or in a sub-directory and adjust accordingly
422 private function determineURLPath()
424 /* Relative script path to the web server root
425 * Not all of those $_SERVER properties can be present, so we do by inverse priority order
427 $relative_script_path = '';
428 $relative_script_path = defaults($_SERVER, 'REDIRECT_URL' , $relative_script_path);
429 $relative_script_path = defaults($_SERVER, 'REDIRECT_URI' , $relative_script_path);
430 $relative_script_path = defaults($_SERVER, 'REDIRECT_SCRIPT_URL', $relative_script_path);
431 $relative_script_path = defaults($_SERVER, 'SCRIPT_URL' , $relative_script_path);
432 $relative_script_path = defaults($_SERVER, 'REQUEST_URI' , $relative_script_path);
434 $this->urlPath = $this->config->get('system', 'urlpath');
436 /* $relative_script_path gives /relative/path/to/friendica/module/parameter
437 * QUERY_STRING gives pagename=module/parameter
439 * To get /relative/path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
441 if (!empty($relative_script_path)) {
443 if (!empty($_SERVER['QUERY_STRING'])) {
444 $path = trim(rdirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
447 $path = trim($relative_script_path, '/');
450 if ($path && $path != $this->urlPath) {
451 $this->urlPath = $path;
456 public function loadDatabase()
458 if (DBA::connected()) {
462 $db_host = $this->config->get('database', 'hostname');
463 $db_user = $this->config->get('database', 'username');
464 $db_pass = $this->config->get('database', 'password');
465 $db_data = $this->config->get('database', 'database');
466 $charset = $this->config->get('database', 'charset');
468 // Use environment variables for mysql if they are set beforehand
469 if (!empty(getenv('MYSQL_HOST'))
470 && !empty(getenv('MYSQL_USERNAME') || !empty(getenv('MYSQL_USER')))
471 && getenv('MYSQL_PASSWORD') !== false
472 && !empty(getenv('MYSQL_DATABASE')))
474 $db_host = getenv('MYSQL_HOST');
475 if (!empty(getenv('MYSQL_PORT'))) {
476 $db_host .= ':' . getenv('MYSQL_PORT');
478 if (!empty(getenv('MYSQL_USERNAME'))) {
479 $db_user = getenv('MYSQL_USERNAME');
481 $db_user = getenv('MYSQL_USER');
483 $db_pass = (string) getenv('MYSQL_PASSWORD');
484 $db_data = getenv('MYSQL_DATABASE');
487 $stamp1 = microtime(true);
489 if (DBA::connect($this->config, $this->profiler, $db_host, $db_user, $db_pass, $db_data, $charset)) {
490 // Loads DB_UPDATE_VERSION constant
491 Database\DBStructure::definition($this->basePath, false);
494 unset($db_host, $db_user, $db_pass, $db_data, $charset);
496 $this->profiler->saveTimestamp($stamp1, 'network', Core\System::callstack());
499 public function getScheme()
501 return $this->scheme;
505 * @brief Retrieves the Friendica instance base URL
507 * This function assembles the base URL from multiple parts:
508 * - Protocol is determined either by the request or a combination of
509 * system.ssl_policy and the $ssl parameter.
510 * - Host name is determined either by system.hostname or inferred from request
511 * - Path is inferred from SCRIPT_NAME
513 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
515 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
516 * @return string Friendica server base URL
517 * @throws InternalServerErrorException
519 public function getBaseURL($ssl = false)
521 $scheme = $this->scheme;
523 if (Core\Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
527 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
528 // (and also the login link). Anything seen by an outsider will have it turned off.
530 if (Core\Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
538 if (Core\Config::get('config', 'hostname') != '') {
539 $this->hostname = Core\Config::get('config', 'hostname');
542 return $scheme . '://' . $this->hostname . (!empty($this->getURLPath()) ? '/' . $this->getURLPath() : '' );
546 * @brief Initializes the baseurl components
548 * Clears the baseurl cache to prevent inconsistencies
551 * @throws InternalServerErrorException
553 public function setBaseURL($url)
555 $parsed = @parse_url($url);
558 if (!empty($parsed)) {
559 if (!empty($parsed['scheme'])) {
560 $this->scheme = $parsed['scheme'];
563 if (!empty($parsed['host'])) {
564 $hostname = $parsed['host'];
567 if (!empty($parsed['port'])) {
568 $hostname .= ':' . $parsed['port'];
570 if (!empty($parsed['path'])) {
571 $this->urlPath = trim($parsed['path'], '\\/');
574 if (file_exists($this->basePath . '/.htpreconfig.php')) {
575 include $this->basePath . '/.htpreconfig.php';
578 if (Core\Config::get('config', 'hostname') != '') {
579 $this->hostname = Core\Config::get('config', 'hostname');
582 if (!isset($this->hostname) || ($this->hostname == '')) {
583 $this->hostname = $hostname;
588 public function getHostName()
590 if (Core\Config::get('config', 'hostname') != '') {
591 $this->hostname = Core\Config::get('config', 'hostname');
594 return $this->hostname;
597 public function getURLPath()
599 return $this->urlPath;
603 * Initializes App->page['htmlhead'].
608 * - Registered stylesheets (through App->registerStylesheet())
609 * - Infinite scroll data
610 * - head.tpl template
612 public function initHead()
614 $interval = ((local_user()) ? Core\PConfig::get(local_user(), 'system', 'update_interval') : 40000);
616 // If the update is 'deactivated' set it to the highest integer number (~24 days)
618 $interval = 2147483647;
621 if ($interval < 10000) {
625 // compose the page title from the sitename and the
626 // current module called
627 if (!$this->module == '') {
628 $this->page['title'] = $this->config->get('config', 'sitename') . ' (' . $this->module . ')';
630 $this->page['title'] = $this->config->get('config', 'sitename');
633 if (!empty(Core\Renderer::$theme['stylesheet'])) {
634 $stylesheet = Core\Renderer::$theme['stylesheet'];
636 $stylesheet = $this->getCurrentThemeStylesheetPath();
639 $this->registerStylesheet($stylesheet);
641 $shortcut_icon = Core\Config::get('system', 'shortcut_icon');
642 if ($shortcut_icon == '') {
643 $shortcut_icon = 'images/friendica-32.png';
646 $touch_icon = Core\Config::get('system', 'touch_icon');
647 if ($touch_icon == '') {
648 $touch_icon = 'images/friendica-128.png';
651 Core\Hook::callAll('head', $this->page['htmlhead']);
653 $tpl = Core\Renderer::getMarkupTemplate('head.tpl');
654 /* put the head template at the beginning of page['htmlhead']
655 * since the code added by the modules frequently depends on it
658 $this->page['htmlhead'] = Core\Renderer::replaceMacros($tpl, [
659 '$baseurl' => $this->getBaseURL(),
660 '$local_user' => local_user(),
661 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
662 '$delitem' => Core\L10n::t('Delete this item?'),
663 '$showmore' => Core\L10n::t('show more'),
664 '$showfewer' => Core\L10n::t('show fewer'),
665 '$update_interval' => $interval,
666 '$shortcut_icon' => $shortcut_icon,
667 '$touch_icon' => $touch_icon,
668 '$block_public' => intval(Core\Config::get('system', 'block_public')),
669 '$stylesheets' => $this->stylesheets,
670 ]) . $this->page['htmlhead'];
674 * Initializes App->page['footer'].
677 * - Javascript homebase
678 * - Mobile toggle link
679 * - Registered footer scripts (through App->registerFooterScript())
680 * - footer.tpl template
682 public function initFooter()
684 // If you're just visiting, let javascript take you home
685 if (!empty($_SESSION['visitor_home'])) {
686 $homebase = $_SESSION['visitor_home'];
687 } elseif (local_user()) {
688 $homebase = 'profile/' . $this->user['nickname'];
691 if (isset($homebase)) {
692 $this->page['footer'] .= '<script>var homebase="' . $homebase . '";</script>' . "\n";
696 * Add a "toggle mobile" link if we're using a mobile device
698 if ($this->is_mobile || $this->is_tablet) {
699 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
700 $link = 'toggle_mobile?address=' . urlencode(curPageURL());
702 $link = 'toggle_mobile?off=1&address=' . urlencode(curPageURL());
704 $this->page['footer'] .= Core\Renderer::replaceMacros(Core\Renderer::getMarkupTemplate("toggle_mobile_footer.tpl"), [
705 '$toggle_link' => $link,
706 '$toggle_text' => Core\L10n::t('toggle mobile')
710 Core\Hook::callAll('footer', $this->page['footer']);
712 $tpl = Core\Renderer::getMarkupTemplate('footer.tpl');
713 $this->page['footer'] = Core\Renderer::replaceMacros($tpl, [
714 '$baseurl' => $this->getBaseURL(),
715 '$footerScripts' => $this->footerScripts,
716 ]) . $this->page['footer'];
720 * @brief Removes the base url from an url. This avoids some mixed content problems.
722 * @param string $origURL
724 * @return string The cleaned url
725 * @throws InternalServerErrorException
727 public function removeBaseURL($origURL)
729 // Remove the hostname from the url if it is an internal link
730 $nurl = Util\Strings::normaliseLink($origURL);
731 $base = Util\Strings::normaliseLink($this->getBaseURL());
732 $url = str_replace($base . '/', '', $nurl);
734 // if it is an external link return the orignal value
735 if ($url == Util\Strings::normaliseLink($origURL)) {
743 * Returns the current UserAgent as a String
745 * @return string the UserAgent as a String
746 * @throws InternalServerErrorException
748 public function getUserAgent()
751 FRIENDICA_PLATFORM . " '" .
752 FRIENDICA_CODENAME . "' " .
753 FRIENDICA_VERSION . '-' .
754 DB_UPDATE_VERSION . '; ' .
759 * Checks, if the call is from the Friendica App
762 * The friendica client has problems with the GUID in the notify. this is some workaround
764 private function checkFriendicaApp()
767 $this->isFriendicaApp = isset($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)';
771 * Is the call via the Friendica app? (not a "normale" call)
773 * @return bool true if it's from the Friendica app
775 public function isFriendicaApp()
777 return $this->isFriendicaApp;
781 * @brief Checks if the site is called via a backend process
783 * This isn't a perfect solution. But we need this check very early.
784 * So we cannot wait until the modules are loaded.
786 * @param string $backend true, if the backend flag was set during App initialization
789 private function checkBackend($backend) {
812 // Check if current module is in backend or backend flag is set
813 $this->isBackend = (in_array($this->module, $backends) || $backend || $this->isBackend);
817 * Returns true, if the call is from a backend node (f.e. from a worker)
819 * @return bool Is it a known backend?
821 public function isBackend()
823 return $this->isBackend;
827 * @brief Checks if the maximum number of database processes is reached
829 * @return bool Is the limit reached?
831 public function isMaxProcessesReached()
833 // Deactivated, needs more investigating if this check really makes sense
837 * Commented out to suppress static analyzer issues
839 if ($this->is_backend()) {
840 $process = 'backend';
841 $max_processes = Core\Config::get('system', 'max_processes_backend');
842 if (intval($max_processes) == 0) {
846 $process = 'frontend';
847 $max_processes = Core\Config::get('system', 'max_processes_frontend');
848 if (intval($max_processes) == 0) {
853 $processlist = DBA::processlist();
854 if ($processlist['list'] != '') {
855 Core\Logger::log('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], Core\Logger::DEBUG);
857 if ($processlist['amount'] > $max_processes) {
858 Core\Logger::log('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', Core\Logger::DEBUG);
867 * @brief Checks if the minimal memory is reached
869 * @return bool Is the memory limit reached?
870 * @throws InternalServerErrorException
872 public function isMinMemoryReached()
874 $min_memory = Core\Config::get('system', 'min_memory', 0);
875 if ($min_memory == 0) {
879 if (!is_readable('/proc/meminfo')) {
883 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
886 foreach ($memdata as $line) {
887 $data = explode(':', $line);
888 if (count($data) != 2) {
891 list($key, $val) = $data;
892 $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
893 $meminfo[$key] = (int) ($meminfo[$key] / 1024);
896 if (!isset($meminfo['MemFree'])) {
900 $free = $meminfo['MemFree'];
902 $reached = ($free < $min_memory);
905 Core\Logger::log('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, Core\Logger::DEBUG);
912 * @brief Checks if the maximum load is reached
914 * @return bool Is the load reached?
915 * @throws InternalServerErrorException
917 public function isMaxLoadReached()
919 if ($this->isBackend()) {
920 $process = 'backend';
921 $maxsysload = intval(Core\Config::get('system', 'maxloadavg'));
922 if ($maxsysload < 1) {
926 $process = 'frontend';
927 $maxsysload = intval(Core\Config::get('system', 'maxloadavg_frontend'));
928 if ($maxsysload < 1) {
933 $load = Core\System::currentLoad();
935 if (intval($load) > $maxsysload) {
936 Core\Logger::log('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
944 * Executes a child process with 'proc_open'
946 * @param string $command The command to execute
947 * @param array $args Arguments to pass to the command ( [ 'key' => value, 'key2' => value2, ... ]
948 * @throws InternalServerErrorException
950 public function proc_run($command, $args)
952 if (!function_exists('proc_open')) {
956 $cmdline = $this->config->get('config', 'php_path', 'php') . ' ' . escapeshellarg($command);
958 foreach ($args as $key => $value) {
959 if (!is_null($value) && is_bool($value) && !$value) {
963 $cmdline .= ' --' . $key;
964 if (!is_null($value) && !is_bool($value)) {
965 $cmdline .= ' ' . $value;
969 if ($this->isMinMemoryReached()) {
973 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
974 $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->basePath);
976 $resource = proc_open($cmdline . ' &', [], $foo, $this->basePath);
978 if (!is_resource($resource)) {
979 Core\Logger::log('We got no resource for command ' . $cmdline, Core\Logger::DEBUG);
982 proc_close($resource);
986 * Generates the site's default sender email address
989 * @throws InternalServerErrorException
991 public function getSenderEmailAddress()
993 $sender_email = Core\Config::get('config', 'sender_email');
994 if (empty($sender_email)) {
995 $hostname = $this->getHostName();
996 if (strpos($hostname, ':')) {
997 $hostname = substr($hostname, 0, strpos($hostname, ':'));
1000 $sender_email = 'noreply@' . $hostname;
1003 return $sender_email;
1007 * Returns the current theme name.
1009 * @return string the name of the current theme
1010 * @throws InternalServerErrorException
1012 public function getCurrentTheme()
1014 if ($this->getMode()->isInstall()) {
1018 if (!$this->currentTheme) {
1019 $this->computeCurrentTheme();
1022 return $this->currentTheme;
1025 public function setCurrentTheme($theme)
1027 $this->currentTheme = $theme;
1031 * Computes the current theme name based on the node settings, the user settings and the device type
1035 private function computeCurrentTheme()
1037 $system_theme = Core\Config::get('system', 'theme');
1038 if (!$system_theme) {
1039 throw new Exception(Core\L10n::t('No system theme config value set.'));
1043 $this->currentTheme = $system_theme;
1045 $allowed_themes = explode(',', Core\Config::get('system', 'allowed_themes', $system_theme));
1048 // Find the theme that belongs to the user whose stuff we are looking at
1049 if ($this->profile_uid && ($this->profile_uid != local_user())) {
1050 // Allow folks to override user themes and always use their own on their own site.
1051 // This works only if the user is on the same server
1052 $user = DBA::selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
1053 if (DBA::isResult($user) && !Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
1054 $page_theme = $user['theme'];
1058 $user_theme = Core\Session::get('theme', $system_theme);
1060 // Specific mobile theme override
1061 if (($this->is_mobile || $this->is_tablet) && Core\Session::get('show-mobile', true)) {
1062 $system_mobile_theme = Core\Config::get('system', 'mobile-theme');
1063 $user_mobile_theme = Core\Session::get('mobile-theme', $system_mobile_theme);
1065 // --- means same mobile theme as desktop
1066 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
1067 $user_theme = $user_mobile_theme;
1072 $theme_name = $page_theme;
1074 $theme_name = $user_theme;
1078 && in_array($theme_name, $allowed_themes)
1079 && (file_exists('view/theme/' . $theme_name . '/style.css')
1080 || file_exists('view/theme/' . $theme_name . '/style.php'))
1082 $this->currentTheme = $theme_name;
1087 * @brief Return full URL to theme which is currently in effect.
1089 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1092 * @throws InternalServerErrorException
1094 public function getCurrentThemeStylesheetPath()
1096 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
1100 * Check if request was an AJAX (xmlhttprequest) request.
1102 * @return boolean true if it was an AJAX request
1104 public function isAjax()
1106 return $this->isAjax;
1110 * Returns the value of a argv key
1111 * TODO there are a lot of $a->argv usages in combination with defaults() which can be replaced with this method
1113 * @param int $position the position of the argument
1114 * @param mixed $default the default value if not found
1116 * @return mixed returns the value of the argument
1118 public function getArgumentValue($position, $default = '')
1120 if (array_key_exists($position, $this->argv)) {
1121 return $this->argv[$position];
1128 * Sets the base url for use in cmdline programs which don't have
1129 * $_SERVER variables
1131 public function checkURL()
1133 $url = Core\Config::get('system', 'url');
1135 // if the url isn't set or the stored url is radically different
1136 // than the currently visited url, store the current value accordingly.
1137 // "Radically different" ignores common variations such as http vs https
1138 // and www.example.com vs example.com.
1139 // We will only change the url to an ip address if there is no existing setting
1141 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()))) {
1142 Core\Config::set('system', 'url', $this->getBaseURL());
1147 * Frontend App script
1149 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
1150 * request and a representation of the response.
1152 * This probably should change to limit the size of this monster method.
1154 public function runFrontend()
1156 // Missing DB connection: ERROR
1157 if ($this->getMode()->has(App\Mode::LOCALCONFIGPRESENT) && !$this->getMode()->has(App\Mode::DBAVAILABLE)) {
1158 Core\System::httpExit(500, ['title' => 'Error 500 - Internal Server Error', 'description' => 'Apologies but the website is unavailable at the moment.']);
1161 // Max Load Average reached: ERROR
1162 if ($this->isMaxProcessesReached() || $this->isMaxLoadReached()) {
1163 header('Retry-After: 120');
1164 header('Refresh: 120; url=' . $this->getBaseURL() . "/" . $this->query_string);
1166 Core\System::httpExit(503, ['title' => 'Error 503 - Service Temporarily Unavailable', 'description' => 'Core\System is currently overloaded. Please try again later.']);
1169 if (strstr($this->query_string, '.well-known/host-meta') && ($this->query_string != '.well-known/host-meta')) {
1170 Core\System::httpExit(404);
1173 if (!$this->getMode()->isInstall()) {
1174 // Force SSL redirection
1175 if (Core\Config::get('system', 'force_ssl') && ($this->getScheme() == "http")
1176 && intval(Core\Config::get('system', 'ssl_policy')) == SSL_POLICY_FULL
1177 && strpos($this->getBaseURL(), 'https://') === 0
1178 && $_SERVER['REQUEST_METHOD'] == 'GET') {
1179 header('HTTP/1.1 302 Moved Temporarily');
1180 header('Location: ' . $this->getBaseURL() . '/' . $this->query_string);
1184 Core\Session::init();
1185 Core\Hook::callAll('init_1');
1188 // Exclude the backend processes from the session management
1189 if (!$this->isBackend()) {
1190 $stamp1 = microtime(true);
1192 $this->profiler->saveTimestamp($stamp1, 'parser', Core\System::callstack());
1193 Core\L10n::setSessionVariable();
1194 Core\L10n::setLangFromSession();
1197 Core\Worker::executeIfIdle();
1201 if (!empty($_GET['zrl']) && $this->getMode()->isNormal()) {
1202 $this->query_string = Model\Profile::stripZrls($this->query_string);
1203 if (!local_user()) {
1204 // Only continue when the given profile link seems valid
1205 // Valid profile links contain a path with "/profile/" and no query parameters
1206 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
1207 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
1208 if (defaults($_SESSION, "visitor_home", "") != $_GET["zrl"]) {
1209 $_SESSION['my_url'] = $_GET['zrl'];
1210 $_SESSION['authenticated'] = 0;
1212 Model\Profile::zrlInit($this);
1214 // Someone came with an invalid parameter, maybe as a DDoS attempt
1215 // We simply stop processing here
1216 Core\Logger::log("Invalid ZRL parameter " . $_GET['zrl'], Core\Logger::DEBUG);
1217 Core\System::httpExit(403, ['title' => '403 Forbidden']);
1222 if (!empty($_GET['owt']) && $this->getMode()->isNormal()) {
1223 $token = $_GET['owt'];
1224 $this->query_string = Model\Profile::stripQueryParam($this->query_string, 'owt');
1225 Model\Profile::openWebAuthInit($token);
1228 Module\Login::sessionAuth();
1230 if (empty($_SESSION['authenticated'])) {
1231 header('X-Account-Management-Status: none');
1234 $_SESSION['sysmsg'] = defaults($_SESSION, 'sysmsg' , []);
1235 $_SESSION['sysmsg_info'] = defaults($_SESSION, 'sysmsg_info' , []);
1236 $_SESSION['last_updated'] = defaults($_SESSION, 'last_updated', []);
1239 * check_config() is responsible for running update scripts. These automatically
1240 * update the DB schema whenever we push a new one out. It also checks to see if
1241 * any addons have been added or removed and reacts accordingly.
1244 // in install mode, any url loads install module
1245 // but we need "view" module for stylesheet
1246 if ($this->getMode()->isInstall() && $this->module != 'view') {
1247 $this->module = 'install';
1248 } elseif (!$this->getMode()->has(App\Mode::MAINTENANCEDISABLED) && $this->module != 'view') {
1249 $this->module = 'maintenance';
1252 Core\Update::check($this->basePath, false);
1253 Core\Addon::loadAddons();
1254 Core\Hook::loadHooks();
1265 'right_aside' => '',
1270 if (strlen($this->module)) {
1271 // Compatibility with the Android Diaspora client
1272 if ($this->module == 'stream') {
1273 $this->internalRedirect('network?f=&order=post');
1276 if ($this->module == 'conversations') {
1277 $this->internalRedirect('message');
1280 if ($this->module == 'commented') {
1281 $this->internalRedirect('network?f=&order=comment');
1284 if ($this->module == 'liked') {
1285 $this->internalRedirect('network?f=&order=comment');
1288 if ($this->module == 'activity') {
1289 $this->internalRedirect('network/?f=&conv=1');
1292 if (($this->module == 'status_messages') && ($this->cmd == 'status_messages/new')) {
1293 $this->internalRedirect('bookmarklet');
1296 if (($this->module == 'user') && ($this->cmd == 'user/edit')) {
1297 $this->internalRedirect('settings');
1300 if (($this->module == 'tag_followings') && ($this->cmd == 'tag_followings/manage')) {
1301 $this->internalRedirect('search');
1304 // Compatibility with the Firefox App
1305 if (($this->module == "users") && ($this->cmd == "users/sign_in")) {
1306 $this->module = "login";
1309 $privateapps = Core\Config::get('config', 'private_addons', false);
1310 if (Core\Addon::isEnabled($this->module) && file_exists("addon/{$this->module}/{$this->module}.php")) {
1311 //Check if module is an app and if public access to apps is allowed or not
1312 if ((!local_user()) && Core\Hook::isAddonApp($this->module) && $privateapps) {
1313 info(Core\L10n::t("You must be logged in to use addons. "));
1315 include_once "addon/{$this->module}/{$this->module}.php";
1316 if (function_exists($this->module . '_module')) {
1317 LegacyModule::setModuleFile("addon/{$this->module}/{$this->module}.php");
1318 $this->module_class = 'Friendica\\LegacyModule';
1319 $this->module_loaded = true;
1324 // Controller class routing
1325 if (! $this->module_loaded && class_exists('Friendica\\Module\\' . ucfirst($this->module))) {
1326 $this->module_class = 'Friendica\\Module\\' . ucfirst($this->module);
1327 $this->module_loaded = true;
1330 /* If not, next look for a 'standard' program module in the 'mod' directory
1331 * We emulate a Module class through the LegacyModule class
1333 if (! $this->module_loaded && file_exists("mod/{$this->module}.php")) {
1334 LegacyModule::setModuleFile("mod/{$this->module}.php");
1335 $this->module_class = 'Friendica\\LegacyModule';
1336 $this->module_loaded = true;
1339 /* The URL provided does not resolve to a valid module.
1341 * On Dreamhost sites, quite often things go wrong for no apparent reason and they send us to '/internal_error.html'.
1342 * We don't like doing this, but as it occasionally accounts for 10-20% or more of all site traffic -
1343 * 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
1344 * this will often succeed and eventually do the right thing.
1346 * Otherwise we are going to emit a 404 not found.
1348 if (! $this->module_loaded) {
1349 // Stupid browser tried to pre-fetch our Javascript img template. Don't log the event or return anything - just quietly exit.
1350 if (!empty($_SERVER['QUERY_STRING']) && preg_match('/{[0-9]}/', $_SERVER['QUERY_STRING']) !== 0) {
1354 if (!empty($_SERVER['QUERY_STRING']) && ($_SERVER['QUERY_STRING'] === 'q=internal_error.html') && isset($dreamhost_error_hack)) {
1355 Core\Logger::log('index.php: dreamhost_error_hack invoked. Original URI =' . $_SERVER['REQUEST_URI']);
1356 $this->internalRedirect($_SERVER['REQUEST_URI']);
1359 Core\Logger::log('index.php: page not found: ' . $_SERVER['REQUEST_URI'] . ' ADDRESS: ' . $_SERVER['REMOTE_ADDR'] . ' QUERY: ' . $_SERVER['QUERY_STRING'], Core\Logger::DEBUG);
1361 header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . Core\L10n::t('Not Found'));
1362 $tpl = Core\Renderer::getMarkupTemplate("404.tpl");
1363 $this->page['content'] = Core\Renderer::replaceMacros($tpl, [
1364 '$message' => Core\L10n::t('Page not found.')
1371 // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
1372 if ($this->module_loaded) {
1373 $this->page['page_title'] = $this->module;
1376 Core\Hook::callAll($this->module . '_mod_init', $placeholder);
1378 call_user_func([$this->module_class, 'init']);
1380 // "rawContent" is especially meant for technical endpoints.
1381 // This endpoint doesn't need any theme initialization or other comparable stuff.
1382 if (!$this->error) {
1383 call_user_func([$this->module_class, 'rawContent']);
1387 // Load current theme info after module has been initialized as theme could have been set in module
1388 $theme_info_file = 'view/theme/' . $this->getCurrentTheme() . '/theme.php';
1389 if (file_exists($theme_info_file)) {
1390 require_once $theme_info_file;
1393 if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_init')) {
1394 $func = str_replace('-', '_', $this->getCurrentTheme()) . '_init';
1398 if ($this->module_loaded) {
1399 if (! $this->error && $_SERVER['REQUEST_METHOD'] === 'POST') {
1400 Core\Hook::callAll($this->module . '_mod_post', $_POST);
1401 call_user_func([$this->module_class, 'post']);
1404 if (! $this->error) {
1405 Core\Hook::callAll($this->module . '_mod_afterpost', $placeholder);
1406 call_user_func([$this->module_class, 'afterpost']);
1409 if (! $this->error) {
1410 $arr = ['content' => $content];
1411 Core\Hook::callAll($this->module . '_mod_content', $arr);
1412 $content = $arr['content'];
1413 $arr = ['content' => call_user_func([$this->module_class, 'content'])];
1414 Core\Hook::callAll($this->module . '_mod_aftercontent', $arr);
1415 $content .= $arr['content'];
1419 // initialise content region
1420 if ($this->getMode()->isNormal()) {
1421 Core\Hook::callAll('page_content_top', $this->page['content']);
1424 $this->page['content'] .= $content;
1426 /* Create the page head after setting the language
1427 * and getting any auth credentials.
1429 * Moved initHead() and initFooter() to after
1430 * all the module functions have executed so that all
1431 * theme choices made by the modules can take effect.
1435 /* Build the page ending -- this is stuff that goes right before
1436 * the closing </body> tag
1438 $this->initFooter();
1440 /* now that we've been through the module content, see if the page reported
1441 * a permission problem and if so, a 403 response would seem to be in order.
1443 if (stristr(implode("", $_SESSION['sysmsg']), Core\L10n::t('Permission denied'))) {
1444 header($_SERVER["SERVER_PROTOCOL"] . ' 403 ' . Core\L10n::t('Permission denied.'));
1447 // Report anything which needs to be communicated in the notification area (before the main body)
1448 Core\Hook::callAll('page_end', $this->page['content']);
1450 // Add the navigation (menu) template
1451 if ($this->module != 'install' && $this->module != 'maintenance') {
1452 $this->page['htmlhead'] .= Core\Renderer::replaceMacros(Core\Renderer::getMarkupTemplate('nav_head.tpl'), []);
1453 $this->page['nav'] = Content\Nav::build($this);
1456 // Build the page - now that we have all the components
1457 if (isset($_GET["mode"]) && (($_GET["mode"] == "raw") || ($_GET["mode"] == "minimal"))) {
1458 $doc = new DOMDocument();
1460 $target = new DOMDocument();
1461 $target->loadXML("<root></root>");
1463 $content = mb_convert_encoding($this->page["content"], 'HTML-ENTITIES', "UTF-8");
1465 /// @TODO one day, kill those error-surpressing @ stuff, or PHP should ban it
1466 @$doc->loadHTML($content);
1468 $xpath = new DOMXPath($doc);
1470 $list = $xpath->query("//*[contains(@id,'tread-wrapper-')]"); /* */
1472 foreach ($list as $item) {
1473 $item = $target->importNode($item, true);
1475 // And then append it to the target
1476 $target->documentElement->appendChild($item);
1479 if ($_GET["mode"] == "raw") {
1480 header("Content-type: text/html; charset=utf-8");
1482 echo substr($target->saveHTML(), 6, -8);
1488 $page = $this->page;
1489 $profile = $this->profile;
1491 header("X-Friendica-Version: " . FRIENDICA_VERSION);
1492 header("Content-type: text/html; charset=utf-8");
1494 if (Core\Config::get('system', 'hsts') && (Core\Config::get('system', 'ssl_policy') == SSL_POLICY_FULL)) {
1495 header("Strict-Transport-Security: max-age=31536000");
1498 // Some security stuff
1499 header('X-Content-Type-Options: nosniff');
1500 header('X-XSS-Protection: 1; mode=block');
1501 header('X-Permitted-Cross-Domain-Policies: none');
1502 header('X-Frame-Options: sameorigin');
1504 // Things like embedded OSM maps don't work, when this is enabled
1505 // 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'");
1507 /* We use $_GET["mode"] for special page templates. So we will check if we have
1508 * to load another page template than the default one.
1509 * The page templates are located in /view/php/ or in the theme directory.
1511 if (isset($_GET["mode"])) {
1512 $template = Core\Theme::getPathForFile($_GET["mode"] . '.php');
1515 // If there is no page template use the default page template
1516 if (empty($template)) {
1517 $template = Core\Theme::getPathForFile("default.php");
1520 // Theme templates expect $a as an App instance
1523 // Used as is in view/php/default.php
1524 $lang = Core\L10n::getCurrentLang();
1526 /// @TODO Looks unsafe (remote-inclusion), is maybe not but Core\Theme::getPathForFile() uses file_exists() but does not escape anything
1527 require_once $template;
1531 * Redirects to another module relative to the current Friendica base.
1532 * If you want to redirect to a external URL, use System::externalRedirectTo()
1534 * @param string $toUrl The destination URL (Default is empty, which is the default page of the Friendica node)
1535 * @param bool $ssl if true, base URL will try to get called with https:// (works just for relative paths)
1537 * @throws InternalServerErrorException In Case the given URL is not relative to the Friendica node
1539 public function internalRedirect($toUrl = '', $ssl = false)
1541 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
1542 throw new InternalServerErrorException("'$toUrl is not a relative path, please use System::externalRedirectTo");
1545 $redirectTo = $this->getBaseURL($ssl) . '/' . ltrim($toUrl, '/');
1546 Core\System::externalRedirect($redirectTo);
1550 * Automatically redirects to relative or absolute URL
1551 * Should only be used if it isn't clear if the URL is either internal or external
1553 * @param string $toUrl The target URL
1554 * @throws InternalServerErrorException
1556 public function redirect($toUrl)
1558 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
1559 Core\System::externalRedirect($toUrl);
1561 $this->internalRedirect($toUrl);