]> BookStack Code Mirror - bookstack/blobdiff - app/Http/Controllers/BookController.php
Refactored common list handling operations to new class
[bookstack] / app / Http / Controllers / BookController.php
index 5a42daddbe8b8dd2e9a4452b9659058ea1c3c660..14c3af1cc5cf8f0a8c92d70de7c24d8a1d608c96 100644 (file)
@@ -1,55 +1,66 @@
-<?php namespace BookStack\Http\Controllers;
+<?php
 
-use Activity;
+namespace BookStack\Http\Controllers;
+
+use BookStack\Actions\ActivityQueries;
 use BookStack\Actions\ActivityType;
-use BookStack\Entities\Managers\BookContents;
-use BookStack\Entities\Bookshelf;
-use BookStack\Entities\Managers\EntityContext;
+use BookStack\Actions\View;
+use BookStack\Entities\Models\Bookshelf;
 use BookStack\Entities\Repos\BookRepo;
+use BookStack\Entities\Tools\BookContents;
+use BookStack\Entities\Tools\Cloner;
+use BookStack\Entities\Tools\HierarchyTransformer;
+use BookStack\Entities\Tools\ShelfContext;
 use BookStack\Exceptions\ImageUploadException;
+use BookStack\Exceptions\NotFoundException;
+use BookStack\Facades\Activity;
+use BookStack\References\ReferenceFetcher;
+use BookStack\Util\SimpleListOptions;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 use Throwable;
-use Views;
 
 class BookController extends Controller
 {
+    protected BookRepo $bookRepo;
+    protected ShelfContext $shelfContext;
+    protected ReferenceFetcher $referenceFetcher;
 
-    protected $bookRepo;
-    protected $entityContextManager;
-
-    public function __construct(EntityContext $entityContextManager, BookRepo $bookRepo)
+    public function __construct(ShelfContext $entityContextManager, BookRepo $bookRepo, ReferenceFetcher $referenceFetcher)
     {
         $this->bookRepo = $bookRepo;
-        $this->entityContextManager = $entityContextManager;
-        parent::__construct();
+        $this->shelfContext = $entityContextManager;
+        $this->referenceFetcher = $referenceFetcher;
     }
 
     /**
      * Display a listing of the book.
      */
-    public function index()
+    public function index(Request $request)
     {
-        $view = setting()->getForCurrentUser('books_view_type', config('app.views.books'));
-        $sort = setting()->getForCurrentUser('books_sort', 'name');
-        $order = setting()->getForCurrentUser('books_sort_order', 'asc');
+        $view = setting()->getForCurrentUser('books_view_type');
+        $listOptions = SimpleListOptions::fromRequest($request, 'books')->withSortOptions([
+            'name' => trans('common.sort_name'),
+            'created_at' => trans('common.sort_created_at'),
+            'updated_at' => trans('common.sort_updated_at'),
+        ]);
 
-        $books = $this->bookRepo->getAllPaginated(18, $sort, $order);
+        $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);
 
-        $this->entityContextManager->clearShelfContext();
+        $this->shelfContext->clearShelfContext();
 
         $this->setPageTitle(trans('entities.books'));
+
         return view('books.index', [
-            'books' => $books,
+            'books'   => $books,
             'recents' => $recents,
             'popular' => $popular,
-            'new' => $new,
-            'view' => $view,
-            'sort' => $sort,
-            'order' => $order,
+            'new'     => $new,
+            'view'    => $view,
+            'listOptions' => $listOptions,
         ]);
     }
 
@@ -67,23 +78,26 @@ class BookController extends Controller
         }
 
         $this->setPageTitle(trans('entities.books_create'));
