1
0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-30 23:52:40 +01:00
BookStack/app/Http/Controllers/PageController.php

485 lines
15 KiB
PHP
Raw Normal View History

2021-06-26 17:23:15 +02:00
<?php
namespace BookStack\Http\Controllers;
2015-07-12 21:01:42 +02:00
use BookStack\Actions\View;
2021-06-26 17:23:15 +02:00
use BookStack\Entities\Models\Page;
use BookStack\Entities\Repos\PageRepo;
use BookStack\Entities\Tools\BookContents;
use BookStack\Entities\Tools\Cloner;
use BookStack\Entities\Tools\NextPreviousContentLocator;
use BookStack\Entities\Tools\PageContent;
use BookStack\Entities\Tools\PageEditActivity;
use BookStack\Entities\Tools\PageEditorData;
use BookStack\Entities\Tools\PermissionsUpdater;
use BookStack\Exceptions\NotFoundException;
use BookStack\Exceptions\PermissionsException;
use Exception;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
2015-07-12 21:01:42 +02:00
use Illuminate\Http\Request;
use Illuminate\Validation\ValidationException;
use Throwable;
2015-07-12 21:01:42 +02:00
class PageController extends Controller
{
protected PageRepo $pageRepo;
2015-07-12 22:31:15 +02:00
/**
* PageController constructor.
*/
public function __construct(PageRepo $pageRepo)
2015-07-12 22:31:15 +02:00
{
$this->pageRepo = $pageRepo;
2015-07-12 22:31:15 +02:00
}
2015-07-12 21:01:42 +02:00
/**
2015-08-09 13:06:52 +02:00
* Show the form for creating a new page.
2021-06-26 17:23:15 +02:00
*
* @throws Throwable
2015-07-12 21:01:42 +02:00
*/
public function create(string $bookSlug, string $chapterSlug = null)
2015-07-12 21:01:42 +02:00
{
$parent = $this->pageRepo->getParentFromSlugs($bookSlug, $chapterSlug);
$this->checkOwnablePermission('page-create', $parent);
// Redirect to draft edit screen if signed in
if ($this->isSignedIn()) {
$draft = $this->pageRepo->getNewDraftPage($parent);
2021-06-26 17:23:15 +02:00
return redirect($draft->getUrl());
}
// Otherwise show the edit view if they're a guest
2016-12-04 17:51:39 +01:00
$this->setPageTitle(trans('entities.pages_new'));
2021-06-26 17:23:15 +02:00
return view('pages.guest-create', ['parent' => $parent]);
}
/**
* Create a new page as a guest user.
2021-06-26 17:23:15 +02:00
*
* @throws ValidationException
*/
public function createAsGuest(Request $request, string $bookSlug, string $chapterSlug = null)
{
$this->validate($request, [
'name' => ['required', 'string', 'max:255'],
]);
$parent = $this->pageRepo->getParentFromSlugs($bookSlug, $chapterSlug);
$this->checkOwnablePermission('page-create', $parent);
$page = $this->pageRepo->getNewDraftPage($parent);
$this->pageRepo->publishDraft($page, [
'name' => $request->get('name'),
2021-06-26 17:23:15 +02:00
'html' => '',
]);
return redirect($page->getUrl('/edit'));
}
/**
* Show form to continue editing a draft page.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
*/
public function editDraft(string $bookSlug, int $pageId)
{
$draft = $this->pageRepo->getById($pageId);
$this->checkOwnablePermission('page-create', $draft->getParent());
$editorData = new PageEditorData($draft, $this->pageRepo);
$this->setPageTitle(trans('entities.pages_edit_draft'));
return view('pages.edit', $editorData->getViewData());
2015-07-12 21:01:42 +02:00
}
/**
* Store a new page by changing a draft into a page.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
* @throws ValidationException
2015-07-12 21:01:42 +02:00
*/
public function store(Request $request, string $bookSlug, int $pageId)
2015-07-12 21:01:42 +02:00
{
2015-07-12 22:31:15 +02:00
$this->validate($request, [
'name' => ['required', 'string', 'max:255'],
2015-07-12 22:31:15 +02:00
]);
$draftPage = $this->pageRepo->getById($pageId);
$this->checkOwnablePermission('page-create', $draftPage->getParent());
$page = $this->pageRepo->publishDraft($draftPage, $request->all());
2015-07-20 23:05:26 +02:00
2015-07-12 22:31:15 +02:00
return redirect($page->getUrl());
2015-07-12 21:01:42 +02:00
}
/**
2015-08-09 13:06:52 +02:00
* Display the specified page.
2017-01-01 17:05:44 +01:00
* If the page is not found via the slug the revisions are searched for a match.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
2015-07-12 21:01:42 +02:00
*/
public function show(string $bookSlug, string $pageSlug)
2015-07-12 21:01:42 +02:00
{
try {
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
} catch (NotFoundException $e) {
$page = $this->pageRepo->getByOldSlug($bookSlug, $pageSlug);
if ($page === null) {
throw $e;
}
return redirect($page->getUrl());
}
$this->checkOwnablePermission('page-view', $page);
$pageContent = (new PageContent($page));
$page->html = $pageContent->render();
$sidebarTree = (new BookContents($page->book))->getTree();
$pageNav = $pageContent->getNavigation($page->html);
// Check if page comments are enabled
$commentsEnabled = !setting('app-disable-comments');
if ($commentsEnabled) {
$page->load(['comments.createdBy']);
}
$nextPreviousLocator = new NextPreviousContentLocator($page, $sidebarTree);
View::incrementFor($page);
$this->setPageTitle($page->getShortName());
2021-06-26 17:23:15 +02:00
return view('pages.show', [
2021-06-26 17:23:15 +02:00
'page' => $page,
'book' => $page->book,
'current' => $page,
'sidebarTree' => $sidebarTree,
'commentsEnabled' => $commentsEnabled,
2021-06-26 17:23:15 +02:00
'pageNav' => $pageNav,
'next' => $nextPreviousLocator->getNext(),
'previous' => $nextPreviousLocator->getPrevious(),
]);
2015-07-12 21:01:42 +02:00
}
2016-03-12 16:52:19 +01:00
/**
* Get page from an ajax request.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
2016-03-12 16:52:19 +01:00
*/
public function getPageAjax(int $pageId)
2016-03-12 16:52:19 +01:00
{
$page = $this->pageRepo->getById($pageId);
$page->setHidden(array_diff($page->getHidden(), ['html', 'markdown']));
$page->makeHidden(['book']);
2021-06-26 17:23:15 +02:00
2016-03-12 16:52:19 +01:00
return response()->json($page);
}
2015-07-12 21:01:42 +02:00
/**
2015-08-09 13:06:52 +02:00
* Show the form for editing the specified page.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
2015-07-12 21:01:42 +02:00
*/
public function edit(string $bookSlug, string $pageSlug)
2015-07-12 21:01:42 +02:00
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-update', $page);
$editorData = new PageEditorData($page, $this->pageRepo);
if ($editorData->getWarnings()) {
$this->showWarningNotification(implode("\n", $editorData->getWarnings()));
2016-03-12 16:52:19 +01:00
}
$this->setPageTitle(trans('entities.pages_editing_named', ['pageName' => $page->getShortName()]));
2021-06-26 17:23:15 +02:00
return view('pages.edit', $editorData->getViewData());
2015-07-12 21:01:42 +02:00
}
/**
2015-08-09 13:06:52 +02:00
* Update the specified page in storage.
2021-06-26 17:23:15 +02:00
*
* @throws ValidationException
* @throws NotFoundException
2015-07-12 21:01:42 +02:00
*/
public function update(Request $request, string $bookSlug, string $pageSlug)
2015-07-12 21:01:42 +02:00
{
$this->validate($request, [
'name' => ['required', 'string', 'max:255'],
]);
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-update', $page);
$this->pageRepo->update($page, $request->all());
2015-07-12 22:31:15 +02:00
return redirect($page->getUrl());
2015-07-12 21:01:42 +02:00
}
/**
* Save a draft update as a revision.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
*/
public function saveDraft(Request $request, int $pageId)
{
$page = $this->pageRepo->getById($pageId);
$this->checkOwnablePermission('page-update', $page);
if (!$this->isSignedIn()) {
return $this->jsonError(trans('errors.guests_cannot_save_drafts'), 500);
}
$draft = $this->pageRepo->updatePageDraft($page, $request->only(['name', 'html', 'markdown']));
$warnings = (new PageEditActivity($page))->getWarningMessagesForDraft($draft);
2021-06-26 17:23:15 +02:00
return response()->json([
2021-06-26 17:23:15 +02:00
'status' => 'success',
'message' => trans('entities.pages_edit_draft_save_at'),
'warning' => implode("\n", $warnings),
'timestamp' => $draft->updated_at->timestamp,
]);
}
2015-07-21 21:13:29 +02:00
/**
* Redirect from a special link url which uses the page id rather than the name.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
2015-07-21 21:13:29 +02:00
*/
public function redirectFromLink(int $pageId)
2015-07-16 20:15:22 +02:00
{
$page = $this->pageRepo->getById($pageId);
2021-06-26 17:23:15 +02:00
2015-07-16 20:15:22 +02:00
return redirect($page->getUrl());
}
2015-08-09 13:06:52 +02:00
/**
* Show the deletion page for the specified page.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
2015-08-09 13:06:52 +02:00
*/
public function showDelete(string $bookSlug, string $pageSlug)
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-delete', $page);
$this->setPageTitle(trans('entities.pages_delete_named', ['pageName' => $page->getShortName()]));
2021-06-26 17:23:15 +02:00
return view('pages.delete', [
2021-06-26 17:23:15 +02:00
'book' => $page->book,
'page' => $page,
'current' => $page,
]);
}
/**
* Show the deletion page for the specified page.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
*/
public function showDeleteDraft(string $bookSlug, int $pageId)
{
$page = $this->pageRepo->getById($pageId);
$this->checkOwnablePermission('page-update', $page);
$this->setPageTitle(trans('entities.pages_delete_draft_named', ['pageName' => $page->getShortName()]));
2021-06-26 17:23:15 +02:00
return view('pages.delete', [
2021-06-26 17:23:15 +02:00
'book' => $page->book,
'page' => $page,
'current' => $page,
]);
}
2015-07-12 21:01:42 +02:00
/**
2015-08-09 13:06:52 +02:00
* Remove the specified page from storage.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
* @throws Throwable
2015-07-12 21:01:42 +02:00
*/
public function destroy(string $bookSlug, string $pageSlug)
2015-07-12 21:01:42 +02:00
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-delete', $page);
$parent = $page->getParent();
$this->pageRepo->destroy($page);
return redirect($parent->getUrl());
}
/**
* Remove the specified draft page from storage.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
* @throws Throwable
*/
public function destroyDraft(string $bookSlug, int $pageId)
{
$page = $this->pageRepo->getById($pageId);
2017-01-01 17:05:44 +01:00
$book = $page->book;
$chapter = $page->chapter;
$this->checkOwnablePermission('page-update', $page);
2015-08-09 13:06:52 +02:00
$this->pageRepo->destroy($page);
2015-08-09 13:06:52 +02:00
$this->showSuccessNotification(trans('entities.pages_delete_draft_success'));
2016-07-07 19:42:21 +02:00
if ($chapter && userCan('view', $chapter)) {
return redirect($chapter->getUrl());
}
2021-06-26 17:23:15 +02:00
return redirect($book->getUrl());
}
/**
* Show a listing of recently created pages.
*/
public function showRecentlyUpdated()
{
$visibleBelongsScope = function (BelongsTo $query) {
$query->scopes('visible');
};
$pages = Page::visible()->with(['updatedBy', 'book' => $visibleBelongsScope, 'chapter' => $visibleBelongsScope])
->orderBy('updated_at', 'desc')
->paginate(20)
->setPath(url('/pages/recently-updated'));
$this->setPageTitle(trans('entities.recently_updated_pages'));
return view('common.detailed-listing-paginated', [
'title' => trans('entities.recently_updated_pages'),
'entities' => $pages,
'showUpdatedBy' => true,
'showPath' => true,
]);
}
/**
* Show the view to choose a new parent to move a page into.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
*/
public function showMove(string $bookSlug, string $pageSlug)
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-update', $page);
$this->checkOwnablePermission('page-delete', $page);
2021-06-26 17:23:15 +02:00
return view('pages.move', [
2017-01-01 17:05:44 +01:00
'book' => $page->book,
2021-06-26 17:23:15 +02:00
'page' => $page,
]);
}
2016-06-25 16:31:38 +02:00
/**
* Does the action of moving the location of a page.
2021-06-26 17:23:15 +02:00
*
2016-06-25 16:31:38 +02:00
* @throws NotFoundException
* @throws Throwable
2016-06-25 16:31:38 +02:00
*/
public function move(Request $request, string $bookSlug, string $pageSlug)
2016-06-12 13:14:14 +02:00
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
2016-06-12 13:14:14 +02:00
$this->checkOwnablePermission('page-update', $page);
$this->checkOwnablePermission('page-delete', $page);
2016-06-12 13:14:14 +02:00
$entitySelection = $request->get('entity_selection', null);
if ($entitySelection === null || $entitySelection === '') {
return redirect($page->getUrl());
}
2017-01-01 17:05:44 +01:00
try {
$parent = $this->pageRepo->move($page, $entitySelection);
} catch (PermissionsException $exception) {
$this->showPermissionError();
} catch (Exception $exception) {
$this->showErrorNotification(trans('errors.selected_book_chapter_not_found'));
2021-06-26 17:23:15 +02:00
2016-06-12 13:14:14 +02:00
return redirect()->back();
}
$this->showSuccessNotification(trans('entities.pages_move_success', ['parentName' => $parent->name]));
2021-06-26 17:23:15 +02:00
2016-06-12 13:14:14 +02:00
return redirect($page->getUrl());
}
/**
* Show the view to copy a page.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
*/
public function showCopy(string $bookSlug, string $pageSlug)
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-view', $page);
session()->flashInput(['name' => $page->name]);
2021-06-26 17:23:15 +02:00
return view('pages.copy', [
'book' => $page->book,
2021-06-26 17:23:15 +02:00
'page' => $page,
]);
}
/**
* Create a copy of a page within the requested target destination.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
* @throws Throwable
*/
public function copy(Request $request, Cloner $cloner, string $bookSlug, string $pageSlug)
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-view', $page);
$entitySelection = $request->get('entity_selection') ?: null;
$newParent = $entitySelection ? $this->pageRepo->findParentByIdentifier($entitySelection) : $page->getParent();
if (is_null($newParent)) {
$this->showErrorNotification(trans('errors.selected_book_chapter_not_found'));
2021-12-20 18:40:27 +01:00
return redirect()->back();
}
$this->checkOwnablePermission('page-create', $newParent);
$newName = $request->get('name') ?: $page->name;
$pageCopy = $cloner->clonePage($page, $newParent, $newName);
$this->showSuccessNotification(trans('entities.pages_copy_success'));
2021-06-26 17:23:15 +02:00
return redirect($pageCopy->getUrl());
}
/**
* Show the Permissions view.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
*/
public function showPermissions(string $bookSlug, string $pageSlug)
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('restrictions-manage', $page);
2021-06-26 17:23:15 +02:00
return view('pages.permissions', [
'page' => $page,
]);
}
/**
* Set the permissions for this page.
2021-06-26 17:23:15 +02:00
*
* @throws NotFoundException
* @throws Throwable
*/
public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $bookSlug, string $pageSlug)
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('restrictions-manage', $page);
$permissionsUpdater->updateFromPermissionsForm($page, $request);
$this->showSuccessNotification(trans('entities.pages_permissions_success'));
2021-06-26 17:23:15 +02:00
return redirect($page->getUrl());
}
2015-07-12 21:01:42 +02:00
}