Author: toad
Date: 2006-05-12 16:43:54 +0000 (Fri, 12 May 2006)
New Revision: 8679
Added:
trunk/freenet/src/freenet/clients/http/HTTPRequest.java
Removed:
trunk/freenet/src/freenet/pluginmanager/HTTPRequest.java
Modified:
trunk/freenet/src/freenet/clients/http/ConfigToadlet.java
trunk/freenet/src/freenet/clients/http/DarknetConnectionsToadlet.java
trunk/freenet/src/freenet/clients/http/FproxyToadlet.java
trunk/freenet/src/freenet/clients/http/QueueToadlet.java
trunk/freenet/src/freenet/clients/http/WelcomeToadlet.java
trunk/freenet/src/freenet/clients/http/filter/GenericReadFilterCallback.java
trunk/freenet/src/freenet/node/Version.java
trunk/freenet/src/freenet/pluginmanager/FredPluginHTTP.java
trunk/freenet/src/freenet/pluginmanager/FredPluginThreadless.java
trunk/freenet/src/freenet/pluginmanager/PluginManager.java
trunk/freenet/src/freenet/pluginmanager/PproxyToadlet.java
Log:
699:
Move HTTPRequest to its rightful location in freenet.clients.http
Modified: trunk/freenet/src/freenet/clients/http/ConfigToadlet.java
===================================================================
--- trunk/freenet/src/freenet/clients/http/ConfigToadlet.java 2006-05-12
16:34:26 UTC (rev 8678)
+++ trunk/freenet/src/freenet/clients/http/ConfigToadlet.java 2006-05-12
16:43:54 UTC (rev 8679)
@@ -8,7 +8,6 @@
import freenet.config.Config;
import freenet.config.Option;
import freenet.config.SubConfig;
-import freenet.pluginmanager.HTTPRequest;
import freenet.support.Bucket;
import freenet.support.BucketTools;
import freenet.support.Logger;
Modified: trunk/freenet/src/freenet/clients/http/DarknetConnectionsToadlet.java
===================================================================
--- trunk/freenet/src/freenet/clients/http/DarknetConnectionsToadlet.java
2006-05-12 16:34:26 UTC (rev 8678)
+++ trunk/freenet/src/freenet/clients/http/DarknetConnectionsToadlet.java
2006-05-12 16:43:54 UTC (rev 8679)
@@ -18,7 +18,6 @@
import freenet.node.Node;
import freenet.node.PeerNode;
import freenet.node.Version;
-import freenet.pluginmanager.HTTPRequest;
import freenet.support.Bucket;
import freenet.support.HTMLEncoder;
import freenet.support.SimpleFieldSet;
Modified: trunk/freenet/src/freenet/clients/http/FproxyToadlet.java
===================================================================
--- trunk/freenet/src/freenet/clients/http/FproxyToadlet.java 2006-05-12
16:34:26 UTC (rev 8678)
+++ trunk/freenet/src/freenet/clients/http/FproxyToadlet.java 2006-05-12
16:43:54 UTC (rev 8679)
@@ -22,7 +22,6 @@
import freenet.keys.FreenetURI;
import freenet.node.Node;
import freenet.node.RequestStarter;
-import freenet.pluginmanager.HTTPRequest;
import freenet.pluginmanager.PproxyToadlet;
import freenet.support.Base64;
import freenet.support.Bucket;
Copied: trunk/freenet/src/freenet/clients/http/HTTPRequest.java (from rev 8677,
trunk/freenet/src/freenet/pluginmanager/HTTPRequest.java)
===================================================================
--- trunk/freenet/src/freenet/pluginmanager/HTTPRequest.java 2006-05-12
16:13:20 UTC (rev 8677)
+++ trunk/freenet/src/freenet/clients/http/HTTPRequest.java 2006-05-12
16:43:54 UTC (rev 8679)
@@ -0,0 +1,557 @@
+package freenet.clients.http;
+
+import java.io.DataInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+import java.util.StringTokenizer;
+
+import freenet.support.Bucket;
+import freenet.support.BucketFactory;
+import freenet.support.BucketTools;
+import freenet.support.Logger;
+import freenet.support.MultiValueTable;
+import freenet.support.URLDecoder;
+import freenet.support.URLEncodedFormatException;
+import freenet.support.io.LineReadingInputStream;
+
+/**
+ * Used for passing all HTTP request information to the FredPlugin that handles
+ * the request. It parses the query string and has several methods for acessing
+ * the request parameter values.
+ *
+ * @author nacktschneck
+ */
+public class HTTPRequest {
+
+ /**
+ * This map is used to store all parameter values. The name (as String)
of
+ * the parameter is used as key, the returned value is a list (of
Strings)
+ * with all values for that parameter sent in the request. You shouldn't
+ * access this map directly, use {@link #getParameterValueList(String)}
and
+ * {@link #isParameterSet(String)} insted
+ */
+ private final Map parameterNameValuesMap = new HashMap();
+
+ /**
+ * the original URI as given to the constructor
+ */
+ private URI uri;
+
+ /**
+ * The headers sent by the client
+ */
+ private MultiValueTable headers;
+
+ /**
+ * The data sent in the connection
+ */
+ private Bucket data;
+
+ /**
+ * A hasmap of buckets that we use to store all the parts for a
multipart/form-data request
+ */
+ private HashMap parts;
+
+ private final BucketFactory bucketfactory;
+
+ /**
+ * Create a new HTTPRequest for the given URI and parse its request
+ * parameters.
+ *
+ * @param uri
+ * the URI being requested
+ */
+ public HTTPRequest(URI uri) {
+ this.uri = uri;
+ this.parseRequestParameters(uri.getRawQuery(), true);
+ this.data = null;
+ this.parts = null;
+ this.bucketfactory = null;
+ }
+
+ /**
+ * Creates a new HTTPRequest for the given path and url-encoded query
string
+ *
+ * @param path i.e. /test/test.html
+ * @param encodedQueryString a=some+text&b=abc%40def.de
+ * @throws URISyntaxException if the URI is invalid
+ */
+ public HTTPRequest(String path, String encodedQueryString) throws
URISyntaxException {
+ this.data = null;
+ this.parts = null;
+ this.bucketfactory = null;
+ if (encodedQueryString!=null && encodedQueryString.length()>0) {
+ this.uri = new URI(path+"?"+encodedQueryString);
+ } else {
+ this.uri = new URI(path);
+ }
+ this.parseRequestParameters(uri.getRawQuery(), true);
+ }
+
+ /**
+ * Creates a new HTTPRequest for the given URI and data.
+ * multipart/form-data will be split into Part's, but
+ * application/x-www-form-urlencoded will be split into Param's.
+ *
+ * @param uri The URI being requested
+ * @param h Client headers
+ * @param d The data
+ * @param ctx The toadlet context (for headers and bucket factory)
+ * @throws URISyntaxException if the URI is invalid
+ */
+ public HTTPRequest(URI uri, Bucket d, ToadletContext ctx) {
+ this.headers = ctx.getHeaders();
+ this.parseRequestParameters(uri.getRawQuery(), true);
+ this.data = d;
+ this.parts = new HashMap();
+ this.bucketfactory = ctx.getBucketFactory();
+ try {
+ this.parseMultiPartData();
+ } catch (IOException ioe) {
+
+ }
+ }
+
+
+ /**
+ * The path of this request, where the part of the path the specified
the
+ * plugin has already been removed..
+ */
+ public String getPath() {
+ return this.uri.getPath();
+ }
+
+
+ /**
+ *
+ * @return true if the query string was totally empty
+ */
+ public boolean hasParameters() {
+ return ! this.parameterNameValuesMap.isEmpty();
+ }
+
+ /**
+ * Parse the query string and populate {@link #parameterNameValuesMap}
with
+ * the lists of values for each parameter. If this method is not called
at
+ * all, all other methods would be useless. Because they rely on the
+ * parameter map to be filled.
+ *
+ * @param queryString
+ * the query string in its raw form (not yet url-decoded)
+ * @param doUrlDecoding TODO
+ */
+ private void parseRequestParameters(String queryString, boolean
doUrlDecoding) {
+
+ Logger.minor(this, "queryString is "+queryString+",
doUrlDecoding="+doUrlDecoding);
+
+ // nothing to do if there was no query string in the URI
+ if (queryString == null || queryString.length() == 0) {
+ return;
+ }
+
+ // iterate over all tokens in the query string (seperated by &)
+ StringTokenizer tokenizer = new StringTokenizer(queryString,
"&");
+ while (tokenizer.hasMoreTokens()) {
+ String nameValueToken = tokenizer.nextToken();
+
+ Logger.minor(this, "Token: "+nameValueToken);
+
+ // a token can be either a name, or a name value pair...
+ String name = null;
+ String value = "";
+ int indexOfEqualsChar = nameValueToken.indexOf('=');
+ if (indexOfEqualsChar < 0) {
+ // ...it's only a name, so the value stays
emptys
+ name = nameValueToken;
+ Logger.minor(this, "Name: "+name);
+ } else if (indexOfEqualsChar == nameValueToken.length()
- 1) {
+ // ...it's a name with an empty value, so
remove the '='
+ // character
+ name = nameValueToken.substring(0,
indexOfEqualsChar);
+ Logger.minor(this, "Name: "+name);
+ } else {
+ // ...it's a name value pair, split into name
and value
+ name = nameValueToken.substring(0,
indexOfEqualsChar);
+ value =
nameValueToken.substring(indexOfEqualsChar + 1);
+ Logger.minor(this, "Name: "+name+" Value:
"+value);
+ }
+
+ // url-decode the name and value
+ try {
+ if (doUrlDecoding) {
+ name = URLDecoder.decode(name);
+ value = URLDecoder.decode(value);
+ Logger.minor(this, "Decoded name:
"+name);
+ Logger.minor(this, "Decoded value:
"+value);
+ }
+
+ // get the list of values for this parameter
that were parsed so
+ // far
+ List valueList =
this.getParameterValueList(name);
+ // add this value to the list
+ valueList.add(value);
+ } catch (URLEncodedFormatException e) {
+ // if we fail to decode the name or value we
fail spectacularly
+ String msg = "Failed to decode request
parameter " + name
+ + " with value '" + value + "'";
+ throw new RuntimeException(msg, e);
+ }
+ }
+ }
+
+ /**
+ * Get the first value of the parameter with the given name.
+ *
+ * @param name
+ * the name of the parameter to get
+ * @return the first value or <code>null</code> if the parameter was not
+ * set
+ */
+ private String getParameterValue(String name) {
+ if (!this.isParameterSet(name)) {
+ return null;
+ }
+ List allValues = this.getParameterValueList(name);
+ return (String) allValues.get(0);
+ }
+
+ /**
+ * Get the list of all values for the parameter with the given name.
When
+ * this method is called for a given parameter for the first time, a new
+ * empty list of values is created and stored in
+ * {@link #parameterNameValuesMap}. This list is returned and should be
+ * used to add parameter values. If you only want to check if a
parameter is
+ * set at all, you must use {@link #isParameterSet(String)}.
+ *
+ * @param name
+ * the name of the parameter to get
+ * @return the list of all values for this parameter that were parsed so
+ * far.
+ */
+ private List getParameterValueList(String name) {
+ List values = (List) this.parameterNameValuesMap.get(name);
+ if (values == null) {
+ values = new LinkedList();
+ this.parameterNameValuesMap.put(name, values);
+ }
+ return values;
+ }
+
+ /**
+ * Check if a parameter was set in the request at all, either with or
+ * without a value.
+ *
+ * @param name
+ * the name of the parameter to check
+ * @return true if the parameter was set in the request, not regarding
if
+ * the value is empty
+ */
+ public boolean isParameterSet(String name) {
+ return this.parameterNameValuesMap.containsKey(name);
+ }
+
+ /**
+ * Get the value of a request parameter, using an empty string as
default
+ * value if the parameter was not set. This method will never return
null,
+ * so its safe to do things like
+ *
+ * <p>
+ * <code>
+ * if (request.getParam("abc").equals("def"))
+ * </code>
+ * </p>
+ *
+ * @param name
+ * the name of the parameter to get
+ * @return the parameter value as String, or an empty String if the
value
+ * was missing or empty
+ */
+ public String getParam(String name) {
+ return this.getParam(name, "");
+ }
+
+ /**
+ * Get the value of a request parameter, using the specified default
value
+ * if the parameter was not set or has an empty value.
+ *
+ * @param name
+ * the name of the parameter to get
+ * @param defaultValue
+ * the default value to be returned if the parameter is
missing
+ * or empty
+ * @return either the parameter value as String, or the default value
+ */
+ public String getParam(String name, String defaultValue) {
+ String value = this.getParameterValue(name);
+ if (value == null) {
+ return defaultValue;
+ }
+ return value;
+ }
+
+ /**
+ * Get the value of a request parameter converted to an int, using 0 as
+ * default value. If there are multiple values for this parameter, the
first
+ * value is used.
+ *
+ * @param name
+ * the name of the parameter to get
+ * @return either the parameter value as int, or 0 if the parameter is
+ * missing, empty or invalid
+ */
+ public int getIntParam(String name) {
+ return this.getIntParam(name, 0);
+ }
+
+ /**
+ * Get the value of a request parameter converted to an
<code>int</code>,
+ * using the specified default value. If there are multiple values for
this
+ * parameter, the first value is used.
+ *
+ * @param name
+ * the name of the parameter to get
+ * @param defaultValue
+ * the default value to be returned if the parameter is
missing,
+ * empty or invalid
+ * @return either the parameter value as int, or the default value
+ */
+ public int getIntParam(String name, int defaultValue) {
+ if (!this.isParameterSet(name)) {
+ return defaultValue;
+ }
+ String value = this.getParameterValue(name);
+ try {
+ return Integer.parseInt(value);
+ } catch (NumberFormatException e) {
+ return defaultValue;
+ }
+ }
+
+ // TODO: add similar methods for long, boolean etc.
+
+ /**
+ * Get all values of a request parameter as a string array. If the
parameter
+ * was not set at all, an empty array is returned, so this method will
never
+ * return <code>null</code>.
+ *
+ * @param name
+ * the name of the parameter to get
+ * @return an array of all paramter values that might include empty
values
+ */
+ public String[] getMultipleParam(String name) {
+ List valueList = this.getParameterValueList(name);
+ String[] values = new String[valueList.size()];
+ valueList.toArray(values);
+ return values;
+ }
+
+ /**
+ * Get all values of a request parameter as int array, ignoring all
values
+ * that can not be parsed. If the parameter was not set at all, an empty
+ * array is returned, so this method will never return
<code>null</code>.
+ *
+ * @param name
+ * the name of the parameter to get
+ * @return an int array of all parameter values that could be parsed as
int
+ */
+ public int[] getMultipleIntParam(String name) {
+ List valueList = this.getParameterValueList(name);
+
+ // try parsing all values and put the valid Integers in a new
list
+ List intValueList = new ArrayList();
+ for (int i = 0; i < valueList.size(); i++) {
+ try {
+ intValueList.add(new Integer((String)
valueList.get(i)));
+ } catch (Exception e) {
+ // ignore invalid parameter values
+ }
+ }
+
+ // convert the valid Integers to an array of ints
+ int[] values = new int[intValueList.size()];
+ for (int i = 0; i < intValueList.size(); i++) {
+ values[i] = ((Integer) intValueList.get(i)).intValue();
+ }
+ return values;
+ }
+
+
+ // TODO: add similar methods for multiple long, boolean etc.
+
+
+ /**
+ * Parse submitted data from a bucket.
+ * Note that if this is application/x-www-form-urlencoded, it will come
out as
+ * params, whereas if it is multipart/form-data it will be separated
into buckets.
+ */
+ private void parseMultiPartData() throws IOException {
+ String ctype = (String) this.headers.get("content-type");
+ if (ctype == null) return;
+ String[] ctypeparts = ctype.split(";");
+
if(ctypeparts[0].equalsIgnoreCase("application/x-www-form-urlencoded")) {
+ // Completely different encoding, but easy to handle
+ if(data.size() > 1024*1024)
+ throw new IOException("Too big");
+ byte[] buf = BucketTools.toByteArray(data);
+ String s = new String(buf, "us-ascii");
+ parseRequestParameters(s, true);
+ }
+ if
(!ctypeparts[0].trim().equalsIgnoreCase("multipart/form-data") ||
ctypeparts.length < 2) {
+ return;
+ }
+
+ String boundary = null;
+ for (int i = 0; i < ctypeparts.length; i++) {
+ String[] subparts = ctypeparts[i].split("=");
+ if (subparts.length == 2 &&
subparts[0].trim().equalsIgnoreCase("boundary")) {
+ boundary = subparts[1];
+ }
+ }
+
+ if (boundary == null || boundary.length() == 0) return;
+ if (boundary.charAt(0) == '"') boundary = boundary.substring(1);
+ if (boundary.charAt(boundary.length() - 1) == '"')
+ boundary = boundary.substring(0, boundary.length() - 1);
+
+ boundary = "--"+boundary;
+
+ InputStream is = this.data.getInputStream();
+ LineReadingInputStream lis = new LineReadingInputStream(is);
+
+ String line;
+ line = lis.readLine(100, 100);
+ while (is.available() > 0 && !line.equals(boundary)) {
+ line = lis.readLine(100, 100);
+ }
+
+ boundary = "\r\n"+boundary;
+
+ Bucket filedata = null;
+ String name = null;
+
+ while(is.available() > 0) {
+ name = null;
+ // chomp headers
+ while( (line = lis.readLine(100, 100)) != null) {
+ if (line.length() == 0) break;
+
+ String[] lineparts = line.split(":");
+ if (lineparts == null) continue;
+ String hdrname = lineparts[0].trim();
+
+ if (lineparts.length < 2) continue;
+ String[] valueparts = lineparts[1].split(";");
+
+ for (int i = 0; i < valueparts.length; i++) {
+ String[] subparts =
valueparts[i].split("=");
+ if (subparts.length != 2) {
+ continue;
+ }
+ if
(hdrname.equalsIgnoreCase("Content-Disposition")) {
+ if
(subparts[0].trim().equalsIgnoreCase("name")) {
+ name =
subparts[1].trim();
+ if (name.charAt(0) ==
'"') name = name.substring(1);
+ if
(name.charAt(name.length() - 1) == '"')
+ name =
name.substring(0, name.length() - 1);
+ }
+ }
+ }
+ }
+
+ if (name == null) continue;
+
+ // we should be at the data now. Start reading it in,
checking for the
+ // boundary string
+
+ // we can only give an upper bound for the size of the
bucket
+ filedata =
this.bucketfactory.makeBucket(is.available());
+ OutputStream bucketos = filedata.getOutputStream();
+ // buffer characters that match the boundary so far
+ byte[] buf = new byte[boundary.length()];
+ byte[] bbound = boundary.getBytes();
+ int offset = 0;
+ while (is.available() > 0 && !boundary.equals(new
String(buf))) {
+ byte b = (byte)is.read();
+
+ if (b == bbound[offset]) {
+ buf[offset] = b;
+ offset++;
+ } else if (b != bbound[offset] && offset > 0) {
+ // empty the buffer out
+ bucketos.write(buf, 0, offset);
+ bucketos.write(b);
+ offset = 0;
+ } else {
+ bucketos.write(b);
+ }
+ }
+
+ bucketos.close();
+
+ this.parts.put(name, filedata);
+ }
+
+ if (filedata != null) {
+ this.bucketfactory.freeBucket(filedata);
+ }
+ }
+
+ public Bucket getPart(String name) {
+ return (Bucket)this.parts.get(name);
+ }
+
+ public boolean isPartSet(String name) {
+ return this.parts.containsKey(name);
+ }
+
+ public String getPartAsString(String name, int maxlength) {
+ Bucket part = (Bucket)this.parts.get(name);
+ if(part == null) return "";
+
+ if (part.size() > maxlength) return "";
+
+ try {
+ InputStream is = part.getInputStream();
+ DataInputStream dis = new DataInputStream(is);
+ byte[] buf = new byte[is.available()];
+ dis.readFully(buf);
+ is.close();
+ return new String(buf);
+ } catch (IOException ioe) {
+
+ }
+ return "";
+ }
+
+ public void freeParts() {
+ if (this.parts == null) return;
+ Iterator i = this.parts.keySet().iterator();
+
+ while (i.hasNext()) {
+ String key = (String) i.next();
+ Bucket b = (Bucket)this.parts.get(key);
+ b.free();
+ }
+ }
+
+ public long getLongParam(String name, long defaultValue) {
+ if (!this.isParameterSet(name)) {
+ return defaultValue;
+ }
+ String value = this.getParameterValue(name);
+ try {
+ return Long.parseLong(value);
+ } catch (NumberFormatException e) {
+ return defaultValue;
+ }
+ }
+}
Modified: trunk/freenet/src/freenet/clients/http/QueueToadlet.java
===================================================================
--- trunk/freenet/src/freenet/clients/http/QueueToadlet.java 2006-05-12
16:34:26 UTC (rev 8678)
+++ trunk/freenet/src/freenet/clients/http/QueueToadlet.java 2006-05-12
16:43:54 UTC (rev 8679)
@@ -16,7 +16,6 @@
import freenet.node.fcp.ClientRequest;
import freenet.node.fcp.FCPServer;
import freenet.node.fcp.MessageInvalidException;
-import freenet.pluginmanager.HTTPRequest;
import freenet.support.Bucket;
import freenet.support.HTMLEncoder;
import freenet.support.Logger;
Modified: trunk/freenet/src/freenet/clients/http/WelcomeToadlet.java
===================================================================
--- trunk/freenet/src/freenet/clients/http/WelcomeToadlet.java 2006-05-12
16:34:26 UTC (rev 8678)
+++ trunk/freenet/src/freenet/clients/http/WelcomeToadlet.java 2006-05-12
16:43:54 UTC (rev 8679)
@@ -15,7 +15,6 @@
import freenet.node.Node;
import freenet.node.UserAlert;
import freenet.node.Version;
-import freenet.pluginmanager.HTTPRequest;
import freenet.support.ArrayBucket;
import freenet.support.Bucket;
import freenet.support.BucketTools;
Modified:
trunk/freenet/src/freenet/clients/http/filter/GenericReadFilterCallback.java
===================================================================
---
trunk/freenet/src/freenet/clients/http/filter/GenericReadFilterCallback.java
2006-05-12 16:34:26 UTC (rev 8678)
+++
trunk/freenet/src/freenet/clients/http/filter/GenericReadFilterCallback.java
2006-05-12 16:43:54 UTC (rev 8679)
@@ -4,8 +4,8 @@
import java.net.URI;
import java.net.URISyntaxException;
+import freenet.clients.http.HTTPRequest;
import freenet.keys.FreenetURI;
-import freenet.pluginmanager.HTTPRequest;
import freenet.support.Logger;
import freenet.support.HTMLEncoder;
import freenet.support.URLEncoder;
Modified: trunk/freenet/src/freenet/node/Version.java
===================================================================
--- trunk/freenet/src/freenet/node/Version.java 2006-05-12 16:34:26 UTC (rev
8678)
+++ trunk/freenet/src/freenet/node/Version.java 2006-05-12 16:43:54 UTC (rev
8679)
@@ -18,7 +18,7 @@
public static final String protocolVersion = "1.0";
/** The build number of the current revision */
- private static final int buildNumber = 698;
+ private static final int buildNumber = 699;
/** Oldest build of Fred we will talk to */
private static final int lastGoodBuild = 591;
Modified: trunk/freenet/src/freenet/pluginmanager/FredPluginHTTP.java
===================================================================
--- trunk/freenet/src/freenet/pluginmanager/FredPluginHTTP.java 2006-05-12
16:34:26 UTC (rev 8678)
+++ trunk/freenet/src/freenet/pluginmanager/FredPluginHTTP.java 2006-05-12
16:43:54 UTC (rev 8679)
@@ -1,5 +1,7 @@
package freenet.pluginmanager;
+import freenet.clients.http.HTTPRequest;
+
public interface FredPluginHTTP {
// Let them return null if unhandled
Modified: trunk/freenet/src/freenet/pluginmanager/FredPluginThreadless.java
===================================================================
--- trunk/freenet/src/freenet/pluginmanager/FredPluginThreadless.java
2006-05-12 16:34:26 UTC (rev 8678)
+++ trunk/freenet/src/freenet/pluginmanager/FredPluginThreadless.java
2006-05-12 16:43:54 UTC (rev 8679)
@@ -1,5 +1,7 @@
package freenet.pluginmanager;
+import freenet.clients.http.HTTPRequest;
+
public interface FredPluginThreadless {
// Let them return null if unhandled
Deleted: trunk/freenet/src/freenet/pluginmanager/HTTPRequest.java
===================================================================
--- trunk/freenet/src/freenet/pluginmanager/HTTPRequest.java 2006-05-12
16:34:26 UTC (rev 8678)
+++ trunk/freenet/src/freenet/pluginmanager/HTTPRequest.java 2006-05-12
16:43:54 UTC (rev 8679)
@@ -1,558 +0,0 @@
-package freenet.pluginmanager;
-
-import java.io.DataInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-import java.net.URI;
-import java.net.URISyntaxException;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.LinkedList;
-import java.util.List;
-import java.util.Map;
-import java.util.StringTokenizer;
-
-import freenet.clients.http.ToadletContext;
-import freenet.support.Bucket;
-import freenet.support.BucketFactory;
-import freenet.support.BucketTools;
-import freenet.support.Logger;
-import freenet.support.MultiValueTable;
-import freenet.support.URLDecoder;
-import freenet.support.URLEncodedFormatException;
-import freenet.support.io.LineReadingInputStream;
-
-/**
- * Used for passing all HTTP request information to the FredPlugin that handles
- * the request. It parses the query string and has several methods for acessing
- * the request parameter values.
- *
- * @author nacktschneck
- */
-public class HTTPRequest {
-
- /**
- * This map is used to store all parameter values. The name (as String)
of
- * the parameter is used as key, the returned value is a list (of
Strings)
- * with all values for that parameter sent in the request. You shouldn't
- * access this map directly, use {@link #getParameterValueList(String)}
and
- * {@link #isParameterSet(String)} insted
- */
- private final Map parameterNameValuesMap = new HashMap();
-
- /**
- * the original URI as given to the constructor
- */
- private URI uri;
-
- /**
- * The headers sent by the client
- */
- private MultiValueTable headers;
-
- /**
- * The data sent in the connection
- */
- private Bucket data;
-
- /**
- * A hasmap of buckets that we use to store all the parts for a
multipart/form-data request
- */
- private HashMap parts;
-
- private final BucketFactory bucketfactory;
-
- /**
- * Create a new HTTPRequest for the given URI and parse its request
- * parameters.
- *
- * @param uri
- * the URI being requested
- */
- public HTTPRequest(URI uri) {
- this.uri = uri;
- this.parseRequestParameters(uri.getRawQuery(), true);
- this.data = null;
- this.parts = null;
- this.bucketfactory = null;
- }
-
- /**
- * Creates a new HTTPRequest for the given path and url-encoded query
string
- *
- * @param path i.e. /test/test.html
- * @param encodedQueryString a=some+text&b=abc%40def.de
- * @throws URISyntaxException if the URI is invalid
- */
- public HTTPRequest(String path, String encodedQueryString) throws
URISyntaxException {
- this.data = null;
- this.parts = null;
- this.bucketfactory = null;
- if (encodedQueryString!=null && encodedQueryString.length()>0) {
- this.uri = new URI(path+"?"+encodedQueryString);
- } else {
- this.uri = new URI(path);
- }
- this.parseRequestParameters(uri.getRawQuery(), true);
- }
-
- /**
- * Creates a new HTTPRequest for the given URI and data.
- * multipart/form-data will be split into Part's, but
- * application/x-www-form-urlencoded will be split into Param's.
- *
- * @param uri The URI being requested
- * @param h Client headers
- * @param d The data
- * @param ctx The toadlet context (for headers and bucket factory)
- * @throws URISyntaxException if the URI is invalid
- */
- public HTTPRequest(URI uri, Bucket d, ToadletContext ctx) {
- this.headers = ctx.getHeaders();
- this.parseRequestParameters(uri.getRawQuery(), true);
- this.data = d;
- this.parts = new HashMap();
- this.bucketfactory = ctx.getBucketFactory();
- try {
- this.parseMultiPartData();
- } catch (IOException ioe) {
-
- }
- }
-
-
- /**
- * The path of this request, where the part of the path the specified
the
- * plugin has already been removed..
- */
- public String getPath() {
- return this.uri.getPath();
- }
-
-
- /**
- *
- * @return true if the query string was totally empty
- */
- public boolean hasParameters() {
- return ! this.parameterNameValuesMap.isEmpty();
- }
-
- /**
- * Parse the query string and populate {@link #parameterNameValuesMap}
with
- * the lists of values for each parameter. If this method is not called
at
- * all, all other methods would be useless. Because they rely on the
- * parameter map to be filled.
- *
- * @param queryString
- * the query string in its raw form (not yet url-decoded)
- * @param doUrlDecoding TODO
- */
- private void parseRequestParameters(String queryString, boolean
doUrlDecoding) {
-
- Logger.minor(this, "queryString is "+queryString+",
doUrlDecoding="+doUrlDecoding);
-
- // nothing to do if there was no query string in the URI
- if (queryString == null || queryString.length() == 0) {
- return;
- }
-
- // iterate over all tokens in the query string (seperated by &)
- StringTokenizer tokenizer = new StringTokenizer(queryString,
"&");
- while (tokenizer.hasMoreTokens()) {
- String nameValueToken = tokenizer.nextToken();
-
- Logger.minor(this, "Token: "+nameValueToken);
-
- // a token can be either a name, or a name value pair...
- String name = null;
- String value = "";
- int indexOfEqualsChar = nameValueToken.indexOf('=');
- if (indexOfEqualsChar < 0) {
- // ...it's only a name, so the value stays
emptys
- name = nameValueToken;
- Logger.minor(this, "Name: "+name);
- } else if (indexOfEqualsChar == nameValueToken.length()
- 1) {
- // ...it's a name with an empty value, so
remove the '='
- // character
- name = nameValueToken.substring(0,
indexOfEqualsChar);
- Logger.minor(this, "Name: "+name);
- } else {
- // ...it's a name value pair, split into name
and value
- name = nameValueToken.substring(0,
indexOfEqualsChar);
- value =
nameValueToken.substring(indexOfEqualsChar + 1);
- Logger.minor(this, "Name: "+name+" Value:
"+value);
- }
-
- // url-decode the name and value
- try {
- if (doUrlDecoding) {
- name = URLDecoder.decode(name);
- value = URLDecoder.decode(value);
- Logger.minor(this, "Decoded name:
"+name);
- Logger.minor(this, "Decoded value:
"+value);
- }
-
- // get the list of values for this parameter
that were parsed so
- // far
- List valueList =
this.getParameterValueList(name);
- // add this value to the list
- valueList.add(value);
- } catch (URLEncodedFormatException e) {
- // if we fail to decode the name or value we
fail spectacularly
- String msg = "Failed to decode request
parameter " + name
- + " with value '" + value + "'";
- throw new RuntimeException(msg, e);
- }
- }
- }
-
- /**
- * Get the first value of the parameter with the given name.
- *
- * @param name
- * the name of the parameter to get
- * @return the first value or <code>null</code> if the parameter was not
- * set
- */
- private String getParameterValue(String name) {
- if (!this.isParameterSet(name)) {
- return null;
- }
- List allValues = this.getParameterValueList(name);
- return (String) allValues.get(0);
- }
-
- /**
- * Get the list of all values for the parameter with the given name.
When
- * this method is called for a given parameter for the first time, a new
- * empty list of values is created and stored in
- * {@link #parameterNameValuesMap}. This list is returned and should be
- * used to add parameter values. If you only want to check if a
parameter is
- * set at all, you must use {@link #isParameterSet(String)}.
- *
- * @param name
- * the name of the parameter to get
- * @return the list of all values for this parameter that were parsed so
- * far.
- */
- private List getParameterValueList(String name) {
- List values = (List) this.parameterNameValuesMap.get(name);
- if (values == null) {
- values = new LinkedList();
- this.parameterNameValuesMap.put(name, values);
- }
- return values;
- }
-
- /**
- * Check if a parameter was set in the request at all, either with or
- * without a value.
- *
- * @param name
- * the name of the parameter to check
- * @return true if the parameter was set in the request, not regarding
if
- * the value is empty
- */
- public boolean isParameterSet(String name) {
- return this.parameterNameValuesMap.containsKey(name);
- }
-
- /**
- * Get the value of a request parameter, using an empty string as
default
- * value if the parameter was not set. This method will never return
null,
- * so its safe to do things like
- *
- * <p>
- * <code>
- * if (request.getParam("abc").equals("def"))
- * </code>
- * </p>
- *
- * @param name
- * the name of the parameter to get
- * @return the parameter value as String, or an empty String if the
value
- * was missing or empty
- */
- public String getParam(String name) {
- return this.getParam(name, "");
- }
-
- /**
- * Get the value of a request parameter, using the specified default
value
- * if the parameter was not set or has an empty value.
- *
- * @param name
- * the name of the parameter to get
- * @param defaultValue
- * the default value to be returned if the parameter is
missing
- * or empty
- * @return either the parameter value as String, or the default value
- */
- public String getParam(String name, String defaultValue) {
- String value = this.getParameterValue(name);
- if (value == null) {
- return defaultValue;
- }
- return value;
- }
-
- /**
- * Get the value of a request parameter converted to an int, using 0 as
- * default value. If there are multiple values for this parameter, the
first
- * value is used.
- *
- * @param name
- * the name of the parameter to get
- * @return either the parameter value as int, or 0 if the parameter is
- * missing, empty or invalid
- */
- public int getIntParam(String name) {
- return this.getIntParam(name, 0);
- }
-
- /**
- * Get the value of a request parameter converted to an
<code>int</code>,
- * using the specified default value. If there are multiple values for
this
- * parameter, the first value is used.
- *
- * @param name
- * the name of the parameter to get
- * @param defaultValue
- * the default value to be returned if the parameter is
missing,
- * empty or invalid
- * @return either the parameter value as int, or the default value
- */
- public int getIntParam(String name, int defaultValue) {
- if (!this.isParameterSet(name)) {
- return defaultValue;
- }
- String value = this.getParameterValue(name);
- try {
- return Integer.parseInt(value);
- } catch (NumberFormatException e) {
- return defaultValue;
- }
- }
-
- // TODO: add similar methods for long, boolean etc.
-
- /**
- * Get all values of a request parameter as a string array. If the
parameter
- * was not set at all, an empty array is returned, so this method will
never
- * return <code>null</code>.
- *
- * @param name
- * the name of the parameter to get
- * @return an array of all paramter values that might include empty
values
- */
- public String[] getMultipleParam(String name) {
- List valueList = this.getParameterValueList(name);
- String[] values = new String[valueList.size()];
- valueList.toArray(values);
- return values;
- }
-
- /**
- * Get all values of a request parameter as int array, ignoring all
values
- * that can not be parsed. If the parameter was not set at all, an empty
- * array is returned, so this method will never return
<code>null</code>.
- *
- * @param name
- * the name of the parameter to get
- * @return an int array of all parameter values that could be parsed as
int
- */
- public int[] getMultipleIntParam(String name) {
- List valueList = this.getParameterValueList(name);
-
- // try parsing all values and put the valid Integers in a new
list
- List intValueList = new ArrayList();
- for (int i = 0; i < valueList.size(); i++) {
- try {
- intValueList.add(new Integer((String)
valueList.get(i)));
- } catch (Exception e) {
- // ignore invalid parameter values
- }
- }
-
- // convert the valid Integers to an array of ints
- int[] values = new int[intValueList.size()];
- for (int i = 0; i < intValueList.size(); i++) {
- values[i] = ((Integer) intValueList.get(i)).intValue();
- }
- return values;
- }
-
-
- // TODO: add similar methods for multiple long, boolean etc.
-
-
- /**
- * Parse submitted data from a bucket.
- * Note that if this is application/x-www-form-urlencoded, it will come
out as
- * params, whereas if it is multipart/form-data it will be separated
into buckets.
- */
- private void parseMultiPartData() throws IOException {
- String ctype = (String) this.headers.get("content-type");
- if (ctype == null) return;
- String[] ctypeparts = ctype.split(";");
-
if(ctypeparts[0].equalsIgnoreCase("application/x-www-form-urlencoded")) {
- // Completely different encoding, but easy to handle
- if(data.size() > 1024*1024)
- throw new IOException("Too big");
- byte[] buf = BucketTools.toByteArray(data);
- String s = new String(buf, "us-ascii");
- parseRequestParameters(s, true);
- }
- if
(!ctypeparts[0].trim().equalsIgnoreCase("multipart/form-data") ||
ctypeparts.length < 2) {
- return;
- }
-
- String boundary = null;
- for (int i = 0; i < ctypeparts.length; i++) {
- String[] subparts = ctypeparts[i].split("=");
- if (subparts.length == 2 &&
subparts[0].trim().equalsIgnoreCase("boundary")) {
- boundary = subparts[1];
- }
- }
-
- if (boundary == null || boundary.length() == 0) return;
- if (boundary.charAt(0) == '"') boundary = boundary.substring(1);
- if (boundary.charAt(boundary.length() - 1) == '"')
- boundary = boundary.substring(0, boundary.length() - 1);
-
- boundary = "--"+boundary;
-
- InputStream is = this.data.getInputStream();
- LineReadingInputStream lis = new LineReadingInputStream(is);
-
- String line;
- line = lis.readLine(100, 100);
- while (is.available() > 0 && !line.equals(boundary)) {
- line = lis.readLine(100, 100);
- }
-
- boundary = "\r\n"+boundary;
-
- Bucket filedata = null;
- String name = null;
-
- while(is.available() > 0) {
- name = null;
- // chomp headers
- while( (line = lis.readLine(100, 100)) != null) {
- if (line.length() == 0) break;
-
- String[] lineparts = line.split(":");
- if (lineparts == null) continue;
- String hdrname = lineparts[0].trim();
-
- if (lineparts.length < 2) continue;
- String[] valueparts = lineparts[1].split(";");
-
- for (int i = 0; i < valueparts.length; i++) {
- String[] subparts =
valueparts[i].split("=");
- if (subparts.length != 2) {
- continue;
- }
- if
(hdrname.equalsIgnoreCase("Content-Disposition")) {
- if
(subparts[0].trim().equalsIgnoreCase("name")) {
- name =
subparts[1].trim();
- if (name.charAt(0) ==
'"') name = name.substring(1);
- if
(name.charAt(name.length() - 1) == '"')
- name =
name.substring(0, name.length() - 1);
- }
- }
- }
- }
-
- if (name == null) continue;
-
- // we should be at the data now. Start reading it in,
checking for the
- // boundary string
-
- // we can only give an upper bound for the size of the
bucket
- filedata =
this.bucketfactory.makeBucket(is.available());
- OutputStream bucketos = filedata.getOutputStream();
- // buffer characters that match the boundary so far
- byte[] buf = new byte[boundary.length()];
- byte[] bbound = boundary.getBytes();
- int offset = 0;
- while (is.available() > 0 && !boundary.equals(new
String(buf))) {
- byte b = (byte)is.read();
-
- if (b == bbound[offset]) {
- buf[offset] = b;
- offset++;
- } else if (b != bbound[offset] && offset > 0) {
- // empty the buffer out
- bucketos.write(buf, 0, offset);
- bucketos.write(b);
- offset = 0;
- } else {
- bucketos.write(b);
- }
- }
-
- bucketos.close();
-
- this.parts.put(name, filedata);
- }
-
- if (filedata != null) {
- this.bucketfactory.freeBucket(filedata);
- }
- }
-
- public Bucket getPart(String name) {
- return (Bucket)this.parts.get(name);
- }
-
- public boolean isPartSet(String name) {
- return this.parts.containsKey(name);
- }
-
- public String getPartAsString(String name, int maxlength) {
- Bucket part = (Bucket)this.parts.get(name);
- if(part == null) return "";
-
- if (part.size() > maxlength) return "";
-
- try {
- InputStream is = part.getInputStream();
- DataInputStream dis = new DataInputStream(is);
- byte[] buf = new byte[is.available()];
- dis.readFully(buf);
- is.close();
- return new String(buf);
- } catch (IOException ioe) {
-
- }
- return "";
- }
-
- public void freeParts() {
- if (this.parts == null) return;
- Iterator i = this.parts.keySet().iterator();
-
- while (i.hasNext()) {
- String key = (String) i.next();
- Bucket b = (Bucket)this.parts.get(key);
- b.free();
- }
- }
-
- public long getLongParam(String name, long defaultValue) {
- if (!this.isParameterSet(name)) {
- return defaultValue;
- }
- String value = this.getParameterValue(name);
- try {
- return Long.parseLong(value);
- } catch (NumberFormatException e) {
- return defaultValue;
- }
- }
-}
Modified: trunk/freenet/src/freenet/pluginmanager/PluginManager.java
===================================================================
--- trunk/freenet/src/freenet/pluginmanager/PluginManager.java 2006-05-12
16:34:26 UTC (rev 8678)
+++ trunk/freenet/src/freenet/pluginmanager/PluginManager.java 2006-05-12
16:43:54 UTC (rev 8679)
@@ -15,6 +15,7 @@
import java.util.Set;
import java.util.jar.JarFile;
+import freenet.clients.http.HTTPRequest;
import freenet.config.InvalidConfigValueException;
import freenet.config.StringArrCallback;
import freenet.config.StringArrOption;
Modified: trunk/freenet/src/freenet/pluginmanager/PproxyToadlet.java
===================================================================
--- trunk/freenet/src/freenet/pluginmanager/PproxyToadlet.java 2006-05-12
16:34:26 UTC (rev 8678)
+++ trunk/freenet/src/freenet/pluginmanager/PproxyToadlet.java 2006-05-12
16:43:54 UTC (rev 8679)
@@ -9,6 +9,7 @@
import java.util.Iterator;
import freenet.client.HighLevelSimpleClient;
+import freenet.clients.http.HTTPRequest;
import freenet.clients.http.Toadlet;
import freenet.clients.http.ToadletContext;
import freenet.clients.http.ToadletContextClosedException;
