3 * @copyright Copyright (C) 2010-2023, 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\Capabilities\ICanCreateResponses;
28 use Friendica\Content\Nav;
29 use Friendica\Core\Config\Factory\Config;
30 use Friendica\Core\Session\Capability\IHandleUserSessions;
31 use Friendica\Database\Definition\DbaDefinition;
32 use Friendica\Database\Definition\ViewDefinition;
33 use Friendica\Module\Maintenance;
34 use Friendica\Security\Authentication;
35 use Friendica\Core\Config\ValueObject\Cache;
36 use Friendica\Core\Config\Capability\IManageConfigValues;
37 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
38 use Friendica\Core\L10n;
39 use Friendica\Core\System;
40 use Friendica\Core\Theme;
41 use Friendica\Database\Database;
42 use Friendica\Model\Contact;
43 use Friendica\Model\Profile;
44 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
45 use Friendica\Network\HTTPException;
46 use Friendica\Util\DateTimeFormat;
47 use Friendica\Util\HTTPInputData;
48 use Friendica\Util\HTTPSignature;
49 use Friendica\Util\Profiler;
50 use Friendica\Util\Strings;
51 use Psr\Log\LoggerInterface;
54 * Our main application structure for the life of this page.
56 * Primarily deals with the URL that got us here
57 * and tries to make some sense of it, and
58 * stores our page contents and config storage
59 * and anything else that might need to be passed around
60 * before we spit the page out.
65 const PLATFORM = 'Friendica';
66 const CODENAME = 'Giant Rhubarb';
67 const VERSION = '2023.09-rc';
69 // Allow themes to control internal parameters
70 // by changing App values in theme.php
71 private $theme_info = [
76 private $timezone = '';
77 private $profile_owner = 0;
78 private $contact_id = 0;
82 * @var App\Mode The Mode of the Application
91 /** @var string The name of the current theme */
92 private $currentTheme;
93 /** @var string The name of the current mobile theme */
94 private $currentMobileTheme;
97 * @var IManageConfigValues The config
102 * @var LoggerInterface The logger
107 * @var Profiler The profiler of this app
112 * @var Database The Friendica database connection
117 * @var L10n The translator
127 * @var IManagePersonalConfigValues
132 * @var IHandleUserSessions
137 * @deprecated 2022.03
138 * @see IHandleUserSessions::isAuthenticated()
140 public function isLoggedIn(): bool
142 return $this->session->isAuthenticated();
146 * @deprecated 2022.03
147 * @see IHandleUserSessions::isSiteAdmin()
149 public function isSiteAdmin(): bool
151 return $this->session->isSiteAdmin();
155 * @deprecated 2022.03
156 * @see IHandleUserSessions::getLocalUserId()
158 public function getLoggedInUserId(): int
160 return $this->session->getLocalUserId();
164 * @deprecated 2022.03
165 * @see IHandleUserSessions::getLocalUserNickname()
167 public function getLoggedInUserNickname(): string
169 return $this->session->getLocalUserNickname();
173 * Set the profile owner ID
175 * @param int $owner_id
178 public function setProfileOwner(int $owner_id)
180 $this->profile_owner = $owner_id;
184 * Get the profile owner ID
188 public function getProfileOwner(): int
190 return $this->profile_owner;
196 * @param int $contact_id
199 public function setContactId(int $contact_id)
201 $this->contact_id = $contact_id;
209 public function getContactId(): int
211 return $this->contact_id;
217 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
220 public function setTimeZone(string $timezone)
222 $this->timezone = (new \DateTimeZone($timezone))->getName();
223 DateTimeFormat::setLocalTimeZone($this->timezone);
231 public function getTimeZone(): string
233 return $this->timezone;
237 * Set workerqueue information
239 * @param array $queue
242 public function setQueue(array $queue)
244 $this->queue = $queue;
248 * Fetch workerqueue information
250 * @return array Worker queue
252 public function getQueue(): array
254 return $this->queue ?? [];
258 * Fetch a specific workerqueue field
260 * @param string $index Work queue record to fetch
261 * @return mixed Work queue item or NULL if not found
263 public function getQueueValue(string $index)
265 return $this->queue[$index] ?? null;
268 public function setThemeInfoValue(string $index, $value)
270 $this->theme_info[$index] = $value;
273 public function getThemeInfo()
275 return $this->theme_info;
278 public function getThemeInfoValue(string $index, $default = null)
280 return $this->theme_info[$index] ?? $default;
284 * Returns the current config cache of this node
288 public function getConfigCache()
290 return $this->config->getCache();
294 * The basepath of this app
296 * @return string Base path from configuration
298 public function getBasePath(): string
300 return $this->config->get('system', 'basepath');
304 * @param Database $database The Friendica Database
305 * @param IManageConfigValues $config The Configuration
306 * @param App\Mode $mode The mode of this Friendica app
307 * @param BaseURL $baseURL The full base URL of this Friendica app
308 * @param LoggerInterface $logger The current app logger
309 * @param Profiler $profiler The profiler of this application
310 * @param L10n $l10n The translator instance
311 * @param App\Arguments $args The Friendica Arguments of the call
312 * @param IManagePersonalConfigValues $pConfig Personal configuration
313 * @param IHandleUserSessions $session The (User)Session handler
314 * @param DbaDefinition $dbaDefinition
315 * @param ViewDefinition $viewDefinition
317 public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, IManagePersonalConfigValues $pConfig, IHandleUserSessions $session, DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition)
319 $this->database = $database;
320 $this->config = $config;
322 $this->baseURL = $baseURL;
323 $this->profiler = $profiler;
324 $this->logger = $logger;
327 $this->pConfig = $pConfig;
328 $this->session = $session;
330 $this->load($dbaDefinition, $viewDefinition);
334 * Load the whole app instance
336 protected function load(DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition)
338 if ($this->config->get('system', 'ini_max_execution_time') !== false) {
339 set_time_limit((int)$this->config->get('system', 'ini_max_execution_time'));
342 if ($this->config->get('system', 'ini_pcre_backtrack_limit') !== false) {
343 ini_set('pcre.backtrack_limit', (int)$this->config->get('system', 'ini_pcre_backtrack_limit'));
346 // Normally this constant is defined - but not if "pcntl" isn't installed
347 if (!defined('SIGTERM')) {
348 define('SIGTERM', 15);
351 // Ensure that all "strtotime" operations do run timezone independent
352 date_default_timezone_set('UTC');
355 get_include_path() . PATH_SEPARATOR
356 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
357 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
358 . $this->getBasePath());
360 $this->profiler->reset();
362 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
363 Core\Hook::loadHooks();
364 $loader = (new Config())->createConfigFileManager($this->getBasePath(), $_SERVER);
365 Core\Hook::callAll('load_config', $loader);
367 // Hooks are now working, reload the whole definitions with hook enabled
368 $dbaDefinition->load(true);
369 $viewDefinition->load(true);
372 $this->loadDefaultTimezone();
373 // Register template engines
374 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
378 * Loads the default timezone
380 * Include support for legacy $default_timezone
382 * @global string $default_timezone
384 private function loadDefaultTimezone()
386 if ($this->config->get('system', 'default_timezone')) {
387 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
389 global $default_timezone;
390 $timezone = $default_timezone ?? '' ?: 'UTC';
393 $this->setTimeZone($timezone);
397 * Returns the current theme name. May be overridden by the mobile theme name.
399 * @return string Current theme name or empty string in installation phase
402 public function getCurrentTheme(): string
404 if ($this->mode->isInstall()) {
408 // Specific mobile theme override
409 if (($this->mode->isMobile() || $this->mode->isTablet()) && $this->session->get('show-mobile', true)) {
410 $user_mobile_theme = $this->getCurrentMobileTheme();
412 // --- means same mobile theme as desktop
413 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
414 return $user_mobile_theme;
418 if (!$this->currentTheme) {
419 $this->computeCurrentTheme();
422 return $this->currentTheme;
426 * Returns the current mobile theme name.
428 * @return string Mobile theme name or empty string if installer
431 public function getCurrentMobileTheme(): string
433 if ($this->mode->isInstall()) {
437 if (is_null($this->currentMobileTheme)) {
438 $this->computeCurrentMobileTheme();
441 return $this->currentMobileTheme;
445 * Setter for current theme name
447 * @param string $theme Name of current theme
449 public function setCurrentTheme(string $theme)
451 $this->currentTheme = $theme;
455 * Setter for current mobile theme name
457 * @param string $theme Name of current mobile theme
459 public function setCurrentMobileTheme(string $theme)
461 $this->currentMobileTheme = $theme;
465 * Computes the current theme name based on the node settings, the page owner settings and the user settings
469 private function computeCurrentTheme()
471 $system_theme = $this->config->get('system', 'theme');
472 if (!$system_theme) {
473 throw new Exception($this->l10n->t('No system theme config value set.'));
477 $this->setCurrentTheme($system_theme);
480 // Find the theme that belongs to the user whose stuff we are looking at
481 if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
482 // Allow folks to override user themes and always use their own on their own site.
483 // This works only if the user is on the same server
484 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
485 if ($this->database->isResult($user) && !$this->session->getLocalUserId()) {
486 $page_theme = $user['theme'];
490 $theme_name = $page_theme ?: $this->session->get('theme', $system_theme);
492 $theme_name = Strings::sanitizeFilePathItem($theme_name);
494 && in_array($theme_name, Theme::getAllowedList())
495 && (file_exists('view/theme/' . $theme_name . '/style.css')
496 || file_exists('view/theme/' . $theme_name . '/style.php'))
498 $this->setCurrentTheme($theme_name);
503 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
505 private function computeCurrentMobileTheme()
507 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
510 $this->setCurrentMobileTheme($system_mobile_theme);
512 $page_mobile_theme = null;
513 // Find the theme that belongs to the user whose stuff we are looking at
514 if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
515 // Allow folks to override user themes and always use their own on their own site.
516 // This works only if the user is on the same server
517 if (!$this->session->getLocalUserId()) {
518 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
522 $mobile_theme_name = $page_mobile_theme ?: $this->session->get('mobile-theme', $system_mobile_theme);
524 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
525 if ($mobile_theme_name == '---'
527 in_array($mobile_theme_name, Theme::getAllowedList())
528 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
529 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
531 $this->setCurrentMobileTheme($mobile_theme_name);
536 * Provide a sane default if nothing is chosen or the specified theme does not exist.
538 * @return string Current theme's stylesheet path
541 public function getCurrentThemeStylesheetPath(): string
543 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
547 * Frontend App script
549 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
550 * request and a representation of the response.
552 * This probably should change to limit the size of this monster method.
554 * @param App\Router $router
555 * @param IManagePersonalConfigValues $pconfig
556 * @param Authentication $auth The Authentication backend of the node
557 * @param App\Page $page The Friendica page printing container
558 * @param ModuleHTTPException $httpException The possible HTTP Exception container
559 * @param HTTPInputData $httpInput A library for processing PHP input streams
560 * @param float $start_time The start time of the overall script execution
561 * @param array $server The $_SERVER array
563 * @throws HTTPException\InternalServerErrorException
564 * @throws \ImagickException
566 public function runFrontend(App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, Nav $nav, ModuleHTTPException $httpException, HTTPInputData $httpInput, float $start_time, array $server)
568 $requeststring = ($_SERVER['REQUEST_METHOD'] ?? '') . ' ' . ($_SERVER['REQUEST_URI'] ?? '') . ' ' . ($_SERVER['SERVER_PROTOCOL'] ?? '');
569 $this->logger->debug('Request received', ['address' => $_SERVER['REMOTE_ADDR'] ?? '', 'request' => $requeststring, 'referer' => $_SERVER['HTTP_REFERER'] ?? '', 'user-agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
571 $this->profiler->set($start_time, 'start');
572 $this->profiler->set(microtime(true), 'classinit');
574 $moduleName = $this->args->getModuleName();
575 $page->setLogging($this->args->getMethod(), $this->args->getModuleName(), $this->args->getCommand());
578 // Missing DB connection: ERROR
579 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
580 throw new HTTPException\InternalServerErrorException($this->l10n->t('Apologies but the website is unavailable at the moment.'));
583 if (!$this->mode->isInstall()) {
584 // Force SSL redirection
585 if ($this->config->get('system', 'force_ssl') &&
586 (empty($server['HTTPS']) || $server['HTTPS'] === 'off') &&
587 (empty($server['HTTP_X_FORWARDED_PROTO']) || $server['HTTP_X_FORWARDED_PROTO'] === 'http') &&
588 !empty($server['REQUEST_METHOD']) &&
589 $server['REQUEST_METHOD'] === 'GET') {
590 System::externalRedirect($this->baseURL . '/' . $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() && !$this->session->getLocalUserId()) {
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 strpos(parse_url($_GET['zrl'], PHP_URL_PATH) ?? '', '/profile/') !== false) {
608 if ($this->session->get('visitor_home') != $_GET['zrl']) {
609 $this->session->set('my_url', $_GET['zrl']);
610 $this->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();
627 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
628 $token = $_GET['owt'];
629 Model\Profile::openWebAuthInit($token);
632 if (!$this->mode->isBackend()) {
633 $auth->withSession($this);
636 if (empty($_SESSION['authenticated'])) {
637 header('X-Account-Management-Status: none');
641 * check_config() is responsible for running update scripts. These automatically
642 * update the DB schema whenever we push a new one out. It also checks to see if
643 * any addons have been added or removed and reacts accordingly.
646 // in install mode, any url loads install module
647 // but we need "view" module for stylesheet
648 if ($this->mode->isInstall() && $moduleName !== 'install') {
649 $this->baseURL->redirect('install');
651 Core\Update::check($this->getBasePath(), false);
652 Core\Addon::loadAddons();
653 Core\Hook::loadHooks();
656 // Compatibility with the Android Diaspora client
657 if ($moduleName == 'stream') {
658 $this->baseURL->redirect('network?order=post');
661 if ($moduleName == 'conversations') {
662 $this->baseURL->redirect('message');
665 if ($moduleName == 'commented') {
666 $this->baseURL->redirect('network?order=comment');
669 if ($moduleName == 'liked') {
670 $this->baseURL->redirect('network?order=comment');
673 if ($moduleName == 'activity') {
674 $this->baseURL->redirect('network?conv=1');
677 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
678 $this->baseURL->redirect('bookmarklet');
681 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
682 $this->baseURL->redirect('settings');
685 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
686 $this->baseURL->redirect('search');
689 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
690 $page['page_title'] = $moduleName;
692 // The "view" module is required to show the theme CSS
693 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'view') {
694 $module = $router->getModule(Maintenance::class);
696 // determine the module class and save it to the module instance
697 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
698 $module = $router->getModule();
701 // Display can change depending on the requested language, so it shouldn't be cached whole
702 header('Vary: Accept-Language', false);
704 // Processes data from GET requests
705 $httpinput = $httpInput->process();
706 $input = array_merge($httpinput['variables'], $httpinput['files'], $request ?? $_REQUEST);
708 // Let the module run its internal process (init, get, post, ...)
709 $timestamp = microtime(true);
710 $response = $module->run($httpException, $input);
711 $this->profiler->set(microtime(true) - $timestamp, 'content');
713 // Wrapping HTML responses in the theme template
714 if ($response->getHeaderLine(ICanCreateResponses::X_HEADER) === ICanCreateResponses::TYPE_HTML) {
715 $response = $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig, $nav, $this->session->getLocalUserId());
718 $this->logger->debug('Request processed sucessfully', ['response' => $response->getStatusCode(), 'address' => $_SERVER['REMOTE_ADDR'] ?? '', 'request' => $requeststring, 'referer' => $_SERVER['HTTP_REFERER'] ?? '', 'user-agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
719 System::echoResponse($response);
720 } catch (HTTPException $e) {
721 $this->logger->debug('Request processed with exception', ['response' => $e->getCode(), 'address' => $_SERVER['REMOTE_ADDR'] ?? '', 'request' => $requeststring, 'referer' => $_SERVER['HTTP_REFERER'] ?? '', 'user-agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
722 $httpException->rawContent($e);
724 $page->logRuntime($this->config, 'runFrontend');
728 * Automatically redirects to relative or absolute URL
729 * Should only be used if it isn't clear if the URL is either internal or external
731 * @param string $toUrl The target URL
733 * @throws HTTPException\InternalServerErrorException
735 public function redirect(string $toUrl)
737 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
738 Core\System::externalRedirect($toUrl);
740 $this->baseURL->redirect($toUrl);