/*
* Copyright (c) 2002-2010 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.html;
import static com.gargoylesoftware.htmlunit.protocol.javascript.JavaScriptURLConnection.JAVASCRIPT_PREFIX;
import java.io.PrintWriter;
import java.util.Map;
import net.sourceforge.htmlunit.corejs.javascript.BaseFunction;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import com.gargoylesoftware.htmlunit.BrowserVersion;
import com.gargoylesoftware.htmlunit.ElementNotFoundException;
import com.gargoylesoftware.htmlunit.FailingHttpStatusCodeException;
import com.gargoylesoftware.htmlunit.SgmlPage;
import com.gargoylesoftware.htmlunit.TextUtil;
import com.gargoylesoftware.htmlunit.html.HtmlPage.JavaScriptLoadResult;
import com.gargoylesoftware.htmlunit.javascript.JavaScriptEngine;
import com.gargoylesoftware.htmlunit.javascript.PostponedAction;
import com.gargoylesoftware.htmlunit.javascript.host.Event;
import com.gargoylesoftware.htmlunit.javascript.host.EventHandler;
import com.gargoylesoftware.htmlunit.javascript.host.Window;
import com.gargoylesoftware.htmlunit.javascript.host.html.HTMLScriptElement;
import com.gargoylesoftware.htmlunit.xml.XmlPage;
/**
* Wrapper for the HTML element "script".<br>
* When a script tag references an external script (with attribute src) it gets executed when the node
* is added to the DOM tree. When the script code is nested, it gets executed when the text node
* containing the script is added to the HtmlScript.<br>
* The ScriptFilter feature of NekoHtml can't be used because it doesn't allow immediate access to the DOM
* (i.e. <code>document.write("<span id='mySpan'/>"); document.getElementById("mySpan").tagName;</code>
* can't work with a filter).
*
* @version $Revision: 5349 $
* @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
* @author <a href="mailto:cse@dynabean.de">Christian Sell</a>
* @author Marc Guillemot
* @author David K. Taylor
* @author Ahmed Ashour
* @author Daniel Gredler
* @author Dmitri Zoubkov
* @author Sudhan Moghe
* @see <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.html#ID-81598695">DOM Level 1</a>
* @see <a href="http://www.w3.org/TR/2003/REC-DOM-Level-2-HTML-20030109/html.html#ID-81598695">DOM Level 2</a>
*/
public class HtmlScript extends HtmlElement {
private static final long serialVersionUID = 5736570536821513938L;
private static final Log LOG = LogFactory.getLog(HtmlScript.class);
/** The HTML tag represented by this element. */
public static final String TAG_NAME = "script";
/** Invalid source attribute which should be ignored (used by JS libraries like jQuery). */
private static final String SLASH_SLASH_COLON = "//:";
/**
* Creates an instance of HtmlScript
*
* @param namespaceURI the URI that identifies an XML namespace
* @param qualifiedName the qualified name of the element type to instantiate
* @param page the HtmlPage that contains this element
* @param attributes the initial attributes
*/
HtmlScript(final String namespaceURI, final String qualifiedName, final SgmlPage page,
final Map<String, DomAttr> attributes) {
super(namespaceURI, qualifiedName, page, attributes);
}
/**
* Returns the value of the attribute "charset". Refer to the
* <a href='http://www.w3.org/TR/html401/'>HTML 4.01</a>
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "charset"
* or an empty string if that attribute isn't defined.
*/
public final String getCharsetAttribute() {
return getAttribute("charset");
}
/**
* Returns the value of the attribute "type". Refer to the
* <a href='http://www.w3.org/TR/html401/'>HTML 4.01</a>
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "type"
* or an empty string if that attribute isn't defined.
*/
public final String getTypeAttribute() {
return getAttribute("type");
}
/**
* Returns the value of the attribute "language". Refer to the
* <a href='http://www.w3.org/TR/html401/'>HTML 4.01</a>
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "language"
* or an empty string if that attribute isn't defined.
*/
public final String getLanguageAttribute() {
return getAttribute("language");
}
/**
* Returns the value of the attribute "src". Refer to the
* <a href='http://www.w3.org/TR/html401/'>HTML 4.01</a>
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "src"
* or an empty string if that attribute isn't defined.
*/
public final String getSrcAttribute() {
return getAttribute("src");
}
/**
* Returns the value of the attribute "event".
* @return the value of the attribute "event"
*/
public final String getEventAttribute() {
return getAttribute("event");
}
/**
* Returns the value of the attribute "for".
* @return the value of the attribute "for"
*/
public final String getHtmlForAttribute() {
return getAttribute("for");
}
/**
* Returns the value of the attribute "defer". Refer to the
* <a href='http://www.w3.org/TR/html401/'>HTML 4.01</a>
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "defer"
* or an empty string if that attribute isn't defined.
*/
public final String getDeferAttribute() {
return getAttribute("defer");
}
/**
* Returns <tt>true</tt> if this script is deferred.
* @return <tt>true</tt> if this script is deferred
*/
protected boolean isDeferred() {
return getDeferAttribute() != ATTRIBUTE_NOT_DEFINED;
}
/**
* If setting the <tt>src</tt> attribute, this method executes the new JavaScript if necessary
* (behavior varies by browser version). {@inheritDoc}
*/
@Override
public void setAttributeNS(final String namespaceURI, final String qualifiedName, final String attributeValue) {
final String oldValue = getAttributeNS(namespaceURI, qualifiedName);
super.setAttributeNS(namespaceURI, qualifiedName, attributeValue);
boolean execute = false;
if (namespaceURI == null && "src".equals(qualifiedName)) {
final boolean ie = getPage().getWebClient().getBrowserVersion().isIE();
if (ie || (oldValue.length() == 0 && getFirstChild() == null)) {
// Always execute if IE; if FF, only execute if the "src" attribute
// was undefined and there was no inline code.
execute = true;
}
}
if (execute) {
executeScriptIfNeeded(true);
}
}
/**
* Executes the <tt>onreadystatechange</tt> handler when simulating IE, as well as executing
* the script itself, if necessary. {@inheritDoc}
*/
@Override
protected void onAllChildrenAddedToPage(final boolean postponed) {
if (getOwnerDocument() instanceof XmlPage) {
return;
}
if (LOG.isDebugEnabled()) {
LOG.debug("Script node added: " + asXml());
}
final PostponedAction action = new PostponedAction(getPage()) {
@Override
public void execute() {
final boolean ie = getPage().getWebClient().getBrowserVersion().isIE();
if (ie) {
if (!isDeferred()) {
if (!getSrcAttribute().equals("//:")) {
setAndExecuteReadyState(READY_STATE_LOADING);
executeScriptIfNeeded(true);
setAndExecuteReadyState(READY_STATE_LOADED);
}
else {
setAndExecuteReadyState(READY_STATE_COMPLETE);
executeScriptIfNeeded(true);
}
}
}
else {
executeScriptIfNeeded(true);
}
}
};
if (postponed && getTextContent().length() == 0) {
final JavaScriptEngine engine = getPage().getWebClient().getJavaScriptEngine();
engine.addPostponedAction(action);
}
else {
try {
action.execute();
}
catch (final Exception e) {
if (e instanceof RuntimeException) {
throw (RuntimeException) e;
}
throw new RuntimeException(e);
}
}
}
/**
* Executes this script node as inline script if necessary and/or possible.
*
* @param executeIfDeferred if <tt>false</tt>, and we are emulating IE, and the <tt>defer</tt>
* attribute is defined, the script is not executed
*/
private void executeInlineScriptIfNeeded(final boolean executeIfDeferred) {
if (!isExecutionNeeded()) {
return;
}
final boolean ie = getPage().getWebClient().getBrowserVersion().isIE();
if (!executeIfDeferred && isDeferred() && ie) {
return;
}
final String src = getSrcAttribute();
if (src != HtmlElement.ATTRIBUTE_NOT_DEFINED) {
return;
}
final DomCharacterData textNode = (DomCharacterData) getFirstChild();
final String forr = getHtmlForAttribute();
String event = getEventAttribute();
// The event name can be like "onload" or "onload()".
if (event.endsWith("()")) {
event = event.substring(0, event.length() - 2);
}
final String scriptCode = textNode.getData();
if (ie && event != ATTRIBUTE_NOT_DEFINED && forr != ATTRIBUTE_NOT_DEFINED) {
if ("window".equals(forr)) {
// everything fine, accepted by IE and FF
final Window window = (Window) getPage().getEnclosingWindow().getScriptObject();
final BaseFunction function = new EventHandler(this, event, scriptCode);
window.jsxFunction_attachEvent(event, function);
}
else {
try {
final HtmlElement elt = ((HtmlPage) getPage()).getHtmlElementById(forr);
elt.setEventHandler(event, scriptCode);
}
catch (final ElementNotFoundException e) {
LOG.warn("<script for='" + forr + "' ...>: no element found with id \""
+ forr + "\". Ignoring.");
}
}
}
else if (forr == ATTRIBUTE_NOT_DEFINED || "onload".equals(event)) {
final String url = getPage().getWebResponse().getRequestSettings().getUrl().toExternalForm();
final int line1 = getStartLineNumber();
final int line2 = getEndLineNumber();
final int col1 = getStartColumnNumber();
final int col2 = getEndColumnNumber();
final String desc = "script in " + url + " from (" + line1 + ", " + col1
+ ") to (" + line2 + ", " + col2 + ")";
((HtmlPage) getPage()).executeJavaScriptIfPossible(scriptCode, desc, line1);
}
}
/**
* Executes this script node if necessary and/or possible.
*
* @param executeIfDeferred if <tt>false</tt>, and we are emulating IE, and the <tt>defer</tt>
* attribute is defined, the script is not executed
*/
void executeScriptIfNeeded(final boolean executeIfDeferred) {
if (!isExecutionNeeded()) {
return;
}
final HtmlPage page = (HtmlPage) getPage();
final BrowserVersion browser = page.getWebClient().getBrowserVersion();
final boolean ie = browser.isIE();
if (!executeIfDeferred && isDeferred() && ie) {
return;
}
final String src = getSrcAttribute();
if (src.equals(SLASH_SLASH_COLON)) {
return;
}
if (src != ATTRIBUTE_NOT_DEFINED) {
if (src.startsWith(JAVASCRIPT_PREFIX)) {
// <script src="javascript:'[code]'"></script>
if (!ie || browser.getBrowserVersionNumeric() != 7) {
String code = StringUtils.removeStart(src, JAVASCRIPT_PREFIX).trim();
final int len = code.length();
if (len > 2) {
if ((code.charAt(0) == '\'' && code.charAt(len - 1) == '\'')
|| (code.charAt(0) == '"' && code.charAt(len - 1) == '"')) {
code = code.substring(1, len - 1);
if (LOG.isDebugEnabled()) {
LOG.debug("Executing JavaScript: " + code);
}
page.executeJavaScriptIfPossible(code, code, getStartLineNumber());
}
}
}
}
else {
// <script src="[url]"></script>
if (LOG.isDebugEnabled()) {
LOG.debug("Loading external JavaScript: " + src);
}
try {
final JavaScriptLoadResult result = page.loadExternalJavaScriptFile(src, getCharsetAttribute());
if (result == JavaScriptLoadResult.SUCCESS) {
executeEventIfNotIE(Event.TYPE_LOAD);
}
else if (result == JavaScriptLoadResult.DOWNLOAD_ERROR) {
executeEventIfNotIE(Event.TYPE_ERROR);
}
}
catch (final FailingHttpStatusCodeException e) {
executeEventIfNotIE(Event.TYPE_ERROR);
throw e;
}
}
}
else if (getFirstChild() != null) {
// <script>[code]</script>
executeInlineScriptIfNeeded(executeIfDeferred);
}
}
private void executeEventIfNotIE(final String type) {
if (!getPage().getWebClient().getBrowserVersion().isIE()) {
final HTMLScriptElement script = (HTMLScriptElement) getScriptObject();
final Event event = new Event(HtmlScript.this, type);
script.executeEvent(event);
}
}
/**
* Indicates if script execution is necessary and/or possible.
*
* @return <code>true</code> if the script should be executed
*/
private boolean isExecutionNeeded() {
final SgmlPage page = getPage();
// If JavaScript is disabled, we don't need to execute.
if (!page.getWebClient().isJavaScriptEnabled()) {
return false;
}
//If innerHTML or outerHTML is being parsed
if (page instanceof HtmlPage && ((HtmlPage) page).isParsingHtmlSnippet()) {
return false;
}
// If the script node is nested in an iframe, a noframes, or a noscript node, we don't need to execute.
for (DomNode o = this; o != null; o = o.getParentNode()) {
if (o instanceof HtmlInlineFrame || o instanceof HtmlNoFrames || o instanceof HtmlNoScript) {
return false;
}
}
// If the underlying page no longer owns its window, the client has moved on (possibly
// because another script set window.location.href), and we don't need to execute.
if (page.getEnclosingWindow() != null && page.getEnclosingWindow().getEnclosedPage() != page) {
return false;
}
// If the script language is not JavaScript, we can't execute.
if (!isJavaScript(getTypeAttribute(), getLanguageAttribute())) {
final String t = getTypeAttribute();
final String l = getLanguageAttribute();
if (LOG.isWarnEnabled()) {
LOG.warn("Script is not JavaScript (type: " + t + ", language: " + l + "). Skipping execution.");
}
return false;
}
// If the script's root ancestor node is not the page, the the script is not a part of the page.
// If it isn't yet part of the page, don't execute the script; it's probably just being cloned.
DomNode root = this;
while (root.getParentNode() != null) {
root = root.getParentNode();
}
if (root != getPage()) {
return false;
}
return true;
}
/**
* Returns true if a script with the specified type and language attributes is actually JavaScript.
* According to <a href="http://www.w3.org/TR/REC-html40/types.html#h-6.7">W3C recommendation</a>
* are content types case insensitive.
* @param typeAttribute the type attribute specified in the script tag
* @param languageAttribute the language attribute specified in the script tag
* @return true if the script is JavaScript
*/
boolean isJavaScript(final String typeAttribute, final String languageAttribute) {
final boolean isJavaScript;
if (typeAttribute != null && typeAttribute.length() != 0) {
isJavaScript = typeAttribute.equalsIgnoreCase("text/javascript")
|| (typeAttribute.equalsIgnoreCase("application/javascript")
&& getPage().getWebClient().getBrowserVersion().isFirefox());
}
else if (languageAttribute != null && languageAttribute.length() != 0) {
isJavaScript = TextUtil.startsWithIgnoreCase(languageAttribute, "javascript");
}
else {
isJavaScript = true;
}
return isJavaScript;
}
/**
* Sets the <tt>readyState</tt> to the specified state and executes the
* <tt>onreadystatechange</tt> handler when simulating IE.
* @param state this script ready state
*/
protected void setAndExecuteReadyState(final String state) {
if (getPage().getWebClient().getBrowserVersion().isIE()) {
setReadyState(state);
final HTMLScriptElement script = (HTMLScriptElement) getScriptObject();
final Event event = new Event(this, Event.TYPE_READY_STATE_CHANGE);
script.executeEvent(event);
}
}
/**
* @see com.gargoylesoftware.htmlunit.html.HtmlInput#asText()
* @return an empty string as the content of script is not visible by itself
*/
// we need to preserve this method as it is there since many versions with the above documentation.
@Override
public String asText() {
return "";
}
/**
* Indicates if a node without children should be written in expanded form as XML
* (i.e. with closing tag rather than with "/>")
* @return <code>true</code> to make generated XML readable as HTML
*/
@Override
protected boolean isEmptyXmlTagExpanded() {
return true;
}
/**
* {@inheritDoc}
*/
@Override
protected void printChildrenAsXml(final String indent, final PrintWriter printWriter) {
final DomCharacterData textNode = (DomCharacterData) getFirstChild();
if (textNode != null) {
printWriter.println("//<![CDATA[");
printWriter.println(textNode.getData());
printWriter.println("//]]>");
}
}
}