<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
namespace Friendica\App;
use Friendica\App;
-use Friendica\BaseObject;
+use Friendica\BaseModule;
use Friendica\Core;
+use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\LegacyModule;
use Friendica\Module\Home;
-use Friendica\Module\PageNotFound;
+use Friendica\Module\HTTPException\MethodNotAllowed;
+use Friendica\Module\HTTPException\PageNotFound;
+use Friendica\Network\HTTPException\MethodNotAllowedException;
+use Friendica\Network\HTTPException\NoContentException;
+use Friendica\Network\HTTPException\NotFoundException;
+use Friendica\Util\Profiler;
use Psr\Log\LoggerInterface;
/**
*/
class Module
{
- const DEFAULT = 'home';
+ const DEFAULT = 'home';
const DEFAULT_CLASS = Home::class;
-
- /**
- * @var string The module name
- */
- private $module;
-
- /**
- * @var BaseObject The module class
- */
- private $module_class;
-
- /**
- * @var bool true, if the module is a backend module
- */
- private $isBackend;
-
- /**
- * @var bool true, if the loaded addon is private, so we have to print out not allowed
- */
- private $printNotAllowedAddon;
-
/**
* A list of modules, which are backend methods
*
'outbox',
'poco',
'post',
- 'proxy',
'pubsub',
'pubsubhubbub',
'receive',
'xrd',
];
+ /**
+ * @var string The module name
+ */
+ private $module;
+
+ /**
+ * @var BaseModule The module class
+ */
+ private $module_class;
+
+ /**
+ * @var array The module parameters
+ */
+ private $module_parameters;
+
+ /**
+ * @var bool true, if the module is a backend module
+ */
+ private $isBackend;
+
+ /**
+ * @var bool true, if the loaded addon is private, so we have to print out not allowed
+ */
+ private $printNotAllowedAddon;
+
/**
* @return string
*/
}
/**
- * @return bool
+ * @return array The module parameters extracted from the route
+ */
+ public function getParameters()
+ {
+ return $this->module_parameters;
+ }
+
+ /**
+ * @return bool True, if the current module is a backend module
+ * @see Module::BACKEND_MODULES for a list
*/
public function isBackend()
{
return $this->isBackend;
}
- public function __construct(string $module = self::DEFAULT, string $moduleClass = self::DEFAULT_CLASS, bool $isBackend = false, bool $printNotAllowedAddon = false)
+ public function __construct(string $module = self::DEFAULT, string $moduleClass = self::DEFAULT_CLASS, array $moduleParameters = [], bool $isBackend = false, bool $printNotAllowedAddon = false)
{
- $this->module = $module;
- $this->module_class = $moduleClass;
- $this->isBackend = $isBackend;
+ $this->module = $module;
+ $this->module_class = $moduleClass;
+ $this->module_parameters = $moduleParameters;
+ $this->isBackend = $isBackend;
$this->printNotAllowedAddon = $printNotAllowedAddon;
}
* Determines the current module based on the App arguments and the server variable
*
* @param Arguments $args The Friendica arguments
- * @param array $server The $_SERVER variable
*
* @return Module The module with the determined module
*/
- public function determineModule(Arguments $args, array $server)
+ public function determineModule(Arguments $args)
{
if ($args->getArgc() > 0) {
$module = str_replace('.', '_', $args->get(0));
$module = "login";
}
- $isBackend = $this->checkBackend($module, $server);
+ $isBackend = in_array($module, Module::BACKEND_MODULES);;
- return new Module($module, $this->module_class, $isBackend, $this->printNotAllowedAddon);
+ return new Module($module, $this->module_class, [], $isBackend, $this->printNotAllowedAddon);
}
/**
* Determine the class of the current module
*
- * @param Arguments $args The Friendica execution arguments
- * @param Router $router The Friendica routing instance
- * @param Core\Config\Configuration $config The Friendica Configuration
+ * @param Arguments $args The Friendica execution arguments
+ * @param Router $router The Friendica routing instance
+ * @param IManageConfigValues $config The Friendica Configuration
*
* @return Module The determined module of this call
*
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \Exception
*/
- public function determineClass(Arguments $args, Router $router, Core\Config\Configuration $config)
+ public function determineClass(Arguments $args, Router $router, IManageConfigValues $config)
{
$printNotAllowedAddon = false;
+ $module_class = null;
+ $module_parameters = [];
/**
* ROUTING
*
* From the request URL, routing consists of obtaining the name of a BaseModule-extending class of which the
* post() and/or content() static methods can be respectively called to produce a data change or an output.
**/
-
- // First we try explicit routes defined in App\Router
- $router->collectRoutes();
-
- $data = $router->getRouteCollector();
- Core\Hook::callAll('route_collection', $data);
-
- $module_class = $router->getModuleClass($args->getCommand());
-
- // Then we try addon-provided modules that we wrap in the LegacyModule class
- if (!$module_class && Core\Addon::isEnabled($this->module) && file_exists("addon/{$this->module}/{$this->module}.php")) {
- //Check if module is an app and if public access to apps is allowed or not
- $privateapps = $config->get('config', 'private_addons', false);
- if ((!local_user()) && Core\Hook::isAddonApp($this->module) && $privateapps) {
- $printNotAllowedAddon = true;
- } else {
- include_once "addon/{$this->module}/{$this->module}.php";
- if (function_exists($this->module . '_module')) {
- LegacyModule::setModuleFile("addon/{$this->module}/{$this->module}.php");
- $module_class = LegacyModule::class;
+ try {
+ $module_class = $router->getModuleClass($args->getCommand());
+ $module_parameters = $router->getModuleParameters();
+ } catch (MethodNotAllowedException $e) {
+ $module_class = MethodNotAllowed::class;
+ } catch (NotFoundException $e) {
+ // Then we try addon-provided modules that we wrap in the LegacyModule class
+ if (Core\Addon::isEnabled($this->module) && file_exists("addon/{$this->module}/{$this->module}.php")) {
+ //Check if module is an app and if public access to apps is allowed or not
+ $privateapps = $config->get('config', 'private_addons', false);
+ if ((!local_user()) && Core\Hook::isAddonApp($this->module) && $privateapps) {
+ $printNotAllowedAddon = true;
+ } else {
+ include_once "addon/{$this->module}/{$this->module}.php";
+ if (function_exists($this->module . '_module')) {
+ LegacyModule::setModuleFile("addon/{$this->module}/{$this->module}.php");
+ $module_class = LegacyModule::class;
+ }
}
}
- }
- /* Finally, we look for a 'standard' program module in the 'mod' directory
- * We emulate a Module class through the LegacyModule class
- */
- if (!$module_class && file_exists("mod/{$this->module}.php")) {
- LegacyModule::setModuleFile("mod/{$this->module}.php");
- $module_class = LegacyModule::class;
- }
+ /* Finally, we look for a 'standard' program module in the 'mod' directory
+ * We emulate a Module class through the LegacyModule class
+ */
+ if (!$module_class && file_exists("mod/{$this->module}.php")) {
+ LegacyModule::setModuleFile("mod/{$this->module}.php");
+ $module_class = LegacyModule::class;
+ }
- $module_class = !isset($module_class) ? PageNotFound::class : $module_class;
+ $module_class = $module_class ?: PageNotFound::class;
+ }
- return new Module($this->module, $module_class, $this->isBackend, $printNotAllowedAddon);
+ return new Module($this->module, $module_class, $module_parameters, $this->isBackend, $printNotAllowedAddon);
}
/**
* Run the determined module class and calls all hooks applied to
*
- * @param Core\L10n\L10n $l10n The L10n instance
- * @param App $app The whole Friendica app (for method arguments)
- * @param LoggerInterface $logger The Friendica logger
- * @param string $currentTheme The chosen theme
- * @param array $server The $_SERVER variable
- * @param array $post The $_POST variables
+ * @param \Friendica\Core\L10n $l10n The L10n instance
+ * @param App\BaseURL $baseUrl The Friendica Base URL
+ * @param LoggerInterface $logger The Friendica logger
+ * @param array $server The $_SERVER variable
+ * @param array $post The $_POST variables
*
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public function run(Core\L10n\L10n $l10n, App $app, LoggerInterface $logger, string $currentTheme, array $server, array $post)
+ public function run(Core\L10n $l10n, App\BaseURL $baseUrl, LoggerInterface $logger, Profiler $profiler, array $server, array $post)
{
if ($this->printNotAllowedAddon) {
- info($l10n->t("You must be logged in to use addons. "));
+ notice($l10n->t("You must be logged in to use addons. "));
}
/* The URL provided does not resolve to a valid module.
if (!empty($queryString) && ($queryString === 'q=internal_error.html') && isset($dreamhost_error_hack)) {
$logger->info('index.php: dreamhost_error_hack invoked.', ['Original URI' => $server['REQUEST_URI']]);
- $app->internalRedirect($server['REQUEST_URI']);
+ $baseUrl->redirect($server['REQUEST_URI']);
}
$logger->debug('index.php: page not found.', ['request_uri' => $server['REQUEST_URI'], 'address' => $server['REMOTE_ADDR'], 'query' => $server['QUERY_STRING']]);
}
+ // @see https://github.com/tootsuite/mastodon/blob/c3aef491d66aec743a3a53e934a494f653745b61/config/initializers/cors.rb
+ if (substr($_REQUEST['pagename'] ?? '', 0, 12) == '.well-known/') {
+ header('Access-Control-Allow-Origin: *');
+ header('Access-Control-Allow-Headers: *');
+ header('Access-Control-Allow-Methods: ' . Router::GET);
+ header('Access-Control-Allow-Credentials: false');
+ } elseif (substr($_REQUEST['pagename'] ?? '', 0, 8) == 'profile/') {
+ header('Access-Control-Allow-Origin: *');
+ header('Access-Control-Allow-Headers: *');
+ header('Access-Control-Allow-Methods: ' . Router::GET);
+ header('Access-Control-Allow-Credentials: false');
+ } elseif (substr($_REQUEST['pagename'] ?? '', 0, 4) == 'api/') {
+ header('Access-Control-Allow-Origin: *');
+ header('Access-Control-Allow-Headers: *');
+ header('Access-Control-Allow-Methods: ' . implode(',', Router::ALLOWED_METHODS));
+ header('Access-Control-Allow-Credentials: false');
+ header('Access-Control-Expose-Headers: Link');
+ } elseif (substr($_REQUEST['pagename'] ?? '', 0, 11) == 'oauth/token') {
+ header('Access-Control-Allow-Origin: *');
+ header('Access-Control-Allow-Headers: *');
+ header('Access-Control-Allow-Methods: ' . Router::POST);
+ header('Access-Control-Allow-Credentials: false');
+ }
+
+ // @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
+ // @todo Check allowed methods per requested path
+ if ($server['REQUEST_METHOD'] === Router::OPTIONS) {
+ header('Allow: ' . implode(',', Router::ALLOWED_METHODS));
+ throw new NoContentException();
+ }
+
$placeholder = '';
+ $profiler->set(microtime(true), 'ready');
+ $timestamp = microtime(true);
+
Core\Hook::callAll($this->module . '_mod_init', $placeholder);
- call_user_func([$this->module_class, 'init']);
+ call_user_func([$this->module_class, 'init'], $this->module_parameters);
- // "rawContent" is especially meant for technical endpoints.
- // This endpoint doesn't need any theme initialization or other comparable stuff.
- call_user_func([$this->module_class, 'rawContent']);
+ $profiler->set(microtime(true) - $timestamp, 'init');
- // Load current theme info after module has been initialized as theme could have been set in module
- $theme_info_file = 'view/theme/' . $currentTheme . '/theme.php';
- if (file_exists($theme_info_file)) {
- require_once $theme_info_file;
+ if ($server['REQUEST_METHOD'] === Router::DELETE) {
+ call_user_func([$this->module_class, 'delete'], $this->module_parameters);
}
- if (function_exists(str_replace('-', '_', $currentTheme) . '_init')) {
- $func = str_replace('-', '_', $currentTheme) . '_init';
- $func($app);
+ if ($server['REQUEST_METHOD'] === Router::PATCH) {
+ call_user_func([$this->module_class, 'patch'], $this->module_parameters);
}
- if ($server['REQUEST_METHOD'] === 'POST') {
+ if ($server['REQUEST_METHOD'] === Router::POST) {
Core\Hook::callAll($this->module . '_mod_post', $post);
- call_user_func([$this->module_class, 'post']);
+ call_user_func([$this->module_class, 'post'], $this->module_parameters);
+ }
+
+ if ($server['REQUEST_METHOD'] === Router::PUT) {
+ call_user_func([$this->module_class, 'put'], $this->module_parameters);
}
Core\Hook::callAll($this->module . '_mod_afterpost', $placeholder);
- call_user_func([$this->module_class, 'afterpost']);
- }
+ call_user_func([$this->module_class, 'afterpost'], $this->module_parameters);
- /**
- * @brief Checks if the site is called via a backend process
- *
- * This isn't a perfect solution. But we need this check very early.
- * So we cannot wait until the modules are loaded.
- *
- * @param string $module The determined module
- * @param array $server The $_SERVER variable
- *
- * @return bool True, if the current module is called at backend
- */
- private function checkBackend($module, array $server)
- {
- // Check if current module is in backend or backend flag is set
- return basename(($server['PHP_SELF'] ?? ''), '.php') !== 'index' &&
- in_array($module, Module::BACKEND_MODULES);
+ // "rawContent" is especially meant for technical endpoints.
+ // This endpoint doesn't need any theme initialization or other comparable stuff.
+ call_user_func([$this->module_class, 'rawContent'], $this->module_parameters);
}
}
projects / friendica.git / blobdiff