8 use Friendica\App\Arguments;
9 use Friendica\App\BaseURL;
10 use Friendica\App\Page;
11 use Friendica\App\Authentication;
12 use Friendica\Core\Config\Cache\ConfigCache;
13 use Friendica\Core\Config\Configuration;
14 use Friendica\Core\Config\PConfiguration;
15 use Friendica\Core\L10n\L10n;
16 use Friendica\Core\Session;
17 use Friendica\Core\System;
18 use Friendica\Core\Theme;
19 use Friendica\Database\Database;
20 use Friendica\Model\Profile;
21 use Friendica\Module\Security\Login;
22 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
23 use Friendica\Network\HTTPException;
24 use Friendica\Util\ConfigFileLoader;
25 use Friendica\Util\HTTPSignature;
26 use Friendica\Util\Profiler;
27 use Friendica\Util\Strings;
28 use Psr\Log\LoggerInterface;
34 * @brief Our main application structure for the life of this page.
36 * Primarily deals with the URL that got us here
37 * and tries to make some sense of it, and
38 * stores our page contents and config storage
39 * and anything else that might need to be passed around
40 * before we spit the page out.
45 /** @deprecated 2019.09 - use App\Arguments->getQueryString() */
48 * @var Page The current page environment
60 /** @deprecated 2019.09 - use App\Arguments->getCommand() */
62 /** @deprecated 2019.09 - use App\Arguments->getArgv() or Arguments->get() */
64 /** @deprecated 2019.09 - use App\Arguments->getArgc() */
66 /** @deprecated 2019.09 - Use App\Module->getName() instead */
69 public $interactive = true;
71 /** @deprecated 2019.09 - Use App\Mode->isMobile() instead */
73 /** @deprecated 2019.09 - Use App\Mode->isTable() instead */
75 public $theme_info = [];
77 // Allow themes to control internal parameters
78 // by changing App values in theme.php
80 public $sourcename = '';
81 public $videowidth = 425;
82 public $videoheight = 350;
83 public $force_max_items = 0;
84 public $theme_events_in_profile = true;
88 * @var App\Mode The Mode of the Application
97 /** @var string The name of the current theme */
98 private $currentTheme;
99 /** @var string The name of the current mobile theme */
100 private $currentMobileTheme;
103 * @var Configuration The config
108 * @var LoggerInterface The logger
113 * @var Profiler The profiler of this app
118 * @var Database The Friendica database connection
123 * @var L10n The translator
133 * @var Core\Process The process methods
138 * Returns the current config cache of this node
140 * @return ConfigCache
142 public function getConfigCache()
144 return $this->config->getCache();
148 * The basepath of this app
152 public function getBasePath()
154 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
155 return $this->config->getCache()->get('system', 'basepath');
159 * The profiler of this app
163 public function getProfiler()
165 return $this->profiler;
169 * Returns the Mode of the Application
171 * @return App\Mode The Application Mode
173 public function getMode()
179 * Returns the Database of the Application
183 public function getDBA()
185 return $this->database;
189 * @deprecated 2019.09 - use Page->registerStylesheet instead
190 * @see Page::registerStylesheet()
192 public function registerStylesheet($path)
194 $this->page->registerStylesheet($path);
198 * @deprecated 2019.09 - use Page->registerFooterScript instead
199 * @see Page::registerFooterScript()
201 public function registerFooterScript($path)
203 $this->page->registerFooterScript($path);
207 * @param Database $database The Friendica Database
208 * @param Configuration $config The Configuration
209 * @param App\Mode $mode The mode of this Friendica app
210 * @param BaseURL $baseURL The full base URL of this Friendica app
211 * @param LoggerInterface $logger The current app logger
212 * @param Profiler $profiler The profiler of this application
213 * @param L10n $l10n The translator instance
214 * @param App\Arguments $args The Friendica Arguments of the call
215 * @param Core\Process $process The process methods
217 public function __construct(Database $database, Configuration $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, App\Module $module, App\Page $page, Core\Process $process)
219 $this->database = $database;
220 $this->config = $config;
222 $this->baseURL = $baseURL;
223 $this->profiler = $profiler;
224 $this->logger = $logger;
227 $this->process = $process;
229 $this->cmd = $args->getCommand();
230 $this->argv = $args->getArgv();
231 $this->argc = $args->getArgc();
232 $this->query_string = $args->getQueryString();
233 $this->module = $module->getName();
236 $this->is_mobile = $mode->isMobile();
237 $this->is_tablet = $mode->isTablet();
243 * Load the whole app instance
245 public function load()
249 // This has to be quite large to deal with embedded private photos
250 ini_set('pcre.backtrack_limit', 500000);
253 get_include_path() . PATH_SEPARATOR
254 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
255 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
256 . $this->getBasePath());
258 $this->profiler->reset();
260 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
261 $this->profiler->update($this->config);
263 Core\Hook::loadHooks();
264 $loader = new ConfigFileLoader($this->getBasePath());
265 Core\Hook::callAll('load_config', $loader);
268 $this->loadDefaultTimezone();
269 // Register template engines
270 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
274 * Loads the default timezone
276 * Include support for legacy $default_timezone
278 * @global string $default_timezone
280 private function loadDefaultTimezone()
282 if ($this->config->get('system', 'default_timezone')) {
283 $this->timezone = $this->config->get('system', 'default_timezone');
285 global $default_timezone;
286 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
289 if ($this->timezone) {
290 date_default_timezone_set($this->timezone);
295 * Returns the scheme of the current call
299 * @deprecated 2019.06 - use BaseURL->getScheme() instead
301 public function getScheme()
303 return $this->baseURL->getScheme();
307 * Retrieves the Friendica instance base URL
309 * @param bool $ssl Whether to append http or https under BaseURL::SSL_POLICY_SELFSIGN
311 * @return string Friendica server base URL
313 * @deprecated 2019.09 - use BaseUrl->get($ssl) instead
315 public function getBaseURL($ssl = false)
317 return $this->baseURL->get($ssl);
321 * @brief Initializes the baseurl components
323 * Clears the baseurl cache to prevent inconsistencies
327 * @deprecated 2019.06 - use BaseURL->saveByURL($url) instead
329 public function setBaseURL($url)
331 $this->baseURL->saveByURL($url);
335 * Returns the current hostname
339 * @deprecated 2019.06 - use BaseURL->getHostname() instead
341 public function getHostName()
343 return $this->baseURL->getHostname();
347 * Returns the sub-path of the full URL
351 * @deprecated 2019.06 - use BaseURL->getUrlPath() instead
353 public function getURLPath()
355 return $this->baseURL->getUrlPath();
359 * @brief Removes the base url from an url. This avoids some mixed content problems.
361 * @param string $origURL
363 * @return string The cleaned url
365 * @deprecated 2019.09 - Use BaseURL->remove() instead
366 * @see BaseURL::remove()
368 public function removeBaseURL(string $origURL)
370 return $this->baseURL->remove($origURL);
374 * Returns the current UserAgent as a String
376 * @return string the UserAgent as a String
377 * @throws HTTPException\InternalServerErrorException
379 public function getUserAgent()
382 FRIENDICA_PLATFORM . " '" .
383 FRIENDICA_CODENAME . "' " .
384 FRIENDICA_VERSION . '-' .
385 DB_UPDATE_VERSION . '; ' .
390 * @deprecated 2019.09 - use Core\Process->isMaxProcessesReached() instead
392 public function isMaxProcessesReached()
394 return $this->process->isMaxProcessesReached();
398 * @deprecated 2019.09 - use Core\Process->isMinMemoryReached() instead
400 public function isMinMemoryReached()
402 return $this->process->isMinMemoryReached();
406 * @deprecated 2019.09 - use Core\Process->isMaxLoadReached() instead
408 public function isMaxLoadReached()
410 return $this->process->isMaxLoadReached();
414 * Generates the site's default sender email address
417 * @throws HTTPException\InternalServerErrorException
419 public function getSenderEmailAddress()
421 $sender_email = $this->config->get('config', 'sender_email');
422 if (empty($sender_email)) {
423 $hostname = $this->baseURL->getHostname();
424 if (strpos($hostname, ':')) {
425 $hostname = substr($hostname, 0, strpos($hostname, ':'));
428 $sender_email = 'noreply@' . $hostname;
431 return $sender_email;
435 * Returns the current theme name. May be overriden by the mobile theme name.
440 public function getCurrentTheme()
442 if ($this->mode->isInstall()) {
446 // Specific mobile theme override
447 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
448 $user_mobile_theme = $this->getCurrentMobileTheme();
450 // --- means same mobile theme as desktop
451 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
452 return $user_mobile_theme;
456 if (!$this->currentTheme) {
457 $this->computeCurrentTheme();
460 return $this->currentTheme;
464 * Returns the current mobile theme name.
469 public function getCurrentMobileTheme()
471 if ($this->mode->isInstall()) {
475 if (is_null($this->currentMobileTheme)) {
476 $this->computeCurrentMobileTheme();
479 return $this->currentMobileTheme;
482 public function setCurrentTheme($theme)
484 $this->currentTheme = $theme;
487 public function setCurrentMobileTheme($theme)
489 $this->currentMobileTheme = $theme;
493 * Computes the current theme name based on the node settings, the page owner settings and the user settings
497 private function computeCurrentTheme()
499 $system_theme = $this->config->get('system', 'theme');
500 if (!$system_theme) {
501 throw new Exception($this->l10n->t('No system theme config value set.'));
505 $this->setCurrentTheme($system_theme);
508 // Find the theme that belongs to the user whose stuff we are looking at
509 if ($this->profile_uid && ($this->profile_uid != local_user())) {
510 // Allow folks to override user themes and always use their own on their own site.
511 // This works only if the user is on the same server
512 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
513 if ($this->database->isResult($user) && !Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
514 $page_theme = $user['theme'];
518 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
520 $theme_name = Strings::sanitizeFilePathItem($theme_name);
522 && in_array($theme_name, Theme::getAllowedList())
523 && (file_exists('view/theme/' . $theme_name . '/style.css')
524 || file_exists('view/theme/' . $theme_name . '/style.php'))
526 $this->setCurrentTheme($theme_name);
531 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
533 private function computeCurrentMobileTheme()
535 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
538 $this->setCurrentMobileTheme($system_mobile_theme);
540 $page_mobile_theme = null;
541 // Find the theme that belongs to the user whose stuff we are looking at
542 if ($this->profile_uid && ($this->profile_uid != local_user())) {
543 // Allow folks to override user themes and always use their own on their own site.
544 // This works only if the user is on the same server
545 if (!Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
546 $page_mobile_theme = Core\PConfig::get($this->profile_uid, 'system', 'mobile-theme');
550 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
552 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
553 if ($mobile_theme_name == '---'
555 in_array($mobile_theme_name, Theme::getAllowedList())
556 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
557 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
559 $this->setCurrentMobileTheme($mobile_theme_name);
564 * @brief Return full URL to theme which is currently in effect.
566 * Provide a sane default if nothing is chosen or the specified theme does not exist.
571 public function getCurrentThemeStylesheetPath()
573 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
577 * @deprecated 2019.09 - use App\Mode->isAjax() instead
578 * @see App\Mode::isAjax()
580 public function isAjax()
582 return $this->mode->isAjax();
586 * @deprecated use Arguments->get() instead
590 public function getArgumentValue($position, $default = '')
592 return $this->args->get($position, $default);
596 * Sets the base url for use in cmdline programs which don't have
599 public function checkURL()
601 $url = $this->config->get('system', 'url');
603 // if the url isn't set or the stored url is radically different
604 // than the currently visited url, store the current value accordingly.
605 // "Radically different" ignores common variations such as http vs https
606 // and www.example.com vs example.com.
607 // We will only change the url to an ip address if there is no existing setting
609 if (empty($url) || (!Util\Strings::compareLink($url, $this->getBaseURL())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $this->baseURL->getHostname()))) {
610 $this->config->set('system', 'url', $this->getBaseURL());
615 * Frontend App script
617 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
618 * request and a representation of the response.
620 * This probably should change to limit the size of this monster method.
622 * @param App\Module $module The determined module
623 * @param App\Router $router
624 * @param PConfiguration $pconfig
625 * @param Authentication $auth The Authentication backend of the node
626 * @throws HTTPException\InternalServerErrorException
627 * @throws \ImagickException
629 public function runFrontend(App\Module $module, App\Router $router, PConfiguration $pconfig, Authentication $auth)
631 $moduleName = $module->getName();
634 // Missing DB connection: ERROR
635 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
636 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
639 // Max Load Average reached: ERROR
640 if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
641 header('Retry-After: 120');
642 header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
644 throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
647 if (!$this->mode->isInstall()) {
648 // Force SSL redirection
649 if ($this->baseURL->checkRedirectHttps()) {
650 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
653 Core\Hook::callAll('init_1');
656 // Exclude the backend processes from the session management
657 if ($this->mode->isBackend()) {
658 Core\Worker::executeIfIdle();
661 if ($this->mode->isNormal()) {
662 $requester = HTTPSignature::getSigner('', $_SERVER);
663 if (!empty($requester)) {
664 Profile::addVisitorCookieForHandle($requester);
669 if (!empty($_GET['zrl']) && $this->mode->isNormal()) {
671 // Only continue when the given profile link seems valid
672 // Valid profile links contain a path with "/profile/" and no query parameters
673 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
674 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
675 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
676 Core\Session::set('my_url', $_GET['zrl']);
677 Core\Session::set('authenticated', 0);
680 Model\Profile::zrlInit($this);
682 // Someone came with an invalid parameter, maybe as a DDoS attempt
683 // We simply stop processing here
684 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
685 throw new HTTPException\ForbiddenException();
690 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
691 $token = $_GET['owt'];
692 Model\Profile::openWebAuthInit($token);
695 $auth->withSession($this);
697 if (empty($_SESSION['authenticated'])) {
698 header('X-Account-Management-Status: none');
701 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
702 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
703 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
706 * check_config() is responsible for running update scripts. These automatically
707 * update the DB schema whenever we push a new one out. It also checks to see if
708 * any addons have been added or removed and reacts accordingly.
711 // in install mode, any url loads install module
712 // but we need "view" module for stylesheet
713 if ($this->mode->isInstall() && $moduleName !== 'install') {
714 $this->internalRedirect('install');
715 } elseif (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'maintenance') {
716 $this->internalRedirect('maintenance');
719 Core\Update::check($this->getBasePath(), false, $this->mode);
720 Core\Addon::loadAddons();
721 Core\Hook::loadHooks();
724 // Compatibility with the Android Diaspora client
725 if ($moduleName == 'stream') {
726 $this->internalRedirect('network?order=post');
729 if ($moduleName == 'conversations') {
730 $this->internalRedirect('message');
733 if ($moduleName == 'commented') {
734 $this->internalRedirect('network?order=comment');
737 if ($moduleName == 'liked') {
738 $this->internalRedirect('network?order=comment');
741 if ($moduleName == 'activity') {
742 $this->internalRedirect('network?conv=1');
745 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
746 $this->internalRedirect('bookmarklet');
749 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
750 $this->internalRedirect('settings');
753 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
754 $this->internalRedirect('search');
757 // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
758 $this->page['page_title'] = $moduleName;
760 // determine the module class and save it to the module instance
761 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
762 $module = $module->determineClass($this->args, $router, $this->config);
764 // Let the module run it's internal process (init, get, post, ...)
765 $module->run($this->l10n, $this, $this->logger, $_SERVER, $_POST);
766 } catch (HTTPException $e) {
767 ModuleHTTPException::rawContent($e);
770 $this->page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->config, $pconfig);
774 * @deprecated 2019.12 use BaseUrl::redirect instead
775 * @see BaseURL::redirect()
777 public function internalRedirect($toUrl = '', $ssl = false)
779 $this->baseURL->redirect($toUrl, $ssl);
783 * Automatically redirects to relative or absolute URL
784 * Should only be used if it isn't clear if the URL is either internal or external
786 * @param string $toUrl The target URL
788 * @throws HTTPException\InternalServerErrorException
790 public function redirect($toUrl)
792 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
793 Core\System::externalRedirect($toUrl);
795 $this->baseURL->redirect($toUrl);