Added basic system tests for markdown editor, Added extra test helpers

[bookstack] / app / Http / Controllers / PageController.php

diff --git a/app/Http/Controllers/PageController.php b/app/Http/Controllers/PageController.php
index 2dbdb81e787c7889e0d04008929d9d81caebf643..c3d8e396c388cd45fab39082475202c2b7a87052 100644 (file)
--- a/app/Http/Controllers/PageController.php
+++ b/app/Http/Controllers/PageController.php
@@ -1,16 +1,15 @@
-<?php
-
-namespace BookStack\Http\Controllers;
+<?php namespace BookStack\Http\Controllers;

 
 use Activity;
 
 use Activity;

+use BookStack\Exceptions\NotFoundException;
+use BookStack\Repos\UserRepo;

 use BookStack\Services\ExportService;
 use Illuminate\Http\Request;
 use BookStack\Services\ExportService;
 use Illuminate\Http\Request;

-
-use Illuminate\Support\Facades\Auth;

 use BookStack\Http\Requests;
 use BookStack\Repos\BookRepo;
 use BookStack\Repos\ChapterRepo;
 use BookStack\Repos\PageRepo;
 use BookStack\Http\Requests;
 use BookStack\Repos\BookRepo;
 use BookStack\Repos\ChapterRepo;
 use BookStack\Repos\PageRepo;

+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

 use Views;
 
 class PageController extends Controller
 use Views;
 
 class PageController extends Controller


@@ -20,26 +19,28 @@ class PageController extends Controller
     protected $bookRepo;
     protected $chapterRepo;
     protected $exportService;
     protected $bookRepo;
     protected $chapterRepo;
     protected $exportService;

+    protected $userRepo;

 
     /**
      * PageController constructor.
 
     /**
      * PageController constructor.

-     * @param PageRepo      $pageRepo
-     * @param BookRepo      $bookRepo
-     * @param ChapterRepo   $chapterRepo
+     * @param PageRepo $pageRepo
+     * @param BookRepo $bookRepo
+     * @param ChapterRepo $chapterRepo

      * @param ExportService $exportService
      * @param ExportService $exportService

+     * @param UserRepo $userRepo

      */
      */

