/*
* 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.javascript.host;
import java.io.IOException;
import java.io.StringReader;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import net.sourceforge.htmlunit.corejs.javascript.Context;
import org.apache.commons.io.IOUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.w3c.css.sac.AttributeCondition;
import org.w3c.css.sac.CombinatorCondition;
import org.w3c.css.sac.Condition;
import org.w3c.css.sac.ConditionalSelector;
import org.w3c.css.sac.ContentCondition;
import org.w3c.css.sac.DescendantSelector;
import org.w3c.css.sac.ElementSelector;
import org.w3c.css.sac.ErrorHandler;
import org.w3c.css.sac.InputSource;
import org.w3c.css.sac.LangCondition;
import org.w3c.css.sac.NegativeCondition;
import org.w3c.css.sac.NegativeSelector;
import org.w3c.css.sac.Selector;
import org.w3c.css.sac.SelectorList;
import org.w3c.css.sac.SiblingSelector;
import org.w3c.dom.css.CSSImportRule;
import org.w3c.dom.css.CSSRule;
import org.w3c.dom.css.CSSRuleList;
import org.w3c.dom.css.CSSStyleSheet;
import com.gargoylesoftware.htmlunit.BrowserVersion;
import com.gargoylesoftware.htmlunit.BrowserVersionFeatures;
import com.gargoylesoftware.htmlunit.Cache;
import com.gargoylesoftware.htmlunit.FailingHttpStatusCodeException;
import com.gargoylesoftware.htmlunit.WebClient;
import com.gargoylesoftware.htmlunit.WebRequestSettings;
import com.gargoylesoftware.htmlunit.WebResponse;
import com.gargoylesoftware.htmlunit.html.DomNode;
import com.gargoylesoftware.htmlunit.html.HtmlCheckBoxInput;
import com.gargoylesoftware.htmlunit.html.HtmlElement;
import com.gargoylesoftware.htmlunit.html.HtmlHtml;
import com.gargoylesoftware.htmlunit.html.HtmlInput;
import com.gargoylesoftware.htmlunit.html.HtmlLink;
import com.gargoylesoftware.htmlunit.html.HtmlPage;
import com.gargoylesoftware.htmlunit.html.HtmlRadioButtonInput;
import com.gargoylesoftware.htmlunit.html.HtmlSelect;
import com.gargoylesoftware.htmlunit.javascript.SimpleScriptable;
import com.gargoylesoftware.htmlunit.javascript.host.css.ComputedCSSStyleDeclaration;
import com.gargoylesoftware.htmlunit.javascript.host.html.HTMLElement;
import com.gargoylesoftware.htmlunit.util.UrlUtils;
import com.steadystate.css.dom.CSSImportRuleImpl;
import com.steadystate.css.dom.CSSStyleRuleImpl;
import com.steadystate.css.dom.CSSStyleSheetImpl;
import com.steadystate.css.parser.CSSOMParser;
import com.steadystate.css.parser.SACParserCSS21;
import com.steadystate.css.parser.SelectorListImpl;
/**
* A JavaScript object for a Stylesheet.
*
* @see <a href="http://msdn2.microsoft.com/en-us/library/ms535871.aspx">MSDN doc</a>
* @version $Revision: 5301 $
* @author Marc Guillemot
* @author Daniel Gredler
* @author Ahmed Ashour
*/
public class Stylesheet extends SimpleScriptable {
private static final long serialVersionUID = -8341675386925348206L;
private static final Log LOG = LogFactory.getLog(Stylesheet.class);
/** The parsed stylesheet which this host object wraps. */
private final CSSStyleSheet wrapped_;
/** The HTML element which owns this stylesheet. */
private final HTMLElement ownerNode_;
/** The collection of rules defined in this style sheet. */
private com.gargoylesoftware.htmlunit.javascript.host.css.CSSRuleList cssRules_;
/** The CSS import rules and their corresponding stylesheets. */
private Map<CSSImportRule, Stylesheet> imports_ = new HashMap<CSSImportRule, Stylesheet>();
/** This stylesheet's URI (used to resolved contained @import rules). */
private String uri_;
/**
* Creates a new empty stylesheet.
*/
public Stylesheet() {
wrapped_ = new CSSStyleSheetImpl();
ownerNode_ = null;
}
/**
* Creates a new stylesheet representing the CSS stylesheet for the specified input source.
* @param element the owning node
* @param source the input source which contains the CSS stylesheet which this stylesheet host object represents
* @param uri this stylesheet's URI (used to resolved contained @import rules)
*/
public Stylesheet(final HTMLElement element, final InputSource source, final String uri) {
setParentScope(element.getWindow());
setPrototype(getPrototype(Stylesheet.class));
wrapped_ = parseCSS(source);
uri_ = uri;
ownerNode_ = element;
}
/**
* Creates a new stylesheet representing the specified CSS stylesheet.
* @param element the owning node
* @param wrapped the CSS stylesheet which this stylesheet host object represents
* @param uri this stylesheet's URI (used to resolved contained @import rules)
*/
public Stylesheet(final HTMLElement element, final CSSStyleSheet wrapped, final String uri) {
setParentScope(element.getWindow());
setPrototype(getPrototype(Stylesheet.class));
wrapped_ = wrapped;
uri_ = uri;
ownerNode_ = element;
}
/**
* Returns the wrapped stylesheet.
* @return the wrapped stylesheet
*/
public CSSStyleSheet getWrappedSheet() {
return wrapped_;
}
/**
* Modifies the specified style object by adding any style rules which apply to the specified
* element.
*
* @param style the style to modify
* @param element the element to which style rules must apply in order for them to be added to
* the specified style
*/
void modifyIfNecessary(final ComputedCSSStyleDeclaration style, final HTMLElement element) {
final HtmlElement e = element.getDomNodeOrDie();
final CSSRuleList rules = getWrappedSheet().getCssRules();
if (rules == null) {
return;
}
for (int i = 0; i < rules.getLength(); i++) {
final CSSRule rule = rules.item(i);
if (rule.getType() == CSSRule.STYLE_RULE) {
final CSSStyleRuleImpl styleRule = (CSSStyleRuleImpl) rule;
final SelectorList selectors = styleRule.getSelectors();
for (int j = 0; j < selectors.getLength(); j++) {
final Selector selector = selectors.item(j);
final boolean selected = selects(selector, e);
if (selected) {
final org.w3c.dom.css.CSSStyleDeclaration dec = styleRule.getStyle();
style.applyStyleFromSelector(dec, selector);
}
}
}
else if (rule.getType() == CSSRule.IMPORT_RULE) {
final CSSImportRuleImpl importRule = (CSSImportRuleImpl) rule;
Stylesheet sheet = imports_.get(importRule);
if (sheet == null) {
// TODO: surely wrong: in which case is it null and why?
final String uri = (uri_ != null) ? uri_
: e.getPage().getWebResponse().getRequestSettings().getUrl().toExternalForm();
final String href = importRule.getHref();
final String url = UrlUtils.resolveUrl(uri, href);
sheet = loadStylesheet(getWindow(), ownerNode_, null, url);
imports_.put(importRule, sheet);
}
sheet.modifyIfNecessary(style, element);
}
}
}
/**
* Loads the stylesheet at the specified link or href.
* @param window the current window
* @param element the parent DOM element
* @param link the stylesheet's link (may be <tt>null</tt> if an <tt>href</tt> is specified)
* @param url the stylesheet's url (may be <tt>null</tt> if a <tt>link</tt> is specified)
* @return the loaded stylesheet
*/
public static Stylesheet loadStylesheet(final Window window, final HTMLElement element,
final HtmlLink link, final String url) {
Stylesheet sheet;
final HtmlPage page = (HtmlPage) element.getDomNodeOrDie().getPage(); // fallback uri for exceptions
String uri = page.getWebResponse().getRequestSettings().getUrl().toExternalForm();
try {
// Retrieve the associated content and respect client settings regarding failing HTTP status codes.
final WebRequestSettings request;
final WebClient client = page.getWebClient();
if (link != null) {
// Use link.
request = link.getWebRequestSettings();
}
else {
// Use href.
request = new WebRequestSettings(new URL(url));
final String referer = page.getWebResponse().getRequestSettings().getUrl().toExternalForm();
request.setAdditionalHeader("Referer", referer);
}
uri = request.getUrl().toExternalForm();
final Cache cache = client.getCache();
final Object fromCache = cache.getCachedObject(request);
if (fromCache != null && fromCache instanceof CSSStyleSheet) {
sheet = new Stylesheet(element, (CSSStyleSheet) fromCache, uri);
}
else {
final WebResponse response = client.loadWebResponse(request);
uri = response.getRequestSettings().getUrl().toExternalForm();
client.printContentIfNecessary(response);
client.throwFailingHttpStatusCodeExceptionIfNecessary(response);
// CSS content must have downloaded OK; go ahead and build the corresponding stylesheet.
final String css = response.getContentAsString();
final InputSource source = new InputSource(new StringReader(css));
sheet = new Stylesheet(element, source, uri);
cache.cacheIfPossible(request, response, sheet.getWrappedSheet());
}
}
catch (final FailingHttpStatusCodeException e) {
// Got a 404 response or something like that; behave nicely.
LOG.error(e.getMessage());
final InputSource source = new InputSource(new StringReader(""));
sheet = new Stylesheet(element, source, uri);
}
catch (final IOException e) {
// Got a basic IO error; behave nicely.
LOG.error(e.getMessage());
final InputSource source = new InputSource(new StringReader(""));
sheet = new Stylesheet(element, source, uri);
}
catch (final Exception e) {
// Got something unexpected; we can throw an exception in this case.
throw Context.reportRuntimeError("Exception: " + e);
}
return sheet;
}
/**
* Returns <tt>true</tt> if the specified selector selects the specified element.
*
* @param selector the selector to test
* @param element the element to test
* @return <tt>true</tt> if it does apply, <tt>false</tt> if it doesn't apply
*/
boolean selects(final Selector selector, final HtmlElement element) {
final String tagName = element.getTagName();
switch (selector.getSelectorType()) {
case Selector.SAC_ANY_NODE_SELECTOR:
return true;
case Selector.SAC_CHILD_SELECTOR:
if (element.getParentNode() == element.getPage()) {
return false;
}
final DescendantSelector cs = (DescendantSelector) selector;
final HtmlElement parent = (HtmlElement) element.getParentNode();
return selects(cs.getSimpleSelector(), element) && parent != null
&& selects(cs.getAncestorSelector(), parent);
case Selector.SAC_DESCENDANT_SELECTOR:
final DescendantSelector ds = (DescendantSelector) selector;
if (selects(ds.getSimpleSelector(), element)) {
DomNode ancestor = element.getParentNode();
while (ancestor instanceof HtmlElement) {
if (selects(ds.getAncestorSelector(), (HtmlElement) ancestor)) {
return true;
}
ancestor = ancestor.getParentNode();
}
}
return false;
case Selector.SAC_CONDITIONAL_SELECTOR:
final ConditionalSelector conditional = (ConditionalSelector) selector;
final Condition condition = conditional.getCondition();
return selects(conditional.getSimpleSelector(), element) && selects(condition, element);
case Selector.SAC_ELEMENT_NODE_SELECTOR:
final ElementSelector es = (ElementSelector) selector;
final String name = es.getLocalName();
return name == null || tagName.equalsIgnoreCase(name);
case Selector.SAC_ROOT_NODE_SELECTOR:
return HtmlHtml.TAG_NAME.equalsIgnoreCase(tagName);
case Selector.SAC_DIRECT_ADJACENT_SELECTOR:
final SiblingSelector ss = (SiblingSelector) selector;
final DomNode prev = element.getPreviousSibling();
return prev instanceof HtmlElement
&& selects(ss.getSelector(), (HtmlElement) prev)
&& selects(ss.getSiblingSelector(), element);
case Selector.SAC_NEGATIVE_SELECTOR:
final NegativeSelector ns = (NegativeSelector) selector;
return !selects(ns.getSimpleSelector(), element);
case Selector.SAC_PSEUDO_ELEMENT_SELECTOR:
case Selector.SAC_COMMENT_NODE_SELECTOR:
case Selector.SAC_CDATA_SECTION_NODE_SELECTOR:
case Selector.SAC_PROCESSING_INSTRUCTION_NODE_SELECTOR:
case Selector.SAC_TEXT_NODE_SELECTOR:
return false;
default:
LOG.error("Unknown CSS selector type '" + selector.getSelectorType() + "'.");
return false;
}
}
/**
* Returns <tt>true</tt> if the specified condition selects the specified element.
*
* @param condition the condition to test
* @param element the element to test
* @return <tt>true</tt> if it does apply, <tt>false</tt> if it doesn't apply
*/
boolean selects(final Condition condition, final HtmlElement element) {
switch (condition.getConditionType()) {
case Condition.SAC_ID_CONDITION:
final AttributeCondition ac4 = (AttributeCondition) condition;
return ac4.getValue().equals(element.getId());
case Condition.SAC_CLASS_CONDITION:
final AttributeCondition ac3 = (AttributeCondition) condition;
final String v3 = ac3.getValue();
final String a3 = element.getAttribute("class");
return a3.equals(v3) || a3.startsWith(v3 + " ") || a3.endsWith(" " + v3) || a3.contains(" " + v3 + " ");
case Condition.SAC_AND_CONDITION:
final CombinatorCondition cc1 = (CombinatorCondition) condition;
return selects(cc1.getFirstCondition(), element) && selects(cc1.getSecondCondition(), element);
case Condition.SAC_ATTRIBUTE_CONDITION:
final AttributeCondition ac1 = (AttributeCondition) condition;
if (ac1.getSpecified()) {
return element.getAttribute(ac1.getLocalName()).equals(ac1.getValue());
}
return element.hasAttribute(ac1.getLocalName());
case Condition.SAC_BEGIN_HYPHEN_ATTRIBUTE_CONDITION:
final AttributeCondition ac2 = (AttributeCondition) condition;
final String v = ac2.getValue();
final String a = element.getAttribute(ac2.getLocalName());
return a.equals(v) || a.startsWith(v + "-") || a.endsWith("-" + v) || a.contains("-" + v + "-");
case Condition.SAC_ONE_OF_ATTRIBUTE_CONDITION:
final AttributeCondition ac5 = (AttributeCondition) condition;
final String v2 = ac5.getValue();
final String a2 = element.getAttribute(ac5.getLocalName());
return a2.equals(v2) || a2.startsWith(v2 + " ") || a2.endsWith(" " + v2) || a2.contains(" " + v2 + " ");
case Condition.SAC_OR_CONDITION:
final CombinatorCondition cc2 = (CombinatorCondition) condition;
return selects(cc2.getFirstCondition(), element) || selects(cc2.getSecondCondition(), element);
case Condition.SAC_NEGATIVE_CONDITION:
final NegativeCondition nc = (NegativeCondition) condition;
return !selects(nc.getCondition(), element);
case Condition.SAC_ONLY_CHILD_CONDITION:
return element.getParentNode().getChildNodes().getLength() == 1;
case Condition.SAC_CONTENT_CONDITION:
final ContentCondition cc = (ContentCondition) condition;
return element.asText().contains(cc.getData());
case Condition.SAC_LANG_CONDITION:
if (getBrowserVersion().isIE()) {
return false;
}
final String lcLang = ((LangCondition) condition).getLang();
for (DomNode node = element; node instanceof HtmlElement; node = node.getParentNode()) {
final String nodeLang = ((HtmlElement) node).getAttribute("lang");
// "en", "en-GB" should be matched by "en" but not "english"
if (nodeLang.startsWith(lcLang)
&& (nodeLang.length() == lcLang.length() || '-' == nodeLang.charAt(lcLang.length()))) {
return true;
}
}
return false;
case Condition.SAC_ONLY_TYPE_CONDITION:
final String tagName = element.getTagName();
return ((HtmlPage) element.getPage()).getElementsByTagName(tagName).getLength() == 1;
case Condition.SAC_PSEUDO_CLASS_CONDITION:
return selectsPseudoClass((AttributeCondition) condition, element);
case Condition.SAC_POSITIONAL_CONDITION:
return false;
default:
LOG.error("Unknown CSS condition type '" + condition.getConditionType() + "'.");
return false;
}
}
private boolean selectsPseudoClass(final AttributeCondition condition, final HtmlElement element) {
if (getBrowserVersion().isIE()) {
return false;
}
final String value = condition.getValue();
if ("root".equals(value)) {
return element == element.getPage().getDocumentElement();
}
else if ("enabled".equals(value)) {
return (element instanceof HtmlInput && !((HtmlInput) element).isDisabled())
|| (element instanceof HtmlSelect && !((HtmlSelect) element).isDisabled());
}
else if ("checked".equals(value)) {
return (element instanceof HtmlCheckBoxInput && ((HtmlCheckBoxInput) element).isChecked())
|| (element instanceof HtmlRadioButtonInput && ((HtmlRadioButtonInput) element).isChecked());
}
return false;
}
/**
* Parses the CSS at the specified input source. If anything at all goes wrong, this method
* returns an empty stylesheet.
*
* @param source the source from which to retrieve the CSS to be parsed
* @return the stylesheet parsed from the specified input source
*/
private CSSStyleSheet parseCSS(final InputSource source) {
CSSStyleSheet ss;
try {
final ErrorHandler errorHandler = getWindow().getWebWindow().getWebClient().getCssErrorHandler();
final CSSOMParser parser = new CSSOMParser(new SACParserCSS21());
parser.setErrorHandler(errorHandler);
ss = parser.parseStyleSheet(source, null, null);
}
catch (final Exception e) {
LOG.error("Error parsing CSS from '" + toString(source) + "': " + e.getMessage(), e);
ss = new CSSStyleSheetImpl();
}
catch (final Error e) {
// SACParser sometimes throws Error: "Missing return statement in function"
LOG.error("Error parsing CSS from '" + toString(source) + "': " + e.getMessage(), e);
ss = new CSSStyleSheetImpl();
}
return ss;
}
/**
* Parses the selectors at the specified input source. If anything at all goes wrong, this
* method returns an empty selector list.
*
* @param source the source from which to retrieve the selectors to be parsed
* @return the selectors parsed from the specified input source
*/
public SelectorList parseSelectors(final InputSource source) {
SelectorList selectors;
try {
final ErrorHandler errorHandler = getWindow().getWebWindow().getWebClient().getCssErrorHandler();
final CSSOMParser parser = new CSSOMParser(new SACParserCSS21());
parser.setErrorHandler(errorHandler);
selectors = parser.parseSelectors(source);
}
catch (final Exception e) {
LOG.error("Error parsing CSS selectors from '" + toString(source) + "': " + e.getMessage(), e);
selectors = new SelectorListImpl();
}
catch (final Error e) {
// SACParser sometimes throws Error: "Missing return statement in function"
LOG.error("Error parsing CSS selectors from '" + toString(source) + "': " + e.getMessage(), e);
selectors = new SelectorListImpl();
}
return selectors;
}
/**
* Returns the contents of the specified input source, ignoring any {@link IOException}s.
* @param source the input source from which to read
* @return the contents of the specified input source, or an empty string if an {@link IOException} occurs
*/
private static String toString(final InputSource source) {
try {
return IOUtils.toString(source.getCharacterStream());
}
catch (final IOException e) {
return "";
}
}
/**
* For Firefox.
* @return the owner
*/
public HTMLElement jsxGet_ownerNode() {
return ownerNode_;
}
/**
* For Internet Explorer.
* @return the owner
*/
public HTMLElement jsxGet_owningElement() {
return ownerNode_;
}
/**
* {@inheritDoc}
*/
@Override
public Object getDefaultValue(final Class< ? > hint) {
if (String.class.equals(hint) || hint == null) {
if (getBrowserVersion().isIE()) {
return "[object]"; // the super helpful IE solution
}
return "[object CSSStyleSheet]";
}
return super.getDefaultValue(hint);
}
/**
* Retrieves the collection of rules defined in this style sheet.
* @return the collection of rules defined in this style sheet
*/
public com.gargoylesoftware.htmlunit.javascript.host.css.CSSRuleList jsxGet_rules() {
return jsxGet_cssRules();
}
/**
* Returns the collection of rules defined in this style sheet.
* @return the collection of rules defined in this style sheet
*/
public com.gargoylesoftware.htmlunit.javascript.host.css.CSSRuleList jsxGet_cssRules() {
if (cssRules_ == null) {
cssRules_ = new com.gargoylesoftware.htmlunit.javascript.host.css.CSSRuleList(this);
}
return cssRules_;
}
/**
* Returns the URL of the stylesheet.
* @return the URL of the stylesheet
*/
public String jsxGet_href() {
final BrowserVersion version = getBrowserVersion();
if (ownerNode_ != null) {
final DomNode node = ownerNode_.getDomNodeOrDie();
if (node instanceof HtmlLink) {
// <link rel="stylesheet" type="text/css" href="..." />
final HtmlLink link = (HtmlLink) node;
final HtmlPage page = (HtmlPage) link.getPage();
final String href = link.getHrefAttribute();
if (!version.hasFeature(BrowserVersionFeatures.STYLESHEET_HREF_EXPANDURL)) {
// Don't expand relative URLs.
return href;
}
// Expand relative URLs.
try {
final URL url = page.getFullyQualifiedUrl(href);
return url.toExternalForm();
}
catch (final MalformedURLException e) {
// Log the error and fall through to the return values below.
LOG.warn(e.getMessage(), e);
}
}
}
// <style type="text/css"> ... </style>
if (version.hasFeature(BrowserVersionFeatures.STYLESHEET_HREF_STYLE_EMPTY)) {
return "";
}
else if (version.hasFeature(BrowserVersionFeatures.STYLESHEET_HREF_STYLE_NULL)) {
return null;
}
else {
final DomNode node = ownerNode_.getDomNodeOrDie();
final HtmlPage page = (HtmlPage) node.getPage();
final URL url = page.getWebResponse().getRequestSettings().getUrl();
return url.toExternalForm();
}
}
/**
* Inserts a new rule.
* @param rule the CSS rule
* @param position the position at which to insert the rule
* @see <a href="http://www.w3.org/TR/DOM-Level-2-Style/css.html#CSS-CSSStyleSheet">DOM level 2</a>
* @return the position of the inserted rule
*/
public int jsxFunction_insertRule(final String rule, final int position) {
return wrapped_.insertRule(rule.trim(), position);
}
/**
* Adds a new rule.
* @see <a href="http://msdn.microsoft.com/en-us/library/aa358796.aspx">MSDN</a>
* @param selector the selector name
* @param rule the rule
* @return always return -1 as of MSDN documentation
*/
public int jsxFunction_addRule(final String selector, final String rule) {
final String completeRule = selector.trim() + " {" + rule + "}";
wrapped_.insertRule(completeRule, wrapped_.getCssRules().getLength());
return -1;
}
/**
* Returns this stylesheet's URI (used to resolved contained @import rules).
* @return this stylesheet's URI (used to resolved contained @import rules)
*/
public String getUri() {
return uri_;
}
}