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\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 * @var int The mode of this Application
56 * @var int Who executes this Application
59 private $executor = self::UNDEFINED;
62 * @var bool True, if the call is a backend call
67 * @var bool True, if the call is a ajax call
72 * @var bool True, if the call is from a mobile device
77 * @var bool True, if the call is from a tablet device
81 public function __construct(int $mode = 0, bool $isBackend = false, bool $isAjax = false, bool $isMobile = false, bool $isTablet = false)
84 $this->isBackend = $isBackend;
85 $this->isAjax = $isAjax;
86 $this->isMobile = $isMobile;
87 $this->isTablet = $isTablet;
93 * - App::MODE_INSTALL : Either the database connection can't be established or the config table doesn't exist
94 * - App::MODE_MAINTENANCE: The maintenance mode has been set
95 * - App::MODE_NORMAL : Normal run with all features enabled
97 * @return Mode returns the determined mode
101 public function determine(BasePath $basepath, Database $database, Cache $configCache)
105 $basepathName = $basepath->getPath();
107 if (!file_exists($basepathName . '/config/local.config.php')
108 && !file_exists($basepathName . '/config/local.ini.php')
109 && !file_exists($basepathName . '/.htconfig.php')) {
110 return new Mode($mode);
113 $mode |= Mode::LOCALCONFIGPRESENT;
115 if (!$database->connected()) {
116 return new Mode($mode);
119 $mode |= Mode::DBAVAILABLE;
121 if ($database->fetchFirst("SHOW TABLES LIKE 'config'") === false) {
122 return new Mode($mode);
125 $mode |= Mode::DBCONFIGAVAILABLE;
127 if (!empty($configCache->get('system', 'maintenance')) ||
128 // Don't use Config or Configuration here because we're possibly BEFORE initializing the Configuration,
129 // so this could lead to a dependency circle
130 !empty($database->selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'maintenance'])['v'])) {
131 return new Mode($mode);
134 $mode |= Mode::MAINTENANCEDISABLED;
136 return new Mode($mode, $this->isBackend, $this->isAjax, $this->isMobile, $this->isTablet);
140 * Checks if the site is called via a backend process
142 * @param bool $isBackend True, if the call is from a backend script (daemon, worker, ...)
143 * @param Module $module The pre-loaded module (just name, not class!)
144 * @param array $server The $_SERVER variable
145 * @param MobileDetect $mobileDetect The mobile detection library
147 * @return Mode returns the determined mode
149 public function determineRunMode(bool $isBackend, Module $module, array $server, MobileDetect $mobileDetect)
151 foreach (self::BACKEND_CONTENT_TYPES as $type) {
152 if (strpos(strtolower($server['HTTP_ACCEPT'] ?? ''), $type) !== false) {
157 $isBackend = $isBackend || $module->isBackend();
158 $isMobile = $mobileDetect->isMobile();
159 $isTablet = $mobileDetect->isTablet();
160 $isAjax = strtolower($server['HTTP_X_REQUESTED_WITH'] ?? '') == 'xmlhttprequest';
162 return new Mode($this->mode, $isBackend, $isAjax, $isMobile, $isTablet);
166 * Checks, if the Friendica Node has the given mode
168 * @param int $mode A mode to test
170 * @return bool returns true, if the mode is set
172 public function has($mode)
174 return ($this->mode & $mode) > 0;
178 * Set the execution mode
180 * @param integer $executor Execution Mode
183 public function setExecutor(int $executor)
185 $this->executor = $executor;
187 // Daemon and worker are always backend
188 if (in_array($executor, [self::DAEMON, self::WORKER])) {
189 $this->isBackend = true;
194 * get the execution mode
196 * @return int Execution Mode
198 public function getExecutor()
200 return $this->executor;
204 * Install mode is when the local config file is missing or the DB schema hasn't been installed yet.
208 public function isInstall()
210 return !$this->has(Mode::LOCALCONFIGPRESENT) ||
211 !$this->has(MODE::DBCONFIGAVAILABLE);
215 * Normal mode is when the local config file is set, the DB schema is installed and the maintenance mode is off.
219 public function isNormal()
221 return $this->has(Mode::LOCALCONFIGPRESENT) &&
222 $this->has(Mode::DBAVAILABLE) &&
223 $this->has(Mode::DBCONFIGAVAILABLE) &&
224 $this->has(Mode::MAINTENANCEDISABLED);
228 * Returns true, if the call is from a backend node (f.e. from a worker)
230 * @return bool Is it a backend call
232 public function isBackend()
234 return $this->isBackend;
238 * Check if request was an AJAX (xmlhttprequest) request.
240 * @return bool true if it was an AJAX request
242 public function isAjax()
244 return $this->isAjax;
248 * Check if request was a mobile request.
250 * @return bool true if it was an mobile request
252 public function isMobile()
254 return $this->isMobile;
258 * Check if request was a tablet request.
260 * @return bool true if it was an tablet request
262 public function isTablet()
264 return $this->isTablet;