/**
* Copyright 2005-2011 Noelios Technologies.
*
* The contents of this file are subject to the terms of one of the following
* open source licenses: LGPL 3.0 or LGPL 2.1 or CDDL 1.0 or EPL 1.0 (the
* "Licenses"). You can select the license that you prefer but you may not use
* this file except in compliance with one of these Licenses.
*
* You can obtain a copy of the LGPL 3.0 license at
* http://www.opensource.org/licenses/lgpl-3.0.html
*
* You can obtain a copy of the LGPL 2.1 license at
* http://www.opensource.org/licenses/lgpl-2.1.php
*
* You can obtain a copy of the CDDL 1.0 license at
* http://www.opensource.org/licenses/cddl1.php
*
* You can obtain a copy of the EPL 1.0 license at
* http://www.opensource.org/licenses/eclipse-1.0.php
*
* See the Licenses for the specific language governing permissions and
* limitations under the Licenses.
*
* Alternatively, you can obtain a royalty free commercial license with less
* limitations, transferable or non-transferable, directly at
* http://www.noelios.com/products/restlet-engine
*
* Restlet is a registered trademark of Noelios Technologies.
*/
package org.restlet.client.engine.header;
import java.io.IOException;
import org.restlet.client.data.Cookie;
import org.restlet.client.data.Parameter;
/**
* Cookie header reader.
*
* @author Jerome Louvel
*/
public class CookieReader extends HeaderReader<Cookie> {
private static final String NAME_DOMAIN = "$Domain";
private static final String NAME_PATH = "$Path";
private static final String NAME_VERSION = "$Version";
/**
* Parses the given String to a Cookie
*
* @param cookie
* @return the Cookie parsed from the String
* @throws IllegalArgumentException
* Thrown if the String can not be parsed as Cookie.
*/
public static Cookie read(String cookie) throws IllegalArgumentException {
CookieReader cr = new CookieReader(cookie);
try {
return cr.readValue();
} catch (IOException e) {
throw new IllegalArgumentException("Could not read the cookie", e);
}
}
/** The global cookie specification version. */
private volatile int globalVersion;
/**
* Constructor.
*
* @param header
* The header to read.
*/
public CookieReader(String header) {
super(header);
this.globalVersion = -1;
}
/**
* Reads the next pair as a parameter.
*
* @param readAttribute
* True, if the intention is to read only cookie attribute.
* @return The next pair as a parameter.
* @throws IOException
*/
private Parameter readPair(boolean readAttribute) throws IOException {
Parameter result = null;
boolean readingName = true;
boolean readingValue = false;
StringBuilder nameBuffer = new StringBuilder();
StringBuilder valueBuffer = new StringBuilder();
int nextChar = 0;
while ((result == null) && (nextChar != -1)) {
nextChar = read();
if (readingName) {
if ((HeaderUtils.isSpace(nextChar))
&& (nameBuffer.length() == 0)) {
// Skip spaces
} else if ((nextChar == -1) || (nextChar == ';')
|| (nextChar == ',')) {
if (nameBuffer.length() > 0) {
// End of pair with no value
result = Parameter.create(nameBuffer, null);
} else if (nextChar == -1) {
// Do nothing return null preference
} else {
throw new IOException(
"Empty cookie name detected. Please check your cookies");
}
} else if (nextChar == '=') {
readingName = false;
readingValue = true;
} else if (HeaderUtils.isTokenChar(nextChar)
|| (this.globalVersion < 1)) {
if (readAttribute && nextChar != '$'
&& (nameBuffer.length() == 0)) {
unread();
nextChar = -1;
} else {
nameBuffer.append((char) nextChar);
}
} else {
throw new IOException(
"Separator and control characters are not allowed within a token. Please check your cookie header");
}
} else if (readingValue) {
if ((HeaderUtils.isSpace(nextChar))
&& (valueBuffer.length() == 0)) {
// Skip spaces
} else if ((nextChar == -1) || (nextChar == ';')) {
// End of pair
result = Parameter.create(nameBuffer, valueBuffer);
} else if ((nextChar == '"') && (valueBuffer.length() == 0)) {
// Step back
unread();
valueBuffer.append(readQuotedString());
} else if (HeaderUtils.isTokenChar(nextChar)
|| (this.globalVersion < 1)) {
valueBuffer.append((char) nextChar);
} else {
throw new IOException(
"Separator and control characters are not allowed within a token. Please check your cookie header");
}
}
}
return result;
}
@Override
public Cookie readValue() throws IOException {
Cookie result = null;
Parameter pair = readPair(false);
if (this.globalVersion == -1) {
// Cookies version not yet detected
if (pair.getName().equalsIgnoreCase(NAME_VERSION)) {
if (pair.getValue() != null) {
this.globalVersion = Integer.parseInt(pair.getValue());
} else {
throw new IOException(
"Empty cookies version attribute detected. Please check your cookie header");
}
} else {
// Set the default version for old Netscape cookies
this.globalVersion = 0;
}
}
while ((pair != null) && (pair.getName().charAt(0) == '$')) {
// Unexpected special attribute
// Silently ignore it as it may have been introduced by new
// specifications
pair = readPair(false);
}
if (pair != null) {
// Set the cookie name and value
result = new Cookie(this.globalVersion, pair.getName(), pair
.getValue());
pair = readPair(true);
}
while ((pair != null) && (pair.getName().charAt(0) == '$')) {
if (pair.getName().equalsIgnoreCase(NAME_PATH)) {
result.setPath(pair.getValue());
} else if (pair.getName().equalsIgnoreCase(NAME_DOMAIN)) {
result.setDomain(pair.getValue());
} else {
// Unexpected special attribute
// Silently ignore it as it may have been introduced by new
// specifications
}
pair = readPair(true);
}
return result;
}
}