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\Module\Maintenance;
29 use Friendica\Security\Authentication;
30 use Friendica\Core\Config\Cache;
31 use Friendica\Core\Config\IConfig;
32 use Friendica\Core\PConfig\IPConfig;
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\ConfigFileLoader;
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 IConfig 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 Core\Process The process methods
132 * @param int $user_id
135 public function setLoggedInUserId(int $user_id)
137 $this->user_id = $user_id;
143 * @param int $user_id
146 public function setLoggedInUserNickname(string $nickname)
148 $this->nickname = $nickname;
151 public function isLoggedIn()
153 return local_user() && $this->user_id && ($this->user_id == local_user());
160 public function getLoggedInUserId()
162 return $this->user_id;
166 * Fetch the user nick name
169 public function getLoggedInUserNickname()
171 return $this->nickname;
175 * Set the profile owner ID
177 * @param int $owner_id
180 public function setProfileOwner(int $owner_id)
182 $this->profile_owner = $owner_id;
186 * Get the profile owner ID
190 public function getProfileOwner():int
192 return $this->profile_owner;
198 * @param int $contact_id
201 public function setContactId(int $contact_id)
203 $this->contact_id = $contact_id;
211 public function getContactId():int
213 return $this->contact_id;
219 * @param int $timezone
222 public function setTimeZone(string $timezone)
224 $this->timezone = $timezone;
232 public function getTimeZone():string
234 return $this->timezone;
238 * Set workerqueue information
240 * @param array $queue
243 public function setQueue(array $queue)
245 $this->queue = $queue;
249 * Fetch workerqueue information
253 public function getQueue()
255 return $this->queue ?? [];
259 * Fetch a specific workerqueue field
261 * @param string $index
264 public function getQueueValue(string $index)
266 return $this->queue[$index] ?? null;
269 public function setThemeInfoValue(string $index, $value)
271 $this->theme_info[$index] = $value;
274 public function getThemeInfo()
276 return $this->theme_info;
279 public function getThemeInfoValue(string $index, $default = null)
281 return $this->theme_info[$index] ?? $default;
285 * Returns the current config cache of this node
289 public function getConfigCache()
291 return $this->config->getCache();
295 * The basepath of this app
299 public function getBasePath()
301 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
302 return $this->config->getCache()->get('system', 'basepath');
306 * @param Database $database The Friendica Database
307 * @param IConfig $config The Configuration
308 * @param App\Mode $mode The mode of this Friendica app
309 * @param BaseURL $baseURL The full base URL of this Friendica app
310 * @param LoggerInterface $logger The current app logger
311 * @param Profiler $profiler The profiler of this application
312 * @param L10n $l10n The translator instance
313 * @param App\Arguments $args The Friendica Arguments of the call
314 * @param Core\Process $process The process methods
315 * @param IPConfig $pConfig Personal configuration
317 public function __construct(Database $database, IConfig $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, Core\Process $process, IPConfig $pConfig)
319 $this->database = $database;
320 $this->config = $config;
322 $this->baseURL = $baseURL;
323 $this->profiler = $profiler;
324 $this->logger = $logger;
327 $this->process = $process;
328 $this->pConfig = $pConfig;
334 * Load the whole app instance
336 public function load()
340 // This has to be quite large to deal with embedded private photos
341 ini_set('pcre.backtrack_limit', 500000);
344 get_include_path() . PATH_SEPARATOR
345 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
346 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
347 . $this->getBasePath());
349 $this->profiler->reset();
351 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
352 $this->profiler->update($this->config);
354 Core\Hook::loadHooks();
355 $loader = new ConfigFileLoader($this->getBasePath());
356 Core\Hook::callAll('load_config', $loader);
359 $this->loadDefaultTimezone();
360 // Register template engines
361 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
365 * Loads the default timezone
367 * Include support for legacy $default_timezone
369 * @global string $default_timezone
371 private function loadDefaultTimezone()
373 if ($this->config->get('system', 'default_timezone')) {
374 $this->timezone = $this->config->get('system', 'default_timezone');
376 global $default_timezone;
377 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
380 if ($this->timezone) {
381 date_default_timezone_set($this->timezone);
386 * Returns the current theme name. May be overriden by the mobile theme name.
391 public function getCurrentTheme()
393 if ($this->mode->isInstall()) {
397 // Specific mobile theme override
398 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
399 $user_mobile_theme = $this->getCurrentMobileTheme();
401 // --- means same mobile theme as desktop
402 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
403 return $user_mobile_theme;
407 if (!$this->currentTheme) {
408 $this->computeCurrentTheme();
411 return $this->currentTheme;
415 * Returns the current mobile theme name.
420 public function getCurrentMobileTheme()
422 if ($this->mode->isInstall()) {
426 if (is_null($this->currentMobileTheme)) {
427 $this->computeCurrentMobileTheme();
430 return $this->currentMobileTheme;
433 public function setCurrentTheme($theme)
435 $this->currentTheme = $theme;
438 public function setCurrentMobileTheme($theme)
440 $this->currentMobileTheme = $theme;
444 * Computes the current theme name based on the node settings, the page owner settings and the user settings
448 private function computeCurrentTheme()
450 $system_theme = $this->config->get('system', 'theme');
451 if (!$system_theme) {
452 throw new Exception($this->l10n->t('No system theme config value set.'));
456 $this->setCurrentTheme($system_theme);
459 // Find the theme that belongs to the user whose stuff we are looking at
460 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
461 // Allow folks to override user themes and always use their own on their own site.
462 // This works only if the user is on the same server
463 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
464 if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
465 $page_theme = $user['theme'];
469 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
471 $theme_name = Strings::sanitizeFilePathItem($theme_name);
473 && in_array($theme_name, Theme::getAllowedList())
474 && (file_exists('view/theme/' . $theme_name . '/style.css')
475 || file_exists('view/theme/' . $theme_name . '/style.php'))
477 $this->setCurrentTheme($theme_name);
482 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
484 private function computeCurrentMobileTheme()
486 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
489 $this->setCurrentMobileTheme($system_mobile_theme);
491 $page_mobile_theme = null;
492 // Find the theme that belongs to the user whose stuff we are looking at
493 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
494 // Allow folks to override user themes and always use their own on their own site.
495 // This works only if the user is on the same server
496 if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
497 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
501 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
503 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
504 if ($mobile_theme_name == '---'
506 in_array($mobile_theme_name, Theme::getAllowedList())
507 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
508 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
510 $this->setCurrentMobileTheme($mobile_theme_name);
515 * Provide a sane default if nothing is chosen or the specified theme does not exist.
520 public function getCurrentThemeStylesheetPath()
522 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
526 * Sets the base url for use in cmdline programs which don't have
529 public function checkURL()
531 $url = $this->config->get('system', 'url');
533 // if the url isn't set or the stored url is radically different
534 // than the currently visited url, store the current value accordingly.
535 // "Radically different" ignores common variations such as http vs https
536 // and www.example.com vs example.com.
537 // We will only change the url to an ip address if there is no existing setting
539 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()))) {
540 $this->config->set('system', 'url', $this->baseURL->get());
545 * Frontend App script
547 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
548 * request and a representation of the response.
550 * This probably should change to limit the size of this monster method.
552 * @param App\Module $module The determined module
553 * @param App\Router $router
554 * @param IPConfig $pconfig
555 * @param Authentication $auth The Authentication backend of the node
556 * @param App\Page $page The Friendica page printing container
558 * @throws HTTPException\InternalServerErrorException
559 * @throws \ImagickException
561 public function runFrontend(App\Module $module, App\Router $router, IPConfig $pconfig, Authentication $auth, App\Page $page, float $start_time)
563 $this->profiler->set($start_time, 'start');
564 $this->profiler->set(microtime(true), 'classinit');
566 $moduleName = $module->getName();
569 // Missing DB connection: ERROR
570 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
571 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
574 // Max Load Average reached: ERROR
575 if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
576 header('Retry-After: 120');
577 header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
579 throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
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 $auth->withSession($this);
632 if (empty($_SESSION['authenticated'])) {
633 header('X-Account-Management-Status: none');
636 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
637 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
638 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
641 * check_config() is responsible for running update scripts. These automatically
642 * update the DB schema whenever we push a new one out. It also checks to see if
643 * any addons have been added or removed and reacts accordingly.
646 // in install mode, any url loads install module
647 // but we need "view" module for stylesheet
648 if ($this->mode->isInstall() && $moduleName !== 'install') {
649 $this->baseURL->redirect('install');
652 Core\Update::check($this->getBasePath(), false, $this->mode);
653 Core\Addon::loadAddons();
654 Core\Hook::loadHooks();
657 // Compatibility with the Android Diaspora client
658 if ($moduleName == 'stream') {
659 $this->baseURL->redirect('network?order=post');
662 if ($moduleName == 'conversations') {
663 $this->baseURL->redirect('message');
666 if ($moduleName == 'commented') {
667 $this->baseURL->redirect('network?order=comment');
670 if ($moduleName == 'liked') {
671 $this->baseURL->redirect('network?order=comment');
674 if ($moduleName == 'activity') {
675 $this->baseURL->redirect('network?conv=1');
678 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
679 $this->baseURL->redirect('bookmarklet');
682 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
683 $this->baseURL->redirect('settings');
686 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
687 $this->baseURL->redirect('search');
690 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
691 $page['page_title'] = $moduleName;
693 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
694 $module = new Module('maintenance', Maintenance::class);
696 // determine the module class and save it to the module instance
697 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
698 $module = $module->determineClass($this->args, $router, $this->config);
701 // Let the module run it's internal process (init, get, post, ...)
702 $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
703 } catch (HTTPException $e) {
704 ModuleHTTPException::rawContent($e);
707 $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
711 * Automatically redirects to relative or absolute URL
712 * Should only be used if it isn't clear if the URL is either internal or external
714 * @param string $toUrl The target URL
716 * @throws HTTPException\InternalServerErrorException
718 public function redirect($toUrl)
720 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
721 Core\System::externalRedirect($toUrl);
723 $this->baseURL->redirect($toUrl);