/** * DefaultSettings.js * * Released under LGPL License. * Copyright (c) 1999-2017 Ephox Corp. All rights reserved * * License: http://www.tinymce.com/license * Contributing: http://www.tinymce.com/contributing */ import { Arr, Fun, Obj, Option, Strings, Struct, Type } from '@ephox/katamari'; import { PlatformDetection } from '@ephox/sand'; import Tools from './api/util/Tools'; import { Editor } from 'tinymce/core/api/Editor'; export interface ParamTypeMap { 'hash': Record; 'string': string; 'number': number; 'boolean': boolean; 'string[]': string[]; 'array': any[]; } const sectionResult = Struct.immutable('sections', 'settings'); const detection = PlatformDetection.detect(); const isTouch = detection.deviceType.isTouch(); const mobilePlugins = [ 'lists', 'autolink', 'autosave' ]; const defaultMobileSettings = { theme: 'mobile' }; const normalizePlugins = function (plugins) { const pluginNames = Type.isArray(plugins) ? plugins.join(' ') : plugins; const trimmedPlugins = Arr.map(Type.isString(pluginNames) ? pluginNames.split(' ') : [ ], Strings.trim); return Arr.filter(trimmedPlugins, function (item) { return item.length > 0; }); }; const filterMobilePlugins = function (plugins) { return Arr.filter(plugins, Fun.curry(Arr.contains, mobilePlugins)); }; const extractSections = function (keys, settings) { const result = Obj.bifilter(settings, function (value, key) { return Arr.contains(keys, key); }); return sectionResult(result.t, result.f); }; const getSection = function (sectionResult, name, defaults) { const sections = sectionResult.sections(); const sectionSettings = sections.hasOwnProperty(name) ? sections[name] : { }; return Tools.extend({}, defaults, sectionSettings); }; const hasSection = function (sectionResult, name) { return sectionResult.sections().hasOwnProperty(name); }; const getDefaultSettings = function (id, documentBaseUrl, editor) { return { id, theme: 'modern', delta_width: 0, delta_height: 0, popup_css: '', plugins: '', document_base_url: documentBaseUrl, add_form_submit_trigger: true, submit_patch: true, add_unload_trigger: true, convert_urls: true, relative_urls: true, remove_script_host: true, object_resizing: true, doctype: '', visual: true, font_size_style_values: 'xx-small,x-small,small,medium,large,x-large,xx-large', // See: http://www.w3.org/TR/CSS2/fonts.html#propdef-font-size font_size_legacy_values: 'xx-small,small,medium,large,x-large,xx-large,300%', forced_root_block: 'p', hidden_input: true, render_ui: true, indentation: '30px', inline_styles: true, convert_fonts_to_spans: true, indent: 'simple', indent_before: 'p,h1,h2,h3,h4,h5,h6,blockquote,div,title,style,pre,script,td,th,ul,ol,li,dl,dt,dd,area,table,thead,' + 'tfoot,tbody,tr,section,article,hgroup,aside,figure,figcaption,option,optgroup,datalist', indent_after: 'p,h1,h2,h3,h4,h5,h6,blockquote,div,title,style,pre,script,td,th,ul,ol,li,dl,dt,dd,area,table,thead,' + 'tfoot,tbody,tr,section,article,hgroup,aside,figure,figcaption,option,optgroup,datalist', entity_encoding: 'named', url_converter: editor.convertURL, url_converter_scope: editor, ie7_compat: true }; }; const getExternalPlugins = function (overrideSettings, settings) { const userDefinedExternalPlugins = settings.external_plugins ? settings.external_plugins : { }; if (overrideSettings && overrideSettings.external_plugins) { return Tools.extend({}, overrideSettings.external_plugins, userDefinedExternalPlugins); } else { return userDefinedExternalPlugins; } }; const combinePlugins = function (forcedPlugins, plugins) { return [].concat(normalizePlugins(forcedPlugins)).concat(normalizePlugins(plugins)); }; const processPlugins = function (isTouchDevice, sectionResult, defaultOverrideSettings, settings) { const forcedPlugins = normalizePlugins(defaultOverrideSettings.forced_plugins); const plugins = normalizePlugins(settings.plugins); const platformPlugins = isTouchDevice && hasSection(sectionResult, 'mobile') ? filterMobilePlugins(plugins) : plugins; const combinedPlugins = combinePlugins(forcedPlugins, platformPlugins); return Tools.extend(settings, { plugins: combinedPlugins.join(' ') }); }; const isOnMobile = function (isTouchDevice, sectionResult) { const isInline = sectionResult.settings().inline; // We don't support mobile inline yet return isTouchDevice && hasSection(sectionResult, 'mobile') && !isInline; }; const combineSettings = function (isTouchDevice, defaultSettings, defaultOverrideSettings, settings) { const sectionResult = extractSections(['mobile'], settings); const extendedSettings = Tools.extend( // Default settings defaultSettings, // tinymce.overrideDefaults settings defaultOverrideSettings, // User settings sectionResult.settings(), // Sections isOnMobile(isTouchDevice, sectionResult) ? getSection(sectionResult, 'mobile', defaultMobileSettings) : { }, // Forced settings { validate: true, content_editable: sectionResult.settings().inline, external_plugins: getExternalPlugins(defaultOverrideSettings, sectionResult.settings()) } ); return processPlugins(isTouchDevice, sectionResult, defaultOverrideSettings, extendedSettings); }; const getEditorSettings = function (editor, id, documentBaseUrl, defaultOverrideSettings, settings) { const defaultSettings = getDefaultSettings(id, documentBaseUrl, editor); return combineSettings(isTouch, defaultSettings, defaultOverrideSettings, settings); }; const get = function (editor, name) { return Option.from(editor.settings[name]); }; const getFiltered = (predicate: (x: any) => boolean, editor, name: string) => Option.from(editor.settings[name]).filter(predicate); const getString = Fun.curry(getFiltered, Type.isString); const getParamObject = (value: string) => { let output = {}; if (typeof value === 'string') { Arr.each(value.indexOf('=') > 0 ? value.split(/[;,](?![^=;,]*(?:[;,]|$))/) : value.split(','), function (val: string) { const arr = val.split('='); if (arr.length > 1) { output[Tools.trim(arr[0])] = Tools.trim(arr[1]); } else { output[Tools.trim(arr[0])] = Tools.trim(arr); } }); } else { output = value; } return output; }; const isArrayOf = (p: (a: any) => boolean) => (a: any) => Type.isArray(a) && Arr.forall(a, p); const getParam = (editor: Editor, name: string, defaultVal?: any, type?: string) => { const value = name in editor.settings ? editor.settings[name] : defaultVal; if (type === 'hash') { return getParamObject(value); } else if (type === 'string') { return getFiltered(Type.isString, editor, name).getOr(defaultVal); } else if (type === 'number') { return getFiltered(Type.isNumber, editor, name).getOr(defaultVal); } else if (type === 'boolean') { return getFiltered(Type.isBoolean, editor, name).getOr(defaultVal); } else if (type === 'object') { return getFiltered(Type.isObject, editor, name).getOr(defaultVal); } else if (type === 'array') { return getFiltered(Type.isArray, editor, name).getOr(defaultVal); } else if (type === 'string[]') { return getFiltered(isArrayOf(Type.isString), editor, name).getOr(defaultVal); } else if (type === 'function') { return getFiltered(Type.isFunction, editor, name).getOr(defaultVal); } else { return value; } }; export { getEditorSettings, get, getString, getParam, combineSettings };