<?php
/**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
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;
/**
protected $profiler;
/** @var array */
protected $server;
+ /** @var ICanCreateResponses */
+ protected $response;
- public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, array $server, 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->logger = $logger;
$this->profiler = $profiler;
$this->server = $server;
+ $this->response = $response;
}
/**
*
* Extend this method if the module is supposed to process DELETE requests.
* Doesn't display any content
+ *
+ * @param string[] $request The $_REQUEST content
*/
- protected function delete()
+ protected function delete(array $request = [])
{
}
*
* Extend this method if the module is supposed to process PATCH requests.
* Doesn't display any content
+ *
+ * @param string[] $request The $_REQUEST content
*/
- protected function patch()
+ protected function patch(array $request = [])
{
}
* Doesn't display any content
*
* @param string[] $request The $_REQUEST content
- * @param string[] $post The $_POST content
*
*/
- protected function post(array $request = [], array $post = [])
+ protected function post(array $request = [])
{
// $this->baseUrl->redirect('module');
}
*
* Extend this method if the module is supposed to process PUT requests.
* Doesn't display any content
+ *
+ * @param string[] $request The $_REQUEST content
*/
- protected function put()
+ protected function put(array $request = [])
{
}
- /** Gets the name of the current class */
- public function getClassName(): string
- {
- return static::class;
- }
-
/**
* {@inheritDoc}
*/
- public function run(array $post = [], array $request = []): string
+ public function run(array $request = []): ResponseInterface
{
// @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');
+ $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/') {
- header('Access-Control-Allow-Origin: *');
- header('Access-Control-Allow-Headers: *');
- header('Access-Control-Allow-Methods: ' . Router::GET);
- header('Access-Control-Allow-Credentials: false');
+ $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/') {
- 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');
+ $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') {
- header('Access-Control-Allow-Origin: *');
- header('Access-Control-Allow-Headers: *');
- header('Access-Control-Allow-Methods: ' . Router::POST);
- header('Access-Control-Allow-Credentials: false');
+ $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) - $timestamp, 'init');
- if ($this->server['REQUEST_METHOD'] === Router::DELETE) {
- $this->delete();
- }
-
- if ($this->server['REQUEST_METHOD'] === Router::PATCH) {
- $this->patch();
- }
-
- if ($this->server['REQUEST_METHOD'] === Router::POST) {
- Core\Hook::callAll($this->args->getModuleName() . '_mod_post', $post);
- $this->post($request, $post);
- }
-
- if ($this->server['REQUEST_METHOD'] === Router::PUT) {
- $this->put();
+ switch ($this->server['REQUEST_METHOD'] ?? Router::GET) {
+ case Router::DELETE:
+ $this->delete($request);
+ break;
+ case Router::PATCH:
+ $this->patch($request);
+ break;
+ case Router::POST:
+ Core\Hook::callAll($this->args->getModuleName() . '_mod_post', $request);
+ $this->post($request);
+ break;
+ case Router::PUT:
+ $this->put($request);
+ 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);
- $content = $arr['content'];
- return $content . $this->content($_REQUEST);
+ $this->response->addContent($arr['content']);
+ $this->response->addContent($this->content($request));
} catch (HTTPException $e) {
- return (new ModuleHTTPException())->content($e);
+ $this->response->addContent((new ModuleHTTPException())->content($e));
+ } finally {
+ $this->profiler->set(microtime(true) - $timestamp, 'content');
+ }
+
+ return $this->response->generate();
+ }
+
+ /**
+ * Checks request inputs and sets default parameters
+ *
+ * @param array $defaults Associative array of expected request keys and their default typed value. A null
+ * value will remove the request key from the resulting value array.
+ * @param array $input Custom REQUEST array, superglobal instead
+ *
+ * @return array Request data
+ */
+ protected function checkDefaults(array $defaults, array $input): array
+ {
+ $request = [];
+
+ foreach ($defaults as $parameter => $defaultvalue) {
+ if (is_string($defaultvalue)) {
+ $request[$parameter] = $input[$parameter] ?? $defaultvalue;
+ } elseif (is_int($defaultvalue)) {
+ $request[$parameter] = (int)($input[$parameter] ?? $defaultvalue);
+ } elseif (is_float($defaultvalue)) {
+ $request[$parameter] = (float)($input[$parameter] ?? $defaultvalue);
+ } elseif (is_array($defaultvalue)) {
+ $request[$parameter] = $input[$parameter] ?? [];
+ } elseif (is_bool($defaultvalue)) {
+ $request[$parameter] = in_array(strtolower($input[$parameter] ?? ''), ['true', '1']);
+ } else {
+ $this->logger->notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]);
+ }
}
+
+ foreach ($input ?? [] as $parameter => $value) {
+ if ($parameter == 'pagename') {
+ continue;
+ }
+ if (!in_array($parameter, array_keys($defaults))) {
+ $this->logger->notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => $this->args->getCommand()]);
+ }
+ }
+
+ $this->logger->debug('Got request parameters', ['request' => $request, 'command' => $this->args->getCommand()]);
+ return $request;
}
/*
*/
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