X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FApp%2FMode.php;h=3e7b9f0d1679a0fa07a362c8393c785d0d1452e9;hb=1ccf22a496f7c05c2ab9b6288d0754215b3d65de;hp=6cb79b6edd4532ac25d4ffeb9791162b82b4ee33;hpb=fcb1a78352fe4db9c895e1b29164574030afe13c;p=friendica.git diff --git a/src/App/Mode.php b/src/App/Mode.php index 6cb79b6edd..3e7b9f0d16 100644 --- a/src/App/Mode.php +++ b/src/App/Mode.php @@ -1,8 +1,28 @@ . + * + */ namespace Friendica\App; -use Friendica\Core\Config\Cache\ConfigCache; +use Detection\MobileDetect; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\Database\Database; use Friendica\Util\BasePath; @@ -18,33 +38,85 @@ class Mode const DBCONFIGAVAILABLE = 4; const MAINTENANCEDISABLED = 8; + const UNDEFINED = 0; + const INDEX = 1; + const DAEMON = 2; + const WORKER = 3; + + const BACKEND_CONTENT_TYPES = ['application/jrd+json', 'text/xml', + 'application/rss+xml', 'application/atom+xml', 'application/activity+json']; + + /** + * A list of modules, which are backend methods + * + * @var array + */ + const BACKEND_MODULES = [ + '_well_known', + 'api', + 'dfrn_notify', + 'feed', + 'fetch', + 'followers', + 'following', + 'hcard', + 'hostxrd', + 'inbox', + 'manifest', + 'nodeinfo', + 'noscrape', + 'objects', + 'outbox', + 'poco', + 'post', + 'pubsub', + 'pubsubhubbub', + 'receive', + 'rsd_xml', + 'salmon', + 'statistics_json', + 'xrd', + ]; + /*** - * @var int the mode of this Application + * @var int The mode of this Application * */ private $mode; + /*** + * @var int Who executes this Application + * + */ + private $executor = self::UNDEFINED; + /** - * @var string the basepath of the application + * @var bool True, if the call is a backend call */ - private $basepath; + private $isBackend; /** - * @var Database + * @var bool True, if the call is a ajax call */ - private $database; + private $isAjax; /** - * @var ConfigCache + * @var bool True, if the call is from a mobile device */ - private $configCache; + private $isMobile; - public function __construct(BasePath $basepath, Database $database, ConfigCache $configCache) + /** + * @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) { - $this->basepath = $basepath->getPath(); - $this->database = $database; - $this->configCache = $configCache; - $this->mode = 0; + $this->mode = $mode; + $this->isBackend = $isBackend; + $this->isAjax = $isAjax; + $this->isMobile = $isMobile; + $this->isTablet = $isTablet; } /** @@ -54,50 +126,72 @@ class Mode * - App::MODE_MAINTENANCE: The maintenance mode has been set * - App::MODE_NORMAL : Normal run with all features enabled * - * @param string $basePath the Basepath of the Application - * - * @return Mode returns itself + * @return Mode returns the determined mode * * @throws \Exception */ - public function determine($basePath = null) + public function determine(BasePath $basepath, Database $database, Cache $configCache) { - if (!empty($basePath)) { - $this->basepath = $basePath; - } + $mode = 0; - $this->mode = 0; + $basepathName = $basepath->getPath(); - if (!file_exists($this->basepath . '/config/local.config.php') - && !file_exists($this->basepath . '/config/local.ini.php') - && !file_exists($this->basepath . '/.htconfig.php')) { - return $this; + if (!file_exists($basepathName . '/config/local.config.php') + && !file_exists($basepathName . '/config/local.ini.php') + && !file_exists($basepathName . '/.htconfig.php')) { + return new Mode($mode); } - $this->mode |= Mode::LOCALCONFIGPRESENT; + $mode |= Mode::LOCALCONFIGPRESENT; - if (!$this->database->connected()) { - return $this; + if (!$database->connected()) { + return new Mode($mode); } - $this->mode |= Mode::DBAVAILABLE; + $mode |= Mode::DBAVAILABLE; - if ($this->database->fetchFirst("SHOW TABLES LIKE 'config'") === false) { - return $this; + if ($database->fetchFirst("SHOW TABLES LIKE 'config'") === false) { + return new Mode($mode); } - $this->mode |= Mode::DBCONFIGAVAILABLE; + $mode |= Mode::DBCONFIGAVAILABLE; - if (!empty($this->configCache->get('system', 'maintenance')) || + if (!empty($configCache->get('system', 'maintenance')) || // Don't use Config or Configuration here because we're possibly BEFORE initializing the Configuration, // so this could lead to a dependency circle - !empty($this->database->selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'maintenance'])['v'])) { - return $this; + !empty($database->selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'maintenance'])['v'])) { + return new Mode($mode); } - $this->mode |= Mode::MAINTENANCEDISABLED; + $mode |= Mode::MAINTENANCEDISABLED; - return $this; + return new Mode($mode, $this->isBackend, $this->isAjax, $this->isMobile, $this->isTablet); + } + + /** + * Checks if the site is called via a backend process + * + * @param bool $isBackend True, if the call is from a backend script (daemon, worker, ...) + * @param array $server The $_SERVER variable + * @param Arguments $args The Friendica App arguments + * @param MobileDetect $mobileDetect The mobile detection library + * + * @return Mode returns the determined mode + */ + public function determineRunMode(bool $isBackend, array $server, Arguments $args, MobileDetect $mobileDetect) + { + foreach (self::BACKEND_CONTENT_TYPES as $type) { + if (strpos(strtolower($server['HTTP_ACCEPT'] ?? ''), $type) !== false) { + $isBackend = true; + } + } + + $isBackend = $isBackend || in_array($args->getModuleName(), static::BACKEND_MODULES); + $isMobile = $mobileDetect->isMobile(); + $isTablet = $mobileDetect->isTablet(); + $isAjax = strtolower($server['HTTP_X_REQUESTED_WITH'] ?? '') == 'xmlhttprequest'; + + return new Mode($this->mode, $isBackend, $isAjax, $isMobile, $isTablet); } /** @@ -112,6 +206,31 @@ class Mode return ($this->mode & $mode) > 0; } + /** + * 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. @@ -136,4 +255,44 @@ class Mode $this->has(Mode::DBCONFIGAVAILABLE) && $this->has(Mode::MAINTENANCEDISABLED); } + + /** + * 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; + } }