Add notice to Page delete confirmation when in use as a template

[bookstack] / app / Http / Controllers / BookshelfController.php

diff --git a/app/Http/Controllers/BookshelfController.php b/app/Http/Controllers/BookshelfController.php
index bcf2e12df88a67628bdded31f2db1162ce120098..537ea915b76130deb086c934b0c22516e070dd07 100644 (file)
--- a/app/Http/Controllers/BookshelfController.php
+++ b/app/Http/Controllers/BookshelfController.php
@@ -1,303 +1,210 @@
-<?php namespace BookStack\Http\Controllers;
-
-use Activity;
-use BookStack\Auth\UserRepo;
-use BookStack\Entities\Bookshelf;
-use BookStack\Entities\EntityContextManager;
-use BookStack\Entities\Repos\EntityRepo;
-use BookStack\Uploads\ImageRepo;
+<?php
+
+namespace BookStack\Http\Controllers;
+
+use BookStack\Actions\ActivityQueries;
+use BookStack\Actions\View;
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Repos\BookshelfRepo;
+use BookStack\Entities\Tools\ShelfContext;
+use BookStack\Exceptions\ImageUploadException;
+use BookStack\Exceptions\NotFoundException;
+use BookStack\References\ReferenceFetcher;
+use BookStack\Util\SimpleListOptions;
+use Exception;

 use Illuminate\Http\Request;
 use Illuminate\Http\Request;

