friendica/src/App.php

727 lines
19 KiB
PHP
Raw Normal View History

<?php
/**
2021-03-29 06:40:20 +00:00
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica;
use Exception;
2019-08-12 16:13:58 +00:00
use Friendica\App\Arguments;
use Friendica\App\BaseURL;
use Friendica\App\Module;
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\L10n;
use Friendica\Core\System;
use Friendica\Core\Theme;
2019-06-06 22:10:45 +00:00
use Friendica\Database\Database;
use Friendica\Model\Contact;
use Friendica\Model\Profile;
2019-08-12 16:13:58 +00:00
use Friendica\Module\Special\HTTPException as ModuleHTTPException;
use Friendica\Network\HTTPException;
use Friendica\Util\ConfigFileLoader;
use Friendica\Util\HTTPSignature;
2019-02-16 22:11:30 +00:00
use Friendica\Util\Profiler;
use Friendica\Util\Strings;
2018-12-30 20:42:56 +00:00
use Psr\Log\LoggerInterface;
2017-05-11 15:53:04 +00:00
/**
2020-01-19 06:05:23 +00:00
* Our main application structure for the life of this page.
*
* Primarily deals with the URL that got us here
* and tries to make some sense of it, and
* stores our page contents and config storage
* and anything else that might need to be passed around
* before we spit the page out.
*
*/
class App
{
// Allow themes to control internal parameters
// by changing App values in theme.php
2021-07-25 19:39:10 +00:00
private $theme_info = [
'videowidth' => 425,
'videoheight' => 350,
'events_in_profile' => true
];
2021-08-08 10:14:56 +00:00
private $user_id = 0;
private $nickname = '';
2021-07-24 22:08:33 +00:00
private $timezone = '';
2021-07-24 20:51:55 +00:00
private $profile_owner = 0;
private $contact_id = 0;
2021-07-24 22:08:33 +00:00
private $queue = [];
2021-07-24 20:42:09 +00:00
/**
* @var App\Mode The Mode of the Application
*/
private $mode;
/**
* @var BaseURL
*/
private $baseURL;
/** @var string The name of the current theme */
private $currentTheme;
/** @var string The name of the current mobile theme */
private $currentMobileTheme;
2018-12-30 20:42:56 +00:00
/**
* @var IConfig The config
2019-02-03 21:22:04 +00:00
*/
private $config;
/**
* @var LoggerInterface The logger
2018-12-30 20:42:56 +00:00
*/
private $logger;
2019-02-03 21:22:04 +00:00
/**
2019-02-16 22:11:30 +00:00
* @var Profiler The profiler of this app
2019-02-03 21:22:04 +00:00
*/
2019-02-16 22:11:30 +00:00
private $profiler;
2019-02-03 21:22:04 +00:00
2019-06-06 22:10:45 +00:00
/**
* @var Database The Friendica database connection
*/
private $database;
/**
* @var L10n The translator
*/
private $l10n;
2019-08-12 16:13:58 +00:00
/**
* @var App\Arguments
*/
private $args;
/**
* @var Core\Process The process methods
*/
private $process;
/**
* @var IPConfig
*/
private $pConfig;
2021-08-08 10:14:56 +00:00
/**
* Set the user ID
*
* @param int $user_id
* @return void
*/
2021-08-09 20:56:15 +00:00
public function setLoggedInUserId(int $user_id)
2021-08-08 10:14:56 +00:00
{
$this->user_id = $user_id;
}
/**
* Set the nickname
*
* @param int $user_id
* @return void
*/
2021-08-09 20:56:15 +00:00
public function setLoggedInUserNickname(string $nickname)
2021-08-08 10:14:56 +00:00
{
$this->nickname = $nickname;
}
2021-08-08 19:30:21 +00:00
public function isLoggedIn()
{
return local_user() && $this->user_id && ($this->user_id == local_user());
}
2021-08-08 10:14:56 +00:00
/**
* Fetch the user id
* @return int
*/
2021-08-09 20:33:46 +00:00
public function getLoggedInUserId()
2021-08-08 10:14:56 +00:00
{
return $this->user_id;
}
/**
* Fetch the user nick name
* @return string
*/
public function getLoggedInUserNickname()
2021-08-08 10:14:56 +00:00
{
return $this->nickname;
}
2021-07-24 20:42:09 +00:00
/**
* Set the profile owner ID
*
2021-07-24 22:08:33 +00:00
* @param int $owner_id
* @return void
2021-07-24 20:42:09 +00:00
*/
2021-07-24 20:34:07 +00:00
public function setProfileOwner(int $owner_id)
{
$this->profile_owner = $owner_id;
}
2021-07-24 20:42:09 +00:00
/**
* Get the profile owner ID
*
2021-07-24 22:08:33 +00:00
* @return int
2021-07-24 20:42:09 +00:00
*/
public function getProfileOwner():int
2021-07-24 20:34:07 +00:00
{
return $this->profile_owner;
}
2021-07-24 20:42:09 +00:00
/**
* Set the contact ID
2021-07-24 22:08:33 +00:00
*
* @param int $contact_id
* @return void
2021-07-24 20:42:09 +00:00
*/
2021-07-24 20:34:07 +00:00
public function setContactId(int $contact_id)
{
$this->contact_id = $contact_id;
}
2021-07-24 20:42:09 +00:00
/**
* Get the contact ID
*
2021-07-24 22:08:33 +00:00
* @return int
2021-07-24 20:42:09 +00:00
*/
public function getContactId():int
2021-07-24 20:34:07 +00:00
{
return $this->contact_id;
}
2021-07-24 21:16:53 +00:00
/**
* Set the timezone
2021-07-24 22:08:33 +00:00
*
* @param int $timezone
* @return void
2021-07-24 21:16:53 +00:00
*/
public function setTimeZone(string $timezone)
{
$this->timezone = $timezone;
}
/**
* Get the timezone
*
2021-07-24 22:08:33 +00:00
* @return int
2021-07-24 21:16:53 +00:00
*/
public function getTimeZone():string
{
return $this->timezone;
}
2021-07-25 19:39:10 +00:00
/**
* Set workerqueue information
*
* @param array $queue
* @return void
*/
2021-07-24 22:08:33 +00:00
public function setQueue(array $queue)
{
$this->queue = $queue;
}
2021-07-25 19:39:10 +00:00
/**
* Fetch workerqueue information
*
* @return array
*/
2021-07-24 22:08:33 +00:00
public function getQueue()
{
return $this->queue ?? [];
}
2021-07-25 19:39:10 +00:00
/**
* Fetch a specific workerqueue field
*
* @param string $index
* @return mixed
*/
2021-07-24 22:08:33 +00:00
public function getQueueValue(string $index)
{
return $this->queue[$index] ?? null;
}
2021-07-25 19:39:10 +00:00
public function setThemeInfoValue(string $index, $value)
{
$this->theme_info[$index] = $value;
}
public function getThemeInfo()
{
return $this->theme_info;
}
public function getThemeInfoValue(string $index, $default = null)
{
return $this->theme_info[$index] ?? $default;
}
2019-02-03 21:22:04 +00:00
/**
* Returns the current config cache of this node
*
* @return Cache
2019-02-03 21:22:04 +00:00
*/
public function getConfigCache()
2019-02-03 21:22:04 +00:00
{
return $this->config->getCache();
2019-02-03 21:22:04 +00:00
}
/**
* The basepath of this app
*
* @return string
*/
public function getBasePath()
{
2019-05-13 17:30:03 +00:00
// 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');
2019-02-03 21:22:04 +00:00
}
/**
2019-08-17 09:08:57 +00:00
* @param Database $database The Friendica Database
* @param IConfig $config The Configuration
2019-08-17 09:08:57 +00:00
* @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
*/
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)
{
2019-08-17 09:08:57 +00:00
$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;
2019-08-15 14:18:08 +00:00
$this->load();
}
2019-08-15 14:18:08 +00:00
/**
* Load the whole app instance
*/
public function load()
{
set_time_limit(0);
// This has to be quite large to deal with embedded private photos
ini_set('pcre.backtrack_limit', 500000);
set_include_path(
get_include_path() . PATH_SEPARATOR
2019-03-23 14:20:51 +00:00
. $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
. $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
. $this->getBasePath());
2019-08-15 14:18:08 +00:00
$this->profiler->reset();
2019-08-15 14:18:08 +00:00
if ($this->mode->has(App\Mode::DBAVAILABLE)) {
$this->profiler->update($this->config);
Core\Hook::loadHooks();
$loader = new ConfigFileLoader($this->getBasePath());
Core\Hook::callAll('load_config', $loader);
}
$this->loadDefaultTimezone();
2019-08-15 14:18:08 +00:00
// Register template engines
Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
}
2018-06-28 03:05:38 +00:00
/**
* Loads the default timezone
*
* Include support for legacy $default_timezone
*
* @global string $default_timezone
*/
private function loadDefaultTimezone()
{
2019-02-03 21:22:04 +00:00
if ($this->config->get('system', 'default_timezone')) {
$this->timezone = $this->config->get('system', 'default_timezone');
} else {
global $default_timezone;
$this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
}
if ($this->timezone) {
date_default_timezone_set($this->timezone);
}
}
/**
* Returns the current theme name. May be overriden by the mobile theme name.
*
* @return string
* @throws Exception
*/
public function getCurrentTheme()
{
2019-08-15 14:18:08 +00:00
if ($this->mode->isInstall()) {
return '';
}
// Specific mobile theme override
if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
$user_mobile_theme = $this->getCurrentMobileTheme();
// --- means same mobile theme as desktop
if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
return $user_mobile_theme;
}
}
if (!$this->currentTheme) {
$this->computeCurrentTheme();
}
return $this->currentTheme;
}
/**
* Returns the current mobile theme name.
*
* @return string
* @throws Exception
*/
public function getCurrentMobileTheme()
{
if ($this->mode->isInstall()) {
return '';
}
if (is_null($this->currentMobileTheme)) {
$this->computeCurrentMobileTheme();
}
return $this->currentMobileTheme;
}
public function setCurrentTheme($theme)
{
$this->currentTheme = $theme;
}
public function setCurrentMobileTheme($theme)
{
$this->currentMobileTheme = $theme;
}
/**
* Computes the current theme name based on the node settings, the page owner settings and the user settings
*
* @throws Exception
*/
private function computeCurrentTheme()
{
2019-03-23 14:23:23 +00:00
$system_theme = $this->config->get('system', 'theme');
if (!$system_theme) {
throw new Exception($this->l10n->t('No system theme config value set.'));
}
// Sane default
$this->setCurrentTheme($system_theme);
$page_theme = null;
// Find the theme that belongs to the user whose stuff we are looking at
2021-07-24 10:09:39 +00:00
if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
// 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
2021-07-24 10:09:39 +00:00
$user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
$page_theme = $user['theme'];
}
}
$theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
$theme_name = Strings::sanitizeFilePathItem($theme_name);
if ($theme_name
2019-08-15 14:18:08 +00:00
&& in_array($theme_name, Theme::getAllowedList())
&& (file_exists('view/theme/' . $theme_name . '/style.css')
|| file_exists('view/theme/' . $theme_name . '/style.php'))
) {
$this->setCurrentTheme($theme_name);
}
}
/**
* Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
*/
private function computeCurrentMobileTheme()
{
$system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
// Sane default
$this->setCurrentMobileTheme($system_mobile_theme);
$page_mobile_theme = null;
// Find the theme that belongs to the user whose stuff we are looking at
2021-07-24 10:09:39 +00:00
if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
// 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')) {
2021-07-24 10:09:39 +00:00
$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 = Strings::sanitizeFilePathItem($mobile_theme_name);
if ($mobile_theme_name == '---'
||
in_array($mobile_theme_name, Theme::getAllowedList())
&& (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
|| file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
) {
$this->setCurrentMobileTheme($mobile_theme_name);
}
}
/**
* Provide a sane default if nothing is chosen or the specified theme does not exist.
*
* @return string
* @throws Exception
*/
public function getCurrentThemeStylesheetPath()
{
return Core\Theme::getStylesheetPath($this->getCurrentTheme());
}
/**
* Sets the base url for use in cmdline programs which don't have
* $_SERVER variables
*/
public function checkURL()
{
2019-03-23 14:23:23 +00:00
$url = $this->config->get('system', 'url');
// if the url isn't set or the stored url is radically different
// than the currently visited url, store the current value accordingly.
// "Radically different" ignores common variations such as http vs https
// and www.example.com vs example.com.
// We will only change the url to an ip address if there is no existing setting
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()))) {
$this->config->set('system', 'url', $this->baseURL->get());
}
}
/**
* Frontend App script
*
* The App object behaves like a container and a dispatcher at the same time, including a representation of the
* request and a representation of the response.
*
* This probably should change to limit the size of this monster method.
2019-08-12 16:13:58 +00:00
*
* @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
*
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
2020-12-10 00:02:23 +00:00
public function runFrontend(App\Module $module, App\Router $router, IPConfig $pconfig, Authentication $auth, App\Page $page, float $start_time)
{
2020-12-10 00:02:23 +00:00
$this->profiler->set($start_time, 'start');
2020-12-09 22:10:27 +00:00
$this->profiler->set(microtime(true), 'classinit');
2019-08-12 16:13:58 +00:00
$moduleName = $module->getName();
try {
// Missing DB connection: ERROR
2019-08-15 14:18:08 +00:00
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');
2019-08-12 16:13:58 +00:00
header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
}
2019-08-15 14:18:08 +00:00
if (!$this->mode->isInstall()) {
// Force SSL redirection
if ($this->baseURL->checkRedirectHttps()) {
2019-08-12 16:13:58 +00:00
System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
}
Core\Hook::callAll('init_1');
}
if ($this->mode->isNormal() && !$this->mode->isBackend()) {
$requester = HTTPSignature::getSigner('', $_SERVER);
if (!empty($requester)) {
Profile::addVisitorCookieForHandle($requester);
}
}
// 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) == "") &&
2019-08-15 14:18:08 +00:00
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'];
}
}
Model\Profile::zrlInit($this);
} else {
// Someone came with an invalid parameter, maybe as a DDoS attempt
// We simply stop processing here
2019-08-15 14:18:08 +00:00
$this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
throw new HTTPException\ForbiddenException();
}
}
}
2019-08-15 14:18:08 +00:00
if (!empty($_GET['owt']) && $this->mode->isNormal()) {
$token = $_GET['owt'];
Model\Profile::openWebAuthInit($token);
}
$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
* any addons have been added or removed and reacts accordingly.
*/
// in install mode, any url loads install module
// but we need "view" module for stylesheet
2019-08-15 14:18:08 +00:00
if ($this->mode->isInstall() && $moduleName !== 'install') {
$this->baseURL->redirect('install');
} else {
$this->checkURL();
2019-08-15 14:18:08 +00:00
Core\Update::check($this->getBasePath(), false, $this->mode);
Core\Addon::loadAddons();
Core\Hook::loadHooks();
}
// Compatibility with the Android Diaspora client
2019-08-12 16:13:58 +00:00
if ($moduleName == 'stream') {
$this->baseURL->redirect('network?order=post');
}
2019-08-12 16:13:58 +00:00
if ($moduleName == 'conversations') {
$this->baseURL->redirect('message');
}
2019-08-12 16:13:58 +00:00
if ($moduleName == 'commented') {
$this->baseURL->redirect('network?order=comment');
}
2019-08-12 16:13:58 +00:00
if ($moduleName == 'liked') {
$this->baseURL->redirect('network?order=comment');
}
2019-08-12 16:13:58 +00:00
if ($moduleName == 'activity') {
$this->baseURL->redirect('network?conv=1');
}
2019-08-12 16:13:58 +00:00
if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
$this->baseURL->redirect('bookmarklet');
}
2019-08-12 16:13:58 +00:00
if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
$this->baseURL->redirect('settings');
}
2019-08-12 16:13:58 +00:00
if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
$this->baseURL->redirect('search');
}
2021-07-25 05:08:29 +00:00
// Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
$page['page_title'] = $moduleName;
2019-08-15 18:58:57 +00:00
if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
$module = new Module('maintenance', 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);
}
2019-08-12 16:13:58 +00:00
// Let the module run it's internal process (init, get, post, ...)
2020-12-09 22:10:27 +00:00
$module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
2019-08-15 14:18:08 +00:00
} catch (HTTPException $e) {
2019-08-12 16:13:58 +00:00
ModuleHTTPException::rawContent($e);
}
2020-12-09 22:10:27 +00:00
$page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
}
/**
2018-10-24 18:52:38 +00:00
* Automatically redirects to relative or absolute URL
* Should only be used if it isn't clear if the URL is either internal or external
*
* @param string $toUrl The target URL
2019-08-15 14:18:08 +00:00
*
* @throws HTTPException\InternalServerErrorException
*/
public function redirect($toUrl)
{
2018-11-30 11:27:17 +00:00
if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
Core\System::externalRedirect($toUrl);
} else {
$this->baseURL->redirect($toUrl);
}
}
}