@oat-sa/tao-core-ui 1.60.2 → 1.62.0

package/dist/ckeditor/ckConfigurator.js

@@ -5,45 +5,41 @@ define(['jquery', 'lodash', 'ui/ckeditor/dtdHandler', 'ckeditor', 'module'], fun
     dtdHandler = dtdHandler && Object.prototype.hasOwnProperty.call(dtdHandler, 'default') ? dtdHandler['default'] : dtdHandler;
     module = module && Object.prototype.hasOwnProperty.call(module, 'default') ? module['default'] : module;
 
-    /**
-     * This program is free software; you can redistribute it and/or
-     * modify it under the terms of the GNU General Public License
-     * as published by the Free Software Foundation; under version 2
-     * of the License (non-upgradable).
-     *
-     * This program is distributed in the hope that it will be useful,
-     * but WITHOUT ANY WARRANTY; without even the implied warranty of
-     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-     * GNU General Public License for more details.
-     *
-     * You should have received a copy of the GNU General Public License
-     * along with this program; if not, write to the Free Software
-     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-     *
-     * Copyright (c) 2015-2022 (original work) Open Assessment Technologies SA ;
+    /**
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; under version 2
+     * of the License (non-upgradable).
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+     *
+     * Copyright (c) 2015-2022 (original work) Open Assessment Technologies SA ;
      */
-    /**
-     * Cache original config
-     */
-
-    var originalConfig = _.cloneDeep(window.CKEDITOR.config);
-
-    var moduleConfig = module.config();
 
+    /**
+     * Cache original config
+     */
+    const originalConfig = _.cloneDeep(window.CKEDITOR.config);
+    const moduleConfig = module.config();
     function getUserLanguage() {
-      var documentLang = window.document.documentElement.getAttribute('lang');
-      var documentLocale = documentLang && documentLang.split('-')[0];
+      const documentLang = window.document.documentElement.getAttribute('lang');
+      const documentLocale = documentLang && documentLang.split('-')[0];
       return documentLocale;
     }
-
-    var lang = getUserLanguage();
-
-    var ckConfigurator = function () {
-      /**
-       * Toolbar presets that you normally never would need to change, they can however be overridden with options.toolbar.
-       * The argument 'toolbarType' determines which toolbar to use
+    const lang = getUserLanguage();
+    const ckConfigurator = function () {
+      /**
+       * Toolbar presets that you normally never would need to change, they can however be overridden with options.toolbar.
+       * The argument 'toolbarType' determines which toolbar to use
        */
-      var toolbarPresets = {
+      const toolbarPresets = {
         inline: [{
           name: 'basicstyles',
           items: ['Bold', 'Italic', 'Subscript', 'Superscript']
@@ -159,11 +155,11 @@ define(['jquery', 'lodash', 'ui/ckeditor/dtdHandler', 'ckeditor', 'module'], fun
           items: ['Language']
         }]
       };
-      /**
-       * defaults for editor configuration
-       */
 
-      var ckConfigDefault = {
+      /**
+       * defaults for editor configuration
+       */
+      const ckConfigDefault = {
         disableAutoInline: true,
         entities: false,
         entities_processNumerical: true,
@@ -192,47 +188,44 @@ define(['jquery', 'lodash', 'ui/ckeditor/dtdHandler', 'ckeditor', 'module'], fun
         specialChars: ['!', '"', '#', '$', '%', '&', "'", '(', ')', '*', '+', '-', '.', '/', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', ':', ';', ['<', 'Less than'], ['≤', 'Less than or equal to'], '≈', '=', '≠', ['≥', 'Greater than or equal to'], ['>', 'Greater than'], '?', '@', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', '[', ']', '^', '_', '`', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '{', '|', '}', '~', '€', '‘', '’', '“', '”', '–', '—', '¡', '¢', '£', '¤', '¥', '¦', '§', '¨', '©', 'ª', '«', '¬', '®', '¯', '°', '²', '³', '´', 'µ', '¶', '·', '¸', '¹', 'º', '»', '¼', '½', '¾', '¿', 'À', 'Á', 'Â', 'Ã', 'Ä', 'Å', 'Æ', 'Ç', 'È', 'É', 'Ê', 'Ë', 'Ì', 'Í', 'Î', 'Ï', 'Ð', 'Ñ', 'Ò', 'Ó', 'Ô', 'Õ', 'Ö', '×', 'Ø', 'Ù', 'Ú', 'Û', 'Ü', 'Ý', 'Þ', 'ß', 'à', 'á', 'â', 'ã', 'ä', 'å', 'æ', 'ç', 'è', 'é', 'ê', 'ë', 'ì', 'í', 'î', 'ï', 'ð', 'ñ', 'ò', 'ó', 'ô', 'õ', 'ö', '÷', 'ø', 'ù', 'ú', 'û', 'ü', 'ý', 'þ', 'ÿ', 'Œ', 'œ', 'Ŵ', '&#374', '&#373', 'ŷ', '‚', '‛', '„', '…', '™', '►', '•', '→', '⇒', '⇔', '♦', '≈'],
         disableNativeTableHandles: true
       };
-
       if (moduleConfig && moduleConfig.specialChars) {
         ckConfigDefault.specialChars = moduleConfig.specialChars;
       }
-      /**
-       * Insert positioned plugins at position specified in options.positionedPlugins
-       *
-       * @param {Object} ckConfig
-       * @param {Object} positionedPlugins
-       */
-
-
-      var _updatePlugins = function _updatePlugins(ckConfig, positionedPlugins) {
-        var itCnt,
-            tbCnt = ckConfig.toolbar.length,
-            itLen,
-            method,
-            plugin,
-            index,
-            separator,
-            idxItem,
-            numToReplace,
-            stringVal,
-            stringVals = {},
-            i;
-        positionedPlugins = positionedPlugins || {}; // add positioned plugins to extraPlugins and let CKEDITOR take care of their registration
 
+      /**
+       * Insert positioned plugins at position specified in options.positionedPlugins
+       *
+       * @param {Object} ckConfig
+       * @param {Object} positionedPlugins
+       */
+      const _updatePlugins = function (ckConfig, positionedPlugins) {
+        let itCnt,
+          tbCnt = ckConfig.toolbar.length,
+          itLen,
+          method,
+          plugin,
+          index,
+          separator,
+          idxItem,
+          numToReplace,
+          stringVal,
+          stringVals = {},
+          i;
+        positionedPlugins = positionedPlugins || {};
+
+        // add positioned plugins to extraPlugins and let CKEDITOR take care of their registration
         ckConfig.extraPlugins = function (positionedPluginArr, extraPlugins) {
-          var pluginIndex = positionedPluginArr.length;
-          var extraPluginArr = extraPlugins.split(',');
-
+          let pluginIndex = positionedPluginArr.length;
+          let extraPluginArr = extraPlugins.split(',');
           while (pluginIndex--) {
             positionedPluginArr[pluginIndex] = positionedPluginArr[pluginIndex].toLowerCase();
           }
-
           extraPluginArr = _.compact(_.union(extraPluginArr, positionedPluginArr));
           return extraPluginArr.join(',');
-        }(_.keys(positionedPlugins), ckConfig.extraPlugins); // capture line breaks (/) and such
-        // and turn them into a objects temporarily
-
+        }(_.keys(positionedPlugins), ckConfig.extraPlugins);
 
+        // capture line breaks (/) and such
+        // and turn them into a objects temporarily
         for (i = 0; i < tbCnt; i++) {
           if (_.isString(ckConfig.toolbar[i])) {
             stringVals[i] = ckConfig.toolbar[i];
@@ -240,145 +233,132 @@ define(['jquery', 'lodash', 'ui/ckeditor/dtdHandler', 'ckeditor', 'module'], fun
               items: []
             };
           }
-        } // add positioned plugins to toolbar
-
+        }
 
+        // add positioned plugins to toolbar
         for (plugin in positionedPlugins) {
           method = function (pluginProps) {
-            var propIndex = pluginProps.length;
-
+            let propIndex = pluginProps.length;
             while (propIndex--) {
               if (pluginProps[propIndex].indexOf('insert') === 0 || pluginProps[propIndex] === 'replace') {
                 return pluginProps[propIndex];
               }
             }
-
             throw new Error('Missing key insertBefore | insertAfter | replace in positionedPlugins');
-          }(_.keys(positionedPlugins[plugin])); // the item to insert before | after
-
+          }(_.keys(positionedPlugins[plugin]));
 
+          // the item to insert before | after
           idxItem = positionedPlugins[plugin][method].toLowerCase();
           separator = positionedPlugins[plugin].separator || false;
-          index = -1; // each button row
+          index = -1;
 
+          // each button row
           while (tbCnt--) {
-            itLen = ckConfig.toolbar[tbCnt].items.length; // each item in row
+            itLen = ckConfig.toolbar[tbCnt].items.length;
 
+            // each item in row
             for (itCnt = 0; itCnt < itLen; itCnt++) {
               if (ckConfig.toolbar[tbCnt].items[itCnt].toLowerCase() === idxItem) {
                 index = itCnt;
                 break;
               }
-            } //continue
-
-
+            }
+            //continue
             if (index > -1) {
               numToReplace = method === 'replace' ? 1 : 0;
-
               if (method === 'insertAfter') {
                 index++;
               }
-
               if (separator) {
                 ckConfig.toolbar[tbCnt].items.splice(index, numToReplace, '-');
                 index++;
               }
-
               ckConfig.toolbar[tbCnt].items.splice(index, numToReplace, plugin);
               break;
             }
-          } // reset tbCnt
-
-
+          }
+          // reset tbCnt
           tbCnt = ckConfig.toolbar.length;
-        } // re-add toolbar line breaks
-
+        }
 
+        // re-add toolbar line breaks
         for (stringVal in stringVals) {
           ckConfig.toolbar[stringVal] = stringVals[stringVal];
         }
       };
-
-      var _switchDtd = function _switchDtd(dtdMode) {
+      const _switchDtd = function _switchDtd(dtdMode) {
         dtdHandler.setMode(dtdMode);
         window.CKEDITOR.dtd = dtdHandler.getDtd();
       };
-      /**
-       * Generate a configuration object for CKEDITOR
-       *
-       * @param editor instance of ckeditor
-       * @param toolbarType block | inline | flow | qtiBlock | qtiInline | qtiFlow | htmlField | reset to get back to normal
-       * @param {Object} [options] - is based on the CKEDITOR config object with some additional sugar
-       *        Note that it's here you need to add parameters for the resource manager.
-       *        Some options are not covered in http://docs.ckeditor.com/#!/api/CKEDITOR.config
-       * @param [options.dtdOverrides] - @see dtdOverrides which pre-defines them
-       * @param {Object} [options.positionedPlugins] - @see ckConfig.positionedPlugins
-       * @param {Boolean} [options.qtiImage] - enables the qtiImage plugin
-       * @param {Boolean} [options.qtiMedia] - enables the qtiMedia plugin
-       * @param {Boolean} [options.qtiInclude] - enables the qtiInclude plugin
-       * @param {Boolean} [options.underline] - enables the underline plugin
-       * @param {Boolean} [options.highlight] - enables the highlight plugin
-       * @param {Boolean} [options.mathJax] - enables the mathJax plugin
-       * @param {Boolean} [options.horizontalRule] - enables the horizontalRule plugin
-       * @param {String} [options.removePlugins] - a coma-separated list of plugins that should not be loaded: 'plugin1,plugin2,plugin3'
-       *
-       * @see http://docs.ckeditor.com/#!/api/CKEDITOR.config
-       */
 
+      /**
+       * Generate a configuration object for CKEDITOR
+       *
+       * @param editor instance of ckeditor
+       * @param toolbarType block | inline | flow | qtiBlock | qtiInline | qtiFlow | htmlField | reset to get back to normal
+       * @param {Object} [options] - is based on the CKEDITOR config object with some additional sugar
+       *        Note that it's here you need to add parameters for the resource manager.
+       *        Some options are not covered in http://docs.ckeditor.com/#!/api/CKEDITOR.config
+       * @param [options.dtdOverrides] - @see dtdOverrides which pre-defines them
+       * @param {Object} [options.positionedPlugins] - @see ckConfig.positionedPlugins
+       * @param {Boolean} [options.qtiImage] - enables the qtiImage plugin
+       * @param {Boolean} [options.qtiMedia] - enables the qtiMedia plugin
+       * @param {Boolean} [options.qtiInclude] - enables the qtiInclude plugin
+       * @param {Boolean} [options.underline] - enables the underline plugin
+       * @param {Boolean} [options.highlight] - enables the highlight plugin
+       * @param {Boolean} [options.mathJax] - enables the mathJax plugin
+       * @param {Boolean} [options.horizontalRule] - enables the horizontalRule plugin
+       * @param {String} [options.removePlugins] - a coma-separated list of plugins that should not be loaded: 'plugin1,plugin2,plugin3'
+       *
+       * @see http://docs.ckeditor.com/#!/api/CKEDITOR.config
+       */
+      const getConfig = function (editor, toolbarType, options) {
+        let toolbar, toolbars, config, dtdMode;
 
-      var getConfig = function getConfig(editor, toolbarType, options) {
-        var toolbar, toolbars, config, dtdMode; // This is different from CKEDITOR.config.extraPlugins since it also allows to position the button
+        // This is different from CKEDITOR.config.extraPlugins since it also allows to position the button
         // Valid positioning keys are insertAfter | insertBefore | replace followed by the button name, e.g. 'Anchor'
         // separator bool, defaults to false
-
-        var positionedPlugins = {};
-
+        let positionedPlugins = {};
         if (toolbarType === 'reset') {
           return originalConfig;
         }
-
         options = options || {};
         options.resourcemgr = options.resourcemgr || {};
         toolbars = _.clone(toolbarPresets, true);
         dtdMode = options.dtdMode || 'html';
+        const ckConfig = _.clone(ckConfigDefault, true);
 
-        var ckConfig = _.clone(ckConfigDefault, true); // modify DTD to either comply with QTI or XHTML
-
-
+        // modify DTD to either comply with QTI or XHTML
         if (dtdMode === 'qti' || toolbarType.indexOf('qti') === 0) {
           toolbarType = toolbarType.slice(3).toLowerCase();
           ckConfig.allowedContent = true;
           ckConfig.autoParagraph = false;
           dtdMode = 'qti';
-        } // modify plugins - this will change the toolbar too
-        // this would add the qti plugins in positionedPlugins
-
+        }
 
+        // modify plugins - this will change the toolbar too
+        // this would add the qti plugins in positionedPlugins
         if (dtdMode === 'qti') {
           if (options.qtiMedia) {
             positionedPlugins.TaoQtiMedia = {
               insertAfter: 'SpecialChar'
             };
           }
-
           if (options.qtiImage) {
             positionedPlugins.TaoQtiImage = {
               insertAfter: 'SpecialChar'
             };
           }
-
           if (options.qtiInclude) {
             positionedPlugins.TaoQtiInclude = {
               insertAfter: 'SpecialChar'
             };
           }
-
           if (options.underline) {
             positionedPlugins.TaoUnderline = {
               insertAfter: 'Italic'
             };
           }
-
           if (options.highlight) {
             if (options.underline) {
               positionedPlugins.TaoHighlight = {
@@ -390,93 +370,89 @@ define(['jquery', 'lodash', 'ui/ckeditor/dtdHandler', 'ckeditor', 'module'], fun
               };
             }
           }
-
           if (options.mathJax) {
             positionedPlugins.TaoQtiMaths = {
               insertAfter: 'SpecialChar'
             };
           }
-
           if (options.horizontalRule && ['block', 'inline'].includes(toolbarType)) {
             positionedPlugins.HorizontalRule = {
               insertAfter: 'TaoTooltip'
             };
           }
-        } // if there is a toolbar in the options add it to the set
-
+        }
 
+        // if there is a toolbar in the options add it to the set
         if (options.toolbar) {
           toolbars[toolbarType] = _.clone(options.toolbar);
-        } // add toolbars to config
-
+        }
 
+        // add toolbars to config
         for (toolbar in toolbars) {
           if (Object.prototype.hasOwnProperty.call(toolbars, toolbar)) {
             ckConfig['toolbar_' + toolbar] = toolbars[toolbar];
           }
-        } // add the toolbar
-
+        }
 
+        // add the toolbar
         if (typeof toolbars[toolbarType] !== 'undefined') {
           ckConfig.toolbar = toolbars[toolbarType];
-        } // ensures positionedPlugins has the right format
-
+        }
 
