-<?php namespace BookStack\Http\Controllers;
+<?php
-use Activity;
+namespace BookStack\Http\Controllers;
+
+use BookStack\Actions\ActivityQueries;
+use BookStack\Actions\View;
use BookStack\Entities\Models\Book;
-use BookStack\Entities\Tools\PermissionsUpdater;
-use BookStack\Entities\Tools\ShelfContext;
use BookStack\Entities\Repos\BookshelfRepo;
+use BookStack\Entities\Tools\ShelfContext;
use BookStack\Exceptions\ImageUploadException;
use BookStack\Exceptions\NotFoundException;
-use BookStack\Uploads\ImageRepo;
+use BookStack\References\ReferenceFetcher;
+use BookStack\Util\SimpleListOptions;
use Exception;
use Illuminate\Http\Request;
use Illuminate\Validation\ValidationException;
-use Views;
class BookshelfController extends Controller
{
+ protected BookshelfRepo $shelfRepo;
+ protected ShelfContext $shelfContext;
+ protected ReferenceFetcher $referenceFetcher;
- protected $bookshelfRepo;
- protected $entityContextManager;
- protected $imageRepo;
-
- public function __construct(BookshelfRepo $bookshelfRepo, ShelfContext $entityContextManager, ImageRepo $imageRepo)
+ public function __construct(BookshelfRepo $shelfRepo, ShelfContext $shelfContext, ReferenceFetcher $referenceFetcher)
{
- $this->bookshelfRepo = $bookshelfRepo;
- $this->entityContextManager = $entityContextManager;
- $this->imageRepo = $imageRepo;
+ $this->shelfRepo = $shelfRepo;
+ $this->shelfContext = $shelfContext;
+ $this->referenceFetcher = $referenceFetcher;
}
/**
* Display a listing of the book.
*/
- public function index()
+ public function index(Request $request)
{
- $view = setting()->getForCurrentUser('bookshelves_view_type', config('app.views.bookshelves', 'grid'));
- $sort = setting()->getForCurrentUser('bookshelves_sort', 'name');
- $order = setting()->getForCurrentUser('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'),
- ];
+ ]);
- $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, $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'));
+
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,
]);
}
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'));
+
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');
- $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'],
]);
$bookIds = explode(',', $request->get('books', ''));
- $shelf = $this->bookshelfRepo->create($request->all(), $bookIds);
- $this->bookshelfRepo->updateCoverImage($shelf, $request->file('image', null));
+ $shelf = $this->shelfRepo->create($validated, $bookIds);
return redirect($shelf->getUrl());
}
/**
* Display the bookshelf of the given slug.
+ *
* @throws NotFoundException
*/
- public function show(string $slug)
+ public function show(Request $request, ActivityQueries $activities, string $slug)
{
- $shelf = $this->bookshelfRepo->getBySlug($slug);
- $this->checkOwnablePermission('book-view', $shelf);
+ $shelf = $this->shelfRepo->getBySlug($slug);
+ $this->checkOwnablePermission('bookshelf-view', $shelf);
- Views::add($shelf);
- $this->entityContextManager->setShelfContext($shelf->id);
- $view = setting()->getForCurrentUser('bookshelf_view_type', config('app.views.books'));
+ $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'),
+ ]);
+
+ $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', [
- 'shelf' => $shelf,
- 'view' => $view,
- '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),
]);
}
*/
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');
- $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()]));
+
return view('shelves.edit', [
'shelf' => $shelf,
'books' => $books,
/**
* Update the specified bookshelf in storage.
+ *
* @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->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'],
]);
+ 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', ''));
- $shelf = $this->bookshelfRepo->update($shelf, $request->all(), $bookIds);
- $resetCover = $request->has('image_reset');
- $this->bookshelfRepo->updateCoverImage($shelf, $request->file('image', null), $resetCover);
+ $shelf = $this->shelfRepo->update($shelf, $validated, $bookIds);
return redirect($shelf->getUrl());
}
/**
- * Shows the page to confirm deletion
+ * Shows the page to confirm deletion.
*/
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()]));
+
return view('shelves.delete', ['shelf' => $shelf]);
}
/**
* Remove the specified bookshelf from storage.
+ *
* @throws Exception
*/
public function destroy(string $slug)
{
- $shelf = $this->bookshelfRepo->getBySlug($slug);
+ $shelf = $this->shelfRepo->getBySlug($slug);
$this->checkOwnablePermission('bookshelf-delete', $shelf);
- $this->bookshelfRepo->destroy($shelf);
+ $this->shelfRepo->destroy($shelf);
return redirect('/shelves');
}
-
- /**
- * Show the permissions view.
- */
- public function showPermissions(string $slug)
- {
- $shelf = $this->bookshelfRepo->getBySlug($slug);
- $this->checkOwnablePermission('restrictions-manage', $shelf);
-
- return view('shelves.permissions', [
- 'shelf' => $shelf,
- ]);
- }
-
- /**
- * Set the permissions for this bookshelf.
- */
- public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $slug)
- {
- $shelf = $this->bookshelfRepo->getBySlug($slug);
- $this->checkOwnablePermission('restrictions-manage', $shelf);
-
- $permissionsUpdater->updateFromPermissionsForm($shelf, $request);
-
- $this->showSuccessNotification(trans('entities.shelves_permissions_updated'));
- return redirect($shelf->getUrl());
- }
-
- /**
- * Copy the permissions of a bookshelf to the child books.
- */
- public function copyPermissions(string $slug)
- {
- $shelf = $this->bookshelfRepo->getBySlug($slug);
- $this->checkOwnablePermission('restrictions-manage', $shelf);
-
- $updateCount = $this->bookshelfRepo->copyDownPermissions($shelf);
- $this->showSuccessNotification(trans('entities.shelves_copy_permission_success', ['count' => $updateCount]));
- return redirect($shelf->getUrl());
- }
}
projects / bookstack / blobdiff