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 * Returns the Database of the Application
163 public function getDBA()
165 return $this->database;
169 * @deprecated 2019.09 - use Page->registerStylesheet instead
170 * @see Page::registerStylesheet()
172 public function registerStylesheet($path)
174 $this->page->registerStylesheet($path);
178 * @deprecated 2019.09 - use Page->registerFooterScript instead
179 * @see Page::registerFooterScript()
181 public function registerFooterScript($path)
183 $this->page->registerFooterScript($path);
187 * @param Database $database The Friendica Database
188 * @param Configuration $config The Configuration
189 * @param App\Mode $mode The mode of this Friendica app
190 * @param BaseURL $baseURL The full base URL of this Friendica app
191 * @param LoggerInterface $logger The current app logger
192 * @param Profiler $profiler The profiler of this application
193 * @param L10n $l10n The translator instance
194 * @param App\Arguments $args The Friendica Arguments of the call
195 * @param Core\Process $process The process methods
197 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)
199 $this->database = $database;
200 $this->config = $config;
202 $this->baseURL = $baseURL;
203 $this->profiler = $profiler;
204 $this->logger = $logger;
207 $this->process = $process;
209 $this->cmd = $args->getCommand();
210 $this->argv = $args->getArgv();
211 $this->argc = $args->getArgc();
212 $this->query_string = $args->getQueryString();
213 $this->module = $module->getName();
216 $this->is_mobile = $mode->isMobile();
217 $this->is_tablet = $mode->isTablet();
223 * Load the whole app instance
225 public function load()
229 // This has to be quite large to deal with embedded private photos
230 ini_set('pcre.backtrack_limit', 500000);
233 get_include_path() . PATH_SEPARATOR
234 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
235 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
236 . $this->getBasePath());
238 $this->profiler->reset();
240 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
241 $this->profiler->update($this->config);
243 Core\Hook::loadHooks();
244 $loader = new ConfigFileLoader($this->getBasePath());
245 Core\Hook::callAll('load_config', $loader);
248 $this->loadDefaultTimezone();
249 // Register template engines
250 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
254 * Loads the default timezone
256 * Include support for legacy $default_timezone
258 * @global string $default_timezone
260 private function loadDefaultTimezone()
262 if ($this->config->get('system', 'default_timezone')) {
263 $this->timezone = $this->config->get('system', 'default_timezone');
265 global $default_timezone;
266 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
269 if ($this->timezone) {
270 date_default_timezone_set($this->timezone);
275 * Returns the scheme of the current call
279 * @deprecated 2019.06 - use BaseURL->getScheme() instead
281 public function getScheme()
283 return $this->baseURL->getScheme();
287 * Retrieves the Friendica instance base URL
289 * @param bool $ssl Whether to append http or https under BaseURL::SSL_POLICY_SELFSIGN
291 * @return string Friendica server base URL
293 * @deprecated 2019.09 - use BaseUrl->get($ssl) instead
295 public function getBaseURL($ssl = false)
297 return $this->baseURL->get($ssl);
301 * @brief Initializes the baseurl components
303 * Clears the baseurl cache to prevent inconsistencies
307 * @deprecated 2019.06 - use BaseURL->saveByURL($url) instead
309 public function setBaseURL($url)
311 $this->baseURL->saveByURL($url);
315 * Returns the current hostname
319 * @deprecated 2019.06 - use BaseURL->getHostname() instead
321 public function getHostName()
323 return $this->baseURL->getHostname();
327 * Returns the sub-path of the full URL
331 * @deprecated 2019.06 - use BaseURL->getUrlPath() instead
333 public function getURLPath()
335 return $this->baseURL->getUrlPath();
339 * @brief Removes the base url from an url. This avoids some mixed content problems.
341 * @param string $origURL
343 * @return string The cleaned url
345 * @deprecated 2019.09 - Use BaseURL->remove() instead
346 * @see BaseURL::remove()
348 public function removeBaseURL(string $origURL)
350 return $this->baseURL->remove($origURL);
354 * Returns the current UserAgent as a String
356 * @return string the UserAgent as a String
357 * @throws HTTPException\InternalServerErrorException
359 public function getUserAgent()
362 FRIENDICA_PLATFORM . " '" .
363 FRIENDICA_CODENAME . "' " .
364 FRIENDICA_VERSION . '-' .
365 DB_UPDATE_VERSION . '; ' .
370 * @deprecated 2019.09 - use Core\Process->isMaxProcessesReached() instead
372 public function isMaxProcessesReached()
374 return $this->process->isMaxProcessesReached();
378 * @deprecated 2019.09 - use Core\Process->isMinMemoryReached() instead
380 public function isMinMemoryReached()
382 return $this->process->isMinMemoryReached();
386 * @deprecated 2019.09 - use Core\Process->isMaxLoadReached() instead
388 public function isMaxLoadReached()
390 return $this->process->isMaxLoadReached();
394 * Generates the site's default sender email address
397 * @throws HTTPException\InternalServerErrorException
399 public function getSenderEmailAddress()
401 $sender_email = $this->config->get('config', 'sender_email');
402 if (empty($sender_email)) {
403 $hostname = $this->baseURL->getHostname();
404 if (strpos($hostname, ':')) {
405 $hostname = substr($hostname, 0, strpos($hostname, ':'));
408 $sender_email = 'noreply@' . $hostname;
411 return $sender_email;
415 * Returns the current theme name. May be overriden by the mobile theme name.
420 public function getCurrentTheme()
422 if ($this->mode->isInstall()) {
426 // Specific mobile theme override
427 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
428 $user_mobile_theme = $this->getCurrentMobileTheme();
430 // --- means same mobile theme as desktop
431 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
432 return $user_mobile_theme;
436 if (!$this->currentTheme) {
437 $this->computeCurrentTheme();
440 return $this->currentTheme;
444 * Returns the current mobile theme name.
449 public function getCurrentMobileTheme()
451 if ($this->mode->isInstall()) {
455 if (is_null($this->currentMobileTheme)) {
456 $this->computeCurrentMobileTheme();
459 return $this->currentMobileTheme;
462 public function setCurrentTheme($theme)
464 $this->currentTheme = $theme;
467 public function setCurrentMobileTheme($theme)
469 $this->currentMobileTheme = $theme;
473 * Computes the current theme name based on the node settings, the page owner settings and the user settings
477 private function computeCurrentTheme()
479 $system_theme = $this->config->get('system', 'theme');
480 if (!$system_theme) {
481 throw new Exception($this->l10n->t('No system theme config value set.'));
485 $this->setCurrentTheme($system_theme);
488 // Find the theme that belongs to the user whose stuff we are looking at
489 if ($this->profile_uid && ($this->profile_uid != local_user())) {
490 // Allow folks to override user themes and always use their own on their own site.
491 // This works only if the user is on the same server
492 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
493 if ($this->database->isResult($user) && !Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
494 $page_theme = $user['theme'];
498 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
500 $theme_name = Strings::sanitizeFilePathItem($theme_name);
502 && in_array($theme_name, Theme::getAllowedList())
503 && (file_exists('view/theme/' . $theme_name . '/style.css')
504 || file_exists('view/theme/' . $theme_name . '/style.php'))
506 $this->setCurrentTheme($theme_name);
511 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
513 private function computeCurrentMobileTheme()
515 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
518 $this->setCurrentMobileTheme($system_mobile_theme);
520 $page_mobile_theme = null;
521 // Find the theme that belongs to the user whose stuff we are looking at
522 if ($this->profile_uid && ($this->profile_uid != local_user())) {
523 // Allow folks to override user themes and always use their own on their own site.
524 // This works only if the user is on the same server
525 if (!Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
526 $page_mobile_theme = Core\PConfig::get($this->profile_uid, 'system', 'mobile-theme');
530 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
532 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
533 if ($mobile_theme_name == '---'
535 in_array($mobile_theme_name, Theme::getAllowedList())
536 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
537 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
539 $this->setCurrentMobileTheme($mobile_theme_name);
544 * @brief Return full URL to theme which is currently in effect.
546 * Provide a sane default if nothing is chosen or the specified theme does not exist.
551 public function getCurrentThemeStylesheetPath()
553 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
557 * @deprecated 2019.09 - use App\Mode->isAjax() instead
558 * @see App\Mode::isAjax()
560 public function isAjax()
562 return $this->mode->isAjax();
566 * @deprecated use Arguments->get() instead
570 public function getArgumentValue($position, $default = '')
572 return $this->args->get($position, $default);
576 * Sets the base url for use in cmdline programs which don't have
579 public function checkURL()
581 $url = $this->config->get('system', 'url');
583 // if the url isn't set or the stored url is radically different
584 // than the currently visited url, store the current value accordingly.
585 // "Radically different" ignores common variations such as http vs https
586 // and www.example.com vs example.com.
587 // We will only change the url to an ip address if there is no existing setting
589 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()))) {
590 $this->config->set('system', 'url', $this->getBaseURL());
595 * Frontend App script
597 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
598 * request and a representation of the response.
600 * This probably should change to limit the size of this monster method.
602 * @param App\Module $module The determined module
603 * @param App\Router $router
604 * @param PConfiguration $pconfig
605 * @param Authentication $auth The Authentication backend of the node
606 * @throws HTTPException\InternalServerErrorException
607 * @throws \ImagickException
609 public function runFrontend(App\Module $module, App\Router $router, PConfiguration $pconfig, Authentication $auth)
611 $moduleName = $module->getName();
614 // Missing DB connection: ERROR
615 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
616 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
619 // Max Load Average reached: ERROR
620 if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
621 header('Retry-After: 120');
622 header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
624 throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
627 if (!$this->mode->isInstall()) {
628 // Force SSL redirection
629 if ($this->baseURL->checkRedirectHttps()) {
630 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
633 Core\Hook::callAll('init_1');
636 // Exclude the backend processes from the session management
637 if ($this->mode->isBackend()) {
638 Core\Worker::executeIfIdle();
641 if ($this->mode->isNormal()) {
642 $requester = HTTPSignature::getSigner('', $_SERVER);
643 if (!empty($requester)) {
644 Profile::addVisitorCookieForHandle($requester);
649 if (!empty($_GET['zrl']) && $this->mode->isNormal()) {
651 // Only continue when the given profile link seems valid
652 // Valid profile links contain a path with "/profile/" and no query parameters
653 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
654 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
655 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
656 Core\Session::set('my_url', $_GET['zrl']);
657 Core\Session::set('authenticated', 0);
660 Model\Profile::zrlInit($this);
662 // Someone came with an invalid parameter, maybe as a DDoS attempt
663 // We simply stop processing here
664 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
665 throw new HTTPException\ForbiddenException();
670 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
671 $token = $_GET['owt'];
672 Model\Profile::openWebAuthInit($token);
675 $auth->withSession($this);
677 if (empty($_SESSION['authenticated'])) {
678 header('X-Account-Management-Status: none');
681 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
682 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
683 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
686 * check_config() is responsible for running update scripts. These automatically
687 * update the DB schema whenever we push a new one out. It also checks to see if
688 * any addons have been added or removed and reacts accordingly.
691 // in install mode, any url loads install module
692 // but we need "view" module for stylesheet
693 if ($this->mode->isInstall() && $moduleName !== 'install') {
694 $this->internalRedirect('install');
695 } elseif (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'maintenance') {
696 $this->internalRedirect('maintenance');
699 Core\Update::check($this->getBasePath(), false, $this->mode);
700 Core\Addon::loadAddons();
701 Core\Hook::loadHooks();
704 // Compatibility with the Android Diaspora client
705 if ($moduleName == 'stream') {
706 $this->internalRedirect('network?order=post');
709 if ($moduleName == 'conversations') {
710 $this->internalRedirect('message');
713 if ($moduleName == 'commented') {
714 $this->internalRedirect('network?order=comment');
717 if ($moduleName == 'liked') {
718 $this->internalRedirect('network?order=comment');
721 if ($moduleName == 'activity') {
722 $this->internalRedirect('network?conv=1');
725 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
726 $this->internalRedirect('bookmarklet');
729 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
730 $this->internalRedirect('settings');
733 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
734 $this->internalRedirect('search');
737 // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
738 $this->page['page_title'] = $moduleName;
740 // determine the module class and save it to the module instance
741 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
742 $module = $module->determineClass($this->args, $router, $this->config);
744 // Let the module run it's internal process (init, get, post, ...)
745 $module->run($this->l10n, $this, $this->logger, $_SERVER, $_POST);
746 } catch (HTTPException $e) {
747 ModuleHTTPException::rawContent($e);
750 $this->page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->config, $pconfig);
754 * @deprecated 2019.12 use BaseUrl::redirect instead
755 * @see BaseURL::redirect()
757 public function internalRedirect($toUrl = '', $ssl = false)
759 $this->baseURL->redirect($toUrl, $ssl);
763 * Automatically redirects to relative or absolute URL
764 * Should only be used if it isn't clear if the URL is either internal or external
766 * @param string $toUrl The target URL
768 * @throws HTTPException\InternalServerErrorException
770 public function redirect($toUrl)
772 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
773 Core\System::externalRedirect($toUrl);
775 $this->baseURL->redirect($toUrl);