src/editor/modules/rng/rng.js

   1 define([
   2 './documentSummary',
   3 'libs/underscore',
   4 'fnpjs/layout',
   5 'fnpjs/logging/logging',
   6 'views/tabs/tabs',
   7 'libs/text!./mainLayout.html',
   8 'libs/text!./editingLayout.html',
   9 'libs/text!./diffLayout.html',
  10 ], function(documentSummary, _, layout, logging, tabs, mainLayoutTemplate, visualEditingLayoutTemplate, diffLayoutTemplate) {
  11
  12 'use strict';
  13
  14 return function(sandbox) {
  15
  16     /* globals gettext */
  17
  18     var logger = logging.getLogger('editor.modules.rng');
  19
  20     function addMainTab(title, slug, view) {
  21         views.mainTabs.addTab(title, slug, view);
  22     }
  23
  24     var commands = {
  25         refreshCanvasSelection: function(selection) {
  26             var fragment = selection.toDocumentFragment();
  27             sandbox.getModule('documentToolbar').setDocumentFragment(fragment);
  28         },
  29     };
  30
  31
  32     var views = {
  33         mainLayout: new layout.Layout(mainLayoutTemplate),
  34         mainTabs: (new tabs.View()).render(),
  35         visualEditing: new layout.Layout(visualEditingLayoutTemplate),
  36         diffLayout: new layout.Layout(diffLayoutTemplate)
  37     };
  38
  39     addMainTab(gettext('Editor'), 'editor', views.visualEditing.getAsView());
  40     addMainTab(gettext('Source'), 'sourceEditor',  '');
  41     addMainTab(gettext('History'), 'history', views.diffLayout.getAsView());
  42
  43     sandbox.getDOM().append(views.mainLayout.getAsView());
  44
  45     var wlxmlDocument, documentIsDirty;
  46
  47     /* Events handling */
  48
  49     var eventHandlers = {};
  50
  51     eventHandlers.sourceEditor = {
  52         ready: function() {
  53             addMainTab(gettext('Source'), 'sourceEditor',  sandbox.getModule('sourceEditor').getView());
  54             sandbox.getModule('sourceEditor').setDocument(sandbox.getModule('data').getDocument());
  55         }
  56     };
  57
  58     eventHandlers.data = {
  59         ready: function(usingDraft, draftTimestamp, xmlValid) {
  60             wlxmlDocument = sandbox.getModule('data').getDocument();
  61
  62             views.mainLayout.setView('mainView', views.mainTabs.getAsView());
  63
  64             documentSummary.init(sandbox.getConfig().documentSummaryView, wlxmlDocument);
  65             documentSummary.render();
  66             documentSummary.setDraftField(usingDraft ? (draftTimestamp || '???') : '-');
  67             sandbox.getModule('mainBar').setSummaryView(documentSummary.dom);
  68
  69             sandbox.getModule('mainBar').setCommandEnabled('drop-draft', usingDraft);
  70             sandbox.getModule('mainBar').setCommandEnabled('save', usingDraft);
  71
  72
  73             var toStart = ['sourceEditor', 'documentToolbar', 'mainBar', 'indicator', 'documentHistory', 'diffViewer', 'statusBar'];
  74             if(xmlValid) {
  75                 toStart.push('documentCanvas');
  76             }
  77             _.each(toStart, function(moduleName) {
  78                 sandbox.getModule(moduleName).start();
  79             });
  80
  81             documentIsDirty = false;
  82             wlxmlDocument.on('change', function() {
  83                 documentIsDirty = true;
  84                 sandbox.getModule('mainBar').setCommandEnabled('save', true);
  85             });
  86             wlxmlDocument.on('contentSet', function() {
  87                 documentIsDirty = true;
  88             });
  89         },
  90         draftDropped: function() {
  91             documentSummary.setDraftField('-');
  92             sandbox.getModule('mainBar').setCommandEnabled('drop-draft', false);
  93             sandbox.getModule('mainBar').setCommandEnabled('save', false);
  94         },
  95         savingStarted: function(what) {
  96             var msg = {
  97                 remote: gettext('Saving document'),
  98                 local: gettext('Saving local copy')
  99             };
 100             sandbox.getModule('mainBar').setCommandEnabled('save', false);
 101             sandbox.getModule('indicator').showMessage(msg[what] + '...');
 102         },
 103         savingEnded: function(status, what, data) {
 104             void(status);
 105             var msg = {
 106                 remote: gettext('Document saved'),
 107                 local: gettext('Local copy saved')
 108             };
 109             documentIsDirty = false;
 110
 111             sandbox.getModule('indicator').clearMessage({message: msg[what]});
 112             if(status === 'success' && what === 'remote') {
 113                 documentSummary.setDraftField('-');
 114                 sandbox.getModule('mainBar').setCommandEnabled('drop-draft', false);
 115                 sandbox.getModule('mainBar').setCommandEnabled('save', false);
 116             }
 117             if(what === 'local') {
 118                 documentSummary.setDraftField(data.timestamp);
 119                 sandbox.getModule('mainBar').setCommandEnabled('drop-draft', true);
 120                 sandbox.getModule('mainBar').setCommandEnabled('save', true);
 121             }
 122         },
 123         restoringStarted: function(event) {
 124             sandbox.getModule('mainBar').setCommandEnabled('save', false);
 125             sandbox.getModule('indicator').showMessage(gettext('Restoring version ') + event.version + '...');
 126         },
 127         historyItemAdded: function(item) {
 128             sandbox.getModule('documentHistory').addHistory([item], {animate: true});
 129         },
 130         diffFetched: function(diff) {
 131             sandbox.getModule('diffViewer').setDiff(diff);
 132         },
 133         documentReverted: function(version) {
 134             documentIsDirty = false;
 135             sandbox.getModule('indicator').clearMessage({message:'Revision restored'});
 136         },
 137         publishingStarted: function(version) {
 138             sandbox.getModule('indicator').showMessage(gettext('Publishing...'));
 139         },
 140         documentPublished: function(version) {
 141             sandbox.getModule('indicator').clearMessage({message:'Published.'});
 142         }
 143     };
 144
 145     eventHandlers.mainBar = {
 146         ready: function() {
 147             views.mainLayout.setView('topPanel', sandbox.getModule('mainBar').getView());
 148         },
 149         'cmd.save': function() {
 150             var sourceEditor = sandbox.getModule('sourceEditor');
 151             if(!sourceEditor.changesCommited()) {
 152                 logger.debug('Source editor has uncommited changes, commiting...');
 153                 sourceEditor.commitChanges();
 154             }
 155             sandbox.getModule('data').saveDocument();
 156         },
 157         'cmd.drop-draft': function() {
 158             sandbox.getModule('data').dropDraft();
 159         }
 160     };
 161
 162     eventHandlers.indicator = {
 163         ready: function() {
 164             views.mainLayout.setView('messages', sandbox.getModule('indicator').getView());
 165         }
 166     };
 167
 168
 169
 170     eventHandlers.documentCanvas = {
 171         ready: function() {
 172             sandbox.getModule('documentCanvas').setDocument(sandbox.getModule('data').getDocument());
 173             views.visualEditing.setView('leftColumn', sandbox.getModule('documentCanvas').getView());
 174         },
 175
 176         selectionChanged: function(selection) {
 177             commands.refreshCanvasSelection(selection);
 178         }
 179     };
 180
 181     eventHandlers.documentToolbar = {
 182         ready: function() {
 183             views.visualEditing.setView('toolbar', sandbox.getModule('documentToolbar').getView());
 184             sandbox.getModule('documentToolbar').setCanvas(sandbox.getModule('documentCanvas').getCanvas());
 185         },
 186         actionExecuted: function(action, ret) {
 187             sandbox.getModule('documentCanvas').onAfterActionExecuted(action, ret);
 188         }
 189     };
 190
 191     eventHandlers.documentHistory = {
 192         ready: function() {
 193             sandbox.getModule('documentHistory').addHistory(sandbox.getModule('data').getHistory());
 194             views.diffLayout.setView('left', sandbox.getModule('documentHistory').getView());
 195         },
 196         compare: function(ver1, ver2) {
 197             sandbox.getModule('data').fetchDiff(ver1, ver2);
 198         },
 199         restoreVersion: function(version) {
 200             sandbox.getModule('data').restoreVersion(version);
 201         },
 202         displayVersion: function(revision) {
 203             /* globals window */
 204             //window.open(sandbox.getConfig().documentPreviewUrl(revision), _.uniqueId());
 205             window.open(sandbox.getConfig().documentPreviewUrl(revision), 'preview');
 206         },
 207         publishVersion: function(version) {
 208             sandbox.getModule('data').publishVersion(version);
 209         }
 210     };
 211
 212     eventHandlers.diffViewer = {
 213         ready: function() {
 214             views.diffLayout.setView('right', sandbox.getModule('diffViewer').getView());
 215         }
 216     };
 217
 218     eventHandlers.statusBar = {
 219         ready: function() {
 220             views.mainLayout.setView('bottomPanel', sandbox.getModule('statusBar').getView());
 221         }
 222     };
 223
 224     eventHandlers.__all__ = {
 225         actionHovered: function(action) {
 226             sandbox.getModule('statusBar').showAction(action);
 227         },
 228         actionOff: function() {
 229             sandbox.getModule('statusBar').clearAction();
 230         }
 231     };
 232
 233     window.addEventListener('beforeunload', function(event) {
 234         var txt = gettext('Do you really want to exit?');
 235         if(documentIsDirty) {
 236             txt += ' ' + gettext('Document contains unsaved changes!');
 237         }
 238         event.returnValue = txt; // FF
 239         return txt; // Chrome
 240     });
 241
 242     /* api */
 243
 244     return {
 245         start: function() {
 246             sandbox.registerActionsAppObject({
 247                 getUser: function() {
 248                     return sandbox.getConfig().user;
 249                 }
 250             });
 251             sandbox.getModule('data').start();
 252         },
 253         handleEvent: function(moduleName, eventName, args) {
 254             var eventRepr = moduleName + '.' + eventName;
 255             if(eventHandlers[moduleName] && eventHandlers[moduleName][eventName]) {
 256                 logger.debug('Handling event ' + eventRepr);
 257                 eventHandlers[moduleName][eventName].apply(eventHandlers, args);
 258                 return;
 259             }
 260
 261             if(eventHandlers.__all__[eventName]) {
 262                 logger.debug('Handling event ' + eventRepr);
 263                 eventHandlers.__all__[eventName].apply(eventHandlers.__all__, args);
 264                 return;
 265             }
 266
 267             logger.warning('No event handler for ' + eventRepr);
 268         }
 269     };
 270 };
 271
 272 });