com.gargoylesoftware.htmlunit.javascript.host.dom.Document Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of htmlunit Show documentation
Show all versions of htmlunit Show documentation
A headless browser intended for use in testing web-based applications.
/*
* Copyright (c) 2002-2017 Gargoyle Software Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.gargoylesoftware.htmlunit.javascript.host.dom;
import static com.gargoylesoftware.htmlunit.BrowserVersionFeatures.JS_DOCUMENT_CREATE_ELEMENT_STRICT;
import static com.gargoylesoftware.htmlunit.BrowserVersionFeatures.JS_DOCUMENT_DESIGN_MODE_INHERIT;
import static com.gargoylesoftware.htmlunit.BrowserVersionFeatures.JS_DOCUMENT_SELECTION_RANGE_COUNT;
import static com.gargoylesoftware.htmlunit.BrowserVersionFeatures.JS_DOCUMENT_SET_LOCATION_EXECUTED_IN_ANCHOR;
import static com.gargoylesoftware.htmlunit.javascript.configuration.BrowserName.CHROME;
import static com.gargoylesoftware.htmlunit.javascript.configuration.BrowserName.EDGE;
import static com.gargoylesoftware.htmlunit.javascript.configuration.BrowserName.FF;
import java.io.IOException;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.xml.utils.PrefixResolver;
import com.gargoylesoftware.htmlunit.BrowserVersion;
import com.gargoylesoftware.htmlunit.ElementNotFoundException;
import com.gargoylesoftware.htmlunit.SgmlPage;
import com.gargoylesoftware.htmlunit.html.BaseFrameElement;
import com.gargoylesoftware.htmlunit.html.DomComment;
import com.gargoylesoftware.htmlunit.html.DomDocumentFragment;
import com.gargoylesoftware.htmlunit.html.DomElement;
import com.gargoylesoftware.htmlunit.html.DomNode;
import com.gargoylesoftware.htmlunit.html.DomText;
import com.gargoylesoftware.htmlunit.html.HTMLParser;
import com.gargoylesoftware.htmlunit.html.HtmlImage;
import com.gargoylesoftware.htmlunit.html.HtmlInput;
import com.gargoylesoftware.htmlunit.html.HtmlKeygen;
import com.gargoylesoftware.htmlunit.html.HtmlPage;
import com.gargoylesoftware.htmlunit.html.HtmlRp;
import com.gargoylesoftware.htmlunit.html.HtmlRt;
import com.gargoylesoftware.htmlunit.html.HtmlScript;
import com.gargoylesoftware.htmlunit.html.HtmlUnknownElement;
import com.gargoylesoftware.htmlunit.html.impl.SimpleRange;
import com.gargoylesoftware.htmlunit.javascript.SimpleScriptable;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxClass;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxConstructor;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxFunction;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxGetter;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxSetter;
import com.gargoylesoftware.htmlunit.javascript.configuration.WebBrowser;
import com.gargoylesoftware.htmlunit.javascript.host.Element;
import com.gargoylesoftware.htmlunit.javascript.host.Location;
import com.gargoylesoftware.htmlunit.javascript.host.NativeFunctionPrefixResolver;
import com.gargoylesoftware.htmlunit.javascript.host.Window;
import com.gargoylesoftware.htmlunit.javascript.host.event.UIEvent;
import com.gargoylesoftware.htmlunit.javascript.host.html.HTMLAnchorElement;
import com.gargoylesoftware.htmlunit.javascript.host.html.HTMLCollection;
import net.sourceforge.htmlunit.corejs.javascript.Context;
import net.sourceforge.htmlunit.corejs.javascript.NativeFunction;
/**
* A JavaScript object for {@code Document}.
*
* @author Mike Bowler
* @author David K. Taylor
* @author Chen Jun
* @author Christian Sell
* @author Chris Erskine
* @author Marc Guillemot
* @author Daniel Gredler
* @author Michael Ottati
* @author George Murnock
* @author Ahmed Ashour
* @author Rob Di Marco
* @author Ronald Brill
* @author Chuck Dumont
* @author Frank Danek
* @author Madis Pärn
* @see MSDN documentation
* @see W3C Dom Level 1
*/
@JsxClass
public class Document extends EventNode {
private static final Log LOG = LogFactory.getLog(Document.class);
private static final Pattern TAG_NAME_PATTERN = Pattern.compile("\\w+");
private Window window_;
private DOMImplementation implementation_;
private String designMode_;
/**
* Creates an instance.
*/
@JsxConstructor({@WebBrowser(CHROME), @WebBrowser(FF), @WebBrowser(EDGE)})
public Document() {
}
/**
* Sets the Window JavaScript object that encloses this document.
* @param window the Window JavaScript object that encloses this document
*/
public void setWindow(final Window window) {
window_ = window;
}
/**
* Returns the value of the {@code location} property.
* @return the value of the {@code location} property
*/
@JsxGetter
public Location getLocation() {
return window_.getLocation();
}
/**
* Sets the value of the {@code location} property. The location's default property is "href",
* so setting "document.location='http://www.sf.net'" is equivalent to setting
* "document.location.href='http://www.sf.net'".
* @see MSDN documentation
* @param location the location to navigate to
* @throws IOException when location loading fails
*/
@JsxSetter
public void setLocation(final String location) throws IOException {
final Object event = getWindow().getEvent();
boolean setLocation = true;
if (event instanceof UIEvent) {
final Object target = ((UIEvent) event).getTarget();
if (target instanceof HTMLAnchorElement) {
final String href = ((HTMLAnchorElement) target).getHref();
if (!href.isEmpty()
&& !getBrowserVersion().hasFeature(JS_DOCUMENT_SET_LOCATION_EXECUTED_IN_ANCHOR)) {
setLocation = false;
}
}
}
if (setLocation) {
window_.setLocation(location);
}
}
/**
* Returns the value of the {@code referrer} property.
* @return the value of the {@code referrer} property
*/
@JsxGetter
public String getReferrer() {
final String referrer = getPage().getWebResponse().getWebRequest().getAdditionalHeaders().get("Referer");
if (referrer == null) {
return "";
}
return referrer;
}
/**
* Gets the JavaScript property {@code documentElement} for the document.
* @return the root node for the document
*/
@JsxGetter
public Element getDocumentElement() {
final Object documentElement = getPage().getDocumentElement();
if (documentElement == null) {
// for instance with an XML document with parsing error
return null;
}
return (Element) getScriptableFor(documentElement);
}
/**
* Gets the JavaScript property {@code doctype} for the document.
* @return the DocumentType of the document
*/
@JsxGetter
public SimpleScriptable getDoctype() {
final Object documentType = getPage().getDoctype();
if (documentType == null) {
return null;
}
return getScriptableFor(documentType);
}
/**
* Returns a value which indicates whether or not the document can be edited.
* @return a value which indicates whether or not the document can be edited
*/
@JsxGetter
public String getDesignMode() {
if (designMode_ == null) {
if (getBrowserVersion().hasFeature(JS_DOCUMENT_DESIGN_MODE_INHERIT)) {
designMode_ = "inherit";
}
else {
designMode_ = "off";
}
}
return designMode_;
}
/**
* Sets a value which indicates whether or not the document can be edited.
* @param mode a value which indicates whether or not the document can be edited
*/
@JsxSetter
public void setDesignMode(final String mode) {
final BrowserVersion browserVersion = getBrowserVersion();
final boolean inherit = browserVersion.hasFeature(JS_DOCUMENT_DESIGN_MODE_INHERIT);
if (inherit) {
if (!"on".equalsIgnoreCase(mode) && !"off".equalsIgnoreCase(mode) && !"inherit".equalsIgnoreCase(mode)) {
throw Context.reportRuntimeError("Invalid document.designMode value '" + mode + "'.");
}
if ("on".equalsIgnoreCase(mode)) {
designMode_ = "on";
}
else if ("off".equalsIgnoreCase(mode)) {
designMode_ = "off";
}
else if ("inherit".equalsIgnoreCase(mode)) {
designMode_ = "inherit";
}
}
else {
if ("on".equalsIgnoreCase(mode)) {
designMode_ = "on";
final SgmlPage page = getPage();
if (page != null && page.isHtmlPage()
&& getBrowserVersion().hasFeature(JS_DOCUMENT_SELECTION_RANGE_COUNT)) {
final HtmlPage htmlPage = (HtmlPage) page;
final DomNode child = htmlPage.getBody().getFirstChild();
final DomNode rangeNode = child == null ? htmlPage.getBody() : child;
htmlPage.setSelectionRange(new SimpleRange(rangeNode, 0));
}
}
else if ("off".equalsIgnoreCase(mode)) {
designMode_ = "off";
}
}
}
/**
* Returns the page that this document is modeling.
* @return the page that this document is modeling
*/
public SgmlPage getPage() {
return (SgmlPage) getDomNodeOrDie();
}
/**
* Gets the window in which this document is contained.
* @return the window
*/
@JsxGetter
public Object getDefaultView() {
return getWindow();
}
/**
* Creates a new document fragment.
* @return a newly created document fragment
*/
@JsxFunction
public Object createDocumentFragment() {
final DomDocumentFragment fragment = getDomNodeOrDie().getPage().createDocumentFragment();
final DocumentFragment node = new DocumentFragment();
node.setParentScope(getParentScope());
node.setPrototype(getPrototype(node.getClass()));
node.setDomNode(fragment);
return getScriptableFor(fragment);
}
/**
* Creates a new HTML attribute with the specified name.
*
* @param attributeName the name of the attribute to create
* @return an attribute with the specified name
*/
@JsxFunction
public Attr createAttribute(final String attributeName) {
return (Attr) getPage().createAttribute(attributeName).getScriptableObject();
}
/**
* Imports a node from another document to this document.
* The source node is not altered or removed from the original document;
* this method creates a new copy of the source node.
*
* @param importedNode the node to import
* @param deep Whether to recursively import the subtree under the specified node; or not
* @return the imported node that belongs to this Document
*/
@JsxFunction
public Object importNode(final Node importedNode, final boolean deep) {
DomNode domNode = importedNode.getDomNodeOrDie();
domNode = domNode.cloneNode(deep);
domNode.processImportNode(this);
for (final DomNode childNode : domNode.getDescendants()) {
childNode.processImportNode(this);
}
return domNode.getScriptableObject();
}
/**
* Adopts a node from an external document.
* The node and its subtree is removed from the document it's in (if any),
* and its ownerDocument is changed to the current document.
* The node can then be inserted into the current document.
*
* @param externalNode the node from another document to be adopted
* @return the adopted node that can be used in the current document
*/
@JsxFunction
public Object adoptNode(final Node externalNode) {
externalNode.remove();
return importNode(externalNode, true);
}
/**
* Returns the implementation object of the current document.
* @return implementation-specific object
*/
@JsxGetter
public DOMImplementation getImplementation() {
if (implementation_ == null) {
implementation_ = new DOMImplementation();
implementation_.setParentScope(getWindow());
implementation_.setPrototype(getPrototype(implementation_.getClass()));
}
return implementation_;
}
/**
* Does nothing special anymore.
*
* @param type the type of events to capture
* @see Window#captureEvents(String)
*/
@JsxFunction
public void captureEvents(final String type) {
// Empty.
}
/**
* Adapts any DOM node to resolve namespaces so that an XPath expression can be easily
* evaluated relative to the context of the node where it appeared within the document.
* @param nodeResolver the node to be used as a context for namespace resolution
* @return an XPathNSResolver which resolves namespaces with respect to the definitions
* in scope for a specified node
*/
@JsxFunction({@WebBrowser(FF), @WebBrowser(CHROME)})
public XPathNSResolver createNSResolver(final Node nodeResolver) {
final XPathNSResolver resolver = new XPathNSResolver();
resolver.setElement(nodeResolver);
resolver.setParentScope(getWindow());
resolver.setPrototype(getPrototype(resolver.getClass()));
return resolver;
}
/**
* Create a new DOM text node with the given data.
*
* @param newData the string value for the text node
* @return the new text node or NOT_FOUND if there is an error
*/
@JsxFunction
public Object createTextNode(final String newData) {
Object result = NOT_FOUND;
try {
final DomNode domNode = new DomText(getDomNodeOrDie().getPage(), newData);
final Object jsElement = getScriptableFor(domNode);
if (jsElement == NOT_FOUND) {
if (LOG.isDebugEnabled()) {
LOG.debug("createTextNode(" + newData
+ ") cannot return a result as there isn't a JavaScript object for the DOM node "
+ domNode.getClass().getName());
}
}
else {
result = jsElement;
}
}
catch (final ElementNotFoundException e) {
// Just fall through - result is already set to NOT_FOUND
}
return result;
}
/**
* Creates a new Comment.
* @param comment the comment text
* @return the new Comment
*/
@JsxFunction
public Object createComment(final String comment) {
final DomNode domNode = new DomComment(getDomNodeOrDie().getPage(), comment);
return getScriptableFor(domNode);
}
/**
* Evaluates an XPath expression string and returns a result of the specified type if possible.
* @param expression the XPath expression string to be parsed and evaluated
* @param contextNode the context node for the evaluation of this XPath expression
* @param resolver the resolver permits translation of all prefixes, including the XML namespace prefix,
* within the XPath expression into appropriate namespace URIs.
* @param type If a specific type is specified, then the result will be returned as the corresponding type
* @param result the result object which may be reused and returned by this method
* @return the result of the evaluation of the XPath expression
*/
@JsxFunction({@WebBrowser(FF), @WebBrowser(CHROME)})
public XPathResult evaluate(final String expression, final Node contextNode,
final Object resolver, final int type, final Object result) {
XPathResult xPathResult = (XPathResult) result;
if (xPathResult == null) {
xPathResult = new XPathResult();
xPathResult.setParentScope(getParentScope());
xPathResult.setPrototype(getPrototype(xPathResult.getClass()));
}
PrefixResolver prefixResolver = null;
if (resolver instanceof NativeFunction) {
prefixResolver = new NativeFunctionPrefixResolver((NativeFunction) resolver, contextNode.getParentScope());
}
else if (resolver instanceof PrefixResolver) {
prefixResolver = (PrefixResolver) resolver;
}
xPathResult.init(contextNode.getDomNodeOrDie().getByXPath(expression, prefixResolver), type);
return xPathResult;
}
/**
* Creates a new element with the given tag name.
*
* @param tagName the tag name
* @return the new HTML element, or NOT_FOUND if the tag is not supported
*/
@JsxFunction
public Object createElement(String tagName) {
Object result = NOT_FOUND;
try {
final BrowserVersion browserVersion = getBrowserVersion();
if (browserVersion.hasFeature(JS_DOCUMENT_CREATE_ELEMENT_STRICT)
&& (tagName.contains("<") || tagName.contains(">"))) {
LOG.info("createElement: Provided string '"
+ tagName + "' contains an invalid character; '<' and '>' are not allowed");
throw Context.reportRuntimeError("String contains an invalid character");
}
else if (tagName.startsWith("<") && tagName.endsWith(">")) {
tagName = tagName.substring(1, tagName.length() - 1);
final Matcher matcher = TAG_NAME_PATTERN.matcher(tagName);
if (!matcher.matches()) {
LOG.info("createElement: Provided string '" + tagName + "' contains an invalid character");
throw Context.reportRuntimeError("String contains an invalid character");
}
}
final SgmlPage page = getPage();
final org.w3c.dom.Node element = page.createElement(tagName);
if (element instanceof BaseFrameElement) {
((BaseFrameElement) element).markAsCreatedByJavascript();
}
else if (element instanceof HtmlInput) {
((HtmlInput) element).markAsCreatedByJavascript();
}
else if (element instanceof HtmlImage) {
((HtmlImage) element).markAsCreatedByJavascript();
}
else if (element instanceof HtmlKeygen) {
((HtmlKeygen) element).markAsCreatedByJavascript();
}
else if (element instanceof HtmlRp) {
((HtmlRp) element).markAsCreatedByJavascript();
}
else if (element instanceof HtmlRt) {
((HtmlRt) element).markAsCreatedByJavascript();
}
else if (element instanceof HtmlScript) {
((HtmlScript) element).markAsCreatedByJavascript();
}
else if (element instanceof HtmlUnknownElement) {
((HtmlUnknownElement) element).markAsCreatedByJavascript();
}
final Object jsElement = getScriptableFor(element);
if (jsElement == NOT_FOUND) {
if (LOG.isDebugEnabled()) {
LOG.debug("createElement(" + tagName
+ ") cannot return a result as there isn't a JavaScript object for the element "
+ element.getClass().getName());
}
}
else {
result = jsElement;
}
}
catch (final ElementNotFoundException e) {
// Just fall through - result is already set to NOT_FOUND
}
return result;
}
/**
* Creates a new HTML element with the given tag name, and name.
*
* @param namespaceURI the URI that identifies an XML namespace
* @param qualifiedName the qualified name of the element type to instantiate
* @return the new HTML element, or NOT_FOUND if the tag is not supported
*/
@JsxFunction
public Object createElementNS(final String namespaceURI, final String qualifiedName) {
final org.w3c.dom.Element element;
if ("http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul".equals(namespaceURI)) {
throw Context.reportRuntimeError("XUL not available");
}
if (HTMLParser.XHTML_NAMESPACE.equals(namespaceURI)
|| HTMLParser.SVG_NAMESPACE.equals(namespaceURI)) {
element = getPage().createElementNS(namespaceURI, qualifiedName);
}
else {
element = new DomElement(namespaceURI, qualifiedName, getPage(), null);
}
return getScriptableFor(element);
}
/**
* Returns all the descendant elements with the specified tag name.
* @param tagName the name to search for
* @return all the descendant elements with the specified tag name
*/
@JsxFunction
public HTMLCollection getElementsByTagName(final String tagName) {
final HTMLCollection collection;
if ("*".equals(tagName)) {
collection = new HTMLCollection(getDomNodeOrDie(), false) {
@Override
protected boolean isMatching(final DomNode node) {
return true;
}
};
}
else {
collection = new HTMLCollection(getDomNodeOrDie(), false) {
@Override
protected boolean isMatching(final DomNode node) {
return tagName.equalsIgnoreCase(node.getNodeName());
}
};
}
return collection;
}
/**
* Returns a list of elements with the given tag name belonging to the given namespace.
* @param namespaceURI the namespace URI of elements to look for
* @param localName is either the local name of elements to look for or the special value "*",
* which matches all elements.
* @return a live NodeList of found elements in the order they appear in the tree
*/
@JsxFunction
public Object getElementsByTagNameNS(final Object namespaceURI, final String localName) {
final HTMLCollection collection = new HTMLCollection(getDomNodeOrDie(), false) {
@Override
protected boolean isMatching(final DomNode node) {
return localName.equals(node.getLocalName());
}
};
return collection;
}
}