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;
25 use Friendica\BaseModule;
27 use Friendica\LegacyModule;
28 use Friendica\Module\Home;
29 use Friendica\Module\HTTPException\MethodNotAllowed;
30 use Friendica\Module\HTTPException\PageNotFound;
31 use Friendica\Network\HTTPException\MethodNotAllowedException;
32 use Friendica\Network\HTTPException\NotFoundException;
33 use Friendica\Util\Profiler;
34 use Psr\Log\LoggerInterface;
37 * Holds the common context of the current, loaded module
41 const DEFAULT = 'home';
42 const DEFAULT_CLASS = Home::class;
44 * A list of modules, which are backend methods
48 const BACKEND_MODULES = [
77 * @var string The module name
82 * @var BaseModule The module class
84 private $module_class;
87 * @var array The module parameters
89 private $module_parameters;
92 * @var bool true, if the module is a backend module
97 * @var bool true, if the loaded addon is private, so we have to print out not allowed
99 private $printNotAllowedAddon;
104 public function getName()
106 return $this->module;
110 * @return string The base class name
112 public function getClassName()
114 return $this->module_class;
118 * @return array The module parameters extracted from the route
120 public function getParameters()
122 return $this->module_parameters;
126 * @return bool True, if the current module is a backend module
127 * @see Module::BACKEND_MODULES for a list
129 public function isBackend()
131 return $this->isBackend;
134 public function __construct(string $module = self::DEFAULT, string $moduleClass = self::DEFAULT_CLASS, array $moduleParameters = [], bool $isBackend = false, bool $printNotAllowedAddon = false)
136 $this->module = $module;
137 $this->module_class = $moduleClass;
138 $this->module_parameters = $moduleParameters;
139 $this->isBackend = $isBackend;
140 $this->printNotAllowedAddon = $printNotAllowedAddon;
144 * Determines the current module based on the App arguments and the server variable
146 * @param Arguments $args The Friendica arguments
148 * @return Module The module with the determined module
150 public function determineModule(Arguments $args)
152 if ($args->getArgc() > 0) {
153 $module = str_replace('.', '_', $args->get(0));
154 $module = str_replace('-', '_', $module);
156 $module = self::DEFAULT;
159 // Compatibility with the Firefox App
160 if (($module == "users") && ($args->getCommand() == "users/sign_in")) {
164 $isBackend = in_array($module, Module::BACKEND_MODULES);;
166 return new Module($module, $this->module_class, [], $isBackend, $this->printNotAllowedAddon);
170 * Determine the class of the current module
172 * @param Arguments $args The Friendica execution arguments
173 * @param Router $router The Friendica routing instance
174 * @param Core\Config\IConfig $config The Friendica Configuration
176 * @return Module The determined module of this call
180 public function determineClass(Arguments $args, Router $router, Core\Config\IConfig $config)
182 $printNotAllowedAddon = false;
184 $module_class = null;
185 $module_parameters = [];
189 * From the request URL, routing consists of obtaining the name of a BaseModule-extending class of which the
190 * post() and/or content() static methods can be respectively called to produce a data change or an output.
193 $module_class = $router->getModuleClass($args->getCommand());
194 $module_parameters = $router->getModuleParameters();
195 } catch (MethodNotAllowedException $e) {
196 $module_class = MethodNotAllowed::class;
197 } catch (NotFoundException $e) {
198 // Then we try addon-provided modules that we wrap in the LegacyModule class
199 if (Core\Addon::isEnabled($this->module) && file_exists("addon/{$this->module}/{$this->module}.php")) {
200 //Check if module is an app and if public access to apps is allowed or not
201 $privateapps = $config->get('config', 'private_addons', false);
202 if ((!local_user()) && Core\Hook::isAddonApp($this->module) && $privateapps) {
203 $printNotAllowedAddon = true;
205 include_once "addon/{$this->module}/{$this->module}.php";
206 if (function_exists($this->module . '_module')) {
207 LegacyModule::setModuleFile("addon/{$this->module}/{$this->module}.php");
208 $module_class = LegacyModule::class;
213 /* Finally, we look for a 'standard' program module in the 'mod' directory
214 * We emulate a Module class through the LegacyModule class
216 if (!$module_class && file_exists("mod/{$this->module}.php")) {
217 LegacyModule::setModuleFile("mod/{$this->module}.php");
218 $module_class = LegacyModule::class;
221 $module_class = $module_class ?: PageNotFound::class;
224 return new Module($this->module, $module_class, $module_parameters, $this->isBackend, $printNotAllowedAddon);
228 * Run the determined module class and calls all hooks applied to
230 * @param \Friendica\Core\L10n $l10n The L10n instance
231 * @param App\BaseURL $baseUrl The Friendica Base URL
232 * @param LoggerInterface $logger The Friendica logger
233 * @param array $server The $_SERVER variable
234 * @param array $post The $_POST variables
236 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
238 public function run(Core\L10n $l10n, App\BaseURL $baseUrl, LoggerInterface $logger, Profiler $profiler, array $server, array $post)
240 if ($this->printNotAllowedAddon) {
241 notice($l10n->t("You must be logged in to use addons. "));
244 /* The URL provided does not resolve to a valid module.
246 * On Dreamhost sites, quite often things go wrong for no apparent reason and they send us to '/internal_error.html'.
247 * We don't like doing this, but as it occasionally accounts for 10-20% or more of all site traffic -
248 * we are going to trap this and redirect back to the requested page. As long as you don't have a critical error on your page
249 * this will often succeed and eventually do the right thing.
251 * Otherwise we are going to emit a 404 not found.
253 if ($this->module_class === PageNotFound::class) {
254 $queryString = $server['QUERY_STRING'];
255 // Stupid browser tried to pre-fetch our Javascript img template. Don't log the event or return anything - just quietly exit.
256 if (!empty($queryString) && preg_match('/{[0-9]}/', $queryString) !== 0) {
260 if (!empty($queryString) && ($queryString === 'q=internal_error.html') && isset($dreamhost_error_hack)) {
261 $logger->info('index.php: dreamhost_error_hack invoked.', ['Original URI' => $server['REQUEST_URI']]);
262 $baseUrl->redirect($server['REQUEST_URI']);
265 $logger->debug('index.php: page not found.', ['request_uri' => $server['REQUEST_URI'], 'address' => $server['REMOTE_ADDR'], 'query' => $server['QUERY_STRING']]);
270 $profiler->set(microtime(true), 'ready');
271 $timestamp = microtime(true);
273 Core\Hook::callAll($this->module . '_mod_init', $placeholder);
275 call_user_func([$this->module_class, 'init'], $this->module_parameters);
277 $profiler->set(microtime(true) - $timestamp, 'init');
279 if ($server['REQUEST_METHOD'] === 'POST') {
280 Core\Hook::callAll($this->module . '_mod_post', $post);
281 call_user_func([$this->module_class, 'post'], $this->module_parameters);
284 Core\Hook::callAll($this->module . '_mod_afterpost', $placeholder);
285 call_user_func([$this->module_class, 'afterpost'], $this->module_parameters);
287 // "rawContent" is especially meant for technical endpoints.
288 // This endpoint doesn't need any theme initialization or other comparable stuff.
289 call_user_func([$this->module_class, 'rawContent'], $this->module_parameters);