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\Factory\ConfigFactory;
29 use Friendica\Module\Maintenance;
30 use Friendica\Security\Authentication;
31 use Friendica\Core\Config\Cache;
32 use Friendica\Core\Config\IConfig;
33 use Friendica\Core\PConfig\IPConfig;
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\ConfigFileLoader;
43 use Friendica\Util\DateTimeFormat;
44 use Friendica\Util\HTTPSignature;
45 use Friendica\Util\Profiler;
46 use Friendica\Util\Strings;
47 use Psr\Log\LoggerInterface;
50 * Our main application structure for the life of this page.
52 * Primarily deals with the URL that got us here
53 * and tries to make some sense of it, and
54 * stores our page contents and config storage
55 * and anything else that might need to be passed around
56 * before we spit the page out.
61 // Allow themes to control internal parameters
62 // by changing App values in theme.php
63 private $theme_info = [
66 'events_in_profile' => true
70 private $nickname = '';
71 private $timezone = '';
72 private $profile_owner = 0;
73 private $contact_id = 0;
77 * @var App\Mode The Mode of the Application
86 /** @var string The name of the current theme */
87 private $currentTheme;
88 /** @var string The name of the current mobile theme */
89 private $currentMobileTheme;
92 * @var IConfig The config
97 * @var LoggerInterface The logger
102 * @var Profiler The profiler of this app
107 * @var Database The Friendica database connection
112 * @var L10n The translator
122 * @var Core\Process The process methods
134 * @param int $user_id
137 public function setLoggedInUserId(int $user_id)
139 $this->user_id = $user_id;
145 * @param int $user_id
148 public function setLoggedInUserNickname(string $nickname)
150 $this->nickname = $nickname;
153 public function isLoggedIn()
155 return local_user() && $this->user_id && ($this->user_id == local_user());
162 public function getLoggedInUserId()
164 return $this->user_id;
168 * Fetch the user nick name
171 public function getLoggedInUserNickname()
173 return $this->nickname;
177 * Set the profile owner ID
179 * @param int $owner_id
182 public function setProfileOwner(int $owner_id)
184 $this->profile_owner = $owner_id;
188 * Get the profile owner ID
192 public function getProfileOwner():int
194 return $this->profile_owner;
200 * @param int $contact_id
203 public function setContactId(int $contact_id)
205 $this->contact_id = $contact_id;
213 public function getContactId():int
215 return $this->contact_id;
221 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
224 public function setTimeZone(string $timezone)
226 $this->timezone = (new \DateTimeZone($timezone))->getName();
227 DateTimeFormat::setLocalTimeZone($this->timezone);
235 public function getTimeZone():string
237 return $this->timezone;
241 * Set workerqueue information
243 * @param array $queue
246 public function setQueue(array $queue)
248 $this->queue = $queue;
252 * Fetch workerqueue information
256 public function getQueue()
258 return $this->queue ?? [];
262 * Fetch a specific workerqueue field
264 * @param string $index
267 public function getQueueValue(string $index)
269 return $this->queue[$index] ?? null;
272 public function setThemeInfoValue(string $index, $value)
274 $this->theme_info[$index] = $value;
277 public function getThemeInfo()
279 return $this->theme_info;
282 public function getThemeInfoValue(string $index, $default = null)
284 return $this->theme_info[$index] ?? $default;
288 * Returns the current config cache of this node
292 public function getConfigCache()
294 return $this->config->getCache();
298 * The basepath of this app
302 public function getBasePath()
304 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
305 return $this->config->getCache()->get('system', 'basepath');
309 * @param Database $database The Friendica Database
310 * @param IConfig $config The Configuration
311 * @param App\Mode $mode The mode of this Friendica app
312 * @param BaseURL $baseURL The full base URL of this Friendica app
313 * @param LoggerInterface $logger The current app logger
314 * @param Profiler $profiler The profiler of this application
315 * @param L10n $l10n The translator instance
316 * @param App\Arguments $args The Friendica Arguments of the call
317 * @param Core\Process $process The process methods
318 * @param IPConfig $pConfig Personal configuration
320 public function __construct(Database $database, IConfig $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, Core\Process $process, IPConfig $pConfig)
322 $this->database = $database;
323 $this->config = $config;
325 $this->baseURL = $baseURL;
326 $this->profiler = $profiler;
327 $this->logger = $logger;
330 $this->process = $process;
331 $this->pConfig = $pConfig;
337 * Load the whole app instance
339 public function load()
343 // Ensure that all "strtotime" operations do run timezone independent
344 date_default_timezone_set('UTC');
346 // This has to be quite large to deal with embedded private photos
347 ini_set('pcre.backtrack_limit', 500000);
350 get_include_path() . PATH_SEPARATOR
351 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
352 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
353 . $this->getBasePath());
355 $this->profiler->reset();
357 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
358 $this->profiler->update($this->config);
360 Core\Hook::loadHooks();
361 $loader = (new ConfigFactory())->createConfigFileLoader($this->getBasePath(), $_SERVER);
362 Core\Hook::callAll('load_config', $loader);
365 $this->loadDefaultTimezone();
366 // Register template engines
367 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
371 * Loads the default timezone
373 * Include support for legacy $default_timezone
375 * @global string $default_timezone
377 private function loadDefaultTimezone()
379 if ($this->config->get('system', 'default_timezone')) {
380 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
382 global $default_timezone;
383 $timezone = $default_timezone ?? '' ?: 'UTC';
386 $this->setTimeZone($timezone);
390 * Returns the current theme name. May be overriden by the mobile theme name.
395 public function getCurrentTheme()
397 if ($this->mode->isInstall()) {
401 // Specific mobile theme override
402 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
403 $user_mobile_theme = $this->getCurrentMobileTheme();
405 // --- means same mobile theme as desktop
406 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
407 return $user_mobile_theme;
411 if (!$this->currentTheme) {
412 $this->computeCurrentTheme();
415 return $this->currentTheme;
419 * Returns the current mobile theme name.
424 public function getCurrentMobileTheme()
426 if ($this->mode->isInstall()) {
430 if (is_null($this->currentMobileTheme)) {
431 $this->computeCurrentMobileTheme();
434 return $this->currentMobileTheme;
437 public function setCurrentTheme($theme)
439 $this->currentTheme = $theme;
442 public function setCurrentMobileTheme($theme)
444 $this->currentMobileTheme = $theme;
448 * Computes the current theme name based on the node settings, the page owner settings and the user settings
452 private function computeCurrentTheme()
454 $system_theme = $this->config->get('system', 'theme');
455 if (!$system_theme) {
456 throw new Exception($this->l10n->t('No system theme config value set.'));
460 $this->setCurrentTheme($system_theme);
463 // Find the theme that belongs to the user whose stuff we are looking at
464 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
465 // Allow folks to override user themes and always use their own on their own site.
466 // This works only if the user is on the same server
467 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
468 if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
469 $page_theme = $user['theme'];
473 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
475 $theme_name = Strings::sanitizeFilePathItem($theme_name);
477 && in_array($theme_name, Theme::getAllowedList())
478 && (file_exists('view/theme/' . $theme_name . '/style.css')
479 || file_exists('view/theme/' . $theme_name . '/style.php'))
481 $this->setCurrentTheme($theme_name);
486 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
488 private function computeCurrentMobileTheme()
490 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
493 $this->setCurrentMobileTheme($system_mobile_theme);
495 $page_mobile_theme = null;
496 // Find the theme that belongs to the user whose stuff we are looking at
497 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
498 // Allow folks to override user themes and always use their own on their own site.
499 // This works only if the user is on the same server
500 if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
501 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
505 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
507 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
508 if ($mobile_theme_name == '---'
510 in_array($mobile_theme_name, Theme::getAllowedList())
511 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
512 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
514 $this->setCurrentMobileTheme($mobile_theme_name);
519 * Provide a sane default if nothing is chosen or the specified theme does not exist.
524 public function getCurrentThemeStylesheetPath()
526 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
530 * Sets the base url for use in cmdline programs which don't have
533 public function checkURL()
535 $url = $this->config->get('system', 'url');
537 // if the url isn't set or the stored url is radically different
538 // than the currently visited url, store the current value accordingly.
539 // "Radically different" ignores common variations such as http vs https
540 // and www.example.com vs example.com.
541 // We will only change the url to an ip address if there is no existing setting
543 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()))) {
544 $this->config->set('system', 'url', $this->baseURL->get());
549 * Frontend App script
551 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
552 * request and a representation of the response.
554 * This probably should change to limit the size of this monster method.
556 * @param App\Module $module The determined module
557 * @param App\Router $router
558 * @param IPConfig $pconfig
559 * @param Authentication $auth The Authentication backend of the node
560 * @param App\Page $page The Friendica page printing container
562 * @throws HTTPException\InternalServerErrorException
563 * @throws \ImagickException
565 public function runFrontend(App\Module $module, App\Router $router, IPConfig $pconfig, Authentication $auth, App\Page $page, float $start_time)
567 $this->profiler->set($start_time, 'start');
568 $this->profiler->set(microtime(true), 'classinit');
570 $moduleName = $module->getName();
573 // Missing DB connection: ERROR
574 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
575 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
578 // Max Load Average reached: ERROR
579 if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
580 header('Retry-After: 120');
581 header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
583 throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
586 if (!$this->mode->isInstall()) {
587 // Force SSL redirection
588 if ($this->baseURL->checkRedirectHttps()) {
589 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
592 Core\Hook::callAll('init_1');
595 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
596 $requester = HTTPSignature::getSigner('', $_SERVER);
597 if (!empty($requester)) {
598 Profile::addVisitorCookieForHandle($requester);
603 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend()) {
605 // Only continue when the given profile link seems valid
606 // Valid profile links contain a path with "/profile/" and no query parameters
607 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
608 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
609 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
610 Core\Session::set('my_url', $_GET['zrl']);
611 Core\Session::set('authenticated', 0);
613 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
614 if (!empty($remote_contact['subscribe'])) {
615 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
619 Model\Profile::zrlInit($this);
621 // Someone came with an invalid parameter, maybe as a DDoS attempt
622 // We simply stop processing here
623 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
624 throw new HTTPException\ForbiddenException();
629 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
630 $token = $_GET['owt'];
631 Model\Profile::openWebAuthInit($token);
634 $auth->withSession($this);
636 if (empty($_SESSION['authenticated'])) {
637 header('X-Account-Management-Status: none');
640 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
641 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
642 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
645 * check_config() is responsible for running update scripts. These automatically
646 * update the DB schema whenever we push a new one out. It also checks to see if
647 * any addons have been added or removed and reacts accordingly.
650 // in install mode, any url loads install module
651 // but we need "view" module for stylesheet
652 if ($this->mode->isInstall() && $moduleName !== 'install') {
653 $this->baseURL->redirect('install');
656 Core\Update::check($this->getBasePath(), false, $this->mode);
657 Core\Addon::loadAddons();
658 Core\Hook::loadHooks();
661 // Compatibility with the Android Diaspora client
662 if ($moduleName == 'stream') {
663 $this->baseURL->redirect('network?order=post');
666 if ($moduleName == 'conversations') {
667 $this->baseURL->redirect('message');
670 if ($moduleName == 'commented') {
671 $this->baseURL->redirect('network?order=comment');
674 if ($moduleName == 'liked') {
675 $this->baseURL->redirect('network?order=comment');
678 if ($moduleName == 'activity') {
679 $this->baseURL->redirect('network?conv=1');
682 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
683 $this->baseURL->redirect('bookmarklet');
686 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
687 $this->baseURL->redirect('settings');
690 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
691 $this->baseURL->redirect('search');
694 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
695 $page['page_title'] = $moduleName;
697 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
698 $module = new Module('maintenance', Maintenance::class);
700 // determine the module class and save it to the module instance
701 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
702 $module = $module->determineClass($this->args, $router, $this->config);
705 // Let the module run it's internal process (init, get, post, ...)
706 $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
707 } catch (HTTPException $e) {
708 ModuleHTTPException::rawContent($e);
711 $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
715 * Automatically redirects to relative or absolute URL
716 * Should only be used if it isn't clear if the URL is either internal or external
718 * @param string $toUrl The target URL
720 * @throws HTTPException\InternalServerErrorException
722 public function redirect($toUrl)
724 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
725 Core\System::externalRedirect($toUrl);
727 $this->baseURL->redirect($toUrl);