-use Illuminate\Http\Response;
-use Views;
+use Illuminate\Validation\ValidationException;

 
 class BookshelfController extends Controller
 {
 
 class BookshelfController extends Controller
 {

+    protected BookshelfRepo $shelfRepo;
+    protected ShelfContext $shelfContext;
+    protected ReferenceFetcher $referenceFetcher;

 
 

-    protected $entityRepo;
-    protected $userRepo;
-    protected $entityContextManager;
-    protected $imageRepo;
-
-    /**
-     * BookController constructor.
-     * @param EntityRepo $entityRepo
-     * @param UserRepo $userRepo
-     * @param EntityContextManager $entityContextManager
-     * @param ImageRepo $imageRepo
-     */
-    public function __construct(EntityRepo $entityRepo, UserRepo $userRepo, EntityContextManager $entityContextManager, ImageRepo $imageRepo)
+    public function __construct(BookshelfRepo $shelfRepo, ShelfContext $shelfContext, ReferenceFetcher $referenceFetcher)

     {
     {

-        $this->entityRepo = $entityRepo;
-        $this->userRepo = $userRepo;
-        $this->entityContextManager = $entityContextManager;
-        $this->imageRepo = $imageRepo;
-        parent::__construct();
+        $this->shelfRepo = $shelfRepo;
+        $this->shelfContext = $shelfContext;
+        $this->referenceFetcher = $referenceFetcher;

     }
 
     /**
      * Display a listing of the book.
     }
 
     /**
      * Display a listing of the book.

-     * @return Response

      */
      */

-    public function index()
+    public function index(Request $request)

     {
     {

-        $view = setting()->getUser($this->currentUser, 'bookshelves_view_type', config('app.views.bookshelves', 'grid'));
-        $sort = setting()->getUser($this->currentUser, 'bookshelves_sort', 'name');
-        $order = setting()->getUser($this->currentUser, 'bookshelves_sort_order', 'asc');
-        $sortOptions = [
-            'name' => trans('common.sort_name'),
+        $view = setting()->getForCurrentUser('bookshelves_view_type');
+        $listOptions = SimpleListOptions::fromRequest($request, 'bookshelves')->withSortOptions([
+            'name'       => trans('common.sort_name'),

             'created_at' => trans('common.sort_created_at'),
             'updated_at' => trans('common.sort_updated_at'),
             'created_at' => trans('common.sort_created_at'),
             'updated_at' => trans('common.sort_updated_at'),

-        ];
-
-        $shelves = $this->entityRepo->getAllPaginated('bookshelf', 18, $sort, $order);
-        foreach ($shelves as $shelf) {
-            $shelf->books = $this->entityRepo->getBookshelfChildren($shelf);
-        }
+        ]);

 
 

-        $recents = $this->signedIn ? $this->entityRepo->getRecentlyViewed('bookshelf', 4, 0) : false;
-        $popular = $this->entityRepo->getPopular('bookshelf', 4, 0);
-        $new = $this->entityRepo->getRecentlyCreated('bookshelf', 4, 0);
+        $shelves = $this->shelfRepo->getAllPaginated(18, $listOptions->getSort(), $listOptions->getOrder());
+        $recents = $this->isSignedIn() ? $this->shelfRepo->getRecentlyViewed(4) : false;
+        $popular = $this->shelfRepo->getPopular(4);
+        $new = $this->shelfRepo->getRecentlyCreated(4);

 
 

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

         $this->setPageTitle(trans('entities.shelves'));
         $this->setPageTitle(trans('entities.shelves'));

+

         return view('shelves.index', [
         return view('shelves.index', [

-            'shelves' => $shelves,
-            'recents' => $recents,
-            'popular' => $popular,
-            'new' => $new,
-            'view' => $view,
-            'sort' => $sort,
-            'order' => $order,
-            'sortOptions' => $sortOptions,
+            'shelves'     => $shelves,
+            'recents'     => $recents,
+            'popular'     => $popular,
+            'new'         => $new,
+            'view'        => $view,
+            'listOptions' => $listOptions,

         ]);
     }
 
     /**
      * Show the form for creating a new bookshelf.
         ]);
     }
 
     /**
      * Show the form for creating a new bookshelf.

-     * @return Response

      */
     public function create()
     {
         $this->checkPermission('bookshelf-create-all');
      */
     public function create()
     {
         $this->checkPermission('bookshelf-create-all');

-        $books = $this->entityRepo->getAll('book', false, 'update');
+        $books = Book::visible()->orderBy('name')->get(['name', 'id', 'slug']);

         $this->setPageTitle(trans('entities.shelves_create'));
         $this->setPageTitle(trans('entities.shelves_create'));

+

         return view('shelves.create', ['books' => $books]);
     }
 
     /**
      * Store a newly created bookshelf in storage.
         return view('shelves.create', ['books' => $books]);
     }
 
     /**
      * Store a newly created bookshelf in storage.

-     * @param Request $request
-     * @return Response
-     * @throws \BookStack\Exceptions\ImageUploadException
+     *
+     * @throws ValidationException
+     * @throws ImageUploadException

      */
     public function store(Request $request)
     {
         $this->checkPermission('bookshelf-create-all');
      */
     public function store(Request $request)
     {
         $this->checkPermission('bookshelf-create-all');

-        $this->validate($request, [
-            'name' => 'required|string|max:255',
-            'description' => 'string|max:1000',
-            'image' => $this->imageRepo->getImageValidationRules(),
+        $validated = $this->validate($request, [
+            'name'        => ['required', 'string', 'max:255'],
+            'description' => ['string', 'max:1000'],
+            'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
+            'tags'        => ['array'],

         ]);
 
         ]);
 

-        $shelf = $this->entityRepo->createFromInput('bookshelf', $request->all());
-        $this->shelfUpdateActions($shelf, $request);
+        $bookIds = explode(',', $request->get('books', ''));
+        $shelf = $this->shelfRepo->create($validated, $bookIds);

 
 

-        Activity::add($shelf, 'bookshelf_create');

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

-

     /**
     /**

-     * Display the specified bookshelf.
-     * @param String $slug
-     * @return Response
-     * @throws \BookStack\Exceptions\NotFoundException
+     * Display the bookshelf of the given slug.
+     *
+     * @throws NotFoundException

      */
      */

-    public function show(string $slug)
+    public function show(Request $request, ActivityQueries $activities, string $slug)

     {
     {

-        /** @var Bookshelf $shelf */
-        $shelf = $this->entityRepo->getBySlug('bookshelf', $slug);
-        $this->checkOwnablePermission('book-view', $shelf);
+        $shelf = $this->shelfRepo->getBySlug($slug);
+        $this->checkOwnablePermission('bookshelf-view', $shelf);
+
+        $listOptions = SimpleListOptions::fromRequest($request, 'shelf_books')->withSortOptions([
+            'default' => trans('common.sort_default'),
+            'name' => trans('common.sort_name'),
+            'created_at' => trans('common.sort_created_at'),
+            'updated_at' => trans('common.sort_updated_at'),
+        ]);

 
 

-        $books = $this->entityRepo->getBookshelfChildren($shelf);
-        Views::add($shelf);
-        $this->entityContextManager->setShelfContext($shelf->id);
+        $sort = $listOptions->getSort();
+        $sortedVisibleShelfBooks = $shelf->visibleBooks()->get()
+            ->sortBy($sort === 'default' ? 'pivot.order' : $sort, SORT_REGULAR, $listOptions->getOrder() === 'desc')
+            ->values()
+            ->all();
+
+        View::incrementFor($shelf);
+        $this->shelfContext->setShelfContext($shelf->id);
+        $view = setting()->getForCurrentUser('bookshelf_view_type');

 
         $this->setPageTitle($shelf->getShortName());
 
         return view('shelves.show', [
 
         $this->setPageTitle($shelf->getShortName());
 
         return view('shelves.show', [

-            'shelf' => $shelf,
-            'books' => $books,
-            'activity' => Activity::entityActivity($shelf, 20, 1)
+            'shelf'                   => $shelf,
+            'sortedVisibleShelfBooks' => $sortedVisibleShelfBooks,
+            'view'                    => $view,
+            'activity'                => $activities->entityActivity($shelf, 20, 1),
+            'listOptions'             => $listOptions,
+            'referenceCount'          => $this->referenceFetcher->getPageReferenceCountToEntity($shelf),

         ]);
     }
 
     /**
      * Show the form for editing the specified bookshelf.
         ]);
     }
 
     /**
      * Show the form for editing the specified bookshelf.

-     * @param $slug
-     * @return Response
-     * @throws \BookStack\Exceptions\NotFoundException

      */
     public function edit(string $slug)
     {
      */
     public function edit(string $slug)
     {

-        $shelf = $this->entityRepo->getBySlug('bookshelf', $slug); /** @var $shelf Bookshelf */
+        $shelf = $this->shelfRepo->getBySlug($slug);

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

-        $shelfBooks = $this->entityRepo->getBookshelfChildren($shelf);
-        $shelfBookIds = $shelfBooks->pluck('id');
-        $books = $this->entityRepo->getAll('book', false, 'update');
-        $books = $books->filter(function ($book) use ($shelfBookIds) {
-             return !$shelfBookIds->contains($book->id);
-        });
+        $shelfBookIds = $shelf->books()->get(['id'])->pluck('id');
+        $books = Book::visible()->whereNotIn('id', $shelfBookIds)->orderBy('name')->get(['name', 'id', 'slug']);

 
         $this->setPageTitle(trans('entities.shelves_edit_named', ['name' => $shelf->getShortName()]));
 
         $this->setPageTitle(trans('entities.shelves_edit_named', ['name' => $shelf->getShortName()]));

+

         return view('shelves.edit', [
             'shelf' => $shelf,
             'books' => $books,
         return view('shelves.edit', [
             'shelf' => $shelf,
             'books' => $books,

-            'shelfBooks' => $shelfBooks,

         ]);
     }
 
         ]);
     }
 

-

     /**
      * Update the specified bookshelf in storage.
     /**
      * Update the specified bookshelf in storage.

-     * @param Request $request
-     * @param string $slug
-     * @return Response
-     * @throws \BookStack\Exceptions\NotFoundException
-     * @throws \BookStack\Exceptions\ImageUploadException
+     *
+     * @throws ValidationException
+     * @throws ImageUploadException
+     * @throws NotFoundException

      */
     public function update(Request $request, string $slug)
     {
      */
     public function update(Request $request, string $slug)
     {

-        $shelf = $this->entityRepo->getBySlug('bookshelf', $slug); /** @var $bookshelf Bookshelf */
+        $shelf = $this->shelfRepo->getBySlug($slug);

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

-        $this->validate($request, [
-            'name' => 'required|string|max:255',
-            'description' => 'string|max:1000',
-            'image' => $this->imageRepo->getImageValidationRules(),
+        $validated = $this->validate($request, [
+            'name'        => ['required', 'string', 'max:255'],
+            'description' => ['string', 'max:1000'],
+            'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
+            'tags'        => ['array'],

         ]);
 
         ]);
 

-         $shelf = $this->entityRepo->updateFromInput('bookshelf', $shelf, $request->all());
-         $this->shelfUpdateActions($shelf, $request);
+        if ($request->has('image_reset')) {
+            $validated['image'] = null;
+        } elseif (array_key_exists('image', $validated) && is_null($validated['image'])) {
+            unset($validated['image']);
+        }

 
 

-         Activity::add($shelf, 'bookshelf_update');
+        $bookIds = explode(',', $request->get('books', ''));
+        $shelf = $this->shelfRepo->update($shelf, $validated, $bookIds);

 
 

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

     }
 
     }
 

-

     /**
     /**

-     * Shows the page to confirm deletion
-     * @param $slug
-     * @return \Illuminate\View\View
-     * @throws \BookStack\Exceptions\NotFoundException
+     * Shows the page to confirm deletion.

      */
     public function showDelete(string $slug)
     {
      */
     public function showDelete(string $slug)
     {

-        $shelf = $this->entityRepo->getBySlug('bookshelf', $slug); /** @var $shelf Bookshelf */
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('bookshelf-delete', $shelf);
 
         $this->setPageTitle(trans('entities.shelves_delete_named', ['name' => $shelf->getShortName()]));
         $this->checkOwnablePermission('bookshelf-delete', $shelf);
 
         $this->setPageTitle(trans('entities.shelves_delete_named', ['name' => $shelf->getShortName()]));

+

         return view('shelves.delete', ['shelf' => $shelf]);
     }
 
     /**
      * Remove the specified bookshelf from storage.
         return view('shelves.delete', ['shelf' => $shelf]);
     }
 
     /**
      * Remove the specified bookshelf from storage.

-     * @param string $slug
-     * @return Response
-     * @throws \BookStack\Exceptions\NotFoundException
-     * @throws \Throwable
+     *
+     * @throws Exception

      */
     public function destroy(string $slug)
     {
      */
     public function destroy(string $slug)
     {

-        $shelf = $this->entityRepo->getBySlug('bookshelf', $slug); /** @var $shelf Bookshelf */
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('bookshelf-delete', $shelf);
         $this->checkOwnablePermission('bookshelf-delete', $shelf);

-        Activity::addMessage('bookshelf_delete', 0, $shelf->name);

 
 

-        if ($shelf->cover) {
-            $this->imageRepo->destroyImage($shelf->cover);
-        }
-        $this->entityRepo->destroyBookshelf($shelf);
+        $this->shelfRepo->destroy($shelf);

 
         return redirect('/shelves');
     }
 
         return redirect('/shelves');
     }

-
-    /**
-     * Show the permissions view.
-     * @param string $slug
-     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
-     * @throws \BookStack\Exceptions\NotFoundException
-     */
-    public function showPermissions(string $slug)
-    {
-        $shelf = $this->entityRepo->getBySlug('bookshelf', $slug);
-        $this->checkOwnablePermission('restrictions-manage', $shelf);
-
-        $roles = $this->userRepo->getRestrictableRoles();
-        return view('shelves.permissions', [
-            'shelf' => $shelf,
-            'roles' => $roles
-        ]);
-    }
-
-    /**
-     * Set the permissions for this bookshelf.
-     * @param string $slug
-     * @param Request $request
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
-     * @throws \BookStack\Exceptions\NotFoundException
-     * @throws \Throwable
-     */
-    public function permissions(string $slug, Request $request)
-    {
-        $shelf = $this->entityRepo->getBySlug('bookshelf', $slug);
-        $this->checkOwnablePermission('restrictions-manage', $shelf);
-
-        $this->entityRepo->updateEntityPermissionsFromRequest($request, $shelf);
-        session()->flash('success', trans('entities.shelves_permissions_updated'));
-        return redirect($shelf->getUrl());
-    }
-
-    /**
-     * Copy the permissions of a bookshelf to the child books.
-     * @param string $slug
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
-     * @throws \BookStack\Exceptions\NotFoundException
-     */
-    public function copyPermissions(string $slug)
-    {
-        $shelf = $this->entityRepo->getBySlug('bookshelf', $slug);
-        $this->checkOwnablePermission('restrictions-manage', $shelf);
-
-        $updateCount = $this->entityRepo->copyBookshelfPermissions($shelf);
-        session()->flash('success', trans('entities.shelves_copy_permission_success', ['count' => $updateCount]));
-        return redirect($shelf->getUrl());
-    }
-
-    /**
-     * Common actions to run on bookshelf update.
-     * @param Bookshelf $shelf
-     * @param Request $request
-     * @throws \BookStack\Exceptions\ImageUploadException
-     */
-    protected function shelfUpdateActions(Bookshelf $shelf, Request $request)
-    {
-        // Update the books that the shelf references
-        $this->entityRepo->updateShelfBooks($shelf, $request->get('books', ''));
-
-        // Update the cover image if in request
-        if ($request->has('image')) {
-            $newImage = $request->file('image');
-            $this->imageRepo->destroyImage($shelf->cover);
-            $image = $this->imageRepo->saveNew($newImage, 'cover_shelf', $shelf->id, 512, 512, true);
-            $shelf->image_id = $image->id;
-            $shelf->save();
-        }
-
-        if ($request->has('image_reset')) {
-            $this->imageRepo->destroyImage($shelf->cover);
-            $shelf->image_id = 0;
-            $shelf->save();
-        }
-    }

 }
 }