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