/**
* @license
* Copyright The Closure Library Authors.
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview
* XML utilities.
*/
goog.provide('goog.dom.xml');
goog.require('goog.dom');
goog.require('goog.dom.NodeType');
goog.require('goog.dom.safe');
goog.require('goog.html.legacyconversions');
goog.require('goog.userAgent');
/**
* Max XML size for MSXML2. Used to prevent potential DoS attacks.
* @type {number}
*/
goog.dom.xml.MAX_XML_SIZE_KB = 2 * 1024; // In kB
/**
* Max XML size for MSXML2. Used to prevent potential DoS attacks.
* @type {number}
*/
goog.dom.xml.MAX_ELEMENT_DEPTH = 256; // Same default as MSXML6.
/**
* Check for ActiveXObject support by the browser.
* @return {boolean} true if browser has ActiveXObject support.
* @private
*/
goog.dom.xml.hasActiveXObjectSupport_ = function() {
'use strict';
if (!goog.userAgent.IE) {
// Avoid raising useless exception in case code is not compiled
// and browser is not MSIE.
return false;
}
try {
// Due to lot of changes in IE 9, 10 & 11 behaviour and ActiveX being
// totally disableable using MSIE's security level, trying to create the
// ActiveXOjbect is a lot more reliable than testing for the existence of
// window.ActiveXObject
new ActiveXObject('MSXML2.DOMDocument');
return true;
} catch (e) {
return false;
}
};
/**
* True if browser has ActiveXObject support.
* Possible override if this test become wrong in coming IE versions.
* @type {boolean}
*/
goog.dom.xml.ACTIVEX_SUPPORT =
goog.userAgent.IE && goog.dom.xml.hasActiveXObjectSupport_();
/**
* Creates an XML document appropriate for the current JS runtime
* @param {string=} opt_rootTagName The root tag name.
* @param {string=} opt_namespaceUri Namespace URI of the document element.
* @param {boolean=} opt_preferActiveX Whether to default to ActiveXObject to
* create Document in IE. Use this if you need xpath support in IE (e.g.,
* selectSingleNode or selectNodes), but be aware that the ActiveXObject does
* not support various DOM-specific Document methods and attributes.
* @return {Document} The new document.
* @throws {Error} if browser does not support creating new documents or
* namespace is provided without a root tag name.
*/
goog.dom.xml.createDocument = function(
opt_rootTagName, opt_namespaceUri, opt_preferActiveX) {
'use strict';
if (opt_namespaceUri && !opt_rootTagName) {
throw new Error('Can\'t create document with namespace and no root tag');
}
// If document.implementation.createDocument is available and they haven't
// explicitly opted to use ActiveXObject when possible.
if (document.implementation && document.implementation.createDocument &&
!(goog.dom.xml.ACTIVEX_SUPPORT && opt_preferActiveX)) {
return document.implementation.createDocument(
opt_namespaceUri || '', opt_rootTagName || '', null);
} else if (goog.dom.xml.ACTIVEX_SUPPORT) {
var doc = goog.dom.xml.createMsXmlDocument_();
if (doc) {
if (opt_rootTagName) {
doc.appendChild(
/** @type {!Node} */ (doc.createNode(
goog.dom.NodeType.ELEMENT, opt_rootTagName,
opt_namespaceUri || '')));
}
return doc;
}
}
throw new Error('Your browser does not support creating new documents');
};
/**
* Creates an XML document from a string
* @param {string} xml The text.
* @param {boolean=} opt_preferActiveX Whether to default to ActiveXObject to
* create Document in IE. Use this if you need xpath support in IE (e.g.,
* selectSingleNode or selectNodes), but be aware that the ActiveXObject does
* not support various DOM-specific Document methods and attributes.
* @return {Document} XML document from the text.
* @throws {Error} if browser does not support loading XML documents.
*/
goog.dom.xml.loadXml = function(xml, opt_preferActiveX) {
'use strict';
if (typeof DOMParser != 'undefined' &&
!(goog.dom.xml.ACTIVEX_SUPPORT && opt_preferActiveX)) {
return goog.dom.safe.parseFromString(
new DOMParser(), goog.html.legacyconversions.safeHtmlFromString(xml),
'application/xml');
} else if (goog.dom.xml.ACTIVEX_SUPPORT) {
var doc = goog.dom.xml.createMsXmlDocument_();
doc.loadXML(xml);
return doc;
}
throw new Error('Your browser does not support loading xml documents');
};
/**
* Serializes an XML document or subtree to string.
* @param {Document|Element} xml The document or the root node of the subtree.
* @return {string} The serialized XML.
* @throws {Error} if browser does not support XML serialization.
*/
goog.dom.xml.serialize = function(xml) {
'use strict';
// Compatible with IE/ActiveXObject.
var text = xml.xml;
if (text) {
return text;
}
// Compatible with Firefox, Opera and WebKit.
if (typeof XMLSerializer != 'undefined') {
return new XMLSerializer().serializeToString(xml);
}
throw new Error('Your browser does not support serializing XML documents');
};
/**
* Selects a single node using an Xpath expression and a root node
* @param {Node} node The root node.
* @param {string} path Xpath selector.
* @return {Node} The selected node, or null if no matching node.
*/
goog.dom.xml.selectSingleNode = function(node, path) {
'use strict';
if (typeof node.selectSingleNode != 'undefined') {
var doc = goog.dom.getOwnerDocument(node);
if (typeof doc.setProperty != 'undefined') {
doc.setProperty('SelectionLanguage', 'XPath');
}
return node.selectSingleNode(path);
} else if (document.implementation.hasFeature('XPath', '3.0')) {
var doc = goog.dom.getOwnerDocument(node);
var resolver = doc.createNSResolver(doc.documentElement);
var result = doc.evaluate(
path, node, resolver, XPathResult.FIRST_ORDERED_NODE_TYPE, null);
return result.singleNodeValue;
}
// This browser does not support xpath for the given node. If IE, ensure XML
// Document was created using ActiveXObject
// TODO(joeltine): This should throw instead of return null.
return null;
};
/**
* Selects multiple nodes using an Xpath expression and a root node
* @param {Node} node The root node.
* @param {string} path Xpath selector.
* @return {(!NodeList<!Node>|!Array<!Node>)} The selected nodes, or empty array
* if no matching nodes.
*/
goog.dom.xml.selectNodes = function(node, path) {
'use strict';
if (typeof node.selectNodes != 'undefined') {
var doc = goog.dom.getOwnerDocument(node);
if (typeof doc.setProperty != 'undefined') {
doc.setProperty('SelectionLanguage', 'XPath');
}
return node.selectNodes(path);
} else if (document.implementation.hasFeature('XPath', '3.0')) {
var doc = goog.dom.getOwnerDocument(node);
var resolver = doc.createNSResolver(doc.documentElement);
var nodes = doc.evaluate(
path, node, resolver, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
var results = [];
var count = nodes.snapshotLength;
for (var i = 0; i < count; i++) {
results.push(nodes.snapshotItem(i));
}
return results;
} else {
// This browser does not support xpath for the given node. If IE, ensure XML
// Document was created using ActiveXObject.
// TODO(joeltine): This should throw instead of return empty array.
return [];
}
};
/**
* Sets multiple attributes on an element. Differs from goog.dom.setProperties
* in that it exclusively uses the element's setAttributes method. Use this
* when you need to ensure that the exact property is available as an attribute
* and can be read later by the native getAttribute method.
* @param {!Element} element XML or DOM element to set attributes on.
* @param {!Object<string, string>} attributes Map of property:value pairs.
*/
goog.dom.xml.setAttributes = function(element, attributes) {
'use strict';
for (var key in attributes) {
if (attributes.hasOwnProperty(key)) {
element.setAttribute(key, attributes[key]);
}
}
};
/**
* Creates an instance of the MSXML2.DOMDocument.
* @return {!XMLDOMDocument} The new document.
* @private
*/
goog.dom.xml.createMsXmlDocument_ = function() {
'use strict';
var doc = new ActiveXObject('MSXML2.DOMDocument');
if (doc) {
// Prevent potential vulnerabilities exposed by MSXML2, see
// http://b/1707300 and http://go/xxe-attacks for details.
doc.resolveExternals = false;
doc.validateOnParse = false;
// Add a try catch block because accessing these properties will throw an
// error on unsupported MSXML versions. This affects Windows machines
// running IE6 or IE7 that are on XP SP2 or earlier without MSXML updates.
// See http://msdn.microsoft.com/en-us/library/ms766391(VS.85).aspx for
// specific details on which MSXML versions support these properties.
try {
doc.setProperty('ProhibitDTD', true);
doc.setProperty('MaxXMLSize', goog.dom.xml.MAX_XML_SIZE_KB);
doc.setProperty('MaxElementDepth', goog.dom.xml.MAX_ELEMENT_DEPTH);
} catch (e) {
// No-op.
}
}
return doc;
};
Codebase Browser
chromium