src/editor/modules/data/data.js

   1 define([
   2     'libs/jquery',
   3     'views/dialog/dialog',
   4     'wlxml/wlxml',
   5     'wlxml/extensions/list/list',
   6     'fnpjs/logging/logging',
   7     'fnpjs/datetime',
   8     './document'
   9 ], function($, Dialog, wlxml, listExtension, logging, datetime, Document) {
  10
  11 'use strict';
  12 /* global gettext, alert, window */
  13
  14 var logger = logging.getLogger('editor.modules.data');
  15
  16
  17 return function(sandbox) {
  18
  19     var data = sandbox.getBootstrappedData(),
  20         documentDirty = false,
  21         draftDirty = false,
  22         wlxmlDocument;
  23
  24
  25     var loadDocument = function(text, isDraft, draftTimestamp) {
  26         logger.debug('loading document');
  27         var xmlValid = true;
  28         try {
  29             wlxmlDocument = wlxml.WLXMLDocumentFromXML(text, {editorConfig: sandbox.getConfig()}, Document.Document);
  30         } catch(e) {
  31             logger.exception(e);
  32             alert(gettext('The content of this document seems to be invalid - only XML source editing will be possible. :(')); // TODO
  33             wlxmlDocument = wlxml.WLXMLDocumentFromXML(text, {}, Document.DumbDocument);
  34             xmlValid = false;
  35         }
  36
  37         Object.keys(data)
  38             .filter(function(key) {
  39                 return key !== 'history' && key !== 'document';
  40             })
  41             .forEach(function(key) {
  42                 wlxmlDocument.setProperty(key, data[key]);
  43             });
  44
  45         wlxmlDocument.registerExtension(listExtension);
  46         sandbox.getPlugins().forEach(function(plugin) {
  47             if(plugin.documentExtension) {
  48                 wlxmlDocument.registerExtension(plugin.documentExtension);
  49             }
  50         });
  51
  52         var modificationFlag = true;
  53         var handleChange = function() {
  54             documentDirty = true;
  55             draftDirty = true;
  56             modificationFlag = true;
  57         };
  58         wlxmlDocument.on('change', handleChange);
  59         wlxmlDocument.on('contentSet', handleChange);
  60
  61         if(window.localStorage) {
  62             window.setInterval(function() {
  63                 var timestamp = datetime.currentStrfmt(),
  64                     key = getLocalStorageKey();
  65                 if(modificationFlag) {
  66                     modificationFlag = false;
  67                     return;
  68                 }
  69                 if(wlxmlDocument && documentDirty && draftDirty) {
  70                     logger.debug('Saving draft to local storage.');
  71                     sandbox.publish('savingStarted', 'local');
  72                     window.localStorage.setItem(key.content, wlxmlDocument.toXML());
  73                     window.localStorage.setItem(key.contentTimestamp, timestamp);
  74                     sandbox.publish('savingEnded', 'success', 'local', {timestamp: timestamp});
  75                     draftDirty = false;
  76                 }
  77             }, sandbox.getConfig().autoSaveInterval || 2500);
  78         }
  79         sandbox.publish('ready', isDraft, draftTimestamp, xmlValid);
  80     };
  81
  82     function readCookie(name) {
  83         /* global escape, unescape, document */
  84         var nameEQ = escape(name) + '=';
  85         var ca = document.cookie.split(';');
  86         for (var i = 0; i < ca.length; i++) {
  87             var c = ca[i];
  88             while (c.charAt(0) === ' ') {
  89                 c = c.substring(1, c.length);
  90             }
  91             if (c.indexOf(nameEQ) === 0) {
  92                 return unescape(c.substring(nameEQ.length, c.length));
  93             }
  94         }
  95         return null;
  96     }
  97
  98     $.ajaxSetup({
  99         crossDomain: false,
 100         beforeSend: function(xhr, settings) {
 101             if (!(/^(GET|HEAD|OPTIONS|TRACE)$/.test(settings.type))) {
 102                 xhr.setRequestHeader('X-CSRFToken', readCookie('csrftoken'));
 103             }
 104         }
 105     });
 106
 107     var reloadHistory = function() {
 108         $.ajax({
 109             method: 'get',
 110             url: sandbox.getConfig().documentHistoryUrl(data.document_id),
 111             success: function(history) {
 112                 data.history = history;
 113                 sandbox.publish('historyItemAdded', history.slice(-1)[0]);
 114             },
 115         });
 116     };
 117
 118     var getLocalStorageKey = function(forVersion) {
 119         var base = 'draft-id:' + data.document_id + '-ver:' + (forVersion || wlxmlDocument.properties.version);
 120         return {
 121             content: base,
 122             contentTimestamp: base + '-content-timestamp'
 123         };
 124     };
 125
 126
 127     return {
 128         start: function() {
 129             var text;
 130             if(window.localStorage) {
 131                 text = window.localStorage.getItem(getLocalStorageKey(data.version).content);
 132
 133                 var timestamp = window.localStorage.getItem(getLocalStorageKey(data.version).contentTimestamp),
 134                     usingDraft;
 135                 if(text) {
 136                     logger.debug('Local draft exists');
 137                     var dialog = Dialog.create({
 138                         title: gettext('Local draft of a document exists'),
 139                         text: gettext('Unsaved local draft of this version of the document exists in your browser. Do you want to load it instead?'),
 140                         executeButtonText: gettext('Yes, restore local draft'),
 141                         cancelButtonText: gettext('No, use version loaded from the server')
 142                     });
 143                     dialog.on('cancel', function() {
 144                         logger.debug('Bootstrapped version chosen');
 145                         usingDraft = false;
 146                         text = sandbox.getBootstrappedData().document;
 147
 148                     });
 149                     dialog.on('execute', function(event) {
 150                         logger.debug('Local draft chosen');
 151                         usingDraft = true;
 152                         event.success();
 153                     });
 154                     dialog.show();
 155                     dialog.on('close', function() {
 156                         loadDocument(text, usingDraft, timestamp);
 157                     });
 158                 } else {
 159                     loadDocument(sandbox.getBootstrappedData().document, false);
 160                 }
 161             } else {
 162                 loadDocument(sandbox.getBootstrappedData().document, false);
 163             }
 164         },
 165         getDocument: function() {
 166             return wlxmlDocument;
 167         },
 168         saveDocument: function() {
 169             var documentSaveForm = $.extend({
 170                         fields: [],
 171                         content_field_name: 'text',
 172                         version_field_name: 'version'
 173                     },
 174                     sandbox.getConfig().documentSaveForm
 175                 ),
 176                 dialog = Dialog.create({
 177                     fields: documentSaveForm.fields,
 178                     title: gettext('Save Document'),
 179                     executeButtonText: gettext('Save'),
 180                     cancelButtonText: gettext('Cancel')
 181                 });
 182
 183             dialog.on('execute', function(event) {
 184                 sandbox.publish('savingStarted', 'remote');
 185
 186                 var formData = event.formData;
 187                 formData[documentSaveForm.content_field_name] = wlxmlDocument.toXML();
 188                 formData[documentSaveForm.version_field_name] = wlxmlDocument.properties.version;
 189                 if(sandbox.getConfig().jsonifySentData) {
 190                     formData = JSON.stringify(formData);
 191                 }
 192
 193                 dialog.toggleButtons(false);
 194                 $.ajax({
 195                     method: 'post',
 196                     url: sandbox.getConfig().documentSaveUrl(data.document_id),
 197                     data: formData,
 198                     success: function(data) {
 199                         event.success();
 200                         sandbox.publish('savingEnded', 'success', 'remote', data);
 201
 202                         Object.keys(data)
 203                             .filter(function(key) {
 204                                 return key !== 'text';
 205                             })
 206                             .forEach(function(key) {
 207                                 wlxmlDocument.setProperty(key, data[key]);
 208                             });
 209
 210                         reloadHistory();
 211                     },
 212                     error: function() {event.error(); sandbox.publish('savingEnded', 'error', 'remote');}
 213                 });
 214             });
 215             dialog.on('cancel', function() {
 216             });
 217             dialog.show();
 218
 219
 220         },
 221         getHistory: function() {
 222             return data.history;
 223         },
 224         fetchDiff: function(ver1, ver2) {
 225             $.ajax({
 226                 method: 'get',
 227                 url: sandbox.getConfig().documentDiffUrl(data.document_id),
 228                 data: {from: ver1, to: ver2},
 229                 success: function(data) {
 230                     sandbox.publish('diffFetched', {table: data, ver1: ver1, ver2: ver2});
 231                 },
 232             });
 233         },
 234         restoreVersion: function(version) {
 235             var documentRestoreForm = $.extend({
 236                         fields: [],
 237                         version_field_name: 'version'
 238                     },
 239                     sandbox.getConfig().documentRestoreForm
 240                 ),
 241                 dialog = Dialog.create({
 242                     fields: documentRestoreForm.fields,
 243                     title: gettext('Restore Version'),
 244                     executeButtonText: gettext('Restore'),
 245                     cancelButtonText: gettext('Cancel')
 246                 });
 247
 248             dialog.on('execute', function(event) {
 249                 var formData = event.formData;
 250                 formData[documentRestoreForm.version_field_name] = version;
 251                 sandbox.publish('restoringStarted', {version: version});
 252                 if(sandbox.getConfig().jsonifySentData) {
 253                     formData = JSON.stringify(formData);
 254                 }
 255                 $.ajax({
 256                     method: 'post',
 257                     dataType: 'json',
 258                     url: sandbox.getConfig().documentRestoreUrl(data.document_id),
 259                     data: formData,
 260                     success: function(data) {
 261                         Object.keys(data)
 262                             .filter(function(key) {
 263                                 return key !== 'document';
 264                             })
 265                             .forEach(function(key) {
 266                                 wlxmlDocument.setProperty(key, data[key]);
 267                             });
 268                         reloadHistory();
 269                         wlxmlDocument.loadXML(data.document);
 270                         documentDirty = false;
 271                         sandbox.publish('documentReverted', data.version);
 272                         event.success();
 273                     },
 274                 });
 275             });
 276             dialog.show();
 277         },
 278         dropDraft: function() {
 279             logger.debug('Dropping a draft...');
 280             wlxmlDocument.loadXML(sandbox.getBootstrappedData().document);
 281             draftDirty = false;
 282             logger.debug('Draft dropped');
 283             sandbox.publish('draftDropped');
 284         }
 285     };
 286 };
 287
 288 });