1 <?php namespace BookStack\Http\Controllers;
4 use BookStack\Auth\UserRepo;
5 use BookStack\Entities\Repos\EntityRepo;
6 use BookStack\Entities\ExportService;
7 use BookStack\Entities\Repos\PageRepo;
8 use BookStack\Exceptions\NotFoundException;
9 use GatherContent\Htmldiff\Htmldiff;
10 use Illuminate\Http\Request;
11 use Illuminate\Http\Response;
14 class PageController extends Controller
18 protected $exportService;
22 * PageController constructor.
23 * @param \BookStack\Entities\Repos\PageRepo $pageRepo
24 * @param \BookStack\Entities\ExportService $exportService
25 * @param UserRepo $userRepo
27 public function __construct(PageRepo $pageRepo, ExportService $exportService, UserRepo $userRepo)
29 $this->pageRepo = $pageRepo;
30 $this->exportService = $exportService;
31 $this->userRepo = $userRepo;
32 parent::__construct();
36 * Show the form for creating a new page.
37 * @param string $bookSlug
38 * @param string $chapterSlug
40 * @internal param bool $pageSlug
41 * @throws NotFoundException
43 public function create($bookSlug, $chapterSlug = null)
45 if ($chapterSlug !== null) {
46 $chapter = $this->pageRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
47 $book = $chapter->book;
50 $book = $this->pageRepo->getBySlug('book', $bookSlug);
53 $parent = $chapter ? $chapter : $book;
54 $this->checkOwnablePermission('page-create', $parent);
56 // Redirect to draft edit screen if signed in
57 if ($this->signedIn) {
58 $draft = $this->pageRepo->getDraftPage($book, $chapter);
59 return redirect($draft->getUrl());
62 // Otherwise show the edit view if they're a guest
63 $this->setPageTitle(trans('entities.pages_new'));
64 return view('pages/guest-create', ['parent' => $parent]);
68 * Create a new page as a guest user.
69 * @param Request $request
70 * @param string $bookSlug
71 * @param string|null $chapterSlug
73 * @throws NotFoundException
75 public function createAsGuest(Request $request, $bookSlug, $chapterSlug = null)
77 $this->validate($request, [
78 'name' => 'required|string|max:255'
81 if ($chapterSlug !== null) {
82 $chapter = $this->pageRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
83 $book = $chapter->book;
86 $book = $this->pageRepo->getBySlug('book', $bookSlug);
89 $parent = $chapter ? $chapter : $book;
90 $this->checkOwnablePermission('page-create', $parent);
92 $page = $this->pageRepo->getDraftPage($book, $chapter);
93 $this->pageRepo->publishPageDraft($page, [
94 'name' => $request->get('name'),
97 return redirect($page->getUrl('/edit'));
101 * Show form to continue editing a draft page.
102 * @param string $bookSlug
104 * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
106 public function editDraft($bookSlug, $pageId)
108 $draft = $this->pageRepo->getById('page', $pageId, true);
109 $this->checkOwnablePermission('page-create', $draft->parent);
110 $this->setPageTitle(trans('entities.pages_edit_draft'));
112 $draftsEnabled = $this->signedIn;
113 return view('pages/edit', [
115 'book' => $draft->book,
117 'draftsEnabled' => $draftsEnabled
122 * Store a new page by changing a draft into a page.
123 * @param Request $request
124 * @param string $bookSlug
128 public function store(Request $request, $bookSlug, $pageId)
130 $this->validate($request, [
131 'name' => 'required|string|max:255'
134 $input = $request->all();
135 $draftPage = $this->pageRepo->getById('page', $pageId, true);
136 $book = $draftPage->book;
138 $parent = $draftPage->parent;
139 $this->checkOwnablePermission('page-create', $parent);
141 if ($parent->isA('chapter')) {
142 $input['priority'] = $this->pageRepo->getNewChapterPriority($parent);
144 $input['priority'] = $this->pageRepo->getNewBookPriority($parent);
147 $page = $this->pageRepo->publishPageDraft($draftPage, $input);
149 Activity::add($page, 'page_create', $book->id);
150 return redirect($page->getUrl());
154 * Display the specified page.
155 * If the page is not found via the slug the revisions are searched for a match.
156 * @param string $bookSlug
157 * @param string $pageSlug
159 * @throws NotFoundException
161 public function show($bookSlug, $pageSlug)
164 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
165 } catch (NotFoundException $e) {
166 $page = $this->pageRepo->getPageByOldSlug($pageSlug, $bookSlug);
167 if ($page === null) {
170 return redirect($page->getUrl());
173 $this->checkOwnablePermission('page-view', $page);
175 $page->html = $this->pageRepo->renderPage($page);
176 $sidebarTree = $this->pageRepo->getBookChildren($page->book);
177 $pageNav = $this->pageRepo->getPageNav($page->html);
179 // check if the comment's are enabled
180 $commentsEnabled = !setting('app-disable-comments');
181 if ($commentsEnabled) {
182 $page->load(['comments.createdBy']);
186 $this->setPageTitle($page->getShortName());
187 return view('pages/show', [
188 'page' => $page,'book' => $page->book,
190 'sidebarTree' => $sidebarTree,
191 'commentsEnabled' => $commentsEnabled,
192 'pageNav' => $pageNav
197 * Get page from an ajax request.
199 * @return \Illuminate\Http\JsonResponse
201 public function getPageAjax($pageId)
203 $page = $this->pageRepo->getById('page', $pageId);
204 return response()->json($page);
208 * Show the form for editing the specified page.
209 * @param string $bookSlug
210 * @param string $pageSlug
212 * @throws NotFoundException
214 public function edit($bookSlug, $pageSlug)
216 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
217 $this->checkOwnablePermission('page-update', $page);
218 $this->setPageTitle(trans('entities.pages_editing_named', ['pageName'=>$page->getShortName()]));
219 $page->isDraft = false;
221 // Check for active editing
223 if ($this->pageRepo->isPageEditingActive($page, 60)) {
224 $warnings[] = $this->pageRepo->getPageEditingActiveMessage($page, 60);
227 // Check for a current draft version for this user
228 $userPageDraft = $this->pageRepo->getUserPageDraft($page, $this->currentUser->id);
229 if ($userPageDraft !== null) {
230 $page->name = $userPageDraft->name;
231 $page->html = $userPageDraft->html;
232 $page->markdown = $userPageDraft->markdown;
233 $page->isDraft = true;
234 $warnings [] = $this->pageRepo->getUserPageDraftMessage($userPageDraft);
237 if (count($warnings) > 0) {
238 session()->flash('warning', implode("\n", $warnings));
241 $draftsEnabled = $this->signedIn;
242 return view('pages/edit', [
244 'book' => $page->book,
246 'draftsEnabled' => $draftsEnabled
251 * Update the specified page in storage.
252 * @param Request $request
253 * @param string $bookSlug
254 * @param string $pageSlug
257 public function update(Request $request, $bookSlug, $pageSlug)
259 $this->validate($request, [
260 'name' => 'required|string|max:255'
262 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
263 $this->checkOwnablePermission('page-update', $page);
264 $this->pageRepo->updatePage($page, $page->book->id, $request->all());
265 Activity::add($page, 'page_update', $page->book->id);
266 return redirect($page->getUrl());
270 * Save a draft update as a revision.
271 * @param Request $request
273 * @return \Illuminate\Http\JsonResponse
275 public function saveDraft(Request $request, $pageId)
277 $page = $this->pageRepo->getById('page', $pageId, true);
278 $this->checkOwnablePermission('page-update', $page);
280 if (!$this->signedIn) {
281 return response()->json([
283 'message' => trans('errors.guests_cannot_save_drafts'),
287 $draft = $this->pageRepo->updatePageDraft($page, $request->only(['name', 'html', 'markdown']));
289 $updateTime = $draft->updated_at->timestamp;
290 return response()->json([
291 'status' => 'success',
292 'message' => trans('entities.pages_edit_draft_save_at'),
293 'timestamp' => $updateTime
298 * Redirect from a special link url which
299 * uses the page id rather than the name.
301 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
303 public function redirectFromLink($pageId)
305 $page = $this->pageRepo->getById('page', $pageId);
306 return redirect($page->getUrl());
310 * Show the deletion page for the specified page.
311 * @param string $bookSlug
312 * @param string $pageSlug
313 * @return \Illuminate\View\View
315 public function showDelete($bookSlug, $pageSlug)
317 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
318 $this->checkOwnablePermission('page-delete', $page);
319 $this->setPageTitle(trans('entities.pages_delete_named', ['pageName'=>$page->getShortName()]));
320 return view('pages/delete', ['book' => $page->book, 'page' => $page, 'current' => $page]);
325 * Show the deletion page for the specified page.
326 * @param string $bookSlug
328 * @return \Illuminate\View\View
329 * @throws NotFoundException
331 public function showDeleteDraft($bookSlug, $pageId)
333 $page = $this->pageRepo->getById('page', $pageId, true);
334 $this->checkOwnablePermission('page-update', $page);
335 $this->setPageTitle(trans('entities.pages_delete_draft_named', ['pageName'=>$page->getShortName()]));
336 return view('pages/delete', ['book' => $page->book, 'page' => $page, 'current' => $page]);
340 * Remove the specified page from storage.
341 * @param string $bookSlug
342 * @param string $pageSlug
344 * @internal param int $id
346 public function destroy($bookSlug, $pageSlug)
348 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
350 $this->checkOwnablePermission('page-delete', $page);
351 $this->pageRepo->destroyPage($page);
353 Activity::addMessage('page_delete', $book->id, $page->name);
354 session()->flash('success', trans('entities.pages_delete_success'));
355 return redirect($book->getUrl());
359 * Remove the specified draft page from storage.
360 * @param string $bookSlug
363 * @throws NotFoundException
365 public function destroyDraft($bookSlug, $pageId)
367 $page = $this->pageRepo->getById('page', $pageId, true);
369 $this->checkOwnablePermission('page-update', $page);
370 session()->flash('success', trans('entities.pages_delete_draft_success'));
371 $this->pageRepo->destroyPage($page);
372 return redirect($book->getUrl());
376 * Shows the last revisions for this page.
377 * @param string $bookSlug
378 * @param string $pageSlug
379 * @return \Illuminate\View\View
381 public function showRevisions($bookSlug, $pageSlug)
383 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
384 $this->setPageTitle(trans('entities.pages_revisions_named', ['pageName'=>$page->getShortName()]));
385 return view('pages/revisions', ['page' => $page, 'book' => $page->book, 'current' => $page]);
389 * Shows a preview of a single revision
390 * @param string $bookSlug
391 * @param string $pageSlug
392 * @param int $revisionId
393 * @return \Illuminate\View\View
395 public function showRevision($bookSlug, $pageSlug, $revisionId)
397 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
398 $revision = $page->revisions()->where('id', '=', $revisionId)->first();
399 if ($revision === null) {
403 $page->fill($revision->toArray());
404 $this->setPageTitle(trans('entities.pages_revision_named', ['pageName' => $page->getShortName()]));
406 return view('pages/revision', [
408 'book' => $page->book,
409 'revision' => $revision
414 * Shows the changes of a single revision
415 * @param string $bookSlug
416 * @param string $pageSlug
417 * @param int $revisionId
418 * @return \Illuminate\View\View
420 public function showRevisionChanges($bookSlug, $pageSlug, $revisionId)
422 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
423 $revision = $page->revisions()->where('id', '=', $revisionId)->first();
424 if ($revision === null) {
428 $prev = $revision->getPrevious();
429 $prevContent = ($prev === null) ? '' : $prev->html;
430 $diff = (new Htmldiff)->diff($prevContent, $revision->html);
432 $page->fill($revision->toArray());
433 $this->setPageTitle(trans('entities.pages_revision_named', ['pageName'=>$page->getShortName()]));
435 return view('pages/revision', [
437 'book' => $page->book,
439 'revision' => $revision
444 * Restores a page using the content of the specified revision.
445 * @param string $bookSlug
446 * @param string $pageSlug
447 * @param int $revisionId
448 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
450 public function restoreRevision($bookSlug, $pageSlug, $revisionId)
452 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
453 $this->checkOwnablePermission('page-update', $page);
454 $page = $this->pageRepo->restorePageRevision($page, $page->book, $revisionId);
455 Activity::add($page, 'page_restore', $page->book->id);
456 return redirect($page->getUrl());
461 * Deletes a revision using the id of the specified revision.
462 * @param string $bookSlug
463 * @param string $pageSlug
465 * @throws NotFoundException
466 * @throws BadRequestException
467 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
469 public function destroyRevision($bookSlug, $pageSlug, $revId)
471 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
472 $this->checkOwnablePermission('page-delete', $page);
474 $revision = $page->revisions()->where('id', '=', $revId)->first();
475 if ($revision === null) {
476 throw new NotFoundException("Revision #{$revId} not found");
479 // Get the current revision for the page
480 $currentRevision = $page->getCurrentRevision();
482 // Check if its the latest revision, cannot delete latest revision.
483 if (intval($currentRevision->id) === intval($revId)) {
484 session()->flash('error', trans('entities.revision_cannot_delete_latest'));
485 return response()->view('pages/revisions', ['page' => $page, 'book' => $page->book, 'current' => $page], 400);
489 session()->flash('success', trans('entities.revision_delete_success'));
490 return view('pages/revisions', ['page' => $page, 'book' => $page->book, 'current' => $page]);
494 * Exports a page to a PDF.
495 * https://github.com/barryvdh/laravel-dompdf
496 * @param string $bookSlug
497 * @param string $pageSlug
498 * @return \Illuminate\Http\Response
500 public function exportPdf($bookSlug, $pageSlug)
502 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
503 $page->html = $this->pageRepo->renderPage($page);
504 $pdfContent = $this->exportService->pageToPdf($page);
505 return $this->downloadResponse($pdfContent, $pageSlug . '.pdf');
509 * Export a page to a self-contained HTML file.
510 * @param string $bookSlug
511 * @param string $pageSlug
512 * @return \Illuminate\Http\Response
514 public function exportHtml($bookSlug, $pageSlug)
516 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
517 $page->html = $this->pageRepo->renderPage($page);
518 $containedHtml = $this->exportService->pageToContainedHtml($page);
519 return $this->downloadResponse($containedHtml, $pageSlug . '.html');
523 * Export a page to a simple plaintext .txt file.
524 * @param string $bookSlug
525 * @param string $pageSlug
526 * @return \Illuminate\Http\Response
528 public function exportPlainText($bookSlug, $pageSlug)
530 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
531 $pageText = $this->exportService->pageToPlainText($page);
532 return $this->downloadResponse($pageText, $pageSlug . '.txt');
536 * Show a listing of recently created pages
537 * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
539 public function showRecentlyCreated()
541 $pages = $this->pageRepo->getRecentlyCreatedPaginated('page', 20)->setPath(baseUrl('/pages/recently-created'));
542 return view('pages/detailed-listing', [
543 'title' => trans('entities.recently_created_pages'),
549 * Show a listing of recently created pages
550 * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
552 public function showRecentlyUpdated()
554 $pages = $this->pageRepo->getRecentlyUpdatedPaginated('page', 20)->setPath(baseUrl('/pages/recently-updated'));
555 return view('pages/detailed-listing', [
556 'title' => trans('entities.recently_updated_pages'),
562 * Show the Restrictions view.
563 * @param string $bookSlug
564 * @param string $pageSlug
565 * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
567 public function showRestrict($bookSlug, $pageSlug)
569 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
570 $this->checkOwnablePermission('restrictions-manage', $page);
571 $roles = $this->userRepo->getRestrictableRoles();
572 return view('pages/restrictions', [
579 * Show the view to choose a new parent to move a page into.
580 * @param string $bookSlug
581 * @param string $pageSlug
583 * @throws NotFoundException
585 public function showMove($bookSlug, $pageSlug)
587 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
588 $this->checkOwnablePermission('page-update', $page);
589 $this->checkOwnablePermission('page-delete', $page);
590 return view('pages/move', [
591 'book' => $page->book,
597 * Does the action of moving the location of a page
598 * @param string $bookSlug
599 * @param string $pageSlug
600 * @param Request $request
602 * @throws NotFoundException
604 public function move($bookSlug, $pageSlug, Request $request)
606 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
607 $this->checkOwnablePermission('page-update', $page);
608 $this->checkOwnablePermission('page-delete', $page);
610 $entitySelection = $request->get('entity_selection', null);
611 if ($entitySelection === null || $entitySelection === '') {
612 return redirect($page->getUrl());
615 $stringExploded = explode(':', $entitySelection);
616 $entityType = $stringExploded[0];
617 $entityId = intval($stringExploded[1]);
621 $parent = $this->pageRepo->getById($entityType, $entityId);
622 } catch (\Exception $e) {
623 session()->flash(trans('entities.selected_book_chapter_not_found'));
624 return redirect()->back();
627 $this->checkOwnablePermission('page-create', $parent);
629 $this->pageRepo->changePageParent($page, $parent);
630 Activity::add($page, 'page_move', $page->book->id);
631 session()->flash('success', trans('entities.pages_move_success', ['parentName' => $parent->name]));
633 return redirect($page->getUrl());
637 * Show the view to copy a page.
638 * @param string $bookSlug
639 * @param string $pageSlug
641 * @throws NotFoundException
643 public function showCopy($bookSlug, $pageSlug)
645 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
646 $this->checkOwnablePermission('page-view', $page);
647 session()->flashInput(['name' => $page->name]);
648 return view('pages/copy', [
649 'book' => $page->book,
655 * Create a copy of a page within the requested target destination.
656 * @param string $bookSlug
657 * @param string $pageSlug
658 * @param Request $request
660 * @throws NotFoundException
662 public function copy($bookSlug, $pageSlug, Request $request)
664 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
665 $this->checkOwnablePermission('page-view', $page);
667 $entitySelection = $request->get('entity_selection', null);
668 if ($entitySelection === null || $entitySelection === '') {
669 $parent = $page->chapter ? $page->chapter : $page->book;
671 $stringExploded = explode(':', $entitySelection);
672 $entityType = $stringExploded[0];
673 $entityId = intval($stringExploded[1]);
676 $parent = $this->pageRepo->getById($entityType, $entityId);
677 } catch (\Exception $e) {
678 session()->flash(trans('entities.selected_book_chapter_not_found'));
679 return redirect()->back();
683 $this->checkOwnablePermission('page-create', $parent);
685 $pageCopy = $this->pageRepo->copyPage($page, $parent, $request->get('name', ''));
687 Activity::add($pageCopy, 'page_create', $pageCopy->book->id);
688 session()->flash('success', trans('entities.pages_copy_success'));
690 return redirect($pageCopy->getUrl());
694 * Set the permissions for this page.
695 * @param string $bookSlug
696 * @param string $pageSlug
697 * @param Request $request
698 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
699 * @throws NotFoundException
701 public function restrict($bookSlug, $pageSlug, Request $request)
703 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
704 $this->checkOwnablePermission('restrictions-manage', $page);
705 $this->pageRepo->updateEntityPermissionsFromRequest($request, $page);
706 session()->flash('success', trans('entities.pages_permissions_success'));
707 return redirect($page->getUrl());