3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
25 use Friendica\App\Arguments;
26 use Friendica\App\BaseURL;
27 use Friendica\App\Module;
28 use Friendica\Core\Config\Factory\Config;
29 use Friendica\Module\Maintenance;
30 use Friendica\Security\Authentication;
31 use Friendica\Core\Config\ValueObject\Cache;
32 use Friendica\Core\Config\Capability\IManageConfigValues;
33 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
34 use Friendica\Core\L10n;
35 use Friendica\Core\System;
36 use Friendica\Core\Theme;
37 use Friendica\Database\Database;
38 use Friendica\Model\Contact;
39 use Friendica\Model\Profile;
40 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
41 use Friendica\Network\HTTPException;
42 use Friendica\Util\DateTimeFormat;
43 use Friendica\Util\HTTPSignature;
44 use Friendica\Util\Profiler;
45 use Friendica\Util\Strings;
46 use Psr\Log\LoggerInterface;
49 * Our main application structure for the life of this page.
51 * Primarily deals with the URL that got us here
52 * and tries to make some sense of it, and
53 * stores our page contents and config storage
54 * and anything else that might need to be passed around
55 * before we spit the page out.
60 // Allow themes to control internal parameters
61 // by changing App values in theme.php
62 private $theme_info = [
65 'events_in_profile' => true
69 private $nickname = '';
70 private $timezone = '';
71 private $profile_owner = 0;
72 private $contact_id = 0;
76 * @var App\Mode The Mode of the Application
85 /** @var string The name of the current theme */
86 private $currentTheme;
87 /** @var string The name of the current mobile theme */
88 private $currentMobileTheme;
91 * @var IManageConfigValues The config
96 * @var LoggerInterface The logger
101 * @var Profiler The profiler of this app
106 * @var Database The Friendica database connection
111 * @var L10n The translator
121 * @var Core\Process The process methods
126 * @var IManagePersonalConfigValues
133 * @param int $user_id
136 public function setLoggedInUserId(int $user_id)
138 $this->user_id = $user_id;
144 * @param int $user_id
147 public function setLoggedInUserNickname(string $nickname)
149 $this->nickname = $nickname;
152 public function isLoggedIn()
154 return local_user() && $this->user_id && ($this->user_id == local_user());
161 public function getLoggedInUserId()
163 return $this->user_id;
167 * Fetch the user nick name
170 public function getLoggedInUserNickname()
172 return $this->nickname;
176 * Set the profile owner ID
178 * @param int $owner_id
181 public function setProfileOwner(int $owner_id)
183 $this->profile_owner = $owner_id;
187 * Get the profile owner ID
191 public function getProfileOwner():int
193 return $this->profile_owner;
199 * @param int $contact_id
202 public function setContactId(int $contact_id)
204 $this->contact_id = $contact_id;
212 public function getContactId():int
214 return $this->contact_id;
220 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
223 public function setTimeZone(string $timezone)
225 $this->timezone = (new \DateTimeZone($timezone))->getName();
226 DateTimeFormat::setLocalTimeZone($this->timezone);
234 public function getTimeZone():string
236 return $this->timezone;
240 * Set workerqueue information
242 * @param array $queue
245 public function setQueue(array $queue)
247 $this->queue = $queue;
251 * Fetch workerqueue information
255 public function getQueue()
257 return $this->queue ?? [];
261 * Fetch a specific workerqueue field
263 * @param string $index
266 public function getQueueValue(string $index)
268 return $this->queue[$index] ?? null;
271 public function setThemeInfoValue(string $index, $value)
273 $this->theme_info[$index] = $value;
276 public function getThemeInfo()
278 return $this->theme_info;
281 public function getThemeInfoValue(string $index, $default = null)
283 return $this->theme_info[$index] ?? $default;
287 * Returns the current config cache of this node
291 public function getConfigCache()
293 return $this->config->getCache();
297 * The basepath of this app
301 public function getBasePath()
303 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
304 return $this->config->getCache()->get('system', 'basepath');
308 * @param Database $database The Friendica Database
309 * @param IManageConfigValues $config The Configuration
310 * @param App\Mode $mode The mode of this Friendica app
311 * @param BaseURL $baseURL The full base URL of this Friendica app
312 * @param LoggerInterface $logger The current app logger
313 * @param Profiler $profiler The profiler of this application
314 * @param L10n $l10n The translator instance
315 * @param App\Arguments $args The Friendica Arguments of the call
316 * @param Core\Process $process The process methods
317 * @param IManagePersonalConfigValues $pConfig Personal configuration
319 public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, Core\Process $process, IManagePersonalConfigValues $pConfig)
321 $this->database = $database;
322 $this->config = $config;
324 $this->baseURL = $baseURL;
325 $this->profiler = $profiler;
326 $this->logger = $logger;
329 $this->process = $process;
330 $this->pConfig = $pConfig;
336 * Load the whole app instance
338 public function load()
342 // Ensure that all "strtotime" operations do run timezone independent
343 date_default_timezone_set('UTC');
345 // This has to be quite large to deal with embedded private photos
346 ini_set('pcre.backtrack_limit', 500000);
349 get_include_path() . PATH_SEPARATOR
350 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
351 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
352 . $this->getBasePath());
354 $this->profiler->reset();
356 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
357 $this->profiler->update($this->config);
359 Core\Hook::loadHooks();
360 $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
361 Core\Hook::callAll('load_config', $loader);
364 $this->loadDefaultTimezone();
365 // Register template engines
366 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
370 * Loads the default timezone
372 * Include support for legacy $default_timezone
374 * @global string $default_timezone
376 private function loadDefaultTimezone()
378 if ($this->config->get('system', 'default_timezone')) {
379 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
381 global $default_timezone;
382 $timezone = $default_timezone ?? '' ?: 'UTC';
385 $this->setTimeZone($timezone);
389 * Returns the current theme name. May be overriden by the mobile theme name.
394 public function getCurrentTheme()
396 if ($this->mode->isInstall()) {
400 // Specific mobile theme override
401 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
402 $user_mobile_theme = $this->getCurrentMobileTheme();
404 // --- means same mobile theme as desktop
405 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
406 return $user_mobile_theme;
410 if (!$this->currentTheme) {
411 $this->computeCurrentTheme();
414 return $this->currentTheme;
418 * Returns the current mobile theme name.
423 public function getCurrentMobileTheme()
425 if ($this->mode->isInstall()) {
429 if (is_null($this->currentMobileTheme)) {
430 $this->computeCurrentMobileTheme();
433 return $this->currentMobileTheme;
436 public function setCurrentTheme($theme)
438 $this->currentTheme = $theme;
441 public function setCurrentMobileTheme($theme)
443 $this->currentMobileTheme = $theme;
447 * Computes the current theme name based on the node settings, the page owner settings and the user settings
451 private function computeCurrentTheme()
453 $system_theme = $this->config->get('system', 'theme');
454 if (!$system_theme) {
455 throw new Exception($this->l10n->t('No system theme config value set.'));
459 $this->setCurrentTheme($system_theme);
462 // Find the theme that belongs to the user whose stuff we are looking at
463 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
464 // Allow folks to override user themes and always use their own on their own site.
465 // This works only if the user is on the same server
466 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
467 if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
468 $page_theme = $user['theme'];
472 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
474 $theme_name = Strings::sanitizeFilePathItem($theme_name);
476 && in_array($theme_name, Theme::getAllowedList())
477 && (file_exists('view/theme/' . $theme_name . '/style.css')
478 || file_exists('view/theme/' . $theme_name . '/style.php'))
480 $this->setCurrentTheme($theme_name);
485 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
487 private function computeCurrentMobileTheme()
489 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
492 $this->setCurrentMobileTheme($system_mobile_theme);
494 $page_mobile_theme = null;
495 // Find the theme that belongs to the user whose stuff we are looking at
496 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
497 // Allow folks to override user themes and always use their own on their own site.
498 // This works only if the user is on the same server
499 if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
500 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
504 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
506 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
507 if ($mobile_theme_name == '---'
509 in_array($mobile_theme_name, Theme::getAllowedList())
510 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
511 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
513 $this->setCurrentMobileTheme($mobile_theme_name);
518 * Provide a sane default if nothing is chosen or the specified theme does not exist.
523 public function getCurrentThemeStylesheetPath()
525 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
529 * Sets the base url for use in cmdline programs which don't have
532 public function checkURL()
534 $url = $this->config->get('system', 'url');
536 // if the url isn't set or the stored url is radically different
537 // than the currently visited url, store the current value accordingly.
538 // "Radically different" ignores common variations such as http vs https
539 // and www.example.com vs example.com.
540 // We will only change the url to an ip address if there is no existing setting
542 if (empty($url) || (!Util\Strings::compareLink($url, $this->baseURL->get())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $this->baseURL->getHostname()))) {
543 $this->config->set('system', 'url', $this->baseURL->get());
548 * Frontend App script
550 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
551 * request and a representation of the response.
553 * This probably should change to limit the size of this monster method.
555 * @param App\Module $module The determined module
556 * @param App\Router $router
557 * @param IManagePersonalConfigValues $pconfig
558 * @param Authentication $auth The Authentication backend of the node
559 * @param App\Page $page The Friendica page printing container
561 * @throws HTTPException\InternalServerErrorException
562 * @throws \ImagickException
564 public function runFrontend(App\Module $module, App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, float $start_time)
566 $this->profiler->set($start_time, 'start');
567 $this->profiler->set(microtime(true), 'classinit');
569 $moduleName = $module->getName();
572 // Missing DB connection: ERROR
573 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
574 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
577 // Max Load Average reached: ERROR
578 if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
579 header('Retry-After: 120');
580 header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
582 throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
585 if (!$this->mode->isInstall()) {
586 // Force SSL redirection
587 if ($this->baseURL->checkRedirectHttps()) {
588 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
591 Core\Hook::callAll('init_1');
594 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
595 $requester = HTTPSignature::getSigner('', $_SERVER);
596 if (!empty($requester)) {
597 Profile::addVisitorCookieForHandle($requester);
602 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend()) {
604 // Only continue when the given profile link seems valid
605 // Valid profile links contain a path with "/profile/" and no query parameters
606 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
607 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
608 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
609 Core\Session::set('my_url', $_GET['zrl']);
610 Core\Session::set('authenticated', 0);
612 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
613 if (!empty($remote_contact['subscribe'])) {
614 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
618 Model\Profile::zrlInit($this);
620 // Someone came with an invalid parameter, maybe as a DDoS attempt
621 // We simply stop processing here
622 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
623 throw new HTTPException\ForbiddenException();
628 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
629 $token = $_GET['owt'];
630 Model\Profile::openWebAuthInit($token);
633 if (!$this->mode->isBackend()) {
634 $auth->withSession($this);
637 if (empty($_SESSION['authenticated'])) {
638 header('X-Account-Management-Status: none');
641 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
642 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
643 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
646 * check_config() is responsible for running update scripts. These automatically
647 * update the DB schema whenever we push a new one out. It also checks to see if
648 * any addons have been added or removed and reacts accordingly.
651 // in install mode, any url loads install module
652 // but we need "view" module for stylesheet
653 if ($this->mode->isInstall() && $moduleName !== 'install') {
654 $this->baseURL->redirect('install');
657 Core\Update::check($this->getBasePath(), false, $this->mode);
658 Core\Addon::loadAddons();
659 Core\Hook::loadHooks();
662 // Compatibility with the Android Diaspora client
663 if ($moduleName == 'stream') {
664 $this->baseURL->redirect('network?order=post');
667 if ($moduleName == 'conversations') {
668 $this->baseURL->redirect('message');
671 if ($moduleName == 'commented') {
672 $this->baseURL->redirect('network?order=comment');
675 if ($moduleName == 'liked') {
676 $this->baseURL->redirect('network?order=comment');
679 if ($moduleName == 'activity') {
680 $this->baseURL->redirect('network?conv=1');
683 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
684 $this->baseURL->redirect('bookmarklet');
687 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
688 $this->baseURL->redirect('settings');
691 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
692 $this->baseURL->redirect('search');
695 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
696 $page['page_title'] = $moduleName;
698 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
699 $module = new Module('maintenance', Maintenance::class);
701 // determine the module class and save it to the module instance
702 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
703 $module = $module->determineClass($this->args, $router, $this->config);
706 // Let the module run it's internal process (init, get, post, ...)
707 $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
708 } catch (HTTPException $e) {
709 ModuleHTTPException::rawContent($e);
712 $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
716 * Automatically redirects to relative or absolute URL
717 * Should only be used if it isn't clear if the URL is either internal or external
719 * @param string $toUrl The target URL
721 * @throws HTTPException\InternalServerErrorException
723 public function redirect($toUrl)
725 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
726 Core\System::externalRedirect($toUrl);
728 $this->baseURL->redirect($toUrl);