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

-<?php namespace BookStack\Http\Controllers;

+<?php

-use Activity;

-use BookStack\Auth\UserRepo;

-use BookStack\Entities\Repos\EntityRepo;

-use BookStack\Entities\ExportService;

+namespace BookStack\Http\Controllers;

+

+use BookStack\Actions\View;

+use BookStack\Entities\Models\Book;

+use BookStack\Entities\Repos\ChapterRepo;

+use BookStack\Entities\Tools\BookContents;

+use BookStack\Entities\Tools\Cloner;

+use BookStack\Entities\Tools\HierarchyTransformer;

+use BookStack\Entities\Tools\NextPreviousContentLocator;

+use BookStack\Exceptions\MoveOperationException;

+use BookStack\Exceptions\NotFoundException;

+use BookStack\Exceptions\PermissionsException;

+use BookStack\References\ReferenceFetcher;

use Illuminate\Http\Request;

-use Illuminate\Http\Response;

-use Views;

+use Illuminate\Validation\ValidationException;

+use Throwable;

class ChapterController extends Controller

{

class ChapterController extends Controller

{

+ protected ChapterRepo $chapterRepo;

+ protected ReferenceFetcher $referenceFetcher;

- protected $userRepo;

- protected $entityRepo;

- protected $exportService;

-

- /**

- * ChapterController constructor.

- * @param EntityRepo $entityRepo

- * @param UserRepo $userRepo

- * @param \BookStack\Entities\ExportService $exportService

- */

- public function __construct(EntityRepo $entityRepo, UserRepo $userRepo, ExportService $exportService)

+ public function __construct(ChapterRepo $chapterRepo, ReferenceFetcher $referenceFetcher)

{

- $this->entityRepo = $entityRepo;

- $this->userRepo = $userRepo;

- $this->exportService = $exportService;

- parent::__construct();

+ $this->chapterRepo = $chapterRepo;

+ $this->referenceFetcher = $referenceFetcher;

}

/**

* Show the form for creating a new chapter.

}

/**

* Show the form for creating a new chapter.

- * @param $bookSlug

- * @return Response

*/

- public function create($bookSlug)

+ public function create(string $bookSlug)

{

- $book = $this->entityRepo->getBySlug('book', $bookSlug);

+ $book = Book::visible()->where('slug', '=', $bookSlug)->firstOrFail();

$this->checkOwnablePermission('chapter-create', $book);

+

$this->setPageTitle(trans('entities.chapters_create'));

+

return view('chapters.create', ['book' => $book, 'current' => $book]);

}

/**

* Store a newly created chapter in storage.

return view('chapters.create', ['book' => $book, 'current' => $book]);

}

/**

* Store a newly created chapter in storage.

- * @param $bookSlug

- * @param Request $request

- * @return Response

+ *

+ * @throws ValidationException

*/

- public function store($bookSlug, Request $request)

+ public function store(Request $request, string $bookSlug)

{

$this->validate($request, [

{

$this->validate($request, [

- 'name' => 'required|string|max:255'

+ 'name' => ['required', 'string', 'max:255'],

]);

- $book = $this->entityRepo->getBySlug('book', $bookSlug);

+ $book = Book::visible()->where('slug', '=', $bookSlug)->firstOrFail();

$this->checkOwnablePermission('chapter-create', $book);

- $input = $request->all();

- $input['priority'] = $this->entityRepo->getNewBookPriority($book);

- $chapter = $this->entityRepo->createFromInput('chapter', $input, $book);

- Activity::add($chapter, 'chapter_create', $book->id);

+ $chapter = $this->chapterRepo->create($request->all(), $book);

+

return redirect($chapter->getUrl());

}

/**

* Display the specified chapter.

return redirect($chapter->getUrl());

}

/**

* Display the specified chapter.

- * @param $bookSlug

- * @param $chapterSlug

- * @return Response

*/

- public function show($bookSlug, $chapterSlug)

+ public function show(string $bookSlug, string $chapterSlug)

{

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

+ $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

$this->checkOwnablePermission('chapter-view', $chapter);

- $sidebarTree = $this->entityRepo->getBookChildren($chapter->book);

- Views::add($chapter);

+

+ $sidebarTree = (new BookContents($chapter->book))->getTree();

+ $pages = $chapter->getVisiblePages();

+ $nextPreviousLocator = new NextPreviousContentLocator($chapter, $sidebarTree);

+ View::incrementFor($chapter);

+

$this->setPageTitle($chapter->getShortName());

- $pages = $this->entityRepo->getChapterChildren($chapter);

+

return view('chapters.show', [

- 'book' => $chapter->book,

- 'chapter' => $chapter,

- 'current' => $chapter,

- 'sidebarTree' => $sidebarTree,

- 'pages' => $pages

+ 'book' => $chapter->book,

+ 'chapter' => $chapter,

+ 'current' => $chapter,

+ 'sidebarTree' => $sidebarTree,

+ 'pages' => $pages,

+ 'next' => $nextPreviousLocator->getNext(),

+ 'previous' => $nextPreviousLocator->getPrevious(),

+ 'referenceCount' => $this->referenceFetcher->getPageReferenceCountToEntity($chapter),

]);

}

/**

* Show the form for editing the specified chapter.

]);

}

/**

* Show the form for editing the specified chapter.

- * @param $bookSlug

- * @param $chapterSlug

- * @return Response

*/

- public function edit($bookSlug, $chapterSlug)

+ public function edit(string $bookSlug, string $chapterSlug)

{

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

+ $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

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

+

$this->setPageTitle(trans('entities.chapters_edit_named', ['chapterName' => $chapter->getShortName()]));

+

return view('chapters.edit', ['book' => $chapter->book, 'chapter' => $chapter, 'current' => $chapter]);

}

/**

* Update the specified chapter in storage.

return view('chapters.edit', ['book' => $chapter->book, 'chapter' => $chapter, 'current' => $chapter]);

}

/**

* Update the specified chapter in storage.

- * @param Request $request

- * @param $bookSlug

- * @param $chapterSlug

- * @return Response

- * @throws \BookStack\Exceptions\NotFoundException

+ *

+ * @throws NotFoundException

*/

- public function update(Request $request, $bookSlug, $chapterSlug)

+ public function update(Request $request, string $bookSlug, string $chapterSlug)

{

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

+ $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

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

- $this->entityRepo->updateFromInput('chapter', $chapter, $request->all());

- Activity::add($chapter, 'chapter_update', $chapter->book->id);

+ $this->chapterRepo->update($chapter, $request->all());

+

return redirect($chapter->getUrl());

}

/**

* Shows the page to confirm deletion of this chapter.

return redirect($chapter->getUrl());

}

/**

* Shows the page to confirm deletion of this chapter.

- * @param $bookSlug

- * @param $chapterSlug

- * @return \Illuminate\View\View

+ *

+ * @throws NotFoundException

*/

- public function showDelete($bookSlug, $chapterSlug)

+ public function showDelete(string $bookSlug, string $chapterSlug)

{

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

+ $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

$this->checkOwnablePermission('chapter-delete', $chapter);

+

$this->setPageTitle(trans('entities.chapters_delete_named', ['chapterName' => $chapter->getShortName()]));

+

return view('chapters.delete', ['book' => $chapter->book, 'chapter' => $chapter, 'current' => $chapter]);

}

/**

* Remove the specified chapter from storage.

return view('chapters.delete', ['book' => $chapter->book, 'chapter' => $chapter, 'current' => $chapter]);

}

/**

* Remove the specified chapter from storage.

- * @param $bookSlug

- * @param $chapterSlug

- * @return Response

+ *

+ * @throws NotFoundException

+ * @throws Throwable

*/

- public function destroy($bookSlug, $chapterSlug)

+ public function destroy(string $bookSlug, string $chapterSlug)

{

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

- $book = $chapter->book;

+ $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

$this->checkOwnablePermission('chapter-delete', $chapter);

- Activity::addMessage('chapter_delete', $book->id, $chapter->name);

- $this->entityRepo->destroyChapter($chapter);

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

+

+ $this->chapterRepo->destroy($chapter);

+

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

}

/**

* Show the page for moving a chapter.

}

/**

* Show the page for moving a chapter.

- * @param $bookSlug

- * @param $chapterSlug

- * @return mixed

- * @throws \BookStack\Exceptions\NotFoundException

+ *

+ * @throws NotFoundException

*/

- public function showMove($bookSlug, $chapterSlug)

+ public function showMove(string $bookSlug, string $chapterSlug)

{

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

+ $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

$this->setPageTitle(trans('entities.chapters_move_named', ['chapterName' => $chapter->getShortName()]));

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

$this->checkOwnablePermission('chapter-delete', $chapter);

$this->setPageTitle(trans('entities.chapters_move_named', ['chapterName' => $chapter->getShortName()]));

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

$this->checkOwnablePermission('chapter-delete', $chapter);

+

return view('chapters.move', [

'chapter' => $chapter,

return view('chapters.move', [

'chapter' => $chapter,

- 'book' => $chapter->book

+ 'book' => $chapter->book,

]);

}

/**

* Perform the move action for a chapter.

]);

}

/**

* Perform the move action for a chapter.

- * @param $bookSlug

- * @param $chapterSlug

- * @param Request $request

- * @return mixed

- * @throws \BookStack\Exceptions\NotFoundException

+ *

+ * @throws NotFoundException

*/

- public function move($bookSlug, $chapterSlug, Request $request)

+ public function move(Request $request, string $bookSlug, string $chapterSlug)

{

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

+ $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

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

$this->checkOwnablePermission('chapter-delete', $chapter);

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

$this->checkOwnablePermission('chapter-delete', $chapter);

return redirect($chapter->getUrl());

}

return redirect($chapter->getUrl());

}

- $stringExploded = explode(':', $entitySelection);

- $entityType = $stringExploded[0];

- $entityId = intval($stringExploded[1]);

-

- $parent = false;

+ try {

+ $newBook = $this->chapterRepo->move($chapter, $entitySelection);

+ } catch (PermissionsException $exception) {

+ $this->showPermissionError();

+ } catch (MoveOperationException $exception) {

+ $this->showErrorNotification(trans('errors.selected_book_not_found'));

- if ($entityType == 'book') {

- $parent = $this->entityRepo->getById('book', $entityId);

- }

-

- if ($parent === false || $parent === null) {

- session()->flash('error', trans('errors.selected_book_not_found'));

return redirect()->back();

}

return redirect()->back();

}

- $this->entityRepo->changeBook('chapter', $parent->id, $chapter, true);

- Activity::add($chapter, 'chapter_move', $chapter->book->id);

- session()->flash('success', trans('entities.chapter_move_success', ['bookName' => $parent->name]));

+ $this->showSuccessNotification(trans('entities.chapter_move_success', ['bookName' => $newBook->name]));

return redirect($chapter->getUrl());

}

/**

return redirect($chapter->getUrl());

}

/**

- * Show the Restrictions view.

- * @param $bookSlug

- * @param $chapterSlug

- * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View

- * @throws \BookStack\Exceptions\NotFoundException

+ * Show the view to copy a chapter.

+ *

+ * @throws NotFoundException

*/

- public function showPermissions($bookSlug, $chapterSlug)

+ public function showCopy(string $bookSlug, string $chapterSlug)

{

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

- $this->checkOwnablePermission('restrictions-manage', $chapter);

- $roles = $this->userRepo->getRestrictableRoles();

- return view('chapters.permissions', [

+ $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

+ $this->checkOwnablePermission('chapter-view', $chapter);

+

+ session()->flashInput(['name' => $chapter->name]);

+

+ return view('chapters.copy', [

+ 'book' => $chapter->book,

'chapter' => $chapter,

- 'roles' => $roles

]);

}

/**

]);

}

/**

- * Set the restrictions for this chapter.

- * @param $bookSlug

- * @param $chapterSlug

- * @param Request $request

- * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector

- * @throws \BookStack\Exceptions\NotFoundException

- * @throws \Throwable

+ * Create a copy of a chapter within the requested target destination.

+ *

+ * @throws NotFoundException

+ * @throws Throwable

*/

- public function permissions($bookSlug, $chapterSlug, Request $request)

+ public function copy(Request $request, Cloner $cloner, string $bookSlug, string $chapterSlug)

{

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

- $this->checkOwnablePermission('restrictions-manage', $chapter);

- $this->entityRepo->updateEntityPermissionsFromRequest($request, $chapter);

- session()->flash('success', trans('entities.chapters_permissions_success'));

- return redirect($chapter->getUrl());

- }

+ $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

+ $this->checkOwnablePermission('chapter-view', $chapter);

- /**

- * Exports a chapter to pdf .

- * @param string $bookSlug

- * @param string $chapterSlug

- * @return \Illuminate\Http\Response

- */

- public function exportPdf($bookSlug, $chapterSlug)

- {

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

- $pdfContent = $this->exportService->chapterToPdf($chapter);

- return $this->downloadResponse($pdfContent, $chapterSlug . '.pdf');

- }

+ $entitySelection = $request->get('entity_selection') ?: null;

+ $newParentBook = $entitySelection ? $this->chapterRepo->findParentByIdentifier($entitySelection) : $chapter->getParent();

- /**

- * Export a chapter to a self-contained HTML file.

- * @param string $bookSlug

- * @param string $chapterSlug

- * @return \Illuminate\Http\Response

- */

- public function exportHtml($bookSlug, $chapterSlug)

- {

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

- $containedHtml = $this->exportService->chapterToContainedHtml($chapter);

- return $this->downloadResponse($containedHtml, $chapterSlug . '.html');

+ if (is_null($newParentBook)) {

+ $this->showErrorNotification(trans('errors.selected_book_not_found'));

+

+ return redirect()->back();

+ }

+

+ $this->checkOwnablePermission('chapter-create', $newParentBook);

+

+ $newName = $request->get('name') ?: $chapter->name;

+ $chapterCopy = $cloner->cloneChapter($chapter, $newParentBook, $newName);

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

+

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

}

/**

}

/**

- * Export a chapter to a simple plaintext .txt file.

- * @param string $bookSlug

- * @param string $chapterSlug

- * @return \Illuminate\Http\Response

+ * Convert the chapter to a book.

*/

- public function exportPlainText($bookSlug, $chapterSlug)

+ public function convertToBook(HierarchyTransformer $transformer, string $bookSlug, string $chapterSlug)

{

- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);

- $chapterText = $this->exportService->chapterToPlainText($chapter);

- return $this->downloadResponse($chapterText, $chapterSlug . '.txt');

+ $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

+ $this->checkOwnablePermission('chapter-update', $chapter);

+ $this->checkOwnablePermission('chapter-delete', $chapter);

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

+

+ $book = $transformer->transformChapterToBook($chapter);

+

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

}