editor: block save button when there is nothing to save

[fnpeditor.git] / src / editor / modules / data / data.js

diff --git a/src/editor/modules/data/data.js b/src/editor/modules/data/data.js
index af8c053..42e46f8 100644 (file)
--- a/src/editor/modules/data/data.js
+++ b/src/editor/modules/data/data.js
@@ -4,7 +4,8 @@ define([
     'wlxml/wlxml',
     'wlxml/extensions/list/list',
     'fnpjs/logging/logging',
-], function($, Dialog, wlxml, listExtension, logging) {
+    'fnpjs/datetime'
+], function($, Dialog, wlxml, listExtension, logging, datetime) {
 
 'use strict';
 /* global gettext, alert, window */
@@ -16,14 +17,23 @@ var logger = logging.getLogger('editor.modules.data'),
 return function(sandbox) {
 
     var document_id = sandbox.getBootstrappedData().document_id;
-    var document_version = sandbox.getBootstrappedData().version;
     var history = sandbox.getBootstrappedData().history;
     var documentDirty = false;
     var draftDirty = false;
 
+    var documentProperties = {};
+    var data = sandbox.getBootstrappedData();
+    Object.keys(data)
+        .filter(function(key) {
+            return key !== 'history' && key !== 'document';
+        })
+        .forEach(function(key) {
+            documentProperties[key] = data[key];
+        });
+
     var wlxmlDocument, text;
 
-    var loadDocument = function(text) {
+    var loadDocument = function(text, isDraft, draftTimestamp) {
         logger.debug('loading document');
         try {
             wlxmlDocument = wlxml.WLXMLDocumentFromXML(text);
@@ -41,11 +51,14 @@ return function(sandbox) {
         });
         
         var modificationFlag = true;
-        wlxmlDocument.on('change', function() {
+        var handleChange = function() {
             documentDirty = true;
             draftDirty = true;
             modificationFlag = true;
-        });
+        };
+        wlxmlDocument.on('change', handleChange);
+        wlxmlDocument.on('contentSet', handleChange);
+
         if(window.localStorage) {
             window.setInterval(function() {
                 if(modificationFlag) {
@@ -53,15 +66,17 @@ return function(sandbox) {
                     return;
                 }
                 if(wlxmlDocument && documentDirty && draftDirty) {
+                    var timestamp = datetime.currentStrfmt();
                     logger.debug('Saving draft to local storage.');
-                    sandbox.publish('savingStarted');
-                    window.localStorage.setItem(getLocalStorageKey(), wlxmlDocument.toXML());
-                    sandbox.publish('savingEnded', 'success');
+                    sandbox.publish('savingStarted', 'local');
+                    window.localStorage.setItem(getLocalStorageKey().content, wlxmlDocument.toXML());
+                    window.localStorage.setItem(getLocalStorageKey().contentTimestamp, timestamp);
+                    sandbox.publish('savingEnded', 'success', 'local', {timestamp: timestamp});
                     draftDirty = false;
                 }
             }, sandbox.getConfig().autoSaveInterval || 2500);
         }
-        sandbox.publish('ready');
+        sandbox.publish('ready', isDraft, draftTimestamp);
     };
     
     function readCookie(name) {
@@ -101,41 +116,49 @@ return function(sandbox) {
     };
 
     var getLocalStorageKey = function() {
-        return 'draft-id:' + document_id + '-ver:' + document_version;
+        var base = 'draft-id:' + document_id + '-ver:' + documentProperties.version;
+        return {
+            content: base,
+            contentTimestamp: base + '-content-timestamp'
+        };
     };
 
    
     return {
         start: function() {
-
             if(window.localStorage) {
-                text = window.localStorage.getItem(getLocalStorageKey());
+                text = window.localStorage.getItem(getLocalStorageKey().content);
+
+                var timestamp = window.localStorage.getItem(getLocalStorageKey().contentTimestamp),
+                    usingDraft;
                 if(text) {
                     logger.debug('Local draft exists');
                     var dialog = Dialog.create({
                         title: gettext('Local draft of a document exists'),
                         text: gettext('Unsaved local draft of this version of the document exists in your browser. Do you want to load it instead?'),
-                        submitButtonText: gettext('Yes, restore local draft'),
+                        executeButtonText: gettext('Yes, restore local draft'),
                         cancelButtonText: gettext('No, use version loaded from the server')
                     });
                     dialog.on('cancel', function() {
                         logger.debug('Bootstrapped version chosen');
+                        usingDraft = false;
                         text = sandbox.getBootstrappedData().document;
                         
                     });
-                    dialog.on('save', function(event) {
+                    dialog.on('execute', function(event) {
                         logger.debug('Local draft chosen');
+                        usingDraft = true;
                         event.success();
                     });
                     dialog.show();
                     dialog.on('close', function() {
-                        loadDocument(text);
+                        loadDocument(text, usingDraft, timestamp);
                     });
                 } else {
-                    loadDocument(sandbox.getBootstrappedData().document);
+                    loadDocument(sandbox.getBootstrappedData().document, false);
                 }
             } else {
-                loadDocument(sandbox.getBootstrappedData().document);
+                loadDocument(sandbox.getBootstrappedData().document, false);
             }
         },
         getDocument: function() {
@@ -152,15 +175,15 @@ return function(sandbox) {
                 dialog = Dialog.create({
                     fields: documentSaveForm.fields,
                     title: gettext('Save Document'),
-                    submitButtonText: gettext('Save')
+                    executeButtonText: gettext('Save')
                 });
             
-            dialog.on('save', function(event) {
-                sandbox.publish('savingStarted');
+            dialog.on('execute', function(event) {
+                sandbox.publish('savingStarted', 'remote');
 
                 var formData = event.formData;
                 formData[documentSaveForm.content_field_name] = wlxmlDocument.toXML();
-                formData[documentSaveForm.version_field_name] = document_version;
+                formData[documentSaveForm.version_field_name] = documentProperties.version;
                 if(sandbox.getConfig().jsonifySentData) {
                     formData = JSON.stringify(formData);
                 }
@@ -172,11 +195,19 @@ return function(sandbox) {
                     data: formData,
                     success: function(data) {
                         event.success();
-                        sandbox.publish('savingEnded', 'success', data.version);
-                        document_version = data.version;
+                        sandbox.publish('savingEnded', 'success', 'remote', data);
+
+                        Object.keys(data)
+                            .filter(function(key) {
+                                return key !== 'text';
+                            })
+                            .forEach(function(key) {
+                                documentProperties[key] = data[key];
+                            });
+
                         reloadHistory();
                     },
-                    error: function() {event.error(); sandbox.publish('savingEnded', 'error');}
+                    error: function() {event.error(); sandbox.publish('savingEnded', 'error', 'remote');}
                 });
             });
             dialog.on('cancel', function() {
@@ -208,10 +239,10 @@ return function(sandbox) {
                 dialog = Dialog.create({
                     fields: documentRestoreForm.fields,
                     title: gettext('Restore Version'),
-                    submitButtonText: gettext('Restore')
+                    executeButtonText: gettext('Restore')
                 });
 
-            dialog.on('save', function(event) {
+            dialog.on('execute', function(event) {
                 var formData = event.formData;
                 formData[documentRestoreForm.version_field_name] = version;
                 sandbox.publish('restoringStarted', {version: version});
@@ -224,7 +255,13 @@ return function(sandbox) {
                     url: sandbox.getConfig().documentRestoreUrl(document_id),
                     data: formData,
                     success: function(data) {
-                        document_version = data.version;
+                        Object.keys(data)
+                            .filter(function(key) {
+                                return key !== 'document';
+                            })
+                            .forEach(function(key) {
+                                documentProperties = data[key];
+                            });
                         reloadHistory();
                         wlxmlDocument.loadXML(data.document);
                         documentDirty = false;
@@ -235,11 +272,18 @@ return function(sandbox) {
             });
             dialog.show();
         },
+        dropDraft: function() {
+            logger.debug('Dropping a draft...');
+            wlxmlDocument.loadXML(sandbox.getBootstrappedData().document);
+            draftDirty = false;
+            logger.debug('Draft dropped');
+            sandbox.publish('draftDropped');
+        },
         getDocumentId: function() {
             return document_id;
         },
-        getDocumentVersion: function() {
-            return document_version;
+        getDocumentProperties: function() {
+            return documentProperties;
         }
     };
 };