-<?php namespace BookStack\Http\Controllers;
+<?php
-use Activity;
-use BookStack\Auth\UserRepo;
-use BookStack\Entities\Book;
-use BookStack\Entities\EntityContextManager;
+namespace BookStack\Http\Controllers;
+
+use BookStack\Actions\ActivityQueries;
+use BookStack\Actions\ActivityType;
+use BookStack\Actions\View;
+use BookStack\Entities\Models\Bookshelf;
use BookStack\Entities\Repos\BookRepo;
-use BookStack\Entities\Repos\EntityRepo;
-use BookStack\Entities\ExportService;
+use BookStack\Entities\Tools\BookContents;
+use BookStack\Entities\Tools\Cloner;
+use BookStack\Entities\Tools\HierarchyTransformer;
+use BookStack\Entities\Tools\ShelfContext;
use BookStack\Exceptions\ImageUploadException;
use BookStack\Exceptions\NotFoundException;
-use BookStack\Exceptions\NotifyException;
-use BookStack\Uploads\ImageRepo;
-use Illuminate\Contracts\View\Factory;
-use Illuminate\Http\RedirectResponse;
+use BookStack\Facades\Activity;
+use BookStack\References\ReferenceFetcher;
+use BookStack\Util\SimpleListOptions;
use Illuminate\Http\Request;
-use Illuminate\Http\Response;
-use Illuminate\Routing\Redirector;
use Illuminate\Validation\ValidationException;
-use Illuminate\View\View;
use Throwable;
-use Views;
class BookController extends Controller
{
+ protected BookRepo $bookRepo;
+ protected ShelfContext $shelfContext;
+ protected ReferenceFetcher $referenceFetcher;
- protected $bookRepo;
- protected $userRepo;
- protected $entityContextManager;
- protected $imageRepo;
-
- /**
- * BookController constructor.
- * @param BookRepo $bookRepo
- * @param UserRepo $userRepo
- * @param EntityContextManager $entityContextManager
- * @param ImageRepo $imageRepo
- */
- public function __construct(
- BookRepo $bookRepo,
- UserRepo $userRepo,
- EntityContextManager $entityContextManager,
- ImageRepo $imageRepo
- ) {
+ public function __construct(ShelfContext $entityContextManager, BookRepo $bookRepo, ReferenceFetcher $referenceFetcher)
+ {
$this->bookRepo = $bookRepo;
- $this->userRepo = $userRepo;
- $this->entityContextManager = $entityContextManager;
- $this->imageRepo = $imageRepo;
- parent::__construct();
+ $this->shelfContext = $entityContextManager;
+ $this->referenceFetcher = $referenceFetcher;
}
/**
* Display a listing of the book.
- * @return Response
*/
- public function index()
+ public function index(Request $request)
{
- $view = setting()->getUser($this->currentUser, 'books_view_type', config('app.views.books'));
- $sort = setting()->getUser($this->currentUser, 'books_sort', 'name');
- $order = setting()->getUser($this->currentUser, 'books_sort_order', 'asc');
- $sortOptions = [
+ $view = setting()->getForCurrentUser('books_view_type');
+ $listOptions = SimpleListOptions::fromRequest($request, 'books')->withSortOptions([
'name' => trans('common.sort_name'),
'created_at' => trans('common.sort_created_at'),
'updated_at' => trans('common.sort_updated_at'),
- ];
+ ]);
- $books = $this->bookRepo->getAllPaginated('book', 18, $sort, $order);
- $recents = $this->signedIn ? $this->bookRepo->getRecentlyViewed('book', 4, 0) : false;
- $popular = $this->bookRepo->getPopular('book', 4, 0);
- $new = $this->bookRepo->getRecentlyCreated('book', 4, 0);
+ $books = $this->bookRepo->getAllPaginated(18, $listOptions->getSort(), $listOptions->getOrder());
+ $recents = $this->isSignedIn() ? $this->bookRepo->getRecentlyViewed(4) : false;
+ $popular = $this->bookRepo->getPopular(4);
+ $new = $this->bookRepo->getRecentlyCreated(4);
- $this->entityContextManager->clearShelfContext();
+ $this->shelfContext->clearShelfContext();
$this->setPageTitle(trans('entities.books'));
+
return view('books.index', [
- 'books' => $books,
+ 'books' => $books,
'recents' => $recents,
'popular' => $popular,
- 'new' => $new,
- 'view' => $view,
- 'sort' => $sort,
- 'order' => $order,
- 'sortOptions' => $sortOptions,
+ 'new' => $new,
+ 'view' => $view,
+ 'listOptions' => $listOptions,
]);
}
/**
* Show the form for creating a new book.
- * @param string $shelfSlug
- * @return Response
- * @throws NotFoundException
*/
public function create(string $shelfSlug = null)
{
+ $this->checkPermission('book-create-all');
+
$bookshelf = null;
if ($shelfSlug !== null) {
- $bookshelf = $this->bookRepo->getEntityBySlug('bookshelf', $shelfSlug);
+ $bookshelf = Bookshelf::visible()->where('slug', '=', $shelfSlug)->firstOrFail();
$this->checkOwnablePermission('bookshelf-update', $bookshelf);
}
- $this->checkPermission('book-create-all');
$this->setPageTitle(trans('entities.books_create'));
+
return view('books.create', [
- 'bookshelf' => $bookshelf
+ 'bookshelf' => $bookshelf,
]);
}
/**
* Store a newly created book in storage.
*
- * @param Request $request
- * @param string $shelfSlug
- * @return Response
- * @throws NotFoundException
* @throws ImageUploadException
* @throws ValidationException
*/
public function store(Request $request, string $shelfSlug = null)
{
$this->checkPermission('book-create-all');
- $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'],
]);
$bookshelf = null;
if ($shelfSlug !== null) {
- $bookshelf = $this->bookRepo->getEntityBySlug('bookshelf', $shelfSlug);
+ $bookshelf = Bookshelf::visible()->where('slug', '=', $shelfSlug)->firstOrFail();
$this->checkOwnablePermission('bookshelf-update', $bookshelf);
}
- $book = $this->bookRepo->createFromInput('book', $request->all());
- $this->bookUpdateActions($book, $request);
- Activity::add($book, 'book_create', $book->id);
+ $book = $this->bookRepo->create($validated);
if ($bookshelf) {
- $this->bookRepo->appendBookToShelf($bookshelf, $book);
- Activity::add($bookshelf, 'bookshelf_update');
+ $bookshelf->appendBook($book);
+ Activity::add(ActivityType::BOOKSHELF_UPDATE, $bookshelf);
}
return redirect($book->getUrl());
/**
* Display the specified book.
- * @param Request $request
- * @param string $slug
- * @return Response
- * @throws NotFoundException
*/
- public function show(Request $request, string $slug)
+ public function show(Request $request, ActivityQueries $activities, string $slug)
{
$book = $this->bookRepo->getBySlug($slug);
- $this->checkOwnablePermission('book-view', $book);
-
- $bookChildren = $this->bookRepo->getBookChildren($book);
+ $bookChildren = (new BookContents($book))->getTree(true);
+ $bookParentShelves = $book->shelves()->scopes('visible')->get();
- Views::add($book);
+ View::incrementFor($book);
if ($request->has('shelf')) {
- $this->entityContextManager->setShelfContext(intval($request->get('shelf')));
+ $this->shelfContext->setShelfContext(intval($request->get('shelf')));
}
$this->setPageTitle($book->getShortName());
+
return view('books.show', [
- 'book' => $book,
- 'current' => $book,
- 'bookChildren' => $bookChildren,
- 'activity' => Activity::entityActivity($book, 20, 1)
+ 'book' => $book,
+ 'current' => $book,
+ 'bookChildren' => $bookChildren,
+ 'bookParentShelves' => $bookParentShelves,
+ 'activity' => $activities->entityActivity($book, 20, 1),
+ 'referenceCount' => $this->referenceFetcher->getPageReferenceCountToEntity($book),
]);
}
/**
* Show the form for editing the specified book.
- * @param string $slug
- * @return Response
- * @throws NotFoundException
*/
public function edit(string $slug)
{
$book = $this->bookRepo->getBySlug($slug);
$this->checkOwnablePermission('book-update', $book);
- $this->setPageTitle(trans('entities.books_edit_named', ['bookName'=>$book->getShortName()]));
+ $this->setPageTitle(trans('entities.books_edit_named', ['bookName' => $book->getShortName()]));
+
return view('books.edit', ['book' => $book, 'current' => $book]);
}
/**
* Update the specified book in storage.
- * @param Request $request
- * @param string $slug
- * @return Response
+ *
* @throws ImageUploadException
- * @throws NotFoundException
* @throws ValidationException
+ * @throws Throwable
*/
public function update(Request $request, string $slug)
{
$book = $this->bookRepo->getBySlug($slug);
$this->checkOwnablePermission('book-update', $book);
- $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'],
]);
- $book = $this->bookRepo->updateFromInput('book', $book, $request->all());
- $this->bookUpdateActions($book, $request);
+ if ($request->has('image_reset')) {
+ $validated['image'] = null;
+ } elseif (array_key_exists('image', $validated) && is_null($validated['image'])) {
+ unset($validated['image']);
+ }
- Activity::add($book, 'book_update', $book->id);
+ $book = $this->bookRepo->update($book, $validated);
- return redirect($book->getUrl());
+ return redirect($book->getUrl());
}
/**
- * Shows the page to confirm deletion
- * @param string $bookSlug
- * @return View
- * @throws NotFoundException
+ * Shows the page to confirm deletion.
*/
public function showDelete(string $bookSlug)
{
$book = $this->bookRepo->getBySlug($bookSlug);
$this->checkOwnablePermission('book-delete', $book);
$this->setPageTitle(trans('entities.books_delete_named', ['bookName' => $book->getShortName()]));
- return view('books.delete', ['book' => $book, 'current' => $book]);
- }
- /**
- * Shows the view which allows pages to be re-ordered and sorted.
- * @param string $bookSlug
- * @return View
- * @throws NotFoundException
- */
- public function sort(string $bookSlug)
- {
- $book = $this->bookRepo->getBySlug($bookSlug);
- $this->checkOwnablePermission('book-update', $book);
-
- $bookChildren = $this->bookRepo->getBookChildren($book, true);
-
- $this->setPageTitle(trans('entities.books_sort_named', ['bookName'=>$book->getShortName()]));
- return view('books.sort', ['book' => $book, 'current' => $book, 'bookChildren' => $bookChildren]);
- }
-
- /**
- * Shows the sort box for a single book.
- * Used via AJAX when loading in extra books to a sort.
- * @param string $bookSlug
- * @return Factory|View
- * @throws NotFoundException
- */
- public function getSortItem(string $bookSlug)
- {
- $book = $this->bookRepo->getBySlug($bookSlug);
- $bookChildren = $this->bookRepo->getBookChildren($book);
- return view('books.sort-box', ['book' => $book, 'bookChildren' => $bookChildren]);
- }
-
- /**
- * Saves an array of sort mapping to pages and chapters.
- * @param Request $request
- * @param string $bookSlug
- * @return RedirectResponse|Redirector
- * @throws NotFoundException
- */
- public function saveSort(Request $request, string $bookSlug)
- {
- $book = $this->bookRepo->getBySlug($bookSlug);
- $this->checkOwnablePermission('book-update', $book);
-
- // Return if no map sent
- if (!$request->filled('sort-tree')) {
- return redirect($book->getUrl());
- }
-
- // Sort pages and chapters
- $sortMap = collect(json_decode($request->get('sort-tree')));
- $bookIdsInvolved = collect([$book->id]);
-
- // Load models into map
- $sortMap->each(function ($mapItem) use ($bookIdsInvolved) {
- $mapItem->type = ($mapItem->type === 'page' ? 'page' : 'chapter');
- $mapItem->model = $this->bookRepo->getById($mapItem->type, $mapItem->id);
- // Store source and target books
- $bookIdsInvolved->push(intval($mapItem->model->book_id));
- $bookIdsInvolved->push(intval($mapItem->book));
- });
-
- // Get the books involved in the sort
- $bookIdsInvolved = $bookIdsInvolved->unique()->toArray();
- $booksInvolved = $this->bookRepo->getManyById('book', $bookIdsInvolved, false, true);
- // Throw permission error if invalid ids or inaccessible books given.
- if (count($bookIdsInvolved) !== count($booksInvolved)) {
- $this->showPermissionError();
- }
- // Check permissions of involved books
- $booksInvolved->each(function (Book $book) {
- $this->checkOwnablePermission('book-update', $book);
- });
-
- // Perform the sort
- $sortMap->each(function ($mapItem) {
- $model = $mapItem->model;
-
- $priorityChanged = intval($model->priority) !== intval($mapItem->sort);
- $bookChanged = intval($model->book_id) !== intval($mapItem->book);
- $chapterChanged = ($mapItem->type === 'page') && intval($model->chapter_id) !== $mapItem->parentChapter;
-
- if ($bookChanged) {
- $this->bookRepo->changeBook($mapItem->type, $mapItem->book, $model);
- }
- if ($chapterChanged) {
- $model->chapter_id = intval($mapItem->parentChapter);
- $model->save();
- }
- if ($priorityChanged) {
- $model->priority = intval($mapItem->sort);
- $model->save();
- }
- });
-
- // Rebuild permissions and add activity for involved books.
- $booksInvolved->each(function (Book $book) {
- $this->bookRepo->buildJointPermissionsForBook($book);
- Activity::add($book, 'book_sort', $book->id);
- });
-
- return redirect($book->getUrl());
+ return view('books.delete', ['book' => $book, 'current' => $book]);
}
/**
- * Remove the specified book from storage.
- * @param string $bookSlug
- * @return Response
- * @throws NotFoundException
+ * Remove the specified book from the system.
+ *
* @throws Throwable
- * @throws NotifyException
*/
public function destroy(string $bookSlug)
{
$book = $this->bookRepo->getBySlug($bookSlug);
$this->checkOwnablePermission('book-delete', $book);
- Activity::addMessage('book_delete', 0, $book->name);
- if ($book->cover) {
- $this->imageRepo->destroyImage($book->cover);
- }
- $this->bookRepo->destroyBook($book);
+ $this->bookRepo->destroy($book);
return redirect('/books');
}
/**
- * Show the Restrictions view.
- * @param string $bookSlug
- * @return Factory|View
+ * Show the view to copy a book.
+ *
* @throws NotFoundException
*/
- public function showPermissions(string $bookSlug)
+ public function showCopy(string $bookSlug)
{
$book = $this->bookRepo->getBySlug($bookSlug);
- $this->checkOwnablePermission('restrictions-manage', $book);
- $roles = $this->userRepo->getRestrictableRoles();
- return view('books.permissions', [
+ $this->checkOwnablePermission('book-view', $book);
+
+ session()->flashInput(['name' => $book->name]);
+
+ return view('books.copy', [
'book' => $book,
- 'roles' => $roles
]);
}
/**
- * Set the restrictions for this book.
- * @param Request $request
- * @param string $bookSlug
- * @return RedirectResponse|Redirector
+ * Create a copy of a book within the requested target destination.
+ *
* @throws NotFoundException
- * @throws Throwable
*/
- public function permissions(Request $request, string $bookSlug)
+ public function copy(Request $request, Cloner $cloner, string $bookSlug)
{
$book = $this->bookRepo->getBySlug($bookSlug);
- $this->checkOwnablePermission('restrictions-manage', $book);
- $this->bookRepo->updateEntityPermissionsFromRequest($request, $book);
- $this->showSuccessNotification(trans('entities.books_permissions_updated'));
- return redirect($book->getUrl());
+ $this->checkOwnablePermission('book-view', $book);
+ $this->checkPermission('book-create-all');
+
+ $newName = $request->get('name') ?: $book->name;
+ $bookCopy = $cloner->cloneBook($book, $newName);
+ $this->showSuccessNotification(trans('entities.books_copy_success'));
+
+ return redirect($bookCopy->getUrl());
}
/**
- * Common actions to run on book update.
- * Handles updating the cover image.
- * @param Book $book
- * @param Request $request
- * @throws ImageUploadException
+ * Convert the chapter to a book.
*/
- protected function bookUpdateActions(Book $book, Request $request)
+ public function convertToShelf(HierarchyTransformer $transformer, string $bookSlug)
{
- // Update the cover image if in request
- if ($request->has('image')) {
- $this->imageRepo->destroyImage($book->cover);
- $newImage = $request->file('image');
- $image = $this->imageRepo->saveNew($newImage, 'cover_book', $book->id, 512, 512, true);
- $book->image_id = $image->id;
- $book->save();
- }
+ $book = $this->bookRepo->getBySlug($bookSlug);
+ $this->checkOwnablePermission('book-update', $book);
+ $this->checkOwnablePermission('book-delete', $book);
+ $this->checkPermission('bookshelf-create-all');
+ $this->checkPermission('book-create-all');
- if ($request->has('image_reset')) {
- $this->imageRepo->destroyImage($book->cover);
- $book->image_id = 0;
- $book->save();
- }
+ $shelf = $transformer->transformBookToShelf($book);
+
+ return redirect($shelf->getUrl());
}
}
projects / bookstack / blobdiff