diff --git a/.gitignore b/.gitignore index 33ea1d0d..6e2a2952 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,6 @@ test.html node_modules/ npm-debug.log -translations/???.js .idea .htaccess docs diff --git a/Gruntfile.cjs b/Gruntfile.cjs index 566cb489..69bdfca2 100644 --- a/Gruntfile.cjs +++ b/Gruntfile.cjs @@ -21,22 +21,22 @@ module.exports = function (grunt) { }, run: { rollup: { - cmd: 'npm', - args: ['exec', 'rollup', '--', '-c'], + cmd: 'node', + args: ['node_modules/rollup/dist/bin/rollup', '-c'], }, jest: { - cmd: 'npm', - args: ['exec', 'jest', '--', '--colors'] + cmd: 'node', + args: ['node_modules/jest/bin/jest.js', '--colors'] }, types: { - cmd: 'npx', - args: ['tsc'] + cmd: 'node', + args: ['node_modules/typescript/bin/tsc', '-p', 'tsconfig.json'] }, }, copy: { dompurify: { files: { - 'build/separate-dompurify/purify.min.js': ['/node_modules/dompurify/dist/purify.min.js'], + 'build/separate-dompurify/purify.min.js': ['node_modules/dompurify/dist/purify.min.js'], } } }, diff --git a/README.md b/README.md index 93d1dde7..5a9e7a38 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ - [Feature List](#feature-list) - [Supported Languages](#supported-languages) - [Compatibility](#compatibility) +- [Content Security Policies](#content-security-policies) - [Dependencies](#dependencies) - [Fallback](#fallback) - [Setup](#setup) @@ -26,6 +27,7 @@ - Supports closed captions and subtitles in Web Video Timed Text (WebVTT) format, the standard format recommended by the HTML5 specification. - Supports chapters, also using WebVTT. Chapters are specific landing points in the video, allowing video content to have structure and be more easily navigated. - Supports text-based audio description, also using WebVTT. At designated times, the description text is read aloud by browsers, or by screen readers for browsers that don't support the Web Speech API. Users can optionally set their player to pause when audio description starts to avoid conflicts between the description and program audio. +- Supports spoken captions, as described in the "Spoken subtitles" requirement to EN 301 549. If enabled by a user, caption timing will be estimated and speed is dynamically adjusted to fit the available time. User can select a default speed, pitch, and volume for captions. - Supports audio description as a separate video. When two videos are available (one with description and one without), both can be delivered together using the same player and users can toggle between the versions. - Supports adjustable playback rate. Users who need to slow down the video to better process and understand its content can do so; and users who need to speed up the video to maintain better focus can do so. - Includes an interactive transcript feature, built from the WebVTT chapter, caption and description files as the page is loaded. Users can click anywhere in the transcript to start playing the video (or audio) at that point. Keyboard users can also choose to keyboard-enable the transcript, so they can tab through its content one caption at a time and press enter to play the media at the desired point. @@ -58,6 +60,7 @@ Able Player has been translated into the following languages.
  • Português - Brasil (Portuguese - Brazil)
  • Norsk Bokmål (Norwegian)
  • Nederlands, Vlaams (Dutch)
  • +
  • Slovenčina (Slovak)
  • Svenska (Swedish)
  • Türkçe (Turkish)
  • @@ -86,6 +89,33 @@ During development, *Able Player* is routinely tested with the latest versions o Since the release of version 4.4, we are no longer supporting Internet Explorer. +## Content Security Policies + +AblePlayer, by default, only references local sources with no inline scripts. However, it is possible to extend it using external scripting, and support for YouTube and Vimeo requires external resources. + +These content policies only cover the default requirements for Able Player; the environment you're using it in may have additional requirements. + +The Able Players demos get jQuery and jsCookie from content delivery networks. If you use those external sources, you will also need to use `script-src 'self' https://cdn.jsdelivr.net https://code.jquery.com`, or references to whatever external source you are using. + +### Using only local sources + +Content-Security-Policy: default-src 'self'; script-src 'self'; style-src 'self'; + +### Using Vimeo + +Content-Security-Policy: default-src 'self' https://vimeo.com; script-src 'self' https://player.vimeo.com; style-src 'self'; frame-src 'self' https://player.vimeo.com; + +### Using YouTube + +The YouTube security policy uses both the 'nocookie' and the default YouTube domains. You do not need to allow both, depending on your usage. + +Content-Security-Policy: default-src 'self' https://img.youtube.com; script-src 'self' https://youtube.com https://nocookie.youtube.com; style-src 'self'; frame-src 'self' https://nocookie.youtube.com https://www.youtube.com; + +### Using YouTube & Vimeo + +Content-Security-Policy: default-src 'self' https://img.youtube.com https://vimeo.com; script-src 'self' https://player.vimeo.com https://youtube.com https://nocookie.youtube.com; style-src 'self'; frame-src 'self' https://www.youtube.com https://player.vimeo.com; + + ## Dependencies *Able Player* has the following third party dependencies: @@ -685,7 +715,7 @@ If your site is running on a Windows server, consult the documentation from Micr *Able Player* includes several keyboard shortcuts that enable users to control the player from anywhere on the web page, as follows: - **p or spacebar** = Play/Pause -- **s** = Stop +- **s** = Restart - **r** = Rewind - **f** = Forward - **b** = Back (previous track in playlist) diff --git a/build/ableplayer.dist.js b/build/ableplayer.dist.js index 117f03f0..62599aff 100644 --- a/build/ableplayer.dist.js +++ b/build/ableplayer.dist.js @@ -1,11 +1,12 @@ -/*! ableplayer V4.8.0 with DOMPurify included */ -/*! @license DOMPurify 3.3.1 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/3.3.1/LICENSE */ +/*! ableplayer V5.0.0 - with DOMPurify included. Console logs disabled, but not minified, for demos. */ (function (global, factory) { - typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() : - typeof define === 'function' && define.amd ? define(factory) : - (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.DOMPurify = factory()); -})(this, (function () { 'use strict'; + typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory(require('jquery')) : + typeof define === 'function' && define.amd ? define(['jquery'], factory) : + (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.AblePlayer = factory(global.jQuery)); +})(this, (function ($) { 'use strict'; + + /*! @license DOMPurify 3.4.0 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/3.4.0/LICENSE */ const { entries, @@ -18,7 +19,7 @@ freeze, seal, create - } = Object; + } = Object; // eslint-disable-line import/no-mutable-exports let { apply, construct @@ -63,6 +64,12 @@ const objectHasOwnProperty = unapply(Object.prototype.hasOwnProperty); const regExpTest = unapply(RegExp.prototype.test); const typeErrorCreate = unconstruct(TypeError); + /** + * Creates a new function that calls the given function with a specified thisArg and arguments. + * + * @param func - The function to be wrapped and called. + * @returns A new function that calls the given function with a specified thisArg and arguments. + */ function unapply(func) { return function (thisArg) { if (thisArg instanceof RegExp) { @@ -74,6 +81,12 @@ return apply(func, thisArg, args); }; } + /** + * Creates a new function that constructs an instance of the given constructor function with the provided arguments. + * + * @param func - The constructor function to be wrapped and called. + * @returns A new function that constructs an instance of the given constructor function with the provided arguments. + */ function unconstruct(Func) { return function () { for (var _len4 = arguments.length, args = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) { @@ -82,9 +95,20 @@ return construct(Func, args); }; } + /** + * Add properties to a lookup table + * + * @param set - The set to which elements will be added. + * @param array - The array containing elements to be added to the set. + * @param transformCaseFunc - An optional function to transform the case of each element before adding to the set. + * @returns The modified set with added elements. + */ function addToSet(set, array) { let transformCaseFunc = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : stringToLowerCase; if (setPrototypeOf) { + // Make 'in' and truthy checks like Boolean(set.constructor) + // independent of any properties defined on Object.prototype. + // Prevent prototype setters from intercepting set as a this value. setPrototypeOf(set, null); } let l = array.length; @@ -93,6 +117,7 @@ if (typeof element === 'string') { const lcElement = transformCaseFunc(element); if (lcElement !== element) { + // Config presets (e.g. tags.js, attrs.js) are immutable. if (!isFrozen(array)) { array[l] = lcElement; } @@ -103,6 +128,12 @@ } return set; } + /** + * Clean up an array to harden against CSPP + * + * @param array - The array to be cleaned. + * @returns The cleaned version of the array + */ function cleanArray(array) { for (let index = 0; index < array.length; index++) { const isPropertyExist = objectHasOwnProperty(array, index); @@ -112,6 +143,12 @@ } return array; } + /** + * Shallow clone an object + * + * @param object - The object to be cloned. + * @returns A new object that copies the original. + */ function clone(object) { const newObject = create(null); for (const [property, value] of entries(object)) { @@ -128,6 +165,13 @@ } return newObject; } + /** + * This method automatically checks if the prop is function or getter and behaves accordingly. + * + * @param object - The object to look up the getter function in its prototype chain. + * @param prop - The property name for which to find the getter function. + * @returns The getter function found in the prototype chain or a fallback function. + */ function lookupGetter(object, prop) { while (object !== null) { const desc = getOwnPropertyDescriptor(object, prop); @@ -150,30 +194,37 @@ const html$1 = freeze(['a', 'abbr', 'acronym', 'address', 'area', 'article', 'aside', 'audio', 'b', 'bdi', 'bdo', 'big', 'blink', 'blockquote', 'body', 'br', 'button', 'canvas', 'caption', 'center', 'cite', 'code', 'col', 'colgroup', 'content', 'data', 'datalist', 'dd', 'decorator', 'del', 'details', 'dfn', 'dialog', 'dir', 'div', 'dl', 'dt', 'element', 'em', 'fieldset', 'figcaption', 'figure', 'font', 'footer', 'form', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'head', 'header', 'hgroup', 'hr', 'html', 'i', 'img', 'input', 'ins', 'kbd', 'label', 'legend', 'li', 'main', 'map', 'mark', 'marquee', 'menu', 'menuitem', 'meter', 'nav', 'nobr', 'ol', 'optgroup', 'option', 'output', 'p', 'picture', 'pre', 'progress', 'q', 'rp', 'rt', 'ruby', 's', 'samp', 'search', 'section', 'select', 'shadow', 'slot', 'small', 'source', 'spacer', 'span', 'strike', 'strong', 'style', 'sub', 'summary', 'sup', 'table', 'tbody', 'td', 'template', 'textarea', 'tfoot', 'th', 'thead', 'time', 'tr', 'track', 'tt', 'u', 'ul', 'var', 'video', 'wbr']); const svg$1 = freeze(['svg', 'a', 'altglyph', 'altglyphdef', 'altglyphitem', 'animatecolor', 'animatemotion', 'animatetransform', 'circle', 'clippath', 'defs', 'desc', 'ellipse', 'enterkeyhint', 'exportparts', 'filter', 'font', 'g', 'glyph', 'glyphref', 'hkern', 'image', 'inputmode', 'line', 'lineargradient', 'marker', 'mask', 'metadata', 'mpath', 'part', 'path', 'pattern', 'polygon', 'polyline', 'radialgradient', 'rect', 'stop', 'style', 'switch', 'symbol', 'text', 'textpath', 'title', 'tref', 'tspan', 'view', 'vkern']); const svgFilters = freeze(['feBlend', 'feColorMatrix', 'feComponentTransfer', 'feComposite', 'feConvolveMatrix', 'feDiffuseLighting', 'feDisplacementMap', 'feDistantLight', 'feDropShadow', 'feFlood', 'feFuncA', 'feFuncB', 'feFuncG', 'feFuncR', 'feGaussianBlur', 'feImage', 'feMerge', 'feMergeNode', 'feMorphology', 'feOffset', 'fePointLight', 'feSpecularLighting', 'feSpotLight', 'feTile', 'feTurbulence']); + // List of SVG elements that are disallowed by default. + // We still need to know them so that we can do namespace + // checks properly in case one wants to add them to + // allow-list. const svgDisallowed = freeze(['animate', 'color-profile', 'cursor', 'discard', 'font-face', 'font-face-format', 'font-face-name', 'font-face-src', 'font-face-uri', 'foreignobject', 'hatch', 'hatchpath', 'mesh', 'meshgradient', 'meshpatch', 'meshrow', 'missing-glyph', 'script', 'set', 'solidcolor', 'unknown', 'use']); const mathMl$1 = freeze(['math', 'menclose', 'merror', 'mfenced', 'mfrac', 'mglyph', 'mi', 'mlabeledtr', 'mmultiscripts', 'mn', 'mo', 'mover', 'mpadded', 'mphantom', 'mroot', 'mrow', 'ms', 'mspace', 'msqrt', 'mstyle', 'msub', 'msup', 'msubsup', 'mtable', 'mtd', 'mtext', 'mtr', 'munder', 'munderover', 'mprescripts']); + // Similarly to SVG, we want to know all MathML elements, + // even those that we disallow by default. const mathMlDisallowed = freeze(['maction', 'maligngroup', 'malignmark', 'mlongdiv', 'mscarries', 'mscarry', 'msgroup', 'mstack', 'msline', 'msrow', 'semantics', 'annotation', 'annotation-xml', 'mprescripts', 'none']); const text = freeze(['#text']); const html = freeze(['accept', 'action', 'align', 'alt', 'autocapitalize', 'autocomplete', 'autopictureinpicture', 'autoplay', 'background', 'bgcolor', 'border', 'capture', 'cellpadding', 'cellspacing', 'checked', 'cite', 'class', 'clear', 'color', 'cols', 'colspan', 'controls', 'controlslist', 'coords', 'crossorigin', 'datetime', 'decoding', 'default', 'dir', 'disabled', 'disablepictureinpicture', 'disableremoteplayback', 'download', 'draggable', 'enctype', 'enterkeyhint', 'exportparts', 'face', 'for', 'headers', 'height', 'hidden', 'high', 'href', 'hreflang', 'id', 'inert', 'inputmode', 'integrity', 'ismap', 'kind', 'label', 'lang', 'list', 'loading', 'loop', 'low', 'max', 'maxlength', 'media', 'method', 'min', 'minlength', 'multiple', 'muted', 'name', 'nonce', 'noshade', 'novalidate', 'nowrap', 'open', 'optimum', 'part', 'pattern', 'placeholder', 'playsinline', 'popover', 'popovertarget', 'popovertargetaction', 'poster', 'preload', 'pubdate', 'radiogroup', 'readonly', 'rel', 'required', 'rev', 'reversed', 'role', 'rows', 'rowspan', 'spellcheck', 'scope', 'selected', 'shape', 'size', 'sizes', 'slot', 'span', 'srclang', 'start', 'src', 'srcset', 'step', 'style', 'summary', 'tabindex', 'title', 'translate', 'type', 'usemap', 'valign', 'value', 'width', 'wrap', 'xmlns', 'slot']); const svg = freeze(['accent-height', 'accumulate', 'additive', 'alignment-baseline', 'amplitude', 'ascent', 'attributename', 'attributetype', 'azimuth', 'basefrequency', 'baseline-shift', 'begin', 'bias', 'by', 'class', 'clip', 'clippathunits', 'clip-path', 'clip-rule', 'color', 'color-interpolation', 'color-interpolation-filters', 'color-profile', 'color-rendering', 'cx', 'cy', 'd', 'dx', 'dy', 'diffuseconstant', 'direction', 'display', 'divisor', 'dur', 'edgemode', 'elevation', 'end', 'exponent', 'fill', 'fill-opacity', 'fill-rule', 'filter', 'filterunits', 'flood-color', 'flood-opacity', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style', 'font-variant', 'font-weight', 'fx', 'fy', 'g1', 'g2', 'glyph-name', 'glyphref', 'gradientunits', 'gradienttransform', 'height', 'href', 'id', 'image-rendering', 'in', 'in2', 'intercept', 'k', 'k1', 'k2', 'k3', 'k4', 'kerning', 'keypoints', 'keysplines', 'keytimes', 'lang', 'lengthadjust', 'letter-spacing', 'kernelmatrix', 'kernelunitlength', 'lighting-color', 'local', 'marker-end', 'marker-mid', 'marker-start', 'markerheight', 'markerunits', 'markerwidth', 'maskcontentunits', 'maskunits', 'max', 'mask', 'mask-type', 'media', 'method', 'mode', 'min', 'name', 'numoctaves', 'offset', 'operator', 'opacity', 'order', 'orient', 'orientation', 'origin', 'overflow', 'paint-order', 'path', 'pathlength', 'patterncontentunits', 'patterntransform', 'patternunits', 'points', 'preservealpha', 'preserveaspectratio', 'primitiveunits', 'r', 'rx', 'ry', 'radius', 'refx', 'refy', 'repeatcount', 'repeatdur', 'restart', 'result', 'rotate', 'scale', 'seed', 'shape-rendering', 'slope', 'specularconstant', 'specularexponent', 'spreadmethod', 'startoffset', 'stddeviation', 'stitchtiles', 'stop-color', 'stop-opacity', 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke', 'stroke-width', 'style', 'surfacescale', 'systemlanguage', 'tabindex', 'tablevalues', 'targetx', 'targety', 'transform', 'transform-origin', 'text-anchor', 'text-decoration', 'text-rendering', 'textlength', 'type', 'u1', 'u2', 'unicode', 'values', 'viewbox', 'visibility', 'version', 'vert-adv-y', 'vert-origin-x', 'vert-origin-y', 'width', 'word-spacing', 'wrap', 'writing-mode', 'xchannelselector', 'ychannelselector', 'x', 'x1', 'x2', 'xmlns', 'y', 'y1', 'y2', 'z', 'zoomandpan']); - const mathMl = freeze(['accent', 'accentunder', 'align', 'bevelled', 'close', 'columnsalign', 'columnlines', 'columnspan', 'denomalign', 'depth', 'dir', 'display', 'displaystyle', 'encoding', 'fence', 'frame', 'height', 'href', 'id', 'largeop', 'length', 'linethickness', 'lspace', 'lquote', 'mathbackground', 'mathcolor', 'mathsize', 'mathvariant', 'maxsize', 'minsize', 'movablelimits', 'notation', 'numalign', 'open', 'rowalign', 'rowlines', 'rowspacing', 'rowspan', 'rspace', 'rquote', 'scriptlevel', 'scriptminsize', 'scriptsizemultiplier', 'selection', 'separator', 'separators', 'stretchy', 'subscriptshift', 'supscriptshift', 'symmetric', 'voffset', 'width', 'xmlns']); + const mathMl = freeze(['accent', 'accentunder', 'align', 'bevelled', 'close', 'columnalign', 'columnlines', 'columnspacing', 'columnspan', 'denomalign', 'depth', 'dir', 'display', 'displaystyle', 'encoding', 'fence', 'frame', 'height', 'href', 'id', 'largeop', 'length', 'linethickness', 'lquote', 'lspace', 'mathbackground', 'mathcolor', 'mathsize', 'mathvariant', 'maxsize', 'minsize', 'movablelimits', 'notation', 'numalign', 'open', 'rowalign', 'rowlines', 'rowspacing', 'rowspan', 'rspace', 'rquote', 'scriptlevel', 'scriptminsize', 'scriptsizemultiplier', 'selection', 'separator', 'separators', 'stretchy', 'subscriptshift', 'supscriptshift', 'symmetric', 'voffset', 'width', 'xmlns']); const xml = freeze(['xlink:href', 'xml:id', 'xlink:title', 'xml:space', 'xmlns:xlink']); - const MUSTACHE_EXPR = seal(/\{\{[\w\W]*|[\w\W]*\}\}/gm); + // eslint-disable-next-line unicorn/better-regex + const MUSTACHE_EXPR = seal(/\{\{[\w\W]*|[\w\W]*\}\}/gm); // Specify template detection regex for SAFE_FOR_TEMPLATES mode const ERB_EXPR = seal(/<%[\w\W]*|[\w\W]*%>/gm); - const TMPLIT_EXPR = seal(/\$\{[\w\W]*/gm); - const DATA_ATTR = seal(/^data-[\-\w.\u00B7-\uFFFF]+$/); - const ARIA_ATTR = seal(/^aria-[\-\w]+$/); - const IS_ALLOWED_URI = seal(/^(?:(?:(?:f|ht)tps?|mailto|tel|callto|sms|cid|xmpp|matrix):|[^a-z]|[a-z+.\-]+(?:[^a-z+.\-:]|$))/i + const TMPLIT_EXPR = seal(/\$\{[\w\W]*/gm); // eslint-disable-line unicorn/better-regex + const DATA_ATTR = seal(/^data-[\-\w.\u00B7-\uFFFF]+$/); // eslint-disable-line no-useless-escape + const ARIA_ATTR = seal(/^aria-[\-\w]+$/); // eslint-disable-line no-useless-escape + const IS_ALLOWED_URI = seal(/^(?:(?:(?:f|ht)tps?|mailto|tel|callto|sms|cid|xmpp|matrix):|[^a-z]|[a-z+.\-]+(?:[^a-z+.\-:]|$))/i // eslint-disable-line no-useless-escape ); const IS_SCRIPT_OR_DATA = seal(/^(?:\w+script|data):/i); - const ATTR_WHITESPACE = seal(/[\u0000-\u0020\u00A0\u1680\u180E\u2000-\u2029\u205F\u3000]/g + const ATTR_WHITESPACE = seal(/[\u0000-\u0020\u00A0\u1680\u180E\u2000-\u2029\u205F\u3000]/g // eslint-disable-line no-control-regex ); const DOCTYPE_NAME = seal(/^html$/i); const CUSTOM_ELEMENT = seal(/^[a-z][.\w]*(-[.\w]+)+$/i); - var EXPRESSIONS = Object.freeze({ + var EXPRESSIONS = /*#__PURE__*/Object.freeze({ __proto__: null, ARIA_ATTR: ARIA_ATTR, ATTR_WHITESPACE: ATTR_WHITESPACE, @@ -187,27 +238,33 @@ TMPLIT_EXPR: TMPLIT_EXPR }); + /* eslint-disable @typescript-eslint/indent */ + // https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeType const NODE_TYPE = { element: 1, - attribute: 2, text: 3, - cdataSection: 4, - entityReference: 5, - entityNode: 6, + // Deprecated progressingInstruction: 7, comment: 8, - document: 9, - documentType: 10, - documentFragment: 11, - notation: 12 - }; + document: 9}; const getGlobal = function getGlobal() { return typeof window === 'undefined' ? null : window; }; + /** + * Creates a no-op policy for internal use only. + * Don't export this function outside this module! + * @param trustedTypes The policy factory. + * @param purifyHostElement The Script element used to load DOMPurify (to determine policy name suffix). + * @return The policy created (or null, if Trusted Types + * are not supported or creating the policy failed). + */ const _createTrustedTypesPolicy = function _createTrustedTypesPolicy(trustedTypes, purifyHostElement) { if (typeof trustedTypes !== 'object' || typeof trustedTypes.createPolicy !== 'function') { return null; } + // Allow the callers to control the unique policy name + // by adding a data-tt-policy-suffix to the script element with the DOMPurify. + // Policy creation with duplicate names throws in Trusted Types. let suffix = null; const ATTR_NAME = 'data-tt-policy-suffix'; if (purifyHostElement && purifyHostElement.hasAttribute(ATTR_NAME)) { @@ -224,8 +281,11 @@ } }); } catch (_) { - - return null; + // Policy creation failed (most likely another DOMPurify script has + // already run). Skip creating the policy, as this will only cause errors + // if TT are enforced. + console.warn('TrustedTypes policy ' + policyName + ' could not be created.'); + return null; } }; const _createHooksMap = function _createHooksMap() { @@ -244,9 +304,11 @@ function createDOMPurify() { let window = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getGlobal(); const DOMPurify = root => createDOMPurify(root); - DOMPurify.version = '3.3.1'; + DOMPurify.version = '3.4.0'; DOMPurify.removed = []; if (!window || !window.document || window.document.nodeType !== NODE_TYPE.document || !window.Element) { + // Not running in a browser, provide a factory function + // so that you can pass your own Window DOMPurify.isSupported = false; return DOMPurify; } @@ -272,6 +334,12 @@ const getNextSibling = lookupGetter(ElementPrototype, 'nextSibling'); const getChildNodes = lookupGetter(ElementPrototype, 'childNodes'); const getParentNode = lookupGetter(ElementPrototype, 'parentNode'); + // As per issue #47, the web-components registry is inherited by a + // new document created via createHTMLDocument. As per the spec + // (http://w3c.github.io/webcomponents/spec/custom/#creating-and-passing-registries) + // a new empty registry is used when creating a template contents owner + // document, so we use that as our parent document to ensure nothing + // is inherited. if (typeof HTMLTemplateElement === 'function') { const template = document.createElement('template'); if (template.content && template.content.ownerDocument) { @@ -290,6 +358,9 @@ importNode } = originalDocument; let hooks = _createHooksMap(); + /** + * Expose whether this browser supports running the full DOMPurify. + */ DOMPurify.isSupported = typeof entries === 'function' && typeof getParentNode === 'function' && implementation && implementation.createHTMLDocument !== undefined; const { MUSTACHE_EXPR, @@ -304,10 +375,22 @@ let { IS_ALLOWED_URI: IS_ALLOWED_URI$1 } = EXPRESSIONS; + /** + * We consider the elements and attributes below to be safe. Ideally + * don't add any new ones but feel free to remove unwanted ones. + */ + /* allowed element names */ let ALLOWED_TAGS = null; const DEFAULT_ALLOWED_TAGS = addToSet({}, [...html$1, ...svg$1, ...svgFilters, ...mathMl$1, ...text]); + /* Allowed attribute names */ let ALLOWED_ATTR = null; const DEFAULT_ALLOWED_ATTR = addToSet({}, [...html, ...svg, ...mathMl, ...xml]); + /* + * Configure how DOMPurify should handle custom elements and their attributes as well as customized built-in elements. + * @property {RegExp|Function|null} tagNameCheck one of [null, regexPattern, predicate]. Default: `null` (disallow any custom elements) + * @property {RegExp|Function|null} attributeNameCheck one of [null, regexPattern, predicate]. Default: `null` (disallow any attributes not on the allow list) + * @property {boolean} allowCustomizedBuiltInElements allow custom elements derived from built-ins if they pass CUSTOM_ELEMENT_HANDLING.tagNameCheck. Default: `false`. + */ let CUSTOM_ELEMENT_HANDLING = Object.seal(create(null, { tagNameCheck: { writable: true, @@ -328,8 +411,11 @@ value: false } })); + /* Explicitly forbidden tags (overrides ALLOWED_TAGS/ADD_TAGS) */ let FORBID_TAGS = null; + /* Explicitly forbidden attributes (overrides ALLOWED_ATTR/ADD_ATTR) */ let FORBID_ATTR = null; + /* Config object to store ADD_TAGS/ADD_ATTR functions (when used as functions) */ const EXTRA_ELEMENT_HANDLING = Object.seal(create(null, { tagCheck: { writable: true, @@ -344,61 +430,128 @@ value: null } })); + /* Decide if ARIA attributes are okay */ let ALLOW_ARIA_ATTR = true; + /* Decide if custom data attributes are okay */ let ALLOW_DATA_ATTR = true; + /* Decide if unknown protocols are okay */ let ALLOW_UNKNOWN_PROTOCOLS = false; + /* Decide if self-closing tags in attributes are allowed. + * Usually removed due to a mXSS issue in jQuery 3.0 */ let ALLOW_SELF_CLOSE_IN_ATTR = true; + /* Output should be safe for common template engines. + * This means, DOMPurify removes data attributes, mustaches and ERB + */ let SAFE_FOR_TEMPLATES = false; + /* Output should be safe even for XML used within HTML and alike. + * This means, DOMPurify removes comments when containing risky content. + */ let SAFE_FOR_XML = true; + /* Decide if document with ... should be returned */ let WHOLE_DOCUMENT = false; + /* Track whether config is already set on this instance of DOMPurify. */ let SET_CONFIG = false; + /* Decide if all elements (e.g. style, script) must be children of + * document.body. By default, browsers might move them to document.head */ let FORCE_BODY = false; + /* Decide if a DOM `HTMLBodyElement` should be returned, instead of a html + * string (or a TrustedHTML object if Trusted Types are supported). + * If `WHOLE_DOCUMENT` is enabled a `HTMLHtmlElement` will be returned instead + */ let RETURN_DOM = false; + /* Decide if a DOM `DocumentFragment` should be returned, instead of a html + * string (or a TrustedHTML object if Trusted Types are supported) */ let RETURN_DOM_FRAGMENT = false; + /* Try to return a Trusted Type object instead of a string, return a string in + * case Trusted Types are not supported */ let RETURN_TRUSTED_TYPE = false; + /* Output should be free from DOM clobbering attacks? + * This sanitizes markups named with colliding, clobberable built-in DOM APIs. + */ let SANITIZE_DOM = true; + /* Achieve full DOM Clobbering protection by isolating the namespace of named + * properties and JS variables, mitigating attacks that abuse the HTML/DOM spec rules. + * + * HTML/DOM spec rules that enable DOM Clobbering: + * - Named Access on Window (§7.3.3) + * - DOM Tree Accessors (§3.1.5) + * - Form Element Parent-Child Relations (§4.10.3) + * - Iframe srcdoc / Nested WindowProxies (§4.8.5) + * - HTMLCollection (§4.2.10.2) + * + * Namespace isolation is implemented by prefixing `id` and `name` attributes + * with a constant string, i.e., `user-content-` + */ let SANITIZE_NAMED_PROPS = false; const SANITIZE_NAMED_PROPS_PREFIX = 'user-content-'; + /* Keep element content when removing element? */ let KEEP_CONTENT = true; + /* If a `Node` is passed to sanitize(), then performs sanitization in-place instead + * of importing it into a new Document and returning a sanitized copy */ let IN_PLACE = false; + /* Allow usage of profiles like html, svg and mathMl */ let USE_PROFILES = {}; + /* Tags to ignore content of when KEEP_CONTENT is true */ let FORBID_CONTENTS = null; const DEFAULT_FORBID_CONTENTS = addToSet({}, ['annotation-xml', 'audio', 'colgroup', 'desc', 'foreignobject', 'head', 'iframe', 'math', 'mi', 'mn', 'mo', 'ms', 'mtext', 'noembed', 'noframes', 'noscript', 'plaintext', 'script', 'style', 'svg', 'template', 'thead', 'title', 'video', 'xmp']); + /* Tags that are safe for data: URIs */ let DATA_URI_TAGS = null; const DEFAULT_DATA_URI_TAGS = addToSet({}, ['audio', 'video', 'img', 'source', 'image', 'track']); + /* Attributes safe for values like "javascript:" */ let URI_SAFE_ATTRIBUTES = null; const DEFAULT_URI_SAFE_ATTRIBUTES = addToSet({}, ['alt', 'class', 'for', 'id', 'label', 'name', 'pattern', 'placeholder', 'role', 'summary', 'title', 'value', 'style', 'xmlns']); const MATHML_NAMESPACE = 'http://www.w3.org/1998/Math/MathML'; const SVG_NAMESPACE = 'http://www.w3.org/2000/svg'; const HTML_NAMESPACE = 'http://www.w3.org/1999/xhtml'; + /* Document namespace */ let NAMESPACE = HTML_NAMESPACE; let IS_EMPTY_INPUT = false; + /* Allowed XHTML+XML namespaces */ let ALLOWED_NAMESPACES = null; const DEFAULT_ALLOWED_NAMESPACES = addToSet({}, [MATHML_NAMESPACE, SVG_NAMESPACE, HTML_NAMESPACE], stringToString); let MATHML_TEXT_INTEGRATION_POINTS = addToSet({}, ['mi', 'mo', 'mn', 'ms', 'mtext']); let HTML_INTEGRATION_POINTS = addToSet({}, ['annotation-xml']); + // Certain elements are allowed in both SVG and HTML + // namespace. We need to specify them explicitly + // so that they don't get erroneously deleted from + // HTML namespace. const COMMON_SVG_AND_HTML_ELEMENTS = addToSet({}, ['title', 'style', 'font', 'a', 'script']); + /* Parsing of strict XHTML documents */ let PARSER_MEDIA_TYPE = null; const SUPPORTED_PARSER_MEDIA_TYPES = ['application/xhtml+xml', 'text/html']; const DEFAULT_PARSER_MEDIA_TYPE = 'text/html'; let transformCaseFunc = null; + /* Keep a reference to config to pass to hooks */ let CONFIG = null; + /* Ideally, do not touch anything below this line */ + /* ______________________________________________ */ const formElement = document.createElement('form'); const isRegexOrFunction = function isRegexOrFunction(testValue) { return testValue instanceof RegExp || testValue instanceof Function; }; + /** + * _parseConfig + * + * @param cfg optional config literal + */ + // eslint-disable-next-line complexity const _parseConfig = function _parseConfig() { let cfg = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {}; if (CONFIG && CONFIG === cfg) { return; } + /* Shield configuration object from tampering */ if (!cfg || typeof cfg !== 'object') { cfg = {}; } + /* Shield configuration object from prototype pollution */ cfg = clone(cfg); PARSER_MEDIA_TYPE = + // eslint-disable-next-line unicorn/prefer-includes SUPPORTED_PARSER_MEDIA_TYPES.indexOf(cfg.PARSER_MEDIA_TYPE) === -1 ? DEFAULT_PARSER_MEDIA_TYPE : cfg.PARSER_MEDIA_TYPE; + // HTML tags and attributes are not case-sensitive, converting to lowercase. Keeping XHTML as is. transformCaseFunc = PARSER_MEDIA_TYPE === 'application/xhtml+xml' ? stringToString : stringToLowerCase; + /* Set configuration parameters */ ALLOWED_TAGS = objectHasOwnProperty(cfg, 'ALLOWED_TAGS') ? addToSet({}, cfg.ALLOWED_TAGS, transformCaseFunc) : DEFAULT_ALLOWED_TAGS; ALLOWED_ATTR = objectHasOwnProperty(cfg, 'ALLOWED_ATTR') ? addToSet({}, cfg.ALLOWED_ATTR, transformCaseFunc) : DEFAULT_ALLOWED_ATTR; ALLOWED_NAMESPACES = objectHasOwnProperty(cfg, 'ALLOWED_NAMESPACES') ? addToSet({}, cfg.ALLOWED_NAMESPACES, stringToString) : DEFAULT_ALLOWED_NAMESPACES; @@ -408,26 +561,26 @@ FORBID_TAGS = objectHasOwnProperty(cfg, 'FORBID_TAGS') ? addToSet({}, cfg.FORBID_TAGS, transformCaseFunc) : clone({}); FORBID_ATTR = objectHasOwnProperty(cfg, 'FORBID_ATTR') ? addToSet({}, cfg.FORBID_ATTR, transformCaseFunc) : clone({}); USE_PROFILES = objectHasOwnProperty(cfg, 'USE_PROFILES') ? cfg.USE_PROFILES : false; - ALLOW_ARIA_ATTR = cfg.ALLOW_ARIA_ATTR !== false; - ALLOW_DATA_ATTR = cfg.ALLOW_DATA_ATTR !== false; - ALLOW_UNKNOWN_PROTOCOLS = cfg.ALLOW_UNKNOWN_PROTOCOLS || false; - ALLOW_SELF_CLOSE_IN_ATTR = cfg.ALLOW_SELF_CLOSE_IN_ATTR !== false; - SAFE_FOR_TEMPLATES = cfg.SAFE_FOR_TEMPLATES || false; - SAFE_FOR_XML = cfg.SAFE_FOR_XML !== false; - WHOLE_DOCUMENT = cfg.WHOLE_DOCUMENT || false; - RETURN_DOM = cfg.RETURN_DOM || false; - RETURN_DOM_FRAGMENT = cfg.RETURN_DOM_FRAGMENT || false; - RETURN_TRUSTED_TYPE = cfg.RETURN_TRUSTED_TYPE || false; - FORCE_BODY = cfg.FORCE_BODY || false; - SANITIZE_DOM = cfg.SANITIZE_DOM !== false; - SANITIZE_NAMED_PROPS = cfg.SANITIZE_NAMED_PROPS || false; - KEEP_CONTENT = cfg.KEEP_CONTENT !== false; - IN_PLACE = cfg.IN_PLACE || false; + ALLOW_ARIA_ATTR = cfg.ALLOW_ARIA_ATTR !== false; // Default true + ALLOW_DATA_ATTR = cfg.ALLOW_DATA_ATTR !== false; // Default true + ALLOW_UNKNOWN_PROTOCOLS = cfg.ALLOW_UNKNOWN_PROTOCOLS || false; // Default false + ALLOW_SELF_CLOSE_IN_ATTR = cfg.ALLOW_SELF_CLOSE_IN_ATTR !== false; // Default true + SAFE_FOR_TEMPLATES = cfg.SAFE_FOR_TEMPLATES || false; // Default false + SAFE_FOR_XML = cfg.SAFE_FOR_XML !== false; // Default true + WHOLE_DOCUMENT = cfg.WHOLE_DOCUMENT || false; // Default false + RETURN_DOM = cfg.RETURN_DOM || false; // Default false + RETURN_DOM_FRAGMENT = cfg.RETURN_DOM_FRAGMENT || false; // Default false + RETURN_TRUSTED_TYPE = cfg.RETURN_TRUSTED_TYPE || false; // Default false + FORCE_BODY = cfg.FORCE_BODY || false; // Default false + SANITIZE_DOM = cfg.SANITIZE_DOM !== false; // Default true + SANITIZE_NAMED_PROPS = cfg.SANITIZE_NAMED_PROPS || false; // Default false + KEEP_CONTENT = cfg.KEEP_CONTENT !== false; // Default true + IN_PLACE = cfg.IN_PLACE || false; // Default false IS_ALLOWED_URI$1 = cfg.ALLOWED_URI_REGEXP || IS_ALLOWED_URI; NAMESPACE = cfg.NAMESPACE || HTML_NAMESPACE; MATHML_TEXT_INTEGRATION_POINTS = cfg.MATHML_TEXT_INTEGRATION_POINTS || MATHML_TEXT_INTEGRATION_POINTS; HTML_INTEGRATION_POINTS = cfg.HTML_INTEGRATION_POINTS || HTML_INTEGRATION_POINTS; - CUSTOM_ELEMENT_HANDLING = cfg.CUSTOM_ELEMENT_HANDLING || {}; + CUSTOM_ELEMENT_HANDLING = cfg.CUSTOM_ELEMENT_HANDLING || create(null); if (cfg.CUSTOM_ELEMENT_HANDLING && isRegexOrFunction(cfg.CUSTOM_ELEMENT_HANDLING.tagNameCheck)) { CUSTOM_ELEMENT_HANDLING.tagNameCheck = cfg.CUSTOM_ELEMENT_HANDLING.tagNameCheck; } @@ -443,9 +596,10 @@ if (RETURN_DOM_FRAGMENT) { RETURN_DOM = true; } + /* Parse profile info */ if (USE_PROFILES) { ALLOWED_TAGS = addToSet({}, text); - ALLOWED_ATTR = []; + ALLOWED_ATTR = create(null); if (USE_PROFILES.html === true) { addToSet(ALLOWED_TAGS, html$1); addToSet(ALLOWED_ATTR, html); @@ -466,6 +620,11 @@ addToSet(ALLOWED_ATTR, xml); } } + /* Always reset function-based ADD_TAGS / ADD_ATTR checks to prevent + * leaking across calls when switching from function to array config */ + EXTRA_ELEMENT_HANDLING.tagCheck = null; + EXTRA_ELEMENT_HANDLING.attributeCheck = null; + /* Merge configuration parameters */ if (cfg.ADD_TAGS) { if (typeof cfg.ADD_TAGS === 'function') { EXTRA_ELEMENT_HANDLING.tagCheck = cfg.ADD_TAGS; @@ -501,12 +660,15 @@ } addToSet(FORBID_CONTENTS, cfg.ADD_FORBID_CONTENTS, transformCaseFunc); } + /* Add #text in case KEEP_CONTENT is set to true */ if (KEEP_CONTENT) { ALLOWED_TAGS['#text'] = true; } + /* Add html, head and body to ALLOWED_TAGS in case WHOLE_DOCUMENT is true */ if (WHOLE_DOCUMENT) { addToSet(ALLOWED_TAGS, ['html', 'head', 'body']); } + /* Add tbody to ALLOWED_TAGS in case tables are permitted, see #286, #365 */ if (ALLOWED_TAGS.table) { addToSet(ALLOWED_TAGS, ['tbody']); delete FORBID_TAGS.tbody; @@ -518,25 +680,42 @@ if (typeof cfg.TRUSTED_TYPES_POLICY.createScriptURL !== 'function') { throw typeErrorCreate('TRUSTED_TYPES_POLICY configuration option must provide a "createScriptURL" hook.'); } + // Overwrite existing TrustedTypes policy. trustedTypesPolicy = cfg.TRUSTED_TYPES_POLICY; + // Sign local variables required by `sanitize`. emptyHTML = trustedTypesPolicy.createHTML(''); } else { + // Uninitialized policy, attempt to initialize the internal dompurify policy. if (trustedTypesPolicy === undefined) { trustedTypesPolicy = _createTrustedTypesPolicy(trustedTypes, currentScript); } + // If creating the internal policy succeeded sign internal variables. if (trustedTypesPolicy !== null && typeof emptyHTML === 'string') { emptyHTML = trustedTypesPolicy.createHTML(''); } } + // Prevent further manipulation of configuration. + // Not available in IE8, Safari 5, etc. if (freeze) { freeze(cfg); } CONFIG = cfg; }; + /* Keep track of all possible SVG and MathML tags + * so that we can perform the namespace checks + * correctly. */ const ALL_SVG_TAGS = addToSet({}, [...svg$1, ...svgFilters, ...svgDisallowed]); const ALL_MATHML_TAGS = addToSet({}, [...mathMl$1, ...mathMlDisallowed]); + /** + * @param element a DOM element whose namespace is being checked + * @returns Return false if the element has a + * namespace that a spec-compliant parser would never + * return. Return true otherwise. + */ const _checkValidNamespace = function _checkValidNamespace(element) { let parent = getParentNode(element); + // In JSDOM, if we're inside shadow DOM, then parentNode + // can be null. We just simulate parent in this case. if (!parent || !parent.tagName) { parent = { namespaceURI: NAMESPACE, @@ -549,47 +728,84 @@ return false; } if (element.namespaceURI === SVG_NAMESPACE) { + // The only way to switch from HTML namespace to SVG + // is via . If it happens via any other tag, then + // it should be killed. if (parent.namespaceURI === HTML_NAMESPACE) { return tagName === 'svg'; } + // The only way to switch from MathML to SVG is via` + // svg if parent is either or MathML + // text integration points. if (parent.namespaceURI === MATHML_NAMESPACE) { return tagName === 'svg' && (parentTagName === 'annotation-xml' || MATHML_TEXT_INTEGRATION_POINTS[parentTagName]); } + // We only allow elements that are defined in SVG + // spec. All others are disallowed in SVG namespace. return Boolean(ALL_SVG_TAGS[tagName]); } if (element.namespaceURI === MATHML_NAMESPACE) { + // The only way to switch from HTML namespace to MathML + // is via . If it happens via any other tag, then + // it should be killed. if (parent.namespaceURI === HTML_NAMESPACE) { return tagName === 'math'; } + // The only way to switch from SVG to MathML is via + // and HTML integration points if (parent.namespaceURI === SVG_NAMESPACE) { return tagName === 'math' && HTML_INTEGRATION_POINTS[parentTagName]; } + // We only allow elements that are defined in MathML + // spec. All others are disallowed in MathML namespace. return Boolean(ALL_MATHML_TAGS[tagName]); } if (element.namespaceURI === HTML_NAMESPACE) { + // The only way to switch from SVG to HTML is via + // HTML integration points, and from MathML to HTML + // is via MathML text integration points if (parent.namespaceURI === SVG_NAMESPACE && !HTML_INTEGRATION_POINTS[parentTagName]) { return false; } if (parent.namespaceURI === MATHML_NAMESPACE && !MATHML_TEXT_INTEGRATION_POINTS[parentTagName]) { return false; } + // We disallow tags that are specific for MathML + // or SVG and should never appear in HTML namespace return !ALL_MATHML_TAGS[tagName] && (COMMON_SVG_AND_HTML_ELEMENTS[tagName] || !ALL_SVG_TAGS[tagName]); } + // For XHTML and XML documents that support custom namespaces if (PARSER_MEDIA_TYPE === 'application/xhtml+xml' && ALLOWED_NAMESPACES[element.namespaceURI]) { return true; } + // The code should never reach this place (this means + // that the element somehow got namespace that is not + // HTML, SVG, MathML or allowed via ALLOWED_NAMESPACES). + // Return false just in case. return false; }; + /** + * _forceRemove + * + * @param node a DOM node + */ const _forceRemove = function _forceRemove(node) { arrayPush(DOMPurify.removed, { element: node }); try { + // eslint-disable-next-line unicorn/prefer-dom-node-remove getParentNode(node).removeChild(node); } catch (_) { remove(node); } }; + /** + * _removeAttribute + * + * @param name an Attribute name + * @param element a DOM node + */ const _removeAttribute = function _removeAttribute(name, element) { try { arrayPush(DOMPurify.removed, { @@ -603,6 +819,7 @@ }); } element.removeAttribute(name); + // We void attribute values for unremovable "is" attributes if (name === 'is') { if (RETURN_DOM || RETURN_DOM_FRAGMENT) { try { @@ -615,47 +832,82 @@ } } }; + /** + * _initDocument + * + * @param dirty - a string of dirty markup + * @return a DOM, filled with the dirty markup + */ const _initDocument = function _initDocument(dirty) { + /* Create a HTML document */ let doc = null; let leadingWhitespace = null; if (FORCE_BODY) { dirty = '' + dirty; } else { + /* If FORCE_BODY isn't used, leading whitespace needs to be preserved manually */ const matches = stringMatch(dirty, /^[\r\n\t ]+/); leadingWhitespace = matches && matches[0]; } if (PARSER_MEDIA_TYPE === 'application/xhtml+xml' && NAMESPACE === HTML_NAMESPACE) { + // Root of XHTML doc must contain xmlns declaration (see https://www.w3.org/TR/xhtml1/normative.html#strict) dirty = '' + dirty + ''; } const dirtyPayload = trustedTypesPolicy ? trustedTypesPolicy.createHTML(dirty) : dirty; + /* + * Use the DOMParser API by default, fallback later if needs be + * DOMParser not work for svg when has multiple root element. + */ if (NAMESPACE === HTML_NAMESPACE) { try { doc = new DOMParser().parseFromString(dirtyPayload, PARSER_MEDIA_TYPE); } catch (_) {} } + /* Use createHTMLDocument in case DOMParser is not available */ if (!doc || !doc.documentElement) { doc = implementation.createDocument(NAMESPACE, 'template', null); try { doc.documentElement.innerHTML = IS_EMPTY_INPUT ? emptyHTML : dirtyPayload; } catch (_) { + // Syntax error if dirtyPayload is invalid xml } } const body = doc.body || doc.documentElement; if (dirty && leadingWhitespace) { body.insertBefore(document.createTextNode(leadingWhitespace), body.childNodes[0] || null); } + /* Work on whole document or just its body */ if (NAMESPACE === HTML_NAMESPACE) { return getElementsByTagName.call(doc, WHOLE_DOCUMENT ? 'html' : 'body')[0]; } return WHOLE_DOCUMENT ? doc.documentElement : body; }; + /** + * Creates a NodeIterator object that you can use to traverse filtered lists of nodes or elements in a document. + * + * @param root The root element or node to start traversing on. + * @return The created NodeIterator + */ const _createNodeIterator = function _createNodeIterator(root) { return createNodeIterator.call(root.ownerDocument || root, root, + // eslint-disable-next-line no-bitwise NodeFilter.SHOW_ELEMENT | NodeFilter.SHOW_COMMENT | NodeFilter.SHOW_TEXT | NodeFilter.SHOW_PROCESSING_INSTRUCTION | NodeFilter.SHOW_CDATA_SECTION, null); }; + /** + * _isClobbered + * + * @param element element to check for clobbering attacks + * @return true if clobbered, false if safe + */ const _isClobbered = function _isClobbered(element) { return element instanceof HTMLFormElement && (typeof element.nodeName !== 'string' || typeof element.textContent !== 'string' || typeof element.removeChild !== 'function' || !(element.attributes instanceof NamedNodeMap) || typeof element.removeAttribute !== 'function' || typeof element.setAttribute !== 'function' || typeof element.namespaceURI !== 'string' || typeof element.insertBefore !== 'function' || typeof element.hasChildNodes !== 'function'); }; + /** + * Checks whether the given object is a DOM node. + * + * @param value object to check whether it's a DOM node + * @return true is object is a DOM node + */ const _isNode = function _isNode(value) { return typeof Node === 'function' && value instanceof Node; }; @@ -664,31 +916,54 @@ hook.call(DOMPurify, currentNode, data, CONFIG); }); } + /** + * _sanitizeElements + * + * @protect nodeName + * @protect textContent + * @protect removeChild + * @param currentNode to check for permission to exist + * @return true if node was killed, false if left alive + */ const _sanitizeElements = function _sanitizeElements(currentNode) { let content = null; + /* Execute a hook if present */ _executeHooks(hooks.beforeSanitizeElements, currentNode, null); + /* Check if element is clobbered or can clobber */ if (_isClobbered(currentNode)) { _forceRemove(currentNode); return true; } + /* Now let's check the element's type and name */ const tagName = transformCaseFunc(currentNode.nodeName); + /* Execute a hook if present */ _executeHooks(hooks.uponSanitizeElement, currentNode, { tagName, allowedTags: ALLOWED_TAGS }); + /* Detect mXSS attempts abusing namespace confusion */ if (SAFE_FOR_XML && currentNode.hasChildNodes() && !_isNode(currentNode.firstElementChild) && regExpTest(/<[/\w!]/g, currentNode.innerHTML) && regExpTest(/<[/\w!]/g, currentNode.textContent)) { _forceRemove(currentNode); return true; } + /* Remove risky CSS construction leading to mXSS */ + if (SAFE_FOR_XML && currentNode.namespaceURI === HTML_NAMESPACE && tagName === 'style' && _isNode(currentNode.firstElementChild)) { + _forceRemove(currentNode); + return true; + } + /* Remove any occurrence of processing instructions */ if (currentNode.nodeType === NODE_TYPE.progressingInstruction) { _forceRemove(currentNode); return true; } + /* Remove any kind of possibly harmful comments */ if (SAFE_FOR_XML && currentNode.nodeType === NODE_TYPE.comment && regExpTest(/<[/\w]/g, currentNode.data)) { _forceRemove(currentNode); return true; } - if (!(EXTRA_ELEMENT_HANDLING.tagCheck instanceof Function && EXTRA_ELEMENT_HANDLING.tagCheck(tagName)) && (!ALLOWED_TAGS[tagName] || FORBID_TAGS[tagName])) { + /* Remove element if anything forbids its presence */ + if (FORBID_TAGS[tagName] || !(EXTRA_ELEMENT_HANDLING.tagCheck instanceof Function && EXTRA_ELEMENT_HANDLING.tagCheck(tagName)) && !ALLOWED_TAGS[tagName]) { + /* Check if we have a custom element to handle */ if (!FORBID_TAGS[tagName] && _isBasicCustomElement(tagName)) { if (CUSTOM_ELEMENT_HANDLING.tagNameCheck instanceof RegExp && regExpTest(CUSTOM_ELEMENT_HANDLING.tagNameCheck, tagName)) { return false; @@ -697,6 +972,7 @@ return false; } } + /* Keep content except for bad-listed elements */ if (KEEP_CONTENT && !FORBID_CONTENTS[tagName]) { const parentNode = getParentNode(currentNode) || currentNode.parentNode; const childNodes = getChildNodes(currentNode) || currentNode.childNodes; @@ -712,15 +988,19 @@ _forceRemove(currentNode); return true; } + /* Check whether element has a valid namespace */ if (currentNode instanceof Element && !_checkValidNamespace(currentNode)) { _forceRemove(currentNode); return true; } + /* Make sure that older browsers don't get fallback-tag mXSS */ if ((tagName === 'noscript' || tagName === 'noembed' || tagName === 'noframes') && regExpTest(/<\/no(script|embed|frames)/i, currentNode.innerHTML)) { _forceRemove(currentNode); return true; } + /* Sanitize element content to be template-safe */ if (SAFE_FOR_TEMPLATES && currentNode.nodeType === NODE_TYPE.text) { + /* Get the element's text content */ content = currentNode.textContent; arrayForEach([MUSTACHE_EXPR, ERB_EXPR, TMPLIT_EXPR], expr => { content = stringReplace(content, expr, ' '); @@ -732,32 +1012,77 @@ currentNode.textContent = content; } } + /* Execute a hook if present */ _executeHooks(hooks.afterSanitizeElements, currentNode, null); return false; }; + /** + * _isValidAttribute + * + * @param lcTag Lowercase tag name of containing element. + * @param lcName Lowercase attribute name. + * @param value Attribute value. + * @return Returns true if `value` is valid, otherwise false. + */ + // eslint-disable-next-line complexity const _isValidAttribute = function _isValidAttribute(lcTag, lcName, value) { + /* FORBID_ATTR must always win, even if ADD_ATTR predicate would allow it */ + if (FORBID_ATTR[lcName]) { + return false; + } + /* Make sure attribute cannot clobber */ if (SANITIZE_DOM && (lcName === 'id' || lcName === 'name') && (value in document || value in formElement)) { return false; } + /* Allow valid data-* attributes: At least one character after "-" + (https://html.spec.whatwg.org/multipage/dom.html#embedding-custom-non-visible-data-with-the-data-*-attributes) + XML-compatible (https://html.spec.whatwg.org/multipage/infrastructure.html#xml-compatible and http://www.w3.org/TR/xml/#d0e804) + We don't need to check the value; it's always URI safe. */ if (ALLOW_DATA_ATTR && !FORBID_ATTR[lcName] && regExpTest(DATA_ATTR, lcName)) ; else if (ALLOW_ARIA_ATTR && regExpTest(ARIA_ATTR, lcName)) ; else if (EXTRA_ELEMENT_HANDLING.attributeCheck instanceof Function && EXTRA_ELEMENT_HANDLING.attributeCheck(lcName, lcTag)) ; else if (!ALLOWED_ATTR[lcName] || FORBID_ATTR[lcName]) { if ( + // First condition does a very basic check if a) it's basically a valid custom element tagname AND + // b) if the tagName passes whatever the user has configured for CUSTOM_ELEMENT_HANDLING.tagNameCheck + // and c) if the attribute name passes whatever the user has configured for CUSTOM_ELEMENT_HANDLING.attributeNameCheck _isBasicCustomElement(lcTag) && (CUSTOM_ELEMENT_HANDLING.tagNameCheck instanceof RegExp && regExpTest(CUSTOM_ELEMENT_HANDLING.tagNameCheck, lcTag) || CUSTOM_ELEMENT_HANDLING.tagNameCheck instanceof Function && CUSTOM_ELEMENT_HANDLING.tagNameCheck(lcTag)) && (CUSTOM_ELEMENT_HANDLING.attributeNameCheck instanceof RegExp && regExpTest(CUSTOM_ELEMENT_HANDLING.attributeNameCheck, lcName) || CUSTOM_ELEMENT_HANDLING.attributeNameCheck instanceof Function && CUSTOM_ELEMENT_HANDLING.attributeNameCheck(lcName, lcTag)) || + // Alternative, second condition checks if it's an `is`-attribute, AND + // the value passes whatever the user has configured for CUSTOM_ELEMENT_HANDLING.tagNameCheck lcName === 'is' && CUSTOM_ELEMENT_HANDLING.allowCustomizedBuiltInElements && (CUSTOM_ELEMENT_HANDLING.tagNameCheck instanceof RegExp && regExpTest(CUSTOM_ELEMENT_HANDLING.tagNameCheck, value) || CUSTOM_ELEMENT_HANDLING.tagNameCheck instanceof Function && CUSTOM_ELEMENT_HANDLING.tagNameCheck(value))) ; else { return false; } + /* Check value is safe. First, is attr inert? If so, is safe */ } else if (URI_SAFE_ATTRIBUTES[lcName]) ; else if (regExpTest(IS_ALLOWED_URI$1, stringReplace(value, ATTR_WHITESPACE, ''))) ; else if ((lcName === 'src' || lcName === 'xlink:href' || lcName === 'href') && lcTag !== 'script' && stringIndexOf(value, 'data:') === 0 && DATA_URI_TAGS[lcTag]) ; else if (ALLOW_UNKNOWN_PROTOCOLS && !regExpTest(IS_SCRIPT_OR_DATA, stringReplace(value, ATTR_WHITESPACE, ''))) ; else if (value) { return false; } else ; return true; }; + /** + * _isBasicCustomElement + * checks if at least one dash is included in tagName, and it's not the first char + * for more sophisticated checking see https://github.com/sindresorhus/validate-element-name + * + * @param tagName name of the tag of the node to sanitize + * @returns Returns true if the tag name meets the basic criteria for a custom element, otherwise false. + */ const _isBasicCustomElement = function _isBasicCustomElement(tagName) { return tagName !== 'annotation-xml' && stringMatch(tagName, CUSTOM_ELEMENT); }; + /** + * _sanitizeAttributes + * + * @protect attributes + * @protect nodeName + * @protect removeAttribute + * @protect setAttribute + * + * @param currentNode to sanitize + */ const _sanitizeAttributes = function _sanitizeAttributes(currentNode) { + /* Execute a hook if present */ _executeHooks(hooks.beforeSanitizeAttributes, currentNode, null); const { attributes } = currentNode; + /* Check if we have attributes; if not we might have a text node */ if (!attributes || _isClobbered(currentNode)) { return; } @@ -769,6 +1094,7 @@ forceKeepAttr: undefined }; let l = attributes.length; + /* Go backwards over all attributes; safely remove bad ones */ while (l--) { const attr = attributes[l]; const { @@ -779,45 +1105,59 @@ const lcName = transformCaseFunc(name); const initValue = attrValue; let value = name === 'value' ? initValue : stringTrim(initValue); + /* Execute a hook if present */ hookEvent.attrName = lcName; hookEvent.attrValue = value; hookEvent.keepAttr = true; - hookEvent.forceKeepAttr = undefined; + hookEvent.forceKeepAttr = undefined; // Allows developers to see this is a property they can set _executeHooks(hooks.uponSanitizeAttribute, currentNode, hookEvent); value = hookEvent.attrValue; + /* Full DOM Clobbering protection via namespace isolation, + * Prefix id and name attributes with `user-content-` + */ if (SANITIZE_NAMED_PROPS && (lcName === 'id' || lcName === 'name')) { + // Remove the attribute with this value _removeAttribute(name, currentNode); + // Prefix the value and later re-create the attribute with the sanitized value value = SANITIZE_NAMED_PROPS_PREFIX + value; } - if (SAFE_FOR_XML && regExpTest(/((--!?|])>)|<\/(style|title|textarea)/i, value)) { + /* Work around a security issue with comments inside attributes */ + if (SAFE_FOR_XML && regExpTest(/((--!?|])>)|<\/(style|script|title|xmp|textarea|noscript|iframe|noembed|noframes)/i, value)) { _removeAttribute(name, currentNode); continue; } + /* Make sure we cannot easily use animated hrefs, even if animations are allowed */ if (lcName === 'attributename' && stringMatch(value, 'href')) { _removeAttribute(name, currentNode); continue; } + /* Did the hooks approve of the attribute? */ if (hookEvent.forceKeepAttr) { continue; } + /* Did the hooks approve of the attribute? */ if (!hookEvent.keepAttr) { _removeAttribute(name, currentNode); continue; } + /* Work around a security issue in jQuery 3.0 */ if (!ALLOW_SELF_CLOSE_IN_ATTR && regExpTest(/\/>/i, value)) { _removeAttribute(name, currentNode); continue; } + /* Sanitize attribute content to be template-safe */ if (SAFE_FOR_TEMPLATES) { arrayForEach([MUSTACHE_EXPR, ERB_EXPR, TMPLIT_EXPR], expr => { value = stringReplace(value, expr, ' '); }); } + /* Is `value` valid for this attribute? */ const lcTag = transformCaseFunc(currentNode.nodeName); if (!_isValidAttribute(lcTag, lcName, value)) { _removeAttribute(name, currentNode); continue; } + /* Handle attributes that require Trusted Types */ if (trustedTypesPolicy && typeof trustedTypes === 'object' && typeof trustedTypes.getAttributeType === 'function') { if (namespaceURI) ; else { switch (trustedTypes.getAttributeType(lcTag, lcName)) { @@ -834,11 +1174,13 @@ } } } + /* Handle invalid data-* attribute set by try-catching it */ if (value !== initValue) { try { if (namespaceURI) { currentNode.setAttributeNS(namespaceURI, name, value); } else { + /* Fallback to setAttribute() for browser-unrecognized namespaces e.g. "x-schema". */ currentNode.setAttribute(name, value); } if (_isClobbered(currentNode)) { @@ -851,32 +1193,49 @@ } } } + /* Execute a hook if present */ _executeHooks(hooks.afterSanitizeAttributes, currentNode, null); }; - const _sanitizeShadowDOM = function _sanitizeShadowDOM(fragment) { + /** + * _sanitizeShadowDOM + * + * @param fragment to iterate over recursively + */ + const _sanitizeShadowDOM2 = function _sanitizeShadowDOM(fragment) { let shadowNode = null; const shadowIterator = _createNodeIterator(fragment); + /* Execute a hook if present */ _executeHooks(hooks.beforeSanitizeShadowDOM, fragment, null); while (shadowNode = shadowIterator.nextNode()) { + /* Execute a hook if present */ _executeHooks(hooks.uponSanitizeShadowNode, shadowNode, null); + /* Sanitize tags and elements */ _sanitizeElements(shadowNode); + /* Check attributes next */ _sanitizeAttributes(shadowNode); + /* Deep shadow DOM detected */ if (shadowNode.content instanceof DocumentFragment) { - _sanitizeShadowDOM(shadowNode.content); + _sanitizeShadowDOM2(shadowNode.content); } } + /* Execute a hook if present */ _executeHooks(hooks.afterSanitizeShadowDOM, fragment, null); }; + // eslint-disable-next-line complexity DOMPurify.sanitize = function (dirty) { let cfg = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; let body = null; let importedNode = null; let currentNode = null; let returnNode = null; + /* Make sure we have a string to sanitize. + DO NOT return early, as this will return the wrong type if + the user has requested a DOM object rather than a string */ IS_EMPTY_INPUT = !dirty; if (IS_EMPTY_INPUT) { dirty = ''; } + /* Stringify, in case dirty is an object */ if (typeof dirty !== 'string' && !_isNode(dirty)) { if (typeof dirty.toString === 'function') { dirty = dirty.toString(); @@ -887,17 +1246,22 @@ throw typeErrorCreate('toString is not a function'); } } + /* Return dirty HTML if DOMPurify cannot run */ if (!DOMPurify.isSupported) { return dirty; } + /* Assign config vars */ if (!SET_CONFIG) { _parseConfig(cfg); } + /* Clean up removed elements */ DOMPurify.removed = []; + /* Check if dirty is correctly typed for IN_PLACE */ if (typeof dirty === 'string') { IN_PLACE = false; } if (IN_PLACE) { + /* Do some early pre-sanitization to avoid unsafe root nodes */ if (dirty.nodeName) { const tagName = transformCaseFunc(dirty.nodeName); if (!ALLOWED_TAGS[tagName] || FORBID_TAGS[tagName]) { @@ -905,57 +1269,91 @@ } } } else if (dirty instanceof Node) { + /* If dirty is a DOM element, append to an empty document to avoid + elements being stripped by the parser */ body = _initDocument(''); importedNode = body.ownerDocument.importNode(dirty, true); if (importedNode.nodeType === NODE_TYPE.element && importedNode.nodeName === 'BODY') { + /* Node is already a body, use as is */ body = importedNode; } else if (importedNode.nodeName === 'HTML') { body = importedNode; } else { + // eslint-disable-next-line unicorn/prefer-dom-node-append body.appendChild(importedNode); } } else { + /* Exit directly if we have nothing to do */ if (!RETURN_DOM && !SAFE_FOR_TEMPLATES && !WHOLE_DOCUMENT && + // eslint-disable-next-line unicorn/prefer-includes dirty.indexOf('<') === -1) { return trustedTypesPolicy && RETURN_TRUSTED_TYPE ? trustedTypesPolicy.createHTML(dirty) : dirty; } + /* Initialize the document to work on */ body = _initDocument(dirty); + /* Check we have a DOM node from the data */ if (!body) { return RETURN_DOM ? null : RETURN_TRUSTED_TYPE ? emptyHTML : ''; } } + /* Remove first element node (ours) if FORCE_BODY is set */ if (body && FORCE_BODY) { _forceRemove(body.firstChild); } + /* Get node iterator */ const nodeIterator = _createNodeIterator(IN_PLACE ? dirty : body); + /* Now start iterating over the created document */ while (currentNode = nodeIterator.nextNode()) { + /* Sanitize tags and elements */ _sanitizeElements(currentNode); + /* Check attributes next */ _sanitizeAttributes(currentNode); + /* Shadow DOM detected, sanitize it */ if (currentNode.content instanceof DocumentFragment) { - _sanitizeShadowDOM(currentNode.content); + _sanitizeShadowDOM2(currentNode.content); } } + /* If we sanitized `dirty` in-place, return it. */ if (IN_PLACE) { return dirty; } + /* Return sanitized string or DOM */ if (RETURN_DOM) { + if (SAFE_FOR_TEMPLATES) { + body.normalize(); + let html = body.innerHTML; + arrayForEach([MUSTACHE_EXPR, ERB_EXPR, TMPLIT_EXPR], expr => { + html = stringReplace(html, expr, ' '); + }); + body.innerHTML = html; + } if (RETURN_DOM_FRAGMENT) { returnNode = createDocumentFragment.call(body.ownerDocument); while (body.firstChild) { + // eslint-disable-next-line unicorn/prefer-dom-node-append returnNode.appendChild(body.firstChild); } } else { returnNode = body; } if (ALLOWED_ATTR.shadowroot || ALLOWED_ATTR.shadowrootmode) { + /* + AdoptNode() is not used because internal state is not reset + (e.g. the past names map of a HTMLFormElement), this is safe + in theory but we would rather not risk another attack vector. + The state that is cloned by importNode() is explicitly defined + by the specs. + */ returnNode = importNode.call(originalDocument, returnNode, true); } return returnNode; } let serializedHTML = WHOLE_DOCUMENT ? body.outerHTML : body.innerHTML; + /* Serialize doctype if allowed */ if (WHOLE_DOCUMENT && ALLOWED_TAGS['!doctype'] && body.ownerDocument && body.ownerDocument.doctype && body.ownerDocument.doctype.name && regExpTest(DOCTYPE_NAME, body.ownerDocument.doctype.name)) { serializedHTML = '\n' + serializedHTML; } + /* Sanitize final string template-safe */ if (SAFE_FOR_TEMPLATES) { arrayForEach([MUSTACHE_EXPR, ERB_EXPR, TMPLIT_EXPR], expr => { serializedHTML = stringReplace(serializedHTML, expr, ' '); @@ -973,6 +1371,7 @@ SET_CONFIG = false; }; DOMPurify.isValidAttribute = function (tag, attr, value) { + /* Initialize shared config vars if necessary. */ if (!CONFIG) { _parseConfig({}); } @@ -1003,13299 +1402,22371 @@ } var purify = createDOMPurify(); - return purify; - -})); + /*jslint node: true, browser: true, white: true, indent: 2, unparam: true, plusplus: true */ + + + // maintain an array of Able Player instances for use globally (e.g., for keeping prefs in sync) + // 5.0.0: this is now a Set to make it easier to create and destroy players + const ablePlayerInstances = new Set(); + + /** + * Performs one-time setup on `window`. + * + * Does nothing if `window` is not available, for example in SSR. + */ + function ablePlayerSetupWindow() { + if (typeof window === 'undefined') { + return; + } + $(function () { + if (typeof purify === 'undefined') { + console.warn('Required dependency DOMPurify not available. Please use the full Able Player bundle which has DOMPurify built in. Or, keep using this bundle, and include DOMPurify separately.'); + } + + $('video, audio').each(function (index, element) { + if ($(element).data('able-player') !== undefined) { + new AblePlayer($(this),$(element)); + } + }); + }); + + // YouTube player support; pass ready event to jQuery so we can catch in player. + window.onYouTubeIframeAPIReady = function() { + AblePlayer.youTubeIframeAPIReady = true; + $('body').trigger('youTubeIframeAPIReady', []); + }; + + // If there is only one player on the page, dispatch global keydown events to it + // Otherwise, keydowwn events are handled locally (see event.js > handleEventListeners()) + $(window).on('keydown',function(e) { + if (AblePlayer.hasSingleInstance()) { + const singleInstance = AblePlayer.getSingleInstance(); + singleInstance.onPlayerKeyPress(e); + } + }); + } + // Outdented for a simpler diff during module conversion + /** + * Construct the AblePlayer object. + * + * Able Player needs `window` to instantiate, so, skip the constructor if + * you are running outside the browser (for example, SSR). + * + * @param object media jQuery selector or element identifying the media. + */ + function AblePlayer(media) { + + if (typeof window === 'undefined') { + console.warn("`window` is undefined. Able Player needs `window` to instantiate. Skip constructing Able Player if you are running outside a browser (for example, SSR)."); + return; + } + + var thisObj = this; + + this.media = media; + + if ($(media).length === 0) { + this.provideFallback(); + return; + } + + // Default variables assignment + // The following variables CAN be overridden with HTML attributes + + // autoplay (Boolean; if present always resolves to true, regardless of value) + if ($(media).attr('autoplay') !== undefined) { + this.autoplay = true; // this value remains constant + this.okToPlay = true; // this value can change dynamically + } else { + this.autoplay = false; + this.okToPlay = false; + } + + // loop (Boolean; if present always resolves to true, regardless of value) + this.loop = ($(media).attr('loop') !== undefined) ? true : false; + + // playsinline (Boolean; if present always resolves to true, regardless of value) + this.playsInline = ($(media).attr('playsinline') !== undefined) ? '1' : '0'; + + // poster (Boolean, indicating whether media element has a poster attribute) + this.hasPoster = ( $(media).attr('poster') || $(media).data('poster') ) ? true : false; + + this.audioPoster = $(media).data('poster'); + this.audioPosterAlt = $(media).data('poster-alt' ); + + // get height and width attributes, if present + // and add them to variables + // Not currently used, but might be useful for resizing player + this.width = $(media).attr('width') ?? 0; + this.height = $(media).attr('height') ?? 0; + + // start-time + var startTime = $(media).data('start-time'); + var isNumeric = ( typeof startTime === 'number' || ( typeof startTime === 'string' && startTime.trim() !== '' && ! isNaN(startTime) && isFinite( Number(startTime) ) ) ) ? true : false; + this.startTime = ( startTime !== undefined && isNumeric ) ? startTime : 0; + + // debug + this.debug = ($(media).data('debug') !== undefined && $(media).data('debug') !== false) ? true : false; + + // Volume + // Range is 0 to 10. Best not to crank it to avoid overpowering screen readers + this.defaultVolume = 7; + if ($(media).data('volume') !== undefined && $(media).data('volume') !== "") { + var volume = $(media).data('volume'); + if (volume >= 0 && volume <= 10) { + this.defaultVolume = volume; + } + } + this.volume = this.defaultVolume; + + // Optional Buttons + // Buttons are added to the player controller if relevant media is present + // However, in some applications it might be undesirable to show buttons + // (e.g., if chapters or transcripts are provided in an external container) + + if ($(media).data('use-chapters-button') !== undefined && $(media).data('use-chapters-button') === false) { + this.useChaptersButton = false; + } else { + this.useChaptersButton = true; + } + + // Control whether text descriptions are read aloud + // set to "false" if the sole purpose of the WebVTT descriptions file + // is to integrate text description into the transcript + // set to "true" to write description text to a div + // This variable does *not* control the method by which description is read. + // For that, see below (this.descMethod) + if ($(media).data('descriptions-audible') !== undefined && $(media).data('descriptions-audible') === false) { + this.readDescriptionsAloud = false; + } else if ($(media).data('description-audible') !== undefined && $(media).data('description-audible') === false) { + // support both singular and plural spelling of attribute + this.readDescriptionsAloud = false; + } else { + this.readDescriptionsAloud = true; + } + + // setting initial this.descVoices to an empty array + // to be populated later by getBrowserVoices + this.descVoices = []; + + // Method by which text descriptions are read + // valid values of data-desc-reader are: + // 'brower' (default) - text-based audio description is handled by the browser, if supported + // 'screenreader' - text-based audio description is always handled by screen readers + // The latter may be preferable by owners of websites in languages that are not well supported + // by the Web Speech API + this.descReader = ($(media).data('desc-reader') == 'screenreader') ? 'screenreader' : 'browser'; + + // Default state of captions and descriptions + // This setting is overridden by user preferences, if they exist + // values for data-state-captions and data-state-descriptions are 'on' or 'off' + this.defaultStateCaptions = ($(media).data('state-captions') == 'off') ? 0 : 1; + this.defaultStateDescriptions = ($(media).data('state-descriptions') == 'on') ? 1 : 0; + + // Default setting for prefDescPause + // Extended description (i.e., pausing during description) is on by default + // but this settings give website owners control over that + // since they know the nature of their videos, and whether pausing is necessary + // This setting is overridden by user preferences, if they exist + this.defaultDescPause = ($(media).data('desc-pause-default') == 'off') ? 0 : 1; + + // Headings + // By default, an off-screen heading is automatically added to the top of the media player + // It is intelligently assigned a heading level based on context, via misc.js > getNextHeadingLevel() + // Authors can override this behavior by manually assigning a heading level using data-heading-level + // Accepted values are 1-6, or 0 which indicates "no heading" + // (i.e., author has already hard-coded a heading before the media player; Able Player doesn't need to do this) + if ($(media).data('heading-level') !== undefined && $(media).data('heading-level') !== "") { + var headingLevel = $(media).data('heading-level'); + if (/^[0-6]*$/.test(headingLevel)) { // must be a valid HTML heading level 1-6; or 0 + this.playerHeadingLevel = headingLevel; + } + } + + // Transcripts + // There are three types of interactive transcripts. + // In descending of order of precedence (in case there are conflicting tags), they are: + // 1. "manual" - A manually coded external transcript (requires data-transcript-src) + // 2. "external" - Automatically generated, written to an external div (requires data-transcript-div & a valid target element) + // 3. "popup" - Automatically generated, written to a draggable, resizable popup window that can be toggled on/off with a button + // If data-include-transcript="false", there is no "popup" transcript + var transcriptDivLocation = $(media).data('transcript-div'); + if ( transcriptDivLocation !== undefined && transcriptDivLocation !== "" && null !== document.getElementById( transcriptDivLocation ) ) { + this.transcriptDivLocation = transcriptDivLocation; + } else { + this.transcriptDivLocation = null; + } + var includeTranscript = $(media).data('include-transcript'); + this.hideTranscriptButton = ( includeTranscript !== undefined && includeTranscript === false) ? true : false; + + this.transcriptType = null; + if ($(media).data('transcript-src') !== undefined) { + this.transcriptSrc = $(media).data('transcript-src'); + if (this.transcriptSrcHasRequiredParts()) { + this.transcriptType = 'manual'; + } + } else if ($(media).find('track[kind="captions"],track[kind="subtitles"],track:not([kind])').length > 0) { + // required tracks are present. COULD automatically generate a transcript + this.transcriptType = (this.transcriptDivLocation) ? 'external' : 'popup'; + } + + // In "Lyrics Mode", line breaks in WebVTT caption files are supported in the transcript + // If false (default), line breaks are are removed from transcripts for a more seamless reading experience + // If true, line breaks are preserved, so content can be presented karaoke-style, or as lines in a poem + this.lyricsMode = ($(media).data('lyrics-mode') !== undefined && $(media).data('lyrics-mode') !== false) ? true : false; + + // Set Transcript Title if defined explicitly. See transcript.js. + if ($(media).data('transcript-title') !== undefined && $(media).data('transcript-title') !== "") { + this.transcriptTitle = $(media).data('transcript-title'); + } + + // Sign Language + // sign language can be a modal (default) or assigned to a div on the page. + var signDivLocation = $(media).data('sign-div'); + if ( signDivLocation !== undefined && signDivLocation !== "" && null !== document.getElementById( signDivLocation ) ) { + this.$signDivLocation = $( '#' + signDivLocation ); + } else { + this.$signDivLocation = null; + } + + // Captions + // data-captions-position can be used to set the default captions position + // this is only the default, and can be overridden by user preferences + // valid values of data-captions-position are 'below' and 'overlay' + this.defaultCaptionsPosition = ($(media).data('captions-position') === 'overlay') ? 'overlay' : 'below'; + + // Chapters + var chaptersDiv = $(media).data('chapters-div'); + if ( chaptersDiv !== undefined && chaptersDiv !== "") { + this.chaptersDivLocation = chaptersDiv; + } + + if ($(media).data('chapters-title') !== undefined) { + // NOTE: empty string is valid; results in no title being displayed + this.chaptersTitle = $(media).data('chapters-title'); + } + + var defaultChapter = $(media).data('chapters-default'); + this.defaultChapter = ( defaultChapter !== undefined && defaultChapter !== "") ? defaultChapter : null; + + // Slower/Faster buttons + // valid values of data-speed-icons are 'animals' (default) and 'arrows' + // 'animals' uses turtle and rabbit; 'arrows' uses up/down arrows + this.speedIcons = ($(media).data('speed-icons') === 'arrows') ? 'arrows' : 'animals'; + + // Seekbar + // valid values of data-seekbar-scope are 'chapter' and 'video'; will also accept 'chapters' + var seekbarScope = $(media).data('seekbar-scope'); + this.seekbarScope = ( seekbarScope === 'chapter' || seekbarScope === 'chapters') ? 'chapter' : 'video'; + + // YouTube + var youTubeId = $(media).data('youtube-id'); + if ( youTubeId !== undefined && youTubeId !== "") { + this.youTubeId = this.getYouTubeId(youTubeId); + if ( ! this.hasPoster ) { + let poster = this.getYouTubePosterUrl(this.youTubeId,'640'); + $(media).attr( 'poster', poster ); + } + } + + var youTubeDescId = $(media).data('youtube-desc-id'); + if ( youTubeDescId !== undefined && youTubeDescId !== "") { + this.youTubeDescId = this.getYouTubeId(youTubeDescId); + } + + var youTubeSignId = $(media).data('youtube-sign-src'); + if ( youTubeSignId !== undefined && youTubeSignId !== "") { + this.youTubeSignId = this.getYouTubeId(youTubeSignId); + } + + var youTubeNoCookie = $(media).data('youtube-nocookie'); + this.youTubeNoCookie = (youTubeNoCookie !== undefined && youTubeNoCookie) ? true : false; + + // Vimeo + var vimeoId = $(media).data('vimeo-id'); + if ( vimeoId !== undefined && vimeoId !== "") { + this.vimeoId = this.getVimeoId(vimeoId); + if ( ! this.hasPoster ) { + let poster = thisObj.getVimeoPosterUrl(this.vimeoId,'1200'); + $(media).attr( 'poster', poster ); + } + } + var vimeoDescId = $(media).data('vimeo-desc-id'); + if ( vimeoDescId !== undefined && vimeoDescId !== "") { + this.vimeoDescId = this.getVimeoId(vimeoDescId); + } + + // Skin + // valid values of data-skin are: + // '2020' (default as of 4.6), all buttons in one row beneath a full-width seekbar + // 'legacy', two rows of controls; seekbar positioned in available space within top row + this.skin = ($(media).data('skin') == 'legacy') ? 'legacy' : '2020'; + + // Size + // width of Able Player is determined using the following order of precedence: + // 1. data-width attribute + // 2. width attribute (for video or audio, although it is not valid HTML for audio) + // 3. Intrinsic size from video (video only, determined later) + if ($(media).data('width') !== undefined) { + this.playerWidth = parseInt($(media).data('width')); + } else if ($(media)[0].getAttribute('width')) { + // NOTE: jQuery attr() returns null for all invalid HTML attributes + // (e.g., width on