BookStack Code Mirror - bookstack/blobdiff - app/Http/Controllers/BookController.php

<?php namespace BookStack\Http\Controllers;

use Activity;

<?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

{

use Views;

class BookController extends Controller

{

- protected $entityRepo;

- protected $userRepo;

- protected $exportService;

+ protected $bookRepo;

+ protected $entityContextManager;

/**

* BookController constructor.

/**

* 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.

parent::__construct();

}

/**

* Display a listing of the book.

- * @return Response

*/

public function index()

{

*/

public function index()

{

- $books = $this->entityRepo->getAllPaginated('book', 18);

- $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', config('app.views.books', '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,

'books' => $books,

'recents' => $recents,

'popular' => $popular,

'new' => $new,

- 'booksViewType' => $booksViewType

+ 'view' => $view,

+ 'sort' => $sort,

+ 'order' => $order,

]);

}

/**

* Show the form for creating a new book.

]);

}

/**

* Show the form for creating a new book.

- * @return Response

*/

- public function create()

+ public function create(string $shelfSlug = null)

{

$this->checkPermission('book-create-all');

{

$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.

}

/**

* 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',

{

$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.

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()->get();

+

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,

'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.

]);

}

/**

* 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()]));

$this->checkOwnablePermission('book-update', $book);

$this->setPageTitle(trans('entities.books_edit_named', ['bookName'=>$book->getShortName()]));

- return view('books/edit', ['book' => $book, 'current' => $book]);

+ return view('books.edit', ['book' => $book, 'current' => $book]);

}

/**

* Update the specified book in storage.

}

/**

* 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',

$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, 'update');

- $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

- $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->entityRepo->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->entityRepo->book->newQuery()->whereIn('id', $bookIdsInvolved)->get();

- // 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->entityRepo->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->entityRepo->buildJointPermissionsForBook($book);

- Activity::add($book, 'book_sort', $book->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');

}

/**

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.

]);

}

/**

* Set the restrictions for this book.

- * @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 $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');

- }

+ $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 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');

+ $this->showSuccessNotification(trans('entities.books_permissions_updated'));

+ return redirect($book->getUrl());

}