Java tutorial
/* * 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.httpclient; import java.util.ArrayList; import java.util.Calendar; import java.util.Collections; import java.util.Comparator; import java.util.Date; import java.util.List; import java.util.Locale; import org.apache.commons.lang3.StringUtils; import org.apache.http.FormattedHeader; import org.apache.http.Header; import org.apache.http.HeaderElement; import org.apache.http.NameValuePair; import org.apache.http.client.utils.DateUtils; import org.apache.http.cookie.Cookie; import org.apache.http.cookie.CookieAttributeHandler; import org.apache.http.cookie.CookieOrigin; import org.apache.http.cookie.CookiePathComparator; import org.apache.http.cookie.MalformedCookieException; import org.apache.http.cookie.SM; import org.apache.http.impl.cookie.BasicClientCookie; import org.apache.http.impl.cookie.BasicCommentHandler; import org.apache.http.impl.cookie.BasicMaxAgeHandler; import org.apache.http.impl.cookie.BasicSecureHandler; import org.apache.http.impl.cookie.CookieSpecBase; import org.apache.http.impl.cookie.NetscapeDraftHeaderParser; import org.apache.http.message.BasicHeader; import org.apache.http.message.BasicHeaderElement; import org.apache.http.message.BufferedHeader; import org.apache.http.message.ParserCursor; import org.apache.http.util.CharArrayBuffer; import com.gargoylesoftware.htmlunit.BrowserVersion; /** * Customized BrowserCompatSpec for HtmlUnit. * * Workaround for <a href="https://issues.apache.org/jira/browse/HTTPCLIENT-1006">HttpClient bug 1006</a>: * quotes are wrongly removed in cookie's values. * * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a> * @author Noboru Sinohara * @author David D. Kilzer * @author Marc Guillemot * @author Brad Clarke * @author Ahmed Ashour * @author Nicolas Belisle * @author Ronald Brill * @author John J Murdoch */ public class HtmlUnitBrowserCompatCookieSpec extends CookieSpecBase { /** The cookie name used for cookies with no name (HttpClient doesn't like empty names). */ public static final String EMPTY_COOKIE_NAME = "HTMLUNIT_EMPTY_COOKIE"; /** Workaround for domain of local files. */ public static final String LOCAL_FILESYSTEM_DOMAIN = "LOCAL_FILESYSTEM"; /** * Comparator for sending cookies in right order. * See specification: * - RFC2109 (#4.3.4) http://www.ietf.org/rfc/rfc2109.txt * - RFC2965 (#3.3.4) http://www.ietf.org/rfc/rfc2965.txt http://www.ietf.org/rfc/rfc2109.txt */ private static final Comparator<Cookie> COOKIE_COMPARATOR = new CookiePathComparator(); static final Date DATE_1_1_1970; static { final Calendar calendar = Calendar.getInstance(Locale.ROOT); calendar.setTimeZone(DateUtils.GMT); calendar.set(1970, Calendar.JANUARY, 1, 0, 0, 0); calendar.set(Calendar.MILLISECOND, 0); DATE_1_1_1970 = calendar.getTime(); } /** * Constructor. * * @param browserVersion the {@link BrowserVersion} to simulate */ public HtmlUnitBrowserCompatCookieSpec(final BrowserVersion browserVersion) { super(new HtmlUnitVersionAttributeHandler(), new HtmlUnitDomainHandler(), new HtmlUnitPathHandler(browserVersion), new BasicMaxAgeHandler(), new BasicSecureHandler(), new BasicCommentHandler(), new HtmlUnitExpiresHandler(browserVersion), new HtmlUnitHttpOnlyHandler()); } /** * {@inheritDoc} */ @Override public List<Cookie> parse(Header header, final CookieOrigin origin) throws MalformedCookieException { // first a hack to support empty headers final String text = header.getValue(); int endPos = text.indexOf(';'); if (endPos < 0) { endPos = text.indexOf('='); } else { final int pos = text.indexOf('='); if (pos > endPos) { endPos = -1; } else { endPos = pos; } } if (endPos < 0) { header = new BasicHeader(header.getName(), EMPTY_COOKIE_NAME + "=" + header.getValue()); } else if (endPos == 0 || StringUtils.isBlank(text.substring(0, endPos))) { header = new BasicHeader(header.getName(), EMPTY_COOKIE_NAME + header.getValue()); } final List<Cookie> cookies; final String headername = header.getName(); if (!headername.equalsIgnoreCase(SM.SET_COOKIE)) { throw new MalformedCookieException("Unrecognized cookie header '" + header.toString() + "'"); } final HeaderElement[] helems = header.getElements(); boolean versioned = false; boolean netscape = false; for (final HeaderElement helem : helems) { if (helem.getParameterByName("version") != null) { versioned = true; } if (helem.getParameterByName("expires") != null) { netscape = true; } } if (netscape || !versioned) { // Need to parse the header again, because Netscape style cookies do not correctly // support multiple header elements (comma cannot be treated as an element separator) final NetscapeDraftHeaderParser parser = NetscapeDraftHeaderParser.DEFAULT; final CharArrayBuffer buffer; final ParserCursor cursor; if (header instanceof FormattedHeader) { buffer = ((FormattedHeader) header).getBuffer(); cursor = new ParserCursor(((FormattedHeader) header).getValuePos(), buffer.length()); } else { final String s = header.getValue(); if (s == null) { throw new MalformedCookieException("Header value is null"); } buffer = new CharArrayBuffer(s.length()); buffer.append(s); cursor = new ParserCursor(0, buffer.length()); } final HeaderElement elem = parser.parseHeader(buffer, cursor); final String name = elem.getName(); final String value = elem.getValue(); if (name == null || name.isEmpty()) { throw new MalformedCookieException("Cookie name may not be empty"); } final BasicClientCookie cookie = new BasicClientCookie(name, value); cookie.setPath(getDefaultPath(origin)); cookie.setDomain(getDefaultDomain(origin)); // cycle through the parameters final NameValuePair[] attribs = elem.getParameters(); for (int j = attribs.length - 1; j >= 0; j--) { final NameValuePair attrib = attribs[j]; final String s = attrib.getName().toLowerCase(Locale.ROOT); cookie.setAttribute(s, attrib.getValue()); final CookieAttributeHandler handler = findAttribHandler(s); if (handler != null) { handler.parse(cookie, attrib.getValue()); } } // Override version for Netscape style cookies if (netscape) { cookie.setVersion(0); } cookies = Collections.<Cookie>singletonList(cookie); } else { cookies = parse(helems, origin); } for (final Cookie c : cookies) { // re-add quotes around value if parsing as incorrectly trimmed them if (header.getValue().contains(c.getName() + "=\"" + c.getValue())) { ((BasicClientCookie) c).setValue('"' + c.getValue() + '"'); } } return cookies; } @Override public List<Header> formatCookies(final List<Cookie> cookies) { Collections.sort(cookies, COOKIE_COMPARATOR); final CharArrayBuffer buffer = new CharArrayBuffer(20 * cookies.size()); buffer.append(SM.COOKIE); buffer.append(": "); for (int i = 0; i < cookies.size(); i++) { final Cookie cookie = cookies.get(i); if (i > 0) { buffer.append("; "); } final String cookieName = cookie.getName(); final String cookieValue = cookie.getValue(); if (cookie.getVersion() > 0 && !isQuoteEnclosed(cookieValue)) { HtmlUnitBrowserCompatCookieHeaderValueFormatter.INSTANCE.formatHeaderElement(buffer, new BasicHeaderElement(cookieName, cookieValue), false); } else { // Netscape style cookies do not support quoted values buffer.append(cookieName); buffer.append("="); if (cookieValue != null) { buffer.append(cookieValue); } } } final List<Header> headers = new ArrayList<>(1); headers.add(new BufferedHeader(buffer)); return headers; } private static boolean isQuoteEnclosed(final String s) { return s != null && s.length() > 1 && '\"' == s.charAt(0) && '\"' == s.charAt(s.length() - 1); } @Override public int getVersion() { return 0; } @Override public Header getVersionHeader() { return null; } @Override public String toString() { return "compatibility"; } }