3 * @copyright Copyright (C) 2020, Friendica
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;
41 const BACKEND_CONTENT_TYPES = ['application/jrd+json', 'text/xml',
42 'application/rss+xml', 'application/atom+xml', 'application/activity+json'];
45 * @var int The mode of this Application
51 * @var bool True, if the call is a backend call
56 * @var bool True, if the call is a ajax call
61 * @var bool True, if the call is from a mobile device
66 * @var bool True, if the call is from a tablet device
70 public function __construct(int $mode = 0, bool $isBackend = false, bool $isAjax = false, bool $isMobile = false, bool $isTablet = false)
73 $this->isBackend = $isBackend;
74 $this->isAjax = $isAjax;
75 $this->isMobile = $isMobile;
76 $this->isTablet = $isTablet;
82 * - App::MODE_INSTALL : Either the database connection can't be established or the config table doesn't exist
83 * - App::MODE_MAINTENANCE: The maintenance mode has been set
84 * - App::MODE_NORMAL : Normal run with all features enabled
86 * @return Mode returns the determined mode
90 public function determine(BasePath $basepath, Database $database, Cache $configCache)
94 $basepathName = $basepath->getPath();
96 if (!file_exists($basepathName . '/config/local.config.php')
97 && !file_exists($basepathName . '/config/local.ini.php')
98 && !file_exists($basepathName . '/.htconfig.php')) {
99 return new Mode($mode);
102 $mode |= Mode::LOCALCONFIGPRESENT;
104 if (!$database->connected()) {
105 return new Mode($mode);
108 $mode |= Mode::DBAVAILABLE;
110 if ($database->fetchFirst("SHOW TABLES LIKE 'config'") === false) {
111 return new Mode($mode);
114 $mode |= Mode::DBCONFIGAVAILABLE;
116 if (!empty($configCache->get('system', 'maintenance')) ||
117 // Don't use Config or Configuration here because we're possibly BEFORE initializing the Configuration,
118 // so this could lead to a dependency circle
119 !empty($database->selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'maintenance'])['v'])) {
120 return new Mode($mode);
123 $mode |= Mode::MAINTENANCEDISABLED;
125 return new Mode($mode, $this->isBackend, $this->isAjax, $this->isMobile, $this->isTablet);
129 * Checks if the site is called via a backend process
131 * @param bool $isBackend True, if the call is from a backend script (daemon, worker, ...)
132 * @param Module $module The pre-loaded module (just name, not class!)
133 * @param array $server The $_SERVER variable
134 * @param MobileDetect $mobileDetect The mobile detection library
136 * @return Mode returns the determined mode
138 public function determineRunMode(bool $isBackend, Module $module, array $server, MobileDetect $mobileDetect)
140 foreach (self::BACKEND_CONTENT_TYPES as $type) {
141 if (strpos(strtolower($server['HTTP_ACCEPT'] ?? ''), $type) !== false) {
146 $isBackend = $isBackend || $module->isBackend();
147 $isMobile = $mobileDetect->isMobile();
148 $isTablet = $mobileDetect->isTablet();
149 $isAjax = strtolower($server['HTTP_X_REQUESTED_WITH'] ?? '') == 'xmlhttprequest';
151 return new Mode($this->mode, $isBackend, $isAjax, $isMobile, $isTablet);
155 * Checks, if the Friendica Node has the given mode
157 * @param int $mode A mode to test
159 * @return bool returns true, if the mode is set
161 public function has($mode)
163 return ($this->mode & $mode) > 0;
168 * Install mode is when the local config file is missing or the DB schema hasn't been installed yet.
172 public function isInstall()
174 return !$this->has(Mode::LOCALCONFIGPRESENT) ||
175 !$this->has(MODE::DBCONFIGAVAILABLE);
179 * Normal mode is when the local config file is set, the DB schema is installed and the maintenance mode is off.
183 public function isNormal()
185 return $this->has(Mode::LOCALCONFIGPRESENT) &&
186 $this->has(Mode::DBAVAILABLE) &&
187 $this->has(Mode::DBCONFIGAVAILABLE) &&
188 $this->has(Mode::MAINTENANCEDISABLED);
192 * Returns true, if the call is from a backend node (f.e. from a worker)
194 * @return bool Is it a backend call
196 public function isBackend()
198 return $this->isBackend;
202 * Check if request was an AJAX (xmlhttprequest) request.
204 * @return bool true if it was an AJAX request
206 public function isAjax()
208 return $this->isAjax;
212 * Check if request was a mobile request.
214 * @return bool true if it was an mobile request
216 public function isMobile()
218 return $this->isMobile;
222 * Check if request was a tablet request.
224 * @return bool true if it was an tablet request
226 public function isTablet()
228 return $this->isTablet;