Applied StyleCI changes, added php/larastan to attribution

[bookstack] / app / Uploads / ImageRepo.php

diff --git a/app/Uploads/ImageRepo.php b/app/Uploads/ImageRepo.php
index 38dd3066b2c5a7b0deb835aa8e9e7a0444e0a9ab..2a4ea424f395ca6281ee181324d62ff6ac86600d 100644 (file)
--- a/app/Uploads/ImageRepo.php
+++ b/app/Uploads/ImageRepo.php
@@ -1,83 +1,59 @@
-<?php namespace BookStack\Uploads;
+<?php
+
+namespace BookStack\Uploads;

 
 use BookStack\Auth\Permissions\PermissionService;
 
 use BookStack\Auth\Permissions\PermissionService;

-use BookStack\Entities\Page;
+use BookStack\Entities\Models\Page;
+use BookStack\Exceptions\ImageUploadException;
+use Exception;

 use Illuminate\Database\Eloquent\Builder;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
 class ImageRepo
 {
 use Illuminate\Database\Eloquent\Builder;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
 class ImageRepo
 {

-
-    protected $image;

     protected $imageService;
     protected $restrictionService;
     protected $imageService;
     protected $restrictionService;

-    protected $page;

 
     /**
      * ImageRepo constructor.
 
     /**
      * ImageRepo constructor.

-     * @param Image $image
-     * @param ImageService $imageService
-     * @param \BookStack\Auth\Permissions\PermissionService $permissionService
-     * @param \BookStack\Entities\Page $page

      */
      */

-    public function __construct(
-        Image $image,
-        ImageService $imageService,
-        PermissionService $permissionService,
-        Page $page
-    ) {
-        $this->image = $image;
+    public function __construct(ImageService $imageService, PermissionService $permissionService)
+    {

         $this->imageService = $imageService;
         $this->restrictionService = $permissionService;
         $this->imageService = $imageService;
         $this->restrictionService = $permissionService;

-        $this->page = $page;

     }
 
     }
 

-

     /**
      * Get an image with the given id.
     /**
      * Get an image with the given id.

-     * @param $id
-     * @return Image

      */
      */

-    public function getById($id)
+    public function getById($id): Image

     {
     {

-        return $this->image->findOrFail($id);
+        return Image::query()->findOrFail($id);

     }
 
     /**
      * Execute a paginated query, returning in a standard format.
      * Also runs the query through the restriction system.
     }
 
     /**
      * Execute a paginated query, returning in a standard format.
      * Also runs the query through the restriction system.

-     * @param $query
-     * @param int $page
-     * @param int $pageSize
-     * @param bool $filterOnPage
-     * @return array

      */
      */

-    private function returnPaginated($query, $page = 1, $pageSize = 24)
+    private function returnPaginated($query, $page = 1, $pageSize = 24): array

     {
         $images = $query->orderBy('created_at', 'desc')->skip($pageSize * ($page - 1))->take($pageSize + 1)->get();
         $hasMore = count($images) > $pageSize;
 
         $returnImages = $images->take($pageSize);
     {
         $images = $query->orderBy('created_at', 'desc')->skip($pageSize * ($page - 1))->take($pageSize + 1)->get();
         $hasMore = count($images) > $pageSize;
 
         $returnImages = $images->take($pageSize);

-        $returnImages->each(function ($image) {
+        $returnImages->each(function (Image $image) {

             $this->loadThumbs($image);
         });
 
         return [
             $this->loadThumbs($image);
         });
 
         return [

-            'images'  => $returnImages,
-            'has_more' => $hasMore
+            'images'   => $returnImages,
+            'has_more' => $hasMore,

         ];
     }
 
     /**
      * Fetch a list of images in a paginated format, filtered by image type.
      * Can be filtered by uploaded to and also by name.
         ];
     }
 
     /**
      * Fetch a list of images in a paginated format, filtered by image type.
      * Can be filtered by uploaded to and also by name.

-     * @param string $type
-     * @param int $page
-     * @param int $pageSize
-     * @param int $uploadedTo
-     * @param string|null $search
-     * @param callable|null $whereClause
-     * @return array

      */
     public function getPaginatedByType(
         string $type,
      */
     public function getPaginatedByType(
         string $type,


@@ -86,8 +62,8 @@ class ImageRepo
         int $uploadedTo = null,
         string $search = null,
         callable $whereClause = null
         int $uploadedTo = null,
         string $search = null,
         callable $whereClause = null

-    ) {
-        $imageQuery = $this->image->newQuery()->where('type', '=', strtolower($type));
+    ): array {
+        $imageQuery = Image::query()->where('type', '=', strtolower($type));

 
         if ($uploadedTo !== null) {
             $imageQuery = $imageQuery->where('uploaded_to', '=', $uploadedTo);
 
         if ($uploadedTo !== null) {
             $imageQuery = $imageQuery->where('uploaded_to', '=', $uploadedTo);


@@ -98,7 +74,7 @@ class ImageRepo
         }
 
         // Filter by page access
         }
 
         // Filter by page access

-        $imageQuery = $this->restrictionService->filterRelatedEntity('page', $imageQuery, 'images', 'uploaded_to');
+        $imageQuery = $this->restrictionService->filterRelatedEntity(Page::class, $imageQuery, 'images', 'uploaded_to');

 
         if ($whereClause !== null) {
             $imageQuery = $imageQuery->where($whereClause);
 
         if ($whereClause !== null) {
             $imageQuery = $imageQuery->where($whereClause);


@@ -109,13 +85,6 @@ class ImageRepo
 
     /**
      * Get paginated gallery images within a specific page or book.
 
     /**
      * Get paginated gallery images within a specific page or book.

-     * @param string $type
-     * @param string $filterType
-     * @param int $page
-     * @param int $pageSize
-     * @param int|null $uploadedTo
-     * @param string|null $search
-     * @return array

      */
     public function getEntityFiltered(
         string $type,
      */
     public function getEntityFiltered(
         string $type,


@@ -124,8 +93,9 @@ class ImageRepo
         int $pageSize = 24,
         int $uploadedTo = null,
         string $search = null
         int $pageSize = 24,
         int $uploadedTo = null,
         string $search = null

-    ) {
-        $contextPage = $this->page->findOrFail($uploadedTo);
+    ): array {
+        /** @var Page $contextPage */
+        $contextPage = Page::visible()->findOrFail($uploadedTo);

         $parentFilter = null;
 
         if ($filterType === 'book' || $filterType === 'page') {
         $parentFilter = null;
 
         if ($filterType === 'book' || $filterType === 'page') {


@@ -133,7 +103,7 @@ class ImageRepo
                 if ($filterType === 'page') {
                     $query->where('uploaded_to', '=', $contextPage->id);
                 } elseif ($filterType === 'book') {
                 if ($filterType === 'page') {
                     $query->where('uploaded_to', '=', $contextPage->id);
                 } elseif ($filterType === 'book') {

-                    $validPageIds = $contextPage->book->pages()->get(['id'])->pluck('id')->toArray();
+                    $validPageIds = $contextPage->book->pages()->visible()->pluck('id')->toArray();

                     $query->whereIn('uploaded_to', $validPageIds);
                 }
             };
                     $query->whereIn('uploaded_to', $validPageIds);
                 }
             };


@@ -144,137 +114,131 @@ class ImageRepo
 
     /**
      * Save a new image into storage and return the new image.
 
     /**
      * Save a new image into storage and return the new image.

-     * @param UploadedFile $uploadFile
-     * @param string $type
-     * @param int $uploadedTo
-     * @param int|null $resizeWidth
-     * @param int|null $resizeHeight
-     * @param bool $keepRatio
-     * @return Image
-     * @throws \BookStack\Exceptions\ImageUploadException
+     *
+     * @throws ImageUploadException

      */
      */

-    public function saveNew(UploadedFile $uploadFile, $type, $uploadedTo = 0, int $resizeWidth = null, int $resizeHeight = null, bool $keepRatio = true)
+    public function saveNew(UploadedFile $uploadFile, string $type, int $uploadedTo = 0, int $resizeWidth = null, int $resizeHeight = null, bool $keepRatio = true): Image

     {
         $image = $this->imageService->saveNewFromUpload($uploadFile, $type, $uploadedTo, $resizeWidth, $resizeHeight, $keepRatio);
         $this->loadThumbs($image);
     {
         $image = $this->imageService->saveNewFromUpload($uploadFile, $type, $uploadedTo, $resizeWidth, $resizeHeight, $keepRatio);
         $this->loadThumbs($image);

+

         return $image;
     }
 
     /**
         return $image;
     }
 
     /**

-     * Save a drawing the the database;
-     * @param string $base64Uri
-     * @param int $uploadedTo
-     * @return Image
-     * @throws \BookStack\Exceptions\ImageUploadException
+     * Save a new image from an existing image data string.
+     *
+     * @throws ImageUploadException

      */
      */

-    public function saveDrawing(string $base64Uri, int $uploadedTo)
+    public function saveNewFromData(string $imageName, string $imageData, string $type, int $uploadedTo = 0): Image

     {
     {

-        $name = 'Drawing-' . user()->getShortName(40) . '-' . strval(time()) . '.png';
-        $image = $this->imageService->saveNewFromBase64Uri($base64Uri, $name, 'drawio', $uploadedTo);
+        $image = $this->imageService->saveNew($imageName, $imageData, $type, $uploadedTo);
+        $this->loadThumbs($image);
+

         return $image;
     }
 
         return $image;
     }
 

+    /**
+     * Save a drawing in the database.
+     *
+     * @throws ImageUploadException
+     */
+    public function saveDrawing(string $base64Uri, int $uploadedTo): Image
+    {
+        $name = 'Drawing-' . user()->id . '-' . time() . '.png';
+
+        return $this->imageService->saveNewFromBase64Uri($base64Uri, $name, 'drawio', $uploadedTo);
+    }

 
     /**
      * Update the details of an image via an array of properties.
 
     /**
      * Update the details of an image via an array of properties.

-     * @param Image $image
-     * @param array $updateDetails
-     * @return Image
-     * @throws \BookStack\Exceptions\ImageUploadException
-     * @throws \Exception
+     *
+     * @throws Exception

      */
      */

-    public function updateImageDetails(Image $image, $updateDetails)
+    public function updateImageDetails(Image $image, $updateDetails): Image

     {
         $image->fill($updateDetails);
         $image->save();
         $this->loadThumbs($image);
     {
         $image->fill($updateDetails);
         $image->save();
         $this->loadThumbs($image);

+

         return $image;
     }
 
         return $image;
     }
 

-

     /**
      * Destroys an Image object along with its revisions, files and thumbnails.
     /**
      * Destroys an Image object along with its revisions, files and thumbnails.

-     * @param Image $image
-     * @return bool
-     * @throws \Exception
+     *
+     * @throws Exception

      */
      */

-    public function destroyImage(Image $image = null)
+    public function destroyImage(Image $image = null): void

     {
         if ($image) {
             $this->imageService->destroy($image);
         }
     {
         if ($image) {
             $this->imageService->destroy($image);
         }

-        return true;

     }
 
     /**
      * Destroy all images of a certain type.
     }
 
     /**
      * Destroy all images of a certain type.

-     * @param string $imageType
-     * @throws \Exception
+     *
+     * @throws Exception

      */
      */

-    public function destroyByType(string $imageType)
+    public function destroyByType(string $imageType): void

     {
     {

-        $images = $this->image->where('type', '=', $imageType)->get();
+        $images = Image::query()->where('type', '=', $imageType)->get();

         foreach ($images as $image) {
             $this->destroyImage($image);
         }
     }
 
         foreach ($images as $image) {
             $this->destroyImage($image);
         }
     }
 

-

     /**
      * Load thumbnails onto an image object.
     /**
      * Load thumbnails onto an image object.

-     * @param Image $image
-     * @throws \BookStack\Exceptions\ImageUploadException
-     * @throws \Exception

      */
      */

-    protected function loadThumbs(Image $image)
+    public function loadThumbs(Image $image): void

     {
     {

-        $image->thumbs = [
+        $image->setAttribute('thumbs', [

             'gallery' => $this->getThumbnail($image, 150, 150, false),
             'gallery' => $this->getThumbnail($image, 150, 150, false),

-            'display' => $this->getThumbnail($image, 840, null, true)
-        ];
+            'display' => $this->getThumbnail($image, 1680, null, true),
+        ]);

     }
 
     /**
      * Get the thumbnail for an image.
      * If $keepRatio is true only the width will be used.
      * Checks the cache then storage to avoid creating / accessing the filesystem on every check.
     }
 
     /**
      * Get the thumbnail for an image.
      * If $keepRatio is true only the width will be used.
      * Checks the cache then storage to avoid creating / accessing the filesystem on every check.

-     * @param Image $image
-     * @param int $width
-     * @param int $height
-     * @param bool $keepRatio
-     * @return string
-     * @throws \BookStack\Exceptions\ImageUploadException
-     * @throws \Exception

      */
      */

-    protected function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false)
+    protected function getThumbnail(Image $image, ?int $width, ?int $height, bool $keepRatio): ?string

     {
         try {
             return $this->imageService->getThumbnail($image, $width, $height, $keepRatio);
     {
         try {
             return $this->imageService->getThumbnail($image, $width, $height, $keepRatio);

-        } catch (\Exception $exception) {
+        } catch (Exception $exception) {

             return null;
         }
     }
 
     /**
      * Get the raw image data from an Image.
             return null;
         }
     }
 
     /**
      * Get the raw image data from an Image.

-     * @param Image $image
-     * @return null|string

      */
      */

-    public function getImageData(Image $image)
+    public function getImageData(Image $image): ?string

     {
         try {
             return $this->imageService->getImageData($image);
     {
         try {
             return $this->imageService->getImageData($image);

-        } catch (\Exception $exception) {
+        } catch (Exception $exception) {

             return null;
         }
     }
 
     /**
             return null;
         }
     }
 
     /**

-     * Get the validation rules for image files.
-     * @return string
+     * Get the user visible pages using the given image.

      */
      */

-    public function getImageValidationRules()
+    public function getPagesUsingImage(Image $image): array

     {
     {

-        return 'image_extension|no_double_extension|mimes:jpeg,png,gif,bmp,webp,tiff';
+        $pages = Page::visible()
+            ->where('html', 'like', '%' . $image->url . '%')
+            ->get(['id', 'name', 'slug', 'book_id']);
+
+        foreach ($pages as $page) {
+            $page->url = $page->getUrl();
+        }
+
+        return $pages->all();

     }
 }
     }
 }