com.aspectran.web.support.multipart.commons.CommonsMultipartFormDataParser Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2023 The Aspectran Project
*
* 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 com.aspectran.web.support.multipart.commons;
import com.aspectran.core.activity.request.FileParameter;
import com.aspectran.core.activity.request.SizeLimitExceededException;
import com.aspectran.core.adapter.RequestAdapter;
import com.aspectran.core.util.FilenameUtils;
import com.aspectran.core.util.LinkedMultiValueMap;
import com.aspectran.core.util.MultiValueMap;
import com.aspectran.core.util.StringUtils;
import com.aspectran.core.util.logging.Logger;
import com.aspectran.core.util.logging.LoggerFactory;
import com.aspectran.web.activity.request.MultipartFormDataParser;
import com.aspectran.web.activity.request.MultipartRequestParseException;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUpload;
import org.apache.commons.fileupload.FileUploadBase;
import org.apache.commons.fileupload.RequestContext;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
import java.io.File;
import java.io.UnsupportedEncodingException;
import java.util.List;
import java.util.Map;
/**
* Multi-part form data parser that use Apache Commons FileUpload 1.4 or above.
*/
public class CommonsMultipartFormDataParser implements MultipartFormDataParser {
private static final Logger logger = LoggerFactory.getLogger(CommonsMultipartFormDataParser.class);
private String tempDirectoryPath;
private long maxRequestSize = -1L;
private long maxFileSize = -1L;
private int maxInMemorySize = -1;
private String allowedFileExtensions;
private String deniedFileExtensions;
/**
* Instantiates a new CommonsMultipartFormDataParser.
*/
public CommonsMultipartFormDataParser() {
}
@Override
public String getTempDirectoryPath() {
return tempDirectoryPath;
}
@Override
public void setTempDirectoryPath(String tempDirectoryPath) {
File tempDirectory = new File(tempDirectoryPath);
if (!tempDirectory.exists() && !tempDirectory.mkdirs()) {
throw new IllegalArgumentException("Given tempDirectoryPath [" +
tempDirectoryPath + "] could not be created");
}
this.tempDirectoryPath = tempDirectoryPath;
}
@Override
public void setMaxRequestSize(long maxRequestSize) {
this.maxRequestSize = maxRequestSize;
}
@Override
public void setMaxFileSize(long maxFileSize) {
this.maxFileSize = maxFileSize;
}
@Override
public void setMaxInMemorySize(int maxInMemorySize) {
this.maxInMemorySize = maxInMemorySize;
}
@Override
public void setAllowedFileExtensions(String allowedFileExtensions) {
this.allowedFileExtensions = allowedFileExtensions;
}
@Override
public void setDeniedFileExtensions(String deniedFileExtensions) {
this.deniedFileExtensions = deniedFileExtensions;
}
@Override
public void parse(RequestAdapter requestAdapter) throws MultipartRequestParseException {
try {
DiskFileItemFactory factory = new DiskFileItemFactory();
if (maxInMemorySize > -1) {
factory.setSizeThreshold(maxInMemorySize);
}
if (tempDirectoryPath != null) {
File repository = new File(tempDirectoryPath);
if (!repository.exists() && !repository.mkdirs()) {
throw new IllegalArgumentException("Given tempDirectoryPath [" +
tempDirectoryPath + "] could not be created");
}
factory.setRepository(repository);
}
FileUpload upload = new ServletFileUpload(factory);
upload.setHeaderEncoding(requestAdapter.getEncoding());
if (maxRequestSize > -1L) {
upload.setSizeMax(maxRequestSize);
}
if (maxFileSize > -1L) {
upload.setFileSizeMax(maxFileSize);
}
Map> fileItemListMap;
try {
RequestContext requestContext = new CommonsRequestContext(requestAdapter);
fileItemListMap = upload.parseParameterMap(requestContext);
} catch (FileUploadBase.SizeLimitExceededException e) {
throw new SizeLimitExceededException("Maximum request length exceeded; actual: " +
e.getActualSize() + "; permitted: " + e.getPermittedSize(),
e.getActualSize(), e.getPermittedSize());
} catch (FileUploadBase.FileSizeLimitExceededException e) {
throw new SizeLimitExceededException("Maximum file length exceeded; actual: " +
e.getActualSize() + "; permitted: " + e.getPermittedSize(),
e.getActualSize(), e.getPermittedSize());
}
parseMultipartParameters(fileItemListMap, requestAdapter);
} catch (Exception e) {
throw new MultipartRequestParseException("Could not parse multipart servlet request", e);
}
}
/**
* Parse form fields and file items.
* @param fileItemListMap the file item list map
* @param requestAdapter the request adapter
*/
private void parseMultipartParameters(Map> fileItemListMap, RequestAdapter requestAdapter) {
String encoding = requestAdapter.getEncoding();
MultiValueMap parameterMap = new LinkedMultiValueMap<>();
MultiValueMap fileParameterMap = new LinkedMultiValueMap<>();
for (Map.Entry> entry : fileItemListMap.entrySet()) {
String fieldName = entry.getKey();
List fileItemList = entry.getValue();
if (fileItemList != null && !fileItemList.isEmpty()) {
for (FileItem fileItem : fileItemList) {
if (fileItem.isFormField()) {
String value = getString(fileItem, encoding);
parameterMap.add(fieldName, value);
} else {
String fileName = fileItem.getName();
// Skip file uploads that don't have a file name - meaning that
// no file was selected.
if (StringUtils.isEmpty(fileName)) {
continue;
}
boolean valid = FilenameUtils.isValidFileExtension(fileName,
allowedFileExtensions, deniedFileExtensions);
if (!valid) {
continue;
}
CommonsMultipartFileParameter fileParameter = new CommonsMultipartFileParameter(fileItem);
fileParameterMap.add(fieldName, fileParameter);
if (logger.isDebugEnabled()) {
logger.debug("Found multipart file [" + fileParameter.getFileName() + "] of size " +
fileParameter.getFileSize() + " bytes, stored " +
fileParameter.getStorageDescription());
}
}
}
}
}
requestAdapter.putAllParameters(parameterMap);
requestAdapter.putAllFileParameters(fileParameterMap);
}
private String getString(FileItem fileItem, String encoding) {
String value;
if (encoding != null) {
try {
value = fileItem.getString(encoding);
} catch (UnsupportedEncodingException ex) {
logger.warn("Could not decode multipart item '" + fileItem.getFieldName() +
"' with encoding '" + encoding + "': using platform default");
value = fileItem.getString();
}
} else {
value = fileItem.getString();
}
return value;
}
}