* A WORequest subclass representing requests which got initiated by a Servlet * container like Jetty or Tomcat. This object contains all the necessary state * to track a WORequest running as a Servlet transaction. * *
* We need to track the servlet response because the Servlet API service()
* method already has the pointer to the response. Which in turn is needed
* for content streaming.
*/
public class WOServletRequest extends WORequest {
private static final Log servLog = LogFactory.getLog("WOServletAdaptor");
HttpServletRequest sRequest;
HttpServletResponse sResponse;
protected static int maxRequestSize = 64 * 1024 * 1024; /* 64MB */
protected static int maxRAMFileSize = 256 * 1024; /* 256KB */
protected static File tmpFileLocation =
new File(System.getProperty("java.io.tmpdir"));
public WOServletRequest(HttpServletRequest _rq, HttpServletResponse _r) {
super();
this.init(_rq, _r);
}
/**
* Initialize the WORequest object with the data contained in the
* HttpServletRequest.
* This will load the HTTP headers from the servlet request into the
* WORequest,
* it will decode cookies,
* it will decode query parameters and form values
* and it will process the content.
*
* @param _rq - the HttpServletRequest
* @param _r - the HttpServletResponse
*/
protected void init(HttpServletRequest _rq, HttpServletResponse _r) {
this.init(_rq.getMethod(), _rq.getRequestURI(), _rq.getProtocol(),
null /* headers */,
null /* contents */,
null /* userInfo */);
this.sRequest = _rq;
this.sResponse = _r;
this.loadHeadersFromServletRequest(_rq);
this.loadCookies();
// Note: ServletFileUpload.isMultipartContent() is deprecated
String contentType = this.headerForKey("content-type");
if (contentType != null) contentType = contentType.toLowerCase();
if (contentType != null && contentType.startsWith("multipart/form-data")) {
FileItemFactory factory =
new DiskFileItemFactory(maxRAMFileSize, tmpFileLocation);
ServletFileUpload upload = new ServletFileUpload(factory);
upload.setSizeMax(maxRequestSize);
List items = null;
try {
items = upload.parseRequest(_rq);
}
catch (FileUploadException e) {
items = null;
log.error("failed to parse upload request", e);
}
/* load regular form values (query parameters) */
this.loadFormValuesFromRequest(_rq);
/* next load form values from file items */
this.loadFormValuesFromFileItems(items);
}
else if (contentType != null &&
contentType.startsWith("application/x-www-form-urlencoded"))
{
/* Note: we need to load form values first, because when we load the
* content, we need to process them on our own.
*/
this.loadFormValuesFromRequest(_rq);
/* Note: since we made the Servlet container process the form content,
* we can't load any content ...
*/
}
else {
/* Note: we need to load form values first, because when we load the
* content, we need to process them on our own.
*/
this.loadFormValuesFromRequest(_rq);
// TODO: make this smarter, eg transfer large PUTs to disk
this.loadContentFromRequest(_rq);
}
}
public void dispose() {
if (this.formValues != null) {
for (Object value: this.formValues.values()) {
if (value instanceof FileItem)
((FileItem)value).delete();
}
}
super.dispose();
}
/* loading WORequest data from the Servlet */
protected void loadHeadersFromServletRequest(HttpServletRequest _rq) {
Enumeration e = _rq.getHeaderNames();
while (e.hasMoreElements()) {
String name = (String)e.nextElement();
Enumeration ve = _rq.getHeaders(name);
name = name.toLowerCase();
while (ve.hasMoreElements()) {
String v = (String)ve.nextElement();
this.appendHeader(v, name);
}
}
}
/**
* This parses a cookie string and adds the resulting WOCookie to the
* receivers set of request cookies.
*
* @param _v - a String representing the cookie
*/
protected void loadCookieFromHeaderString(String _v) {
WOCookie cookie = WOCookie.parseCookieString(_v);
if (cookie == null) {
servLog.error("could not parse cookie: '" + _v + "'");
return;
}
this.addCookie(cookie);
}
protected void loadCookies() {
/*
* Note: this is loading using the 'Cookie' syntax. That is, ';' separates
* individual cookies, not cookie options.
*/
for (String v: this.headersForKey("cookie")) {
String[] cookieStrings = v.split(";");
for (int i = 0; i < cookieStrings.length; i++)
this.loadCookieFromHeaderString(cookieStrings[i].trim());
}
}
protected IOException loadContentFromStream(int len, InputStream _in) {
// TODO: directly load into contents buffer w/o copying
// TODO: deal with requests which have no content-length?
// TODO: add support for streamed input?
if (len < 1)
return null; /* no content, no error */
if (log.isInfoEnabled()) {
log.info("load content, length " + len + ", type " +
this.headerForKey("content-type"));
}
int pos = 0;
try {
byte[] buffer = new byte[4096];
int gotlen;
this.contents = new byte[len];
while ((gotlen = _in.read(buffer)) != -1) {
System.arraycopy(buffer, 0, this.contents, pos, gotlen);
pos += gotlen;
}
}
catch (IOException ioe) {
// TODO: what to do with failed requests?
log.warn("could not read request ...");
return ioe;
}
if (pos != len)
log.warn("did read less bytes than expected (" + pos + " vs " + len +")");
return null; /* everything allright */
}
protected static final Object[] emptyObjectArray = new Object[0];
/**
* As explained in "Passing Parameters to Scripts" in
* http://www.faqs.org/docs/ZopeBook/ScriptingZope.html
*
* You can annotate form names with "filters" to convert strings being * passed in by browsers into objects, eg: *
<input type="text" name="age:int" />*
* When the browser submits the form, "age:int" will initially be stored * as a string. This method will detect the ":int" suffix and create an * Integer object keyed under 'age'. That is, you will be able to do this: *
int age = (Integer)request.formValueForKey("age");
*
* The facility is quite powerful, eg filters can be nested.
*/
@SuppressWarnings("deprecation")
protected Object formatFormValue(String _s, String _format) {
// TODO: we should use java.text.Format in an extensible way (map the filter
// to a Format object)
int len = _format != null ? _format.length() : 0;
if (len < 3) return _s;
if ("int".equals(_format))
return _s != null ? Integer.valueOf(_s) : null;
if ("boolean".equals(_format))
return _s != null ? UObject.boolValue(_s) : Boolean.FALSE;
if ("long".equals(_format))
return _s != null ? Long.valueOf(_s) : null;
if ("float".equals(_format))
return _s != null ? Float.valueOf(_s) : null;
if ("string".equals(_format))
return _s;
if ("text".equals(_format)) // normalize line endings
return _s != null ? _s.replace("\r", "") : null;
if ("date".equals(_format)) {
// TODO: improve date support
return _s != null ? new Date(_s) : null;
}
if ("lines".equals(_format))
return _s != null ? _s.split("\n") : null;
if ("tokens".equals(_format))
return _s != null ? _s.split("\\s") : null;
if ("required".equals(_format)) {
// TODO: include name
// TODO: raise a better exception
String c = _s != null ? _s.trim() : null;
if (c == null || c.length() == 0)
throw new NSException("missing required field");
return c;
}
if ("ignore_empty".equals(_format)) {
String c = _s != null ? _s.trim() : null;
return (c == null || c.length() == 0) ? null : c;
}
/* Method prefixes, we should not process them in here */
if ("method".equals(_format) || "action".equals(_format)) {
/*
* This is processed in the lookup phase. Example:
*
*/
return _s;
}
if ("default_method".equals(_format) || "default_action".equals(_format)) {
/*
* This is processed in the lookup phase. Example:
*
*/
return _s;
}
/* failed to lookup format, treat as string */
log.error("unsupported request value format: " + _format);
return _s;
}
@SuppressWarnings("unchecked")
protected void loadFormValuesFromRequest(final HttpServletRequest _rq) {
servLog.debug("loading form values from Servlet request ...");
if (this.formValues == null)
this.formValues = new HashMap
* Note that once you started streaming, you cannot change any headers
* anymore.
*/
public boolean prepareForStreaming(final WOResponse _r) {
if (_r == null || this.sResponse == null)
return false;
WOServletAdaptor.prepareResponseHeader(_r, this.sResponse);
return true;
}
/**
* Returns the OutputStream associated with the ServletResponse.
*/
public OutputStream outputStream() {
if (this.sResponse == null)
return null;
try {
return this.sResponse.getOutputStream();
}
catch (IOException e) {
log.warn("could not get OutputStream of ServletResponse: " +
this.sResponse, e);
return null;
}
}
/* URL support */
@Override
public String url() {
return this.sRequest.getRequestURL().toString();
}
}