X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/07b889547d28e68e5fc8f923c166bd607da17ad7..refs/pull/1698/head:/app/Http/Controllers/BookController.php diff --git a/app/Http/Controllers/BookController.php b/app/Http/Controllers/BookController.php index a990eed9a..a9a24d2ff 100644 --- a/app/Http/Controllers/BookController.php +++ b/app/Http/Controllers/BookController.php @@ -3,41 +3,46 @@ use Activity; use BookStack\Auth\UserRepo; use BookStack\Entities\Book; +use BookStack\Entities\Bookshelf; use BookStack\Entities\EntityContextManager; -use BookStack\Entities\Repos\EntityRepo; -use BookStack\Entities\ExportService; +use BookStack\Entities\Repos\BookRepo; +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 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 $entityRepo; + protected $bookRepo; protected $userRepo; - protected $exportService; protected $entityContextManager; protected $imageRepo; /** * BookController constructor. - * @param EntityRepo $entityRepo + * @param BookRepo $bookRepo * @param UserRepo $userRepo - * @param ExportService $exportService * @param EntityContextManager $entityContextManager * @param ImageRepo $imageRepo */ public function __construct( - EntityRepo $entityRepo, + BookRepo $bookRepo, UserRepo $userRepo, - ExportService $exportService, EntityContextManager $entityContextManager, ImageRepo $imageRepo ) { - $this->entityRepo = $entityRepo; + $this->bookRepo = $bookRepo; $this->userRepo = $userRepo; - $this->exportService = $exportService; $this->entityContextManager = $entityContextManager; $this->imageRepo = $imageRepo; parent::__construct(); @@ -49,19 +54,14 @@ class BookController extends Controller */ public function index() { - $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 = [ - 'name' => trans('common.sort_name'), - 'created_at' => trans('common.sort_created_at'), - 'updated_at' => trans('common.sort_updated_at'), - ]; - - $books = $this->entityRepo->getAllPaginated('book', 18, $sort, $order); - $recents = $this->signedIn ? $this->entityRepo->getRecentlyViewed('book', 4, 0) : false; - $popular = $this->entityRepo->getPopular('book', 4, 0); - $new = $this->entityRepo->getRecentlyCreated('book', 4, 0); + $view = setting()->getForCurrentUser('books_view_type', config('app.views.books')); + $sort = setting()->getForCurrentUser('books_sort', 'name'); + $order = setting()->getForCurrentUser('books_sort_order', 'asc'); + + $books = $this->bookRepo->getAllPaginated('book', 18, $sort, $order); + $recents = $this->isSignedIn() ? $this->bookRepo->getRecentlyViewed('book', 4, 0) : false; + $popular = $this->bookRepo->getPopular('book', 4, 0); + $new = $this->bookRepo->getRecentlyCreated('book', 4, 0); $this->entityContextManager->clearShelfContext(); @@ -74,7 +74,6 @@ class BookController extends Controller 'view' => $view, 'sort' => $sort, 'order' => $order, - 'sortOptions' => $sortOptions, ]); } @@ -82,13 +81,13 @@ class BookController extends Controller * Show the form for creating a new book. * @param string $shelfSlug * @return Response - * @throws \BookStack\Exceptions\NotFoundException + * @throws NotFoundException */ public function create(string $shelfSlug = null) { $bookshelf = null; if ($shelfSlug !== null) { - $bookshelf = $this->entityRepo->getBySlug('bookshelf', $shelfSlug); + $bookshelf = $this->bookRepo->getEntityBySlug('bookshelf', $shelfSlug); $this->checkOwnablePermission('bookshelf-update', $bookshelf); } @@ -105,8 +104,9 @@ class BookController extends Controller * @param Request $request * @param string $shelfSlug * @return Response - * @throws \BookStack\Exceptions\NotFoundException - * @throws \BookStack\Exceptions\ImageUploadException + * @throws NotFoundException + * @throws ImageUploadException + * @throws ValidationException */ public function store(Request $request, string $shelfSlug = null) { @@ -119,16 +119,18 @@ class BookController extends Controller $bookshelf = null; if ($shelfSlug !== null) { - $bookshelf = $this->entityRepo->getBySlug('bookshelf', $shelfSlug); + /** @var Bookshelf $bookshelf */ + $bookshelf = $this->bookRepo->getEntityBySlug('bookshelf', $shelfSlug); $this->checkOwnablePermission('bookshelf-update', $bookshelf); } - $book = $this->entityRepo->createFromInput('book', $request->all()); + /** @var Book $book */ + $book = $this->bookRepo->createFromInput('book', $request->all()); $this->bookUpdateActions($book, $request); Activity::add($book, 'book_create', $book->id); if ($bookshelf) { - $this->entityRepo->appendBookToShelf($bookshelf, $book); + $bookshelf->appendBook($book); Activity::add($bookshelf, 'bookshelf_update'); } @@ -137,17 +139,17 @@ class BookController extends Controller /** * Display the specified book. - * @param $slug * @param Request $request + * @param string $slug * @return Response - * @throws \BookStack\Exceptions\NotFoundException + * @throws NotFoundException */ - public function show($slug, Request $request) + public function show(Request $request, string $slug) { - $book = $this->entityRepo->getBySlug('book', $slug); + $book = $this->bookRepo->getBySlug($slug); $this->checkOwnablePermission('book-view', $book); - $bookChildren = $this->entityRepo->getBookChildren($book); + $bookChildren = $this->bookRepo->getBookChildren($book); Views::add($book); if ($request->has('shelf')) { @@ -165,12 +167,13 @@ class BookController extends Controller /** * Show the form for editing the specified book. - * @param $slug + * @param string $slug * @return Response + * @throws NotFoundException */ - public function edit($slug) + public function edit(string $slug) { - $book = $this->entityRepo->getBySlug('book', $slug); + $book = $this->bookRepo->getBySlug($slug); $this->checkOwnablePermission('book-update', $book); $this->setPageTitle(trans('entities.books_edit_named', ['bookName'=>$book->getShortName()])); return view('books.edit', ['book' => $book, 'current' => $book]); @@ -179,14 +182,16 @@ class BookController extends Controller /** * Update the specified book in storage. * @param Request $request - * @param $slug + * @param string $slug * @return Response - * @throws \BookStack\Exceptions\ImageUploadException - * @throws \BookStack\Exceptions\NotFoundException + * @throws ImageUploadException + * @throws NotFoundException + * @throws ValidationException + * @throws Throwable */ public function update(Request $request, string $slug) { - $book = $this->entityRepo->getBySlug('book', $slug); + $book = $this->bookRepo->getBySlug($slug); $this->checkOwnablePermission('book-update', $book); $this->validate($request, [ 'name' => 'required|string|max:255', @@ -194,7 +199,7 @@ class BookController extends Controller 'image' => $this->imageRepo->getImageValidationRules(), ]); - $book = $this->entityRepo->updateFromInput('book', $book, $request->all()); + $book = $this->bookRepo->updateFromInput($book, $request->all()); $this->bookUpdateActions($book, $request); Activity::add($book, 'book_update', $book->id); @@ -204,29 +209,30 @@ class BookController extends Controller /** * Shows the page to confirm deletion - * @param $bookSlug - * @return \Illuminate\View\View + * @param string $bookSlug + * @return View + * @throws NotFoundException */ - public function showDelete($bookSlug) + public function showDelete(string $bookSlug) { - $book = $this->entityRepo->getBySlug('book', $bookSlug); + $book = $this->bookRepo->getBySlug($bookSlug); $this->checkOwnablePermission('book-delete', $book); - $this->setPageTitle(trans('entities.books_delete_named', ['bookName'=>$book->getShortName()])); + $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 \Illuminate\View\View - * @throws \BookStack\Exceptions\NotFoundException + * @return View + * @throws NotFoundException */ - public function sort($bookSlug) + public function sort(string $bookSlug) { - $book = $this->entityRepo->getBySlug('book', $bookSlug); + $book = $this->bookRepo->getBySlug($bookSlug); $this->checkOwnablePermission('book-update', $book); - $bookChildren = $this->entityRepo->getBookChildren($book, true); + $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]); @@ -235,25 +241,27 @@ class BookController extends Controller /** * Shows the sort box for a single book. * Used via AJAX when loading in extra books to a sort. - * @param $bookSlug - * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View + * @param string $bookSlug + * @return Factory|View + * @throws NotFoundException */ - public function getSortItem($bookSlug) + public function sortItem(string $bookSlug) { - $book = $this->entityRepo->getBySlug('book', $bookSlug); - $bookChildren = $this->entityRepo->getBookChildren($book); + $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 string $bookSlug * @param Request $request - * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * @param string $bookSlug + * @return RedirectResponse|Redirector + * @throws NotFoundException */ - public function saveSort($bookSlug, Request $request) + public function saveSort(Request $request, string $bookSlug) { - $book = $this->entityRepo->getBySlug('book', $bookSlug); + $book = $this->bookRepo->getBySlug($bookSlug); $this->checkOwnablePermission('book-update', $book); // Return if no map sent @@ -268,7 +276,7 @@ class BookController extends Controller // Load models into map $sortMap->each(function ($mapItem) use ($bookIdsInvolved) { $mapItem->type = ($mapItem->type === 'page' ? 'page' : 'chapter'); - $mapItem->model = $this->entityRepo->getById($mapItem->type, $mapItem->id); + $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)); @@ -276,11 +284,13 @@ class BookController extends Controller // Get the books involved in the sort $bookIdsInvolved = $bookIdsInvolved->unique()->toArray(); - $booksInvolved = $this->entityRepo->getManyById('book', $bookIdsInvolved, false, true); + $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); @@ -295,7 +305,7 @@ class BookController extends Controller $chapterChanged = ($mapItem->type === 'page') && intval($model->chapter_id) !== $mapItem->parentChapter; if ($bookChanged) { - $this->entityRepo->changeBook($mapItem->type, $mapItem->book, $model); + $this->bookRepo->changeBook($model, $mapItem->book); } if ($chapterChanged) { $model->chapter_id = intval($mapItem->parentChapter); @@ -309,7 +319,7 @@ class BookController extends Controller // Rebuild permissions and add activity for involved books. $booksInvolved->each(function (Book $book) { - $this->entityRepo->buildJointPermissionsForBook($book); + $book->rebuildPermissions(); Activity::add($book, 'book_sort', $book->id); }); @@ -318,31 +328,35 @@ class BookController extends Controller /** * Remove the specified book from storage. - * @param $bookSlug + * @param string $bookSlug * @return Response + * @throws NotFoundException + * @throws Throwable + * @throws NotifyException */ - public function destroy($bookSlug) + public function destroy(string $bookSlug) { - $book = $this->entityRepo->getBySlug('book', $bookSlug); + $book = $this->bookRepo->getBySlug($bookSlug); $this->checkOwnablePermission('book-delete', $book); - Activity::addMessage('book_delete', 0, $book->name); + Activity::addMessage('book_delete', $book->name); if ($book->cover) { $this->imageRepo->destroyImage($book->cover); } - $this->entityRepo->destroyBook($book); + $this->bookRepo->destroyBook($book); return redirect('/books'); } /** * Show the Restrictions view. - * @param $bookSlug - * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View + * @param string $bookSlug + * @return Factory|View + * @throws NotFoundException */ - public function showPermissions($bookSlug) + public function showPermissions(string $bookSlug) { - $book = $this->entityRepo->getBySlug('book', $bookSlug); + $book = $this->bookRepo->getBySlug($bookSlug); $this->checkOwnablePermission('restrictions-manage', $book); $roles = $this->userRepo->getRestrictableRoles(); return view('books.permissions', [ @@ -353,63 +367,27 @@ class BookController extends Controller /** * Set the restrictions for this book. - * @param $bookSlug * @param Request $request - * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector - * @throws \BookStack\Exceptions\NotFoundException - * @throws \Throwable + * @param string $bookSlug + * @return RedirectResponse|Redirector + * @throws NotFoundException + * @throws Throwable */ - public function permissions($bookSlug, Request $request) + public function permissions(Request $request, string $bookSlug) { - $book = $this->entityRepo->getBySlug('book', $bookSlug); + $book = $this->bookRepo->getBySlug($bookSlug); $this->checkOwnablePermission('restrictions-manage', $book); - $this->entityRepo->updateEntityPermissionsFromRequest($request, $book); - session()->flash('success', trans('entities.books_permissions_updated')); + $this->bookRepo->updateEntityPermissionsFromRequest($request, $book); + $this->showSuccessNotification(trans('entities.books_permissions_updated')); return redirect($book->getUrl()); } - /** - * Export a book as a PDF file. - * @param string $bookSlug - * @return mixed - */ - public function exportPdf($bookSlug) - { - $book = $this->entityRepo->getBySlug('book', $bookSlug); - $pdfContent = $this->exportService->bookToPdf($book); - return $this->downloadResponse($pdfContent, $bookSlug . '.pdf'); - } - - /** - * Export a book as a contained HTML file. - * @param string $bookSlug - * @return mixed - */ - public function exportHtml($bookSlug) - { - $book = $this->entityRepo->getBySlug('book', $bookSlug); - $htmlContent = $this->exportService->bookToContainedHtml($book); - return $this->downloadResponse($htmlContent, $bookSlug . '.html'); - } - - /** - * Export a book as a plain text file. - * @param $bookSlug - * @return mixed - */ - public function exportPlainText($bookSlug) - { - $book = $this->entityRepo->getBySlug('book', $bookSlug); - $textContent = $this->exportService->bookToPlainText($book); - return $this->downloadResponse($textContent, $bookSlug . '.txt'); - } - /** * Common actions to run on book update. * Handles updating the cover image. * @param Book $book * @param Request $request - * @throws \BookStack\Exceptions\ImageUploadException + * @throws ImageUploadException */ protected function bookUpdateActions(Book $book, Request $request) {