4680aeff25460661cbf3e9df0e409fa81f0e4e2e
[moodle.git] / lib / editor / atto / yui / build / moodle-editor_atto-editor / moodle-editor_atto-editor.js
1 YUI.add('moodle-editor_atto-editor', function (Y, NAME) {
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /* eslint-disable no-unused-vars */
19 /**
20  * The Atto WYSIWG pluggable editor, written for Moodle.
21  *
22  * @module     moodle-editor_atto-editor
23  * @package    editor_atto
24  * @copyright  2013 Damyon Wiese  <damyon@moodle.com>
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  * @main       moodle-editor_atto-editor
27  */
29 /**
30  * @module moodle-editor_atto-editor
31  * @submodule editor-base
32  */
34 var LOGNAME = 'moodle-editor_atto-editor';
35 var CSS = {
36         CONTENT: 'editor_atto_content',
37         CONTENTWRAPPER: 'editor_atto_content_wrap',
38         TOOLBAR: 'editor_atto_toolbar',
39         WRAPPER: 'editor_atto',
40         HIGHLIGHT: 'highlight'
41     },
42     rangy = window.rangy;
44 /**
45  * The Atto editor for Moodle.
46  *
47  * @namespace M.editor_atto
48  * @class Editor
49  * @constructor
50  * @uses M.editor_atto.EditorClean
51  * @uses M.editor_atto.EditorFilepicker
52  * @uses M.editor_atto.EditorSelection
53  * @uses M.editor_atto.EditorStyling
54  * @uses M.editor_atto.EditorTextArea
55  * @uses M.editor_atto.EditorToolbar
56  * @uses M.editor_atto.EditorToolbarNav
57  */
59 function Editor() {
60     Editor.superclass.constructor.apply(this, arguments);
61 }
63 Y.extend(Editor, Y.Base, {
65     /**
66      * List of known block level tags.
67      * Taken from "https://developer.mozilla.org/en-US/docs/HTML/Block-level_elements".
68      *
69      * @property BLOCK_TAGS
70      * @type {Array}
71      */
72     BLOCK_TAGS : [
73         'address',
74         'article',
75         'aside',
76         'audio',
77         'blockquote',
78         'canvas',
79         'dd',
80         'div',
81         'dl',
82         'fieldset',
83         'figcaption',
84         'figure',
85         'footer',
86         'form',
87         'h1',
88         'h2',
89         'h3',
90         'h4',
91         'h5',
92         'h6',
93         'header',
94         'hgroup',
95         'hr',
96         'noscript',
97         'ol',
98         'output',
99         'p',
100         'pre',
101         'section',
102         'table',
103         'tfoot',
104         'ul',
105         'video'
106     ],
108     PLACEHOLDER_CLASS: 'atto-tmp-class',
109     ALL_NODES_SELECTOR: '[style],font[face]',
110     FONT_FAMILY: 'fontFamily',
112     /**
113      * The wrapper containing the editor.
114      *
115      * @property _wrapper
116      * @type Node
117      * @private
118      */
119     _wrapper: null,
121     /**
122      * A reference to the content editable Node.
123      *
124      * @property editor
125      * @type Node
126      */
127     editor: null,
129     /**
130      * A reference to the original text area.
131      *
132      * @property textarea
133      * @type Node
134      */
135     textarea: null,
137     /**
138      * A reference to the label associated with the original text area.
139      *
140      * @property textareaLabel
141      * @type Node
142      */
143     textareaLabel: null,
145     /**
146      * A reference to the list of plugins.
147      *
148      * @property plugins
149      * @type object
150      */
151     plugins: null,
153     /**
154      * Event Handles to clear on editor destruction.
155      *
156      * @property _eventHandles
157      * @private
158      */
159     _eventHandles: null,
161     initializer: function() {
162         var template;
164         // Note - it is not safe to use a CSS selector like '#' + elementid because the id
165         // may have colons in it - e.g.  quiz.
166         this.textarea = Y.one(document.getElementById(this.get('elementid')));
168         if (!this.textarea) {
169             // No text area found.
170             return;
171         }
173         this._eventHandles = [];
175         this._wrapper = Y.Node.create('<div class="' + CSS.WRAPPER + '" />');
176         template = Y.Handlebars.compile('<div id="{{elementid}}editable" ' +
177                 'contenteditable="true" ' +
178                 'role="textbox" ' +
179                 'spellcheck="true" ' +
180                 'aria-live="off" ' +
181                 'class="{{CSS.CONTENT}}" ' +
182                 '/>');
183         this.editor = Y.Node.create(template({
184             elementid: this.get('elementid'),
185             CSS: CSS
186         }));
188         // Add a labelled-by attribute to the contenteditable.
189         this.textareaLabel = Y.one('[for="' + this.get('elementid') + '"]');
190         if (this.textareaLabel) {
191             this.textareaLabel.generateID();
192             this.editor.setAttribute('aria-labelledby', this.textareaLabel.get("id"));
193         }
195         // Add everything to the wrapper.
196         this.setupToolbar();
198         // Editable content wrapper.
199         var content = Y.Node.create('<div class="' + CSS.CONTENTWRAPPER + '" />');
200         content.appendChild(this.editor);
201         this._wrapper.appendChild(content);
203         // Style the editor. According to the styles.css: 20 is the line-height, 8 is padding-top + padding-bottom.
204         this.editor.setStyle('minHeight', ((20 * this.textarea.getAttribute('rows')) + 8) + 'px');
206         if (Y.UA.ie === 0) {
207             // We set a height here to force the overflow because decent browsers allow the CSS property resize.
208             this.editor.setStyle('height', ((20 * this.textarea.getAttribute('rows')) + 8) + 'px');
209         }
211         // Disable odd inline CSS styles.
212         this.disableCssStyling();
214         // Use paragraphs not divs.
215         if (document.queryCommandSupported('DefaultParagraphSeparator')) {
216             document.execCommand('DefaultParagraphSeparator', false, 'p');
217         }
219         // Add the toolbar and editable zone to the page.
220         this.textarea.get('parentNode').insert(this._wrapper, this.textarea).
221                 setAttribute('class', 'editor_atto_wrap');
223         // Hide the old textarea.
224         this.textarea.hide();
226         // Copy the text to the contenteditable div.
227         this.updateFromTextArea();
229         // Publish the events that are defined by this editor.
230         this.publishEvents();
232         // Add handling for saving and restoring selections on cursor/focus changes.
233         this.setupSelectionWatchers();
235         // Add polling to update the textarea periodically when typing long content.
236         this.setupAutomaticPolling();
238         // Setup plugins.
239         this.setupPlugins();
241         // Initialize the auto-save timer.
242         this.setupAutosave();
243         // Preload the icons for the notifications.
244         this.setupNotifications();
245     },
247     /**
248      * Focus on the editable area for this editor.
249      *
250      * @method focus
251      * @chainable
252      */
253     focus: function() {
254         this.editor.focus();
256         return this;
257     },
259     /**
260      * Publish events for this editor instance.
261      *
262      * @method publishEvents
263      * @private
264      * @chainable
265      */
266     publishEvents: function() {
267         /**
268          * Fired when changes are made within the editor.
269          *
270          * @event change
271          */
272         this.publish('change', {
273             broadcast: true,
274             preventable: true
275         });
277         /**
278          * Fired when all plugins have completed loading.
279          *
280          * @event pluginsloaded
281          */
282         this.publish('pluginsloaded', {
283             fireOnce: true
284         });
286         this.publish('atto:selectionchanged', {
287             prefix: 'atto'
288         });
290         return this;
291     },
293     /**
294      * Set up automated polling of the text area to update the textarea.
295      *
296      * @method setupAutomaticPolling
297      * @chainable
298      */
299     setupAutomaticPolling: function() {
300         this._registerEventHandle(this.editor.on(['keyup', 'cut'], this.updateOriginal, this));
301         this._registerEventHandle(this.editor.on('paste', this.pasteCleanup, this));
303         // Call this.updateOriginal after dropped content has been processed.
304         this._registerEventHandle(this.editor.on('drop', this.updateOriginalDelayed, this));
306         return this;
307     },
309     /**
310      * Calls updateOriginal on a short timer to allow native event handlers to run first.
311      *
312      * @method updateOriginalDelayed
313      * @chainable
314      */
315     updateOriginalDelayed: function() {
316         Y.soon(Y.bind(this.updateOriginal, this));
318         return this;
319     },
321     setupPlugins: function() {
322         // Clear the list of plugins.
323         this.plugins = {};
325         var plugins = this.get('plugins');
327         var groupIndex,
328             group,
329             pluginIndex,
330             plugin,
331             pluginConfig;
333         for (groupIndex in plugins) {
334             group = plugins[groupIndex];
335             if (!group.plugins) {
336                 // No plugins in this group - skip it.
337                 continue;
338             }
339             for (pluginIndex in group.plugins) {
340                 plugin = group.plugins[pluginIndex];
342                 pluginConfig = Y.mix({
343                     name: plugin.name,
344                     group: group.group,
345                     editor: this.editor,
346                     toolbar: this.toolbar,
347                     host: this
348                 }, plugin);
350                 // Add a reference to the current editor.
351                 if (typeof Y.M['atto_' + plugin.name] === "undefined") {
352                     continue;
353                 }
354                 this.plugins[plugin.name] = new Y.M['atto_' + plugin.name].Button(pluginConfig);
355             }
356         }
358         // Some plugins need to perform actions once all plugins have loaded.
359         this.fire('pluginsloaded');
361         return this;
362     },
364     enablePlugins: function(plugin) {
365         this._setPluginState(true, plugin);
366     },
368     disablePlugins: function(plugin) {
369         this._setPluginState(false, plugin);
370     },
372     _setPluginState: function(enable, plugin) {
373         var target = 'disableButtons';
374         if (enable) {
375             target = 'enableButtons';
376         }
378         if (plugin) {
379             this.plugins[plugin][target]();
380         } else {
381             Y.Object.each(this.plugins, function(currentPlugin) {
382                 currentPlugin[target]();
383             }, this);
384         }
385     },
387     /**
388      * Register an event handle for disposal in the destructor.
389      *
390      * @method _registerEventHandle
391      * @param {EventHandle} The Event Handle as returned by Y.on, and Y.delegate.
392      * @private
393      */
394     _registerEventHandle: function(handle) {
395         this._eventHandles.push(handle);
396     }
398 }, {
399     NS: 'editor_atto',
400     ATTRS: {
401         /**
402          * The unique identifier for the form element representing the editor.
403          *
404          * @attribute elementid
405          * @type String
406          * @writeOnce
407          */
408         elementid: {
409             value: null,
410             writeOnce: true
411         },
413         /**
414          * The contextid of the form.
415          *
416          * @attribute contextid
417          * @type Integer
418          * @writeOnce
419          */
420         contextid: {
421             value: null,
422             writeOnce: true
423         },
425         /**
426          * Plugins with their configuration.
427          *
428          * The plugins structure is:
429          *
430          *     [
431          *         {
432          *             "group": "groupName",
433          *             "plugins": [
434          *                 "pluginName": {
435          *                     "configKey": "configValue"
436          *                 },
437          *                 "pluginName": {
438          *                     "configKey": "configValue"
439          *                 }
440          *             ]
441          *         },
442          *         {
443          *             "group": "groupName",
444          *             "plugins": [
445          *                 "pluginName": {
446          *                     "configKey": "configValue"
447          *                 }
448          *             ]
449          *         }
450          *     ]
451          *
452          * @attribute plugins
453          * @type Object
454          * @writeOnce
455          */
456         plugins: {
457             value: {},
458             writeOnce: true
459         }
460     }
461 });
463 // The Editor publishes custom events that can be subscribed to.
464 Y.augment(Editor, Y.EventTarget);
466 Y.namespace('M.editor_atto').Editor = Editor;
468 // Function for Moodle's initialisation.
469 Y.namespace('M.editor_atto.Editor').init = function(config) {
470     return new Y.M.editor_atto.Editor(config);
471 };
472 // This file is part of Moodle - http://moodle.org/
473 //
474 // Moodle is free software: you can redistribute it and/or modify
475 // it under the terms of the GNU General Public License as published by
476 // the Free Software Foundation, either version 3 of the License, or
477 // (at your option) any later version.
478 //
479 // Moodle is distributed in the hope that it will be useful,
480 // but WITHOUT ANY WARRANTY; without even the implied warranty of
481 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
482 // GNU General Public License for more details.
483 //
484 // You should have received a copy of the GNU General Public License
485 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
487 /**
488  * A notify function for the Atto editor.
489  *
490  * @module     moodle-editor_atto-notify
491  * @submodule  notify
492  * @package    editor_atto
493  * @copyright  2014 Damyon Wiese
494  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
495  */
497 var LOGNAME_NOTIFY = 'moodle-editor_atto-editor-notify',
498     NOTIFY_INFO = 'info',
499     NOTIFY_WARNING = 'warning';
501 function EditorNotify() {}
503 EditorNotify.ATTRS= {
504 };
506 EditorNotify.prototype = {
508     /**
509      * A single Y.Node for this editor. There is only ever one - it is replaced if a new message comes in.
510      *
511      * @property messageOverlay
512      * @type {Node}
513      */
514     messageOverlay: null,
516     /**
517      * A single timer object that can be used to cancel the hiding behaviour.
518      *
519      * @property hideTimer
520      * @type {timer}
521      */
522     hideTimer: null,
524     /**
525      * Initialize the notifications.
526      *
527      * @method setupNotifications
528      * @chainable
529      */
530     setupNotifications: function() {
531         var preload1 = new Image(),
532             preload2 = new Image();
534         preload1.src = M.util.image_url('i/warning', 'moodle');
535         preload2.src = M.util.image_url('i/info', 'moodle');
537         return this;
538     },
540     /**
541      * Show a notification in a floaty overlay somewhere in the atto editor text area.
542      *
543      * @method showMessage
544      * @param {String} message The translated message (use get_string)
545      * @param {String} type Must be either "info" or "warning"
546      * @param {Number} timeout Time in milliseconds to show this message for.
547      * @chainable
548      */
549     showMessage: function(message, type, timeout) {
550         var messageTypeIcon = '',
551             intTimeout,
552             bodyContent;
554         if (this.messageOverlay === null) {
555             this.messageOverlay = Y.Node.create('<div class="editor_atto_notification"></div>');
557             this.messageOverlay.hide(true);
558             this.textarea.get('parentNode').append(this.messageOverlay);
560             this.messageOverlay.on('click', function() {
561                 this.messageOverlay.hide(true);
562             }, this);
563         }
565         if (this.hideTimer !== null) {
566             this.hideTimer.cancel();
567         }
569         if (type === NOTIFY_WARNING) {
570             messageTypeIcon = '<img src="' +
571                               M.util.image_url('i/warning', 'moodle') +
572                               '" alt="' + M.util.get_string('warning', 'moodle') + '"/>';
573         } else if (type === NOTIFY_INFO) {
574             messageTypeIcon = '<img src="' +
575                               M.util.image_url('i/info', 'moodle') +
576                               '" alt="' + M.util.get_string('info', 'moodle') + '"/>';
577         } else {
578         }
580         // Parse the timeout value.
581         intTimeout = parseInt(timeout, 10);
582         if (intTimeout <= 0) {
583             intTimeout = 60000;
584         }
586         // Convert class to atto_info (for example).
587         type = 'atto_' + type;
589         bodyContent = Y.Node.create('<div class="' + type + '" role="alert" aria-live="assertive">' +
590                                         messageTypeIcon + ' ' +
591                                         Y.Escape.html(message) +
592                                         '</div>');
593         this.messageOverlay.empty();
594         this.messageOverlay.append(bodyContent);
595         this.messageOverlay.show(true);
597         this.hideTimer = Y.later(intTimeout, this, function() {
598             this.hideTimer = null;
599             if (this.messageOverlay.inDoc()) {
600                 this.messageOverlay.hide(true);
601             }
602         });
604         return this;
605     }
607 };
609 Y.Base.mix(Y.M.editor_atto.Editor, [EditorNotify]);
610 // This file is part of Moodle - http://moodle.org/
611 //
612 // Moodle is free software: you can redistribute it and/or modify
613 // it under the terms of the GNU General Public License as published by
614 // the Free Software Foundation, either version 3 of the License, or
615 // (at your option) any later version.
616 //
617 // Moodle is distributed in the hope that it will be useful,
618 // but WITHOUT ANY WARRANTY; without even the implied warranty of
619 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
620 // GNU General Public License for more details.
621 //
622 // You should have received a copy of the GNU General Public License
623 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
625 /**
626  * @module moodle-editor_atto-editor
627  * @submodule textarea
628  */
630 /**
631  * Textarea functions for the Atto editor.
632  *
633  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
634  *
635  * @namespace M.editor_atto
636  * @class EditorTextArea
637  */
639 function EditorTextArea() {}
641 EditorTextArea.ATTRS= {
642 };
644 EditorTextArea.prototype = {
646     /**
647      * Return the appropriate empty content value for the current browser.
648      *
649      * Different browsers use a different content when they are empty and
650      * we must set this reliable across the board.
651      *
652      * @method _getEmptyContent
653      * @return String The content to use representing no user-provided content
654      * @private
655      */
656     _getEmptyContent: function() {
657         if (Y.UA.ie && Y.UA.ie < 10) {
658             return '<p></p>';
659         } else {
660             return '<p><br></p>';
661         }
662     },
664     /**
665      * Copy and clean the text from the textarea into the contenteditable div.
666      *
667      * If the text is empty, provide a default paragraph tag to hold the content.
668      *
669      * @method updateFromTextArea
670      * @chainable
671      */
672     updateFromTextArea: function() {
673         // Clear it first.
674         this.editor.setHTML('');
676         // Copy cleaned HTML to editable div.
677         this.editor.append(this._cleanHTML(this.textarea.get('value')));
679         // Insert a paragraph in the empty contenteditable div.
680         if (this.editor.getHTML() === '') {
681             this.editor.setHTML(this._getEmptyContent());
682         }
684         return this;
685     },
687     /**
688      * Copy the text from the contenteditable to the textarea which it replaced.
689      *
690      * @method updateOriginal
691      * @chainable
692      */
693     updateOriginal : function() {
694         // Get the previous and current value to compare them.
695         var oldValue = this.textarea.get('value'),
696             newValue = this.getCleanHTML();
698         if (newValue === "" && this.isActive()) {
699             // The content was entirely empty so get the empty content placeholder.
700             newValue = this._getEmptyContent();
701         }
703         // Only call this when there has been an actual change to reduce processing.
704         if (oldValue !== newValue) {
705             // Insert the cleaned content.
706             this.textarea.set('value', newValue);
708             // Trigger the onchange callback on the textarea, essentially to notify moodle-core-formchangechecker.
709             this.textarea.simulate('change');
711             // Trigger handlers for this action.
712             this.fire('change');
713         }
715         return this;
716     }
717 };
719 Y.Base.mix(Y.M.editor_atto.Editor, [EditorTextArea]);
720 // This file is part of Moodle - http://moodle.org/
721 //
722 // Moodle is free software: you can redistribute it and/or modify
723 // it under the terms of the GNU General Public License as published by
724 // the Free Software Foundation, either version 3 of the License, or
725 // (at your option) any later version.
726 //
727 // Moodle is distributed in the hope that it will be useful,
728 // but WITHOUT ANY WARRANTY; without even the implied warranty of
729 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
730 // GNU General Public License for more details.
731 //
732 // You should have received a copy of the GNU General Public License
733 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
734 /* global NOTIFY_WARNING, NOTIFY_INFO */
735 /* eslint-disable no-unused-vars */
737 /**
738  * A autosave function for the Atto editor.
739  *
740  * @module     moodle-editor_atto-autosave
741  * @submodule  autosave-base
742  * @package    editor_atto
743  * @copyright  2014 Damyon Wiese
744  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
745  */
747 var SUCCESS_MESSAGE_TIMEOUT = 5000,
748     RECOVER_MESSAGE_TIMEOUT = 60000,
749     LOGNAME_AUTOSAVE = 'moodle-editor_atto-editor-autosave';
751 function EditorAutosave() {}
753 EditorAutosave.ATTRS= {
754     /**
755      * Enable/Disable auto save for this instance.
756      *
757      * @attribute autosaveEnabled
758      * @type Boolean
759      * @writeOnce
760      */
761     autosaveEnabled: {
762         value: true,
763         writeOnce: true
764     },
766     /**
767      * The time between autosaves (in seconds).
768      *
769      * @attribute autosaveFrequency
770      * @type Number
771      * @default 60
772      * @writeOnce
773      */
774     autosaveFrequency: {
775         value: 60,
776         writeOnce: true
777     },
779     /**
780      * Unique hash for this page instance. Calculated from $PAGE->url in php.
781      *
782      * @attribute pageHash
783      * @type String
784      * @writeOnce
785      */
786     pageHash: {
787         value: '',
788         writeOnce: true
789     }
790 };
792 EditorAutosave.prototype = {
794     /**
795      * The text that was auto saved in the last request.
796      *
797      * @property lastText
798      * @type string
799      */
800     lastText: "",
802     /**
803      * Autosave instance.
804      *
805      * @property autosaveInstance
806      * @type string
807      */
808     autosaveInstance: null,
810     /**
811      * Autosave Timer.
812      *
813      * @property autosaveTimer
814      * @type object
815      */
816     autosaveTimer: null,
818     /**
819      * Initialize the autosave process
820      *
821      * @method setupAutosave
822      * @chainable
823      */
824     setupAutosave: function() {
825         var draftid = -1,
826             form,
827             optiontype = null,
828             options = this.get('filepickeroptions'),
829             params;
831         if (!this.get('autosaveEnabled')) {
832             // Autosave disabled for this instance.
833             return;
834         }
836         this.autosaveInstance = Y.stamp(this);
837         for (optiontype in options) {
838             if (typeof options[optiontype].itemid !== "undefined") {
839                 draftid = options[optiontype].itemid;
840             }
841         }
843         // First see if there are any saved drafts.
844         // Make an ajax request.
845         params = {
846             contextid: this.get('contextid'),
847             action: 'resume',
848             draftid: draftid,
849             elementid: this.get('elementid'),
850             pageinstance: this.autosaveInstance,
851             pagehash: this.get('pageHash')
852         };
854         this.autosaveIo(params, this, {
855             success: function(response) {
856                 if (response === null) {
857                     // This can happen when there is nothing to resume from.
858                     return;
859                 } else if (!response) {
860                     return;
861                 }
863                 // Revert untouched editor contents to an empty string.
864                 // Check for FF and Chrome.
865                 if (response.result === '<p></p>' || response.result === '<p><br></p>' ||
866                     response.result === '<br>') {
867                     response.result = '';
868                 }
870                 // Check for IE 9 and 10.
871                 if (response.result === '<p>&nbsp;</p>' || response.result === '<p><br>&nbsp;</p>') {
872                     response.result = '';
873                 }
875                 if (response.error || typeof response.result === 'undefined') {
876                     this.showMessage(M.util.get_string('errortextrecovery', 'editor_atto'),
877                             NOTIFY_WARNING, RECOVER_MESSAGE_TIMEOUT);
878                 } else if (response.result !== this.textarea.get('value') &&
879                         response.result !== '') {
880                     this.recoverText(response.result);
881                 }
882                 this._fireSelectionChanged();
884             },
885             failure: function() {
886                 this.showMessage(M.util.get_string('errortextrecovery', 'editor_atto'),
887                         NOTIFY_WARNING, RECOVER_MESSAGE_TIMEOUT);
888             }
889         });
891         // Now setup the timer for periodic saves.
892         var delay = parseInt(this.get('autosaveFrequency'), 10) * 1000;
893         this.autosaveTimer = Y.later(delay, this, this.saveDraft, false, true);
895         // Now setup the listener for form submission.
896         form = this.textarea.ancestor('form');
897         if (form) {
898             this.autosaveIoOnSubmit(form, {
899                 action: 'reset',
900                 contextid: this.get('contextid'),
901                 elementid: this.get('elementid'),
902                 pageinstance: this.autosaveInstance,
903                 pagehash: this.get('pageHash')
904             });
905         }
906         return this;
907     },
909     /**
910      * Recover a previous version of this text and show a message.
911      *
912      * @method recoverText
913      * @param {String} text
914      * @chainable
915      */
916     recoverText: function(text) {
917         this.editor.setHTML(text);
918         this.saveSelection();
919         this.updateOriginal();
920         this.lastText = text;
922         this.showMessage(M.util.get_string('textrecovered', 'editor_atto'),
923                 NOTIFY_INFO, RECOVER_MESSAGE_TIMEOUT);
925         return this;
926     },
928     /**
929      * Save a single draft via ajax.
930      *
931      * @method saveDraft
932      * @chainable
933      */
934     saveDraft: function() {
935         var url, params;
937         if (!this.editor.getDOMNode()) {
938             // Stop autosaving if the editor was removed from the page.
939             this.autosaveTimer.cancel();
940             return;
941         }
942         // Only copy the text from the div to the textarea if the textarea is not currently visible.
943         if (!this.editor.get('hidden')) {
944             this.updateOriginal();
945         }
946         var newText = this.textarea.get('value');
948         if (newText !== this.lastText) {
950             // Make an ajax request.
951             url = M.cfg.wwwroot + this.get('autosaveAjaxScript');
952             params = {
953                 sesskey: M.cfg.sesskey,
954                 contextid: this.get('contextid'),
955                 action: 'save',
956                 drafttext: newText,
957                 elementid: this.get('elementid'),
958                 pagehash: this.get('pageHash'),
959                 pageinstance: this.autosaveInstance
960             };
962             // Reusable error handler - must be passed the correct context.
963             var ajaxErrorFunction = function(response) {
964                 var errorDuration = parseInt(this.get('autosaveFrequency'), 10) * 1000;
965                 this.showMessage(M.util.get_string('autosavefailed', 'editor_atto'), NOTIFY_WARNING, errorDuration);
966             };
968             this.autosaveIo(params, this, {
969                 failure: ajaxErrorFunction,
970                 success: function(response) {
971                     if (response && response.error) {
972                         Y.soon(Y.bind(ajaxErrorFunction, this, [response]));
973                     } else {
974                         // All working.
975                         this.lastText = newText;
976                         this.showMessage(M.util.get_string('autosavesucceeded', 'editor_atto'),
977                                 NOTIFY_INFO, SUCCESS_MESSAGE_TIMEOUT);
978                     }
979                 }
980             });
981         }
982         return this;
983     }
984 };
986 Y.Base.mix(Y.M.editor_atto.Editor, [EditorAutosave]);
987 // This file is part of Moodle - http://moodle.org/
988 //
989 // Moodle is free software: you can redistribute it and/or modify
990 // it under the terms of the GNU General Public License as published by
991 // the Free Software Foundation, either version 3 of the License, or
992 // (at your option) any later version.
993 //
994 // Moodle is distributed in the hope that it will be useful,
995 // but WITHOUT ANY WARRANTY; without even the implied warranty of
996 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
997 // GNU General Public License for more details.
998 //
999 // You should have received a copy of the GNU General Public License
1000 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1002 /**
1003  * A autosave function for the Atto editor.
1004  *
1005  * @module     moodle-editor_atto-autosave-io
1006  * @submodule  autosave-io
1007  * @package    editor_atto
1008  * @copyright  2016 Frédéric Massart
1009  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1010  */
1012 var EditorAutosaveIoDispatcherInstance = null;
1014 function EditorAutosaveIoDispatcher() {
1015     EditorAutosaveIoDispatcher.superclass.constructor.apply(this, arguments);
1016     this._submitEvents = {};
1017     this._queue = [];
1018     this._throttle = null;
1020 EditorAutosaveIoDispatcher.NAME = 'EditorAutosaveIoDispatcher';
1021 EditorAutosaveIoDispatcher.ATTRS = {
1023     /**
1024      * The relative path to the ajax script.
1025      *
1026      * @attribute autosaveAjaxScript
1027      * @type String
1028      * @default '/lib/editor/atto/autosave-ajax.php'
1029      * @readOnly
1030      */
1031     autosaveAjaxScript: {
1032         value: '/lib/editor/atto/autosave-ajax.php',
1033         readOnly: true
1034     },
1036     /**
1037      * The time buffer for the throttled requested.
1038      *
1039      * @attribute delay
1040      * @type Number
1041      * @default 50
1042      * @readOnly
1043      */
1044     delay: {
1045         value: 50,
1046         readOnly: true
1047     }
1049 };
1050 Y.extend(EditorAutosaveIoDispatcher, Y.Base, {
1052     /**
1053      * Dispatch an IO request.
1054      *
1055      * This method will put the requests in a queue in order to attempt to bulk them.
1056      *
1057      * @param  {Object} params    The parameters of the request.
1058      * @param  {Object} context   The context in which the callbacks are called.
1059      * @param  {Object} callbacks Object with 'success', 'complete', 'end', 'failure' and 'start' as
1060      *                            optional keys defining the callbacks to call. Success and Complete
1061      *                            functions will receive the response as parameter. Success and Complete
1062      *                            may receive an object containing the error key, use this to confirm
1063      *                            that no errors occured.
1064      * @return {Void}
1065      */
1066     dispatch: function(params, context, callbacks) {
1067         if (this._throttle) {
1068             this._throttle.cancel();
1069         }
1071         this._throttle = Y.later(this.get('delay'), this, this._processDispatchQueue);
1072         this._queue.push([params, context, callbacks]);
1073     },
1075     /**
1076      * Dispatches the requests in the queue.
1077      *
1078      * @return {Void}
1079      */
1080     _processDispatchQueue: function() {
1081         var queue = this._queue,
1082             data = {};
1084         this._queue = [];
1085         if (queue.length < 1) {
1086             return;
1087         }
1089         Y.Array.each(queue, function(item, index) {
1090             data[index] = item[0];
1091         });
1093         Y.io(M.cfg.wwwroot + this.get('autosaveAjaxScript'), {
1094             method: 'POST',
1095             data: Y.QueryString.stringify({
1096                 actions: data,
1097                 sesskey: M.cfg.sesskey
1098             }),
1099             on: {
1100                 start: this._makeIoEventCallback('start', queue),
1101                 complete: this._makeIoEventCallback('complete', queue),
1102                 failure: this._makeIoEventCallback('failure', queue),
1103                 end: this._makeIoEventCallback('end', queue),
1104                 success: this._makeIoEventCallback('success', queue)
1105             }
1106         });
1107     },
1109     /**
1110      * Creates a function that dispatches an IO response to callbacks.
1111      *
1112      * @param  {String} event The type of event.
1113      * @param  {Array} queue The queue.
1114      * @return {Function}
1115      */
1116     _makeIoEventCallback: function(event, queue) {
1117         var noop = function() {};
1118         return function() {
1119             var response = arguments[1],
1120                 parsed = {};
1122             if ((event == 'complete' || event == 'success') && (typeof response !== 'undefined'
1123                     && typeof response.responseText !== 'undefined' && response.responseText !== '')) {
1125                 // Success and complete events need to parse the response.
1126                 parsed = JSON.parse(response.responseText) || {};
1127             }
1129             Y.Array.each(queue, function(item, index) {
1130                 var context = item[1],
1131                     cb = (item[2] && item[2][event]) || noop,
1132                     arg;
1134                 if (parsed && parsed.error) {
1135                     // The response is an error, we send it to everyone.
1136                     arg = parsed;
1137                 } else if (parsed) {
1138                     // The response was parsed, we only communicate the relevant portion of the response.
1139                     arg = parsed[index];
1140                 }
1142                 cb.apply(context, [arg]);
1143             });
1144         };
1145     },
1147     /**
1148      * Form submit handler.
1149      *
1150      * @param  {EventFacade} e The event.
1151      * @return {Void}
1152      */
1153     _onSubmit: function(e) {
1154         var data = {},
1155             id = e.currentTarget.generateID(),
1156             params = this._submitEvents[id];
1158         if (!params || params.ios.length < 1) {
1159             return;
1160         }
1162         Y.Array.each(params.ios, function(param, index) {
1163             data[index] = param;
1164         });
1166         Y.io(M.cfg.wwwroot + this.get('autosaveAjaxScript'), {
1167             method: 'POST',
1168             data: Y.QueryString.stringify({
1169                 actions: data,
1170                 sesskey: M.cfg.sesskey
1171             }),
1172             sync: true
1173         });
1174     },
1176     /**
1177      * Registers a request to be made on form submission.
1178      *
1179      * @param  {Node} node The forum node we will listen to.
1180      * @param  {Object} params Parameters for the IO request.
1181      * @return {Void}
1182      */
1183     whenSubmit: function(node, params) {
1184         if (typeof this._submitEvents[node.generateID()] === 'undefined') {
1185             this._submitEvents[node.generateID()] = {
1186                 event: node.on('submit', this._onSubmit, this),
1187                 ios: []
1188             };
1189         }
1190         this._submitEvents[node.get('id')].ios.push([params]);
1191     }
1193 });
1194 EditorAutosaveIoDispatcherInstance = new EditorAutosaveIoDispatcher();
1197 function EditorAutosaveIo() {}
1198 EditorAutosaveIo.prototype = {
1200     /**
1201      * Dispatch an IO request.
1202      *
1203      * This method will put the requests in a queue in order to attempt to bulk them.
1204      *
1205      * @param  {Object} params    The parameters of the request.
1206      * @param  {Object} context   The context in which the callbacks are called.
1207      * @param  {Object} callbacks Object with 'success', 'complete', 'end', 'failure' and 'start' as
1208      *                            optional keys defining the callbacks to call. Success and Complete
1209      *                            functions will receive the response as parameter. Success and Complete
1210      *                            may receive an object containing the error key, use this to confirm
1211      *                            that no errors occured.
1212      * @return {Void}
1213      */
1214     autosaveIo: function(params, context, callbacks) {
1215         EditorAutosaveIoDispatcherInstance.dispatch(params, context, callbacks);
1216     },
1218     /**
1219      * Registers a request to be made on form submission.
1220      *
1221      * @param  {Node} form The forum node we will listen to.
1222      * @param  {Object} params Parameters for the IO request.
1223      * @return {Void}
1224      */
1225     autosaveIoOnSubmit: function(form, params) {
1226         EditorAutosaveIoDispatcherInstance.whenSubmit(form, params);
1227     }
1229 };
1230 Y.Base.mix(Y.M.editor_atto.Editor, [EditorAutosaveIo]);
1231 // This file is part of Moodle - http://moodle.org/
1232 //
1233 // Moodle is free software: you can redistribute it and/or modify
1234 // it under the terms of the GNU General Public License as published by
1235 // the Free Software Foundation, either version 3 of the License, or
1236 // (at your option) any later version.
1237 //
1238 // Moodle is distributed in the hope that it will be useful,
1239 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1240 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1241 // GNU General Public License for more details.
1242 //
1243 // You should have received a copy of the GNU General Public License
1244 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1245 /* global LOGNAME */
1247 /**
1248  * @module moodle-editor_atto-editor
1249  * @submodule clean
1250  */
1252 /**
1253  * Functions for the Atto editor to clean the generated content.
1254  *
1255  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1256  *
1257  * @namespace M.editor_atto
1258  * @class EditorClean
1259  */
1261 function EditorClean() {}
1263 EditorClean.ATTRS= {
1264 };
1266 EditorClean.prototype = {
1267     /**
1268      * Clean the generated HTML content without modifying the editor content.
1269      *
1270      * This includes removes all YUI ids from the generated content.
1271      *
1272      * @return {string} The cleaned HTML content.
1273      */
1274     getCleanHTML: function() {
1275         // Clone the editor so that we don't actually modify the real content.
1276         var editorClone = this.editor.cloneNode(true),
1277             html;
1279         // Remove all YUI IDs.
1280         Y.each(editorClone.all('[id^="yui"]'), function(node) {
1281             node.removeAttribute('id');
1282         });
1284         editorClone.all('.atto_control').remove(true);
1285         html = editorClone.get('innerHTML');
1287         // Revert untouched editor contents to an empty string.
1288         if (html === '<p></p>' || html === '<p><br></p>') {
1289             return '';
1290         }
1292         // Remove any and all nasties from source.
1293        return this._cleanHTML(html);
1294     },
1296     /**
1297      * Clean the HTML content of the editor.
1298      *
1299      * @method cleanEditorHTML
1300      * @chainable
1301      */
1302     cleanEditorHTML: function() {
1303         var startValue = this.editor.get('innerHTML');
1304         this.editor.set('innerHTML', this._cleanHTML(startValue));
1306         return this;
1307     },
1309     /**
1310      * Clean the specified HTML content and remove any content which could cause issues.
1311      *
1312      * @method _cleanHTML
1313      * @private
1314      * @param {String} content The content to clean
1315      * @return {String} The cleaned HTML
1316      */
1317     _cleanHTML: function(content) {
1318         // Removing limited things that can break the page or a disallowed, like unclosed comments, style blocks, etc.
1320         var rules = [
1321             // Remove any style blocks. Some browsers do not work well with them in a contenteditable.
1322             // Plus style blocks are not allowed in body html, except with "scoped", which most browsers don't support as of 2015.
1323             // Reference: "http://stackoverflow.com/questions/1068280/javascript-regex-multiline-flag-doesnt-work"
1324             {regex: /<style[^>]*>[\s\S]*?<\/style>/gi, replace: ""},
1326             // Remove any open HTML comment opens that are not followed by a close. This can completely break page layout.
1327             {regex: /<!--(?![\s\S]*?-->)/gi, replace: ""},
1329             // Source: "http://www.codinghorror.com/blog/2006/01/cleaning-words-nasty-html.html"
1330             // Remove forbidden tags for content, title, meta, style, st0-9, head, font, html, body, link.
1331             {regex: /<\/?(?:title|meta|style|st\d|head|font|html|body|link)[^>]*?>/gi, replace: ""}
1332         ];
1334         return this._filterContentWithRules(content, rules);
1335     },
1337     /**
1338      * Take the supplied content and run on the supplied regex rules.
1339      *
1340      * @method _filterContentWithRules
1341      * @private
1342      * @param {String} content The content to clean
1343      * @param {Array} rules An array of structures: [ {regex: /something/, replace: "something"}, {...}, ...]
1344      * @return {String} The cleaned content
1345      */
1346     _filterContentWithRules: function(content, rules) {
1347         var i = 0;
1348         for (i = 0; i < rules.length; i++) {
1349             content = content.replace(rules[i].regex, rules[i].replace);
1350         }
1352         return content;
1353     },
1355     /**
1356      * Intercept and clean html paste events.
1357      *
1358      * @method pasteCleanup
1359      * @param {Object} sourceEvent The YUI EventFacade  object
1360      * @return {Boolean} True if the passed event should continue, false if not.
1361      */
1362     pasteCleanup: function(sourceEvent) {
1363         // We only expect paste events, but we will check anyways.
1364         if (sourceEvent.type === 'paste') {
1365             // The YUI event wrapper doesn't provide paste event info, so we need the underlying event.
1366             var event = sourceEvent._event;
1367             // Check if we have a valid clipboardData object in the event.
1368             // IE has a clipboard object at window.clipboardData, but as of IE 11, it does not provide HTML content access.
1369             if (event && event.clipboardData && event.clipboardData.getData && event.clipboardData.types) {
1370                 // Check if there is HTML type to be pasted, if we can get it, we want to scrub before insert.
1371                 var types = event.clipboardData.types;
1372                 var isHTML = false;
1373                 // Different browsers use different containers to hold the types, so test various functions.
1374                 if (typeof types.contains === 'function') {
1375                     isHTML = types.contains('text/html');
1376                 } else if (typeof types.indexOf === 'function') {
1377                     isHTML = (types.indexOf('text/html') > -1);
1378                 }
1380                 if (isHTML) {
1381                     // Get the clipboard content.
1382                     var content;
1383                     try {
1384                         content = event.clipboardData.getData('text/html');
1385                     } catch (error) {
1386                         // Something went wrong. Fallback.
1387                         this.fallbackPasteCleanupDelayed();
1388                         return true;
1389                     }
1391                     // Stop the original paste.
1392                     sourceEvent.preventDefault();
1394                     // Scrub the paste content.
1395                     content = this._cleanPasteHTML(content);
1397                     // Save the current selection.
1398                     // Using saveSelection as it produces a more consistent experience.
1399                     var selection = window.rangy.saveSelection();
1401                     // Insert the content.
1402                     this.insertContentAtFocusPoint(content);
1404                     // Restore the selection, and collapse to end.
1405                     window.rangy.restoreSelection(selection);
1406                     window.rangy.getSelection().collapseToEnd();
1408                     // Update the text area.
1409                     this.updateOriginal();
1410                     return false;
1411                 } else {
1412                     // Due to poor cross browser clipboard compatibility, the failure to find html doesn't mean it isn't there.
1413                     // Wait for the clipboard event to finish then fallback clean the entire editor.
1414                     this.fallbackPasteCleanupDelayed();
1415                     return true;
1416                 }
1417             } else {
1418                 // If we reached a here, this probably means the browser has limited (or no) clipboard support.
1419                 // Wait for the clipboard event to finish then fallback clean the entire editor.
1420                 this.fallbackPasteCleanupDelayed();
1421                 return true;
1422             }
1423         }
1425         // We should never get here - we must have received a non-paste event for some reason.
1426         // Um, just call updateOriginalDelayed() - it's safe.
1427         this.updateOriginalDelayed();
1428         return true;
1429     },
1431     /**
1432      * Cleanup code after a paste event if we couldn't intercept the paste content.
1433      *
1434      * @method fallbackPasteCleanup
1435      * @chainable
1436      */
1437     fallbackPasteCleanup: function() {
1439         // Save the current selection (cursor position).
1440         var selection = window.rangy.saveSelection();
1442         // Get, clean, and replace the content in the editable.
1443         var content = this.editor.get('innerHTML');
1444         this.editor.set('innerHTML', this._cleanPasteHTML(content));
1446         // Update the textarea.
1447         this.updateOriginal();
1449         // Restore the selection (cursor position).
1450         window.rangy.restoreSelection(selection);
1452         return this;
1453     },
1455     /**
1456      * Calls fallbackPasteCleanup on a short timer to allow the paste event handlers to complete.
1457      *
1458      * @method fallbackPasteCleanupDelayed
1459      * @chainable
1460      */
1461     fallbackPasteCleanupDelayed: function() {
1462         Y.soon(Y.bind(this.fallbackPasteCleanup, this));
1464         return this;
1465     },
1467     /**
1468      * Cleanup html that comes from WYSIWYG paste events. These are more likely to contain messy code that we should strip.
1469      *
1470      * @method _cleanPasteHTML
1471      * @private
1472      * @param {String} content The html content to clean
1473      * @return {String} The cleaned HTML
1474      */
1475     _cleanPasteHTML: function(content) {
1476         // Return an empty string if passed an invalid or empty object.
1477         if (!content || content.length === 0) {
1478             return "";
1479         }
1481         // Rules that get rid of the real-nasties and don't care about normalize code (correct quotes, white spaces, etc).
1482         var rules = [
1483             // Stuff that is specifically from MS Word and similar office packages.
1484             // Remove all garbage after closing html tag.
1485             {regex: /<\s*\/html\s*>([\s\S]+)$/gi, replace: ""},
1486             // Remove if comment blocks.
1487             {regex: /<!--\[if[\s\S]*?endif\]-->/gi, replace: ""},
1488             // Remove start and end fragment comment blocks.
1489             {regex: /<!--(Start|End)Fragment-->/gi, replace: ""},
1490             // Remove any xml blocks.
1491             {regex: /<xml[^>]*>[\s\S]*?<\/xml>/gi, replace: ""},
1492             // Remove any <?xml><\?xml> blocks.
1493             {regex: /<\?xml[^>]*>[\s\S]*?<\\\?xml>/gi, replace: ""},
1494             // Remove <o:blah>, <\o:blah>.
1495             {regex: /<\/?\w+:[^>]*>/gi, replace: ""}
1496         ];
1498         // Apply the first set of harsher rules.
1499         content = this._filterContentWithRules(content, rules);
1501         // Apply the standard rules, which mainly cleans things like headers, links, and style blocks.
1502         content = this._cleanHTML(content);
1504         // Check if the string is empty or only contains whitespace.
1505         if (content.length === 0 || !content.match(/\S/)) {
1506             return content;
1507         }
1509         // Now we let the browser normalize the code by loading it into the DOM and then get the html back.
1510         // This gives us well quoted, well formatted code to continue our work on. Word may provide very poorly formatted code.
1511         var holder = document.createElement('div');
1512         holder.innerHTML = content;
1513         content = holder.innerHTML;
1514         // Free up the DOM memory.
1515         holder.innerHTML = "";
1517         // Run some more rules that care about quotes and whitespace.
1518         rules = [
1519             // Get all class attributes so we can work on them.
1520             {regex: /(<[^>]*?class\s*?=\s*?")([^>"]*)(")/gi, replace: function(match, group1, group2, group3) {
1521                     // Remove MSO classes.
1522                     group2 = group2.replace(/(?:^|[\s])[\s]*MSO[_a-zA-Z0-9\-]*/gi,"");
1523                     // Remove Apple- classes.
1524                     group2 = group2.replace(/(?:^|[\s])[\s]*Apple-[_a-zA-Z0-9\-]*/gi,"");
1525                     return group1 + group2 + group3;
1526                 }},
1527             // Remove OLE_LINK# anchors that may litter the code.
1528             {regex: /<a [^>]*?name\s*?=\s*?"OLE_LINK\d*?"[^>]*?>\s*?<\/a>/gi, replace: ""}
1529         ];
1531         // Clean all style attributes from the text.
1532         content = this._cleanStyles(content);
1534         // Apply the rules.
1535         content = this._filterContentWithRules(content, rules);
1537         // Reapply the standard cleaner to the content.
1538         content = this._cleanHTML(content);
1540         // Clean unused spans out of the content.
1541         content = this._cleanSpans(content);
1543         return content;
1544     },
1546     /**
1547      * Clean all inline styles from pasted text.
1548      *
1549      * This code intentionally doesn't use YUI Nodes. YUI was quite a bit slower at this, so using raw DOM objects instead.
1550      *
1551      * @method _cleanStyles
1552      * @private
1553      * @param {String} content The content to clean
1554      * @return {String} The cleaned HTML
1555      */
1556     _cleanStyles: function(content) {
1557         var holder = document.createElement('div');
1558         holder.innerHTML = content;
1559         var elementsWithStyle = holder.querySelectorAll('[style]');
1560         var i = 0;
1562         for (i = 0; i < elementsWithStyle.length; i++) {
1563             elementsWithStyle[i].removeAttribute('style');
1564         }
1566         var elementsWithClass = holder.querySelectorAll('[class]');
1567         for (i = 0; i < elementsWithClass.length; i++) {
1568             elementsWithClass[i].removeAttribute('class');
1569         }
1571         return holder.innerHTML;
1572     },
1573     /**
1574      * Clean empty or un-unused spans from passed HTML.
1575      *
1576      * This code intentionally doesn't use YUI Nodes. YUI was quite a bit slower at this, so using raw DOM objects instead.
1577      *
1578      * @method _cleanSpans
1579      * @private
1580      * @param {String} content The content to clean
1581      * @return {String} The cleaned HTML
1582      */
1583     _cleanSpans: function(content) {
1584         // Return an empty string if passed an invalid or empty object.
1585         if (!content || content.length === 0) {
1586             return "";
1587         }
1588         // Check if the string is empty or only contains whitespace.
1589         if (content.length === 0 || !content.match(/\S/)) {
1590             return content;
1591         }
1593         var rules = [
1594             // Remove unused class, style, or id attributes. This will make empty tag detection easier later.
1595             {regex: /(<[^>]*?)(?:[\s]*(?:class|style|id)\s*?=\s*?"\s*?")+/gi, replace: "$1"}
1596         ];
1597         // Apply the rules.
1598         content = this._filterContentWithRules(content, rules);
1600         // Reference: "http://stackoverflow.com/questions/8131396/remove-nested-span-without-id"
1602         // This is better to run detached from the DOM, so the browser doesn't try to update on each change.
1603         var holder = document.createElement('div');
1604         holder.innerHTML = content;
1605         var spans = holder.getElementsByTagName('span');
1607         // Since we will be removing elements from the list, we should copy it to an array, making it static.
1608         var spansarr = Array.prototype.slice.call(spans, 0);
1610         spansarr.forEach(function(span) {
1611             if (!span.hasAttributes()) {
1612                 // If no attributes (id, class, style, etc), this span is has no effect.
1613                 // Move each child (if they exist) to the parent in place of this span.
1614                 while (span.firstChild) {
1615                     span.parentNode.insertBefore(span.firstChild, span);
1616                 }
1618                 // Remove the now empty span.
1619                 span.parentNode.removeChild(span);
1620             }
1621         });
1623         return holder.innerHTML;
1624     }
1625 };
1627 Y.Base.mix(Y.M.editor_atto.Editor, [EditorClean]);
1628 // This file is part of Moodle - http://moodle.org/
1629 //
1630 // Moodle is free software: you can redistribute it and/or modify
1631 // it under the terms of the GNU General Public License as published by
1632 // the Free Software Foundation, either version 3 of the License, or
1633 // (at your option) any later version.
1634 //
1635 // Moodle is distributed in the hope that it will be useful,
1636 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1637 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1638 // GNU General Public License for more details.
1639 //
1640 // You should have received a copy of the GNU General Public License
1641 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1643 /**
1644  * @module moodle-editor_atto-editor
1645  * @submodule commands
1646  */
1648 /**
1649  * Selection functions for the Atto editor.
1650  *
1651  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1652  *
1653  * @namespace M.editor_atto
1654  * @class EditorCommand
1655  */
1657 function EditorCommand() {}
1659 EditorCommand.ATTRS= {
1660 };
1662 EditorCommand.prototype = {
1663     /**
1664      * Applies a callback method to editor if selection is uncollapsed or waits for input to select first.
1665      * @method applyFormat
1666      * @param e EventTarget Event to be passed to callback if selection is uncollapsed
1667      * @param method callback A callback method which changes editor when text is selected.
1668      * @param object context Context to be used for callback method
1669      * @param array args Array of arguments to pass to callback
1670      */
1671     applyFormat: function(e, callback, context, args) {
1672         function handleInsert(e, callback, context, args, anchorNode, anchorOffset) {
1673             // After something is inputed, select it and apply the formating function.
1674             Y.soon(Y.bind(function(e, callback, context, args, anchorNode, anchorOffset) {
1675                 var selection = window.rangy.getSelection();
1677                 // Set the start of the selection to where it was when the method was first called.
1678                 var range = selection.getRangeAt(0);
1679                 range.setStart(anchorNode, anchorOffset);
1680                 selection.setSingleRange(range);
1682                 // Now apply callback to the new text that is selected.
1683                 callback.apply(context, [e, args]);
1685                 // Collapse selection so cursor is at end of inserted material.
1686                 selection.collapseToEnd();
1688                 // Save save selection and editor contents.
1689                 this.saveSelection();
1690                 this.updateOriginal();
1691             }, this, e, callback, context, args, anchorNode, anchorOffset));
1692         }
1694         // Set default context for the method.
1695         context = context || this;
1697         // Check whether range is collapsed.
1698         var selection = window.rangy.getSelection();
1700         if (selection.isCollapsed) {
1701             // Selection is collapsed so listen for input into editor.
1702             var handle = this.editor.once('input', handleInsert, this, callback, context, args,
1703                     selection.anchorNode, selection.anchorOffset);
1705             // Cancel if selection changes before input.
1706             this.editor.onceAfter(['click', 'selectstart'], handle.detach, handle);
1708             return;
1709         }
1711         // The range is not collapsed; so apply callback method immediately.
1712         callback.apply(context, [e, args]);
1714         // Save save selection and editor contents.
1715         this.saveSelection();
1716         this.updateOriginal();
1717     },
1719     /**
1720      * Replaces all the tags in a node list with new type.
1721      * @method replaceTags
1722      * @param NodeList nodelist
1723      * @param String tag
1724      */
1725     replaceTags: function(nodelist, tag) {
1726         // We mark elements in the node list for iterations.
1727         nodelist.setAttribute('data-iterate', true);
1728         var node = this.editor.one('[data-iterate="true"]');
1729         while (node) {
1730             var clone = Y.Node.create('<' + tag + ' />')
1731                 .setAttrs(node.getAttrs())
1732                 .removeAttribute('data-iterate');
1733             // Copy class and style if not blank.
1734             if (node.getAttribute('style')) {
1735                 clone.setAttribute('style', node.getAttribute('style'));
1736             }
1737             if (node.getAttribute('class')) {
1738                 clone.setAttribute('class', node.getAttribute('class'));
1739             }
1740             // We use childNodes here because we are interested in both type 1 and 3 child nodes.
1741             var children = node.getDOMNode().childNodes, child;
1742             child = children[0];
1743             while (typeof child !== "undefined") {
1744                 clone.append(child);
1745                 child = children[0];
1746             }
1747             node.replace(clone);
1748             node = this.editor.one('[data-iterate="true"]');
1749         }
1750     },
1752     /**
1753      * Change all tags with given type to a span with CSS class attribute.
1754      * @method changeToCSS
1755      * @param String tag Tag type to be changed to span
1756      * @param String markerClass CSS class that corresponds to desired tag
1757      */
1758     changeToCSS: function(tag, markerClass) {
1759         // Save the selection.
1760         var selection = window.rangy.saveSelection();
1762         // Remove display:none from rangy markers so browser doesn't delete them.
1763         this.editor.all('.rangySelectionBoundary').setStyle('display', null);
1765         // Replace tags with CSS classes.
1766         this.editor.all(tag).addClass(markerClass);
1767         this.replaceTags(this.editor.all('.' + markerClass), 'span');
1769         // Restore selection and toggle class.
1770         window.rangy.restoreSelection(selection);
1771     },
1773     /**
1774      * Change spans with CSS classes in editor into elements with given tag.
1775      * @method changeToCSS
1776      * @param String markerClass CSS class that corresponds to desired tag
1777      * @param String tag New tag type to be created
1778      */
1779     changeToTags: function(markerClass, tag) {
1780         // Save the selection.
1781         var selection = window.rangy.saveSelection();
1783         // Remove display:none from rangy markers so browser doesn't delete them.
1784         this.editor.all('.rangySelectionBoundary').setStyle('display', null);
1786         // Replace spans with given tag.
1787         this.replaceTags(this.editor.all('span[class="' + markerClass + '"]'), tag);
1788         this.editor.all(tag + '[class="' + markerClass + '"]').removeAttribute('class');
1789         this.editor.all('.' + markerClass).each(function(n) {
1790             n.wrap('<' + tag + '/>');
1791             n.removeClass(markerClass);
1792         });
1794         // Remove CSS classes.
1795         this.editor.all('[class="' + markerClass + '"]').removeAttribute('class');
1796         this.editor.all(tag).removeClass(markerClass);
1798         // Restore selection.
1799         window.rangy.restoreSelection(selection);
1800     }
1801 };
1803 Y.Base.mix(Y.M.editor_atto.Editor, [EditorCommand]);
1804 // This file is part of Moodle - http://moodle.org/
1805 //
1806 // Moodle is free software: you can redistribute it and/or modify
1807 // it under the terms of the GNU General Public License as published by
1808 // the Free Software Foundation, either version 3 of the License, or
1809 // (at your option) any later version.
1810 //
1811 // Moodle is distributed in the hope that it will be useful,
1812 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1813 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1814 // GNU General Public License for more details.
1815 //
1816 // You should have received a copy of the GNU General Public License
1817 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1819 /**
1820  * @module moodle-editor_atto-editor
1821  * @submodule toolbar
1822  */
1824 /**
1825  * Toolbar functions for the Atto editor.
1826  *
1827  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1828  *
1829  * @namespace M.editor_atto
1830  * @class EditorToolbar
1831  */
1833 function EditorToolbar() {}
1835 EditorToolbar.ATTRS= {
1836 };
1838 EditorToolbar.prototype = {
1839     /**
1840      * A reference to the toolbar Node.
1841      *
1842      * @property toolbar
1843      * @type Node
1844      */
1845     toolbar: null,
1847     /**
1848      * A reference to any currently open menus in the toolbar.
1849      *
1850      * @property openMenus
1851      * @type Array
1852      */
1853     openMenus: null,
1855     /**
1856      * Setup the toolbar on the editor.
1857      *
1858      * @method setupToolbar
1859      * @chainable
1860      */
1861     setupToolbar: function() {
1862         this.toolbar = Y.Node.create('<div class="' + CSS.TOOLBAR + '" role="toolbar" aria-live="off"/>');
1863         this.openMenus = [];
1864         this._wrapper.appendChild(this.toolbar);
1866         if (this.textareaLabel) {
1867             this.toolbar.setAttribute('aria-labelledby', this.textareaLabel.get("id"));
1868         }
1870         // Add keyboard navigation for the toolbar.
1871         this.setupToolbarNavigation();
1873         return this;
1874     }
1875 };
1877 Y.Base.mix(Y.M.editor_atto.Editor, [EditorToolbar]);
1878 // This file is part of Moodle - http://moodle.org/
1879 //
1880 // Moodle is free software: you can redistribute it and/or modify
1881 // it under the terms of the GNU General Public License as published by
1882 // the Free Software Foundation, either version 3 of the License, or
1883 // (at your option) any later version.
1884 //
1885 // Moodle is distributed in the hope that it will be useful,
1886 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1887 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1888 // GNU General Public License for more details.
1889 //
1890 // You should have received a copy of the GNU General Public License
1891 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1892 /* global LOGNAME */
1894 /**
1895  * @module moodle-editor_atto-editor
1896  * @submodule toolbarnav
1897  */
1899 /**
1900  * Toolbar Navigation functions for the Atto editor.
1901  *
1902  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1903  *
1904  * @namespace M.editor_atto
1905  * @class EditorToolbarNav
1906  */
1908 function EditorToolbarNav() {}
1910 EditorToolbarNav.ATTRS= {
1911 };
1913 EditorToolbarNav.prototype = {
1914     /**
1915      * The current focal point for tabbing.
1916      *
1917      * @property _tabFocus
1918      * @type Node
1919      * @default null
1920      * @private
1921      */
1922     _tabFocus: null,
1924     /**
1925      * Set up the watchers for toolbar navigation.
1926      *
1927      * @method setupToolbarNavigation
1928      * @chainable
1929      */
1930     setupToolbarNavigation: function() {
1931         // Listen for Arrow left and Arrow right keys.
1932         this._wrapper.delegate('key',
1933                 this.toolbarKeyboardNavigation,
1934                 'down:37,39',
1935                 '.' + CSS.TOOLBAR,
1936                 this);
1937         this._wrapper.delegate('focus',
1938                 function(e) {
1939                     this._setTabFocus(e.currentTarget);
1940                 }, '.' + CSS.TOOLBAR + ' button', this);
1942         return this;
1943     },
1945     /**
1946      * Implement arrow key navigation for the buttons in the toolbar.
1947      *
1948      * @method toolbarKeyboardNavigation
1949      * @param {EventFacade} e - the keyboard event.
1950      */
1951     toolbarKeyboardNavigation: function(e) {
1952         // Prevent the default browser behaviour.
1953         e.preventDefault();
1955         // On cursor moves we loops through the buttons.
1956         var buttons = this.toolbar.all('button'),
1957             direction = 1,
1958             button,
1959             current = e.target.ancestor('button', true);
1961         if (e.keyCode === 37) {
1962             // Moving left so reverse the direction.
1963             direction = -1;
1964         }
1966         button = this._findFirstFocusable(buttons, current, direction);
1967         if (button) {
1968             button.focus();
1969             this._setTabFocus(button);
1970         } else {
1971         }
1972     },
1974     /**
1975      * Find the first focusable button.
1976      *
1977      * @param {NodeList} buttons A list of nodes.
1978      * @param {Node} startAt The node in the list to start the search from.
1979      * @param {Number} direction The direction in which to search (1 or -1).
1980      * @return {Node | Undefined} The Node or undefined.
1981      * @method _findFirstFocusable
1982      * @private
1983      */
1984     _findFirstFocusable: function(buttons, startAt, direction) {
1985         var checkCount = 0,
1986             group,
1987             candidate,
1988             button,
1989             index;
1991         // Determine which button to start the search from.
1992         index = buttons.indexOf(startAt);
1993         if (index < -1) {
1994             index = 0;
1995         }
1997         // Try to find the next.
1998         while (checkCount < buttons.size()) {
1999             index += direction;
2000             if (index < 0) {
2001                 index = buttons.size() - 1;
2002             } else if (index >= buttons.size()) {
2003                 // Handle wrapping.
2004                 index = 0;
2005             }
2007             candidate = buttons.item(index);
2009             // Add a counter to ensure we don't get stuck in a loop if there's only one visible menu item.
2010             checkCount++;
2012             // Loop while:
2013             // * we haven't checked every button;
2014             // * the button is hidden or disabled;
2015             // * the group is hidden.
2016             if (candidate.hasAttribute('hidden') || candidate.hasAttribute('disabled')) {
2017                 continue;
2018             }
2019             group = candidate.ancestor('.atto_group');
2020             if (group.hasAttribute('hidden')) {
2021                 continue;
2022             }
2024             button = candidate;
2025             break;
2026         }
2028         return button;
2029     },
2031     /**
2032      * Check the tab focus.
2033      *
2034      * When we disable or hide a button, we should call this method to ensure that the
2035      * focus is not currently set on an inaccessible button, otherwise tabbing to the toolbar
2036      * would be impossible.
2037      *
2038      * @method checkTabFocus
2039      * @chainable
2040      */
2041     checkTabFocus: function() {
2042         if (this._tabFocus) {
2043             if (this._tabFocus.hasAttribute('disabled') || this._tabFocus.hasAttribute('hidden')
2044                     || this._tabFocus.ancestor('.atto_group').hasAttribute('hidden')) {
2045                 // Find first available button.
2046                 var button = this._findFirstFocusable(this.toolbar.all('button'), this._tabFocus, -1);
2047                 if (button) {
2048                     if (this._tabFocus.compareTo(document.activeElement)) {
2049                         // We should also move the focus, because the inaccessible button also has the focus.
2050                         button.focus();
2051                     }
2052                     this._setTabFocus(button);
2053                 }
2054             }
2055         }
2056         return this;
2057     },
2059     /**
2060      * Sets tab focus for the toolbar to the specified Node.
2061      *
2062      * @method _setTabFocus
2063      * @param {Node} button The node that focus should now be set to
2064      * @chainable
2065      * @private
2066      */
2067     _setTabFocus: function(button) {
2068         if (this._tabFocus) {
2069             // Unset the previous entry.
2070             this._tabFocus.setAttribute('tabindex', '-1');
2071         }
2073         // Set up the new entry.
2074         this._tabFocus = button;
2075         this._tabFocus.setAttribute('tabindex', 0);
2077         // And update the activedescendant to point at the currently selected button.
2078         this.toolbar.setAttribute('aria-activedescendant', this._tabFocus.generateID());
2080         return this;
2081     }
2082 };
2084 Y.Base.mix(Y.M.editor_atto.Editor, [EditorToolbarNav]);
2085 // This file is part of Moodle - http://moodle.org/
2086 //
2087 // Moodle is free software: you can redistribute it and/or modify
2088 // it under the terms of the GNU General Public License as published by
2089 // the Free Software Foundation, either version 3 of the License, or
2090 // (at your option) any later version.
2091 //
2092 // Moodle is distributed in the hope that it will be useful,
2093 // but WITHOUT ANY WARRANTY; without even the implied warranty of
2094 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2095 // GNU General Public License for more details.
2096 //
2097 // You should have received a copy of the GNU General Public License
2098 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
2099 /* global rangy */
2101 /**
2102  * @module moodle-editor_atto-editor
2103  * @submodule selection
2104  */
2106 /**
2107  * Selection functions for the Atto editor.
2108  *
2109  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
2110  *
2111  * @namespace M.editor_atto
2112  * @class EditorSelection
2113  */
2115 function EditorSelection() {}
2117 EditorSelection.ATTRS= {
2118 };
2120 EditorSelection.prototype = {
2122     /**
2123      * List of saved selections per editor instance.
2124      *
2125      * @property _selections
2126      * @private
2127      */
2128     _selections: null,
2130     /**
2131      * A unique identifier for the last selection recorded.
2132      *
2133      * @property _lastSelection
2134      * @param lastselection
2135      * @type string
2136      * @private
2137      */
2138     _lastSelection: null,
2140     /**
2141      * Whether focus came from a click event.
2142      *
2143      * This is used to determine whether to restore the selection or not.
2144      *
2145      * @property _focusFromClick
2146      * @type Boolean
2147      * @default false
2148      * @private
2149      */
2150     _focusFromClick: false,
2152     /**
2153      * Whether if the last gesturemovestart event target was contained in this editor or not.
2154      *
2155      * @property _gesturestartededitor
2156      * @type Boolean
2157      * @default false
2158      * @private
2159      */
2160     _gesturestartededitor: false,
2162     /**
2163      * Set up the watchers for selection save and restoration.
2164      *
2165      * @method setupSelectionWatchers
2166      * @chainable
2167      */
2168     setupSelectionWatchers: function() {
2169         // Save the selection when a change was made.
2170         this.on('atto:selectionchanged', this.saveSelection, this);
2172         this.editor.on('focus', this.restoreSelection, this);
2174         // Do not restore selection when focus is from a click event.
2175         this.editor.on('mousedown', function() {
2176             this._focusFromClick = true;
2177         }, this);
2179         // Copy the current value back to the textarea when focus leaves us and save the current selection.
2180         this.editor.on('blur', function() {
2181             // Clear the _focusFromClick value.
2182             this._focusFromClick = false;
2184             // Update the original text area.
2185             this.updateOriginal();
2186         }, this);
2188         this.editor.on(['keyup', 'focus'], function(e) {
2189                 Y.soon(Y.bind(this._hasSelectionChanged, this, e));
2190             }, this);
2192         Y.one(document.body).on('gesturemovestart', function(e) {
2193             if (this._wrapper.contains(e.target._node)) {
2194                 this._gesturestartededitor = true;
2195             } else {
2196                 this._gesturestartededitor = false;
2197             }
2198         }, null, this);
2200         Y.one(document.body).on('gesturemoveend', function(e) {
2201             if (!this._gesturestartededitor) {
2202                 // Ignore the event if movestart target was not contained in the editor.
2203                 return;
2204             }
2205             Y.soon(Y.bind(this._hasSelectionChanged, this, e));
2206         }, {
2207             // Standalone will make sure all editors receive the end event.
2208             standAlone: true
2209         }, this);
2211         return this;
2212     },
2214     /**
2215      * Work out if the cursor is in the editable area for this editor instance.
2216      *
2217      * @method isActive
2218      * @return {boolean}
2219      */
2220     isActive: function() {
2221         var range = rangy.createRange(),
2222             selection = rangy.getSelection();
2224         if (!selection.rangeCount) {
2225             // If there was no range count, then there is no selection.
2226             return false;
2227         }
2229         // We can't be active if the editor doesn't have focus at the moment.
2230         if (!document.activeElement ||
2231                 !(this.editor.compareTo(document.activeElement) || this.editor.contains(document.activeElement))) {
2232             return false;
2233         }
2235         // Check whether the range intersects the editor selection.
2236         range.selectNode(this.editor.getDOMNode());
2237         return range.intersectsRange(selection.getRangeAt(0));
2238     },
2240     /**
2241      * Create a cross browser selection object that represents a YUI node.
2242      *
2243      * @method getSelectionFromNode
2244      * @param {Node} YUI Node to base the selection upon.
2245      * @return {[rangy.Range]}
2246      */
2247     getSelectionFromNode: function(node) {
2248         var range = rangy.createRange();
2249         range.selectNode(node.getDOMNode());
2250         return [range];
2251     },
2253     /**
2254      * Save the current selection to an internal property.
2255      *
2256      * This allows more reliable return focus, helping improve keyboard navigation.
2257      *
2258      * Should be used in combination with {{#crossLink "M.editor_atto.EditorSelection/restoreSelection"}}{{/crossLink}}.
2259      *
2260      * @method saveSelection
2261      */
2262     saveSelection: function() {
2263         if (this.isActive()) {
2264             this._selections = this.getSelection();
2265         }
2266     },
2268     /**
2269      * Restore any stored selection when the editor gets focus again.
2270      *
2271      * Should be used in combination with {{#crossLink "M.editor_atto.EditorSelection/saveSelection"}}{{/crossLink}}.
2272      *
2273      * @method restoreSelection
2274      */
2275     restoreSelection: function() {
2276         if (!this._focusFromClick) {
2277             if (this._selections) {
2278                 this.setSelection(this._selections);
2279             }
2280         }
2281         this._focusFromClick = false;
2282     },
2284     /**
2285      * Get the selection object that can be passed back to setSelection.
2286      *
2287      * @method getSelection
2288      * @return {array} An array of rangy ranges.
2289      */
2290     getSelection: function() {
2291         return rangy.getSelection().getAllRanges();
2292     },
2294     /**
2295      * Check that a YUI node it at least partly contained by the current selection.
2296      *
2297      * @method selectionContainsNode
2298      * @param {Node} The node to check.
2299      * @return {boolean}
2300      */
2301     selectionContainsNode: function(node) {
2302         return rangy.getSelection().containsNode(node.getDOMNode(), true);
2303     },
2305     /**
2306      * Runs a filter on each node in the selection, and report whether the
2307      * supplied selector(s) were found in the supplied Nodes.
2308      *
2309      * By default, all specified nodes must match the selection, but this
2310      * can be controlled with the requireall property.
2311      *
2312      * @method selectionFilterMatches
2313      * @param {String} selector
2314      * @param {NodeList} [selectednodes] For performance this should be passed. If not passed, this will be looked up each time.
2315      * @param {Boolean} [requireall=true] Used to specify that "any" match is good enough.
2316      * @return {Boolean}
2317      */
2318     selectionFilterMatches: function(selector, selectednodes, requireall) {
2319         if (typeof requireall === 'undefined') {
2320             requireall = true;
2321         }
2322         if (!selectednodes) {
2323             // Find this because it was not passed as a param.
2324             selectednodes = this.getSelectedNodes();
2325         }
2326         var allmatch = selectednodes.size() > 0,
2327             anymatch = false;
2329         var editor = this.editor,
2330             stopFn = function(node) {
2331                 // The function getSelectedNodes only returns nodes within the editor, so this test is safe.
2332                 return node === editor;
2333             };
2335         // If we do not find at least one match in the editor, no point trying to find them in the selection.
2336         if (!editor.one(selector)) {
2337             return false;
2338         }
2340         selectednodes.each(function(node){
2341             // Check each node, if it doesn't match the tags AND is not within the specified tags then fail this thing.
2342             if (requireall) {
2343                 // Check for at least one failure.
2344                 if (!allmatch || !node.ancestor(selector, true, stopFn)) {
2345                     allmatch = false;
2346                 }
2347             } else {
2348                 // Check for at least one match.
2349                 if (!anymatch && node.ancestor(selector, true, stopFn)) {
2350                     anymatch = true;
2351                 }
2352             }
2353         }, this);
2354         if (requireall) {
2355             return allmatch;
2356         } else {
2357             return anymatch;
2358         }
2359     },
2361     /**
2362      * Get the deepest possible list of nodes in the current selection.
2363      *
2364      * @method getSelectedNodes
2365      * @return {NodeList}
2366      */
2367     getSelectedNodes: function() {
2368         var results = new Y.NodeList(),
2369             nodes,
2370             selection,
2371             range,
2372             node,
2373             i;
2375         selection = rangy.getSelection();
2377         if (selection.rangeCount) {
2378             range = selection.getRangeAt(0);
2379         } else {
2380             // Empty range.
2381             range = rangy.createRange();
2382         }
2384         if (range.collapsed) {
2385             // We do not want to select all the nodes in the editor if we managed to
2386             // have a collapsed selection directly in the editor.
2387             // It's also possible for the commonAncestorContainer to be the document, which selectNode does not handle
2388             // so we must filter that out here too.
2389             if (range.commonAncestorContainer !== this.editor.getDOMNode()
2390                     && range.commonAncestorContainer !== Y.config.doc) {
2391                 range = range.cloneRange();
2392                 range.selectNode(range.commonAncestorContainer);
2393             }
2394         }
2396         nodes = range.getNodes();
2398         for (i = 0; i < nodes.length; i++) {
2399             node = Y.one(nodes[i]);
2400             if (this.editor.contains(node)) {
2401                 results.push(node);
2402             }
2403         }
2404         return results;
2405     },
2407     /**
2408      * Check whether the current selection has changed since this method was last called.
2409      *
2410      * If the selection has changed, the atto:selectionchanged event is also fired.
2411      *
2412      * @method _hasSelectionChanged
2413      * @private
2414      * @param {EventFacade} e
2415      * @return {Boolean}
2416      */
2417     _hasSelectionChanged: function(e) {
2418         var selection = rangy.getSelection(),
2419             range,
2420             changed = false;
2422         if (selection.rangeCount) {
2423             range = selection.getRangeAt(0);
2424         } else {
2425             // Empty range.
2426             range = rangy.createRange();
2427         }
2429         if (this._lastSelection) {
2430             if (!this._lastSelection.equals(range)) {
2431                 changed = true;
2432                 return this._fireSelectionChanged(e);
2433             }
2434         }
2435         this._lastSelection = range;
2436         return changed;
2437     },
2439     /**
2440      * Fires the atto:selectionchanged event.
2441      *
2442      * When the selectionchanged event is fired, the following arguments are provided:
2443      *   - event : the original event that lead to this event being fired.
2444      *   - selectednodes :  an array containing nodes that are entirely selected of contain partially selected content.
2445      *
2446      * @method _fireSelectionChanged
2447      * @private
2448      * @param {EventFacade} e
2449      */
2450     _fireSelectionChanged: function(e) {
2451         this.fire('atto:selectionchanged', {
2452             event: e,
2453             selectedNodes: this.getSelectedNodes()
2454         });
2455     },
2457     /**
2458      * Get the DOM node representing the common anscestor of the selection nodes.
2459      *
2460      * @method getSelectionParentNode
2461      * @return {Element|boolean} The DOM Node for this parent, or false if no seletion was made.
2462      */
2463     getSelectionParentNode: function() {
2464         var selection = rangy.getSelection();
2465         if (selection.rangeCount) {
2466             return selection.getRangeAt(0).commonAncestorContainer;
2467         }
2468         return false;
2469     },
2471     /**
2472      * Set the current selection. Used to restore a selection.
2473      *
2474      * @method selection
2475      * @param {array} ranges A list of rangy.range objects in the selection.
2476      */
2477     setSelection: function(ranges) {
2478         var selection = rangy.getSelection();
2479         selection.setRanges(ranges);
2480     },
2482     /**
2483      * Inserts the given HTML into the editable content at the currently focused point.
2484      *
2485      * @method insertContentAtFocusPoint
2486      * @param {String} html
2487      * @return {Node} The YUI Node object added to the DOM.
2488      */
2489     insertContentAtFocusPoint: function(html) {
2490         var selection = rangy.getSelection(),
2491             range,
2492             node = Y.Node.create(html);
2493         if (selection.rangeCount) {
2494             range = selection.getRangeAt(0);
2495         }
2496         if (range) {
2497             range.deleteContents();
2498             range.insertNode(node.getDOMNode());
2499         }
2500         return node;
2501     }
2503 };
2505 Y.Base.mix(Y.M.editor_atto.Editor, [EditorSelection]);
2506 // This file is part of Moodle - http://moodle.org/
2507 //
2508 // Moodle is free software: you can redistribute it and/or modify
2509 // it under the terms of the GNU General Public License as published by
2510 // the Free Software Foundation, either version 3 of the License, or
2511 // (at your option) any later version.
2512 //
2513 // Moodle is distributed in the hope that it will be useful,
2514 // but WITHOUT ANY WARRANTY; without even the implied warranty of
2515 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2516 // GNU General Public License for more details.
2517 //
2518 // You should have received a copy of the GNU General Public License
2519 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
2520 /* global rangy */
2522 /**
2523  * @module moodle-editor_atto-editor
2524  * @submodule styling
2525  */
2527 /**
2528  * Editor styling functions for the Atto editor.
2529  *
2530  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
2531  *
2532  * @namespace M.editor_atto
2533  * @class EditorStyling
2534  */
2536 function EditorStyling() {}
2538 EditorStyling.ATTRS= {
2539 };
2541 EditorStyling.prototype = {
2542     /**
2543      * Disable CSS styling.
2544      *
2545      * @method disableCssStyling
2546      */
2547     disableCssStyling: function() {
2548         try {
2549             document.execCommand("styleWithCSS", 0, false);
2550         } catch (e1) {
2551             try {
2552                 document.execCommand("useCSS", 0, true);
2553             } catch (e2) {
2554                 try {
2555                     document.execCommand('styleWithCSS', false, false);
2556                 } catch (e3) {
2557                     // We did our best.
2558                 }
2559             }
2560         }
2561     },
2563     /**
2564      * Enable CSS styling.
2565      *
2566      * @method enableCssStyling
2567      */
2568     enableCssStyling: function() {
2569         try {
2570             document.execCommand("styleWithCSS", 0, true);
2571         } catch (e1) {
2572             try {
2573                 document.execCommand("useCSS", 0, false);
2574             } catch (e2) {
2575                 try {
2576                     document.execCommand('styleWithCSS', false, true);
2577                 } catch (e3) {
2578                     // We did our best.
2579                 }
2580             }
2581         }
2582     },
2584     /**
2585      * Change the formatting for the current selection.
2586      *
2587      * This will wrap the selection in span tags, adding the provided classes.
2588      *
2589      * If the selection covers multiple block elements, multiple spans will be inserted to preserve the original structure.
2590      *
2591      * @method toggleInlineSelectionClass
2592      * @param {Array} toggleclasses - Class names to be toggled on or off.
2593      */
2594     toggleInlineSelectionClass: function(toggleclasses) {
2595         var classname = toggleclasses.join(" ");
2596         var cssApplier = rangy.createClassApplier(classname, {normalize: true});
2598         cssApplier.toggleSelection();
2599     },
2601     /**
2602      * Change the formatting for the current selection.
2603      *
2604      * This will set inline styles on the current selection.
2605      *
2606      * @method formatSelectionInlineStyle
2607      * @param {Array} styles - Style attributes to set on the nodes.
2608      */
2609     formatSelectionInlineStyle: function(styles) {
2610         var classname = this.PLACEHOLDER_CLASS;
2611         var cssApplier = rangy.createClassApplier(classname, {normalize: true});
2613         cssApplier.applyToSelection();
2615         this.editor.all('.' + classname).each(function (node) {
2616             node.removeClass(classname).setStyles(styles);
2617         }, this);
2619     },
2621     /**
2622      * Change the formatting for the current selection.
2623      *
2624      * Also changes the selection to the newly formatted block (allows applying multiple styles to a block).
2625      *
2626      * @method formatSelectionBlock
2627      * @param {String} [blocktag] Change the block level tag to this. Empty string, means do not change the tag.
2628      * @param {Object} [attributes] The keys and values for attributes to be added/changed in the block tag.
2629      * @return {Node|boolean} The Node that was formatted if a change was made, otherwise false.
2630      */
2631     formatSelectionBlock: function(blocktag, attributes) {
2632         // First find the nearest ancestor of the selection that is a block level element.
2633         var selectionparentnode = this.getSelectionParentNode(),
2634             boundary,
2635             cell,
2636             nearestblock,
2637             newcontent,
2638             match,
2639             replacement;
2641         if (!selectionparentnode) {
2642             // No selection, nothing to format.
2643             return false;
2644         }
2646         boundary = this.editor;
2648         selectionparentnode = Y.one(selectionparentnode);
2650         // If there is a table cell in between the selectionparentnode and the boundary,
2651         // move the boundary to the table cell.
2652         // This is because we might have a table in a div, and we select some text in a cell,
2653         // want to limit the change in style to the table cell, not the entire table (via the outer div).
2654         cell = selectionparentnode.ancestor(function (node) {
2655             var tagname = node.get('tagName');
2656             if (tagname) {
2657                 tagname = tagname.toLowerCase();
2658             }
2659             return (node === boundary) ||
2660                    (tagname === 'td') ||
2661                    (tagname === 'th');
2662         }, true);
2664         if (cell) {
2665             // Limit the scope to the table cell.
2666             boundary = cell;
2667         }
2669         nearestblock = selectionparentnode.ancestor(this.BLOCK_TAGS.join(', '), true);
2670         if (nearestblock) {
2671             // Check that the block is contained by the boundary.
2672             match = nearestblock.ancestor(function (node) {
2673                 return node === boundary;
2674             }, false);
2676             if (!match) {
2677                 nearestblock = false;
2678             }
2679         }
2681         // No valid block element - make one.
2682         if (!nearestblock) {
2683             // There is no block node in the content, wrap the content in a p and use that.
2684             newcontent = Y.Node.create('<p></p>');
2685             boundary.get('childNodes').each(function (child) {
2686                 newcontent.append(child.remove());
2687             });
2688             boundary.append(newcontent);
2689             nearestblock = newcontent;
2690         }
2692         // Guaranteed to have a valid block level element contained in the contenteditable region.
2693         // Change the tag to the new block level tag.
2694         if (blocktag && blocktag !== '') {
2695             // Change the block level node for a new one.
2696             replacement = Y.Node.create('<' + blocktag + '></' + blocktag + '>');
2697             // Copy all attributes.
2698             replacement.setAttrs(nearestblock.getAttrs());
2699             // Copy all children.
2700             nearestblock.get('childNodes').each(function (child) {
2701                 child.remove();
2702                 replacement.append(child);
2703             });
2705             nearestblock.replace(replacement);
2706             nearestblock = replacement;
2707         }
2709         // Set the attributes on the block level tag.
2710         if (attributes) {
2711             nearestblock.setAttrs(attributes);
2712         }
2714         // Change the selection to the modified block. This makes sense when we might apply multiple styles
2715         // to the block.
2716         var selection = this.getSelectionFromNode(nearestblock);
2717         this.setSelection(selection);
2719         return nearestblock;
2720     }
2722 };
2724 Y.Base.mix(Y.M.editor_atto.Editor, [EditorStyling]);
2725 // This file is part of Moodle - http://moodle.org/
2726 //
2727 // Moodle is free software: you can redistribute it and/or modify
2728 // it under the terms of the GNU General Public License as published by
2729 // the Free Software Foundation, either version 3 of the License, or
2730 // (at your option) any later version.
2731 //
2732 // Moodle is distributed in the hope that it will be useful,
2733 // but WITHOUT ANY WARRANTY; without even the implied warranty of
2734 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2735 // GNU General Public License for more details.
2736 //
2737 // You should have received a copy of the GNU General Public License
2738 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
2740 /**
2741  * @module moodle-editor_atto-editor
2742  * @submodule filepicker
2743  */
2745 /**
2746  * Filepicker options for the Atto editor.
2747  *
2748  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
2749  *
2750  * @namespace M.editor_atto
2751  * @class EditorFilepicker
2752  */
2754 function EditorFilepicker() {}
2756 EditorFilepicker.ATTRS= {
2757     /**
2758      * The options for the filepicker.
2759      *
2760      * @attribute filepickeroptions
2761      * @type object
2762      * @default {}
2763      */
2764     filepickeroptions: {
2765         value: {}
2766     }
2767 };
2769 EditorFilepicker.prototype = {
2770     /**
2771      * Should we show the filepicker for this filetype?
2772      *
2773      * @method canShowFilepicker
2774      * @param string type The media type for the file picker.
2775      * @return {boolean}
2776      */
2777     canShowFilepicker: function(type) {
2778         return (typeof this.get('filepickeroptions')[type] !== 'undefined');
2779     },
2781     /**
2782      * Show the filepicker.
2783      *
2784      * This depends on core_filepicker, and then call that modules show function.
2785      *
2786      * @method showFilepicker
2787      * @param {string} type The media type for the file picker.
2788      * @param {function} callback The callback to use when selecting an item of media.
2789      * @param {object} [context] The context from which to call the callback.
2790      */
2791     showFilepicker: function(type, callback, context) {
2792         var self = this;
2793         Y.use('core_filepicker', function (Y) {
2794             var options = Y.clone(self.get('filepickeroptions')[type], true);
2795             options.formcallback = callback;
2796             if (context) {
2797                 options.magicscope = context;
2798             }
2800             M.core_filepicker.show(Y, options);
2801         });
2802     }
2803 };
2805 Y.Base.mix(Y.M.editor_atto.Editor, [EditorFilepicker]);
2808 }, '@VERSION@', {
2809     "requires": [
2810         "node",
2811         "transition",
2812         "io",
2813         "overlay",
2814         "escape",
2815         "event",
2816         "event-simulate",
2817         "event-custom",
2818         "node-event-html5",
2819         "yui-throttle",
2820         "moodle-core-notification-dialogue",
2821         "moodle-core-notification-confirm",
2822         "moodle-editor_atto-rangy",
2823         "handlebars",
2824         "timers",
2825         "querystring-stringify"
2826     ]
2827 });