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\Profile;
38 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
39 use Friendica\Network\HTTPException;
40 use Friendica\Util\ConfigFileLoader;
41 use Friendica\Util\HTTPSignature;
42 use Friendica\Util\Profiler;
43 use Friendica\Util\Strings;
44 use Psr\Log\LoggerInterface;
47 * Our main application structure for the life of this page.
49 * Primarily deals with the URL that got us here
50 * and tries to make some sense of it, and
51 * stores our page contents and config storage
52 * and anything else that might need to be passed around
53 * before we spit the page out.
67 /** @deprecated 2019.09 - use App\Arguments->getArgv() or Arguments->get() */
69 /** @deprecated 2019.09 - use App\Arguments->getArgc() */
72 public $interactive = true;
74 public $theme_info = [];
76 // Allow themes to control internal parameters
77 // by changing App values in theme.php
79 public $sourcename = '';
80 public $videowidth = 425;
81 public $videoheight = 350;
82 public $theme_events_in_profile = true;
86 * @var App\Mode The Mode of the Application
95 /** @var string The name of the current theme */
96 private $currentTheme;
97 /** @var string The name of the current mobile theme */
98 private $currentMobileTheme;
101 * @var IConfig The config
106 * @var LoggerInterface The logger
111 * @var Profiler The profiler of this app
116 * @var Database The Friendica database connection
121 * @var L10n The translator
131 * @var Core\Process The process methods
141 * Returns the current config cache of this node
145 public function getConfigCache()
147 return $this->config->getCache();
151 * The basepath of this app
155 public function getBasePath()
157 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
158 return $this->config->getCache()->get('system', 'basepath');
162 * @param Database $database The Friendica Database
163 * @param IConfig $config The Configuration
164 * @param App\Mode $mode The mode of this Friendica app
165 * @param BaseURL $baseURL The full base URL of this Friendica app
166 * @param LoggerInterface $logger The current app logger
167 * @param Profiler $profiler The profiler of this application
168 * @param L10n $l10n The translator instance
169 * @param App\Arguments $args The Friendica Arguments of the call
170 * @param Core\Process $process The process methods
171 * @param IPConfig $pConfig Personal configuration
173 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)
175 $this->database = $database;
176 $this->config = $config;
178 $this->baseURL = $baseURL;
179 $this->profiler = $profiler;
180 $this->logger = $logger;
183 $this->process = $process;
184 $this->pConfig = $pConfig;
186 $this->argv = $args->getArgv();
187 $this->argc = $args->getArgc();
193 * Load the whole app instance
195 public function load()
199 // This has to be quite large to deal with embedded private photos
200 ini_set('pcre.backtrack_limit', 500000);
203 get_include_path() . PATH_SEPARATOR
204 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
205 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
206 . $this->getBasePath());
208 $this->profiler->reset();
210 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
211 $this->profiler->update($this->config);
213 Core\Hook::loadHooks();
214 $loader = new ConfigFileLoader($this->getBasePath());
215 Core\Hook::callAll('load_config', $loader);
218 $this->loadDefaultTimezone();
219 // Register template engines
220 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
224 * Loads the default timezone
226 * Include support for legacy $default_timezone
228 * @global string $default_timezone
230 private function loadDefaultTimezone()
232 if ($this->config->get('system', 'default_timezone')) {
233 $this->timezone = $this->config->get('system', 'default_timezone');
235 global $default_timezone;
236 $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
239 if ($this->timezone) {
240 date_default_timezone_set($this->timezone);
245 * Returns the current theme name. May be overriden by the mobile theme name.
250 public function getCurrentTheme()
252 if ($this->mode->isInstall()) {
256 // Specific mobile theme override
257 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
258 $user_mobile_theme = $this->getCurrentMobileTheme();
260 // --- means same mobile theme as desktop
261 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
262 return $user_mobile_theme;
266 if (!$this->currentTheme) {
267 $this->computeCurrentTheme();
270 return $this->currentTheme;
274 * Returns the current mobile theme name.
279 public function getCurrentMobileTheme()
281 if ($this->mode->isInstall()) {
285 if (is_null($this->currentMobileTheme)) {
286 $this->computeCurrentMobileTheme();
289 return $this->currentMobileTheme;
292 public function setCurrentTheme($theme)
294 $this->currentTheme = $theme;
297 public function setCurrentMobileTheme($theme)
299 $this->currentMobileTheme = $theme;
303 * Computes the current theme name based on the node settings, the page owner settings and the user settings
307 private function computeCurrentTheme()
309 $system_theme = $this->config->get('system', 'theme');
310 if (!$system_theme) {
311 throw new Exception($this->l10n->t('No system theme config value set.'));
315 $this->setCurrentTheme($system_theme);
318 // Find the theme that belongs to the user whose stuff we are looking at
319 if ($this->profile_uid && ($this->profile_uid != local_user())) {
320 // Allow folks to override user themes and always use their own on their own site.
321 // This works only if the user is on the same server
322 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
323 if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
324 $page_theme = $user['theme'];
328 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
330 $theme_name = Strings::sanitizeFilePathItem($theme_name);
332 && in_array($theme_name, Theme::getAllowedList())
333 && (file_exists('view/theme/' . $theme_name . '/style.css')
334 || file_exists('view/theme/' . $theme_name . '/style.php'))
336 $this->setCurrentTheme($theme_name);
341 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
343 private function computeCurrentMobileTheme()
345 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
348 $this->setCurrentMobileTheme($system_mobile_theme);
350 $page_mobile_theme = null;
351 // Find the theme that belongs to the user whose stuff we are looking at
352 if ($this->profile_uid && ($this->profile_uid != local_user())) {
353 // Allow folks to override user themes and always use their own on their own site.
354 // This works only if the user is on the same server
355 if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
356 $page_mobile_theme = $this->pConfig->get($this->profile_uid, 'system', 'mobile-theme');
360 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
362 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
363 if ($mobile_theme_name == '---'
365 in_array($mobile_theme_name, Theme::getAllowedList())
366 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
367 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
369 $this->setCurrentMobileTheme($mobile_theme_name);
374 * Provide a sane default if nothing is chosen or the specified theme does not exist.
379 public function getCurrentThemeStylesheetPath()
381 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
385 * Sets the base url for use in cmdline programs which don't have
388 public function checkURL()
390 $url = $this->config->get('system', 'url');
392 // if the url isn't set or the stored url is radically different
393 // than the currently visited url, store the current value accordingly.
394 // "Radically different" ignores common variations such as http vs https
395 // and www.example.com vs example.com.
396 // We will only change the url to an ip address if there is no existing setting
398 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()))) {
399 $this->config->set('system', 'url', $this->baseURL->get());
404 * Frontend App script
406 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
407 * request and a representation of the response.
409 * This probably should change to limit the size of this monster method.
411 * @param App\Module $module The determined module
412 * @param App\Router $router
413 * @param IPConfig $pconfig
414 * @param Authentication $auth The Authentication backend of the node
415 * @param App\Page $page The Friendica page printing container
417 * @throws HTTPException\InternalServerErrorException
418 * @throws \ImagickException
420 public function runFrontend(App\Module $module, App\Router $router, IPConfig $pconfig, Authentication $auth, App\Page $page, float $start_time)
422 $this->profiler->set($start_time, 'start');
423 $this->profiler->set(microtime(true), 'classinit');
425 $moduleName = $module->getName();
428 // Missing DB connection: ERROR
429 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
430 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
433 // Max Load Average reached: ERROR
434 if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
435 header('Retry-After: 120');
436 header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
438 throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
441 if (!$this->mode->isInstall()) {
442 // Force SSL redirection
443 if ($this->baseURL->checkRedirectHttps()) {
444 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
447 Core\Hook::callAll('init_1');
450 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
451 $requester = HTTPSignature::getSigner('', $_SERVER);
452 if (!empty($requester)) {
453 Profile::addVisitorCookieForHandle($requester);
458 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend()) {
460 // Only continue when the given profile link seems valid
461 // Valid profile links contain a path with "/profile/" and no query parameters
462 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
463 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
464 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
465 Core\Session::set('my_url', $_GET['zrl']);
466 Core\Session::set('authenticated', 0);
469 Model\Profile::zrlInit($this);
471 // Someone came with an invalid parameter, maybe as a DDoS attempt
472 // We simply stop processing here
473 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
474 throw new HTTPException\ForbiddenException();
479 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
480 $token = $_GET['owt'];
481 Model\Profile::openWebAuthInit($token);
484 $auth->withSession($this);
486 if (empty($_SESSION['authenticated'])) {
487 header('X-Account-Management-Status: none');
490 $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
491 $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
492 $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
495 * check_config() is responsible for running update scripts. These automatically
496 * update the DB schema whenever we push a new one out. It also checks to see if
497 * any addons have been added or removed and reacts accordingly.
500 // in install mode, any url loads install module
501 // but we need "view" module for stylesheet
502 if ($this->mode->isInstall() && $moduleName !== 'install') {
503 $this->baseURL->redirect('install');
506 Core\Update::check($this->getBasePath(), false, $this->mode);
507 Core\Addon::loadAddons();
508 Core\Hook::loadHooks();
511 // Compatibility with the Android Diaspora client
512 if ($moduleName == 'stream') {
513 $this->baseURL->redirect('network?order=post');
516 if ($moduleName == 'conversations') {
517 $this->baseURL->redirect('message');
520 if ($moduleName == 'commented') {
521 $this->baseURL->redirect('network?order=comment');
524 if ($moduleName == 'liked') {
525 $this->baseURL->redirect('network?order=comment');
528 if ($moduleName == 'activity') {
529 $this->baseURL->redirect('network?conv=1');
532 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
533 $this->baseURL->redirect('bookmarklet');
536 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
537 $this->baseURL->redirect('settings');
540 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
541 $this->baseURL->redirect('search');
544 // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
545 $page['page_title'] = $moduleName;
547 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
548 $module = new Module('maintenance', Maintenance::class);
550 // determine the module class and save it to the module instance
551 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
552 $module = $module->determineClass($this->args, $router, $this->config);
555 // Let the module run it's internal process (init, get, post, ...)
556 $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
557 } catch (HTTPException $e) {
558 ModuleHTTPException::rawContent($e);
561 $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
565 * Automatically redirects to relative or absolute URL
566 * Should only be used if it isn't clear if the URL is either internal or external
568 * @param string $toUrl The target URL
570 * @throws HTTPException\InternalServerErrorException
572 public function redirect($toUrl)
574 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
575 Core\System::externalRedirect($toUrl);
577 $this->baseURL->redirect($toUrl);