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/>.
26 use Friendica\App\Arguments;
27 use Friendica\App\BaseURL;
28 use Friendica\App\Module;
29 use Friendica\Core\Config\Factory\Config;
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\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 Core\System The system methods
127 * @var IManagePersonalConfigValues
134 * @param int $user_id
137 public function setLoggedInUserId(int $user_id)
139 $this->user_id = $user_id;
145 * @param int $user_id
148 public function setLoggedInUserNickname(string $nickname)
150 $this->nickname = $nickname;
153 public function isLoggedIn()
155 return local_user() && $this->user_id && ($this->user_id == local_user());
159 * Check if current user has admin role.
161 * @return bool true if user is an admin
163 public function isSiteAdmin()
165 $admin_email = $this->config->get('config', 'admin_email');
167 $adminlist = explode(',', str_replace(' ', '', $admin_email));
169 return local_user() && $admin_email && $this->database->exists('user', ['uid' => $this->getLoggedInUserId(), 'email' => $adminlist]);
176 public function getLoggedInUserId()
178 return $this->user_id;
182 * Fetch the user nick name
185 public function getLoggedInUserNickname()
187 return $this->nickname;
191 * Set the profile owner ID
193 * @param int $owner_id
196 public function setProfileOwner(int $owner_id)
198 $this->profile_owner = $owner_id;
202 * Get the profile owner ID
206 public function getProfileOwner():int
208 return $this->profile_owner;
214 * @param int $contact_id
217 public function setContactId(int $contact_id)
219 $this->contact_id = $contact_id;
227 public function getContactId():int
229 return $this->contact_id;
235 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
238 public function setTimeZone(string $timezone)
240 $this->timezone = (new \DateTimeZone($timezone))->getName();
241 DateTimeFormat::setLocalTimeZone($this->timezone);
249 public function getTimeZone():string
251 return $this->timezone;
255 * Set workerqueue information
257 * @param array $queue
260 public function setQueue(array $queue)
262 $this->queue = $queue;
266 * Fetch workerqueue information
270 public function getQueue()
272 return $this->queue ?? [];
276 * Fetch a specific workerqueue field
278 * @param string $index
281 public function getQueueValue(string $index)
283 return $this->queue[$index] ?? null;
286 public function setThemeInfoValue(string $index, $value)
288 $this->theme_info[$index] = $value;
291 public function getThemeInfo()
293 return $this->theme_info;
296 public function getThemeInfoValue(string $index, $default = null)
298 return $this->theme_info[$index] ?? $default;
302 * Returns the current config cache of this node
306 public function getConfigCache()
308 return $this->config->getCache();
312 * The basepath of this app
316 public function getBasePath()
318 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
319 return $this->config->getCache()->get('system', 'basepath');
323 * @param Database $database The Friendica Database
324 * @param IManageConfigValues $config The Configuration
325 * @param App\Mode $mode The mode of this Friendica app
326 * @param BaseURL $baseURL The full base URL of this Friendica app
327 * @param LoggerInterface $logger The current app logger
328 * @param Profiler $profiler The profiler of this application
329 * @param L10n $l10n The translator instance
330 * @param App\Arguments $args The Friendica Arguments of the call
331 * @param Core\System $system The system methods
332 * @param IManagePersonalConfigValues $pConfig Personal configuration
334 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)
336 $this->database = $database;
337 $this->config = $config;
339 $this->baseURL = $baseURL;
340 $this->profiler = $profiler;
341 $this->logger = $logger;
344 $this->system = $system;
345 $this->pConfig = $pConfig;
351 * Load the whole app instance
353 public function load()
357 // Ensure that all "strtotime" operations do run timezone independent
358 date_default_timezone_set('UTC');
360 // This has to be quite large to deal with embedded private photos
361 ini_set('pcre.backtrack_limit', 500000);
364 get_include_path() . PATH_SEPARATOR
365 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
366 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
367 . $this->getBasePath());
369 $this->profiler->reset();
371 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
372 $this->profiler->update($this->config);
374 Core\Hook::loadHooks();
375 $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
376 Core\Hook::callAll('load_config', $loader);
379 $this->loadDefaultTimezone();
380 // Register template engines
381 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
385 * Loads the default timezone
387 * Include support for legacy $default_timezone
389 * @global string $default_timezone
391 private function loadDefaultTimezone()
393 if ($this->config->get('system', 'default_timezone')) {
394 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
396 global $default_timezone;
397 $timezone = $default_timezone ?? '' ?: 'UTC';
400 $this->setTimeZone($timezone);
404 * Returns the current theme name. May be overriden by the mobile theme name.
409 public function getCurrentTheme()
411 if ($this->mode->isInstall()) {
415 // Specific mobile theme override
416 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
417 $user_mobile_theme = $this->getCurrentMobileTheme();
419 // --- means same mobile theme as desktop
420 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
421 return $user_mobile_theme;
425 if (!$this->currentTheme) {
426 $this->computeCurrentTheme();
429 return $this->currentTheme;
433 * Returns the current mobile theme name.
438 public function getCurrentMobileTheme()
440 if ($this->mode->isInstall()) {
444 if (is_null($this->currentMobileTheme)) {
445 $this->computeCurrentMobileTheme();
448 return $this->currentMobileTheme;
451 public function setCurrentTheme($theme)
453 $this->currentTheme = $theme;
456 public function setCurrentMobileTheme($theme)
458 $this->currentMobileTheme = $theme;
462 * Computes the current theme name based on the node settings, the page owner settings and the user settings
466 private function computeCurrentTheme()
468 $system_theme = $this->config->get('system', 'theme');
469 if (!$system_theme) {
470 throw new Exception($this->l10n->t('No system theme config value set.'));
474 $this->setCurrentTheme($system_theme);
477 // Find the theme that belongs to the user whose stuff we are looking at
478 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
479 // Allow folks to override user themes and always use their own on their own site.
480 // This works only if the user is on the same server
481 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
482 if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
483 $page_theme = $user['theme'];
487 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
489 $theme_name = Strings::sanitizeFilePathItem($theme_name);
491 && in_array($theme_name, Theme::getAllowedList())
492 && (file_exists('view/theme/' . $theme_name . '/style.css')
493 || file_exists('view/theme/' . $theme_name . '/style.php'))
495 $this->setCurrentTheme($theme_name);
500 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
502 private function computeCurrentMobileTheme()
504 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
507 $this->setCurrentMobileTheme($system_mobile_theme);
509 $page_mobile_theme = null;
510 // Find the theme that belongs to the user whose stuff we are looking at
511 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
512 // Allow folks to override user themes and always use their own on their own site.
513 // This works only if the user is on the same server
514 if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
515 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
519 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
521 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
522 if ($mobile_theme_name == '---'
524 in_array($mobile_theme_name, Theme::getAllowedList())
525 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
526 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
528 $this->setCurrentMobileTheme($mobile_theme_name);
533 * Provide a sane default if nothing is chosen or the specified theme does not exist.
538 public function getCurrentThemeStylesheetPath()
540 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
544 * Sets the base url for use in cmdline programs which don't have
547 public function checkURL()
549 $url = $this->config->get('system', 'url');
551 // if the url isn't set or the stored url is radically different
552 // than the currently visited url, store the current value accordingly.
553 // "Radically different" ignores common variations such as http vs https
554 // and www.example.com vs example.com.
555 // We will only change the url to an ip address if there is no existing setting
557 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()))) {
558 $this->config->set('system', 'url', $this->baseURL->get());
563 * Frontend App script
565 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
566 * request and a representation of the response.
568 * This probably should change to limit the size of this monster method.
570 * @param App\Module $module The determined module
571 * @param App\Router $router
572 * @param IManagePersonalConfigValues $pconfig
573 * @param Authentication $auth The Authentication backend of the node
574 * @param App\Page $page The Friendica page printing container
576 * @throws HTTPException\InternalServerErrorException
577 * @throws \ImagickException
579 public function runFrontend(App\Module $module, App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, Dice $dice, float $start_time)
581 $this->profiler->set($start_time, 'start');
582 $this->profiler->set(microtime(true), 'classinit');
584 $moduleName = $module->getName();
587 // Missing DB connection: ERROR
588 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
589 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
592 if (!$this->mode->isInstall()) {
593 // Force SSL redirection
594 if ($this->baseURL->checkRedirectHttps()) {
595 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
598 Core\Hook::callAll('init_1');
601 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
602 $requester = HTTPSignature::getSigner('', $_SERVER);
603 if (!empty($requester)) {
604 Profile::addVisitorCookieForHandle($requester);
609 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend()) {
611 // Only continue when the given profile link seems valid
612 // Valid profile links contain a path with "/profile/" and no query parameters
613 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
614 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
615 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
616 Core\Session::set('my_url', $_GET['zrl']);
617 Core\Session::set('authenticated', 0);
619 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
620 if (!empty($remote_contact['subscribe'])) {
621 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
625 Model\Profile::zrlInit($this);
627 // Someone came with an invalid parameter, maybe as a DDoS attempt
628 // We simply stop processing here
629 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
630 throw new HTTPException\ForbiddenException();
635 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
636 $token = $_GET['owt'];
637 Model\Profile::openWebAuthInit($token);
640 if (!$this->mode->isBackend()) {
641 $auth->withSession($this);
644 if (empty($_SESSION['authenticated'])) {
645 header('X-Account-Management-Status: none');
648 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
649 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
650 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
653 * check_config() is responsible for running update scripts. These automatically
654 * update the DB schema whenever we push a new one out. It also checks to see if
655 * any addons have been added or removed and reacts accordingly.
658 // in install mode, any url loads install module
659 // but we need "view" module for stylesheet
660 if ($this->mode->isInstall() && $moduleName !== 'install') {
661 $this->baseURL->redirect('install');
664 Core\Update::check($this->getBasePath(), false, $this->mode);
665 Core\Addon::loadAddons();
666 Core\Hook::loadHooks();
669 // Compatibility with the Android Diaspora client
670 if ($moduleName == 'stream') {
671 $this->baseURL->redirect('network?order=post');
674 if ($moduleName == 'conversations') {
675 $this->baseURL->redirect('message');
678 if ($moduleName == 'commented') {
679 $this->baseURL->redirect('network?order=comment');
682 if ($moduleName == 'liked') {
683 $this->baseURL->redirect('network?order=comment');
686 if ($moduleName == 'activity') {
687 $this->baseURL->redirect('network?conv=1');
690 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
691 $this->baseURL->redirect('bookmarklet');
694 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
695 $this->baseURL->redirect('settings');
698 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
699 $this->baseURL->redirect('search');
702 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
703 $page['page_title'] = $moduleName;
705 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
706 $module = new Module('maintenance', new Maintenance());
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 = $module->determineClass($this->args, $router, $this->config, $dice);
713 // Let the module run it's internal process (init, get, post, ...)
714 $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
715 } catch (HTTPException $e) {
716 ModuleHTTPException::rawContent($e);
719 $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
723 * Automatically redirects to relative or absolute URL
724 * Should only be used if it isn't clear if the URL is either internal or external
726 * @param string $toUrl The target URL
728 * @throws HTTPException\InternalServerErrorException
730 public function redirect($toUrl)
732 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
733 Core\System::externalRedirect($toUrl);
735 $this->baseURL->redirect($toUrl);