editor: additional descriptions for some transactions

[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 db17955..38a80a9 100644 (file)
--- a/src/editor/modules/data/data.js
+++ b/src/editor/modules/data/data.js
@@ -1,13 +1,15 @@
 define([
     'libs/jquery',
 define([
     'libs/jquery',

-    './dialog',
+    'views/dialog/dialog',

     'wlxml/wlxml',
     'wlxml/extensions/list/list',
     'fnpjs/logging/logging',
     'wlxml/wlxml',
     'wlxml/extensions/list/list',
     'fnpjs/logging/logging',

-], function($, Dialog, wlxml, listExtension, logging) {
+    'fnpjs/datetime',
+    './document'
+], function($, Dialog, wlxml, listExtension, logging, datetime, Document) {

 
 'use strict';
 
 'use strict';

-/* global gettext, alert */
+/* global gettext, alert, window */

 
 var logger = logging.getLogger('editor.modules.data'),
     stubDocument = '<section><div>' + gettext('This is an empty document.') + '</div></section>';
 
 var logger = logging.getLogger('editor.modules.data'),
     stubDocument = '<section><div>' + gettext('This is an empty document.') + '</div></section>';


@@ -16,25 +18,67 @@ var logger = logging.getLogger('editor.modules.data'),
 return function(sandbox) {
 
     var document_id = sandbox.getBootstrappedData().document_id;
 return function(sandbox) {
 
     var document_id = sandbox.getBootstrappedData().document_id;

-    var document_version = sandbox.getBootstrappedData().version;

     var history = sandbox.getBootstrappedData().history;
     var history = sandbox.getBootstrappedData().history;

+    var documentDirty = false;
+    var draftDirty = false;

 
 

-    var wlxmlDocument;
-    try {
-        wlxmlDocument = wlxml.WLXMLDocumentFromXML(sandbox.getBootstrappedData().document);
-    } catch(e) {
-        logger.exception(e);
-        alert(gettext('This document contains errors and can\'t be loaded. :(')); // TODO
-        wlxmlDocument = wlxml.WLXMLDocumentFromXML(stubDocument);
-    }
+    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;

 
 

-    wlxmlDocument.registerExtension(listExtension);
-    sandbox.getPlugins().forEach(function(plugin) {
-        if(plugin.documentExtension) {
-            wlxmlDocument.registerExtension(plugin.documentExtension);
+    var loadDocument = function(text, isDraft, draftTimestamp) {
+        logger.debug('loading document');
+        try {
+            wlxmlDocument = wlxml.WLXMLDocumentFromXML(text, {}, Document);
+        } catch(e) {
+            logger.exception(e);
+            alert(gettext('This document contains errors and can\'t be loaded. :(')); // TODO
+            wlxmlDocument = wlxml.WLXMLDocumentFromXML(stubDocument, {}, Document);

         }
         }

-    });
-     
+
+        wlxmlDocument.registerExtension(listExtension);
+        sandbox.getPlugins().forEach(function(plugin) {
+            if(plugin.documentExtension) {
+                wlxmlDocument.registerExtension(plugin.documentExtension);
+            }
+        });
+        
+        var modificationFlag = true;
+        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) {
+                    modificationFlag = false;
+                    return;
+                }
+                if(wlxmlDocument && documentDirty && draftDirty) {
+                    var timestamp = datetime.currentStrfmt();
+                    logger.debug('Saving draft to local storage.');
+                    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', isDraft, draftTimestamp);
+    };

     
     function readCookie(name) {
         /* global escape, unescape, document */
     
     function readCookie(name) {
         /* global escape, unescape, document */


@@ -71,10 +115,52 @@ return function(sandbox) {
             },
         });
     };
             },
         });
     };

-    
+
+    var getLocalStorageKey = function() {
+        var base = 'draft-id:' + document_id + '-ver:' + documentProperties.version;
+        return {
+            content: base,
+            contentTimestamp: base + '-content-timestamp'
+        };
+    };
+
+   

     return {
         start: function() {
     return {
         start: function() {

-            sandbox.publish('ready');
+            if(window.localStorage) {
+                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?'),
+                        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('execute', function(event) {
+                        logger.debug('Local draft chosen');
+                        usingDraft = true;
+                        event.success();
+                    });
+                    dialog.show();
+                    dialog.on('close', function() {
+                        loadDocument(text, usingDraft, timestamp);
+                    });
+                } else {
+                    loadDocument(sandbox.getBootstrappedData().document, false);
+                }
+            } else {
+                loadDocument(sandbox.getBootstrappedData().document, false);
+            }

         },
         getDocument: function() {
             return wlxmlDocument;
         },
         getDocument: function() {
             return wlxmlDocument;


@@ -90,15 +176,16 @@ return function(sandbox) {
                 dialog = Dialog.create({
                     fields: documentSaveForm.fields,
                     title: gettext('Save Document'),
                 dialog = Dialog.create({
                     fields: documentSaveForm.fields,
                     title: gettext('Save Document'),

-                    submitButtonText: gettext('Save')
+                    executeButtonText: gettext('Save'),
+                    cancelButtonText: gettext('Cancel')

                 });
             
                 });
             

-            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();
 
                 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);
                 }
                 if(sandbox.getConfig().jsonifySentData) {
                     formData = JSON.stringify(formData);
                 }


@@ -110,11 +197,19 @@ return function(sandbox) {
                     data: formData,
                     success: function(data) {
                         event.success();
                     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();
                     },
                         reloadHistory();
                     },

-                    error: function() {event.error(); sandbox.publish('savingEnded', 'error');}
+                    error: function() {event.error(); sandbox.publish('savingEnded', 'error', 'remote');}

                 });
             });
             dialog.on('cancel', function() {
                 });
             });
             dialog.on('cancel', function() {


@@ -146,10 +241,11 @@ return function(sandbox) {
                 dialog = Dialog.create({
                     fields: documentRestoreForm.fields,
                     title: gettext('Restore Version'),
                 dialog = Dialog.create({
                     fields: documentRestoreForm.fields,
                     title: gettext('Restore Version'),

-                    submitButtonText: gettext('Restore')
+                    executeButtonText: gettext('Restore'),
+                    cancelButtonText: gettext('Cancel')

                 });
 
                 });
 

-            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});
                 var formData = event.formData;
                 formData[documentRestoreForm.version_field_name] = version;
                 sandbox.publish('restoringStarted', {version: version});


@@ -162,9 +258,16 @@ return function(sandbox) {
                     url: sandbox.getConfig().documentRestoreUrl(document_id),
                     data: formData,
                     success: function(data) {
                     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);
                         reloadHistory();
                         wlxmlDocument.loadXML(data.document);

+                        documentDirty = false;

                         sandbox.publish('documentReverted', data.version);
                         event.success();
                     },
                         sandbox.publish('documentReverted', data.version);
                         event.success();
                     },


@@ -172,11 +275,18 @@ return function(sandbox) {
             });
             dialog.show();
         },
             });
             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;
         },
         getDocumentId: function() {
             return document_id;
         },

-        getDocumentVersion: function() {
-            return document_version;
+        getDocumentProperties: function() {
+            return documentProperties;

         }
     };
 };
         }
     };
 };