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 c9ecf7d..38a80a9 100644 (file)
--- a/src/editor/modules/data/data.js
+++ b/src/editor/modules/data/data.js
@@ -1,27 +1,97 @@
 define([
 define([

-    './saveDialog',
-    'wlxml/wlxml'
-
-], function(saveDialog, wlxml) {
+    'libs/jquery',
+    'views/dialog/dialog',
+    'wlxml/wlxml',
+    'wlxml/extensions/list/list',
+    'fnpjs/logging/logging',
+    'fnpjs/datetime',
+    './document'
+], function($, Dialog, wlxml, listExtension, logging, datetime, Document) {

 
 'use strict';
 
 'use strict';

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

 
 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 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, 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);

 
 

-    var wlxmlDocument = wlxml.WLXMLDocumentFromXML(sandbox.getBootstrappedData().document);
-     
+        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) {
     
     function readCookie(name) {

-        var nameEQ = escape(name) + "=";
+        /* global escape, unescape, document */
+        var nameEQ = escape(name) + '=';

         var ca = document.cookie.split(';');
         for (var i = 0; i < ca.length; i++) {
             var c = ca[i];
         var ca = document.cookie.split(';');
         for (var i = 0; i < ca.length; i++) {
             var c = ca[i];

-            while (c.charAt(0) == ' ') c = c.substring(1, c.length);
-            if (c.indexOf(nameEQ) === 0) return unescape(c.substring(nameEQ.length, c.length));
+            while (c.charAt(0) === ' ') {
+                c = c.substring(1, c.length);
+            }
+            if (c.indexOf(nameEQ) === 0) {
+                return unescape(c.substring(nameEQ.length, c.length));
+            }

         }
         return null;
     }
         }
         return null;
     }


@@ -30,7 +100,7 @@ return function(sandbox) {
         crossDomain: false,
         beforeSend: function(xhr, settings) {
             if (!(/^(GET|HEAD|OPTIONS|TRACE)$/.test(settings.type))) {
         crossDomain: false,
         beforeSend: function(xhr, settings) {
             if (!(/^(GET|HEAD|OPTIONS|TRACE)$/.test(settings.type))) {

-                xhr.setRequestHeader("X-CSRFToken", readCookie('csrftoken'));
+                xhr.setRequestHeader('X-CSRFToken', readCookie('csrftoken'));

             }
         }
     });
             }
         }
     });


@@ -38,43 +108,109 @@ return function(sandbox) {
     var reloadHistory = function() {
         $.ajax({
             method: 'get',
     var reloadHistory = function() {
         $.ajax({
             method: 'get',

-            url: '/' + gettext('editor') + '/' + document_id + '/history',
+            url: sandbox.getConfig().documentHistoryUrl(document_id),

             success: function(data) {
             success: function(data) {

-                history = data; 
+                history = data;

                 sandbox.publish('historyItemAdded', data.slice(-1)[0]);
             },
         });
     };
                 sandbox.publish('historyItemAdded', data.slice(-1)[0]);
             },
         });
     };

-    
+
+    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;
         },

-        commitDocument: function(newDocument, reason) {
-            // doc = newDocument;
-            // sandbox.publish('documentChanged', doc, reason);
-        },

         saveDocument: function() {
         saveDocument: function() {

+            var documentSaveForm = $.extend({
+                        fields: [],
+                        content_field_name: 'text',
+                        version_field_name: 'version'
+                    },
+                    sandbox.getConfig().documentSaveForm
+                ),
+                dialog = Dialog.create({
+                    fields: documentSaveForm.fields,
+                    title: gettext('Save Document'),
+                    executeButtonText: gettext('Save'),
+                    cancelButtonText: gettext('Cancel')
+                });
+            
+            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] = documentProperties.version;
+                if(sandbox.getConfig().jsonifySentData) {
+                    formData = JSON.stringify(formData);
+                }

 
 

-            var dialog = saveDialog.create();
-            dialog.on('save', function(event) {
-                sandbox.publish('savingStarted');

                 dialog.toggleButtons(false);
                 $.ajax({
                     method: 'post',
                 dialog.toggleButtons(false);
                 $.ajax({
                     method: 'post',

-                    url: '/' + gettext('editor') + '/' + document_id,
-                    data: JSON.stringify({document:wlxmlDocument.toXML(), description: event.data.description}),
-                    success: function() {
+                    url: sandbox.getConfig().documentSaveUrl(document_id),
+                    data: formData,
+                    success: function(data) {

                         event.success();
                         event.success();

-                        sandbox.publish('savingEnded', 'success');
+                        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');}

                 });
                 });

-                console.log('save');

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


@@ -88,34 +224,69 @@ return function(sandbox) {
         fetchDiff: function(ver1, ver2) {
             $.ajax({
                 method: 'get',
         fetchDiff: function(ver1, ver2) {
             $.ajax({
                 method: 'get',

-                url: '/' + gettext('editor') + '/' + document_id + '/diff',
+                url: sandbox.getConfig().documentDiffUrl(document_id),

                 data: {from: ver1, to: ver2},
                 success: function(data) {
                     sandbox.publish('diffFetched', {table: data, ver1: ver1, ver2: ver2});
                 },
             });
         },
                 data: {from: ver1, to: ver2},
                 success: function(data) {
                     sandbox.publish('diffFetched', {table: data, ver1: ver1, ver2: ver2});
                 },
             });
         },

-        restoreVersion: function(options) {
-            if(options.version && options.description) {
-                sandbox.publish('restoringStarted', {version: options.version});
+        restoreVersion: function(version) {
+            var documentRestoreForm = $.extend({
+                        fields: [],
+                        version_field_name: 'version'
+                    },
+                    sandbox.getConfig().documentRestoreForm
+                ),
+                dialog = Dialog.create({
+                    fields: documentRestoreForm.fields,
+                    title: gettext('Restore Version'),
+                    executeButtonText: gettext('Restore'),
+                    cancelButtonText: gettext('Cancel')
+                });
+
+            dialog.on('execute', function(event) {
+                var formData = event.formData;
+                formData[documentRestoreForm.version_field_name] = version;
+                sandbox.publish('restoringStarted', {version: version});
+                if(sandbox.getConfig().jsonifySentData) {
+                    formData = JSON.stringify(formData);
+                }

                 $.ajax({
                     method: 'post',
                     dataType: 'json',
                 $.ajax({
                     method: 'post',
                     dataType: 'json',

-                    url: '/' + gettext('editor') + '/' + document_id + '/revert',
-                    data: JSON.stringify(options),
+                    url: sandbox.getConfig().documentRestoreUrl(document_id),
+                    data: formData,

                     success: function(data) {
                     success: function(data) {

-                        document_version = data.version;
+                        Object.keys(data)
+                            .filter(function(key) {
+                                return key !== 'document';
+                            })
+                            .forEach(function(key) {
+                                documentProperties = data[key];
+                            });

                         reloadHistory();
                         reloadHistory();

-                        sandbox.publish('documentReverted', data);
+                        wlxmlDocument.loadXML(data.document);
+                        documentDirty = false;
+                        sandbox.publish('documentReverted', data.version);
+                        event.success();

                     },
                     },

-                }); 
-            }
+                });
+            });
+            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;

         }
     };
 };
         }
     };
 };