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\Factory\ConfigFactory;
29 use Friendica\Module\Maintenance;
30 use Friendica\Security\Authentication;
31 use Friendica\Core\Config\Cache;
32 use Friendica\Core\Config\IConfig;
33 use Friendica\Core\PConfig\IPConfig;
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\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.
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 IConfig 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\Process The process methods
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());
161 public function getLoggedInUserId()
163 return $this->user_id;
167 * Fetch the user nick name
170 public function getLoggedInUserNickname()
172 return $this->nickname;
176 * Set the profile owner ID
178 * @param int $owner_id
181 public function setProfileOwner(int $owner_id)
183 $this->profile_owner = $owner_id;
187 * Get the profile owner ID
191 public function getProfileOwner():int
193 return $this->profile_owner;
199 * @param int $contact_id
202 public function setContactId(int $contact_id)
204 $this->contact_id = $contact_id;
212 public function getContactId():int
214 return $this->contact_id;
220 * @param int $timezone
223 public function setTimeZone(string $timezone)
225 $this->timezone = $timezone;
233 public function getTimeZone():string
235 return $this->timezone;
239 * Set workerqueue information
241 * @param array $queue
244 public function setQueue(array $queue)
246 $this->queue = $queue;
250 * Fetch workerqueue information
254 public function getQueue()
256 return $this->queue ?? [];
260 * Fetch a specific workerqueue field
262 * @param string $index
265 public function getQueueValue(string $index)
267 return $this->queue[$index] ?? null;
270 public function setThemeInfoValue(string $index, $value)
272 $this->theme_info[$index] = $value;
275 public function getThemeInfo()
277 return $this->theme_info;
280 public function getThemeInfoValue(string $index, $default = null)
282 return $this->theme_info[$index] ?? $default;
286 * Returns the current config cache of this node
290 public function getConfigCache()
292 return $this->config->getCache();
296 * The basepath of this app
300 public function getBasePath()
302 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
303 return $this->config->getCache()->get('system', 'basepath');
307 * @param Database $database The Friendica Database
308 * @param IConfig $config The Configuration
309 * @param App\Mode $mode The mode of this Friendica app
310 * @param BaseURL $baseURL The full base URL of this Friendica app
311 * @param LoggerInterface $logger The current app logger
312 * @param Profiler $profiler The profiler of this application
313 * @param L10n $l10n The translator instance
314 * @param App\Arguments $args The Friendica Arguments of the call
315 * @param Core\Process $process The process methods
316 * @param IPConfig $pConfig Personal configuration
318 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)
320 $this->database = $database;
321 $this->config = $config;
323 $this->baseURL = $baseURL;
324 $this->profiler = $profiler;
325 $this->logger = $logger;
328 $this->process = $process;
329 $this->pConfig = $pConfig;
335 * Load the whole app instance
337 public function load()
341 // This has to be quite large to deal with embedded private photos
342 ini_set('pcre.backtrack_limit', 500000);
345 get_include_path() . PATH_SEPARATOR
346 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
347 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
348 . $this->getBasePath());
350 $this->profiler->reset();
352 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
353 $this->profiler->update($this->config);
355 Core\Hook::loadHooks();
356 $loader = (new ConfigFactory())->createConfigFileLoader($this->getBasePath(), $_SERVER);
357 Core\Hook::callAll('load_config', $loader);
360 $this->loadDefaultTimezone();
361 // Register template engines
362 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
366 * Loads the default timezone
368 * Include support for legacy $default_timezone
370 * @global string $default_timezone
372 private function loadDefaultTimezone()
374 if ($this->config->get('system', 'default_timezone')) {
375 $this->timezone = $this->config->get('system', 'default_timezone');
377 global $default_timezone;
378 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
381 if ($this->timezone) {
382 date_default_timezone_set($this->timezone);
387 * Returns the current theme name. May be overriden by the mobile theme name.
392 public function getCurrentTheme()
394 if ($this->mode->isInstall()) {
398 // Specific mobile theme override
399 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
400 $user_mobile_theme = $this->getCurrentMobileTheme();
402 // --- means same mobile theme as desktop
403 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
404 return $user_mobile_theme;
408 if (!$this->currentTheme) {
409 $this->computeCurrentTheme();
412 return $this->currentTheme;
416 * Returns the current mobile theme name.
421 public function getCurrentMobileTheme()
423 if ($this->mode->isInstall()) {
427 if (is_null($this->currentMobileTheme)) {
428 $this->computeCurrentMobileTheme();
431 return $this->currentMobileTheme;
434 public function setCurrentTheme($theme)
436 $this->currentTheme = $theme;
439 public function setCurrentMobileTheme($theme)
441 $this->currentMobileTheme = $theme;
445 * Computes the current theme name based on the node settings, the page owner settings and the user settings
449 private function computeCurrentTheme()
451 $system_theme = $this->config->get('system', 'theme');
452 if (!$system_theme) {
453 throw new Exception($this->l10n->t('No system theme config value set.'));
457 $this->setCurrentTheme($system_theme);
460 // Find the theme that belongs to the user whose stuff we are looking at
461 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
462 // Allow folks to override user themes and always use their own on their own site.
463 // This works only if the user is on the same server
464 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
465 if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
466 $page_theme = $user['theme'];
470 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
472 $theme_name = Strings::sanitizeFilePathItem($theme_name);
474 && in_array($theme_name, Theme::getAllowedList())
475 && (file_exists('view/theme/' . $theme_name . '/style.css')
476 || file_exists('view/theme/' . $theme_name . '/style.php'))
478 $this->setCurrentTheme($theme_name);
483 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
485 private function computeCurrentMobileTheme()
487 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
490 $this->setCurrentMobileTheme($system_mobile_theme);
492 $page_mobile_theme = null;
493 // Find the theme that belongs to the user whose stuff we are looking at
494 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
495 // Allow folks to override user themes and always use their own on their own site.
496 // This works only if the user is on the same server
497 if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
498 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
502 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
504 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
505 if ($mobile_theme_name == '---'
507 in_array($mobile_theme_name, Theme::getAllowedList())
508 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
509 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
511 $this->setCurrentMobileTheme($mobile_theme_name);
516 * Provide a sane default if nothing is chosen or the specified theme does not exist.
521 public function getCurrentThemeStylesheetPath()
523 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
527 * Sets the base url for use in cmdline programs which don't have
530 public function checkURL()
532 $url = $this->config->get('system', 'url');
534 // if the url isn't set or the stored url is radically different
535 // than the currently visited url, store the current value accordingly.
536 // "Radically different" ignores common variations such as http vs https
537 // and www.example.com vs example.com.
538 // We will only change the url to an ip address if there is no existing setting
540 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()))) {
541 $this->config->set('system', 'url', $this->baseURL->get());
546 * Frontend App script
548 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
549 * request and a representation of the response.
551 * This probably should change to limit the size of this monster method.
553 * @param App\Module $module The determined module
554 * @param App\Router $router
555 * @param IPConfig $pconfig
556 * @param Authentication $auth The Authentication backend of the node
557 * @param App\Page $page The Friendica page printing container
559 * @throws HTTPException\InternalServerErrorException
560 * @throws \ImagickException
562 public function runFrontend(App\Module $module, App\Router $router, IPConfig $pconfig, Authentication $auth, App\Page $page, float $start_time)
564 $this->profiler->set($start_time, 'start');
565 $this->profiler->set(microtime(true), 'classinit');
567 $moduleName = $module->getName();
570 // Missing DB connection: ERROR
571 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
572 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
575 // Max Load Average reached: ERROR
576 if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
577 header('Retry-After: 120');
578 header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
580 throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
583 if (!$this->mode->isInstall()) {
584 // Force SSL redirection
585 if ($this->baseURL->checkRedirectHttps()) {
586 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
589 Core\Hook::callAll('init_1');
592 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
593 $requester = HTTPSignature::getSigner('', $_SERVER);
594 if (!empty($requester)) {
595 Profile::addVisitorCookieForHandle($requester);
600 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend()) {
602 // Only continue when the given profile link seems valid
603 // Valid profile links contain a path with "/profile/" and no query parameters
604 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
605 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
606 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
607 Core\Session::set('my_url', $_GET['zrl']);
608 Core\Session::set('authenticated', 0);
610 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
611 if (!empty($remote_contact['subscribe'])) {
612 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
616 Model\Profile::zrlInit($this);
618 // Someone came with an invalid parameter, maybe as a DDoS attempt
619 // We simply stop processing here
620 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
621 throw new HTTPException\ForbiddenException();
626 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
627 $token = $_GET['owt'];
628 Model\Profile::openWebAuthInit($token);
631 $auth->withSession($this);
633 if (empty($_SESSION['authenticated'])) {
634 header('X-Account-Management-Status: none');
637 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
638 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
639 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
642 * check_config() is responsible for running update scripts. These automatically
643 * update the DB schema whenever we push a new one out. It also checks to see if
644 * any addons have been added or removed and reacts accordingly.
647 // in install mode, any url loads install module
648 // but we need "view" module for stylesheet
649 if ($this->mode->isInstall() && $moduleName !== 'install') {
650 $this->baseURL->redirect('install');
653 Core\Update::check($this->getBasePath(), false, $this->mode);
654 Core\Addon::loadAddons();
655 Core\Hook::loadHooks();
658 // Compatibility with the Android Diaspora client
659 if ($moduleName == 'stream') {
660 $this->baseURL->redirect('network?order=post');
663 if ($moduleName == 'conversations') {
664 $this->baseURL->redirect('message');
667 if ($moduleName == 'commented') {
668 $this->baseURL->redirect('network?order=comment');
671 if ($moduleName == 'liked') {
672 $this->baseURL->redirect('network?order=comment');
675 if ($moduleName == 'activity') {
676 $this->baseURL->redirect('network?conv=1');
679 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
680 $this->baseURL->redirect('bookmarklet');
683 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
684 $this->baseURL->redirect('settings');
687 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
688 $this->baseURL->redirect('search');
691 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
692 $page['page_title'] = $moduleName;
694 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
695 $module = new Module('maintenance', Maintenance::class);
697 // determine the module class and save it to the module instance
698 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
699 $module = $module->determineClass($this->args, $router, $this->config);
702 // Let the module run it's internal process (init, get, post, ...)
703 $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
704 } catch (HTTPException $e) {
705 ModuleHTTPException::rawContent($e);
708 $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
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);