<?php
/**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
use Exception;
use Friendica\App\Arguments;
use Friendica\App\BaseURL;
-use Friendica\App\Module;
+use Friendica\Capabilities\ICanCreateResponses;
+use Friendica\Core\Config\Factory\Config;
+use Friendica\Core\Session\Capability\IHandleUserSessions;
+use Friendica\Database\Definition\DbaDefinition;
+use Friendica\Database\Definition\ViewDefinition;
use Friendica\Module\Maintenance;
use Friendica\Security\Authentication;
-use Friendica\Core\Config\Cache;
-use Friendica\Core\Config\IConfig;
-use Friendica\Core\PConfig\IPConfig;
+use Friendica\Core\Config\ValueObject\Cache;
+use Friendica\Core\Config\Capability\IManageConfigValues;
+use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
use Friendica\Core\L10n;
use Friendica\Core\System;
use Friendica\Core\Theme;
use Friendica\Database\Database;
use Friendica\Model\Contact;
use Friendica\Model\Profile;
-use Friendica\Model\User;
use Friendica\Module\Special\HTTPException as ModuleHTTPException;
use Friendica\Network\HTTPException;
-use Friendica\Util\ConfigFileLoader;
+use Friendica\Util\DateTimeFormat;
+use Friendica\Util\HTTPInputData;
use Friendica\Util\HTTPSignature;
use Friendica\Util\Profiler;
use Friendica\Util\Strings;
*/
class App
{
- public $user;
+ const PLATFORM = 'Friendica';
+ const CODENAME = 'Giant Rhubarb';
+ const VERSION = '2023.03-dev';
// Allow themes to control internal parameters
// by changing App values in theme.php
private $theme_info = [
'videowidth' => 425,
'videoheight' => 350,
- 'events_in_profile' => true
];
- private $user_id = 0;
- private $nickname = '';
private $timezone = '';
private $profile_owner = 0;
private $contact_id = 0;
private $currentMobileTheme;
/**
- * @var IConfig The config
+ * @var IManageConfigValues The config
*/
private $config;
private $args;
/**
- * @var Core\Process The process methods
- */
- private $process;
-
- /**
- * @var IPConfig
+ * @var IManagePersonalConfigValues
*/
private $pConfig;
/**
- * Set the user ID
- *
- * @param int $user_id
- * @return void
+ * @var IHandleUserSessions
*/
- public function setUserId(int $user_id)
- {
- $this->user_id = $user_id;
- }
+ private $session;
/**
- * Set the nickname
- *
- * @param int $user_id
- * @return void
+ * @deprecated 2022.03
+ * @see IHandleUserSessions::isAuthenticated()
*/
- public function setNickname(string $nickname)
+ public function isLoggedIn(): bool
{
- $this->nickname = $nickname;
+ return $this->session->isAuthenticated();
}
/**
- * Fetch the user id
- * @return int
+ * @deprecated 2022.03
+ * @see IHandleUserSessions::isSiteAdmin()
*/
- public function getUserId()
+ public function isSiteAdmin(): bool
{
- return $this->user_id;
+ return $this->session->isSiteAdmin();
}
/**
- * Fetch the user nick name
- * @return string
+ * @deprecated 2022.03
+ * @see IHandleUserSessions::getLocalUserId()
*/
- public function getNickname()
+ public function getLoggedInUserId(): int
{
- return $this->nickname;
+ return $this->session->getLocalUserId();
}
/**
- * Fetch a specific user field
- *
- * @param string $index
- * @return mixed
+ * @deprecated 2022.03
+ * @see IHandleUserSessions::getLocalUserNickname()
*/
- public function getUserValue(string $index)
+ public function getLoggedInUserNickname(): string
{
- if (empty($this->user_id)) {
- return null;
- }
-
- if (empty($this->user)) {
- $this->user = User::getById($this->user_id);
- }
-
- return $this->user[$index] ?? null;
+ return $this->session->getLocalUserNickname();
}
/**
*
* @return int
*/
- public function getProfileOwner():int
+ public function getProfileOwner(): int
{
return $this->profile_owner;
}
*
* @return int
*/
- public function getContactId():int
+ public function getContactId(): int
{
return $this->contact_id;
}
/**
* Set the timezone
*
- * @param int $timezone
+ * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
* @return void
*/
public function setTimeZone(string $timezone)
{
- $this->timezone = $timezone;
+ $this->timezone = (new \DateTimeZone($timezone))->getName();
+ DateTimeFormat::setLocalTimeZone($this->timezone);
}
/**
*
* @return int
*/
- public function getTimeZone():string
+ public function getTimeZone(): string
{
return $this->timezone;
}
/**
* Set workerqueue information
*
- * @param array $queue
- * @return void
+ * @param array $queue
+ * @return void
*/
public function setQueue(array $queue)
{
/**
* Fetch workerqueue information
*
- * @return array
+ * @return array Worker queue
*/
- public function getQueue()
+ public function getQueue(): array
{
return $this->queue ?? [];
}
/**
* Fetch a specific workerqueue field
*
- * @param string $index
- * @return mixed
+ * @param string $index Work queue record to fetch
+ * @return mixed Work queue item or NULL if not found
*/
public function getQueueValue(string $index)
{
/**
* The basepath of this app
*
- * @return string
+ * @return string Base path from configuration
*/
- public function getBasePath()
+ public function getBasePath(): string
{
// Don't use the basepath of the config table for basepath (it should always be the config-file one)
return $this->config->getCache()->get('system', 'basepath');
}
/**
- * @param Database $database The Friendica Database
- * @param IConfig $config The Configuration
- * @param App\Mode $mode The mode of this Friendica app
- * @param BaseURL $baseURL The full base URL of this Friendica app
- * @param LoggerInterface $logger The current app logger
- * @param Profiler $profiler The profiler of this application
- * @param L10n $l10n The translator instance
- * @param App\Arguments $args The Friendica Arguments of the call
- * @param Core\Process $process The process methods
- * @param IPConfig $pConfig Personal configuration
+ * @param Database $database The Friendica Database
+ * @param IManageConfigValues $config The Configuration
+ * @param App\Mode $mode The mode of this Friendica app
+ * @param BaseURL $baseURL The full base URL of this Friendica app
+ * @param LoggerInterface $logger The current app logger
+ * @param Profiler $profiler The profiler of this application
+ * @param L10n $l10n The translator instance
+ * @param App\Arguments $args The Friendica Arguments of the call
+ * @param IManagePersonalConfigValues $pConfig Personal configuration
+ * @param IHandleUserSessions $session The (User)Session handler
+ * @param DbaDefinition $dbaDefinition
+ * @param ViewDefinition $viewDefinition
*/
- 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)
+ public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, IManagePersonalConfigValues $pConfig, IHandleUserSessions $session, DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition)
{
- $this->database = $database;
- $this->config = $config;
- $this->mode = $mode;
- $this->baseURL = $baseURL;
- $this->profiler = $profiler;
- $this->logger = $logger;
- $this->l10n = $l10n;
- $this->args = $args;
- $this->process = $process;
- $this->pConfig = $pConfig;
-
- $this->load();
+ $this->database = $database;
+ $this->config = $config;
+ $this->mode = $mode;
+ $this->baseURL = $baseURL;
+ $this->profiler = $profiler;
+ $this->logger = $logger;
+ $this->l10n = $l10n;
+ $this->args = $args;
+ $this->pConfig = $pConfig;
+ $this->session = $session;
+
+ $this->load($dbaDefinition, $viewDefinition);
}
/**
* Load the whole app instance
*/
- public function load()
+ protected function load(DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition)
{
set_time_limit(0);
+ // Normally this constant is defined - but not if "pcntl" isn't installed
+ if (!defined('SIGTERM')) {
+ define('SIGTERM', 15);
+ }
+
+ // Ensure that all "strtotime" operations do run timezone independent
+ date_default_timezone_set('UTC');
+
// This has to be quite large to deal with embedded private photos
ini_set('pcre.backtrack_limit', 500000);
$this->profiler->update($this->config);
Core\Hook::loadHooks();
- $loader = new ConfigFileLoader($this->getBasePath());
+ $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
Core\Hook::callAll('load_config', $loader);
+
+ // Hooks are now working, reload the whole definitions with hook enabled
+ $dbaDefinition->load(true);
+ $viewDefinition->load(true);
}
$this->loadDefaultTimezone();
private function loadDefaultTimezone()
{
if ($this->config->get('system', 'default_timezone')) {
- $this->timezone = $this->config->get('system', 'default_timezone');
+ $timezone = $this->config->get('system', 'default_timezone', 'UTC');
} else {
global $default_timezone;
- $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
+ $timezone = $default_timezone ?? '' ?: 'UTC';
}
- if ($this->timezone) {
- date_default_timezone_set($this->timezone);
- }
+ $this->setTimeZone($timezone);
}
/**
* Returns the current theme name. May be overriden by the mobile theme name.
*
- * @return string
+ * @return string Current theme name or empty string in installation phase
* @throws Exception
*/
- public function getCurrentTheme()
+ public function getCurrentTheme(): string
{
if ($this->mode->isInstall()) {
return '';
}
// Specific mobile theme override
- if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
+ if (($this->mode->isMobile() || $this->mode->isTablet()) && $this->session->get('show-mobile', true)) {
$user_mobile_theme = $this->getCurrentMobileTheme();
// --- means same mobile theme as desktop
/**
* Returns the current mobile theme name.
*
- * @return string
+ * @return string Mobile theme name or empty string if installer
* @throws Exception
*/
- public function getCurrentMobileTheme()
+ public function getCurrentMobileTheme(): string
{
if ($this->mode->isInstall()) {
return '';
return $this->currentMobileTheme;
}
- public function setCurrentTheme($theme)
+ /**
+ * Setter for current theme name
+ *
+ * @param string $theme Name of current theme
+ */
+ public function setCurrentTheme(string $theme)
{
$this->currentTheme = $theme;
}
- public function setCurrentMobileTheme($theme)
+ /**
+ * Setter for current mobile theme name
+ *
+ * @param string $theme Name of current mobile theme
+ */
+ public function setCurrentMobileTheme(string $theme)
{
$this->currentMobileTheme = $theme;
}
$page_theme = null;
// Find the theme that belongs to the user whose stuff we are looking at
- if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
+ if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
// Allow folks to override user themes and always use their own on their own site.
// This works only if the user is on the same server
$user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
- if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
+ if ($this->database->isResult($user) && !$this->session->getLocalUserId()) {
$page_theme = $user['theme'];
}
}
- $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
+ $theme_name = $page_theme ?: $this->session->get('theme', $system_theme);
$theme_name = Strings::sanitizeFilePathItem($theme_name);
if ($theme_name
$page_mobile_theme = null;
// Find the theme that belongs to the user whose stuff we are looking at
- if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
+ if (!empty($this->profile_owner) && ($this->profile_owner != $this->session->getLocalUserId())) {
// Allow folks to override user themes and always use their own on their own site.
// This works only if the user is on the same server
- if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
+ if (!$this->session->getLocalUserId()) {
$page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
}
}
- $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
+ $mobile_theme_name = $page_mobile_theme ?: $this->session->get('mobile-theme', $system_mobile_theme);
$mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
if ($mobile_theme_name == '---'
/**
* Provide a sane default if nothing is chosen or the specified theme does not exist.
*
- * @return string
+ * @return string Current theme's stylsheet path
* @throws Exception
*/
- public function getCurrentThemeStylesheetPath()
+ public function getCurrentThemeStylesheetPath(): string
{
return Core\Theme::getStylesheetPath($this->getCurrentTheme());
}
*
* This probably should change to limit the size of this monster method.
*
- * @param App\Module $module The determined module
- * @param App\Router $router
- * @param IPConfig $pconfig
- * @param Authentication $auth The Authentication backend of the node
- * @param App\Page $page The Friendica page printing container
+ * @param App\Router $router
+ * @param IManagePersonalConfigValues $pconfig
+ * @param Authentication $auth The Authentication backend of the node
+ * @param App\Page $page The Friendica page printing container
+ * @param ModuleHTTPException $httpException The possible HTTP Exception container
+ * @param HTTPInputData $httpInput A library for processing PHP input streams
+ * @param float $start_time The start time of the overall script execution
*
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- public function runFrontend(App\Module $module, App\Router $router, IPConfig $pconfig, Authentication $auth, App\Page $page, float $start_time)
+ public function runFrontend(App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, ModuleHTTPException $httpException, HTTPInputData $httpInput, float $start_time)
{
$this->profiler->set($start_time, 'start');
$this->profiler->set(microtime(true), 'classinit');
- $moduleName = $module->getName();
+ $moduleName = $this->args->getModuleName();
+ $page->setLogging($this->args->getMethod(), $this->args->getModuleName(), $this->args->getCommand());
try {
// Missing DB connection: ERROR
if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
- throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
- }
-
- // Max Load Average reached: ERROR
- if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
- header('Retry-After: 120');
- header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
-
- throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
+ throw new HTTPException\InternalServerErrorException($this->l10n->t('Apologies but the website is unavailable at the moment.'));
}
if (!$this->mode->isInstall()) {
}
// ZRL
- if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend()) {
- if (!local_user()) {
- // Only continue when the given profile link seems valid
- // Valid profile links contain a path with "/profile/" and no query parameters
- if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
- strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
- if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
- Core\Session::set('my_url', $_GET['zrl']);
- Core\Session::set('authenticated', 0);
-
- $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
- if (!empty($remote_contact['subscribe'])) {
- $_SESSION['remote_comment'] = $remote_contact['subscribe'];
- }
+ if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend() && !$this->session->getLocalUserId()) {
+ // Only continue when the given profile link seems valid.
+ // Valid profile links contain a path with "/profile/" and no query parameters
+ if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == '') &&
+ strpos(parse_url($_GET['zrl'], PHP_URL_PATH) ?? '', '/profile/') !== false) {
+ if ($this->session->get('visitor_home') != $_GET['zrl']) {
+ $this->session->set('my_url', $_GET['zrl']);
+ $this->session->set('authenticated', 0);
+
+ $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
+ if (!empty($remote_contact['subscribe'])) {
+ $_SESSION['remote_comment'] = $remote_contact['subscribe'];
}
-
- Model\Profile::zrlInit($this);
- } else {
- // Someone came with an invalid parameter, maybe as a DDoS attempt
- // We simply stop processing here
- $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
- throw new HTTPException\ForbiddenException();
}
+
+ Model\Profile::zrlInit($this);
+ } else {
+ // Someone came with an invalid parameter, maybe as a DDoS attempt
+ // We simply stop processing here
+ $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
+ throw new HTTPException\ForbiddenException();
}
}
Model\Profile::openWebAuthInit($token);
}
- $auth->withSession($this);
+ if (!$this->mode->isBackend()) {
+ $auth->withSession($this);
+ }
if (empty($_SESSION['authenticated'])) {
header('X-Account-Management-Status: none');
}
- $_SESSION['sysmsg'] = Core\Session::get('sysmsg', []);
- $_SESSION['sysmsg_info'] = Core\Session::get('sysmsg_info', []);
- $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
-
/*
* check_config() is responsible for running update scripts. These automatically
* update the DB schema whenever we push a new one out. It also checks to see if
// Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
$page['page_title'] = $moduleName;
- if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
- $module = new Module('maintenance', Maintenance::class);
+ // The "view" module is required to show the theme CSS
+ if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'view') {
+ $module = $router->getModule(Maintenance::class);
} else {
// determine the module class and save it to the module instance
// @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
- $module = $module->determineClass($this->args, $router, $this->config);
+ $module = $router->getModule();
}
- // Let the module run it's internal process (init, get, post, ...)
- $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
+ // Processes data from GET requests
+ $httpinput = $httpInput->process();
+ $input = array_merge($httpinput['variables'], $httpinput['files'], $request ?? $_REQUEST);
+
+ // Let the module run its internal process (init, get, post, ...)
+ $timestamp = microtime(true);
+ $response = $module->run($httpException, $input);
+ $this->profiler->set(microtime(true) - $timestamp, 'content');
+ if ($response->getHeaderLine(ICanCreateResponses::X_HEADER) === ICanCreateResponses::TYPE_HTML) {
+ $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig, $this->session->getLocalUserId());
+ } else {
+ $page->exit($response);
+ }
} catch (HTTPException $e) {
- ModuleHTTPException::rawContent($e);
+ $httpException->rawContent($e);
}
-
- $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
+ $page->logRuntime($this->config, 'runFrontend');
}
/**
*
* @throws HTTPException\InternalServerErrorException
*/
- public function redirect($toUrl)
+ public function redirect(string $toUrl)
{
if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
Core\System::externalRedirect($toUrl);