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\Module\Maintenance;
30 use Friendica\Security\Authentication;
31 use Friendica\Core\Config\ValueObject\Cache;
32 use Friendica\Core\Config\Capability\IManageConfigValues;
33 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
34 use Friendica\Core\L10n;
35 use Friendica\Core\System;
36 use Friendica\Core\Theme;
37 use Friendica\Database\Database;
38 use Friendica\Model\Contact;
39 use Friendica\Model\Profile;
40 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
41 use Friendica\Network\HTTPException;
42 use Friendica\Util\DateTimeFormat;
43 use Friendica\Util\HTTPInputData;
44 use Friendica\Util\HTTPSignature;
45 use Friendica\Util\Profiler;
46 use Friendica\Util\Strings;
47 use Psr\Log\LoggerInterface;
50 * Our main application structure for the life of this page.
52 * Primarily deals with the URL that got us here
53 * and tries to make some sense of it, and
54 * stores our page contents and config storage
55 * and anything else that might need to be passed around
56 * before we spit the page out.
61 // Allow themes to control internal parameters
62 // by changing App values in theme.php
63 private $theme_info = [
66 'events_in_profile' => true
70 private $nickname = '';
71 private $timezone = '';
72 private $profile_owner = 0;
73 private $contact_id = 0;
77 * @var App\Mode The Mode of the Application
86 /** @var string The name of the current theme */
87 private $currentTheme;
88 /** @var string The name of the current mobile theme */
89 private $currentMobileTheme;
92 * @var IManageConfigValues The config
97 * @var LoggerInterface The logger
102 * @var Profiler The profiler of this app
107 * @var Database The Friendica database connection
112 * @var L10n The translator
122 * @var IManagePersonalConfigValues
129 * @param int $user_id
132 public function setLoggedInUserId(int $user_id)
134 $this->user_id = $user_id;
140 * @param int $user_id
143 public function setLoggedInUserNickname(string $nickname)
145 $this->nickname = $nickname;
148 public function isLoggedIn(): bool
150 return local_user() && $this->user_id && ($this->user_id == local_user());
154 * Check if current user has admin role.
156 * @return bool true if user is an admin
158 public function isSiteAdmin(): bool
160 $admin_email = $this->config->get('config', 'admin_email');
162 $adminlist = explode(',', str_replace(' ', '', $admin_email));
164 return local_user() && $admin_email && $this->database->exists('user', ['uid' => $this->getLoggedInUserId(), 'email' => $adminlist]);
169 * @return int User id
171 public function getLoggedInUserId(): int
173 return $this->user_id;
177 * Fetch the user nick name
178 * @return string User's nickname
180 public function getLoggedInUserNickname(): string
182 return $this->nickname;
186 * Set the profile owner ID
188 * @param int $owner_id
191 public function setProfileOwner(int $owner_id)
193 $this->profile_owner = $owner_id;
197 * Get the profile owner ID
201 public function getProfileOwner(): int
203 return $this->profile_owner;
209 * @param int $contact_id
212 public function setContactId(int $contact_id)
214 $this->contact_id = $contact_id;
222 public function getContactId(): int
224 return $this->contact_id;
230 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
233 public function setTimeZone(string $timezone)
235 $this->timezone = (new \DateTimeZone($timezone))->getName();
236 DateTimeFormat::setLocalTimeZone($this->timezone);
244 public function getTimeZone(): string
246 return $this->timezone;
250 * Set workerqueue information
252 * @param array $queue
255 public function setQueue(array $queue)
257 $this->queue = $queue;
261 * Fetch workerqueue information
263 * @return array Worker queue
265 public function getQueue(): array
267 return $this->queue ?? [];
271 * Fetch a specific workerqueue field
273 * @param string $index Work queue record to fetch
274 * @return mixed Work queue item or NULL if not found
276 public function getQueueValue(string $index)
278 return $this->queue[$index] ?? null;
281 public function setThemeInfoValue(string $index, $value)
283 $this->theme_info[$index] = $value;
286 public function getThemeInfo()
288 return $this->theme_info;
291 public function getThemeInfoValue(string $index, $default = null)
293 return $this->theme_info[$index] ?? $default;
297 * Returns the current config cache of this node
301 public function getConfigCache()
303 return $this->config->getCache();
307 * The basepath of this app
309 * @return string Base path from configuration
311 public function getBasePath(): string
313 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
314 return $this->config->getCache()->get('system', 'basepath');
318 * @param Database $database The Friendica Database
319 * @param IManageConfigValues $config The Configuration
320 * @param App\Mode $mode The mode of this Friendica app
321 * @param BaseURL $baseURL The full base URL of this Friendica app
322 * @param LoggerInterface $logger The current app logger
323 * @param Profiler $profiler The profiler of this application
324 * @param L10n $l10n The translator instance
325 * @param App\Arguments $args The Friendica Arguments of the call
326 * @param IManagePersonalConfigValues $pConfig Personal configuration
328 public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, IManagePersonalConfigValues $pConfig)
330 $this->database = $database;
331 $this->config = $config;
333 $this->baseURL = $baseURL;
334 $this->profiler = $profiler;
335 $this->logger = $logger;
338 $this->pConfig = $pConfig;
344 * Load the whole app instance
346 public function load()
350 // Ensure that all "strtotime" operations do run timezone independent
351 date_default_timezone_set('UTC');
353 // This has to be quite large to deal with embedded private photos
354 ini_set('pcre.backtrack_limit', 500000);
357 get_include_path() . PATH_SEPARATOR
358 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
359 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
360 . $this->getBasePath());
362 $this->profiler->reset();
364 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
365 $this->profiler->update($this->config);
367 Core\Hook::loadHooks();
368 $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
369 Core\Hook::callAll('load_config', $loader);
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 overriden 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()) && Core\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 != local_user())) {
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) && !local_user()) {
486 $page_theme = $user['theme'];
490 $theme_name = $page_theme ?: Core\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 != local_user())) {
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
518 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
522 $mobile_theme_name = $page_mobile_theme ?: Core\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 stylsheet path
541 public function getCurrentThemeStylesheetPath(): string
543 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
547 * Sets the base url for use in cmdline programs which don't have
550 public function checkURL()
552 $url = $this->config->get('system', 'url');
554 // if the url isn't set or the stored url is radically different
555 // than the currently visited url, store the current value accordingly.
556 // "Radically different" ignores common variations such as http vs https
557 // and www.example.com vs example.com.
558 // We will only change the url to an ip address if there is no existing setting
560 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()))) {
561 $this->config->set('system', 'url', $this->baseURL->get());
566 * Frontend App script
568 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
569 * request and a representation of the response.
571 * This probably should change to limit the size of this monster method.
573 * @param App\Router $router
574 * @param IManagePersonalConfigValues $pconfig
575 * @param Authentication $auth The Authentication backend of the node
576 * @param App\Page $page The Friendica page printing container
577 * @param HTTPInputData $httpInput A library for processing PHP input streams
578 * @param float $start_time The start time of the overall script execution
580 * @throws HTTPException\InternalServerErrorException
581 * @throws \ImagickException
583 public function runFrontend(App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, HTTPInputData $httpInput, float $start_time)
585 $this->profiler->set($start_time, 'start');
586 $this->profiler->set(microtime(true), 'classinit');
588 $moduleName = $this->args->getModuleName();
589 $page->setLogging($this->args->getCommand(), $this->args->getMethod());
592 // Missing DB connection: ERROR
593 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
594 throw new HTTPException\InternalServerErrorException($this->l10n->t('Apologies but the website is unavailable at the moment.'));
597 if (!$this->mode->isInstall()) {
598 // Force SSL redirection
599 if ($this->baseURL->checkRedirectHttps()) {
600 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
603 Core\Hook::callAll('init_1');
606 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
607 $requester = HTTPSignature::getSigner('', $_SERVER);
608 if (!empty($requester)) {
609 Profile::addVisitorCookieForHandle($requester);
614 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend() && !local_user()) {
615 // Only continue when the given profile link seems valid
616 // Valid profile links contain a path with "/profile/" and no query parameters
617 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == '') &&
618 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), '/profile/')) {
619 if (Core\Session::get('visitor_home') != $_GET['zrl']) {
620 Core\Session::set('my_url', $_GET['zrl']);
621 Core\Session::set('authenticated', 0);
623 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
624 if (!empty($remote_contact['subscribe'])) {
625 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
629 Model\Profile::zrlInit($this);
631 // Someone came with an invalid parameter, maybe as a DDoS attempt
632 // We simply stop processing here
633 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
634 throw new HTTPException\ForbiddenException();
638 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
639 $token = $_GET['owt'];
640 Model\Profile::openWebAuthInit($token);
643 if (!$this->mode->isBackend()) {
644 $auth->withSession($this);
647 if (empty($_SESSION['authenticated'])) {
648 header('X-Account-Management-Status: none');
652 * check_config() is responsible for running update scripts. These automatically
653 * update the DB schema whenever we push a new one out. It also checks to see if
654 * any addons have been added or removed and reacts accordingly.
657 // in install mode, any url loads install module
658 // but we need "view" module for stylesheet
659 if ($this->mode->isInstall() && $moduleName !== 'install') {
660 $this->baseURL->redirect('install');
663 Core\Update::check($this->getBasePath(), false, $this->mode);
664 Core\Addon::loadAddons();
665 Core\Hook::loadHooks();
668 // Compatibility with the Android Diaspora client
669 if ($moduleName == 'stream') {
670 $this->baseURL->redirect('network?order=post');
673 if ($moduleName == 'conversations') {
674 $this->baseURL->redirect('message');
677 if ($moduleName == 'commented') {
678 $this->baseURL->redirect('network?order=comment');
681 if ($moduleName == 'liked') {
682 $this->baseURL->redirect('network?order=comment');
685 if ($moduleName == 'activity') {
686 $this->baseURL->redirect('network?conv=1');
689 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
690 $this->baseURL->redirect('bookmarklet');
693 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
694 $this->baseURL->redirect('settings');
697 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
698 $this->baseURL->redirect('search');
701 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
702 $page['page_title'] = $moduleName;
704 // The "view" module is required to show the theme CSS
705 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'view') {
706 $module = $router->getModule(Maintenance::class);
708 // determine the module class and save it to the module instance
709 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
710 $module = $router->getModule();
713 // Processes data from GET requests
714 $httpinput = $httpInput->process();
715 $input = array_merge($httpinput['variables'], $httpinput['files'], $request ?? $_REQUEST);
717 // Let the module run it's internal process (init, get, post, ...)
718 $timestamp = microtime(true);
719 $response = $module->run($input);
720 $this->profiler->set(microtime(true) - $timestamp, 'content');
721 if ($response->getHeaderLine(ICanCreateResponses::X_HEADER) === ICanCreateResponses::TYPE_HTML) {
722 $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig);
724 $page->exit($response);
726 } catch (HTTPException $e) {
727 (new ModuleHTTPException())->rawContent($e);
729 $page->logRuntime($this->config, 'runFrontend');
733 * Automatically redirects to relative or absolute URL
734 * Should only be used if it isn't clear if the URL is either internal or external
736 * @param string $toUrl The target URL
738 * @throws HTTPException\InternalServerErrorException
740 public function redirect(string $toUrl)
742 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
743 Core\System::externalRedirect($toUrl);
745 $this->baseURL->redirect($toUrl);