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\Core\Config\Factory\Config;
29 use Friendica\Core\Session\Capability\IHandleUserSessions;
30 use Friendica\Database\Definition\DbaDefinition;
31 use Friendica\Database\Definition\ViewDefinition;
32 use Friendica\Module\Maintenance;
33 use Friendica\Security\Authentication;
34 use Friendica\Core\Config\ValueObject\Cache;
35 use Friendica\Core\Config\Capability\IManageConfigValues;
36 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
37 use Friendica\Core\L10n;
38 use Friendica\Core\System;
39 use Friendica\Core\Theme;
40 use Friendica\Database\Database;
41 use Friendica\Model\Contact;
42 use Friendica\Model\Profile;
43 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
44 use Friendica\Network\HTTPException;
45 use Friendica\Util\DateTimeFormat;
46 use Friendica\Util\HTTPInputData;
47 use Friendica\Util\HTTPSignature;
48 use Friendica\Util\Profiler;
49 use Friendica\Util\Strings;
50 use Psr\Log\LoggerInterface;
53 * Our main application structure for the life of this page.
55 * Primarily deals with the URL that got us here
56 * and tries to make some sense of it, and
57 * stores our page contents and config storage
58 * and anything else that might need to be passed around
59 * before we spit the page out.
64 const PLATFORM = 'Friendica';
65 const CODENAME = 'Giant Rhubarb';
66 const VERSION = '2023.03-dev';
68 // Allow themes to control internal parameters
69 // by changing App values in theme.php
70 private $theme_info = [
75 private $timezone = '';
76 private $profile_owner = 0;
77 private $contact_id = 0;
81 * @var App\Mode The Mode of the Application
90 /** @var string The name of the current theme */
91 private $currentTheme;
92 /** @var string The name of the current mobile theme */
93 private $currentMobileTheme;
96 * @var IManageConfigValues The config
101 * @var LoggerInterface The logger
106 * @var Profiler The profiler of this app
111 * @var Database The Friendica database connection
116 * @var L10n The translator
126 * @var IManagePersonalConfigValues
131 * @var IHandleUserSessions
136 * @deprecated 2022.03
137 * @see IHandleUserSessions::isAuthenticated()
139 public function isLoggedIn(): bool
141 return $this->session->isAuthenticated();
145 * @deprecated 2022.03
146 * @see IHandleUserSessions::isSiteAdmin()
148 public function isSiteAdmin(): bool
150 return $this->session->isSiteAdmin();
154 * @deprecated 2022.03
155 * @see IHandleUserSessions::getLocalUserId()
157 public function getLoggedInUserId(): int
159 return $this->session->getLocalUserId();
163 * @deprecated 2022.03
164 * @see IHandleUserSessions::getLocalUserNickname()
166 public function getLoggedInUserNickname(): string
168 return $this->session->getLocalUserNickname();
172 * Set the profile owner ID
174 * @param int $owner_id
177 public function setProfileOwner(int $owner_id)
179 $this->profile_owner = $owner_id;
183 * Get the profile owner ID
187 public function getProfileOwner(): int
189 return $this->profile_owner;
195 * @param int $contact_id
198 public function setContactId(int $contact_id)
200 $this->contact_id = $contact_id;
208 public function getContactId(): int
210 return $this->contact_id;
216 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
219 public function setTimeZone(string $timezone)
221 $this->timezone = (new \DateTimeZone($timezone))->getName();
222 DateTimeFormat::setLocalTimeZone($this->timezone);
230 public function getTimeZone(): string
232 return $this->timezone;
236 * Set workerqueue information
238 * @param array $queue
241 public function setQueue(array $queue)
243 $this->queue = $queue;
247 * Fetch workerqueue information
249 * @return array Worker queue
251 public function getQueue(): array
253 return $this->queue ?? [];
257 * Fetch a specific workerqueue field
259 * @param string $index Work queue record to fetch
260 * @return mixed Work queue item or NULL if not found
262 public function getQueueValue(string $index)
264 return $this->queue[$index] ?? null;
267 public function setThemeInfoValue(string $index, $value)
269 $this->theme_info[$index] = $value;
272 public function getThemeInfo()
274 return $this->theme_info;
277 public function getThemeInfoValue(string $index, $default = null)
279 return $this->theme_info[$index] ?? $default;
283 * Returns the current config cache of this node
287 public function getConfigCache()
289 return $this->config->getCache();
293 * The basepath of this app
295 * @return string Base path from configuration
297 public function getBasePath(): string
299 return $this->config->get('system', 'basepath');
303 * @param Database $database The Friendica Database
304 * @param IManageConfigValues $config The Configuration
305 * @param App\Mode $mode The mode of this Friendica app
306 * @param BaseURL $baseURL The full base URL of this Friendica app
307 * @param LoggerInterface $logger The current app logger
308 * @param Profiler $profiler The profiler of this application
309 * @param L10n $l10n The translator instance
310 * @param App\Arguments $args The Friendica Arguments of the call
311 * @param IManagePersonalConfigValues $pConfig Personal configuration
312 * @param IHandleUserSessions $session The (User)Session handler
313 * @param DbaDefinition $dbaDefinition
314 * @param ViewDefinition $viewDefinition
316 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)
318 $this->database = $database;
319 $this->config = $config;
321 $this->baseURL = $baseURL;
322 $this->profiler = $profiler;
323 $this->logger = $logger;
326 $this->pConfig = $pConfig;
327 $this->session = $session;
329 $this->load($dbaDefinition, $viewDefinition);
333 * Load the whole app instance
335 protected function load(DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition)
339 // Normally this constant is defined - but not if "pcntl" isn't installed
340 if (!defined('SIGTERM')) {
341 define('SIGTERM', 15);
344 // Ensure that all "strtotime" operations do run timezone independent
345 date_default_timezone_set('UTC');
347 // This has to be quite large to deal with embedded private photos
348 ini_set('pcre.backtrack_limit', 500000);
351 get_include_path() . PATH_SEPARATOR
352 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
353 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
354 . $this->getBasePath());
356 $this->profiler->reset();
358 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
359 $this->profiler->update($this->config);
361 Core\Hook::loadHooks();
362 $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
363 Core\Hook::callAll('load_config', $loader);
365 // Hooks are now working, reload the whole definitions with hook enabled
366 $dbaDefinition->load(true);
367 $viewDefinition->load(true);
370 $this->loadDefaultTimezone();
371 // Register template engines
372 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
376 * Loads the default timezone
378 * Include support for legacy $default_timezone
380 * @global string $default_timezone
382 private function loadDefaultTimezone()
384 if ($this->config->get('system', 'default_timezone')) {
385 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
387 global $default_timezone;
388 $timezone = $default_timezone ?? '' ?: 'UTC';
391 $this->setTimeZone($timezone);
395 * Returns the current theme name. May be overriden by the mobile theme name.
397 * @return string Current theme name or empty string in installation phase
400 public function getCurrentTheme(): string
402 if ($this->mode->isInstall()) {
406 // Specific mobile theme override
407 if (($this->mode->isMobile() || $this->mode->isTablet()) && $this->session->get('show-mobile', true)) {
408 $user_mobile_theme = $this->getCurrentMobileTheme();
410 // --- means same mobile theme as desktop
411 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
412 return $user_mobile_theme;
416 if (!$this->currentTheme) {
417 $this->computeCurrentTheme();
420 return $this->currentTheme;
424 * Returns the current mobile theme name.
426 * @return string Mobile theme name or empty string if installer
429 public function getCurrentMobileTheme(): string
431 if ($this->mode->isInstall()) {
435 if (is_null($this->currentMobileTheme)) {
436 $this->computeCurrentMobileTheme();
439 return $this->currentMobileTheme;
443 * Setter for current theme name
445 * @param string $theme Name of current theme
447 public function setCurrentTheme(string $theme)
449 $this->currentTheme = $theme;
453 * Setter for current mobile theme name
455 * @param string $theme Name of current mobile theme
457 public function setCurrentMobileTheme(string $theme)
459 $this->currentMobileTheme = $theme;
463 * Computes the current theme name based on the node settings, the page owner settings and the user settings
467 private function computeCurrentTheme()
469 $system_theme = $this->config->get('system', 'theme');
470 if (!$system_theme) {
471 throw new Exception($this->l10n->t('No system theme config value set.'));
475 $this->setCurrentTheme($system_theme);
478 // Find the theme that belongs to the user whose stuff we are looking at
479 if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
480 // Allow folks to override user themes and always use their own on their own site.
481 // This works only if the user is on the same server
482 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
483 if ($this->database->isResult($user) && !$this->session->getLocalUserId()) {
484 $page_theme = $user['theme'];
488 $theme_name = $page_theme ?: $this->session->get('theme', $system_theme);
490 $theme_name = Strings::sanitizeFilePathItem($theme_name);
492 && in_array($theme_name, Theme::getAllowedList())
493 && (file_exists('view/theme/' . $theme_name . '/style.css')
494 || file_exists('view/theme/' . $theme_name . '/style.php'))
496 $this->setCurrentTheme($theme_name);
501 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
503 private function computeCurrentMobileTheme()
505 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
508 $this->setCurrentMobileTheme($system_mobile_theme);
510 $page_mobile_theme = null;
511 // Find the theme that belongs to the user whose stuff we are looking at
512 if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
513 // Allow folks to override user themes and always use their own on their own site.
514 // This works only if the user is on the same server
515 if (!$this->session->getLocalUserId()) {
516 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
520 $mobile_theme_name = $page_mobile_theme ?: $this->session->get('mobile-theme', $system_mobile_theme);
522 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
523 if ($mobile_theme_name == '---'
525 in_array($mobile_theme_name, Theme::getAllowedList())
526 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
527 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
529 $this->setCurrentMobileTheme($mobile_theme_name);
534 * Provide a sane default if nothing is chosen or the specified theme does not exist.
536 * @return string Current theme's stylsheet path
539 public function getCurrentThemeStylesheetPath(): string
541 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
545 * Sets the base url for use in cmdline programs which don't have
548 public function checkURL()
550 $url = $this->config->get('system', 'url');
552 // if the url isn't set or the stored url is radically different
553 // than the currently visited url, store the current value accordingly.
554 // "Radically different" ignores common variations such as http vs https
555 // and www.example.com vs example.com.
556 // We will only change the url to an ip address if there is no existing setting
558 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()))) {
559 $this->config->set('system', 'url', $this->baseURL->get());
564 * Frontend App script
566 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
567 * request and a representation of the response.
569 * This probably should change to limit the size of this monster method.
571 * @param App\Router $router
572 * @param IManagePersonalConfigValues $pconfig
573 * @param Authentication $auth The Authentication backend of the node
574 * @param App\Page $page The Friendica page printing container
575 * @param ModuleHTTPException $httpException The possible HTTP Exception container
576 * @param HTTPInputData $httpInput A library for processing PHP input streams
577 * @param float $start_time The start time of the overall script execution
579 * @throws HTTPException\InternalServerErrorException
580 * @throws \ImagickException
582 public function runFrontend(App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, ModuleHTTPException $httpException, HTTPInputData $httpInput, float $start_time)
584 $this->profiler->set($start_time, 'start');
585 $this->profiler->set(microtime(true), 'classinit');
587 $moduleName = $this->args->getModuleName();
588 $page->setLogging($this->args->getMethod(), $this->args->getModuleName(), $this->args->getCommand());
591 // Missing DB connection: ERROR
592 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
593 throw new HTTPException\InternalServerErrorException($this->l10n->t('Apologies but the website is unavailable at the moment.'));
596 if (!$this->mode->isInstall()) {
597 // Force SSL redirection
598 if ($this->baseURL->checkRedirectHttps()) {
599 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
602 Core\Hook::callAll('init_1');
605 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
606 $requester = HTTPSignature::getSigner('', $_SERVER);
607 if (!empty($requester)) {
608 Profile::addVisitorCookieForHandle($requester);
613 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend() && !$this->session->getLocalUserId()) {
614 // Only continue when the given profile link seems valid.
615 // Valid profile links contain a path with "/profile/" and no query parameters
616 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == '') &&
617 strpos(parse_url($_GET['zrl'], PHP_URL_PATH) ?? '', '/profile/') !== false) {
618 if ($this->session->get('visitor_home') != $_GET['zrl']) {
619 $this->session->set('my_url', $_GET['zrl']);
620 $this->session->set('authenticated', 0);
622 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
623 if (!empty($remote_contact['subscribe'])) {
624 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
628 Model\Profile::zrlInit($this);
630 // Someone came with an invalid parameter, maybe as a DDoS attempt
631 // We simply stop processing here
632 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
633 throw new HTTPException\ForbiddenException();
637 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
638 $token = $_GET['owt'];
639 Model\Profile::openWebAuthInit($token);
642 if (!$this->mode->isBackend()) {
643 $auth->withSession($this);
646 if (empty($_SESSION['authenticated'])) {
647 header('X-Account-Management-Status: none');
651 * check_config() is responsible for running update scripts. These automatically
652 * update the DB schema whenever we push a new one out. It also checks to see if
653 * any addons have been added or removed and reacts accordingly.
656 // in install mode, any url loads install module
657 // but we need "view" module for stylesheet
658 if ($this->mode->isInstall() && $moduleName !== 'install') {
659 $this->baseURL->redirect('install');
662 Core\Update::check($this->getBasePath(), false, $this->mode);
663 Core\Addon::loadAddons();
664 Core\Hook::loadHooks();
667 // Compatibility with the Android Diaspora client
668 if ($moduleName == 'stream') {
669 $this->baseURL->redirect('network?order=post');
672 if ($moduleName == 'conversations') {
673 $this->baseURL->redirect('message');
676 if ($moduleName == 'commented') {
677 $this->baseURL->redirect('network?order=comment');
680 if ($moduleName == 'liked') {
681 $this->baseURL->redirect('network?order=comment');
684 if ($moduleName == 'activity') {
685 $this->baseURL->redirect('network?conv=1');
688 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
689 $this->baseURL->redirect('bookmarklet');
692 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
693 $this->baseURL->redirect('settings');
696 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
697 $this->baseURL->redirect('search');
700 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
701 $page['page_title'] = $moduleName;
703 // The "view" module is required to show the theme CSS
704 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'view') {
705 $module = $router->getModule(Maintenance::class);
707 // determine the module class and save it to the module instance
708 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
709 $module = $router->getModule();
712 // Processes data from GET requests
713 $httpinput = $httpInput->process();
714 $input = array_merge($httpinput['variables'], $httpinput['files'], $request ?? $_REQUEST);
716 // Let the module run its internal process (init, get, post, ...)
717 $timestamp = microtime(true);
718 $response = $module->run($httpException, $input);
719 $this->profiler->set(microtime(true) - $timestamp, 'content');
720 if ($response->getHeaderLine(ICanCreateResponses::X_HEADER) === ICanCreateResponses::TYPE_HTML) {
721 $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig, $this->session->getLocalUserId());
723 $page->exit($response);
725 } catch (HTTPException $e) {
726 $httpException->rawContent($e);
728 $page->logRuntime($this->config, 'runFrontend');
732 * Automatically redirects to relative or absolute URL
733 * Should only be used if it isn't clear if the URL is either internal or external
735 * @param string $toUrl The target URL
737 * @throws HTTPException\InternalServerErrorException
739 public function redirect(string $toUrl)
741 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
742 Core\System::externalRedirect($toUrl);
744 $this->baseURL->redirect($toUrl);