better placement of the comment tutorial

[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 7c9077f..0c3b23f 100644 (file)
--- a/src/editor/modules/data/data.js
+++ b/src/editor/modules/data/data.js
@@ -1,24 +1,86 @@
 define([
     'libs/jquery',
 define([
     'libs/jquery',

-    './saveDialog',
-    'wlxml/wlxml'
-
-], function($, saveDialog, wlxml) {
+    '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');
+

 
 return function(sandbox) {
 
 return function(sandbox) {

-    /* global gettext */

 
 

-    var document_id = sandbox.getBootstrappedData().document_id;
-    var document_version = sandbox.getBootstrappedData().version;
-    var history = sandbox.getBootstrappedData().history;
+    var data = sandbox.getBootstrappedData(),
+        documentDirty = false,
+        draftDirty = false,
+        wlxmlDocument;
+
+
+    var loadDocument = function(text, isDraft, draftTimestamp) {
+        logger.debug('loading document');
+        var xmlValid = true;
+        try {
+            wlxmlDocument = wlxml.WLXMLDocumentFromXML(text, {editorConfig: sandbox.getConfig()}, Document.Document);
+        } catch(e) {
+            logger.exception(e);
+            alert(gettext('The content of this document seems to be invalid - only XML source editing will be possible. :(')); // TODO
+            wlxmlDocument = wlxml.WLXMLDocumentFromXML(text, {}, Document.DumbDocument);
+            xmlValid = false;
+        }
+
+        Object.keys(data)
+            .filter(function(key) {
+                return key !== 'history' && key !== 'document';
+            })
+            .forEach(function(key) {
+                wlxmlDocument.setProperty(key, data[key]);
+            });
+
+        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() {
+                var timestamp = datetime.currentStrfmt(),
+                    key = getLocalStorageKey();
+                if(modificationFlag) {
+                    modificationFlag = false;
+                    return;
+                }
+                if(wlxmlDocument && documentDirty && draftDirty) {
+                    logger.debug('Saving draft to local storage.');
+                    sandbox.publish('savingStarted', 'local');
+                    window.localStorage.setItem(key.content, wlxmlDocument.toXML());
+                    window.localStorage.setItem(key.contentTimestamp, timestamp);
+                    sandbox.publish('savingEnded', 'success', 'local', {timestamp: timestamp});
+                    draftDirty = false;
+                }
+            }, sandbox.getConfig().autoSaveInterval || 2500);
+        }
+        sandbox.publish('ready', isDraft, draftTimestamp, xmlValid);
+    };

     
     function readCookie(name) {
     
     function readCookie(name) {

-        /* global escape, unescape */
+        /* global escape, unescape, document */

         var nameEQ = escape(name) + '=';
         var ca = document.cookie.split(';');
         for (var i = 0; i < ca.length; i++) {
         var nameEQ = escape(name) + '=';
         var ca = document.cookie.split(';');
         for (var i = 0; i < ca.length; i++) {


@@ -45,37 +107,130 @@ return function(sandbox) {
     var reloadHistory = function() {
         $.ajax({
             method: 'get',
     var reloadHistory = function() {
         $.ajax({
             method: 'get',

-            url: '/' + gettext('editor') + '/' + document_id + '/history',
-            success: function(data) {
-                history = data;
-                sandbox.publish('historyItemAdded', data.slice(-1)[0]);
+            url: sandbox.getConfig().documentHistoryUrl(data.document_id),
+            success: function(history) {
+                data.history = history;
+                sandbox.publish('historyItemAdded', history.slice(-1)[0]);

             },
         });
     };
             },
         });
     };

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

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

-            sandbox.publish('ready');
+            var text;
+            $('#tuton').remove();
+            if(window.localStorage) {
+                text = window.localStorage.getItem(getLocalStorageKey(data.version).content);
+
+                var timestamp = window.localStorage.getItem(getLocalStorageKey(data.version).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;
         },
         saveDocument: function() {
         },
         getDocument: function() {
             return wlxmlDocument;
         },
         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')
+                });
+            /* Set stage field initial value to current document stage. */
+            for (var i in documentSaveForm.fields) {
+                if (documentSaveForm.fields[i].name == 'textsave-stage') {
+                    documentSaveForm.fields[i].initialValue = data.stage;
+                }
+            }
+            
+            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] = wlxmlDocument.properties.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(data.document_id),
+                    data: formData,
+                    success: function(ajax_data) {

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

-                        sandbox.publish('savingEnded', 'success');
+                        sandbox.publish('savingEnded', 'success', 'remote', ajax_data);
+
+                        Object.keys(ajax_data)
+                            .filter(function(key) {
+                                return key !== 'text';
+                            })
+                            .forEach(function(key) {
+                                wlxmlDocument.setProperty(key, ajax_data[key]);
+                                // ugly, but whatever
+                                data[key] = ajax_data[key];
+                            });
+

                         reloadHistory();
                     },
                         reloadHistory();
                     },

-                    error: function() {event.error(); sandbox.publish('savingEnded', 'error');}
+                    error: function(data) {
+                        event.error();
+                        sandbox.publish('savingEnded', 'error', 'remote');
+                        var dialog = Dialog.create({
+                            title: gettext('Error'),
+                            text: JSON.parse(data.responseText).text.join('\n'),
+                            executeButtonText: gettext('Close')
+                        });
+                        dialog.show();
+                        dialog.on('execute', function(e) {
+                            e.success();
+                        });
+                    }

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


@@ -85,42 +240,108 @@ return function(sandbox) {
 
         },
         getHistory: function() {
 
         },
         getHistory: function() {

-            return history;
+            return data.history;

         },
         fetchDiff: function(ver1, ver2) {
             $.ajax({
                 method: 'get',
         },
         fetchDiff: function(ver1, ver2) {
             $.ajax({
                 method: 'get',

-                url: '/' + gettext('editor') + '/' + document_id + '/diff',
+                url: sandbox.getConfig().documentDiffUrl(data.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),
-                    success: function(data) {
-                        document_version = data.current_version;
+                    url: sandbox.getConfig().documentRestoreUrl(data.document_id),
+                    data: formData,
+                    success: function(ajax_data) {
+                        Object.keys(ajax_data)
+                            .filter(function(key) {
+                                return key !== 'document';
+                            })
+                            .forEach(function(key) {
+                                wlxmlDocument.setProperty(key, ajax_data[key]);
+                                // ugly, but whatever
+                                data[key] = ajax_data[key];
+                            });

                         reloadHistory();
                         reloadHistory();

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

                     },
                 });
                     },
                 });

-            }
+            });
+            dialog.show();

         },
         },

-        getDocumentId: function() {
-            return document_id;
+        publishVersion: function(revision) {
+            var documentPublishForm = $.extend({
+                        fields: [],
+                        revision_field_name: 'revision'
+                    },
+                    sandbox.getConfig().documentPublishForm
+                ),
+                dialog = Dialog.create({
+                    fields: documentPublishForm.fields,
+                    title: gettext('Publish'),
+                    executeButtonText: gettext('Publish'),
+                    cancelButtonText: gettext('Cancel')
+                });
+
+            dialog.on('execute', function(event) {
+                var formData = event.formData;
+                formData[documentPublishForm.revision_field_name] = revision;
+                sandbox.publish('publishingStarted', {version: revision});
+                if(sandbox.getConfig().jsonifySentData) {
+                    formData = JSON.stringify(formData);
+                }
+                $.ajax({
+                    method: 'post',
+                    //dataType: 'json',
+                    dataType: 'text',
+                    url: sandbox.getConfig().documentPublishUrl,
+                    data: formData,
+                    success: function(data) {
+                        reloadHistory();
+                        sandbox.publish('documentPublished');
+                        event.success();
+                    },
+                });
+            });
+            dialog.show();

         },
         },

-        getDocumentVersion: function() {
-            return document_version;
+        dropDraft: function() {
+            logger.debug('Dropping a draft...');
+            wlxmlDocument.loadXML(sandbox.getBootstrappedData().document);
+            draftDirty = false;
+            logger.debug('Draft dropped');
+            sandbox.publish('draftDropped');

         }
     };
 };
 
         }
     };
 };
 

-});
\ No newline at end of file
+});