BookStack Code Mirror - bookstack/blob - app/Http/Controllers/BookshelfController.php

   1 <?php
   2
   3 namespace BookStack\Http\Controllers;
   4
   5 use BookStack\Actions\ActivityQueries;
   6 use BookStack\Actions\View;
   7 use BookStack\Entities\Models\Book;
   8 use BookStack\Entities\Repos\BookshelfRepo;
   9 use BookStack\Entities\Tools\PermissionsUpdater;
  10 use BookStack\Entities\Tools\ShelfContext;
  11 use BookStack\Exceptions\ImageUploadException;
  12 use BookStack\Exceptions\NotFoundException;
  13 use BookStack\References\ReferenceFetcher;
  14 use Exception;
  15 use Illuminate\Http\Request;
  16 use Illuminate\Validation\ValidationException;
  17
  18 class BookshelfController extends Controller
  19 {
  20     protected BookshelfRepo $shelfRepo;
  21     protected ShelfContext $shelfContext;
  22     protected ReferenceFetcher $referenceFetcher;
  23
  24     public function __construct(BookshelfRepo $shelfRepo, ShelfContext $shelfContext, ReferenceFetcher $referenceFetcher)
  25     {
  26         $this->shelfRepo = $shelfRepo;
  27         $this->shelfContext = $shelfContext;
  28         $this->referenceFetcher = $referenceFetcher;
  29     }
  30
  31     /**
  32      * Display a listing of the book.
  33      */
  34     public function index()
  35     {
  36         $view = setting()->getForCurrentUser('bookshelves_view_type');
  37         $sort = setting()->getForCurrentUser('bookshelves_sort', 'name');
  38         $order = setting()->getForCurrentUser('bookshelves_sort_order', 'asc');
  39         $sortOptions = [
  40             'name'       => trans('common.sort_name'),
  41             'created_at' => trans('common.sort_created_at'),
  42             'updated_at' => trans('common.sort_updated_at'),
  43         ];
  44
  45         $shelves = $this->shelfRepo->getAllPaginated(18, $sort, $order);
  46         $recents = $this->isSignedIn() ? $this->shelfRepo->getRecentlyViewed(4) : false;
  47         $popular = $this->shelfRepo->getPopular(4);
  48         $new = $this->shelfRepo->getRecentlyCreated(4);
  49
  50         $this->shelfContext->clearShelfContext();
  51         $this->setPageTitle(trans('entities.shelves'));
  52
  53         return view('shelves.index', [
  54             'shelves'     => $shelves,
  55             'recents'     => $recents,
  56             'popular'     => $popular,
  57             'new'         => $new,
  58             'view'        => $view,
  59             'sort'        => $sort,
  60             'order'       => $order,
  61             'sortOptions' => $sortOptions,
  62         ]);
  63     }
  64
  65     /**
  66      * Show the form for creating a new bookshelf.
  67      */
  68     public function create()
  69     {
  70         $this->checkPermission('bookshelf-create-all');
  71         $books = Book::visible()->orderBy('name')->get(['name', 'id', 'slug']);
  72         $this->setPageTitle(trans('entities.shelves_create'));
  73
  74         return view('shelves.create', ['books' => $books]);
  75     }
  76
  77     /**
  78      * Store a newly created bookshelf in storage.
  79      *
  80      * @throws ValidationException
  81      * @throws ImageUploadException
  82      */
  83     public function store(Request $request)
  84     {
  85         $this->checkPermission('bookshelf-create-all');
  86         $validated = $this->validate($request, [
  87             'name'        => ['required', 'string', 'max:255'],
  88             'description' => ['string', 'max:1000'],
  89             'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
  90             'tags'        => ['array'],
  91         ]);
  92
  93         $bookIds = explode(',', $request->get('books', ''));
  94         $shelf = $this->shelfRepo->create($validated, $bookIds);
  95
  96         return redirect($shelf->getUrl());
  97     }
  98
  99     /**
 100      * Display the bookshelf of the given slug.
 101      *
 102      * @throws NotFoundException
 103      */
 104     public function show(ActivityQueries $activities, string $slug)
 105     {
 106         $shelf = $this->shelfRepo->getBySlug($slug);
 107         $this->checkOwnablePermission('bookshelf-view', $shelf);
 108
 109         $sort = setting()->getForCurrentUser('shelf_books_sort', 'default');
 110         $order = setting()->getForCurrentUser('shelf_books_sort_order', 'asc');
 111
 112         $sortedVisibleShelfBooks = $shelf->visibleBooks()->get()
 113             ->sortBy($sort === 'default' ? 'pivot.order' : $sort, SORT_REGULAR, $order === 'desc')
 114             ->values()
 115             ->all();
 116
 117         View::incrementFor($shelf);
 118         $this->shelfContext->setShelfContext($shelf->id);
 119         $view = setting()->getForCurrentUser('bookshelf_view_type');
 120
 121         $this->setPageTitle($shelf->getShortName());
 122
 123         return view('shelves.show', [
 124             'shelf'                   => $shelf,
 125             'sortedVisibleShelfBooks' => $sortedVisibleShelfBooks,
 126             'view'                    => $view,
 127             'activity'                => $activities->entityActivity($shelf, 20, 1),
 128             'order'                   => $order,
 129             'sort'                    => $sort,
 130             'referenceCount'          => $this->referenceFetcher->getPageReferenceCountToEntity($shelf),
 131         ]);
 132     }
 133
 134     /**
 135      * Show the form for editing the specified bookshelf.
 136      */
 137     public function edit(string $slug)
 138     {
 139         $shelf = $this->shelfRepo->getBySlug($slug);
 140         $this->checkOwnablePermission('bookshelf-update', $shelf);
 141
 142         $shelfBookIds = $shelf->books()->get(['id'])->pluck('id');
 143         $books = Book::visible()->whereNotIn('id', $shelfBookIds)->orderBy('name')->get(['name', 'id', 'slug']);
 144
 145         $this->setPageTitle(trans('entities.shelves_edit_named', ['name' => $shelf->getShortName()]));
 146
 147         return view('shelves.edit', [
 148             'shelf' => $shelf,
 149             'books' => $books,
 150         ]);
 151     }
 152
 153     /**
 154      * Update the specified bookshelf in storage.
 155      *
 156      * @throws ValidationException
 157      * @throws ImageUploadException
 158      * @throws NotFoundException
 159      */
 160     public function update(Request $request, string $slug)
 161     {
 162         $shelf = $this->shelfRepo->getBySlug($slug);
 163         $this->checkOwnablePermission('bookshelf-update', $shelf);
 164         $validated = $this->validate($request, [
 165             'name'        => ['required', 'string', 'max:255'],
 166             'description' => ['string', 'max:1000'],
 167             'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
 168             'tags'        => ['array'],
 169         ]);
 170
 171         if ($request->has('image_reset')) {
 172             $validated['image'] = null;
 173         } elseif (array_key_exists('image', $validated) && is_null($validated['image'])) {
 174             unset($validated['image']);
 175         }
 176
 177         $bookIds = explode(',', $request->get('books', ''));
 178         $shelf = $this->shelfRepo->update($shelf, $validated, $bookIds);
 179
 180         return redirect($shelf->getUrl());
 181     }
 182
 183     /**
 184      * Shows the page to confirm deletion.
 185      */
 186     public function showDelete(string $slug)
 187     {
 188         $shelf = $this->shelfRepo->getBySlug($slug);
 189         $this->checkOwnablePermission('bookshelf-delete', $shelf);
 190
 191         $this->setPageTitle(trans('entities.shelves_delete_named', ['name' => $shelf->getShortName()]));
 192
 193         return view('shelves.delete', ['shelf' => $shelf]);
 194     }
 195
 196     /**
 197      * Remove the specified bookshelf from storage.
 198      *
 199      * @throws Exception
 200      */
 201     public function destroy(string $slug)
 202     {
 203         $shelf = $this->shelfRepo->getBySlug($slug);
 204         $this->checkOwnablePermission('bookshelf-delete', $shelf);
 205
 206         $this->shelfRepo->destroy($shelf);
 207
 208         return redirect('/shelves');
 209     }
 210
 211     /**
 212      * Show the permissions view.
 213      */
 214     public function showPermissions(string $slug)
 215     {
 216         $shelf = $this->shelfRepo->getBySlug($slug);
 217         $this->checkOwnablePermission('restrictions-manage', $shelf);
 218
 219         return view('shelves.permissions', [
 220             'shelf' => $shelf,
 221         ]);
 222     }
 223
 224     /**
 225      * Set the permissions for this bookshelf.
 226      */
 227     public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $slug)
 228     {
 229         $shelf = $this->shelfRepo->getBySlug($slug);
 230         $this->checkOwnablePermission('restrictions-manage', $shelf);
 231
 232         $permissionsUpdater->updateFromPermissionsForm($shelf, $request);
 233
 234         $this->showSuccessNotification(trans('entities.shelves_permissions_updated'));
 235
 236         return redirect($shelf->getUrl());
 237     }
 238
 239     /**
 240      * Copy the permissions of a bookshelf to the child books.
 241      */
 242     public function copyPermissions(string $slug)
 243     {
 244         $shelf = $this->shelfRepo->getBySlug($slug);
 245         $this->checkOwnablePermission('restrictions-manage', $shelf);
 246
 247         $updateCount = $this->shelfRepo->copyDownPermissions($shelf);
 248         $this->showSuccessNotification(trans('entities.shelves_copy_permission_success', ['count' => $updateCount]));
 249
 250         return redirect($shelf->getUrl());
 251     }
 252 }