editor: fixing, refactoring, improving styling in choice exercises

[fnpeditor.git] / src / editor / modules / rng / rng.js

diff --git a/src/editor/modules/rng/rng.js b/src/editor/modules/rng/rng.js
index 05e0620..fc8cd61 100644 (file)
--- a/src/editor/modules/rng/rng.js
+++ b/src/editor/modules/rng/rng.js
@@ -1,53 +1,31 @@
 define([
 define([

+'./documentSummary',

 'libs/underscore',
 'fnpjs/layout',
 'libs/underscore',
 'fnpjs/layout',

-'fnpjs/vbox',
+'fnpjs/logging/logging',

 'views/tabs/tabs',
 'libs/text!./mainLayout.html',
 'libs/text!./editingLayout.html',
 'libs/text!./diffLayout.html',
 'views/tabs/tabs',
 'libs/text!./mainLayout.html',
 'libs/text!./editingLayout.html',
 'libs/text!./diffLayout.html',

-], function(_, layout, vbox, tabs, mainLayoutTemplate, visualEditingLayoutTemplate, diffLayoutTemplate) {
+], function(documentSummary, _, layout, logging, tabs, mainLayoutTemplate, visualEditingLayoutTemplate, diffLayoutTemplate) {

 
 'use strict';
 
 return function(sandbox) {
 
     /* globals gettext */
 
 'use strict';
 
 return function(sandbox) {
 
     /* globals gettext */

+
+    var logger = logging.getLogger('editor.modules.rng');

     
     function addMainTab(title, slug, view) {
         views.mainTabs.addTab(title, slug, view);
     }
      
     var commands = {
     
     function addMainTab(title, slug, view) {
         views.mainTabs.addTab(title, slug, view);
     }
      
     var commands = {

-        highlightDocumentElement: function(element, origin) {
-            ///'nodeBreadCrumbs', 'nodeFamilyTree'
-            ['documentCanvas', 'nodeFamilyTree'].forEach(function(moduleName) {
-                if(!origin || moduleName !== origin) {
-                    sandbox.getModule(moduleName).highlightElement(element);
-                }
-            });
+        refreshCanvasSelection: function(selection) {
+            var fragment = selection.toDocumentFragment();
+            sandbox.getModule('documentToolbar').setDocumentFragment(fragment);

         },
         },

-        dimDocumentElement: function(element, origin) {
-            //'nodeBreadCrumbs', 'nodeFamilyTree'
-            ['documentCanvas', 'nodeFamilyTree'].forEach(function(moduleName) {
-                if(!origin || moduleName !== origin) {
-                    sandbox.getModule(moduleName).dimElement(element);
-                }
-            });
-        },
-        jumpToDocumentElement: function(element) {
-            sandbox.getModule('documentCanvas').jumpToElement(element);
-        },
-        updateCurrentNodeElement: function(nodeElement) {
-            sandbox.getModule('nodePane').setNodeElement(nodeElement);
-            sandbox.getModule('nodeFamilyTree').setElement(nodeElement);
-            sandbox.getModule('nodeBreadCrumbs').setNodeElement(nodeElement);
-            sandbox.getModule('documentToolbar').setNodeElement(nodeElement);
-            sandbox.getModule('metadataEditor').setNodeElement(nodeElement);
-        },
-        updateCurrentTextElement: function(textElement) {
-            sandbox.getModule('nodeFamilyTree').setElement(textElement);
-        }

     };
     
 
     };
     
 


@@ -55,20 +33,15 @@ return function(sandbox) {
         mainLayout: new layout.Layout(mainLayoutTemplate),
         mainTabs: (new tabs.View()).render(),
         visualEditing: new layout.Layout(visualEditingLayoutTemplate),
         mainLayout: new layout.Layout(mainLayoutTemplate),
         mainTabs: (new tabs.View()).render(),
         visualEditing: new layout.Layout(visualEditingLayoutTemplate),

-        visualEditingSidebar: (new tabs.View({stacked: true})).render(),
-        currentNodePaneLayout: new vbox.VBox(),

         diffLayout: new layout.Layout(diffLayoutTemplate)
     };
     
         diffLayout: new layout.Layout(diffLayoutTemplate)
     };
     

-    views.visualEditing.setView('rightColumn', views.visualEditingSidebar.getAsView());

     addMainTab(gettext('Editor'), 'editor', views.visualEditing.getAsView());
     addMainTab(gettext('Source'), 'sourceEditor',  '');
     addMainTab(gettext('History'), 'history', views.diffLayout.getAsView());
     
     sandbox.getDOM().append(views.mainLayout.getAsView());
     
     addMainTab(gettext('Editor'), 'editor', views.visualEditing.getAsView());
     addMainTab(gettext('Source'), 'sourceEditor',  '');
     addMainTab(gettext('History'), 'history', views.diffLayout.getAsView());
     
     sandbox.getDOM().append(views.mainLayout.getAsView());
     

-    views.visualEditingSidebar.addTab({icon: 'pencil'}, 'edit', views.currentNodePaneLayout.getAsView());
-

     var wlxmlDocument, documentIsDirty;
     
     /* Events handling */
     var wlxmlDocument, documentIsDirty;
     
     /* Events handling */


@@ -83,22 +56,42 @@ return function(sandbox) {
     };
     
     eventHandlers.data = {
     };
     
     eventHandlers.data = {

-        ready: function() {
+        ready: function(usingDraft, draftTimestamp, xmlValid) {
+            wlxmlDocument = sandbox.getModule('data').getDocument();
+

             views.mainLayout.setView('mainView', views.mainTabs.getAsView());
             
             views.mainLayout.setView('mainView', views.mainTabs.getAsView());
             

-            _.each(['sourceEditor', 'documentCanvas', 'documentToolbar', 'nodePane', 'metadataEditor', 'nodeFamilyTree', 'nodeBreadCrumbs', 'mainBar', 'indicator', 'documentHistory', 'diffViewer'], function(moduleName) {
+            documentSummary.init(sandbox.getConfig().documentSummaryView, wlxmlDocument);
+            documentSummary.render();
+            documentSummary.setDraftField(usingDraft ? (draftTimestamp || '???') : '-');
+            sandbox.getModule('mainBar').setSummaryView(documentSummary.dom);
+
+            sandbox.getModule('mainBar').setCommandEnabled('drop-draft', usingDraft);
+            sandbox.getModule('mainBar').setCommandEnabled('save', usingDraft);
+
+            
+            var toStart = ['sourceEditor', 'documentToolbar', 'mainBar', 'indicator', 'documentHistory', 'diffViewer', 'statusBar'];
+            if(xmlValid) {
+                toStart.push('documentCanvas');
+            }
+            _.each(toStart, function(moduleName) {

                 sandbox.getModule(moduleName).start();
             });
             
                 sandbox.getModule(moduleName).start();
             });
             

-            wlxmlDocument = sandbox.getModule('data').getDocument();

             documentIsDirty = false;
             wlxmlDocument.on('change', function() {
                 documentIsDirty = true;
             documentIsDirty = false;
             wlxmlDocument.on('change', function() {
                 documentIsDirty = true;

+                sandbox.getModule('mainBar').setCommandEnabled('save', true);

             });
             wlxmlDocument.on('contentSet', function() {
                 documentIsDirty = true;
             });
         },
             });
             wlxmlDocument.on('contentSet', function() {
                 documentIsDirty = true;
             });
         },

+        draftDropped: function() {
+            documentSummary.setDraftField('-');
+            sandbox.getModule('mainBar').setCommandEnabled('drop-draft', false);
+            sandbox.getModule('mainBar').setCommandEnabled('save', false);
+        },

         savingStarted: function(what) {
             var msg = {
                 remote: gettext('Saving document'),
         savingStarted: function(what) {
             var msg = {
                 remote: gettext('Saving document'),


@@ -107,16 +100,25 @@ return function(sandbox) {
             sandbox.getModule('mainBar').setCommandEnabled('save', false);
             sandbox.getModule('indicator').showMessage(msg[what] + '...');
         },
             sandbox.getModule('mainBar').setCommandEnabled('save', false);
             sandbox.getModule('indicator').showMessage(msg[what] + '...');
         },

-        savingEnded: function(status, what, current_version) {
+        savingEnded: function(status, what, data) {

             void(status);
             var msg = {
                 remote: gettext('Document saved'),
                 local: gettext('Local copy saved')
             };
             documentIsDirty = false;
             void(status);
             var msg = {
                 remote: gettext('Document saved'),
                 local: gettext('Local copy saved')
             };
             documentIsDirty = false;

-            sandbox.getModule('mainBar').setCommandEnabled('save', true);
+            

             sandbox.getModule('indicator').clearMessage({message: msg[what]});
             sandbox.getModule('indicator').clearMessage({message: msg[what]});

-            sandbox.getModule('mainBar').setVersion(current_version);
+            if(status === 'success' && what === 'remote') {
+                documentSummary.setDraftField('-');
+                sandbox.getModule('mainBar').setCommandEnabled('drop-draft', false);
+                sandbox.getModule('mainBar').setCommandEnabled('save', false);
+            }
+            if(what === 'local') {
+                documentSummary.setDraftField(data.timestamp);
+                sandbox.getModule('mainBar').setCommandEnabled('drop-draft', true);
+                sandbox.getModule('mainBar').setCommandEnabled('save', true);
+            }

         },
         restoringStarted: function(event) {
             sandbox.getModule('mainBar').setCommandEnabled('save', false);
         },
         restoringStarted: function(event) {
             sandbox.getModule('mainBar').setCommandEnabled('save', false);


@@ -130,23 +132,24 @@ return function(sandbox) {
         },
         documentReverted: function(version) {
             documentIsDirty = false;
         },
         documentReverted: function(version) {
             documentIsDirty = false;

-            sandbox.getModule('mainBar').setCommandEnabled('save', true);

             sandbox.getModule('indicator').clearMessage({message:'Wersja ' + version + ' przywrócona'});
             sandbox.getModule('indicator').clearMessage({message:'Wersja ' + version + ' przywrócona'});

-            sandbox.getModule('mainBar').setVersion(version);

         }
     };
     
     eventHandlers.mainBar = {
         ready: function() {
         }
     };
     
     eventHandlers.mainBar = {
         ready: function() {

-            sandbox.getModule('mainBar').setVersion(sandbox.getModule('data').getDocumentVersion());

             views.mainLayout.setView('topPanel', sandbox.getModule('mainBar').getView());
         },
         'cmd.save': function() {
             var sourceEditor = sandbox.getModule('sourceEditor');
             if(!sourceEditor.changesCommited()) {
             views.mainLayout.setView('topPanel', sandbox.getModule('mainBar').getView());
         },
         'cmd.save': function() {
             var sourceEditor = sandbox.getModule('sourceEditor');
             if(!sourceEditor.changesCommited()) {

+                logger.debug('Source editor has uncommited changes, commiting...');

                 sourceEditor.commitChanges();
             }
             sandbox.getModule('data').saveDocument();
                 sourceEditor.commitChanges();
             }
             sandbox.getModule('data').saveDocument();

+        },
+        'cmd.drop-draft': function() {
+            sandbox.getModule('data').dropDraft();

         }
     };
     
         }
     };
     


@@ -164,80 +167,18 @@ return function(sandbox) {
             views.visualEditing.setView('leftColumn', sandbox.getModule('documentCanvas').getView());
         },
         
             views.visualEditing.setView('leftColumn', sandbox.getModule('documentCanvas').getView());
         },
         

-        currentTextElementSet: function(textElement) {
-            commands.updateCurrentTextElement(textElement);
-        },
-
-        currentNodeElementSet: function(nodeElement) {
-            commands.updateCurrentNodeElement(nodeElement);
-        },
-        
-        currentNodeElementChanged: function(nodeElement) {
-            commands.updateCurrentNodeElement(nodeElement);
-        },
-
-        nodeHovered: function(canvasNode) {
-            commands.highlightDocumentNode(canvasNode);
-        },
-        
-        nodeBlured: function(canvasNode) {
-            commands.dimDocumentNode(canvasNode);
-        }
-    };
-
-    eventHandlers.nodePane = {
-        ready: function() {
-            views.currentNodePaneLayout.appendView(sandbox.getModule('nodePane').getView());
-        },
-        
-        nodeElementChange: function(attr, value) {
-            sandbox.getModule('documentCanvas').modifyCurrentNodeElement(attr, value);
-        }
-    };
-    
-    eventHandlers.metadataEditor = {
-        ready: function() {
-            sandbox.getModule('metadataEditor').setDocument(sandbox.getModule('data').getDocument());
-            views.visualEditingSidebar.addTab({icon: 'info-sign'}, 'metadataEditor', sandbox.getModule('metadataEditor').getView());
-        }
-    };
-    
-    eventHandlers.nodeFamilyTree = {
-        ready: function() {
-            views.currentNodePaneLayout.appendView(sandbox.getModule('nodeFamilyTree').getView());
-        },
-        nodeEntered: function(node) {
-            commands.highlightDocumentElement(node, 'nodeFamilyTree');
-        },
-        nodeLeft: function(node) {
-            commands.dimDocumentElement(node, 'nodeFamilyTree');
-        },
-        nodeClicked: function(node) {
-            commands.jumpToDocumentElement(node);
+        selectionChanged: function(selection) {
+            commands.refreshCanvasSelection(selection);

         }
     };
     
     eventHandlers.documentToolbar = {
         ready: function() {
             views.visualEditing.setView('toolbar', sandbox.getModule('documentToolbar').getView());
         }
     };
     
     eventHandlers.documentToolbar = {
         ready: function() {
             views.visualEditing.setView('toolbar', sandbox.getModule('documentToolbar').getView());

+            sandbox.getModule('documentToolbar').setCanvas(sandbox.getModule('documentCanvas').getCanvas());

         },
         },

-        command: function(cmd, params) {
-            sandbox.getModule('documentCanvas').command(cmd, params);
-        }
-    };
-    
-    eventHandlers.nodeBreadCrumbs = {
-        ready: function() {
-            views.visualEditing.setView('statusBar', sandbox.getModule('nodeBreadCrumbs').getView());
-        },
-        elementEntered: function(element) {
-            commands.highlightDocumentElement(element, 'nodeBreadCrumbs');
-        },
-        elementLeft: function(element) {
-            commands.dimDocumentElement(element, 'nodeBreadCrumbs');
-        },
-        elementClicked: function(element) {
-            commands.jumpToDocumentElement(element);
+        actionExecuted: function(action, ret) {
+            sandbox.getModule('documentCanvas').onAfterActionExecuted(action, ret);

         }
     };
     
         }
     };
     


@@ -254,7 +195,14 @@ return function(sandbox) {
         },
         displayVersion: function(event) {
             /* globals window */
         },
         displayVersion: function(event) {
             /* globals window */

-            window.open('/' + gettext('editor') + '/' + sandbox.getModule('data').getDocumentId() + '?version=' + event.version, _.uniqueId());
+            var config = sandbox.getConfig(),
+                doc = sandbox.getModule('data').getDocument();
+
+            if(config.documentUrl) {
+                window.open(config.documentUrl(doc.properties.document_id, event.version), _.uniqueId());
+            } else {
+                logger.error('Unable to show version ' + event.version + ' of a document - config.documentUrl missing');
+            }

         }
     };
     
         }
     };
     


@@ -264,6 +212,21 @@ return function(sandbox) {
         }
     };
 
         }
     };
 

