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