Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #261 from dotkernel/issue-259
Implement content-negociation
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| return [ | ||
| 'content-negotiation' => [ | ||
| 'default' => [ // default to any route if not configured above | ||
| 'Accept' => [ | ||
| 'application/json', | ||
| 'application/hal+json', | ||
| ], | ||
| 'Content-Type' => [ | ||
| 'application/json', | ||
| 'application/hal+json', | ||
| ], | ||
| ], | ||
| 'your.route.name' => [ | ||
| 'Accept' => [], | ||
| 'Content-Type' => [], | ||
| ], | ||
| ], | ||
| ]; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Api\App\Middleware; | ||
|
|
||
| use Dot\AnnotatedServices\Annotation\Inject; | ||
| use Laminas\Diactoros\Response\JsonResponse; | ||
| use Laminas\Http\Response; | ||
| use Mezzio\Router\RouteResult; | ||
| use Psr\Http\Message\ResponseInterface; | ||
| use Psr\Http\Message\ServerRequestInterface; | ||
| use Psr\Http\Server\MiddlewareInterface; | ||
| use Psr\Http\Server\RequestHandlerInterface; | ||
|
|
||
| use function array_filter; | ||
| use function array_intersect; | ||
| use function array_map; | ||
| use function explode; | ||
| use function in_array; | ||
| use function is_array; | ||
| use function str_contains; | ||
| use function strtok; | ||
| use function trim; | ||
|
|
||
| class ContentNegotiationMiddleware implements MiddlewareInterface | ||
| { | ||
| /** | ||
| * @Inject({"config.content-negotiation"}) | ||
| */ | ||
| public function __construct(private array $config) | ||
| { | ||
| } | ||
|
|
||
| public function process( | ||
| ServerRequestInterface $request, | ||
| RequestHandlerInterface $handler | ||
| ): ResponseInterface { | ||
| $routeResult = $request->getAttribute(RouteResult::class); | ||
| if (! $routeResult instanceof RouteResult || $routeResult->isFailure()) { | ||
| return $handler->handle($request); | ||
| } | ||
|
|
||
| $routeName = (string) $routeResult->getMatchedRouteName(); | ||
|
|
||
| $accept = $this->formatAcceptRequest($request->getHeaderLine('Accept')); | ||
| if (! $this->checkAccept($routeName, $accept)) { | ||
| return $this->notAcceptedResponse('Not Acceptable'); | ||
| } | ||
|
|
||
| $contentType = $request->getHeaderLine('Content-Type'); | ||
| if (! $this->checkContentType($routeName, $contentType)) { | ||
| return $this->unsupportedMediaTypeResponse( | ||
| 'Unsupported Media Type' | ||
| ); | ||
| } | ||
|
|
||
| $response = $handler->handle($request); | ||
|
|
||
| $responseContentType = $response->getHeaderLine('Content-Type'); | ||
| if ( | ||
| ! $this->validateResponseContentType( | ||
| $responseContentType, | ||
| $accept | ||
| ) | ||
| ) { | ||
| return $this->notAcceptedResponse( | ||
| 'Unable to resolve Accept header to a representation' | ||
| ); | ||
| } | ||
|
|
||
| return $response; | ||
| } | ||
|
|
||
| public function formatAcceptRequest(string $accept): array | ||
| { | ||
| $accept = array_map(function ($item) { | ||
| return trim(strtok($item, ';')); | ||
| }, explode(',', $accept)); | ||
|
|
||
| return array_filter($accept); | ||
| } | ||
|
|
||
| public function checkAccept(string $routeName, array $accept): bool | ||
| { | ||
| if (in_array('*/*', $accept, true)) { | ||
| return true; | ||
| } | ||
|
|
||
| $acceptList = $this->config['default']['Accept'] ?? []; | ||
| if (isset($this->config[$routeName])) { | ||
| $acceptList = $this->config[$routeName]['Accept'] ?? []; | ||
| } | ||
|
|
||
| if (is_array($acceptList)) { | ||
| return ! empty(array_intersect($accept, $acceptList)); | ||
| } else { | ||
| return in_array($acceptList, $accept, true); | ||
| } | ||
| } | ||
|
|
||
| public function checkContentType(string $routeName, string $contentType): bool | ||
| { | ||
| if (empty($contentType)) { | ||
| return true; | ||
| } | ||
| $acceptList = $this->config['default']['Content-Type'] ?? []; | ||
| if (isset($this->config[$routeName])) { | ||
| $acceptList = $this->config[$routeName]['Content-Type'] ?? []; | ||
| } | ||
|
|
||
| if (is_array($acceptList)) { | ||
| return in_array($contentType, $acceptList, true); | ||
| } else { | ||
| return $contentType === $acceptList; | ||
| } | ||
| } | ||
|
|
||
| public function notAcceptedResponse(string $message): JsonResponse | ||
| { | ||
| return new JsonResponse([ | ||
| 'error' => [ | ||
| 'messages' => [ | ||
| $message, | ||
| ], | ||
| ], | ||
| ], Response::STATUS_CODE_406); | ||
| } | ||
|
|
||
| public function unsupportedMediaTypeResponse(string $message): JsonResponse | ||
| { | ||
| return new JsonResponse([ | ||
| 'error' => [ | ||
| 'messages' => [ | ||
| $message, | ||
| ], | ||
| ], | ||
| ], Response::STATUS_CODE_415); | ||
| } | ||
|
|
||
| public function validateResponseContentType(?string $contentType, array $accept): bool | ||
| { | ||
| if (in_array('*/*', $accept, true)) { | ||
| return true; | ||
| } | ||
|
|
||
| if (null === $contentType) { | ||
| return false; | ||
| } | ||
|
|
||
| $accept = array_map(function ($item) { | ||
| return str_contains($item, 'json') ? 'json' : $item; | ||
| }, $accept); | ||
|
|
||
| if (str_contains($contentType, 'json')) { | ||
| $contentType = 'json'; | ||
| } | ||
|
|
||
| return in_array($contentType, $accept, true); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.