Coverage Report

Coverage Report - org.melati.servlet.MultipartFormField

Classes in this File

Line Coverage

Branch Coverage

Complexity

MultipartFormField

44%

26/59

30%

6/20

1.85

 /*
  * $Source$
  * $Revision$
  *
  * Copyright (C) 2000 Vasily Pozhidaev
  *
  * Part of Melati (http://melati.org), a framework for the rapid
  * development of clean, maintainable web applications.
  *
  * Melati is free software; Permission is granted to copy, distribute
  * and/or modify this software under the terms either:
  *
  * a) the GNU General Public License as published by the Free Software
  *    Foundation; either version 2 of the License, or (at your option)
  *    any later version,
  *
  *    or
  *
  * b) any version of the Melati Software License, as published
  *    at http://melati.org
  *
  * You should have received a copy of the GNU General Public License and
  * the Melati Software License along with this program;
  * if not, write to the Free Software Foundation, Inc.,
  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
  * GNU General Public License and visit http://melati.org to obtain the
  * Melati Software License.
  *
  * Feel free to contact the Developers of Melati (http://melati.org),
  * if you would like to work out a different arrangement than the options
  * outlined here.  It is our intention to allow Melati to be used by as
  * wide an audience as possible.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * Contact details for copyright holder:
  *
  *     Vasily Pozhidaev <voodoo At knastu.ru; vpozhidaev At mail.ru>
  *     http://paneris.org/~vasilyp
  */
 
 package org.melati.servlet;
 
 import java.io.File;
 import java.io.UnsupportedEncodingException;
 
 /**
  * Holds information parsed from a multipart/form-data file upload.
  *
  * Based on RFC 1867 which describes the format 
  * for uploading files in multipart/form-data.
  * Tested on IE 5.0, HotJava 3.0, Netscape Navigator 4.x
  *
  * @see <a href="http://www.ietf.org/rfc/rfc1867.txt">rfc1867</a>
  * @author Vasily Pozhidaev (vasilyp At paneris.org)
  */
 public class MultipartFormField {
 
   private String contentDisposition = "";
   private String fieldName = "";
   private String filePath = "";
   private String contentType = "";
   private FormDataAdaptor adaptor = null;
 
   /** Number of bytes in a kilobyte. */
   public static final long KILOBYTE = 1024;
   /** Number of bytes in a megabyte. */
   public static final long MEGABYTE = 1024 * 1024;
   /** Number of bytes in a gigabyte. */
   public static final long GIGABYTE = 1024 * 1024 * 1024;
 
   /** The path to a local file */
   //private File localFile = null;
 
   /** The url to this file */
   String url = null;
 
   /** Constructor. */
   public MultipartFormField() {}
     
   /**
    * Mime information
    */
 
   /** 
    * Set the <code>ContentType</code>. 
    *
    * @param contentType  the Content Type to set it to
    */
   public void setContentType(String contentType) {
     this.contentType = contentType;
   }
     
   /** 
    * Get the <code>ContentType</code>. 
    *
    * @return the <code>ContentType</code>
    */
   public String getContentType() {
     return contentType;
   }
     
   /** Set the <code>ContentDisposition</code>. 
    *
    * @param contentDisposition  the Content Disposition to set it to
    */
   public void setContentDisposition(String contentDisposition) {
     this.contentDisposition = contentDisposition;
   }
 
   /** 
    * Get the <code>ContentDisposition</code>. 
    *
    * @return the <code>ContentDisposition</code>
    */
   public String getContentDisposition() {
     return contentDisposition;
   }
 
   /** 
    * Set the <code>FieldName</code>. 
    *
    * @param fieldName  the name to set <code>fieldName</code> to 
    */
   public void setFieldName(String fieldName) {
     this.fieldName = fieldName;
   }
 
   /** 
    * Get the <code>FieldName</code>. 
    *
    * @return the <code>FieldName</code>
    */
   public String getFieldName() {
     return fieldName;
   }
     
   /** 
    * Set the <code>UploadedFilePath</code>.
    *
    * @param filePath  the name to set <code>filePath</code> to 
    */
   public void setUploadedFilePath(String filePath) {
     this.filePath = filePath;
   }
 
   /** 
    * Get the <code>UploadedFilePath</code>. 
    * @return the <code>UploadedFilePath</code>
    */
   public String getUploadedFilePath() {
     return filePath;
   }
 
   /** 
    * Get the <code>UploadedFileName</code>.
    *
    * @return the <code>UploadedFileName</code> 
    */
   public String getUploadedFileName() {
     try {
       return filePath.substring(((filePath.lastIndexOf("\\") != -1)
                                  ? filePath.lastIndexOf("\\")
                                  : filePath.lastIndexOf("/")) + 1);
     }
     catch (Exception e) {
       return "";
     }
   }
 
   /**
    * @return the adaptor
    */
   public FormDataAdaptor getFormDataAdaptor() {
     return adaptor;
   }
   /**
    * Work with an uploaded file/stored value.
    * 
    * We can store uploaded files or values in different ways depending
    * on which adaptor we use.
    *
    * @param adaptor  a {@link FormDataAdaptor} to set <code>adaptor</code> to
    */
   public void setFormDataAdaptor(FormDataAdaptor adaptor) {
     this.adaptor = adaptor;
   }
 
   /**
    * @return the saved data as a byte array
    */
   public byte[] getData() {
     return (adaptor != null) ? adaptor.getData() : new byte[0];
   }
 
   /**
    * @return the saved data as a string
    */
   public String getDataString() {
     return new String(getData());
   }
 
   /**
    * Get the data using the specified encoding.
    *
    * @param enc an encoding which may be null or empty
    * @return the saved data as a string using the encoding supplied
    */
   public String getDataString(String enc) {
     if (enc == null || enc.equals(""))
       return getDataString();
     try {
       return new String(getData(), enc);
     }
     catch (UnsupportedEncodingException e) {
       e.printStackTrace();
       return getDataString();
     }
   }
 
   /**
    * Return the length of the data.
    * @return the length of the data
    */
   public long getDataSize() {
     return (adaptor != null) ? adaptor.getSize() : 0;
   }
 
   /**
    * Return the data saved as a file (or null if it is not saved).
    * @return The data saved as a file (or null if it is not saved)
    */
   public File getDataFile() {
     return (adaptor != null) ? adaptor.getFile() : null;
   }
 
   /**
    * Return a URL to the saved data (or null if no such URL exists).
    * @return a URL to the saved data (or null if no such URL exists)
    */
   public String getDataURL() {
     return (adaptor != null) ? adaptor.getURL() : null;
   }
 
   /**
    * The size of the file as a formatted string.
    * 
    * @return the size <code>String</code>.
    */
   public String getPrettyDataSize() {
     long size = 0;
     try {
       size = getDataSize();
     }
     catch (Exception e) {
       return "Unknown";
     }
     String sizeString = null;
     if ((size / KILOBYTE) >= 1) {
       if ((size / MEGABYTE) >= 1) {
         if ((size / GIGABYTE) >= 1)
           sizeString = (size / GIGABYTE) + " Gb";
         else
           sizeString = (size / MEGABYTE) + " Mb";
       } else {
         sizeString = (size / KILOBYTE) + " Kb";
       }
     } else {
       sizeString = size + " bytes";
     }
     return sizeString;
   }
 
   /**
    * {@inheritDoc}
    * @see java.lang.Object#toString()
    */
   public String toString() {
     String returnString =  "contentDisposition=" + contentDisposition;
     returnString += "; fieldName=" + fieldName;
     returnString += "; filePath=" + filePath;
     returnString += "; contentType=" + contentType;
     returnString += "; adaptor=" + adaptor;
     returnString += "; url=" + url;
     return returnString;
   }
 
   
 }

