/**
* 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.util;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import org.restlet.client.Context;
import org.restlet.client.data.CharacterSet;
import org.restlet.client.data.Form;
import org.restlet.client.data.Parameter;
import org.restlet.client.representation.Representation;
import org.restlet.client.util.Series;
/**
* Form reader.
*
* @author Jerome Louvel
*/
public class FormReader {
/** The encoding to use, decoding is enabled, see {@link #decoding}. */
private volatile CharacterSet characterSet;
/** Indicates if the parameters should be decoded. */
private volatile boolean decoding;
/** The form stream. */
private volatile InputStream stream;
/** The separator character used between parameters. */
private volatile char separator;
/**
* Constructor.<br>
* In case the representation does not define a character set, the UTF-8
* character set is used.
*
* @param representation
* The web form content.
* @throws IOException
* if the stream of the representation could not be opened.
*/
public FormReader(Representation representation) throws IOException {
this.decoding = true;
this.stream = representation.getStream();
this.separator = '&';
if (representation.getCharacterSet() != null) {
this.characterSet = representation.getCharacterSet();
} else {
this.characterSet = CharacterSet.UTF_8;
}
}
/**
* Constructor. Will leave the parsed data encoded.
*
* @param parametersString
* The parameters string.
*/
public FormReader(String parametersString, char separator) {
this.decoding = false;
this.stream = new org.restlet.client.engine.io.StringInputStream(parametersString);
this.characterSet = null;
this.separator = separator;
}
/**
* Constructor.
*
* @param parametersString
* The parameters string.
* @param characterSet
* The supported character encoding. Set to null to leave the
* data encoded.
*/
public FormReader(String parametersString, CharacterSet characterSet,
char separator) {
this.decoding = true;
this.stream = new org.restlet.client.engine.io.StringInputStream(parametersString);
this.characterSet = characterSet;
this.separator = separator;
}
/**
* Adds the parameters into a given form.
*
* @param form
* The target form.
*/
public void addParameters(Form form) {
boolean readNext = true;
Parameter param = null;
if (this.stream != null) {
// Let's read all form parameters
try {
while (readNext) {
param = readNextParameter();
if (param != null) {
// Add parsed parameter to the form
form.add(param);
} else {
// Last parameter parsed
readNext = false;
}
}
} catch (IOException ioe) {
Context.getCurrentLogger()
.log(Level.WARNING,
"Unable to parse a form parameter. Skipping the remaining parameters.",
ioe);
}
try {
this.stream.close();
} catch (IOException ioe) {
Context.getCurrentLogger().log(Level.WARNING,
"Unable to close the form input stream", ioe);
}
}
}
/**
* Reads all the parameters.
*
* @return The form read.
* @throws IOException
* If the parameters could not be read.
*/
public Form read() throws IOException {
final Form result = new Form();
Parameter param = readNextParameter();
while (param != null) {
result.add(param);
param = readNextParameter();
}
this.stream.close();
return result;
}
/**
* Reads the first parameter with the given name.
*
* @param name
* The parameter name to match.
* @return The parameter value.
* @throws IOException
*/
public Parameter readFirstParameter(String name) throws IOException {
Parameter param = readNextParameter();
Parameter result = null;
while ((param != null) && (result == null)) {
if (param.getName().equals(name)) {
result = param;
}
param = readNextParameter();
}
this.stream.close();
return result;
}
/**
* Reads the next parameter available or null.
*
* @return The next parameter available or null.
* @throws IOException
* If the next parameter could not be read.
*/
public Parameter readNextParameter() throws IOException {
Parameter result = null;
try {
boolean readingName = true;
boolean readingValue = false;
final StringBuilder nameBuffer = new StringBuilder();
final StringBuilder valueBuffer = new StringBuilder();
int nextChar = 0;
while ((result == null) && (nextChar != -1)) {
nextChar = this.stream.read();
if (readingName) {
if (nextChar == '=') {
if (nameBuffer.length() > 0) {
readingName = false;
readingValue = true;
} else {
throw new IOException(
"Empty parameter name detected. Please check your form data");
}
} else if ((nextChar == this.separator) || (nextChar == -1)) {
if (nameBuffer.length() > 0) {
result = FormUtils.create(nameBuffer, null,
this.decoding, this.characterSet);
} else if (nextChar == -1) {
// Do nothing return null preference
} else {
Context.getCurrentLogger()
.fine("Empty parameter name detected. Please check your form data");
}
} else {
nameBuffer.append((char) nextChar);
}
} else if (readingValue) {
if ((nextChar == this.separator) || (nextChar == -1)) {
if (valueBuffer.length() > 0) {
result = FormUtils.create(nameBuffer, valueBuffer,
this.decoding, this.characterSet);
} else {
result = FormUtils.create(nameBuffer, null,
this.decoding, this.characterSet);
}
} else {
valueBuffer.append((char) nextChar);
}
}
}
} catch (UnsupportedEncodingException uee) {
throw new IOException(
"Unsupported encoding. Please contact the administrator");
}
return result;
}
/**
* Reads the parameters with the given name. If multiple values are found, a
* list is returned created.
*
* @param name
* The parameter name to match.
* @return The parameter value or list of values.
* @throws IOException
* If the parameters could not be read.
*/
@SuppressWarnings("unchecked")
public Object readParameter(String name) throws IOException {
Parameter param = readNextParameter();
Object result = null;
while (param != null) {
if (param.getName().equals(name)) {
if (result != null) {
List<Object> values = null;
if (result instanceof List) {
// Multiple values already found for this parameter
values = (List<Object>) result;
} else {
// Second value found for this parameter
// Create a list of values
values = new ArrayList<Object>();
values.add(result);
result = values;
}
if (param.getValue() == null) {
values.add(Series.EMPTY_VALUE);
} else {
values.add(param.getValue());
}
} else {
if (param.getValue() == null) {
result = Series.EMPTY_VALUE;
} else {
result = param.getValue();
}
}
}
param = readNextParameter();
}
this.stream.close();
return result;
}
/**
* Reads the parameters whose name is a key in the given map. If a matching
* parameter is found, its value is put in the map. If multiple values are
* found, a list is created and set in the map.
*
* @param parameters
* The parameters map controlling the reading.
* @throws IOException
* If the parameters could not be read.
*/
@SuppressWarnings("unchecked")
public void readParameters(Map<String, Object> parameters)
throws IOException {
Parameter param = readNextParameter();
Object currentValue = null;
while (param != null) {
if (parameters.containsKey(param.getName())) {
currentValue = parameters.get(param.getName());
if (currentValue != null) {
List<Object> values = null;
if (currentValue instanceof List) {
// Multiple values already found for this parameter
values = (List<Object>) currentValue;
} else {
// Second value found for this parameter
// Create a list of values
values = new ArrayList<Object>();
values.add(currentValue);
parameters.put(param.getName(), values);
}
if (param.getValue() == null) {
values.add(Series.EMPTY_VALUE);
} else {
values.add(param.getValue());
}
} else {
if (param.getValue() == null) {
parameters.put(param.getName(), Series.EMPTY_VALUE);
} else {
parameters.put(param.getName(), param.getValue());
}
}
}
param = readNextParameter();
}
this.stream.close();
}
}