-<?php namespace BookStack\Http\Controllers;
+<?php
+namespace BookStack\Http\Controllers;
+
+use BookStack\Actions\View;
+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\Models\Page;
-use BookStack\Entities\Repos\PageRepo;
-use BookStack\Entities\Tools\PermissionsUpdater;
+use BookStack\Entities\Tools\PageEditorData;
use BookStack\Exceptions\NotFoundException;
-use BookStack\Exceptions\NotifyException;
use BookStack\Exceptions\PermissionsException;
+use BookStack\References\ReferenceFetcher;
use Exception;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Http\Request;
use Illuminate\Validation\ValidationException;
use Throwable;
-use Views;
class PageController extends Controller
{
-
- protected $pageRepo;
+ protected PageRepo $pageRepo;
+ protected ReferenceFetcher $referenceFetcher;
/**
* PageController constructor.
*/
- public function __construct(PageRepo $pageRepo)
+ public function __construct(PageRepo $pageRepo, ReferenceFetcher $referenceFetcher)
{
$this->pageRepo = $pageRepo;
+ $this->referenceFetcher = $referenceFetcher;
}
/**
* Show the form for creating a new page.
+ *
* @throws Throwable
*/
public function create(string $bookSlug, string $chapterSlug = null)
// Redirect to draft edit screen if signed in
if ($this->isSignedIn()) {
$draft = $this->pageRepo->getNewDraftPage($parent);
+
return redirect($draft->getUrl());
}
// Otherwise show the edit view if they're a guest
$this->setPageTitle(trans('entities.pages_new'));
+
return view('pages.guest-create', ['parent' => $parent]);
}
/**
* Create a new page as a guest user.
+ *
* @throws ValidationException
*/
public function createAsGuest(Request $request, string $bookSlug, string $chapterSlug = null)
{
$this->validate($request, [
- 'name' => 'required|string|max:255'
+ 'name' => ['required', 'string', 'max:255'],
]);
$parent = $this->pageRepo->getParentFromSlugs($bookSlug, $chapterSlug);
$page = $this->pageRepo->getNewDraftPage($parent);
$this->pageRepo->publishDraft($page, [
'name' => $request->get('name'),
- 'html' => ''
+ 'html' => '',
]);
return redirect($page->getUrl('/edit'));
/**
* Show form to continue editing a draft page.
+ *
* @throws NotFoundException
*/
- public function editDraft(string $bookSlug, int $pageId)
+ public function editDraft(Request $request, string $bookSlug, int $pageId)
{
$draft = $this->pageRepo->getById($pageId);
$this->checkOwnablePermission('page-create', $draft->getParent());
- $this->setPageTitle(trans('entities.pages_edit_draft'));
- $draftsEnabled = $this->isSignedIn();
- $templates = $this->pageRepo->getTemplates(10);
+ $editorData = new PageEditorData($draft, $this->pageRepo, $request->query('editor', ''));
+ $this->setPageTitle(trans('entities.pages_edit_draft'));
- return view('pages.edit', [
- 'page' => $draft,
- 'book' => $draft->book,
- 'isDraft' => true,
- 'draftsEnabled' => $draftsEnabled,
- 'templates' => $templates,
- ]);
+ return view('pages.edit', $editorData->getViewData());
}
/**
* Store a new page by changing a draft into a page.
+ *
* @throws NotFoundException
* @throws ValidationException
*/
public function store(Request $request, string $bookSlug, int $pageId)
{
$this->validate($request, [
- 'name' => 'required|string|max:255'
+ 'name' => ['required', 'string', 'max:255'],
]);
$draftPage = $this->pageRepo->getById($pageId);
$this->checkOwnablePermission('page-create', $draftPage->getParent());
/**
* Display the specified page.
* If the page is not found via the slug the revisions are searched for a match.
+ *
* @throws NotFoundException
*/
public function show(string $bookSlug, string $pageSlug)
$page->load(['comments.createdBy']);
}
- Views::add($page);
+ $nextPreviousLocator = new NextPreviousContentLocator($page, $sidebarTree);
+
+ View::incrementFor($page);
$this->setPageTitle($page->getShortName());
+
return view('pages.show', [
- 'page' => $page,
- 'book' => $page->book,
- 'current' => $page,
- 'sidebarTree' => $sidebarTree,
+ 'page' => $page,
+ 'book' => $page->book,
+ 'current' => $page,
+ 'sidebarTree' => $sidebarTree,
'commentsEnabled' => $commentsEnabled,
- 'pageNav' => $pageNav
+ 'pageNav' => $pageNav,
+ 'next' => $nextPreviousLocator->getNext(),
+ 'previous' => $nextPreviousLocator->getPrevious(),
+ 'referenceCount' => $this->referenceFetcher->getPageReferenceCountToEntity($page),
]);
}
/**
* Get page from an ajax request.
+ *
* @throws NotFoundException
*/
public function getPageAjax(int $pageId)
{
$page = $this->pageRepo->getById($pageId);
$page->setHidden(array_diff($page->getHidden(), ['html', 'markdown']));
- $page->addHidden(['book']);
+ $page->makeHidden(['book']);
+
return response()->json($page);
}
/**
* Show the form for editing the specified page.
+ *
* @throws NotFoundException
*/
- public function edit(string $bookSlug, string $pageSlug)
+ public function edit(Request $request, string $bookSlug, string $pageSlug)
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-update', $page);
- $page->isDraft = false;
- $editActivity = new PageEditActivity($page);
-
- // Check for active editing
- $warnings = [];
- if ($editActivity->hasActiveEditing()) {
- $warnings[] = $editActivity->activeEditingMessage();
+ $editorData = new PageEditorData($page, $this->pageRepo, $request->query('editor', ''));
+ if ($editorData->getWarnings()) {
+ $this->showWarningNotification(implode("\n", $editorData->getWarnings()));
}
- // Check for a current draft version for this user
- $userDraft = $this->pageRepo->getUserDraft($page);
- if ($userDraft !== null) {
- $page->forceFill($userDraft->only(['name', 'html', 'markdown']));
- $page->isDraft = true;
- $warnings[] = $editActivity->getEditingActiveDraftMessage($userDraft);
- }
-
- if (count($warnings) > 0) {
- $this->showWarningNotification(implode("\n", $warnings));
- }
-
- $templates = $this->pageRepo->getTemplates(10);
- $draftsEnabled = $this->isSignedIn();
$this->setPageTitle(trans('entities.pages_editing_named', ['pageName' => $page->getShortName()]));
- return view('pages.edit', [
- 'page' => $page,
- 'book' => $page->book,
- 'current' => $page,
- 'draftsEnabled' => $draftsEnabled,
- 'templates' => $templates,
- ]);
+
+ return view('pages.edit', $editorData->getViewData());
}
/**
* Update the specified page in storage.
+ *
* @throws ValidationException
* @throws NotFoundException
*/
public function update(Request $request, string $bookSlug, string $pageSlug)
{
$this->validate($request, [
- 'name' => 'required|string|max:255'
+ 'name' => ['required', 'string', 'max:255'],
]);
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-update', $page);
/**
* Save a draft update as a revision.
+ *
* @throws NotFoundException
*/
public function saveDraft(Request $request, int $pageId)
}
$draft = $this->pageRepo->updatePageDraft($page, $request->only(['name', 'html', 'markdown']));
+ $warnings = (new PageEditActivity($page))->getWarningMessagesForDraft($draft);
- $updateTime = $draft->updated_at->timestamp;
return response()->json([
'status' => 'success',
'message' => trans('entities.pages_edit_draft_save_at'),
- 'timestamp' => $updateTime
+ 'warning' => implode("\n", $warnings),
+ 'timestamp' => $draft->updated_at->timestamp,
]);
}
/**
* Redirect from a special link url which uses the page id rather than the name.
+ *
* @throws NotFoundException
*/
public function redirectFromLink(int $pageId)
{
$page = $this->pageRepo->getById($pageId);
+
return redirect($page->getUrl());
}
/**
* Show the deletion page for the specified page.
+ *
* @throws NotFoundException
*/
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()]));
+ $this->setPageTitle(trans('entities.pages_delete_named', ['pageName' => $page->getShortName()]));
+
return view('pages.delete', [
- 'book' => $page->book,
- 'page' => $page,
- 'current' => $page
+ 'book' => $page->book,
+ 'page' => $page,
+ 'current' => $page,
]);
}
/**
* Show the deletion page for the specified page.
+ *
* @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()]));
+ $this->setPageTitle(trans('entities.pages_delete_draft_named', ['pageName' => $page->getShortName()]));
+
return view('pages.delete', [
- 'book' => $page->book,
- 'page' => $page,
- 'current' => $page
+ 'book' => $page->book,
+ 'page' => $page,
+ 'current' => $page,
]);
}
/**
* Remove the specified page from storage.
+ *
* @throws NotFoundException
* @throws Throwable
- * @throws NotifyException
*/
public function destroy(string $bookSlug, string $pageSlug)
{
/**
* Remove the specified draft page from storage.
+ *
* @throws NotFoundException
- * @throws NotifyException
* @throws Throwable
*/
public function destroyDraft(string $bookSlug, int $pageId)
if ($chapter && userCan('view', $chapter)) {
return redirect($chapter->getUrl());
}
+
return redirect($book->getUrl());
}
*/
public function showRecentlyUpdated()
{
- $pages = Page::visible()->orderBy('updated_at', 'desc')
+ $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'));
- return view('pages.detailed-listing', [
- 'title' => trans('entities.recently_updated_pages'),
- 'pages' => $pages
+ $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.
+ *
* @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);
+
return view('pages.move', [
'book' => $page->book,
- 'page' => $page
+ 'page' => $page,
]);
}
/**
* Does the action of moving the location of a page.
+ *
* @throws NotFoundException
* @throws Throwable
*/
try {
$parent = $this->pageRepo->move($page, $entitySelection);
+ } catch (PermissionsException $exception) {
+ $this->showPermissionError();
} catch (Exception $exception) {
- if ($exception instanceof PermissionsException) {
- $this->showPermissionError();
- }
-
$this->showErrorNotification(trans('errors.selected_book_chapter_not_found'));
+
return redirect()->back();
}
$this->showSuccessNotification(trans('entities.pages_move_success', ['parentName' => $parent->name]));
+
return redirect($page->getUrl());
}
/**
* Show the view to copy a page.
+ *
* @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]);
+
return view('pages.copy', [
'book' => $page->book,
- 'page' => $page
+ 'page' => $page,
]);
}
-
/**
* Create a copy of a page within the requested target destination.
+ *
* @throws NotFoundException
* @throws Throwable
*/
- public function copy(Request $request, string $bookSlug, string $pageSlug)
+ 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) ?? null;
- $newName = $request->get('name', null);
-
- try {
- $pageCopy = $this->pageRepo->copy($page, $entitySelection, $newName);
- } catch (Exception $exception) {
- if ($exception instanceof PermissionsException) {
- $this->showPermissionError();
- }
+ $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'));
+
return redirect()->back();
}
- $this->showSuccessNotification(trans('entities.pages_copy_success'));
- return redirect($pageCopy->getUrl());
- }
+ $this->checkOwnablePermission('page-create', $newParent);
- /**
- * Show the Permissions view.
- * @throws NotFoundException
- */
- public function showPermissions(string $bookSlug, string $pageSlug)
- {
- $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
- $this->checkOwnablePermission('restrictions-manage', $page);
- return view('pages.permissions', [
- 'page' => $page,
- ]);
- }
-
- /**
- * Set the permissions for this page.
- * @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);
+ $newName = $request->get('name') ?: $page->name;
+ $pageCopy = $cloner->clonePage($page, $newParent, $newName);
+ $this->showSuccessNotification(trans('entities.pages_copy_success'));
- $this->showSuccessNotification(trans('entities.pages_permissions_success'));
- return redirect($page->getUrl());
+ return redirect($pageCopy->getUrl());
}
}