Added 'Sort Book' action to chapters

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

diff --git a/app/Http/Controllers/BookshelfController.php b/app/Http/Controllers/BookshelfController.php
index 5c9da762fb3499341c4be851bacc455cd13dad2c..ccbeb6484b0db0720f4d55cf872d74e810d1d6d6 100644 (file)
--- a/app/Http/Controllers/BookshelfController.php
+++ b/app/Http/Controllers/BookshelfController.php
@@ -1,33 +1,28 @@
-<?php namespace BookStack\Http\Controllers;
+<?php

 
 

-use Activity;
-use BookStack\Entities\Book;
-use BookStack\Entities\Managers\EntityContext;
+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\Repos\BookshelfRepo;

+use BookStack\Entities\Tools\PermissionsUpdater;
+use BookStack\Entities\Tools\ShelfContext;

 use BookStack\Exceptions\ImageUploadException;
 use BookStack\Exceptions\NotFoundException;
 use BookStack\Exceptions\ImageUploadException;
 use BookStack\Exceptions\NotFoundException;

-use BookStack\Uploads\ImageRepo;

 use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;

-use Views;

 
 class BookshelfController extends Controller
 {
 
 class BookshelfController extends Controller
 {

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

 
 

-    protected $bookshelfRepo;
-    protected $entityContextManager;
-    protected $imageRepo;
-
-    /**
-     * BookController constructor.
-     */
-    public function __construct(BookshelfRepo $bookshelfRepo, EntityContext $entityContextManager, ImageRepo $imageRepo)
+    public function __construct(BookshelfRepo $shelfRepo, ShelfContext $shelfContext)

     {
     {

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

     }
 
     /**
     }
 
     /**


@@ -35,30 +30,31 @@ class BookshelfController extends Controller
      */
     public function index()
     {
      */
     public function index()
     {

-        $view = setting()->getForCurrentUser('bookshelves_view_type', config('app.views.bookshelves', 'grid'));
+        $view = setting()->getForCurrentUser('bookshelves_view_type');

         $sort = setting()->getForCurrentUser('bookshelves_sort', 'name');
         $order = setting()->getForCurrentUser('bookshelves_sort_order', 'asc');
         $sortOptions = [
         $sort = setting()->getForCurrentUser('bookshelves_sort', 'name');
         $order = setting()->getForCurrentUser('bookshelves_sort_order', 'asc');
         $sortOptions = [

-            'name' => trans('common.sort_name'),
+            '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->bookshelfRepo->getAllPaginated(18, $sort, $order);
-        $recents = $this->isSignedIn() ? $this->bookshelfRepo->getRecentlyViewed(4) : false;
-        $popular = $this->bookshelfRepo->getPopular(4);
-        $new = $this->bookshelfRepo->getRecentlyCreated(4);
+        $shelves = $this->shelfRepo->getAllPaginated(18, $sort, $order);
+        $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,
+            'shelves'     => $shelves,
+            'recents'     => $recents,
+            'popular'     => $popular,
+            'new'         => $new,
+            'view'        => $view,
+            'sort'        => $sort,
+            'order'       => $order,

             'sortOptions' => $sortOptions,
         ]);
     }
             'sortOptions' => $sortOptions,
         ]);
     }


@@ -69,51 +65,65 @@ class BookshelfController extends Controller
     public function create()
     {
         $this->checkPermission('bookshelf-create-all');
     public function create()
     {
         $this->checkPermission('bookshelf-create-all');

-        $books = Book::hasPermission('update')->get();
+        $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.

+     *

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

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

         ]);
 
         $bookIds = explode(',', $request->get('books', ''));
         ]);
 
         $bookIds = explode(',', $request->get('books', ''));

-        $shelf = $this->bookshelfRepo->create($request->all(), $bookIds);
-        $this->bookshelfRepo->updateCoverImage($shelf);
+        $shelf = $this->shelfRepo->create($validated, $bookIds);

 
 

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

         return redirect($shelf->getUrl());
     }
 
     /**
      * Display the bookshelf of the given slug.
         return redirect($shelf->getUrl());
     }
 
     /**
      * Display the bookshelf of the given slug.

+     *

      * @throws NotFoundException
      */
      * @throws NotFoundException
      */

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

     {
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
-        $view = setting()->getForCurrentUser('books_view_type', config('app.views.books'));
-        $this->checkOwnablePermission('book-view', $shelf);
+        $shelf = $this->shelfRepo->getBySlug($slug);
+        $this->checkOwnablePermission('bookshelf-view', $shelf);
+
+        $sort = setting()->getForCurrentUser('shelf_books_sort', 'default');
+        $order = setting()->getForCurrentUser('shelf_books_sort_order', 'asc');

 
 

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

 
         $this->setPageTitle($shelf->getShortName());
 
         $this->setPageTitle($shelf->getShortName());

+

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

-            'shelf' => $shelf,
-            'view' => $view,
-            'activity' => Activity::entityActivity($shelf, 20, 1)
+            'shelf'                   => $shelf,
+            'sortedVisibleShelfBooks' => $sortedVisibleShelfBooks,
+            'view'                    => $view,
+            'activity'                => $activities->entityActivity($shelf, 20, 1),
+            'order'                   => $order,
+            'sort'                    => $sort,

         ]);
     }
 
         ]);
     }
 


