<?php namespace BookStack\Http\Controllers;
use Activity;
-use BookStack\Book;
-use BookStack\Repos\EntityRepo;
-use BookStack\Repos\UserRepo;
-use BookStack\Services\ExportService;
+use BookStack\Entities\Managers\BookContents;
+use BookStack\Entities\Bookshelf;
+use BookStack\Entities\Managers\EntityContext;
+use BookStack\Entities\Repos\BookRepo;
+use BookStack\Exceptions\ImageUploadException;
+use BookStack\Exceptions\NotifyException;
use Illuminate\Http\Request;
-use Illuminate\Http\Response;
+use Illuminate\Validation\ValidationException;
+use Throwable;
use Views;
class BookController extends Controller
{
- protected $entityRepo;
- protected $userRepo;
- protected $exportService;
+ protected $bookRepo;
+ protected $entityContextManager;
/**
* BookController constructor.
- * @param EntityRepo $entityRepo
- * @param UserRepo $userRepo
- * @param ExportService $exportService
*/
- public function __construct(EntityRepo $entityRepo, UserRepo $userRepo, ExportService $exportService)
+ public function __construct(EntityContext $entityContextManager, BookRepo $bookRepo)
{
- $this->entityRepo = $entityRepo;
- $this->userRepo = $userRepo;
- $this->exportService = $exportService;
+ $this->bookRepo = $bookRepo;
+ $this->entityContextManager = $entityContextManager;
parent::__construct();
}
/**
* Display a listing of the book.
- * @return Response
*/
public function index()
{
- $books = $this->entityRepo->getAllPaginated('book', 20);
- $recents = $this->signedIn ? $this->entityRepo->getRecentlyViewed('book', 4, 0) : false;
- $popular = $this->entityRepo->getPopular('book', 4, 0);
- $new = $this->entityRepo->getRecentlyCreated('book', 4, 0);
- $booksViewType = setting()->getUser($this->currentUser, 'books_view_type', 'list');
+ $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(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', [
+ return view('books.index', [
'books' => $books,
'recents' => $recents,
'popular' => $popular,
- 'new' => $new,
- 'booksViewType' => $booksViewType
+ '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-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');
+ 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-all');
$this->validate($request, [
'name' => 'required|string|max:255',
- 'description' => 'string|max:1000'
+ 'description' => 'string|max:1000',
+ 'image' => 'nullable|' . $this->getImageValidationRules(),
]);
- $book = $this->entityRepo->createFromInput('book', $request->all());
+
+ $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));
Activity::add($book, 'book_create', $book->id);
+
+ if ($bookshelf) {
+ $bookshelf->appendBook($book);
+ Activity::add($bookshelf, 'bookshelf_update');
+ }
+
return redirect($book->getUrl());
}
/**
* Display the specified book.
- * @param $slug
- * @return Response
*/
- public function show($slug)
+ public function show(Request $request, string $slug)
{
- $book = $this->entityRepo->getBySlug('book', $slug);
- $this->checkOwnablePermission('book-view', $book);
- $bookChildren = $this->entityRepo->getBookChildren($book);
+ $book = $this->bookRepo->getBySlug($slug);
+ $bookChildren = (new BookContents($book))->getTree(true);
+ $bookParentShelves = $book->shelves()->visible();
+
Views::add($book);
+ if ($request->has('shelf')) {
+ $this->entityContextManager->setShelfContext(intval($request->get('shelf')));
+ }
+
$this->setPageTitle($book->getShortName());
- return view('books/show', [
+ return view('books.show', [
'book' => $book,
'current' => $book,
'bookChildren' => $bookChildren,
- 'activity' => Activity::entityActivity($book, 20, 0)
+ 'bookParentShelves' => $bookParentShelves,
+ 'activity' => Activity::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)
{
- $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]);
+ $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)
{
- $book = $this->entityRepo->getBySlug('book', $slug);
+ $book = $this->bookRepo->getBySlug($slug);
$this->checkOwnablePermission('book-update', $book);
$this->validate($request, [
'name' => 'required|string|max:255',
- 'description' => 'string|max:1000'
+ 'description' => 'string|max:1000',
+ 'image' => 'nullable|' . $this->getImageValidationRules(),
]);
- $book = $this->entityRepo->updateFromInput('book', $book, $request->all());
- Activity::add($book, 'book_update', $book->id);
- return redirect($book->getUrl());
- }
- /**
- * Shows the page to confirm deletion
- * @param $bookSlug
- * @return \Illuminate\View\View
- */
- public function showDelete($bookSlug)
- {
- $book = $this->entityRepo->getBySlug('book', $bookSlug);
- $this->checkOwnablePermission('book-delete', $book);
- $this->setPageTitle(trans('entities.books_delete_named', ['bookName'=>$book->getShortName()]));
- return view('books/delete', ['book' => $book, 'current' => $book]);
- }
+ $book = $this->bookRepo->update($book, $request->all());
+ $resetCover = $request->has('image_reset');
+ $this->bookRepo->updateCoverImage($book, $request->file('image', null), $resetCover);
- /**
- * Shows the view which allows pages to be re-ordered and sorted.
- * @param string $bookSlug
- * @return \Illuminate\View\View
- */
- public function sort($bookSlug)
- {
- $book = $this->entityRepo->getBySlug('book', $bookSlug);
- $this->checkOwnablePermission('book-update', $book);
- $bookChildren = $this->entityRepo->getBookChildren($book, true);
- $books = $this->entityRepo->getAll('book', false);
- $this->setPageTitle(trans('entities.books_sort_named', ['bookName'=>$book->getShortName()]));
- return view('books/sort', ['book' => $book, 'current' => $book, 'books' => $books, 'bookChildren' => $bookChildren]);
- }
+ Activity::add($book, 'book_update', $book->id);
- /**
- * 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
- */
- public function getSortItem($bookSlug)
- {
- $book = $this->entityRepo->getBySlug('book', $bookSlug);
- $bookChildren = $this->entityRepo->getBookChildren($book);
- return view('books/sort-box', ['book' => $book, 'bookChildren' => $bookChildren]);
+ return redirect($book->getUrl());
}
/**
- * Saves an array of sort mapping to pages and chapters.
- * @param string $bookSlug
- * @param Request $request
- * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+ * Shows the page to confirm deletion.
*/
- public function saveSort($bookSlug, Request $request)
+ public function showDelete(string $bookSlug)
{
- $book = $this->entityRepo->getBySlug('book', $bookSlug);
- $this->checkOwnablePermission('book-update', $book);
-
- // Return if no map sent
- if (!$request->filled('sort-tree')) {
- return redirect($book->getUrl());
- }
-
- // Sort pages and chapters
- $sortedBooks = [];
- $updatedModels = collect();
- $sortMap = json_decode($request->get('sort-tree'));
- $defaultBookId = $book->id;
-
- // Loop through contents of provided map and update entities accordingly
- foreach ($sortMap as $bookChild) {
- $priority = $bookChild->sort;
- $id = intval($bookChild->id);
- $isPage = $bookChild->type == 'page';
- $bookId = $this->entityRepo->exists('book', $bookChild->book) ? intval($bookChild->book) : $defaultBookId;
- $chapterId = ($isPage && $bookChild->parentChapter === false) ? 0 : intval($bookChild->parentChapter);
- $model = $this->entityRepo->getById($isPage?'page':'chapter', $id);
-
- // Update models only if there's a change in parent chain or ordering.
- if ($model->priority !== $priority || $model->book_id !== $bookId || ($isPage && $model->chapter_id !== $chapterId)) {
- $this->entityRepo->changeBook($isPage?'page':'chapter', $bookId, $model);
- $model->priority = $priority;
- if ($isPage) $model->chapter_id = $chapterId;
- $model->save();
- $updatedModels->push($model);
- }
-
- // Store involved books to be sorted later
- if (!in_array($bookId, $sortedBooks)) {
- $sortedBooks[] = $bookId;
- }
- }
-
- // Add activity for books
- foreach ($sortedBooks as $bookId) {
- /** @var Book $updatedBook */
- $updatedBook = $this->entityRepo->getById('book', $bookId);
- $this->entityRepo->buildJointPermissionsForBook($updatedBook);
- Activity::add($updatedBook, 'book_sort', $updatedBook->id);
- }
-
- return redirect($book->getUrl());
+ $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]);
}
/**
- * Remove the specified book from storage.
- * @param $bookSlug
- * @return Response
+ * Remove the specified book from the system.
+ * @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);
- $this->entityRepo->destroyBook($book);
+
+ Activity::addMessage('book_delete', $book->name);
+ $this->bookRepo->destroy($book);
+
return redirect('/books');
}
/**
- * Show the Restrictions view.
- * @param $bookSlug
- * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+ * Show the permissions view.
*/
- public function showRestrict($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/restrictions', [
+
+ return view('books.permissions', [
'book' => $book,
- 'roles' => $roles
]);
}
/**
* Set the restrictions for this book.
- * @param $bookSlug
- * @param $bookSlug
- * @param Request $request
- * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+ * @throws Throwable
*/
- public function restrict($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'));
- 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 response()->make($pdfContent, 200, [
- 'Content-Type' => 'application/octet-stream',
- 'Content-Disposition' => 'attachment; filename="' . $bookSlug . '.pdf'
- ]);
- }
+ $restricted = $request->get('restricted') === 'true';
+ $permissions = $request->filled('restrictions') ? collect($request->get('restrictions')) : null;
+ $this->bookRepo->updatePermissions($book, $restricted, $permissions);
- /**
- * 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 response()->make($htmlContent, 200, [
- 'Content-Type' => 'application/octet-stream',
- 'Content-Disposition' => 'attachment; filename="' . $bookSlug . '.html'
- ]);
- }
-
- /**
- * Export a book as a plain text file.
- * @param $bookSlug
- * @return mixed
- */
- public function exportPlainText($bookSlug)
- {
- $book = $this->entityRepo->getBySlug('book', $bookSlug);
- $htmlContent = $this->exportService->bookToPlainText($book);
- return response()->make($htmlContent, 200, [
- 'Content-Type' => 'application/octet-stream',
- 'Content-Disposition' => 'attachment; filename="' . $bookSlug . '.txt'
- ]);
+ $this->showSuccessNotification(trans('entities.books_permissions_updated'));
+ return redirect($book->getUrl());
}
}
projects / bookstack / blobdiff