src/editor/modules/documentCanvas/canvas/canvas.js

   1 define([
   2 'libs/jquery',
   3 'libs/underscore',
   4 'libs/backbone',
   5 'fnpjs/logging/logging',
   6 'modules/documentCanvas/canvas/documentElement',
   7 'modules/documentCanvas/canvas/keyboard',
   8 'modules/documentCanvas/canvas/utils',
   9 'modules/documentCanvas/canvas/wlxmlListener',
  10 'modules/documentCanvas/canvas/elementsRegister',
  11 'modules/documentCanvas/canvas/genericElement',
  12 ], function($, _, Backbone, logging, documentElement, keyboard, utils, wlxmlListener, ElementsRegister, genericElement) {
  13
  14 'use strict';
  15 /* global document:false, window:false, Node:false, gettext */
  16
  17 var logger = logging.getLogger('canvas');
  18
  19 var TextHandler = function(canvas) {this.canvas = canvas; this.buffer = null;};
  20 $.extend(TextHandler.prototype, {
  21     handle: function(node, text) {
  22         this.setText(text, node);
  23         // return;
  24         // if(!this.node) {
  25         //     this.node = node;
  26         // }
  27         // if(this.node.sameNode(node)) {
  28         //     this._ping(text);
  29         // } else {
  30         //     this.flush();
  31         //     this.node = node;
  32         //     this._ping(text);
  33         // }
  34     },
  35     _ping: _.throttle(function(text) {
  36         this.buffer = text;
  37         this.flush();
  38     }, 1000),
  39     flush: function() {
  40         if(this.buffer !== null) {
  41             this.setText(this.buffer, this.node);
  42             this.buffer = null;
  43         }
  44     },
  45     setText: function(text, node) {
  46         //this.canvas.wlxmlDocument.transform('setText', {node:node, text: text});
  47         node.document.transaction(function() {
  48             node.setText(text);
  49         }, {
  50             metadata:{
  51                 description: gettext('Changing text')
  52             }
  53         });
  54
  55     }
  56
  57 });
  58
  59
  60 var Canvas = function(wlxmlDocument, elements) {
  61     this.elementsRegister = new ElementsRegister(documentElement.DocumentNodeElement, genericElement);
  62
  63     elements = [
  64         {tag: 'section', klass: null, prototype: genericElement},
  65         {tag: 'div', klass: null, prototype: genericElement},
  66         {tag: 'header', klass: null, prototype: genericElement},
  67         {tag: 'span', klass: null, prototype: genericElement},
  68         {tag: 'aside', klass: null, prototype: genericElement}
  69     ].concat(elements || []);
  70
  71     (elements).forEach(function(elementDesc) {
  72         this.elementsRegister.register(elementDesc);
  73     }.bind(this));
  74     this.eventBus = _.extend({}, Backbone.Events);
  75     this.wrapper = $('<div>').addClass('canvas-wrapper').attr('contenteditable', true);
  76     this.wlxmlListener = wlxmlListener.create(this);
  77     this.loadWlxmlDocument(wlxmlDocument);
  78     this.setupEventHandling();
  79     this.textHandler = new TextHandler(this);
  80 };
  81
  82 $.extend(Canvas.prototype, Backbone.Events, {
  83
  84     loadWlxmlDocument: function(wlxmlDocument) {
  85         if(!wlxmlDocument) {
  86             return false;
  87         }
  88
  89         this.wlxmlListener.listenTo(wlxmlDocument);
  90         this.wlxmlDocument = wlxmlDocument;
  91         this.reloadRoot();
  92     },
  93
  94     createElement: function(wlxmlNode) {
  95         var Factory;
  96         if(wlxmlNode.nodeType === Node.TEXT_NODE) {
  97             Factory = documentElement.DocumentTextElement;
  98         } else {
  99             Factory = this.elementsRegister.getElement({tag: wlxmlNode.getTagName(), klass: wlxmlNode.getClass()});
 100         }
 101         return new Factory(wlxmlNode, this);
 102     },
 103
 104     getDocumentElement: function(htmlElement) {
 105         /* globals HTMLElement, Text */
 106         if(!htmlElement || !(htmlElement instanceof HTMLElement || htmlElement instanceof Text)) {
 107             return null;
 108         }
 109         var $element = $(htmlElement);
 110         if(htmlElement.nodeType === Node.ELEMENT_NODE && $element.attr('document-node-element') !== undefined) {
 111             return $element.data('canvas-element');
 112         }
 113
 114         if(htmlElement.nodeType === Node.TEXT_NODE && $element.parent().attr('document-text-element') !== undefined) {
 115             $element = $element.parent();
 116         }
 117
 118         if($element.attr('document-text-element') !== undefined || (htmlElement.nodeType === Node.TEXT_NODE && $element.parent().attr('document-text-element') !== undefined)) {
 119             //return DocumentTextElement.fromHTMLElement(htmlElement, canvas);
 120             return $element.data('canvas-element');
 121         }
 122     },
 123
 124     reloadRoot: function() {
 125         this.rootElement = this.createElement(this.wlxmlDocument.root);
 126         this.wrapper.empty();
 127         this.wrapper.append(this.rootElement.dom());
 128     },
 129
 130     setupEventHandling: function() {
 131         var canvas = this;
 132
 133         this.wrapper.on('keyup keydown keypress', function(e) {
 134             keyboard.handleKey(e, canvas);
 135         });
 136
 137         this.wrapper.on('mouseup', function() {
 138             canvas.triggerSelectionChanged();
 139         });
 140
 141         var mouseDown;
 142         this.wrapper.on('mousedown', '[document-node-element], [document-text-element]', function(e) {
 143             mouseDown = e.target;
 144         });
 145
 146         this.wrapper.on('click', '[document-node-element], [document-text-element]', function(e) {
 147             e.stopPropagation();
 148             if(e.originalEvent.detail === 3) {
 149                 e.preventDefault();
 150                 canvas._moveCaretToTextElement(canvas.getDocumentElement(e.currentTarget), 'whole');
 151             } else {
 152                 if(mouseDown === e.target) {
 153                     canvas.setCurrentElement(canvas.getDocumentElement(e.currentTarget), {caretTo: false});
 154                 }
 155             }
 156         });
 157
 158         this.wrapper.on('paste', function(e) {
 159             e.preventDefault();
 160
 161             var clipboardData = e.originalEvent.clipboardData;
 162             if(!clipboardData || !clipboardData.getData) {
 163                 return; // TODO: alert
 164             }
 165
 166             var text = clipboardData.getData('text/plain').replace(/\r?\n|\r/g, ' '),
 167                 cursor = canvas.getCursor(),
 168                 element = cursor.getPosition().element,
 169                 lhs, rhs;
 170
 171             if(element && cursor.isWithinElement()) {
 172                 lhs = element.getText().substr(0, cursor.getSelectionStart().offset);
 173                 rhs = element.getText().substr(cursor.getSelectionEnd().offset);
 174                 element.setText(lhs+text+rhs);
 175                 canvas.setCurrentElement(element, {caretTo: lhs.length + text.length});
 176             } else {
 177                 /* jshint noempty:false */
 178                 // TODO: alert
 179             }
 180         });
 181
 182         /* globals MutationObserver */
 183         var observer = new MutationObserver(function(mutations) {
 184             mutations.forEach(function(mutation) {
 185                 if(documentElement.DocumentTextElement.isContentContainer(mutation.target)) {
 186                     observer.disconnect();
 187                     if(mutation.target.data === '') {
 188                         mutation.target.data = utils.unicode.ZWS;
 189                     }
 190                     else if(mutation.oldValue === utils.unicode.ZWS) {
 191                         mutation.target.data = mutation.target.data.replace(utils.unicode.ZWS, '');
 192                         canvas._moveCaretToTextElement(canvas.getDocumentElement(mutation.target), 'end');
 193                     }
 194                     observer.observe(canvas.wrapper[0], config);
 195
 196                     var textElement = canvas.getDocumentElement(mutation.target),
 197                         toSet = mutation.target.data !== utils.unicode.ZWS ? mutation.target.data : '';
 198
 199                     //textElement.data('wlxmlNode').setText(toSet);
 200                     //textElement.data('wlxmlNode').document.transform('setText', {node: textElement.data('wlxmlNode'), text: toSet});
 201                     if(textElement.wlxmlNode.getText() !== toSet) {
 202                         canvas.textHandler.handle(textElement.wlxmlNode, toSet);
 203                     }
 204                 }
 205             });
 206         });
 207         var config = { attributes: false, childList: false, characterData: true, subtree: true, characterDataOldValue: true};
 208         observer.observe(this.wrapper[0], config);
 209
 210
 211         this.wrapper.on('mouseover', '[document-node-element], [document-text-element]', function(e) {
 212             var el = canvas.getDocumentElement(e.currentTarget);
 213             if(!el) {
 214                 return;
 215             }
 216             e.stopPropagation();
 217             if(el instanceof documentElement.DocumentTextElement) {
 218                 el = el.parent();
 219             }
 220             el.toggleLabel(true);
 221         });
 222         this.wrapper.on('mouseout', '[document-node-element], [document-text-element]', function(e) {
 223             var el = canvas.getDocumentElement(e.currentTarget);
 224             if(!el) {
 225                 return;
 226             }
 227             e.stopPropagation();
 228             if(el instanceof documentElement.DocumentTextElement) {
 229                 el = el.parent();
 230             }
 231             el.toggleLabel(false);
 232         });
 233
 234         this.eventBus.on('elementToggled', function(toggle, element) {
 235             if(!toggle) {
 236                 canvas.setCurrentElement(element.getPreviousTextElement());
 237             }
 238         });
 239     },
 240
 241     view: function() {
 242         return this.wrapper;
 243     },
 244
 245     doc: function() {
 246         return this.rootElement;
 247     },
 248
 249     toggleElementHighlight: function(node, toggle) {
 250         var element = utils.findCanvasElement(node);
 251         element.toggleHighlight(toggle);
 252     },
 253
 254     getCursor: function() {
 255         return new Cursor(this);
 256     },
 257
 258
 259     getCurrentNodeElement: function() {
 260         var htmlElement = this.wrapper.find('.current-node-element').parent()[0];
 261         if(htmlElement) {
 262             return this.getDocumentElement(htmlElement);
 263         }
 264     },
 265
 266     getCurrentTextElement: function() {
 267         var htmlElement = this.wrapper.find('.current-text-element')[0];
 268         if(htmlElement) {
 269             return this.getDocumentElement(htmlElement);
 270         }
 271     },
 272
 273     contains: function(element) {
 274         return element.dom().parents().index(this.wrapper) !== -1;
 275     },
 276
 277     triggerSelectionChanged: function() {
 278         this.trigger('selectionChanged', this.getSelection());
 279     },
 280
 281     getSelection: function() {
 282         return new Selection(this);
 283     },
 284
 285     setCurrentElement: function(element, params) {
 286         if(!element) {
 287             logger.debug('Invalid element passed to setCurrentElement: ' + element);
 288             return;
 289         }
 290
 291         if(!(element instanceof documentElement.DocumentElement)) {
 292             element = utils.findCanvasElement(element);
 293         }
 294
 295         if(!element || !this.contains(element)) {
 296             logger.warning('Cannot set current element: element doesn\'t exist on canvas');
 297             return;
 298         }
 299
 300         params = _.extend({caretTo: 'end'}, params);
 301         var findFirstDirectTextChild = function(e, nodeToLand) {
 302             var byBrowser = this.getCursor().getPosition().element;
 303             if(byBrowser && byBrowser.parent().sameNode(nodeToLand)) {
 304                 return byBrowser;
 305             }
 306             var children = e.children();
 307             for(var i = 0; i < children.length; i++) {
 308                 if(children[i] instanceof documentElement.DocumentTextElement) {
 309                     return children[i];
 310                 }
 311             }
 312             return null;
 313         }.bind(this);
 314         var _markAsCurrent = function(element) {
 315             if(element instanceof documentElement.DocumentTextElement) {
 316                 this.wrapper.find('.current-text-element').removeClass('current-text-element');
 317                 element.dom().addClass('current-text-element');
 318             } else {
 319                 this.wrapper.find('.current-node-element').removeClass('current-node-element');
 320                 element._container().addClass('current-node-element');
 321             }
 322         }.bind(this);
 323
 324
 325         var isTextElement = element instanceof documentElement.DocumentTextElement,
 326             nodeElementToLand = isTextElement ? element.parent() : element,
 327             textElementToLand = isTextElement ? element : findFirstDirectTextChild(element, nodeElementToLand),
 328             currentTextElement = this.getCurrentTextElement(),
 329             currentNodeElement = this.getCurrentNodeElement();
 330
 331         if(currentTextElement && !(currentTextElement.sameNode(textElementToLand))) {
 332             this.wrapper.find('.current-text-element').removeClass('current-text-element');
 333         }
 334
 335         if(textElementToLand) {
 336             _markAsCurrent(textElementToLand);
 337             if(params.caretTo || !textElementToLand.sameNode(this.getCursor().getPosition().element)) {
 338                 this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
 339             }
 340         } else {
 341             document.getSelection().removeAllRanges();
 342         }
 343
 344         if(!(currentNodeElement && currentNodeElement.sameNode(nodeElementToLand))) {
 345             _markAsCurrent(nodeElementToLand);
 346         }
 347         this.triggerSelectionChanged();
 348     },
 349
 350     _moveCaretToTextElement: function(element, where) {
 351         var range = document.createRange(),
 352             node = element.dom().contents()[0];
 353
 354         if(typeof where !== 'number') {
 355             range.selectNodeContents(node);
 356         } else {
 357             range.setStart(node, Math.min(node.data.length, where));
 358         }
 359
 360         if(where !== 'whole') {
 361             var collapseArg = true;
 362             if(where === 'end') {
 363                 collapseArg = false;
 364             }
 365             range.collapse(collapseArg);
 366         }
 367         var selection = document.getSelection();
 368
 369         selection.removeAllRanges();
 370         selection.addRange(range);
 371         this.wrapper.focus(); // FF requires this for caret to be put where range colllapses, Chrome doesn't.
 372     },
 373
 374     setCursorPosition: function(position) {
 375         if(position.element) {
 376             this._moveCaretToTextElement(position.element, position.offset);
 377         }
 378     },
 379
 380     findCanvasElement: function(node) {
 381         return utils.findCanvasElement(node);
 382     },
 383
 384     toggleGrid: function() {
 385         this.wrapper.toggleClass('grid-on');
 386         this.trigger('changed');
 387     },
 388     isGridToggled: function() {
 389         return this.wrapper.hasClass('grid-on');
 390     }
 391 });
 392
 393
 394 var isText = function(node) {
 395     return node && node.nodeType === Node.TEXT_NODE && $(node.parentNode).is('[document-text-element]');
 396 };
 397
 398 var Selection = function(canvas) {
 399     this.canvas = canvas;
 400     var nativeSelection = this.nativeSelection = window.getSelection();
 401     Object.defineProperty(this, 'type', {
 402         get: function() {
 403             if(nativeSelection.focusNode) {
 404                 if(nativeSelection.isCollapsed && isText(nativeSelection.focusNode)) {
 405                     return 'caret';
 406                 }
 407                 if(isText(nativeSelection.focusNode) && isText(nativeSelection.anchorNode)) {
 408                     return 'textSelection';
 409                 }
 410             }
 411             if(canvas.getCurrentNodeElement()) {
 412                 return 'node';
 413             }
 414         }
 415     });
 416 };
 417
 418 $.extend(Selection.prototype, {
 419     toDocumentFragment: function() {
 420         var doc = this.canvas.wlxmlDocument,
 421             anchorElement = this.canvas.getDocumentElement(this.nativeSelection.anchorNode),
 422             focusElement = this.canvas.getDocumentElement(this.nativeSelection.focusNode),
 423             anchorNode = anchorElement ? anchorElement.wlxmlNode : null,
 424             focusNode = focusElement ? focusElement.wlxmlNode : null;
 425         if(this.type === 'caret') {
 426             return doc.createFragment(doc.CaretFragment, {node: anchorNode, offset: this.nativeSelection.anchorOffset});
 427         }
 428         if(this.type === 'textSelection') {
 429             if(anchorNode.isSiblingOf(focusNode)) {
 430                 return doc.createFragment(doc.TextRangeFragment, {
 431                     node1: anchorNode,
 432                     offset1: this.nativeSelection.anchorOffset,
 433                     node2: focusNode,
 434                     offset2: this.nativeSelection.focusOffset,
 435                 });
 436             }
 437             else {
 438                 var siblingParents = doc.getSiblingParents({node1: anchorNode, node2: focusNode});
 439                 return doc.createFragment(doc.RangeFragment, {
 440                     node1: siblingParents.node1,
 441                     node2: siblingParents.node2
 442                 });
 443             }
 444         }
 445         if(this.type === 'node') {
 446             return doc.createFragment(doc.NodeFragment, {node: this.canvas.getCurrentNodeElement().wlxmlNode});
 447         }
 448     },
 449     sameAs: function(other) {
 450         void(other);
 451     }
 452 });
 453
 454 var Cursor = function(canvas) {
 455     this.canvas = canvas;
 456     this.selection = window.getSelection();
 457 };
 458
 459 $.extend(Cursor.prototype, {
 460     sameAs: function(other) {
 461         var same = true;
 462         if(!other) {
 463             return false;
 464         }
 465
 466         ['focusNode', 'focusOffset', 'anchorNode', 'anchorOffset'].some(function(prop) {
 467             same = same && this.selection[prop] === other.selection[prop];
 468             if(!same) {
 469                 return true; // break
 470             }
 471         }.bind(this));
 472
 473         return same;
 474     },
 475     isSelecting: function() {
 476         var selection = window.getSelection();
 477         return !selection.isCollapsed;
 478     },
 479     isSelectingWithinElement: function() {
 480         return this.isSelecting() && this.getSelectionStart().element.sameNode(this.getSelectionEnd().element);
 481     },
 482     isWithinElement: function() {
 483         return !this.isSelecting() || this.isSelectingWithinElement();
 484     },
 485     isSelectingSiblings: function() {
 486         return this.isSelecting() && this.getSelectionStart().element.parent().sameNode(this.getSelectionEnd().element.parent());
 487     },
 488     getPosition: function() {
 489         return this.getSelectionAnchor();
 490     },
 491     getSelectionStart: function() {
 492         return this.getSelectionBoundry('start');
 493     },
 494     getSelectionEnd: function() {
 495         return this.getSelectionBoundry('end');
 496     },
 497     getSelectionAnchor: function() {
 498         return this.getSelectionBoundry('anchor');
 499     },
 500     getSelectionFocus: function() {
 501         return this.getSelectionBoundry('focus');
 502     },
 503     getSelectionBoundry: function(which) {
 504         /* globals window */
 505         var selection = window.getSelection(),
 506             anchorElement = this.canvas.getDocumentElement(selection.anchorNode),
 507             focusElement = this.canvas.getDocumentElement(selection.focusNode);
 508
 509         if((!anchorElement) || (anchorElement instanceof documentElement.DocumentNodeElement) || (!focusElement) || focusElement instanceof documentElement.DocumentNodeElement) {
 510             return {};
 511         }
 512
 513         if(which === 'anchor') {
 514             return {
 515                 element: anchorElement,
 516                 offset: selection.anchorOffset,
 517                 offsetAtBeginning: selection.anchorOffset === 0 || anchorElement.getText() === '',
 518                 offsetAtEnd: selection.anchorNode.data.length === selection.anchorOffset || anchorElement.getText() === ''
 519             };
 520         }
 521         if(which === 'focus') {
 522             return {
 523                 element: focusElement,
 524                 offset: selection.focusOffset,
 525                 offsetAtBeginning: selection.focusOffset === 0 || focusElement.getText() === '',
 526                 offsetAtEnd: selection.focusNode.data.length === selection.focusOffset || focusElement.getText() === '',
 527             };
 528         }
 529
 530         var getPlaceData = function(anchorFirst) {
 531             var element, offset;
 532             if(anchorFirst) {
 533                 if(which === 'start') {
 534                     element = anchorElement;
 535                     offset = selection.anchorOffset;
 536                 }
 537                 else if(which === 'end') {
 538                     element = focusElement;
 539                     offset = selection.focusOffset;
 540                 }
 541             } else {
 542                 if(which === 'start') {
 543                     element = focusElement;
 544                     offset = selection.focusOffset;
 545                 }
 546                 else if(which === 'end') {
 547                     element = anchorElement;
 548                     offset = selection.anchorOffset;
 549                 }
 550             }
 551             return {element: element, offset: offset};
 552         };
 553
 554         var anchorFirst, placeData, parent;
 555
 556         if(anchorElement.parent().sameNode(focusElement.parent())) {
 557             parent = anchorElement.parent();
 558             if(selection.anchorNode === selection.focusNode) {
 559                 anchorFirst = selection.anchorOffset <= selection.focusOffset;
 560             } else {
 561                 anchorFirst = parent.childIndex(anchorElement) < parent.childIndex(focusElement);
 562             }
 563             placeData = getPlaceData(anchorFirst);
 564         } else {
 565             /*jshint bitwise: false*/
 566             anchorFirst = selection.anchorNode.compareDocumentPosition(selection.focusNode) & Node.DOCUMENT_POSITION_FOLLOWING;
 567             placeData = getPlaceData(anchorFirst);
 568         }
 569
 570         var nodeLen = (placeData.element.sameNode(focusElement) ? selection.focusNode : selection.anchorNode).length;
 571         return {
 572             element: placeData.element,
 573             offset: placeData.offset,
 574             offsetAtBeginning: placeData.offset === 0 || focusElement.getText() === '',
 575             offsetAtEnd: nodeLen === placeData.offset || focusElement.getText() === ''
 576         };
 577     }
 578 });
 579
 580 return {
 581     fromXMLDocument: function(wlxmlDocument, elements) {
 582         return new Canvas(wlxmlDocument, elements);
 583     }
 584 };
 585
 586 });