Extend /users API endpoint

[bookstack] / app / Uploads / ImageRepo.php

diff --git a/app/Uploads/ImageRepo.php b/app/Uploads/ImageRepo.php
index c13d995bdae266f6e2fedbb2e4bb5d04e2d3ce3c..e6f7668241dafa4dcfad7a0b852bfc6d214904c8 100644 (file)
--- a/app/Uploads/ImageRepo.php
+++ b/app/Uploads/ImageRepo.php
@@ -1,8 +1,10 @@
 <?php namespace BookStack\Uploads;
 
 use BookStack\Auth\Permissions\PermissionService;
 <?php namespace BookStack\Uploads;
 
 use BookStack\Auth\Permissions\PermissionService;

-use BookStack\Entities\Page;
-use BookStack\Http\Requests\Request;
+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 Symfony\Component\HttpFoundation\File\UploadedFile;
 
 class ImageRepo


@@ -15,13 +17,13 @@ class ImageRepo
 
     /**
      * 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)
-    {
+    public function __construct(
+        Image $image,
+        ImageService $imageService,
+        PermissionService $permissionService,
+        Page $page
+    ) {

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


@@ -31,10 +33,8 @@ class ImageRepo
 
     /**
      * Get an image with the given id.
 
     /**
      * Get an image with the given id.

-     * @param $id
-     * @return mixed

      */
      */

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

     {
         return $this->image->findOrFail($id);
     }
     {
         return $this->image->findOrFail($id);
     }


@@ -42,140 +42,111 @@ class ImageRepo
     /**
      * 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 = 0, $pageSize = 24)
+    private function returnPaginated($query, $page = 1, $pageSize = 24): array

     {
     {

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

         $hasMore = count($images) > $pageSize;
 
         $hasMore = count($images) > $pageSize;
 

-        $returnImages = $images->take(24);
+        $returnImages = $images->take($pageSize);

         $returnImages->each(function ($image) {
             $this->loadThumbs($image);
         });
 
         return [
             'images'  => $returnImages,
         $returnImages->each(function ($image) {
             $this->loadThumbs($image);
         });
 
         return [
             'images'  => $returnImages,

-            'hasMore' => $hasMore
+            'has_more' => $hasMore

         ];
     }
 
     /**
         ];
     }
 
     /**

-     * Gets a load images paginated, filtered by image type.
-     * @param string $type
-     * @param int $page
-     * @param int $pageSize
-     * @param int $uploadedTo
-     * @return array
+     * Fetch a list of images in a paginated format, filtered by image type.
+     * Can be filtered by uploaded to and also by name.

      */
      */

