X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/c32d70abc4f3cca4a8b3533d45b09d2a830d6a57..0930e8519c508d46a848db93c76f258da5ee84a9:/app/Http/Controllers/BookController.php diff --git a/app/Http/Controllers/BookController.php b/app/Http/Controllers/BookController.php index a4365d605..bc403c6d0 100644 --- a/app/Http/Controllers/BookController.php +++ b/app/Http/Controllers/BookController.php @@ -2,238 +2,264 @@ namespace BookStack\Http\Controllers; -use Activity; +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\Tools\BookContents; +use BookStack\Entities\Tools\Cloner; +use BookStack\Entities\Tools\PermissionsUpdater; +use BookStack\Entities\Tools\ShelfContext; +use BookStack\Exceptions\ImageUploadException; +use BookStack\Exceptions\NotFoundException; +use BookStack\Facades\Activity; use Illuminate\Http\Request; - -use Illuminate\Support\Facades\Auth; -use Illuminate\Support\Str; -use BookStack\Http\Requests; -use BookStack\Repos\BookRepo; -use BookStack\Repos\ChapterRepo; -use BookStack\Repos\PageRepo; -use Views; +use Illuminate\Validation\ValidationException; +use Throwable; class BookController extends Controller { - protected $bookRepo; - protected $pageRepo; - protected $chapterRepo; + protected $entityContextManager; - /** - * BookController constructor. - * @param BookRepo $bookRepo - * @param PageRepo $pageRepo - * @param ChapterRepo $chapterRepo - */ - public function __construct(BookRepo $bookRepo, PageRepo $pageRepo, ChapterRepo $chapterRepo) + public function __construct(ShelfContext $entityContextManager, BookRepo $bookRepo) { $this->bookRepo = $bookRepo; - $this->pageRepo = $pageRepo; - $this->chapterRepo = $chapterRepo; - parent::__construct(); + $this->entityContextManager = $entityContextManager; } /** * Display a listing of the book. - * - * @return Response */ public function index() { - $books = $this->bookRepo->getAllPaginated(10); - $recents = $this->signedIn ? $this->bookRepo->getRecentlyViewed(4, 0) : false; - $popular = $this->bookRepo->getPopular(4, 0); - $this->setPageTitle('Books'); - return view('books/index', ['books' => $books, 'recents' => $recents, 'popular' => $popular]); + $view = setting()->getForCurrentUser('books_view_type'); + $sort = setting()->getForCurrentUser('books_sort', 'name'); + $order = setting()->getForCurrentUser('books_sort_order', 'asc'); + + $books = $this->bookRepo->getAllPaginated(18, $sort, $order); + $recents = $this->isSignedIn() ? $this->bookRepo->getRecentlyViewed(4) : false; + $popular = $this->bookRepo->getPopular(4); + $new = $this->bookRepo->getRecentlyCreated(4); + + $this->entityContextManager->clearShelfContext(); + + $this->setPageTitle(trans('entities.books')); + + return view('books.index', [ + 'books' => $books, + 'recents' => $recents, + 'popular' => $popular, + 'new' => $new, + 'view' => $view, + 'sort' => $sort, + 'order' => $order, + ]); } /** * Show the form for creating a new book. - * - * @return Response */ - public function create() + public function create(string $shelfSlug = null) { - $this->checkPermission('book-create'); - $this->setPageTitle('Create New Book'); - return view('books/create'); + $this->checkPermission('book-create-all'); + + $bookshelf = null; + if ($shelfSlug !== null) { + $bookshelf = Bookshelf::visible()->where('slug', '=', $shelfSlug)->firstOrFail(); + $this->checkOwnablePermission('bookshelf-update', $bookshelf); + } + + $this->setPageTitle(trans('entities.books_create')); + + return view('books.create', [ + 'bookshelf' => $bookshelf, + ]); } /** * Store a newly created book in storage. * - * @param Request $request - * @return Response + * @throws ImageUploadException + * @throws ValidationException */ - public function store(Request $request) + public function store(Request $request, string $shelfSlug = null) { - $this->checkPermission('book-create'); + $this->checkPermission('book-create-all'); $this->validate($request, [ - 'name' => 'required|string|max:255', - 'description' => 'string|max:1000' + 'name' => ['required', 'string', 'max:255'], + 'description' => ['string', 'max:1000'], + 'image' => array_merge(['nullable'], $this->getImageValidationRules()), ]); - $book = $this->bookRepo->newFromInput($request->all()); - $book->slug = $this->bookRepo->findSuitableSlug($book->name); - $book->created_by = Auth::user()->id; - $book->updated_by = Auth::user()->id; - $book->save(); - Activity::add($book, 'book_create', $book->id); + + $bookshelf = null; + if ($shelfSlug !== null) { + $bookshelf = Bookshelf::visible()->where('slug', '=', $shelfSlug)->firstOrFail(); + $this->checkOwnablePermission('bookshelf-update', $bookshelf); + } + + $book = $this->bookRepo->create($request->all()); + $this->bookRepo->updateCoverImage($book, $request->file('image', null)); + + if ($bookshelf) { + $bookshelf->appendBook($book); + Activity::add(ActivityType::BOOKSHELF_UPDATE, $bookshelf); + } + return redirect($book->getUrl()); } /** * Display the specified book. - * - * @param $slug - * @return Response */ - public function show($slug) + public function show(Request $request, ActivityQueries $activities, string $slug) { $book = $this->bookRepo->getBySlug($slug); - $bookChildren = $this->bookRepo->getChildren($book); - Views::add($book); + $bookChildren = (new BookContents($book))->getTree(true); + $bookParentShelves = $book->shelves()->scopes('visible')->get(); + + View::incrementFor($book); + if ($request->has('shelf')) { + $this->entityContextManager->setShelfContext(intval($request->get('shelf'))); + } + $this->setPageTitle($book->getShortName()); - return view('books/show', ['book' => $book, 'current' => $book, 'bookChildren' => $bookChildren]); + + return view('books.show', [ + 'book' => $book, + 'current' => $book, + 'bookChildren' => $bookChildren, + 'bookParentShelves' => $bookParentShelves, + 'activity' => $activities->entityActivity($book, 20, 1), + ]); } /** * Show the form for editing the specified book. - * - * @param $slug - * @return Response */ - public function edit($slug) + public function edit(string $slug) { - $this->checkPermission('book-update'); $book = $this->bookRepo->getBySlug($slug); - $this->setPageTitle('Edit Book ' . $book->getShortName()); - return view('books/edit', ['book' => $book, 'current' => $book]); + $this->checkOwnablePermission('book-update', $book); + $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 $slug - * @return Response + * @throws ImageUploadException + * @throws ValidationException + * @throws Throwable */ - public function update(Request $request, $slug) + public function update(Request $request, string $slug) { - $this->checkPermission('book-update'); $book = $this->bookRepo->getBySlug($slug); + $this->checkOwnablePermission('book-update', $book); $this->validate($request, [ - 'name' => 'required|string|max:255', - 'description' => 'string|max:1000' + 'name' => ['required', 'string', 'max:255'], + 'description' => ['string', 'max:1000'], + 'image' => array_merge(['nullable'], $this->getImageValidationRules()), ]); - $book->fill($request->all()); - $book->slug = $this->bookRepo->findSuitableSlug($book->name, $book->id); - $book->updated_by = Auth::user()->id; - $book->save(); - Activity::add($book, 'book_update', $book->id); + + $book = $this->bookRepo->update($book, $request->all()); + $resetCover = $request->has('image_reset'); + $this->bookRepo->updateCoverImage($book, $request->file('image', null), $resetCover); + return redirect($book->getUrl()); } /** - * Shows the page to confirm deletion - * @param $bookSlug - * @return \Illuminate\View\View + * Shows the page to confirm deletion. */ - public function showDelete($bookSlug) + public function showDelete(string $bookSlug) { - $this->checkPermission('book-delete'); $book = $this->bookRepo->getBySlug($bookSlug); - $this->setPageTitle('Delete Book ' . $book->getShortName()); - return view('books/delete', ['book' => $book, 'current' => $book]); + $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 \Illuminate\View\View + * Remove the specified book from the system. + * + * @throws Throwable */ - public function sort($bookSlug) + public function destroy(string $bookSlug) { - $this->checkPermission('book-update'); $book = $this->bookRepo->getBySlug($bookSlug); - $bookChildren = $this->bookRepo->getChildren($book); - $books = $this->bookRepo->getAll(); - $this->setPageTitle('Sort Book ' . $book->getShortName()); - return view('books/sort', ['book' => $book, 'current' => $book, 'books' => $books, 'bookChildren' => $bookChildren]); + $this->checkOwnablePermission('book-delete', $book); + + $this->bookRepo->destroy($book); + + return redirect('/books'); } /** - * 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 + * Show the permissions view. */ - public function getSortItem($bookSlug) + public function showPermissions(string $bookSlug) { $book = $this->bookRepo->getBySlug($bookSlug); - $bookChildren = $this->bookRepo->getChildren($book); - return view('books/sort-box', ['book' => $book, 'bookChildren' => $bookChildren]); + $this->checkOwnablePermission('restrictions-manage', $book); + + return view('books.permissions', [ + 'book' => $book, + ]); } /** - * Saves an array of sort mapping to pages and chapters. + * Set the restrictions for this book. * - * @param string $bookSlug - * @param Request $request - * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * @throws Throwable */ - public function saveSort($bookSlug, Request $request) + public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $bookSlug) { - $this->checkPermission('book-update'); $book = $this->bookRepo->getBySlug($bookSlug); + $this->checkOwnablePermission('restrictions-manage', $book); - // Return if no map sent - if (!$request->has('sort-tree')) { - return redirect($book->getUrl()); - } - - $sortedBooks = []; - // Sort pages and chapters - $sortMap = json_decode($request->get('sort-tree')); - $defaultBookId = $book->id; - foreach ($sortMap as $index => $bookChild) { - $id = $bookChild->id; - $isPage = $bookChild->type == 'page'; - $bookId = $this->bookRepo->exists($bookChild->book) ? $bookChild->book : $defaultBookId; - $model = $isPage ? $this->pageRepo->getById($id) : $this->chapterRepo->getById($id); - $isPage ? $this->pageRepo->changeBook($bookId, $model) : $this->chapterRepo->changeBook($bookId, $model); - $model->priority = $index; - if ($isPage) { - $model->chapter_id = ($bookChild->parentChapter === false) ? 0 : $bookChild->parentChapter; - } - $model->save(); - if (!in_array($bookId, $sortedBooks)) { - $sortedBooks[] = $bookId; - } - } + $permissionsUpdater->updateFromPermissionsForm($book, $request); - // Add activity for books - foreach ($sortedBooks as $bookId) { - $updatedBook = $this->bookRepo->getById($bookId); - Activity::add($updatedBook, 'book_sort', $updatedBook->id); - } + $this->showSuccessNotification(trans('entities.books_permissions_updated')); return redirect($book->getUrl()); } /** - * Remove the specified book from storage. + * Show the view to copy a book. * - * @param $bookSlug - * @return Response + * @throws NotFoundException */ - public function destroy($bookSlug) + public function showCopy(string $bookSlug) { - $this->checkPermission('book-delete'); $book = $this->bookRepo->getBySlug($bookSlug); - Activity::addMessage('book_delete', 0, $book->name); - Activity::removeEntity($book); - $this->bookRepo->destroyBySlug($bookSlug); - return redirect('/books'); + $this->checkOwnablePermission('book-view', $book); + + session()->flashInput(['name' => $book->name]); + + return view('books.copy', [ + 'book' => $book, + ]); + } + + /** + * Create a copy of a book within the requested target destination. + * + * @throws NotFoundException + */ + public function copy(Request $request, Cloner $cloner, string $bookSlug) + { + $book = $this->bookRepo->getBySlug($bookSlug); + $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()); } }