friendica/src/App/Mode.php

267 lines
6.6 KiB
PHP
Raw Normal View History

<?php
2020-02-08 17:16:42 +01:00
/**
2021-03-29 08:40:20 +02:00
* @copyright Copyright (C) 2010-2021, the Friendica project
2020-02-08 17:16:42 +01:00
*
* @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\App;
use Detection\MobileDetect;
2021-10-26 21:44:29 +02:00
use Friendica\Core\Config\ValueObject\Cache;
use Friendica\Database\Database;
use Friendica\Util\BasePath;
/**
* Mode of the current Friendica Node
*
* @package Friendica\App
*/
class Mode
{
2019-07-21 14:40:50 +02:00
const LOCALCONFIGPRESENT = 1;
const DBAVAILABLE = 2;
const DBCONFIGAVAILABLE = 4;
const MAINTENANCEDISABLED = 8;
2021-01-01 20:35:29 +01:00
const UNDEFINED = 0;
const INDEX = 1;
const DAEMON = 2;
const WORKER = 3;
const BACKEND_CONTENT_TYPES = ['application/jrd+json', 'text/xml',
2020-10-02 12:55:42 +02:00
'application/rss+xml', 'application/atom+xml', 'application/activity+json'];
/***
2019-08-15 15:51:15 +02:00
* @var int The mode of this Application
*
*/
private $mode;
2021-01-01 20:35:29 +01:00
/***
* @var int Who executes this Application
*
*/
private $executor = self::UNDEFINED;
2019-08-15 15:51:15 +02:00
/**
* @var bool True, if the call is a backend call
*/
private $isBackend;
/**
* @var bool True, if the call is a ajax call
*/
private $isAjax;
/**
* @var bool True, if the call is from a mobile device
*/
private $isMobile;
/**
* @var bool True, if the call is from a tablet device
*/
private $isTablet;
public function __construct(int $mode = 0, bool $isBackend = false, bool $isAjax = false, bool $isMobile = false, bool $isTablet = false)
{
2019-08-15 15:51:15 +02:00
$this->mode = $mode;
$this->isBackend = $isBackend;
$this->isAjax = $isAjax;
$this->isMobile = $isMobile;
$this->isTablet = $isTablet;
}
/**
* Sets the App mode
*
* - App::MODE_INSTALL : Either the database connection can't be established or the config table doesn't exist
* - App::MODE_MAINTENANCE: The maintenance mode has been set
* - App::MODE_NORMAL : Normal run with all features enabled
*
2019-08-12 18:13:58 +02:00
* @return Mode returns the determined mode
*
2019-07-21 14:40:50 +02:00
* @throws \Exception
*/
public function determine(BasePath $basepath, Database $database, Cache $configCache)
{
2019-08-12 18:13:58 +02:00
$mode = 0;
2019-08-12 18:13:58 +02:00
$basepathName = $basepath->getPath();
2019-08-12 18:13:58 +02:00
if (!file_exists($basepathName . '/config/local.config.php')
&& !file_exists($basepathName . '/config/local.ini.php')
&& !file_exists($basepathName . '/.htconfig.php')) {
return new Mode($mode);
}
2019-08-12 18:13:58 +02:00
$mode |= Mode::LOCALCONFIGPRESENT;
2019-08-12 18:13:58 +02:00
if (!$database->connected()) {
return new Mode($mode);
}
2019-08-12 18:13:58 +02:00
$mode |= Mode::DBAVAILABLE;
2019-08-12 18:13:58 +02:00
if ($database->fetchFirst("SHOW TABLES LIKE 'config'") === false) {
return new Mode($mode);
}
2019-08-12 18:13:58 +02:00
$mode |= Mode::DBCONFIGAVAILABLE;
2019-08-12 18:13:58 +02:00
if (!empty($configCache->get('system', 'maintenance')) ||
2019-07-21 14:40:50 +02:00
// Don't use Config or Configuration here because we're possibly BEFORE initializing the Configuration,
// so this could lead to a dependency circle
2019-08-12 18:13:58 +02:00
!empty($database->selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'maintenance'])['v'])) {
return new Mode($mode);
}
2019-08-12 18:13:58 +02:00
$mode |= Mode::MAINTENANCEDISABLED;
return new Mode($mode, $this->isBackend, $this->isAjax, $this->isMobile, $this->isTablet);
2019-08-15 15:51:15 +02:00
}
/**
* Checks if the site is called via a backend process
*
2019-09-17 16:47:00 +02:00
* @param bool $isBackend True, if the call is from a backend script (daemon, worker, ...)
* @param Module $module The pre-loaded module (just name, not class!)
* @param array $server The $_SERVER variable
* @param MobileDetect $mobileDetect The mobile detection library
2019-08-15 15:51:15 +02:00
*
* @return Mode returns the determined mode
*/
2019-09-17 16:47:00 +02:00
public function determineRunMode(bool $isBackend, Module $module, array $server, MobileDetect $mobileDetect)
2019-08-15 15:51:15 +02:00
{
2020-10-02 12:55:42 +02:00
foreach (self::BACKEND_CONTENT_TYPES as $type) {
if (strpos(strtolower($server['HTTP_ACCEPT'] ?? ''), $type) !== false) {
$isBackend = true;
}
}
$isBackend = $isBackend || $module->isBackend();
$isMobile = $mobileDetect->isMobile();
$isTablet = $mobileDetect->isTablet();
$isAjax = strtolower($server['HTTP_X_REQUESTED_WITH'] ?? '') == 'xmlhttprequest';
2019-08-15 15:51:15 +02:00
return new Mode($this->mode, $isBackend, $isAjax, $isMobile, $isTablet);
}
/**
* Checks, if the Friendica Node has the given mode
*
* @param int $mode A mode to test
*
* @return bool returns true, if the mode is set
*/
public function has($mode)
{
return ($this->mode & $mode) > 0;
}
2021-01-01 20:35:29 +01:00
/**
* Set the execution mode
*
* @param integer $executor Execution Mode
* @return void
*/
public function setExecutor(int $executor)
{
$this->executor = $executor;
// Daemon and worker are always backend
if (in_array($executor, [self::DAEMON, self::WORKER])) {
$this->isBackend = true;
}
}
/*isBackend = true;*
* get the execution mode
*
* @return int Execution Mode
*/
public function getExecutor()
{
return $this->executor;
}
/**
* Install mode is when the local config file is missing or the DB schema hasn't been installed yet.
*
* @return bool
*/
public function isInstall()
{
return !$this->has(Mode::LOCALCONFIGPRESENT) ||
!$this->has(MODE::DBCONFIGAVAILABLE);
}
/**
* Normal mode is when the local config file is set, the DB schema is installed and the maintenance mode is off.
*
* @return bool
*/
public function isNormal()
{
return $this->has(Mode::LOCALCONFIGPRESENT) &&
$this->has(Mode::DBAVAILABLE) &&
$this->has(Mode::DBCONFIGAVAILABLE) &&
$this->has(Mode::MAINTENANCEDISABLED);
}
2019-08-15 15:51:15 +02:00
/**
* Returns true, if the call is from a backend node (f.e. from a worker)
*
* @return bool Is it a backend call
*/
public function isBackend()
{
return $this->isBackend;
}
/**
* Check if request was an AJAX (xmlhttprequest) request.
*
* @return bool true if it was an AJAX request
*/
public function isAjax()
{
return $this->isAjax;
}
/**
* Check if request was a mobile request.
*
* @return bool true if it was an mobile request
*/
public function isMobile()
{
return $this->isMobile;
}
/**
* Check if request was a tablet request.
*
* @return bool true if it was an tablet request
*/
public function isTablet()
{
return $this->isTablet;
}
2019-07-21 14:40:50 +02:00
}