/* * Copyright (C) 2014 The Android Open Source Project * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package java.net; import java.util.List; import java.util.StringTokenizer; import java.util.NoSuchElementException; import java.text.SimpleDateFormat; import java.util.TimeZone; import java.util.Calendar; import java.util.GregorianCalendar; import java.util.Date; import java.lang.NullPointerException; // for javadoc import java.util.Locale; import java.util.Objects; // ----- BEGIN android ----- import java.util.Set; import java.util.HashSet; // ----- END android ----- /** * An HttpCookie object represents an http cookie, which carries state * information between server and user agent. Cookie is widely adopted * to create stateful sessions. * *

There are 3 http cookie specifications: *

* Netscape draft
* RFC 2109 - * http://www.ietf.org/rfc/rfc2109.txt
* RFC 2965 - * http://www.ietf.org/rfc/rfc2965.txt *
* *

HttpCookie class can accept all these 3 forms of syntax. * * @author Edward Wang * @since 1.6 */ public final class HttpCookie implements Cloneable { // ----- BEGIN android ----- private static final Set RESERVED_NAMES = new HashSet(); static { RESERVED_NAMES.add("comment"); // RFC 2109 RFC 2965 RFC 6265 RESERVED_NAMES.add("commenturl"); // RFC 2965 RFC 6265 RESERVED_NAMES.add("discard"); // RFC 2965 RFC 6265 RESERVED_NAMES.add("domain"); // Netscape RFC 2109 RFC 2965 RFC 6265 RESERVED_NAMES.add("expires"); // Netscape RESERVED_NAMES.add("httponly"); // RFC 6265 RESERVED_NAMES.add("max-age"); // RFC 2109 RFC 2965 RFC 6265 RESERVED_NAMES.add("path"); // Netscape RFC 2109 RFC 2965 RFC 6265 RESERVED_NAMES.add("port"); // RFC 2965 RFC 6265 RESERVED_NAMES.add("secure"); // Netscape RFC 2109 RFC 2965 RFC 6265 RESERVED_NAMES.add("version"); // RFC 2109 RFC 2965 RFC 6265 } // ----- END android ----- /* ---------------- Fields -------------- */ // // The value of the cookie itself. // private String name; // NAME= ... "$Name" style is reserved private String value; // value of NAME // // Attributes encoded in the header's cookie fields. // private String comment; // Comment=VALUE ... describes cookie's use private String commentURL; // CommentURL="http URL" ... describes cookie's use private boolean toDiscard; // Discard ... discard cookie unconditionally private String domain; // Domain=VALUE ... domain that sees cookie private long maxAge = MAX_AGE_UNSPECIFIED; // Max-Age=VALUE ... cookies auto-expire private String path; // Path=VALUE ... URLs that see the cookie private String portlist; // Port[="portlist"] ... the port cookie may be returned to private boolean secure; // Secure ... e.g. use SSL private boolean httpOnly; // HttpOnly ... i.e. not accessible to scripts private int version = 1; // Version=1 ... RFC 2965 style /** * The original header this cookie was consructed from, if it was * constructed by parsing a header, otherwise null. * * @hide */ public final String header; // // Hold the creation time (in seconds) of the http cookie for later // expiration calculation // private long whenCreated = 0; // // Since the positive and zero max-age have their meanings, // this value serves as a hint as 'not specify max-age' // private final static long MAX_AGE_UNSPECIFIED = -1; // // date formats used by Netscape's cookie draft // as well as formats seen on various sites // private final static String[] COOKIE_DATE_FORMATS = { "EEE',' dd-MMM-yyyy HH:mm:ss 'GMT'", "EEE',' dd MMM yyyy HH:mm:ss 'GMT'", "EEE MMM dd yyyy HH:mm:ss 'GMT'Z", "EEE',' dd-MMM-yy HH:mm:ss 'GMT'", "EEE',' dd MMM yy HH:mm:ss 'GMT'", "EEE MMM dd yy HH:mm:ss 'GMT'Z" }; // // constant strings represent set-cookie header token // private final static String SET_COOKIE = "set-cookie:"; private final static String SET_COOKIE2 = "set-cookie2:"; /* ---------------- Ctors -------------- */ /** * Constructs a cookie with a specified name and value. * *

The name must conform to RFC 2965. That means it can contain * only ASCII alphanumeric characters and cannot contain commas, * semicolons, or white space or begin with a $ character. The cookie's * name cannot be changed after creation. * *

The value can be anything the server chooses to send. Its * value is probably of interest only to the server. The cookie's * value can be changed after creation with the * setValue method. * *

By default, cookies are created according to the RFC 2965 * cookie specification. The version can be changed with the * setVersion method. * * * @param name a String specifying the name of the cookie * * @param value a String specifying the value of the cookie * * @throws IllegalArgumentException if the cookie name contains illegal characters * or it is one of the tokens reserved for use * by the cookie protocol * @throws NullPointerException if name is null * @see #setValue * @see #setVersion * */ public HttpCookie(String name, String value) { this(name, value, null /*header*/); } private HttpCookie(String name, String value, String header) { name = name.trim(); if (name.length() == 0 || !isToken(name) || name.charAt(0) == '$') { throw new IllegalArgumentException("Illegal cookie name"); } this.name = name; this.value = value; toDiscard = false; secure = false; whenCreated = System.currentTimeMillis(); portlist = null; this.header = header; } /** * Constructs cookies from set-cookie or set-cookie2 header string. * RFC 2965 section 3.2.2 set-cookie2 syntax indicates that one header line * may contain more than one cookie definitions, so this is a static * utility method instead of another constructor. * * @param header a String specifying the set-cookie header. * The header should start with "set-cookie", or "set-cookie2" * token; or it should have no leading token at all. * @return a List of cookie parsed from header line string * @throws IllegalArgumentException if header string violates the cookie * specification's syntax, or the cookie * name contains llegal characters, or * the cookie name is one of the tokens * reserved for use by the cookie protocol * @throws NullPointerException if the header string is null */ public static List parse(String header) { return parse(header, false); } // Private version of parse() that will store the original header used to // create the cookie, in the cookie itself. This can be useful for filtering // Set-Cookie[2] headers, using the internal parsing logic defined in this // class. /** * @hide */ public static List parse(String header, boolean retainHeader) { int version = guessCookieVersion(header); // if header start with set-cookie or set-cookie2, strip it off if (startsWithIgnoreCase(header, SET_COOKIE2)) { header = header.substring(SET_COOKIE2.length()); } else if (startsWithIgnoreCase(header, SET_COOKIE)) { header = header.substring(SET_COOKIE.length()); } List cookies = new java.util.ArrayList(); // The Netscape cookie may have a comma in its expires attribute, // while the comma is the delimiter in rfc 2965/2109 cookie header string. // so the parse logic is slightly different if (version == 0) { // Netscape draft cookie HttpCookie cookie = parseInternal(header, retainHeader); cookie.setVersion(0); cookies.add(cookie); } else { // rfc2965/2109 cookie // if header string contains more than one cookie, // it'll separate them with comma List cookieStrings = splitMultiCookies(header); for (String cookieStr : cookieStrings) { HttpCookie cookie = parseInternal(cookieStr, retainHeader); cookie.setVersion(1); cookies.add(cookie); } } return cookies; } /* ---------------- Public operations -------------- */ /** * Reports whether this http cookie has expired or not. * * @return true to indicate this http cookie has expired; * otherwise, false */ public boolean hasExpired() { if (maxAge == 0) return true; // if not specify max-age, this cookie should be // discarded when user agent is to be closed, but // it is not expired. if (maxAge == MAX_AGE_UNSPECIFIED) return false; long deltaSecond = (System.currentTimeMillis() - whenCreated) / 1000; if (deltaSecond > maxAge) return true; else return false; } /** * * Specifies a comment that describes a cookie's purpose. * The comment is useful if the browser presents the cookie * to the user. Comments * are not supported by Netscape Version 0 cookies. * * @param purpose a String specifying the comment * to display to the user * * @see #getComment * */ public void setComment(String purpose) { comment = purpose; } /** * Returns the comment describing the purpose of this cookie, or * null if the cookie has no comment. * * @return a String containing the comment, * or null if none * * @see #setComment * */ public String getComment() { return comment; } /** * * Specifies a comment url that describes a cookie's purpose. * The comment url is useful if the browser presents the cookie * to the user. Comment url is RFC 2965 only. * * @param purpose a String specifying the comment url * to display to the user * * @see #getCommentURL * */ public void setCommentURL(String purpose) { commentURL = purpose; } /** * Returns the comment url describing the purpose of this cookie, or * null if the cookie has no comment url. * * @return a String containing the comment url, * or null if none * * @see #setCommentURL * */ public String getCommentURL() { return commentURL; } /** * Specify whether user agent should discard the cookie unconditionally. * This is RFC 2965 only attribute. * * @param discard true indicates to discard cookie unconditionally * * @see #getDiscard */ public void setDiscard(boolean discard) { toDiscard = discard; } /** * Return the discard attribute of the cookie * * @return a boolean to represent this cookie's discard attribute * * @see #setDiscard */ public boolean getDiscard() { return toDiscard; } /** * Specify the portlist of the cookie, which restricts the port(s) * to which a cookie may be sent back in a Cookie header. * * @param ports a String specify the port list, which is * comma seperated series of digits * @see #getPortlist */ public void setPortlist(String ports) { portlist = ports; } /** * Return the port list attribute of the cookie * * @return a String contains the port list * or null if none * @see #setPortlist */ public String getPortlist() { return portlist; } /** * * Specifies the domain within which this cookie should be presented. * *

The form of the domain name is specified by RFC 2965. A domain * name begins with a dot (.foo.com) and means that * the cookie is visible to servers in a specified Domain Name System * (DNS) zone (for example, www.foo.com, but not * a.b.foo.com). By default, cookies are only returned * to the server that sent them. * * * @param pattern a String containing the domain name * within which this cookie is visible; * form is according to RFC 2965 * * @see #getDomain * */ public void setDomain(String pattern) { if (pattern != null) domain = pattern.toLowerCase(); else domain = pattern; } /** * Returns the domain name set for this cookie. The form of * the domain name is set by RFC 2965. * * @return a String containing the domain name * * @see #setDomain * */ public String getDomain() { return domain; } /** * Sets the maximum age of the cookie in seconds. * *

A positive value indicates that the cookie will expire * after that many seconds have passed. Note that the value is * the maximum age when the cookie will expire, not the cookie's * current age. * *

A negative value means * that the cookie is not stored persistently and will be deleted * when the Web browser exits. A zero value causes the cookie * to be deleted. * * @param expiry an integer specifying the maximum age of the * cookie in seconds; if zero, the cookie * should be discarded immediately; * otherwise, the cookie's max age is unspecified. * * @see #getMaxAge * */ public void setMaxAge(long expiry) { maxAge = expiry; } /** * Returns the maximum age of the cookie, specified in seconds. * By default, -1 indicating the cookie will persist * until browser shutdown. * * * @return an integer specifying the maximum age of the * cookie in seconds * * * @see #setMaxAge * */ public long getMaxAge() { return maxAge; } /** * Specifies a path for the cookie * to which the client should return the cookie. * *

The cookie is visible to all the pages in the directory * you specify, and all the pages in that directory's subdirectories. * A cookie's path must include the servlet that set the cookie, * for example, /catalog, which makes the cookie * visible to all directories on the server under /catalog. * *

Consult RFC 2965 (available on the Internet) for more * information on setting path names for cookies. * * * @param uri a String specifying a path * * * @see #getPath * */ public void setPath(String uri) { path = uri; } /** * Returns the path on the server * to which the browser returns this cookie. The * cookie is visible to all subpaths on the server. * * * @return a String specifying a path that contains * a servlet name, for example, /catalog * * @see #setPath * */ public String getPath() { return path; } /** * Indicates whether the cookie should only be sent using a secure protocol, * such as HTTPS or SSL. * *

The default value is false. * * @param flag If true, the cookie can only be sent over * a secure protocol like https. * If false, it can be sent over any protocol. * * @see #getSecure * */ public void setSecure(boolean flag) { secure = flag; } /** * Returns true if sending this cookie should be * restricted to a secure protocol, or false if the * it can be sent using any protocol. * * @return false if the cookie can be sent over * any standard protocol; otherwise, true * * @see #setSecure * */ public boolean getSecure() { return secure; } /** * Returns the name of the cookie. The name cannot be changed after * creation. * * @return a String specifying the cookie's name * */ public String getName() { return name; } /** * * Assigns a new value to a cookie after the cookie is created. * If you use a binary value, you may want to use BASE64 encoding. * *

With Version 0 cookies, values should not contain white * space, brackets, parentheses, equals signs, commas, * double quotes, slashes, question marks, at signs, colons, * and semicolons. Empty values may not behave the same way * on all browsers. * * @param newValue a String specifying the new value * * * @see #getValue * */ public void setValue(String newValue) { value = newValue; } /** * Returns the value of the cookie. * * @return a String containing the cookie's * present value * * @see #setValue * */ public String getValue() { return value; } /** * Returns the version of the protocol this cookie complies * with. Version 1 complies with RFC 2965/2109, * and version 0 complies with the original * cookie specification drafted by Netscape. Cookies provided * by a browser use and identify the browser's cookie version. * * * @return 0 if the cookie complies with the * original Netscape specification; 1 * if the cookie complies with RFC 2965/2109 * * @see #setVersion * */ public int getVersion() { return version; } /** * Sets the version of the cookie protocol this cookie complies * with. Version 0 complies with the original Netscape cookie * specification. Version 1 complies with RFC 2965/2109. * * * @param v 0 if the cookie should comply with * the original Netscape specification; * 1 if the cookie should comply with RFC 2965/2109 * * @throws IllegalArgumentException if v is neither 0 nor 1 * * @see #getVersion * */ public void setVersion(int v) { if (v != 0 && v != 1) { throw new IllegalArgumentException("cookie version should be 0 or 1"); } version = v; } /** * Returns {@code true} if this cookie contains the HttpOnly * attribute. This means that the cookie should not be accessible to * scripting engines, like javascript. * * @return {@code true} if this cookie should be considered http only. * @see #setHttpOnly(boolean) */ public boolean isHttpOnly() { return httpOnly; } /** * Indicates whether the cookie should be considered HTTP Only. If set to * {@code true} it means the cookie should not be accessible to scripting * engines like javascript. * * @param httpOnly if {@code true} make the cookie HTTP only, i.e. * only visible as part of an HTTP request. * @see #isHttpOnly() */ public void setHttpOnly(boolean httpOnly) { this.httpOnly = httpOnly; } /** * The utility method to check whether a host name is in a domain * or not. * *

This concept is described in the cookie specification. * To understand the concept, some terminologies need to be defined first: *

* effective host name = hostname if host name contains dot
*                  or = hostname.local if not *
*

Host A's name domain-matches host B's if: *

* *

A host isn't in a domain (RFC 2965 sec. 3.3.2) if: *

* *

Examples: *

* * @param domain the domain name to check host name with * @param host the host name in question * @return true if they domain-matches; false if not */ public static boolean domainMatches(String domain, String host) { if (domain == null || host == null) return false; // if there's no embedded dot in domain and domain is not .local boolean isLocalDomain = ".local".equalsIgnoreCase(domain); int embeddedDotInDomain = domain.indexOf('.'); if (embeddedDotInDomain == 0) embeddedDotInDomain = domain.indexOf('.', 1); if (!isLocalDomain && (embeddedDotInDomain == -1 || embeddedDotInDomain == domain.length() - 1)) return false; // if the host name contains no dot and the domain name is .local int firstDotInHost = host.indexOf('.'); if (firstDotInHost == -1 && isLocalDomain) return true; int domainLength = domain.length(); int lengthDiff = host.length() - domainLength; if (lengthDiff == 0) { // if the host name and the domain name are just string-compare euqal return host.equalsIgnoreCase(domain); } else if (lengthDiff > 0) { // need to check H & D component String H = host.substring(0, lengthDiff); String D = host.substring(lengthDiff); // ----- BEGIN android ----- //return (H.indexOf('.') == -1 && D.equalsIgnoreCase(domain)); return D.equalsIgnoreCase(domain) && ((domain.startsWith(".") && isFullyQualifiedDomainName(domain, 1)) || isLocalDomain); // ----- END android ----- } else if (lengthDiff == -1) { // if domain is actually .host return (domain.charAt(0) == '.' && host.equalsIgnoreCase(domain.substring(1))); } return false; } // ----- BEGIN android ----- private static boolean isFullyQualifiedDomainName(String s, int firstCharacter) { int dotPosition = s.indexOf('.', firstCharacter + 1); return dotPosition != -1 && dotPosition < s.length() - 1; } // ----- END android ----- /** * Constructs a cookie header string representation of this cookie, * which is in the format defined by corresponding cookie specification, * but without the leading "Cookie:" token. * * @return a string form of the cookie. The string has the defined format */ @Override public String toString() { if (getVersion() > 0) { return toRFC2965HeaderString(); } else { return toNetscapeHeaderString(); } } /** * Test the equality of two http cookies. * *

The result is true only if two cookies * come from same domain (case-insensitive), * have same name (case-insensitive), * and have same path (case-sensitive). * * @return true if 2 http cookies equal to each other; * otherwise, false */ @Override public boolean equals(Object obj) { if (obj == this) return true; if (!(obj instanceof HttpCookie)) return false; HttpCookie other = (HttpCookie)obj; // One http cookie equals to another cookie (RFC 2965 sec. 3.3.3) if: // 1. they come from same domain (case-insensitive), // 2. have same name (case-insensitive), // 3. and have same path (case-sensitive). return equalsIgnoreCase(getName(), other.getName()) && equalsIgnoreCase(getDomain(), other.getDomain()) && Objects.equals(getPath(), other.getPath()); } /** * Return hash code of this http cookie. The result is the sum of * hash code value of three significant components of this cookie: * name, domain, and path. * That is, the hash code is the value of the expression: *

* getName().toLowerCase().hashCode()
* + getDomain().toLowerCase().hashCode()
* + getPath().hashCode() *
* * @return this http cookie's hash code */ @Override public int hashCode() { int h1 = name.toLowerCase().hashCode(); int h2 = (domain!=null) ? domain.toLowerCase().hashCode() : 0; int h3 = (path!=null) ? path.hashCode() : 0; return h1 + h2 + h3; } /** * Create and return a copy of this object. * * @return a clone of this http cookie */ @Override public Object clone() { try { return super.clone(); } catch (CloneNotSupportedException e) { throw new RuntimeException(e.getMessage()); } } /* ---------------- Private operations -------------- */ // Note -- disabled for now to allow full Netscape compatibility // from RFC 2068, token special case characters // // private static final String tspecials = "()<>@,;:\\\"/[]?={} \t"; // ----- BEGIN android ----- // private static final String tspecials = ",;"; private static final String tspecials = ",;= \t"; // ----- END android ----- /* * Tests a string and returns true if the string counts as a * token. * * @param value the String to be tested * * @return true if the String is * a token; false if it is not */ private static boolean isToken(String value) { // ----- BEGIN android ----- if (RESERVED_NAMES.contains(value.toLowerCase(Locale.US))) { return false; } // ----- END android ----- int len = value.length(); for (int i = 0; i < len; i++) { char c = value.charAt(i); if (c < 0x20 || c >= 0x7f || tspecials.indexOf(c) != -1) return false; } return true; } /* * Parse header string to cookie object. * * @param header header string; should contain only one NAME=VALUE pair * * @return an HttpCookie being extracted * * @throws IllegalArgumentException if header string violates the cookie * specification */ private static HttpCookie parseInternal(String header, boolean retainHeader) { HttpCookie cookie = null; String namevaluePair = null; StringTokenizer tokenizer = new StringTokenizer(header, ";"); // there should always have at least on name-value pair; // it's cookie's name try { namevaluePair = tokenizer.nextToken(); int index = namevaluePair.indexOf('='); if (index != -1) { String name = namevaluePair.substring(0, index).trim(); String value = namevaluePair.substring(index + 1).trim(); if (retainHeader) cookie = new HttpCookie(name, stripOffSurroundingQuote(value), header); else cookie = new HttpCookie(name, stripOffSurroundingQuote(value)); } else { // no "=" in name-value pair; it's an error throw new IllegalArgumentException("Invalid cookie name-value pair"); } } catch (NoSuchElementException ignored) { throw new IllegalArgumentException("Empty cookie header string"); } // remaining name-value pairs are cookie's attributes while (tokenizer.hasMoreTokens()) { namevaluePair = tokenizer.nextToken(); int index = namevaluePair.indexOf('='); String name, value; if (index != -1) { name = namevaluePair.substring(0, index).trim(); value = namevaluePair.substring(index + 1).trim(); } else { name = namevaluePair.trim(); value = null; } // assign attribute to cookie assignAttribute(cookie, name, value); } return cookie; } /* * assign cookie attribute value to attribute name; * use a map to simulate method dispatch */ static interface CookieAttributeAssignor { public void assign(HttpCookie cookie, String attrName, String attrValue); } static java.util.Map assignors = null; static { assignors = new java.util.HashMap(); assignors.put("comment", new CookieAttributeAssignor(){ public void assign(HttpCookie cookie, String attrName, String attrValue) { if (cookie.getComment() == null) cookie.setComment(attrValue); } }); assignors.put("commenturl", new CookieAttributeAssignor(){ public void assign(HttpCookie cookie, String attrName, String attrValue) { if (cookie.getCommentURL() == null) cookie.setCommentURL(attrValue); } }); assignors.put("discard", new CookieAttributeAssignor(){ public void assign(HttpCookie cookie, String attrName, String attrValue) { cookie.setDiscard(true); } }); assignors.put("domain", new CookieAttributeAssignor(){ public void assign(HttpCookie cookie, String attrName, String attrValue) { if (cookie.getDomain() == null) cookie.setDomain(attrValue); } }); assignors.put("max-age", new CookieAttributeAssignor(){ public void assign(HttpCookie cookie, String attrName, String attrValue) { try { long maxage = Long.parseLong(attrValue); if (cookie.getMaxAge() == MAX_AGE_UNSPECIFIED) cookie.setMaxAge(maxage); } catch (NumberFormatException ignored) { throw new IllegalArgumentException("Illegal cookie max-age attribute"); } } }); assignors.put("path", new CookieAttributeAssignor(){ public void assign(HttpCookie cookie, String attrName, String attrValue) { if (cookie.getPath() == null) cookie.setPath(attrValue); } }); assignors.put("port", new CookieAttributeAssignor(){ public void assign(HttpCookie cookie, String attrName, String attrValue) { if (cookie.getPortlist() == null) cookie.setPortlist(attrValue == null ? "" : attrValue); } }); assignors.put("secure", new CookieAttributeAssignor(){ public void assign(HttpCookie cookie, String attrName, String attrValue) { cookie.setSecure(true); } }); assignors.put("httponly", new CookieAttributeAssignor(){ public void assign(HttpCookie cookie, String attrName, String attrValue) { cookie.setHttpOnly(true); } }); assignors.put("version", new CookieAttributeAssignor(){ public void assign(HttpCookie cookie, String attrName, String attrValue) { try { int version = Integer.parseInt(attrValue); cookie.setVersion(version); } catch (NumberFormatException ignored) { // Just ignore bogus version, it will default to 0 or 1 } } }); assignors.put("expires", new CookieAttributeAssignor(){ // Netscape only public void assign(HttpCookie cookie, String attrName, String attrValue) { if (cookie.getMaxAge() == MAX_AGE_UNSPECIFIED) { cookie.setMaxAge(cookie.expiryDate2DeltaSeconds(attrValue)); } } }); } private static void assignAttribute(HttpCookie cookie, String attrName, String attrValue) { // strip off the surrounding "-sign if there's any attrValue = stripOffSurroundingQuote(attrValue); CookieAttributeAssignor assignor = assignors.get(attrName.toLowerCase()); if (assignor != null) { assignor.assign(cookie, attrName, attrValue); } else { // Ignore the attribute as per RFC 2965 } } /* * Returns the original header this cookie was consructed from, if it was * constructed by parsing a header, otherwise null. */ private String header() { return header; } /* * Constructs a string representation of this cookie. The string format is * as Netscape spec, but without leading "Cookie:" token. */ private String toNetscapeHeaderString() { StringBuilder sb = new StringBuilder(); sb.append(getName() + "=" + getValue()); return sb.toString(); } /* * Constructs a string representation of this cookie. The string format is * as RFC 2965/2109, but without leading "Cookie:" token. */ private String toRFC2965HeaderString() { StringBuilder sb = new StringBuilder(); sb.append(getName()).append("=\"").append(getValue()).append('"'); if (getPath() != null) sb.append(";$Path=\"").append(getPath()).append('"'); if (getDomain() != null) sb.append(";$Domain=\"").append(getDomain()).append('"'); if (getPortlist() != null) sb.append(";$Port=\"").append(getPortlist()).append('"'); return sb.toString(); } static final TimeZone GMT = TimeZone.getTimeZone("GMT"); /* * @param dateString a date string in one of the formats * defined in Netscape cookie spec * * @return delta seconds between this cookie's creation * time and the time specified by dateString */ private long expiryDate2DeltaSeconds(String dateString) { Calendar cal = new GregorianCalendar(GMT); for (int i = 0; i < COOKIE_DATE_FORMATS.length; i++) { SimpleDateFormat df = new SimpleDateFormat(COOKIE_DATE_FORMATS[i], Locale.US); cal.set(1970, 0, 1, 0, 0, 0); df.setTimeZone(GMT); df.setLenient(false); df.set2DigitYearStart(cal.getTime()); try { cal.setTime(df.parse(dateString)); if (!COOKIE_DATE_FORMATS[i].contains("yyyy")) { // 2-digit years following the standard set // out it rfc 6265 int year = cal.get(Calendar.YEAR); year %= 100; if (year < 70) { year += 2000; } else { year += 1900; } cal.set(Calendar.YEAR, year); } return (cal.getTimeInMillis() - whenCreated) / 1000; } catch (Exception e) { // Ignore, try the next date format } } return 0; } /* * try to guess the cookie version through set-cookie header string */ private static int guessCookieVersion(String header) { int version = 0; header = header.toLowerCase(); if (header.indexOf("expires=") != -1) { // only netscape cookie using 'expires' version = 0; } else if (header.indexOf("version=") != -1) { // version is mandatory for rfc 2965/2109 cookie version = 1; } else if (header.indexOf("max-age") != -1) { // rfc 2965/2109 use 'max-age' version = 1; } else if (startsWithIgnoreCase(header, SET_COOKIE2)) { // only rfc 2965 cookie starts with 'set-cookie2' version = 1; } return version; } private static String stripOffSurroundingQuote(String str) { if (str != null && str.length() > 2 && str.charAt(0) == '"' && str.charAt(str.length() - 1) == '"') { return str.substring(1, str.length() - 1); } if (str != null && str.length() > 2 && str.charAt(0) == '\'' && str.charAt(str.length() - 1) == '\'') { return str.substring(1, str.length() - 1); } return str; } private static boolean equalsIgnoreCase(String s, String t) { if (s == t) return true; if ((s != null) && (t != null)) { return s.equalsIgnoreCase(t); } return false; } private static boolean startsWithIgnoreCase(String s, String start) { if (s == null || start == null) return false; if (s.length() >= start.length() && start.equalsIgnoreCase(s.substring(0, start.length()))) { return true; } return false; } /* * Split cookie header string according to rfc 2965: * 1) split where it is a comma; * 2) but not the comma surrounding by double-quotes, which is the comma * inside port list or embeded URIs. * * @param header the cookie header string to split * * @return list of strings; never null * */ private static List splitMultiCookies(String header) { List cookies = new java.util.ArrayList(); int quoteCount = 0; int p, q; for (p = 0, q = 0; p < header.length(); p++) { char c = header.charAt(p); if (c == '"') quoteCount++; if (c == ',' && (quoteCount % 2 == 0)) { // it is comma and not surrounding by double-quotes cookies.add(header.substring(q, p)); q = p + 1; } } cookies.add(header.substring(q)); return cookies; } }