tutorial in editor (mechanics only)

[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 3bb2c2c..919ce68 100644 (file)
--- a/src/editor/modules/data/data.js
+++ b/src/editor/modules/data/data.js
@@ -4,45 +4,44 @@ define([
     'wlxml/wlxml',
     'wlxml/extensions/list/list',
     'fnpjs/logging/logging',
     'wlxml/wlxml',
     'wlxml/extensions/list/list',
     'fnpjs/logging/logging',

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

 
 'use strict';
 /* global gettext, alert, window */
 
 
 'use strict';
 /* 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');

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

-    var document_id = sandbox.getBootstrappedData().document_id;
-    var history = sandbox.getBootstrappedData().history;
-    var documentDirty = false;
-    var draftDirty = false;
+    var data = sandbox.getBootstrappedData(),
+        documentDirty = false,
+        draftDirty = false,
+        wlxmlDocument;

 
 

-    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');
 
     var loadDocument = function(text, isDraft, draftTimestamp) {
         logger.debug('loading document');

+        var xmlValid = true;

         try {
         try {

-            wlxmlDocument = wlxml.WLXMLDocumentFromXML(text);
+            wlxmlDocument = wlxml.WLXMLDocumentFromXML(text, {editorConfig: sandbox.getConfig()}, Document.Document);

         } catch(e) {
             logger.exception(e);
         } catch(e) {
             logger.exception(e);

-            alert(gettext('This document contains errors and can\'t be loaded. :(')); // TODO
-            wlxmlDocument = wlxml.WLXMLDocumentFromXML(stubDocument);
+            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(listExtension);
         sandbox.getPlugins().forEach(function(plugin) {
             if(plugin.documentExtension) {


@@ -61,22 +60,23 @@ return function(sandbox) {
 
         if(window.localStorage) {
             window.setInterval(function() {
 
         if(window.localStorage) {
             window.setInterval(function() {

+                var timestamp = datetime.currentStrfmt(),
+                    key = getLocalStorageKey();

                 if(modificationFlag) {
                     modificationFlag = false;
                     return;
                 }
                 if(wlxmlDocument && documentDirty && draftDirty) {
                 if(modificationFlag) {
                     modificationFlag = false;
                     return;
                 }
                 if(wlxmlDocument && documentDirty && draftDirty) {

-                    var timestamp = datetime.currentStrfmt();

                     logger.debug('Saving draft to local storage.');
                     sandbox.publish('savingStarted', 'local');
                     logger.debug('Saving draft to local storage.');
                     sandbox.publish('savingStarted', 'local');

-                    window.localStorage.setItem(getLocalStorageKey().content, wlxmlDocument.toXML());
-                    window.localStorage.setItem(getLocalStorageKey().contentTimestamp, timestamp);
+                    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('savingEnded', 'success', 'local', {timestamp: timestamp});
                     draftDirty = false;
                 }
             }, sandbox.getConfig().autoSaveInterval || 2500);
         }

-        sandbox.publish('ready', isDraft, draftTimestamp);
+        sandbox.publish('ready', isDraft, draftTimestamp, xmlValid);

     };
     
     function readCookie(name) {
     };
     
     function readCookie(name) {


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

-            url: sandbox.getConfig().documentHistoryUrl(document_id),
-            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() {
-        var base = 'draft-id:' + document_id + '-ver:' + documentProperties.version;
+    var getLocalStorageKey = function(forVersion) {
+        var base = 'draft-id:' + data.document_id + '-ver:' + (forVersion || wlxmlDocument.properties.version);

         return {
             content: base,
             contentTimestamp: base + '-content-timestamp'
         return {
             content: base,
             contentTimestamp: base + '-content-timestamp'


@@ -126,10 +126,11 @@ return function(sandbox) {
    
     return {
         start: function() {
    
     return {
         start: function() {

+            var text;

             if(window.localStorage) {
             if(window.localStorage) {

-                text = window.localStorage.getItem(getLocalStorageKey().content);
+                text = window.localStorage.getItem(getLocalStorageKey(data.version).content);

 
 

-                var timestamp = window.localStorage.getItem(getLocalStorageKey().contentTimestamp),
+                var timestamp = window.localStorage.getItem(getLocalStorageKey(data.version).contentTimestamp),

                     usingDraft;
                 if(text) {
                     logger.debug('Local draft exists');
                     usingDraft;
                 if(text) {
                     logger.debug('Local draft exists');


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

-                    executeButtonText: gettext('Save')
+                    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();
             
             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;
+                formData[documentSaveForm.version_field_name] = wlxmlDocument.properties.version;

                 if(sandbox.getConfig().jsonifySentData) {
                     formData = JSON.stringify(formData);
                 }
                 if(sandbox.getConfig().jsonifySentData) {
                     formData = JSON.stringify(formData);
                 }


@@ -191,23 +199,37 @@ return function(sandbox) {
                 dialog.toggleButtons(false);
                 $.ajax({
                     method: 'post',
                 dialog.toggleButtons(false);
                 $.ajax({
                     method: 'post',

-                    url: sandbox.getConfig().documentSaveUrl(document_id),
+                    url: sandbox.getConfig().documentSaveUrl(data.document_id),

                     data: formData,
                     data: formData,

-                    success: function(data) {
+                    success: function(ajax_data) {

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

-                        sandbox.publish('savingEnded', 'success', 'remote', data);
+                        sandbox.publish('savingEnded', 'success', 'remote', ajax_data);

 
 

-                        Object.keys(data)
+                        Object.keys(ajax_data)

                             .filter(function(key) {
                                 return key !== 'text';
                             })
                             .forEach(function(key) {
                             .filter(function(key) {
                                 return key !== 'text';
                             })
                             .forEach(function(key) {

-                                documentProperties[key] = data[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', 'remote');}
+                    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() {


@@ -217,12 +239,12 @@ 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: sandbox.getConfig().documentDiffUrl(document_id),
+                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});


@@ -239,7 +261,8 @@ return function(sandbox) {
                 dialog = Dialog.create({
                     fields: documentRestoreForm.fields,
                     title: gettext('Restore Version'),
                 dialog = Dialog.create({
                     fields: documentRestoreForm.fields,
                     title: gettext('Restore Version'),

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

                 });
 
             dialog.on('execute', function(event) {
                 });
 
             dialog.on('execute', function(event) {


@@ -252,20 +275,58 @@ return function(sandbox) {
                 $.ajax({
                     method: 'post',
                     dataType: 'json',
                 $.ajax({
                     method: 'post',
                     dataType: 'json',

-                    url: sandbox.getConfig().documentRestoreUrl(document_id),
+                    url: sandbox.getConfig().documentRestoreUrl(data.document_id),

                     data: formData,
                     data: formData,

-                    success: function(data) {
-                        Object.keys(data)
+                    success: function(ajax_data) {
+                        Object.keys(ajax_data)

                             .filter(function(key) {
                                 return key !== 'document';
                             })
                             .forEach(function(key) {
                             .filter(function(key) {
                                 return key !== 'document';
                             })
                             .forEach(function(key) {

-                                documentProperties = data[key];
+                                wlxmlDocument.setProperty(key, ajax_data[key]);
+                                // ugly, but whatever
+                                data[key] = ajax_data[key];

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

-                        wlxmlDocument.loadXML(data.document);
+                        wlxmlDocument.loadXML(ajax_data.document);

                         documentDirty = false;
                         documentDirty = false;

-                        sandbox.publish('documentReverted', data.version);
+                        sandbox.publish('documentReverted', ajax_data.version);
+                        event.success();
+                    },
+                });
+            });
+            dialog.show();
+        },
+        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();
                     },
                 });
                         event.success();
                     },
                 });


@@ -278,14 +339,8 @@ return function(sandbox) {
             draftDirty = false;
             logger.debug('Draft dropped');
             sandbox.publish('draftDropped');
             draftDirty = false;
             logger.debug('Draft dropped');
             sandbox.publish('draftDropped');

-        },
-        getDocumentId: function() {
-            return document_id;
-        },
-        getDocumentProperties: function() {
-            return documentProperties;

         }
     };
 };
 
         }
     };
 };
 

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