ZIP Imports: Added API examples, finished testing

[bookstack] / app / Entities / Controllers / BookController.php

diff --git a/app/Entities/Controllers/BookController.php b/app/Entities/Controllers/BookController.php
index a956a47d64ffc6659a20888549dde9cb27f4c999..5d3d67f645c36afbf66599a7cabd0558096835b3 100644 (file)
--- a/app/Entities/Controllers/BookController.php
+++ b/app/Entities/Controllers/BookController.php
@@ -6,8 +6,8 @@ use BookStack\Activity\ActivityQueries;
 use BookStack\Activity\ActivityType;
 use BookStack\Activity\Models\View;
 use BookStack\Activity\Tools\UserEntityWatchOptions;
 use BookStack\Activity\ActivityType;
 use BookStack\Activity\Models\View;
 use BookStack\Activity\Tools\UserEntityWatchOptions;

-use BookStack\Entities\Models\Bookshelf;

 use BookStack\Entities\Queries\BookQueries;
 use BookStack\Entities\Queries\BookQueries;

+use BookStack\Entities\Queries\BookshelfQueries;

 use BookStack\Entities\Repos\BookRepo;
 use BookStack\Entities\Tools\BookContents;
 use BookStack\Entities\Tools\Cloner;
 use BookStack\Entities\Repos\BookRepo;
 use BookStack\Entities\Tools\BookContents;
 use BookStack\Entities\Tools\Cloner;


@@ -18,6 +18,7 @@ use BookStack\Exceptions\NotFoundException;
 use BookStack\Facades\Activity;
 use BookStack\Http\Controller;
 use BookStack\References\ReferenceFetcher;
 use BookStack\Facades\Activity;
 use BookStack\Http\Controller;
 use BookStack\References\ReferenceFetcher;

+use BookStack\Util\DatabaseTransaction;

 use BookStack\Util\SimpleListOptions;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 use BookStack\Util\SimpleListOptions;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;


@@ -29,6 +30,7 @@ class BookController extends Controller
         protected ShelfContext $shelfContext,
         protected BookRepo $bookRepo,
         protected BookQueries $queries,
         protected ShelfContext $shelfContext,
         protected BookRepo $bookRepo,
         protected BookQueries $queries,

+        protected BookshelfQueries $shelfQueries,

         protected ReferenceFetcher $referenceFetcher,
     ) {
     }
         protected ReferenceFetcher $referenceFetcher,
     ) {
     }


@@ -69,13 +71,13 @@ class BookController extends Controller
     /**
      * Show the form for creating a new book.
      */
     /**
      * Show the form for creating a new book.
      */

