3 * @copyright Copyright (C) 2010-2021, 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;
28 use phpDocumentor\Reflection\Types\Static_;
31 * Mode of the current Friendica Node
33 * @package Friendica\App
37 const LOCALCONFIGPRESENT = 1;
38 const DBAVAILABLE = 2;
39 const DBCONFIGAVAILABLE = 4;
40 const MAINTENANCEDISABLED = 8;
47 const BACKEND_CONTENT_TYPES = ['application/jrd+json', 'text/xml',
48 'application/rss+xml', 'application/atom+xml', 'application/activity+json'];
51 * A list of modules, which are backend methods
55 const BACKEND_MODULES = [
83 * @var int The mode of this Application
89 * @var int Who executes this Application
92 private $executor = self::UNDEFINED;
95 * @var bool True, if the call is a backend call
100 * @var bool True, if the call is a ajax call
105 * @var bool True, if the call is from a mobile device
110 * @var bool True, if the call is from a tablet device
114 public function __construct(int $mode = 0, bool $isBackend = false, bool $isAjax = false, bool $isMobile = false, bool $isTablet = false)
117 $this->isBackend = $isBackend;
118 $this->isAjax = $isAjax;
119 $this->isMobile = $isMobile;
120 $this->isTablet = $isTablet;
126 * - App::MODE_INSTALL : Either the database connection can't be established or the config table doesn't exist
127 * - App::MODE_MAINTENANCE: The maintenance mode has been set
128 * - App::MODE_NORMAL : Normal run with all features enabled
130 * @return Mode returns the determined mode
134 public function determine(BasePath $basepath, Database $database, Cache $configCache)
138 $basepathName = $basepath->getPath();
140 if (!file_exists($basepathName . '/config/local.config.php')
141 && !file_exists($basepathName . '/config/local.ini.php')
142 && !file_exists($basepathName . '/.htconfig.php')) {
143 return new Mode($mode);
146 $mode |= Mode::LOCALCONFIGPRESENT;
148 if (!$database->connected()) {
149 return new Mode($mode);
152 $mode |= Mode::DBAVAILABLE;
154 if ($database->fetchFirst("SHOW TABLES LIKE 'config'") === false) {
155 return new Mode($mode);
158 $mode |= Mode::DBCONFIGAVAILABLE;
160 if (!empty($configCache->get('system', 'maintenance')) ||
161 // Don't use Config or Configuration here because we're possibly BEFORE initializing the Configuration,
162 // so this could lead to a dependency circle
163 !empty($database->selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'maintenance'])['v'])) {
164 return new Mode($mode);
167 $mode |= Mode::MAINTENANCEDISABLED;
169 return new Mode($mode, $this->isBackend, $this->isAjax, $this->isMobile, $this->isTablet);
173 * Checks if the site is called via a backend process
175 * @param bool $isBackend True, if the call is from a backend script (daemon, worker, ...)
176 * @param array $server The $_SERVER variable
177 * @param Arguments $args The Friendica App arguments
178 * @param MobileDetect $mobileDetect The mobile detection library
180 * @return Mode returns the determined mode
182 public function determineRunMode(bool $isBackend, array $server, Arguments $args, MobileDetect $mobileDetect)
184 foreach (self::BACKEND_CONTENT_TYPES as $type) {
185 if (strpos(strtolower($server['HTTP_ACCEPT'] ?? ''), $type) !== false) {
190 $isBackend = $isBackend || in_array($args->getModuleName(), static::BACKEND_MODULES);
191 $isMobile = $mobileDetect->isMobile();
192 $isTablet = $mobileDetect->isTablet();
193 $isAjax = strtolower($server['HTTP_X_REQUESTED_WITH'] ?? '') == 'xmlhttprequest';
195 return new Mode($this->mode, $isBackend, $isAjax, $isMobile, $isTablet);
199 * Checks, if the Friendica Node has the given mode
201 * @param int $mode A mode to test
203 * @return bool returns true, if the mode is set
205 public function has($mode)
207 return ($this->mode & $mode) > 0;
211 * Set the execution mode
213 * @param integer $executor Execution Mode
216 public function setExecutor(int $executor)
218 $this->executor = $executor;
220 // Daemon and worker are always backend
221 if (in_array($executor, [self::DAEMON, self::WORKER])) {
222 $this->isBackend = true;
227 * get the execution mode
229 * @return int Execution Mode
231 public function getExecutor()
233 return $this->executor;
237 * Install mode is when the local config file is missing or the DB schema hasn't been installed yet.
241 public function isInstall()
243 return !$this->has(Mode::LOCALCONFIGPRESENT) ||
244 !$this->has(MODE::DBCONFIGAVAILABLE);
248 * Normal mode is when the local config file is set, the DB schema is installed and the maintenance mode is off.
252 public function isNormal()
254 return $this->has(Mode::LOCALCONFIGPRESENT) &&
255 $this->has(Mode::DBAVAILABLE) &&
256 $this->has(Mode::DBCONFIGAVAILABLE) &&
257 $this->has(Mode::MAINTENANCEDISABLED);
261 * Returns true, if the call is from a backend node (f.e. from a worker)
263 * @return bool Is it a backend call
265 public function isBackend()
267 return $this->isBackend;
271 * Check if request was an AJAX (xmlhttprequest) request.
273 * @return bool true if it was an AJAX request
275 public function isAjax()
277 return $this->isAjax;
281 * Check if request was a mobile request.
283 * @return bool true if it was an mobile request
285 public function isMobile()
287 return $this->isMobile;
291 * Check if request was a tablet request.
293 * @return bool true if it was an tablet request
295 public function isTablet()
297 return $this->isTablet;