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\Core\Config\Factory\Config;
28 use Friendica\Module\Maintenance;
29 use Friendica\Security\Authentication;
30 use Friendica\Core\Config\ValueObject\Cache;
31 use Friendica\Core\Config\Capability\IManageConfigValues;
32 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
33 use Friendica\Core\L10n;
34 use Friendica\Core\System;
35 use Friendica\Core\Theme;
36 use Friendica\Database\Database;
37 use Friendica\Model\Contact;
38 use Friendica\Model\Profile;
39 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
40 use Friendica\Network\HTTPException;
41 use Friendica\Util\DateTimeFormat;
42 use Friendica\Util\HTTPSignature;
43 use Friendica\Util\Profiler;
44 use Friendica\Util\Strings;
45 use Psr\Log\LoggerInterface;
48 * Our main application structure for the life of this page.
50 * Primarily deals with the URL that got us here
51 * and tries to make some sense of it, and
52 * stores our page contents and config storage
53 * and anything else that might need to be passed around
54 * before we spit the page out.
59 // Allow themes to control internal parameters
60 // by changing App values in theme.php
61 private $theme_info = [
64 'events_in_profile' => true
68 private $nickname = '';
69 private $timezone = '';
70 private $profile_owner = 0;
71 private $contact_id = 0;
75 * @var App\Mode The Mode of the Application
84 /** @var string The name of the current theme */
85 private $currentTheme;
86 /** @var string The name of the current mobile theme */
87 private $currentMobileTheme;
90 * @var IManageConfigValues The config
95 * @var LoggerInterface The logger
100 * @var Profiler The profiler of this app
105 * @var Database The Friendica database connection
110 * @var L10n The translator
120 * @var IManagePersonalConfigValues
127 * @param int $user_id
130 public function setLoggedInUserId(int $user_id)
132 $this->user_id = $user_id;
138 * @param int $user_id
141 public function setLoggedInUserNickname(string $nickname)
143 $this->nickname = $nickname;
146 public function isLoggedIn()
148 return local_user() && $this->user_id && ($this->user_id == local_user());
152 * Check if current user has admin role.
154 * @return bool true if user is an admin
156 public function isSiteAdmin()
158 $admin_email = $this->config->get('config', 'admin_email');
160 $adminlist = explode(',', str_replace(' ', '', $admin_email));
162 return local_user() && $admin_email && $this->database->exists('user', ['uid' => $this->getLoggedInUserId(), 'email' => $adminlist]);
169 public function getLoggedInUserId()
171 return $this->user_id;
175 * Fetch the user nick name
178 public function getLoggedInUserNickname()
180 return $this->nickname;
184 * Set the profile owner ID
186 * @param int $owner_id
189 public function setProfileOwner(int $owner_id)
191 $this->profile_owner = $owner_id;
195 * Get the profile owner ID
199 public function getProfileOwner():int
201 return $this->profile_owner;
207 * @param int $contact_id
210 public function setContactId(int $contact_id)
212 $this->contact_id = $contact_id;
220 public function getContactId():int
222 return $this->contact_id;
228 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
231 public function setTimeZone(string $timezone)
233 $this->timezone = (new \DateTimeZone($timezone))->getName();
234 DateTimeFormat::setLocalTimeZone($this->timezone);
242 public function getTimeZone():string
244 return $this->timezone;
248 * Set workerqueue information
250 * @param array $queue
253 public function setQueue(array $queue)
255 $this->queue = $queue;
259 * Fetch workerqueue information
263 public function getQueue()
265 return $this->queue ?? [];
269 * Fetch a specific workerqueue field
271 * @param string $index
274 public function getQueueValue(string $index)
276 return $this->queue[$index] ?? null;
279 public function setThemeInfoValue(string $index, $value)
281 $this->theme_info[$index] = $value;
284 public function getThemeInfo()
286 return $this->theme_info;
289 public function getThemeInfoValue(string $index, $default = null)
291 return $this->theme_info[$index] ?? $default;
295 * Returns the current config cache of this node
299 public function getConfigCache()
301 return $this->config->getCache();
305 * The basepath of this app
309 public function getBasePath()
311 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
312 return $this->config->getCache()->get('system', 'basepath');
316 * @param Database $database The Friendica Database
317 * @param IManageConfigValues $config The Configuration
318 * @param App\Mode $mode The mode of this Friendica app
319 * @param BaseURL $baseURL The full base URL of this Friendica app
320 * @param LoggerInterface $logger The current app logger
321 * @param Profiler $profiler The profiler of this application
322 * @param L10n $l10n The translator instance
323 * @param App\Arguments $args The Friendica Arguments of the call
324 * @param IManagePersonalConfigValues $pConfig Personal configuration
326 public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, IManagePersonalConfigValues $pConfig)
328 $this->database = $database;
329 $this->config = $config;
331 $this->baseURL = $baseURL;
332 $this->profiler = $profiler;
333 $this->logger = $logger;
336 $this->pConfig = $pConfig;
342 * Load the whole app instance
344 public function load()
348 // Ensure that all "strtotime" operations do run timezone independent
349 date_default_timezone_set('UTC');
351 // This has to be quite large to deal with embedded private photos
352 ini_set('pcre.backtrack_limit', 500000);
355 get_include_path() . PATH_SEPARATOR
356 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
357 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
358 . $this->getBasePath());
360 $this->profiler->reset();
362 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
363 $this->profiler->update($this->config);
365 Core\Hook::loadHooks();
366 $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
367 Core\Hook::callAll('load_config', $loader);
370 $this->loadDefaultTimezone();
371 // Register template engines
372 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
376 * Loads the default timezone
378 * Include support for legacy $default_timezone
380 * @global string $default_timezone
382 private function loadDefaultTimezone()
384 if ($this->config->get('system', 'default_timezone')) {
385 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
387 global $default_timezone;
388 $timezone = $default_timezone ?? '' ?: 'UTC';
391 $this->setTimeZone($timezone);
395 * Returns the current theme name. May be overriden by the mobile theme name.
400 public function getCurrentTheme()
402 if ($this->mode->isInstall()) {
406 // Specific mobile theme override
407 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
408 $user_mobile_theme = $this->getCurrentMobileTheme();
410 // --- means same mobile theme as desktop
411 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
412 return $user_mobile_theme;
416 if (!$this->currentTheme) {
417 $this->computeCurrentTheme();
420 return $this->currentTheme;
424 * Returns the current mobile theme name.
429 public function getCurrentMobileTheme()
431 if ($this->mode->isInstall()) {
435 if (is_null($this->currentMobileTheme)) {
436 $this->computeCurrentMobileTheme();
439 return $this->currentMobileTheme;
442 public function setCurrentTheme($theme)
444 $this->currentTheme = $theme;
447 public function setCurrentMobileTheme($theme)
449 $this->currentMobileTheme = $theme;
453 * Computes the current theme name based on the node settings, the page owner settings and the user settings
457 private function computeCurrentTheme()
459 $system_theme = $this->config->get('system', 'theme');
460 if (!$system_theme) {
461 throw new Exception($this->l10n->t('No system theme config value set.'));
465 $this->setCurrentTheme($system_theme);
468 // Find the theme that belongs to the user whose stuff we are looking at
469 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
470 // Allow folks to override user themes and always use their own on their own site.
471 // This works only if the user is on the same server
472 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
473 if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
474 $page_theme = $user['theme'];
478 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
480 $theme_name = Strings::sanitizeFilePathItem($theme_name);
482 && in_array($theme_name, Theme::getAllowedList())
483 && (file_exists('view/theme/' . $theme_name . '/style.css')
484 || file_exists('view/theme/' . $theme_name . '/style.php'))
486 $this->setCurrentTheme($theme_name);
491 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
493 private function computeCurrentMobileTheme()
495 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
498 $this->setCurrentMobileTheme($system_mobile_theme);
500 $page_mobile_theme = null;
501 // Find the theme that belongs to the user whose stuff we are looking at
502 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
503 // Allow folks to override user themes and always use their own on their own site.
504 // This works only if the user is on the same server
505 if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
506 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
510 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
512 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
513 if ($mobile_theme_name == '---'
515 in_array($mobile_theme_name, Theme::getAllowedList())
516 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
517 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
519 $this->setCurrentMobileTheme($mobile_theme_name);
524 * Provide a sane default if nothing is chosen or the specified theme does not exist.
529 public function getCurrentThemeStylesheetPath()
531 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
535 * Sets the base url for use in cmdline programs which don't have
538 public function checkURL()
540 $url = $this->config->get('system', 'url');
542 // if the url isn't set or the stored url is radically different
543 // than the currently visited url, store the current value accordingly.
544 // "Radically different" ignores common variations such as http vs https
545 // and www.example.com vs example.com.
546 // We will only change the url to an ip address if there is no existing setting
548 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()))) {
549 $this->config->set('system', 'url', $this->baseURL->get());
554 * Frontend App script
556 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
557 * request and a representation of the response.
559 * This probably should change to limit the size of this monster method.
561 * @param App\Router $router
562 * @param IManagePersonalConfigValues $pconfig
563 * @param Authentication $auth The Authentication backend of the node
564 * @param App\Page $page The Friendica page printing container
566 * @throws HTTPException\InternalServerErrorException
567 * @throws \ImagickException
569 public function runFrontend(App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, float $start_time)
571 $this->profiler->set($start_time, 'start');
572 $this->profiler->set(microtime(true), 'classinit');
574 $moduleName = $this->args->getModuleName();
577 // Missing DB connection: ERROR
578 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
579 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
582 if (!$this->mode->isInstall()) {
583 // Force SSL redirection
584 if ($this->baseURL->checkRedirectHttps()) {
585 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
588 Core\Hook::callAll('init_1');
591 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
592 $requester = HTTPSignature::getSigner('', $_SERVER);
593 if (!empty($requester)) {
594 Profile::addVisitorCookieForHandle($requester);
599 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend()) {
601 // Only continue when the given profile link seems valid
602 // Valid profile links contain a path with "/profile/" and no query parameters
603 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
604 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
605 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
606 Core\Session::set('my_url', $_GET['zrl']);
607 Core\Session::set('authenticated', 0);
609 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
610 if (!empty($remote_contact['subscribe'])) {
611 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
615 Model\Profile::zrlInit($this);
617 // Someone came with an invalid parameter, maybe as a DDoS attempt
618 // We simply stop processing here
619 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
620 throw new HTTPException\ForbiddenException();
625 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
626 $token = $_GET['owt'];
627 Model\Profile::openWebAuthInit($token);
630 if (!$this->mode->isBackend()) {
631 $auth->withSession($this);
634 if (empty($_SESSION['authenticated'])) {
635 header('X-Account-Management-Status: none');
638 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
639 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
640 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
643 * check_config() is responsible for running update scripts. These automatically
644 * update the DB schema whenever we push a new one out. It also checks to see if
645 * any addons have been added or removed and reacts accordingly.
648 // in install mode, any url loads install module
649 // but we need "view" module for stylesheet
650 if ($this->mode->isInstall() && $moduleName !== 'install') {
651 $this->baseURL->redirect('install');
654 Core\Update::check($this->getBasePath(), false, $this->mode);
655 Core\Addon::loadAddons();
656 Core\Hook::loadHooks();
659 // Compatibility with the Android Diaspora client
660 if ($moduleName == 'stream') {
661 $this->baseURL->redirect('network?order=post');
664 if ($moduleName == 'conversations') {
665 $this->baseURL->redirect('message');
668 if ($moduleName == 'commented') {
669 $this->baseURL->redirect('network?order=comment');
672 if ($moduleName == 'liked') {
673 $this->baseURL->redirect('network?order=comment');
676 if ($moduleName == 'activity') {
677 $this->baseURL->redirect('network?conv=1');
680 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
681 $this->baseURL->redirect('bookmarklet');
684 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
685 $this->baseURL->redirect('settings');
688 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
689 $this->baseURL->redirect('search');
692 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
693 $page['page_title'] = $moduleName;
695 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
696 $module = $router->getModule(Maintenance::class);
698 // determine the module class and save it to the module instance
699 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
700 $module = $router->getModule();
703 // Let the module run it's internal process (init, get, post, ...)
704 $response = $module->run($_POST, $_REQUEST);
705 $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig);
706 } catch (HTTPException $e) {
707 (new ModuleHTTPException())->rawContent($e);
712 * Automatically redirects to relative or absolute URL
713 * Should only be used if it isn't clear if the URL is either internal or external
715 * @param string $toUrl The target URL
717 * @throws HTTPException\InternalServerErrorException
719 public function redirect($toUrl)
721 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
722 Core\System::externalRedirect($toUrl);
724 $this->baseURL->redirect($toUrl);