/***
* Copyright (c) 2009 Caelum - www.caelum.com.br/opensource
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package br.com.caelum.vraptor.interceptor.multipart;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.util.Collection;
import java.util.regex.Pattern;
import javax.servlet.Filter;
import javax.servlet.ServletException;
import javax.servlet.annotation.MultipartConfig;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.Part;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import br.com.caelum.vraptor.InterceptionException;
import br.com.caelum.vraptor.Intercepts;
import br.com.caelum.vraptor.Validator;
import br.com.caelum.vraptor.core.InterceptorStack;
import br.com.caelum.vraptor.http.MutableRequest;
import br.com.caelum.vraptor.interceptor.ParametersInstantiatorInterceptor;
import br.com.caelum.vraptor.ioc.RequestScoped;
import br.com.caelum.vraptor.resource.ResourceMethod;
import br.com.caelum.vraptor.validator.I18nMessage;
import com.google.common.base.Strings;
import com.google.common.collect.HashMultiset;
import com.google.common.collect.LinkedListMultimap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multiset;
import com.google.common.io.ByteStreams;
import com.google.common.io.Closeables;
/**
* <p>
* A multipart interceptor based on Servlet3 File Upload. It's only enabled if Servlet Part is avaliable. If you're
* using servlet3 upload features, the {@link MultipartConfig#getDirectory()} has no effect.
* </p>
* <p>
* TODO This interceptor fails in Apache Tomcat 7.x because request.getParts() doesn't work in a {@link Filter}. So you
* need to use {@link CommonsUploadMultipartInterceptor}. See bug
* https://issues.apache.org/bugzilla/show_bug.cgi?id=49711 and
* https://servlet-spec-public.dev.java.net/issues/show_bug.cgi?id=14 for more info.
* </p>
* <p>
* TODO According JSR315, all form fields are also avaliable via request.getParameter and request.getParameters(), but
* not all containers implements this issue (Glassfish 3.0 fails).
* </p>
*
* @author Otávio Scherer Garcia
* @since 3.2
* @see DefaultMultipartConfig
* @see NullMultipartInterceptor
* @see MultipartInterceptor
*/
@Intercepts(before = ParametersInstantiatorInterceptor.class)
@RequestScoped
public class Servlet3MultipartInterceptor
implements MultipartInterceptor {
private static final Logger logger = LoggerFactory.getLogger(Servlet3MultipartInterceptor.class);
private static final Pattern EXTRACT_FILENAME = Pattern.compile("(.*)name=\"(.*)\"");
public static final String ACCEPT_MULTIPART = "multipart/form-data";
public static final String CONTENT_DISPOSITION_KEY = "content-disposition";
private final HttpServletRequest request;
private final MutableRequest parameters;
private final Validator validator;
private Multiset<String> indexes;
public Servlet3MultipartInterceptor(HttpServletRequest request, MutableRequest parameters, Validator validator) {
this.request = request;
this.parameters = parameters;
this.validator = validator;
}
/**
* Only accept requests that contains multipart headers.
*/
public boolean accepts(ResourceMethod method) {
if (!request.getMethod().toUpperCase().equals("POST")) {
return false;
}
String contentType = request.getContentType();
return contentType != null && contentType.startsWith(ACCEPT_MULTIPART);
}
public void intercept(InterceptorStack stack, ResourceMethod method, Object resourceInstance)
throws InterceptionException {
logger.info("Request contains multipart data. Try to parse with Servlet3 Part");
final Multimap<String, String> params = LinkedListMultimap.create();
indexes = HashMultiset.create();
try {
for (Part part : request.getParts()) {
String name = part.getName();
name = fixIndexedParameters(name);
if (isField(part)) {
logger.debug("{} is a field", name);
params.put(name, getStringValue(part));
} else {
logger.debug("{} is a file", name);
String fileName = getFileName(part);
UploadedFile upload = new DefaultUploadedFile(part.getInputStream(), fileName, part.getContentType(), part.getSize());
parameters.setParameter(name, name);
request.setAttribute(name, upload);
}
}
} catch (IllegalStateException e) {
reportSizeLimitExceeded(e);
} catch (IOException e) {
throw new InterceptionException(e);
} catch (ServletException e) {
throw new InterceptionException(e);
}
for (String paramName : params.keySet()) {
Collection<String> paramValues = params.get(paramName);
parameters.setParameter(paramName, paramValues.toArray(new String[paramValues.size()]));
}
stack.next(method, resourceInstance);
}
/**
* This method is called when the max upload size is reached. There are no way to get the maxFileSize() and
* maxRequestSize() attributes in a Filter.
*
* @param e
*/
protected void reportSizeLimitExceeded(final IllegalStateException e) {
validator.add(new I18nMessage("upload", "servlet3.upload.filesize.exceeded"));
logger.warn("The file size limit was exceeded.", e);
}
/**
* Returns true if the part is a field, false otherwise.
*/
protected boolean isField(Part part) {
return Strings.isNullOrEmpty(part.getContentType());
}
/**
* Get the filename of the part. The filename is extracted by header.
*/
protected String getFileName(Part part) {
String name = part.getHeader(CONTENT_DISPOSITION_KEY);
return EXTRACT_FILENAME.matcher(name).replaceAll("$2");
}
/**
* Get the content of a part as String.
*/
protected String getStringValue(Part part)
throws IOException {
String encoding = request.getCharacterEncoding();
InputStream in = part.getInputStream();
byte[] out = ByteStreams.toByteArray(in);
Closeables.closeQuietly(in);
if (!Strings.isNullOrEmpty(encoding)) {
try {
return new String(out, encoding);
} catch (UnsupportedEncodingException e) {
logger.warn("Request have an invalid encoding. Ignoring it");
}
}
return new String(out);
}
protected String fixIndexedParameters(String name) {
if (name.contains("[]")) {
String newName = name.replace("[]", "[" + (indexes.count(name)) + "]");
indexes.add(name);
logger.debug("{} was renamed to {}", name, newName);
name = newName;
}
return name;
}
}