-    public function __construct(PageRepo $pageRepo, BookRepo $bookRepo, ChapterRepo $chapterRepo, ExportService $exportService)
+    public function __construct(PageRepo $pageRepo, BookRepo $bookRepo, ChapterRepo $chapterRepo, ExportService $exportService, UserRepo $userRepo)

     {
         $this->pageRepo = $pageRepo;
         $this->bookRepo = $bookRepo;
         $this->chapterRepo = $chapterRepo;
         $this->exportService = $exportService;
     {
         $this->pageRepo = $pageRepo;
         $this->bookRepo = $bookRepo;
         $this->chapterRepo = $chapterRepo;
         $this->exportService = $exportService;

+        $this->userRepo = $userRepo;

         parent::__construct();
     }
 
     /**
      * Show the form for creating a new page.
         parent::__construct();
     }
 
     /**
      * Show the form for creating a new page.

-     *

      * @param      $bookSlug
      * @param bool $chapterSlug
      * @return Response
      * @param      $bookSlug
      * @param bool $chapterSlug
      * @return Response


@@ -47,33 +48,55 @@ class PageController extends Controller
      */
     public function create($bookSlug, $chapterSlug = false)
     {
      */
     public function create($bookSlug, $chapterSlug = false)
     {

-        $this->checkPermission('page-create');

         $book = $this->bookRepo->getBySlug($bookSlug);
         $book = $this->bookRepo->getBySlug($bookSlug);

-        $chapter = $chapterSlug ? $this->chapterRepo->getBySlug($chapterSlug, $book->id) : false;
+        $chapter = $chapterSlug ? $this->chapterRepo->getBySlug($chapterSlug, $book->id) : null;
+        $parent = $chapter ? $chapter : $book;
+        $this->checkOwnablePermission('page-create', $parent);

         $this->setPageTitle('Create New Page');
         $this->setPageTitle('Create New Page');

-        return view('pages/create', ['book' => $book, 'chapter' => $chapter]);
+
+        $draft = $this->pageRepo->getDraftPage($book, $chapter);
+        return redirect($draft->getUrl());

     }
 
     /**
     }
 
     /**

-     * Store a newly created page in storage.
-     *
+     * Show form to continue editing a draft page.
+     * @param $bookSlug
+     * @param $pageId
+     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+     */
+    public function editDraft($bookSlug, $pageId)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $draft = $this->pageRepo->getById($pageId, true);
+        $this->checkOwnablePermission('page-create', $draft);
+        $this->setPageTitle('Edit Page Draft');
+
+        return view('pages/create', ['draft' => $draft, 'book' => $book]);
+    }
+
+    /**
+     * Store a new page by changing a draft into a page.

      * @param  Request $request
      * @param  Request $request

-     * @param          $bookSlug
+     * @param  string $bookSlug

      * @return Response
      */
      * @return Response
      */

-    public function store(Request $request, $bookSlug)
+    public function store(Request $request, $bookSlug, $pageId)

     {
     {

-        $this->checkPermission('page-create');

         $this->validate($request, [
         $this->validate($request, [

-            'name'   => 'required|string|max:255'
+            'name' => 'required|string|max:255'

         ]);
 
         $input = $request->all();
         $book = $this->bookRepo->getBySlug($bookSlug);
         ]);
 
         $input = $request->all();
         $book = $this->bookRepo->getBySlug($bookSlug);

-        $chapterId = ($request->has('chapter') && $this->chapterRepo->idExists($request->get('chapter'))) ? $request->get('chapter') : null;

         $input['priority'] = $this->bookRepo->getNewPriority($book);
 
         $input['priority'] = $this->bookRepo->getNewPriority($book);
 

-        $page = $this->pageRepo->saveNew($input, $book, $chapterId);
+        $draftPage = $this->pageRepo->getById($pageId, true);
+
+        $chapterId = $draftPage->chapter_id;
+        $parent = $chapterId !== 0 ? $this->chapterRepo->getById($chapterId) : $book;
+        $this->checkOwnablePermission('page-create', $parent);
+
+        $page = $this->pageRepo->publishDraft($draftPage, $input);

 
         Activity::add($page, 'page_create', $book->id);
         return redirect($page->getUrl());
 
         Activity::add($page, 'page_create', $book->id);
         return redirect($page->getUrl());


@@ -81,7 +104,8 @@ class PageController extends Controller
 
     /**
      * Display the specified page.
 
     /**
      * Display the specified page.

-     *
+     * If the page is not found via the slug the
+     * revisions are searched for a match.

      * @param $bookSlug
      * @param $pageSlug
      * @return Response
      * @param $bookSlug
      * @param $pageSlug
      * @return Response


@@ -89,32 +113,69 @@ class PageController extends Controller
     public function show($bookSlug, $pageSlug)
     {
         $book = $this->bookRepo->getBySlug($bookSlug);
     public function show($bookSlug, $pageSlug)
     {
         $book = $this->bookRepo->getBySlug($bookSlug);

-        $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
+
+        try {
+            $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
+        } catch (NotFoundException $e) {
+            $page = $this->pageRepo->findPageUsingOldSlug($pageSlug, $bookSlug);
+            if ($page === null) abort(404);
+            return redirect($page->getUrl());
+        }
+

         $sidebarTree = $this->bookRepo->getChildren($book);
         Views::add($page);
         $this->setPageTitle($page->getShortName());
         return view('pages/show', ['page' => $page, 'book' => $book, 'current' => $page, 'sidebarTree' => $sidebarTree]);
     }
 
         $sidebarTree = $this->bookRepo->getChildren($book);
         Views::add($page);
         $this->setPageTitle($page->getShortName());
         return view('pages/show', ['page' => $page, 'book' => $book, 'current' => $page, 'sidebarTree' => $sidebarTree]);
     }
 

+    /**
+     * Get page from an ajax request.
+     * @param $pageId
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function getPageAjax($pageId)
+    {
+        $page = $this->pageRepo->getById($pageId);
+        return response()->json($page);
+    }
+

     /**
      * Show the form for editing the specified page.
     /**
      * Show the form for editing the specified page.

-     *

      * @param $bookSlug
      * @param $pageSlug
      * @return Response
      */
     public function edit($bookSlug, $pageSlug)
     {
      * @param $bookSlug
      * @param $pageSlug
      * @return Response
      */
     public function edit($bookSlug, $pageSlug)
     {

-        $this->checkPermission('page-update');

         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);

+        $this->checkOwnablePermission('page-update', $page);

         $this->setPageTitle('Editing Page ' . $page->getShortName());
         $this->setPageTitle('Editing Page ' . $page->getShortName());

+        $page->isDraft = false;
+
+        // Check for active editing
+        $warnings = [];
+        if ($this->pageRepo->isPageEditingActive($page, 60)) {
+            $warnings[] = $this->pageRepo->getPageEditingActiveMessage($page, 60);
+        }
+
+        // Check for a current draft version for this user
+        if ($this->pageRepo->hasUserGotPageDraft($page, $this->currentUser->id)) {
+            $draft = $this->pageRepo->getUserPageDraft($page, $this->currentUser->id);
+            $page->name = $draft->name;
+            $page->html = $draft->html;
+            $page->markdown = $draft->markdown;
+            $page->isDraft = true;
+            $warnings [] = $this->pageRepo->getUserPageDraftMessage($draft);
+        }
+
+        if (count($warnings) > 0) session()->flash('warning', implode("\n", $warnings));
+

         return view('pages/edit', ['page' => $page, 'book' => $book, 'current' => $page]);
     }
 
     /**
      * Update the specified page in storage.
         return view('pages/edit', ['page' => $page, 'book' => $book, 'current' => $page]);
     }
 
     /**
      * Update the specified page in storage.

-     *

      * @param  Request $request
      * @param          $bookSlug
      * @param          $pageSlug
      * @param  Request $request
      * @param          $bookSlug
      * @param          $pageSlug


@@ -122,17 +183,36 @@ class PageController extends Controller
      */
     public function update(Request $request, $bookSlug, $pageSlug)
     {
      */
     public function update(Request $request, $bookSlug, $pageSlug)
     {

-        $this->checkPermission('page-update');

         $this->validate($request, [
         $this->validate($request, [

-            'name'   => 'required|string|max:255'
+            'name' => 'required|string|max:255'

         ]);
         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         ]);
         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);

+        $this->checkOwnablePermission('page-update', $page);

         $this->pageRepo->updatePage($page, $book->id, $request->all());
         Activity::add($page, 'page_update', $book->id);
         return redirect($page->getUrl());
     }
 
         $this->pageRepo->updatePage($page, $book->id, $request->all());
         Activity::add($page, 'page_update', $book->id);
         return redirect($page->getUrl());
     }
 

+    /**
+     * Save a draft update as a revision.
+     * @param Request $request
+     * @param $pageId
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function saveDraft(Request $request, $pageId)
+    {
+        $page = $this->pageRepo->getById($pageId, true);
+        $this->checkOwnablePermission('page-update', $page);
+        if ($page->draft) {
+            $draft = $this->pageRepo->updateDraftPage($page, $request->only(['name', 'html', 'markdown']));
+        } else {
+            $draft = $this->pageRepo->saveUpdateDraft($page, $request->only(['name', 'html', 'markdown']));
+        }
+        $updateTime = $draft->updated_at->format('H:i');
+        return response()->json(['status' => 'success', 'message' => 'Draft saved at ' . $updateTime]);
+    }
+

     /**
      * Redirect from a special link url which
      * uses the page id rather than the name.
     /**
      * Redirect from a special link url which
      * uses the page id rather than the name.


@@ -153,16 +233,32 @@ class PageController extends Controller
      */
     public function showDelete($bookSlug, $pageSlug)
     {
      */
     public function showDelete($bookSlug, $pageSlug)
     {

-        $this->checkPermission('page-delete');

         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);

+        $this->checkOwnablePermission('page-delete', $page);

         $this->setPageTitle('Delete Page ' . $page->getShortName());
         return view('pages/delete', ['book' => $book, 'page' => $page, 'current' => $page]);
     }
 
         $this->setPageTitle('Delete Page ' . $page->getShortName());
         return view('pages/delete', ['book' => $book, 'page' => $page, 'current' => $page]);
     }
 

+
+    /**
+     * Show the deletion page for the specified page.
+     * @param $bookSlug
+     * @param $pageId
+     * @return \Illuminate\View\View
+     * @throws NotFoundException
+     */
+    public function showDeleteDraft($bookSlug, $pageId)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $page = $this->pageRepo->getById($pageId, true);
+        $this->checkOwnablePermission('page-update', $page);
+        $this->setPageTitle('Delete Draft Page ' . $page->getShortName());
+        return view('pages/delete', ['book' => $book, 'page' => $page, 'current' => $page]);
+    }
+

     /**
      * Remove the specified page from storage.
     /**
      * Remove the specified page from storage.

-     *

      * @param $bookSlug
      * @param $pageSlug
      * @return Response
      * @param $bookSlug
      * @param $pageSlug
      * @return Response


@@ -170,10 +266,28 @@ class PageController extends Controller
      */
     public function destroy($bookSlug, $pageSlug)
     {
      */
     public function destroy($bookSlug, $pageSlug)
     {

-        $this->checkPermission('page-delete');

         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);

+        $this->checkOwnablePermission('page-delete', $page);

         Activity::addMessage('page_delete', $book->id, $page->name);
         Activity::addMessage('page_delete', $book->id, $page->name);

+        session()->flash('success', 'Page deleted');
+        $this->pageRepo->destroy($page);
+        return redirect($book->getUrl());
+    }
+
+    /**
+     * Remove the specified draft page from storage.
+     * @param $bookSlug
+     * @param $pageId
+     * @return Response
+     * @throws NotFoundException
+     */
+    public function destroyDraft($bookSlug, $pageId)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $page = $this->pageRepo->getById($pageId, true);
+        $this->checkOwnablePermission('page-update', $page);
+        session()->flash('success', 'Draft deleted');

         $this->pageRepo->destroy($page);
         return redirect($book->getUrl());
     }
         $this->pageRepo->destroy($page);
         return redirect($book->getUrl());
     }