+        // ensures positionedPlugins has the right format
         if (typeof options.positionedPlugins !== 'undefined') {
           options.positionedPlugins = {};
-        } // set options.positionedPlugins to false to prevent the class from using them at all
-
+        }
 
+        // set options.positionedPlugins to false to prevent the class from using them at all
         if (false !== options.positionedPlugins) {
           // this would add positionedPlugins (e.g. the media manager)
           positionedPlugins = _.assign(positionedPlugins, _.clone(options.positionedPlugins));
-
           _updatePlugins(ckConfig, positionedPlugins);
-        } // forward the options to ckConfig, exclude local options
+        }
 
+        // forward the options to ckConfig, exclude local options
+        config = _.assign({}, _.cloneDeep(originalConfig), ckConfig, _.omit(options, ['qtiImage', 'qtiInclude', 'underline', 'highlight', 'mathJax', 'toolbar', 'positionedPlugins']));
 
-        config = _.assign({}, _.cloneDeep(originalConfig), ckConfig, _.omit(options, ['qtiImage', 'qtiInclude', 'underline', 'highlight', 'mathJax', 'toolbar', 'positionedPlugins'])); // debugger: has this config been used?
+        // debugger: has this config been used?
         //config.aaaConfigurationHasBeenLoadedFromConfigurator = true;
