Add an image too large error (#1019)

Author: BentiGorlich

src/Controller/Entry/EntryCreateController.php

@@ -7,6 +7,7 @@
 use App\Controller\AbstractController;
 use App\DTO\EntryDto;
 use App\Entity\Magazine;
+use App\Exception\ImageDownloadTooLargeException;
 use App\Exception\PostingRestrictedException;
 use App\Exception\TagBannedException;
 use App\PageView\EntryPageView;
@@ -16,19 +17,23 @@
 use App\Service\EntryCommentManager;
 use App\Service\EntryManager;
 use App\Service\IpResolver;
+use App\Service\SettingsManager;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Symfony\Component\Security\Http\Attribute\IsGranted;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 class EntryCreateController extends AbstractController
 {
     use EntryTemplateTrait;
     use EntryFormTrait;
 
     public function __construct(
+        private readonly TranslatorInterface $translator,
+        private readonly SettingsManager $settingsManager,
         private readonly LoggerInterface $logger,
         private readonly TagLinkRepository $tagLinkRepository,
         private readonly TagRepository $tagRepository,
@@ -45,6 +50,7 @@ public function __invoke(?Magazine $magazine, ?string $type, Request $request):
         $dto = new EntryDto();
         $dto->magazine = $magazine;
         $user = $this->getUserOrThrow();
+        $maxBytes = $this->settingsManager->getMaxImageByteString();
 
         $form = $this->createFormByType((new EntryPageView(1))->resolveType($type), $dto);
         try {
@@ -85,6 +91,7 @@ public function __invoke(?Magazine $magazine, ?string $type, Request $request):
                     'magazine' => $magazine,
                     'user' => $user,
                     'form' => $form->createView(),
+                    'maxSize' => $maxBytes,
                 ],
                 new Response(null, $form->isSubmitted() && !$form->isValid() ? 422 : 200)
             );
@@ -99,6 +106,7 @@ public function __invoke(?Magazine $magazine, ?string $type, Request $request):
                     'magazine' => $magazine,
                     'user' => $user,
                     'form' => $form->createView(),
+                    'maxSize' => $maxBytes,
                 ],
                 new Response(null, 422)
             );
@@ -112,6 +120,21 @@ public function __invoke(?Magazine $magazine, ?string $type, Request $request):
                     'magazine' => $magazine,
                     'user' => $user,
                     'form' => $form->createView(),
+                    'maxSize' => $maxBytes,
+                ],
+                new Response(null, 422)
+            );
+        } catch (ImageDownloadTooLargeException $e) {
+            $this->addFlash('error', $this->translator->trans('flash_image_download_too_large_error', ['%bytes%' => $maxBytes]));
+            $this->logger->error($e);
+
+            return $this->render(
+                $this->getTemplateName((new EntryPageView(1))->resolveType($type)),
+                [
+                    'magazine' => $magazine,
+                    'user' => $user,
+                    'form' => $form->createView(),
+                    'maxSize' => $maxBytes,
                 ],
                 new Response(null, 422)
             );
@@ -126,6 +149,7 @@ public function __invoke(?Magazine $magazine, ?string $type, Request $request):
                     'magazine' => $magazine,
                     'user' => $user,
                     'form' => $form->createView(),
+                    'maxSize' => $maxBytes,
                 ],
                 new Response(null, 422)
             );

src/Controller/Entry/EntryEditController.php

@@ -10,6 +10,7 @@
 use App\Entity\Magazine;
 use App\Form\EntryEditType;
 use App\Service\EntryManager;
+use App\Service\SettingsManager;
 use Psr\Log\LoggerInterface;
 use Symfony\Bridge\Doctrine\Attribute\MapEntity;
 use Symfony\Component\HttpFoundation\Request;
@@ -24,6 +25,7 @@ class EntryEditController extends AbstractController
     public function __construct(
         private readonly EntryManager $manager,
         private readonly LoggerInterface $logger,
+        private readonly SettingsManager $settingsManager,
     ) {
     }
 
@@ -37,6 +39,7 @@ public function __invoke(
         Request $request
     ): Response {
         $dto = $this->manager->createDto($entry);
+        $maxBytes = $this->settingsManager->getMaxImageByteString();
 
         $form = $this->createForm(EntryEditType::class, $dto);
         try {
@@ -66,6 +69,7 @@ public function __invoke(
                 'magazine' => $magazine,
                 'entry' => $entry,
                 'form' => $form->createView(),
+                'maxSize' => $maxBytes,
             ],
             new Response(null, $form->isSubmitted() && !$form->isValid() ? 422 : 200)
         );

src/Repository/ImageRepository.php

@@ -37,9 +37,9 @@ public function __construct(
     /**
      * Process and store an uploaded image.
      *
-     * @param upload file path of uploaded image
+     * @param $upload UploadedFile file path of uploaded image
      *
-     * @throws RuntimeException if image type can't be identified
+     * @throws \RuntimeException if image type can't be identified
      */
     public function findOrCreateFromUpload(UploadedFile $upload): ?Image
     {
@@ -49,9 +49,10 @@ public function findOrCreateFromUpload(UploadedFile $upload): ?Image
     /**
      * Process and store an image from source path.
      *
-     * @param source file path of the image
+     * @param $source string file path of the image
      *
-     * @throws RuntimeException if image type can't be identified
+     * @throws \RuntimeException              if image type can't be identified
+     * @throws ImageDownloadTooLargeException
      */
     public function findOrCreateFromPath(string $source): ?Image
     {
@@ -63,6 +64,8 @@ public function findOrCreateFromPath(string $source): ?Image
      *
      * @param string      $source file path of the image
      * @param ImageOrigin $origin where the image comes from
+     *
+     * @throws ImageDownloadTooLargeException
      */
     private function findOrCreateFromSource(string $source, ImageOrigin $origin): ?Image
     {
@@ -108,9 +111,10 @@ private function findOrCreateFromSource(string $source, ImageOrigin $origin): ?I
                 return $image;
             } else {
                 $this->logger->error(
-                    'findOrCreateFromSource: failed to store image file, because it is too big',
-                    ['origin' => $origin, 'type' => \gettype($e)],
+                    'findOrCreateFromSource: failed to store image file, because it is too big - {msg}',
+                    ['origin' => $origin, 'type' => \gettype($e), 'msg' => $e->getMessage()],
                 );
+                throw $e;
             }
         } catch (\Exception $e) {
             $this->logger->error(

templates/layout/_form_media.html.twig

@@ -7,6 +7,9 @@
         {% if form.image is defined %}
             {{ form_row(form.image, {label: 'image', attr: {class: 'image-input'}}) }}
         {% endif %}
+        {% if maxSize is defined %}
+            <div>{{ 'max_image_size'|trans }}: {{ maxSize }}</div>
+        {% endif %}
         <div hidden>
             {{ form_row(form.imageUrl, {label: 'url'}) }}
         </div>

translations/messages.en.yaml

@@ -743,6 +743,7 @@ position_top: Top
 pending: Pending
 flash_thread_new_error: Thread could not be created. Something went wrong.
 flash_thread_tag_banned_error: Thread could not be created. The content is not allowed.
+flash_image_download_too_large_error: Image could not be created, it is too big (max size %bytes%)
 flash_email_was_sent: Email has been successfully sent.
 flash_email_failed_to_sent: Email could not be sent.
 flash_post_new_success: Post has been successfully created.
@@ -887,3 +888,4 @@ admin_users_inactive: Inactive
 admin_users_suspended: Suspended
 admin_users_banned: Banned
 user_verify: Activate account
+max_image_size: Maximum file size