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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* Copyright (C) 2004-2022 Apple Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#pragma once
#include "BlobData.h"
#include <variant>
#include <wtf/ArgumentCoder.h>
#include <wtf/Forward.h>
#include <wtf/RefCounted.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/URL.h>
#include <wtf/Vector.h>
#include <wtf/text/WTFString.h>
namespace PAL {
class TextEncoding;
}
namespace WebCore {
class BlobRegistryImpl;
class DOMFormData;
class File;
class SharedBuffer;
struct FormDataElement {
struct EncodedFileData;
struct EncodedBlobData;
using Data = std::variant<Vector<uint8_t>, EncodedFileData, EncodedBlobData>;
FormDataElement() = default;
explicit FormDataElement(Data&& data)
: data(WTFMove(data)) { }
explicit FormDataElement(Vector<uint8_t>&& array)
: data(WTFMove(array)) { }
FormDataElement(const String& filename, int64_t fileStart, int64_t fileLength, std::optional<WallTime> expectedFileModificationTime)
: data(EncodedFileData { filename, fileStart, fileLength, expectedFileModificationTime }) { }
explicit FormDataElement(const URL& blobURL)
: data(EncodedBlobData { blobURL }) { }
uint64_t lengthInBytes(NOESCAPE const Function<uint64_t(const URL&)>&) const;
uint64_t lengthInBytes() const;
FormDataElement isolatedCopy() const;
struct EncodedFileData {
String filename;
int64_t fileStart { 0 };
int64_t fileLength { 0 };
std::optional<WallTime> expectedFileModificationTime;
bool fileModificationTimeMatchesExpectation() const;
EncodedFileData isolatedCopy() const
{
return { filename.isolatedCopy(), fileStart, fileLength, expectedFileModificationTime };
}
friend bool operator==(const EncodedFileData&, const EncodedFileData&) = default;
};
struct EncodedBlobData {
URL url;
friend bool operator==(const EncodedBlobData&, const EncodedBlobData&) = default;
};
bool operator==(const FormDataElement& other) const
{
if (&other == this)
return true;
if (data.index() != other.data.index())
return false;
if (!data.index())
return std::get<0>(data) == std::get<0>(other.data);
if (data.index() == 1)
return std::get<1>(data) == std::get<1>(other.data);
return std::get<2>(data) == std::get<2>(other.data);
}
Data data;
};
class FormData;
struct FormDataForUpload {
public:
FormDataForUpload(FormDataForUpload&&) = default;
~FormDataForUpload();
FormData& data() { return m_data.get(); }
private:
friend class FormData;
FormDataForUpload(FormData&, Vector<String>&&);
Ref<FormData> m_data;
Vector<String> m_temporaryZipFiles;
};
class FormData final : public RefCounted<FormData> {
WTF_MAKE_TZONE_OR_ISO_ALLOCATED_EXPORT(FormData, WEBCORE_EXPORT);
public:
enum class EncodingType : uint8_t {
FormURLEncoded, // for application/x-www-form-urlencoded
TextPlain, // for text/plain
MultipartFormData // for multipart/form-data
};
WEBCORE_EXPORT static Ref<FormData> create();
WEBCORE_EXPORT static Ref<FormData> create(std::span<const uint8_t>);
WEBCORE_EXPORT static Ref<FormData> create(const CString&);
WEBCORE_EXPORT static Ref<FormData> create(Vector<uint8_t>&&);
WEBCORE_EXPORT static Ref<FormData> create(Vector<WebCore::FormDataElement>&&, uint64_t identifier, bool alwaysStream, Vector<uint8_t>&& boundary);
static Ref<FormData> create(const Vector<uint8_t>&);
static Ref<FormData> create(const DOMFormData&, EncodingType = EncodingType::FormURLEncoded);
static Ref<FormData> createMultiPart(const DOMFormData&);
WEBCORE_EXPORT ~FormData();
// FIXME: Both these functions perform a deep copy of m_elements, but differ in handling of other data members.
// How much of that is intentional? We need better names that explain the difference.
Ref<FormData> copy() const;
WEBCORE_EXPORT Ref<FormData> isolatedCopy() const;
WEBCORE_EXPORT void appendData(std::span<const uint8_t> data);
void appendFile(const String& filePath);
WEBCORE_EXPORT void appendFileRange(const String& filename, long long start, long long length, std::optional<WallTime> expectedModificationTime);
WEBCORE_EXPORT void appendBlob(const URL& blobURL);
WEBCORE_EXPORT Vector<uint8_t> flatten() const; // omits files
String flattenToString() const; // omits files
// Resolve all blob references so we only have file and data.
// If the FormData has no blob references to resolve, this is returned.
WEBCORE_EXPORT Ref<FormData> resolveBlobReferences(BlobRegistryImpl* = nullptr);
bool containsBlobElement() const;
WEBCORE_EXPORT FormDataForUpload prepareForUpload();
bool isEmpty() const { return m_elements.isEmpty(); }
const Vector<FormDataElement>& elements() const { return m_elements; }
const Vector<uint8_t>& boundary() const { return m_boundary; }
WEBCORE_EXPORT RefPtr<SharedBuffer> asSharedBuffer() const;
bool alwaysStream() const { return m_alwaysStream; }
void setAlwaysStream(bool alwaysStream) { m_alwaysStream = alwaysStream; }
// Identifies a particular form submission instance. A value of 0 is used
// to indicate an unspecified identifier.
void setIdentifier(int64_t identifier) { m_identifier = identifier; }
int64_t identifier() const { return m_identifier; }
unsigned imageOrMediaFilesCount() const;
static EncodingType parseEncodingType(const String& type)
{
if (equalLettersIgnoringASCIICase(type, "text/plain"_s))
return EncodingType::TextPlain;
if (equalLettersIgnoringASCIICase(type, "multipart/form-data"_s))
return EncodingType::MultipartFormData;
return EncodingType::FormURLEncoded;
}
WEBCORE_EXPORT uint64_t lengthInBytes() const;
WEBCORE_EXPORT URL asBlobURL() const;
private:
friend struct IPC::ArgumentCoder<FormData, void>;
FormData() = default;
FormData(const FormData&);
void appendMultiPartFileValue(const File&, Vector<uint8_t>& header, PAL::TextEncoding&);
void appendMultiPartStringValue(const String&, Vector<uint8_t>& header, PAL::TextEncoding&);
void appendMultiPartKeyValuePairItems(const DOMFormData&);
void appendNonMultiPartKeyValuePairItems(const DOMFormData&, EncodingType);
Vector<FormDataElement> m_elements;
int64_t m_identifier { 0 };
bool m_alwaysStream { false };
Vector<uint8_t> m_boundary;
mutable std::optional<uint64_t> m_lengthInBytes;
};
inline bool operator==(const FormData& a, const FormData& b)
{
return a.elements() == b.elements();
}
} // namespace WebCore
|
