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 $templates = $this->pageRepo->getPageTemplates(10);
115 return view('pages.edit', [
117 'book' => $draft->book,
119 'draftsEnabled' => $draftsEnabled,
120 'templates' => $templates,
125 * Store a new page by changing a draft into a page.
126 * @param Request $request
127 * @param string $bookSlug
131 public function store(Request $request, $bookSlug, $pageId)
133 $this->validate($request, [
134 'name' => 'required|string|max:255'
137 $input = $request->all();
138 $draftPage = $this->pageRepo->getById('page', $pageId, true);
139 $book = $draftPage->book;
141 $parent = $draftPage->parent;
142 $this->checkOwnablePermission('page-create', $parent);
144 if ($parent->isA('chapter')) {
145 $input['priority'] = $this->pageRepo->getNewChapterPriority($parent);
147 $input['priority'] = $this->pageRepo->getNewBookPriority($parent);
150 $page = $this->pageRepo->publishPageDraft($draftPage, $input);
152 Activity::add($page, 'page_create', $book->id);
153 return redirect($page->getUrl());
157 * Display the specified page.
158 * If the page is not found via the slug the revisions are searched for a match.
159 * @param string $bookSlug
160 * @param string $pageSlug
162 * @throws NotFoundException
164 public function show($bookSlug, $pageSlug)
167 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
168 } catch (NotFoundException $e) {
169 $page = $this->pageRepo->getPageByOldSlug($pageSlug, $bookSlug);
170 if ($page === null) {
173 return redirect($page->getUrl());
176 $this->checkOwnablePermission('page-view', $page);
178 $page->html = $this->pageRepo->renderPage($page);
179 $sidebarTree = $this->pageRepo->getBookChildren($page->book);
180 $pageNav = $this->pageRepo->getPageNav($page->html);
182 // check if the comment's are enabled
183 $commentsEnabled = !setting('app-disable-comments');
184 if ($commentsEnabled) {
185 $page->load(['comments.createdBy']);
189 $this->setPageTitle($page->getShortName());
190 return view('pages.show', [
191 'page' => $page,'book' => $page->book,
193 'sidebarTree' => $sidebarTree,
194 'commentsEnabled' => $commentsEnabled,
195 'pageNav' => $pageNav
200 * Get page from an ajax request.
202 * @return \Illuminate\Http\JsonResponse
204 public function getPageAjax($pageId)
206 $page = $this->pageRepo->getById('page', $pageId);
207 return response()->json($page);
211 * Show the form for editing the specified page.
212 * @param string $bookSlug
213 * @param string $pageSlug
215 * @throws NotFoundException
217 public function edit($bookSlug, $pageSlug)
219 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
220 $this->checkOwnablePermission('page-update', $page);
221 $this->setPageTitle(trans('entities.pages_editing_named', ['pageName'=>$page->getShortName()]));
222 $page->isDraft = false;
224 // Check for active editing
226 if ($this->pageRepo->isPageEditingActive($page, 60)) {
227 $warnings[] = $this->pageRepo->getPageEditingActiveMessage($page, 60);
230 // Check for a current draft version for this user
231 $userPageDraft = $this->pageRepo->getUserPageDraft($page, $this->currentUser->id);
232 if ($userPageDraft !== null) {
233 $page->name = $userPageDraft->name;
234 $page->html = $userPageDraft->html;
235 $page->markdown = $userPageDraft->markdown;
236 $page->isDraft = true;
237 $warnings [] = $this->pageRepo->getUserPageDraftMessage($userPageDraft);
240 if (count($warnings) > 0) {
241 session()->flash('warning', implode("\n", $warnings));
244 $draftsEnabled = $this->signedIn;
245 $templates = $this->pageRepo->getPageTemplates(10);
247 return view('pages.edit', [
249 'book' => $page->book,
251 'draftsEnabled' => $draftsEnabled,
252 'templates' => $templates,
257 * Update the specified page in storage.
258 * @param Request $request
259 * @param string $bookSlug
260 * @param string $pageSlug
263 public function update(Request $request, $bookSlug, $pageSlug)
265 $this->validate($request, [
266 'name' => 'required|string|max:255'
268 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
269 $this->checkOwnablePermission('page-update', $page);
270 $this->pageRepo->updatePage($page, $page->book->id, $request->all());
271 Activity::add($page, 'page_update', $page->book->id);
272 return redirect($page->getUrl());
276 * Save a draft update as a revision.
277 * @param Request $request
279 * @return \Illuminate\Http\JsonResponse
281 public function saveDraft(Request $request, $pageId)
283 $page = $this->pageRepo->getById('page', $pageId, true);
284 $this->checkOwnablePermission('page-update', $page);
286 if (!$this->signedIn) {
287 return response()->json([
289 'message' => trans('errors.guests_cannot_save_drafts'),
293 $draft = $this->pageRepo->updatePageDraft($page, $request->only(['name', 'html', 'markdown']));
295 $updateTime = $draft->updated_at->timestamp;
296 return response()->json([
297 'status' => 'success',
298 'message' => trans('entities.pages_edit_draft_save_at'),
299 'timestamp' => $updateTime
304 * Redirect from a special link url which
305 * uses the page id rather than the name.
307 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
309 public function redirectFromLink($pageId)
311 $page = $this->pageRepo->getById('page', $pageId);
312 return redirect($page->getUrl());
316 * Show the deletion page for the specified page.
317 * @param string $bookSlug
318 * @param string $pageSlug
319 * @return \Illuminate\View\View
321 public function showDelete($bookSlug, $pageSlug)
323 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
324 $this->checkOwnablePermission('page-delete', $page);
325 $this->setPageTitle(trans('entities.pages_delete_named', ['pageName'=>$page->getShortName()]));
326 return view('pages.delete', ['book' => $page->book, 'page' => $page, 'current' => $page]);
331 * Show the deletion page for the specified page.
332 * @param string $bookSlug
334 * @return \Illuminate\View\View
335 * @throws NotFoundException
337 public function showDeleteDraft($bookSlug, $pageId)
339 $page = $this->pageRepo->getById('page', $pageId, true);
340 $this->checkOwnablePermission('page-update', $page);
341 $this->setPageTitle(trans('entities.pages_delete_draft_named', ['pageName'=>$page->getShortName()]));
342 return view('pages.delete', ['book' => $page->book, 'page' => $page, 'current' => $page]);
346 * Remove the specified page from storage.
347 * @param string $bookSlug
348 * @param string $pageSlug
350 * @internal param int $id
352 public function destroy($bookSlug, $pageSlug)
354 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
356 $this->checkOwnablePermission('page-delete', $page);
357 $this->pageRepo->destroyPage($page);
359 Activity::addMessage('page_delete', $book->id, $page->name);
360 session()->flash('success', trans('entities.pages_delete_success'));
361 return redirect($book->getUrl());
365 * Remove the specified draft page from storage.
366 * @param string $bookSlug
369 * @throws NotFoundException
371 public function destroyDraft($bookSlug, $pageId)
373 $page = $this->pageRepo->getById('page', $pageId, true);
375 $this->checkOwnablePermission('page-update', $page);
376 session()->flash('success', trans('entities.pages_delete_draft_success'));
377 $this->pageRepo->destroyPage($page);
378 return redirect($book->getUrl());
382 * Shows the last revisions for this page.
383 * @param string $bookSlug
384 * @param string $pageSlug
385 * @return \Illuminate\View\View
386 * @throws NotFoundException
388 public function showRevisions($bookSlug, $pageSlug)
390 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
391 $this->setPageTitle(trans('entities.pages_revisions_named', ['pageName'=>$page->getShortName()]));
392 return view('pages.revisions', ['page' => $page, 'current' => $page]);
396 * Shows a preview of a single revision
397 * @param string $bookSlug
398 * @param string $pageSlug
399 * @param int $revisionId
400 * @return \Illuminate\View\View
402 public function showRevision($bookSlug, $pageSlug, $revisionId)
404 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
405 $revision = $page->revisions()->where('id', '=', $revisionId)->first();
406 if ($revision === null) {
410 $page->fill($revision->toArray());
411 $this->setPageTitle(trans('entities.pages_revision_named', ['pageName' => $page->getShortName()]));
413 return view('pages.revision', [
415 'book' => $page->book,
417 'revision' => $revision
422 * Shows the changes of a single revision
423 * @param string $bookSlug
424 * @param string $pageSlug
425 * @param int $revisionId
426 * @return \Illuminate\View\View
428 public function showRevisionChanges($bookSlug, $pageSlug, $revisionId)
430 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
431 $revision = $page->revisions()->where('id', '=', $revisionId)->first();
432 if ($revision === null) {
436 $prev = $revision->getPrevious();
437 $prevContent = ($prev === null) ? '' : $prev->html;
438 $diff = (new Htmldiff)->diff($prevContent, $revision->html);
440 $page->fill($revision->toArray());
441 $this->setPageTitle(trans('entities.pages_revision_named', ['pageName'=>$page->getShortName()]));
443 return view('pages.revision', [
445 'book' => $page->book,
447 'revision' => $revision
452 * Restores a page using the content of the specified revision.
453 * @param string $bookSlug
454 * @param string $pageSlug
455 * @param int $revisionId
456 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
458 public function restoreRevision($bookSlug, $pageSlug, $revisionId)
460 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
461 $this->checkOwnablePermission('page-update', $page);
462 $page = $this->pageRepo->restorePageRevision($page, $page->book, $revisionId);
463 Activity::add($page, 'page_restore', $page->book->id);
464 return redirect($page->getUrl());
469 * Deletes a revision using the id of the specified revision.
470 * @param string $bookSlug
471 * @param string $pageSlug
473 * @throws NotFoundException
474 * @throws BadRequestException
475 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
477 public function destroyRevision($bookSlug, $pageSlug, $revId)
479 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
480 $this->checkOwnablePermission('page-delete', $page);
482 $revision = $page->revisions()->where('id', '=', $revId)->first();
483 if ($revision === null) {
484 throw new NotFoundException("Revision #{$revId} not found");
487 // Get the current revision for the page
488 $currentRevision = $page->getCurrentRevision();
490 // Check if its the latest revision, cannot delete latest revision.
491 if (intval($currentRevision->id) === intval($revId)) {
492 session()->flash('error', trans('entities.revision_cannot_delete_latest'));
493 return response()->view('pages.revisions', ['page' => $page, 'book' => $page->book, 'current' => $page], 400);
497 session()->flash('success', trans('entities.revision_delete_success'));
498 return redirect($page->getUrl('/revisions'));
502 * Exports a page to a PDF.
503 * https://github.com/barryvdh/laravel-dompdf
504 * @param string $bookSlug
505 * @param string $pageSlug
506 * @return \Illuminate\Http\Response
508 public function exportPdf($bookSlug, $pageSlug)
510 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
511 $page->html = $this->pageRepo->renderPage($page);
512 $pdfContent = $this->exportService->pageToPdf($page);
513 return $this->downloadResponse($pdfContent, $pageSlug . '.pdf');
517 * Export a page to a self-contained HTML file.
518 * @param string $bookSlug
519 * @param string $pageSlug
520 * @return \Illuminate\Http\Response
522 public function exportHtml($bookSlug, $pageSlug)
524 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
525 $page->html = $this->pageRepo->renderPage($page);
526 $containedHtml = $this->exportService->pageToContainedHtml($page);
527 return $this->downloadResponse($containedHtml, $pageSlug . '.html');
531 * Export a page to a simple plaintext .txt file.
532 * @param string $bookSlug
533 * @param string $pageSlug
534 * @return \Illuminate\Http\Response
536 public function exportPlainText($bookSlug, $pageSlug)
538 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
539 $pageText = $this->exportService->pageToPlainText($page);
540 return $this->downloadResponse($pageText, $pageSlug . '.txt');
544 * Show a listing of recently created pages
545 * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
547 public function showRecentlyUpdated()
549 // TODO - Still exist?
550 $pages = $this->pageRepo->getRecentlyUpdatedPaginated('page', 20)->setPath(url('/pages/recently-updated'));
551 return view('pages.detailed-listing', [
552 'title' => trans('entities.recently_updated_pages'),
558 * Show the view to choose a new parent to move a page into.
559 * @param string $bookSlug
560 * @param string $pageSlug
562 * @throws NotFoundException
564 public function showMove($bookSlug, $pageSlug)
566 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
567 $this->checkOwnablePermission('page-update', $page);
568 $this->checkOwnablePermission('page-delete', $page);
569 return view('pages.move', [
570 'book' => $page->book,
576 * Does the action of moving the location of a page
577 * @param string $bookSlug
578 * @param string $pageSlug
579 * @param Request $request
581 * @throws NotFoundException
583 public function move($bookSlug, $pageSlug, Request $request)
585 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
586 $this->checkOwnablePermission('page-update', $page);
587 $this->checkOwnablePermission('page-delete', $page);
589 $entitySelection = $request->get('entity_selection', null);
590 if ($entitySelection === null || $entitySelection === '') {
591 return redirect($page->getUrl());
594 $stringExploded = explode(':', $entitySelection);
595 $entityType = $stringExploded[0];
596 $entityId = intval($stringExploded[1]);
600 $parent = $this->pageRepo->getById($entityType, $entityId);
601 } catch (\Exception $e) {
602 session()->flash(trans('entities.selected_book_chapter_not_found'));
603 return redirect()->back();
606 $this->checkOwnablePermission('page-create', $parent);
608 $this->pageRepo->changePageParent($page, $parent);
609 Activity::add($page, 'page_move', $page->book->id);
610 session()->flash('success', trans('entities.pages_move_success', ['parentName' => $parent->name]));
612 return redirect($page->getUrl());
616 * Show the view to copy a page.
617 * @param string $bookSlug
618 * @param string $pageSlug
620 * @throws NotFoundException
622 public function showCopy($bookSlug, $pageSlug)
624 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
625 $this->checkOwnablePermission('page-view', $page);
626 session()->flashInput(['name' => $page->name]);
627 return view('pages.copy', [
628 'book' => $page->book,
634 * Create a copy of a page within the requested target destination.
635 * @param string $bookSlug
636 * @param string $pageSlug
637 * @param Request $request
639 * @throws NotFoundException
641 public function copy($bookSlug, $pageSlug, Request $request)
643 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
644 $this->checkOwnablePermission('page-view', $page);
646 $entitySelection = $request->get('entity_selection', null);
647 if ($entitySelection === null || $entitySelection === '') {
648 $parent = $page->chapter ? $page->chapter : $page->book;
650 $stringExploded = explode(':', $entitySelection);
651 $entityType = $stringExploded[0];
652 $entityId = intval($stringExploded[1]);
655 $parent = $this->pageRepo->getById($entityType, $entityId);
656 } catch (\Exception $e) {
657 session()->flash(trans('entities.selected_book_chapter_not_found'));
658 return redirect()->back();
662 $this->checkOwnablePermission('page-create', $parent);
664 $pageCopy = $this->pageRepo->copyPage($page, $parent, $request->get('name', ''));
666 Activity::add($pageCopy, 'page_create', $pageCopy->book->id);
667 session()->flash('success', trans('entities.pages_copy_success'));
669 return redirect($pageCopy->getUrl());
673 * Show the Permissions view.
674 * @param string $bookSlug
675 * @param string $pageSlug
676 * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
677 * @throws NotFoundException
679 public function showPermissions($bookSlug, $pageSlug)
681 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
682 $this->checkOwnablePermission('restrictions-manage', $page);
683 $roles = $this->userRepo->getRestrictableRoles();
684 return view('pages.permissions', [
691 * Set the permissions for this page.
692 * @param string $bookSlug
693 * @param string $pageSlug
694 * @param Request $request
695 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
696 * @throws NotFoundException
699 public function permissions($bookSlug, $pageSlug, Request $request)
701 $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
702 $this->checkOwnablePermission('restrictions-manage', $page);
703 $this->pageRepo->updateEntityPermissionsFromRequest($request, $page);
704 session()->flash('success', trans('entities.pages_permissions_success'));
705 return redirect($page->getUrl());