3 * @copyright Copyright (C) 2010-2022, 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\Model\User;
31 use Friendica\Module\Maintenance;
32 use Friendica\Security\Authentication;
33 use Friendica\Core\Config\ValueObject\Cache;
34 use Friendica\Core\Config\Capability\IManageConfigValues;
35 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
36 use Friendica\Core\L10n;
37 use Friendica\Core\System;
38 use Friendica\Core\Theme;
39 use Friendica\Database\Database;
40 use Friendica\Model\Contact;
41 use Friendica\Model\Profile;
42 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
43 use Friendica\Network\HTTPException;
44 use Friendica\Util\DateTimeFormat;
45 use Friendica\Util\HTTPInputData;
46 use Friendica\Util\HTTPSignature;
47 use Friendica\Util\Profiler;
48 use Friendica\Util\Strings;
49 use Psr\Log\LoggerInterface;
52 * Our main application structure for the life of this page.
54 * Primarily deals with the URL that got us here
55 * and tries to make some sense of it, and
56 * stores our page contents and config storage
57 * and anything else that might need to be passed around
58 * before we spit the page out.
63 const PLATFORM = 'Friendica';
64 const CODENAME = 'Giant Rhubarb';
65 const VERSION = '2022.12-rc';
67 // Allow themes to control internal parameters
68 // by changing App values in theme.php
69 private $theme_info = [
75 private $nickname = '';
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
139 * @param int $user_id
142 public function setLoggedInUserId(int $user_id)
144 $this->user_id = $user_id;
150 * @param int $user_id
153 public function setLoggedInUserNickname(string $nickname)
155 $this->nickname = $nickname;
158 public function isLoggedIn(): bool
160 return $this->session->getLocalUserId() && $this->user_id && ($this->user_id == $this->session->getLocalUserId());
164 * Check if current user has admin role.
166 * @return bool true if user is an admin
169 public function isSiteAdmin(): bool
172 $this->session->getLocalUserId()
173 && $this->database->exists('user', [
174 'uid' => $this->getLoggedInUserId(),
175 'email' => User::getAdminEmailList()
181 * @return int User id
183 public function getLoggedInUserId(): int
185 return $this->user_id;
189 * Fetch the user nick name
190 * @return string User's nickname
192 public function getLoggedInUserNickname(): string
194 return $this->nickname;
198 * Set the profile owner ID
200 * @param int $owner_id
203 public function setProfileOwner(int $owner_id)
205 $this->profile_owner = $owner_id;
209 * Get the profile owner ID
213 public function getProfileOwner(): int
215 return $this->profile_owner;
221 * @param int $contact_id
224 public function setContactId(int $contact_id)
226 $this->contact_id = $contact_id;
234 public function getContactId(): int
236 return $this->contact_id;
242 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
245 public function setTimeZone(string $timezone)
247 $this->timezone = (new \DateTimeZone($timezone))->getName();
248 DateTimeFormat::setLocalTimeZone($this->timezone);
256 public function getTimeZone(): string
258 return $this->timezone;
262 * Set workerqueue information
264 * @param array $queue
267 public function setQueue(array $queue)
269 $this->queue = $queue;
273 * Fetch workerqueue information
275 * @return array Worker queue
277 public function getQueue(): array
279 return $this->queue ?? [];
283 * Fetch a specific workerqueue field
285 * @param string $index Work queue record to fetch
286 * @return mixed Work queue item or NULL if not found
288 public function getQueueValue(string $index)
290 return $this->queue[$index] ?? null;
293 public function setThemeInfoValue(string $index, $value)
295 $this->theme_info[$index] = $value;
298 public function getThemeInfo()
300 return $this->theme_info;
303 public function getThemeInfoValue(string $index, $default = null)
305 return $this->theme_info[$index] ?? $default;
309 * Returns the current config cache of this node
313 public function getConfigCache()
315 return $this->config->getCache();
319 * The basepath of this app
321 * @return string Base path from configuration
323 public function getBasePath(): string
325 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
326 return $this->config->getCache()->get('system', 'basepath');
330 * @param Database $database The Friendica Database
331 * @param IManageConfigValues $config The Configuration
332 * @param App\Mode $mode The mode of this Friendica app
333 * @param BaseURL $baseURL The full base URL of this Friendica app
334 * @param LoggerInterface $logger The current app logger
335 * @param Profiler $profiler The profiler of this application
336 * @param L10n $l10n The translator instance
337 * @param App\Arguments $args The Friendica Arguments of the call
338 * @param IManagePersonalConfigValues $pConfig Personal configuration
339 * @param IHandleUserSessions $session The (User)Session handler
341 public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, IManagePersonalConfigValues $pConfig, IHandleUserSessions $session)
343 $this->database = $database;
344 $this->config = $config;
346 $this->baseURL = $baseURL;
347 $this->profiler = $profiler;
348 $this->logger = $logger;
351 $this->pConfig = $pConfig;
352 $this->session = $session;
358 * Load the whole app instance
360 public function load()
364 // Normally this constant is defined - but not if "pcntl" isn't installed
365 if (!defined('SIGTERM')) {
366 define('SIGTERM', 15);
369 // Ensure that all "strtotime" operations do run timezone independent
370 date_default_timezone_set('UTC');
372 // This has to be quite large to deal with embedded private photos
373 ini_set('pcre.backtrack_limit', 500000);
376 get_include_path() . PATH_SEPARATOR
377 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
378 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
379 . $this->getBasePath());
381 $this->profiler->reset();
383 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
384 $this->profiler->update($this->config);
386 Core\Hook::loadHooks();
387 $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
388 Core\Hook::callAll('load_config', $loader);
391 $this->loadDefaultTimezone();
392 // Register template engines
393 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
397 * Loads the default timezone
399 * Include support for legacy $default_timezone
401 * @global string $default_timezone
403 private function loadDefaultTimezone()
405 if ($this->config->get('system', 'default_timezone')) {
406 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
408 global $default_timezone;
409 $timezone = $default_timezone ?? '' ?: 'UTC';
412 $this->setTimeZone($timezone);
416 * Returns the current theme name. May be overriden by the mobile theme name.
418 * @return string Current theme name or empty string in installation phase
421 public function getCurrentTheme(): string
423 if ($this->mode->isInstall()) {
427 // Specific mobile theme override
428 if (($this->mode->isMobile() || $this->mode->isTablet()) && $this->session->get('show-mobile', true)) {
429 $user_mobile_theme = $this->getCurrentMobileTheme();
431 // --- means same mobile theme as desktop
432 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
433 return $user_mobile_theme;
437 if (!$this->currentTheme) {
438 $this->computeCurrentTheme();
441 return $this->currentTheme;
445 * Returns the current mobile theme name.
447 * @return string Mobile theme name or empty string if installer
450 public function getCurrentMobileTheme(): string
452 if ($this->mode->isInstall()) {
456 if (is_null($this->currentMobileTheme)) {
457 $this->computeCurrentMobileTheme();
460 return $this->currentMobileTheme;
464 * Setter for current theme name
466 * @param string $theme Name of current theme
468 public function setCurrentTheme(string $theme)
470 $this->currentTheme = $theme;
474 * Setter for current mobile theme name
476 * @param string $theme Name of current mobile theme
478 public function setCurrentMobileTheme(string $theme)
480 $this->currentMobileTheme = $theme;
484 * Computes the current theme name based on the node settings, the page owner settings and the user settings
488 private function computeCurrentTheme()
490 $system_theme = $this->config->get('system', 'theme');
491 if (!$system_theme) {
492 throw new Exception($this->l10n->t('No system theme config value set.'));
496 $this->setCurrentTheme($system_theme);
499 // Find the theme that belongs to the user whose stuff we are looking at
500 if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
501 // Allow folks to override user themes and always use their own on their own site.
502 // This works only if the user is on the same server
503 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
504 if ($this->database->isResult($user) && !$this->session->getLocalUserId()) {
505 $page_theme = $user['theme'];
509 $theme_name = $page_theme ?: $this->session->get('theme', $system_theme);
511 $theme_name = Strings::sanitizeFilePathItem($theme_name);
513 && in_array($theme_name, Theme::getAllowedList())
514 && (file_exists('view/theme/' . $theme_name . '/style.css')
515 || file_exists('view/theme/' . $theme_name . '/style.php'))
517 $this->setCurrentTheme($theme_name);
522 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
524 private function computeCurrentMobileTheme()
526 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
529 $this->setCurrentMobileTheme($system_mobile_theme);
531 $page_mobile_theme = null;
532 // Find the theme that belongs to the user whose stuff we are looking at
533 if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
534 // Allow folks to override user themes and always use their own on their own site.
535 // This works only if the user is on the same server
536 if (!$this->session->getLocalUserId()) {
537 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
541 $mobile_theme_name = $page_mobile_theme ?: $this->session->get('mobile-theme', $system_mobile_theme);
543 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
544 if ($mobile_theme_name == '---'
546 in_array($mobile_theme_name, Theme::getAllowedList())
547 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
548 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
550 $this->setCurrentMobileTheme($mobile_theme_name);
555 * Provide a sane default if nothing is chosen or the specified theme does not exist.
557 * @return string Current theme's stylsheet path
560 public function getCurrentThemeStylesheetPath(): string
562 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
566 * Sets the base url for use in cmdline programs which don't have
569 public function checkURL()
571 $url = $this->config->get('system', 'url');
573 // if the url isn't set or the stored url is radically different
574 // than the currently visited url, store the current value accordingly.
575 // "Radically different" ignores common variations such as http vs https
576 // and www.example.com vs example.com.
577 // We will only change the url to an ip address if there is no existing setting
579 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()))) {
580 $this->config->set('system', 'url', $this->baseURL->get());
585 * Frontend App script
587 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
588 * request and a representation of the response.
590 * This probably should change to limit the size of this monster method.
592 * @param App\Router $router
593 * @param IManagePersonalConfigValues $pconfig
594 * @param Authentication $auth The Authentication backend of the node
595 * @param App\Page $page The Friendica page printing container
596 * @param HTTPInputData $httpInput A library for processing PHP input streams
597 * @param float $start_time The start time of the overall script execution
599 * @throws HTTPException\InternalServerErrorException
600 * @throws \ImagickException
602 public function runFrontend(App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, HTTPInputData $httpInput, float $start_time)
604 $this->profiler->set($start_time, 'start');
605 $this->profiler->set(microtime(true), 'classinit');
607 $moduleName = $this->args->getModuleName();
608 $page->setLogging($this->args->getMethod(), $this->args->getModuleName(), $this->args->getCommand());
611 // Missing DB connection: ERROR
612 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
613 throw new HTTPException\InternalServerErrorException($this->l10n->t('Apologies but the website is unavailable at the moment.'));
616 if (!$this->mode->isInstall()) {
617 // Force SSL redirection
618 if ($this->baseURL->checkRedirectHttps()) {
619 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
622 Core\Hook::callAll('init_1');
625 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
626 $requester = HTTPSignature::getSigner('', $_SERVER);
627 if (!empty($requester)) {
628 Profile::addVisitorCookieForHandle($requester);
633 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend() && !$this->session->getLocalUserId()) {
634 // Only continue when the given profile link seems valid.
635 // Valid profile links contain a path with "/profile/" and no query parameters
636 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == '') &&
637 strpos(parse_url($_GET['zrl'], PHP_URL_PATH) ?? '', '/profile/') !== false) {
638 if ($this->session->get('visitor_home') != $_GET['zrl']) {
639 $this->session->set('my_url', $_GET['zrl']);
640 $this->session->set('authenticated', 0);
642 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
643 if (!empty($remote_contact['subscribe'])) {
644 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
648 Model\Profile::zrlInit($this);
650 // Someone came with an invalid parameter, maybe as a DDoS attempt
651 // We simply stop processing here
652 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
653 throw new HTTPException\ForbiddenException();
657 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
658 $token = $_GET['owt'];
659 Model\Profile::openWebAuthInit($token);
662 if (!$this->mode->isBackend()) {
663 $auth->withSession($this);
666 if (empty($_SESSION['authenticated'])) {
667 header('X-Account-Management-Status: none');
671 * check_config() is responsible for running update scripts. These automatically
672 * update the DB schema whenever we push a new one out. It also checks to see if
673 * any addons have been added or removed and reacts accordingly.
676 // in install mode, any url loads install module
677 // but we need "view" module for stylesheet
678 if ($this->mode->isInstall() && $moduleName !== 'install') {
679 $this->baseURL->redirect('install');
682 Core\Update::check($this->getBasePath(), false, $this->mode);
683 Core\Addon::loadAddons();
684 Core\Hook::loadHooks();
687 // Compatibility with the Android Diaspora client
688 if ($moduleName == 'stream') {
689 $this->baseURL->redirect('network?order=post');
692 if ($moduleName == 'conversations') {
693 $this->baseURL->redirect('message');
696 if ($moduleName == 'commented') {
697 $this->baseURL->redirect('network?order=comment');
700 if ($moduleName == 'liked') {
701 $this->baseURL->redirect('network?order=comment');
704 if ($moduleName == 'activity') {
705 $this->baseURL->redirect('network?conv=1');
708 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
709 $this->baseURL->redirect('bookmarklet');
712 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
713 $this->baseURL->redirect('settings');
716 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
717 $this->baseURL->redirect('search');
720 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
721 $page['page_title'] = $moduleName;
723 // The "view" module is required to show the theme CSS
724 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'view') {
725 $module = $router->getModule(Maintenance::class);
727 // determine the module class and save it to the module instance
728 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
729 $module = $router->getModule();
732 // Processes data from GET requests
733 $httpinput = $httpInput->process();
734 $input = array_merge($httpinput['variables'], $httpinput['files'], $request ?? $_REQUEST);
736 // Let the module run it's internal process (init, get, post, ...)
737 $timestamp = microtime(true);
738 $response = $module->run($input);
739 $this->profiler->set(microtime(true) - $timestamp, 'content');
740 if ($response->getHeaderLine(ICanCreateResponses::X_HEADER) === ICanCreateResponses::TYPE_HTML) {
741 $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig, $this->session->getLocalUserId());
743 $page->exit($response);
745 } catch (HTTPException $e) {
746 (new ModuleHTTPException())->rawContent($e);
748 $page->logRuntime($this->config, 'runFrontend');
752 * Automatically redirects to relative or absolute URL
753 * Should only be used if it isn't clear if the URL is either internal or external
755 * @param string $toUrl The target URL
757 * @throws HTTPException\InternalServerErrorException
759 public function redirect(string $toUrl)
761 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
762 Core\System::externalRedirect($toUrl);
764 $this->baseURL->redirect($toUrl);