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 Icap\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      $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 $bookSlug
  66      * @param $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 $bookSlug
 117      * @param $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         Views::add($page);
 136         $this->setPageTitle($page->getShortName());
 137         return view('pages/show', ['page' => $page, 'book' => $book, 'current' => $page, 'sidebarTree' => $sidebarTree]);
 138     }
 139
 140     /**
 141      * Get page from an ajax request.
 142      * @param $pageId
 143      * @return \Illuminate\Http\JsonResponse
 144      */
 145     public function getPageAjax($pageId)
 146     {
 147         $page = $this->pageRepo->getById($pageId);
 148         return response()->json($page);
 149     }
 150
 151     /**
 152      * Show the form for editing the specified page.
 153      * @param $bookSlug
 154      * @param $pageSlug
 155      * @return Response
 156      */
 157     public function edit($bookSlug, $pageSlug)
 158     {
 159         $book = $this->bookRepo->getBySlug($bookSlug);
 160         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 161         $this->checkOwnablePermission('page-update', $page);
 162         $this->setPageTitle('Editing Page ' . $page->getShortName());
 163         $page->isDraft = false;
 164
 165         // Check for active editing
 166         $warnings = [];
 167         if ($this->pageRepo->isPageEditingActive($page, 60)) {
 168             $warnings[] = $this->pageRepo->getPageEditingActiveMessage($page, 60);
 169         }
 170
 171         // Check for a current draft version for this user
 172         if ($this->pageRepo->hasUserGotPageDraft($page, $this->currentUser->id)) {
 173             $draft = $this->pageRepo->getUserPageDraft($page, $this->currentUser->id);
 174             $page->name = $draft->name;
 175             $page->html = $draft->html;
 176             $page->markdown = $draft->markdown;
 177             $page->isDraft = true;
 178             $warnings [] = $this->pageRepo->getUserPageDraftMessage($draft);
 179         }
 180
 181         if (count($warnings) > 0) session()->flash('warning', implode("\n", $warnings));
 182
 183         return view('pages/edit', ['page' => $page, 'book' => $book, 'current' => $page]);
 184     }
 185
 186     /**
 187      * Update the specified page in storage.
 188      * @param  Request $request
 189      * @param          $bookSlug
 190      * @param          $pageSlug
 191      * @return Response
 192      */
 193     public function update(Request $request, $bookSlug, $pageSlug)
 194     {
 195         $this->validate($request, [
 196             'name' => 'required|string|max:255'
 197         ]);
 198         $book = $this->bookRepo->getBySlug($bookSlug);
 199         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 200         $this->checkOwnablePermission('page-update', $page);
 201         $this->pageRepo->updatePage($page, $book->id, $request->all());
 202         Activity::add($page, 'page_update', $book->id);
 203         return redirect($page->getUrl());
 204     }
 205
 206     /**
 207      * Save a draft update as a revision.
 208      * @param Request $request
 209      * @param $pageId
 210      * @return \Illuminate\Http\JsonResponse
 211      */
 212     public function saveDraft(Request $request, $pageId)
 213     {
 214         $page = $this->pageRepo->getById($pageId, true);
 215         $this->checkOwnablePermission('page-update', $page);
 216         if ($page->draft) {
 217             $draft = $this->pageRepo->updateDraftPage($page, $request->only(['name', 'html', 'markdown']));
 218         } else {
 219             $draft = $this->pageRepo->saveUpdateDraft($page, $request->only(['name', 'html', 'markdown']));
 220         }
 221
 222         $updateTime = $draft->updated_at->timestamp;
 223         $utcUpdateTimestamp = $updateTime + Carbon::createFromTimestamp(0)->offset;
 224         return response()->json([
 225             'status'    => 'success',
 226             'message'   => 'Draft saved at ',
 227             'timestamp' => $utcUpdateTimestamp
 228         ]);
 229     }
 230
 231     /**
 232      * Redirect from a special link url which
 233      * uses the page id rather than the name.
 234      * @param $pageId
 235      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 236      */
 237     public function redirectFromLink($pageId)
 238     {
 239         $page = $this->pageRepo->getById($pageId);
 240         return redirect($page->getUrl());
 241     }
 242
 243     /**
 244      * Show the deletion page for the specified page.
 245      * @param $bookSlug
 246      * @param $pageSlug
 247      * @return \Illuminate\View\View
 248      */
 249     public function showDelete($bookSlug, $pageSlug)
 250     {
 251         $book = $this->bookRepo->getBySlug($bookSlug);
 252         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 253         $this->checkOwnablePermission('page-delete', $page);
 254         $this->setPageTitle('Delete Page ' . $page->getShortName());
 255         return view('pages/delete', ['book' => $book, 'page' => $page, 'current' => $page]);
 256     }
 257
 258
 259     /**
 260      * Show the deletion page for the specified page.
 261      * @param $bookSlug
 262      * @param $pageId
 263      * @return \Illuminate\View\View
 264      * @throws NotFoundException
 265      */
 266     public function showDeleteDraft($bookSlug, $pageId)
 267     {
 268         $book = $this->bookRepo->getBySlug($bookSlug);
 269         $page = $this->pageRepo->getById($pageId, true);
 270         $this->checkOwnablePermission('page-update', $page);
 271         $this->setPageTitle('Delete Draft Page ' . $page->getShortName());
 272         return view('pages/delete', ['book' => $book, 'page' => $page, 'current' => $page]);
 273     }
 274
 275     /**
 276      * Remove the specified page from storage.
 277      * @param $bookSlug
 278      * @param $pageSlug
 279      * @return Response
 280      * @internal param int $id
 281      */
 282     public function destroy($bookSlug, $pageSlug)
 283     {
 284         $book = $this->bookRepo->getBySlug($bookSlug);
 285         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 286         $this->checkOwnablePermission('page-delete', $page);
 287         Activity::addMessage('page_delete', $book->id, $page->name);
 288         session()->flash('success', 'Page deleted');
 289         $this->pageRepo->destroy($page);
 290         return redirect($book->getUrl());
 291     }
 292
 293     /**
 294      * Remove the specified draft page from storage.
 295      * @param $bookSlug
 296      * @param $pageId
 297      * @return Response
 298      * @throws NotFoundException
 299      */
 300     public function destroyDraft($bookSlug, $pageId)
 301     {
 302         $book = $this->bookRepo->getBySlug($bookSlug);
 303         $page = $this->pageRepo->getById($pageId, true);
 304         $this->checkOwnablePermission('page-update', $page);
 305         session()->flash('success', 'Draft deleted');
 306         $this->pageRepo->destroy($page);
 307         return redirect($book->getUrl());
 308     }
 309
 310     /**
 311      * Shows the last revisions for this page.
 312      * @param $bookSlug
 313      * @param $pageSlug
 314      * @return \Illuminate\View\View
 315      */
 316     public function showRevisions($bookSlug, $pageSlug)
 317     {
 318         $book = $this->bookRepo->getBySlug($bookSlug);
 319         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 320         $this->setPageTitle('Revisions For ' . $page->getShortName());
 321         return view('pages/revisions', ['page' => $page, 'book' => $book, 'current' => $page]);
 322     }
 323
 324     /**
 325      * Shows a preview of a single revision
 326      * @param $bookSlug
 327      * @param $pageSlug
 328      * @param $revisionId
 329      * @return \Illuminate\View\View
 330      */
 331     public function showRevision($bookSlug, $pageSlug, $revisionId)
 332     {
 333         $book = $this->bookRepo->getBySlug($bookSlug);
 334         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 335         $revision = $this->pageRepo->getRevisionById($revisionId);
 336
 337         $next     = $revision->getNext() ?: $page;
 338         $htmlDiff = new HtmlDiff($revision->html, $next->html, true);
 339         $diff     = $htmlDiff->outputDiff()->toString();
 340
 341         $page->fill($revision->toArray());
 342         $this->setPageTitle('Page Revision For ' . $page->getShortName());
 343
 344         return view('pages/revision', [
 345             'page' => $page,
 346             'book' => $book,
 347             'diff' => $diff,
 348         ]);
 349     }
 350
 351     /**
 352      * Restores a page using the content of the specified revision.
 353      * @param $bookSlug
 354      * @param $pageSlug
 355      * @param $revisionId
 356      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 357      */
 358     public function restoreRevision($bookSlug, $pageSlug, $revisionId)
 359     {
 360         $book = $this->bookRepo->getBySlug($bookSlug);
 361         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 362         $this->checkOwnablePermission('page-update', $page);
 363         $page = $this->pageRepo->restoreRevision($page, $book, $revisionId);
 364         Activity::add($page, 'page_restore', $book->id);
 365         return redirect($page->getUrl());
 366     }
 367
 368     /**
 369      * Exports a page to pdf format using barryvdh/laravel-dompdf wrapper.
 370      * https://github.com/barryvdh/laravel-dompdf
 371      * @param $bookSlug
 372      * @param $pageSlug
 373      * @return \Illuminate\Http\Response
 374      */
 375     public function exportPdf($bookSlug, $pageSlug)
 376     {
 377         $book = $this->bookRepo->getBySlug($bookSlug);
 378         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 379         $pdfContent = $this->exportService->pageToPdf($page);
 380         return response()->make($pdfContent, 200, [
 381             'Content-Type'        => 'application/octet-stream',
 382             'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.pdf'
 383         ]);
 384     }
 385
 386     /**
 387      * Export a page to a self-contained HTML file.
 388      * @param $bookSlug
 389      * @param $pageSlug
 390      * @return \Illuminate\Http\Response
 391      */
 392     public function exportHtml($bookSlug, $pageSlug)
 393     {
 394         $book = $this->bookRepo->getBySlug($bookSlug);
 395         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 396         $containedHtml = $this->exportService->pageToContainedHtml($page);
 397         return response()->make($containedHtml, 200, [
 398             'Content-Type'        => 'application/octet-stream',
 399             'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.html'
 400         ]);
 401     }
 402
 403     /**
 404      * Export a page to a simple plaintext .txt file.
 405      * @param $bookSlug
 406      * @param $pageSlug
 407      * @return \Illuminate\Http\Response
 408      */
 409     public function exportPlainText($bookSlug, $pageSlug)
 410     {
 411         $book = $this->bookRepo->getBySlug($bookSlug);
 412         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 413         $containedHtml = $this->exportService->pageToPlainText($page);
 414         return response()->make($containedHtml, 200, [
 415             'Content-Type'        => 'application/octet-stream',
 416             'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.txt'
 417         ]);
 418     }
 419
 420     /**
 421      * Show a listing of recently created pages
 422      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
 423      */
 424     public function showRecentlyCreated()
 425     {
 426         $pages = $this->pageRepo->getRecentlyCreatedPaginated(20);
 427         return view('pages/detailed-listing', [
 428             'title' => 'Recently Created Pages',
 429             'pages' => $pages
 430         ]);
 431     }
 432
 433     /**
 434      * Show a listing of recently created pages
 435      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
 436      */
 437     public function showRecentlyUpdated()
 438     {
 439         $pages = $this->pageRepo->getRecentlyUpdatedPaginated(20);
 440         return view('pages/detailed-listing', [
 441             'title' => 'Recently Updated Pages',
 442             'pages' => $pages
 443         ]);
 444     }
 445
 446     /**
 447      * Show the Restrictions view.
 448      * @param $bookSlug
 449      * @param $pageSlug
 450      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
 451      */
 452     public function showRestrict($bookSlug, $pageSlug)
 453     {
 454         $book = $this->bookRepo->getBySlug($bookSlug);
 455         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 456         $this->checkOwnablePermission('restrictions-manage', $page);
 457         $roles = $this->userRepo->getRestrictableRoles();
 458         return view('pages/restrictions', [
 459             'page'  => $page,
 460             'roles' => $roles
 461         ]);
 462     }
 463
 464     /**
 465      * Show the view to choose a new parent to move a page into.
 466      * @param $bookSlug
 467      * @param $pageSlug
 468      * @return mixed
 469      * @throws NotFoundException
 470      */
 471     public function showMove($bookSlug, $pageSlug)
 472     {
 473         $book = $this->bookRepo->getBySlug($bookSlug);
 474         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 475         $this->checkOwnablePermission('page-update', $page);
 476         return view('pages/move', [
 477             'book' => $book,
 478             'page' => $page
 479         ]);
 480     }
 481
 482     /**
 483      * Does the action of moving the location of a page
 484      * @param $bookSlug
 485      * @param $pageSlug
 486      * @param Request $request
 487      * @return mixed
 488      * @throws NotFoundException
 489      */
 490     public function move($bookSlug, $pageSlug, Request $request)
 491     {
 492         $book = $this->bookRepo->getBySlug($bookSlug);
 493         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 494         $this->checkOwnablePermission('page-update', $page);
 495
 496         $entitySelection = $request->get('entity_selection', null);
 497         if ($entitySelection === null || $entitySelection === '') {
 498             return redirect($page->getUrl());
 499         }
 500
 501         $stringExploded = explode(':', $entitySelection);
 502         $entityType = $stringExploded[0];
 503         $entityId = intval($stringExploded[1]);
 504
 505         $parent = false;
 506
 507         if ($entityType == 'chapter') {
 508             $parent = $this->chapterRepo->getById($entityId);
 509         } else if ($entityType == 'book') {
 510             $parent = $this->bookRepo->getById($entityId);
 511         }
 512
 513         if ($parent === false || $parent === null) {
 514             session()->flash('The selected Book or Chapter was not found');
 515             return redirect()->back();
 516         }
 517
 518         $this->pageRepo->changePageParent($page, $parent);
 519         Activity::add($page, 'page_move', $page->book->id);
 520         session()->flash('success', sprintf('Page moved to "%s"', $parent->name));
 521
 522         return redirect($page->getUrl());
 523     }
 524
 525     /**
 526      * Set the permissions for this page.
 527      * @param $bookSlug
 528      * @param $pageSlug
 529      * @param Request $request
 530      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 531      */
 532     public function restrict($bookSlug, $pageSlug, Request $request)
 533     {
 534         $book = $this->bookRepo->getBySlug($bookSlug);
 535         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
 536         $this->checkOwnablePermission('restrictions-manage', $page);
 537         $this->pageRepo->updateEntityPermissionsFromRequest($request, $page);
 538         session()->flash('success', 'Page Permissions Updated');
 539         return redirect($page->getUrl());
 540     }
 541
 542 }