1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_FormData_h
#define mozilla_dom_FormData_h
#include "mozilla/Attributes.h"
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/HTMLFormSubmission.h"
#include "mozilla/dom/File.h"
#include "mozilla/dom/FormDataBinding.h"
#include "nsGenericHTMLElement.h"
#include "nsTArray.h"
#include "nsWrapperCache.h"
namespace mozilla {
class ErrorResult;
namespace dom {
class CustomElementFormValue;
class HTMLFormElement;
class GlobalObject;
class FormData final : public nsISupports,
public HTMLFormSubmission,
public nsWrapperCache {
private:
FormData(const FormData& aFormData);
~FormData() = default;
struct FormDataTuple {
nsString name;
OwningBlobOrDirectoryOrUSVString value;
};
// Returns the FormDataTuple to modify. This may be null, in which case
// no element with aName was found.
FormDataTuple* RemoveAllOthersAndGetFirstFormDataTuple(
const nsAString& aName);
void SetNameValuePair(FormDataTuple* aData, const nsAString& aName,
const nsAString& aValue);
void SetNameFilePair(FormDataTuple* aData, const nsAString& aName,
File* aFile);
void SetNameDirectoryPair(FormDataTuple* aData, const nsAString& aName,
Directory* aDirectory);
public:
explicit FormData(nsISupports* aOwner = nullptr,
NotNull<const Encoding*> aEncoding = UTF_8_ENCODING,
Element* aSubmitter = nullptr);
already_AddRefed<FormData> Clone();
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(FormData)
// nsWrapperCache
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
// WebIDL
nsISupports* GetParentObject() const { return mOwner; }
static already_AddRefed<FormData> Constructor(
const GlobalObject& aGlobal,
const Optional<NonNull<HTMLFormElement> >& aFormElement,
nsGenericHTMLElement* aSubmitter, ErrorResult& aRv);
void Append(const nsAString& aName, const nsAString& aValue,
ErrorResult& aRv);
void Append(const nsAString& aName, Blob& aBlob,
const Optional<nsAString>& aFilename, ErrorResult& aRv);
void Append(const nsAString& aName, Directory* aDirectory);
void Append(const FormData& aFormData);
void Delete(const nsAString& aName);
void Get(const nsAString& aName,
Nullable<OwningBlobOrDirectoryOrUSVString>& aOutValue);
void GetAll(const nsAString& aName,
nsTArray<OwningBlobOrDirectoryOrUSVString>& aValues);
bool Has(const nsAString& aName);
void Set(const nsAString& aName, Blob& aBlob,
const Optional<nsAString>& aFilename, ErrorResult& aRv);
void Set(const nsAString& aName, const nsAString& aValue, ErrorResult& aRv);
uint32_t GetIterableLength() const;
const nsAString& GetKeyAtIndex(uint32_t aIndex) const;
const OwningBlobOrDirectoryOrUSVString& GetValueAtIndex(
uint32_t aIndex) const;
// HTMLFormSubmission
virtual nsresult GetEncodedSubmission(nsIURI* aURI,
nsIInputStream** aPostDataStream,
nsCOMPtr<nsIURI>& aOutURI) override;
virtual nsresult AddNameValuePair(const nsAString& aName,
const nsAString& aValue) override {
nsAutoString usvName(aName);
nsAutoString usvValue(aValue);
if (!NormalizeUSVString(usvName) || !NormalizeUSVString(usvValue)) {
return NS_ERROR_OUT_OF_MEMORY;
}
FormDataTuple* data = mFormData.AppendElement();
SetNameValuePair(data, usvName, usvValue);
return NS_OK;
}
virtual nsresult AddNameBlobPair(const nsAString& aName,
Blob* aBlob) override;
virtual nsresult AddNameDirectoryPair(const nsAString& aName,
Directory* aDirectory) override;
uint32_t Length() const { return mFormData.Length(); }
// Stops iteration and returns false if any invocation of callback returns
// false. Returns true otherwise.
// Accepts callbacks of the form `bool(const nsString&, const
// OwningBlobOrDirectoryOrUSVString&)`.
template <typename F>
bool ForEach(F&& aCallback) {
for (uint32_t i = 0; i < mFormData.Length(); ++i) {
FormDataTuple& tuple = mFormData[i];
if (!aCallback(tuple.name, tuple.value)) {
return false;
}
}
return true;
}
nsresult GetSendInfo(nsIInputStream** aBody, uint64_t* aContentLength,
nsACString& aContentTypeWithCharset,
nsACString& aCharset) const;
nsresult CopySubmissionDataTo(HTMLFormSubmission* aFormSubmission) const;
Element* GetSubmitterElement() const { return mSubmitter.get(); }
CustomElementFormValue ConvertToCustomElementFormValue();
private:
nsCOMPtr<nsISupports> mOwner;
// Submitter element.
RefPtr<Element> mSubmitter;
nsTArray<FormDataTuple> mFormData;
};
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_FormData_h
|