III-5017: Allow uploading images via online Url in Json Body

app/Media/MediaServiceProvider.php

@@ -17,6 +17,7 @@
 use CultuurNet\UDB3\Media\ReadModel\ImageLDProjector;
 use CultuurNet\UDB3\Media\Serialization\MediaObjectSerializer;
 use CultuurNet\UDB3\Model\Serializer\ValueObject\MediaObject\ImageNormalizer;
+use GuzzleHttp\Client;
 
 final class MediaServiceProvider extends AbstractServiceProvider
 {
@@ -26,6 +27,7 @@ protected function getProvidedServiceNames(): array
     {
         return [
             'image_uploader',
+            ImageDownloader::class,
             'media_object_store',
             'media_object_repository',
             'media_object_iri_generator',
@@ -58,6 +60,21 @@ function () use ($container) {
             }
         );
 
+        $container->addShared(
+            ImageDownloader::class,
+            fn () => new GuzzleImageDownloader(
+                new Client([
+                    'timeout' => $container->get('config')['media']['timeout'] ?? 30,
+                    'connect_timeout' => $container->get('config')['media']['connect_timeout'] ?? 10,
+                    'allow_redirects' => [
+                        'max' => 3,
+                        'strict' => true,
+                    ],
+                ]),
+                $container->get('config')['media']['file_size_limit'] ?? 1000000
+            )
+        );
+
         $container->addShared(
             'media_object_store',
             function () use ($container) {
@@ -168,6 +185,7 @@ function () use ($container) {
             function () use ($container) {
                 return new UploadMediaRequestHandler(
                     $container->get('image_uploader'),
+                    $container->get(ImageDownloader::class),
                     $container->get('media_object_iri_generator')
                 );
             }

composer.json

@@ -61,7 +61,7 @@
     "predis/predis": "~1.0",
     "psr/http-server-middleware": "^1.0",
     "psr/log": "^1.0",
-    "publiq/udb3-json-schemas": "dev-main",
+    "publiq/udb3-json-schemas": "dev-III-5017-docs",
     "ramsey/uuid": "^3.2.0",
     "rase/socket.io-emitter": "0.6.1",
     "sentry/sentry": "^3.6",

features/image/create.feature

@@ -6,7 +6,7 @@ Feature: Test the UDB3 image API
     And I am authorized as JWT provider user "centraal_beheerder"
     And I accept "application/json"
 
-   Scenario: Create image
+   Scenario: Create image via multiform
      Given I set the form data properties to:
         | description     | logo |
         | copyrightHolder | me   |
@@ -50,7 +50,7 @@ Feature: Test the UDB3 image API
      }
      """
 
-  Scenario: Create image without trailing slash in URL
+  Scenario: Create image via multiform without trailing slash in URL
     Given I set the form data properties to:
       | description     | logo |
       | copyrightHolder | me   |
@@ -93,3 +93,131 @@ Feature: Test the UDB3 image API
       "id": "%{image_id}"
      }
      """
+
+  Scenario: Create image via json body
+    Given I send and accept "application/json"
+    And I set the JSON request payload to:
+    """
+    {
+      "contentUrl": "http://io.uitdatabank.local/testfiles/publiq.png",
+      "description": "afbeelding via Json Body",
+      "copyrightHolder": "publiq",
+      "inLanguage": "nl"
+    }
+    """
+    And I send a POST request to "/images/"
+    Then the response status should be "201"
+    And I keep the value of the JSON response at "@id" as "image_@id"
+    And I keep the value of the JSON response at "imageId" as "image_id"
+    When I send a GET request to "/images/%{image_id}"
+    Then the response status should be "200"
+    And the JSON response should be:
+     """
+     {
+      "@id": "%{baseUrl}/images/%{image_id}",
+      "@type":"schema:ImageObject",
+      "contentUrl":"https://images.uitdatabank.dev/%{image_id}.png",
+      "thumbnailUrl":"https://images.uitdatabank.dev/%{image_id}.png",
+      "description":"afbeelding via Json Body",
+      "copyrightHolder":"publiq",
+      "inLanguage":"nl",
+      "id": "%{image_id}"
+     }
+     """
+
+  Scenario: Create image with unknown file extension
+    Given I send and accept "application/json"
+    And I set the JSON request payload to:
+    """
+    {
+      "contentUrl": "http://io.uitdatabank.local/testfiles/publiq",
+      "description": "afbeelding via Json Body",
+      "copyrightHolder": "publiq",
+      "inLanguage": "nl"
+    }
+    """
+    And I send a POST request to "/images/"
+    Then the response status should be "201"
+    And I keep the value of the JSON response at "@id" as "image_@id"
+    And I keep the value of the JSON response at "imageId" as "image_id"
+    When I send a GET request to "/images/%{image_id}"
+    Then the response status should be "200"
+    And the JSON response should be:
+     """
+     {
+      "@id": "%{baseUrl}/images/%{image_id}",
+      "@type":"schema:ImageObject",
+      "contentUrl":"https://images.uitdatabank.dev/%{image_id}.png",
+      "thumbnailUrl":"https://images.uitdatabank.dev/%{image_id}.png",
+      "description":"afbeelding via Json Body",
+      "copyrightHolder":"publiq",
+      "inLanguage":"nl",
+      "id": "%{image_id}"
+     }
+     """
+
+  Scenario: check for non image types
+    Given I send and accept "application/json"
+    And I set the JSON request payload to:
+    """
+    {
+      "contentUrl": "http://io.uitdatabank.local/testfiles/textfile",
+      "description": "afbeelding via Json Body",
+      "copyrightHolder": "publiq",
+      "inLanguage": "nl"
+    }
+    """
+    And I send a POST request to "/images/"
+    Then the response status should be "400"
+    And the JSON response should be:
+     """
+     {
+       "type":"https:\/\/api.publiq.be\/probs\/body\/file-invalid-type",
+       "title":"Invalid file type",
+       "status":400,
+       "detail":"The uploaded file has mime type \"text\/plain\" instead of image\/png,image\/jpeg,image\/gif"
+     }
+     """
+
+  Scenario: It handles non existing urls
+    Given I send and accept "application/json"
+    And I set the JSON request payload to:
+    """
+    {
+      "contentUrl": "http://io.uitdatabank.local/testfiles/thisDoesNotExist.png",
+      "description": "afbeelding via Json Body",
+      "copyrightHolder": "publiq",
+      "inLanguage": "nl"
+    }
+    """
+    And I send a POST request to "/images/"
+    Then the response status should be "400"
+    And the JSON response should be:
+     """
+     {
+       "type":"https:\/\/api.publiq.be\/probs\/body\/file-invalid-type",
+       "title":"Invalid file type",
+       "status":400,
+       "detail":"The file could not be downloaded correctly."
+     }
+     """
+
+  Scenario: It handles missing data
+    Given I send and accept "application/json"
+    And I set the JSON request payload to:
+    """
+    {
+      "contentUrl": "http://io.uitdatabank.local/testfiles/publiq.png"
+    }
+    """
+    And I send a POST request to "/images/"
+    Then the response status should be "400"
+    And the JSON response should be:
+     """
+     {
+       "type":"https:\/\/api.publiq.be\/probs\/body\/invalid-data",
+       "title":"Invalid body data",
+       "status":400,
+       "schemaErrors":[{"jsonPointer":"\/","error":"The required properties (description, copyrightHolder, inLanguage) are missing"}]
+     }
+     """

src/Http/Media/UploadMediaRequestHandler.php

@@ -5,12 +5,18 @@
 namespace CultuurNet\UDB3\Http\Media;
 
 use CultuurNet\UDB3\Http\ApiProblem\ApiProblem;
+use CultuurNet\UDB3\Http\Request\Body\JsonSchemaLocator;
+use CultuurNet\UDB3\Http\Request\Body\JsonSchemaValidatingRequestBodyParser;
+use CultuurNet\UDB3\Http\Request\Body\RequestBodyParserFactory;
 use CultuurNet\UDB3\Http\Response\JsonResponse;
 use CultuurNet\UDB3\Iri\IriGeneratorInterface;
+use CultuurNet\UDB3\Media\ImageDownloader;
 use CultuurNet\UDB3\Media\ImageUploaderInterface;
 use CultuurNet\UDB3\Media\Properties\Description;
+use CultuurNet\UDB3\Model\ValueObject\Identity\Uuid;
 use CultuurNet\UDB3\Model\ValueObject\MediaObject\CopyrightHolder;
 use CultuurNet\UDB3\Model\ValueObject\Translation\Language;
+use CultuurNet\UDB3\Model\ValueObject\Web\Url;
 use InvalidArgumentException;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -20,15 +26,42 @@
 final class UploadMediaRequestHandler implements RequestHandlerInterface
 {
     private ImageUploaderInterface $imageUploader;
+
+    private ImageDownloader $imageDownloader;
     private IriGeneratorInterface $iriGenerator;
 
-    public function __construct(ImageUploaderInterface $imageUploader, IriGeneratorInterface $iriGenerator)
-    {
+    public function __construct(
+        ImageUploaderInterface $imageUploader,
+        ImageDownloader $imageDownloader,
+        IriGeneratorInterface $iriGenerator
+    ) {
         $this->imageUploader = $imageUploader;
+        $this->imageDownloader = $imageDownloader;
         $this->iriGenerator = $iriGenerator;
     }
 
     public function handle(ServerRequestInterface $request): ResponseInterface
+    {
+        $contentTypeHeaders = $request->getHeader('Content-Type');
+        $isMultipart = !empty($contentTypeHeaders)
+            && isset($contentTypeHeaders[0])
+            && str_contains($contentTypeHeaders[0], 'multipart/form-data');
+        if ($isMultipart) {
+            $imageId = $this->handleFormData($request);
+        } else {
+            $imageId = $this->handleJsonBody($request);
+        }
+
+        return new JsonResponse(
+            [
+                '@id' => $this->iriGenerator->iri($imageId->toString()),
+                'imageId' => $imageId->toString(),
+            ],
+            201
+        );
+    }
+
+    private function handleFormData(ServerRequestInterface $request): Uuid
     {
         $uploadedFiles = $request->getUploadedFiles();
         if (!isset($uploadedFiles['file']) || !$uploadedFiles['file'] instanceof UploadedFileInterface) {
@@ -69,19 +102,35 @@ public function handle(ServerRequestInterface $request): ResponseInterface
             throw ApiProblem::bodyInvalidDataWithDetail('Form data field "language" is must be exactly 2 lowercase letters long (for example "nl").');
         }
 
-        $imageId = $this->imageUploader->upload(
+        return $this->imageUploader->upload(
             $uploadedFile,
             new Description($description),
             $copyrightHolder,
             $language
         );
+    }
+
+    private function handleJsonBody(ServerRequestInterface $request): Uuid
+    {
+        $parser = RequestBodyParserFactory::createBaseParser(
+            new JsonSchemaValidatingRequestBodyParser(JsonSchemaLocator::IMAGE_POST)
+        );
 
-        return new JsonResponse(
-            [
-                '@id' => $this->iriGenerator->iri($imageId->toString()),
-                'imageId' => $imageId->toString(),
-            ],
-            201
+        /** @var \stdClass $data */
+        $data = $parser->parse($request)->getParsedBody();
+
+        $contentUrl = new Url($data->contentUrl);
+        $description = new Description($data->description);
+        $copyrightHolder = new CopyrightHolder($data->copyrightHolder);
+        $language = new Language($data->inLanguage);
+
+        $uploadedFile = $this->imageDownloader->download($contentUrl);
+
+        return $this->imageUploader->upload(
+            $uploadedFile,
+            $description,
+            $copyrightHolder,
+            $language
         );
     }
 }

src/Http/Request/Body/JsonSchemaLocator.php

@@ -79,6 +79,8 @@ final class JsonSchemaLocator
 
     public const NEWS_ARTICLE_POST = 'newsArticle-post.json';
 
+    public const IMAGE_POST = 'image-post.json';
+
     public static function setSchemaDirectory(string $schemaDirectory): void
     {
         if (!is_dir($schemaDirectory)) {