X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/1859c7917ff11230a0d364dd592c1fb325e8e40a..refs/pull/3579/head:/app/Http/Controllers/Api/BookshelfApiController.php

diff --git a/app/Http/Controllers/Api/BookshelfApiController.php b/app/Http/Controllers/Api/BookshelfApiController.php
index e6379fdec..620df1638 100644
--- a/app/Http/Controllers/Api/BookshelfApiController.php
+++ b/app/Http/Controllers/Api/BookshelfApiController.php
@@ -1,35 +1,20 @@
-<?php namespace BookStack\Http\Controllers\Api;
+<?php
 
-use BookStack\Facades\Activity;
+namespace BookStack\Http\Controllers\Api;
+
+use BookStack\Entities\Models\Bookshelf;
 use BookStack\Entities\Repos\BookshelfRepo;
-use BookStack\Entities\Bookshelf;
 use Exception;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 
-
 class BookshelfApiController extends ApiController
 {
-
-    /**
-     * @var BookshelfRepo
-     */
-    protected $bookshelfRepo;
-
-    protected $rules = [
-        'create' => [
-            'name' => 'required|string|max:255',
-            'description' => 'string|max:1000',
-        ],
-        'update' => [
-            'name' => 'string|min:1|max:255',
-            'description' => 'string|max:1000',
-        ],
-    ];
+    protected BookshelfRepo $bookshelfRepo;
 
     /**
      * BookshelfApiController constructor.
-     * @param BookshelfRepo $bookshelfRepo
      */
     public function __construct(BookshelfRepo $bookshelfRepo)
     {
@@ -42,24 +27,28 @@ class BookshelfApiController extends ApiController
     public function list()
     {
         $shelves = Bookshelf::visible();
+
         return $this->apiListingResponse($shelves, [
-            'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'image_id',
+            'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'owned_by',
         ]);
     }
 
     /**
      * Create a new shelf in the system.
+     * An array of books IDs can be provided in the request. These
+     * will be added to the shelf in the same order as provided.
+     * The cover image of a shelf can be set by sending a file via an 'image' property within a 'multipart/form-data' request.
+     * If the 'image' property is null then the shelf cover image will be removed.
+     *
      * @throws ValidationException
      */
     public function create(Request $request)
     {
         $this->checkPermission('bookshelf-create-all');
-        $requestData = $this->validate($request, $this->rules['create']);
+        $requestData = $this->validate($request, $this->rules()['create']);
 
         $bookIds = $request->get('books', []);
-
-        $shelf = $this->bookshelfRepo->create($requestData,$bookIds);
-        Activity::add($shelf, 'bookshelf_create', $shelf->id);
+        $shelf = $this->bookshelfRepo->create($requestData, $bookIds);
 
         return response()->json($shelf);
     }
@@ -69,12 +58,24 @@ class BookshelfApiController extends ApiController
      */
     public function read(string $id)
     {
-        $shelf = Bookshelf::visible()->with(['tags', 'cover', 'createdBy', 'updatedBy'])->findOrFail($id);
+        $shelf = Bookshelf::visible()->with([
+            'tags', 'cover', 'createdBy', 'updatedBy', 'ownedBy',
+            'books' => function (BelongsToMany $query) {
+                $query->scopes('visible')->get(['id', 'name', 'slug']);
+            },
+        ])->findOrFail($id);
+
         return response()->json($shelf);
     }
 
     /**
      * Update the details of a single shelf.
+     * An array of books IDs can be provided in the request. These
+     * will be added to the shelf in the same order as provided and overwrite
+     * any existing book assignments.
+     * The cover image of a shelf can be set by sending a file via an 'image' property within a 'multipart/form-data' request.
+     * If the 'image' property is null then the shelf cover image will be removed.
+     *
      * @throws ValidationException
      */
     public function update(Request $request, string $id)
@@ -82,22 +83,18 @@ class BookshelfApiController extends ApiController
         $shelf = Bookshelf::visible()->findOrFail($id);
         $this->checkOwnablePermission('bookshelf-update', $shelf);
 
-        $requestData = $this->validate($request, $this->rules['update']);
+        $requestData = $this->validate($request, $this->rules()['update']);
+        $bookIds = $request->get('books', null);
 
-        $bookIds = $request->get('books', []);
-
-        $shelf = $this->bookshelfRepo->update($shelf, $requestData,$bookIds);
-        Activity::add($shelf, 'bookshelf_update', $shelf->id);
+        $shelf = $this->bookshelfRepo->update($shelf, $requestData, $bookIds);
 
         return response()->json($shelf);
     }
 
-
-
     /**
-     * Delete a single shelf from the system.
-     * @param string $id
-     * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\Response
+     * Delete a single shelf.
+     * This will typically send the shelf to the recycle bin.
+     *
      * @throws Exception
      */
     public function delete(string $id)
@@ -106,8 +103,27 @@ class BookshelfApiController extends ApiController
         $this->checkOwnablePermission('bookshelf-delete', $shelf);
 
         $this->bookshelfRepo->destroy($shelf);
-        Activity::addMessage('bookshelf-delete', $shelf->name);
 
         return response('', 204);
     }
-}
\ No newline at end of file
+
+    protected function rules(): array
+    {
+        return [
+            'create' => [
+                'name'        => ['required', 'string', 'max:255'],
+                'description' => ['string', 'max:1000'],
+                'books'       => ['array'],
+                'tags'        => ['array'],
+                'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
+            ],
+            'update' => [
+                'name'        => ['string', 'min:1', 'max:255'],
+                'description' => ['string', 'max:1000'],
+                'books'       => ['array'],
+                'tags'        => ['array'],
+                'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
+            ],
+        ];
+    }
+}