Added migration file.

[bookstack] / resources / assets / js / controllers.js

diff --git a/resources/assets/js/controllers.js b/resources/assets/js/controllers.js
index 305e0c3c1ab81fb215eeb4c81f33cb9dcd1961b1..8b37379fa18543cbeca92b542f61f88c1475ba6c 100644 (file)
--- a/resources/assets/js/controllers.js
+++ b/resources/assets/js/controllers.js
@@ -1,261 +1,369 @@
 "use strict";
 
 "use strict";
 

-module.exports = function (ngApp, events) {
+const moment = require('moment');
+require('moment/locale/en-gb');
+const editorOptions = require("./pages/page-form");

 
 

-    ngApp.controller('ImageManagerController', ['$scope', '$attrs', '$http', '$timeout', 'imageManagerService',
-        function ($scope, $attrs, $http, $timeout, imageManagerService) {
-            $scope.images = [];
-            $scope.imageType = $attrs.imageType;
-            $scope.selectedImage = false;
-            $scope.dependantPages = false;
-            $scope.showing = false;
-            $scope.hasMore = false;
-            $scope.imageUpdateSuccess = false;
-            $scope.imageDeleteSuccess = false;
-            var page = 0;
-            var previousClickTime = 0;
-            var dataLoaded = false;
-            var callback = false;
-
-            /**
-             * Simple returns the appropriate upload url depending on the image type set.
-             * @returns {string}
-             */
-            $scope.getUploadUrl = function () {
-                return '/images/' + $scope.imageType + '/upload';
-            };
+moment.locale('en-gb');

 
 

-            /**
-             * Runs on image upload, Adds an image to local list of images
-             * and shows a success message to the user.
-             * @param file
-             * @param data
-             */
-            $scope.uploadSuccess = function (file, data) {
-                $scope.$apply(() => {
-                    $scope.images.unshift(data);
-                });
-                events.emit('success', 'Image uploaded');
-            };
+module.exports = function (ngApp, events) {

 
 

-            /**
-             * Runs the callback and hides the image manager.
-             * @param returnData
-             */
-            function callbackAndHide(returnData) {
-                if (callback) callback(returnData);
-                $scope.showing = false;
-            }

 
 

-            /**
-             * Image select action. Checks if a double-click was fired.
-             * @param image
-             */
-            $scope.imageSelect = function (image) {
-                var dblClickTime = 300;
-                var currentTime = Date.now();
-                var timeDiff = currentTime - previousClickTime;
-
-                if (timeDiff < dblClickTime) {
-                    // If double click
-                    callbackAndHide(image);
-                } else {
-                    // If single
-                    $scope.selectedImage = image;
-                    $scope.dependantPages = false;
-                }
-                previousClickTime = currentTime;
-            };
+    ngApp.controller('PageEditController', ['$scope', '$http', '$attrs', '$interval', '$timeout', '$sce',
+        function ($scope, $http, $attrs, $interval, $timeout, $sce) {

 
 

-            /**
-             * Action that runs when the 'Select image' button is clicked.
-             * Runs the callback and hides the image manager.
-             */
-            $scope.selectButtonClick = function () {
-                callbackAndHide($scope.selectedImage);
-            };
+        $scope.editorOptions = editorOptions();
+        $scope.editContent = '';
+        $scope.draftText = '';
+        let pageId = Number($attrs.pageId);
+        let isEdit = pageId !== 0;
+        let autosaveFrequency = 30; // AutoSave interval in seconds.
+        let isMarkdown = $attrs.editorType === 'markdown';
+        $scope.draftsEnabled = $attrs.draftsEnabled === 'true';
+        $scope.isUpdateDraft = Number($attrs.pageUpdateDraft) === 1;
+        $scope.isNewPageDraft = Number($attrs.pageNewDraft) === 1;
+
+        // Set initial header draft text
+        if ($scope.isUpdateDraft || $scope.isNewPageDraft) {
+            $scope.draftText = trans('entities.pages_editing_draft');
+        } else {
+            $scope.draftText = trans('entities.pages_editing_page');
+        }

 
 

-            /**
-             * Show the image manager.
-             * Takes a callback to execute later on.
-             * @param doneCallback
-             */
-            function show(doneCallback) {
-                callback = doneCallback;
-                $scope.showing = true;
-                // Get initial images if they have not yet been loaded in.
-                if (!dataLoaded) {
-                    fetchData();
-                    dataLoaded = true;
-                }
-            }
+        let autoSave = false;

 
 

-            // Connects up the image manger so it can be used externally
-            // such as from TinyMCE.
-            imageManagerService.show = show;
-            imageManagerService.showExternal = function (doneCallback) {
-                $scope.$apply(() => {
-                    show(doneCallback);
-                });
-            };
-            window.ImageManager = imageManagerService;
+        let currentContent = {
+            title: false,
+            html: false
+        };

 
 

-            /**
-             * Hide the image manager
-             */
-            $scope.hide = function () {
-                $scope.showing = false;
-            };
+        if (isEdit && $scope.draftsEnabled) {
+            setTimeout(() => {
+                startAutoSave();
+            }, 1000);
+        }

 
 

-            /**
-             * Fetch the list image data from the server.
-             */
-            function fetchData() {
-                var url = '/images/' + $scope.imageType + '/all/' + page;
-                $http.get(url).then((response) => {
-                    $scope.images = $scope.images.concat(response.data.images);
-                    $scope.hasMore = response.data.hasMore;
-                    page++;
-                });
+        // Actions specifically for the markdown editor
+        if (isMarkdown) {
+            $scope.displayContent = '';
+            // Editor change event
+            $scope.editorChange = function (content) {
+                $scope.displayContent = $sce.trustAsHtml(content);

             }
             }

+        }

 
 

-            $scope.fetchData = fetchData;
-
-            /**
-             * Save the details of an image.
-             * @param event
-             */
-            $scope.saveImageDetails = function (event) {
-                event.preventDefault();
-                var url = '/images/update/' + $scope.selectedImage.id;
-                $http.put(url, this.selectedImage).then((response) => {
-                    events.emit('success', 'Image details updated');
-                }, (response) => {
-                    if (response.status === 422) {
-                        var errors = response.data;
-                        var message = '';
-                        Object.keys(errors).forEach((key) => {
-                            message += errors[key].join('\n');
-                        });
-                        events.emit('error', message);
-                    } else if (response.status === 403) {
-                        events.emit('error', response.data.error);
-                    }
-                });
-            };
+        if (!isMarkdown) {
+            $scope.editorChange = function() {};
+        }

 
 

-            /**
-             * Delete an image from system and notify of success.
-             * Checks if it should force delete when an image
-             * has dependant pages.
-             * @param event
-             */
-            $scope.deleteImage = function (event) {
-                event.preventDefault();
-                var force = $scope.dependantPages !== false;
-                var url = '/images/' + $scope.selectedImage.id;
-                if (force) url += '?force=true';
-                $http.delete(url).then((response) => {
-                    $scope.images.splice($scope.images.indexOf($scope.selectedImage), 1);
-                    $scope.selectedImage = false;
-                    events.emit('success', 'Image successfully deleted');
-                }, (response) => {
-                    // Pages failure
-                    if (response.status === 400) {
-                        $scope.dependantPages = response.data;
-                    } else if (response.status === 403) {
-                        events.emit('error', response.data.error);
-                    }
-                });
-            };
+        let lastSave = 0;
+
+        /**
+         * Start the AutoSave loop, Checks for content change
+         * before performing the costly AJAX request.
+         */
+        function startAutoSave() {
+            currentContent.title = $('#name').val();
+            currentContent.html = $scope.editContent;
+
+            autoSave = $interval(() => {
+                // Return if manually saved recently to prevent bombarding the server
+                if (Date.now() - lastSave < (1000*autosaveFrequency)/2) return;
+                let newTitle = $('#name').val();
+                let newHtml = $scope.editContent;
+
+                if (newTitle !== currentContent.title || newHtml !== currentContent.html) {
+                    currentContent.html = newHtml;
+                    currentContent.title = newTitle;
+                    saveDraft();
+                }
+
+            }, 1000 * autosaveFrequency);
+        }

 
 

-            /**
-             * Simple date creator used to properly format dates.
-             * @param stringDate
-             * @returns {Date}
-             */
-            $scope.getDate = function (stringDate) {
-                return new Date(stringDate);
+        let draftErroring = false;
+        /**
+         * Save a draft update into the system via an AJAX request.
+         */
+        function saveDraft() {
+            if (!$scope.draftsEnabled) return;
+            let data = {
+                name: $('#name').val(),
+                html: isMarkdown ? $sce.getTrustedHtml($scope.displayContent) : $scope.editContent

             };
 
             };
 

-        }]);
+            if (isMarkdown) data.markdown = $scope.editContent;
+
+            let url = window.baseUrl('/ajax/page/' + pageId + '/save-draft');
+            $http.put(url, data).then(responseData => {
+                draftErroring = false;
+                let updateTime = moment.utc(moment.unix(responseData.data.timestamp)).toDate();
+                $scope.draftText = responseData.data.message + moment(updateTime).format('HH:mm');
+                if (!$scope.isNewPageDraft) $scope.isUpdateDraft = true;
+                showDraftSaveNotification();
+                lastSave = Date.now();
+            }, errorRes => {
+                if (draftErroring) return;
+                events.emit('error', trans('errors.page_draft_autosave_fail'));
+                draftErroring = true;
+            });
+        }

 
 

+        function showDraftSaveNotification() {
+            $scope.draftUpdated = true;
+            $timeout(() => {
+                $scope.draftUpdated = false;
+            }, 2000)
+        }

 
 

-    ngApp.controller('BookShowController', ['$scope', '$http', '$attrs', '$sce', function ($scope, $http, $attrs, $sce) {
-        $scope.searching = false;
-        $scope.searchTerm = '';
-        $scope.searchResults = '';
+        $scope.forceDraftSave = function() {
+            saveDraft();
+        };

 
 

-        $scope.searchBook = function (e) {
-            e.preventDefault();
-            var term = $scope.searchTerm;
-            if (term.length == 0) return;
-            $scope.searching = true;
-            $scope.searchResults = '';
-            var searchUrl = '/search/book/' + $attrs.bookId;
-            searchUrl += '?term=' + encodeURIComponent(term);
-            $http.get(searchUrl).then((response) => {
-                $scope.searchResults = $sce.trustAsHtml(response.data);
+        // Listen to save draft events from editor
+        $scope.$on('save-draft', saveDraft);
+
+        /**
+         * Discard the current draft and grab the current page
+         * content from the system via an AJAX request.
+         */
+        $scope.discardDraft = function () {
+            let url = window.baseUrl('/ajax/page/' + pageId);
+            $http.get(url).then(responseData => {
+                if (autoSave) $interval.cancel(autoSave);
+                $scope.draftText = trans('entities.pages_editing_page');
+                $scope.isUpdateDraft = false;
+                $scope.$broadcast('html-update', responseData.data.html);
+                $scope.$broadcast('markdown-update', responseData.data.markdown || responseData.data.html);
+                $('#name').val(responseData.data.name);
+                $timeout(() => {
+                    startAutoSave();
+                }, 1000);
+                events.emit('success', trans('entities.pages_draft_discarded'));

             });
         };
 
             });
         };
 

-        $scope.checkSearchForm = function () {
-            if ($scope.searchTerm.length < 1) {
-                $scope.searching = false;
+    }]);
+
+    // Controller used to reply to and add new comments
+    ngApp.controller('CommentReplyController', ['$scope', '$http', '$timeout', function ($scope, $http, $timeout) {
+        const MarkdownIt = require("markdown-it");
+        const md = new MarkdownIt({html: true});
+        let vm = this;
+
+        vm.saveComment = function () {
+            let pageId = $scope.comment.pageId || $scope.pageId;
+            let comment = $scope.comment.text;
+            if (!comment) {
+                return events.emit('warning', trans('errors.empty_comment'));

             }
             }

-        };
+            let commentHTML = md.render($scope.comment.text);
+            let serviceUrl = `/ajax/page/${pageId}/comment/`;
+            let httpMethod = 'post';
+            let reqObj = {
+                text: comment,
+                html: commentHTML
+            };
+
+            if ($scope.isEdit === true) {
+                // this will be set when editing the comment.
+                serviceUrl = `/ajax/page/${pageId}/comment/${$scope.comment.id}`;
+                httpMethod = 'put';
+            } else if ($scope.isReply === true) {
+                // if its reply, get the parent comment id
+                reqObj.parent_id = $scope.parentId;
+            }
+            $http[httpMethod](window.baseUrl(serviceUrl), reqObj).then(resp => {
+                if (!isCommentOpSuccess(resp)) {
+                     return;
+                }
+                // hide the comments first, and then retrigger the refresh
+                if ($scope.isEdit) {
+                    updateComment($scope.comment, resp.data);
+                    $scope.$emit('evt.comment-success', $scope.comment.id);
+                } else {
+                    $scope.comment.text = '';
+                    if ($scope.isReply === true && $scope.parent.sub_comments) {
+                        $scope.parent.sub_comments.push(resp.data.comment);
+                    } else {
+                        $scope.$emit('evt.new-comment', resp.data.comment);
+                    }
+                    $scope.$emit('evt.comment-success', null, true);
+                }
+                $scope.comment.is_hidden = true;
+                $timeout(function() {
+                    $scope.comment.is_hidden = false;
+                });
+
+                events.emit('success', trans(resp.data.message));
+
+            }, checkError);

 
 

-        $scope.clearSearch = function () {
-            $scope.searching = false;
-            $scope.searchTerm = '';

         };
 
         };
 

+        function checkError(response) {
+            let msg = null;
+            if (isCommentOpSuccess(response)) {
+                // all good
+                return;
+            } else if (response.data) {
+                msg = response.data.message;
+            } else {
+                msg = trans('errors.comment_add');
+            }
+            if (msg) {
+                events.emit('success', msg);
+            }
+        }

     }]);
 
     }]);
 

+    // Controller used to delete comments
+    ngApp.controller('CommentDeleteController', ['$scope', '$http', '$timeout', function ($scope, $http, $timeout) {
+        let vm = this;

 
 

-    ngApp.controller('PageEditController',  ['$scope', '$http', '$attrs', '$interval', function ($scope, $http, $attrs, $interval) {
+        vm.delete = function(comment) {
+            $http.delete(window.baseUrl(`/ajax/comment/${comment.id}`)).then(resp => {
+                if (!isCommentOpSuccess(resp)) {
+                    return;
+                }
+                updateComment(comment, resp.data, $timeout, true);
+            }, function (resp) {
+                if (isCommentOpSuccess(resp)) {
+                    events.emit('success', trans('entities.comment_deleted'));
+                } else {
+                    events.emit('error', trans('error.comment_delete'));
+                }
+            });
+        };
+    }]);

 
 

-        $scope.editorOptions = require('./pages/page-form');
-        $scope.editorHtml = '';
-        $scope.draftText = '';
-        var pageId = Number($attrs.pageId);
-        var isEdit = pageId !== 0;
+    // Controller used to fetch all comments for a page
+    ngApp.controller('CommentListController', ['$scope', '$http', '$timeout', '$location', function ($scope, $http, $timeout, $location) {
+        let vm = this;
+        $scope.errors = {};
+        // keep track of comment levels
+        $scope.level = 1;
+        vm.totalCommentsStr = trans('entities.comments_loading');
+        vm.permissions = {};
+        vm.trans = window.trans;
+
+        $scope.$on('evt.new-comment', function (event, comment) {
+            // add the comment to the comment list.
+            vm.comments.push(comment);
+            ++vm.totalComments;
+            setTotalCommentMsg();
+            event.stopPropagation();
+            event.preventDefault();
+        });
+
+        vm.canEditDelete = function (comment, prop) {
+            if (!comment.active) {
+                return false;
+            }
+            let propAll = prop + '_all';
+            let propOwn = prop + '_own';

 
 

-        if (isEdit) {
-            startAutoSave();
-        }
+            if (vm.permissions[propAll]) {
+                return true;
+            }

 
 

-        $scope.editorChange = function() {
-            $scope.draftText = '';
-        }
+            if (vm.permissions[propOwn] && comment.created_by.id === vm.current_user_id) {
+                return true;
+            }

 
 

-        function startAutoSave() {
-            var currentTitle = $('#name').val();
-            var currentHtml = $scope.editorHtml;
+            return false;
+        };

 
 

-            console.log('Starting auto save');
+        vm.canComment = function () {
+            return vm.permissions.comment_create;
+        };

 
 

-            $interval(() => {
-                var newTitle = $('#name').val();
-                var newHtml = $scope.editorHtml;
+        // check if there are is any direct linking
+        let linkedCommentId = $location.search().cm;

 
 

-                if (newTitle !== currentTitle || newHtml !== currentHtml) {
-                    currentHtml = newHtml;
-                    currentTitle = newTitle;
-                    saveDraftUpdate(newTitle, newHtml);
+        $timeout(function() {
+            $http.get(window.baseUrl(`/ajax/page/${$scope.pageId}/comments/`)).then(resp => {
+                if (!isCommentOpSuccess(resp)) {
+                    // just show that no comments are available.
+                    vm.totalComments = 0;
+                    setTotalCommentMsg();
+                    return;

                 }
                 }

-            }, 1000*5);
+                vm.comments = resp.data.comments;
+                vm.totalComments = +resp.data.total;
+                vm.permissions = resp.data.permissions;
+                vm.current_user_id = resp.data.user_id;
+                setTotalCommentMsg();
+                if (!linkedCommentId) {
+                    return;
+                }
+                $timeout(function() {
+                    // wait for the UI to render.
+                    focusLinkedComment(linkedCommentId);
+                });
+            }, checkError);
+        });
+
+        function setTotalCommentMsg () {
+            if (vm.totalComments === 0) {
+                vm.totalCommentsStr = trans('entities.no_comments');
+            } else if (vm.totalComments === 1) {
+                vm.totalCommentsStr = trans('entities.one_comment');
+            } else {
+                vm.totalCommentsStr = trans('entities.x_comments', {
+                    numComments: vm.totalComments
+                });
+            }

         }
 
         }
 

-        function saveDraftUpdate(title, html) {
-            $http.put('/ajax/page/' + pageId + '/save-draft', {
-                name: title,
-                html: html
-            }).then((responseData) => {
-                $scope.draftText = 'Draft saved'
-            })
+        function focusLinkedComment(linkedCommentId) {
+            let comment = angular.element('#' + linkedCommentId);
+            if (comment.length === 0) {
+                return;
+            }
+
+            window.setupPageShow.goToText(linkedCommentId);

         }
 
         }
 

+        function checkError(response) {
+            let msg = null;
+            if (isCommentOpSuccess(response)) {
+                // all good
+                return;
+            } else if (response.data) {
+                msg = response.data.message;
+            } else {
+                msg = trans('errors.comment_list');
+            }
+            if (msg) {
+                events.emit('success', msg);
+            }
+        }

     }]);
 
     }]);
 

-};
\ No newline at end of file
+    function updateComment(comment, resp, $timeout, isDelete) {
+        comment.text = resp.comment.text;
+        comment.updated = resp.comment.updated;
+        comment.updated_by = resp.comment.updated_by;
+        comment.active = resp.comment.active;
+        if (isDelete && !resp.comment.active) {
+            comment.html = trans('entities.comment_deleted');
+        } else {
+            comment.html = resp.comment.html;
+        }
+        if (!$timeout) {
+            return;
+        }
+        comment.is_hidden = true;
+        $timeout(function() {
+            comment.is_hidden = false;
+        });
+    }
+
+    function isCommentOpSuccess(resp) {
+        if (resp && resp.data && resp.data.status === 'success') {
+            return true;
+        }
+        return false;
+    }
+};