+    eventHandlers.statusBar = {
+        ready: function() {
+            views.mainLayout.setView('bottomPanel', sandbox.getModule('statusBar').getView());
+        }
+    };
+
+    eventHandlers.__all__ = {
+        actionHovered: function(action) {
+            sandbox.getModule('statusBar').showAction(action);
+        },
+        actionOff: function() {
+            sandbox.getModule('statusBar').clearAction();
+        }
+    };
+

     window.addEventListener('beforeunload', function(event) {
         var txt = gettext('Do you really want to exit?');
         if(documentIsDirty) {
     window.addEventListener('beforeunload', function(event) {
         var txt = gettext('Do you really want to exit?');
         if(documentIsDirty) {


@@ -277,12 +240,28 @@ return function(sandbox) {
     
     return {
         start: function() {
     
     return {
         start: function() {

+            sandbox.registerActionsAppObject({
+                getUser: function() {
+                    return sandbox.getConfig().user;
+                }
+            });

             sandbox.getModule('data').start();
         },
         handleEvent: function(moduleName, eventName, args) {
             sandbox.getModule('data').start();
         },
         handleEvent: function(moduleName, eventName, args) {

+            var eventRepr = moduleName + '.' + eventName;

             if(eventHandlers[moduleName] && eventHandlers[moduleName][eventName]) {
             if(eventHandlers[moduleName] && eventHandlers[moduleName][eventName]) {

+                logger.debug('Handling event ' + eventRepr);

                 eventHandlers[moduleName][eventName].apply(eventHandlers, args);
                 eventHandlers[moduleName][eventName].apply(eventHandlers, args);

+                return;
+            }
+
+            if(eventHandlers.__all__[eventName]) {
+                logger.debug('Handling event ' + eventRepr);
+                eventHandlers.__all__[eventName].apply(eventHandlers.__all__, args);
+                return;

             }
             }

+
+            logger.warning('No event handler for ' + eventRepr);

         }
     };
 };
         }
     };
 };