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 da56fb26bc569945d34ddc9f1b07e198bb83a732..c3d8e396c388cd45fab39082475202c2b7a87052 100644 (file)
--- a/app/Http/Controllers/PageController.php
+++ b/app/Http/Controllers/PageController.php
@@ -1,84 +1,111 @@
-<?php
-
-namespace Oxbow\Http\Controllers;
+<?php namespace BookStack\Http\Controllers;

 
 

+use Activity;
+use BookStack\Exceptions\NotFoundException;
+use BookStack\Repos\UserRepo;
+use BookStack\Services\ExportService;

 use Illuminate\Http\Request;
 use Illuminate\Http\Request;

-
-use Illuminate\Support\Str;
-use Oxbow\Http\Requests;
-use Oxbow\Repos\BookRepo;
-use Oxbow\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
 {
 
     protected $pageRepo;
     protected $bookRepo;
 
 class PageController extends Controller
 {
 
     protected $pageRepo;
     protected $bookRepo;

+    protected $chapterRepo;
+    protected $exportService;
+    protected $userRepo;

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

-     * @param $pageRepo
-     * @param $bookRepo
+     * @param PageRepo $pageRepo
+     * @param BookRepo $bookRepo
+     * @param ChapterRepo $chapterRepo
+     * @param ExportService $exportService
+     * @param UserRepo $userRepo

      */
      */

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

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

+        $this->chapterRepo = $chapterRepo;
+        $this->exportService = $exportService;
+        $this->userRepo = $userRepo;
+        parent::__construct();

     }
 
     }
 

-

     /**
     /**

-     * Display a listing of the resource.
-     *
+     * Show the form for creating a new page.
+     * @param      $bookSlug
+     * @param bool $chapterSlug

      * @return Response
      * @return Response

+     * @internal param bool $pageSlug

      */
      */

-    public function index()
+    public function create($bookSlug, $chapterSlug = false)

     {
     {

-        //
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $chapter = $chapterSlug ? $this->chapterRepo->getBySlug($chapterSlug, $book->id) : null;
+        $parent = $chapter ? $chapter : $book;
+        $this->checkOwnablePermission('page-create', $parent);
+        $this->setPageTitle('Create New Page');
+
+        $draft = $this->pageRepo->getDraftPage($book, $chapter);
+        return redirect($draft->getUrl());

     }
 
     /**
     }
 
     /**

-     * Show the form for creating a new resource.
-     *
+     * Show form to continue editing a draft page.

      * @param $bookSlug
      * @param $bookSlug

-     * @return Response
+     * @param $pageId
+     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View

      */
      */

-    public function create($bookSlug)
+    public function editDraft($bookSlug, $pageId)

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

-        return view('pages/create', ['book' => $book]);
+        $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 newly created resource in storage.
-     *
+     * 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->validate($request, [
     {
         $this->validate($request, [

-            'name' => 'required|string|max:255',
-            'html' => 'required|string',
-            'priority' => 'integer'
+            'name' => 'required|string|max:255'

         ]);
         ]);

+
+        $input = $request->all();

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

-        $page = $this->pageRepo->newFromInput($request->all());
-        $slug = Str::slug($page->name);
-        while($this->pageRepo->countBySlug($slug, $book->id) > 0) {
-            $slug .= '1';
-        }
-        $page->slug =$slug;
-        $page->book_id = $book->id;
-        $page->text = strip_tags($page->html);
-        $page->save();
+        $input['priority'] = $this->bookRepo->getNewPriority($book);
+
+        $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());
     }
 
     /**
         return redirect($page->getUrl());
     }
 
     /**

-     * Display the specified resource.
-     *
+     * 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


@@ -86,13 +113,34 @@ 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);
-        return view('pages/show', ['page' => $page]);
+
+        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]);

     }
 
     /**
     }
 
     /**

-     * Show the form for editing the specified resource.
-     *
+     * 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.

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


@@ -101,39 +149,308 @@ class PageController extends Controller
     {
         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
     {
         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);

-        return view('pages/edit', ['page' => $page]);
+        $this->checkOwnablePermission('page-update', $page);
+        $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 resource in storage.
-     *
+     * Update the specified page in storage.

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

-     * @param $bookSlug
-     * @param $pageSlug
+     * @param          $bookSlug
+     * @param          $pageSlug

      * @return Response
      */
     public function update(Request $request, $bookSlug, $pageSlug)
     {
      * @return Response
      */
     public function update(Request $request, $bookSlug, $pageSlug)
     {

+        $this->validate($request, [
+            '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);

-        $page->fill($request->all());
-        $slug = Str::slug($page->name);
-        while($this->pageRepo->countBySlug($slug, $book->id) > 0 && $slug != $pageSlug) {
-            $slug .= '1';
+        $this->checkOwnablePermission('page-update', $page);
+        $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']));

         }
         }

-        $page->text = strip_tags($page->html);
-        $page->save();
+        $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.
+     * @param $pageId
+     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+     */
+    public function redirectFromLink($pageId)
+    {
+        $page = $this->pageRepo->getById($pageId);

         return redirect($page->getUrl());
     }
 
     /**
         return redirect($page->getUrl());
     }
 
     /**

-     * Remove the specified resource from storage.
-     *
-     * @param  int  $id
+     * Show the deletion page for the specified page.
+     * @param $bookSlug
+     * @param $pageSlug
+     * @return \Illuminate\View\View
+     */
+    public function showDelete($bookSlug, $pageSlug)
+    {
+        $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]);
+    }
+
+
+    /**
+     * 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.
+     * @param $bookSlug
+     * @param $pageSlug
+     * @return Response
+     * @internal param int $id
+     */
+    public function destroy($bookSlug, $pageSlug)
+    {
+        $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);
+        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
      * @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());
