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