+
         // toggle global DTD depending on the CK instance which is receiving the focus
         // I know that this is rather ugly <= don't worry, we'll keep this a secret ;)
-
         editor.on('focus', function () {
-          _switchDtd(dtdMode); // should be 1 on html, undefined on qti
+          _switchDtd(dtdMode);
+          // should be 1 on html, undefined on qti
           // console.log(CKEDITOR.dtd.pre.img)
+        });
 
-        }); // remove title 'Rich Text Editor, instance n' that CKE sets by default
+        // remove title 'Rich Text Editor, instance n' that CKE sets by default
         // ref: http://tinyurl.com/keedruc
-
         editor.on('instanceReady', function (e) {
           $(e.editor.element.$).removeAttr('title');
-        }); // This fixes bug #2855. Unfortunately this can be done on the global object only, not on the instance
+        });
 
+        // This fixes bug #2855. Unfortunately this can be done on the global object only, not on the instance
         window.CKEDITOR.on('dialogDefinition', function (e) {
-          var linkTypes, wanted, linkIndex;
-
+          let linkTypes, wanted, linkIndex;
           if (e.data.name !== 'link') {
             return;
           }
-
           linkTypes = e.data.definition.getContents('info').get('linkType').items;
           linkIndex = linkTypes.length;
-
           while (linkIndex--) {
             if (linkTypes[linkIndex][1] !== 'anchor') {
               wanted = linkIndex;
               continue;
             }
           }
-
           linkTypes.splice(wanted + 1, 1);
           return;
         });
         return config;
-      }; // Set TAO custom DTD the first time CKEditor is initialized
-
+      };
 
+      // Set TAO custom DTD the first time CKEditor is initialized
       _switchDtd('qti');
-
       return {
         getConfig: getConfig
       };