1		/*
2		* $Source$
3		* $Revision$
4		*
5		* Copyright (C) 2000 Vasily Pozhidaev
6		*
7		* Part of Melati (http://melati.org), a framework for the rapid
8		* development of clean, maintainable web applications.
9		*
10		* Melati is free software; Permission is granted to copy, distribute
11		* and/or modify this software under the terms either:
12		*
13		* a) the GNU General Public License as published by the Free Software
14		* Foundation; either version 2 of the License, or (at your option)
15		* any later version,
16		*
17		* or
18		*
19		* b) any version of the Melati Software License, as published
20		* at http://melati.org
21		*
22		* You should have received a copy of the GNU General Public License and
23		* the Melati Software License along with this program;
24		* if not, write to the Free Software Foundation, Inc.,
25		* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26		* GNU General Public License and visit http://melati.org to obtain the
27		* Melati Software License.
28		*
29		* Feel free to contact the Developers of Melati (http://melati.org),
30		* if you would like to work out a different arrangement than the options
31		* outlined here. It is our intention to allow Melati to be used by as
32		* wide an audience as possible.
33		*
34		* This program is distributed in the hope that it will be useful,
35		* but WITHOUT ANY WARRANTY; without even the implied warranty of
36		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37		* GNU General Public License for more details.
38		*
39		* Contact details for copyright holder:
40		*
41		* Vasily Pozhidaev <voodoo At knastu.ru; vpozhidaev At mail.ru>
42		* http://paneris.org/~vasilyp
43		*/
44
45		package org.melati.servlet;
46
47		import java.io.File;
48		import java.io.UnsupportedEncodingException;
49
50		/**
51		* Holds information parsed from a multipart/form-data file upload.
52		*
53		* Based on RFC 1867 which describes the format
54		* for uploading files in multipart/form-data.
55		* Tested on IE 5.0, HotJava 3.0, Netscape Navigator 4.x
56		*
57		* @see <a href="http://www.ietf.org/rfc/rfc1867.txt">rfc1867</a>
58		* @author Vasily Pozhidaev (vasilyp At paneris.org)
59		*/
60		public class MultipartFormField {
61
62	64	private String contentDisposition = "";
63	64	private String fieldName = "";
64	64	private String filePath = "";
65	64	private String contentType = "";
66	64	private FormDataAdaptor adaptor = null;
67
68		/** Number of bytes in a kilobyte. */
69		public static final long KILOBYTE = 1024;
70		/** Number of bytes in a megabyte. */
71		public static final long MEGABYTE = 1024 * 1024;
72		/** Number of bytes in a gigabyte. */
73		public static final long GIGABYTE = 1024 * 1024 * 1024;
74
75		/** The path to a local file */
76		//private File localFile = null;
77
78		/** The url to this file */
79	64	String url = null;
80
81		/** Constructor. */
82	128	public MultipartFormField() {}
83
84		/**
85		* Mime information
86		*/
87
88		/**
89		* Set the <code>ContentType</code>.
90		*
91		* @param contentType the Content Type to set it to
92		*/
93		public void setContentType(String contentType) {
94	64	this.contentType = contentType;
95	64	}
96
97		/**
98		* Get the <code>ContentType</code>.
99		*
100		* @return the <code>ContentType</code>
101		*/
102		public String getContentType() {
103	12	return contentType;
104		}
105
106		/** Set the <code>ContentDisposition</code>.
107		*
108		* @param contentDisposition the Content Disposition to set it to
109		*/
110		public void setContentDisposition(String contentDisposition) {
111	64	this.contentDisposition = contentDisposition;
112	64	}
113
114		/**
115		* Get the <code>ContentDisposition</code>.
116		*
117		* @return the <code>ContentDisposition</code>
118		*/
119		public String getContentDisposition() {
120	0	return contentDisposition;
121		}
122
123		/**
124		* Set the <code>FieldName</code>.
125		*
126		* @param fieldName the name to set <code>fieldName</code> to
127		*/
128		public void setFieldName(String fieldName) {
129	64	this.fieldName = fieldName;
130	64	}
131
132		/**
133		* Get the <code>FieldName</code>.
134		*
135		* @return the <code>FieldName</code>
136		*/
137		public String getFieldName() {
138	64	return fieldName;
139		}
140
141		/**
142		* Set the <code>UploadedFilePath</code>.
143		*
144		* @param filePath the name to set <code>filePath</code> to
145		*/
146		public void setUploadedFilePath(String filePath) {
147	21	this.filePath = filePath;
148	21	}
149
150		/**
151		* Get the <code>UploadedFilePath</code>.
152		* @return the <code>UploadedFilePath</code>
153		*/
154		public String getUploadedFilePath() {
155	0	return filePath;
156		}
157
158		/**
159		* Get the <code>UploadedFileName</code>.
160		*
161		* @return the <code>UploadedFileName</code>
162		*/
163		public String getUploadedFileName() {
164		try {
165	142	return filePath.substring(((filePath.lastIndexOf("\\") != -1)
166	0	? filePath.lastIndexOf("\\")
167	71	: filePath.lastIndexOf("/")) + 1);
168		}
169	0	catch (Exception e) {
170	0	return "";
171		}
172		}
173
174		/**
175		* @return the adaptor
176		*/
177		public FormDataAdaptor getFormDataAdaptor() {
178	0	return adaptor;
179		}
180		/**
181		* Work with an uploaded file/stored value.
182		*
183		* We can store uploaded files or values in different ways depending
184		* on which adaptor we use.
185		*
186		* @param adaptor a {@link FormDataAdaptor} to set <code>adaptor</code> to
187		*/
188		public void setFormDataAdaptor(FormDataAdaptor adaptor) {
189	64	this.adaptor = adaptor;
190	64	}
191
192		/**
193		* @return the saved data as a byte array
194		*/
195		public byte[] getData() {
196	27	return (adaptor != null) ? adaptor.getData() : new byte[0];
197		}
198
199		/**
200		* @return the saved data as a string
201		*/
202		public String getDataString() {
203	0	return new String(getData());
204		}
205
206		/**
207		* Get the data using the specified encoding.
208		*
209		* @param enc an encoding which may be null or empty
210		* @return the saved data as a string using the encoding supplied
211		*/
212		public String getDataString(String enc) {
213	11	if (enc == null \|\| enc.equals(""))
214	0	return getDataString();
215		try {
216	11	return new String(getData(), enc);
217		}
218	0	catch (UnsupportedEncodingException e) {
219	0	e.printStackTrace();
220	0	return getDataString();
221		}
222		}
223
224		/**
225		* Return the length of the data.
226		* @return the length of the data
227		*/
228		public long getDataSize() {
229	0	return (adaptor != null) ? adaptor.getSize() : 0;
230		}
231
232		/**
233		* Return the data saved as a file (or null if it is not saved).
234		* @return The data saved as a file (or null if it is not saved)
235		*/
236		public File getDataFile() {
237	4	return (adaptor != null) ? adaptor.getFile() : null;
238		}
239
240		/**
241		* Return a URL to the saved data (or null if no such URL exists).
242		* @return a URL to the saved data (or null if no such URL exists)
243		*/
244		public String getDataURL() {
245	1	return (adaptor != null) ? adaptor.getURL() : null;
246		}
247
248		/**
249		* The size of the file as a formatted string.
250		*
251		* @return the size <code>String</code>.
252		*/
253		public String getPrettyDataSize() {
254	0	long size = 0;
255		try {
256	0	size = getDataSize();
257		}
258	0	catch (Exception e) {
259	0	return "Unknown";
260	0	}
261	0	String sizeString = null;
262	0	if ((size / KILOBYTE) >= 1) {
263	0	if ((size / MEGABYTE) >= 1) {
264	0	if ((size / GIGABYTE) >= 1)
265	0	sizeString = (size / GIGABYTE) + " Gb";
266		else
267	0	sizeString = (size / MEGABYTE) + " Mb";
268		} else {
269	0	sizeString = (size / KILOBYTE) + " Kb";
270		}
271		} else {
272	0	sizeString = size + " bytes";
273		}
274	0	return sizeString;
275		}
276
277		/**
278		* {@inheritDoc}
279		* @see java.lang.Object#toString()
280		*/
281		public String toString() {
282	0	String returnString = "contentDisposition=" + contentDisposition;
283	0	returnString += "; fieldName=" + fieldName;
284	0	returnString += "; filePath=" + filePath;
285	0	returnString += "; contentType=" + contentType;
286	0	returnString += "; adaptor=" + adaptor;
287	0	returnString += "; url=" + url;
288	0	return returnString;
289		}
290
291
292		}