From 59f10619ba4a64e1a43720d365839f6d714d436d Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Thu, 3 May 2018 18:26:31 +0200
Subject: [PATCH] Created middleware used with short codes creation actions to
 handle content negotiation

---
 module/Rest/config/dependencies.config.php    |  1 +
 module/Rest/config/routes.config.php          | 10 +++-
 .../AbstractCreateShortCodeAction.php         |  1 -
 ...eShortCodeContentNegotiationMiddleware.php | 47 +++++++++++++++++++
 4 files changed, 56 insertions(+), 3 deletions(-)
 create mode 100644 module/Rest/src/Middleware/ShortCode/CreateShortCodeContentNegotiationMiddleware.php

diff --git a/module/Rest/config/dependencies.config.php b/module/Rest/config/dependencies.config.php
index 72198c3f..304e667d 100644
--- a/module/Rest/config/dependencies.config.php
+++ b/module/Rest/config/dependencies.config.php
@@ -36,6 +36,7 @@ return [
             Middleware\CrossDomainMiddleware::class => InvokableFactory::class,
             Middleware\PathVersionMiddleware::class => InvokableFactory::class,
             Middleware\CheckAuthenticationMiddleware::class => ConfigAbstractFactory::class,
+            Middleware\ShortCode\CreateShortCodeContentNegotiationMiddleware::class => InvokableFactory::class,
         ],
     ],
 
diff --git a/module/Rest/config/routes.config.php b/module/Rest/config/routes.config.php
index 24d70cdd..0f453e26 100644
--- a/module/Rest/config/routes.config.php
+++ b/module/Rest/config/routes.config.php
@@ -1,6 +1,8 @@
 <?php
 declare(strict_types=1);
 
+namespace Shlinkio\Shlink\Rest;
+
 use Shlinkio\Shlink\Rest\Action;
 
 return [
@@ -9,8 +11,12 @@ return [
         Action\AuthenticateAction::getRouteDef(),
 
         // Short codes
-        Action\ShortCode\CreateShortCodeAction::getRouteDef(),
-        Action\ShortCode\SingleStepCreateShortCodeAction::getRouteDef(),
+        Action\ShortCode\CreateShortCodeAction::getRouteDef([
+            Middleware\ShortCode\CreateShortCodeContentNegotiationMiddleware::class,
+        ]),
+        Action\ShortCode\SingleStepCreateShortCodeAction::getRouteDef([
+            Middleware\ShortCode\CreateShortCodeContentNegotiationMiddleware::class,
+        ]),
         Action\ShortCode\EditShortCodeAction::getRouteDef(),
         Action\ShortCode\ResolveUrlAction::getRouteDef(),
         Action\ShortCode\ListShortCodesAction::getRouteDef(),
diff --git a/module/Rest/src/Action/ShortCode/AbstractCreateShortCodeAction.php b/module/Rest/src/Action/ShortCode/AbstractCreateShortCodeAction.php
index 6d7ba5f2..57b87bc5 100644
--- a/module/Rest/src/Action/ShortCode/AbstractCreateShortCodeAction.php
+++ b/module/Rest/src/Action/ShortCode/AbstractCreateShortCodeAction.php
@@ -77,7 +77,6 @@ abstract class AbstractCreateShortCodeAction extends AbstractRestAction
                                    ->withScheme($this->domainConfig['schema'])
                                    ->withHost($this->domainConfig['hostname']);
 
-            // TODO Make response to be generated based on Accept header
             return new JsonResponse([
                 'longUrl' => (string) $longUrl,
                 'shortUrl' => (string) $shortUrl,
diff --git a/module/Rest/src/Middleware/ShortCode/CreateShortCodeContentNegotiationMiddleware.php b/module/Rest/src/Middleware/ShortCode/CreateShortCodeContentNegotiationMiddleware.php
new file mode 100644
index 00000000..41ce8813
--- /dev/null
+++ b/module/Rest/src/Middleware/ShortCode/CreateShortCodeContentNegotiationMiddleware.php
@@ -0,0 +1,47 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Rest\Middleware\ShortCode;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\MiddlewareInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+use Zend\Diactoros\Response;
+use Zend\Diactoros\Response\JsonResponse;
+
+class CreateShortCodeContentNegotiationMiddleware implements MiddlewareInterface
+{
+    private const PLAIN_TEXT = 'text';
+    private const JSON = 'json';
+
+    /**
+     * Process an incoming server request and return a response, optionally delegating
+     * response creation to a handler.
+     * @throws \RuntimeException
+     * @throws \InvalidArgumentException
+     */
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+    {
+        /** @var JsonResponse $response */
+        $response = $handler->handle($request);
+        $acceptedType = $this->determineAcceptedType($request);
+        if ($acceptedType === self::JSON) {
+            return $response;
+        }
+
+        // If requested, return a plain text response containing the short URL only
+        $resp = (new Response())->withHeader('Content-Type', 'text/plain');
+        $body = $resp->getBody();
+        $body->write($response->getPayload()['shortUrl'] ?? '');
+        $body->rewind();
+        return $resp;
+    }
+
+    private function determineAcceptedType(ServerRequestInterface $request): string
+    {
+        $accepts = \explode(',', $request->getHeaderLine('Accept'));
+        $accept = \strtolower(\array_shift($accepts));
+        return \strpos($accept, 'text/plain') !== false ? self::PLAIN_TEXT : self::JSON;
+    }
+}