friendica/friendica
6
0
Fork 1
mirror of https://github.com/friendica/friendica synced 2024-05-12 04:09:40 +02:00
Code Issues Packages Projects Releases 1 Wiki Activity

Add OPTIONS endpoint

Browse source
This commit is contained in:
Philipp Holzer 2022-01-02 20:25:32 +01:00
parent 1239ce1e7e
commit 01c1e137f7
Signed by: nupplaPhil
GPG key ID: 24A7501396EB5432
3 changed files with 35 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/App/Router.php
View file

@ -37,9 +37,9 @@ use Friendica\Core\Lock\Capability\ICanLock;
use Friendica\LegacyModule;
use Friendica\Module\HTTPException\MethodNotAllowed;
use Friendica\Module\HTTPException\PageNotFound;
use Friendica\Module\Special\Options;
use Friendica\Network\HTTPException;
use Friendica\Network\HTTPException\MethodNotAllowedException;
use Friendica\Network\HTTPException\NoContentException;
use Friendica\Network\HTTPException\NotFoundException;
use Psr\Log\LoggerInterface;
@ -141,13 +141,6 @@ class Router
$httpMethod = $this->server['REQUEST_METHOD'] ?? self::GET;
// @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
// @todo Check allowed methods per requested path
if ($httpMethod === static::OPTIONS) {
header('Allow: ' . implode(',', Router::ALLOWED_METHODS));
throw new NoContentException();
}
$this->httpMethod = in_array($httpMethod, self::ALLOWED_METHODS) ? $httpMethod : self::GET;
$this->routeCollector = isset($routeCollector) ?
@ -284,6 +277,9 @@ class Router
$this->parameters = $routeInfo[2];
} elseif ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
} elseif ($this->httpMethod === static::OPTIONS) {
// Default response for HTTP OPTIONS requests in case there is no special treatment
$moduleClass = Options::class;
} else {
throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
}

15
src/BaseModule.php
View file

@ -173,6 +173,18 @@ abstract class BaseModule implements ICanHandleRequests
{
}
/**
* Module OPTIONS method to process submitted data
*
* Extend this method if the module is supposed to process OPTIONS requests.
* Doesn't display any content
*
* @param string[] $request The $_REQUEST content
*/
protected function options(array $request = [])
{
}
/**
* {@inheritDoc}
*/
@ -225,6 +237,9 @@ abstract class BaseModule implements ICanHandleRequests
case Router::PUT:
$this->put($request);
break;
case Router::OPTIONS:
$this->options($request);
break;
}
$timestamp = microtime(true);

16
src/Module/Special/Options.php Normal file
View file

@ -0,0 +1,16 @@
<?php
namespace Friendica\Module\Special;
use Friendica\App\Router;
use Friendica\BaseModule;
class Options extends BaseModule
{
protected function options(array $request = [])
{
// @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
$this->response->setHeader('Allow', implode(',', Router::ALLOWED_METHODS));
$this->response->setHeader(($this->server['SERVER_PROTOCOL'] ?? 'HTTP/1.1') . ' 204 No Content');
}
}