3 * @copyright Copyright (C) 2010-2022, 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\Capabilities\ICanCreateResponses;
28 use Friendica\Core\Config\Factory\Config;
29 use Friendica\Module\Maintenance;
30 use Friendica\Security\Authentication;
31 use Friendica\Core\Config\ValueObject\Cache;
32 use Friendica\Core\Config\Capability\IManageConfigValues;
33 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
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\DateTimeFormat;
43 use Friendica\Util\HTTPInputData;
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 const PLATFORM = 'Friendica';
62 const CODENAME = 'Giant Rhubarb';
63 const VERSION = '2022.12-dev';
65 // Allow themes to control internal parameters
66 // by changing App values in theme.php
67 private $theme_info = [
70 'events_in_profile' => true
74 private $nickname = '';
75 private $timezone = '';
76 private $profile_owner = 0;
77 private $contact_id = 0;
81 * @var App\Mode The Mode of the Application
90 /** @var string The name of the current theme */
91 private $currentTheme;
92 /** @var string The name of the current mobile theme */
93 private $currentMobileTheme;
96 * @var IManageConfigValues The config
101 * @var LoggerInterface The logger
106 * @var Profiler The profiler of this app
111 * @var Database The Friendica database connection
116 * @var L10n The translator
126 * @var IManagePersonalConfigValues
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(): bool
154 return local_user() && $this->user_id && ($this->user_id == local_user());
158 * Check if current user has admin role.
160 * @return bool true if user is an admin
162 public function isSiteAdmin(): bool
164 $admin_email = $this->config->get('config', 'admin_email');
166 $adminlist = explode(',', str_replace(' ', '', $admin_email));
168 return local_user() && $admin_email && $this->database->exists('user', ['uid' => $this->getLoggedInUserId(), 'email' => $adminlist]);
173 * @return int User id
175 public function getLoggedInUserId(): int
177 return $this->user_id;
181 * Fetch the user nick name
182 * @return string User's nickname
184 public function getLoggedInUserNickname(): string
186 return $this->nickname;
190 * Set the profile owner ID
192 * @param int $owner_id
195 public function setProfileOwner(int $owner_id)
197 $this->profile_owner = $owner_id;
201 * Get the profile owner ID
205 public function getProfileOwner(): int
207 return $this->profile_owner;
213 * @param int $contact_id
216 public function setContactId(int $contact_id)
218 $this->contact_id = $contact_id;
226 public function getContactId(): int
228 return $this->contact_id;
234 * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
237 public function setTimeZone(string $timezone)
239 $this->timezone = (new \DateTimeZone($timezone))->getName();
240 DateTimeFormat::setLocalTimeZone($this->timezone);
248 public function getTimeZone(): string
250 return $this->timezone;
254 * Set workerqueue information
256 * @param array $queue
259 public function setQueue(array $queue)
261 $this->queue = $queue;
265 * Fetch workerqueue information
267 * @return array Worker queue
269 public function getQueue(): array
271 return $this->queue ?? [];
275 * Fetch a specific workerqueue field
277 * @param string $index Work queue record to fetch
278 * @return mixed Work queue item or NULL if not found
280 public function getQueueValue(string $index)
282 return $this->queue[$index] ?? null;
285 public function setThemeInfoValue(string $index, $value)
287 $this->theme_info[$index] = $value;
290 public function getThemeInfo()
292 return $this->theme_info;
295 public function getThemeInfoValue(string $index, $default = null)
297 return $this->theme_info[$index] ?? $default;
301 * Returns the current config cache of this node
305 public function getConfigCache()
307 return $this->config->getCache();
311 * The basepath of this app
313 * @return string Base path from configuration
315 public function getBasePath(): string
317 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
318 return $this->config->getCache()->get('system', 'basepath');
322 * @param Database $database The Friendica Database
323 * @param IManageConfigValues $config The Configuration
324 * @param App\Mode $mode The mode of this Friendica app
325 * @param BaseURL $baseURL The full base URL of this Friendica app
326 * @param LoggerInterface $logger The current app logger
327 * @param Profiler $profiler The profiler of this application
328 * @param L10n $l10n The translator instance
329 * @param App\Arguments $args The Friendica Arguments of the call
330 * @param IManagePersonalConfigValues $pConfig Personal configuration
332 public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, IManagePersonalConfigValues $pConfig)
334 $this->database = $database;
335 $this->config = $config;
337 $this->baseURL = $baseURL;
338 $this->profiler = $profiler;
339 $this->logger = $logger;
342 $this->pConfig = $pConfig;
348 * Load the whole app instance
350 public function load()
354 // Normally this constant is defined - but not if "pcntl" isn't installed
355 if (!defined('SIGTERM')) {
356 define('SIGTERM', 15);
359 // Ensure that all "strtotime" operations do run timezone independent
360 date_default_timezone_set('UTC');
362 // This has to be quite large to deal with embedded private photos
363 ini_set('pcre.backtrack_limit', 500000);
366 get_include_path() . PATH_SEPARATOR
367 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
368 . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
369 . $this->getBasePath());
371 $this->profiler->reset();
373 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
374 $this->profiler->update($this->config);
376 Core\Hook::loadHooks();
377 $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
378 Core\Hook::callAll('load_config', $loader);
381 $this->loadDefaultTimezone();
382 // Register template engines
383 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
387 * Loads the default timezone
389 * Include support for legacy $default_timezone
391 * @global string $default_timezone
393 private function loadDefaultTimezone()
395 if ($this->config->get('system', 'default_timezone')) {
396 $timezone = $this->config->get('system', 'default_timezone', 'UTC');
398 global $default_timezone;
399 $timezone = $default_timezone ?? '' ?: 'UTC';
402 $this->setTimeZone($timezone);
406 * Returns the current theme name. May be overriden by the mobile theme name.
408 * @return string Current theme name or empty string in installation phase
411 public function getCurrentTheme(): string
413 if ($this->mode->isInstall()) {
417 // Specific mobile theme override
418 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
419 $user_mobile_theme = $this->getCurrentMobileTheme();
421 // --- means same mobile theme as desktop
422 if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
423 return $user_mobile_theme;
427 if (!$this->currentTheme) {
428 $this->computeCurrentTheme();
431 return $this->currentTheme;
435 * Returns the current mobile theme name.
437 * @return string Mobile theme name or empty string if installer
440 public function getCurrentMobileTheme(): string
442 if ($this->mode->isInstall()) {
446 if (is_null($this->currentMobileTheme)) {
447 $this->computeCurrentMobileTheme();
450 return $this->currentMobileTheme;
454 * Setter for current theme name
456 * @param string $theme Name of current theme
458 public function setCurrentTheme(string $theme)
460 $this->currentTheme = $theme;
464 * Setter for current mobile theme name
466 * @param string $theme Name of current mobile theme
468 public function setCurrentMobileTheme(string $theme)
470 $this->currentMobileTheme = $theme;
474 * Computes the current theme name based on the node settings, the page owner settings and the user settings
478 private function computeCurrentTheme()
480 $system_theme = $this->config->get('system', 'theme');
481 if (!$system_theme) {
482 throw new Exception($this->l10n->t('No system theme config value set.'));
486 $this->setCurrentTheme($system_theme);
489 // Find the theme that belongs to the user whose stuff we are looking at
490 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
491 // Allow folks to override user themes and always use their own on their own site.
492 // This works only if the user is on the same server
493 $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
494 if ($this->database->isResult($user) && !local_user()) {
495 $page_theme = $user['theme'];
499 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
501 $theme_name = Strings::sanitizeFilePathItem($theme_name);
503 && in_array($theme_name, Theme::getAllowedList())
504 && (file_exists('view/theme/' . $theme_name . '/style.css')
505 || file_exists('view/theme/' . $theme_name . '/style.php'))
507 $this->setCurrentTheme($theme_name);
512 * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
514 private function computeCurrentMobileTheme()
516 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
519 $this->setCurrentMobileTheme($system_mobile_theme);
521 $page_mobile_theme = null;
522 // Find the theme that belongs to the user whose stuff we are looking at
523 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
524 // Allow folks to override user themes and always use their own on their own site.
525 // This works only if the user is on the same server
527 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
531 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
533 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
534 if ($mobile_theme_name == '---'
536 in_array($mobile_theme_name, Theme::getAllowedList())
537 && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
538 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
540 $this->setCurrentMobileTheme($mobile_theme_name);
545 * Provide a sane default if nothing is chosen or the specified theme does not exist.
547 * @return string Current theme's stylsheet path
550 public function getCurrentThemeStylesheetPath(): string
552 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
556 * Sets the base url for use in cmdline programs which don't have
559 public function checkURL()
561 $url = $this->config->get('system', 'url');
563 // if the url isn't set or the stored url is radically different
564 // than the currently visited url, store the current value accordingly.
565 // "Radically different" ignores common variations such as http vs https
566 // and www.example.com vs example.com.
567 // We will only change the url to an ip address if there is no existing setting
569 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()))) {
570 $this->config->set('system', 'url', $this->baseURL->get());
575 * Frontend App script
577 * The App object behaves like a container and a dispatcher at the same time, including a representation of the
578 * request and a representation of the response.
580 * This probably should change to limit the size of this monster method.
582 * @param App\Router $router
583 * @param IManagePersonalConfigValues $pconfig
584 * @param Authentication $auth The Authentication backend of the node
585 * @param App\Page $page The Friendica page printing container
586 * @param HTTPInputData $httpInput A library for processing PHP input streams
587 * @param float $start_time The start time of the overall script execution
589 * @throws HTTPException\InternalServerErrorException
590 * @throws \ImagickException
592 public function runFrontend(App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, HTTPInputData $httpInput, float $start_time)
594 $this->profiler->set($start_time, 'start');
595 $this->profiler->set(microtime(true), 'classinit');
597 $moduleName = $this->args->getModuleName();
598 $page->setLogging($this->args->getMethod(), $this->args->getModuleName(), $this->args->getCommand());
601 // Missing DB connection: ERROR
602 if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
603 throw new HTTPException\InternalServerErrorException($this->l10n->t('Apologies but the website is unavailable at the moment.'));
606 if (!$this->mode->isInstall()) {
607 // Force SSL redirection
608 if ($this->baseURL->checkRedirectHttps()) {
609 System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
612 Core\Hook::callAll('init_1');
615 if ($this->mode->isNormal() && !$this->mode->isBackend()) {
616 $requester = HTTPSignature::getSigner('', $_SERVER);
617 if (!empty($requester)) {
618 Profile::addVisitorCookieForHandle($requester);
623 if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend() && !local_user()) {
624 // Only continue when the given profile link seems valid
625 // Valid profile links contain a path with "/profile/" and no query parameters
626 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == '') &&
627 strstr(parse_url($_GET['zrl'], PHP_URL_PATH), '/profile/')) {
628 if (Core\Session::get('visitor_home') != $_GET['zrl']) {
629 Core\Session::set('my_url', $_GET['zrl']);
630 Core\Session::set('authenticated', 0);
632 $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
633 if (!empty($remote_contact['subscribe'])) {
634 $_SESSION['remote_comment'] = $remote_contact['subscribe'];
638 Model\Profile::zrlInit($this);
640 // Someone came with an invalid parameter, maybe as a DDoS attempt
641 // We simply stop processing here
642 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
643 throw new HTTPException\ForbiddenException();
647 if (!empty($_GET['owt']) && $this->mode->isNormal()) {
648 $token = $_GET['owt'];
649 Model\Profile::openWebAuthInit($token);
652 if (!$this->mode->isBackend()) {
653 $auth->withSession($this);
656 if (empty($_SESSION['authenticated'])) {
657 header('X-Account-Management-Status: none');
661 * check_config() is responsible for running update scripts. These automatically
662 * update the DB schema whenever we push a new one out. It also checks to see if
663 * any addons have been added or removed and reacts accordingly.
666 // in install mode, any url loads install module
667 // but we need "view" module for stylesheet
668 if ($this->mode->isInstall() && $moduleName !== 'install') {
669 $this->baseURL->redirect('install');
672 Core\Update::check($this->getBasePath(), false, $this->mode);
673 Core\Addon::loadAddons();
674 Core\Hook::loadHooks();
677 // Compatibility with the Android Diaspora client
678 if ($moduleName == 'stream') {
679 $this->baseURL->redirect('network?order=post');
682 if ($moduleName == 'conversations') {
683 $this->baseURL->redirect('message');
686 if ($moduleName == 'commented') {
687 $this->baseURL->redirect('network?order=comment');
690 if ($moduleName == 'liked') {
691 $this->baseURL->redirect('network?order=comment');
694 if ($moduleName == 'activity') {
695 $this->baseURL->redirect('network?conv=1');
698 if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
699 $this->baseURL->redirect('bookmarklet');
702 if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
703 $this->baseURL->redirect('settings');
706 if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
707 $this->baseURL->redirect('search');
710 // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
711 $page['page_title'] = $moduleName;
713 // The "view" module is required to show the theme CSS
714 if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'view') {
715 $module = $router->getModule(Maintenance::class);
717 // determine the module class and save it to the module instance
718 // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
719 $module = $router->getModule();
722 // Processes data from GET requests
723 $httpinput = $httpInput->process();
724 $input = array_merge($httpinput['variables'], $httpinput['files'], $request ?? $_REQUEST);
726 // Let the module run it's internal process (init, get, post, ...)
727 $timestamp = microtime(true);
728 $response = $module->run($input);
729 $this->profiler->set(microtime(true) - $timestamp, 'content');
730 if ($response->getHeaderLine(ICanCreateResponses::X_HEADER) === ICanCreateResponses::TYPE_HTML) {
731 $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig);
733 $page->exit($response);
735 } catch (HTTPException $e) {
736 (new ModuleHTTPException())->rawContent($e);
738 $page->logRuntime($this->config, 'runFrontend');
742 * Automatically redirects to relative or absolute URL
743 * Should only be used if it isn't clear if the URL is either internal or external
745 * @param string $toUrl The target URL
747 * @throws HTTPException\InternalServerErrorException
749 public function redirect(string $toUrl)
751 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
752 Core\System::externalRedirect($toUrl);
754 $this->baseURL->redirect($toUrl);