3 * @copyright Copyright (C) 2010-2021, 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\App\Module;
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\HTTPSignature;
44 use Friendica\Util\Profiler;
45 use Friendica\Util\Strings;
46 use Psr\Log\LoggerInterface;
49 * Our main application structure for the life of this page.
51 * Primarily deals with the URL that got us here
52 * and tries to make some sense of it, and
53 * stores our page contents and config storage
54 * and anything else that might need to be passed around
55 * before we spit the page out.
60 // Allow themes to control internal parameters
61 // by changing App values in theme.php
62 private $theme_info = [
65 'events_in_profile' => true
69 private $nickname = '';
70 private $timezone = '';
71 private $profile_owner = 0;
72 private $contact_id = 0;
76 * @var App\Mode The Mode of the Application
85 /** @var string The name of the current theme */
86 private $currentTheme;
87 /** @var string The name of the current mobile theme */
88 private $currentMobileTheme;
91 * @var IManageConfigValues The config
96 * @var LoggerInterface The logger
101 * @var Profiler The profiler of this app
106 * @var Database The Friendica database connection
111 * @var L10n The translator
121 * @var Core\System The system methods
126 * @var IManagePersonalConfigValues
133 * @param int $user_id
136 public function setLoggedInUserId(int $user_id)
138 $this->user_id = $user_id;
144 * @param int $user_id
147 public function setLoggedInUserNickname(string $nickname)
149 $this->nickname = $nickname;
152 public function isLoggedIn()
154 return local_user() && $this->user_id && ($this->user_id == local_user());
158 * Check if current user has admin role.
160 * @return bool true if user is an admin
162 public function isSiteAdmin()
164 $admin_email = $this->config->get('config', 'admin_email');
166 $adminlist = explode(',', str_replace(' ', '', $admin_email));
168 return local_user() && $admin_email && $this->database->exists('user', ['uid' => $this->getLoggedInUserId(), 'email' => $adminlist]);
175 public function getLoggedInUserId()
177 return $this->user_id;
181 * Fetch the user nick name
184 public function getLoggedInUserNickname()
186 return $this->nickname;
190 * Set the profile owner ID
192 * @param int $owner_id
195 public function setProfileOwner(int $owner_id)
197 $this->profile_owner = $owner_id;
201 * Get the profile owner ID
205 public function getProfileOwner():int
207 return $this->profile_owner;
213 * @param int $contact_id
216 public function setContactId(int $contact_id)
218 $this->contact_id = $contact_id;
226 public function getContactId():int
228 return $this->contact_id;
234 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
237 public function setTimeZone(string $timezone)
239 $this->timezone = (new \DateTimeZone($timezone))->getName();
240 DateTimeFormat::setLocalTimeZone($this->timezone);
248 public function getTimeZone():string
250 return $this->timezone;
254 * Set workerqueue information
256 * @param array $queue
259 public function setQueue(array $queue)
261 $this->queue = $queue;
265 * Fetch workerqueue information
269 public function getQueue()
271 return $this->queue ?? [];
275 * Fetch a specific workerqueue field
277 * @param string $index
280 public function getQueueValue(string $index)
282 return $this->queue[$index] ?? null;
285 public function setThemeInfoValue(string $index, $value)
287 $this->theme_info[$index] = $value;
290 public function getThemeInfo()
292 return $this->theme_info;
295 public function getThemeInfoValue(string $index, $default = null)
297 return $this->theme_info[$index] ?? $default;
301 * Returns the current config cache of this node
305 public function getConfigCache()
307 return $this->config->getCache();
311 * The basepath of this app
315 public function getBasePath()
317 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
318 return $this->config->getCache()->get('system', 'basepath');
322 * @param Database $database The Friendica Database
323 * @param IManageConfigValues $config The Configuration
324 * @param App\Mode $mode The mode of this Friendica app
325 * @param BaseURL $baseURL The full base URL of this Friendica app
326 * @param LoggerInterface $logger The current app logger
327 * @param Profiler $profiler The profiler of this application
328 * @param L10n $l10n The translator instance
329 * @param App\Arguments $args The Friendica Arguments of the call
330 * @param Core\System $system The system methods
331 * @param IManagePersonalConfigValues $pConfig Personal configuration
333 public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, Core\System $system, IManagePersonalConfigValues $pConfig)
335 $this->database = $database;
336 $this->config = $config;
338 $this->baseURL = $baseURL;
339 $this->profiler = $profiler;
340 $this->logger = $logger;
343 $this->system = $system;
344 $this->pConfig = $pConfig;
350 * Load the whole app instance
352 public function load()
356 // Ensure that all "strtotime" operations do run timezone independent
357 date_default_timezone_set('UTC');
359 // This has to be quite large to deal with embedded private photos
360 ini_set('pcre.backtrack_limit', 500000);
363 get_include_path() . PATH_SEPARATOR
364 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
365 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
366 . $this->getBasePath());
368 $this->profiler->reset();
370 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
371 $this->profiler->update($this->config);
373 Core\Hook::loadHooks();
374 $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
375 Core\Hook::callAll('load_config', $loader);
378 $this->loadDefaultTimezone();
379 // Register template engines
380 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
384 * Loads the default timezone
386 * Include support for legacy $default_timezone
388 * @global string $default_timezone
390 private function loadDefaultTimezone()
392 if ($this->config->get('system', 'default_timezone')) {
393 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
395 global $default_timezone;
396 $timezone = $default_timezone ?? '' ?: 'UTC';
399 $this->setTimeZone($timezone);
403 * Returns the current theme name. May be overriden by the mobile theme name.
408 public function getCurrentTheme()
410 if ($this->mode->isInstall()) {
414 // Specific mobile theme override
415 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
416 $user_mobile_theme = $this->getCurrentMobileTheme();
418 // --- means same mobile theme as desktop
419 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
420 return $user_mobile_theme;
424 if (!$this->currentTheme) {
425 $this->computeCurrentTheme();
428 return $this->currentTheme;
432 * Returns the current mobile theme name.
437 public function getCurrentMobileTheme()
439 if ($this->mode->isInstall()) {
443 if (is_null($this->currentMobileTheme)) {
444 $this->computeCurrentMobileTheme();
447 return $this->currentMobileTheme;
450 public function setCurrentTheme($theme)
452 $this->currentTheme = $theme;
455 public function setCurrentMobileTheme($theme)
457 $this->currentMobileTheme = $theme;
461 * Computes the current theme name based on the node settings, the page owner settings and the user settings
465 private function computeCurrentTheme()
467 $system_theme = $this->config->get('system', 'theme');
468 if (!$system_theme) {
469 throw new Exception($this->l10n->t('No system theme config value set.'));
473 $this->setCurrentTheme($system_theme);
476 // Find the theme that belongs to the user whose stuff we are looking at
477 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
478 // Allow folks to override user themes and always use their own on their own site.
479 // This works only if the user is on the same server
480 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
481 if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
482 $page_theme = $user['theme'];
486 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
488 $theme_name = Strings::sanitizeFilePathItem($theme_name);
490 && in_array($theme_name, Theme::getAllowedList())
491 && (file_exists('view/theme/' . $theme_name . '/style.css')
492 || file_exists('view/theme/' . $theme_name . '/style.php'))
494 $this->setCurrentTheme($theme_name);
499 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
501 private function computeCurrentMobileTheme()
503 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
506 $this->setCurrentMobileTheme($system_mobile_theme);
508 $page_mobile_theme = null;
509 // Find the theme that belongs to the user whose stuff we are looking at
510 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
511 // Allow folks to override user themes and always use their own on their own site.
512 // This works only if the user is on the same server
513 if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
514 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
518 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
520 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
521 if ($mobile_theme_name == '---'
523 in_array($mobile_theme_name, Theme::getAllowedList())
524 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
525 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
527 $this->setCurrentMobileTheme($mobile_theme_name);
532 * Provide a sane default if nothing is chosen or the specified theme does not exist.
537 public function getCurrentThemeStylesheetPath()
539 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
543 * Sets the base url for use in cmdline programs which don't have
546 public function checkURL()
548 $url = $this->config->get('system', 'url');
550 // if the url isn't set or the stored url is radically different
551 // than the currently visited url, store the current value accordingly.
552 // "Radically different" ignores common variations such as http vs https
553 // and www.example.com vs example.com.
554 // We will only change the url to an ip address if there is no existing setting
556 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()))) {
557 $this->config->set('system', 'url', $this->baseURL->get());
562 * Frontend App script
564 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
565 * request and a representation of the response.
567 * This probably should change to limit the size of this monster method.
569 * @param App\Module $module The determined module
570 * @param App\Router $router
571 * @param IManagePersonalConfigValues $pconfig
572 * @param Authentication $auth The Authentication backend of the node
573 * @param App\Page $page The Friendica page printing container
575 * @throws HTTPException\InternalServerErrorException
576 * @throws \ImagickException
578 public function runFrontend(App\Module $module, App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, float $start_time)
580 $this->profiler->set($start_time, 'start');
581 $this->profiler->set(microtime(true), 'classinit');
583 $moduleName = $module->getName();
586 // Missing DB connection: ERROR
587 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
588 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
591 if (!$this->mode->isInstall()) {
592 // Force SSL redirection
593 if ($this->baseURL->checkRedirectHttps()) {
594 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
597 Core\Hook::callAll('init_1');
600 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
601 $requester = HTTPSignature::getSigner('', $_SERVER);
602 if (!empty($requester)) {
603 Profile::addVisitorCookieForHandle($requester);
608 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend()) {
610 // Only continue when the given profile link seems valid
611 // Valid profile links contain a path with "/profile/" and no query parameters
612 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
613 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
614 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
615 Core\Session::set('my_url', $_GET['zrl']);
616 Core\Session::set('authenticated', 0);
618 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
619 if (!empty($remote_contact['subscribe'])) {
620 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
624 Model\Profile::zrlInit($this);
626 // Someone came with an invalid parameter, maybe as a DDoS attempt
627 // We simply stop processing here
628 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
629 throw new HTTPException\ForbiddenException();
634 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
635 $token = $_GET['owt'];
636 Model\Profile::openWebAuthInit($token);
639 if (!$this->mode->isBackend()) {
640 $auth->withSession($this);
643 if (empty($_SESSION['authenticated'])) {
644 header('X-Account-Management-Status: none');
647 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
648 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
649 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
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 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
705 $module = new Module('maintenance', 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 = $module->determineClass($this->args, $router, $this->config);
712 // Let the module run it's internal process (init, get, post, ...)
713 $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
714 } catch (HTTPException $e) {
715 ModuleHTTPException::rawContent($e);
718 $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
722 * Automatically redirects to relative or absolute URL
723 * Should only be used if it isn't clear if the URL is either internal or external
725 * @param string $toUrl The target URL
727 * @throws HTTPException\InternalServerErrorException
729 public function redirect($toUrl)
731 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
732 Core\System::externalRedirect($toUrl);
734 $this->baseURL->redirect($toUrl);