Author: remy.maucherat(a)jboss.com Date: 2009-11-20 18:18:44 -0500 (Fri, 20 Nov 2009) New Revision: 1281 Added: trunk/java/org/apache/catalina/core/StandardPart.java trunk/java/org/apache/tomcat/util/http/fileupload/ByteArrayOutputStream.java trunk/java/org/apache/tomcat/util/http/fileupload/Closeable.java trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileItem.java trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileItemFactory.java trunk/java/org/apache/tomcat/util/http/fileupload/FileCleanerCleanup.java trunk/java/org/apache/tomcat/util/http/fileupload/FileCleaningTracker.java trunk/java/org/apache/tomcat/util/http/fileupload/FileDeleteStrategy.java trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeaders.java trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersImpl.java trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersSupport.java trunk/java/org/apache/tomcat/util/http/fileupload/FileItemIterator.java trunk/java/org/apache/tomcat/util/http/fileupload/FileItemStream.java trunk/java/org/apache/tomcat/util/http/fileupload/FileUtils.java trunk/java/org/apache/tomcat/util/http/fileupload/IOUtils.java trunk/java/org/apache/tomcat/util/http/fileupload/LimitedInputStream.java trunk/java/org/apache/tomcat/util/http/fileupload/ParameterParser.java trunk/java/org/apache/tomcat/util/http/fileupload/ProgressListener.java trunk/java/org/apache/tomcat/util/http/fileupload/RequestContext.java trunk/java/org/apache/tomcat/util/http/fileupload/ServletFileUpload.java trunk/java/org/apache/tomcat/util/http/fileupload/ServletRequestContext.java trunk/java/org/apache/tomcat/util/http/fileupload/Streams.java Removed: trunk/java/org/apache/tomcat/util/http/fileupload/DefaultFileItem.java trunk/java/org/apache/tomcat/util/http/fileupload/DefaultFileItemFactory.java trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileUpload.java Modified: trunk/java/org/apache/catalina/connector/Request.java trunk/java/org/apache/catalina/manager/HTMLManagerServlet.java trunk/java/org/apache/tomcat/util/http/fileupload/DeferredFileOutputStream.java trunk/java/org/apache/tomcat/util/http/fileupload/FileItem.java trunk/java/org/apache/tomcat/util/http/fileupload/FileItemFactory.java trunk/java/org/apache/tomcat/util/http/fileupload/FileUpload.java trunk/java/org/apache/tomcat/util/http/fileupload/FileUploadBase.java trunk/java/org/apache/tomcat/util/http/fileupload/FileUploadException.java trunk/java/org/apache/tomcat/util/http/fileupload/MultipartStream.java trunk/java/org/apache/tomcat/util/http/fileupload/ThresholdingOutputStream.java trunk/java/org/apache/tomcat/util/http/fileupload/package.html Log: - Tomcat did rebase on a new fileupload, so pick that up. Modified: trunk/java/org/apache/catalina/connector/Request.java =================================================================== --- trunk/java/org/apache/catalina/connector/Request.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/catalina/connector/Request.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -48,6 +48,7 @@ import java.io.BufferedReader; +import java.io.File; import java.io.IOException; import java.io.InputStream; import java.io.UnsupportedEncodingException; @@ -94,6 +95,7 @@ import org.apache.catalina.core.ApplicationFilterChain; import org.apache.catalina.core.ApplicationFilterConfig; import org.apache.catalina.core.ApplicationFilterFactory; +import org.apache.catalina.core.StandardPart; import org.apache.catalina.deploy.FilterDef; import org.apache.catalina.deploy.Multipart; import org.apache.catalina.realm.GenericPrincipal; @@ -110,9 +112,12 @@ import org.apache.tomcat.util.http.FastHttpDateFormat; import org.apache.tomcat.util.http.Parameters; import org.apache.tomcat.util.http.ServerCookie; -import org.apache.tomcat.util.http.fileupload.DiskFileUpload; +import org.apache.tomcat.util.http.fileupload.DiskFileItemFactory; import org.apache.tomcat.util.http.fileupload.FileItem; -import org.apache.tomcat.util.http.fileupload.FileUploadBase; +import org.apache.tomcat.util.http.fileupload.FileUploadException; +import org.apache.tomcat.util.http.fileupload.ServletFileUpload; +import org.apache.tomcat.util.http.fileupload.FileUploadBase.FileSizeLimitExceededException; +import org.apache.tomcat.util.http.fileupload.FileUploadBase.SizeLimitExceededException; import org.apache.tomcat.util.http.mapper.MappingData; @@ -2818,30 +2823,34 @@ if (!("multipart/form-data".equals(contentType))) throw new ServletException(sm.getString("coyoteRequest.notMultipart")); - DiskFileUpload fu = new DiskFileUpload(); - fu.setRepositoryPath(config.getLocation()); + DiskFileItemFactory factory = new DiskFileItemFactory(); + if (config.getLocation() != null) { + factory.setRepository(new File(config.getLocation())); + } if (config.getFileSizeThreshold() > 0) { - fu.setSizeThreshold(config.getFileSizeThreshold()); + factory.setSizeThreshold(config.getFileSizeThreshold()); } - if (config.getMaxRequestSize() > 0) { - fu.setSizeMax(config.getMaxRequestSize()); - } - if (config.getMaxFileSize() > 0) { - fu.setFileSizeMax(config.getMaxFileSize()); - } + + ServletFileUpload upload = new ServletFileUpload(); + upload.setFileItemFactory(factory); + upload.setFileSizeMax(config.getMaxFileSize()); + upload.setSizeMax(config.getMaxRequestSize()); parts = new HashMap<String, Part>(); try { - for (FileItem fileItem : fu.parseRequest(getRequest())) { - if (fileItem.getFileName() == null) { - coyoteRequest.getParameters().addParameterValues(fileItem.getName(), new String[] {fileItem.getString()}); + for (FileItem fileItem : upload.parseRequest(getRequest())) { + if (fileItem.getName() == null) { + coyoteRequest.getParameters().addParameterValues + (fileItem.getFieldName(), new String[] {fileItem.getString()}); } - parts.put(fileItem.getName(), fileItem); + parts.put(fileItem.getFieldName(), new StandardPart(fileItem, config)); } - } catch(FileUploadBase.FileSizeLimitExceededException e) { + } catch(FileSizeLimitExceededException e) { throw new IllegalStateException(sm.getString("coyoteRequest.parseMultipart"), e); - } catch(FileUploadBase.SizeLimitExceededException e) { + } catch(SizeLimitExceededException e) { throw new IllegalStateException(sm.getString("coyoteRequest.parseMultipart"), e); + } catch (FileUploadException e) { + throw new IOException(sm.getString("coyoteRequest.parseMultipart"), e); } } Added: trunk/java/org/apache/catalina/core/StandardPart.java =================================================================== --- trunk/java/org/apache/catalina/core/StandardPart.java (rev 0) +++ trunk/java/org/apache/catalina/core/StandardPart.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,124 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.catalina.core; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.util.Collection; +import java.util.Collections; +import java.util.HashSet; +import java.util.Iterator; + +import javax.servlet.MultipartConfigElement; +import javax.servlet.http.Part; + +import org.apache.catalina.deploy.Multipart; +import org.apache.tomcat.util.http.fileupload.DiskFileItem; +import org.apache.tomcat.util.http.fileupload.FileItem; + +/** + * Adaptor to allow {@link FileItem} objects generated by the package renamed + * commons-upload to be used by the Servlet 3.0 upload API that expects + * {@link Part}s. + */ +public class StandardPart implements Part { + + private FileItem fileItem; + private Multipart config; + + public StandardPart(FileItem fileItem, Multipart config) { + this.fileItem = fileItem; + this.config = config; + } + + @Override + public void delete() throws IOException { + fileItem.delete(); + } + + @Override + public String getContentType() { + return fileItem.getContentType(); + } + + @Override + public String getHeader(String name) { + if (fileItem instanceof DiskFileItem) { + return ((DiskFileItem) fileItem).getHeaders().getHeader(name); + } + return null; + } + + @Override + public Collection<String> getHeaderNames() { + if (fileItem instanceof DiskFileItem) { + HashSet<String> headerNames = new HashSet<String>(); + Iterator<String> iter = + ((DiskFileItem) fileItem).getHeaders().getHeaderNames(); + while (iter.hasNext()) { + headerNames.add(iter.next()); + } + return headerNames; + } + return Collections.emptyList(); + } + + @Override + public Collection<String> getHeaders(String name) { + if (fileItem instanceof DiskFileItem) { + HashSet<String> headers = new HashSet<String>(); + Iterator<String> iter = + ((DiskFileItem) fileItem).getHeaders().getHeaders(name); + while (iter.hasNext()) { + headers.add(iter.next()); + } + return headers; + } + return Collections.emptyList(); + } + + @Override + public InputStream getInputStream() throws IOException { + return fileItem.getInputStream(); + } + + @Override + public String getName() { + return fileItem.getFieldName(); + } + + @Override + public long getSize() { + return fileItem.getSize(); + } + + @Override + public void write(String fileName) throws IOException { + File file = new File(fileName); + if (!file.isAbsolute()) { + file = new File(config.getLocation(), fileName); + } + try { + fileItem.write(file); + } catch (Exception e) { + throw new IOException(e); + } + } + +} Modified: trunk/java/org/apache/catalina/manager/HTMLManagerServlet.java =================================================================== --- trunk/java/org/apache/catalina/manager/HTMLManagerServlet.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/catalina/manager/HTMLManagerServlet.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -24,6 +24,7 @@ import java.io.StringWriter; import java.text.MessageFormat; import java.util.Arrays; +import java.util.Collection; import java.util.Collections; import java.util.Comparator; import java.util.Date; @@ -32,11 +33,11 @@ import java.util.Map; import java.util.TreeMap; -import javax.servlet.ServletContext; import javax.servlet.ServletException; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpSession; +import javax.servlet.http.Part; import org.apache.catalina.Container; import org.apache.catalina.Context; @@ -47,8 +48,7 @@ import org.apache.catalina.util.RequestUtil; import org.apache.catalina.util.ServerInfo; import org.apache.catalina.util.URLEncoder; -import org.apache.tomcat.util.http.fileupload.DiskFileUpload; -import org.apache.tomcat.util.http.fileupload.FileItem; +import org.apache.tomcat.util.http.fileupload.ParameterParser; /** * Servlet that enables remote management of the web applications deployed @@ -172,62 +172,54 @@ String message = ""; - // Create a new file upload handler - DiskFileUpload upload = new DiskFileUpload(); + Part warPart = null; + String filename = null; + String basename = null; - // Get the tempdir - File tempdir = (File) getServletContext().getAttribute(ServletContext.TEMPDIR); - // Set upload parameters - upload.setSizeMax(-1); - upload.setRepositoryPath(tempdir.getCanonicalPath()); - - // Parse the request - String basename = null; - String war = null; - FileItem warUpload = null; + Collection<Part> parts = request.getParts(); + Iterator<Part> iter = parts.iterator(); + try { - List items = upload.parseRequest(request); - - // Process the uploaded fields - Iterator iter = items.iterator(); while (iter.hasNext()) { - FileItem item = (FileItem) iter.next(); - - if (!item.isFormField()) { - if (item.getFieldName().equals("deployWar") && - warUpload == null) { - warUpload = item; - } else { - item.delete(); - } + Part part = iter.next(); + if (part.getName().equals("deployWar") && warPart == null) { + warPart = part; + } else { + part.delete(); } } + while (true) { - if (warUpload == null) { - message = sm.getString - ("htmlManagerServlet.deployUploadNoFile"); + if (warPart == null) { + message = + sm.getString("htmlManagerServlet.deployUploadNoFile"); break; } - war = warUpload.getFileName(); - if (!war.toLowerCase().endsWith(".war")) { - message = sm.getString - ("htmlManagerServlet.deployUploadNotWar",war); + filename = + extractFilename(warPart.getHeader("Content-Disposition")); + if (!filename.toLowerCase().endsWith(".war")) { + message = sm.getString( + "htmlManagerServlet.deployUploadNotWar", filename); break; } // Get the filename if uploaded name includes a path - if (war.lastIndexOf('\\') >= 0) { - war = war.substring(war.lastIndexOf('\\') + 1); + if (filename.lastIndexOf('\\') >= 0) { + filename = + filename.substring(filename.lastIndexOf('\\') + 1); } - if (war.lastIndexOf('/') >= 0) { - war = war.substring(war.lastIndexOf('/') + 1); + if (filename.lastIndexOf('/') >= 0) { + filename = + filename.substring(filename.lastIndexOf('/') + 1); } // Identify the appBase of the owning Host of this Context // (if any) - basename = war.substring(0, war.toLowerCase().indexOf(".war")); - File file = new File(getAppBase(), war); + basename = filename.substring(0, + filename.toLowerCase().indexOf(".war")); + File file = new File(getAppBase(), filename); if (file.exists()) { - message = sm.getString - ("htmlManagerServlet.deployUploadWarExists",war); + message = sm.getString( + "htmlManagerServlet.deployUploadWarExists", + filename); break; } String path = null; @@ -238,15 +230,16 @@ } if ((host.findChild(path) != null) && !isDeployed(path)) { - message = sm.getString - ("htmlManagerServlet.deployUploadInServerXml", war); + message = sm.getString( + "htmlManagerServlet.deployUploadInServerXml", + filename); break; } if (!isServiced(path)) { addServiced(path); try { - warUpload.write(file); + warPart.write(file.getAbsolutePath()); // Perform new deployment check(path); } finally { @@ -260,15 +253,41 @@ ("htmlManagerServlet.deployUploadFail", e.getMessage()); log(message, e); } finally { - if (warUpload != null) { - warUpload.delete(); + if (warPart != null) { + warPart.delete(); } - warUpload = null; + warPart = null; } list(request, response, message); } + private String extractFilename(String cd) { + String fileName = null; + if (cd != null) { + String cdl = cd.toLowerCase(); + if (cdl.startsWith("form-data") || cdl.startsWith("attachment")) { + ParameterParser parser = new ParameterParser(); + parser.setLowerCaseNames(true); + // Parameter parser can handle null input + Map<String,String> params = + parser.parse(cd, ';'); + if (params.containsKey("filename")) { + fileName = params.get("filename"); + if (fileName != null) { + fileName = fileName.trim(); + } else { + // Even if there is no value, the parameter is present, + // so we return an empty file name rather than no file + // name. + fileName = ""; + } + } + } + } + return fileName; + } + /** * Deploy an application for the specified path from the specified * web application archive. Added: trunk/java/org/apache/tomcat/util/http/fileupload/ByteArrayOutputStream.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/ByteArrayOutputStream.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/ByteArrayOutputStream.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,312 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.UnsupportedEncodingException; +import java.util.ArrayList; +import java.util.List; + +/** + * This class implements an output stream in which the data is + * written into a byte array. The buffer automatically grows as data + * is written to it. + * <p> + * The data can be retrieved using <code>toByteArray()</code> and + * <code>toString()</code>. + * <p> + * Closing a <tt>ByteArrayOutputStream</tt> has no effect. The methods in + * this class can be called after the stream has been closed without + * generating an <tt>IOException</tt>. + * <p> + * This is an alternative implementation of the java.io.ByteArrayOutputStream + * class. The original implementation only allocates 32 bytes at the beginning. + * As this class is designed for heavy duty it starts at 1024 bytes. In contrast + * to the original it doesn't reallocate the whole memory block but allocates + * additional buffers. This way no buffers need to be garbage collected and + * the contents don't have to be copied to the new buffer. This class is + * designed to behave exactly like the original. The only exception is the + * deprecated toString(int) method that has been ignored. + * + * @author <a href="mailto:jeremias@apache.org">Jeremias Maerki</a> + * @author Holger Hoffstatte + * @version $Id: ByteArrayOutputStream.java 881562 2009-11-17 22:03:22Z markt $ + */ +public class ByteArrayOutputStream extends OutputStream { + + /** A singleton empty byte array. */ + private static final byte[] EMPTY_BYTE_ARRAY = new byte[0]; + + /** The list of buffers, which grows and never reduces. */ + private List<byte[]> buffers = new ArrayList<byte[]>(); + /** The index of the current buffer. */ + private int currentBufferIndex; + /** The total count of bytes in all the filled buffers. */ + private int filledBufferSum; + /** The current buffer. */ + private byte[] currentBuffer; + /** The total count of bytes written. */ + private int count; + + /** + * Creates a new byte array output stream. The buffer capacity is + * initially 1024 bytes, though its size increases if necessary. + */ + public ByteArrayOutputStream() { + this(1024); + } + + /** + * Creates a new byte array output stream, with a buffer capacity of + * the specified size, in bytes. + * + * @param size the initial size + * @throws IllegalArgumentException if size is negative + */ + public ByteArrayOutputStream(int size) { + if (size < 0) { + throw new IllegalArgumentException( + "Negative initial size: " + size); + } + needNewBuffer(size); + } + + /** + * Return the appropriate <code>byte[]</code> buffer + * specified by index. + * + * @param index the index of the buffer required + * @return the buffer + */ + private byte[] getBuffer(int index) { + return buffers.get(index); + } + + /** + * Makes a new buffer available either by allocating + * a new one or re-cycling an existing one. + * + * @param newcount the size of the buffer if one is created + */ + private void needNewBuffer(int newcount) { + if (currentBufferIndex < buffers.size() - 1) { + //Recycling old buffer + filledBufferSum += currentBuffer.length; + + currentBufferIndex++; + currentBuffer = getBuffer(currentBufferIndex); + } else { + //Creating new buffer + int newBufferSize; + if (currentBuffer == null) { + newBufferSize = newcount; + filledBufferSum = 0; + } else { + newBufferSize = Math.max( + currentBuffer.length << 1, + newcount - filledBufferSum); + filledBufferSum += currentBuffer.length; + } + + currentBufferIndex++; + currentBuffer = new byte[newBufferSize]; + buffers.add(currentBuffer); + } + } + + /** + * Write the bytes to byte array. + * @param b the bytes to write + * @param off The start offset + * @param len The number of bytes to write + */ + @Override + public void write(byte[] b, int off, int len) { + if ((off < 0) + || (off > b.length) + || (len < 0) + || ((off + len) > b.length) + || ((off + len) < 0)) { + throw new IndexOutOfBoundsException(); + } else if (len == 0) { + return; + } + synchronized (this) { + int newcount = count + len; + int remaining = len; + int inBufferPos = count - filledBufferSum; + while (remaining > 0) { + int part = Math.min(remaining, currentBuffer.length - inBufferPos); + System.arraycopy(b, off + len - remaining, currentBuffer, inBufferPos, part); + remaining -= part; + if (remaining > 0) { + needNewBuffer(newcount); + inBufferPos = 0; + } + } + count = newcount; + } + } + + /** + * Write a byte to byte array. + * @param b the byte to write + */ + @Override + public synchronized void write(int b) { + int inBufferPos = count - filledBufferSum; + if (inBufferPos == currentBuffer.length) { + needNewBuffer(count + 1); + inBufferPos = 0; + } + currentBuffer[inBufferPos] = (byte) b; + count++; + } + + /** + * Writes the entire contents of the specified input stream to this + * byte stream. Bytes from the input stream are read directly into the + * internal buffers of this streams. + * + * @param in the input stream to read from + * @return total number of bytes read from the input stream + * (and written to this stream) + * @throws IOException if an I/O error occurs while reading the input stream + * @since Commons IO 1.4 + */ + public synchronized int write(InputStream in) throws IOException { + int readCount = 0; + int inBufferPos = count - filledBufferSum; + int n = in.read(currentBuffer, inBufferPos, currentBuffer.length - inBufferPos); + while (n != -1) { + readCount += n; + inBufferPos += n; + count += n; + if (inBufferPos == currentBuffer.length) { + needNewBuffer(currentBuffer.length); + inBufferPos = 0; + } + n = in.read(currentBuffer, inBufferPos, currentBuffer.length - inBufferPos); + } + return readCount; + } + + /** + * Return the current size of the byte array. + * @return the current size of the byte array + */ + public synchronized int size() { + return count; + } + + /** + * Closing a <tt>ByteArrayOutputStream</tt> has no effect. The methods in + * this class can be called after the stream has been closed without + * generating an <tt>IOException</tt>. + * + * @throws IOException never (this method should not declare this exception + * but it has to now due to backwards compatability) + */ + @Override + public void close() throws IOException { + //nop + } + + /** + * @see java.io.ByteArrayOutputStream#reset() + */ + public synchronized void reset() { + count = 0; + filledBufferSum = 0; + currentBufferIndex = 0; + currentBuffer = getBuffer(currentBufferIndex); + } + + /** + * Writes the entire contents of this byte stream to the + * specified output stream. + * + * @param out the output stream to write to + * @throws IOException if an I/O error occurs, such as if the stream is closed + * @see java.io.ByteArrayOutputStream#writeTo(OutputStream) + */ + public synchronized void writeTo(OutputStream out) throws IOException { + int remaining = count; + for (int i = 0; i < buffers.size(); i++) { + byte[] buf = getBuffer(i); + int c = Math.min(buf.length, remaining); + out.write(buf, 0, c); + remaining -= c; + if (remaining == 0) { + break; + } + } + } + + /** + * Gets the curent contents of this byte stream as a byte array. + * The result is independent of this stream. + * + * @return the current contents of this output stream, as a byte array + * @see java.io.ByteArrayOutputStream#toByteArray() + */ + public synchronized byte[] toByteArray() { + int remaining = count; + if (remaining == 0) { + return EMPTY_BYTE_ARRAY; + } + byte newbuf[] = new byte[remaining]; + int pos = 0; + for (int i = 0; i < buffers.size(); i++) { + byte[] buf = getBuffer(i); + int c = Math.min(buf.length, remaining); + System.arraycopy(buf, 0, newbuf, pos, c); + pos += c; + remaining -= c; + if (remaining == 0) { + break; + } + } + return newbuf; + } + + /** + * Gets the curent contents of this byte stream as a string. + * @return the contents of the byte array as a String + * @see java.io.ByteArrayOutputStream#toString() + */ + @Override + public String toString() { + return new String(toByteArray()); + } + + /** + * Gets the curent contents of this byte stream as a string + * using the specified encoding. + * + * @param enc the name of the character encoding + * @return the string converted from the byte array + * @throws UnsupportedEncodingException if the encoding is not supported + * @see java.io.ByteArrayOutputStream#toString(String) + */ + public String toString(String enc) throws UnsupportedEncodingException { + return new String(toByteArray(), enc); + } + +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/Closeable.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/Closeable.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/Closeable.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,38 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.IOException; + + +/** + * Interface of an object, which may be closed. + */ +public interface Closeable { + /** + * Closes the object. + * @throws IOException An I/O error occurred. + */ + void close() throws IOException; + + /** + * Returns, whether the object is already closed. + * @return True, if the object is closed, otherwise false. + * @throws IOException An I/O error occurred. + */ + boolean isClosed() throws IOException; +} Deleted: trunk/java/org/apache/tomcat/util/http/fileupload/DefaultFileItem.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/DefaultFileItem.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/DefaultFileItem.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -1,645 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; - - -import java.io.BufferedInputStream; -import java.io.BufferedOutputStream; -import java.io.ByteArrayInputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.FileOutputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.io.UnsupportedEncodingException; -import java.util.Collection; -import java.util.Map; - - -/** - * <p> The default implementation of the - * {@link org.apache.tomcat.util.http.fileupload.FileItem FileItem} interface. - * - * <p> After retrieving an instance of this class from a {@link - * org.apache.tomcat.util.http.fileupload.DiskFileUpload DiskFileUpload} instance (see - * {@link org.apache.tomcat.util.http.fileupload.DiskFileUpload - * #parseRequest(javax.servlet.http.HttpServletRequest)}), you may - * either request all contents of file at once using {@link #get()} or - * request an {@link java.io.InputStream InputStream} with - * {@link #getInputStream()} and process the file without attempting to load - * it into memory, which may come handy with large files. - * - * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a> - * @author <a href="mailto:sean@informage.net">Sean Legassick</a> - * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> - * @author <a href="mailto:jmcnally@apache.org">John McNally</a> - * @author <a href="mailto:martinc@apache.org">Martin Cooper</a> - * @author Sean C. Sullivan - * - * @version $Id$ - */ -public class DefaultFileItem - implements FileItem -{ - - // ----------------------------------------------------------- Data members - - - /** - * Counter used in unique identifier generation. - */ - private static int counter = 0; - - - /** - * The name of the form field as provided by the browser. - */ - private String fieldName; - - - /** - * The content type passed by the browser, or <code>null</code> if - * not defined. - */ - private String contentType; - - - /** - * Whether or not this item is a simple form field. - */ - private boolean isFormField; - - - /** - * The original filename in the user's filesystem. - */ - private String fileName; - - - /** - * The threshold above which uploads will be stored on disk. - */ - private int sizeThreshold; - - - /** - * The directory in which uploaded files will be stored, if stored on disk. - */ - private File repository; - - - /** - * Cached contents of the file. - */ - private byte[] cachedContent; - - - /** - * Output stream for this item. - */ - private transient DeferredFileOutputStream dfos; - - - /** - * Headers associated with the file item. - */ - private Map<String, String> headers; - - - // ----------------------------------------------------------- Constructors - - - /** - * Constructs a new <code>DefaultFileItem</code> instance. - * - * @param fieldName The name of the form field. - * @param contentType The content type passed by the browser or - * <code>null</code> if not specified. - * @param isFormField Whether or not this item is a plain form field, as - * opposed to a file upload. - * @param fileName The original filename in the user's filesystem, or - * <code>null</code> if not specified. - * @param sizeThreshold The threshold, in bytes, below which items will be - * retained in memory and above which they will be - * stored as a file. - * @param repository The data repository, which is the directory in - * which files will be created, should the item size - * exceed the threshold. - */ - DefaultFileItem(String fieldName, String contentType, boolean isFormField, - String fileName, Map<String, String> headers, int sizeThreshold, - File repository) - { - this.fieldName = fieldName; - this.contentType = contentType; - this.isFormField = isFormField; - this.fileName = fileName; - this.headers = headers; - this.sizeThreshold = sizeThreshold; - this.repository = repository; - } - - - // ------------------------------- Methods from javax.activation.DataSource - - - /** - * Returns an {@link java.io.InputStream InputStream} that can be - * used to retrieve the contents of the file. - * - * @return An {@link java.io.InputStream InputStream} that can be - * used to retrieve the contents of the file. - * - * @exception IOException if an error occurs. - */ - public InputStream getInputStream() - throws IOException - { - if (!dfos.isInMemory()) - { - return new FileInputStream(dfos.getFile()); - } - - if (cachedContent == null) - { - cachedContent = dfos.getData(); - } - return new ByteArrayInputStream(cachedContent); - } - - - /** - * Returns the content type passed by the browser or <code>null</code> if - * not defined. - * - * @return The content type passed by the browser or <code>null</code> if - * not defined. - */ - public String getContentType() - { - return contentType; - } - - - /** - * Returns the original filename in the client's filesystem. - * - * @return The original filename in the client's filesystem. - */ - public String getFileName() - { - return fileName; - } - - - // ------------------------------------------------------- FileItem methods - - - /** - * Provides a hint as to whether or not the file contents will be read - * from memory. - * - * @return <code>true</code> if the file contents will be read - * from memory; <code>false</code> otherwise. - */ - public boolean isInMemory() - { - return (dfos.isInMemory()); - } - - - /** - * Returns the size of the file. - * - * @return The size of the file, in bytes. - */ - public long getSize() - { - if (cachedContent != null) - { - return cachedContent.length; - } - else if (dfos.isInMemory()) - { - return dfos.getData().length; - } - else - { - return dfos.getFile().length(); - } - } - - - /** - * Returns the contents of the file as an array of bytes. If the - * contents of the file were not yet cached in memory, they will be - * loaded from the disk storage and cached. - * - * @return The contents of the file as an array of bytes. - */ - public byte[] get() - { - if (dfos.isInMemory()) - { - if (cachedContent == null) - { - cachedContent = dfos.getData(); - } - return cachedContent; - } - - byte[] fileData = new byte[(int) getSize()]; - FileInputStream fis = null; - - try - { - fis = new FileInputStream(dfos.getFile()); - fis.read(fileData); - } - catch (IOException e) - { - fileData = null; - } - finally - { - if (fis != null) - { - try - { - fis.close(); - } - catch (IOException e) - { - // ignore - } - } - } - - return fileData; - } - - - /** - * Returns the contents of the file as a String, using the specified - * encoding. This method uses {@link #get()} to retrieve the - * contents of the file. - * - * @param encoding The character encoding to use. - * - * @return The contents of the file, as a string. - * - * @exception UnsupportedEncodingException if the requested character - * encoding is not available. - */ - public String getString(String encoding) - throws UnsupportedEncodingException - { - return new String(get(), encoding); - } - - - /** - * Returns the contents of the file as a String, using the default - * character encoding. This method uses {@link #get()} to retrieve the - * contents of the file. - * - * @return The contents of the file, as a string. - */ - public String getString() - { - return new String(get()); - } - - - /** - * A convenience method to write an uploaded item to disk. The client code - * is not concerned with whether or not the item is stored in memory, or on - * disk in a temporary location. They just want to write the uploaded item - * to a file. - * <p> - * This implementation first attempts to rename the uploaded item to the - * specified destination file, if the item was originally written to disk. - * Otherwise, the data will be copied to the specified file. - * <p> - * This method is only guaranteed to work <em>once</em>, the first time it - * is invoked for a particular item. This is because, in the event that the - * method renames a temporary file, that file will no longer be available - * to copy or rename again at a later time. - * - * @param file The <code>File</code> into which the uploaded item should - * be stored. - * - * @exception Exception if an error occurs. - */ - public void write(File file) throws IOException - { - if (isInMemory()) - { - FileOutputStream fout = null; - try - { - fout = new FileOutputStream(file); - fout.write(get()); - } - finally - { - if (fout != null) - { - fout.close(); - } - } - } - else - { - File outputFile = getStoreLocation(); - if (outputFile != null) - { - /* - * The uploaded file is being stored on disk - * in a temporary location so move it to the - * desired file. - */ - if (!outputFile.renameTo(file)) - { - BufferedInputStream in = null; - BufferedOutputStream out = null; - try - { - in = new BufferedInputStream( - new FileInputStream(outputFile)); - out = new BufferedOutputStream( - new FileOutputStream(file)); - byte[] bytes = new byte[2048]; - int s = 0; - while ((s = in.read(bytes)) != -1) - { - out.write(bytes, 0, s); - } - } - finally - { - try - { - in.close(); - } - catch (IOException e) - { - // ignore - } - try - { - out.close(); - } - catch (IOException e) - { - // ignore - } - } - } - } - else - { - /* - * For whatever reason we cannot write the - * file to disk. - */ - throw new FileUploadException( - "Cannot write uploaded file to disk!"); - } - } - } - - - /** - * Deletes the underlying storage for a file item, including deleting any - * associated temporary disk file. Although this storage will be deleted - * automatically when the <code>FileItem</code> instance is garbage - * collected, this method can be used to ensure that this is done at an - * earlier time, thus preserving system resources. - */ - public void delete() - { - cachedContent = null; - File outputFile = getStoreLocation(); - if (outputFile != null && outputFile.exists()) - { - outputFile.delete(); - } - } - - - /** - * Returns the name of the field in the multipart form corresponding to - * this file item. - * - * @return The name of the form field. - * - * @see #setFieldName(java.lang.String) - * - */ - public String getFieldName() - { - return fieldName; - } - - - public String getName() - { - return fieldName; - } - - - /** - * Sets the field name used to reference this file item. - * - * @param fieldName The name of the form field. - * - * @see #getFieldName() - * - */ - public void setFieldName(String fieldName) - { - this.fieldName = fieldName; - } - - - /** - * Determines whether or not a <code>FileItem</code> instance represents - * a simple form field. - * - * @return <code>true</code> if the instance represents a simple form - * field; <code>false</code> if it represents an uploaded file. - * - * @see #setFormField(boolean) - * - */ - public boolean isFormField() - { - return isFormField; - } - - - /** - * Specifies whether or not a <code>FileItem</code> instance represents - * a simple form field. - * - * @param state <code>true</code> if the instance represents a simple form - * field; <code>false</code> if it represents an uploaded file. - * - * @see #isFormField() - * - */ - public void setFormField(boolean state) - { - isFormField = state; - } - - - /** - * Returns an {@link java.io.OutputStream OutputStream} that can - * be used for storing the contents of the file. - * - * @return An {@link java.io.OutputStream OutputStream} that can be used - * for storing the contensts of the file. - * - * @exception IOException if an error occurs. - */ - public OutputStream getOutputStream() - throws IOException - { - if (dfos == null) - { - File outputFile = getTempFile(); - dfos = new DeferredFileOutputStream(sizeThreshold, outputFile); - } - return dfos; - } - - - public String getHeader(String name) { - return headers.get(name); - } - - - public Collection<String> getHeaderNames() { - return headers.keySet(); - } - - - public Collection<String> getHeaders(String name) { - // FIXME: Create a Set out of the comma separated values - return null; - } - - - public void write(String fileName) throws IOException { - write(new File(fileName)); - } - - // --------------------------------------------------------- Public methods - - - /** - * Returns the {@link java.io.File} object for the <code>FileItem</code>'s - * data's temporary location on the disk. Note that for - * <code>FileItem</code>s that have their data stored in memory, - * this method will return <code>null</code>. When handling large - * files, you can use {@link java.io.File#renameTo(java.io.File)} to - * move the file to new location without copying the data, if the - * source and destination locations reside within the same logical - * volume. - * - * @return The data file, or <code>null</code> if the data is stored in - * memory. - */ - public File getStoreLocation() - { - return dfos.getFile(); - } - - - // ------------------------------------------------------ Protected methods - - - /** - * Removes the file contents from the temporary storage. - */ - protected void finalize() - { - File outputFile = dfos.getFile(); - - if (outputFile != null && outputFile.exists()) - { - outputFile.delete(); - } - } - - - /** - * Creates and returns a {@link java.io.File File} representing a uniquely - * named temporary file in the configured repository path. - * - * @return The {@link java.io.File File} to be used for temporary storage. - */ - protected File getTempFile() - { - File tempDir = repository; - if (tempDir == null) - { - tempDir = new File(System.getProperty("java.io.tmpdir")); - } - - String fileName = "upload_" + getUniqueId() + ".tmp"; - - File f = new File(tempDir, fileName); - f.deleteOnExit(); - return f; - } - - - // -------------------------------------------------------- Private methods - - - /** - * Returns an identifier that is unique within the class loader used to - * load this class, but does not have random-like apearance. - * - * @return A String with the non-random looking instance identifier. - */ - private static String getUniqueId() - { - int current; - synchronized (DefaultFileItem.class) - { - current = counter++; - } - String id = Integer.toString(current); - - // If you manage to get more than 100 million of ids, you'll - // start getting ids longer than 8 characters. - if (current < 100000000) - { - id = ("00000000" + id).substring(id.length()); - } - return id; - } - - -} Deleted: trunk/java/org/apache/tomcat/util/http/fileupload/DefaultFileItemFactory.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/DefaultFileItemFactory.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/DefaultFileItemFactory.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -1,231 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; - -import java.io.File; -import java.util.Map; - - -/** - * <p>The default {@link org.apache.tomcat.util.http.fileupload.FileItemFactory} - * implementation. This implementation creates - * {@link org.apache.tomcat.util.http.fileupload.FileItem} instances which keep their - * content either in memory, for smaller items, or in a temporary file on disk, - * for larger items. The size threshold, above which content will be stored on - * disk, is configurable, as is the directory in which temporary files will be - * created.</p> - * - * <p>If not otherwise configured, the default configuration values are as - * follows: - * <ul> - * <li>Size threshold is 10KB.</li> - * <li>Repository is the system default temp directory, as returned by - * <code>System.getProperty("java.io.tmpdir")</code>.</li> - * </ul> - * </p> - * - * @author <a href="mailto:martinc@apache.org">Martin Cooper</a> - * - * @version $Id$ - */ -public class DefaultFileItemFactory implements FileItemFactory -{ - - // ----------------------------------------------------- Manifest constants - - - /** - * The default threshold above which uploads will be stored on disk. - */ - public static final int DEFAULT_SIZE_THRESHOLD = 10240; - - - /** - * The default max size for a file. - */ - public static final int DEFAULT_FILE_SIZE_MAX = -1; - - - // ----------------------------------------------------- Instance Variables - - - /** - * The directory in which uploaded files will be stored, if stored on disk. - */ - private File repository; - - - /** - * The threshold above which uploads will be stored on disk. - */ - private int sizeThreshold = DEFAULT_SIZE_THRESHOLD; - - - /** - * The max file size. - */ - private long fileSizeMax = DEFAULT_FILE_SIZE_MAX; - - - // ----------------------------------------------------------- Constructors - - - /** - * Constructs an unconfigured instance of this class. The resulting factory - * may be configured by calling the appropriate setter methods. - */ - public DefaultFileItemFactory() - { - } - - - /** - * Constructs a preconfigured instance of this class. - * - * @param sizeThreshold The threshold, in bytes, below which items will be - * retained in memory and above which they will be - * stored as a file. - * @param repository The data repository, which is the directory in - * which files will be created, should the item size - * exceed the threshold. - */ - public DefaultFileItemFactory(int sizeThreshold, File repository) - { - this.sizeThreshold = sizeThreshold; - this.repository = repository; - } - - - // ------------------------------------------------------------- Properties - - - /** - * Returns the directory used to temporarily store files that are larger - * than the configured size threshold. - * - * @return The directory in which temporary files will be located. - * - * @see #setRepository(java.io.File) - * - */ - public File getRepository() - { - return repository; - } - - - /** - * Sets the directory used to temporarily store files that are larger - * than the configured size threshold. - * - * @param repository The directory in which temporary files will be located. - * - * @see #getRepository() - * - */ - public void setRepository(File repository) - { - this.repository = repository; - } - - - /** - * Returns the size threshold beyond which files are written directly to - * disk. The default value is 1024 bytes. - * - * @return The size threshold, in bytes. - * - * @see #setSizeThreshold(int) - */ - public int getSizeThreshold() - { - return sizeThreshold; - } - - - /** - * Sets the size threshold beyond which files are written directly to disk. - * - * @param sizeThreshold The size threshold, in bytes. - * - * @see #getSizeThreshold() - * - */ - public void setSizeThreshold(int sizeThreshold) - { - this.sizeThreshold = sizeThreshold; - } - - - /** - * Returns the max size of a file. - * - * @return The size, in bytes. - * - * @see #setFileSizeMax(int) - */ - public long getFileSizeMax() - { - return fileSizeMax; - } - - - /** - * Sets the max size of a file. - * - * @param fileSizeMax The size, in bytes. - * - * @see #getSizeThreshold() - */ - public void setFileSizeMax(long fileSizeMax) - { - this.fileSizeMax = fileSizeMax; - } - - - // --------------------------------------------------------- Public Methods - - /** - * Create a new {@link org.apache.tomcat.util.http.fileupload.DefaultFileItem} - * instance from the supplied parameters and the local factory - * configuration. - * - * @param fieldName The name of the form field. - * @param contentType The content type of the form field. - * @param isFormField <code>true</code> if this is a plain form field; - * <code>false</code> otherwise. - * @param fileName The name of the uploaded file, if any, as supplied - * by the browser or other client. - * - * @return The newly created file item. - */ - public FileItem createItem( - String fieldName, - String contentType, - boolean isFormField, - String fileName, - Map<String, String> headers - ) - { - // FIXME: Add file size max - return new DefaultFileItem(fieldName, contentType, - isFormField, fileName, headers, sizeThreshold, repository); - } - -} Modified: trunk/java/org/apache/tomcat/util/http/fileupload/DeferredFileOutputStream.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/DeferredFileOutputStream.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/DeferredFileOutputStream.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -14,23 +14,28 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.tomcat.util.http.fileupload; -import java.io.ByteArrayOutputStream; import java.io.File; +import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStream; + /** - * <p>An output stream which will retain data in memory until a specified + * An output stream which will retain data in memory until a specified * threshold is reached, and only then commit it to disk. If the stream is * closed before the threshold is reached, the data will not be written to - * disk at all.</p> + * disk at all. + * <p> + * This class originated in FileUpload processing. In this use case, you do + * not know in advance the size of the file being uploaded. If the file is small + * you want to store it in memory (for speed), but if the file is large you want + * to store it to file (to avoid memory issues). * * @author <a href="mailto:martinc@apache.org">Martin Cooper</a> + * @author gaxzerow * * @version $Id$ */ @@ -49,13 +54,6 @@ /** - * The output stream to which data will be written after the theshold is - * reached. - */ - private FileOutputStream diskOutputStream; - - - /** * The output stream to which data will be written at any given time. This * will always be one of <code>memoryOutputStream</code> or * <code>diskOutputStream</code>. @@ -68,7 +66,27 @@ */ private File outputFile; + /** + * The temporary file prefix. + */ + private String prefix; + /** + * The temporary file suffix. + */ + private String suffix; + + /** + * The directory to use for temporary files. + */ + private File directory; + + + /** + * True when close() has been called successfully. + */ + private boolean closed = false; + // ----------------------------------------------------------- Constructors @@ -84,18 +102,34 @@ super(threshold); this.outputFile = outputFile; - if (threshold < DefaultFileItemFactory.DEFAULT_SIZE_THRESHOLD) { - // Small threshold, use it - memoryOutputStream = new ByteArrayOutputStream(threshold); - } else { - // Large threshold. Use default and array will expand if required - memoryOutputStream = new ByteArrayOutputStream( - DefaultFileItemFactory.DEFAULT_SIZE_THRESHOLD); - } + memoryOutputStream = new ByteArrayOutputStream(); currentOutputStream = memoryOutputStream; } + /** + * Constructs an instance of this class which will trigger an event at the + * specified threshold, and save data to a temporary file beyond that point. + * + * @param threshold The number of bytes at which to trigger an event. + * @param prefix Prefix to use for the temporary file. + * @param suffix Suffix to use for the temporary file. + * @param directory Temporary file directory. + * + * @since Commons IO 1.4 + */ + public DeferredFileOutputStream(int threshold, String prefix, String suffix, File directory) + { + this(threshold, (File)null); + if (prefix == null) { + throw new IllegalArgumentException("Temporary file prefix is missing"); + } + this.prefix = prefix; + this.suffix = suffix; + this.directory = directory; + } + + // --------------------------------------- ThresholdingOutputStream methods @@ -107,6 +141,7 @@ * * @exception IOException if an error occurs. */ + @Override protected OutputStream getStream() throws IOException { return currentOutputStream; @@ -121,12 +156,14 @@ * * @exception IOException if an error occurs. */ + @Override protected void thresholdReached() throws IOException { - byte[] data = memoryOutputStream.toByteArray(); + if (prefix != null) { + outputFile = File.createTempFile(prefix, suffix, directory); + } FileOutputStream fos = new FileOutputStream(outputFile); - fos.write(data); - diskOutputStream = fos; + memoryOutputStream.writeTo(fos); currentOutputStream = fos; memoryOutputStream = null; } @@ -167,9 +204,15 @@ /** - * Returns the data for this output stream as a <code>File</code>, assuming - * that the data was written to disk. If the data was retained in memory, - * this method returns <code>null</code>. + * Returns either the output file specified in the constructor or + * the temporary file created or null. + * <p> + * If the constructor specifying the file is used then it returns that + * same output file, even when threashold has not been reached. + * <p> + * If constructor specifying a temporary file prefix/suffix is used + * then the temporary file created once the threashold is reached is returned + * If the threshold was not reached then <code>null</code> is returned. * * @return The file for this output stream, or <code>null</code> if no such * file exists. @@ -178,4 +221,50 @@ { return outputFile; } + + + /** + * Closes underlying output stream, and mark this as closed + * + * @exception IOException if an error occurs. + */ + @Override + public void close() throws IOException + { + super.close(); + closed = true; + } + + + /** + * Writes the data from this output stream to the specified output stream, + * after it has been closed. + * + * @param out output stream to write to. + * @exception IOException if this stream is not yet closed or an error occurs. + */ + public void writeTo(OutputStream out) throws IOException + { + // we may only need to check if this is closed if we are working with a file + // but we should force the habit of closing wether we are working with + // a file or memory. + if (!closed) + { + throw new IOException("Stream not closed"); + } + + if(isInMemory()) + { + memoryOutputStream.writeTo(out); + } + else + { + FileInputStream fis = new FileInputStream(outputFile); + try { + IOUtils.copy(fis, out); + } finally { + IOUtils.closeQuietly(fis); + } + } + } } Added: trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileItem.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileItem.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileItem.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,728 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.BufferedInputStream; +import java.io.BufferedOutputStream; +import java.io.ByteArrayInputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.ObjectInputStream; +import java.io.ObjectOutputStream; +import java.io.OutputStream; +import java.io.UnsupportedEncodingException; +import java.util.Map; + + +/** + * <p> The default implementation of the + * {@link org.apache.commons.fileupload.FileItem FileItem} interface. + * + * <p> After retrieving an instance of this class from a {@link + * org.apache.commons.fileupload.DiskFileUpload DiskFileUpload} instance (see + * {@link org.apache.commons.fileupload.DiskFileUpload + * #parseRequest(javax.servlet.http.HttpServletRequest)}), you may + * either request all contents of file at once using {@link #get()} or + * request an {@link java.io.InputStream InputStream} with + * {@link #getInputStream()} and process the file without attempting to load + * it into memory, which may come handy with large files. + * + * <p>When using the <code>DiskFileItemFactory</code>, then you should + * consider the following: Temporary files are automatically deleted as + * soon as they are no longer needed. (More precisely, when the + * corresponding instance of {@link java.io.File} is garbage collected.) + * This is done by the so-called reaper thread, which is started + * automatically when the class {@link org.apache.commons.io.FileCleaner} + * is loaded. + * It might make sense to terminate that thread, for example, if + * your web application ends. See the section on "Resource cleanup" + * in the users guide of commons-fileupload.</p> + * + * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a> + * @author <a href="mailto:sean@informage.net">Sean Legassick</a> + * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> + * @author <a href="mailto:jmcnally@apache.org">John McNally</a> + * @author <a href="mailto:martinc@apache.org">Martin Cooper</a> + * @author Sean C. Sullivan + * + * @since FileUpload 1.1 + * + * @version $Id: DiskFileItem.java 881562 2009-11-17 22:03:22Z markt $ + */ +public class DiskFileItem + implements FileItem, FileItemHeadersSupport { + + // ----------------------------------------------------- Manifest constants + + /** + * The UID to use when serializing this instance. + */ + private static final long serialVersionUID = 2237570099615271025L; + + + /** + * Default content charset to be used when no explicit charset + * parameter is provided by the sender. Media subtypes of the + * "text" type are defined to have a default charset value of + * "ISO-8859-1" when received via HTTP. + */ + public static final String DEFAULT_CHARSET = "ISO-8859-1"; + + + // ----------------------------------------------------------- Data members + + + /** + * UID used in unique file name generation. + */ + private static final String UID = + new java.rmi.server.UID().toString() + .replace(':', '_').replace('-', '_'); + + /** + * Counter used in unique identifier generation. + */ + private static int counter = 0; + + + /** + * The name of the form field as provided by the browser. + */ + private String fieldName; + + + /** + * The content type passed by the browser, or <code>null</code> if + * not defined. + */ + private String contentType; + + + /** + * Whether or not this item is a simple form field. + */ + private boolean isFormField; + + + /** + * The original filename in the user's filesystem. + */ + private String fileName; + + + /** + * The size of the item, in bytes. This is used to cache the size when a + * file item is moved from its original location. + */ + private long size = -1; + + + /** + * The threshold above which uploads will be stored on disk. + */ + private int sizeThreshold; + + + /** + * The directory in which uploaded files will be stored, if stored on disk. + */ + private File repository; + + + /** + * Cached contents of the file. + */ + private byte[] cachedContent; + + + /** + * Output stream for this item. + */ + private transient DeferredFileOutputStream dfos; + + /** + * The temporary file to use. + */ + private transient File tempFile; + + /** + * File to allow for serialization of the content of this item. + */ + private File dfosFile; + + /** + * The file items headers. + */ + private FileItemHeaders headers; + + // ----------------------------------------------------------- Constructors + + + /** + * Constructs a new <code>DiskFileItem</code> instance. + * + * @param fieldName The name of the form field. + * @param contentType The content type passed by the browser or + * <code>null</code> if not specified. + * @param isFormField Whether or not this item is a plain form field, as + * opposed to a file upload. + * @param fileName The original filename in the user's filesystem, or + * <code>null</code> if not specified. + * @param sizeThreshold The threshold, in bytes, below which items will be + * retained in memory and above which they will be + * stored as a file. + * @param repository The data repository, which is the directory in + * which files will be created, should the item size + * exceed the threshold. + */ + public DiskFileItem(String fieldName, + String contentType, boolean isFormField, String fileName, + int sizeThreshold, File repository) { + this.fieldName = fieldName; + this.contentType = contentType; + this.isFormField = isFormField; + this.fileName = fileName; + this.sizeThreshold = sizeThreshold; + this.repository = repository; + } + + + // ------------------------------- Methods from javax.activation.DataSource + + + /** + * Returns an {@link java.io.InputStream InputStream} that can be + * used to retrieve the contents of the file. + * + * @return An {@link java.io.InputStream InputStream} that can be + * used to retrieve the contents of the file. + * + * @throws IOException if an error occurs. + */ + public InputStream getInputStream() + throws IOException { + if (!isInMemory()) { + return new FileInputStream(dfos.getFile()); + } + + if (cachedContent == null) { + cachedContent = dfos.getData(); + } + return new ByteArrayInputStream(cachedContent); + } + + + /** + * Returns the content type passed by the agent or <code>null</code> if + * not defined. + * + * @return The content type passed by the agent or <code>null</code> if + * not defined. + */ + public String getContentType() { + return contentType; + } + + + /** + * Returns the content charset passed by the agent or <code>null</code> if + * not defined. + * + * @return The content charset passed by the agent or <code>null</code> if + * not defined. + */ + public String getCharSet() { + ParameterParser parser = new ParameterParser(); + parser.setLowerCaseNames(true); + // Parameter parser can handle null input + Map<String,String> params = parser.parse(getContentType(), ';'); + return params.get("charset"); + } + + + /** + * Returns the original filename in the client's filesystem. + * + * @return The original filename in the client's filesystem. + */ + public String getName() { + return fileName; + } + + + // ------------------------------------------------------- FileItem methods + + + /** + * Provides a hint as to whether or not the file contents will be read + * from memory. + * + * @return <code>true</code> if the file contents will be read + * from memory; <code>false</code> otherwise. + */ + public boolean isInMemory() { + if (cachedContent != null) { + return true; + } + return dfos.isInMemory(); + } + + + /** + * Returns the size of the file. + * + * @return The size of the file, in bytes. + */ + public long getSize() { + if (size >= 0) { + return size; + } else if (cachedContent != null) { + return cachedContent.length; + } else if (dfos.isInMemory()) { + return dfos.getData().length; + } else { + return dfos.getFile().length(); + } + } + + + /** + * Returns the contents of the file as an array of bytes. If the + * contents of the file were not yet cached in memory, they will be + * loaded from the disk storage and cached. + * + * @return The contents of the file as an array of bytes. + */ + public byte[] get() { + if (isInMemory()) { + if (cachedContent == null) { + cachedContent = dfos.getData(); + } + return cachedContent; + } + + byte[] fileData = new byte[(int) getSize()]; + FileInputStream fis = null; + + try { + fis = new FileInputStream(dfos.getFile()); + fis.read(fileData); + } catch (IOException e) { + fileData = null; + } finally { + if (fis != null) { + try { + fis.close(); + } catch (IOException e) { + // ignore + } + } + } + + return fileData; + } + + + /** + * Returns the contents of the file as a String, using the specified + * encoding. This method uses {@link #get()} to retrieve the + * contents of the file. + * + * @param charset The charset to use. + * + * @return The contents of the file, as a string. + * + * @throws UnsupportedEncodingException if the requested character + * encoding is not available. + */ + public String getString(final String charset) + throws UnsupportedEncodingException { + return new String(get(), charset); + } + + + /** + * Returns the contents of the file as a String, using the default + * character encoding. This method uses {@link #get()} to retrieve the + * contents of the file. + * + * @return The contents of the file, as a string. + * + * @todo Consider making this method throw UnsupportedEncodingException. + */ + public String getString() { + byte[] rawdata = get(); + String charset = getCharSet(); + if (charset == null) { + charset = DEFAULT_CHARSET; + } + try { + return new String(rawdata, charset); + } catch (UnsupportedEncodingException e) { + return new String(rawdata); + } + } + + + /** + * A convenience method to write an uploaded item to disk. The client code + * is not concerned with whether or not the item is stored in memory, or on + * disk in a temporary location. They just want to write the uploaded item + * to a file. + * <p> + * This implementation first attempts to rename the uploaded item to the + * specified destination file, if the item was originally written to disk. + * Otherwise, the data will be copied to the specified file. + * <p> + * This method is only guaranteed to work <em>once</em>, the first time it + * is invoked for a particular item. This is because, in the event that the + * method renames a temporary file, that file will no longer be available + * to copy or rename again at a later time. + * + * @param file The <code>File</code> into which the uploaded item should + * be stored. + * + * @throws Exception if an error occurs. + */ + public void write(File file) throws Exception { + if (isInMemory()) { + FileOutputStream fout = null; + try { + fout = new FileOutputStream(file); + fout.write(get()); + } finally { + if (fout != null) { + fout.close(); + } + } + } else { + File outputFile = getStoreLocation(); + if (outputFile != null) { + // Save the length of the file + size = outputFile.length(); + /* + * The uploaded file is being stored on disk + * in a temporary location so move it to the + * desired file. + */ + if (!outputFile.renameTo(file)) { + BufferedInputStream in = null; + BufferedOutputStream out = null; + try { + in = new BufferedInputStream( + new FileInputStream(outputFile)); + out = new BufferedOutputStream( + new FileOutputStream(file)); + IOUtils.copy(in, out); + } finally { + if (in != null) { + try { + in.close(); + } catch (IOException e) { + // ignore + } + } + if (out != null) { + try { + out.close(); + } catch (IOException e) { + // ignore + } + } + } + } + } else { + /* + * For whatever reason we cannot write the + * file to disk. + */ + throw new FileUploadException( + "Cannot write uploaded file to disk!"); + } + } + } + + + /** + * Deletes the underlying storage for a file item, including deleting any + * associated temporary disk file. Although this storage will be deleted + * automatically when the <code>FileItem</code> instance is garbage + * collected, this method can be used to ensure that this is done at an + * earlier time, thus preserving system resources. + */ + public void delete() { + cachedContent = null; + File outputFile = getStoreLocation(); + if (outputFile != null && outputFile.exists()) { + outputFile.delete(); + } + } + + + /** + * Returns the name of the field in the multipart form corresponding to + * this file item. + * + * @return The name of the form field. + * + * @see #setFieldName(java.lang.String) + * + */ + public String getFieldName() { + return fieldName; + } + + + /** + * Sets the field name used to reference this file item. + * + * @param fieldName The name of the form field. + * + * @see #getFieldName() + * + */ + public void setFieldName(String fieldName) { + this.fieldName = fieldName; + } + + + /** + * Determines whether or not a <code>FileItem</code> instance represents + * a simple form field. + * + * @return <code>true</code> if the instance represents a simple form + * field; <code>false</code> if it represents an uploaded file. + * + * @see #setFormField(boolean) + * + */ + public boolean isFormField() { + return isFormField; + } + + + /** + * Specifies whether or not a <code>FileItem</code> instance represents + * a simple form field. + * + * @param state <code>true</code> if the instance represents a simple form + * field; <code>false</code> if it represents an uploaded file. + * + * @see #isFormField() + * + */ + public void setFormField(boolean state) { + isFormField = state; + } + + + /** + * Returns an {@link java.io.OutputStream OutputStream} that can + * be used for storing the contents of the file. + * + * @return An {@link java.io.OutputStream OutputStream} that can be used + * for storing the contensts of the file. + * + * @throws IOException if an error occurs. + */ + public OutputStream getOutputStream() + throws IOException { + if (dfos == null) { + File outputFile = getTempFile(); + dfos = new DeferredFileOutputStream(sizeThreshold, outputFile); + } + return dfos; + } + + + // --------------------------------------------------------- Public methods + + + /** + * Returns the {@link java.io.File} object for the <code>FileItem</code>'s + * data's temporary location on the disk. Note that for + * <code>FileItem</code>s that have their data stored in memory, + * this method will return <code>null</code>. When handling large + * files, you can use {@link java.io.File#renameTo(java.io.File)} to + * move the file to new location without copying the data, if the + * source and destination locations reside within the same logical + * volume. + * + * @return The data file, or <code>null</code> if the data is stored in + * memory. + */ + public File getStoreLocation() { + return dfos == null ? null : dfos.getFile(); + } + + + // ------------------------------------------------------ Protected methods + + + /** + * Removes the file contents from the temporary storage. + */ + @Override + protected void finalize() { + File outputFile = dfos.getFile(); + + if (outputFile != null && outputFile.exists()) { + outputFile.delete(); + } + } + + + /** + * Creates and returns a {@link java.io.File File} representing a uniquely + * named temporary file in the configured repository path. The lifetime of + * the file is tied to the lifetime of the <code>FileItem</code> instance; + * the file will be deleted when the instance is garbage collected. + * + * @return The {@link java.io.File File} to be used for temporary storage. + */ + protected File getTempFile() { + if (tempFile == null) { + File tempDir = repository; + if (tempDir == null) { + tempDir = new File(System.getProperty("java.io.tmpdir")); + } + + String tempFileName = + "upload_" + UID + "_" + getUniqueId() + ".tmp"; + + tempFile = new File(tempDir, tempFileName); + } + return tempFile; + } + + + // -------------------------------------------------------- Private methods + + + /** + * Returns an identifier that is unique within the class loader used to + * load this class, but does not have random-like apearance. + * + * @return A String with the non-random looking instance identifier. + */ + private static String getUniqueId() { + final int limit = 100000000; + int current; + synchronized (DiskFileItem.class) { + current = counter++; + } + String id = Integer.toString(current); + + // If you manage to get more than 100 million of ids, you'll + // start getting ids longer than 8 characters. + if (current < limit) { + id = ("00000000" + id).substring(id.length()); + } + return id; + } + + + + + /** + * Returns a string representation of this object. + * + * @return a string representation of this object. + */ + @Override + public String toString() { + return "name=" + this.getName() + + ", StoreLocation=" + + String.valueOf(this.getStoreLocation()) + + ", size=" + + this.getSize() + + "bytes, " + + "isFormField=" + isFormField() + + ", FieldName=" + + this.getFieldName(); + } + + + // -------------------------------------------------- Serialization methods + + + /** + * Writes the state of this object during serialization. + * + * @param out The stream to which the state should be written. + * + * @throws IOException if an error occurs. + */ + private void writeObject(ObjectOutputStream out) throws IOException { + // Read the data + if (dfos.isInMemory()) { + cachedContent = get(); + } else { + cachedContent = null; + dfosFile = dfos.getFile(); + } + + // write out values + out.defaultWriteObject(); + } + + /** + * Reads the state of this object during deserialization. + * + * @param in The stream from which the state should be read. + * + * @throws IOException if an error occurs. + * @throws ClassNotFoundException if class cannot be found. + */ + private void readObject(ObjectInputStream in) + throws IOException, ClassNotFoundException { + // read values + in.defaultReadObject(); + + OutputStream output = getOutputStream(); + if (cachedContent != null) { + output.write(cachedContent); + } else { + FileInputStream input = new FileInputStream(dfosFile); + IOUtils.copy(input, output); + dfosFile.delete(); + dfosFile = null; + } + output.close(); + + cachedContent = null; + } + + /** + * Returns the file item headers. + * @return The file items headers. + */ + public FileItemHeaders getHeaders() { + return headers; + } + + /** + * Sets the file item headers. + * @param pHeaders The file items headers. + */ + public void setHeaders(FileItemHeaders pHeaders) { + headers = pHeaders; + } +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileItemFactory.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileItemFactory.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileItemFactory.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,223 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.File; + + +/** + * <p>The default {@link org.apache.commons.fileupload.FileItemFactory} + * implementation. This implementation creates + * {@link org.apache.commons.fileupload.FileItem} instances which keep their + * content either in memory, for smaller items, or in a temporary file on disk, + * for larger items. The size threshold, above which content will be stored on + * disk, is configurable, as is the directory in which temporary files will be + * created.</p> + * + * <p>If not otherwise configured, the default configuration values are as + * follows: + * <ul> + * <li>Size threshold is 10KB.</li> + * <li>Repository is the system default temp directory, as returned by + * <code>System.getProperty("java.io.tmpdir")</code>.</li> + * </ul> + * </p> + * + * <p>When using the <code>DiskFileItemFactory</code>, then you should + * consider the following: Temporary files are automatically deleted as + * soon as they are no longer needed. (More precisely, when the + * corresponding instance of {@link java.io.File} is garbage collected.) + * Cleaning up those files is done by an instance of + * {@link FileCleaningTracker}, and an associated thread. In a complex + * environment, for example in a web application, you should consider + * terminating this thread, for example, when your web application + * ends. See the section on "Resource cleanup" + * in the users guide of commons-fileupload.</p> + * + * @author <a href="mailto:martinc@apache.org">Martin Cooper</a> + * + * @since FileUpload 1.1 + * + * @version $Id: DiskFileItemFactory.java 881493 2009-11-17 20:30:39Z markt $ + */ +public class DiskFileItemFactory implements FileItemFactory { + + // ----------------------------------------------------- Manifest constants + + + /** + * The default threshold above which uploads will be stored on disk. + */ + public static final int DEFAULT_SIZE_THRESHOLD = 10240; + + + // ----------------------------------------------------- Instance Variables + + + /** + * The directory in which uploaded files will be stored, if stored on disk. + */ + private File repository; + + + /** + * The threshold above which uploads will be stored on disk. + */ + private int sizeThreshold = DEFAULT_SIZE_THRESHOLD; + + + /** + * <p>The instance of {@link FileCleaningTracker}, which is responsible + * for deleting temporary files.</p> + * <p>May be null, if tracking files is not required.</p> + */ + private FileCleaningTracker fileCleaningTracker; + + // ----------------------------------------------------------- Constructors + + + /** + * Constructs an unconfigured instance of this class. The resulting factory + * may be configured by calling the appropriate setter methods. + */ + public DiskFileItemFactory() { + this(DEFAULT_SIZE_THRESHOLD, null); + } + + + /** + * Constructs a preconfigured instance of this class. + * + * @param sizeThreshold The threshold, in bytes, below which items will be + * retained in memory and above which they will be + * stored as a file. + * @param repository The data repository, which is the directory in + * which files will be created, should the item size + * exceed the threshold. + */ + public DiskFileItemFactory(int sizeThreshold, File repository) { + this.sizeThreshold = sizeThreshold; + this.repository = repository; + } + + // ------------------------------------------------------------- Properties + + + /** + * Returns the directory used to temporarily store files that are larger + * than the configured size threshold. + * + * @return The directory in which temporary files will be located. + * + * @see #setRepository(java.io.File) + * + */ + public File getRepository() { + return repository; + } + + + /** + * Sets the directory used to temporarily store files that are larger + * than the configured size threshold. + * + * @param repository The directory in which temporary files will be located. + * + * @see #getRepository() + * + */ + public void setRepository(File repository) { + this.repository = repository; + } + + + /** + * Returns the size threshold beyond which files are written directly to + * disk. The default value is 10240 bytes. + * + * @return The size threshold, in bytes. + * + * @see #setSizeThreshold(int) + */ + public int getSizeThreshold() { + return sizeThreshold; + } + + + /** + * Sets the size threshold beyond which files are written directly to disk. + * + * @param sizeThreshold The size threshold, in bytes. + * + * @see #getSizeThreshold() + * + */ + public void setSizeThreshold(int sizeThreshold) { + this.sizeThreshold = sizeThreshold; + } + + + // --------------------------------------------------------- Public Methods + + /** + * Create a new {@link org.apache.commons.fileupload.disk.DiskFileItem} + * instance from the supplied parameters and the local factory + * configuration. + * + * @param fieldName The name of the form field. + * @param contentType The content type of the form field. + * @param isFormField <code>true</code> if this is a plain form field; + * <code>false</code> otherwise. + * @param fileName The name of the uploaded file, if any, as supplied + * by the browser or other client. + * + * @return The newly created file item. + */ + public FileItem createItem(String fieldName, String contentType, + boolean isFormField, String fileName) { + DiskFileItem result = new DiskFileItem(fieldName, contentType, + isFormField, fileName, sizeThreshold, repository); + FileCleaningTracker tracker = getFileCleaningTracker(); + if (tracker != null) { + tracker.track(result.getTempFile(), this); + } + return result; + } + + + /** + * Returns the tracker, which is responsible for deleting temporary + * files. + * @return An instance of {@link FileCleaningTracker}, defaults to + * {@link org.apache.commons.io.FileCleaner#getInstance()}. Null, + * if temporary files aren't tracked. + */ + public FileCleaningTracker getFileCleaningTracker() { + return fileCleaningTracker; + } + + /** + * Returns the tracker, which is responsible for deleting temporary + * files. + * @param pTracker An instance of {@link FileCleaningTracker}, + * which will from now on track the created files. May be null + * to disable tracking. + */ + public void setFileCleaningTracker(FileCleaningTracker pTracker) { + fileCleaningTracker = pTracker; + } +} Deleted: trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileUpload.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileUpload.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/DiskFileUpload.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -1,231 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; - - -import java.io.File; -import java.io.IOException; -import java.util.List; -import javax.servlet.http.HttpServletRequest; - - -/** - * <p>High level API for processing file uploads.</p> - * - * <p>This class handles multiple files per single HTML widget, sent using - * <code>multipart/mixed</code> encoding type, as specified by - * <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>. Use {@link - * #parseRequest(HttpServletRequest)} to acquire a list of {@link - * org.apache.tomcat.util.http.fileupload.FileItem}s associated with a given HTML - * widget.</p> - * - * <p>Individual parts will be stored in temporary disk storage or in memory, - * depending on their size, and will be available as {@link - * org.apache.tomcat.util.http.fileupload.FileItem}s.</p> - * - * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a> - * @author <a href="mailto:dlr@collab.net">Daniel Rall</a> - * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> - * @author <a href="mailto:jmcnally@collab.net">John McNally</a> - * @author <a href="mailto:martinc@apache.org">Martin Cooper</a> - * @author Sean C. Sullivan - * - * @version $Id$ - */ -public class DiskFileUpload - extends FileUploadBase - { - - // ----------------------------------------------------------- Data members - - - /** - * The factory to use to create new form items. - */ - private DefaultFileItemFactory fileItemFactory; - - - // ----------------------------------------------------------- Constructors - - - /** - * Constructs an instance of this class which uses the default factory to - * create <code>FileItem</code> instances. - * - * @see #DiskFileUpload(DefaultFileItemFactory fileItemFactory) - */ - public DiskFileUpload() - { - super(); - this.fileItemFactory = new DefaultFileItemFactory(); - } - - - /** - * Constructs an instance of this class which uses the supplied factory to - * create <code>FileItem</code> instances. - * - * @see #DiskFileUpload() - */ - public DiskFileUpload(DefaultFileItemFactory fileItemFactory) - { - super(); - this.fileItemFactory = fileItemFactory; - } - - - // ----------------------------------------------------- Property accessors - - - /** - * Returns the factory class used when creating file items. - * - * @return The factory class for new file items. - */ - public FileItemFactory getFileItemFactory() - { - return fileItemFactory; - } - - - /** - * Sets the factory class to use when creating file items. The factory must - * be an instance of <code>DefaultFileItemFactory</code> or a subclass - * thereof, or else a <code>ClassCastException</code> will be thrown. - * - * @param factory The factory class for new file items. - */ - public void setFileItemFactory(FileItemFactory factory) - { - this.fileItemFactory = (DefaultFileItemFactory) factory; - } - - - /** - * Returns the size threshold beyond which files are written directly to - * disk. - * - * @return The size threshold, in bytes. - * - * @see #setSizeThreshold(int) - */ - public int getSizeThreshold() - { - return fileItemFactory.getSizeThreshold(); - } - - - /** - * Sets the size threshold beyond which files are written directly to disk. - * - * @param sizeThreshold The size threshold, in bytes. - * - * @see #getSizeThreshold() - */ - public void setSizeThreshold(int sizeThreshold) - { - fileItemFactory.setSizeThreshold(sizeThreshold); - } - - - /** - * Returns the location used to temporarily store files that are larger - * than the configured size threshold. - * - * @return The path to the temporary file location. - * - * @see #setRepositoryPath(String) - */ - public String getRepositoryPath() - { - return fileItemFactory.getRepository().getPath(); - } - - - /** - * Sets the location used to temporarily store files that are larger - * than the configured size threshold. - * - * @param repositoryPath The path to the temporary file location. - * - * @see #getRepositoryPath() - */ - public void setRepositoryPath(String repositoryPath) - { - fileItemFactory.setRepository(new File(repositoryPath)); - } - - - /** - * Returns the max size of a file. - * - * @return The size, in bytes. - * - * @see #setFileSizeMax(long) - */ - public long getFileSizeMax() - { - return fileItemFactory.getFileSizeMax(); - } - - - /** - * Sets the max size of a file. - * - * @param fileSizeMax The size, in bytes. - * - * @see #getSizeThreshold() - */ - public void setFileSizeMax(long fileSizeMax) - { - fileItemFactory.setFileSizeMax(fileSizeMax); - } - - - // --------------------------------------------------------- Public methods - - - /** - * Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> - * compliant <code>multipart/form-data</code> stream. If files are stored - * on disk, the path is given by <code>getRepository()</code>. - * - * @param req The servlet request to be parsed. Must be non-null. - * @param sizeThreshold The max size in bytes to be stored in memory. - * @param sizeMax The maximum allowed upload size, in bytes. - * @param path The location where the files should be stored. - * - * @return A list of <code>FileItem</code> instances parsed from the - * request, in the order that they were transmitted. - * - * @exception FileUploadException if there are problems reading/parsing - * the request or storing files. - */ - public List<FileItem> parseRequest(HttpServletRequest req, - int sizeThreshold, - long sizeMax, String path) - throws IOException, FileUploadException - { - setSizeThreshold(sizeThreshold); - setSizeMax(sizeMax); - setRepositoryPath(path); - return parseRequest(req); - } - -} Added: trunk/java/org/apache/tomcat/util/http/fileupload/FileCleanerCleanup.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileCleanerCleanup.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileCleanerCleanup.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,81 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import javax.servlet.ServletContext; +import javax.servlet.ServletContextListener; +import javax.servlet.ServletContextEvent; + + +/** + * A servlet context listener, which ensures that the + * {@link org.apache.commons.io.FileCleaner FileCleaner's} + * reaper thread is terminated, + * when the web application is destroyed. + */ +public class FileCleanerCleanup implements ServletContextListener { + /** + * Attribute name, which is used for storing an instance of + * {@link FileCleaningTracker} in the web application. + */ + public static final String FILE_CLEANING_TRACKER_ATTRIBUTE + = FileCleanerCleanup.class.getName() + ".FileCleaningTracker"; + + /** + * Returns the instance of {@link FileCleaningTracker}, which is + * associated with the given {@link ServletContext}. + * @param pServletContext The servlet context to query + * @return The contexts tracker + */ + public static FileCleaningTracker + getFileCleaningTracker(ServletContext pServletContext) { + return (FileCleaningTracker) + pServletContext.getAttribute(FILE_CLEANING_TRACKER_ATTRIBUTE); + } + + /** + * Sets the instance of {@link FileCleaningTracker}, which is + * associated with the given {@link ServletContext}. + * @param pServletContext The servlet context to modify + * @param pTracker The tracker to set + */ + public static void setFileCleaningTracker(ServletContext pServletContext, + FileCleaningTracker pTracker) { + pServletContext.setAttribute(FILE_CLEANING_TRACKER_ATTRIBUTE, pTracker); + } + + /** + * Called when the web application is initialized. Does + * nothing. + * @param sce The servlet context, used for calling + * {@link #setFileCleaningTracker(ServletContext, FileCleaningTracker)}. + */ + public void contextInitialized(ServletContextEvent sce) { + setFileCleaningTracker(sce.getServletContext(), + new FileCleaningTracker()); + } + + /** + * Called when the web application is being destroyed. + * Calls {@link FileCleaningTracker#exitWhenFinished()}. + * @param sce The servlet context, used for calling + * {@link #getFileCleaningTracker(ServletContext)}. + */ + public void contextDestroyed(ServletContextEvent sce) { + getFileCleaningTracker(sce.getServletContext()).exitWhenFinished(); + } +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/FileCleaningTracker.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileCleaningTracker.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileCleaningTracker.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,259 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.File; +import java.lang.ref.PhantomReference; +import java.lang.ref.ReferenceQueue; +import java.util.Collection; +import java.util.Vector; + +/** + * Keeps track of files awaiting deletion, and deletes them when an associated + * marker object is reclaimed by the garbage collector. + * <p> + * This utility creates a background thread to handle file deletion. + * Each file to be deleted is registered with a handler object. + * When the handler object is garbage collected, the file is deleted. + * <p> + * In an environment with multiple class loaders (a servlet container, for + * example), you should consider stopping the background thread if it is no + * longer needed. This is done by invoking the method + * {@link #exitWhenFinished}, typically in + * {@link javax.servlet.ServletContextListener#contextDestroyed} or similar. + * + * @author Noel Bergman + * @author Martin Cooper + * @version $Id: FileCleaner.java 490987 2006-12-29 12:11:48Z scolebourne $ + */ +public class FileCleaningTracker { + /** + * Queue of <code>Tracker</code> instances being watched. + */ + ReferenceQueue /* Tracker */ q = new ReferenceQueue(); + /** + * Collection of <code>Tracker</code> instances in existence. + */ + final Collection<Tracker> trackers = new Vector<Tracker>(); // synchronized + /** + * Whether to terminate the thread when the tracking is complete. + */ + volatile boolean exitWhenFinished = false; + /** + * The thread that will clean up registered files. + */ + Thread reaper; + + //----------------------------------------------------------------------- + /** + * Track the specified file, using the provided marker, deleting the file + * when the marker instance is garbage collected. + * The {@link FileDeleteStrategy#NORMAL normal} deletion strategy will be used. + * + * @param file the file to be tracked, not null + * @param marker the marker object used to track the file, not null + * @throws NullPointerException if the file is null + */ + public void track(File file, Object marker) { + track(file, marker, (FileDeleteStrategy) null); + } + + /** + * Track the specified file, using the provided marker, deleting the file + * when the marker instance is garbage collected. + * The speified deletion strategy is used. + * + * @param file the file to be tracked, not null + * @param marker the marker object used to track the file, not null + * @param deleteStrategy the strategy to delete the file, null means normal + * @throws NullPointerException if the file is null + */ + public void track(File file, Object marker, FileDeleteStrategy deleteStrategy) { + if (file == null) { + throw new NullPointerException("The file must not be null"); + } + addTracker(file.getPath(), marker, deleteStrategy); + } + + /** + * Track the specified file, using the provided marker, deleting the file + * when the marker instance is garbage collected. + * The {@link FileDeleteStrategy#NORMAL normal} deletion strategy will be used. + * + * @param path the full path to the file to be tracked, not null + * @param marker the marker object used to track the file, not null + * @throws NullPointerException if the path is null + */ + public void track(String path, Object marker) { + track(path, marker, (FileDeleteStrategy) null); + } + + /** + * Track the specified file, using the provided marker, deleting the file + * when the marker instance is garbage collected. + * The speified deletion strategy is used. + * + * @param path the full path to the file to be tracked, not null + * @param marker the marker object used to track the file, not null + * @param deleteStrategy the strategy to delete the file, null means normal + * @throws NullPointerException if the path is null + */ + public void track(String path, Object marker, FileDeleteStrategy deleteStrategy) { + if (path == null) { + throw new NullPointerException("The path must not be null"); + } + addTracker(path, marker, deleteStrategy); + } + + /** + * Adds a tracker to the list of trackers. + * + * @param path the full path to the file to be tracked, not null + * @param marker the marker object used to track the file, not null + * @param deleteStrategy the strategy to delete the file, null means normal + */ + private synchronized void addTracker(String path, Object marker, FileDeleteStrategy deleteStrategy) { + // synchronized block protects reaper + if (exitWhenFinished) { + throw new IllegalStateException("No new trackers can be added once exitWhenFinished() is called"); + } + if (reaper == null) { + reaper = new Reaper(); + reaper.start(); + } + trackers.add(new Tracker(path, deleteStrategy, marker, q)); + } + + //----------------------------------------------------------------------- + /** + * Retrieve the number of files currently being tracked, and therefore + * awaiting deletion. + * + * @return the number of files being tracked + */ + public int getTrackCount() { + return trackers.size(); + } + + /** + * Call this method to cause the file cleaner thread to terminate when + * there are no more objects being tracked for deletion. + * <p> + * In a simple environment, you don't need this method as the file cleaner + * thread will simply exit when the JVM exits. In a more complex environment, + * with multiple class loaders (such as an application server), you should be + * aware that the file cleaner thread will continue running even if the class + * loader it was started from terminates. This can consitute a memory leak. + * <p> + * For example, suppose that you have developed a web application, which + * contains the commons-io jar file in your WEB-INF/lib directory. In other + * words, the FileCleaner class is loaded through the class loader of your + * web application. If the web application is terminated, but the servlet + * container is still running, then the file cleaner thread will still exist, + * posing a memory leak. + * <p> + * This method allows the thread to be terminated. Simply call this method + * in the resource cleanup code, such as {@link javax.servlet.ServletContextListener#contextDestroyed}. + * One called, no new objects can be tracked by the file cleaner. + */ + public synchronized void exitWhenFinished() { + // synchronized block protects reaper + exitWhenFinished = true; + if (reaper != null) { + synchronized (reaper) { + reaper.interrupt(); + } + } + } + + //----------------------------------------------------------------------- + /** + * The reaper thread. + */ + private final class Reaper extends Thread { + /** Construct a new Reaper */ + Reaper() { + super("File Reaper"); + setPriority(Thread.MAX_PRIORITY); + setDaemon(true); + } + + /** + * Run the reaper thread that will delete files as their associated + * marker objects are reclaimed by the garbage collector. + */ + @Override + public void run() { + // thread exits when exitWhenFinished is true and there are no more tracked objects + while (exitWhenFinished == false || trackers.size() > 0) { + Tracker tracker = null; + try { + // Wait for a tracker to remove. + tracker = (Tracker) q.remove(); + } catch (Exception e) { + continue; + } + if (tracker != null) { + tracker.delete(); + tracker.clear(); + trackers.remove(tracker); + } + } + } + } + + //----------------------------------------------------------------------- + /** + * Inner class which acts as the reference for a file pending deletion. + */ + private static final class Tracker extends PhantomReference { + + /** + * The full path to the file being tracked. + */ + private final String path; + /** + * The strategy for deleting files. + */ + private final FileDeleteStrategy deleteStrategy; + + /** + * Constructs an instance of this class from the supplied parameters. + * + * @param path the full path to the file to be tracked, not null + * @param deleteStrategy the strategy to delete the file, null means normal + * @param marker the marker object used to track the file, not null + * @param queue the queue on to which the tracker will be pushed, not null + */ + Tracker(String path, FileDeleteStrategy deleteStrategy, Object marker, ReferenceQueue queue) { + super(marker, queue); + this.path = path; + this.deleteStrategy = (deleteStrategy == null ? FileDeleteStrategy.NORMAL : deleteStrategy); + } + + /** + * Deletes the file associated with this tracker instance. + * + * @return <code>true</code> if the file was deleted successfully; + * <code>false</code> otherwise. + */ + public boolean delete() { + return deleteStrategy.deleteQuietly(new File(path)); + } + } + +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/FileDeleteStrategy.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileDeleteStrategy.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileDeleteStrategy.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,158 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.File; +import java.io.IOException; + +/** + * Strategy for deleting files. + * <p> + * There is more than one way to delete a file. + * You may want to limit access to certain directories, to only delete + * directories if they are empty, or maybe to force deletion. + * <p> + * This class captures the strategy to use and is designed for user subclassing. + * + * @author Stephen Colebourne + * @version $Id: FileDeleteStrategy.java 881533 2009-11-17 21:21:41Z markt $ + * @since Commons IO 1.3 + */ +public class FileDeleteStrategy { + + /** + * The singleton instance for normal file deletion, which does not permit + * the deletion of directories that are not empty. + */ + public static final FileDeleteStrategy NORMAL = new FileDeleteStrategy("Normal"); + /** + * The singleton instance for forced file deletion, which always deletes, + * even if the file represents a non-empty directory. + */ + public static final FileDeleteStrategy FORCE = new ForceFileDeleteStrategy(); + + /** The name of the strategy. */ + private final String name; + + //----------------------------------------------------------------------- + /** + * Restricted constructor. + * + * @param name the name by which the strategy is known + */ + protected FileDeleteStrategy(String name) { + this.name = name; + } + + //----------------------------------------------------------------------- + /** + * Deletes the file object, which may be a file or a directory. + * All <code>IOException</code>s are caught and false returned instead. + * If the file does not exist or is null, true is returned. + * <p> + * Subclass writers should override {@link #doDelete(File)}, not this method. + * + * @param fileToDelete the file to delete, null returns true + * @return true if the file was deleted, or there was no such file + */ + public boolean deleteQuietly(File fileToDelete) { + if (fileToDelete == null || fileToDelete.exists() == false) { + return true; + } + try { + return doDelete(fileToDelete); + } catch (IOException ex) { + return false; + } + } + + /** + * Deletes the file object, which may be a file or a directory. + * If the file does not exist, the method just returns. + * <p> + * Subclass writers should override {@link #doDelete(File)}, not this method. + * + * @param fileToDelete the file to delete, not null + * @throws NullPointerException if the file is null + * @throws IOException if an error occurs during file deletion + */ + public void delete(File fileToDelete) throws IOException { + if (fileToDelete.exists() && doDelete(fileToDelete) == false) { + throw new IOException("Deletion failed: " + fileToDelete); + } + } + + /** + * Actually deletes the file object, which may be a file or a directory. + * <p> + * This method is designed for subclasses to override. + * The implementation may return either false or an <code>IOException</code> + * when deletion fails. The {@link #delete(File)} and {@link #deleteQuietly(File)} + * methods will handle either response appropriately. + * A check has been made to ensure that the file will exist. + * <p> + * This implementation uses {@link File#delete()}. + * + * @param fileToDelete the file to delete, exists, not null + * @return true if the file was deleteds + * @throws NullPointerException if the file is null + * @throws IOException if an error occurs during file deletion + */ + protected boolean doDelete(File fileToDelete) throws IOException { + return fileToDelete.delete(); + } + + //----------------------------------------------------------------------- + /** + * Gets a string describing the delete strategy. + * + * @return a string describing the delete strategy + */ + @Override + public String toString() { + return "FileDeleteStrategy[" + name + "]"; + } + + //----------------------------------------------------------------------- + /** + * Force file deletion strategy. + */ + static class ForceFileDeleteStrategy extends FileDeleteStrategy { + /** Default Constructor */ + ForceFileDeleteStrategy() { + super("Force"); + } + + /** + * Deletes the file object. + * <p> + * This implementation uses <code>FileUtils.forceDelete() <code> + * if the file exists. + * + * @param fileToDelete the file to delete, not null + * @return Always returns <code>true</code> + * @throws NullPointerException if the file is null + * @throws IOException if an error occurs during file deletion + */ + @Override + protected boolean doDelete(File fileToDelete) throws IOException { + FileUtils.forceDelete(fileToDelete); + return true; + } + } + +} Modified: trunk/java/org/apache/tomcat/util/http/fileupload/FileItem.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileItem.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileItem.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -5,36 +5,31 @@ * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; - import java.io.File; import java.io.IOException; +import java.io.InputStream; import java.io.OutputStream; import java.io.Serializable; import java.io.UnsupportedEncodingException; -import javax.servlet.http.Part; - - /** * <p> This class represents a file or form item that was received within a * <code>multipart/form-data</code> POST request. * * <p> After retrieving an instance of this class from a {@link - * org.apache.tomcat.util.http.fileupload.FileUpload FileUpload} instance (see - * {@link org.apache.tomcat.util.http.fileupload.FileUpload + * org.apache.commons.fileupload.FileUpload FileUpload} instance (see + * {@link org.apache.commons.fileupload.FileUpload * #parseRequest(javax.servlet.http.HttpServletRequest)}), you may * either request all contents of the file at once using {@link #get()} or * request an {@link java.io.InputStream InputStream} with @@ -55,11 +50,45 @@ * * @version $Id$ */ -public interface FileItem - extends Part, Serializable -{ +public interface FileItem extends Serializable { + // ------------------------------- Methods from javax.activation.DataSource + + + /** + * Returns an {@link java.io.InputStream InputStream} that can be + * used to retrieve the contents of the file. + * + * @return An {@link java.io.InputStream InputStream} that can be + * used to retrieve the contents of the file. + * + * @throws IOException if an error occurs. + */ + InputStream getInputStream() throws IOException; + + + /** + * Returns the content type passed by the browser or <code>null</code> if + * not defined. + * + * @return The content type passed by the browser or <code>null</code> if + * not defined. + */ + String getContentType(); + + + /** + * Returns the original filename in the client's filesystem, as provided by + * the browser (or other client software). In most cases, this will be the + * base file name, without path information. However, some clients, such as + * the Opera browser, do include path information. + * + * @return The original filename in the client's filesystem. + */ + String getName(); + + // ------------------------------------------------------- FileItem methods @@ -74,6 +103,14 @@ /** + * Returns the size of the file item. + * + * @return The size of the file item, in bytes. + */ + long getSize(); + + + /** * Returns the contents of the file item as an array of bytes. * * @return The contents of the file item as an array of bytes. @@ -90,11 +127,10 @@ * * @return The contents of the item, as a string. * - * @exception UnsupportedEncodingException if the requested character - * encoding is not available. + * @throws UnsupportedEncodingException if the requested character + * encoding is not available. */ - String getString(String encoding) - throws UnsupportedEncodingException; + String getString(String encoding) throws UnsupportedEncodingException; /** @@ -121,17 +157,19 @@ * @param file The <code>File</code> into which the uploaded item should * be stored. * - * @exception Exception if an error occurs. + * @throws Exception if an error occurs. */ - void write(File file) throws IOException; + void write(File file) throws Exception; /** - * Returns the original filename in the client's filesystem. - * - * @return The original filename in the client's filesystem. + * Deletes the underlying storage for a file item, including deleting any + * associated temporary disk file. Although this storage will be deleted + * automatically when the <code>FileItem</code> instance is garbage + * collected, this method can be used to ensure that this is done at an + * earlier time, thus preserving system resources. */ - String getFileName(); + void delete(); /** @@ -176,9 +214,9 @@ * be used for storing the contents of the file. * * @return An {@link java.io.OutputStream OutputStream} that can be used - * for storing the contensts of the file. + * for storing the contents of the file. * - * @exception IOException if an error occurs. + * @throws IOException if an error occurs. */ OutputStream getOutputStream() throws IOException; Modified: trunk/java/org/apache/tomcat/util/http/fileupload/FileItemFactory.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileItemFactory.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileItemFactory.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -5,33 +5,28 @@ * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; -import java.util.Map; - /** * <p>A factory interface for creating {@link FileItem} instances. Factories * can provide their own custom configuration, over and above that provided * by the default file upload implementation.</p> * * @author <a href="mailto:martinc@apache.org">Martin Cooper</a> - * + * * @version $Id$ */ -public interface FileItemFactory -{ +public interface FileItemFactory { /** * Create a new {@link FileItem} instance from the supplied parameters and @@ -50,7 +45,6 @@ String fieldName, String contentType, boolean isFormField, - String fileName, - Map<String, String> headers + String fileName ); } Added: trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeaders.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeaders.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeaders.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,77 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.util.Iterator; + +/** + * <p> This class provides support for accessing the headers for a file or form + * item that was received within a <code>multipart/form-data</code> POST + * request.</p> + * + * @author Michael C. Macaluso + * @since 1.3 + */ +public interface FileItemHeaders { + /** + * Returns the value of the specified part header as a <code>String</code>. + * If the part did not include a header of the specified name, this method + * return <code>null</code>. If there are multiple headers with the same + * name, this method returns the first header in the item. The header + * name is case insensitive. + * + * @param name a <code>String</code> specifying the header name + * @return a <code>String</code> containing the value of the requested + * header, or <code>null</code> if the item does not have a header + * of that name + */ + String getHeader(String name); + + /** + * <p> + * Returns all the values of the specified item header as an + * <code>Enumeration</code> of <code>String</code> objects. + * </p> + * <p> + * If the item did not include any headers of the specified name, this + * method returns an empty <code>Enumeration</code>. The header name is + * case insensitive. + * </p> + * + * @param name a <code>String</code> specifying the header name + * @return an <code>Enumeration</code> containing the values of the + * requested header. If the item does not have any headers of + * that name, return an empty <code>Enumeration</code> + */ + Iterator<String> getHeaders(String name); + + /** + * <p> + * Returns an <code>Enumeration</code> of all the header names. + * </p> + * <p> + * If the item did not include any headers of the specified name, this + * method returns an empty <code>Enumeration</code>. The header name is + * case insensitive. + * </p> + * + * @return an <code>Enumeration</code> containing the values of the + * requested header. If the item does not have any headers of + * that name return an empty <code>Enumeration</code> + */ + Iterator<String> getHeaderNames(); +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersImpl.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersImpl.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersImpl.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,89 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; + + +/** + * Default implementation of the {@link FileItemHeaders} interface. + * + * @author Michael C. Macaluso + * @since 1.3 + */ +public class FileItemHeadersImpl implements FileItemHeaders, Serializable { + private static final long serialVersionUID = -4455695752627032559L; + + /** + * Map of <code>String</code> keys to a <code>List</code> of + * <code>String</code> instances. + */ + private final Map<String,List<String>> headerNameToValueListMap = + new HashMap<String,List<String>>(); + + /** + * List to preserve order of headers as added. This would not be + * needed if a <code>LinkedHashMap</code> could be used, but don't + * want to depend on 1.4. + */ + private final List<String> headerNameList = new ArrayList<String>(); + + public String getHeader(String name) { + String nameLower = name.toLowerCase(); + List<String> headerValueList = headerNameToValueListMap.get(nameLower); + if (null == headerValueList) { + return null; + } + return headerValueList.get(0); + } + + public Iterator<String> getHeaderNames() { + return headerNameList.iterator(); + } + + public Iterator<String> getHeaders(String name) { + String nameLower = name.toLowerCase(); + List<String> headerValueList = headerNameToValueListMap.get(nameLower); + if (null == headerValueList) { + return Collections.<String>emptyList().iterator(); + } + return headerValueList.iterator(); + } + + /** + * Method to add header values to this instance. + * + * @param name name of this header + * @param value value of this header + */ + public synchronized void addHeader(String name, String value) { + String nameLower = name.toLowerCase(); + List<String> headerValueList = headerNameToValueListMap.get(nameLower); + if (null == headerValueList) { + headerValueList = new ArrayList<String>(); + headerNameToValueListMap.put(nameLower, headerValueList); + headerNameList.add(nameLower); + } + headerValueList.add(value); + } +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersSupport.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersSupport.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersSupport.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,47 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +/** + * Interface that will indicate that {@link FileItem} or {@link FileItemStream} + * implementations will accept the headers read for the item. + * + * @author Michael C. Macaluso + * @since 1.3 + * + * @see FileItem + * @see FileItemStream + */ +public interface FileItemHeadersSupport { + /** + * Returns the collection of headers defined locally within this item. + * + * @return the {@link FileItemHeaders} present for this item. + */ + FileItemHeaders getHeaders(); + + /** + * Sets the headers read from within an item. Implementations of + * {@link FileItem} or {@link FileItemStream} should implement this + * interface to be able to get the raw headers found within the item + * header block. + * + * @param headers the instance that holds onto the headers + * for this instance. + */ + void setHeaders(FileItemHeaders headers); +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/FileItemIterator.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileItemIterator.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileItemIterator.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,48 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; +import java.io.IOException; + + +/** + * An iterator, as returned by + * {@link FileUploadBase#getItemIterator(RequestContext)}. + */ +public interface FileItemIterator { + /** + * Returns, whether another instance of {@link FileItemStream} + * is available. + * @throws FileUploadException Parsing or processing the + * file item failed. + * @throws IOException Reading the file item failed. + * @return True, if one or more additional file items + * are available, otherwise false. + */ + boolean hasNext() throws FileUploadException, IOException; + + /** + * Returns the next available {@link FileItemStream}. + * @throws java.util.NoSuchElementException No more items are available. Use + * {@link #hasNext()} to prevent this exception. + * @throws FileUploadException Parsing or processing the + * file item failed. + * @throws IOException Reading the file item failed. + * @return FileItemStream instance, which provides + * access to the next file item. + */ + FileItemStream next() throws FileUploadException, IOException; +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/FileItemStream.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileItemStream.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileItemStream.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,97 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.IOException; +import java.io.InputStream; + + +/** + * <p> This interface provides access to a file or form item that was + * received within a <code>multipart/form-data</code> POST request. + * The items contents are retrieved by calling {@link #openStream()}.</p> + * <p>Instances of this class are created by accessing the + * iterator, returned by + * {@link FileUploadBase#getItemIterator(RequestContext)}.</p> + * <p><em>Note</em>: There is an interaction between the iterator and + * its associated instances of {@link FileItemStream}: By invoking + * {@link java.util.Iterator#hasNext()} on the iterator, you discard all data, + * which hasn't been read so far from the previous data.</p> + */ +public interface FileItemStream extends FileItemHeadersSupport { + /** + * This exception is thrown, if an attempt is made to read + * data from the {@link InputStream}, which has been returned + * by {@link FileItemStream#openStream()}, after + * {@link java.util.Iterator#hasNext()} has been invoked on the + * iterator, which created the {@link FileItemStream}. + */ + public static class ItemSkippedException extends IOException { + /** + * The exceptions serial version UID, which is being used + * when serializing an exception instance. + */ + private static final long serialVersionUID = -7280778431581963740L; + } + + /** Creates an {@link InputStream}, which allows to read the + * items contents. + * @return The input stream, from which the items data may + * be read. + * @throws IllegalStateException The method was already invoked on + * this item. It is not possible to recreate the data stream. + * @throws IOException An I/O error occurred. + * @see ItemSkippedException + */ + InputStream openStream() throws IOException; + + /** + * Returns the content type passed by the browser or <code>null</code> if + * not defined. + * + * @return The content type passed by the browser or <code>null</code> if + * not defined. + */ + String getContentType(); + + /** + * Returns the original filename in the client's filesystem, as provided by + * the browser (or other client software). In most cases, this will be the + * base file name, without path information. However, some clients, such as + * the Opera browser, do include path information. + * + * @return The original filename in the client's filesystem. + */ + String getName(); + + /** + * Returns the name of the field in the multipart form corresponding to + * this file item. + * + * @return The name of the form field. + */ + String getFieldName(); + + /** + * Determines whether or not a <code>FileItem</code> instance represents + * a simple form field. + * + * @return <code>true</code> if the instance represents a simple form + * field; <code>false</code> if it represents an uploaded file. + */ + boolean isFormField(); +} Modified: trunk/java/org/apache/tomcat/util/http/fileupload/FileUpload.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileUpload.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileUpload.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -5,17 +5,15 @@ * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; @@ -25,9 +23,9 @@ * <p>This class handles multiple files per single HTML widget, sent using * <code>multipart/mixed</code> encoding type, as specified by * <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>. Use {@link - * #parseRequest(HttpServletRequest)} to acquire a list of {@link - * org.apache.tomcat.util.http.fileupload.FileItem}s associated with a given HTML - * widget.</p> + * #parseRequest(javax.servlet.http.HttpServletRequest)} to acquire a list + * of {@link org.apache.commons.fileupload.FileItem FileItems} associated + * with a given HTML widget.</p> * * <p>How the data for individual parts is stored is determined by the factory * used to create them; a given part may be in memory, on disk, or somewhere @@ -43,8 +41,7 @@ * @version $Id$ */ public class FileUpload - extends FileUploadBase - { + extends FileUploadBase { // ----------------------------------------------------------- Data members @@ -59,13 +56,13 @@ /** - * Constructs an instance of this class which uses the default factory to - * create <code>FileItem</code> instances. + * Constructs an uninitialised instance of this class. A factory must be + * configured, using <code>setFileItemFactory()</code>, before attempting + * to parse requests. * * @see #FileUpload(FileItemFactory) */ - public FileUpload() - { + public FileUpload() { super(); } @@ -75,9 +72,9 @@ * create <code>FileItem</code> instances. * * @see #FileUpload() + * @param fileItemFactory The factory to use for creating file items. */ - public FileUpload(FileItemFactory fileItemFactory) - { + public FileUpload(FileItemFactory fileItemFactory) { super(); this.fileItemFactory = fileItemFactory; } @@ -91,8 +88,8 @@ * * @return The factory class for new file items. */ - public FileItemFactory getFileItemFactory() - { + @Override + public FileItemFactory getFileItemFactory() { return fileItemFactory; } @@ -102,8 +99,8 @@ * * @param factory The factory class for new file items. */ - public void setFileItemFactory(FileItemFactory factory) - { + @Override + public void setFileItemFactory(FileItemFactory factory) { this.fileItemFactory = factory; } Modified: trunk/java/org/apache/tomcat/util/http/fileupload/FileUploadBase.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileUploadBase.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileUploadBase.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -5,30 +5,30 @@ * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; - import java.io.IOException; import java.io.InputStream; -import java.io.OutputStream; +import java.io.UnsupportedEncodingException; import java.util.ArrayList; -import java.util.HashMap; import java.util.List; import java.util.Map; +import java.util.NoSuchElementException; + import javax.servlet.http.HttpServletRequest; +import org.apache.tomcat.util.http.fileupload.MultipartStream.ItemInputStream; + /** * <p>High level API for processing file uploads.</p> * @@ -36,7 +36,7 @@ * <code>multipart/mixed</code> encoding type, as specified by * <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>. Use {@link * #parseRequest(HttpServletRequest)} to acquire a list of {@link - * org.apache.tomcat.util.http.fileupload.FileItem}s associated with a given HTML + * org.apache.commons.fileupload.FileItem}s associated with a given HTML * widget.</p> * * <p>How the data for individual parts is stored is determined by the factory @@ -52,30 +52,31 @@ * * @version $Id$ */ -public abstract class FileUploadBase -{ +public abstract class FileUploadBase { // ---------------------------------------------------------- Class methods /** - * Utility method that determines whether the request contains multipart - * content. + * <p>Utility method that determines whether the request contains multipart + * content.</p> * - * @param req The servlet request to be evaluated. Must be non-null. + * <p><strong>NOTE:</strong>This method will be moved to the + * <code>ServletFileUpload</code> class after the FileUpload 1.1 release. + * Unfortunately, since this method is static, it is not possible to + * provide its replacement until this method is removed.</p> * + * @param ctx The request context to be evaluated. Must be non-null. + * * @return <code>true</code> if the request is multipart; * <code>false</code> otherwise. */ - public static final boolean isMultipartContent(HttpServletRequest req) - { - String contentType = req.getHeader(CONTENT_TYPE); - if (contentType == null) - { + public static final boolean isMultipartContent(RequestContext ctx) { + String contentType = ctx.getContentType(); + if (contentType == null) { return false; } - if (contentType.startsWith(MULTIPART)) - { + if (contentType.toLowerCase().startsWith(MULTIPART)) { return true; } return false; @@ -96,7 +97,12 @@ */ public static final String CONTENT_DISPOSITION = "Content-disposition"; + /** + * HTTP content length header name. + */ + public static final String CONTENT_LENGTH = "Content-length"; + /** * Content-disposition value for form data. */ @@ -127,19 +133,12 @@ public static final String MULTIPART_MIXED = "multipart/mixed"; - /** - * The maximum length of a single header line that will be parsed - * (1024 bytes). - */ - public static final int MAX_HEADER_SIZE = 1024; - - // ----------------------------------------------------------- Data members /** - * The maximum size permitted for an uploaded file. A value of -1 indicates - * no maximum. + * The maximum size permitted for the complete request, as opposed to + * {@link #fileSizeMax}. A value of -1 indicates no maximum. */ private long sizeMax = -1; @@ -154,6 +153,10 @@ */ private String headerEncoding; + /** + * The progress listener. + */ + private ProgressListener listener; // ----------------------------------------------------- Property accessors @@ -175,33 +178,34 @@ /** - * Returns the maximum allowed upload size. + * Returns the maximum allowed size of a complete request, as opposed + * to {@link #getFileSizeMax()}. * - * @return The maximum allowed size, in bytes. + * @return The maximum allowed size, in bytes. The default value of + * -1 indicates, that there is no limit. * * @see #setSizeMax(long) * */ - public long getSizeMax() - { + public long getSizeMax() { return sizeMax; } /** - * Sets the maximum allowed upload size. If negative, there is no maximum. + * Sets the maximum allowed size of a complete request, as opposed + * to {@link #setFileSizeMax(long)}. * - * @param sizeMax The maximum allowed size, in bytes, or -1 for no maximum. + * @param sizeMax The maximum allowed size, in bytes. The default value of + * -1 indicates, that there is no limit. * * @see #getSizeMax() * */ - public void setSizeMax(long sizeMax) - { + public void setSizeMax(long sizeMax) { this.sizeMax = sizeMax; } - /** * Returns the maximum allowed size of a single uploaded file, * as opposed to {@link #getSizeMax()}. @@ -226,26 +230,26 @@ /** * Retrieves the character encoding used when reading the headers of an - * individual part. When not specified, or <code>null</code>, the platform - * default encoding is used. + * individual part. When not specified, or <code>null</code>, the request + * encoding is used. If that is also not specified, or <code>null</code>, + * the platform default encoding is used. * * @return The encoding used to read part headers. */ - public String getHeaderEncoding() - { + public String getHeaderEncoding() { return headerEncoding; } /** * Specifies the character encoding to be used when reading the headers of - * individual parts. When not specified, or <code>null</code>, the platform - * default encoding is used. + * individual part. When not specified, or <code>null</code>, the request + * encoding is used. If that is also not specified, or <code>null</code>, + * the platform default encoding is used. * * @param encoding The encoding used to read part headers. */ - public void setHeaderEncoding(String encoding) - { + public void setHeaderEncoding(String encoding) { headerEncoding = encoding; } @@ -255,183 +259,147 @@ /** * Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> - * compliant <code>multipart/form-data</code> stream. If files are stored - * on disk, the path is given by <code>getRepository()</code>. + * compliant <code>multipart/form-data</code> stream. * - * @param req The servlet request to be parsed. + * @param ctx The context for the request to be parsed. * + * @return An iterator to instances of <code>FileItemStream</code> + * parsed from the request, in the order that they were + * transmitted. + * + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + * @throws IOException An I/O error occurred. This may be a network + * error while communicating with the client or a problem while + * storing the uploaded content. + */ + public FileItemIterator getItemIterator(RequestContext ctx) + throws FileUploadException, IOException { + return new FileItemIteratorImpl(ctx); + } + + /** + * Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> + * compliant <code>multipart/form-data</code> stream. + * + * @param ctx The context for the request to be parsed. + * * @return A list of <code>FileItem</code> instances parsed from the * request, in the order that they were transmitted. * - * @exception FileUploadException if there are problems reading/parsing - * the request or storing files. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. */ - public List<FileItem> parseRequest(HttpServletRequest req) - throws IOException, FileUploadException - { - if (null == req) - { - throw new NullPointerException("req parameter"); + public List<FileItem> parseRequest(RequestContext ctx) + throws FileUploadException { + try { + FileItemIterator iter = getItemIterator(ctx); + List<FileItem> items = new ArrayList<FileItem>(); + FileItemFactory fac = getFileItemFactory(); + if (fac == null) { + throw new NullPointerException( + "No FileItemFactory has been set."); + } + while (iter.hasNext()) { + FileItemStream item = iter.next(); + FileItem fileItem = fac.createItem(item.getFieldName(), + item.getContentType(), item.isFormField(), + item.getName()); + try { + Streams.copy(item.openStream(), fileItem.getOutputStream(), + true); + } catch (FileUploadIOException e) { + throw (FileUploadException) e.getCause(); + } catch (IOException e) { + throw new IOFileUploadException( + "Processing of " + MULTIPART_FORM_DATA + + " request failed. " + e.getMessage(), e); + } + if (fileItem instanceof FileItemHeadersSupport) { + final FileItemHeaders fih = item.getHeaders(); + ((FileItemHeadersSupport) fileItem).setHeaders(fih); + } + items.add(fileItem); + } + return items; + } catch (FileUploadIOException e) { + throw (FileUploadException) e.getCause(); + } catch (IOException e) { + throw new FileUploadException(e.getMessage(), e); } + } - ArrayList<FileItem> items = new ArrayList<FileItem>(); - String contentType = req.getHeader(CONTENT_TYPE); - if ((null == contentType) || (!contentType.startsWith(MULTIPART))) - { - throw new InvalidContentTypeException( - "the request doesn't contain a " - + MULTIPART_FORM_DATA - + " or " - + MULTIPART_MIXED - + " stream, content type header is " - + contentType); - } - int requestSize = req.getContentLength(); + // ------------------------------------------------------ Protected methods - if (requestSize == -1) - { - throw new UnknownSizeException( - "the request was rejected because it's size is unknown"); - } - if (sizeMax >= 0 && requestSize > sizeMax) - { - throw new SizeLimitExceededException( - "the request was rejected because " - + "it's size exceeds allowed range"); - } + /** + * Retrieves the boundary from the <code>Content-type</code> header. + * + * @param contentType The value of the content type header from which to + * extract the boundary value. + * + * @return The boundary, as a byte array. + */ + protected byte[] getBoundary(String contentType) { + ParameterParser parser = new ParameterParser(); + parser.setLowerCaseNames(true); + // Parameter parser can handle null input + Map<String,String> params = + parser.parse(contentType, new char[] {';', ','}); + String boundaryStr = params.get("boundary"); - int boundaryIndex = contentType.indexOf("boundary="); - if (boundaryIndex < 0) - { - throw new FileUploadException( - "the request was rejected because " - + "no multipart boundary was found"); + if (boundaryStr == null) { + return null; } - byte[] boundary = contentType.substring( - boundaryIndex + 9).getBytes(); - - InputStream input = req.getInputStream(); - - MultipartStream multi = new MultipartStream(input, boundary); - multi.setFileSizeMax(fileSizeMax); - multi.setHeaderEncoding(headerEncoding); - - boolean nextPart = multi.skipPreamble(); - while (nextPart) - { - Map<String, String> headers = parseHeaders(multi.readHeaders()); - String fieldName = getFieldName(headers); - if (fieldName != null) - { - String subContentType = getHeader(headers, CONTENT_TYPE); - if (subContentType != null && subContentType - .startsWith(MULTIPART_MIXED)) - { - // Multiple files. - byte[] subBoundary = - subContentType.substring( - subContentType - .indexOf("boundary=") + 9).getBytes(); - multi.setBoundary(subBoundary); - boolean nextSubPart = multi.skipPreamble(); - while (nextSubPart) - { - headers = parseHeaders(multi.readHeaders()); - if (getFileName(headers) != null) - { - FileItem item = - createItem(headers, false); - OutputStream os = item.getOutputStream(); - try - { - multi.readBodyData(os); - } - finally - { - os.close(); - } - items.add(item); - } - else - { - // Ignore anything but files inside - // multipart/mixed. - multi.discardBodyData(); - } - nextSubPart = multi.readBoundary(); - } - multi.setBoundary(boundary); - } - else - { - if (getFileName(headers) != null) - { - // A single file. - FileItem item = createItem(headers, false); - OutputStream os = item.getOutputStream(); - try - { - multi.readBodyData(os); - } - finally - { - os.close(); - } - items.add(item); - } - else - { - // A form field. - FileItem item = createItem(headers, true); - OutputStream os = item.getOutputStream(); - try - { - multi.readBodyData(os); - } - finally - { - os.close(); - } - items.add(item); - } - } - } - else - { - // Skip this part. - multi.discardBodyData(); - } - nextPart = multi.readBoundary(); + byte[] boundary; + try { + boundary = boundaryStr.getBytes("ISO-8859-1"); + } catch (UnsupportedEncodingException e) { + boundary = boundaryStr.getBytes(); } - - return items; + return boundary; } - // ------------------------------------------------------ Protected methods - - /** * Retrieves the file name from the <code>Content-disposition</code> * header. * - * @param headers A <code>Map</code> containing the HTTP request headers. + * @param headers The HTTP headers object. * * @return The file name for the current <code>encapsulation</code>. */ - protected String getFileName(Map /* String, String */ headers) - { + protected String getFileName(FileItemHeaders headers) { + return getFileName(headers.getHeader(CONTENT_DISPOSITION)); + } + + /** + * Returns the given content-disposition headers file name. + * @param pContentDisposition The content-disposition headers value. + * @return The file name + */ + private String getFileName(String pContentDisposition) { String fileName = null; - String cd = getHeader(headers, CONTENT_DISPOSITION); - if (cd.startsWith(FORM_DATA) || cd.startsWith(ATTACHMENT)) - { - int start = cd.indexOf("filename=\""); - int end = cd.indexOf('"', start + 10); - if (start != -1 && end != -1) - { - fileName = cd.substring(start + 10, end).trim(); + if (pContentDisposition != null) { + String cdl = pContentDisposition.toLowerCase(); + if (cdl.startsWith(FORM_DATA) || cdl.startsWith(ATTACHMENT)) { + ParameterParser parser = new ParameterParser(); + parser.setLowerCaseNames(true); + // Parameter parser can handle null input + Map<String,String> params = + parser.parse(pContentDisposition, ';'); + if (params.containsKey("filename")) { + fileName = params.get("filename"); + if (fileName != null) { + fileName = fileName.trim(); + } else { + // Even if there is no value, the parameter is present, + // so we return an empty file name rather than no file + // name. + fileName = ""; + } + } } } return fileName; @@ -446,48 +414,34 @@ * * @return The field name for the current <code>encapsulation</code>. */ - protected String getFieldName(Map /* String, String */ headers) - { + protected String getFieldName(FileItemHeaders headers) { + return getFieldName(headers.getHeader(CONTENT_DISPOSITION)); + } + + /** + * Returns the field name, which is given by the content-disposition + * header. + * @param pContentDisposition The content-dispositions header value. + * @return The field jake + */ + private String getFieldName(String pContentDisposition) { String fieldName = null; - String cd = getHeader(headers, CONTENT_DISPOSITION); - if (cd != null && cd.startsWith(FORM_DATA)) - { - int start = cd.indexOf("name=\""); - int end = cd.indexOf('"', start + 6); - if (start != -1 && end != -1) - { - fieldName = cd.substring(start + 6, end); + if (pContentDisposition != null + && pContentDisposition.toLowerCase().startsWith(FORM_DATA)) { + ParameterParser parser = new ParameterParser(); + parser.setLowerCaseNames(true); + // Parameter parser can handle null input + Map<String,String> params = + parser.parse(pContentDisposition, ';'); + fieldName = params.get("name"); + if (fieldName != null) { + fieldName = fieldName.trim(); } } return fieldName; } - /** - * Creates a new {@link FileItem} instance. - * - * @param headers A <code>Map</code> containing the HTTP request - * headers. - * @param isFormField Whether or not this item is a form field, as - * opposed to a file. - * - * @return A newly created <code>FileItem</code> instance. - * - * @exception FileUploadException if an error occurs. - */ - protected FileItem createItem(Map<String, String> headers, - boolean isFormField) - throws FileUploadException - { - return getFileItemFactory().createItem(getFieldName(headers), - getHeader(headers, CONTENT_TYPE), - isFormField, - getFileName(headers), - headers); - } - - - /** * <p> Parses the <code>header-part</code> and returns as key/value * pairs. * @@ -499,95 +453,521 @@ * * @return A <code>Map</code> containing the parsed HTTP request headers. */ - protected Map<String, String> parseHeaders(String headerPart) - { - Map<String, String> headers = new HashMap<String, String>(); - char buffer[] = new char[MAX_HEADER_SIZE]; - boolean done = false; - int j = 0; - int i; - String header, headerName, headerValue; - try - { - while (!done) - { - i = 0; - // Copy a single line of characters into the buffer, - // omitting trailing CRLF. - while (i < 2 || buffer[i - 2] != '\r' || buffer[i - 1] != '\n') - { - buffer[i++] = headerPart.charAt(j++); + protected FileItemHeaders getParsedHeaders(String headerPart) { + final int len = headerPart.length(); + FileItemHeadersImpl headers = newFileItemHeaders(); + int start = 0; + for (;;) { + int end = parseEndOfLine(headerPart, start); + if (start == end) { + break; + } + String header = headerPart.substring(start, end); + start = end + 2; + while (start < len) { + int nonWs = start; + while (nonWs < len) { + char c = headerPart.charAt(nonWs); + if (c != ' ' && c != '\t') { + break; + } + ++nonWs; } - header = new String(buffer, 0, i - 2); - if (header.equals("")) - { - done = true; + if (nonWs == start) { + break; } - else - { - if (header.indexOf(':') == -1) - { - // This header line is malformed, skip it. - continue; + // Continuation line found + end = parseEndOfLine(headerPart, nonWs); + header += " " + headerPart.substring(nonWs, end); + start = end + 2; + } + parseHeaderLine(headers, header); + } + return headers; + } + + /** + * Creates a new instance of {@link FileItemHeaders}. + * @return The new instance. + */ + protected FileItemHeadersImpl newFileItemHeaders() { + return new FileItemHeadersImpl(); + } + + /** + * Skips bytes until the end of the current line. + * @param headerPart The headers, which are being parsed. + * @param end Index of the last byte, which has yet been + * processed. + * @return Index of the \r\n sequence, which indicates + * end of line. + */ + private int parseEndOfLine(String headerPart, int end) { + int index = end; + for (;;) { + int offset = headerPart.indexOf('\r', index); + if (offset == -1 || offset + 1 >= headerPart.length()) { + throw new IllegalStateException( + "Expected headers to be terminated by an empty line."); + } + if (headerPart.charAt(offset + 1) == '\n') { + return offset; + } + index = offset + 1; + } + } + + /** + * Reads the next header line. + * @param headers String with all headers. + * @param header Map where to store the current header. + */ + private void parseHeaderLine(FileItemHeadersImpl headers, String header) { + final int colonOffset = header.indexOf(':'); + if (colonOffset == -1) { + // This header line is malformed, skip it. + return; + } + String headerName = header.substring(0, colonOffset).trim(); + String headerValue = + header.substring(header.indexOf(':') + 1).trim(); + headers.addHeader(headerName, headerValue); + } + + /** + * The iterator, which is returned by + * {@link FileUploadBase#getItemIterator(RequestContext)}. + */ + private class FileItemIteratorImpl implements FileItemIterator { + /** + * Default implementation of {@link FileItemStream}. + */ + private class FileItemStreamImpl implements FileItemStream { + /** The file items content type. + */ + private final String contentType; + /** The file items field name. + */ + private final String fieldName; + /** The file items file name. + */ + private final String name; + /** Whether the file item is a form field. + */ + private final boolean formField; + /** The file items input stream. + */ + private final InputStream stream; + /** Whether the file item was already opened. + */ + private boolean opened; + /** The headers, if any. + */ + private FileItemHeaders headers; + + /** + * Creates a new instance. + * @param pName The items file name, or null. + * @param pFieldName The items field name. + * @param pContentType The items content type, or null. + * @param pFormField Whether the item is a form field. + * @param pContentLength The items content length, if known, or -1 + * @throws IOException Creating the file item failed. + */ + FileItemStreamImpl(String pName, String pFieldName, + String pContentType, boolean pFormField, + long pContentLength) throws IOException { + name = pName; + fieldName = pFieldName; + contentType = pContentType; + formField = pFormField; + final ItemInputStream itemStream = multi.newInputStream(); + InputStream istream = itemStream; + if (fileSizeMax != -1) { + if (pContentLength != -1 + && pContentLength > fileSizeMax) { + FileUploadException e = + new FileSizeLimitExceededException( + "The field " + fieldName + + " exceeds its maximum permitted " + + " size of " + fileSizeMax + + " characters.", + pContentLength, fileSizeMax); + throw new FileUploadIOException(e); } - headerName = header.substring(0, header.indexOf(':')) - .trim().toLowerCase(); - headerValue = - header.substring(header.indexOf(':') + 1).trim(); - if (getHeader(headers, headerName) != null) - { - // More that one heder of that name exists, - // append to the list. - headers.put(headerName, - getHeader(headers, headerName) + ',' - + headerValue); + istream = new LimitedInputStream(istream, fileSizeMax) { + @Override + protected void raiseError(long pSizeMax, long pCount) + throws IOException { + itemStream.close(true); + FileUploadException e = + new FileSizeLimitExceededException( + "The field " + fieldName + + " exceeds its maximum permitted " + + " size of " + pSizeMax + + " characters.", + pCount, pSizeMax); + throw new FileUploadIOException(e); + } + }; + } + stream = istream; + } + + /** + * Returns the items content type, or null. + * @return Content type, if known, or null. + */ + public String getContentType() { + return contentType; + } + + /** + * Returns the items field name. + * @return Field name. + */ + public String getFieldName() { + return fieldName; + } + + /** + * Returns the items file name. + * @return File name, if known, or null. + */ + public String getName() { + return name; + } + + /** + * Returns, whether this is a form field. + * @return True, if the item is a form field, + * otherwise false. + */ + public boolean isFormField() { + return formField; + } + + /** + * Returns an input stream, which may be used to + * read the items contents. + * @return Opened input stream. + * @throws IOException An I/O error occurred. + */ + public InputStream openStream() throws IOException { + if (opened) { + throw new IllegalStateException( + "The stream was already opened."); + } + if (((Closeable) stream).isClosed()) { + throw new FileItemStream.ItemSkippedException(); + } + return stream; + } + + /** + * Closes the file item. + * @throws IOException An I/O error occurred. + */ + void close() throws IOException { + stream.close(); + } + + /** + * Returns the file item headers. + * @return The items header object + */ + public FileItemHeaders getHeaders() { + return headers; + } + + /** + * Sets the file item headers. + * @param pHeaders The items header object + */ + public void setHeaders(FileItemHeaders pHeaders) { + headers = pHeaders; + } + } + + /** + * The multi part stream to process. + */ + private final MultipartStream multi; + /** + * The notifier, which used for triggering the + * {@link ProgressListener}. + */ + private final MultipartStream.ProgressNotifier notifier; + /** + * The boundary, which separates the various parts. + */ + private final byte[] boundary; + /** + * The item, which we currently process. + */ + private FileItemStreamImpl currentItem; + /** + * The current items field name. + */ + private String currentFieldName; + /** + * Whether we are currently skipping the preamble. + */ + private boolean skipPreamble; + /** + * Whether the current item may still be read. + */ + private boolean itemValid; + /** + * Whether we have seen the end of the file. + */ + private boolean eof; + + /** + * Creates a new instance. + * @param ctx The request context. + * @throws FileUploadException An error occurred while + * parsing the request. + * @throws IOException An I/O error occurred. + */ + FileItemIteratorImpl(RequestContext ctx) + throws FileUploadException, IOException { + if (ctx == null) { + throw new NullPointerException("ctx parameter"); + } + + String contentType = ctx.getContentType(); + if ((null == contentType) + || (!contentType.toLowerCase().startsWith(MULTIPART))) { + throw new InvalidContentTypeException( + "the request doesn't contain a " + + MULTIPART_FORM_DATA + + " or " + + MULTIPART_MIXED + + " stream, content type header is " + + contentType); + } + + InputStream input = ctx.getInputStream(); + + if (sizeMax >= 0) { + int requestSize = ctx.getContentLength(); + if (requestSize == -1) { + input = new LimitedInputStream(input, sizeMax) { + @Override + protected void raiseError(long pSizeMax, long pCount) + throws IOException { + FileUploadException ex = + new SizeLimitExceededException( + "the request was rejected because" + + " its size (" + pCount + + ") exceeds the configured maximum" + + " (" + pSizeMax + ")", + pCount, pSizeMax); + throw new FileUploadIOException(ex); + } + }; + } else { + if (sizeMax >= 0 && requestSize > sizeMax) { + throw new SizeLimitExceededException( + "the request was rejected because its size (" + + requestSize + + ") exceeds the configured maximum (" + + sizeMax + ")", + requestSize, sizeMax); } - else - { - headers.put(headerName, headerValue); + } + } + + String charEncoding = headerEncoding; + if (charEncoding == null) { + charEncoding = ctx.getCharacterEncoding(); + } + + boundary = getBoundary(contentType); + if (boundary == null) { + throw new FileUploadException( + "the request was rejected because " + + "no multipart boundary was found"); + } + + notifier = new MultipartStream.ProgressNotifier(listener, + ctx.getContentLength()); + multi = new MultipartStream(input, boundary, notifier); + multi.setHeaderEncoding(charEncoding); + + skipPreamble = true; + findNextItem(); + } + + /** + * Called for finding the nex item, if any. + * @return True, if an next item was found, otherwise false. + * @throws IOException An I/O error occurred. + */ + private boolean findNextItem() throws IOException { + if (eof) { + return false; + } + if (currentItem != null) { + currentItem.close(); + currentItem = null; + } + for (;;) { + boolean nextPart; + if (skipPreamble) { + nextPart = multi.skipPreamble(); + } else { + nextPart = multi.readBoundary(); + } + if (!nextPart) { + if (currentFieldName == null) { + // Outer multipart terminated -> No more data + eof = true; + return false; } + // Inner multipart terminated -> Return to parsing the outer + multi.setBoundary(boundary); + currentFieldName = null; + continue; } + FileItemHeaders headers = getParsedHeaders(multi.readHeaders()); + if (currentFieldName == null) { + // We're parsing the outer multipart + String fieldName = getFieldName(headers); + if (fieldName != null) { + String subContentType = headers.getHeader(CONTENT_TYPE); + if (subContentType != null + && subContentType.toLowerCase() + .startsWith(MULTIPART_MIXED)) { + currentFieldName = fieldName; + // Multiple files associated with this field name + byte[] subBoundary = getBoundary(subContentType); + multi.setBoundary(subBoundary); + skipPreamble = true; + continue; + } + String fileName = getFileName(headers); + currentItem = new FileItemStreamImpl(fileName, + fieldName, headers.getHeader(CONTENT_TYPE), + fileName == null, getContentLength(headers)); + currentItem.setHeaders(headers); + notifier.noteItem(); + itemValid = true; + return true; + } + } else { + String fileName = getFileName(headers); + if (fileName != null) { + currentItem = new FileItemStreamImpl(fileName, + currentFieldName, + headers.getHeader(CONTENT_TYPE), + false, getContentLength(headers)); + currentItem.setHeaders(headers); + notifier.noteItem(); + itemValid = true; + return true; + } + } + multi.discardBodyData(); } } - catch (IndexOutOfBoundsException e) - { - // Headers were malformed. continue with all that was - // parsed. + + private long getContentLength(FileItemHeaders pHeaders) { + try { + return Long.parseLong(pHeaders.getHeader(CONTENT_LENGTH)); + } catch (Exception e) { + return -1; + } } - return headers; + + /** + * Returns, whether another instance of {@link FileItemStream} + * is available. + * @throws FileUploadException Parsing or processing the + * file item failed. + * @throws IOException Reading the file item failed. + * @return True, if one or more additional file items + * are available, otherwise false. + */ + public boolean hasNext() throws FileUploadException, IOException { + if (eof) { + return false; + } + if (itemValid) { + return true; + } + return findNextItem(); + } + + /** + * Returns the next available {@link FileItemStream}. + * @throws java.util.NoSuchElementException No more items are + * available. Use {@link #hasNext()} to prevent this exception. + * @throws FileUploadException Parsing or processing the + * file item failed. + * @throws IOException Reading the file item failed. + * @return FileItemStream instance, which provides + * access to the next file item. + */ + public FileItemStream next() throws FileUploadException, IOException { + if (eof || (!itemValid && !hasNext())) { + throw new NoSuchElementException(); + } + itemValid = false; + return currentItem; + } } - /** - * Returns the header with the specified name from the supplied map. The - * header lookup is case-insensitive. - * - * @param headers A <code>Map</code> containing the HTTP request headers. - * @param name The name of the header to return. - * - * @return The value of specified header, or a comma-separated list if - * there were multiple headers of that name. + * This exception is thrown for hiding an inner + * {@link FileUploadException} in an {@link IOException}. */ - protected final String getHeader(Map /* String, String */ headers, - String name) - { - return (String) headers.get(name.toLowerCase()); + public static class FileUploadIOException extends IOException { + /** The exceptions UID, for serializing an instance. + */ + private static final long serialVersionUID = -7047616958165584154L; + /** The exceptions cause; we overwrite the parent + * classes field, which is available since Java + * 1.4 only. + */ + private final FileUploadException cause; + + /** + * Creates a <code>FileUploadIOException</code> with the + * given cause. + * @param pCause The exceptions cause, if any, or null. + */ + public FileUploadIOException(FileUploadException pCause) { + // We're not doing super(pCause) cause of 1.3 compatibility. + cause = pCause; + } + + /** + * Returns the exceptions cause. + * @return The exceptions cause, if any, or null. + */ + @Override + public Throwable getCause() { + return cause; + } } - /** * Thrown to indicate that the request is not a multipart request. */ public static class InvalidContentTypeException - extends FileUploadException - { + extends FileUploadException { + /** The exceptions UID, for serializing an instance. + */ + private static final long serialVersionUID = -9073026332015646668L; + /** * Constructs a <code>InvalidContentTypeException</code> with no * detail message. */ - public InvalidContentTypeException() - { - super(); + public InvalidContentTypeException() { + // Nothing to do. } /** @@ -596,93 +976,151 @@ * * @param message The detail message. */ - public InvalidContentTypeException(String message) - { + public InvalidContentTypeException(String message) { super(message); } } - /** - * Thrown to indicate that the request size is not specified. + * Thrown to indicate an IOException. */ - public static class UnknownSizeException - extends FileUploadException - { + public static class IOFileUploadException extends FileUploadException { + /** The exceptions UID, for serializing an instance. + */ + private static final long serialVersionUID = 1749796615868477269L; + /** The exceptions cause; we overwrite the parent + * classes field, which is available since Java + * 1.4 only. + */ + private final IOException cause; + /** - * Constructs a <code>UnknownSizeException</code> with no - * detail message. + * Creates a new instance with the given cause. + * @param pMsg The detail message. + * @param pException The exceptions cause. */ - public UnknownSizeException() - { - super(); + public IOFileUploadException(String pMsg, IOException pException) { + super(pMsg); + cause = pException; } /** - * Constructs an <code>UnknownSizeException</code> with - * the specified detail message. - * + * Returns the exceptions cause. + * @return The exceptions cause, if any, or null. + */ + @Override + public Throwable getCause() { + return cause; + } + } + + /** This exception is thrown, if a requests permitted size + * is exceeded. + */ + public abstract static class SizeException extends FileUploadException { + + private static final long serialVersionUID = 1L; + + /** + * The actual size of the request. + */ + private final long actual; + + /** + * The maximum permitted size of the request. + */ + private final long permitted; + + /** + * Creates a new instance. * @param message The detail message. + * @param actual The actual number of bytes in the request. + * @param permitted The requests size limit, in bytes. */ - public UnknownSizeException(String message) - { + protected SizeException(String message, long actual, long permitted) { super(message); + this.actual = actual; + this.permitted = permitted; } + + /** + * Retrieves the actual size of the request. + * + * @return The actual size of the request. + */ + public long getActualSize() { + return actual; + } + + /** + * Retrieves the permitted size of the request. + * + * @return The permitted size of the request. + */ + public long getPermittedSize() { + return permitted; + } } - /** * Thrown to indicate that the request size exceeds the configured maximum. */ public static class SizeLimitExceededException - extends FileUploadException - { - /** - * Constructs a <code>SizeExceededException</code> with no - * detail message. + extends SizeException { + /** The exceptions UID, for serializing an instance. */ - public SizeLimitExceededException() - { - super(); - } + private static final long serialVersionUID = -2474893167098052828L; /** - * Constructs an <code>SizeExceededException</code> with - * the specified detail message. + * Constructs a <code>SizeExceededException</code> with + * the specified detail message, and actual and permitted sizes. * - * @param message The detail message. + * @param message The detail message. + * @param actual The actual request size. + * @param permitted The maximum permitted request size. */ - public SizeLimitExceededException(String message) - { - super(message); + public SizeLimitExceededException(String message, long actual, + long permitted) { + super(message, actual, permitted); } } /** - * Thrown to indicate that the request size exceeds the configured maximum. + * Thrown to indicate that A files size exceeds the configured maximum. */ public static class FileSizeLimitExceededException - extends FileUploadException - { - /** - * Constructs a <code>SizeExceededException</code> with no - * detail message. + extends SizeException { + /** The exceptions UID, for serializing an instance. */ - public FileSizeLimitExceededException() - { - super(); - } + private static final long serialVersionUID = 8150776562029630058L; /** - * Constructs an <code>SizeExceededException</code> with - * the specified detail message. + * Constructs a <code>SizeExceededException</code> with + * the specified detail message, and actual and permitted sizes. * - * @param message The detail message. + * @param message The detail message. + * @param actual The actual request size. + * @param permitted The maximum permitted request size. */ - public FileSizeLimitExceededException(String message) - { - super(message); + public FileSizeLimitExceededException(String message, long actual, + long permitted) { + super(message, actual, permitted); } } + /** + * Returns the progress listener. + * @return The progress listener, if any, or null. + */ + public ProgressListener getProgressListener() { + return listener; + } + + /** + * Sets the progress listener. + * @param pListener The progress listener, if any. Defaults to null. + */ + public void setProgressListener(ProgressListener pListener) { + listener = pListener; + } } Modified: trunk/java/org/apache/tomcat/util/http/fileupload/FileUploadException.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileUploadException.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileUploadException.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -5,20 +5,19 @@ * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; -import java.io.IOException; +import java.io.PrintStream; +import java.io.PrintWriter; /** @@ -27,15 +26,23 @@ * @author <a href="mailto:jmcnally@collab.net">John McNally</a> * @version $Id$ */ -public class FileUploadException - extends IOException -{ +public class FileUploadException extends Exception { + /** + * Serial version UID, being used, if the exception + * is serialized. + */ + private static final long serialVersionUID = 8881893724388807504L; + /** + * The exceptions cause. We overwrite the cause of + * the super class, which isn't available in Java 1.3. + */ + private final Throwable cause; /** * Constructs a new <code>FileUploadException</code> without message. */ - public FileUploadException() - { + public FileUploadException() { + this(null, null); } /** @@ -44,8 +51,52 @@ * * @param msg the error message. */ - public FileUploadException(String msg) - { + public FileUploadException(final String msg) { + this(msg, null); + } + + /** + * Creates a new <code>FileUploadException</code> with the given + * detail message and cause. + * @param msg The exceptions detail message. + * @param cause The exceptions cause. + */ + public FileUploadException(String msg, Throwable cause) { super(msg); + this.cause = cause; } + + /** + * Prints this throwable and its backtrace to the specified print stream. + * + * @param stream <code>PrintStream</code> to use for output + */ + @Override + public void printStackTrace(PrintStream stream) { + super.printStackTrace(stream); + if (cause != null) { + stream.println("Caused by:"); + cause.printStackTrace(stream); + } + } + + /** + * Prints this throwable and its backtrace to the specified + * print writer. + * + * @param writer <code>PrintWriter</code> to use for output + */ + @Override + public void printStackTrace(PrintWriter writer) { + super.printStackTrace(writer); + if (cause != null) { + writer.println("Caused by:"); + cause.printStackTrace(writer); + } + } + + @Override + public Throwable getCause() { + return cause; + } } Added: trunk/java/org/apache/tomcat/util/http/fileupload/FileUtils.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/FileUtils.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/FileUtils.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,229 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.File; +import java.io.FileNotFoundException; +import java.io.IOException; + + +/** + * General file manipulation utilities. + * <p> + * Facilities are provided in the following areas: + * <ul> + * <li>writing to a file + * <li>reading from a file + * <li>make a directory including parent directories + * <li>copying files and directories + * <li>deleting files and directories + * <li>converting to and from a URL + * <li>listing files and directories by filter and extension + * <li>comparing file content + * <li>file last changed date + * <li>calculating a checksum + * </ul> + * <p> + * Origin of code: Excalibur, Alexandria, Commons-Utils + * + * @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</A> + * @author <a href="mailto:sanders@apache.org">Scott Sanders</a> + * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a> + * @author <a href="mailto:Christoph.Reck@dlr.de">Christoph.Reck</a> + * @author <a href="mailto:peter@apache.org">Peter Donald</a> + * @author <a href="mailto:jefft@apache.org">Jeff Turner</a> + * @author Matthew Hawthorne + * @author <a href="mailto:jeremias@apache.org">Jeremias Maerki</a> + * @author Stephen Colebourne + * @author Ian Springer + * @author Chris Eldredge + * @author Jim Harrington + * @author Niall Pemberton + * @author Sandy McArthur + * @version $Id: FileUtils.java 881493 2009-11-17 20:30:39Z markt $ + */ +public class FileUtils { + + /** + * Instances should NOT be constructed in standard programming. + */ + public FileUtils() { + super(); + } + + //----------------------------------------------------------------------- + /** + * Deletes a directory recursively. + * + * @param directory directory to delete + * @throws IOException in case deletion is unsuccessful + */ + public static void deleteDirectory(File directory) throws IOException { + if (!directory.exists()) { + return; + } + + cleanDirectory(directory); + if (!directory.delete()) { + String message = + "Unable to delete directory " + directory + "."; + throw new IOException(message); + } + } + + + + /** + * Cleans a directory without deleting it. + * + * @param directory directory to clean + * @throws IOException in case cleaning is unsuccessful + */ + public static void cleanDirectory(File directory) throws IOException { + if (!directory.exists()) { + String message = directory + " does not exist"; + throw new IllegalArgumentException(message); + } + + if (!directory.isDirectory()) { + String message = directory + " is not a directory"; + throw new IllegalArgumentException(message); + } + + File[] files = directory.listFiles(); + if (files == null) { // null if security restricted + throw new IOException("Failed to list contents of " + directory); + } + + IOException exception = null; + for (int i = 0; i < files.length; i++) { + File file = files[i]; + try { + forceDelete(file); + } catch (IOException ioe) { + exception = ioe; + } + } + + if (null != exception) { + throw exception; + } + } + + + //----------------------------------------------------------------------- + /** + * Deletes a file. If file is a directory, delete it and all sub-directories. + * <p> + * The difference between File.delete() and this method are: + * <ul> + * <li>A directory to be deleted does not have to be empty.</li> + * <li>You get exceptions when a file or directory cannot be deleted. + * (java.io.File methods returns a boolean)</li> + * </ul> + * + * @param file file or directory to delete, must not be <code>null</code> + * @throws NullPointerException if the directory is <code>null</code> + * @throws FileNotFoundException if the file was not found + * @throws IOException in case deletion is unsuccessful + */ + public static void forceDelete(File file) throws IOException { + if (file.isDirectory()) { + deleteDirectory(file); + } else { + boolean filePresent = file.exists(); + if (!file.delete()) { + if (!filePresent){ + throw new FileNotFoundException("File does not exist: " + file); + } + String message = + "Unable to delete file: " + file; + throw new IOException(message); + } + } + } + + /** + * Schedules a file to be deleted when JVM exits. + * If file is directory delete it and all sub-directories. + * + * @param file file or directory to delete, must not be <code>null</code> + * @throws NullPointerException if the file is <code>null</code> + * @throws IOException in case deletion is unsuccessful + */ + public static void forceDeleteOnExit(File file) throws IOException { + if (file.isDirectory()) { + deleteDirectoryOnExit(file); + } else { + file.deleteOnExit(); + } + } + + /** + * Schedules a directory recursively for deletion on JVM exit. + * + * @param directory directory to delete, must not be <code>null</code> + * @throws NullPointerException if the directory is <code>null</code> + * @throws IOException in case deletion is unsuccessful + */ + private static void deleteDirectoryOnExit(File directory) throws IOException { + if (!directory.exists()) { + return; + } + + cleanDirectoryOnExit(directory); + directory.deleteOnExit(); + } + + /** + * Cleans a directory without deleting it. + * + * @param directory directory to clean, must not be <code>null</code> + * @throws NullPointerException if the directory is <code>null</code> + * @throws IOException in case cleaning is unsuccessful + */ + private static void cleanDirectoryOnExit(File directory) throws IOException { + if (!directory.exists()) { + String message = directory + " does not exist"; + throw new IllegalArgumentException(message); + } + + if (!directory.isDirectory()) { + String message = directory + " is not a directory"; + throw new IllegalArgumentException(message); + } + + File[] files = directory.listFiles(); + if (files == null) { // null if security restricted + throw new IOException("Failed to list contents of " + directory); + } + + IOException exception = null; + for (int i = 0; i < files.length; i++) { + File file = files[i]; + try { + forceDeleteOnExit(file); + } catch (IOException ioe) { + exception = ioe; + } + } + + if (null != exception) { + throw exception; + } + } +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/IOUtils.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/IOUtils.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/IOUtils.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,162 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; + + +/** + * General IO stream manipulation utilities. + * <p> + * This class provides static utility methods for input/output operations. + * <ul> + * <li>closeQuietly - these methods close a stream ignoring nulls and exceptions + * <li>toXxx/read - these methods read data from a stream + * <li>write - these methods write data to a stream + * <li>copy - these methods copy all the data from one stream to another + * <li>contentEquals - these methods compare the content of two streams + * </ul> + * <p> + * The byte-to-char methods and char-to-byte methods involve a conversion step. + * Two methods are provided in each case, one that uses the platform default + * encoding and the other which allows you to specify an encoding. You are + * encouraged to always specify an encoding because relying on the platform + * default can lead to unexpected results, for example when moving from + * development to production. + * <p> + * All the methods in this class that read a stream are buffered internally. + * This means that there is no cause to use a <code>BufferedInputStream</code> + * or <code>BufferedReader</code>. The default buffer size of 4K has been shown + * to be efficient in tests. + * <p> + * Wherever possible, the methods in this class do <em>not</em> flush or close + * the stream. This is to avoid making non-portable assumptions about the + * streams' origin and further use. Thus the caller is still responsible for + * closing streams after use. + * <p> + * Origin of code: Excalibur. + * + * @author Peter Donald + * @author Jeff Turner + * @author Matthew Hawthorne + * @author Stephen Colebourne + * @author Gareth Davis + * @author Ian Springer + * @author Niall Pemberton + * @author Sandy McArthur + * @version $Id: IOUtils.java 881493 2009-11-17 20:30:39Z markt $ + */ +public class IOUtils { + // NOTE: This class is focussed on InputStream, OutputStream, Reader and + // Writer. Each method should take at least one of these as a parameter, + // or return one of them. + + /** + * The default buffer size to use. + */ + private static final int DEFAULT_BUFFER_SIZE = 1024 * 4; + + /** + * Instances should NOT be constructed in standard programming. + */ + public IOUtils() { + super(); + } + + + /** + * Unconditionally close an <code>InputStream</code>. + * <p> + * Equivalent to {@link InputStream#close()}, except any exceptions will be ignored. + * This is typically used in finally blocks. + * + * @param input the InputStream to close, may be null or already closed + */ + public static void closeQuietly(InputStream input) { + try { + if (input != null) { + input.close(); + } + } catch (IOException ioe) { + // ignore + } + } + + // copy from InputStream + //----------------------------------------------------------------------- + /** + * Copy bytes from an <code>InputStream</code> to an + * <code>OutputStream</code>. + * <p> + * This method buffers the input internally, so there is no need to use a + * <code>BufferedInputStream</code>. + * <p> + * Large streams (over 2GB) will return a bytes copied value of + * <code>-1</code> after the copy has completed since the correct + * number of bytes cannot be returned as an int. For large streams + * use the <code>copyLarge(InputStream, OutputStream)</code> method. + * + * @param input the <code>InputStream</code> to read from + * @param output the <code>OutputStream</code> to write to + * @return the number of bytes copied + * @throws NullPointerException if the input or output is null + * @throws IOException if an I/O error occurs + * @throws ArithmeticException if the byte count is too large + * @since Commons IO 1.1 + */ + public static int copy(InputStream input, OutputStream output) throws IOException { + long count = copyLarge(input, output); + if (count > Integer.MAX_VALUE) { + return -1; + } + return (int) count; + } + + /** + * Copy bytes from a large (over 2GB) <code>InputStream</code> to an + * <code>OutputStream</code>. + * <p> + * This method buffers the input internally, so there is no need to use a + * <code>BufferedInputStream</code>. + * + * @param input the <code>InputStream</code> to read from + * @param output the <code>OutputStream</code> to write to + * @return the number of bytes copied + * @throws NullPointerException if the input or output is null + * @throws IOException if an I/O error occurs + * @since Commons IO 1.3 + */ + public static long copyLarge(InputStream input, OutputStream output) + throws IOException { + byte[] buffer = new byte[DEFAULT_BUFFER_SIZE]; + long count = 0; + int n = 0; + while (-1 != (n = input.read(buffer))) { + output.write(buffer, 0, n); + count += n; + } + return count; + } + + + + + + +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/LimitedInputStream.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/LimitedInputStream.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/LimitedInputStream.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,158 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.FilterInputStream; +import java.io.IOException; +import java.io.InputStream; + + +/** + * An input stream, which limits its data size. This stream is + * used, if the content length is unknown. + */ +public abstract class LimitedInputStream + extends FilterInputStream implements Closeable { + /** + * The maximum size of an item, in bytes. + */ + private long sizeMax; + /** + * The current number of bytes. + */ + private long count; + /** + * Whether this stream is already closed. + */ + private boolean closed; + + /** + * Creates a new instance. + * @param pIn The input stream, which shall be limited. + * @param pSizeMax The limit; no more than this number of bytes + * shall be returned by the source stream. + */ + public LimitedInputStream(InputStream pIn, long pSizeMax) { + super(pIn); + sizeMax = pSizeMax; + } + + /** + * Called to indicate, that the input streams limit has + * been exceeded. + * @param pSizeMax The input streams limit, in bytes. + * @param pCount The actual number of bytes. + * @throws IOException The called method is expected + * to raise an IOException. + */ + protected abstract void raiseError(long pSizeMax, long pCount) + throws IOException; + + /** Called to check, whether the input streams + * limit is reached. + * @throws IOException The given limit is exceeded. + */ + private void checkLimit() throws IOException { + if (count > sizeMax) { + raiseError(sizeMax, count); + } + } + + /** + * Reads the next byte of data from this input stream. The value + * byte is returned as an <code>int</code> in the range + * <code>0</code> to <code>255</code>. If no byte is available + * because the end of the stream has been reached, the value + * <code>-1</code> is returned. This method blocks until input data + * is available, the end of the stream is detected, or an exception + * is thrown. + * <p> + * This method + * simply performs <code>in.read()</code> and returns the result. + * + * @return the next byte of data, or <code>-1</code> if the end of the + * stream is reached. + * @exception IOException if an I/O error occurs. + * @see java.io.FilterInputStream#in + */ + @Override + public int read() throws IOException { + int res = super.read(); + if (res != -1) { + count++; + checkLimit(); + } + return res; + } + + /** + * Reads up to <code>len</code> bytes of data from this input stream + * into an array of bytes. If <code>len</code> is not zero, the method + * blocks until some input is available; otherwise, no + * bytes are read and <code>0</code> is returned. + * <p> + * This method simply performs <code>in.read(b, off, len)</code> + * and returns the result. + * + * @param b the buffer into which the data is read. + * @param off The start offset in the destination array + * <code>b</code>. + * @param len the maximum number of bytes read. + * @return the total number of bytes read into the buffer, or + * <code>-1</code> if there is no more data because the end of + * the stream has been reached. + * @exception NullPointerException If <code>b</code> is <code>null</code>. + * @exception IndexOutOfBoundsException If <code>off</code> is negative, + * <code>len</code> is negative, or <code>len</code> is greater than + * <code>b.length - off</code> + * @exception IOException if an I/O error occurs. + * @see java.io.FilterInputStream#in + */ + @Override + public int read(byte[] b, int off, int len) throws IOException { + int res = super.read(b, off, len); + if (res > 0) { + count += res; + checkLimit(); + } + return res; + } + + /** + * Returns, whether this stream is already closed. + * @return True, if the stream is closed, otherwise false. + * @throws IOException An I/O error occurred. + */ + public boolean isClosed() throws IOException { + return closed; + } + + /** + * Closes this input stream and releases any system resources + * associated with the stream. + * This + * method simply performs <code>in.close()</code>. + * + * @exception IOException if an I/O error occurs. + * @see java.io.FilterInputStream#in + */ + @Override + public void close() throws IOException { + closed = true; + super.close(); + } +} Modified: trunk/java/org/apache/tomcat/util/http/fileupload/MultipartStream.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/MultipartStream.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/MultipartStream.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -5,20 +5,17 @@ * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; - import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; @@ -41,7 +38,7 @@ * multipart-body := preamble 1*encapsulation close-delimiter epilogue<br> * encapsulation := delimiter body CRLF<br> * delimiter := "--" boundary CRLF<br> - * close-delimiter := "--" boudary "--"<br> + * close-delimiter := "--" boundary "--"<br> * preamble := &lt;ignore&gt;<br> * epilogue := &lt;ignore&gt;<br> * body := header-part CRLF body-part<br> @@ -58,13 +55,13 @@ * boundary token of the same length as the parent stream (see {@link * #setBoundary(byte[])}). * - * <p>Here is an exaple of usage of this class.<br> + * <p>Here is an example of usage of this class.<br> * * <pre> * try { * MultipartStream multipartStream = new MultipartStream(input, * boundary); - * boolean nextPart = malitPartStream.skipPreamble(); + * boolean nextPart = multipartStream.skipPreamble(); * OutputStream output; * while(nextPart) { * header = chunks.readHeader(); @@ -87,13 +84,79 @@ * * @version $Id$ */ -public class MultipartStream -{ +public class MultipartStream { + /** + * Internal class, which is used to invoke the + * {@link ProgressListener}. + */ + static class ProgressNotifier { + /** The listener to invoke. + */ + private final ProgressListener listener; + /** Number of expected bytes, if known, or -1. + */ + private final long contentLength; + /** Number of bytes, which have been read so far. + */ + private long bytesRead; + /** Number of items, which have been read so far. + */ + private int items; + /** Creates a new instance with the given listener + * and content length. + * @param pListener The listener to invoke. + * @param pContentLength The expected content length. + */ + ProgressNotifier(ProgressListener pListener, long pContentLength) { + listener = pListener; + contentLength = pContentLength; + } + /** Called to indicate that bytes have been read. + * @param pBytes Number of bytes, which have been read. + */ + void noteBytesRead(int pBytes) { + /* Indicates, that the given number of bytes have been read from + * the input stream. + */ + bytesRead += pBytes; + notifyListener(); + } + /** Called to indicate, that a new file item has been detected. + */ + void noteItem() { + ++items; + } + /** Called for notifying the listener. + */ + private void notifyListener() { + if (listener != null) { + listener.update(bytesRead, contentLength, items); + } + } + } // ----------------------------------------------------- Manifest constants /** + * The Carriage Return ASCII character value. + */ + public static final byte CR = 0x0D; + + + /** + * The Line Feed ASCII character value. + */ + public static final byte LF = 0x0A; + + + /** + * The dash (-) ASCII character value. + */ + public static final byte DASH = 0x2D; + + + /** * The maximum length of <code>header-part</code> that will be * processed (10 kilobytes = 10240 bytes.). */ @@ -110,30 +173,40 @@ * A byte sequence that marks the end of <code>header-part</code> * (<code>CRLFCRLF</code>). */ - protected static final byte[] HEADER_SEPARATOR = {0x0D, 0x0A, 0x0D, 0x0A}; + protected static final byte[] HEADER_SEPARATOR = { + CR, LF, CR, LF }; /** * A byte sequence that that follows a delimiter that will be * followed by an encapsulation (<code>CRLF</code>). */ - protected static final byte[] FIELD_SEPARATOR = { 0x0D, 0x0A }; + protected static final byte[] FIELD_SEPARATOR = { + CR, LF}; /** * A byte sequence that that follows a delimiter of the last * encapsulation in the stream (<code>--</code>). */ - protected static final byte[] STREAM_TERMINATOR = { 0x2D, 0x2D }; + protected static final byte[] STREAM_TERMINATOR = { + DASH, DASH}; + /** + * A byte sequence that precedes a boundary (<code>CRLF--</code>). + */ + protected static final byte[] BOUNDARY_PREFIX = { + CR, LF, DASH, DASH}; + + // ----------------------------------------------------------- Data members /** * The input stream from which data is read. */ - private InputStream input; + private final InputStream input; /** @@ -158,13 +231,13 @@ /** * The length of the buffer used for processing the request. */ - private int bufSize; + private final int bufSize; /** * The buffer used for processing the request. */ - private byte[] buffer; + private final byte[] buffer; /** @@ -176,7 +249,7 @@ /** - * The index of last valid characer in the buffer + 1. + * The index of last valid character in the buffer + 1. * <br> * 0 <= tail <= bufSize */ @@ -188,24 +261,13 @@ */ private String headerEncoding; - - private long fileSizeMax = -1; - - // ----------------------------------------------------------- Constructors - - /** - * Default constructor. - * - * @see #MultipartStream(InputStream, byte[], int) - * @see #MultipartStream(InputStream, byte[]) - * + * The progress notifier, if any, or null. */ - public MultipartStream() - { - } + private final ProgressNotifier notifier; + // ----------------------------------------------------------- Constructors /** * <p> Constructs a <code>MultipartStream</code> with a custom size buffer. @@ -219,30 +281,30 @@ * @param boundary The token used for dividing the stream into * <code>encapsulations</code>. * @param bufSize The size of the buffer to be used, in bytes. + * @param pNotifier The notifier, which is used for calling the + * progress listener, if any. * - * - * @see #MultipartStream() - * @see #MultipartStream(InputStream, byte[]) - * + * @see #MultipartStream(InputStream, byte[], + * MultipartStream.ProgressNotifier) */ - public MultipartStream(InputStream input, - byte[] boundary, - int bufSize) - { + MultipartStream(InputStream input, + byte[] boundary, + int bufSize, + ProgressNotifier pNotifier) { this.input = input; this.bufSize = bufSize; this.buffer = new byte[bufSize]; + this.notifier = pNotifier; - // We prepend CR/LF to the boundary to chop trailng CR/LF from + // We prepend CR/LF to the boundary to chop trailing CR/LF from // body-data tokens. - this.boundary = new byte[boundary.length + 4]; - this.boundaryLength = boundary.length + 4; - this.keepRegion = boundary.length + 3; - this.boundary[0] = 0x0D; - this.boundary[1] = 0x0A; - this.boundary[2] = 0x2D; - this.boundary[3] = 0x2D; - System.arraycopy(boundary, 0, this.boundary, 4, boundary.length); + this.boundary = new byte[boundary.length + BOUNDARY_PREFIX.length]; + this.boundaryLength = boundary.length + BOUNDARY_PREFIX.length; + this.keepRegion = this.boundary.length; + System.arraycopy(BOUNDARY_PREFIX, 0, this.boundary, 0, + BOUNDARY_PREFIX.length); + System.arraycopy(boundary, 0, this.boundary, BOUNDARY_PREFIX.length, + boundary.length); head = 0; tail = 0; @@ -255,24 +317,20 @@ * @param input The <code>InputStream</code> to serve as a data source. * @param boundary The token used for dividing the stream into * <code>encapsulations</code>. + * @param pNotifier An object for calling the progress listener, if any. * - * @exception IOException when an error occurs. * - * @see #MultipartStream() - * @see #MultipartStream(InputStream, byte[], int) - * + * @see #MultipartStream(InputStream, byte[], int, + * MultipartStream.ProgressNotifier) */ - public MultipartStream(InputStream input, - byte[] boundary) - { - this(input, boundary, DEFAULT_BUFSIZE); + MultipartStream(InputStream input, + byte[] boundary, + ProgressNotifier pNotifier) { + this(input, boundary, DEFAULT_BUFSIZE, pNotifier); } - // --------------------------------------------------------- Public methods - - /** * Retrieves the character encoding used when reading the headers of an @@ -282,22 +340,11 @@ * * @return The encoding used to read part headers. */ - public String getHeaderEncoding() - { + public String getHeaderEncoding() { return headerEncoding; } - public long getFileSizeMax() { - return fileSizeMax; - } - - - public void setFileSizeMax(long fileSizeMax) { - this.fileSizeMax = fileSizeMax; - } - - /** * Specifies the character encoding to be used when reading the headers of * individual parts. When not specified, or <code>null</code>, the platform @@ -305,8 +352,7 @@ * * @param encoding The encoding used to read part headers. */ - public void setHeaderEncoding(String encoding) - { + public void setHeaderEncoding(String encoding) { headerEncoding = encoding; } @@ -317,22 +363,21 @@ * * @return The next byte from the input stream. * - * @exception IOException if there is no more data available. + * @throws IOException if there is no more data available. */ - public byte readByte() - throws IOException - { + public byte readByte() throws IOException { // Buffer depleted ? - if (head == tail) - { + if (head == tail) { head = 0; // Refill. tail = input.read(buffer, head, bufSize); - if (tail == -1) - { + if (tail == -1) { // No more data available. throw new IOException("No more data is available"); } + if (notifier != null) { + notifier.noteBytesRead(tail); + } } return buffer[head++]; } @@ -345,36 +390,37 @@ * @return <code>true</code> if there are more encapsulations in * this stream; <code>false</code> otherwise. * - * @exception MalformedStreamException if the stream ends unexpecetedly or - * fails to follow required syntax. + * @throws MalformedStreamException if the stream ends unexpecetedly or + * fails to follow required syntax. */ public boolean readBoundary() - throws MalformedStreamException - { + throws MalformedStreamException { byte[] marker = new byte[2]; boolean nextChunk = false; head += boundaryLength; - try - { + try { marker[0] = readByte(); + if (marker[0] == LF) { + // Work around IE5 Mac bug with input type=image. + // Because the boundary delimiter, not including the trailing + // CRLF, must not appear within any file (RFC 2046, section + // 5.1.1), we know the missing CR is due to a buggy browser + // rather than a file containing something similar to a + // boundary. + return true; + } + marker[1] = readByte(); - if (arrayequals(marker, STREAM_TERMINATOR, 2)) - { + if (arrayequals(marker, STREAM_TERMINATOR, 2)) { nextChunk = false; - } - else if (arrayequals(marker, FIELD_SEPARATOR, 2)) - { + } else if (arrayequals(marker, FIELD_SEPARATOR, 2)) { nextChunk = true; - } - else - { + } else { throw new MalformedStreamException( - "Unexpected characters follow a boundary"); + "Unexpected characters follow a boundary"); } - } - catch (IOException e) - { + } catch (IOException e) { throw new MalformedStreamException("Stream ended unexpectedly"); } return nextChunk; @@ -396,19 +442,18 @@ * @param boundary The boundary to be used for parsing of the nested * stream. * - * @exception IllegalBoundaryException if the <code>boundary</code> - * has a different length than the one - * being currently parsed. + * @throws IllegalBoundaryException if the <code>boundary</code> + * has a different length than the one + * being currently parsed. */ public void setBoundary(byte[] boundary) - throws IllegalBoundaryException - { - if (boundary.length != boundaryLength - 4) - { + throws IllegalBoundaryException { + if (boundary.length != boundaryLength - BOUNDARY_PREFIX.length) { throw new IllegalBoundaryException( - "The length of a boundary token can not be changed"); + "The length of a boundary token can not be changed"); } - System.arraycopy(boundary, 0, this.boundary, 4, boundary.length); + System.arraycopy(boundary, 0, this.boundary, BOUNDARY_PREFIX.length, + boundary.length); } @@ -425,58 +470,44 @@ * * @return The <code>header-part</code> of the current encapsulation. * - * @exception MalformedStreamException if the stream ends unexpecetedly. + * @throws MalformedStreamException if the stream ends unexpecetedly. */ public String readHeaders() - throws MalformedStreamException - { + throws MalformedStreamException { int i = 0; - byte b[] = new byte[1]; + byte b; // to support multi-byte characters ByteArrayOutputStream baos = new ByteArrayOutputStream(); - int sizeMax = HEADER_PART_SIZE_MAX; int size = 0; - while (i < 4) - { - try - { - b[0] = readByte(); - } - catch (IOException e) - { + while (i < HEADER_SEPARATOR.length) { + try { + b = readByte(); + } catch (IOException e) { throw new MalformedStreamException("Stream ended unexpectedly"); } - size++; - if (b[0] == HEADER_SEPARATOR[i]) - { + if (++size > HEADER_PART_SIZE_MAX) { + throw new MalformedStreamException( + "Header section has more than " + HEADER_PART_SIZE_MAX + + " bytes (maybe it is not properly terminated)"); + } + if (b == HEADER_SEPARATOR[i]) { i++; - } - else - { + } else { i = 0; } - if (size <= sizeMax) - { - baos.write(b[0]); - } + baos.write(b); } String headers = null; - if (headerEncoding != null) - { - try - { + if (headerEncoding != null) { + try { headers = baos.toString(headerEncoding); - } - catch (UnsupportedEncodingException e) - { + } catch (UnsupportedEncodingException e) { // Fall back to platform default if specified encoding is not // supported. headers = baos.toString(); } - } - else - { + } else { headers = baos.toString(); } @@ -491,85 +522,32 @@ * * <p>Arbitrary large amounts of data can be processed by this * method using a constant size buffer. (see {@link - * #MultipartStream(InputStream,byte[],int) constructor}). + * #MultipartStream(InputStream,byte[],int, + * MultipartStream.ProgressNotifier) constructor}). * - * @param output The <code>Stream</code> to write data into. + * @param output The <code>Stream</code> to write data into. May + * be null, in which case this method is equivalent + * to {@link #discardBodyData()}. * * @return the amount of data written. * - * @exception MalformedStreamException if the stream ends unexpectedly. - * @exception IOException if an i/o error occurs. + * @throws MalformedStreamException if the stream ends unexpectedly. + * @throws IOException if an i/o error occurs. */ public int readBodyData(OutputStream output) - throws MalformedStreamException, - IOException - { - boolean done = false; - int pad; - int pos; - int bytesRead; - int total = 0; - while (!done) - { - if (fileSizeMax > 0 && total > fileSizeMax) { - throw new FileUploadBase.FileSizeLimitExceededException("File size exceeded"); - } - // Is boundary token present somewere in the buffer? - pos = findSeparator(); - if (pos != -1) - { - // Write the rest of the data before the boundary. - output.write(buffer, head, pos - head); - total += pos - head; - head = pos; - done = true; - } - else - { - // Determine how much data should be kept in the - // buffer. - if (tail - head > keepRegion) - { - pad = keepRegion; - } - else - { - pad = tail - head; - } - // Write out the data belonging to the body-data. - output.write(buffer, head, tail - head - pad); + throws MalformedStreamException, IOException { + final InputStream istream = newInputStream(); + return (int) Streams.copy(istream, output, false); + } - // Move the data to the beging of the buffer. - total += tail - head - pad; - System.arraycopy(buffer, tail - pad, buffer, 0, pad); - - // Refill buffer with new data. - head = 0; - bytesRead = input.read(buffer, pad, bufSize - pad); - - // [pprrrrrrr] - if (bytesRead != -1) - { - tail = pad + bytesRead; - } - else - { - // The last pad amount is left in the buffer. - // Boundary can't be in there so write out the - // data you have and signal an error condition. - output.write(buffer, 0, pad); - output.flush(); - total += pad; - throw new MalformedStreamException( - "Stream ended unexpectedly"); - } - } - } - output.flush(); - return total; + /** + * Creates a new {@link ItemInputStream}. + * @return A new instance of {@link ItemInputStream}. + */ + ItemInputStream newInputStream() { + return new ItemInputStream(); } - /** * <p> Reads <code>body-data</code> from the current * <code>encapsulation</code> and discards it. @@ -579,67 +557,13 @@ * * @return The amount of data discarded. * - * @exception MalformedStreamException if the stream ends unexpectedly. - * @exception IOException if an i/o error occurs. + * @throws MalformedStreamException if the stream ends unexpectedly. + * @throws IOException if an i/o error occurs. */ public int discardBodyData() - throws MalformedStreamException, - IOException - { - boolean done = false; - int pad; - int pos; - int bytesRead; - int total = 0; - while (!done) - { - // Is boundary token present somewere in the buffer? - pos = findSeparator(); - if (pos != -1) - { - // Write the rest of the data before the boundary. - total += pos - head; - head = pos; - done = true; - } - else - { - // Determine how much data should be kept in the - // buffer. - if (tail - head > keepRegion) - { - pad = keepRegion; - } - else - { - pad = tail - head; - } - total += tail - head - pad; - - // Move the data to the beging of the buffer. - System.arraycopy(buffer, tail - pad, buffer, 0, pad); - - // Refill buffer with new data. - head = 0; - bytesRead = input.read(buffer, pad, bufSize - pad); - - // [pprrrrrrr] - if (bytesRead != -1) - { - tail = pad + bytesRead; - } - else - { - // The last pad amount is left in the buffer. - // Boundary can't be in there so signal an error - // condition. - total += pad; - throw new MalformedStreamException( - "Stream ended unexpectedly"); - } - } - } - return total; + throws MalformedStreamException, + IOException { + return readBodyData(null); } @@ -649,34 +573,28 @@ * @return <code>true</code> if an <code>encapsulation</code> was found in * the stream. * - * @exception IOException if an i/o error occurs. + * @throws IOException if an i/o error occurs. */ public boolean skipPreamble() - throws IOException - { + throws IOException { // First delimiter may be not preceeded with a CRLF. System.arraycopy(boundary, 2, boundary, 0, boundary.length - 2); boundaryLength = boundary.length - 2; - try - { + try { // Discard all data up to the delimiter. discardBodyData(); - // Read boundary - if succeded, the stream contains an + // Read boundary - if succeeded, the stream contains an // encapsulation. return readBoundary(); - } - catch (MalformedStreamException e) - { + } catch (MalformedStreamException e) { return false; - } - finally - { + } finally { // Restore delimiter. System.arraycopy(boundary, 0, boundary, 2, boundary.length - 2); boundaryLength = boundary.length; - boundary[0] = 0x0D; - boundary[1] = 0x0A; + boundary[0] = CR; + boundary[1] = LF; } } @@ -693,13 +611,10 @@ * <code>a</code> and <code>b</code> are equal. */ public static boolean arrayequals(byte[] a, - byte[] b, - int count) - { - for (int i = 0; i < count; i++) - { - if (a[i] != b[i]) - { + byte[] b, + int count) { + for (int i = 0; i < count; i++) { + if (a[i] != b[i]) { return false; } } @@ -718,12 +633,9 @@ * <code>buffer</code>, or <code>-1</code> if not found. */ protected int findByte(byte value, - int pos) - { - for (int i = pos; i < tail; i++) - { - if (buffer[i] == value) - { + int pos) { + for (int i = pos; i < tail; i++) { + if (buffer[i] == value) { return i; } } @@ -740,63 +652,43 @@ * beginning of the <code>buffer</code>, or <code>-1</code> if * not found. */ - protected int findSeparator() - { + protected int findSeparator() { int first; int match = 0; int maxpos = tail - boundaryLength; for (first = head; - (first <= maxpos) && (match != boundaryLength); - first++) - { + (first <= maxpos) && (match != boundaryLength); + first++) { first = findByte(boundary[0], first); - if (first == -1 || (first > maxpos)) - { + if (first == -1 || (first > maxpos)) { return -1; } - for (match = 1; match < boundaryLength; match++) - { - if (buffer[first + match] != boundary[match]) - { + for (match = 1; match < boundaryLength; match++) { + if (buffer[first + match] != boundary[match]) { break; } } } - if (match == boundaryLength) - { + if (match == boundaryLength) { return first - 1; } return -1; } /** - * Returns a string representation of this object. - * - * @return The string representation of this object. - */ - public String toString() - { - StringBuilder sbTemp = new StringBuilder(); - sbTemp.append("boundary='"); - sbTemp.append(String.valueOf(boundary)); - sbTemp.append("'\nbufSize="); - sbTemp.append(bufSize); - return sbTemp.toString(); - } - - /** * Thrown to indicate that the input stream fails to follow the * required syntax. */ - public class MalformedStreamException - extends IOException - { + public static class MalformedStreamException + extends IOException { + + private static final long serialVersionUID = 1L; + /** * Constructs a <code>MalformedStreamException</code> with no * detail message. */ - public MalformedStreamException() - { + public MalformedStreamException() { super(); } @@ -806,8 +698,7 @@ * * @param message The detail message. */ - public MalformedStreamException(String message) - { + public MalformedStreamException(String message) { super(message); } } @@ -816,15 +707,16 @@ /** * Thrown upon attempt of setting an invalid boundary token. */ - public class IllegalBoundaryException - extends IOException - { + public static class IllegalBoundaryException + extends IOException { + + private static final long serialVersionUID = 1L; + /** * Constructs an <code>IllegalBoundaryException</code> with no * detail message. */ - public IllegalBoundaryException() - { + public IllegalBoundaryException() { super(); } @@ -834,13 +726,243 @@ * * @param message The detail message. */ - public IllegalBoundaryException(String message) - { + public IllegalBoundaryException(String message) { super(message); } } + /** + * An {@link InputStream} for reading an items contents. + */ + public class ItemInputStream extends InputStream implements Closeable { + /** The number of bytes, which have been read so far. + */ + private long total; + /** The number of bytes, which must be hold, because + * they might be a part of the boundary. + */ + private int pad; + /** The current offset in the buffer. + */ + private int pos; + /** Whether the stream is already closed. + */ + private boolean closed; + /** + * Creates a new instance. + */ + ItemInputStream() { + findSeparator(); + } + + /** + * Called for finding the separator. + */ + private void findSeparator() { + pos = MultipartStream.this.findSeparator(); + if (pos == -1) { + if (tail - head > keepRegion) { + pad = keepRegion; + } else { + pad = tail - head; + } + } + } + + /** + * Returns the number of bytes, which have been read + * by the stream. + * @return Number of bytes, which have been read so far. + */ + public long getBytesRead() { + return total; + } + + /** + * Returns the number of bytes, which are currently + * available, without blocking. + * @throws IOException An I/O error occurs. + * @return Number of bytes in the buffer. + */ + @Override + public int available() throws IOException { + if (pos == -1) { + return tail - head - pad; + } + return pos - head; + } + + /** Offset when converting negative bytes to integers. + */ + private static final int BYTE_POSITIVE_OFFSET = 256; + + /** + * Returns the next byte in the stream. + * @return The next byte in the stream, as a non-negative + * integer, or -1 for EOF. + * @throws IOException An I/O error occurred. + */ + @Override + public int read() throws IOException { + if (closed) { + throw new FileItemStream.ItemSkippedException(); + } + if (available() == 0) { + if (makeAvailable() == 0) { + return -1; + } + } + ++total; + int b = buffer[head++]; + if (b >= 0) { + return b; + } + return b + BYTE_POSITIVE_OFFSET; + } + + /** + * Reads bytes into the given buffer. + * @param b The destination buffer, where to write to. + * @param off Offset of the first byte in the buffer. + * @param len Maximum number of bytes to read. + * @return Number of bytes, which have been actually read, + * or -1 for EOF. + * @throws IOException An I/O error occurred. + */ + @Override + public int read(byte[] b, int off, int len) throws IOException { + if (closed) { + throw new FileItemStream.ItemSkippedException(); + } + if (len == 0) { + return 0; + } + int res = available(); + if (res == 0) { + res = makeAvailable(); + if (res == 0) { + return -1; + } + } + res = Math.min(res, len); + System.arraycopy(buffer, head, b, off, res); + head += res; + total += res; + return res; + } + + /** + * Closes the input stream. + * @throws IOException An I/O error occurred. + */ + @Override + public void close() throws IOException { + close(false); + } + + /** + * Closes the input stream. + * @param pCloseUnderlying Whether to close the underlying stream + * (hard close) + * @throws IOException An I/O error occurred. + */ + public void close(boolean pCloseUnderlying) throws IOException { + if (closed) { + return; + } + if (pCloseUnderlying) { + closed = true; + input.close(); + } else { + for (;;) { + int av = available(); + if (av == 0) { + av = makeAvailable(); + if (av == 0) { + break; + } + } + skip(av); + } + } + closed = true; + } + + /** + * Skips the given number of bytes. + * @param bytes Number of bytes to skip. + * @return The number of bytes, which have actually been + * skipped. + * @throws IOException An I/O error occurred. + */ + @Override + public long skip(long bytes) throws IOException { + if (closed) { + throw new FileItemStream.ItemSkippedException(); + } + int av = available(); + if (av == 0) { + av = makeAvailable(); + if (av == 0) { + return 0; + } + } + long res = Math.min(av, bytes); + head += res; + return res; + } + + /** + * Attempts to read more data. + * @return Number of available bytes + * @throws IOException An I/O error occurred. + */ + private int makeAvailable() throws IOException { + if (pos != -1) { + return 0; + } + + // Move the data to the beginning of the buffer. + total += tail - head - pad; + System.arraycopy(buffer, tail - pad, buffer, 0, pad); + + // Refill buffer with new data. + head = 0; + tail = pad; + + for (;;) { + int bytesRead = input.read(buffer, tail, bufSize - tail); + if (bytesRead == -1) { + // The last pad amount is left in the buffer. + // Boundary can't be in there so signal an error + // condition. + final String msg = "Stream ended unexpectedly"; + throw new MalformedStreamException(msg); + } + if (notifier != null) { + notifier.noteBytesRead(bytesRead); + } + tail += bytesRead; + + findSeparator(); + int av = available(); + + if (av > 0 || pos != -1) { + return av; + } + } + } + + /** + * Returns, whether the stream is closed. + * @return True, if the stream is closed, otherwise false. + */ + public boolean isClosed() { + return closed; + } + } + // ------------------------------------------------------ Debugging methods @@ -877,7 +999,7 @@ // Main routine, for testing purposes only. // // @param args A String[] with the command line arguments. - // @exception Exception, a generic exception. + // @throws Exception, a generic exception. public static void main( String[] args ) throws Exception { @@ -905,5 +1027,5 @@ } } - */ + */ } Added: trunk/java/org/apache/tomcat/util/http/fileupload/ParameterParser.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/ParameterParser.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/ParameterParser.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,329 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.util.HashMap; +import java.util.Map; + +/** + * A simple parser intended to parse sequences of name/value pairs. + * Parameter values are exptected to be enclosed in quotes if they + * contain unsafe characters, such as '=' characters or separators. + * Parameter values are optional and can be omitted. + * + * <p> + * <code>param1 = value; param2 = "anything goes; really"; param3</code> + * </p> + * + * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a> + */ + +public class ParameterParser { + /** + * String to be parsed. + */ + private char[] chars = null; + + /** + * Current position in the string. + */ + private int pos = 0; + + /** + * Maximum position in the string. + */ + private int len = 0; + + /** + * Start of a token. + */ + private int i1 = 0; + + /** + * End of a token. + */ + private int i2 = 0; + + /** + * Whether names stored in the map should be converted to lower case. + */ + private boolean lowerCaseNames = false; + + /** + * Default ParameterParser constructor. + */ + public ParameterParser() { + super(); + } + + /** + * Are there any characters left to parse? + * + * @return <tt>true</tt> if there are unparsed characters, + * <tt>false</tt> otherwise. + */ + private boolean hasChar() { + return this.pos < this.len; + } + + /** + * A helper method to process the parsed token. This method removes + * leading and trailing blanks as well as enclosing quotation marks, + * when necessary. + * + * @param quoted <tt>true</tt> if quotation marks are expected, + * <tt>false</tt> otherwise. + * @return the token + */ + private String getToken(boolean quoted) { + // Trim leading white spaces + while ((i1 < i2) && (Character.isWhitespace(chars[i1]))) { + i1++; + } + // Trim trailing white spaces + while ((i2 > i1) && (Character.isWhitespace(chars[i2 - 1]))) { + i2--; + } + // Strip away quotation marks if necessary + if (quoted) { + if (((i2 - i1) >= 2) + && (chars[i1] == '"') + && (chars[i2 - 1] == '"')) { + i1++; + i2--; + } + } + String result = null; + if (i2 > i1) { + result = new String(chars, i1, i2 - i1); + } + return result; + } + + /** + * Tests if the given character is present in the array of characters. + * + * @param ch the character to test for presense in the array of characters + * @param charray the array of characters to test against + * + * @return <tt>true</tt> if the character is present in the array of + * characters, <tt>false</tt> otherwise. + */ + private boolean isOneOf(char ch, final char[] charray) { + boolean result = false; + for (int i = 0; i < charray.length; i++) { + if (ch == charray[i]) { + result = true; + break; + } + } + return result; + } + + /** + * Parses out a token until any of the given terminators + * is encountered. + * + * @param terminators the array of terminating characters. Any of these + * characters when encountered signify the end of the token + * + * @return the token + */ + private String parseToken(final char[] terminators) { + char ch; + i1 = pos; + i2 = pos; + while (hasChar()) { + ch = chars[pos]; + if (isOneOf(ch, terminators)) { + break; + } + i2++; + pos++; + } + return getToken(false); + } + + /** + * Parses out a token until any of the given terminators + * is encountered outside the quotation marks. + * + * @param terminators the array of terminating characters. Any of these + * characters when encountered outside the quotation marks signify the end + * of the token + * + * @return the token + */ + private String parseQuotedToken(final char[] terminators) { + char ch; + i1 = pos; + i2 = pos; + boolean quoted = false; + boolean charEscaped = false; + while (hasChar()) { + ch = chars[pos]; + if (!quoted && isOneOf(ch, terminators)) { + break; + } + if (!charEscaped && ch == '"') { + quoted = !quoted; + } + charEscaped = (!charEscaped && ch == '\\'); + i2++; + pos++; + + } + return getToken(true); + } + + /** + * Returns <tt>true</tt> if parameter names are to be converted to lower + * case when name/value pairs are parsed. + * + * @return <tt>true</tt> if parameter names are to be + * converted to lower case when name/value pairs are parsed. + * Otherwise returns <tt>false</tt> + */ + public boolean isLowerCaseNames() { + return this.lowerCaseNames; + } + + /** + * Sets the flag if parameter names are to be converted to lower case when + * name/value pairs are parsed. + * + * @param b <tt>true</tt> if parameter names are to be + * converted to lower case when name/value pairs are parsed. + * <tt>false</tt> otherwise. + */ + public void setLowerCaseNames(boolean b) { + this.lowerCaseNames = b; + } + + /** + * Extracts a map of name/value pairs from the given string. Names are + * expected to be unique. Multiple separators may be specified and + * the earliest found in the input string is used. + * + * @param str the string that contains a sequence of name/value pairs + * @param separators the name/value pairs separators + * + * @return a map of name/value pairs + */ + public Map<String,String> parse(final String str, char[] separators) { + if (separators == null || separators.length == 0) { + return new HashMap<String,String>(); + } + char separator = separators[0]; + if (str != null) { + int idx = str.length(); + for (int i = 0; i < separators.length; i++) { + int tmp = str.indexOf(separators[i]); + if (tmp != -1) { + if (tmp < idx) { + idx = tmp; + separator = separators[i]; + } + } + } + } + return parse(str, separator); + } + + /** + * Extracts a map of name/value pairs from the given string. Names are + * expected to be unique. + * + * @param str the string that contains a sequence of name/value pairs + * @param separator the name/value pairs separator + * + * @return a map of name/value pairs + */ + public Map<String,String> parse(final String str, char separator) { + if (str == null) { + return new HashMap<String,String>(); + } + return parse(str.toCharArray(), separator); + } + + /** + * Extracts a map of name/value pairs from the given array of + * characters. Names are expected to be unique. + * + * @param chars the array of characters that contains a sequence of + * name/value pairs + * @param separator the name/value pairs separator + * + * @return a map of name/value pairs + */ + public Map<String,String> parse(final char[] inputChars, char separator) { + if (inputChars == null) { + return new HashMap<String,String>(); + } + return parse(inputChars, 0, inputChars.length, separator); + } + + /** + * Extracts a map of name/value pairs from the given array of + * characters. Names are expected to be unique. + * + * @param chars the array of characters that contains a sequence of + * name/value pairs + * @param offset - the initial offset. + * @param length - the length. + * @param separator the name/value pairs separator + * + * @return a map of name/value pairs + */ + public Map<String,String> parse( + final char[] inputChars, + int offset, + int length, + char separator) { + + if (inputChars == null) { + return new HashMap<String,String>(); + } + HashMap<String,String> params = new HashMap<String,String>(); + this.chars = inputChars; + this.pos = offset; + this.len = length; + + String paramName = null; + String paramValue = null; + while (hasChar()) { + paramName = parseToken(new char[] { + '=', separator }); + paramValue = null; + if (hasChar() && (chars[pos] == '=')) { + pos++; // skip '=' + paramValue = parseQuotedToken(new char[] { + separator }); + } + if (hasChar() && (chars[pos] == separator)) { + pos++; // skip separator + } + if ((paramName != null) && (paramName.length() > 0)) { + if (this.lowerCaseNames) { + paramName = paramName.toLowerCase(); + } + params.put(paramName, paramValue); + } + } + return params; + } +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/ProgressListener.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/ProgressListener.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/ProgressListener.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,34 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + + +/** + * The {@link ProgressListener} may be used to display a progress bar + * or do stuff like that. + */ +public interface ProgressListener { + /** Updates the listeners status information. + * @param pBytesRead The total number of bytes, which have been read + * so far. + * @param pContentLength The total number of bytes, which are being + * read. May be -1, if this number is unknown. + * @param pItems The number of the field, which is currently being + * read. (0 = no item so far, 1 = first item is being read, ...) + */ + void update(long pBytesRead, long pContentLength, int pItems); +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/RequestContext.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/RequestContext.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/RequestContext.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,64 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.InputStream; +import java.io.IOException; + +/** + * <p>Abstracts access to the request information needed for file uploads. This + * interfsace should be implemented for each type of request that may be + * handled by FileUpload, such as servlets and portlets.</p> + * + * @author <a href="mailto:martinc@apache.org">Martin Cooper</a> + * + * @since FileUpload 1.1 + * + * @version $Id: RequestContext.java 881493 2009-11-17 20:30:39Z markt $ + */ +public interface RequestContext { + + /** + * Retrieve the character encoding for the request. + * + * @return The character encoding for the request. + */ + String getCharacterEncoding(); + + /** + * Retrieve the content type of the request. + * + * @return The content type of the request. + */ + String getContentType(); + + /** + * Retrieve the content length of the request. + * + * @return The content length of the request. + */ + int getContentLength(); + + /** + * Retrieve the input stream for the request. + * + * @return The input stream for the request. + * + * @throws IOException if a problem occurs. + */ + InputStream getInputStream() throws IOException; +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/ServletFileUpload.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/ServletFileUpload.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/ServletFileUpload.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,146 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.IOException; +import java.util.List; + +import javax.servlet.http.HttpServletRequest; + + +/** + * <p>High level API for processing file uploads.</p> + * + * <p>This class handles multiple files per single HTML widget, sent using + * <code>multipart/mixed</code> encoding type, as specified by + * <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>. Use {@link + * #parseRequest(HttpServletRequest)} to acquire a list of {@link + * org.apache.commons.fileupload.FileItem}s associated with a given HTML + * widget.</p> + * + * <p>How the data for individual parts is stored is determined by the factory + * used to create them; a given part may be in memory, on disk, or somewhere + * else.</p> + * + * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a> + * @author <a href="mailto:dlr@collab.net">Daniel Rall</a> + * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> + * @author <a href="mailto:jmcnally@collab.net">John McNally</a> + * @author <a href="mailto:martinc@apache.org">Martin Cooper</a> + * @author Sean C. Sullivan + * + * @version $Id: ServletFileUpload.java 881562 2009-11-17 22:03:22Z markt $ + */ +public class ServletFileUpload extends FileUpload { + + // ---------------------------------------------------------- Class methods + + + /** + * Utility method that determines whether the request contains multipart + * content. + * + * @param request The servlet request to be evaluated. Must be non-null. + * + * @return <code>true</code> if the request is multipart; + * <code>false</code> otherwise. + */ + public static final boolean isMultipartContent( + HttpServletRequest request) { + if (!"post".equals(request.getMethod().toLowerCase())) { + return false; + } + String contentType = request.getContentType(); + if (contentType == null) { + return false; + } + if (contentType.toLowerCase().startsWith(MULTIPART)) { + return true; + } + return false; + } + + + // ----------------------------------------------------------- Constructors + + + /** + * Constructs an uninitialised instance of this class. A factory must be + * configured, using <code>setFileItemFactory()</code>, before attempting + * to parse requests. + * + * @see FileUpload#FileUpload(FileItemFactory) + */ + public ServletFileUpload() { + super(); + } + + + /** + * Constructs an instance of this class which uses the supplied factory to + * create <code>FileItem</code> instances. + * + * @see FileUpload#FileUpload() + * @param fileItemFactory The factory to use for creating file items. + */ + public ServletFileUpload(FileItemFactory fileItemFactory) { + super(fileItemFactory); + } + + + // --------------------------------------------------------- Public methods + + + /** + * Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> + * compliant <code>multipart/form-data</code> stream. + * + * @param request The servlet request to be parsed. + * + * @return A list of <code>FileItem</code> instances parsed from the + * request, in the order that they were transmitted. + * + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + */ + public List<FileItem> parseRequest(HttpServletRequest request) + throws FileUploadException { + return parseRequest(new ServletRequestContext(request)); + } + + + /** + * Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> + * compliant <code>multipart/form-data</code> stream. + * + * @param request The servlet request to be parsed. + * + * @return An iterator to instances of <code>FileItemStream</code> + * parsed from the request, in the order that they were + * transmitted. + * + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + * @throws IOException An I/O error occurred. This may be a network + * error while communicating with the client or a problem while + * storing the uploaded content. + */ + public FileItemIterator getItemIterator(HttpServletRequest request) + throws FileUploadException, IOException { + return super.getItemIterator(new ServletRequestContext(request)); + } +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/ServletRequestContext.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/ServletRequestContext.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/ServletRequestContext.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,108 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.InputStream; +import java.io.IOException; +import javax.servlet.http.HttpServletRequest; + + +/** + * <p>Provides access to the request information needed for a request made to + * an HTTP servlet.</p> + * + * @author <a href="mailto:martinc@apache.org">Martin Cooper</a> + * + * @since FileUpload 1.1 + * + * @version $Id: ServletRequestContext.java 881533 2009-11-17 21:21:41Z markt $ + */ +public class ServletRequestContext implements RequestContext { + + // ----------------------------------------------------- Instance Variables + + /** + * The request for which the context is being provided. + */ + private HttpServletRequest request; + + + // ----------------------------------------------------------- Constructors + + /** + * Construct a context for this request. + * + * @param request The request to which this context applies. + */ + public ServletRequestContext(HttpServletRequest request) { + this.request = request; + } + + + // --------------------------------------------------------- Public Methods + + /** + * Retrieve the character encoding for the request. + * + * @return The character encoding for the request. + */ + public String getCharacterEncoding() { + return request.getCharacterEncoding(); + } + + /** + * Retrieve the content type of the request. + * + * @return The content type of the request. + */ + public String getContentType() { + return request.getContentType(); + } + + /** + * Retrieve the content length of the request. + * + * @return The content length of the request. + */ + public int getContentLength() { + return request.getContentLength(); + } + + /** + * Retrieve the input stream for the request. + * + * @return The input stream for the request. + * + * @throws IOException if a problem occurs. + */ + public InputStream getInputStream() throws IOException { + return request.getInputStream(); + } + + /** + * Returns a string representation of this object. + * + * @return a string representation of this object. + */ + @Override + public String toString() { + return "ContentLength=" + + this.getContentLength() + + ", ContentType=" + + this.getContentType(); + } +} Added: trunk/java/org/apache/tomcat/util/http/fileupload/Streams.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/Streams.java (rev 0) +++ trunk/java/org/apache/tomcat/util/http/fileupload/Streams.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -0,0 +1,166 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.tomcat.util.http.fileupload; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; + + +/** Utility class for working with streams. + */ +public final class Streams { + /** + * Private constructor, to prevent instantiation. + * This class has only static methods. + */ + private Streams() { + // Does nothing + } + + /** + * Default buffer size for use in + * {@link #copy(InputStream, OutputStream, boolean)}. + */ + private static final int DEFAULT_BUFFER_SIZE = 8192; + + /** + * Copies the contents of the given {@link InputStream} + * to the given {@link OutputStream}. Shortcut for + * <pre> + * copy(pInputStream, pOutputStream, new byte[8192]); + * </pre> + * @param pInputStream The input stream, which is being read. + * It is guaranteed, that {@link InputStream#close()} is called + * on the stream. + * @param pOutputStream The output stream, to which data should + * be written. May be null, in which case the input streams + * contents are simply discarded. + * @param pClose True guarantees, that {@link OutputStream#close()} + * is called on the stream. False indicates, that only + * {@link OutputStream#flush()} should be called finally. + * + * @return Number of bytes, which have been copied. + * @throws IOException An I/O error occurred. + */ + public static long copy(InputStream pInputStream, + OutputStream pOutputStream, boolean pClose) + throws IOException { + return copy(pInputStream, pOutputStream, pClose, + new byte[DEFAULT_BUFFER_SIZE]); + } + + /** + * Copies the contents of the given {@link InputStream} + * to the given {@link OutputStream}. + * @param pIn The input stream, which is being read. + * It is guaranteed, that {@link InputStream#close()} is called + * on the stream. + * @param pOut The output stream, to which data should + * be written. May be null, in which case the input streams + * contents are simply discarded. + * @param pClose True guarantees, that {@link OutputStream#close()} + * is called on the stream. False indicates, that only + * {@link OutputStream#flush()} should be called finally. + * @param pBuffer Temporary buffer, which is to be used for + * copying data. + * @return Number of bytes, which have been copied. + * @throws IOException An I/O error occurred. + */ + public static long copy(InputStream pIn, + OutputStream pOut, boolean pClose, + byte[] pBuffer) + throws IOException { + OutputStream out = pOut; + InputStream in = pIn; + try { + long total = 0; + for (;;) { + int res = in.read(pBuffer); + if (res == -1) { + break; + } + if (res > 0) { + total += res; + if (out != null) { + out.write(pBuffer, 0, res); + } + } + } + if (out != null) { + if (pClose) { + out.close(); + } else { + out.flush(); + } + out = null; + } + in.close(); + in = null; + return total; + } finally { + if (in != null) { + try { + in.close(); + } catch (Throwable t) { + /* Ignore me */ + } + } + if (pClose && out != null) { + try { + out.close(); + } catch (Throwable t) { + /* Ignore me */ + } + } + } + } + + /** + * This convenience method allows to read a + * {@link org.apache.commons.fileupload.FileItemStream}'s + * content into a string. The platform's default character encoding + * is used for converting bytes into characters. + * @param pStream The input stream to read. + * @see #asString(InputStream, String) + * @return The streams contents, as a string. + * @throws IOException An I/O error occurred. + */ + public static String asString(InputStream pStream) throws IOException { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + copy(pStream, baos, true); + return baos.toString(); + } + + /** + * This convenience method allows to read a + * {@link org.apache.commons.fileupload.FileItemStream}'s + * content into a string, using the given character encoding. + * @param pStream The input stream to read. + * @param pEncoding The character encoding, typically "UTF-8". + * @see #asString(InputStream) + * @return The streams contents, as a string. + * @throws IOException An I/O error occurred. + */ + public static String asString(InputStream pStream, String pEncoding) + throws IOException { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + copy(pStream, baos, true); + return baos.toString(pEncoding); + } +} Modified: trunk/java/org/apache/tomcat/util/http/fileupload/ThresholdingOutputStream.java =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/ThresholdingOutputStream.java 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/ThresholdingOutputStream.java 2009-11-20 23:18:44 UTC (rev 1281) @@ -14,8 +14,6 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.tomcat.util.http.fileupload; import java.io.IOException; @@ -90,6 +88,7 @@ * * @exception IOException if an error occurs. */ + @Override public void write(int b) throws IOException { checkThreshold(1); @@ -106,6 +105,7 @@ * * @exception IOException if an error occurs. */ + @Override public void write(byte b[]) throws IOException { checkThreshold(b.length); @@ -124,6 +124,7 @@ * * @exception IOException if an error occurs. */ + @Override public void write(byte b[], int off, int len) throws IOException { checkThreshold(len); @@ -138,6 +139,7 @@ * * @exception IOException if an error occurs. */ + @Override public void flush() throws IOException { getStream().flush(); @@ -150,6 +152,7 @@ * * @exception IOException if an error occurs. */ + @Override public void close() throws IOException { try @@ -219,11 +222,20 @@ { if (!thresholdExceeded && (written + count > threshold)) { + thresholdExceeded = true; thresholdReached(); - thresholdExceeded = true; } } + /** + * Resets the byteCount to zero. You can call this from + * {@link #thresholdReached()} if you want the event to be triggered again. + */ + protected void resetByteCount() + { + this.thresholdExceeded = false; + this.written = 0; + } // ------------------------------------------------------- Abstract methods Modified: trunk/java/org/apache/tomcat/util/http/fileupload/package.html =================================================================== --- trunk/java/org/apache/tomcat/util/http/fileupload/package.html 2009-11-20 15:36:52 UTC (rev 1280) +++ trunk/java/org/apache/tomcat/util/http/fileupload/package.html 2009-11-20 23:18:44 UTC (rev 1281) @@ -1,41 +1,65 @@ -<!-- $Id: package.html 467222 2006-10-24 03:17:11Z markt $ --> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You 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. +--> +<!-- $Id: package.html 881493 2009-11-17 20:30:39Z markt $ --> <html> - <head> - <title>Overview of the org.apache.commons.fileupload component</title> - </head> - <body> - <p> - Component for handling html file uploads as given by rfc 1867 - <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC&nbsp;1867...;. - </p> - <p> - Normal usage of the package involves - {@link org.apache.commons.fileupload.DiskFileUpload DiskFileUpload} - parsing the HttpServletRequest and returning a list of - {@link org.apache.commons.fileupload.FileItem FileItem}'s. - These <code>FileItem</code>'s provide easy access to the data - given in the upload. There is also a low level api for - manipulating the upload data encapsulated in the - {@link org.apache.commons.fileupload.MultipartStream MultipartStream} - class. - </p> - - <p> - Normal usage example: - </p> + <head> + <title>Overview of the org.apache.commons.fileupload component</title> + </head> + <body> + <p><b>NOTE:</b> This code has been copied from commons-fileupload 1.2.1 and + commons-io 1.4 and package renamed to avoid clashes with any web apps that + may wish to use these libraries. + </p> + <p> + A component for handling HTML file uploads as specified by + <a href="http://www.ietf.org/rfc/rfc1867.txt" target="_top">RFC&nbsp;1867</a>. + This component provides support for uploads within both servlets (JSR 53) + and portlets (JSR 168). + </p> + <p> + While this package provides the generic functionality for file uploads, + these classes are not typically used directly. Instead, normal usage + involves one of the provided extensions of + {@link org.apache.commons.fileupload.FileUpload FileUpload} such as + {@link org.apache.commons.fileupload.servlet.ServletFileUpload ServletFileUpload} + or + {@link org.apache.commons.fileupload.portlet.PortletFileUpload PortletFileUpload}, + together with a factory for + {@link org.apache.commons.fileupload.FileItem FileItem} instances, + such as + {@link org.apache.commons.fileupload.disk.DiskFileItemFactory DiskFileItemFactory}. + </p> + <p> + The following is a brief example of typical usage in a servlet, storing + the uploaded files on disk. + </p> <pre> - - public void doPost(HttpServletRequest req, HttpServletResponse res) - { - DiskFileUpload fu = new DiskFileUpload(); - // maximum size before a FileUploadException will be thrown - fu.setSizeMax(1000000); + public void doPost(HttpServletRequest req, HttpServletResponse res) { + DiskFileItemFactory factory = new DiskFileItemFactory(); // maximum size that will be stored in memory - fu.setSizeThreshold(4096); + factory.setSizeThreshold(4096); // the location for saving data that is larger than getSizeThreshold() - fu.setRepositoryPath("/tmp"); + factory.setRepository(new File("/tmp")); - List fileItems = fu.parseRequest(req); + ServletFileUpload upload = new ServletFileUpload(factory); + // maximum size before a FileUploadException will be thrown + upload.setSizeMax(1000000); + + List fileItems = upload.parseRequest(req); // assume we know there are two files. The first file is a small // text file, the second is unknown and is written to a file on // the server @@ -47,20 +71,24 @@ // save comment and filename to database ... // write the file - fi.write("/www/uploads/" + fileName); + fi.write(new File("/www/uploads/", fileName)); } </pre> - <p> - In the example above the first file is loaded into memory as a - <code>String</code>. Before calling the getString method, the data - may have been in memory or on disk depending on its size. The second - file we assume it will be large and therefore never explicitly load - it into memory, though if it is less than 4096 bytes it will be - in memory before it is written to its final location. When writing to - the final location, if the data is larger than the - threshold, an attempt is made to rename the temporary file to - the given location. If it cannot be renamed, it is streamed to the - new location. - </p> - </body> + <p> + In the example above, the first file is loaded into memory as a + <code>String</code>. Before calling the <code>getString</code> method, + the data may have been in memory or on disk depending on its size. The + second file we assume it will be large and therefore never explicitly + load it into memory, though if it is less than 4096 bytes it will be + in memory before it is written to its final location. When writing to + the final location, if the data is larger than the threshold, an attempt + is made to rename the temporary file to the given location. If it cannot + be renamed, it is streamed to the new location. + </p> + <p> + Please see the FileUpload + <a href="http://commons.apache.org/fileupload/using.html" target="_top">User Guide</a> + for further details and examples of how to use this package. + </p> + </body> </html>