/**
* @param queryString a query string of the form n1=v1&n2=v2&... to decode. May be null.
* @param acceptAmp -> "&" if true, "&" if false
* @return a Map of String[] indexed by name, an empty Map if the query string was null
*/
public static Map<String, String[]> decodeQueryString(
final CharSequence queryString, final boolean acceptAmp) {
final Map<String, String[]> result = new TreeMap<String, String[]>();
if (queryString != null) {
final Matcher matcher =
acceptAmp ? PATTERN_AMP.matcher(queryString) : PATTERN_NO_AMP.matcher(queryString);
int matcherEnd = 0;
while (matcher.find()) {
matcherEnd = matcher.end();
try {
// Group 0 is the whole match, e.g. a=b, while group 1 is the first group
// denoted ( with parens ) in the expression. Hence we start with group 1.
final String name =
URLDecoder.decode(matcher.group(1), NetUtils.STANDARD_PARAMETER_ENCODING);
final String value =
URLDecoder.decode(matcher.group(2), NetUtils.STANDARD_PARAMETER_ENCODING);
StringUtils.addValueToStringArrayMap(result, name, value);
} catch (UnsupportedEncodingException e) {
// Should not happen as we are using a required encoding
throw new OXFException(e);
}
}
if (queryString.length() != matcherEnd) {
// There was garbage at the end of the query.
throw new OXFException("Malformed URL: " + queryString);
}
}
return result;
}
/**
* Utility method to decode a multipart/fomr-data stream and return a Map of parameters of type
* Object[], each of which can be a String or FileData.
*/
public static Map<String, Object[]> getParameterMapMultipart(
PipelineContext pipelineContext,
final ExternalContext.Request request,
String headerEncoding) {
final Map<String, Object[]> uploadParameterMap = new HashMap<String, Object[]>();
try {
// Setup commons upload
// Read properties
// NOTE: We use properties scoped in the Request generator for historical reasons. Not too
// good.
int maxSize = RequestGenerator.getMaxSizeProperty();
int maxMemorySize = RequestGenerator.getMaxMemorySizeProperty();
final DiskFileItemFactory diskFileItemFactory =
new DiskFileItemFactory(maxMemorySize, SystemUtils.getTemporaryDirectory());
final ServletFileUpload upload =
new ServletFileUpload(diskFileItemFactory) {
protected FileItem createItem(Map headers, boolean isFormField)
throws FileUploadException {
if (isFormField) {
// Handle externalized values
final String externalizeFormValuesPrefix =
org.orbeon.oxf.properties.Properties.instance()
.getPropertySet()
.getString(ServletExternalContext.EXTERNALIZE_FORM_VALUES_PREFIX_PROPERTY);
final String fieldName = getFieldName(headers);
if (externalizeFormValuesPrefix != null
&& fieldName.startsWith(externalizeFormValuesPrefix)) {
// In this case, we do as if the value content is an uploaded file so that it can
// be externalized
return super.createItem(headers, false);
} else {
// Just create the FileItem using the default way
return super.createItem(headers, isFormField);
}
} else {
// Just create the FileItem using the default way
return super.createItem(headers, isFormField);
}
}
};
upload.setHeaderEncoding(headerEncoding);
upload.setSizeMax(maxSize);
// Add a listener to destroy file items when the pipeline context is destroyed
pipelineContext.addContextListener(
new PipelineContext.ContextListenerAdapter() {
public void contextDestroyed(boolean success) {
for (final String name : uploadParameterMap.keySet()) {
final Object values[] = uploadParameterMap.get(name);
for (final Object currentValue : values) {
if (currentValue instanceof FileItem) {
final FileItem fileItem = (FileItem) currentValue;
fileItem.delete();
}
}
}
}
});
// Wrap and implement just the required methods for the upload code
final InputStream inputStream;
try {
inputStream = request.getInputStream();
} catch (IOException e) {
throw new OXFException(e);
}
final RequestContext requestContext =
new RequestContext() {
public int getContentLength() {
return request.getContentLength();
}
public InputStream getInputStream() {
// NOTE: The upload code does not actually check that it doesn't read more than the
// content-length
// sent by the client! Maybe here would be a good place to put an interceptor and make
// sure we
// don't read too much.
return new InputStream() {
public int read() throws IOException {
return inputStream.read();
}
};
}
public String getContentType() {
return request.getContentType();
}
public String getCharacterEncoding() {
return request.getCharacterEncoding();
}
};
// Parse the request and add file information
try {
for (Object o : upload.parseRequest(requestContext)) {
final FileItem fileItem = (FileItem) o;
// Add value to existing values if any
if (fileItem.isFormField()) {
// Simple form field
// Assume that form fields are in UTF-8. Can they have another encoding? If so, how is
// it specified?
StringUtils.addValueToObjectArrayMap(
uploadParameterMap,
fileItem.getFieldName(),
fileItem.getString(STANDARD_PARAMETER_ENCODING));
} else {
// File
StringUtils.addValueToObjectArrayMap(
uploadParameterMap, fileItem.getFieldName(), fileItem);
}
}
} catch (FileUploadBase.SizeLimitExceededException e) {
// Should we do something smart so we can use the Presentation
// Server error page anyway? Right now, this is going to fail
// miserably with an error.
throw e;
} catch (UnsupportedEncodingException e) {
// Should not happen
throw new OXFException(e);
} finally {
// Close the input stream; if we don't nobody does, and if this stream is
// associated with a temporary file, that file may resist deletion
if (inputStream != null) {
try {
inputStream.close();
} catch (IOException e) {
throw new OXFException(e);
}
}
}
return uploadParameterMap;
} catch (FileUploadException e) {
throw new OXFException(e);
}
}
