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