namespace Friendica;
+use Friendica\App\Router;
use Friendica\Capabilities\ICanHandleRequests;
+use Friendica\Capabilities\ICanCreateResponses;
+use Friendica\Core\Hook;
use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Model\User;
+use Friendica\Module\Response;
+use Friendica\Module\Special\HTTPException as ModuleHTTPException;
+use Friendica\Network\HTTPException;
+use Friendica\Util\Profiler;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Log\LoggerInterface;
/**
* All modules in Friendica should extend BaseModule, although not all modules
{
/** @var array */
protected $parameters = [];
-
/** @var L10n */
protected $l10n;
+ /** @var App\BaseURL */
+ protected $baseUrl;
+ /** @var App\Arguments */
+ protected $args;
+ /** @var LoggerInterface */
+ protected $logger;
+ /** @var Profiler */
+ protected $profiler;
+ /** @var array */
+ protected $server;
+ /** @var ICanCreateResponses */
+ protected $response;
- public function __construct(L10n $l10n, array $parameters = [])
+ public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
{
$this->parameters = $parameters;
$this->l10n = $l10n;
+ $this->baseUrl = $baseUrl;
+ $this->args = $args;
+ $this->logger = $logger;
+ $this->profiler = $profiler;
+ $this->server = $server;
+ $this->response = $response;
}
/**
*/
protected function t(string $s, ...$args): string
{
- return $this->l10n->t($s, $args);
+ return $this->l10n->t($s, ...$args);
}
/**
}
/**
- * {@inheritDoc}
+ * Module GET method to display raw content from technical endpoints
+ *
+ * Extend this method if the module is supposed to return communication data,
+ * e.g. from protocol implementations.
+ *
+ * @param string[] $request The $_REQUEST content
*/
- public function rawContent()
+ protected function rawContent(array $request = [])
{
// echo '';
// exit;
}
/**
- * {@inheritDoc}
+ * Module GET method to display any content
+ *
+ * Extend this method if the module is supposed to return any display
+ * through a GET request. It can be an HTML page through templating or a
+ * XML feed or a JSON output.
+ *
+ * @param string[] $request The $_REQUEST content
*/
- public function content(): string
+ protected function content(array $request = []): string
{
return '';
}
/**
- * {@inheritDoc}
+ * Module DELETE method to process submitted data
+ *
+ * Extend this method if the module is supposed to process DELETE requests.
+ * Doesn't display any content
*/
- public function delete()
+ protected function delete()
{
}
/**
- * {@inheritDoc}
+ * Module PATCH method to process submitted data
+ *
+ * Extend this method if the module is supposed to process PATCH requests.
+ * Doesn't display any content
*/
- public function patch()
+ protected function patch()
{
}
/**
- * {@inheritDoc}
+ * Module POST method to process submitted data
+ *
+ * Extend this method if the module is supposed to process POST requests.
+ * Doesn't display any content
+ *
+ * @param string[] $request The $_REQUEST content
+ * @param string[] $post The $_POST content
+ *
*/
- public function post()
+ protected function post(array $request = [], array $post = [])
{
- // DI::baseurl()->redirect('module');
+ // $this->baseUrl->redirect('module');
}
/**
- * {@inheritDoc}
+ * Module PUT method to process submitted data
+ *
+ * Extend this method if the module is supposed to process PUT requests.
+ * Doesn't display any content
*/
- public function put()
+ protected function put()
{
}
- /** Gets the name of the current class */
- public function getClassName(): string
+ /**
+ * {@inheritDoc}
+ */
+ public function run(array $post = [], array $request = []): ResponseInterface
{
- return static::class;
+ // @see https://github.com/tootsuite/mastodon/blob/c3aef491d66aec743a3a53e934a494f653745b61/config/initializers/cors.rb
+ if (substr($request['pagename'] ?? '', 0, 12) == '.well-known/') {
+ $this->response->setHeader('*', 'Access-Control-Allow-Origin');
+ $this->response->setHeader('*', 'Access-Control-Allow-Headers');
+ $this->response->setHeader(Router::GET, 'Access-Control-Allow-Methods');
+ $this->response->setHeader('false', 'Access-Control-Allow-Credentials');
+ } elseif (substr($request['pagename'] ?? '', 0, 8) == 'profile/') {
+ $this->response->setHeader('*', 'Access-Control-Allow-Origin');
+ $this->response->setHeader('*', 'Access-Control-Allow-Headers');
+ $this->response->setHeader(Router::GET, 'Access-Control-Allow-Methods');
+ $this->response->setHeader('false', 'Access-Control-Allow-Credentials');
+ } elseif (substr($request['pagename'] ?? '', 0, 4) == 'api/') {
+ $this->response->setHeader('*', 'Access-Control-Allow-Origin');
+ $this->response->setHeader('*', 'Access-Control-Allow-Headers');
+ $this->response->setHeader(implode(',', Router::ALLOWED_METHODS), 'Access-Control-Allow-Methods');
+ $this->response->setHeader('false', 'Access-Control-Allow-Credentials');
+ $this->response->setHeader('Link', 'Access-Control-Expose-Headers');
+ } elseif (substr($request['pagename'] ?? '', 0, 11) == 'oauth/token') {
+ $this->response->setHeader('*', 'Access-Control-Allow-Origin');
+ $this->response->setHeader('*', 'Access-Control-Allow-Headers');
+ $this->response->setHeader(Router::POST, 'Access-Control-Allow-Methods');
+ $this->response->setHeader('false', 'Access-Control-Allow-Credentials');
+ }
+
+ $placeholder = '';
+
+ $this->profiler->set(microtime(true), 'ready');
+ $timestamp = microtime(true);
+
+ Core\Hook::callAll($this->args->getModuleName() . '_mod_init', $placeholder);
+
+ $this->profiler->set(microtime(true) - $timestamp, 'init');
+
+ switch ($this->server['REQUEST_METHOD'] ?? Router::GET) {
+ case Router::DELETE:
+ $this->delete();
+ break;
+ case Router::PATCH:
+ $this->patch();
+ break;
+ case Router::POST:
+ Core\Hook::callAll($this->args->getModuleName() . '_mod_post', $post);
+ $this->post($request, $post);
+ break;
+ case Router::PUT:
+ $this->put();
+ break;
+ }
+
+ $timestamp = microtime(true);
+ // "rawContent" is especially meant for technical endpoints.
+ // This endpoint doesn't need any theme initialization or other comparable stuff.
+ $this->rawContent($request);
+
+ try {
+ $arr = ['content' => ''];
+ Hook::callAll(static::class . '_mod_content', $arr);
+ $this->response->addContent($arr['content']);
+ $this->response->addContent($this->content($_REQUEST));
+ } catch (HTTPException $e) {
+ $this->response->addContent((new ModuleHTTPException())->content($e));
+ } finally {
+ $this->profiler->set(microtime(true) - $timestamp, 'content');
+ }
+
+ return $this->response->generate();
}
/*
*/
public static function getFormSecurityToken($typename = '')
{
- $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
+ $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
$timestamp = time();
- $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename);
+ $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename);
return $timestamp . '.' . $sec_hash;
}
projects / friendica.git / blobdiff