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\Model\User;
40 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
41 use Friendica\Network\HTTPException;
42 use Friendica\Util\ConfigFileLoader;
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.
62 // Allow themes to control internal parameters
63 // by changing App values in theme.php
64 private $theme_info = [
67 'events_in_profile' => true
71 private $nickname = '';
72 private $timezone = '';
73 private $profile_owner = 0;
74 private $contact_id = 0;
78 * @var App\Mode The Mode of the Application
87 /** @var string The name of the current theme */
88 private $currentTheme;
89 /** @var string The name of the current mobile theme */
90 private $currentMobileTheme;
93 * @var IConfig The config
98 * @var LoggerInterface The logger
103 * @var Profiler The profiler of this app
108 * @var Database The Friendica database connection
113 * @var L10n The translator
123 * @var Core\Process The process methods
135 * @param int $user_id
138 public function setUserId(int $user_id)
140 $this->user_id = $user_id;
146 * @param int $user_id
149 public function setNickname(string $nickname)
151 $this->nickname = $nickname;
158 public function getUserId()
160 return $this->user_id;
164 * Fetch the user nick name
167 public function getNickname()
169 return $this->nickname;
173 * Fetch a specific user field
175 * @param string $index
178 public function getUserValue(string $index)
180 if (empty($this->user_id)) {
184 if (empty($this->user)) {
185 $this->user = User::getById($this->user_id);
188 return $this->user[$index] ?? null;
192 * Set the profile owner ID
194 * @param int $owner_id
197 public function setProfileOwner(int $owner_id)
199 $this->profile_owner = $owner_id;
203 * Get the profile owner ID
207 public function getProfileOwner():int
209 return $this->profile_owner;
215 * @param int $contact_id
218 public function setContactId(int $contact_id)
220 $this->contact_id = $contact_id;
228 public function getContactId():int
230 return $this->contact_id;
236 * @param int $timezone
239 public function setTimeZone(string $timezone)
241 $this->timezone = $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 IConfig $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\Process $process The process methods
332 * @param IPConfig $pConfig Personal configuration
334 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)
336 $this->database = $database;
337 $this->config = $config;
339 $this->baseURL = $baseURL;
340 $this->profiler = $profiler;
341 $this->logger = $logger;
344 $this->process = $process;
345 $this->pConfig = $pConfig;
351 * Load the whole app instance
353 public function load()
357 // This has to be quite large to deal with embedded private photos
358 ini_set('pcre.backtrack_limit', 500000);
361 get_include_path() . PATH_SEPARATOR
362 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
363 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
364 . $this->getBasePath());
366 $this->profiler->reset();
368 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
369 $this->profiler->update($this->config);
371 Core\Hook::loadHooks();
372 $loader = new ConfigFileLoader($this->getBasePath());
373 Core\Hook::callAll('load_config', $loader);
376 $this->loadDefaultTimezone();
377 // Register template engines
378 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
382 * Loads the default timezone
384 * Include support for legacy $default_timezone
386 * @global string $default_timezone
388 private function loadDefaultTimezone()
390 if ($this->config->get('system', 'default_timezone')) {
391 $this->timezone = $this->config->get('system', 'default_timezone');
393 global $default_timezone;
394 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
397 if ($this->timezone) {
398 date_default_timezone_set($this->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 IPConfig $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, IPConfig $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 // Max Load Average reached: ERROR
592 if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
593 header('Retry-After: 120');
594 header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
596 throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
599 if (!$this->mode->isInstall()) {
600 // Force SSL redirection
601 if ($this->baseURL->checkRedirectHttps()) {
602 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
605 Core\Hook::callAll('init_1');
608 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
609 $requester = HTTPSignature::getSigner('', $_SERVER);
610 if (!empty($requester)) {
611 Profile::addVisitorCookieForHandle($requester);
616 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend()) {
618 // Only continue when the given profile link seems valid
619 // Valid profile links contain a path with "/profile/" and no query parameters
620 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
621 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
622 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
623 Core\Session::set('my_url', $_GET['zrl']);
624 Core\Session::set('authenticated', 0);
626 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
627 if (!empty($remote_contact['subscribe'])) {
628 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
632 Model\Profile::zrlInit($this);
634 // Someone came with an invalid parameter, maybe as a DDoS attempt
635 // We simply stop processing here
636 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
637 throw new HTTPException\ForbiddenException();
642 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
643 $token = $_GET['owt'];
644 Model\Profile::openWebAuthInit($token);
647 $auth->withSession($this);
649 if (empty($_SESSION['authenticated'])) {
650 header('X-Account-Management-Status: none');
653 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
654 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
655 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
658 * check_config() is responsible for running update scripts. These automatically
659 * update the DB schema whenever we push a new one out. It also checks to see if
660 * any addons have been added or removed and reacts accordingly.
663 // in install mode, any url loads install module
664 // but we need "view" module for stylesheet
665 if ($this->mode->isInstall() && $moduleName !== 'install') {
666 $this->baseURL->redirect('install');
669 Core\Update::check($this->getBasePath(), false, $this->mode);
670 Core\Addon::loadAddons();
671 Core\Hook::loadHooks();
674 // Compatibility with the Android Diaspora client
675 if ($moduleName == 'stream') {
676 $this->baseURL->redirect('network?order=post');
679 if ($moduleName == 'conversations') {
680 $this->baseURL->redirect('message');
683 if ($moduleName == 'commented') {
684 $this->baseURL->redirect('network?order=comment');
687 if ($moduleName == 'liked') {
688 $this->baseURL->redirect('network?order=comment');
691 if ($moduleName == 'activity') {
692 $this->baseURL->redirect('network?conv=1');
695 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
696 $this->baseURL->redirect('bookmarklet');
699 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
700 $this->baseURL->redirect('settings');
703 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
704 $this->baseURL->redirect('search');
707 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
708 $page['page_title'] = $moduleName;
710 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
711 $module = new Module('maintenance', Maintenance::class);
713 // determine the module class and save it to the module instance
714 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
715 $module = $module->determineClass($this->args, $router, $this->config);
718 // Let the module run it's internal process (init, get, post, ...)
719 $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
720 } catch (HTTPException $e) {
721 ModuleHTTPException::rawContent($e);
724 $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
728 * Automatically redirects to relative or absolute URL
729 * Should only be used if it isn't clear if the URL is either internal or external
731 * @param string $toUrl The target URL
733 * @throws HTTPException\InternalServerErrorException
735 public function redirect($toUrl)
737 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
738 Core\System::externalRedirect($toUrl);
740 $this->baseURL->redirect($toUrl);