+
         return view('books.create', [
-            'bookshelf' => $bookshelf
+            'bookshelf' => $bookshelf,
         ]);
     }
 
     /**
      * Store a newly created book in storage.
+     *
      * @throws ImageUploadException
      * @throws ValidationException
      */
     public function store(Request $request, string $shelfSlug = null)
     {
         $this->checkPermission('book-create-all');
-        $this->validate($request, [
-            'name' => 'required|string|max:255',
-            'description' => 'string|max:1000',
-            'image' => 'nullable|' . $this->getImageValidationRules(),
+        $validated = $this->validate($request, [
+            'name'        => ['required', 'string', 'max:255'],
+            'description' => ['string', 'max:1000'],
+            'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
+            'tags'        => ['array'],
         ]);
 
         $bookshelf = null;
@@ -92,12 +106,11 @@ class BookController extends Controller
             $this->checkOwnablePermission('bookshelf-update', $bookshelf);
         }
 
-        $book = $this->bookRepo->create($request->all());
-        $this->bookRepo->updateCoverImage($book, $request->file('image', null));
+        $book = $this->bookRepo->create($validated);
 
         if ($bookshelf) {
             $bookshelf->appendBook($book);
-            Activity::add($bookshelf, ActivityType::BOOKSHELF_UPDATE);
+            Activity::add(ActivityType::BOOKSHELF_UPDATE, $bookshelf);
         }
 
         return redirect($book->getUrl());
@@ -106,24 +119,26 @@ class BookController extends Controller
     /**
      * Display the specified book.
      */
-    public function show(Request $request, string $slug)
+    public function show(Request $request, ActivityQueries $activities, string $slug)
     {
         $book = $this->bookRepo->getBySlug($slug);
         $bookChildren = (new BookContents($book))->getTree(true);
-        $bookParentShelves = $book->shelves()->visible()->get();
+        $bookParentShelves = $book->shelves()->scopes('visible')->get();
 
-        Views::add($book);
+        View::incrementFor($book);
         if ($request->has('shelf')) {
-            $this->entityContextManager->setShelfContext(intval($request->get('shelf')));
+            $this->shelfContext->setShelfContext(intval($request->get('shelf')));
         }
 
         $this->setPageTitle($book->getShortName());
+
         return view('books.show', [
-            'book' => $book,
-            'current' => $book,
-            'bookChildren' => $bookChildren,
+            'book'              => $book,
+            'current'           => $book,
+            'bookChildren'      => $bookChildren,
             'bookParentShelves' => $bookParentShelves,
-            'activity' => Activity::entityActivity($book, 20, 1)
+            'activity'          => $activities->entityActivity($book, 20, 1),
+            'referenceCount'    => $this->referenceFetcher->getPageReferenceCountToEntity($book),
         ]);
     }
 
@@ -134,12 +149,14 @@ class BookController extends Controller
     {
         $book = $this->bookRepo->getBySlug($slug);
         $this->checkOwnablePermission('book-update', $book);
-        $this->setPageTitle(trans('entities.books_edit_named', ['bookName'=>$book->getShortName()]));
+        $this->setPageTitle(trans('entities.books_edit_named', ['bookName' => $book->getShortName()]));
+
         return view('books.edit', ['book' => $book, 'current' => $book]);
     }
 
     /**
      * Update the specified book in storage.
+     *
      * @throws ImageUploadException
      * @throws ValidationException
      * @throws Throwable
@@ -148,15 +165,21 @@ class BookController extends Controller
     {
         $book = $this->bookRepo->getBySlug($slug);
         $this->checkOwnablePermission('book-update', $book);
-        $this->validate($request, [
-            'name' => 'required|string|max:255',
-            'description' => 'string|max:1000',
-            'image' => 'nullable|' . $this->getImageValidationRules(),
+
+        $validated = $this->validate($request, [
+            'name'        => ['required', 'string', 'max:255'],
+            'description' => ['string', 'max:1000'],
+            'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
+            'tags'        => ['array'],
         ]);
 
-        $book = $this->bookRepo->update($book, $request->all());
-        $resetCover = $request->has('image_reset');
-        $this->bookRepo->updateCoverImage($book, $request->file('image', null), $resetCover);
+        if ($request->has('image_reset')) {
+            $validated['image'] = null;
+        } elseif (array_key_exists('image', $validated) && is_null($validated['image'])) {
+            unset($validated['image']);
+        }
+
+        $book = $this->bookRepo->update($book, $validated);
 
         return redirect($book->getUrl());
     }
@@ -169,11 +192,13 @@ class BookController extends Controller
         $book = $this->bookRepo->getBySlug($bookSlug);
         $this->checkOwnablePermission('book-delete', $book);
         $this->setPageTitle(trans('entities.books_delete_named', ['bookName' => $book->getShortName()]));
+
         return view('books.delete', ['book' => $book, 'current' => $book]);
     }
 
     /**
      * Remove the specified book from the system.
+     *
      * @throws Throwable
      */
     public function destroy(string $bookSlug)
@@ -187,32 +212,53 @@ class BookController extends Controller
     }
 
     /**
-     * Show the permissions view.
+     * Show the view to copy a book.
+     *
+     * @throws NotFoundException
      */
-    public function showPermissions(string $bookSlug)
+    public function showCopy(string $bookSlug)
     {
         $book = $this->bookRepo->getBySlug($bookSlug);
-        $this->checkOwnablePermission('restrictions-manage', $book);
+        $this->checkOwnablePermission('book-view', $book);
+
+        session()->flashInput(['name' => $book->name]);
 
-        return view('books.permissions', [
+        return view('books.copy', [
             'book' => $book,
         ]);
     }
 
     /**
-     * Set the restrictions for this book.
-     * @throws Throwable
+     * Create a copy of a book within the requested target destination.
+     *
+     * @throws NotFoundException
      */
-    public function permissions(Request $request, string $bookSlug)
+    public function copy(Request $request, Cloner $cloner, string $bookSlug)
     {
         $book = $this->bookRepo->getBySlug($bookSlug);
-        $this->checkOwnablePermission('restrictions-manage', $book);
+        $this->checkOwnablePermission('book-view', $book);
+        $this->checkPermission('book-create-all');
 
-        $restricted = $request->get('restricted') === 'true';
-        $permissions = $request->filled('restrictions') ? collect($request->get('restrictions')) : null;
-        $this->bookRepo->updatePermissions($book, $restricted, $permissions);
+        $newName = $request->get('name') ?: $book->name;
+        $bookCopy = $cloner->cloneBook($book, $newName);
+        $this->showSuccessNotification(trans('entities.books_copy_success'));
 
-        $this->showSuccessNotification(trans('entities.books_permissions_updated'));
-        return redirect($book->getUrl());
+        return redirect($bookCopy->getUrl());
+    }
+
+    /**
+     * Convert the chapter to a book.
+     */
+    public function convertToShelf(HierarchyTransformer $transformer, string $bookSlug)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $this->checkOwnablePermission('book-update', $book);
+        $this->checkOwnablePermission('book-delete', $book);
+        $this->checkPermission('bookshelf-create-all');
+        $this->checkPermission('book-create-all');
+
+        $shelf = $transformer->transformBookToShelf($book);
+
+        return redirect($shelf->getUrl());
     }
 }