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\Module\Maintenance;
31 use Friendica\Security\Authentication;
32 use Friendica\Core\Config\ValueObject\Cache;
33 use Friendica\Core\Config\Capability\IManageConfigValues;
34 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
35 use Friendica\Core\L10n;
36 use Friendica\Core\System;
37 use Friendica\Core\Theme;
38 use Friendica\Database\Database;
39 use Friendica\Model\Contact;
40 use Friendica\Model\Profile;
41 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
42 use Friendica\Network\HTTPException;
43 use Friendica\Util\DateTimeFormat;
44 use Friendica\Util\HTTPInputData;
45 use Friendica\Util\HTTPSignature;
46 use Friendica\Util\Profiler;
47 use Friendica\Util\Strings;
48 use Psr\Log\LoggerInterface;
51 * Our main application structure for the life of this page.
53 * Primarily deals with the URL that got us here
54 * and tries to make some sense of it, and
55 * stores our page contents and config storage
56 * and anything else that might need to be passed around
57 * before we spit the page out.
62 const PLATFORM = 'Friendica';
63 const CODENAME = 'Giant Rhubarb';
64 const VERSION = '2022.12-dev';
66 // Allow themes to control internal parameters
67 // by changing App values in theme.php
68 private $theme_info = [
71 'events_in_profile' => true
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
168 public function isSiteAdmin(): bool
170 $admin_email = $this->config->get('config', 'admin_email');
172 $adminlist = explode(',', str_replace(' ', '', $admin_email));
174 return $this->session->getLocalUserId() && $admin_email && $this->database->exists('user', ['uid' => $this->getLoggedInUserId(), 'email' => $adminlist]);
179 * @return int User id
181 public function getLoggedInUserId(): int
183 return $this->user_id;
187 * Fetch the user nick name
188 * @return string User's nickname
190 public function getLoggedInUserNickname(): string
192 return $this->nickname;
196 * Set the profile owner ID
198 * @param int $owner_id
201 public function setProfileOwner(int $owner_id)
203 $this->profile_owner = $owner_id;
207 * Get the profile owner ID
211 public function getProfileOwner(): int
213 return $this->profile_owner;
219 * @param int $contact_id
222 public function setContactId(int $contact_id)
224 $this->contact_id = $contact_id;
232 public function getContactId(): int
234 return $this->contact_id;
240 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
243 public function setTimeZone(string $timezone)
245 $this->timezone = (new \DateTimeZone($timezone))->getName();
246 DateTimeFormat::setLocalTimeZone($this->timezone);
254 public function getTimeZone(): string
256 return $this->timezone;
260 * Set workerqueue information
262 * @param array $queue
265 public function setQueue(array $queue)
267 $this->queue = $queue;
271 * Fetch workerqueue information
273 * @return array Worker queue
275 public function getQueue(): array
277 return $this->queue ?? [];
281 * Fetch a specific workerqueue field
283 * @param string $index Work queue record to fetch
284 * @return mixed Work queue item or NULL if not found
286 public function getQueueValue(string $index)
288 return $this->queue[$index] ?? null;
291 public function setThemeInfoValue(string $index, $value)
293 $this->theme_info[$index] = $value;
296 public function getThemeInfo()
298 return $this->theme_info;
301 public function getThemeInfoValue(string $index, $default = null)
303 return $this->theme_info[$index] ?? $default;
307 * Returns the current config cache of this node
311 public function getConfigCache()
313 return $this->config->getCache();
317 * The basepath of this app
319 * @return string Base path from configuration
321 public function getBasePath(): string
323 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
324 return $this->config->getCache()->get('system', 'basepath');
328 * @param Database $database The Friendica Database
329 * @param IManageConfigValues $config The Configuration
330 * @param App\Mode $mode The mode of this Friendica app
331 * @param BaseURL $baseURL The full base URL of this Friendica app
332 * @param LoggerInterface $logger The current app logger
333 * @param Profiler $profiler The profiler of this application
334 * @param L10n $l10n The translator instance
335 * @param App\Arguments $args The Friendica Arguments of the call
336 * @param IManagePersonalConfigValues $pConfig Personal configuration
337 * @param IHandleUserSessions $session The (User)Session handler
339 public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, IManagePersonalConfigValues $pConfig, IHandleUserSessions $session)
341 $this->database = $database;
342 $this->config = $config;
344 $this->baseURL = $baseURL;
345 $this->profiler = $profiler;
346 $this->logger = $logger;
349 $this->pConfig = $pConfig;
350 $this->session = $session;
356 * Load the whole app instance
358 public function load()
362 // Normally this constant is defined - but not if "pcntl" isn't installed
363 if (!defined('SIGTERM')) {
364 define('SIGTERM', 15);
367 // Ensure that all "strtotime" operations do run timezone independent
368 date_default_timezone_set('UTC');
370 // This has to be quite large to deal with embedded private photos
371 ini_set('pcre.backtrack_limit', 500000);
374 get_include_path() . PATH_SEPARATOR
375 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
376 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
377 . $this->getBasePath());
379 $this->profiler->reset();
381 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
382 $this->profiler->update($this->config);
384 Core\Hook::loadHooks();
385 $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
386 Core\Hook::callAll('load_config', $loader);
389 $this->loadDefaultTimezone();
390 // Register template engines
391 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
395 * Loads the default timezone
397 * Include support for legacy $default_timezone
399 * @global string $default_timezone
401 private function loadDefaultTimezone()
403 if ($this->config->get('system', 'default_timezone')) {
404 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
406 global $default_timezone;
407 $timezone = $default_timezone ?? '' ?: 'UTC';
410 $this->setTimeZone($timezone);
414 * Returns the current theme name. May be overriden by the mobile theme name.
416 * @return string Current theme name or empty string in installation phase
419 public function getCurrentTheme(): string
421 if ($this->mode->isInstall()) {
425 // Specific mobile theme override
426 if (($this->mode->isMobile() || $this->mode->isTablet()) && $this->session->get('show-mobile', true)) {
427 $user_mobile_theme = $this->getCurrentMobileTheme();
429 // --- means same mobile theme as desktop
430 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
431 return $user_mobile_theme;
435 if (!$this->currentTheme) {
436 $this->computeCurrentTheme();
439 return $this->currentTheme;
443 * Returns the current mobile theme name.
445 * @return string Mobile theme name or empty string if installer
448 public function getCurrentMobileTheme(): string
450 if ($this->mode->isInstall()) {
454 if (is_null($this->currentMobileTheme)) {
455 $this->computeCurrentMobileTheme();
458 return $this->currentMobileTheme;
462 * Setter for current theme name
464 * @param string $theme Name of current theme
466 public function setCurrentTheme(string $theme)
468 $this->currentTheme = $theme;
472 * Setter for current mobile theme name
474 * @param string $theme Name of current mobile theme
476 public function setCurrentMobileTheme(string $theme)
478 $this->currentMobileTheme = $theme;
482 * Computes the current theme name based on the node settings, the page owner settings and the user settings
486 private function computeCurrentTheme()
488 $system_theme = $this->config->get('system', 'theme');
489 if (!$system_theme) {
490 throw new Exception($this->l10n->t('No system theme config value set.'));
494 $this->setCurrentTheme($system_theme);
497 // Find the theme that belongs to the user whose stuff we are looking at
498 if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
499 // Allow folks to override user themes and always use their own on their own site.
500 // This works only if the user is on the same server
501 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
502 if ($this->database->isResult($user) && !$this->session->getLocalUserId()) {
503 $page_theme = $user['theme'];
507 $theme_name = $page_theme ?: $this->session->get('theme', $system_theme);
509 $theme_name = Strings::sanitizeFilePathItem($theme_name);
511 && in_array($theme_name, Theme::getAllowedList())
512 && (file_exists('view/theme/' . $theme_name . '/style.css')
513 || file_exists('view/theme/' . $theme_name . '/style.php'))
515 $this->setCurrentTheme($theme_name);
520 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
522 private function computeCurrentMobileTheme()
524 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
527 $this->setCurrentMobileTheme($system_mobile_theme);
529 $page_mobile_theme = null;
530 // Find the theme that belongs to the user whose stuff we are looking at
531 if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
532 // Allow folks to override user themes and always use their own on their own site.
533 // This works only if the user is on the same server
534 if (!$this->session->getLocalUserId()) {
535 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
539 $mobile_theme_name = $page_mobile_theme ?: $this->session->get('mobile-theme', $system_mobile_theme);
541 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
542 if ($mobile_theme_name == '---'
544 in_array($mobile_theme_name, Theme::getAllowedList())
545 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
546 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
548 $this->setCurrentMobileTheme($mobile_theme_name);
553 * Provide a sane default if nothing is chosen or the specified theme does not exist.
555 * @return string Current theme's stylsheet path
558 public function getCurrentThemeStylesheetPath(): string
560 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
564 * Sets the base url for use in cmdline programs which don't have
567 public function checkURL()
569 $url = $this->config->get('system', 'url');
571 // if the url isn't set or the stored url is radically different
572 // than the currently visited url, store the current value accordingly.
573 // "Radically different" ignores common variations such as http vs https
574 // and www.example.com vs example.com.
575 // We will only change the url to an ip address if there is no existing setting
577 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()))) {
578 $this->config->set('system', 'url', $this->baseURL->get());
583 * Frontend App script
585 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
586 * request and a representation of the response.
588 * This probably should change to limit the size of this monster method.
590 * @param App\Router $router
591 * @param IManagePersonalConfigValues $pconfig
592 * @param Authentication $auth The Authentication backend of the node
593 * @param App\Page $page The Friendica page printing container
594 * @param HTTPInputData $httpInput A library for processing PHP input streams
595 * @param float $start_time The start time of the overall script execution
597 * @throws HTTPException\InternalServerErrorException
598 * @throws \ImagickException
600 public function runFrontend(App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, HTTPInputData $httpInput, float $start_time)
602 $this->profiler->set($start_time, 'start');
603 $this->profiler->set(microtime(true), 'classinit');
605 $moduleName = $this->args->getModuleName();
606 $page->setLogging($this->args->getMethod(), $this->args->getModuleName(), $this->args->getCommand());
609 // Missing DB connection: ERROR
610 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
611 throw new HTTPException\InternalServerErrorException($this->l10n->t('Apologies but the website is unavailable at the moment.'));
614 if (!$this->mode->isInstall()) {
615 // Force SSL redirection
616 if ($this->baseURL->checkRedirectHttps()) {
617 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
620 Core\Hook::callAll('init_1');
623 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
624 $requester = HTTPSignature::getSigner('', $_SERVER);
625 if (!empty($requester)) {
626 Profile::addVisitorCookieForHandle($requester);
631 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend() && !$this->session->getLocalUserId()) {
632 // Only continue when the given profile link seems valid
633 // Valid profile links contain a path with "/profile/" and no query parameters
634 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == '') &&
635 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), '/profile/')) {
636 if ($this->session->get('visitor_home') != $_GET['zrl']) {
637 $this->session->set('my_url', $_GET['zrl']);
638 $this->session->set('authenticated', 0);
640 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
641 if (!empty($remote_contact['subscribe'])) {
642 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
646 Model\Profile::zrlInit($this);
648 // Someone came with an invalid parameter, maybe as a DDoS attempt
649 // We simply stop processing here
650 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
651 throw new HTTPException\ForbiddenException();
655 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
656 $token = $_GET['owt'];
657 Model\Profile::openWebAuthInit($token);
660 if (!$this->mode->isBackend()) {
661 $auth->withSession($this);
664 if (empty($_SESSION['authenticated'])) {
665 header('X-Account-Management-Status: none');
669 * check_config() is responsible for running update scripts. These automatically
670 * update the DB schema whenever we push a new one out. It also checks to see if
671 * any addons have been added or removed and reacts accordingly.
674 // in install mode, any url loads install module
675 // but we need "view" module for stylesheet
676 if ($this->mode->isInstall() && $moduleName !== 'install') {
677 $this->baseURL->redirect('install');
680 Core\Update::check($this->getBasePath(), false, $this->mode);
681 Core\Addon::loadAddons();
682 Core\Hook::loadHooks();
685 // Compatibility with the Android Diaspora client
686 if ($moduleName == 'stream') {
687 $this->baseURL->redirect('network?order=post');
690 if ($moduleName == 'conversations') {
691 $this->baseURL->redirect('message');
694 if ($moduleName == 'commented') {
695 $this->baseURL->redirect('network?order=comment');
698 if ($moduleName == 'liked') {
699 $this->baseURL->redirect('network?order=comment');
702 if ($moduleName == 'activity') {
703 $this->baseURL->redirect('network?conv=1');
706 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
707 $this->baseURL->redirect('bookmarklet');
710 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
711 $this->baseURL->redirect('settings');
714 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
715 $this->baseURL->redirect('search');
718 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
719 $page['page_title'] = $moduleName;
721 // The "view" module is required to show the theme CSS
722 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'view') {
723 $module = $router->getModule(Maintenance::class);
725 // determine the module class and save it to the module instance
726 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
727 $module = $router->getModule();
730 // Processes data from GET requests
731 $httpinput = $httpInput->process();
732 $input = array_merge($httpinput['variables'], $httpinput['files'], $request ?? $_REQUEST);
734 // Let the module run it's internal process (init, get, post, ...)
735 $timestamp = microtime(true);
736 $response = $module->run($input);
737 $this->profiler->set(microtime(true) - $timestamp, 'content');
738 if ($response->getHeaderLine(ICanCreateResponses::X_HEADER) === ICanCreateResponses::TYPE_HTML) {
739 $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig, $this->session->getLocalUserId());
741 $page->exit($response);
743 } catch (HTTPException $e) {
744 (new ModuleHTTPException())->rawContent($e);
746 $page->logRuntime($this->config, 'runFrontend');
750 * Automatically redirects to relative or absolute URL
751 * Should only be used if it isn't clear if the URL is either internal or external
753 * @param string $toUrl The target URL
755 * @throws HTTPException\InternalServerErrorException
757 public function redirect(string $toUrl)
759 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
760 Core\System::externalRedirect($toUrl);
762 $this->baseURL->redirect($toUrl);