3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\App;
24 use Detection\MobileDetect;
25 use Friendica\Core\Config\ValueObject\Cache;
26 use Friendica\Database\Database;
27 use Friendica\Util\BasePath;
30 * Mode of the current Friendica Node
32 * @package Friendica\App
36 const LOCALCONFIGPRESENT = 1;
37 const DBAVAILABLE = 2;
38 const DBCONFIGAVAILABLE = 4;
39 const MAINTENANCEDISABLED = 8;
46 const BACKEND_CONTENT_TYPES = ['application/jrd+json', 'text/xml',
47 'application/rss+xml', 'application/atom+xml', 'application/activity+json'];
50 * A list of modules, which are backend methods
54 const BACKEND_MODULES = [
82 * @var int The mode of this Application
88 * @var int Who executes this Application
91 private $executor = self::UNDEFINED;
94 * @var bool True, if the call is a backend call
99 * @var bool True, if the call is a ajax call
104 * @var bool True, if the call is from a mobile device
109 * @var bool True, if the call is from a tablet device
113 public function __construct(int $mode = 0, bool $isBackend = false, bool $isAjax = false, bool $isMobile = false, bool $isTablet = false)
116 $this->isBackend = $isBackend;
117 $this->isAjax = $isAjax;
118 $this->isMobile = $isMobile;
119 $this->isTablet = $isTablet;
125 * - App::MODE_INSTALL : Either the database connection can't be established or the config table doesn't exist
126 * - App::MODE_MAINTENANCE: The maintenance mode has been set
127 * - App::MODE_NORMAL : Normal run with all features enabled
129 * @return Mode returns the determined mode
133 public function determine(BasePath $basepath, Database $database, Cache $configCache): Mode
137 $basepathName = $basepath->getPath();
139 if (!file_exists($basepathName . '/config/local.config.php')
140 && !file_exists($basepathName . '/config/local.ini.php')
141 && !file_exists($basepathName . '/.htconfig.php')) {
142 return new Mode($mode);
145 $mode |= Mode::LOCALCONFIGPRESENT;
147 if (!$database->connected()) {
148 return new Mode($mode);
151 $mode |= Mode::DBAVAILABLE;
153 if ($database->fetchFirst("SHOW TABLES LIKE 'config'") === false) {
154 return new Mode($mode);
157 $mode |= Mode::DBCONFIGAVAILABLE;
159 if (!empty($configCache->get('system', 'maintenance')) ||
160 // Don't use Config or Configuration here because we're possibly BEFORE initializing the Configuration,
161 // so this could lead to a dependency circle
162 !empty($database->selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'maintenance'])['v'])) {
163 return new Mode($mode);
166 $mode |= Mode::MAINTENANCEDISABLED;
168 return new Mode($mode, $this->isBackend, $this->isAjax, $this->isMobile, $this->isTablet);
172 * Checks if the site is called via a backend process
174 * @param bool $isBackend True, if the call is from a backend script (daemon, worker, ...)
175 * @param array $server The $_SERVER variable
176 * @param Arguments $args The Friendica App arguments
177 * @param MobileDetect $mobileDetect The mobile detection library
179 * @return Mode returns the determined mode
181 public function determineRunMode(bool $isBackend, array $server, Arguments $args, MobileDetect $mobileDetect): Mode
183 foreach (self::BACKEND_CONTENT_TYPES as $type) {
184 if (strpos(strtolower($server['HTTP_ACCEPT'] ?? ''), $type) !== false) {
189 $isBackend = $isBackend || in_array($args->getModuleName(), static::BACKEND_MODULES);
190 $isMobile = $mobileDetect->isMobile();
191 $isTablet = $mobileDetect->isTablet();
192 $isAjax = strtolower($server['HTTP_X_REQUESTED_WITH'] ?? '') == 'xmlhttprequest';
194 return new Mode($this->mode, $isBackend, $isAjax, $isMobile, $isTablet);
198 * Checks, if the Friendica Node has the given mode
200 * @param int $mode A mode to test
202 * @return bool returns true, if the mode is set
204 public function has(int $mode): bool
206 return ($this->mode & $mode) > 0;
210 * Set the execution mode
212 * @param integer $executor Execution Mode
215 public function setExecutor(int $executor)
217 $this->executor = $executor;
219 // Daemon and worker are always backend
220 if (in_array($executor, [self::DAEMON, self::WORKER])) {
221 $this->isBackend = true;
226 * get the execution mode
228 * @return int Execution Mode
230 public function getExecutor(): int
232 return $this->executor;
236 * Install mode is when the local config file is missing or the DB schema hasn't been installed yet.
238 * @return bool Whether installation mode is active (local/database configuration files present or not)
240 public function isInstall(): bool
242 return !$this->has(Mode::LOCALCONFIGPRESENT) ||
243 !$this->has(MODE::DBCONFIGAVAILABLE);
247 * Normal mode is when the local config file is set, the DB schema is installed and the maintenance mode is off.
251 public function isNormal(): bool
253 return $this->has(Mode::LOCALCONFIGPRESENT) &&
254 $this->has(Mode::DBAVAILABLE) &&
255 $this->has(Mode::DBCONFIGAVAILABLE) &&
256 $this->has(Mode::MAINTENANCEDISABLED);
260 * Returns true, if the call is from a backend node (f.e. from a worker)
262 * @return bool Is it a backend call
264 public function isBackend(): bool
266 return $this->isBackend;
270 * Check if request was an AJAX (xmlhttprequest) request.
272 * @return bool true if it was an AJAX request
274 public function isAjax(): bool
276 return $this->isAjax;
280 * Check if request was a mobile request.
282 * @return bool true if it was an mobile request
284 public function isMobile(): bool
286 return $this->isMobile;
290 * Check if request was a tablet request.
292 * @return bool true if it was an tablet request
294 public function isTablet(): bool
296 return $this->isTablet;