Added UI components of page autosaving

app/Http/Controllers/PageController.php

@@ -107,6 +107,17 @@ class PageController extends Controller
         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.
      * @param $bookSlug
@@ -119,6 +130,24 @@ class PageController extends Controller
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $this->checkOwnablePermission('page-update', $page);
         $this->setPageTitle('Editing Page ' . $page->getShortName());
+        $page->isDraft = false;
+
+        // Check for active editing and drafts
+        $warnings = [];
+        if ($this->pageRepo->isPageEditingActive($page, 60)) {
+            $warnings[] = $this->pageRepo->getPageEditingActiveMessage($page, 60);
+        }
+
+        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->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]);
     }
 
@@ -155,8 +184,9 @@ class PageController extends Controller
         ]);
         $page = $this->pageRepo->getById($pageId);
         $this->checkOwnablePermission('page-update', $page);
-        $this->pageRepo->saveUpdateDraft($page, $request->only(['name', 'html']));
-        return response()->json(['status' => 'success', 'message' => 'Draft successfully saved']);
+        $draft = $this->pageRepo->saveUpdateDraft($page, $request->only(['name', 'html']));
+        $updateTime = $draft->updated_at->format('H:i');
+        return response()->json(['status' => 'success', 'message' => 'Draft saved at ' . $updateTime]);
     }
 
     /**

app/Http/routes.php

@@ -77,6 +77,7 @@ Route::group(['middleware' => 'auth'], function () {
 
     // Ajax routes
     Route::put('/ajax/page/{id}/save-draft', 'PageController@saveUpdateDraft');
+    Route::get('/ajax/page/{id}', 'PageController@getPageAjax');
 
     // Links
     Route::get('/link/{id}', 'PageController@redirectFromLink');

app/Repos/PageRepo.php

@@ -4,6 +4,7 @@
 use Activity;
 use BookStack\Book;
 use BookStack\Exceptions\NotFoundException;
+use Carbon\Carbon;
 use DOMDocument;
 use Illuminate\Support\Str;
 use BookStack\Page;
@@ -259,11 +260,16 @@ class PageRepo extends EntityRepo
         }
 
         // Update with new details
+        $userId = auth()->user()->id;
         $page->fill($input);
         $page->html = $this->formatHtml($input['html']);
         $page->text = strip_tags($page->html);
-        $page->updated_by = auth()->user()->id;
+        $page->updated_by = $userId;
         $page->save();
+
+        // Remove all update drafts for this user & page.
+        $this->userUpdateDraftsQuery($page, $userId)->delete();
+
         return $page;
     }
 
@@ -318,10 +324,7 @@ class PageRepo extends EntityRepo
     public function saveUpdateDraft(Page $page, $data = [])
     {
         $userId = auth()->user()->id;
-        $drafts = $this->pageRevision->where('created_by', '=', $userId)
-            ->where('type', 'update_draft')
-            ->where('page_id', '=', $page->id)
-            ->orderBy('created_at', 'desc')->get();
+        $drafts = $this->userUpdateDraftsQuery($page, $userId)->get();
 
         if ($drafts->count() > 0) {
             $draft = $drafts->first();
@@ -339,6 +342,107 @@ class PageRepo extends EntityRepo
         return $draft;
     }
 
+    /**
+     * The base query for getting user update drafts.
+     * @param Page $page
+     * @param $userId
+     * @return mixed
+     */
+    private function userUpdateDraftsQuery(Page $page, $userId)
+    {
+        return $this->pageRevision->where('created_by', '=', $userId)
+            ->where('type', 'update_draft')
+            ->where('page_id', '=', $page->id)
+            ->orderBy('created_at', 'desc');
+    }
+
+    /**
+     * Checks whether a user has a draft version of a particular page or not.
+     * @param Page $page
+     * @param $userId
+     * @return bool
+     */
+    public function hasUserGotPageDraft(Page $page, $userId)
+    {
+        return $this->userUpdateDraftsQuery($page, $userId)->count() > 0;
+    }
+
+    /**
+     * Get the latest updated draft revision for a particular page and user.
+     * @param Page $page
+     * @param $userId
+     * @return mixed
+     */
+    public function getUserPageDraft(Page $page, $userId)
+    {
+        return $this->userUpdateDraftsQuery($page, $userId)->first();
+    }
+
+    /**
+     * Get the notification message that informs the user that they are editing a draft page.
+     * @param PageRevision $draft
+     * @return string
+     */
+    public function getUserPageDraftMessage(PageRevision $draft)
+    {
+        $message = 'You are currently editing a draft that was last saved ' . $draft->updated_at->diffForHumans() . '.';
+        if ($draft->page->updated_at->timestamp > $draft->updated_at->timestamp) {
+            $message .= "\n This page has been updated by since that time. It is recommended that you discard this draft.";
+        }
+        return $message;
+    }
+
+    /**
+     * Check if a page is being actively editing.
+     * Checks for edits since last page updated.
+     * Passing in a minuted range will check for edits
+     * within the last x minutes.
+     * @param Page $page
+     * @param null $minRange
+     * @return bool
+     */
+    public function isPageEditingActive(Page $page, $minRange = null)
+    {
+        $draftSearch = $this->activePageEditingQuery($page, $minRange);
+        return $draftSearch->count() > 0;
+    }
+
+    /**
+     * Get a notification message concerning the editing activity on
+     * a particular page.
+     * @param Page $page
+     * @param null $minRange
+     * @return string
+     */
+    public function getPageEditingActiveMessage(Page $page, $minRange = null)
+    {
+        $pageDraftEdits = $this->activePageEditingQuery($page, $minRange)->get();
+        $userMessage = $pageDraftEdits->count() > 1 ? $pageDraftEdits->count() . ' users have' : $pageDraftEdits->first()->createdBy->name . ' has';
+        $timeMessage = $minRange === null ? 'since the page was last updated' : 'in the last ' . $minRange . ' minutes';
+        $message = '%s started editing this page %s. Take care not to overwrite each other\'s updates!';
+        return sprintf($message, $userMessage, $timeMessage);
+    }
+
+    /**
+     * A query to check for active update drafts on a particular page.
+     * @param Page $page
+     * @param null $minRange
+     * @return mixed
+     */
+    private function activePageEditingQuery(Page $page, $minRange = null)
+    {
+        $query = $this->pageRevision->where('type', '=', 'update_draft')
+            ->where('updated_at', '>', $page->updated_at)
+            ->where('created_by', '!=', auth()->user()->id)
+            ->with('createdBy');
+
+        if ($minRange !== null) {
+            $query = $query->where('updated_at', '>=', Carbon::now()->subMinutes($minRange));
+        }
+
+        return $query;
+    }
+
     /**
      * Gets a single revision via it's id.
      * @param $id