MDL-54796 forms: Editor restore event created.
[moodle.git] / lib / editor / atto / yui / build / moodle-editor_atto-editor / moodle-editor_atto-editor-debug.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             Y.log('Text area not found - unable to setup editor for ' + this.get('elementid'),
171                     'error', LOGNAME);
172             return;
173         }
175         this._eventHandles = [];
177         this._wrapper = Y.Node.create('<div class="' + CSS.WRAPPER + '" />');
178         template = Y.Handlebars.compile('<div id="{{elementid}}editable" ' +
179                 'contenteditable="true" ' +
180                 'role="textbox" ' +
181                 'spellcheck="true" ' +
182                 'aria-live="off" ' +
183                 'class="{{CSS.CONTENT}}" ' +
184                 '/>');
185         this.editor = Y.Node.create(template({
186             elementid: this.get('elementid'),
187             CSS: CSS
188         }));
190         // Add a labelled-by attribute to the contenteditable.
191         this.textareaLabel = Y.one('[for="' + this.get('elementid') + '"]');
192         if (this.textareaLabel) {
193             this.textareaLabel.generateID();
194             this.editor.setAttribute('aria-labelledby', this.textareaLabel.get("id"));
195         }
197         // Add everything to the wrapper.
198         this.setupToolbar();
200         // Editable content wrapper.
201         var content = Y.Node.create('<div class="' + CSS.CONTENTWRAPPER + '" />');
202         content.appendChild(this.editor);
203         this._wrapper.appendChild(content);
205         // Style the editor. According to the styles.css: 20 is the line-height, 8 is padding-top + padding-bottom.
206         this.editor.setStyle('minHeight', ((20 * this.textarea.getAttribute('rows')) + 8) + 'px');
208         if (Y.UA.ie === 0) {
209             // We set a height here to force the overflow because decent browsers allow the CSS property resize.
210             this.editor.setStyle('height', ((20 * this.textarea.getAttribute('rows')) + 8) + 'px');
211         }
213         // Disable odd inline CSS styles.
214         this.disableCssStyling();
216         // Use paragraphs not divs.
217         if (document.queryCommandSupported('DefaultParagraphSeparator')) {
218             document.execCommand('DefaultParagraphSeparator', false, 'p');
219         }
221         // Add the toolbar and editable zone to the page.
222         this.textarea.get('parentNode').insert(this._wrapper, this.textarea).
223                 setAttribute('class', 'editor_atto_wrap');
225         // Hide the old textarea.
226         this.textarea.hide();
228         // Copy the text to the contenteditable div.
229         this.updateFromTextArea();
231         // Publish the events that are defined by this editor.
232         this.publishEvents();
234         // Add handling for saving and restoring selections on cursor/focus changes.
235         this.setupSelectionWatchers();
237         // Add polling to update the textarea periodically when typing long content.
238         this.setupAutomaticPolling();
240         // Setup plugins.
241         this.setupPlugins();
243         // Initialize the auto-save timer.
244         this.setupAutosave();
245         // Preload the icons for the notifications.
246         this.setupNotifications();
247     },
249     /**
250      * Focus on the editable area for this editor.
251      *
252      * @method focus
253      * @chainable
254      */
255     focus: function() {
256         this.editor.focus();
258         return this;
259     },
261     /**
262      * Publish events for this editor instance.
263      *
264      * @method publishEvents
265      * @private
266      * @chainable
267      */
268     publishEvents: function() {
269         /**
270          * Fired when changes are made within the editor.
271          *
272          * @event change
273          */
274         this.publish('change', {
275             broadcast: true,
276             preventable: true
277         });
279         /**
280          * Fired when all plugins have completed loading.
281          *
282          * @event pluginsloaded
283          */
284         this.publish('pluginsloaded', {
285             fireOnce: true
286         });
288         this.publish('atto:selectionchanged', {
289             prefix: 'atto'
290         });
292         return this;
293     },
295     /**
296      * Set up automated polling of the text area to update the textarea.
297      *
298      * @method setupAutomaticPolling
299      * @chainable
300      */
301     setupAutomaticPolling: function() {
302         this._registerEventHandle(this.editor.on(['keyup', 'cut'], this.updateOriginal, this));
303         this._registerEventHandle(this.editor.on('paste', this.pasteCleanup, this));
305         // Call this.updateOriginal after dropped content has been processed.
306         this._registerEventHandle(this.editor.on('drop', this.updateOriginalDelayed, this));
308         return this;
309     },
311     /**
312      * Calls updateOriginal on a short timer to allow native event handlers to run first.
313      *
314      * @method updateOriginalDelayed
315      * @chainable
316      */
317     updateOriginalDelayed: function() {
318         Y.soon(Y.bind(this.updateOriginal, this));
320         return this;
321     },
323     setupPlugins: function() {
324         // Clear the list of plugins.
325         this.plugins = {};
327         var plugins = this.get('plugins');
329         var groupIndex,
330             group,
331             pluginIndex,
332             plugin,
333             pluginConfig;
335         for (groupIndex in plugins) {
336             group = plugins[groupIndex];
337             if (!group.plugins) {
338                 // No plugins in this group - skip it.
339                 continue;
340             }
341             for (pluginIndex in group.plugins) {
342                 plugin = group.plugins[pluginIndex];
344                 pluginConfig = Y.mix({
345                     name: plugin.name,
346                     group: group.group,
347                     editor: this.editor,
348                     toolbar: this.toolbar,
349                     host: this
350                 }, plugin);
352                 // Add a reference to the current editor.
353                 if (typeof Y.M['atto_' + plugin.name] === "undefined") {
354                     Y.log("Plugin '" + plugin.name + "' could not be found - skipping initialisation", "warn", LOGNAME);
355                     continue;
356                 }
357                 this.plugins[plugin.name] = new Y.M['atto_' + plugin.name].Button(pluginConfig);
358             }
359         }
361         // Some plugins need to perform actions once all plugins have loaded.
362         this.fire('pluginsloaded');
364         return this;
365     },
367     enablePlugins: function(plugin) {
368         this._setPluginState(true, plugin);
369     },
371     disablePlugins: function(plugin) {
372         this._setPluginState(false, plugin);
373     },
375     _setPluginState: function(enable, plugin) {
376         var target = 'disableButtons';
377         if (enable) {
378             target = 'enableButtons';
379         }
381         if (plugin) {
382             this.plugins[plugin][target]();
383         } else {
384             Y.Object.each(this.plugins, function(currentPlugin) {
385                 currentPlugin[target]();
386             }, this);
387         }
388     },
390     /**
391      * Register an event handle for disposal in the destructor.
392      *
393      * @method _registerEventHandle
394      * @param {EventHandle} The Event Handle as returned by Y.on, and Y.delegate.
395      * @private
396      */
397     _registerEventHandle: function(handle) {
398         this._eventHandles.push(handle);
399     }
401 }, {
402     NS: 'editor_atto',
403     ATTRS: {
404         /**
405          * The unique identifier for the form element representing the editor.
406          *
407          * @attribute elementid
408          * @type String
409          * @writeOnce
410          */
411         elementid: {
412             value: null,
413             writeOnce: true
414         },
416         /**
417          * The contextid of the form.
418          *
419          * @attribute contextid
420          * @type Integer
421          * @writeOnce
422          */
423         contextid: {
424             value: null,
425             writeOnce: true
426         },
428         /**
429          * Plugins with their configuration.
430          *
431          * The plugins structure is:
432          *
433          *     [
434          *         {
435          *             "group": "groupName",
436          *             "plugins": [
437          *                 "pluginName": {
438          *                     "configKey": "configValue"
439          *                 },
440          *                 "pluginName": {
441          *                     "configKey": "configValue"
442          *                 }
443          *             ]
444          *         },
445          *         {
446          *             "group": "groupName",
447          *             "plugins": [
448          *                 "pluginName": {
449          *                     "configKey": "configValue"
450          *                 }
451          *             ]
452          *         }
453          *     ]
454          *
455          * @attribute plugins
456          * @type Object
457          * @writeOnce
458          */
459         plugins: {
460             value: {},
461             writeOnce: true
462         }
463     }
464 });
466 // The Editor publishes custom events that can be subscribed to.
467 Y.augment(Editor, Y.EventTarget);
469 Y.namespace('M.editor_atto').Editor = Editor;
471 // Function for Moodle's initialisation.
472 Y.namespace('M.editor_atto.Editor').init = function(config) {
473     return new Y.M.editor_atto.Editor(config);
474 };
475 // This file is part of Moodle - http://moodle.org/
476 //
477 // Moodle is free software: you can redistribute it and/or modify
478 // it under the terms of the GNU General Public License as published by
479 // the Free Software Foundation, either version 3 of the License, or
480 // (at your option) any later version.
481 //
482 // Moodle is distributed in the hope that it will be useful,
483 // but WITHOUT ANY WARRANTY; without even the implied warranty of
484 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
485 // GNU General Public License for more details.
486 //
487 // You should have received a copy of the GNU General Public License
488 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
490 /**
491  * A notify function for the Atto editor.
492  *
493  * @module     moodle-editor_atto-notify
494  * @submodule  notify
495  * @package    editor_atto
496  * @copyright  2014 Damyon Wiese
497  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
498  */
500 var LOGNAME_NOTIFY = 'moodle-editor_atto-editor-notify',
501     NOTIFY_INFO = 'info',
502     NOTIFY_WARNING = 'warning';
504 function EditorNotify() {}
506 EditorNotify.ATTRS= {
507 };
509 EditorNotify.prototype = {
511     /**
512      * A single Y.Node for this editor. There is only ever one - it is replaced if a new message comes in.
513      *
514      * @property messageOverlay
515      * @type {Node}
516      */
517     messageOverlay: null,
519     /**
520      * A single timer object that can be used to cancel the hiding behaviour.
521      *
522      * @property hideTimer
523      * @type {timer}
524      */
525     hideTimer: null,
527     /**
528      * Initialize the notifications.
529      *
530      * @method setupNotifications
531      * @chainable
532      */
533     setupNotifications: function() {
534         var preload1 = new Image(),
535             preload2 = new Image();
537         preload1.src = M.util.image_url('i/warning', 'moodle');
538         preload2.src = M.util.image_url('i/info', 'moodle');
540         return this;
541     },
543     /**
544      * Show a notification in a floaty overlay somewhere in the atto editor text area.
545      *
546      * @method showMessage
547      * @param {String} message The translated message (use get_string)
548      * @param {String} type Must be either "info" or "warning"
549      * @param {Number} timeout Time in milliseconds to show this message for.
550      * @chainable
551      */
552     showMessage: function(message, type, timeout) {
553         var messageTypeIcon = '',
554             intTimeout,
555             bodyContent;
557         if (this.messageOverlay === null) {
558             this.messageOverlay = Y.Node.create('<div class="editor_atto_notification"></div>');
560             this.messageOverlay.hide(true);
561             this.textarea.get('parentNode').append(this.messageOverlay);
563             this.messageOverlay.on('click', function() {
564                 this.messageOverlay.hide(true);
565             }, this);
566         }
568         if (this.hideTimer !== null) {
569             this.hideTimer.cancel();
570         }
572         if (type === NOTIFY_WARNING) {
573             messageTypeIcon = '<img src="' +
574                               M.util.image_url('i/warning', 'moodle') +
575                               '" alt="' + M.util.get_string('warning', 'moodle') + '"/>';
576         } else if (type === NOTIFY_INFO) {
577             messageTypeIcon = '<img src="' +
578                               M.util.image_url('i/info', 'moodle') +
579                               '" alt="' + M.util.get_string('info', 'moodle') + '"/>';
580         } else {
581             Y.log('Invalid message type specified: ' + type + '. Must be either "info" or "warning".', 'debug', LOGNAME_NOTIFY);
582         }
584         // Parse the timeout value.
585         intTimeout = parseInt(timeout, 10);
586         if (intTimeout <= 0) {
587             intTimeout = 60000;
588         }
590         // Convert class to atto_info (for example).
591         type = 'atto_' + type;
593         bodyContent = Y.Node.create('<div class="' + type + '" role="alert" aria-live="assertive">' +
594                                         messageTypeIcon + ' ' +
595                                         Y.Escape.html(message) +
596                                         '</div>');
597         this.messageOverlay.empty();
598         this.messageOverlay.append(bodyContent);
599         this.messageOverlay.show(true);
601         this.hideTimer = Y.later(intTimeout, this, function() {
602             Y.log('Hide Atto notification.', 'debug', LOGNAME_NOTIFY);
603             this.hideTimer = null;
604             if (this.messageOverlay.inDoc()) {
605                 this.messageOverlay.hide(true);
606             }
607         });
609         return this;
610     }
612 };
614 Y.Base.mix(Y.M.editor_atto.Editor, [EditorNotify]);
615 // This file is part of Moodle - http://moodle.org/
616 //
617 // Moodle is free software: you can redistribute it and/or modify
618 // it under the terms of the GNU General Public License as published by
619 // the Free Software Foundation, either version 3 of the License, or
620 // (at your option) any later version.
621 //
622 // Moodle is distributed in the hope that it will be useful,
623 // but WITHOUT ANY WARRANTY; without even the implied warranty of
624 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
625 // GNU General Public License for more details.
626 //
627 // You should have received a copy of the GNU General Public License
628 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
630 /**
631  * @module moodle-editor_atto-editor
632  * @submodule textarea
633  */
635 /**
636  * Textarea functions for the Atto editor.
637  *
638  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
639  *
640  * @namespace M.editor_atto
641  * @class EditorTextArea
642  */
644 function EditorTextArea() {}
646 EditorTextArea.ATTRS= {
647 };
649 EditorTextArea.prototype = {
651     /**
652      * Return the appropriate empty content value for the current browser.
653      *
654      * Different browsers use a different content when they are empty and
655      * we must set this reliable across the board.
656      *
657      * @method _getEmptyContent
658      * @return String The content to use representing no user-provided content
659      * @private
660      */
661     _getEmptyContent: function() {
662         if (Y.UA.ie && Y.UA.ie < 10) {
663             return '<p></p>';
664         } else {
665             return '<p><br></p>';
666         }
667     },
669     /**
670      * Copy and clean the text from the textarea into the contenteditable div.
671      *
672      * If the text is empty, provide a default paragraph tag to hold the content.
673      *
674      * @method updateFromTextArea
675      * @chainable
676      */
677     updateFromTextArea: function() {
678         // Clear it first.
679         this.editor.setHTML('');
681         // Copy cleaned HTML to editable div.
682         this.editor.append(this._cleanHTML(this.textarea.get('value')));
684         // Insert a paragraph in the empty contenteditable div.
685         if (this.editor.getHTML() === '') {
686             this.editor.setHTML(this._getEmptyContent());
687         }
689         return this;
690     },
692     /**
693      * Copy the text from the contenteditable to the textarea which it replaced.
694      *
695      * @method updateOriginal
696      * @chainable
697      */
698     updateOriginal : function() {
699         // Get the previous and current value to compare them.
700         var oldValue = this.textarea.get('value'),
701             newValue = this.getCleanHTML();
703         if (newValue === "" && this.isActive()) {
704             // The content was entirely empty so get the empty content placeholder.
705             newValue = this._getEmptyContent();
706         }
708         // Only call this when there has been an actual change to reduce processing.
709         if (oldValue !== newValue) {
710             // Insert the cleaned content.
711             this.textarea.set('value', newValue);
713             // Trigger the onchange callback on the textarea, essentially to notify moodle-core-formchangechecker.
714             this.textarea.simulate('change');
716             // Trigger handlers for this action.
717             this.fire('change');
718         }
720         return this;
721     }
722 };
724 Y.Base.mix(Y.M.editor_atto.Editor, [EditorTextArea]);
725 // This file is part of Moodle - http://moodle.org/
726 //
727 // Moodle is free software: you can redistribute it and/or modify
728 // it under the terms of the GNU General Public License as published by
729 // the Free Software Foundation, either version 3 of the License, or
730 // (at your option) any later version.
731 //
732 // Moodle is distributed in the hope that it will be useful,
733 // but WITHOUT ANY WARRANTY; without even the implied warranty of
734 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
735 // GNU General Public License for more details.
736 //
737 // You should have received a copy of the GNU General Public License
738 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
739 /* global NOTIFY_WARNING, NOTIFY_INFO */
740 /* eslint-disable no-unused-vars */
742 /**
743  * A autosave function for the Atto editor.
744  *
745  * @module     moodle-editor_atto-autosave
746  * @submodule  autosave-base
747  * @package    editor_atto
748  * @copyright  2014 Damyon Wiese
749  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
750  */
752 var SUCCESS_MESSAGE_TIMEOUT = 5000,
753     RECOVER_MESSAGE_TIMEOUT = 60000,
754     LOGNAME_AUTOSAVE = 'moodle-editor_atto-editor-autosave';
756 function EditorAutosave() {}
758 EditorAutosave.ATTRS= {
759     /**
760      * Enable/Disable auto save for this instance.
761      *
762      * @attribute autosaveEnabled
763      * @type Boolean
764      * @writeOnce
765      */
766     autosaveEnabled: {
767         value: true,
768         writeOnce: true
769     },
771     /**
772      * The time between autosaves (in seconds).
773      *
774      * @attribute autosaveFrequency
775      * @type Number
776      * @default 60
777      * @writeOnce
778      */
779     autosaveFrequency: {
780         value: 60,
781         writeOnce: true
782     },
784     /**
785      * Unique hash for this page instance. Calculated from $PAGE->url in php.
786      *
787      * @attribute pageHash
788      * @type String
789      * @writeOnce
790      */
791     pageHash: {
792         value: '',
793         writeOnce: true
794     }
795 };
797 EditorAutosave.prototype = {
799     /**
800      * The text that was auto saved in the last request.
801      *
802      * @property lastText
803      * @type string
804      */
805     lastText: "",
807     /**
808      * Autosave instance.
809      *
810      * @property autosaveInstance
811      * @type string
812      */
813     autosaveInstance: null,
815     /**
816      * Autosave Timer.
817      *
818      * @property autosaveTimer
819      * @type object
820      */
821     autosaveTimer: null,
823     /**
824      * Initialize the autosave process
825      *
826      * @method setupAutosave
827      * @chainable
828      */
829     setupAutosave: function() {
830         var draftid = -1,
831             form,
832             optiontype = null,
833             options = this.get('filepickeroptions'),
834             params;
836         if (!this.get('autosaveEnabled')) {
837             // Autosave disabled for this instance.
838             return;
839         }
841         this.autosaveInstance = Y.stamp(this);
842         for (optiontype in options) {
843             if (typeof options[optiontype].itemid !== "undefined") {
844                 draftid = options[optiontype].itemid;
845             }
846         }
848         // First see if there are any saved drafts.
849         // Make an ajax request.
850         params = {
851             contextid: this.get('contextid'),
852             action: 'resume',
853             draftid: draftid,
854             elementid: this.get('elementid'),
855             pageinstance: this.autosaveInstance,
856             pagehash: this.get('pageHash')
857         };
859         this.autosaveIo(params, this, {
860             success: function(response) {
861                 if (response === null) {
862                     // This can happen when there is nothing to resume from.
863                     return;
864                 } else if (!response) {
865                     Y.log('Invalid response received.', 'debug', LOGNAME_AUTOSAVE);
866                     return;
867                 }
869                 // Revert untouched editor contents to an empty string.
870                 // Check for FF and Chrome.
871                 if (response.result === '<p></p>' || response.result === '<p><br></p>' ||
872                     response.result === '<br>') {
873                     response.result = '';
874                 }
876                 // Check for IE 9 and 10.
877                 if (response.result === '<p>&nbsp;</p>' || response.result === '<p><br>&nbsp;</p>') {
878                     response.result = '';
879                 }
881                 if (response.error || typeof response.result === 'undefined') {
882                     Y.log('Error occurred recovering draft text: ' + response.error, 'debug', LOGNAME_AUTOSAVE);
883                     this.showMessage(M.util.get_string('errortextrecovery', 'editor_atto'),
884                             NOTIFY_WARNING, RECOVER_MESSAGE_TIMEOUT);
885                 } else if (response.result !== this.textarea.get('value') &&
886                         response.result !== '') {
887                     Y.log('Autosave text found - recover it.', 'debug', LOGNAME_AUTOSAVE);
888                     this.recoverText(response.result);
889                 }
890                 this._fireSelectionChanged();
892             },
893             failure: function() {
894                 this.showMessage(M.util.get_string('errortextrecovery', 'editor_atto'),
895                         NOTIFY_WARNING, RECOVER_MESSAGE_TIMEOUT);
896             }
897         });
899         // Now setup the timer for periodic saves.
900         var delay = parseInt(this.get('autosaveFrequency'), 10) * 1000;
901         this.autosaveTimer = Y.later(delay, this, this.saveDraft, false, true);
903         // Now setup the listener for form submission.
904         form = this.textarea.ancestor('form');
905         if (form) {
906             this.autosaveIoOnSubmit(form, {
907                 action: 'reset',
908                 contextid: this.get('contextid'),
909                 elementid: this.get('elementid'),
910                 pageinstance: this.autosaveInstance,
911                 pagehash: this.get('pageHash')
912             });
913         }
914         return this;
915     },
917     /**
918      * Recover a previous version of this text and show a message.
919      *
920      * @method recoverText
921      * @param {String} text
922      * @chainable
923      */
924     recoverText: function(text) {
925         this.editor.setHTML(text);
926         this.saveSelection();
927         this.updateOriginal();
928         this.lastText = text;
930         this.showMessage(M.util.get_string('textrecovered', 'editor_atto'),
931                 NOTIFY_INFO, RECOVER_MESSAGE_TIMEOUT);
933         // Fire an event that the editor content has changed.
934         require(['core/event'], function(event) {
935             event.notifyEditorContentRestored();
936         });
938         return this;
939     },
941     /**
942      * Save a single draft via ajax.
943      *
944      * @method saveDraft
945      * @chainable
946      */
947     saveDraft: function() {
948         var url, params;
950         if (!this.editor.getDOMNode()) {
951             // Stop autosaving if the editor was removed from the page.
952             this.autosaveTimer.cancel();
953             return;
954         }
955         // Only copy the text from the div to the textarea if the textarea is not currently visible.
956         if (!this.editor.get('hidden')) {
957             this.updateOriginal();
958         }
959         var newText = this.textarea.get('value');
961         if (newText !== this.lastText) {
962             Y.log('Autosave text', 'debug', LOGNAME_AUTOSAVE);
964             // Make an ajax request.
965             url = M.cfg.wwwroot + this.get('autosaveAjaxScript');
966             params = {
967                 sesskey: M.cfg.sesskey,
968                 contextid: this.get('contextid'),
969                 action: 'save',
970                 drafttext: newText,
971                 elementid: this.get('elementid'),
972                 pagehash: this.get('pageHash'),
973                 pageinstance: this.autosaveInstance
974             };
976             // Reusable error handler - must be passed the correct context.
977             var ajaxErrorFunction = function(response) {
978                 var errorDuration = parseInt(this.get('autosaveFrequency'), 10) * 1000;
979                 Y.log('Error while autosaving text', 'warn', LOGNAME_AUTOSAVE);
980                 Y.log(response, 'warn', LOGNAME_AUTOSAVE);
981                 this.showMessage(M.util.get_string('autosavefailed', 'editor_atto'), NOTIFY_WARNING, errorDuration);
982             };
984             this.autosaveIo(params, this, {
985                 failure: ajaxErrorFunction,
986                 success: function(response) {
987                     if (response && response.error) {
988                         Y.soon(Y.bind(ajaxErrorFunction, this, [response]));
989                     } else {
990                         // All working.
991                         this.lastText = newText;
992                         this.showMessage(M.util.get_string('autosavesucceeded', 'editor_atto'),
993                                 NOTIFY_INFO, SUCCESS_MESSAGE_TIMEOUT);
994                     }
995                 }
996             });
997         }
998         return this;
999     }
1000 };
1002 Y.Base.mix(Y.M.editor_atto.Editor, [EditorAutosave]);
1003 // This file is part of Moodle - http://moodle.org/
1004 //
1005 // Moodle is free software: you can redistribute it and/or modify
1006 // it under the terms of the GNU General Public License as published by
1007 // the Free Software Foundation, either version 3 of the License, or
1008 // (at your option) any later version.
1009 //
1010 // Moodle is distributed in the hope that it will be useful,
1011 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1012 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1013 // GNU General Public License for more details.
1014 //
1015 // You should have received a copy of the GNU General Public License
1016 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1018 /**
1019  * A autosave function for the Atto editor.
1020  *
1021  * @module     moodle-editor_atto-autosave-io
1022  * @submodule  autosave-io
1023  * @package    editor_atto
1024  * @copyright  2016 Frédéric Massart
1025  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1026  */
1028 var EditorAutosaveIoDispatcherInstance = null;
1030 function EditorAutosaveIoDispatcher() {
1031     EditorAutosaveIoDispatcher.superclass.constructor.apply(this, arguments);
1032     this._submitEvents = {};
1033     this._queue = [];
1034     this._throttle = null;
1036 EditorAutosaveIoDispatcher.NAME = 'EditorAutosaveIoDispatcher';
1037 EditorAutosaveIoDispatcher.ATTRS = {
1039     /**
1040      * The relative path to the ajax script.
1041      *
1042      * @attribute autosaveAjaxScript
1043      * @type String
1044      * @default '/lib/editor/atto/autosave-ajax.php'
1045      * @readOnly
1046      */
1047     autosaveAjaxScript: {
1048         value: '/lib/editor/atto/autosave-ajax.php',
1049         readOnly: true
1050     },
1052     /**
1053      * The time buffer for the throttled requested.
1054      *
1055      * @attribute delay
1056      * @type Number
1057      * @default 50
1058      * @readOnly
1059      */
1060     delay: {
1061         value: 50,
1062         readOnly: true
1063     }
1065 };
1066 Y.extend(EditorAutosaveIoDispatcher, Y.Base, {
1068     /**
1069      * Dispatch an IO request.
1070      *
1071      * This method will put the requests in a queue in order to attempt to bulk them.
1072      *
1073      * @param  {Object} params    The parameters of the request.
1074      * @param  {Object} context   The context in which the callbacks are called.
1075      * @param  {Object} callbacks Object with 'success', 'complete', 'end', 'failure' and 'start' as
1076      *                            optional keys defining the callbacks to call. Success and Complete
1077      *                            functions will receive the response as parameter. Success and Complete
1078      *                            may receive an object containing the error key, use this to confirm
1079      *                            that no errors occured.
1080      * @return {Void}
1081      */
1082     dispatch: function(params, context, callbacks) {
1083         if (this._throttle) {
1084             this._throttle.cancel();
1085         }
1087         this._throttle = Y.later(this.get('delay'), this, this._processDispatchQueue);
1088         this._queue.push([params, context, callbacks]);
1089     },
1091     /**
1092      * Dispatches the requests in the queue.
1093      *
1094      * @return {Void}
1095      */
1096     _processDispatchQueue: function() {
1097         var queue = this._queue,
1098             data = {};
1100         this._queue = [];
1101         if (queue.length < 1) {
1102             return;
1103         }
1105         Y.Array.each(queue, function(item, index) {
1106             data[index] = item[0];
1107         });
1109         Y.io(M.cfg.wwwroot + this.get('autosaveAjaxScript'), {
1110             method: 'POST',
1111             data: Y.QueryString.stringify({
1112                 actions: data,
1113                 sesskey: M.cfg.sesskey
1114             }),
1115             on: {
1116                 start: this._makeIoEventCallback('start', queue),
1117                 complete: this._makeIoEventCallback('complete', queue),
1118                 failure: this._makeIoEventCallback('failure', queue),
1119                 end: this._makeIoEventCallback('end', queue),
1120                 success: this._makeIoEventCallback('success', queue)
1121             }
1122         });
1123     },
1125     /**
1126      * Creates a function that dispatches an IO response to callbacks.
1127      *
1128      * @param  {String} event The type of event.
1129      * @param  {Array} queue The queue.
1130      * @return {Function}
1131      */
1132     _makeIoEventCallback: function(event, queue) {
1133         var noop = function() {};
1134         return function() {
1135             var response = arguments[1],
1136                 parsed = {};
1138             if ((event == 'complete' || event == 'success') && (typeof response !== 'undefined'
1139                     && typeof response.responseText !== 'undefined' && response.responseText !== '')) {
1141                 // Success and complete events need to parse the response.
1142                 parsed = JSON.parse(response.responseText) || {};
1143             }
1145             Y.Array.each(queue, function(item, index) {
1146                 var context = item[1],
1147                     cb = (item[2] && item[2][event]) || noop,
1148                     arg;
1150                 if (parsed && parsed.error) {
1151                     // The response is an error, we send it to everyone.
1152                     arg = parsed;
1153                 } else if (parsed) {
1154                     // The response was parsed, we only communicate the relevant portion of the response.
1155                     arg = parsed[index];
1156                 }
1158                 cb.apply(context, [arg]);
1159             });
1160         };
1161     },
1163     /**
1164      * Form submit handler.
1165      *
1166      * @param  {EventFacade} e The event.
1167      * @return {Void}
1168      */
1169     _onSubmit: function(e) {
1170         var data = {},
1171             id = e.currentTarget.generateID(),
1172             params = this._submitEvents[id];
1174         if (!params || params.ios.length < 1) {
1175             return;
1176         }
1178         Y.Array.each(params.ios, function(param, index) {
1179             data[index] = param;
1180         });
1182         Y.io(M.cfg.wwwroot + this.get('autosaveAjaxScript'), {
1183             method: 'POST',
1184             data: Y.QueryString.stringify({
1185                 actions: data,
1186                 sesskey: M.cfg.sesskey
1187             }),
1188             sync: true
1189         });
1190     },
1192     /**
1193      * Registers a request to be made on form submission.
1194      *
1195      * @param  {Node} node The forum node we will listen to.
1196      * @param  {Object} params Parameters for the IO request.
1197      * @return {Void}
1198      */
1199     whenSubmit: function(node, params) {
1200         if (typeof this._submitEvents[node.generateID()] === 'undefined') {
1201             this._submitEvents[node.generateID()] = {
1202                 event: node.on('submit', this._onSubmit, this),
1203                 ios: []
1204             };
1205         }
1206         this._submitEvents[node.get('id')].ios.push([params]);
1207     }
1209 });
1210 EditorAutosaveIoDispatcherInstance = new EditorAutosaveIoDispatcher();
1213 function EditorAutosaveIo() {}
1214 EditorAutosaveIo.prototype = {
1216     /**
1217      * Dispatch an IO request.
1218      *
1219      * This method will put the requests in a queue in order to attempt to bulk them.
1220      *
1221      * @param  {Object} params    The parameters of the request.
1222      * @param  {Object} context   The context in which the callbacks are called.
1223      * @param  {Object} callbacks Object with 'success', 'complete', 'end', 'failure' and 'start' as
1224      *                            optional keys defining the callbacks to call. Success and Complete
1225      *                            functions will receive the response as parameter. Success and Complete
1226      *                            may receive an object containing the error key, use this to confirm
1227      *                            that no errors occured.
1228      * @return {Void}
1229      */
1230     autosaveIo: function(params, context, callbacks) {
1231         EditorAutosaveIoDispatcherInstance.dispatch(params, context, callbacks);
1232     },
1234     /**
1235      * Registers a request to be made on form submission.
1236      *
1237      * @param  {Node} form The forum node we will listen to.
1238      * @param  {Object} params Parameters for the IO request.
1239      * @return {Void}
1240      */
1241     autosaveIoOnSubmit: function(form, params) {
1242         EditorAutosaveIoDispatcherInstance.whenSubmit(form, params);
1243     }
1245 };
1246 Y.Base.mix(Y.M.editor_atto.Editor, [EditorAutosaveIo]);
1247 // This file is part of Moodle - http://moodle.org/
1248 //
1249 // Moodle is free software: you can redistribute it and/or modify
1250 // it under the terms of the GNU General Public License as published by
1251 // the Free Software Foundation, either version 3 of the License, or
1252 // (at your option) any later version.
1253 //
1254 // Moodle is distributed in the hope that it will be useful,
1255 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1256 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1257 // GNU General Public License for more details.
1258 //
1259 // You should have received a copy of the GNU General Public License
1260 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1261 /* global LOGNAME */
1263 /**
1264  * @module moodle-editor_atto-editor
1265  * @submodule clean
1266  */
1268 /**
1269  * Functions for the Atto editor to clean the generated content.
1270  *
1271  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1272  *
1273  * @namespace M.editor_atto
1274  * @class EditorClean
1275  */
1277 function EditorClean() {}
1279 EditorClean.ATTRS= {
1280 };
1282 EditorClean.prototype = {
1283     /**
1284      * Clean the generated HTML content without modifying the editor content.
1285      *
1286      * This includes removes all YUI ids from the generated content.
1287      *
1288      * @return {string} The cleaned HTML content.
1289      */
1290     getCleanHTML: function() {
1291         // Clone the editor so that we don't actually modify the real content.
1292         var editorClone = this.editor.cloneNode(true),
1293             html;
1295         // Remove all YUI IDs.
1296         Y.each(editorClone.all('[id^="yui"]'), function(node) {
1297             node.removeAttribute('id');
1298         });
1300         editorClone.all('.atto_control').remove(true);
1301         html = editorClone.get('innerHTML');
1303         // Revert untouched editor contents to an empty string.
1304         if (html === '<p></p>' || html === '<p><br></p>') {
1305             return '';
1306         }
1308         // Remove any and all nasties from source.
1309        return this._cleanHTML(html);
1310     },
1312     /**
1313      * Clean the HTML content of the editor.
1314      *
1315      * @method cleanEditorHTML
1316      * @chainable
1317      */
1318     cleanEditorHTML: function() {
1319         var startValue = this.editor.get('innerHTML');
1320         this.editor.set('innerHTML', this._cleanHTML(startValue));
1322         return this;
1323     },
1325     /**
1326      * Clean the specified HTML content and remove any content which could cause issues.
1327      *
1328      * @method _cleanHTML
1329      * @private
1330      * @param {String} content The content to clean
1331      * @return {String} The cleaned HTML
1332      */
1333     _cleanHTML: function(content) {
1334         // Removing limited things that can break the page or a disallowed, like unclosed comments, style blocks, etc.
1336         var rules = [
1337             // Remove any style blocks. Some browsers do not work well with them in a contenteditable.
1338             // Plus style blocks are not allowed in body html, except with "scoped", which most browsers don't support as of 2015.
1339             // Reference: "http://stackoverflow.com/questions/1068280/javascript-regex-multiline-flag-doesnt-work"
1340             {regex: /<style[^>]*>[\s\S]*?<\/style>/gi, replace: ""},
1342             // Remove any open HTML comment opens that are not followed by a close. This can completely break page layout.
1343             {regex: /<!--(?![\s\S]*?-->)/gi, replace: ""},
1345             // Source: "http://www.codinghorror.com/blog/2006/01/cleaning-words-nasty-html.html"
1346             // Remove forbidden tags for content, title, meta, style, st0-9, head, font, html, body, link.
1347             {regex: /<\/?(?:title|meta|style|st\d|head|font|html|body|link)[^>]*?>/gi, replace: ""}
1348         ];
1350         return this._filterContentWithRules(content, rules);
1351     },
1353     /**
1354      * Take the supplied content and run on the supplied regex rules.
1355      *
1356      * @method _filterContentWithRules
1357      * @private
1358      * @param {String} content The content to clean
1359      * @param {Array} rules An array of structures: [ {regex: /something/, replace: "something"}, {...}, ...]
1360      * @return {String} The cleaned content
1361      */
1362     _filterContentWithRules: function(content, rules) {
1363         var i = 0;
1364         for (i = 0; i < rules.length; i++) {
1365             content = content.replace(rules[i].regex, rules[i].replace);
1366         }
1368         return content;
1369     },
1371     /**
1372      * Intercept and clean html paste events.
1373      *
1374      * @method pasteCleanup
1375      * @param {Object} sourceEvent The YUI EventFacade  object
1376      * @return {Boolean} True if the passed event should continue, false if not.
1377      */
1378     pasteCleanup: function(sourceEvent) {
1379         // We only expect paste events, but we will check anyways.
1380         if (sourceEvent.type === 'paste') {
1381             // The YUI event wrapper doesn't provide paste event info, so we need the underlying event.
1382             var event = sourceEvent._event;
1383             // Check if we have a valid clipboardData object in the event.
1384             // IE has a clipboard object at window.clipboardData, but as of IE 11, it does not provide HTML content access.
1385             if (event && event.clipboardData && event.clipboardData.getData && event.clipboardData.types) {
1386                 // Check if there is HTML type to be pasted, if we can get it, we want to scrub before insert.
1387                 var types = event.clipboardData.types;
1388                 var isHTML = false;
1389                 // Different browsers use different containers to hold the types, so test various functions.
1390                 if (typeof types.contains === 'function') {
1391                     isHTML = types.contains('text/html');
1392                 } else if (typeof types.indexOf === 'function') {
1393                     isHTML = (types.indexOf('text/html') > -1);
1394                 }
1396                 if (isHTML) {
1397                     // Get the clipboard content.
1398                     var content;
1399                     try {
1400                         content = event.clipboardData.getData('text/html');
1401                     } catch (error) {
1402                         // Something went wrong. Fallback.
1403                         this.fallbackPasteCleanupDelayed();
1404                         return true;
1405                     }
1407                     // Stop the original paste.
1408                     sourceEvent.preventDefault();
1410                     // Scrub the paste content.
1411                     content = this._cleanPasteHTML(content);
1413                     // Save the current selection.
1414                     // Using saveSelection as it produces a more consistent experience.
1415                     var selection = window.rangy.saveSelection();
1417                     // Insert the content.
1418                     this.insertContentAtFocusPoint(content);
1420                     // Restore the selection, and collapse to end.
1421                     window.rangy.restoreSelection(selection);
1422                     window.rangy.getSelection().collapseToEnd();
1424                     // Update the text area.
1425                     this.updateOriginal();
1426                     return false;
1427                 } else {
1428                     // Due to poor cross browser clipboard compatibility, the failure to find html doesn't mean it isn't there.
1429                     // Wait for the clipboard event to finish then fallback clean the entire editor.
1430                     this.fallbackPasteCleanupDelayed();
1431                     return true;
1432                 }
1433             } else {
1434                 // If we reached a here, this probably means the browser has limited (or no) clipboard support.
1435                 // Wait for the clipboard event to finish then fallback clean the entire editor.
1436                 this.fallbackPasteCleanupDelayed();
1437                 return true;
1438             }
1439         }
1441         // We should never get here - we must have received a non-paste event for some reason.
1442         // Um, just call updateOriginalDelayed() - it's safe.
1443         this.updateOriginalDelayed();
1444         return true;
1445     },
1447     /**
1448      * Cleanup code after a paste event if we couldn't intercept the paste content.
1449      *
1450      * @method fallbackPasteCleanup
1451      * @chainable
1452      */
1453     fallbackPasteCleanup: function() {
1454         Y.log('Using fallbackPasteCleanup for atto cleanup', 'debug', LOGNAME);
1456         // Save the current selection (cursor position).
1457         var selection = window.rangy.saveSelection();
1459         // Get, clean, and replace the content in the editable.
1460         var content = this.editor.get('innerHTML');
1461         this.editor.set('innerHTML', this._cleanPasteHTML(content));
1463         // Update the textarea.
1464         this.updateOriginal();
1466         // Restore the selection (cursor position).
1467         window.rangy.restoreSelection(selection);
1469         return this;
1470     },
1472     /**
1473      * Calls fallbackPasteCleanup on a short timer to allow the paste event handlers to complete.
1474      *
1475      * @method fallbackPasteCleanupDelayed
1476      * @chainable
1477      */
1478     fallbackPasteCleanupDelayed: function() {
1479         Y.soon(Y.bind(this.fallbackPasteCleanup, this));
1481         return this;
1482     },
1484     /**
1485      * Cleanup html that comes from WYSIWYG paste events. These are more likely to contain messy code that we should strip.
1486      *
1487      * @method _cleanPasteHTML
1488      * @private
1489      * @param {String} content The html content to clean
1490      * @return {String} The cleaned HTML
1491      */
1492     _cleanPasteHTML: function(content) {
1493         // Return an empty string if passed an invalid or empty object.
1494         if (!content || content.length === 0) {
1495             return "";
1496         }
1498         // Rules that get rid of the real-nasties and don't care about normalize code (correct quotes, white spaces, etc).
1499         var rules = [
1500             // Stuff that is specifically from MS Word and similar office packages.
1501             // Remove all garbage after closing html tag.
1502             {regex: /<\s*\/html\s*>([\s\S]+)$/gi, replace: ""},
1503             // Remove if comment blocks.
1504             {regex: /<!--\[if[\s\S]*?endif\]-->/gi, replace: ""},
1505             // Remove start and end fragment comment blocks.
1506             {regex: /<!--(Start|End)Fragment-->/gi, replace: ""},
1507             // Remove any xml blocks.
1508             {regex: /<xml[^>]*>[\s\S]*?<\/xml>/gi, replace: ""},
1509             // Remove any <?xml><\?xml> blocks.
1510             {regex: /<\?xml[^>]*>[\s\S]*?<\\\?xml>/gi, replace: ""},
1511             // Remove <o:blah>, <\o:blah>.
1512             {regex: /<\/?\w+:[^>]*>/gi, replace: ""}
1513         ];
1515         // Apply the first set of harsher rules.
1516         content = this._filterContentWithRules(content, rules);
1518         // Apply the standard rules, which mainly cleans things like headers, links, and style blocks.
1519         content = this._cleanHTML(content);
1521         // Check if the string is empty or only contains whitespace.
1522         if (content.length === 0 || !content.match(/\S/)) {
1523             return content;
1524         }
1526         // Now we let the browser normalize the code by loading it into the DOM and then get the html back.
1527         // This gives us well quoted, well formatted code to continue our work on. Word may provide very poorly formatted code.
1528         var holder = document.createElement('div');
1529         holder.innerHTML = content;
1530         content = holder.innerHTML;
1531         // Free up the DOM memory.
1532         holder.innerHTML = "";
1534         // Run some more rules that care about quotes and whitespace.
1535         rules = [
1536             // Get all class attributes so we can work on them.
1537             {regex: /(<[^>]*?class\s*?=\s*?")([^>"]*)(")/gi, replace: function(match, group1, group2, group3) {
1538                     // Remove MSO classes.
1539                     group2 = group2.replace(/(?:^|[\s])[\s]*MSO[_a-zA-Z0-9\-]*/gi,"");
1540                     // Remove Apple- classes.
1541                     group2 = group2.replace(/(?:^|[\s])[\s]*Apple-[_a-zA-Z0-9\-]*/gi,"");
1542                     return group1 + group2 + group3;
1543                 }},
1544             // Remove OLE_LINK# anchors that may litter the code.
1545             {regex: /<a [^>]*?name\s*?=\s*?"OLE_LINK\d*?"[^>]*?>\s*?<\/a>/gi, replace: ""}
1546         ];
1548         // Clean all style attributes from the text.
1549         content = this._cleanStyles(content);
1551         // Apply the rules.
1552         content = this._filterContentWithRules(content, rules);
1554         // Reapply the standard cleaner to the content.
1555         content = this._cleanHTML(content);
1557         // Clean unused spans out of the content.
1558         content = this._cleanSpans(content);
1560         return content;
1561     },
1563     /**
1564      * Clean all inline styles from pasted text.
1565      *
1566      * This code intentionally doesn't use YUI Nodes. YUI was quite a bit slower at this, so using raw DOM objects instead.
1567      *
1568      * @method _cleanStyles
1569      * @private
1570      * @param {String} content The content to clean
1571      * @return {String} The cleaned HTML
1572      */
1573     _cleanStyles: function(content) {
1574         var holder = document.createElement('div');
1575         holder.innerHTML = content;
1576         var elementsWithStyle = holder.querySelectorAll('[style]');
1577         var i = 0;
1579         for (i = 0; i < elementsWithStyle.length; i++) {
1580             elementsWithStyle[i].removeAttribute('style');
1581         }
1583         var elementsWithClass = holder.querySelectorAll('[class]');
1584         for (i = 0; i < elementsWithClass.length; i++) {
1585             elementsWithClass[i].removeAttribute('class');
1586         }
1588         return holder.innerHTML;
1589     },
1590     /**
1591      * Clean empty or un-unused spans from passed HTML.
1592      *
1593      * This code intentionally doesn't use YUI Nodes. YUI was quite a bit slower at this, so using raw DOM objects instead.
1594      *
1595      * @method _cleanSpans
1596      * @private
1597      * @param {String} content The content to clean
1598      * @return {String} The cleaned HTML
1599      */
1600     _cleanSpans: function(content) {
1601         // Return an empty string if passed an invalid or empty object.
1602         if (!content || content.length === 0) {
1603             return "";
1604         }
1605         // Check if the string is empty or only contains whitespace.
1606         if (content.length === 0 || !content.match(/\S/)) {
1607             return content;
1608         }
1610         var rules = [
1611             // Remove unused class, style, or id attributes. This will make empty tag detection easier later.
1612             {regex: /(<[^>]*?)(?:[\s]*(?:class|style|id)\s*?=\s*?"\s*?")+/gi, replace: "$1"}
1613         ];
1614         // Apply the rules.
1615         content = this._filterContentWithRules(content, rules);
1617         // Reference: "http://stackoverflow.com/questions/8131396/remove-nested-span-without-id"
1619         // This is better to run detached from the DOM, so the browser doesn't try to update on each change.
1620         var holder = document.createElement('div');
1621         holder.innerHTML = content;
1622         var spans = holder.getElementsByTagName('span');
1624         // Since we will be removing elements from the list, we should copy it to an array, making it static.
1625         var spansarr = Array.prototype.slice.call(spans, 0);
1627         spansarr.forEach(function(span) {
1628             if (!span.hasAttributes()) {
1629                 // If no attributes (id, class, style, etc), this span is has no effect.
1630                 // Move each child (if they exist) to the parent in place of this span.
1631                 while (span.firstChild) {
1632                     span.parentNode.insertBefore(span.firstChild, span);
1633                 }
1635                 // Remove the now empty span.
1636                 span.parentNode.removeChild(span);
1637             }
1638         });
1640         return holder.innerHTML;
1641     }
1642 };
1644 Y.Base.mix(Y.M.editor_atto.Editor, [EditorClean]);
1645 // This file is part of Moodle - http://moodle.org/
1646 //
1647 // Moodle is free software: you can redistribute it and/or modify
1648 // it under the terms of the GNU General Public License as published by
1649 // the Free Software Foundation, either version 3 of the License, or
1650 // (at your option) any later version.
1651 //
1652 // Moodle is distributed in the hope that it will be useful,
1653 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1654 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1655 // GNU General Public License for more details.
1656 //
1657 // You should have received a copy of the GNU General Public License
1658 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1660 /**
1661  * @module moodle-editor_atto-editor
1662  * @submodule commands
1663  */
1665 /**
1666  * Selection functions for the Atto editor.
1667  *
1668  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1669  *
1670  * @namespace M.editor_atto
1671  * @class EditorCommand
1672  */
1674 function EditorCommand() {}
1676 EditorCommand.ATTRS= {
1677 };
1679 EditorCommand.prototype = {
1680     /**
1681      * Applies a callback method to editor if selection is uncollapsed or waits for input to select first.
1682      * @method applyFormat
1683      * @param e EventTarget Event to be passed to callback if selection is uncollapsed
1684      * @param method callback A callback method which changes editor when text is selected.
1685      * @param object context Context to be used for callback method
1686      * @param array args Array of arguments to pass to callback
1687      */
1688     applyFormat: function(e, callback, context, args) {
1689         function handleInsert(e, callback, context, args, anchorNode, anchorOffset) {
1690             // After something is inputed, select it and apply the formating function.
1691             Y.soon(Y.bind(function(e, callback, context, args, anchorNode, anchorOffset) {
1692                 var selection = window.rangy.getSelection();
1694                 // Set the start of the selection to where it was when the method was first called.
1695                 var range = selection.getRangeAt(0);
1696                 range.setStart(anchorNode, anchorOffset);
1697                 selection.setSingleRange(range);
1699                 // Now apply callback to the new text that is selected.
1700                 callback.apply(context, [e, args]);
1702                 // Collapse selection so cursor is at end of inserted material.
1703                 selection.collapseToEnd();
1705                 // Save save selection and editor contents.
1706                 this.saveSelection();
1707                 this.updateOriginal();
1708             }, this, e, callback, context, args, anchorNode, anchorOffset));
1709         }
1711         // Set default context for the method.
1712         context = context || this;
1714         // Check whether range is collapsed.
1715         var selection = window.rangy.getSelection();
1717         if (selection.isCollapsed) {
1718             // Selection is collapsed so listen for input into editor.
1719             var handle = this.editor.once('input', handleInsert, this, callback, context, args,
1720                     selection.anchorNode, selection.anchorOffset);
1722             // Cancel if selection changes before input.
1723             this.editor.onceAfter(['click', 'selectstart'], handle.detach, handle);
1725             return;
1726         }
1728         // The range is not collapsed; so apply callback method immediately.
1729         callback.apply(context, [e, args]);
1731         // Save save selection and editor contents.
1732         this.saveSelection();
1733         this.updateOriginal();
1734     },
1736     /**
1737      * Replaces all the tags in a node list with new type.
1738      * @method replaceTags
1739      * @param NodeList nodelist
1740      * @param String tag
1741      */
1742     replaceTags: function(nodelist, tag) {
1743         // We mark elements in the node list for iterations.
1744         nodelist.setAttribute('data-iterate', true);
1745         var node = this.editor.one('[data-iterate="true"]');
1746         while (node) {
1747             var clone = Y.Node.create('<' + tag + ' />')
1748                 .setAttrs(node.getAttrs())
1749                 .removeAttribute('data-iterate');
1750             // Copy class and style if not blank.
1751             if (node.getAttribute('style')) {
1752                 clone.setAttribute('style', node.getAttribute('style'));
1753             }
1754             if (node.getAttribute('class')) {
1755                 clone.setAttribute('class', node.getAttribute('class'));
1756             }
1757             // We use childNodes here because we are interested in both type 1 and 3 child nodes.
1758             var children = node.getDOMNode().childNodes, child;
1759             child = children[0];
1760             while (typeof child !== "undefined") {
1761                 clone.append(child);
1762                 child = children[0];
1763             }
1764             node.replace(clone);
1765             node = this.editor.one('[data-iterate="true"]');
1766         }
1767     },
1769     /**
1770      * Change all tags with given type to a span with CSS class attribute.
1771      * @method changeToCSS
1772      * @param String tag Tag type to be changed to span
1773      * @param String markerClass CSS class that corresponds to desired tag
1774      */
1775     changeToCSS: function(tag, markerClass) {
1776         // Save the selection.
1777         var selection = window.rangy.saveSelection();
1779         // Remove display:none from rangy markers so browser doesn't delete them.
1780         this.editor.all('.rangySelectionBoundary').setStyle('display', null);
1782         // Replace tags with CSS classes.
1783         this.editor.all(tag).addClass(markerClass);
1784         this.replaceTags(this.editor.all('.' + markerClass), 'span');
1786         // Restore selection and toggle class.
1787         window.rangy.restoreSelection(selection);
1788     },
1790     /**
1791      * Change spans with CSS classes in editor into elements with given tag.
1792      * @method changeToCSS
1793      * @param String markerClass CSS class that corresponds to desired tag
1794      * @param String tag New tag type to be created
1795      */
1796     changeToTags: function(markerClass, tag) {
1797         // Save the selection.
1798         var selection = window.rangy.saveSelection();
1800         // Remove display:none from rangy markers so browser doesn't delete them.
1801         this.editor.all('.rangySelectionBoundary').setStyle('display', null);
1803         // Replace spans with given tag.
1804         this.replaceTags(this.editor.all('span[class="' + markerClass + '"]'), tag);
1805         this.editor.all(tag + '[class="' + markerClass + '"]').removeAttribute('class');
1806         this.editor.all('.' + markerClass).each(function(n) {
1807             n.wrap('<' + tag + '/>');
1808             n.removeClass(markerClass);
1809         });
1811         // Remove CSS classes.
1812         this.editor.all('[class="' + markerClass + '"]').removeAttribute('class');
1813         this.editor.all(tag).removeClass(markerClass);
1815         // Restore selection.
1816         window.rangy.restoreSelection(selection);
1817     }
1818 };
1820 Y.Base.mix(Y.M.editor_atto.Editor, [EditorCommand]);
1821 // This file is part of Moodle - http://moodle.org/
1822 //
1823 // Moodle is free software: you can redistribute it and/or modify
1824 // it under the terms of the GNU General Public License as published by
1825 // the Free Software Foundation, either version 3 of the License, or
1826 // (at your option) any later version.
1827 //
1828 // Moodle is distributed in the hope that it will be useful,
1829 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1830 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1831 // GNU General Public License for more details.
1832 //
1833 // You should have received a copy of the GNU General Public License
1834 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1836 /**
1837  * @module moodle-editor_atto-editor
1838  * @submodule toolbar
1839  */
1841 /**
1842  * Toolbar functions for the Atto editor.
1843  *
1844  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1845  *
1846  * @namespace M.editor_atto
1847  * @class EditorToolbar
1848  */
1850 function EditorToolbar() {}
1852 EditorToolbar.ATTRS= {
1853 };
1855 EditorToolbar.prototype = {
1856     /**
1857      * A reference to the toolbar Node.
1858      *
1859      * @property toolbar
1860      * @type Node
1861      */
1862     toolbar: null,
1864     /**
1865      * A reference to any currently open menus in the toolbar.
1866      *
1867      * @property openMenus
1868      * @type Array
1869      */
1870     openMenus: null,
1872     /**
1873      * Setup the toolbar on the editor.
1874      *
1875      * @method setupToolbar
1876      * @chainable
1877      */
1878     setupToolbar: function() {
1879         this.toolbar = Y.Node.create('<div class="' + CSS.TOOLBAR + '" role="toolbar" aria-live="off"/>');
1880         this.openMenus = [];
1881         this._wrapper.appendChild(this.toolbar);
1883         if (this.textareaLabel) {
1884             this.toolbar.setAttribute('aria-labelledby', this.textareaLabel.get("id"));
1885         }
1887         // Add keyboard navigation for the toolbar.
1888         this.setupToolbarNavigation();
1890         return this;
1891     }
1892 };
1894 Y.Base.mix(Y.M.editor_atto.Editor, [EditorToolbar]);
1895 // This file is part of Moodle - http://moodle.org/
1896 //
1897 // Moodle is free software: you can redistribute it and/or modify
1898 // it under the terms of the GNU General Public License as published by
1899 // the Free Software Foundation, either version 3 of the License, or
1900 // (at your option) any later version.
1901 //
1902 // Moodle is distributed in the hope that it will be useful,
1903 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1904 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1905 // GNU General Public License for more details.
1906 //
1907 // You should have received a copy of the GNU General Public License
1908 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1909 /* global LOGNAME */
1911 /**
1912  * @module moodle-editor_atto-editor
1913  * @submodule toolbarnav
1914  */
1916 /**
1917  * Toolbar Navigation functions for the Atto editor.
1918  *
1919  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1920  *
1921  * @namespace M.editor_atto
1922  * @class EditorToolbarNav
1923  */
1925 function EditorToolbarNav() {}
1927 EditorToolbarNav.ATTRS= {
1928 };
1930 EditorToolbarNav.prototype = {
1931     /**
1932      * The current focal point for tabbing.
1933      *
1934      * @property _tabFocus
1935      * @type Node
1936      * @default null
1937      * @private
1938      */
1939     _tabFocus: null,
1941     /**
1942      * Set up the watchers for toolbar navigation.
1943      *
1944      * @method setupToolbarNavigation
1945      * @chainable
1946      */
1947     setupToolbarNavigation: function() {
1948         // Listen for Arrow left and Arrow right keys.
1949         this._wrapper.delegate('key',
1950                 this.toolbarKeyboardNavigation,
1951                 'down:37,39',
1952                 '.' + CSS.TOOLBAR,
1953                 this);
1954         this._wrapper.delegate('focus',
1955                 function(e) {
1956                     this._setTabFocus(e.currentTarget);
1957                 }, '.' + CSS.TOOLBAR + ' button', this);
1959         return this;
1960     },
1962     /**
1963      * Implement arrow key navigation for the buttons in the toolbar.
1964      *
1965      * @method toolbarKeyboardNavigation
1966      * @param {EventFacade} e - the keyboard event.
1967      */
1968     toolbarKeyboardNavigation: function(e) {
1969         // Prevent the default browser behaviour.
1970         e.preventDefault();
1972         // On cursor moves we loops through the buttons.
1973         var buttons = this.toolbar.all('button'),
1974             direction = 1,
1975             button,
1976             current = e.target.ancestor('button', true);
1978         if (e.keyCode === 37) {
1979             // Moving left so reverse the direction.
1980             direction = -1;
1981         }
1983         button = this._findFirstFocusable(buttons, current, direction);
1984         if (button) {
1985             button.focus();
1986             this._setTabFocus(button);
1987         } else {
1988             Y.log("Unable to find a button to focus on", 'debug', LOGNAME);
1989         }
1990     },
1992     /**
1993      * Find the first focusable button.
1994      *
1995      * @param {NodeList} buttons A list of nodes.
1996      * @param {Node} startAt The node in the list to start the search from.
1997      * @param {Number} direction The direction in which to search (1 or -1).
1998      * @return {Node | Undefined} The Node or undefined.
1999      * @method _findFirstFocusable
2000      * @private
2001      */
2002     _findFirstFocusable: function(buttons, startAt, direction) {
2003         var checkCount = 0,
2004             group,
2005             candidate,
2006             button,
2007             index;
2009         // Determine which button to start the search from.
2010         index = buttons.indexOf(startAt);
2011         if (index < -1) {
2012             Y.log("Unable to find the button in the list of buttons", 'debug', LOGNAME);
2013             index = 0;
2014         }
2016         // Try to find the next.
2017         while (checkCount < buttons.size()) {
2018             index += direction;
2019             if (index < 0) {
2020                 index = buttons.size() - 1;
2021             } else if (index >= buttons.size()) {
2022                 // Handle wrapping.
2023                 index = 0;
2024             }
2026             candidate = buttons.item(index);
2028             // Add a counter to ensure we don't get stuck in a loop if there's only one visible menu item.
2029             checkCount++;
2031             // Loop while:
2032             // * we haven't checked every button;
2033             // * the button is hidden or disabled;
2034             // * the group is hidden.
2035             if (candidate.hasAttribute('hidden') || candidate.hasAttribute('disabled')) {
2036                 continue;
2037             }
2038             group = candidate.ancestor('.atto_group');
2039             if (group.hasAttribute('hidden')) {
2040                 continue;
2041             }
2043             button = candidate;
2044             break;
2045         }
2047         return button;
2048     },
2050     /**
2051      * Check the tab focus.
2052      *
2053      * When we disable or hide a button, we should call this method to ensure that the
2054      * focus is not currently set on an inaccessible button, otherwise tabbing to the toolbar
2055      * would be impossible.
2056      *
2057      * @method checkTabFocus
2058      * @chainable
2059      */
2060     checkTabFocus: function() {
2061         if (this._tabFocus) {
2062             if (this._tabFocus.hasAttribute('disabled') || this._tabFocus.hasAttribute('hidden')
2063                     || this._tabFocus.ancestor('.atto_group').hasAttribute('hidden')) {
2064                 // Find first available button.
2065                 var button = this._findFirstFocusable(this.toolbar.all('button'), this._tabFocus, -1);
2066                 if (button) {
2067                     if (this._tabFocus.compareTo(document.activeElement)) {
2068                         // We should also move the focus, because the inaccessible button also has the focus.
2069                         button.focus();
2070                     }
2071                     this._setTabFocus(button);
2072                 }
2073             }
2074         }
2075         return this;
2076     },
2078     /**
2079      * Sets tab focus for the toolbar to the specified Node.
2080      *
2081      * @method _setTabFocus
2082      * @param {Node} button The node that focus should now be set to
2083      * @chainable
2084      * @private
2085      */
2086     _setTabFocus: function(button) {
2087         if (this._tabFocus) {
2088             // Unset the previous entry.
2089             this._tabFocus.setAttribute('tabindex', '-1');
2090         }
2092         // Set up the new entry.
2093         this._tabFocus = button;
2094         this._tabFocus.setAttribute('tabindex', 0);
2096         // And update the activedescendant to point at the currently selected button.
2097         this.toolbar.setAttribute('aria-activedescendant', this._tabFocus.generateID());
2099         return this;
2100     }
2101 };
2103 Y.Base.mix(Y.M.editor_atto.Editor, [EditorToolbarNav]);
2104 // This file is part of Moodle - http://moodle.org/
2105 //
2106 // Moodle is free software: you can redistribute it and/or modify
2107 // it under the terms of the GNU General Public License as published by
2108 // the Free Software Foundation, either version 3 of the License, or
2109 // (at your option) any later version.
2110 //
2111 // Moodle is distributed in the hope that it will be useful,
2112 // but WITHOUT ANY WARRANTY; without even the implied warranty of
2113 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2114 // GNU General Public License for more details.
2115 //
2116 // You should have received a copy of the GNU General Public License
2117 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
2118 /* global rangy */
2120 /**
2121  * @module moodle-editor_atto-editor
2122  * @submodule selection
2123  */
2125 /**
2126  * Selection functions for the Atto editor.
2127  *
2128  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
2129  *
2130  * @namespace M.editor_atto
2131  * @class EditorSelection
2132  */
2134 function EditorSelection() {}
2136 EditorSelection.ATTRS= {
2137 };
2139 EditorSelection.prototype = {
2141     /**
2142      * List of saved selections per editor instance.
2143      *
2144      * @property _selections
2145      * @private
2146      */
2147     _selections: null,
2149     /**
2150      * A unique identifier for the last selection recorded.
2151      *
2152      * @property _lastSelection
2153      * @param lastselection
2154      * @type string
2155      * @private
2156      */
2157     _lastSelection: null,
2159     /**
2160      * Whether focus came from a click event.
2161      *
2162      * This is used to determine whether to restore the selection or not.
2163      *
2164      * @property _focusFromClick
2165      * @type Boolean
2166      * @default false
2167      * @private
2168      */
2169     _focusFromClick: false,
2171     /**
2172      * Whether if the last gesturemovestart event target was contained in this editor or not.
2173      *
2174      * @property _gesturestartededitor
2175      * @type Boolean
2176      * @default false
2177      * @private
2178      */
2179     _gesturestartededitor: false,
2181     /**
2182      * Set up the watchers for selection save and restoration.
2183      *
2184      * @method setupSelectionWatchers
2185      * @chainable
2186      */
2187     setupSelectionWatchers: function() {
2188         // Save the selection when a change was made.
2189         this.on('atto:selectionchanged', this.saveSelection, this);
2191         this.editor.on('focus', this.restoreSelection, this);
2193         // Do not restore selection when focus is from a click event.
2194         this.editor.on('mousedown', function() {
2195             this._focusFromClick = true;
2196         }, this);
2198         // Copy the current value back to the textarea when focus leaves us and save the current selection.
2199         this.editor.on('blur', function() {
2200             // Clear the _focusFromClick value.
2201             this._focusFromClick = false;
2203             // Update the original text area.
2204             this.updateOriginal();
2205         }, this);
2207         this.editor.on(['keyup', 'focus'], function(e) {
2208                 Y.soon(Y.bind(this._hasSelectionChanged, this, e));
2209             }, this);
2211         Y.one(document.body).on('gesturemovestart', function(e) {
2212             if (this._wrapper.contains(e.target._node)) {
2213                 this._gesturestartededitor = true;
2214             } else {
2215                 this._gesturestartededitor = false;
2216             }
2217         }, null, this);
2219         Y.one(document.body).on('gesturemoveend', function(e) {
2220             if (!this._gesturestartededitor) {
2221                 // Ignore the event if movestart target was not contained in the editor.
2222                 return;
2223             }
2224             Y.soon(Y.bind(this._hasSelectionChanged, this, e));
2225         }, {
2226             // Standalone will make sure all editors receive the end event.
2227             standAlone: true
2228         }, this);
2230         return this;
2231     },
2233     /**
2234      * Work out if the cursor is in the editable area for this editor instance.
2235      *
2236      * @method isActive
2237      * @return {boolean}
2238      */
2239     isActive: function() {
2240         var range = rangy.createRange(),
2241             selection = rangy.getSelection();
2243         if (!selection.rangeCount) {
2244             // If there was no range count, then there is no selection.
2245             return false;
2246         }
2248         // We can't be active if the editor doesn't have focus at the moment.
2249         if (!document.activeElement ||
2250                 !(this.editor.compareTo(document.activeElement) || this.editor.contains(document.activeElement))) {
2251             return false;
2252         }
2254         // Check whether the range intersects the editor selection.
2255         range.selectNode(this.editor.getDOMNode());
2256         return range.intersectsRange(selection.getRangeAt(0));
2257     },
2259     /**
2260      * Create a cross browser selection object that represents a YUI node.
2261      *
2262      * @method getSelectionFromNode
2263      * @param {Node} YUI Node to base the selection upon.
2264      * @return {[rangy.Range]}
2265      */
2266     getSelectionFromNode: function(node) {
2267         var range = rangy.createRange();
2268         range.selectNode(node.getDOMNode());
2269         return [range];
2270     },
2272     /**
2273      * Save the current selection to an internal property.
2274      *
2275      * This allows more reliable return focus, helping improve keyboard navigation.
2276      *
2277      * Should be used in combination with {{#crossLink "M.editor_atto.EditorSelection/restoreSelection"}}{{/crossLink}}.
2278      *
2279      * @method saveSelection
2280      */
2281     saveSelection: function() {
2282         if (this.isActive()) {
2283             this._selections = this.getSelection();
2284         }
2285     },
2287     /**
2288      * Restore any stored selection when the editor gets focus again.
2289      *
2290      * Should be used in combination with {{#crossLink "M.editor_atto.EditorSelection/saveSelection"}}{{/crossLink}}.
2291      *
2292      * @method restoreSelection
2293      */
2294     restoreSelection: function() {
2295         if (!this._focusFromClick) {
2296             if (this._selections) {
2297                 this.setSelection(this._selections);
2298             }
2299         }
2300         this._focusFromClick = false;
2301     },
2303     /**
2304      * Get the selection object that can be passed back to setSelection.
2305      *
2306      * @method getSelection
2307      * @return {array} An array of rangy ranges.
2308      */
2309     getSelection: function() {
2310         return rangy.getSelection().getAllRanges();
2311     },
2313     /**
2314      * Check that a YUI node it at least partly contained by the current selection.
2315      *
2316      * @method selectionContainsNode
2317      * @param {Node} The node to check.
2318      * @return {boolean}
2319      */
2320     selectionContainsNode: function(node) {
2321         return rangy.getSelection().containsNode(node.getDOMNode(), true);
2322     },
2324     /**
2325      * Runs a filter on each node in the selection, and report whether the
2326      * supplied selector(s) were found in the supplied Nodes.
2327      *
2328      * By default, all specified nodes must match the selection, but this
2329      * can be controlled with the requireall property.
2330      *
2331      * @method selectionFilterMatches
2332      * @param {String} selector
2333      * @param {NodeList} [selectednodes] For performance this should be passed. If not passed, this will be looked up each time.
2334      * @param {Boolean} [requireall=true] Used to specify that "any" match is good enough.
2335      * @return {Boolean}
2336      */
2337     selectionFilterMatches: function(selector, selectednodes, requireall) {
2338         if (typeof requireall === 'undefined') {
2339             requireall = true;
2340         }
2341         if (!selectednodes) {
2342             // Find this because it was not passed as a param.
2343             selectednodes = this.getSelectedNodes();
2344         }
2345         var allmatch = selectednodes.size() > 0,
2346             anymatch = false;
2348         var editor = this.editor,
2349             stopFn = function(node) {
2350                 // The function getSelectedNodes only returns nodes within the editor, so this test is safe.
2351                 return node === editor;
2352             };
2354         // If we do not find at least one match in the editor, no point trying to find them in the selection.
2355         if (!editor.one(selector)) {
2356             return false;
2357         }
2359         selectednodes.each(function(node){
2360             // Check each node, if it doesn't match the tags AND is not within the specified tags then fail this thing.
2361             if (requireall) {
2362                 // Check for at least one failure.
2363                 if (!allmatch || !node.ancestor(selector, true, stopFn)) {
2364                     allmatch = false;
2365                 }
2366             } else {
2367                 // Check for at least one match.
2368                 if (!anymatch && node.ancestor(selector, true, stopFn)) {
2369                     anymatch = true;
2370                 }
2371             }
2372         }, this);
2373         if (requireall) {
2374             return allmatch;
2375         } else {
2376             return anymatch;
2377         }
2378     },
2380     /**
2381      * Get the deepest possible list of nodes in the current selection.
2382      *
2383      * @method getSelectedNodes
2384      * @return {NodeList}
2385      */
2386     getSelectedNodes: function() {
2387         var results = new Y.NodeList(),
2388             nodes,
2389             selection,
2390             range,
2391             node,
2392             i;
2394         selection = rangy.getSelection();
2396         if (selection.rangeCount) {
2397             range = selection.getRangeAt(0);
2398         } else {
2399             // Empty range.
2400             range = rangy.createRange();
2401         }
2403         if (range.collapsed) {
2404             // We do not want to select all the nodes in the editor if we managed to
2405             // have a collapsed selection directly in the editor.
2406             // It's also possible for the commonAncestorContainer to be the document, which selectNode does not handle
2407             // so we must filter that out here too.
2408             if (range.commonAncestorContainer !== this.editor.getDOMNode()
2409                     && range.commonAncestorContainer !== Y.config.doc) {
2410                 range = range.cloneRange();
2411                 range.selectNode(range.commonAncestorContainer);
2412             }
2413         }
2415         nodes = range.getNodes();
2417         for (i = 0; i < nodes.length; i++) {
2418             node = Y.one(nodes[i]);
2419             if (this.editor.contains(node)) {
2420                 results.push(node);
2421             }
2422         }
2423         return results;
2424     },
2426     /**
2427      * Check whether the current selection has changed since this method was last called.
2428      *
2429      * If the selection has changed, the atto:selectionchanged event is also fired.
2430      *
2431      * @method _hasSelectionChanged
2432      * @private
2433      * @param {EventFacade} e
2434      * @return {Boolean}
2435      */
2436     _hasSelectionChanged: function(e) {
2437         var selection = rangy.getSelection(),
2438             range,
2439             changed = false;
2441         if (selection.rangeCount) {
2442             range = selection.getRangeAt(0);
2443         } else {
2444             // Empty range.
2445             range = rangy.createRange();
2446         }
2448         if (this._lastSelection) {
2449             if (!this._lastSelection.equals(range)) {
2450                 changed = true;
2451                 return this._fireSelectionChanged(e);
2452             }
2453         }
2454         this._lastSelection = range;
2455         return changed;
2456     },
2458     /**
2459      * Fires the atto:selectionchanged event.
2460      *
2461      * When the selectionchanged event is fired, the following arguments are provided:
2462      *   - event : the original event that lead to this event being fired.
2463      *   - selectednodes :  an array containing nodes that are entirely selected of contain partially selected content.
2464      *
2465      * @method _fireSelectionChanged
2466      * @private
2467      * @param {EventFacade} e
2468      */
2469     _fireSelectionChanged: function(e) {
2470         this.fire('atto:selectionchanged', {
2471             event: e,
2472             selectedNodes: this.getSelectedNodes()
2473         });
2474     },
2476     /**
2477      * Get the DOM node representing the common anscestor of the selection nodes.
2478      *
2479      * @method getSelectionParentNode
2480      * @return {Element|boolean} The DOM Node for this parent, or false if no seletion was made.
2481      */
2482     getSelectionParentNode: function() {
2483         var selection = rangy.getSelection();
2484         if (selection.rangeCount) {
2485             return selection.getRangeAt(0).commonAncestorContainer;
2486         }
2487         return false;
2488     },
2490     /**
2491      * Set the current selection. Used to restore a selection.
2492      *
2493      * @method selection
2494      * @param {array} ranges A list of rangy.range objects in the selection.
2495      */
2496     setSelection: function(ranges) {
2497         var selection = rangy.getSelection();
2498         selection.setRanges(ranges);
2499     },
2501     /**
2502      * Inserts the given HTML into the editable content at the currently focused point.
2503      *
2504      * @method insertContentAtFocusPoint
2505      * @param {String} html
2506      * @return {Node} The YUI Node object added to the DOM.
2507      */
2508     insertContentAtFocusPoint: function(html) {
2509         var selection = rangy.getSelection(),
2510             range,
2511             node = Y.Node.create(html);
2512         if (selection.rangeCount) {
2513             range = selection.getRangeAt(0);
2514         }
2515         if (range) {
2516             range.deleteContents();
2517             range.insertNode(node.getDOMNode());
2518         }
2519         return node;
2520     }
2522 };
2524 Y.Base.mix(Y.M.editor_atto.Editor, [EditorSelection]);
2525 // This file is part of Moodle - http://moodle.org/
2526 //
2527 // Moodle is free software: you can redistribute it and/or modify
2528 // it under the terms of the GNU General Public License as published by
2529 // the Free Software Foundation, either version 3 of the License, or
2530 // (at your option) any later version.
2531 //
2532 // Moodle is distributed in the hope that it will be useful,
2533 // but WITHOUT ANY WARRANTY; without even the implied warranty of
2534 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2535 // GNU General Public License for more details.
2536 //
2537 // You should have received a copy of the GNU General Public License
2538 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
2539 /* global rangy */
2541 /**
2542  * @module moodle-editor_atto-editor
2543  * @submodule styling
2544  */
2546 /**
2547  * Editor styling functions for the Atto editor.
2548  *
2549  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
2550  *
2551  * @namespace M.editor_atto
2552  * @class EditorStyling
2553  */
2555 function EditorStyling() {}
2557 EditorStyling.ATTRS= {
2558 };
2560 EditorStyling.prototype = {
2561     /**
2562      * Disable CSS styling.
2563      *
2564      * @method disableCssStyling
2565      */
2566     disableCssStyling: function() {
2567         try {
2568             document.execCommand("styleWithCSS", 0, false);
2569         } catch (e1) {
2570             try {
2571                 document.execCommand("useCSS", 0, true);
2572             } catch (e2) {
2573                 try {
2574                     document.execCommand('styleWithCSS', false, false);
2575                 } catch (e3) {
2576                     // We did our best.
2577                 }
2578             }
2579         }
2580     },
2582     /**
2583      * Enable CSS styling.
2584      *
2585      * @method enableCssStyling
2586      */
2587     enableCssStyling: function() {
2588         try {
2589             document.execCommand("styleWithCSS", 0, true);
2590         } catch (e1) {
2591             try {
2592                 document.execCommand("useCSS", 0, false);
2593             } catch (e2) {
2594                 try {
2595                     document.execCommand('styleWithCSS', false, true);
2596                 } catch (e3) {
2597                     // We did our best.
2598                 }
2599             }
2600         }
2601     },
2603     /**
2604      * Change the formatting for the current selection.
2605      *
2606      * This will wrap the selection in span tags, adding the provided classes.
2607      *
2608      * If the selection covers multiple block elements, multiple spans will be inserted to preserve the original structure.
2609      *
2610      * @method toggleInlineSelectionClass
2611      * @param {Array} toggleclasses - Class names to be toggled on or off.
2612      */
2613     toggleInlineSelectionClass: function(toggleclasses) {
2614         var classname = toggleclasses.join(" ");
2615         var cssApplier = rangy.createClassApplier(classname, {normalize: true});
2617         cssApplier.toggleSelection();
2618     },
2620     /**
2621      * Change the formatting for the current selection.
2622      *
2623      * This will set inline styles on the current selection.
2624      *
2625      * @method formatSelectionInlineStyle
2626      * @param {Array} styles - Style attributes to set on the nodes.
2627      */
2628     formatSelectionInlineStyle: function(styles) {
2629         var classname = this.PLACEHOLDER_CLASS;
2630         var cssApplier = rangy.createClassApplier(classname, {normalize: true});
2632         cssApplier.applyToSelection();
2634         this.editor.all('.' + classname).each(function (node) {
2635             node.removeClass(classname).setStyles(styles);
2636         }, this);
2638     },
2640     /**
2641      * Change the formatting for the current selection.
2642      *
2643      * Also changes the selection to the newly formatted block (allows applying multiple styles to a block).
2644      *
2645      * @method formatSelectionBlock
2646      * @param {String} [blocktag] Change the block level tag to this. Empty string, means do not change the tag.
2647      * @param {Object} [attributes] The keys and values for attributes to be added/changed in the block tag.
2648      * @return {Node|boolean} The Node that was formatted if a change was made, otherwise false.
2649      */
2650     formatSelectionBlock: function(blocktag, attributes) {
2651         // First find the nearest ancestor of the selection that is a block level element.
2652         var selectionparentnode = this.getSelectionParentNode(),
2653             boundary,
2654             cell,
2655             nearestblock,
2656             newcontent,
2657             match,
2658             replacement;
2660         if (!selectionparentnode) {
2661             // No selection, nothing to format.
2662             return false;
2663         }
2665         boundary = this.editor;
2667         selectionparentnode = Y.one(selectionparentnode);
2669         // If there is a table cell in between the selectionparentnode and the boundary,
2670         // move the boundary to the table cell.
2671         // This is because we might have a table in a div, and we select some text in a cell,
2672         // want to limit the change in style to the table cell, not the entire table (via the outer div).
2673         cell = selectionparentnode.ancestor(function (node) {
2674             var tagname = node.get('tagName');
2675             if (tagname) {
2676                 tagname = tagname.toLowerCase();
2677             }
2678             return (node === boundary) ||
2679                    (tagname === 'td') ||
2680                    (tagname === 'th');
2681         }, true);
2683         if (cell) {
2684             // Limit the scope to the table cell.
2685             boundary = cell;
2686         }
2688         nearestblock = selectionparentnode.ancestor(this.BLOCK_TAGS.join(', '), true);
2689         if (nearestblock) {
2690             // Check that the block is contained by the boundary.
2691             match = nearestblock.ancestor(function (node) {
2692                 return node === boundary;
2693             }, false);
2695             if (!match) {
2696                 nearestblock = false;
2697             }
2698         }
2700         // No valid block element - make one.
2701         if (!nearestblock) {
2702             // There is no block node in the content, wrap the content in a p and use that.
2703             newcontent = Y.Node.create('<p></p>');
2704             boundary.get('childNodes').each(function (child) {
2705                 newcontent.append(child.remove());
2706             });
2707             boundary.append(newcontent);
2708             nearestblock = newcontent;
2709         }
2711         // Guaranteed to have a valid block level element contained in the contenteditable region.
2712         // Change the tag to the new block level tag.
2713         if (blocktag && blocktag !== '') {
2714             // Change the block level node for a new one.
2715             replacement = Y.Node.create('<' + blocktag + '></' + blocktag + '>');
2716             // Copy all attributes.
2717             replacement.setAttrs(nearestblock.getAttrs());
2718             // Copy all children.
2719             nearestblock.get('childNodes').each(function (child) {
2720                 child.remove();
2721                 replacement.append(child);
2722             });
2724             nearestblock.replace(replacement);
2725             nearestblock = replacement;
2726         }
2728         // Set the attributes on the block level tag.
2729         if (attributes) {
2730             nearestblock.setAttrs(attributes);
2731         }
2733         // Change the selection to the modified block. This makes sense when we might apply multiple styles
2734         // to the block.
2735         var selection = this.getSelectionFromNode(nearestblock);
2736         this.setSelection(selection);
2738         return nearestblock;
2739     }
2741 };
2743 Y.Base.mix(Y.M.editor_atto.Editor, [EditorStyling]);
2744 // This file is part of Moodle - http://moodle.org/
2745 //
2746 // Moodle is free software: you can redistribute it and/or modify
2747 // it under the terms of the GNU General Public License as published by
2748 // the Free Software Foundation, either version 3 of the License, or
2749 // (at your option) any later version.
2750 //
2751 // Moodle is distributed in the hope that it will be useful,
2752 // but WITHOUT ANY WARRANTY; without even the implied warranty of
2753 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2754 // GNU General Public License for more details.
2755 //
2756 // You should have received a copy of the GNU General Public License
2757 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
2759 /**
2760  * @module moodle-editor_atto-editor
2761  * @submodule filepicker
2762  */
2764 /**
2765  * Filepicker options for the Atto editor.
2766  *
2767  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
2768  *
2769  * @namespace M.editor_atto
2770  * @class EditorFilepicker
2771  */
2773 function EditorFilepicker() {}
2775 EditorFilepicker.ATTRS= {
2776     /**
2777      * The options for the filepicker.
2778      *
2779      * @attribute filepickeroptions
2780      * @type object
2781      * @default {}
2782      */
2783     filepickeroptions: {
2784         value: {}
2785     }
2786 };
2788 EditorFilepicker.prototype = {
2789     /**
2790      * Should we show the filepicker for this filetype?
2791      *
2792      * @method canShowFilepicker
2793      * @param string type The media type for the file picker.
2794      * @return {boolean}
2795      */
2796     canShowFilepicker: function(type) {
2797         return (typeof this.get('filepickeroptions')[type] !== 'undefined');
2798     },
2800     /**
2801      * Show the filepicker.
2802      *
2803      * This depends on core_filepicker, and then call that modules show function.
2804      *
2805      * @method showFilepicker
2806      * @param {string} type The media type for the file picker.
2807      * @param {function} callback The callback to use when selecting an item of media.
2808      * @param {object} [context] The context from which to call the callback.
2809      */
2810     showFilepicker: function(type, callback, context) {
2811         var self = this;
2812         Y.use('core_filepicker', function (Y) {
2813             var options = Y.clone(self.get('filepickeroptions')[type], true);
2814             options.formcallback = callback;
2815             if (context) {
2816                 options.magicscope = context;
2817             }
2819             M.core_filepicker.show(Y, options);
2820         });
2821     }
2822 };
2824 Y.Base.mix(Y.M.editor_atto.Editor, [EditorFilepicker]);
2827 }, '@VERSION@', {
2828     "requires": [
2829         "node",
2830         "transition",
2831         "io",
2832         "overlay",
2833         "escape",
2834         "event",
2835         "event-simulate",
2836         "event-custom",
2837         "node-event-html5",
2838         "yui-throttle",
2839         "moodle-core-notification-dialogue",
2840         "moodle-core-notification-confirm",
2841         "moodle-editor_atto-rangy",
2842         "handlebars",
2843         "timers",
2844         "querystring-stringify"
2845     ]
2846 });