<?php
+/**
+ * @copyright Copyright (C) 2010-2022, 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\App;
-use Friendica\Core\Config\Cache\ConfigCache;
+use Detection\MobileDetect;
+use Friendica\Core\Config\ValueObject\Cache;
use Friendica\Database\Database;
use Friendica\Util\BasePath;
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;
}
/**
* - 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);
}
/**
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.
$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;
+ }
}
projects / friendica.git / blobdiff