+    }
+
+    /**
+     * Shows the last revisions for this page.
+     * @param $bookSlug
+     * @param $pageSlug
+     * @return \Illuminate\View\View
+     */
+    public function showRevisions($bookSlug, $pageSlug)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
+        $this->setPageTitle('Revisions For ' . $page->getShortName());
+        return view('pages/revisions', ['page' => $page, 'book' => $book, 'current' => $page]);
+    }
+
+    /**
+     * Shows a preview of a single revision
+     * @param $bookSlug
+     * @param $pageSlug
+     * @param $revisionId
+     * @return \Illuminate\View\View
+     */
+    public function showRevision($bookSlug, $pageSlug, $revisionId)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
+        $revision = $this->pageRepo->getRevisionById($revisionId);
+        $page->fill($revision->toArray());
+        $this->setPageTitle('Page Revision For ' . $page->getShortName());
+        return view('pages/revision', ['page' => $page, 'book' => $book]);
+    }
+
+    /**
+     * Restores a page using the content of the specified revision.
+     * @param $bookSlug
+     * @param $pageSlug
+     * @param $revisionId
+     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+     */
+    public function restoreRevision($bookSlug, $pageSlug, $revisionId)
+    {
+        $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());
+    }
+
+    /**
+     * Exports a page to pdf format using barryvdh/laravel-dompdf wrapper.
+     * https://github.com/barryvdh/laravel-dompdf
+     * @param $bookSlug
+     * @param $pageSlug
+     * @return \Illuminate\Http\Response
+     */
+    public function exportPdf($bookSlug, $pageSlug)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $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'
+        ]);
+    }
+
+    /**
+     * Export a page to a self-contained HTML file.
+     * @param $bookSlug
+     * @param $pageSlug
+     * @return \Illuminate\Http\Response
+     */
+    public function exportHtml($bookSlug, $pageSlug)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $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'
+        ]);
+    }
+
+    /**
+     * Export a page to a simple plaintext .txt file.
+     * @param $bookSlug
+     * @param $pageSlug
+     * @return \Illuminate\Http\Response

      */
      */

-    public function destroy($id)
+    public function exportPlainText($bookSlug, $pageSlug)

     {
     {

-        //
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $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'
+        ]);

     }
     }

+
+    /**
+     * Show a listing of recently created pages
+     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+     */
+    public function showRecentlyCreated()
+    {
+        $pages = $this->pageRepo->getRecentlyCreatedPaginated(20);
+        return view('pages/detailed-listing', [
+            'title' => 'Recently Created Pages',
+            'pages' => $pages
+        ]);
+    }
+
+    /**
+     * Show a listing of recently created pages
+     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+     */
+    public function showRecentlyUpdated()
+    {
+        $pages = $this->pageRepo->getRecentlyUpdatedPaginated(20);
+        return view('pages/detailed-listing', [
+            'title' => 'Recently Updated Pages',
+            'pages' => $pages
+        ]);
+    }
+
+    /**
+     * 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());
+    }
+

 }
 }