View Javadoc

1   /*
2    * $Source: /usr/cvsroot/melati/melati/src/main/java/org/melati/servlet/DefaultFileFormDataAdaptor.java,v $
3    * $Revision: 1.2 $
4    *
5    * Copyright (C) 2000 Myles Chippendale
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   *     Mylesc Chippendale <mylesc At paneris.org>
42   *     http://paneris.org/
43   *     29 Stanley Road, Oxford, OX4 1QY, UK
44   */
45  
46  package org.melati.servlet;
47  
48  import java.io.File;
49  
50  import org.melati.Melati;
51  import org.melati.util.UTF8URLEncoder;
52  import org.melati.util.FileUtils;
53  
54  /**
55   * The default way to save an uploaded file to disk.
56   *
57   * We tell it what directory to save it in and the base URL 
58   * to that directory.
59   */
60  
61  public class DefaultFileFormDataAdaptor extends BaseFileFormDataAdaptor {
62  
63    protected Melati melati;
64    protected String uploadDir = null;
65    protected String uploadURL = null;
66    protected boolean makeUnique = true;
67  
68    /**
69     * Constructor.
70     * 
71     * @param melatiP    The current melati
72     * @param uploadDirP The directory to save this file in
73     * @param uploadUrlP A URL pointing to this directory (null if there
74     *                   isn't an appropriate URL)
75     */
76    public DefaultFileFormDataAdaptor(Melati melatiP, String uploadDirP, String uploadUrlP) {
77      this(melatiP, uploadDirP, uploadUrlP, true);
78    }
79  
80    /**
81     * Constructor.
82     * 
83     * @param melatiP    The current melati
84     * @param uploadDirP  The directory to save this file in
85     * @param uploadURLP  A URL pointing to this directory  (null if there
86     *                   isn't an appropriate URL)
87     * @param makeUnique Whether we should make sure the new file has a unique
88     *                   name within the <code>uploadDir</code> directory
89     */
90  
91    public DefaultFileFormDataAdaptor(Melati melatiP, String uploadDirP, String uploadURLP,
92                                  boolean makeUniqueP) {
93      this.melati = melatiP;
94      this.uploadDir = uploadDirP;
95      if (uploadDirP == null) throw new NullPointerException();
96      this.uploadURL = uploadURLP;
97      this.makeUnique = makeUniqueP;
98    }
99  
100   protected File calculateLocalFile() {
101     File f = new File(uploadDir,
102                       UTF8URLEncoder.encode(field.getUploadedFileName(), melati.getEncoding()));
103     return makeUnique ? FileUtils.withUniqueName(f) : f;
104   }
105 
106   protected String calculateURL() {
107     return (uploadURL != null && getFile() != null)
108              ? uploadURL + File.separatorChar + file.getName()
109              : null;
110   }
111 }