@@ -218,9 +332,9 @@ class PageController extends Controller
      */
     public function restoreRevision($bookSlug, $pageSlug, $revisionId)
     {
      */
     public function restoreRevision($bookSlug, $pageSlug, $revisionId)
     {

-        $this->checkPermission('page-update');

         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);

+        $this->checkOwnablePermission('page-update', $page);

         $page = $this->pageRepo->restoreRevision($page, $book, $revisionId);
         Activity::add($page, 'page_restore', $book->id);
         return redirect($page->getUrl());
         $page = $this->pageRepo->restoreRevision($page, $book, $revisionId);
         Activity::add($page, 'page_restore', $book->id);
         return redirect($page->getUrl());


@@ -239,8 +353,8 @@ class PageController extends Controller
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $pdfContent = $this->exportService->pageToPdf($page);
         return response()->make($pdfContent, 200, [
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $pdfContent = $this->exportService->pageToPdf($page);
         return response()->make($pdfContent, 200, [

-            'Content-Type' => 'application/octet-stream',
-            'Content-Disposition' => 'attachment; filename="'.$pageSlug.'.pdf'
+            'Content-Type'        => 'application/octet-stream',
+            'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.pdf'

         ]);
     }
 
         ]);
     }
 


@@ -256,8 +370,8 @@ class PageController extends Controller
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $containedHtml = $this->exportService->pageToContainedHtml($page);
         return response()->make($containedHtml, 200, [
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $containedHtml = $this->exportService->pageToContainedHtml($page);
         return response()->make($containedHtml, 200, [

-            'Content-Type' => 'application/octet-stream',
-            'Content-Disposition' => 'attachment; filename="'.$pageSlug.'.html'
+            'Content-Type'        => 'application/octet-stream',
+            'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.html'

         ]);
     }
 
         ]);
     }
 


