Saving and restoring local draft of a document
authorAleksander Łukasz <aleksander.lukasz@nowoczesnapolska.org.pl>
Fri, 28 Feb 2014 11:35:55 +0000 (12:35 +0100)
committerAleksander Łukasz <aleksander.lukasz@nowoczesnapolska.org.pl>
Fri, 28 Feb 2014 13:43:07 +0000 (14:43 +0100)
src/editor/modules/data/data.js

index db17955..af8c053 100644 (file)
@@ -7,7 +7,7 @@ define([
 ], function($, Dialog, wlxml, listExtension, logging) {
 
 'use strict';
 ], function($, Dialog, wlxml, listExtension, logging) {
 
 '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>';
@@ -18,23 +18,51 @@ return function(sandbox) {
     var document_id = sandbox.getBootstrappedData().document_id;
     var document_version = sandbox.getBootstrappedData().version;
     var history = sandbox.getBootstrappedData().history;
     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 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 wlxmlDocument, text;
 
 
-    wlxmlDocument.registerExtension(listExtension);
-    sandbox.getPlugins().forEach(function(plugin) {
-        if(plugin.documentExtension) {
-            wlxmlDocument.registerExtension(plugin.documentExtension);
+    var loadDocument = function(text) {
+        logger.debug('loading document');
+        try {
+            wlxmlDocument = wlxml.WLXMLDocumentFromXML(text);
+        } catch(e) {
+            logger.exception(e);
+            alert(gettext('This document contains errors and can\'t be loaded. :(')); // TODO
+            wlxmlDocument = wlxml.WLXMLDocumentFromXML(stubDocument);
         }
         }
-    });
-     
+
+        wlxmlDocument.registerExtension(listExtension);
+        sandbox.getPlugins().forEach(function(plugin) {
+            if(plugin.documentExtension) {
+                wlxmlDocument.registerExtension(plugin.documentExtension);
+            }
+        });
+        
+        var modificationFlag = true;
+        wlxmlDocument.on('change', function() {
+            documentDirty = true;
+            draftDirty = true;
+            modificationFlag = true;
+        });
+        if(window.localStorage) {
+            window.setInterval(function() {
+                if(modificationFlag) {
+                    modificationFlag = false;
+                    return;
+                }
+                if(wlxmlDocument && documentDirty && draftDirty) {
+                    logger.debug('Saving draft to local storage.');
+                    sandbox.publish('savingStarted');
+                    window.localStorage.setItem(getLocalStorageKey(), wlxmlDocument.toXML());
+                    sandbox.publish('savingEnded', 'success');
+                    draftDirty = false;
+                }
+            }, sandbox.getConfig().autoSaveInterval || 2500);
+        }
+        sandbox.publish('ready');
+    };
     
     function readCookie(name) {
         /* global escape, unescape, document */
     
     function readCookie(name) {
         /* global escape, unescape, document */
@@ -71,10 +99,44 @@ return function(sandbox) {
             },
         });
     };
             },
         });
     };
-    
+
+    var getLocalStorageKey = function() {
+        return 'draft-id:' + document_id + '-ver:' + document_version;
+    };
+
+   
     return {
         start: function() {
     return {
         start: function() {
-            sandbox.publish('ready');
+
+            if(window.localStorage) {
+                text = window.localStorage.getItem(getLocalStorageKey());
+                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'),
+                        cancelButtonText: gettext('No, use version loaded from the server')
+                    });
+                    dialog.on('cancel', function() {
+                        logger.debug('Bootstrapped version chosen');
+                        text = sandbox.getBootstrappedData().document;
+                        
+                    });
+                    dialog.on('save', function(event) {
+                        logger.debug('Local draft chosen');
+                        event.success();
+                    });
+                    dialog.show();
+                    dialog.on('close', function() {
+                        loadDocument(text);
+                    });
+                } else {
+                    loadDocument(sandbox.getBootstrappedData().document);
+                }
+            } else {
+                loadDocument(sandbox.getBootstrappedData().document);
+            }
         },
         getDocument: function() {
             return wlxmlDocument;
         },
         getDocument: function() {
             return wlxmlDocument;
@@ -165,6 +227,7 @@ return function(sandbox) {
                         document_version = data.version;
                         reloadHistory();
                         wlxmlDocument.loadXML(data.document);
                         document_version = data.version;
                         reloadHistory();
                         wlxmlDocument.loadXML(data.document);
+                        documentDirty = false;
                         sandbox.publish('documentReverted', data.version);
                         event.success();
                     },
                         sandbox.publish('documentReverted', data.version);
                         event.success();
                     },