1 /**
2 * This file Copyright (c) 2003-2015 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.beans.runtime;
35
36 import java.io.File;
37 import java.util.Enumeration;
38 import java.util.Hashtable;
39 import java.util.Map;
40
41 import org.apache.commons.lang3.StringUtils;
42
43
44 /**
45 * A util class to access file uploads in multipart post requests. Use {@link #getDocument(String)} to access an uploaded file.
46 */
47 public class MultipartForm {
48
49 /**
50 * The name of the request attribute containing a MultipartForm instance.
51 */
52 public static final String REQUEST_ATTRIBUTE_NAME = "multipartform";
53
54 private final Map<String, String[]> parameters;
55
56 private final Map<String, Document> documents;
57
58 private final Map parameterList;
59
60 public MultipartForm() {
61 this.parameters = new Hashtable<String, String[]>();
62 this.documents = new Hashtable<String, Document>();
63 this.parameterList = new Hashtable();
64 }
65
66 /**
67 * @deprecated since 4.0 - should not be needed anymore since MAGNOLIA-2449 - request parameters should be correctly wrapped.
68 */
69 public void addParameter(String name, Object value) {
70 if (value instanceof String[]) {
71 this.parameters.put(name, (String[]) value);
72 } else {
73 this.parameters.put(name, new String[]{(String) value});
74 }
75 }
76
77 /**
78 * @deprecated since 4.0 - should not be needed anymore since MAGNOLIA-2449 - request parameters should be correctly wrapped.
79 */
80 public void removeParameter(String name) {
81 this.parameters.remove(name);
82 }
83
84 /**
85 * @deprecated since 4.0 - should not be needed anymore since MAGNOLIA-2449 - request parameters should be correctly wrapped.
86 */
87 public Map<String, String[]> getParameters() {
88 return this.parameters;
89 }
90
91 /**
92 * @deprecated since 4.0 - should not be needed anymore since MAGNOLIA-2449 - request parameters should be correctly wrapped.
93 */
94 public String getParameter(String name) {
95 try {
96 String[] params = this.parameters.get(name);
97 if (params != null && params.length > 0) {
98 return params[0];
99 }
100 return null;
101 } catch (Exception e) {
102 return null;
103 }
104 }
105
106 /**
107 * @deprecated since 4.0 - should not be needed anymore since MAGNOLIA-2449 - request parameters should be correctly wrapped.
108 */
109 public String[] getParameterValues(String name) {
110 try {
111 return ((String[]) this.parameterList.get(name));
112 } catch (Exception e) {
113 return null;
114 }
115 }
116
117 /**
118 * @deprecated since 4.0 - should not be needed anymore since MAGNOLIA-2449 - request parameters should be correctly wrapped.
119 */
120 public void addparameterValues(String name, String[] values) {
121 this.parameterList.put(name, values);
122 }
123
124 public void addDocument(String atomName, String fileName, String type, File file) {
125 if (StringUtils.isEmpty(fileName)) {
126 return;
127 }
128 Document document = new Document();
129 document.setAtomName(atomName);
130 document.setType(type);
131 document.setFile(file);
132 if (!StringUtils.contains(fileName, ".")) {
133 document.setExtension(StringUtils.EMPTY);
134 document.setFileName(fileName);
135 } else {
136 document.setExtension(StringUtils.substringAfterLast(fileName, "."));
137 document.setFileName(StringUtils.substringBeforeLast(fileName, "."));
138 }
139 this.documents.put(atomName, document);
140 }
141
142 public Document getDocument(String name) {
143 return this.documents.get(name);
144 }
145
146 public Map<String, Document> getDocuments() {
147 return this.documents;
148 }
149
150 /**
151 * @deprecated since 4.0 - should not be needed anymore since MAGNOLIA-2449 - request parameters should be correctly wrapped.
152 */
153 public Enumeration<String> getParameterNames() {
154 return ((Hashtable<String, String[]>) this.parameters).keys();
155 }
156 }