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 55d28c6847e32a1227cb4663902e3388fbb27524..5d3d67f645c36afbf66599a7cabd0558096835b3 100644 (file)
--- a/app/Entities/Controllers/BookController.php
+++ b/app/Entities/Controllers/BookController.php
@@ -6,7 +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\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;


@@ -17,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;


@@ -24,15 +26,13 @@ use Throwable;
 
 class BookController extends Controller
 {
 
 class BookController extends Controller
 {

-    protected BookRepo $bookRepo;
-    protected ShelfContext $shelfContext;
-    protected ReferenceFetcher $referenceFetcher;
-
-    public function __construct(ShelfContext $entityContextManager, BookRepo $bookRepo, ReferenceFetcher $referenceFetcher)
-    {
-        $this->bookRepo = $bookRepo;
-        $this->shelfContext = $entityContextManager;
-        $this->referenceFetcher = $referenceFetcher;
+    public function __construct(
+        protected ShelfContext $shelfContext,
+        protected BookRepo $bookRepo,
+        protected BookQueries $queries,
+        protected BookshelfQueries $shelfQueries,
+        protected ReferenceFetcher $referenceFetcher,
+    ) {

     }
 
     /**
     }
 
     /**


@@ -47,10 +47,12 @@ class BookController extends Controller
             'updated_at' => trans('common.sort_updated_at'),
         ]);
 
             'updated_at' => trans('common.sort_updated_at'),
         ]);
 

-        $books = $this->bookRepo->getAllPaginated(18, $listOptions->getSort(), $listOptions->getOrder());
-        $recents = $this->isSignedIn() ? $this->bookRepo->getRecentlyViewed(4) : false;
-        $popular = $this->bookRepo->getPopular(4);
-        $new = $this->bookRepo->getRecentlyCreated(4);
+        $books = $this->queries->visibleForListWithCover()
+            ->orderBy($listOptions->getSort(), $listOptions->getOrder())
+            ->paginate(18);
+        $recents = $this->isSignedIn() ? $this->queries->recentlyViewedForCurrentUser()->take(4)->get() : false;
+        $popular = $this->queries->popularForList()->take(4)->get();
+        $new = $this->queries->visibleForList()->orderBy('created_at', 'desc')->take(4)->get();

 
         $this->shelfContext->clearShelfContext();
 
 
         $this->shelfContext->clearShelfContext();
 


@@ -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,19 +94,20 @@ 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, [

-            'name'        => ['required', 'string', 'max:255'],
-            'description' => ['string', 'max:1000'],
-            'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
-            'tags'        => ['array'],
+            'name'                => ['required', 'string', 'max:255'],
+            'description_html'    => ['string', 'max:2000'],
+            'image'               => array_merge(['nullable'], $this->getImageValidationRules()),
+            'tags'                => ['array'],
+            'default_template_id' => ['nullable', 'integer'],

         ]);
 
         $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);
         }
 


@@ -123,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->bookRepo->getBySlug($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();
 


@@ -141,7 +144,7 @@ class BookController extends Controller
             'bookParentShelves' => $bookParentShelves,
             'watchOptions'      => new UserEntityWatchOptions(user(), $book),
             'activity'          => $activities->entityActivity($book, 20, 1),
             'bookParentShelves' => $bookParentShelves,
             'watchOptions'      => new UserEntityWatchOptions(user(), $book),
             'activity'          => $activities->entityActivity($book, 20, 1),

-            'referenceCount'    => $this->referenceFetcher->getPageReferenceCountToEntity($book),
+            'referenceCount'    => $this->referenceFetcher->getReferenceCountToEntity($book),

         ]);
     }
 
         ]);
     }
 


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

-        $book = $this->bookRepo->getBySlug($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()]));
 


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

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

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

-            'name'        => ['required', 'string', 'max:255'],
-            'description' => ['string', 'max:1000'],
-            'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
-            'tags'        => ['array'],
+            'name'                => ['required', 'string', 'max:255'],
+            'description_html'    => ['string', 'max:2000'],
+            'image'               => array_merge(['nullable'], $this->getImageValidationRules()),
+            'tags'                => ['array'],
+            'default_template_id' => ['nullable', 'integer'],

         ]);
 
         if ($request->has('image_reset')) {
         ]);
 
         if ($request->has('image_reset')) {


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

-        $book = $this->bookRepo->getBySlug($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()]));
 


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

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

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


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

-        $book = $this->bookRepo->getBySlug($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]);


@@ -238,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->bookRepo->getBySlug($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');
 


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

-        $book = $this->bookRepo->getBySlug($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());
     }