Skip to Content

Wiki source code of WOFileUpload

Version 40.1 by Pascal Robert on 2023/11/13 11:56
Show last authors
1 {{toc/}}
2
3 = Introduction =
4
5 The **WOFileUpload** element allows you to add an <input type=file> HTML element into your form, hence letting your users upload files to your server. This element must be inside an HTML form ([[doc:documentation.Home.Development Architecture.Dynamic Elements.WOForm.WebHome]]) element and the //enctype// binding of the form must be set to "multipart/form-data" (see the examples).
6
7 Starting with WebObjects 5.2, it is possible to stream file uploads so that the entire file is not stored in memory on the server while being uploaded.
8
9 = Usage =
10
11 {{code}}
12
13 WOFileUpload {
14 filePath=aPath;
15 data=fileData;
16 [inputStream=fileName];
17 [bufferSize=sizeKB];
18 [outputStream=fileName];
19 [streamToFilePath=filePath];
20 [overwrite=[boolean]];
21 [finalFilePath=filePath];
22 }
23
24 {{/code}}
25
26 = Bindings =
27
28 |=(((
29 Binding Name
30 )))|=(((
31 Binding Type
32 )))|=(((
33 In/Out
34 )))|=(((
35 Required
36 )))|=(((
37 Description
38 )))
39 |(((
40 filePath
41 )))|(((
42 String
43 )))|(((
44 in
45 )))|(((
46 Yes
47 )))|(((
48 The name of the file being uploaded, including the full path when the client is on Windows. To get only the name of the file without the full path, you can use
49
50 {{code}}
51 NSPathUtilities.lastPathComponent(filePath)
52 {{/code}}
53
54
55 )))
56 |(((
57
58
59
60 data
61 )))|(((
62 NSData
63 )))|(((
64 out
65 )))|(((
66 No
67 )))|(((
68 The file being uploaded will be stored in a [[NSData>>url:http://www.webobjects.me/API/wo542/com/webobjects/foundation/NSData.html||shape="rect"]] object. Please note that the entire file will be in-memory, so beware of out-of-memory errors if users upload large files.
69 )))
70 |(((
71 inputStream
72 )))|(((
73 String
74 )))|(((
75 in
76 )))|(((
77 No
78 )))|(((
79 The binding will be set to an InputStream that points to the file upload. Note that the input stream points directly to the multipart request body part incoming stream and thus you **must** consume this input stream and close it inside the current request action logic. If you use this binding, you can only have one WOFileUpload element in your form, and it have to be the last element of the form and the form's multipleSubmit attribute must be set to false. Our advice, just use streamToFilePath.
80 )))
81 |(((
82 bufferSize
83 )))|(((
84 int
85 )))|(((
86 in
87 )))|(((
88 No
89 )))|(((
90 Sets the size (in bytes) of the buffer used by the outputStream and streamToFilePath attributes. The default buffer size is 512KB. There is no reasonable restriction on the buffer size.
91 )))
92 |(((
93 outputStream
94 )))|(((
95 String
96 )))|(((
97 out
98 )))|(((
99 No
100 )))|(((
101 WebObjects copies the file upload data from the content to the outputStream specified by this attribute.
102 )))
103 |(((
104 streamToFilePath
105 )))|(((
106 String
107 )))|(((
108 in
109 )))|(((
110 No
111 )))|(((
112 WebObjects writes the file upload data from the content directly to the file path specified in this attribute. This is an atomic operation~-~--the data is written to a temporary file, which is renamed when the process is complete.
113 )))
114 |(((
115 overwrite
116 )))|(((
117 boolean
118 )))|(((
119 in
120 )))|(((
121 No
122 )))|(((
123 When streamToFilePath is specified, this binding determines whether WebObjects should overwrite an existing file. Defaults to false.
124 )))
125 |(((
126 finalFilePath
127 )))|(((
128 String
129 )))|(((
130 out
131 )))|(((
132 No
133 )))|(((
134 When streamToFilePath is specified, its value is set to the actual file location (it may differ from the streamToFilePath value if there is a problem renaming the file).
135 )))
136
137 = Examples =
138
139 == Java methods ==
140
141 {{code/}}
142
143 == WOD-style ==
144
145 {{code/}}
146
147 == Inline bindings (WOOGNL) ==
148
149 {{code}}
150
151 <wo:form enctype = "multipart/form-data">
152
153 <wo:fileUpload streamToFilePath="$streamPathLocation"
154 overwrite="true"
155 filePath="$clientFilePath"
156 finalFilePath="$finalFilePath" />
157
158 </wo:form>
159
160 {{/code}}
161
162 = Related documents =
163
164 [[ERXWOFileUpload>>url:http://wocommunity.org/documents/javadoc/wonder/latest/er/extensions/components/_private/ERXWOFileUpload.html||shape="rect"]]
165 [[AjaxFileUpload>>url:http://wocommunity.org/documents/javadoc/wonder/latest/er/ajax/AjaxFileUpload.html||shape="rect"]]
166 [[NSPathUtilities.lastPathComponent>>url:http://wocommunity.org/documents/javadoc/WebObjects/5.4.2/com/webobjects/foundation/NSPathUtilities.html#lastPathComponent(java.lang.String)||shape="rect"]]
167 [[ERAttachment>>doc:documentation.ERAttachment Framework]]
168 [[Database vs Filesystem>>doc:documentation.Home.Best Practices.Development-Database vs Filesystem.WebHome]]
169 [[Localization and Internationalization>>doc:documentation.Development-Localization and Internationalization]]