2021-06-26 11:23:15 -04:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace BookStack\Http\Controllers;
|
2018-08-27 09:18:09 -04:00
|
|
|
|
2021-12-11 12:29:33 -05:00
|
|
|
use BookStack\Actions\ActivityQueries;
|
2021-05-16 05:49:37 -04:00
|
|
|
use BookStack\Actions\View;
|
2020-11-21 19:17:45 -05:00
|
|
|
use BookStack\Entities\Models\Book;
|
2021-06-26 11:23:15 -04:00
|
|
|
use BookStack\Entities\Repos\BookshelfRepo;
|
2021-01-01 12:49:48 -05:00
|
|
|
use BookStack\Entities\Tools\PermissionsUpdater;
|
2020-11-21 18:20:54 -05:00
|
|
|
use BookStack\Entities\Tools\ShelfContext;
|
2019-10-05 07:55:01 -04:00
|
|
|
use BookStack\Exceptions\ImageUploadException;
|
|
|
|
use BookStack\Exceptions\NotFoundException;
|
2019-04-27 09:55:23 -04:00
|
|
|
use BookStack\Uploads\ImageRepo;
|
2019-10-05 07:55:01 -04:00
|
|
|
use Exception;
|
2018-08-27 09:18:09 -04:00
|
|
|
use Illuminate\Http\Request;
|
2019-10-05 07:55:01 -04:00
|
|
|
use Illuminate\Validation\ValidationException;
|
2018-08-27 09:18:09 -04:00
|
|
|
|
|
|
|
class BookshelfController extends Controller
|
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
protected $bookshelfRepo;
|
2019-04-07 13:28:11 -04:00
|
|
|
protected $entityContextManager;
|
2019-04-27 09:55:23 -04:00
|
|
|
protected $imageRepo;
|
2018-08-27 09:18:09 -04:00
|
|
|
|
2020-11-21 18:20:54 -05:00
|
|
|
public function __construct(BookshelfRepo $bookshelfRepo, ShelfContext $entityContextManager, ImageRepo $imageRepo)
|
2018-08-27 09:18:09 -04:00
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
$this->bookshelfRepo = $bookshelfRepo;
|
2019-04-07 13:28:11 -04:00
|
|
|
$this->entityContextManager = $entityContextManager;
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->imageRepo = $imageRepo;
|
2018-08-27 09:18:09 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Display a listing of the book.
|
|
|
|
*/
|
|
|
|
public function index()
|
|
|
|
{
|
2021-02-07 18:12:05 -05:00
|
|
|
$view = setting()->getForCurrentUser('bookshelves_view_type');
|
2019-09-19 19:18:28 -04:00
|
|
|
$sort = setting()->getForCurrentUser('bookshelves_sort', 'name');
|
|
|
|
$order = setting()->getForCurrentUser('bookshelves_sort_order', 'asc');
|
2019-02-03 08:45:45 -05:00
|
|
|
$sortOptions = [
|
2021-06-26 11:23:15 -04:00
|
|
|
'name' => trans('common.sort_name'),
|
2019-02-03 08:45:45 -05:00
|
|
|
'created_at' => trans('common.sort_created_at'),
|
|
|
|
'updated_at' => trans('common.sort_updated_at'),
|
|
|
|
];
|
|
|
|
|
2019-10-05 07:55:01 -04:00
|
|
|
$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);
|
2019-02-03 08:45:45 -05:00
|
|
|
|
2019-04-07 13:28:11 -04:00
|
|
|
$this->entityContextManager->clearShelfContext();
|
2018-08-27 09:18:09 -04:00
|
|
|
$this->setPageTitle(trans('entities.shelves'));
|
2021-06-26 11:23:15 -04:00
|
|
|
|
2019-02-02 06:41:41 -05:00
|
|
|
return view('shelves.index', [
|
2021-06-26 11:23:15 -04:00
|
|
|
'shelves' => $shelves,
|
|
|
|
'recents' => $recents,
|
|
|
|
'popular' => $popular,
|
|
|
|
'new' => $new,
|
|
|
|
'view' => $view,
|
|
|
|
'sort' => $sort,
|
|
|
|
'order' => $order,
|
2019-02-03 08:45:45 -05:00
|
|
|
'sortOptions' => $sortOptions,
|
2018-08-27 09:18:09 -04:00
|
|
|
]);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Show the form for creating a new bookshelf.
|
|
|
|
*/
|
|
|
|
public function create()
|
|
|
|
{
|
|
|
|
$this->checkPermission('bookshelf-create-all');
|
2022-07-16 08:17:08 -04:00
|
|
|
$books = Book::visible()->get();
|
2018-09-16 14:34:09 -04:00
|
|
|
$this->setPageTitle(trans('entities.shelves_create'));
|
2021-06-26 11:23:15 -04:00
|
|
|
|
2019-02-02 06:41:41 -05:00
|
|
|
return view('shelves.create', ['books' => $books]);
|
2018-08-27 09:18:09 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-09-16 14:34:09 -04:00
|
|
|
* Store a newly created bookshelf in storage.
|
2021-06-26 11:23:15 -04:00
|
|
|
*
|
2019-10-05 07:55:01 -04:00
|
|
|
* @throws ValidationException
|
|
|
|
* @throws ImageUploadException
|
2018-08-27 09:18:09 -04:00
|
|
|
*/
|
|
|
|
public function store(Request $request)
|
|
|
|
{
|
|
|
|
$this->checkPermission('bookshelf-create-all');
|
2022-06-13 12:20:21 -04:00
|
|
|
$validated = $this->validate($request, [
|
2021-11-04 20:26:55 -04:00
|
|
|
'name' => ['required', 'string', 'max:255'],
|
|
|
|
'description' => ['string', 'max:1000'],
|
|
|
|
'image' => array_merge(['nullable'], $this->getImageValidationRules()),
|
2022-06-19 13:44:34 -04:00
|
|
|
'tags' => ['array'],
|
2018-08-27 09:18:09 -04:00
|
|
|
]);
|
|
|
|
|
2019-10-05 07:55:01 -04:00
|
|
|
$bookIds = explode(',', $request->get('books', ''));
|
2022-06-13 12:20:21 -04:00
|
|
|
$shelf = $this->bookshelfRepo->create($validated, $bookIds);
|
2018-08-27 09:18:09 -04:00
|
|
|
|
2019-04-27 09:55:23 -04:00
|
|
|
return redirect($shelf->getUrl());
|
2018-08-27 09:18:09 -04:00
|
|
|
}
|
|
|
|
|
2018-09-16 14:34:09 -04:00
|
|
|
/**
|
2019-10-05 07:55:01 -04:00
|
|
|
* Display the bookshelf of the given slug.
|
2021-06-26 11:23:15 -04:00
|
|
|
*
|
2019-10-05 07:55:01 -04:00
|
|
|
* @throws NotFoundException
|
2018-09-16 14:34:09 -04:00
|
|
|
*/
|
2021-12-11 12:29:33 -05:00
|
|
|
public function show(ActivityQueries $activities, string $slug)
|
2018-09-16 14:34:09 -04:00
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
$shelf = $this->bookshelfRepo->getBySlug($slug);
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->checkOwnablePermission('book-view', $shelf);
|
2018-09-16 14:34:09 -04:00
|
|
|
|
2021-03-21 19:06:15 -04:00
|
|
|
$sort = setting()->getForCurrentUser('shelf_books_sort', 'default');
|
2021-01-30 22:25:31 -05:00
|
|
|
$order = setting()->getForCurrentUser('shelf_books_sort_order', 'asc');
|
|
|
|
|
2021-03-21 19:06:15 -04:00
|
|
|
$sortedVisibleShelfBooks = $shelf->visibleBooks()->get()
|
|
|
|
->sortBy($sort === 'default' ? 'pivot.order' : $sort, SORT_REGULAR, $order === 'desc')
|
2021-01-30 22:25:31 -05:00
|
|
|
->values()
|
|
|
|
->all();
|
2021-01-29 01:58:17 -05:00
|
|
|
|
2021-05-16 05:49:37 -04:00
|
|
|
View::incrementFor($shelf);
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->entityContextManager->setShelfContext($shelf->id);
|
2021-02-07 18:12:05 -05:00
|
|
|
$view = setting()->getForCurrentUser('bookshelf_view_type');
|
2018-09-16 14:34:09 -04:00
|
|
|
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->setPageTitle($shelf->getShortName());
|
2021-06-26 11:23:15 -04:00
|
|
|
|
2019-02-02 06:41:41 -05:00
|
|
|
return view('shelves.show', [
|
2021-06-26 11:23:15 -04:00
|
|
|
'shelf' => $shelf,
|
2021-01-30 22:25:31 -05:00
|
|
|
'sortedVisibleShelfBooks' => $sortedVisibleShelfBooks,
|
2021-06-26 11:23:15 -04:00
|
|
|
'view' => $view,
|
2021-12-11 12:29:33 -05:00
|
|
|
'activity' => $activities->entityActivity($shelf, 20, 1),
|
2021-06-26 11:23:15 -04:00
|
|
|
'order' => $order,
|
|
|
|
'sort' => $sort,
|
2018-09-16 14:34:09 -04:00
|
|
|
]);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Show the form for editing the specified bookshelf.
|
|
|
|
*/
|
|
|
|
public function edit(string $slug)
|
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
$shelf = $this->bookshelfRepo->getBySlug($slug);
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->checkOwnablePermission('bookshelf-update', $shelf);
|
2018-09-16 14:34:09 -04:00
|
|
|
|
2019-10-05 07:55:01 -04:00
|
|
|
$shelfBookIds = $shelf->books()->get(['id'])->pluck('id');
|
2022-07-16 08:17:08 -04:00
|
|
|
$books = Book::visible()->whereNotIn('id', $shelfBookIds)->get();
|
2018-09-16 14:34:09 -04:00
|
|
|
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->setPageTitle(trans('entities.shelves_edit_named', ['name' => $shelf->getShortName()]));
|
2021-06-26 11:23:15 -04:00
|
|
|
|
2019-02-02 06:41:41 -05:00
|
|
|
return view('shelves.edit', [
|
2019-04-27 09:55:23 -04:00
|
|
|
'shelf' => $shelf,
|
2018-09-16 14:34:09 -04:00
|
|
|
'books' => $books,
|
|
|
|
]);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Update the specified bookshelf in storage.
|
2021-06-26 11:23:15 -04:00
|
|
|
*
|
2019-10-05 07:55:01 -04:00
|
|
|
* @throws ValidationException
|
|
|
|
* @throws ImageUploadException
|
|
|
|
* @throws NotFoundException
|
2018-09-16 14:34:09 -04:00
|
|
|
*/
|
|
|
|
public function update(Request $request, string $slug)
|
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
$shelf = $this->bookshelfRepo->getBySlug($slug);
|
2018-09-16 14:34:09 -04:00
|
|
|
$this->checkOwnablePermission('bookshelf-update', $shelf);
|
2022-06-13 12:20:21 -04:00
|
|
|
$validated = $this->validate($request, [
|
2021-11-04 20:26:55 -04:00
|
|
|
'name' => ['required', 'string', 'max:255'],
|
|
|
|
'description' => ['string', 'max:1000'],
|
|
|
|
'image' => array_merge(['nullable'], $this->getImageValidationRules()),
|
2022-06-19 13:44:34 -04:00
|
|
|
'tags' => ['array'],
|
2018-09-16 14:34:09 -04:00
|
|
|
]);
|
|
|
|
|
2022-06-13 12:20:21 -04:00
|
|
|
if ($request->has('image_reset')) {
|
|
|
|
$validated['image'] = null;
|
2022-06-19 13:14:53 -04:00
|
|
|
} elseif (array_key_exists('image', $validated) && is_null($validated['image'])) {
|
2022-06-13 12:20:21 -04:00
|
|
|
unset($validated['image']);
|
|
|
|
}
|
|
|
|
|
2019-10-05 07:55:01 -04:00
|
|
|
$bookIds = explode(',', $request->get('books', ''));
|
2022-06-13 12:20:21 -04:00
|
|
|
$shelf = $this->bookshelfRepo->update($shelf, $validated, $bookIds);
|
2018-09-16 14:34:09 -04:00
|
|
|
|
2019-10-05 07:55:01 -04:00
|
|
|
return redirect($shelf->getUrl());
|
2018-09-16 14:34:09 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2021-06-26 11:23:15 -04:00
|
|
|
* Shows the page to confirm deletion.
|
2018-09-16 14:34:09 -04:00
|
|
|
*/
|
|
|
|
public function showDelete(string $slug)
|
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
$shelf = $this->bookshelfRepo->getBySlug($slug);
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->checkOwnablePermission('bookshelf-delete', $shelf);
|
2018-09-16 14:34:09 -04:00
|
|
|
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->setPageTitle(trans('entities.shelves_delete_named', ['name' => $shelf->getShortName()]));
|
2021-06-26 11:23:15 -04:00
|
|
|
|
2019-04-27 09:55:23 -04:00
|
|
|
return view('shelves.delete', ['shelf' => $shelf]);
|
2018-09-16 14:34:09 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Remove the specified bookshelf from storage.
|
2021-06-26 11:23:15 -04:00
|
|
|
*
|
2019-10-05 07:55:01 -04:00
|
|
|
* @throws Exception
|
2018-09-16 14:34:09 -04:00
|
|
|
*/
|
|
|
|
public function destroy(string $slug)
|
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
$shelf = $this->bookshelfRepo->getBySlug($slug);
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->checkOwnablePermission('bookshelf-delete', $shelf);
|
|
|
|
|
2019-10-05 07:55:01 -04:00
|
|
|
$this->bookshelfRepo->destroy($shelf);
|
2019-04-27 09:55:23 -04:00
|
|
|
|
2018-09-16 14:34:09 -04:00
|
|
|
return redirect('/shelves');
|
|
|
|
}
|
2018-09-20 14:16:11 -04:00
|
|
|
|
|
|
|
/**
|
2019-02-03 08:45:45 -05:00
|
|
|
* Show the permissions view.
|
2018-09-20 14:16:11 -04:00
|
|
|
*/
|
2019-02-03 08:45:45 -05:00
|
|
|
public function showPermissions(string $slug)
|
2018-09-20 14:16:11 -04:00
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
$shelf = $this->bookshelfRepo->getBySlug($slug);
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->checkOwnablePermission('restrictions-manage', $shelf);
|
2018-09-20 14:16:11 -04:00
|
|
|
|
2019-02-03 08:45:45 -05:00
|
|
|
return view('shelves.permissions', [
|
2019-04-27 09:55:23 -04:00
|
|
|
'shelf' => $shelf,
|
2018-09-20 14:16:11 -04:00
|
|
|
]);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-02-03 08:45:45 -05:00
|
|
|
* Set the permissions for this bookshelf.
|
2018-09-20 14:16:11 -04:00
|
|
|
*/
|
2021-01-01 12:49:48 -05:00
|
|
|
public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $slug)
|
2018-09-20 14:16:11 -04:00
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
$shelf = $this->bookshelfRepo->getBySlug($slug);
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->checkOwnablePermission('restrictions-manage', $shelf);
|
2018-09-20 14:16:11 -04:00
|
|
|
|
2021-01-01 12:49:48 -05:00
|
|
|
$permissionsUpdater->updateFromPermissionsForm($shelf, $request);
|
2019-10-05 07:55:01 -04:00
|
|
|
|
|
|
|
$this->showSuccessNotification(trans('entities.shelves_permissions_updated'));
|
2021-06-26 11:23:15 -04:00
|
|
|
|
2019-04-27 09:55:23 -04:00
|
|
|
return redirect($shelf->getUrl());
|
2018-09-20 14:16:11 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Copy the permissions of a bookshelf to the child books.
|
|
|
|
*/
|
|
|
|
public function copyPermissions(string $slug)
|
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
$shelf = $this->bookshelfRepo->getBySlug($slug);
|
2019-04-27 09:55:23 -04:00
|
|
|
$this->checkOwnablePermission('restrictions-manage', $shelf);
|
2018-09-20 14:16:11 -04:00
|
|
|
|
2019-10-05 07:55:01 -04:00
|
|
|
$updateCount = $this->bookshelfRepo->copyDownPermissions($shelf);
|
|
|
|
$this->showSuccessNotification(trans('entities.shelves_copy_permission_success', ['count' => $updateCount]));
|
2021-06-26 11:23:15 -04:00
|
|
|
|
2019-04-27 09:55:23 -04:00
|
|
|
return redirect($shelf->getUrl());
|
|
|
|
}
|
2018-08-27 09:18:09 -04:00
|
|
|
}
|