mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-12-11 20:54:38 +08:00
f634b4ea57
Not totally happy with implementation as is requires extra service to be injected to core controllers, but does the job. Included test to cover. Updated some controller properties to be typed while there.
294 lines
9.8 KiB
PHP
294 lines
9.8 KiB
PHP
<?php
|
|
|
|
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\Entities\Tools\PermissionsUpdater;
|
|
use BookStack\Exceptions\MoveOperationException;
|
|
use BookStack\Exceptions\NotFoundException;
|
|
use BookStack\Exceptions\PermissionsException;
|
|
use BookStack\References\ReferenceFetcher;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Validation\ValidationException;
|
|
use Throwable;
|
|
|
|
class ChapterController extends Controller
|
|
{
|
|
protected ChapterRepo $chapterRepo;
|
|
protected ReferenceFetcher $referenceFetcher;
|
|
|
|
|
|
public function __construct(ChapterRepo $chapterRepo, ReferenceFetcher $referenceFetcher)
|
|
{
|
|
$this->chapterRepo = $chapterRepo;
|
|
$this->referenceFetcher = $referenceFetcher;
|
|
}
|
|
|
|
/**
|
|
* Show the form for creating a new chapter.
|
|
*/
|
|
public function create(string $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.
|
|
*
|
|
* @throws ValidationException
|
|
*/
|
|
public function store(Request $request, string $bookSlug)
|
|
{
|
|
$this->validate($request, [
|
|
'name' => ['required', 'string', 'max:255'],
|
|
]);
|
|
|
|
$book = Book::visible()->where('slug', '=', $bookSlug)->firstOrFail();
|
|
$this->checkOwnablePermission('chapter-create', $book);
|
|
|
|
$chapter = $this->chapterRepo->create($request->all(), $book);
|
|
|
|
return redirect($chapter->getUrl());
|
|
}
|
|
|
|
/**
|
|
* Display the specified chapter.
|
|
*/
|
|
public function show(string $bookSlug, string $chapterSlug)
|
|
{
|
|
$chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
|
|
$this->checkOwnablePermission('chapter-view', $chapter);
|
|
|
|
$sidebarTree = (new BookContents($chapter->book))->getTree();
|
|
$pages = $chapter->getVisiblePages();
|
|
$nextPreviousLocator = new NextPreviousContentLocator($chapter, $sidebarTree);
|
|
View::incrementFor($chapter);
|
|
|
|
$this->setPageTitle($chapter->getShortName());
|
|
|
|
return view('chapters.show', [
|
|
'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.
|
|
*/
|
|
public function edit(string $bookSlug, string $chapterSlug)
|
|
{
|
|
$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.
|
|
*
|
|
* @throws NotFoundException
|
|
*/
|
|
public function update(Request $request, string $bookSlug, string $chapterSlug)
|
|
{
|
|
$chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
|
|
$this->checkOwnablePermission('chapter-update', $chapter);
|
|
|
|
$this->chapterRepo->update($chapter, $request->all());
|
|
|
|
return redirect($chapter->getUrl());
|
|
}
|
|
|
|
/**
|
|
* Shows the page to confirm deletion of this chapter.
|
|
*
|
|
* @throws NotFoundException
|
|
*/
|
|
public function showDelete(string $bookSlug, string $chapterSlug)
|
|
{
|
|
$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.
|
|
*
|
|
* @throws NotFoundException
|
|
* @throws Throwable
|
|
*/
|
|
public function destroy(string $bookSlug, string $chapterSlug)
|
|
{
|
|
$chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
|
|
$this->checkOwnablePermission('chapter-delete', $chapter);
|
|
|
|
$this->chapterRepo->destroy($chapter);
|
|
|
|
return redirect($chapter->book->getUrl());
|
|
}
|
|
|
|
/**
|
|
* Show the page for moving a chapter.
|
|
*
|
|
* @throws NotFoundException
|
|
*/
|
|
public function showMove(string $bookSlug, string $chapterSlug)
|
|
{
|
|
$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);
|
|
|
|
return view('chapters.move', [
|
|
'chapter' => $chapter,
|
|
'book' => $chapter->book,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Perform the move action for a chapter.
|
|
*
|
|
* @throws NotFoundException
|
|
*/
|
|
public function move(Request $request, string $bookSlug, string $chapterSlug)
|
|
{
|
|
$chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
|
|
$this->checkOwnablePermission('chapter-update', $chapter);
|
|
$this->checkOwnablePermission('chapter-delete', $chapter);
|
|
|
|
$entitySelection = $request->get('entity_selection', null);
|
|
if ($entitySelection === null || $entitySelection === '') {
|
|
return redirect($chapter->getUrl());
|
|
}
|
|
|
|
try {
|
|
$newBook = $this->chapterRepo->move($chapter, $entitySelection);
|
|
} catch (PermissionsException $exception) {
|
|
$this->showPermissionError();
|
|
} catch (MoveOperationException $exception) {
|
|
$this->showErrorNotification(trans('errors.selected_book_not_found'));
|
|
|
|
return redirect()->back();
|
|
}
|
|
|
|
$this->showSuccessNotification(trans('entities.chapter_move_success', ['bookName' => $newBook->name]));
|
|
|
|
return redirect($chapter->getUrl());
|
|
}
|
|
|
|
/**
|
|
* Show the view to copy a chapter.
|
|
*
|
|
* @throws NotFoundException
|
|
*/
|
|
public function showCopy(string $bookSlug, string $chapterSlug)
|
|
{
|
|
$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,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Create a copy of a chapter within the requested target destination.
|
|
*
|
|
* @throws NotFoundException
|
|
* @throws Throwable
|
|
*/
|
|
public function copy(Request $request, Cloner $cloner, string $bookSlug, string $chapterSlug)
|
|
{
|
|
$chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
|
|
$this->checkOwnablePermission('chapter-view', $chapter);
|
|
|
|
$entitySelection = $request->get('entity_selection') ?: null;
|
|
$newParentBook = $entitySelection ? $this->chapterRepo->findParentByIdentifier($entitySelection) : $chapter->getParent();
|
|
|
|
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());
|
|
}
|
|
|
|
/**
|
|
* Show the Restrictions view.
|
|
*
|
|
* @throws NotFoundException
|
|
*/
|
|
public function showPermissions(string $bookSlug, string $chapterSlug)
|
|
{
|
|
$chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
|
|
$this->checkOwnablePermission('restrictions-manage', $chapter);
|
|
|
|
return view('chapters.permissions', [
|
|
'chapter' => $chapter,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Set the restrictions for this chapter.
|
|
*
|
|
* @throws NotFoundException
|
|
*/
|
|
public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $bookSlug, string $chapterSlug)
|
|
{
|
|
$chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
|
|
$this->checkOwnablePermission('restrictions-manage', $chapter);
|
|
|
|
$permissionsUpdater->updateFromPermissionsForm($chapter, $request);
|
|
|
|
$this->showSuccessNotification(trans('entities.chapters_permissions_success'));
|
|
|
|
return redirect($chapter->getUrl());
|
|
}
|
|
|
|
/**
|
|
* Convert the chapter to a book.
|
|
*/
|
|
public function convertToBook(HierarchyTransformer $transformer, string $bookSlug, string $chapterSlug)
|
|
{
|
|
$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());
|
|
}
|
|
}
|