4a50db5c6fc1cef167c2265b68f2b3b61264addb
[moodle.git] / lib / editor / atto / yui / build / moodle-editor_atto-editor / moodle-editor_atto-editor.js
1 YUI.add('moodle-editor_atto-editor', function (Y, NAME) {
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * The Atto WYSIWG pluggable editor, written for Moodle.
20  *
21  * @module     moodle-editor_atto-editor
22  * @package    editor_atto
23  * @copyright  2013 Damyon Wiese  <damyon@moodle.com>
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  * @main       moodle-editor_atto-editor
26  */
28 /**
29  * @module moodle-editor_atto-editor
30  * @submodule editor-base
31  */
33 var LOGNAME = 'moodle-editor_atto-editor';
34 var CSS = {
35         CONTENT: 'editor_atto_content',
36         CONTENTWRAPPER: 'editor_atto_content_wrap',
37         TOOLBAR: 'editor_atto_toolbar',
38         WRAPPER: 'editor_atto',
39         HIGHLIGHT: 'highlight'
40     },
41     rangy = window.rangy;
43 /**
44  * The Atto editor for Moodle.
45  *
46  * @namespace M.editor_atto
47  * @class Editor
48  * @constructor
49  * @uses M.editor_atto.EditorClean
50  * @uses M.editor_atto.EditorFilepicker
51  * @uses M.editor_atto.EditorSelection
52  * @uses M.editor_atto.EditorStyling
53  * @uses M.editor_atto.EditorTextArea
54  * @uses M.editor_atto.EditorToolbar
55  * @uses M.editor_atto.EditorToolbarNav
56  */
58 function Editor() {
59     Editor.superclass.constructor.apply(this, arguments);
60 }
62 Y.extend(Editor, Y.Base, {
64     /**
65      * List of known block level tags.
66      * Taken from "https://developer.mozilla.org/en-US/docs/HTML/Block-level_elements".
67      *
68      * @property BLOCK_TAGS
69      * @type {Array}
70      */
71     BLOCK_TAGS : [
72         'address',
73         'article',
74         'aside',
75         'audio',
76         'blockquote',
77         'canvas',
78         'dd',
79         'div',
80         'dl',
81         'fieldset',
82         'figcaption',
83         'figure',
84         'footer',
85         'form',
86         'h1',
87         'h2',
88         'h3',
89         'h4',
90         'h5',
91         'h6',
92         'header',
93         'hgroup',
94         'hr',
95         'noscript',
96         'ol',
97         'output',
98         'p',
99         'pre',
100         'section',
101         'table',
102         'tfoot',
103         'ul',
104         'video'
105     ],
107     PLACEHOLDER_CLASS: 'atto-tmp-class',
108     ALL_NODES_SELECTOR: '[style],font[face]',
109     FONT_FAMILY: 'fontFamily',
111     /**
112      * The wrapper containing the editor.
113      *
114      * @property _wrapper
115      * @type Node
116      * @private
117      */
118     _wrapper: null,
120     /**
121      * A reference to the content editable Node.
122      *
123      * @property editor
124      * @type Node
125      */
126     editor: null,
128     /**
129      * A reference to the original text area.
130      *
131      * @property textarea
132      * @type Node
133      */
134     textarea: null,
136     /**
137      * A reference to the label associated with the original text area.
138      *
139      * @property textareaLabel
140      * @type Node
141      */
142     textareaLabel: null,
144     /**
145      * A reference to the list of plugins.
146      *
147      * @property plugins
148      * @type object
149      */
150     plugins: null,
152     /**
153      * Event Handles to clear on editor destruction.
154      *
155      * @property _eventHandles
156      * @private
157      */
158     _eventHandles: null,
160     initializer: function() {
161         var template;
163         // Note - it is not safe to use a CSS selector like '#' + elementid because the id
164         // may have colons in it - e.g.  quiz.
165         this.textarea = Y.one(document.getElementById(this.get('elementid')));
167         if (!this.textarea) {
168             // No text area found.
169             return;
170         }
172         this._eventHandles = [];
174         this._wrapper = Y.Node.create('<div class="' + CSS.WRAPPER + '" />');
175         template = Y.Handlebars.compile('<div id="{{elementid}}editable" ' +
176                 'contenteditable="true" ' +
177                 'role="textbox" ' +
178                 'spellcheck="true" ' +
179                 'aria-live="off" ' +
180                 'class="{{CSS.CONTENT}}" ' +
181                 '/>');
182         this.editor = Y.Node.create(template({
183             elementid: this.get('elementid'),
184             CSS: CSS
185         }));
187         // Add a labelled-by attribute to the contenteditable.
188         this.textareaLabel = Y.one('[for="' + this.get('elementid') + '"]');
189         if (this.textareaLabel) {
190             this.textareaLabel.generateID();
191             this.editor.setAttribute('aria-labelledby', this.textareaLabel.get("id"));
192         }
194         // Add everything to the wrapper.
195         this.setupToolbar();
197         // Editable content wrapper.
198         var content = Y.Node.create('<div class="' + CSS.CONTENTWRAPPER + '" />');
199         content.appendChild(this.editor);
200         this._wrapper.appendChild(content);
202         // Style the editor. According to the styles.css: 20 is the line-height, 8 is padding-top + padding-bottom.
203         this.editor.setStyle('minHeight', ((20 * this.textarea.getAttribute('rows')) + 8) + 'px');
205         if (Y.UA.ie === 0) {
206             // We set a height here to force the overflow because decent browsers allow the CSS property resize.
207             this.editor.setStyle('height', ((20 * this.textarea.getAttribute('rows')) + 8) + 'px');
208         }
210         // Disable odd inline CSS styles.
211         this.disableCssStyling();
213         // Use paragraphs not divs.
214         if (document.queryCommandSupported('DefaultParagraphSeparator')) {
215             document.execCommand('DefaultParagraphSeparator', false, 'p');
216         }
218         // Add the toolbar and editable zone to the page.
219         this.textarea.get('parentNode').insert(this._wrapper, this.textarea).
220                 setAttribute('class', 'editor_atto_wrap');
222         // Hide the old textarea.
223         this.textarea.hide();
225         // Copy the text to the contenteditable div.
226         this.updateFromTextArea();
228         // Publish the events that are defined by this editor.
229         this.publishEvents();
231         // Add handling for saving and restoring selections on cursor/focus changes.
232         this.setupSelectionWatchers();
234         // Add polling to update the textarea periodically when typing long content.
235         this.setupAutomaticPolling();
237         // Setup plugins.
238         this.setupPlugins();
240         // Initialize the auto-save timer.
241         this.setupAutosave();
242         // Preload the icons for the notifications.
243         this.setupNotifications();
244     },
246     /**
247      * Focus on the editable area for this editor.
248      *
249      * @method focus
250      * @chainable
251      */
252     focus: function() {
253         this.editor.focus();
255         return this;
256     },
258     /**
259      * Publish events for this editor instance.
260      *
261      * @method publishEvents
262      * @private
263      * @chainable
264      */
265     publishEvents: function() {
266         /**
267          * Fired when changes are made within the editor.
268          *
269          * @event change
270          */
271         this.publish('change', {
272             broadcast: true,
273             preventable: true
274         });
276         /**
277          * Fired when all plugins have completed loading.
278          *
279          * @event pluginsloaded
280          */
281         this.publish('pluginsloaded', {
282             fireOnce: true
283         });
285         this.publish('atto:selectionchanged', {
286             prefix: 'atto'
287         });
289         return this;
290     },
292     /**
293      * Set up automated polling of the text area to update the textarea.
294      *
295      * @method setupAutomaticPolling
296      * @chainable
297      */
298     setupAutomaticPolling: function() {
299         this._registerEventHandle(this.editor.on(['keyup', 'cut'], this.updateOriginal, this));
300         this._registerEventHandle(this.editor.on('paste', this.pasteCleanup, this));
302         // Call this.updateOriginal after dropped content has been processed.
303         this._registerEventHandle(this.editor.on('drop', this.updateOriginalDelayed, this));
305         return this;
306     },
308     /**
309      * Calls updateOriginal on a short timer to allow native event handlers to run first.
310      *
311      * @method updateOriginalDelayed
312      * @chainable
313      */
314     updateOriginalDelayed: function() {
315         Y.soon(Y.bind(this.updateOriginal, this));
317         return this;
318     },
320     setupPlugins: function() {
321         // Clear the list of plugins.
322         this.plugins = {};
324         var plugins = this.get('plugins');
326         var groupIndex,
327             group,
328             pluginIndex,
329             plugin,
330             pluginConfig;
332         for (groupIndex in plugins) {
333             group = plugins[groupIndex];
334             if (!group.plugins) {
335                 // No plugins in this group - skip it.
336                 continue;
337             }
338             for (pluginIndex in group.plugins) {
339                 plugin = group.plugins[pluginIndex];
341                 pluginConfig = Y.mix({
342                     name: plugin.name,
343                     group: group.group,
344                     editor: this.editor,
345                     toolbar: this.toolbar,
346                     host: this
347                 }, plugin);
349                 // Add a reference to the current editor.
350                 if (typeof Y.M['atto_' + plugin.name] === "undefined") {
351                     continue;
352                 }
353                 this.plugins[plugin.name] = new Y.M['atto_' + plugin.name].Button(pluginConfig);
354             }
355         }
357         // Some plugins need to perform actions once all plugins have loaded.
358         this.fire('pluginsloaded');
360         return this;
361     },
363     enablePlugins: function(plugin) {
364         this._setPluginState(true, plugin);
365     },
367     disablePlugins: function(plugin) {
368         this._setPluginState(false, plugin);
369     },
371     _setPluginState: function(enable, plugin) {
372         var target = 'disableButtons';
373         if (enable) {
374             target = 'enableButtons';
375         }
377         if (plugin) {
378             this.plugins[plugin][target]();
379         } else {
380             Y.Object.each(this.plugins, function(currentPlugin) {
381                 currentPlugin[target]();
382             }, this);
383         }
384     },
386     /**
387      * Register an event handle for disposal in the destructor.
388      *
389      * @method _registerEventHandle
390      * @param {EventHandle} The Event Handle as returned by Y.on, and Y.delegate.
391      * @private
392      */
393     _registerEventHandle: function(handle) {
394         this._eventHandles.push(handle);
395     }
397 }, {
398     NS: 'editor_atto',
399     ATTRS: {
400         /**
401          * The unique identifier for the form element representing the editor.
402          *
403          * @attribute elementid
404          * @type String
405          * @writeOnce
406          */
407         elementid: {
408             value: null,
409             writeOnce: true
410         },
412         /**
413          * The contextid of the form.
414          *
415          * @attribute contextid
416          * @type Integer
417          * @writeOnce
418          */
419         contextid: {
420             value: null,
421             writeOnce: true
422         },
424         /**
425          * Plugins with their configuration.
426          *
427          * The plugins structure is:
428          *
429          *     [
430          *         {
431          *             "group": "groupName",
432          *             "plugins": [
433          *                 "pluginName": {
434          *                     "configKey": "configValue"
435          *                 },
436          *                 "pluginName": {
437          *                     "configKey": "configValue"
438          *                 }
439          *             ]
440          *         },
441          *         {
442          *             "group": "groupName",
443          *             "plugins": [
444          *                 "pluginName": {
445          *                     "configKey": "configValue"
446          *                 }
447          *             ]
448          *         }
449          *     ]
450          *
451          * @attribute plugins
452          * @type Object
453          * @writeOnce
454          */
455         plugins: {
456             value: {},
457             writeOnce: true
458         }
459     }
460 });
462 // The Editor publishes custom events that can be subscribed to.
463 Y.augment(Editor, Y.EventTarget);
465 Y.namespace('M.editor_atto').Editor = Editor;
467 // Function for Moodle's initialisation.
468 Y.namespace('M.editor_atto.Editor').init = function(config) {
469     return new Y.M.editor_atto.Editor(config);
470 };
471 // This file is part of Moodle - http://moodle.org/
472 //
473 // Moodle is free software: you can redistribute it and/or modify
474 // it under the terms of the GNU General Public License as published by
475 // the Free Software Foundation, either version 3 of the License, or
476 // (at your option) any later version.
477 //
478 // Moodle is distributed in the hope that it will be useful,
479 // but WITHOUT ANY WARRANTY; without even the implied warranty of
480 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
481 // GNU General Public License for more details.
482 //
483 // You should have received a copy of the GNU General Public License
484 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
486 /**
487  * A notify function for the Atto editor.
488  *
489  * @module     moodle-editor_atto-notify
490  * @submodule  notify
491  * @package    editor_atto
492  * @copyright  2014 Damyon Wiese
493  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
494  */
496 var LOGNAME_NOTIFY = 'moodle-editor_atto-editor-notify',
497     NOTIFY_INFO = 'info',
498     NOTIFY_WARNING = 'warning';
500 function EditorNotify() {}
502 EditorNotify.ATTRS= {
503 };
505 EditorNotify.prototype = {
507     /**
508      * A single Y.Node for this editor. There is only ever one - it is replaced if a new message comes in.
509      *
510      * @property messageOverlay
511      * @type {Node}
512      */
513     messageOverlay: null,
515     /**
516      * A single timer object that can be used to cancel the hiding behaviour.
517      *
518      * @property hideTimer
519      * @type {timer}
520      */
521     hideTimer: null,
523     /**
524      * Initialize the notifications.
525      *
526      * @method setupNotifications
527      * @chainable
528      */
529     setupNotifications: function() {
530         var preload1 = new Image(),
531             preload2 = new Image();
533         preload1.src = M.util.image_url('i/warning', 'moodle');
534         preload2.src = M.util.image_url('i/info', 'moodle');
536         return this;
537     },
539     /**
540      * Show a notification in a floaty overlay somewhere in the atto editor text area.
541      *
542      * @method showMessage
543      * @param {String} message The translated message (use get_string)
544      * @param {String} type Must be either "info" or "warning"
545      * @param {Number} timeout Time in milliseconds to show this message for.
546      * @chainable
547      */
548     showMessage: function(message, type, timeout) {
549         var messageTypeIcon = '',
550             intTimeout,
551             bodyContent;
553         if (this.messageOverlay === null) {
554             this.messageOverlay = Y.Node.create('<div class="editor_atto_notification"></div>');
556             this.messageOverlay.hide(true);
557             this.textarea.get('parentNode').append(this.messageOverlay);
559             this.messageOverlay.on('click', function() {
560                 this.messageOverlay.hide(true);
561             }, this);
562         }
564         if (this.hideTimer !== null) {
565             this.hideTimer.cancel();
566         }
568         if (type === NOTIFY_WARNING) {
569             messageTypeIcon = '<img src="' +
570                               M.util.image_url('i/warning', 'moodle') +
571                               '" alt="' + M.util.get_string('warning', 'moodle') + '"/>';
572         } else if (type === NOTIFY_INFO) {
573             messageTypeIcon = '<img src="' +
574                               M.util.image_url('i/info', 'moodle') +
575                               '" alt="' + M.util.get_string('info', 'moodle') + '"/>';
576         } else {
577         }
579         // Parse the timeout value.
580         intTimeout = parseInt(timeout, 10);
581         if (intTimeout <= 0) {
582             intTimeout = 60000;
583         }
585         // Convert class to atto_info (for example).
586         type = 'atto_' + type;
588         bodyContent = Y.Node.create('<div class="' + type + '" role="alert" aria-live="assertive">' +
589                                         messageTypeIcon + ' ' +
590                                         Y.Escape.html(message) +
591                                         '</div>');
592         this.messageOverlay.empty();
593         this.messageOverlay.append(bodyContent);
594         this.messageOverlay.show(true);
596         this.hideTimer = Y.later(intTimeout, this, function() {
597             this.hideTimer = null;
598             this.messageOverlay.hide(true);
599         });
601         return this;
602     }
604 };
606 Y.Base.mix(Y.M.editor_atto.Editor, [EditorNotify]);
607 // This file is part of Moodle - http://moodle.org/
608 //
609 // Moodle is free software: you can redistribute it and/or modify
610 // it under the terms of the GNU General Public License as published by
611 // the Free Software Foundation, either version 3 of the License, or
612 // (at your option) any later version.
613 //
614 // Moodle is distributed in the hope that it will be useful,
615 // but WITHOUT ANY WARRANTY; without even the implied warranty of
616 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
617 // GNU General Public License for more details.
618 //
619 // You should have received a copy of the GNU General Public License
620 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
622 /**
623  * @module moodle-editor_atto-editor
624  * @submodule textarea
625  */
627 /**
628  * Textarea functions for the Atto editor.
629  *
630  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
631  *
632  * @namespace M.editor_atto
633  * @class EditorTextArea
634  */
636 function EditorTextArea() {}
638 EditorTextArea.ATTRS= {
639 };
641 EditorTextArea.prototype = {
643     /**
644      * Return the appropriate empty content value for the current browser.
645      *
646      * Different browsers use a different content when they are empty and
647      * we must set this reliable across the board.
648      *
649      * @method _getEmptyContent
650      * @return String The content to use representing no user-provided content
651      * @private
652      */
653     _getEmptyContent: function() {
654         if (Y.UA.ie && Y.UA.ie < 10) {
655             return '<p></p>';
656         } else {
657             return '<p><br></p>';
658         }
659     },
661     /**
662      * Copy and clean the text from the textarea into the contenteditable div.
663      *
664      * If the text is empty, provide a default paragraph tag to hold the content.
665      *
666      * @method updateFromTextArea
667      * @chainable
668      */
669     updateFromTextArea: function() {
670         // Clear it first.
671         this.editor.setHTML('');
673         // Copy text to editable div.
674         this.editor.append(this.textarea.get('value'));
676         // Clean it.
677         this.cleanEditorHTML();
679         // Insert a paragraph in the empty contenteditable div.
680         if (this.editor.getHTML() === '') {
681             this.editor.setHTML(this._getEmptyContent());
682         }
683     },
685     /**
686      * Copy the text from the contenteditable to the textarea which it replaced.
687      *
688      * @method updateOriginal
689      * @chainable
690      */
691     updateOriginal : function() {
692         // Get the previous and current value to compare them.
693         var oldValue = this.textarea.get('value'),
694             newValue = this.getCleanHTML();
696         if (newValue === "" && this.isActive()) {
697             // The content was entirely empty so get the empty content placeholder.
698             newValue = this._getEmptyContent();
699         }
701         // Only call this when there has been an actual change to reduce processing.
702         if (oldValue !== newValue) {
703             // Insert the cleaned content.
704             this.textarea.set('value', newValue);
706             // Trigger the onchange callback on the textarea, essentially to notify moodle-core-formchangechecker.
707             this.textarea.simulate('change');
709             // Trigger handlers for this action.
710             this.fire('change');
711         }
713         return this;
714     }
715 };
717 Y.Base.mix(Y.M.editor_atto.Editor, [EditorTextArea]);
718 // This file is part of Moodle - http://moodle.org/
719 //
720 // Moodle is free software: you can redistribute it and/or modify
721 // it under the terms of the GNU General Public License as published by
722 // the Free Software Foundation, either version 3 of the License, or
723 // (at your option) any later version.
724 //
725 // Moodle is distributed in the hope that it will be useful,
726 // but WITHOUT ANY WARRANTY; without even the implied warranty of
727 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
728 // GNU General Public License for more details.
729 //
730 // You should have received a copy of the GNU General Public License
731 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
733 /**
734  * A autosave function for the Atto editor.
735  *
736  * @module     moodle-editor_atto-autosave
737  * @submodule  autosave-base
738  * @package    editor_atto
739  * @copyright  2014 Damyon Wiese
740  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
741  */
743 var SUCCESS_MESSAGE_TIMEOUT = 5000,
744     RECOVER_MESSAGE_TIMEOUT = 60000,
745     LOGNAME_AUTOSAVE = 'moodle-editor_atto-editor-autosave';
747 function EditorAutosave() {}
749 EditorAutosave.ATTRS= {
750     /**
751      * Enable/Disable auto save for this instance.
752      *
753      * @attribute autosaveEnabled
754      * @type Boolean
755      * @writeOnce
756      */
757     autosaveEnabled: {
758         value: true,
759         writeOnce: true
760     },
762     /**
763      * The time between autosaves (in seconds).
764      *
765      * @attribute autosaveFrequency
766      * @type Number
767      * @default 60
768      * @writeOnce
769      */
770     autosaveFrequency: {
771         value: 60,
772         writeOnce: true
773     },
775     /**
776      * Unique hash for this page instance. Calculated from $PAGE->url in php.
777      *
778      * @attribute pageHash
779      * @type String
780      * @writeOnce
781      */
782     pageHash: {
783         value: '',
784         writeOnce: true
785     },
787     /**
788      * The relative path to the ajax script.
789      *
790      * @attribute autosaveAjaxScript
791      * @type String
792      * @default '/lib/editor/atto/autosave-ajax.php'
793      * @readOnly
794      */
795     autosaveAjaxScript: {
796         value: '/lib/editor/atto/autosave-ajax.php',
797         readOnly: true
798     }
799 };
801 EditorAutosave.prototype = {
803     /**
804      * The text that was auto saved in the last request.
805      *
806      * @property lastText
807      * @type string
808      */
809     lastText: "",
811     /**
812      * Autosave instance.
813      *
814      * @property autosaveInstance
815      * @type string
816      */
817     autosaveInstance: null,
819     /**
820      * Initialize the autosave process
821      *
822      * @method setupAutosave
823      * @chainable
824      */
825     setupAutosave: function() {
826         var draftid = -1,
827             form,
828             optiontype = null,
829             options = this.get('filepickeroptions'),
830             params,
831             url;
833         if (!this.get('autosaveEnabled')) {
834             // Autosave disabled for this instance.
835             return;
836         }
838         this.autosaveInstance = Y.stamp(this);
839         for (optiontype in options) {
840             if (typeof options[optiontype].itemid !== "undefined") {
841                 draftid = options[optiontype].itemid;
842             }
843         }
845         // First see if there are any saved drafts.
846         // Make an ajax request.
847         url = M.cfg.wwwroot + this.get('autosaveAjaxScript');
848         params = {
849             sesskey: M.cfg.sesskey,
850             contextid: this.get('contextid'),
851             action: 'resume',
852             drafttext: '',
853             draftid: draftid,
854             elementid: this.get('elementid'),
855             pageinstance: this.autosaveInstance,
856             pagehash: this.get('pageHash')
857         };
859         Y.io(url, {
860             method: 'POST',
861             data: params,
862             context: this,
863             on: {
864                 success: function(id,o) {
865                     var response_json;
866                     if (typeof o.responseText !== "undefined" && o.responseText !== "") {
867                         response_json = JSON.parse(o.responseText);
869                         // Revert untouched editor contents to an empty string.
870                         // Check for FF and Chrome.
871                         if (response_json.result === '<p></p>' || response_json.result === '<p><br></p>' ||
872                             response_json.result === '<br>') {
873                             response_json.result = '';
874                         }
876                         // Check for IE 9 and 10.
877                         if (response_json.result === '<p>&nbsp;</p>' || response_json.result === '<p><br>&nbsp;</p>') {
878                             response_json.result = '';
879                         }
881                         if (response_json.error || typeof response_json.result === 'undefined') {
882                             this.showMessage(M.util.get_string('errortextrecovery', 'editor_atto'),
883                                     NOTIFY_WARNING, RECOVER_MESSAGE_TIMEOUT);
884                         } else if (response_json.result !== this.textarea.get('value') &&
885                                 response_json.result !== '') {
886                             this.recoverText(response_json.result);
887                         }
888                         this._fireSelectionChanged();
889                     }
890                 },
891                 failure: function() {
892                     this.showMessage(M.util.get_string('errortextrecovery', 'editor_atto'),
893                             NOTIFY_WARNING, RECOVER_MESSAGE_TIMEOUT);
894                 }
895             }
896         });
898         // Now setup the timer for periodic saves.
900         var delay = parseInt(this.get('autosaveFrequency'), 10) * 1000;
901         Y.later(delay, this, this.saveDraft, false, true);
903         // Now setup the listener for form submission.
904         form = this.textarea.ancestor('form');
905         if (form) {
906             form.on('submit', this.resetAutosave, this);
907         }
908         return this;
909     },
911     /**
912      * Clear the autosave text because the form was submitted normally.
913      *
914      * @method resetAutosave
915      * @chainable
916      */
917     resetAutosave: function() {
918         // Make an ajax request to reset the autosaved text.
919         var url = M.cfg.wwwroot + this.get('autosaveAjaxScript');
920         var params = {
921             sesskey: M.cfg.sesskey,
922             contextid: this.get('contextid'),
923             action: 'reset',
924             elementid: this.get('elementid'),
925             pageinstance: this.autosaveInstance,
926             pagehash: this.get('pageHash')
927         };
929         Y.io(url, {
930             method: 'POST',
931             data: params,
932             sync: true
933         });
934         return this;
935     },
938     /**
939      * Recover a previous version of this text and show a message.
940      *
941      * @method recoverText
942      * @param {String} text
943      * @chainable
944      */
945     recoverText: function(text) {
946         this.editor.setHTML(text);
947         this.saveSelection();
948         this.updateOriginal();
949         this.lastText = text;
951         this.showMessage(M.util.get_string('textrecovered', 'editor_atto'),
952                 NOTIFY_INFO, RECOVER_MESSAGE_TIMEOUT);
954         return this;
955     },
957     /**
958      * Save a single draft via ajax.
959      *
960      * @method saveDraft
961      * @chainable
962      */
963     saveDraft: function() {
964         var url, params;
965         // Only copy the text from the div to the textarea if the textarea is not currently visible.
966         if (!this.editor.get('hidden')) {
967             this.updateOriginal();
968         }
969         var newText = this.textarea.get('value');
971         if (newText !== this.lastText) {
973             // Make an ajax request.
974             url = M.cfg.wwwroot + this.get('autosaveAjaxScript');
975             params = {
976                 sesskey: M.cfg.sesskey,
977                 contextid: this.get('contextid'),
978                 action: 'save',
979                 drafttext: newText,
980                 elementid: this.get('elementid'),
981                 pagehash: this.get('pageHash'),
982                 pageinstance: this.autosaveInstance
983             };
985             // Reusable error handler - must be passed the correct context.
986             var ajaxErrorFunction = function(code, response) {
987                 var errorDuration = parseInt(this.get('autosaveFrequency'), 10) * 1000;
988                 this.showMessage(M.util.get_string('autosavefailed', 'editor_atto'), NOTIFY_WARNING, errorDuration);
989             };
991             Y.io(url, {
992                 method: 'POST',
993                 data: params,
994                 context: this,
995                 on: {
996                     error: ajaxErrorFunction,
997                     failure: ajaxErrorFunction,
998                     success: function(code, response) {
999                         if (response.responseText !== "") {
1000                             Y.soon(Y.bind(ajaxErrorFunction, this, [code, response]));
1001                         } else {
1002                             // All working.
1003                             this.lastText = newText;
1004                             this.showMessage(M.util.get_string('autosavesucceeded', 'editor_atto'),
1005                                     NOTIFY_INFO, SUCCESS_MESSAGE_TIMEOUT);
1006                         }
1007                     }
1008                 }
1009             });
1010         }
1011         return this;
1012     }
1013 };
1015 Y.Base.mix(Y.M.editor_atto.Editor, [EditorAutosave]);
1016 // This file is part of Moodle - http://moodle.org/
1017 //
1018 // Moodle is free software: you can redistribute it and/or modify
1019 // it under the terms of the GNU General Public License as published by
1020 // the Free Software Foundation, either version 3 of the License, or
1021 // (at your option) any later version.
1022 //
1023 // Moodle is distributed in the hope that it will be useful,
1024 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1025 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1026 // GNU General Public License for more details.
1027 //
1028 // You should have received a copy of the GNU General Public License
1029 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1031 /**
1032  * @module moodle-editor_atto-editor
1033  * @submodule clean
1034  */
1036 /**
1037  * Functions for the Atto editor to clean the generated content.
1038  *
1039  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1040  *
1041  * @namespace M.editor_atto
1042  * @class EditorClean
1043  */
1045 function EditorClean() {}
1047 EditorClean.ATTRS= {
1048 };
1050 EditorClean.prototype = {
1051     /**
1052      * Clean the generated HTML content without modifying the editor content.
1053      *
1054      * This includes removes all YUI ids from the generated content.
1055      *
1056      * @return {string} The cleaned HTML content.
1057      */
1058     getCleanHTML: function() {
1059         // Clone the editor so that we don't actually modify the real content.
1060         var editorClone = this.editor.cloneNode(true),
1061             html;
1063         // Remove all YUI IDs.
1064         Y.each(editorClone.all('[id^="yui"]'), function(node) {
1065             node.removeAttribute('id');
1066         });
1068         editorClone.all('.atto_control').remove(true);
1069         html = editorClone.get('innerHTML');
1071         // Revert untouched editor contents to an empty string.
1072         if (html === '<p></p>' || html === '<p><br></p>') {
1073             return '';
1074         }
1076         // Remove any and all nasties from source.
1077        return this._cleanHTML(html);
1078     },
1080     /**
1081      * Clean the HTML content of the editor.
1082      *
1083      * @method cleanEditorHTML
1084      * @chainable
1085      */
1086     cleanEditorHTML: function() {
1087         var startValue = this.editor.get('innerHTML');
1088         this.editor.set('innerHTML', this._cleanHTML(startValue));
1090         return this;
1091     },
1093     /**
1094      * Clean the specified HTML content and remove any content which could cause issues.
1095      *
1096      * @method _cleanHTML
1097      * @private
1098      * @param {String} content The content to clean
1099      * @return {String} The cleaned HTML
1100      */
1101     _cleanHTML: function(content) {
1102         // Removing limited things that can break the page or a disallowed, like unclosed comments, style blocks, etc.
1104         var rules = [
1105             // Remove any style blocks. Some browsers do not work well with them in a contenteditable.
1106             // Plus style blocks are not allowed in body html, except with "scoped", which most browsers don't support as of 2015.
1107             // Reference: "http://stackoverflow.com/questions/1068280/javascript-regex-multiline-flag-doesnt-work"
1108             {regex: /<style[^>]*>[\s\S]*?<\/style>/gi, replace: ""},
1110             // Remove any open HTML comment opens that are not followed by a close. This can completely break page layout.
1111             {regex: /<!--(?![\s\S]*?-->)/gi, replace: ""},
1113             // Source: "http://www.codinghorror.com/blog/2006/01/cleaning-words-nasty-html.html"
1114             // Remove forbidden tags for content, title, meta, style, st0-9, head, font, html, body, link.
1115             {regex: /<\/?(?:title|meta|style|st\d|head|font|html|body|link)[^>]*?>/gi, replace: ""}
1116         ];
1118         return this._filterContentWithRules(content, rules);
1119     },
1121     /**
1122      * Take the supplied content and run on the supplied regex rules.
1123      *
1124      * @method _filterContentWithRules
1125      * @private
1126      * @param {String} content The content to clean
1127      * @param {Array} rules An array of structures: [ {regex: /something/, replace: "something"}, {...}, ...]
1128      * @return {String} The cleaned content
1129      */
1130     _filterContentWithRules: function(content, rules) {
1131         var i = 0;
1132         for (i = 0; i < rules.length; i++) {
1133             content = content.replace(rules[i].regex, rules[i].replace);
1134         }
1136         return content;
1137     },
1139     /**
1140      * Intercept and clean html paste events.
1141      *
1142      * @method pasteCleanup
1143      * @param {Object} sourceEvent The YUI EventFacade  object
1144      * @return {Boolean} True if the passed event should continue, false if not.
1145      */
1146     pasteCleanup: function(sourceEvent) {
1147         // We only expect paste events, but we will check anyways.
1148         if (sourceEvent.type === 'paste') {
1149             // The YUI event wrapper doesn't provide paste event info, so we need the underlying event.
1150             var event = sourceEvent._event;
1151             // Check if we have a valid clipboardData object in the event.
1152             // IE has a clipboard object at window.clipboardData, but as of IE 11, it does not provide HTML content access.
1153             if (event && event.clipboardData && event.clipboardData.getData) {
1154                 // Check if there is HTML type to be pasted, this is all we care about.
1155                 var types = event.clipboardData.types;
1156                 var isHTML = false;
1157                 // Different browsers use different things to hold the types, so test various functions.
1158                 if (!types) {
1159                     isHTML = false;
1160                 } else if (typeof types.contains === 'function') {
1161                     isHTML = types.contains('text/html');
1162                 } else if (typeof types.indexOf === 'function') {
1163                     isHTML = (types.indexOf('text/html') > -1);
1164                     if (!isHTML) {
1165                         if ((types.indexOf('com.apple.webarchive') > -1) || (types.indexOf('com.apple.iWork.TSPNativeData') > -1)) {
1166                             // This is going to be a specialized Apple paste paste. We cannot capture this, so clean everything.
1167                             this.fallbackPasteCleanupDelayed();
1168                             return true;
1169                         }
1170                     }
1171                 } else {
1172                     // We don't know how to handle the clipboard info, so wait for the clipboard event to finish then fallback.
1173                     this.fallbackPasteCleanupDelayed();
1174                     return true;
1175                 }
1177                 if (isHTML) {
1178                     // Get the clipboard content.
1179                     var content;
1180                     try {
1181                         content = event.clipboardData.getData('text/html');
1182                     } catch (error) {
1183                         // Something went wrong. Fallback.
1184                         this.fallbackPasteCleanupDelayed();
1185                         return true;
1186                     }
1188                     // Stop the original paste.
1189                     sourceEvent.preventDefault();
1191                     // Scrub the paste content.
1192                     content = this._cleanPasteHTML(content);
1194                     // Save the current selection.
1195                     // Using saveSelection as it produces a more consistent experience.
1196                     var selection = window.rangy.saveSelection();
1198                     // Insert the content.
1199                     this.insertContentAtFocusPoint(content);
1201                     // Restore the selection, and collapse to end.
1202                     window.rangy.restoreSelection(selection);
1203                     window.rangy.getSelection().collapseToEnd();
1205                     // Update the text area.
1206                     this.updateOriginal();
1207                     return false;
1208                 } else {
1209                     // This is a non-html paste event, we can just let this continue on and call updateOriginalDelayed.
1210                     this.updateOriginalDelayed();
1211                     return true;
1212                 }
1213             } else {
1214                 // If we reached a here, this probably means the browser has limited (or no) clipboard support.
1215                 // Wait for the clipboard event to finish then fallback.
1216                 this.fallbackPasteCleanupDelayed();
1217                 return true;
1218             }
1219         }
1221         // We should never get here - we must have received a non-paste event for some reason.
1222         // Um, just call updateOriginalDelayed() - it's safe.
1223         this.updateOriginalDelayed();
1224         return true;
1225     },
1227     /**
1228      * Cleanup code after a paste event if we couldn't intercept the paste content.
1229      *
1230      * @method fallbackPasteCleanup
1231      * @chainable
1232      */
1233     fallbackPasteCleanup: function() {
1235         // Save the current selection (cursor position).
1236         var selection = window.rangy.saveSelection();
1238         // Get, clean, and replace the content in the editable.
1239         var content = this.editor.get('innerHTML');
1240         this.editor.set('innerHTML', this._cleanPasteHTML(content));
1242         // Update the textarea.
1243         this.updateOriginal();
1245         // Restore the selection (cursor position).
1246         window.rangy.restoreSelection(selection);
1248         return this;
1249     },
1251     /**
1252      * Calls fallbackPasteCleanup on a short timer to allow the paste event handlers to complete.
1253      *
1254      * @method fallbackPasteCleanupDelayed
1255      * @chainable
1256      */
1257     fallbackPasteCleanupDelayed: function() {
1258         Y.soon(Y.bind(this.fallbackPasteCleanup, this));
1260         return this;
1261     },
1263     /**
1264      * Cleanup html that comes from WYSIWYG paste events. These are more likely to contain messy code that we should strip.
1265      *
1266      * @method _cleanPasteHTML
1267      * @private
1268      * @param {String} content The html content to clean
1269      * @return {String} The cleaned HTML
1270      */
1271     _cleanPasteHTML: function(content) {
1272         // Return an empty string if passed an invalid or empty object.
1273         if (!content || content.length === 0) {
1274             return "";
1275         }
1277         // Rules that get rid of the real-nasties and don't care about normalize code (correct quotes, white spaces, etc).
1278         var rules = [
1279             // Stuff that is specifically from MS Word and similar office packages.
1280             // Remove if comment blocks.
1281             {regex: /<!--\[if[\s\S]*?endif\]-->/gi, replace: ""},
1282             // Remove start and end fragment comment blocks.
1283             {regex: /<!--(Start|End)Fragment-->/gi, replace: ""},
1284             // Remove any xml blocks.
1285             {regex: /<xml[^>]*>[\s\S]*?<\/xml>/gi, replace: ""},
1286             // Remove any <?xml><\?xml> blocks.
1287             {regex: /<\?xml[^>]*>[\s\S]*?<\\\?xml>/gi, replace: ""},
1288             // Remove <o:blah>, <\o:blah>.
1289             {regex: /<\/?\w+:[^>]*>/gi, replace: ""}
1290         ];
1292         // Apply the first set of harsher rules.
1293         content = this._filterContentWithRules(content, rules);
1295         // Apply the standard rules, which mainly cleans things like headers, links, and style blocks.
1296         content = this._cleanHTML(content);
1298         // Check if the string is empty or only contains whitespace.
1299         if (content.length === 0 || !content.match(/\S/)) {
1300             return content;
1301         }
1303         // Now we let the browser normalize the code by loading it into the DOM and then get the html back.
1304         // This gives us well quoted, well formatted code to continue our work on. Word may provide very poorly formatted code.
1305         var holder = document.createElement('div');
1306         holder.innerHTML = content;
1307         content = holder.innerHTML;
1308         // Free up the DOM memory.
1309         holder.innerHTML = "";
1311         // Run some more rules that care about quotes and whitespace.
1312         rules = [
1313             // Remove MSO-blah, MSO:blah in style attributes. Only removes one or more that appear in succession.
1314             {regex: /(<[^>]*?style\s*?=\s*?"[^>"]*?)(?:[\s]*MSO[-:][^>;"]*;?)+/gi, replace: "$1"},
1315             // Remove MSO classes in class attributes. Only removes one or more that appear in succession.
1316             {regex: /(<[^>]*?class\s*?=\s*?"[^>"]*?)(?:[\s]*MSO[_a-zA-Z0-9\-]*)+/gi, replace: "$1"},
1317             // Remove Apple- classes in class attributes. Only removes one or more that appear in succession.
1318             {regex: /(<[^>]*?class\s*?=\s*?"[^>"]*?)(?:[\s]*Apple-[_a-zA-Z0-9\-]*)+/gi, replace: "$1"},
1319             // Remove OLE_LINK# anchors that may litter the code.
1320             {regex: /<a [^>]*?name\s*?=\s*?"OLE_LINK\d*?"[^>]*?>\s*?<\/a>/gi, replace: ""},
1321             // Remove empty spans, but not ones from Rangy.
1322             {regex: /<span(?![^>]*?rangySelectionBoundary[^>]*?)[^>]*>(&nbsp;|\s)*<\/span>/gi, replace: ""}
1323         ];
1325         // Apply the rules.
1326         content = this._filterContentWithRules(content, rules);
1328         // Reapply the standard cleaner to the content.
1329         content = this._cleanHTML(content);
1331         return content;
1332     }
1333 };
1335 Y.Base.mix(Y.M.editor_atto.Editor, [EditorClean]);
1336 // This file is part of Moodle - http://moodle.org/
1337 //
1338 // Moodle is free software: you can redistribute it and/or modify
1339 // it under the terms of the GNU General Public License as published by
1340 // the Free Software Foundation, either version 3 of the License, or
1341 // (at your option) any later version.
1342 //
1343 // Moodle is distributed in the hope that it will be useful,
1344 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1345 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1346 // GNU General Public License for more details.
1347 //
1348 // You should have received a copy of the GNU General Public License
1349 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1351 /**
1352  * @module moodle-editor_atto-editor
1353  * @submodule toolbar
1354  */
1356 /**
1357  * Toolbar functions for the Atto editor.
1358  *
1359  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1360  *
1361  * @namespace M.editor_atto
1362  * @class EditorToolbar
1363  */
1365 function EditorToolbar() {}
1367 EditorToolbar.ATTRS= {
1368 };
1370 EditorToolbar.prototype = {
1371     /**
1372      * A reference to the toolbar Node.
1373      *
1374      * @property toolbar
1375      * @type Node
1376      */
1377     toolbar: null,
1379     /**
1380      * A reference to any currently open menus in the toolbar.
1381      *
1382      * @property openMenus
1383      * @type Array
1384      */
1385     openMenus: null,
1387     /**
1388      * Setup the toolbar on the editor.
1389      *
1390      * @method setupToolbar
1391      * @chainable
1392      */
1393     setupToolbar: function() {
1394         this.toolbar = Y.Node.create('<div class="' + CSS.TOOLBAR + '" role="toolbar" aria-live="off"/>');
1395         this.openMenus = [];
1396         this._wrapper.appendChild(this.toolbar);
1398         if (this.textareaLabel) {
1399             this.toolbar.setAttribute('aria-labelledby', this.textareaLabel.get("id"));
1400         }
1402         // Add keyboard navigation for the toolbar.
1403         this.setupToolbarNavigation();
1405         return this;
1406     }
1407 };
1409 Y.Base.mix(Y.M.editor_atto.Editor, [EditorToolbar]);
1410 // This file is part of Moodle - http://moodle.org/
1411 //
1412 // Moodle is free software: you can redistribute it and/or modify
1413 // it under the terms of the GNU General Public License as published by
1414 // the Free Software Foundation, either version 3 of the License, or
1415 // (at your option) any later version.
1416 //
1417 // Moodle is distributed in the hope that it will be useful,
1418 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1419 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1420 // GNU General Public License for more details.
1421 //
1422 // You should have received a copy of the GNU General Public License
1423 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1425 /**
1426  * @module moodle-editor_atto-editor
1427  * @submodule toolbarnav
1428  */
1430 /**
1431  * Toolbar Navigation functions for the Atto editor.
1432  *
1433  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1434  *
1435  * @namespace M.editor_atto
1436  * @class EditorToolbarNav
1437  */
1439 function EditorToolbarNav() {}
1441 EditorToolbarNav.ATTRS= {
1442 };
1444 EditorToolbarNav.prototype = {
1445     /**
1446      * The current focal point for tabbing.
1447      *
1448      * @property _tabFocus
1449      * @type Node
1450      * @default null
1451      * @private
1452      */
1453     _tabFocus: null,
1455     /**
1456      * Set up the watchers for toolbar navigation.
1457      *
1458      * @method setupToolbarNavigation
1459      * @chainable
1460      */
1461     setupToolbarNavigation: function() {
1462         // Listen for Arrow left and Arrow right keys.
1463         this._wrapper.delegate('key',
1464                 this.toolbarKeyboardNavigation,
1465                 'down:37,39',
1466                 '.' + CSS.TOOLBAR,
1467                 this);
1468         this._wrapper.delegate('focus',
1469                 function(e) {
1470                     this._setTabFocus(e.currentTarget);
1471                 }, '.' + CSS.TOOLBAR + ' button', this);
1473         return this;
1474     },
1476     /**
1477      * Implement arrow key navigation for the buttons in the toolbar.
1478      *
1479      * @method toolbarKeyboardNavigation
1480      * @param {EventFacade} e - the keyboard event.
1481      */
1482     toolbarKeyboardNavigation: function(e) {
1483         // Prevent the default browser behaviour.
1484         e.preventDefault();
1486         // On cursor moves we loops through the buttons.
1487         var buttons = this.toolbar.all('button'),
1488             direction = 1,
1489             button,
1490             current = e.target.ancestor('button', true);
1492         if (e.keyCode === 37) {
1493             // Moving left so reverse the direction.
1494             direction = -1;
1495         }
1497         button = this._findFirstFocusable(buttons, current, direction);
1498         if (button) {
1499             button.focus();
1500             this._setTabFocus(button);
1501         } else {
1502         }
1503     },
1505     /**
1506      * Find the first focusable button.
1507      *
1508      * @param {NodeList} buttons A list of nodes.
1509      * @param {Node} startAt The node in the list to start the search from.
1510      * @param {Number} direction The direction in which to search (1 or -1).
1511      * @return {Node | Undefined} The Node or undefined.
1512      * @method _findFirstFocusable
1513      * @private
1514      */
1515     _findFirstFocusable: function(buttons, startAt, direction) {
1516         var checkCount = 0,
1517             group,
1518             candidate,
1519             button,
1520             index;
1522         // Determine which button to start the search from.
1523         index = buttons.indexOf(startAt);
1524         if (index < -1) {
1525             index = 0;
1526         }
1528         // Try to find the next.
1529         while (checkCount < buttons.size()) {
1530             index += direction;
1531             if (index < 0) {
1532                 index = buttons.size() - 1;
1533             } else if (index >= buttons.size()) {
1534                 // Handle wrapping.
1535                 index = 0;
1536             }
1538             candidate = buttons.item(index);
1540             // Add a counter to ensure we don't get stuck in a loop if there's only one visible menu item.
1541             checkCount++;
1543             // Loop while:
1544             // * we haven't checked every button;
1545             // * the button is hidden or disabled;
1546             // * the group is hidden.
1547             if (candidate.hasAttribute('hidden') || candidate.hasAttribute('disabled')) {
1548                 continue;
1549             }
1550             group = candidate.ancestor('.atto_group');
1551             if (group.hasAttribute('hidden')) {
1552                 continue;
1553             }
1555             button = candidate;
1556             break;
1557         }
1559         return button;
1560     },
1562     /**
1563      * Check the tab focus.
1564      *
1565      * When we disable or hide a button, we should call this method to ensure that the
1566      * focus is not currently set on an inaccessible button, otherwise tabbing to the toolbar
1567      * would be impossible.
1568      *
1569      * @method checkTabFocus
1570      * @chainable
1571      */
1572     checkTabFocus: function() {
1573         if (this._tabFocus) {
1574             if (this._tabFocus.hasAttribute('disabled') || this._tabFocus.hasAttribute('hidden')
1575                     || this._tabFocus.ancestor('.atto_group').hasAttribute('hidden')) {
1576                 // Find first available button.
1577                 var button = this._findFirstFocusable(this.toolbar.all('button'), this._tabFocus, -1);
1578                 if (button) {
1579                     if (this._tabFocus.compareTo(document.activeElement)) {
1580                         // We should also move the focus, because the inaccessible button also has the focus.
1581                         button.focus();
1582                     }
1583                     this._setTabFocus(button);
1584                 }
1585             }
1586         }
1587         return this;
1588     },
1590     /**
1591      * Sets tab focus for the toolbar to the specified Node.
1592      *
1593      * @method _setTabFocus
1594      * @param {Node} button The node that focus should now be set to
1595      * @chainable
1596      * @private
1597      */
1598     _setTabFocus: function(button) {
1599         if (this._tabFocus) {
1600             // Unset the previous entry.
1601             this._tabFocus.setAttribute('tabindex', '-1');
1602         }
1604         // Set up the new entry.
1605         this._tabFocus = button;
1606         this._tabFocus.setAttribute('tabindex', 0);
1608         // And update the activedescendant to point at the currently selected button.
1609         this.toolbar.setAttribute('aria-activedescendant', this._tabFocus.generateID());
1611         return this;
1612     }
1613 };
1615 Y.Base.mix(Y.M.editor_atto.Editor, [EditorToolbarNav]);
1616 // This file is part of Moodle - http://moodle.org/
1617 //
1618 // Moodle is free software: you can redistribute it and/or modify
1619 // it under the terms of the GNU General Public License as published by
1620 // the Free Software Foundation, either version 3 of the License, or
1621 // (at your option) any later version.
1622 //
1623 // Moodle is distributed in the hope that it will be useful,
1624 // but WITHOUT ANY WARRANTY; without even the implied warranty of
1625 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1626 // GNU General Public License for more details.
1627 //
1628 // You should have received a copy of the GNU General Public License
1629 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
1631 /**
1632  * @module moodle-editor_atto-editor
1633  * @submodule selection
1634  */
1636 /**
1637  * Selection functions for the Atto editor.
1638  *
1639  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
1640  *
1641  * @namespace M.editor_atto
1642  * @class EditorSelection
1643  */
1645 function EditorSelection() {}
1647 EditorSelection.ATTRS= {
1648 };
1650 EditorSelection.prototype = {
1652     /**
1653      * List of saved selections per editor instance.
1654      *
1655      * @property _selections
1656      * @private
1657      */
1658     _selections: null,
1660     /**
1661      * A unique identifier for the last selection recorded.
1662      *
1663      * @property _lastSelection
1664      * @param lastselection
1665      * @type string
1666      * @private
1667      */
1668     _lastSelection: null,
1670     /**
1671      * Whether focus came from a click event.
1672      *
1673      * This is used to determine whether to restore the selection or not.
1674      *
1675      * @property _focusFromClick
1676      * @type Boolean
1677      * @default false
1678      * @private
1679      */
1680     _focusFromClick: false,
1682     /**
1683      * Set up the watchers for selection save and restoration.
1684      *
1685      * @method setupSelectionWatchers
1686      * @chainable
1687      */
1688     setupSelectionWatchers: function() {
1689         // Save the selection when a change was made.
1690         this.on('atto:selectionchanged', this.saveSelection, this);
1692         this.editor.on('focus', this.restoreSelection, this);
1694         // Do not restore selection when focus is from a click event.
1695         this.editor.on('mousedown', function() {
1696             this._focusFromClick = true;
1697         }, this);
1699         // Copy the current value back to the textarea when focus leaves us and save the current selection.
1700         this.editor.on('blur', function() {
1701             // Clear the _focusFromClick value.
1702             this._focusFromClick = false;
1704             // Update the original text area.
1705             this.updateOriginal();
1706         }, this);
1708         this.editor.on(['keyup', 'focus'], function(e) {
1709                 Y.soon(Y.bind(this._hasSelectionChanged, this, e));
1710             }, this);
1712         // To capture both mouseup and touchend events, we need to track the gesturemoveend event in standAlone mode. Without
1713         // standAlone, it will only fire if we listened to a gesturemovestart too.
1714         this.editor.on('gesturemoveend', function(e) {
1715                 Y.soon(Y.bind(this._hasSelectionChanged, this, e));
1716             }, {
1717                 standAlone: true
1718             }, this);
1720         return this;
1721     },
1723     /**
1724      * Work out if the cursor is in the editable area for this editor instance.
1725      *
1726      * @method isActive
1727      * @return {boolean}
1728      */
1729     isActive: function() {
1730         var range = rangy.createRange(),
1731             selection = rangy.getSelection();
1733         if (!selection.rangeCount) {
1734             // If there was no range count, then there is no selection.
1735             return false;
1736         }
1738         // We can't be active if the editor doesn't have focus at the moment.
1739         if (!document.activeElement ||
1740                 !(this.editor.compareTo(document.activeElement) || this.editor.contains(document.activeElement))) {
1741             return false;
1742         }
1744         // Check whether the range intersects the editor selection.
1745         range.selectNode(this.editor.getDOMNode());
1746         return range.intersectsRange(selection.getRangeAt(0));
1747     },
1749     /**
1750      * Create a cross browser selection object that represents a YUI node.
1751      *
1752      * @method getSelectionFromNode
1753      * @param {Node} YUI Node to base the selection upon.
1754      * @return {[rangy.Range]}
1755      */
1756     getSelectionFromNode: function(node) {
1757         var range = rangy.createRange();
1758         range.selectNode(node.getDOMNode());
1759         return [range];
1760     },
1762     /**
1763      * Save the current selection to an internal property.
1764      *
1765      * This allows more reliable return focus, helping improve keyboard navigation.
1766      *
1767      * Should be used in combination with {{#crossLink "M.editor_atto.EditorSelection/restoreSelection"}}{{/crossLink}}.
1768      *
1769      * @method saveSelection
1770      */
1771     saveSelection: function() {
1772         if (this.isActive()) {
1773             this._selections = this.getSelection();
1774         }
1775     },
1777     /**
1778      * Restore any stored selection when the editor gets focus again.
1779      *
1780      * Should be used in combination with {{#crossLink "M.editor_atto.EditorSelection/saveSelection"}}{{/crossLink}}.
1781      *
1782      * @method restoreSelection
1783      */
1784     restoreSelection: function() {
1785         if (!this._focusFromClick) {
1786             if (this._selections) {
1787                 this.setSelection(this._selections);
1788             }
1789         }
1790         this._focusFromClick = false;
1791     },
1793     /**
1794      * Get the selection object that can be passed back to setSelection.
1795      *
1796      * @method getSelection
1797      * @return {array} An array of rangy ranges.
1798      */
1799     getSelection: function() {
1800         return rangy.getSelection().getAllRanges();
1801     },
1803     /**
1804      * Check that a YUI node it at least partly contained by the current selection.
1805      *
1806      * @method selectionContainsNode
1807      * @param {Node} The node to check.
1808      * @return {boolean}
1809      */
1810     selectionContainsNode: function(node) {
1811         return rangy.getSelection().containsNode(node.getDOMNode(), true);
1812     },
1814     /**
1815      * Runs a filter on each node in the selection, and report whether the
1816      * supplied selector(s) were found in the supplied Nodes.
1817      *
1818      * By default, all specified nodes must match the selection, but this
1819      * can be controlled with the requireall property.
1820      *
1821      * @method selectionFilterMatches
1822      * @param {String} selector
1823      * @param {NodeList} [selectednodes] For performance this should be passed. If not passed, this will be looked up each time.
1824      * @param {Boolean} [requireall=true] Used to specify that "any" match is good enough.
1825      * @return {Boolean}
1826      */
1827     selectionFilterMatches: function(selector, selectednodes, requireall) {
1828         if (typeof requireall === 'undefined') {
1829             requireall = true;
1830         }
1831         if (!selectednodes) {
1832             // Find this because it was not passed as a param.
1833             selectednodes = this.getSelectedNodes();
1834         }
1835         var allmatch = selectednodes.size() > 0,
1836             anymatch = false;
1838         var editor = this.editor,
1839             stopFn = function(node) {
1840                 // The function getSelectedNodes only returns nodes within the editor, so this test is safe.
1841                 return node === editor;
1842             };
1844         // If we do not find at least one match in the editor, no point trying to find them in the selection.
1845         if (!editor.one(selector)) {
1846             return false;
1847         }
1849         selectednodes.each(function(node){
1850             // Check each node, if it doesn't match the tags AND is not within the specified tags then fail this thing.
1851             if (requireall) {
1852                 // Check for at least one failure.
1853                 if (!allmatch || !node.ancestor(selector, true, stopFn)) {
1854                     allmatch = false;
1855                 }
1856             } else {
1857                 // Check for at least one match.
1858                 if (!anymatch && node.ancestor(selector, true, stopFn)) {
1859                     anymatch = true;
1860                 }
1861             }
1862         }, this);
1863         if (requireall) {
1864             return allmatch;
1865         } else {
1866             return anymatch;
1867         }
1868     },
1870     /**
1871      * Get the deepest possible list of nodes in the current selection.
1872      *
1873      * @method getSelectedNodes
1874      * @return {NodeList}
1875      */
1876     getSelectedNodes: function() {
1877         var results = new Y.NodeList(),
1878             nodes,
1879             selection,
1880             range,
1881             node,
1882             i;
1884         selection = rangy.getSelection();
1886         if (selection.rangeCount) {
1887             range = selection.getRangeAt(0);
1888         } else {
1889             // Empty range.
1890             range = rangy.createRange();
1891         }
1893         if (range.collapsed) {
1894             // We do not want to select all the nodes in the editor if we managed to
1895             // have a collapsed selection directly in the editor.
1896             // It's also possible for the commonAncestorContainer to be the document, which selectNode does not handle
1897             // so we must filter that out here too.
1898             if (range.commonAncestorContainer !== this.editor.getDOMNode()
1899                     && range.commonAncestorContainer !== Y.config.doc) {
1900                 range = range.cloneRange();
1901                 range.selectNode(range.commonAncestorContainer);
1902             }
1903         }
1905         nodes = range.getNodes();
1907         for (i = 0; i < nodes.length; i++) {
1908             node = Y.one(nodes[i]);
1909             if (this.editor.contains(node)) {
1910                 results.push(node);
1911             }
1912         }
1913         return results;
1914     },
1916     /**
1917      * Check whether the current selection has changed since this method was last called.
1918      *
1919      * If the selection has changed, the atto:selectionchanged event is also fired.
1920      *
1921      * @method _hasSelectionChanged
1922      * @private
1923      * @param {EventFacade} e
1924      * @return {Boolean}
1925      */
1926     _hasSelectionChanged: function(e) {
1927         var selection = rangy.getSelection(),
1928             range,
1929             changed = false;
1931         if (selection.rangeCount) {
1932             range = selection.getRangeAt(0);
1933         } else {
1934             // Empty range.
1935             range = rangy.createRange();
1936         }
1938         if (this._lastSelection) {
1939             if (!this._lastSelection.equals(range)) {
1940                 changed = true;
1941                 return this._fireSelectionChanged(e);
1942             }
1943         }
1944         this._lastSelection = range;
1945         return changed;
1946     },
1948     /**
1949      * Fires the atto:selectionchanged event.
1950      *
1951      * When the selectionchanged event is fired, the following arguments are provided:
1952      *   - event : the original event that lead to this event being fired.
1953      *   - selectednodes :  an array containing nodes that are entirely selected of contain partially selected content.
1954      *
1955      * @method _fireSelectionChanged
1956      * @private
1957      * @param {EventFacade} e
1958      */
1959     _fireSelectionChanged: function(e) {
1960         this.fire('atto:selectionchanged', {
1961             event: e,
1962             selectedNodes: this.getSelectedNodes()
1963         });
1964     },
1966     /**
1967      * Get the DOM node representing the common anscestor of the selection nodes.
1968      *
1969      * @method getSelectionParentNode
1970      * @return {Element|boolean} The DOM Node for this parent, or false if no seletion was made.
1971      */
1972     getSelectionParentNode: function() {
1973         var selection = rangy.getSelection();
1974         if (selection.rangeCount) {
1975             return selection.getRangeAt(0).commonAncestorContainer;
1976         }
1977         return false;
1978     },
1980     /**
1981      * Set the current selection. Used to restore a selection.
1982      *
1983      * @method selection
1984      * @param {array} ranges A list of rangy.range objects in the selection.
1985      */
1986     setSelection: function(ranges) {
1987         var selection = rangy.getSelection();
1988         selection.setRanges(ranges);
1989     },
1991     /**
1992      * Inserts the given HTML into the editable content at the currently focused point.
1993      *
1994      * @method insertContentAtFocusPoint
1995      * @param {String} html
1996      * @return {Node} The YUI Node object added to the DOM.
1997      */
1998     insertContentAtFocusPoint: function(html) {
1999         var selection = rangy.getSelection(),
2000             range,
2001             node = Y.Node.create(html);
2002         if (selection.rangeCount) {
2003             range = selection.getRangeAt(0);
2004         }
2005         if (range) {
2006             range.deleteContents();
2007             range.insertNode(node.getDOMNode());
2008         }
2009         return node;
2010     }
2012 };
2014 Y.Base.mix(Y.M.editor_atto.Editor, [EditorSelection]);
2015 // This file is part of Moodle - http://moodle.org/
2016 //
2017 // Moodle is free software: you can redistribute it and/or modify
2018 // it under the terms of the GNU General Public License as published by
2019 // the Free Software Foundation, either version 3 of the License, or
2020 // (at your option) any later version.
2021 //
2022 // Moodle is distributed in the hope that it will be useful,
2023 // but WITHOUT ANY WARRANTY; without even the implied warranty of
2024 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2025 // GNU General Public License for more details.
2026 //
2027 // You should have received a copy of the GNU General Public License
2028 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
2030 /**
2031  * @module moodle-editor_atto-editor
2032  * @submodule styling
2033  */
2035 /**
2036  * Editor styling functions for the Atto editor.
2037  *
2038  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
2039  *
2040  * @namespace M.editor_atto
2041  * @class EditorStyling
2042  */
2044 function EditorStyling() {}
2046 EditorStyling.ATTRS= {
2047 };
2049 EditorStyling.prototype = {
2050     /**
2051      * Disable CSS styling.
2052      *
2053      * @method disableCssStyling
2054      */
2055     disableCssStyling: function() {
2056         try {
2057             document.execCommand("styleWithCSS", 0, false);
2058         } catch (e1) {
2059             try {
2060                 document.execCommand("useCSS", 0, true);
2061             } catch (e2) {
2062                 try {
2063                     document.execCommand('styleWithCSS', false, false);
2064                 } catch (e3) {
2065                     // We did our best.
2066                 }
2067             }
2068         }
2069     },
2071     /**
2072      * Enable CSS styling.
2073      *
2074      * @method enableCssStyling
2075      */
2076     enableCssStyling: function() {
2077         try {
2078             document.execCommand("styleWithCSS", 0, true);
2079         } catch (e1) {
2080             try {
2081                 document.execCommand("useCSS", 0, false);
2082             } catch (e2) {
2083                 try {
2084                     document.execCommand('styleWithCSS', false, true);
2085                 } catch (e3) {
2086                     // We did our best.
2087                 }
2088             }
2089         }
2090     },
2092     /**
2093      * Change the formatting for the current selection.
2094      *
2095      * This will wrap the selection in span tags, adding the provided classes.
2096      *
2097      * If the selection covers multiple block elements, multiple spans will be inserted to preserve the original structure.
2098      *
2099      * @method toggleInlineSelectionClass
2100      * @param {Array} toggleclasses - Class names to be toggled on or off.
2101      */
2102     toggleInlineSelectionClass: function(toggleclasses) {
2103         var classname = toggleclasses.join(" ");
2104         var originalSelection = this.getSelection();
2105         var cssApplier = rangy.createCssClassApplier(classname, {normalize: true});
2107         cssApplier.toggleSelection();
2109         this.setSelection(originalSelection);
2110     },
2112     /**
2113      * Change the formatting for the current selection.
2114      *
2115      * This will set inline styles on the current selection.
2116      *
2117      * @method toggleInlineSelectionClass
2118      * @param {Array} styles - Style attributes to set on the nodes.
2119      */
2120     formatSelectionInlineStyle: function(styles) {
2121         var classname = this.PLACEHOLDER_CLASS;
2122         var originalSelection = this.getSelection();
2123         var cssApplier = rangy.createCssClassApplier(classname, {normalize: true});
2125         cssApplier.applyToSelection();
2127         this.editor.all('.' + classname).each(function (node) {
2128             node.removeClass(classname).setStyles(styles);
2129         }, this);
2131         this.setSelection(originalSelection);
2132     },
2134     /**
2135      * Change the formatting for the current selection.
2136      *
2137      * Also changes the selection to the newly formatted block (allows applying multiple styles to a block).
2138      *
2139      * @method formatSelectionBlock
2140      * @param {String} [blocktag] Change the block level tag to this. Empty string, means do not change the tag.
2141      * @param {Object} [attributes] The keys and values for attributes to be added/changed in the block tag.
2142      * @return {Node|boolean} The Node that was formatted if a change was made, otherwise false.
2143      */
2144     formatSelectionBlock: function(blocktag, attributes) {
2145         // First find the nearest ancestor of the selection that is a block level element.
2146         var selectionparentnode = this.getSelectionParentNode(),
2147             boundary,
2148             cell,
2149             nearestblock,
2150             newcontent,
2151             match,
2152             replacement;
2154         if (!selectionparentnode) {
2155             // No selection, nothing to format.
2156             return false;
2157         }
2159         boundary = this.editor;
2161         selectionparentnode = Y.one(selectionparentnode);
2163         // If there is a table cell in between the selectionparentnode and the boundary,
2164         // move the boundary to the table cell.
2165         // This is because we might have a table in a div, and we select some text in a cell,
2166         // want to limit the change in style to the table cell, not the entire table (via the outer div).
2167         cell = selectionparentnode.ancestor(function (node) {
2168             var tagname = node.get('tagName');
2169             if (tagname) {
2170                 tagname = tagname.toLowerCase();
2171             }
2172             return (node === boundary) ||
2173                    (tagname === 'td') ||
2174                    (tagname === 'th');
2175         }, true);
2177         if (cell) {
2178             // Limit the scope to the table cell.
2179             boundary = cell;
2180         }
2182         nearestblock = selectionparentnode.ancestor(this.BLOCK_TAGS.join(', '), true);
2183         if (nearestblock) {
2184             // Check that the block is contained by the boundary.
2185             match = nearestblock.ancestor(function (node) {
2186                 return node === boundary;
2187             }, false);
2189             if (!match) {
2190                 nearestblock = false;
2191             }
2192         }
2194         // No valid block element - make one.
2195         if (!nearestblock) {
2196             // There is no block node in the content, wrap the content in a p and use that.
2197             newcontent = Y.Node.create('<p></p>');
2198             boundary.get('childNodes').each(function (child) {
2199                 newcontent.append(child.remove());
2200             });
2201             boundary.append(newcontent);
2202             nearestblock = newcontent;
2203         }
2205         // Guaranteed to have a valid block level element contained in the contenteditable region.
2206         // Change the tag to the new block level tag.
2207         if (blocktag && blocktag !== '') {
2208             // Change the block level node for a new one.
2209             replacement = Y.Node.create('<' + blocktag + '></' + blocktag + '>');
2210             // Copy all attributes.
2211             replacement.setAttrs(nearestblock.getAttrs());
2212             // Copy all children.
2213             nearestblock.get('childNodes').each(function (child) {
2214                 child.remove();
2215                 replacement.append(child);
2216             });
2218             nearestblock.replace(replacement);
2219             nearestblock = replacement;
2220         }
2222         // Set the attributes on the block level tag.
2223         if (attributes) {
2224             nearestblock.setAttrs(attributes);
2225         }
2227         // Change the selection to the modified block. This makes sense when we might apply multiple styles
2228         // to the block.
2229         var selection = this.getSelectionFromNode(nearestblock);
2230         this.setSelection(selection);
2232         return nearestblock;
2233     }
2235 };
2237 Y.Base.mix(Y.M.editor_atto.Editor, [EditorStyling]);
2238 // This file is part of Moodle - http://moodle.org/
2239 //
2240 // Moodle is free software: you can redistribute it and/or modify
2241 // it under the terms of the GNU General Public License as published by
2242 // the Free Software Foundation, either version 3 of the License, or
2243 // (at your option) any later version.
2244 //
2245 // Moodle is distributed in the hope that it will be useful,
2246 // but WITHOUT ANY WARRANTY; without even the implied warranty of
2247 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2248 // GNU General Public License for more details.
2249 //
2250 // You should have received a copy of the GNU General Public License
2251 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
2253 /**
2254  * @module moodle-editor_atto-editor
2255  * @submodule filepicker
2256  */
2258 /**
2259  * Filepicker options for the Atto editor.
2260  *
2261  * See {{#crossLink "M.editor_atto.Editor"}}{{/crossLink}} for details.
2262  *
2263  * @namespace M.editor_atto
2264  * @class EditorFilepicker
2265  */
2267 function EditorFilepicker() {}
2269 EditorFilepicker.ATTRS= {
2270     /**
2271      * The options for the filepicker.
2272      *
2273      * @attribute filepickeroptions
2274      * @type object
2275      * @default {}
2276      */
2277     filepickeroptions: {
2278         value: {}
2279     }
2280 };
2282 EditorFilepicker.prototype = {
2283     /**
2284      * Should we show the filepicker for this filetype?
2285      *
2286      * @method canShowFilepicker
2287      * @param string type The media type for the file picker.
2288      * @return {boolean}
2289      */
2290     canShowFilepicker: function(type) {
2291         return (typeof this.get('filepickeroptions')[type] !== 'undefined');
2292     },
2294     /**
2295      * Show the filepicker.
2296      *
2297      * This depends on core_filepicker, and then call that modules show function.
2298      *
2299      * @method showFilepicker
2300      * @param {string} type The media type for the file picker.
2301      * @param {function} callback The callback to use when selecting an item of media.
2302      * @param {object} [context] The context from which to call the callback.
2303      */
2304     showFilepicker: function(type, callback, context) {
2305         var self = this;
2306         Y.use('core_filepicker', function (Y) {
2307             var options = Y.clone(self.get('filepickeroptions')[type], true);
2308             options.formcallback = callback;
2309             if (context) {
2310                 options.magicscope = context;
2311             }
2313             M.core_filepicker.show(Y, options);
2314         });
2315     }
2316 };
2318 Y.Base.mix(Y.M.editor_atto.Editor, [EditorFilepicker]);
2321 }, '@VERSION@', {
2322     "requires": [
2323         "node",
2324         "transition",
2325         "io",
2326         "overlay",
2327         "escape",
2328         "event",
2329         "event-simulate",
2330         "event-custom",
2331         "yui-throttle",
2332         "moodle-core-notification-dialogue",
2333         "moodle-core-notification-confirm",
2334         "moodle-editor_atto-rangy",
2335         "handlebars",
2336         "timers"
2337     ]
2338 });