-    public function create(string $shelfSlug = null)
+    public function create(?string $shelfSlug = null)

     {
         $this->checkPermission('book-create-all');
 
         $bookshelf = null;
         if ($shelfSlug !== null) {
     {
         $this->checkPermission('book-create-all');
 
         $bookshelf = null;
         if ($shelfSlug !== null) {

-            $bookshelf = Bookshelf::visible()->where('slug', '=', $shelfSlug)->firstOrFail();
+            $bookshelf = $this->shelfQueries->findVisibleBySlugOrFail($shelfSlug);

             $this->checkOwnablePermission('bookshelf-update', $bookshelf);
         }
 
             $this->checkOwnablePermission('bookshelf-update', $bookshelf);
         }
 


@@ -92,7 +94,7 @@ class BookController extends Controller
      * @throws ImageUploadException
      * @throws ValidationException
      */
      * @throws ImageUploadException
      * @throws ValidationException
      */

-    public function store(Request $request, string $shelfSlug = null)
+    public function store(Request $request, ?string $shelfSlug = null)

     {
         $this->checkPermission('book-create-all');
         $validated = $this->validate($request, [
     {
         $this->checkPermission('book-create-all');
         $validated = $this->validate($request, [


@@ -105,7 +107,7 @@ class BookController extends Controller
 
         $bookshelf = null;
         if ($shelfSlug !== null) {
 
         $bookshelf = null;
         if ($shelfSlug !== null) {

-            $bookshelf = Bookshelf::visible()->where('slug', '=', $shelfSlug)->firstOrFail();
+            $bookshelf = $this->shelfQueries->findVisibleBySlugOrFail($shelfSlug);

             $this->checkOwnablePermission('bookshelf-update', $bookshelf);
         }
 
             $this->checkOwnablePermission('bookshelf-update', $bookshelf);
         }
 


@@ -124,7 +126,7 @@ class BookController extends Controller
      */
     public function show(Request $request, ActivityQueries $activities, string $slug)
     {
      */
     public function show(Request $request, ActivityQueries $activities, string $slug)
     {

-        $book = $this->queries->findVisibleBySlug($slug);
+        $book = $this->queries->findVisibleBySlugOrFail($slug);

         $bookChildren = (new BookContents($book))->getTree(true);
         $bookParentShelves = $book->shelves()->scopes('visible')->get();
 
         $bookChildren = (new BookContents($book))->getTree(true);
         $bookParentShelves = $book->shelves()->scopes('visible')->get();
 


@@ -151,7 +153,7 @@ class BookController extends Controller
      */
     public function edit(string $slug)
     {
      */
     public function edit(string $slug)
     {

-        $book = $this->queries->findVisibleBySlug($slug);
+        $book = $this->queries->findVisibleBySlugOrFail($slug);

         $this->checkOwnablePermission('book-update', $book);
         $this->setPageTitle(trans('entities.books_edit_named', ['bookName' => $book->getShortName()]));
 
         $this->checkOwnablePermission('book-update', $book);
         $this->setPageTitle(trans('entities.books_edit_named', ['bookName' => $book->getShortName()]));
 


@@ -167,7 +169,7 @@ class BookController extends Controller
      */
     public function update(Request $request, string $slug)
     {
      */
     public function update(Request $request, string $slug)
     {

-        $book = $this->queries->findVisibleBySlug($slug);
+        $book = $this->queries->findVisibleBySlugOrFail($slug);

         $this->checkOwnablePermission('book-update', $book);
 
         $validated = $this->validate($request, [
         $this->checkOwnablePermission('book-update', $book);
 
         $validated = $this->validate($request, [


@@ -194,7 +196,7 @@ class BookController extends Controller
      */
     public function showDelete(string $bookSlug)
     {
      */
     public function showDelete(string $bookSlug)
     {

-        $book = $this->queries->findVisibleBySlug($bookSlug);
+        $book = $this->queries->findVisibleBySlugOrFail($bookSlug);

         $this->checkOwnablePermission('book-delete', $book);
         $this->setPageTitle(trans('entities.books_delete_named', ['bookName' => $book->getShortName()]));
 
         $this->checkOwnablePermission('book-delete', $book);
         $this->setPageTitle(trans('entities.books_delete_named', ['bookName' => $book->getShortName()]));
 


@@ -208,7 +210,7 @@ class BookController extends Controller
      */
     public function destroy(string $bookSlug)
     {
      */
     public function destroy(string $bookSlug)
     {

-        $book = $this->queries->findVisibleBySlug($bookSlug);
+        $book = $this->queries->findVisibleBySlugOrFail($bookSlug);

         $this->checkOwnablePermission('book-delete', $book);
 
         $this->bookRepo->destroy($book);
         $this->checkOwnablePermission('book-delete', $book);
 
         $this->bookRepo->destroy($book);


@@ -223,7 +225,7 @@ class BookController extends Controller
      */
     public function showCopy(string $bookSlug)
     {
      */
     public function showCopy(string $bookSlug)
     {

-        $book = $this->queries->findVisibleBySlug($bookSlug);
+        $book = $this->queries->findVisibleBySlugOrFail($bookSlug);

         $this->checkOwnablePermission('book-view', $book);
 
         session()->flashInput(['name' => $book->name]);
         $this->checkOwnablePermission('book-view', $book);
 
         session()->flashInput(['name' => $book->name]);


@@ -240,7 +242,7 @@ class BookController extends Controller
      */
     public function copy(Request $request, Cloner $cloner, string $bookSlug)
     {
      */
     public function copy(Request $request, Cloner $cloner, string $bookSlug)
     {

-        $book = $this->queries->findVisibleBySlug($bookSlug);
+        $book = $this->queries->findVisibleBySlugOrFail($bookSlug);

         $this->checkOwnablePermission('book-view', $book);
         $this->checkPermission('book-create-all');
 
         $this->checkOwnablePermission('book-view', $book);
         $this->checkPermission('book-create-all');
 


@@ -256,13 +258,15 @@ class BookController extends Controller
      */
     public function convertToShelf(HierarchyTransformer $transformer, string $bookSlug)
     {
      */
     public function convertToShelf(HierarchyTransformer $transformer, string $bookSlug)
     {

-        $book = $this->queries->findVisibleBySlug($bookSlug);
+        $book = $this->queries->findVisibleBySlugOrFail($bookSlug);

         $this->checkOwnablePermission('book-update', $book);
         $this->checkOwnablePermission('book-delete', $book);
         $this->checkPermission('bookshelf-create-all');
         $this->checkPermission('book-create-all');
 
         $this->checkOwnablePermission('book-update', $book);
         $this->checkOwnablePermission('book-delete', $book);
         $this->checkPermission('bookshelf-create-all');
         $this->checkPermission('book-create-all');
 

-        $shelf = $transformer->transformBookToShelf($book);
+        $shelf = (new DatabaseTransaction(function () use ($book, $transformer) {
+            return $transformer->transformBookToShelf($book);
+        }))->run();

 
         return redirect($shelf->getUrl());
     }
 
         return redirect($shelf->getUrl());
     }