1 <?php namespace BookStack\Http\Controllers;
4 use BookStack\Entities\Models\Book;
5 use BookStack\Entities\Tools\PermissionsUpdater;
6 use BookStack\Entities\Tools\ShelfContext;
7 use BookStack\Entities\Repos\BookshelfRepo;
8 use BookStack\Exceptions\ImageUploadException;
9 use BookStack\Exceptions\NotFoundException;
10 use BookStack\Uploads\ImageRepo;
12 use Illuminate\Http\Request;
13 use Illuminate\Validation\ValidationException;
16 class BookshelfController extends Controller
19 protected $bookshelfRepo;
20 protected $entityContextManager;
23 public function __construct(BookshelfRepo $bookshelfRepo, ShelfContext $entityContextManager, ImageRepo $imageRepo)
25 $this->bookshelfRepo = $bookshelfRepo;
26 $this->entityContextManager = $entityContextManager;
27 $this->imageRepo = $imageRepo;
31 * Display a listing of the book.
33 public function index()
35 $view = setting()->getForCurrentUser('bookshelves_view_type', config('app.views.bookshelves', 'grid'));
36 $sort = setting()->getForCurrentUser('bookshelves_sort', 'name');
37 $order = setting()->getForCurrentUser('bookshelves_sort_order', 'asc');
39 'name' => trans('common.sort_name'),
40 'created_at' => trans('common.sort_created_at'),
41 'updated_at' => trans('common.sort_updated_at'),
44 $shelves = $this->bookshelfRepo->getAllPaginated(18, $sort, $order);
45 $recents = $this->isSignedIn() ? $this->bookshelfRepo->getRecentlyViewed(4) : false;
46 $popular = $this->bookshelfRepo->getPopular(4);
47 $new = $this->bookshelfRepo->getRecentlyCreated(4);
49 $this->entityContextManager->clearShelfContext();
50 $this->setPageTitle(trans('entities.shelves'));
51 return view('shelves.index', [
52 'shelves' => $shelves,
53 'recents' => $recents,
54 'popular' => $popular,
59 'sortOptions' => $sortOptions,
64 * Show the form for creating a new bookshelf.
66 public function create()
68 $this->checkPermission('bookshelf-create-all');
69 $books = Book::hasPermission('update')->get();
70 $this->setPageTitle(trans('entities.shelves_create'));
71 return view('shelves.create', ['books' => $books]);
75 * Store a newly created bookshelf in storage.
76 * @throws ValidationException
77 * @throws ImageUploadException
79 public function store(Request $request)
81 $this->checkPermission('bookshelf-create-all');
82 $this->validate($request, [
83 'name' => 'required|string|max:255',
84 'description' => 'string|max:1000',
85 'image' => 'nullable|' . $this->getImageValidationRules(),
88 $bookIds = explode(',', $request->get('books', ''));
89 $shelf = $this->bookshelfRepo->create($request->all(), $bookIds);
90 $this->bookshelfRepo->updateCoverImage($shelf, $request->file('image', null));
92 return redirect($shelf->getUrl());
96 * Display the bookshelf of the given slug.
97 * @throws NotFoundException
99 public function show(string $slug)
101 $shelf = $this->bookshelfRepo->getBySlug($slug);
102 $this->checkOwnablePermission('book-view', $shelf);
105 $this->entityContextManager->setShelfContext($shelf->id);
106 $view = setting()->getForCurrentUser('bookshelf_view_type', config('app.views.books'));
108 $this->setPageTitle($shelf->getShortName());
109 return view('shelves.show', [
112 'activity' => Activity::entityActivity($shelf, 20, 1)
117 * Show the form for editing the specified bookshelf.
119 public function edit(string $slug)
121 $shelf = $this->bookshelfRepo->getBySlug($slug);
122 $this->checkOwnablePermission('bookshelf-update', $shelf);
124 $shelfBookIds = $shelf->books()->get(['id'])->pluck('id');
125 $books = Book::hasPermission('update')->whereNotIn('id', $shelfBookIds)->get();
127 $this->setPageTitle(trans('entities.shelves_edit_named', ['name' => $shelf->getShortName()]));
128 return view('shelves.edit', [
135 * Update the specified bookshelf in storage.
136 * @throws ValidationException
137 * @throws ImageUploadException
138 * @throws NotFoundException
140 public function update(Request $request, string $slug)
142 $shelf = $this->bookshelfRepo->getBySlug($slug);
143 $this->checkOwnablePermission('bookshelf-update', $shelf);
144 $this->validate($request, [
145 'name' => 'required|string|max:255',
146 'description' => 'string|max:1000',
147 'image' => 'nullable|' . $this->getImageValidationRules(),
151 $bookIds = explode(',', $request->get('books', ''));
152 $shelf = $this->bookshelfRepo->update($shelf, $request->all(), $bookIds);
153 $resetCover = $request->has('image_reset');
154 $this->bookshelfRepo->updateCoverImage($shelf, $request->file('image', null), $resetCover);
156 return redirect($shelf->getUrl());
160 * Shows the page to confirm deletion
162 public function showDelete(string $slug)
164 $shelf = $this->bookshelfRepo->getBySlug($slug);
165 $this->checkOwnablePermission('bookshelf-delete', $shelf);
167 $this->setPageTitle(trans('entities.shelves_delete_named', ['name' => $shelf->getShortName()]));
168 return view('shelves.delete', ['shelf' => $shelf]);
172 * Remove the specified bookshelf from storage.
175 public function destroy(string $slug)
177 $shelf = $this->bookshelfRepo->getBySlug($slug);
178 $this->checkOwnablePermission('bookshelf-delete', $shelf);
180 $this->bookshelfRepo->destroy($shelf);
182 return redirect('/shelves');
186 * Show the permissions view.
188 public function showPermissions(string $slug)
190 $shelf = $this->bookshelfRepo->getBySlug($slug);
191 $this->checkOwnablePermission('restrictions-manage', $shelf);
193 return view('shelves.permissions', [
199 * Set the permissions for this bookshelf.
201 public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $slug)
203 $shelf = $this->bookshelfRepo->getBySlug($slug);
204 $this->checkOwnablePermission('restrictions-manage', $shelf);
206 $permissionsUpdater->updateFromPermissionsForm($shelf, $request);
208 $this->showSuccessNotification(trans('entities.shelves_permissions_updated'));
209 return redirect($shelf->getUrl());
213 * Copy the permissions of a bookshelf to the child books.
215 public function copyPermissions(string $slug)
217 $shelf = $this->bookshelfRepo->getBySlug($slug);
218 $this->checkOwnablePermission('restrictions-manage', $shelf);
220 $updateCount = $this->bookshelfRepo->copyDownPermissions($shelf);
221 $this->showSuccessNotification(trans('entities.shelves_copy_permission_success', ['count' => $updateCount]));
222 return redirect($shelf->getUrl());