BookStack Code Mirror - bookstack/blob - app/Http/Controllers/PageController.php

   1 <?php namespace BookStack\Http\Controllers;
   2
   3 use Activity;
   4 use BookStack\Exceptions\NotFoundException;
   5 use BookStack\Repos\UserRepo;
   6 use BookStack\Services\ExportService;
   7 use Carbon\Carbon;
   8 use Illuminate\Http\Request;
   9 use BookStack\Http\Requests;
  10 use BookStack\Repos\BookRepo;
  11 use BookStack\Repos\ChapterRepo;
  12 use BookStack\Repos\PageRepo;
  13 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  14 use Views;
  15 use GatherContent\Htmldiff\Htmldiff;
  16
  17 class PageController extends Controller
  18 {
  19
  20     protected $pageRepo;
  21     protected $bookRepo;
  22     protected $chapterRepo;
  23     protected $exportService;
  24     protected $userRepo;
  25
  26     /**
  27      * PageController constructor.
  28      * @param PageRepo $pageRepo
  29      * @param BookRepo $bookRepo
  30      * @param ChapterRepo $chapterRepo
  31      * @param ExportService $exportService
  32      * @param UserRepo $userRepo
  33      */
  34     public function __construct(PageRepo $pageRepo, BookRepo $bookRepo, ChapterRepo $chapterRepo, ExportService $exportService, UserRepo $userRepo)
  35     {
  36         $this->pageRepo = $pageRepo;
  37         $this->bookRepo = $bookRepo;
  38         $this->chapterRepo = $chapterRepo;
  39         $this->exportService = $exportService;
  40         $this->userRepo = $userRepo;
  41         parent::__construct();
  42     }
  43
  44     /**
  45      * Show the form for creating a new page.
  46      * @param string $bookSlug
  47      * @param bool $chapterSlug
  48      * @return Response
  49      * @internal param bool $pageSlug
  50      */
  51     public function create($bookSlug, $chapterSlug = false)
  52     {
  53         $book = $this->bookRepo->getBySlug($bookSlug);
  54         $chapter = $chapterSlug ? $this->chapterRepo->getBySlug($chapterSlug, $book->id) : null;
  55         $parent = $chapter ? $chapter : $book;
  56         $this->checkOwnablePermission('page-create', $parent);
  57         $this->setPageTitle('Create New Page');
  58
  59         $draft = $this->pageRepo->getDraftPage($book, $chapter);
  60         return redirect($draft->getUrl());
  61     }
  62
  63     /**
  64      * Show form to continue editing a draft page.
  65      * @param string $bookSlug
  66      * @param int $pageId
  67      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
  68      */
  69     public function editDraft($bookSlug, $pageId)
  70     {
  71         $book = $this->bookRepo->getBySlug($bookSlug);
  72         $draft = $this->pageRepo->getById($pageId, true);
  73         $this->checkOwnablePermission('page-create', $book);
  74         $this->setPageTitle('Edit Page Draft');
  75
  76         return view('pages/edit', ['page' => $draft, 'book' => $book, 'isDraft' => true]);
  77     }
  78
  79     /**
  80      * Store a new page by changing a draft into a page.
  81      * @param  Request $request
  82      * @param  string $bookSlug
  83      * @return Response
  84      */
  85     public function store(Request $request, $bookSlug, $pageId)
  86     {
  87         $this->validate($request, [
  88             'name' => 'required|string|max:255'
  89         ]);
  90
  91         $input = $request->all();
  92         $book = $this->bookRepo->getBySlug($bookSlug);
  93
  94         $draftPage = $this->pageRepo->getById($pageId, true);
  95
  96         $chapterId = intval($draftPage->chapter_id);
  97         $parent = $chapterId !== 0 ? $this->chapterRepo->getById($chapterId) : $book;
  98         $this->checkOwnablePermission('page-create', $parent);
  99
 100         if ($parent->isA('chapter')) {
 101             $input['priority'] = $this->chapterRepo->getNewPriority($parent);
 102         } else {
 103             $input['priority'] = $this->bookRepo->getNewPriority($parent);
 104         }
 105
 106         $page = $this->pageRepo->publishDraft($draftPage, $input);
 107
 108         Activity::add($page, 'page_create', $book->id);
 109         return redirect($page->getUrl());
 110     }
 111
 112     /**
 113      * Display the specified page.
 114      * If the page is not found via the slug the
 115      * revisions are searched for a match.
 116      * @param string $bookSlug
 117      * @param string $pageSlug
 118      * @return Response
 119      */
 120     public function show($bookSlug, $pageSlug)
 121     {
 122         $book = $this->bookRepo->getBySlug($bookSlug);
 123
 124         try {
 125             $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 126         } catch (NotFoundException $e) {
 127             $page = $this->pageRepo->findPageUsingOldSlug($pageSlug, $bookSlug);
 128             if ($page === null) abort(404);
 129             return redirect($page->getUrl());
 130         }
 131
 132         $this->checkOwnablePermission('page-view', $page);
 133
 134         $sidebarTree = $this->bookRepo->getChildren($book);
 135         $pageNav = $this->pageRepo->getPageNav($page);
 136
 137         Views::add($page);
 138         $this->setPageTitle($page->getShortName());
 139         return view('pages/show', ['page' => $page, 'book' => $book,
 140                                    'current' => $page, 'sidebarTree' => $sidebarTree, 'pageNav' => $pageNav]);
 141     }
 142
 143     /**
 144      * Get page from an ajax request.
 145      * @param int $pageId
 146      * @return \Illuminate\Http\JsonResponse
 147      */
 148     public function getPageAjax($pageId)
 149     {
 150         $page = $this->pageRepo->getById($pageId);
 151         return response()->json($page);
 152     }
 153
 154     /**
 155      * Show the form for editing the specified page.
 156      * @param string $bookSlug
 157      * @param string $pageSlug
 158      * @return Response
 159      */
 160     public function edit($bookSlug, $pageSlug)
 161     {
 162         $book = $this->bookRepo->getBySlug($bookSlug);
 163         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 164         $this->checkOwnablePermission('page-update', $page);
 165         $this->setPageTitle('Editing Page ' . $page->getShortName());
 166         $page->isDraft = false;
 167
 168         // Check for active editing
 169         $warnings = [];
 170         if ($this->pageRepo->isPageEditingActive($page, 60)) {
 171             $warnings[] = $this->pageRepo->getPageEditingActiveMessage($page, 60);
 172         }
 173
 174         // Check for a current draft version for this user
 175         if ($this->pageRepo->hasUserGotPageDraft($page, $this->currentUser->id)) {
 176             $draft = $this->pageRepo->getUserPageDraft($page, $this->currentUser->id);
 177             $page->name = $draft->name;
 178             $page->html = $draft->html;
 179             $page->markdown = $draft->markdown;
 180             $page->isDraft = true;
 181             $warnings [] = $this->pageRepo->getUserPageDraftMessage($draft);
 182         }
 183
 184         if (count($warnings) > 0) session()->flash('warning', implode("\n", $warnings));
 185
 186         return view('pages/edit', ['page' => $page, 'book' => $book, 'current' => $page]);
 187     }
 188
 189     /**
 190      * Update the specified page in storage.
 191      * @param  Request $request
 192      * @param  string $bookSlug
 193      * @param  string $pageSlug
 194      * @return Response
 195      */
 196     public function update(Request $request, $bookSlug, $pageSlug)
 197     {
 198         $this->validate($request, [
 199             'name' => 'required|string|max:255'
 200         ]);
 201         $book = $this->bookRepo->getBySlug($bookSlug);
 202         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 203         $this->checkOwnablePermission('page-update', $page);
 204         $this->pageRepo->updatePage($page, $book->id, $request->all());
 205         Activity::add($page, 'page_update', $book->id);
 206         return redirect($page->getUrl());
 207     }
 208
 209     /**
 210      * Save a draft update as a revision.
 211      * @param Request $request
 212      * @param int $pageId
 213      * @return \Illuminate\Http\JsonResponse
 214      */
 215     public function saveDraft(Request $request, $pageId)
 216     {
 217         $page = $this->pageRepo->getById($pageId, true);
 218         $this->checkOwnablePermission('page-update', $page);
 219         if ($page->draft) {
 220             $draft = $this->pageRepo->updateDraftPage($page, $request->only(['name', 'html', 'markdown']));
 221         } else {
 222             $draft = $this->pageRepo->saveUpdateDraft($page, $request->only(['name', 'html', 'markdown']));
 223         }
 224
 225         $updateTime = $draft->updated_at->timestamp;
 226         $utcUpdateTimestamp = $updateTime + Carbon::createFromTimestamp(0)->offset;
 227         return response()->json([
 228             'status'    => 'success',
 229             'message'   => 'Draft saved at ',
 230             'timestamp' => $utcUpdateTimestamp
 231         ]);
 232     }
 233
 234     /**
 235      * Redirect from a special link url which
 236      * uses the page id rather than the name.
 237      * @param int $pageId
 238      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 239      */
 240     public function redirectFromLink($pageId)
 241     {
 242         $page = $this->pageRepo->getById($pageId);
 243         return redirect($page->getUrl());
 244     }
 245
 246     /**
 247      * Show the deletion page for the specified page.
 248      * @param string $bookSlug
 249      * @param string $pageSlug
 250      * @return \Illuminate\View\View
 251      */
 252     public function showDelete($bookSlug, $pageSlug)
 253     {
 254         $book = $this->bookRepo->getBySlug($bookSlug);
 255         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 256         $this->checkOwnablePermission('page-delete', $page);
 257         $this->setPageTitle('Delete Page ' . $page->getShortName());
 258         return view('pages/delete', ['book' => $book, 'page' => $page, 'current' => $page]);
 259     }
 260
 261
 262     /**
 263      * Show the deletion page for the specified page.
 264      * @param string $bookSlug
 265      * @param int $pageId
 266      * @return \Illuminate\View\View
 267      * @throws NotFoundException
 268      */
 269     public function showDeleteDraft($bookSlug, $pageId)
 270     {
 271         $book = $this->bookRepo->getBySlug($bookSlug);
 272         $page = $this->pageRepo->getById($pageId, true);
 273         $this->checkOwnablePermission('page-update', $page);
 274         $this->setPageTitle('Delete Draft Page ' . $page->getShortName());
 275         return view('pages/delete', ['book' => $book, 'page' => $page, 'current' => $page]);
 276     }
 277
 278     /**
 279      * Remove the specified page from storage.
 280      * @param string $bookSlug
 281      * @param string $pageSlug
 282      * @return Response
 283      * @internal param int $id
 284      */
 285     public function destroy($bookSlug, $pageSlug)
 286     {
 287         $book = $this->bookRepo->getBySlug($bookSlug);
 288         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 289         $this->checkOwnablePermission('page-delete', $page);
 290         Activity::addMessage('page_delete', $book->id, $page->name);
 291         session()->flash('success', 'Page deleted');
 292         $this->pageRepo->destroy($page);
 293         return redirect($book->getUrl());
 294     }
 295
 296     /**
 297      * Remove the specified draft page from storage.
 298      * @param string $bookSlug
 299      * @param int $pageId
 300      * @return Response
 301      * @throws NotFoundException
 302      */
 303     public function destroyDraft($bookSlug, $pageId)
 304     {
 305         $book = $this->bookRepo->getBySlug($bookSlug);
 306         $page = $this->pageRepo->getById($pageId, true);
 307         $this->checkOwnablePermission('page-update', $page);
 308         session()->flash('success', 'Draft deleted');
 309         $this->pageRepo->destroy($page);
 310         return redirect($book->getUrl());
 311     }
 312
 313     /**
 314      * Shows the last revisions for this page.
 315      * @param string $bookSlug
 316      * @param string $pageSlug
 317      * @return \Illuminate\View\View
 318      */
 319     public function showRevisions($bookSlug, $pageSlug)
 320     {
 321         $book = $this->bookRepo->getBySlug($bookSlug);
 322         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 323         $this->setPageTitle('Revisions For ' . $page->getShortName());
 324         return view('pages/revisions', ['page' => $page, 'book' => $book, 'current' => $page]);
 325     }
 326
 327     /**
 328      * Shows a preview of a single revision
 329      * @param string $bookSlug
 330      * @param string $pageSlug
 331      * @param int $revisionId
 332      * @return \Illuminate\View\View
 333      */
 334     public function showRevision($bookSlug, $pageSlug, $revisionId)
 335     {
 336         $book = $this->bookRepo->getBySlug($bookSlug);
 337         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 338         $revision = $this->pageRepo->getRevisionById($revisionId);
 339
 340         $page->fill($revision->toArray());
 341         $this->setPageTitle('Page Revision For ' . $page->getShortName());
 342
 343         return view('pages/revision', [
 344             'page' => $page,
 345             'book' => $book,
 346         ]);
 347     }
 348
 349     /**
 350      * Shows the changes of a single revision
 351      * @param string $bookSlug
 352      * @param string $pageSlug
 353      * @param int $revisionId
 354      * @return \Illuminate\View\View
 355      */
 356     public function showRevisionChanges($bookSlug, $pageSlug, $revisionId)
 357     {
 358         $book = $this->bookRepo->getBySlug($bookSlug);
 359         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 360         $revision = $this->pageRepo->getRevisionById($revisionId);
 361
 362         $prev = $revision->getPrevious();
 363         $prevContent = ($prev === null) ? '' : $prev->html;
 364         $diff = (new Htmldiff)->diff($prevContent, $revision->html);
 365
 366         $page->fill($revision->toArray());
 367         $this->setPageTitle('Page Revision For ' . $page->getShortName());
 368
 369         return view('pages/revision', [
 370             'page' => $page,
 371             'book' => $book,
 372             'diff' => $diff,
 373         ]);
 374     }
 375
 376     /**
 377      * Restores a page using the content of the specified revision.
 378      * @param string $bookSlug
 379      * @param string $pageSlug
 380      * @param int $revisionId
 381      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 382      */
 383     public function restoreRevision($bookSlug, $pageSlug, $revisionId)
 384     {
 385         $book = $this->bookRepo->getBySlug($bookSlug);
 386         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 387         $this->checkOwnablePermission('page-update', $page);
 388         $page = $this->pageRepo->restoreRevision($page, $book, $revisionId);
 389         Activity::add($page, 'page_restore', $book->id);
 390         return redirect($page->getUrl());
 391     }
 392
 393     /**
 394      * Exports a page to pdf format using barryvdh/laravel-dompdf wrapper.
 395      * https://github.com/barryvdh/laravel-dompdf
 396      * @param string $bookSlug
 397      * @param string $pageSlug
 398      * @return \Illuminate\Http\Response
 399      */
 400     public function exportPdf($bookSlug, $pageSlug)
 401     {
 402         $book = $this->bookRepo->getBySlug($bookSlug);
 403         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 404         $pdfContent = $this->exportService->pageToPdf($page);
 405         return response()->make($pdfContent, 200, [
 406             'Content-Type'        => 'application/octet-stream',
 407             'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.pdf'
 408         ]);
 409     }
 410
 411     /**
 412      * Export a page to a self-contained HTML file.
 413      * @param string $bookSlug
 414      * @param string $pageSlug
 415      * @return \Illuminate\Http\Response
 416      */
 417     public function exportHtml($bookSlug, $pageSlug)
 418     {
 419         $book = $this->bookRepo->getBySlug($bookSlug);
 420         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 421         $containedHtml = $this->exportService->pageToContainedHtml($page);
 422         return response()->make($containedHtml, 200, [
 423             'Content-Type'        => 'application/octet-stream',
 424             'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.html'
 425         ]);
 426     }
 427
 428     /**
 429      * Export a page to a simple plaintext .txt file.
 430      * @param string $bookSlug
 431      * @param string $pageSlug
 432      * @return \Illuminate\Http\Response
 433      */
 434     public function exportPlainText($bookSlug, $pageSlug)
 435     {
 436         $book = $this->bookRepo->getBySlug($bookSlug);
 437         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 438         $containedHtml = $this->exportService->pageToPlainText($page);
 439         return response()->make($containedHtml, 200, [
 440             'Content-Type'        => 'application/octet-stream',
 441             'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.txt'
 442         ]);
 443     }
 444
 445     /**
 446      * Show a listing of recently created pages
 447      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
 448      */
 449     public function showRecentlyCreated()
 450     {
 451         $pages = $this->pageRepo->getRecentlyCreatedPaginated(20)->setPath(baseUrl('/pages/recently-created'));
 452         return view('pages/detailed-listing', [
 453             'title' => 'Recently Created Pages',
 454             'pages' => $pages
 455         ]);
 456     }
 457
 458     /**
 459      * Show a listing of recently created pages
 460      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
 461      */
 462     public function showRecentlyUpdated()
 463     {
 464         $pages = $this->pageRepo->getRecentlyUpdatedPaginated(20)->setPath(baseUrl('/pages/recently-updated'));
 465         return view('pages/detailed-listing', [
 466             'title' => 'Recently Updated Pages',
 467             'pages' => $pages
 468         ]);
 469     }
 470
 471     /**
 472      * Show the Restrictions view.
 473      * @param string $bookSlug
 474      * @param string $pageSlug
 475      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
 476      */
 477     public function showRestrict($bookSlug, $pageSlug)
 478     {
 479         $book = $this->bookRepo->getBySlug($bookSlug);
 480         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 481         $this->checkOwnablePermission('restrictions-manage', $page);
 482         $roles = $this->userRepo->getRestrictableRoles();
 483         return view('pages/restrictions', [
 484             'page'  => $page,
 485             'roles' => $roles
 486         ]);
 487     }
 488
 489     /**
 490      * Show the view to choose a new parent to move a page into.
 491      * @param string $bookSlug
 492      * @param string $pageSlug
 493      * @return mixed
 494      * @throws NotFoundException
 495      */
 496     public function showMove($bookSlug, $pageSlug)
 497     {
 498         $book = $this->bookRepo->getBySlug($bookSlug);
 499         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 500         $this->checkOwnablePermission('page-update', $page);
 501         return view('pages/move', [
 502             'book' => $book,
 503             'page' => $page
 504         ]);
 505     }
 506
 507     /**
 508      * Does the action of moving the location of a page
 509      * @param string $bookSlug
 510      * @param string $pageSlug
 511      * @param Request $request
 512      * @return mixed
 513      * @throws NotFoundException
 514      */
 515     public function move($bookSlug, $pageSlug, Request $request)
 516     {
 517         $book = $this->bookRepo->getBySlug($bookSlug);
 518         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 519         $this->checkOwnablePermission('page-update', $page);
 520
 521         $entitySelection = $request->get('entity_selection', null);
 522         if ($entitySelection === null || $entitySelection === '') {
 523             return redirect($page->getUrl());
 524         }
 525
 526         $stringExploded = explode(':', $entitySelection);
 527         $entityType = $stringExploded[0];
 528         $entityId = intval($stringExploded[1]);
 529
 530         $parent = false;
 531
 532         if ($entityType == 'chapter') {
 533             $parent = $this->chapterRepo->getById($entityId);
 534         } else if ($entityType == 'book') {
 535             $parent = $this->bookRepo->getById($entityId);
 536         }
 537
 538         if ($parent === false || $parent === null) {
 539             session()->flash('The selected Book or Chapter was not found');
 540             return redirect()->back();
 541         }
 542
 543         $this->pageRepo->changePageParent($page, $parent);
 544         Activity::add($page, 'page_move', $page->book->id);
 545         session()->flash('success', sprintf('Page moved to "%s"', $parent->name));
 546
 547         return redirect($page->getUrl());
 548     }
 549
 550     /**
 551      * Set the permissions for this page.
 552      * @param string $bookSlug
 553      * @param string $pageSlug
 554      * @param Request $request
 555      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 556      */
 557     public function restrict($bookSlug, $pageSlug, Request $request)
 558     {
 559         $book = $this->bookRepo->getBySlug($bookSlug);
 560         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 561         $this->checkOwnablePermission('restrictions-manage', $page);
 562         $this->pageRepo->updateEntityPermissionsFromRequest($request, $page);
 563         session()->flash('success', 'Page Permissions Updated');
 564         return redirect($page->getUrl());
 565     }
 566
 567 }