@@ -273,8 +387,8 @@ class PageController extends Controller
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $containedHtml = $this->exportService->pageToPlainText($page);
         return response()->make($containedHtml, 200, [
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $containedHtml = $this->exportService->pageToPlainText($page);
         return response()->make($containedHtml, 200, [

-            'Content-Type' => 'application/octet-stream',
-            'Content-Disposition' => 'attachment; filename="'.$pageSlug.'.txt'
+            'Content-Type'        => 'application/octet-stream',
+            'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.txt'

         ]);
     }
 
         ]);
     }
 


@@ -304,4 +418,39 @@ class PageController extends Controller
         ]);
     }
 
         ]);
     }
 

+    /**
+     * Show the Restrictions view.
+     * @param $bookSlug
+     * @param $pageSlug
+     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+     */
+    public function showRestrict($bookSlug, $pageSlug)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
+        $this->checkOwnablePermission('restrictions-manage', $page);
+        $roles = $this->userRepo->getRestrictableRoles();
+        return view('pages/restrictions', [
+            'page'  => $page,
+            'roles' => $roles
+        ]);
+    }
+
+    /**
+     * Set the restrictions for this page.
+     * @param $bookSlug
+     * @param $pageSlug
+     * @param Request $request
+     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+     */
+    public function restrict($bookSlug, $pageSlug, Request $request)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
+        $this->checkOwnablePermission('restrictions-manage', $page);
+        $this->pageRepo->updateRestrictionsFromRequest($request, $page);
+        session()->flash('success', 'Page Restrictions Updated');
+        return redirect($page->getUrl());
+    }
+

 }
 }