-    public function getPaginatedByType(string $type, int $page = 0, int $pageSize = 24, int $uploadedTo = null)
-    {
-        $images = $this->image->newQuery()->where('type', '=', strtolower($type));
+    public function getPaginatedByType(
+        string $type,
+        int $page = 0,
+        int $pageSize = 24,
+        int $uploadedTo = null,
+        string $search = null,
+        callable $whereClause = null
+    ): array {
+        $imageQuery = $this->image->newQuery()->where('type', '=', strtolower($type));

 
         if ($uploadedTo !== null) {
 
         if ($uploadedTo !== null) {

-            $images = $images->where('uploaded_to', '=', $uploadedTo);
+            $imageQuery = $imageQuery->where('uploaded_to', '=', $uploadedTo);

         }
 
         }
 

-        // Filter by page access if gallery
-        if ($type === 'gallery') {
-            $images = $this->restrictionService->filterRelatedPages($images, 'images', 'uploaded_to');
+        if ($search !== null) {
+            $imageQuery = $imageQuery->where('name', 'LIKE', '%' . $search . '%');

         }
 
         }
 

-        return $this->returnPaginated($images, $page, $pageSize);
-    }
+        // Filter by page access
+        $imageQuery = $this->restrictionService->filterRelatedEntity(Page::class, $imageQuery, 'images', 'uploaded_to');

 
 

-    /**
-     * Search for images by query, of a particular type.
-     * @param string $type
-     * @param int $page
-     * @param int $pageSize
-     * @param string $searchTerm
-     * @return array
-     */
-    public function searchPaginatedByType(Request $request, $type, $searchTerm, $page = 0, $pageSize = 24)
-    {
-        // TODO - Filter by uploaded_to
-        $images = $this->image->newQuery()
-            ->where('type', '=', strtolower($type))
-            ->where('name', 'LIKE', '%' . $searchTerm . '%');
-
-        if ($type === 'gallery') {
-            $images = $this->restrictionService->filterRelatedPages($images, 'images', 'uploaded_to');
+        if ($whereClause !== null) {
+            $imageQuery = $imageQuery->where($whereClause);

         }
 
         }
 

-        return $this->returnPaginated($images, $page, $pageSize);
+        return $this->returnPaginated($imageQuery, $page, $pageSize);

     }
 
     /**
     }
 
     /**

-     * Get gallery images with a particular filter criteria such as
-     * being within the current book or page.
-     * @param $filter
-     * @param $pageId
-     * @param int $pageNum
-     * @param int $pageSize
-     * @return array
+     * Get paginated gallery images within a specific page or book.

      */
      */

-    public function getGalleryFiltered($filter, $pageId, $pageNum = 0, $pageSize = 24)
-    {
-        $images = $this->image->where('type', '=', 'gallery');
-
-        $page = $this->page->findOrFail($pageId);
-
-        if ($filter === 'page') {
-            $images = $images->where('uploaded_to', '=', $page->id);
-        } elseif ($filter === 'book') {
-            $validPageIds = $page->book->pages->pluck('id')->toArray();
-            $images = $images->whereIn('uploaded_to', $validPageIds);
+    public function getEntityFiltered(
+        string $type,
+        string $filterType = null,
+        int $page = 0,
+        int $pageSize = 24,
+        int $uploadedTo = null,
+        string $search = null
+    ): array {
+        $contextPage = $this->page->findOrFail($uploadedTo);
+        $parentFilter = null;
+
+        if ($filterType === 'book' || $filterType === 'page') {
+            $parentFilter = function (Builder $query) use ($filterType, $contextPage) {
+                if ($filterType === 'page') {
+                    $query->where('uploaded_to', '=', $contextPage->id);
+                } elseif ($filterType === 'book') {
+                    $validPageIds = $contextPage->book->pages()->visible()->get(['id'])->pluck('id')->toArray();
+                    $query->whereIn('uploaded_to', $validPageIds);
+                }
+            };

         }
 
         }
 

-        $images = $this->restrictionService->filterRelatedPages($images, 'images', 'uploaded_to');
-        return $this->returnPaginated($images, $pageNum, $pageSize);
+        return $this->getPaginatedByType($type, $page, $pageSize, null, $search, $parentFilter);

     }
 
     /**
      * 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
-     * @return Image
-     * @throws \BookStack\Exceptions\ImageUploadException
-     * @throws \Exception
+     * @throws ImageUploadException

      */
      */

-    public function saveNew(UploadedFile $uploadFile, $type, $uploadedTo = 0)
+    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);
+        $image = $this->imageService->saveNewFromUpload($uploadFile, $type, $uploadedTo, $resizeWidth, $resizeHeight, $keepRatio);

         $this->loadThumbs($image);
         return $image;
     }
 
     /**
         $this->loadThumbs($image);
         return $image;
     }
 
     /**

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

      */
      */

-    public function saveDrawing(string $base64Uri, int $uploadedTo)
+    public function saveDrawing(string $base64Uri, int $uploadedTo): Image

     {
     {

-        $name = 'Drawing-' . user()->getShortName(40) . '-' . strval(time()) . '.png';
-        $image = $this->imageService->saveNewFromBase64Uri($base64Uri, $name, 'drawio', $uploadedTo);
-        return $image;
+        $name = 'Drawing-' . strval(user()->id) . '-' . strval(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 ImageUploadException
+     * @throws Exception

      */
      */

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

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


@@ -183,31 +154,40 @@ class ImageRepo
         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)
+    public function destroyImage(Image $image = null): bool

     {
     {

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

         return true;
     }
 
         return true;
     }
 

+    /**
+     * Destroy all images of a certain type.
+     * @throws Exception
+     */
+    public function destroyByType(string $imageType)
+    {
+        $images = $this->image->where('type', '=', $imageType)->get();
+        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
+     * @throws Exception

      */
      */

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

     {
         $image->thumbs = [
     {
         $image->thumbs = [

-            'gallery' => $this->getThumbnail($image, 150, 150),
-            'display' => $this->getThumbnail($image, 840, 0, true)
+            'gallery' => $this->getThumbnail($image, 150, 150, false),
+            'display' => $this->getThumbnail($image, 1680, null, true)

         ];
     }
 
         ];
     }
 


@@ -215,45 +195,42 @@ class ImageRepo
      * 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
+     * @throws Exception

      */
      */

-    public function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false)
+    protected function getThumbnail(Image $image, ?int $width = 220, ?int $height = 220, bool $keepRatio = false): ?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;
         }
     }
 
     /**

-     * Check if the provided image type is valid.
-     * @param $type
-     * @return bool
+     * Get the user visible pages using the given image.

      */
      */

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

     {
     {

-        $validTypes = ['gallery', 'cover', 'system', 'user'];
-        return in_array($type, $validTypes);
+        $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();

     }
 }
     }
 }