@@ -122,13 +132,14 @@ class BookshelfController extends Controller
      */
     public function edit(string $slug)
     {
      */
     public function edit(string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('bookshelf-update', $shelf);
 
         $shelfBookIds = $shelf->books()->get(['id'])->pluck('id');
         $this->checkOwnablePermission('bookshelf-update', $shelf);
 
         $shelfBookIds = $shelf->books()->get(['id'])->pluck('id');

-        $books = Book::hasPermission('update')->whereNotIn('id', $shelfBookIds)->get();
+        $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,


@@ -137,53 +148,58 @@ class BookshelfController extends Controller
 
     /**
      * Update the specified bookshelf in storage.
 
     /**
      * Update the specified bookshelf in storage.

+     *

      * @throws ValidationException
      * @throws ImageUploadException
      * @throws NotFoundException
      */
     public function update(Request $request, string $slug)
     {
      * @throws ValidationException
      * @throws ImageUploadException
      * @throws NotFoundException
      */
     public function update(Request $request, string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $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'],

         ]);
 
         ]);
 

+        if ($request->has('image_reset')) {
+            $validated['image'] = null;
+        } elseif (array_key_exists('image', $validated) && is_null($validated['image'])) {
+            unset($validated['image']);
+        }

 
         $bookIds = explode(',', $request->get('books', ''));
 
         $bookIds = explode(',', $request->get('books', ''));

-        $shelf = $this->bookshelfRepo->update($shelf, $request->all(), $bookIds);
-        $resetCover = $request->has('image_reset');
-        $this->bookshelfRepo->updateCoverImage($shelf, $request->file('image', null), $resetCover);
-        Activity::add($shelf, 'bookshelf_update');
+        $shelf = $this->shelfRepo->update($shelf, $validated, $bookIds);

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

-     * Shows the page to confirm deletion
+     * Shows the page to confirm deletion.

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

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $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.

+     *

      * @throws Exception
      */
     public function destroy(string $slug)
     {
      * @throws Exception
      */
     public function destroy(string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

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

-        Activity::addMessage('bookshelf_delete', $shelf->name);
-        $this->bookshelfRepo->destroy($shelf);
+        $this->shelfRepo->destroy($shelf);

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


@@ -193,7 +209,7 @@ class BookshelfController extends Controller
      */
     public function showPermissions(string $slug)
     {
      */
     public function showPermissions(string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('restrictions-manage', $shelf);
 
         return view('shelves.permissions', [
         $this->checkOwnablePermission('restrictions-manage', $shelf);
 
         return view('shelves.permissions', [


@@ -204,16 +220,15 @@ class BookshelfController extends Controller
     /**
      * Set the permissions for this bookshelf.
      */
     /**
      * Set the permissions for this bookshelf.
      */

-    public function permissions(Request $request, string $slug)
+    public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $slug)

     {
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('restrictions-manage', $shelf);
 
         $this->checkOwnablePermission('restrictions-manage', $shelf);
 

-        $restricted = $request->get('restricted') === 'true';
-        $permissions = $request->filled('restrictions') ? collect($request->get('restrictions')) : null;
-        $this->bookshelfRepo->updatePermissions($shelf, $restricted, $permissions);
+        $permissionsUpdater->updateFromPermissionsForm($shelf, $request);

 
         $this->showSuccessNotification(trans('entities.shelves_permissions_updated'));
 
         $this->showSuccessNotification(trans('entities.shelves_permissions_updated'));

+

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


@@ -222,11 +237,12 @@ class BookshelfController extends Controller
      */
     public function copyPermissions(string $slug)
     {
      */
     public function copyPermissions(string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('restrictions-manage', $shelf);
 
         $this->checkOwnablePermission('restrictions-manage', $shelf);
 

-        $updateCount = $this->bookshelfRepo->copyDownPermissions($shelf);
+        $updateCount = $this->shelfRepo->copyDownPermissions($shelf);

         $this->showSuccessNotification(trans('entities.shelves_copy_permission_success', ['count' => $updateCount]));
         $this->showSuccessNotification(trans('entities.shelves_copy_permission_success', ['count' => $updateCount]));

+

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