1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
3 /* This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6
7 #include "FormData.h"
8 #include "nsIInputStream.h"
9 #include "mozilla/dom/File.h"
10 #include "mozilla/dom/Directory.h"
11 #include "mozilla/dom/HTMLFormElement.h"
12 #include "mozilla/Encoding.h"
13
14 #include "MultipartBlobImpl.h"
15
16 using namespace mozilla;
17 using namespace mozilla::dom;
18
FormData(nsISupports * aOwner,NotNull<const Encoding * > aEncoding,Element * aSubmitter)19 FormData::FormData(nsISupports* aOwner, NotNull<const Encoding*> aEncoding,
20 Element* aSubmitter)
21 : HTMLFormSubmission(nullptr, EmptyString(), aEncoding, aSubmitter),
22 mOwner(aOwner) {}
23
FormData(const FormData & aFormData)24 FormData::FormData(const FormData& aFormData)
25 : HTMLFormSubmission(aFormData.mActionURL, aFormData.mTarget,
26 aFormData.mEncoding, aFormData.mSubmitter) {
27 mOwner = aFormData.mOwner;
28 mFormData = aFormData.mFormData.Clone();
29 }
30
31 namespace {
32
GetOrCreateFileCalledBlob(Blob & aBlob,ErrorResult & aRv)33 already_AddRefed<File> GetOrCreateFileCalledBlob(Blob& aBlob,
34 ErrorResult& aRv) {
35 // If this is file, we can just use it
36 RefPtr<File> file = aBlob.ToFile();
37 if (file) {
38 return file.forget();
39 }
40
41 // Forcing 'blob' as filename
42 file = aBlob.ToFile(NS_LITERAL_STRING("blob"), aRv);
43 if (NS_WARN_IF(aRv.Failed())) {
44 return nullptr;
45 }
46
47 return file.forget();
48 }
49
GetBlobForFormDataStorage(Blob & aBlob,const Optional<nsAString> & aFilename,ErrorResult & aRv)50 already_AddRefed<File> GetBlobForFormDataStorage(
51 Blob& aBlob, const Optional<nsAString>& aFilename, ErrorResult& aRv) {
52 // Forcing a filename
53 if (aFilename.WasPassed()) {
54 RefPtr<File> file = aBlob.ToFile(aFilename.Value(), aRv);
55 if (NS_WARN_IF(aRv.Failed())) {
56 return nullptr;
57 }
58
59 return file.forget();
60 }
61
62 return GetOrCreateFileCalledBlob(aBlob, aRv);
63 }
64
65 } // namespace
66
67 // -------------------------------------------------------------------------
68 // nsISupports
69
70 NS_IMPL_CYCLE_COLLECTION_CLASS(FormData)
71
72 NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(FormData)
73 NS_IMPL_CYCLE_COLLECTION_UNLINK(mOwner)
74
75 for (uint32_t i = 0, len = tmp->mFormData.Length(); i < len; ++i) {
76 ImplCycleCollectionUnlink(tmp->mFormData[i].value);
77 }
78
79 NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER
80 NS_IMPL_CYCLE_COLLECTION_UNLINK_END
81
82 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(FormData)
83 NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mOwner)
84
85 for (uint32_t i = 0, len = tmp->mFormData.Length(); i < len; ++i) {
86 ImplCycleCollectionTraverse(cb, tmp->mFormData[i].value,
87 "mFormData[i].GetAsBlob()", 0);
88 }
89
90 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
91
NS_IMPL_CYCLE_COLLECTION_TRACE_WRAPPERCACHE(FormData)92 NS_IMPL_CYCLE_COLLECTION_TRACE_WRAPPERCACHE(FormData)
93
94 NS_IMPL_CYCLE_COLLECTING_ADDREF(FormData)
95 NS_IMPL_CYCLE_COLLECTING_RELEASE(FormData)
96
97 NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(FormData)
98 NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
99 NS_INTERFACE_MAP_ENTRY(nsISupports)
100 NS_INTERFACE_MAP_END
101
102 // -------------------------------------------------------------------------
103 // HTMLFormSubmission
104 nsresult FormData::GetEncodedSubmission(nsIURI* aURI,
105 nsIInputStream** aPostDataStream,
106 nsCOMPtr<nsIURI>& aOutURI) {
107 MOZ_ASSERT_UNREACHABLE("Shouldn't call FormData::GetEncodedSubmission");
108 return NS_OK;
109 }
110
Append(const nsAString & aName,const nsAString & aValue,ErrorResult & aRv)111 void FormData::Append(const nsAString& aName, const nsAString& aValue,
112 ErrorResult& aRv) {
113 AddNameValuePair(aName, aValue);
114 }
115
Append(const nsAString & aName,Blob & aBlob,const Optional<nsAString> & aFilename,ErrorResult & aRv)116 void FormData::Append(const nsAString& aName, Blob& aBlob,
117 const Optional<nsAString>& aFilename, ErrorResult& aRv) {
118 RefPtr<File> file = GetBlobForFormDataStorage(aBlob, aFilename, aRv);
119 if (NS_WARN_IF(aRv.Failed())) {
120 return;
121 }
122
123 AddNameBlobOrNullPair(aName, file);
124 }
125
Append(const nsAString & aName,Directory * aDirectory)126 void FormData::Append(const nsAString& aName, Directory* aDirectory) {
127 AddNameDirectoryPair(aName, aDirectory);
128 }
129
Delete(const nsAString & aName)130 void FormData::Delete(const nsAString& aName) {
131 // We have to use this slightly awkward for loop since uint32_t >= 0 is an
132 // error for being always true.
133 for (uint32_t i = mFormData.Length(); i-- > 0;) {
134 if (aName.Equals(mFormData[i].name)) {
135 mFormData.RemoveElementAt(i);
136 }
137 }
138 }
139
Get(const nsAString & aName,Nullable<OwningBlobOrDirectoryOrUSVString> & aOutValue)140 void FormData::Get(const nsAString& aName,
141 Nullable<OwningBlobOrDirectoryOrUSVString>& aOutValue) {
142 for (uint32_t i = 0; i < mFormData.Length(); ++i) {
143 if (aName.Equals(mFormData[i].name)) {
144 aOutValue.SetValue() = mFormData[i].value;
145 return;
146 }
147 }
148
149 aOutValue.SetNull();
150 }
151
GetAll(const nsAString & aName,nsTArray<OwningBlobOrDirectoryOrUSVString> & aValues)152 void FormData::GetAll(const nsAString& aName,
153 nsTArray<OwningBlobOrDirectoryOrUSVString>& aValues) {
154 for (uint32_t i = 0; i < mFormData.Length(); ++i) {
155 if (aName.Equals(mFormData[i].name)) {
156 OwningBlobOrDirectoryOrUSVString* element = aValues.AppendElement();
157 *element = mFormData[i].value;
158 }
159 }
160 }
161
Has(const nsAString & aName)162 bool FormData::Has(const nsAString& aName) {
163 for (uint32_t i = 0; i < mFormData.Length(); ++i) {
164 if (aName.Equals(mFormData[i].name)) {
165 return true;
166 }
167 }
168
169 return false;
170 }
171
AddNameBlobOrNullPair(const nsAString & aName,Blob * aBlob)172 nsresult FormData::AddNameBlobOrNullPair(const nsAString& aName, Blob* aBlob) {
173 RefPtr<File> file;
174
175 if (!aBlob) {
176 FormDataTuple* data = mFormData.AppendElement();
177 SetNameValuePair(data, aName, EmptyString(), true /* aWasNullBlob */);
178 return NS_OK;
179 }
180
181 ErrorResult rv;
182 file = GetOrCreateFileCalledBlob(*aBlob, rv);
183 if (NS_WARN_IF(rv.Failed())) {
184 return rv.StealNSResult();
185 }
186
187 FormDataTuple* data = mFormData.AppendElement();
188 SetNameFilePair(data, aName, file);
189 return NS_OK;
190 }
191
AddNameDirectoryPair(const nsAString & aName,Directory * aDirectory)192 nsresult FormData::AddNameDirectoryPair(const nsAString& aName,
193 Directory* aDirectory) {
194 MOZ_ASSERT(aDirectory);
195
196 FormDataTuple* data = mFormData.AppendElement();
197 SetNameDirectoryPair(data, aName, aDirectory);
198 return NS_OK;
199 }
200
RemoveAllOthersAndGetFirstFormDataTuple(const nsAString & aName)201 FormData::FormDataTuple* FormData::RemoveAllOthersAndGetFirstFormDataTuple(
202 const nsAString& aName) {
203 FormDataTuple* lastFoundTuple = nullptr;
204 uint32_t lastFoundIndex = mFormData.Length();
205 // We have to use this slightly awkward for loop since uint32_t >= 0 is an
206 // error for being always true.
207 for (uint32_t i = mFormData.Length(); i-- > 0;) {
208 if (aName.Equals(mFormData[i].name)) {
209 if (lastFoundTuple) {
210 // The one we found earlier was not the first one, we can remove it.
211 mFormData.RemoveElementAt(lastFoundIndex);
212 }
213
214 lastFoundTuple = &mFormData[i];
215 lastFoundIndex = i;
216 }
217 }
218
219 return lastFoundTuple;
220 }
221
Set(const nsAString & aName,Blob & aBlob,const Optional<nsAString> & aFilename,ErrorResult & aRv)222 void FormData::Set(const nsAString& aName, Blob& aBlob,
223 const Optional<nsAString>& aFilename, ErrorResult& aRv) {
224 FormDataTuple* tuple = RemoveAllOthersAndGetFirstFormDataTuple(aName);
225 if (tuple) {
226 RefPtr<File> file = GetBlobForFormDataStorage(aBlob, aFilename, aRv);
227 if (NS_WARN_IF(aRv.Failed())) {
228 return;
229 }
230
231 SetNameFilePair(tuple, aName, file);
232 } else {
233 Append(aName, aBlob, aFilename, aRv);
234 }
235 }
236
Set(const nsAString & aName,const nsAString & aValue,ErrorResult & aRv)237 void FormData::Set(const nsAString& aName, const nsAString& aValue,
238 ErrorResult& aRv) {
239 FormDataTuple* tuple = RemoveAllOthersAndGetFirstFormDataTuple(aName);
240 if (tuple) {
241 SetNameValuePair(tuple, aName, aValue);
242 } else {
243 Append(aName, aValue, aRv);
244 }
245 }
246
GetIterableLength() const247 uint32_t FormData::GetIterableLength() const { return mFormData.Length(); }
248
GetKeyAtIndex(uint32_t aIndex) const249 const nsAString& FormData::GetKeyAtIndex(uint32_t aIndex) const {
250 MOZ_ASSERT(aIndex < mFormData.Length());
251 return mFormData[aIndex].name;
252 }
253
GetValueAtIndex(uint32_t aIndex) const254 const OwningBlobOrDirectoryOrUSVString& FormData::GetValueAtIndex(
255 uint32_t aIndex) const {
256 MOZ_ASSERT(aIndex < mFormData.Length());
257 return mFormData[aIndex].value;
258 }
259
SetNameValuePair(FormDataTuple * aData,const nsAString & aName,const nsAString & aValue,bool aWasNullBlob)260 void FormData::SetNameValuePair(FormDataTuple* aData, const nsAString& aName,
261 const nsAString& aValue, bool aWasNullBlob) {
262 MOZ_ASSERT(aData);
263 aData->name = aName;
264 aData->wasNullBlob = aWasNullBlob;
265 aData->value.SetAsUSVString() = aValue;
266 }
267
SetNameFilePair(FormDataTuple * aData,const nsAString & aName,File * aFile)268 void FormData::SetNameFilePair(FormDataTuple* aData, const nsAString& aName,
269 File* aFile) {
270 MOZ_ASSERT(aData);
271 MOZ_ASSERT(aFile);
272
273 aData->name = aName;
274 aData->wasNullBlob = false;
275 aData->value.SetAsBlob() = aFile;
276 }
277
SetNameDirectoryPair(FormDataTuple * aData,const nsAString & aName,Directory * aDirectory)278 void FormData::SetNameDirectoryPair(FormDataTuple* aData,
279 const nsAString& aName,
280 Directory* aDirectory) {
281 MOZ_ASSERT(aData);
282 MOZ_ASSERT(aDirectory);
283
284 aData->name = aName;
285 aData->wasNullBlob = false;
286 aData->value.SetAsDirectory() = aDirectory;
287 }
288
289 /* virtual */
WrapObject(JSContext * aCx,JS::Handle<JSObject * > aGivenProto)290 JSObject* FormData::WrapObject(JSContext* aCx,
291 JS::Handle<JSObject*> aGivenProto) {
292 return FormData_Binding::Wrap(aCx, this, aGivenProto);
293 }
294
295 /* static */
Constructor(const GlobalObject & aGlobal,const Optional<NonNull<HTMLFormElement>> & aFormElement,ErrorResult & aRv)296 already_AddRefed<FormData> FormData::Constructor(
297 const GlobalObject& aGlobal,
298 const Optional<NonNull<HTMLFormElement> >& aFormElement, ErrorResult& aRv) {
299 RefPtr<FormData> formData = new FormData(aGlobal.GetAsSupports());
300 if (aFormElement.WasPassed()) {
301 aRv = aFormElement.Value().ConstructEntryList(formData);
302 if (NS_WARN_IF(aRv.Failed())) {
303 return nullptr;
304 }
305
306 // Step 9. Return a shallow clone of entry list.
307 // https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#constructing-form-data-set
308 if (StaticPrefs::dom_formdata_event_enabled()) {
309 formData = formData->Clone();
310 }
311 }
312
313 return formData.forget();
314 }
315
316 // contentTypeWithCharset can be set to the contentType or
317 // contentType+charset based on what the spec says.
318 // See: https://fetch.spec.whatwg.org/#concept-bodyinit-extract
GetSendInfo(nsIInputStream ** aBody,uint64_t * aContentLength,nsACString & aContentTypeWithCharset,nsACString & aCharset) const319 nsresult FormData::GetSendInfo(nsIInputStream** aBody, uint64_t* aContentLength,
320 nsACString& aContentTypeWithCharset,
321 nsACString& aCharset) const {
322 FSMultipartFormData fs(nullptr, EmptyString(), UTF_8_ENCODING, nullptr);
323 nsresult rv = CopySubmissionDataTo(&fs);
324 NS_ENSURE_SUCCESS(rv, rv);
325
326 fs.GetContentType(aContentTypeWithCharset);
327 aCharset.Truncate();
328 *aContentLength = 0;
329 NS_ADDREF(*aBody = fs.GetSubmissionBody(aContentLength));
330
331 return NS_OK;
332 }
333
Clone()334 already_AddRefed<FormData> FormData::Clone() {
335 RefPtr<FormData> formData = new FormData(*this);
336 return formData.forget();
337 }
338
CopySubmissionDataTo(HTMLFormSubmission * aFormSubmission) const339 nsresult FormData::CopySubmissionDataTo(
340 HTMLFormSubmission* aFormSubmission) const {
341 MOZ_ASSERT(aFormSubmission, "Must have FormSubmission!");
342 for (size_t i = 0; i < mFormData.Length(); ++i) {
343 if (mFormData[i].wasNullBlob) {
344 MOZ_ASSERT(mFormData[i].value.IsUSVString());
345 aFormSubmission->AddNameBlobOrNullPair(mFormData[i].name, nullptr);
346 } else if (mFormData[i].value.IsUSVString()) {
347 aFormSubmission->AddNameValuePair(mFormData[i].name,
348 mFormData[i].value.GetAsUSVString());
349 } else if (mFormData[i].value.IsBlob()) {
350 aFormSubmission->AddNameBlobOrNullPair(mFormData[i].name,
351 mFormData[i].value.GetAsBlob());
352 } else {
353 MOZ_ASSERT(mFormData[i].value.IsDirectory());
354 aFormSubmission->AddNameDirectoryPair(
355 mFormData[i].name, mFormData[i].value.GetAsDirectory());
356 }
357 }
358
359 return NS_OK;
360 }
361