X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/444a23a419539b9236a3cf04cf5c76c2d216c49e..refs/pull/1695/head:/app/Http/Controllers/PageController.php

diff --git a/app/Http/Controllers/PageController.php b/app/Http/Controllers/PageController.php
index ad1e32665..736fcf4f6 100644
--- a/app/Http/Controllers/PageController.php
+++ b/app/Http/Controllers/PageController.php
@@ -2,32 +2,34 @@
 
 use Activity;
 use BookStack\Auth\UserRepo;
-use BookStack\Entities\Repos\EntityRepo;
-use BookStack\Entities\ExportService;
 use BookStack\Entities\Repos\PageRepo;
 use BookStack\Exceptions\NotFoundException;
+use Exception;
 use GatherContent\Htmldiff\Htmldiff;
+use Illuminate\Contracts\View\Factory;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
+use Illuminate\Routing\Redirector;
+use Illuminate\View\View;
+use Throwable;
 use Views;
 
 class PageController extends Controller
 {
 
     protected $pageRepo;
-    protected $exportService;
     protected $userRepo;
 
     /**
      * PageController constructor.
-     * @param \BookStack\Entities\Repos\PageRepo $pageRepo
-     * @param \BookStack\Entities\ExportService $exportService
+     * @param PageRepo $pageRepo
      * @param UserRepo $userRepo
      */
-    public function __construct(PageRepo $pageRepo, ExportService $exportService, UserRepo $userRepo)
+    public function __construct(PageRepo $pageRepo, UserRepo $userRepo)
     {
         $this->pageRepo = $pageRepo;
-        $this->exportService = $exportService;
         $this->userRepo = $userRepo;
         parent::__construct();
     }
@@ -43,18 +45,18 @@ class PageController extends Controller
     public function create($bookSlug, $chapterSlug = null)
     {
         if ($chapterSlug !== null) {
-            $chapter = $this->pageRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+            $chapter = $this->pageRepo->getEntityBySlug('chapter', $chapterSlug, $bookSlug);
             $book = $chapter->book;
         } else {
             $chapter = null;
-            $book = $this->pageRepo->getBySlug('book', $bookSlug);
+            $book = $this->pageRepo->getEntityBySlug('book', $bookSlug);
         }
 
         $parent = $chapter ? $chapter : $book;
         $this->checkOwnablePermission('page-create', $parent);
 
         // Redirect to draft edit screen if signed in
-        if ($this->signedIn) {
+        if ($this->isSignedIn()) {
             $draft = $this->pageRepo->getDraftPage($book, $chapter);
             return redirect($draft->getUrl());
         }
@@ -79,11 +81,11 @@ class PageController extends Controller
         ]);
 
         if ($chapterSlug !== null) {
-            $chapter = $this->pageRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+            $chapter = $this->pageRepo->getEntityBySlug('chapter', $chapterSlug, $bookSlug);
             $book = $chapter->book;
         } else {
             $chapter = null;
-            $book = $this->pageRepo->getBySlug('book', $bookSlug);
+            $book = $this->pageRepo->getEntityBySlug('book', $bookSlug);
         }
 
         $parent = $chapter ? $chapter : $book;
@@ -101,7 +103,7 @@ class PageController extends Controller
      * Show form to continue editing a draft page.
      * @param string $bookSlug
      * @param int $pageId
-     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+     * @return Factory|View
      */
     public function editDraft($bookSlug, $pageId)
     {
@@ -109,7 +111,7 @@ class PageController extends Controller
         $this->checkOwnablePermission('page-create', $draft->parent);
         $this->setPageTitle(trans('entities.pages_edit_draft'));
 
-        $draftsEnabled = $this->signedIn;
+        $draftsEnabled = $this->isSignedIn();
         $templates = $this->pageRepo->getPageTemplates(10);
 
         return view('pages.edit', [
@@ -164,7 +166,7 @@ class PageController extends Controller
     public function show($bookSlug, $pageSlug)
     {
         try {
-            $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+            $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         } catch (NotFoundException $e) {
             $page = $this->pageRepo->getPageByOldSlug($pageSlug, $bookSlug);
             if ($page === null) {
@@ -199,7 +201,7 @@ class PageController extends Controller
     /**
      * Get page from an ajax request.
      * @param int $pageId
-     * @return \Illuminate\Http\JsonResponse
+     * @return JsonResponse
      */
     public function getPageAjax($pageId)
     {
@@ -216,7 +218,7 @@ class PageController extends Controller
      */
     public function edit($bookSlug, $pageSlug)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('page-update', $page);
         $this->setPageTitle(trans('entities.pages_editing_named', ['pageName'=>$page->getShortName()]));
         $page->isDraft = false;
@@ -228,7 +230,7 @@ class PageController extends Controller
         }
 
         // Check for a current draft version for this user
-        $userPageDraft = $this->pageRepo->getUserPageDraft($page, $this->currentUser->id);
+        $userPageDraft = $this->pageRepo->getUserPageDraft($page, user()->id);
         if ($userPageDraft !== null) {
             $page->name = $userPageDraft->name;
             $page->html = $userPageDraft->html;
@@ -238,10 +240,10 @@ class PageController extends Controller
         }
 
         if (count($warnings) > 0) {
-            session()->flash('warning', implode("\n", $warnings));
+            $this->showWarningNotification( implode("\n", $warnings));
         }
 
-        $draftsEnabled = $this->signedIn;
+        $draftsEnabled = $this->isSignedIn();
         $templates = $this->pageRepo->getPageTemplates(10);
 
         return view('pages.edit', [
@@ -265,7 +267,7 @@ class PageController extends Controller
         $this->validate($request, [
             'name' => 'required|string|max:255'
         ]);
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('page-update', $page);
         $this->pageRepo->updatePage($page, $page->book->id, $request->all());
         Activity::add($page, 'page_update', $page->book->id);
@@ -276,14 +278,14 @@ class PageController extends Controller
      * Save a draft update as a revision.
      * @param Request $request
      * @param int $pageId
-     * @return \Illuminate\Http\JsonResponse
+     * @return JsonResponse
      */
     public function saveDraft(Request $request, $pageId)
     {
         $page = $this->pageRepo->getById('page', $pageId, true);
         $this->checkOwnablePermission('page-update', $page);
 
-        if (!$this->signedIn) {
+        if (!$this->isSignedIn()) {
             return response()->json([
                 'status' => 'error',
                 'message' => trans('errors.guests_cannot_save_drafts'),
@@ -304,7 +306,7 @@ class PageController extends Controller
      * Redirect from a special link url which
      * uses the page id rather than the name.
      * @param int $pageId
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+     * @return RedirectResponse|Redirector
      */
     public function redirectFromLink($pageId)
     {
@@ -316,11 +318,11 @@ class PageController extends Controller
      * Show the deletion page for the specified page.
      * @param string $bookSlug
      * @param string $pageSlug
-     * @return \Illuminate\View\View
+     * @return View
      */
     public function showDelete($bookSlug, $pageSlug)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('page-delete', $page);
         $this->setPageTitle(trans('entities.pages_delete_named', ['pageName'=>$page->getShortName()]));
         return view('pages.delete', ['book' => $page->book, 'page' => $page, 'current' => $page]);
@@ -331,7 +333,7 @@ class PageController extends Controller
      * Show the deletion page for the specified page.
      * @param string $bookSlug
      * @param int $pageId
-     * @return \Illuminate\View\View
+     * @return View
      * @throws NotFoundException
      */
     public function showDeleteDraft($bookSlug, $pageId)
@@ -351,13 +353,13 @@ class PageController extends Controller
      */
     public function destroy($bookSlug, $pageSlug)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $book = $page->book;
         $this->checkOwnablePermission('page-delete', $page);
         $this->pageRepo->destroyPage($page);
 
-        Activity::addMessage('page_delete', $book->id, $page->name);
-        session()->flash('success', trans('entities.pages_delete_success'));
+        Activity::addMessage('page_delete', $page->name, $book->id);
+        $this->showSuccessNotification( trans('entities.pages_delete_success'));
         return redirect($book->getUrl());
     }
 
@@ -373,7 +375,7 @@ class PageController extends Controller
         $page = $this->pageRepo->getById('page', $pageId, true);
         $book = $page->book;
         $this->checkOwnablePermission('page-update', $page);
-        session()->flash('success', trans('entities.pages_delete_draft_success'));
+        $this->showSuccessNotification( trans('entities.pages_delete_draft_success'));
         $this->pageRepo->destroyPage($page);
         return redirect($book->getUrl());
     }
@@ -382,12 +384,12 @@ class PageController extends Controller
      * Shows the last revisions for this page.
      * @param string $bookSlug
      * @param string $pageSlug
-     * @return \Illuminate\View\View
+     * @return View
      * @throws NotFoundException
      */
     public function showRevisions($bookSlug, $pageSlug)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->setPageTitle(trans('entities.pages_revisions_named', ['pageName'=>$page->getShortName()]));
         return view('pages.revisions', ['page' => $page, 'current' => $page]);
     }
@@ -397,11 +399,11 @@ class PageController extends Controller
      * @param string $bookSlug
      * @param string $pageSlug
      * @param int $revisionId
-     * @return \Illuminate\View\View
+     * @return View
      */
     public function showRevision($bookSlug, $pageSlug, $revisionId)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $revision = $page->revisions()->where('id', '=', $revisionId)->first();
         if ($revision === null) {
             abort(404);
@@ -423,11 +425,11 @@ class PageController extends Controller
      * @param string $bookSlug
      * @param string $pageSlug
      * @param int $revisionId
-     * @return \Illuminate\View\View
+     * @return View
      */
     public function showRevisionChanges($bookSlug, $pageSlug, $revisionId)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $revision = $page->revisions()->where('id', '=', $revisionId)->first();
         if ($revision === null) {
             abort(404);
@@ -453,11 +455,11 @@ class PageController extends Controller
      * @param string $bookSlug
      * @param string $pageSlug
      * @param int $revisionId
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+     * @return RedirectResponse|Redirector
      */
     public function restoreRevision($bookSlug, $pageSlug, $revisionId)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('page-update', $page);
         $page = $this->pageRepo->restorePageRevision($page, $page->book, $revisionId);
         Activity::add($page, 'page_restore', $page->book->id);
@@ -470,13 +472,13 @@ class PageController extends Controller
      * @param string $bookSlug
      * @param string $pageSlug
      * @param int $revId
+     * @return RedirectResponse|Redirector
+     *@throws BadRequestException
      * @throws NotFoundException
-     * @throws BadRequestException
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
      */
     public function destroyRevision($bookSlug, $pageSlug, $revId)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('page-delete', $page);
 
         $revision = $page->revisions()->where('id', '=', $revId)->first();
@@ -489,60 +491,18 @@ class PageController extends Controller
 
         // Check if its the latest revision, cannot delete latest revision.
         if (intval($currentRevision->id) === intval($revId)) {
-            session()->flash('error', trans('entities.revision_cannot_delete_latest'));
+            $this->showErrorNotification( trans('entities.revision_cannot_delete_latest'));
             return response()->view('pages.revisions', ['page' => $page, 'book' => $page->book, 'current' => $page], 400);
         }
 
         $revision->delete();
-        session()->flash('success', trans('entities.revision_delete_success'));
+        $this->showSuccessNotification( trans('entities.revision_delete_success'));
         return redirect($page->getUrl('/revisions'));
     }
 
-    /**
-     * Exports a page to a PDF.
-     * https://github.com/barryvdh/laravel-dompdf
-     * @param string $bookSlug
-     * @param string $pageSlug
-     * @return \Illuminate\Http\Response
-     */
-    public function exportPdf($bookSlug, $pageSlug)
-    {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
-        $page->html = $this->pageRepo->renderPage($page);
-        $pdfContent = $this->exportService->pageToPdf($page);
-        return $this->downloadResponse($pdfContent, $pageSlug . '.pdf');
-    }
-
-    /**
-     * Export a page to a self-contained HTML file.
-     * @param string $bookSlug
-     * @param string $pageSlug
-     * @return \Illuminate\Http\Response
-     */
-    public function exportHtml($bookSlug, $pageSlug)
-    {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
-        $page->html = $this->pageRepo->renderPage($page);
-        $containedHtml = $this->exportService->pageToContainedHtml($page);
-        return $this->downloadResponse($containedHtml, $pageSlug . '.html');
-    }
-
-    /**
-     * Export a page to a simple plaintext .txt file.
-     * @param string $bookSlug
-     * @param string $pageSlug
-     * @return \Illuminate\Http\Response
-     */
-    public function exportPlainText($bookSlug, $pageSlug)
-    {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
-        $pageText = $this->exportService->pageToPlainText($page);
-        return $this->downloadResponse($pageText, $pageSlug . '.txt');
-    }
-
     /**
      * Show a listing of recently created pages
-     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+     * @return Factory|View
      */
     public function showRecentlyUpdated()
     {
@@ -563,7 +523,7 @@ class PageController extends Controller
      */
     public function showMove($bookSlug, $pageSlug)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('page-update', $page);
         $this->checkOwnablePermission('page-delete', $page);
         return view('pages.move', [
@@ -574,15 +534,16 @@ class PageController extends Controller
 
     /**
      * Does the action of moving the location of a page
+     * @param Request $request
      * @param string $bookSlug
      * @param string $pageSlug
-     * @param Request $request
      * @return mixed
      * @throws NotFoundException
+     * @throws Throwable
      */
-    public function move($bookSlug, $pageSlug, Request $request)
+    public function move(Request $request, string $bookSlug, string $pageSlug)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('page-update', $page);
         $this->checkOwnablePermission('page-delete', $page);
 
@@ -598,7 +559,7 @@ class PageController extends Controller
 
         try {
             $parent = $this->pageRepo->getById($entityType, $entityId);
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             session()->flash(trans('entities.selected_book_chapter_not_found'));
             return redirect()->back();
         }
@@ -607,7 +568,7 @@ class PageController extends Controller
 
         $this->pageRepo->changePageParent($page, $parent);
         Activity::add($page, 'page_move', $page->book->id);
-        session()->flash('success', trans('entities.pages_move_success', ['parentName' => $parent->name]));
+        $this->showSuccessNotification( trans('entities.pages_move_success', ['parentName' => $parent->name]));
 
         return redirect($page->getUrl());
     }
@@ -621,7 +582,7 @@ class PageController extends Controller
      */
     public function showCopy($bookSlug, $pageSlug)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('page-view', $page);
         session()->flashInput(['name' => $page->name]);
         return view('pages.copy', [
@@ -632,15 +593,16 @@ class PageController extends Controller
 
     /**
      * Create a copy of a page within the requested target destination.
+     * @param Request $request
      * @param string $bookSlug
      * @param string $pageSlug
-     * @param Request $request
      * @return mixed
      * @throws NotFoundException
+     * @throws Throwable
      */
-    public function copy($bookSlug, $pageSlug, Request $request)
+    public function copy(Request $request, string $bookSlug, string $pageSlug)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('page-view', $page);
 
         $entitySelection = $request->get('entity_selection', null);
@@ -653,8 +615,8 @@ class PageController extends Controller
 
             try {
                 $parent = $this->pageRepo->getById($entityType, $entityId);
-            } catch (\Exception $e) {
-                session()->flash(trans('entities.selected_book_chapter_not_found'));
+            } catch (Exception $e) {
+                $this->showErrorNotification(trans('entities.selected_book_chapter_not_found'));
                 return redirect()->back();
             }
         }
@@ -664,7 +626,7 @@ class PageController extends Controller
         $pageCopy = $this->pageRepo->copyPage($page, $parent, $request->get('name', ''));
 
         Activity::add($pageCopy, 'page_create', $pageCopy->book->id);
-        session()->flash('success', trans('entities.pages_copy_success'));
+        $this->showSuccessNotification( trans('entities.pages_copy_success'));
 
         return redirect($pageCopy->getUrl());
     }
@@ -673,12 +635,12 @@ class PageController extends Controller
      * Show the Permissions view.
      * @param string $bookSlug
      * @param string $pageSlug
-     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+     * @return Factory|View
      * @throws NotFoundException
      */
     public function showPermissions($bookSlug, $pageSlug)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('restrictions-manage', $page);
         $roles = $this->userRepo->getRestrictableRoles();
         return view('pages.permissions', [
@@ -692,16 +654,16 @@ class PageController extends Controller
      * @param string $bookSlug
      * @param string $pageSlug
      * @param Request $request
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+     * @return RedirectResponse|Redirector
      * @throws NotFoundException
-     * @throws \Throwable
+     * @throws Throwable
      */
-    public function permissions($bookSlug, $pageSlug, Request $request)
+    public function permissions(Request $request, string $bookSlug, string $pageSlug)
     {
-        $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $bookSlug);
         $this->checkOwnablePermission('restrictions-manage', $page);
         $this->pageRepo->updateEntityPermissionsFromRequest($request, $page);
-        session()->flash('success', trans('entities.pages_permissions_success'));
+        $this->showSuccessNotification( trans('entities.pages_permissions_success'));
         return redirect($page->getUrl());
     }
 }