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\Database\Definition\DbaDefinition;
31 use Friendica\Database\Definition\ViewDefinition;
32 use Friendica\Model\User;
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 = '2022.12-rc';
69 // Allow themes to control internal parameters
70 // by changing App values in theme.php
71 private $theme_info = [
77 private $nickname = '';
78 private $timezone = '';
79 private $profile_owner = 0;
80 private $contact_id = 0;
84 * @var App\Mode The Mode of the Application
93 /** @var string The name of the current theme */
94 private $currentTheme;
95 /** @var string The name of the current mobile theme */
96 private $currentMobileTheme;
99 * @var IManageConfigValues The config
104 * @var LoggerInterface The logger
109 * @var Profiler The profiler of this app
114 * @var Database The Friendica database connection
119 * @var L10n The translator
129 * @var IManagePersonalConfigValues
134 * @var IHandleUserSessions
141 * @param int $user_id
144 public function setLoggedInUserId(int $user_id)
146 $this->user_id = $user_id;
152 * @param int $user_id
155 public function setLoggedInUserNickname(string $nickname)
157 $this->nickname = $nickname;
160 public function isLoggedIn(): bool
162 return $this->session->getLocalUserId() && $this->user_id && ($this->user_id == $this->session->getLocalUserId());
166 * Check if current user has admin role.
168 * @return bool true if user is an admin
171 public function isSiteAdmin(): bool
174 $this->session->getLocalUserId()
175 && $this->database->exists('user', [
176 'uid' => $this->getLoggedInUserId(),
177 'email' => User::getAdminEmailList()
183 * @return int User id
185 public function getLoggedInUserId(): int
187 return $this->user_id;
191 * Fetch the user nick name
192 * @return string User's nickname
194 public function getLoggedInUserNickname(): string
196 return $this->nickname;
200 * Set the profile owner ID
202 * @param int $owner_id
205 public function setProfileOwner(int $owner_id)
207 $this->profile_owner = $owner_id;
211 * Get the profile owner ID
215 public function getProfileOwner(): int
217 return $this->profile_owner;
223 * @param int $contact_id
226 public function setContactId(int $contact_id)
228 $this->contact_id = $contact_id;
236 public function getContactId(): int
238 return $this->contact_id;
244 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
247 public function setTimeZone(string $timezone)
249 $this->timezone = (new \DateTimeZone($timezone))->getName();
250 DateTimeFormat::setLocalTimeZone($this->timezone);
258 public function getTimeZone(): string
260 return $this->timezone;
264 * Set workerqueue information
266 * @param array $queue
269 public function setQueue(array $queue)
271 $this->queue = $queue;
275 * Fetch workerqueue information
277 * @return array Worker queue
279 public function getQueue(): array
281 return $this->queue ?? [];
285 * Fetch a specific workerqueue field
287 * @param string $index Work queue record to fetch
288 * @return mixed Work queue item or NULL if not found
290 public function getQueueValue(string $index)
292 return $this->queue[$index] ?? null;
295 public function setThemeInfoValue(string $index, $value)
297 $this->theme_info[$index] = $value;
300 public function getThemeInfo()
302 return $this->theme_info;
305 public function getThemeInfoValue(string $index, $default = null)
307 return $this->theme_info[$index] ?? $default;
311 * Returns the current config cache of this node
315 public function getConfigCache()
317 return $this->config->getCache();
321 * The basepath of this app
323 * @return string Base path from configuration
325 public function getBasePath(): string
327 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
328 return $this->config->getCache()->get('system', 'basepath');
332 * @param Database $database The Friendica Database
333 * @param IManageConfigValues $config The Configuration
334 * @param App\Mode $mode The mode of this Friendica app
335 * @param BaseURL $baseURL The full base URL of this Friendica app
336 * @param LoggerInterface $logger The current app logger
337 * @param Profiler $profiler The profiler of this application
338 * @param L10n $l10n The translator instance
339 * @param App\Arguments $args The Friendica Arguments of the call
340 * @param IManagePersonalConfigValues $pConfig Personal configuration
341 * @param IHandleUserSessions $session The (User)Session handler
342 * @param DbaDefinition $dbaDefinition
343 * @param ViewDefinition $viewDefinition
345 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)
347 $this->database = $database;
348 $this->config = $config;
350 $this->baseURL = $baseURL;
351 $this->profiler = $profiler;
352 $this->logger = $logger;
355 $this->pConfig = $pConfig;
356 $this->session = $session;
358 $this->load($dbaDefinition, $viewDefinition);
362 * Load the whole app instance
364 protected function load(DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition)
368 // Normally this constant is defined - but not if "pcntl" isn't installed
369 if (!defined('SIGTERM')) {
370 define('SIGTERM', 15);
373 // Ensure that all "strtotime" operations do run timezone independent
374 date_default_timezone_set('UTC');
376 // This has to be quite large to deal with embedded private photos
377 ini_set('pcre.backtrack_limit', 500000);
380 get_include_path() . PATH_SEPARATOR
381 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
382 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
383 . $this->getBasePath());
385 $this->profiler->reset();
387 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
388 $this->profiler->update($this->config);
390 Core\Hook::loadHooks();
391 $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
392 Core\Hook::callAll('load_config', $loader);
394 // Hooks are now working, reload the whole definitions with hook enabled
395 $dbaDefinition->load(true);
396 $viewDefinition->load(true);
399 $this->loadDefaultTimezone();
400 // Register template engines
401 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
405 * Loads the default timezone
407 * Include support for legacy $default_timezone
409 * @global string $default_timezone
411 private function loadDefaultTimezone()
413 if ($this->config->get('system', 'default_timezone')) {
414 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
416 global $default_timezone;
417 $timezone = $default_timezone ?? '' ?: 'UTC';
420 $this->setTimeZone($timezone);
424 * Returns the current theme name. May be overriden by the mobile theme name.
426 * @return string Current theme name or empty string in installation phase
429 public function getCurrentTheme(): string
431 if ($this->mode->isInstall()) {
435 // Specific mobile theme override
436 if (($this->mode->isMobile() || $this->mode->isTablet()) && $this->session->get('show-mobile', true)) {
437 $user_mobile_theme = $this->getCurrentMobileTheme();
439 // --- means same mobile theme as desktop
440 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
441 return $user_mobile_theme;
445 if (!$this->currentTheme) {
446 $this->computeCurrentTheme();
449 return $this->currentTheme;
453 * Returns the current mobile theme name.
455 * @return string Mobile theme name or empty string if installer
458 public function getCurrentMobileTheme(): string
460 if ($this->mode->isInstall()) {
464 if (is_null($this->currentMobileTheme)) {
465 $this->computeCurrentMobileTheme();
468 return $this->currentMobileTheme;
472 * Setter for current theme name
474 * @param string $theme Name of current theme
476 public function setCurrentTheme(string $theme)
478 $this->currentTheme = $theme;
482 * Setter for current mobile theme name
484 * @param string $theme Name of current mobile theme
486 public function setCurrentMobileTheme(string $theme)
488 $this->currentMobileTheme = $theme;
492 * Computes the current theme name based on the node settings, the page owner settings and the user settings
496 private function computeCurrentTheme()
498 $system_theme = $this->config->get('system', 'theme');
499 if (!$system_theme) {
500 throw new Exception($this->l10n->t('No system theme config value set.'));
504 $this->setCurrentTheme($system_theme);
507 // Find the theme that belongs to the user whose stuff we are looking at
508 if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
509 // Allow folks to override user themes and always use their own on their own site.
510 // This works only if the user is on the same server
511 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
512 if ($this->database->isResult($user) && !$this->session->getLocalUserId()) {
513 $page_theme = $user['theme'];
517 $theme_name = $page_theme ?: $this->session->get('theme', $system_theme);
519 $theme_name = Strings::sanitizeFilePathItem($theme_name);
521 && in_array($theme_name, Theme::getAllowedList())
522 && (file_exists('view/theme/' . $theme_name . '/style.css')
523 || file_exists('view/theme/' . $theme_name . '/style.php'))
525 $this->setCurrentTheme($theme_name);
530 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
532 private function computeCurrentMobileTheme()
534 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
537 $this->setCurrentMobileTheme($system_mobile_theme);
539 $page_mobile_theme = null;
540 // Find the theme that belongs to the user whose stuff we are looking at
541 if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
542 // Allow folks to override user themes and always use their own on their own site.
543 // This works only if the user is on the same server
544 if (!$this->session->getLocalUserId()) {
545 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
549 $mobile_theme_name = $page_mobile_theme ?: $this->session->get('mobile-theme', $system_mobile_theme);
551 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
552 if ($mobile_theme_name == '---'
554 in_array($mobile_theme_name, Theme::getAllowedList())
555 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
556 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
558 $this->setCurrentMobileTheme($mobile_theme_name);
563 * Provide a sane default if nothing is chosen or the specified theme does not exist.
565 * @return string Current theme's stylsheet path
568 public function getCurrentThemeStylesheetPath(): string
570 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
574 * Sets the base url for use in cmdline programs which don't have
577 public function checkURL()
579 $url = $this->config->get('system', 'url');
581 // if the url isn't set or the stored url is radically different
582 // than the currently visited url, store the current value accordingly.
583 // "Radically different" ignores common variations such as http vs https
584 // and www.example.com vs example.com.
585 // We will only change the url to an ip address if there is no existing setting
587 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()))) {
588 $this->config->set('system', 'url', $this->baseURL->get());
593 * Frontend App script
595 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
596 * request and a representation of the response.
598 * This probably should change to limit the size of this monster method.
600 * @param App\Router $router
601 * @param IManagePersonalConfigValues $pconfig
602 * @param Authentication $auth The Authentication backend of the node
603 * @param App\Page $page The Friendica page printing container
604 * @param HTTPInputData $httpInput A library for processing PHP input streams
605 * @param float $start_time The start time of the overall script execution
607 * @throws HTTPException\InternalServerErrorException
608 * @throws \ImagickException
610 public function runFrontend(App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, HTTPInputData $httpInput, float $start_time)
612 $this->profiler->set($start_time, 'start');
613 $this->profiler->set(microtime(true), 'classinit');
615 $moduleName = $this->args->getModuleName();
616 $page->setLogging($this->args->getMethod(), $this->args->getModuleName(), $this->args->getCommand());
619 // Missing DB connection: ERROR
620 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
621 throw new HTTPException\InternalServerErrorException($this->l10n->t('Apologies but the website is unavailable at the moment.'));
624 if (!$this->mode->isInstall()) {
625 // Force SSL redirection
626 if ($this->baseURL->checkRedirectHttps()) {
627 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
630 Core\Hook::callAll('init_1');
633 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
634 $requester = HTTPSignature::getSigner('', $_SERVER);
635 if (!empty($requester)) {
636 Profile::addVisitorCookieForHandle($requester);
641 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend() && !$this->session->getLocalUserId()) {
642 // Only continue when the given profile link seems valid.
643 // Valid profile links contain a path with "/profile/" and no query parameters
644 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == '') &&
645 strpos(parse_url($_GET['zrl'], PHP_URL_PATH) ?? '', '/profile/') !== false) {
646 if ($this->session->get('visitor_home') != $_GET['zrl']) {
647 $this->session->set('my_url', $_GET['zrl']);
648 $this->session->set('authenticated', 0);
650 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
651 if (!empty($remote_contact['subscribe'])) {
652 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
656 Model\Profile::zrlInit($this);
658 // Someone came with an invalid parameter, maybe as a DDoS attempt
659 // We simply stop processing here
660 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
661 throw new HTTPException\ForbiddenException();
665 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
666 $token = $_GET['owt'];
667 Model\Profile::openWebAuthInit($token);
670 if (!$this->mode->isBackend()) {
671 $auth->withSession($this);
674 if (empty($_SESSION['authenticated'])) {
675 header('X-Account-Management-Status: none');
679 * check_config() is responsible for running update scripts. These automatically
680 * update the DB schema whenever we push a new one out. It also checks to see if
681 * any addons have been added or removed and reacts accordingly.
684 // in install mode, any url loads install module
685 // but we need "view" module for stylesheet
686 if ($this->mode->isInstall() && $moduleName !== 'install') {
687 $this->baseURL->redirect('install');
690 Core\Update::check($this->getBasePath(), false, $this->mode);
691 Core\Addon::loadAddons();
692 Core\Hook::loadHooks();
695 // Compatibility with the Android Diaspora client
696 if ($moduleName == 'stream') {
697 $this->baseURL->redirect('network?order=post');
700 if ($moduleName == 'conversations') {
701 $this->baseURL->redirect('message');
704 if ($moduleName == 'commented') {
705 $this->baseURL->redirect('network?order=comment');
708 if ($moduleName == 'liked') {
709 $this->baseURL->redirect('network?order=comment');
712 if ($moduleName == 'activity') {
713 $this->baseURL->redirect('network?conv=1');
716 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
717 $this->baseURL->redirect('bookmarklet');
720 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
721 $this->baseURL->redirect('settings');
724 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
725 $this->baseURL->redirect('search');
728 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
729 $page['page_title'] = $moduleName;
731 // The "view" module is required to show the theme CSS
732 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'view') {
733 $module = $router->getModule(Maintenance::class);
735 // determine the module class and save it to the module instance
736 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
737 $module = $router->getModule();
740 // Processes data from GET requests
741 $httpinput = $httpInput->process();
742 $input = array_merge($httpinput['variables'], $httpinput['files'], $request ?? $_REQUEST);
744 // Let the module run it's internal process (init, get, post, ...)
745 $timestamp = microtime(true);
746 $response = $module->run($input);
747 $this->profiler->set(microtime(true) - $timestamp, 'content');
748 if ($response->getHeaderLine(ICanCreateResponses::X_HEADER) === ICanCreateResponses::TYPE_HTML) {
749 $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig, $this->session->getLocalUserId());
751 $page->exit($response);
753 } catch (HTTPException $e) {
754 (new ModuleHTTPException())->rawContent($e);
756 $page->logRuntime($this->config, 'runFrontend');
760 * Automatically redirects to relative or absolute URL
761 * Should only be used if it isn't clear if the URL is either internal or external
763 * @param string $toUrl The target URL
765 * @throws HTTPException\InternalServerErrorException
767 public function redirect(string $toUrl)
769 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
770 Core\System::externalRedirect($toUrl);
772 $this->baseURL->redirect($toUrl);