Have is<>(T*) function do a null check on the pointer argument
[WebKit-https.git] / Source / WebCore / platform / network / FormData.cpp
1 /*
2  * Copyright (C) 2004, 2006, 2008, 2011 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Google Inc. All rights reserved.
4  * Copyright (C) 2012 Digia Plc. and/or its subsidiary(-ies)
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB. If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #include "config.h"
23
24 #include "FormData.h"
25
26 #include "BlobRegistryImpl.h"
27 #include "BlobURL.h"
28 #include "Chrome.h"
29 #include "ChromeClient.h"
30 #include "Document.h"
31 #include "File.h"
32 #include "FileSystem.h"
33 #include "FormDataBuilder.h"
34 #include "FormDataList.h"
35 #include "MIMETypeRegistry.h"
36 #include "Page.h"
37 #include "TextEncoding.h"
38
39 namespace WebCore {
40
41 inline FormData::FormData()
42     : m_identifier(0)
43     , m_alwaysStream(false)
44     , m_containsPasswordData(false)
45 {
46 }
47
48 inline FormData::FormData(const FormData& data)
49     : RefCounted<FormData>()
50     , m_elements(data.m_elements)
51     , m_identifier(data.m_identifier)
52     , m_alwaysStream(false)
53     , m_containsPasswordData(data.m_containsPasswordData)
54 {
55     // We shouldn't be copying FormData that hasn't already removed its generated files
56     // but just in case, make sure the new FormData is ready to generate its own files.
57     for (FormDataElement& element : m_elements) {
58         if (element.m_type == FormDataElement::Type::EncodedFile) {
59             element.m_generatedFilename = String();
60             element.m_ownsGeneratedFile = false;
61         }
62     }
63 }
64
65 FormData::~FormData()
66 {
67     // This cleanup should've happened when the form submission finished.
68     // Just in case, let's assert, and do the cleanup anyway in release builds.
69     ASSERT(!hasOwnedGeneratedFiles());
70     removeGeneratedFilesIfNeeded();
71 }
72
73 PassRefPtr<FormData> FormData::create()
74 {
75     return adoptRef(new FormData);
76 }
77
78 PassRefPtr<FormData> FormData::create(const void* data, size_t size)
79 {
80     RefPtr<FormData> result = create();
81     result->appendData(data, size);
82     return result.release();
83 }
84
85 PassRefPtr<FormData> FormData::create(const CString& string)
86 {
87     RefPtr<FormData> result = create();
88     result->appendData(string.data(), string.length());
89     return result.release();
90 }
91
92 PassRefPtr<FormData> FormData::create(const Vector<char>& vector)
93 {
94     RefPtr<FormData> result = create();
95     result->appendData(vector.data(), vector.size());
96     return result.release();
97 }
98
99 PassRefPtr<FormData> FormData::create(const FormDataList& list, const TextEncoding& encoding, EncodingType encodingType)
100 {
101     RefPtr<FormData> result = create();
102     result->appendKeyValuePairItems(list, encoding, false, 0, encodingType);
103     return result.release();
104 }
105
106 PassRefPtr<FormData> FormData::createMultiPart(const FormDataList& list, const TextEncoding& encoding, Document* document)
107 {
108     RefPtr<FormData> result = create();
109     result->appendKeyValuePairItems(list, encoding, true, document);
110     return result.release();
111 }
112
113 PassRefPtr<FormData> FormData::copy() const
114 {
115     return adoptRef(new FormData(*this));
116 }
117
118 PassRefPtr<FormData> FormData::deepCopy() const
119 {
120     RefPtr<FormData> formData(create());
121
122     formData->m_alwaysStream = m_alwaysStream;
123
124     formData->m_elements.reserveInitialCapacity(m_elements.size());
125     for (const FormDataElement& element : m_elements) {
126         switch (element.m_type) {
127         case FormDataElement::Type::Data:
128             formData->m_elements.uncheckedAppend(FormDataElement(element.m_data));
129             break;
130         case FormDataElement::Type::EncodedFile:
131             formData->m_elements.uncheckedAppend(FormDataElement(element.m_filename, element.m_fileStart, element.m_fileLength, element.m_expectedFileModificationTime, element.m_shouldGenerateFile));
132             break;
133         case FormDataElement::Type::EncodedBlob:
134             formData->m_elements.uncheckedAppend(FormDataElement(element.m_url));
135             break;
136         }
137     }
138     return formData.release();
139 }
140
141 void FormData::appendData(const void* data, size_t size)
142 {
143     memcpy(expandDataStore(size), data, size);
144 }
145
146 void FormData::appendFile(const String& filename, bool shouldGenerateFile)
147 {
148     m_elements.append(FormDataElement(filename, 0, BlobDataItem::toEndOfFile, invalidFileTime(), shouldGenerateFile));
149 }
150
151 void FormData::appendFileRange(const String& filename, long long start, long long length, double expectedModificationTime, bool shouldGenerateFile)
152 {
153     m_elements.append(FormDataElement(filename, start, length, expectedModificationTime, shouldGenerateFile));
154 }
155
156 void FormData::appendBlob(const URL& blobURL)
157 {
158     m_elements.append(FormDataElement(blobURL));
159 }
160
161 void FormData::appendKeyValuePairItems(const FormDataList& list, const TextEncoding& encoding, bool isMultiPartForm, Document* document, EncodingType encodingType)
162 {
163     if (isMultiPartForm)
164         m_boundary = FormDataBuilder::generateUniqueBoundaryString();
165
166     Vector<char> encodedData;
167
168     const Vector<FormDataList::Item>& items = list.items();
169     size_t formDataListSize = items.size();
170     ASSERT(!(formDataListSize % 2));
171     for (size_t i = 0; i < formDataListSize; i += 2) {
172         const FormDataList::Item& key = items[i];
173         const FormDataList::Item& value = items[i + 1];
174         if (isMultiPartForm) {
175             Vector<char> header;
176             FormDataBuilder::beginMultiPartHeader(header, m_boundary.data(), key.data());
177
178             bool shouldGenerateFile = false;
179
180             // If the current type is blob, then we also need to include the filename
181             if (value.blob()) {
182                 String name;
183                 if (is<File>(*value.blob())) {
184                     File& file = downcast<File>(*value.blob());
185                     name = file.name();
186                     // Let the application specify a filename if it's going to generate a replacement file for the upload.
187                     const String& path = file.path();
188                     if (!path.isEmpty()) {
189                         if (Page* page = document->page()) {
190                             String generatedFileName;
191                             shouldGenerateFile = page->chrome().client().shouldReplaceWithGeneratedFileForUpload(path, generatedFileName);
192                             if (shouldGenerateFile)
193                                 name = generatedFileName;
194                         }
195                     }
196
197                     // If a filename is passed in FormData.append(), use it instead of the file blob's name.
198                     if (!value.filename().isNull())
199                         name = value.filename();
200                 } else {
201                     // For non-file blob, use the filename if it is passed in FormData.append().
202                     if (!value.filename().isNull())
203                         name = value.filename();
204                     else
205                         name = "blob";
206                 }
207
208                 // We have to include the filename=".." part in the header, even if the filename is empty
209                 FormDataBuilder::addFilenameToMultiPartHeader(header, encoding, name);
210
211                 // Add the content type if available, or "application/octet-stream" otherwise (RFC 1867).
212                 String contentType = value.blob()->type();
213                 if (contentType.isEmpty())
214                     contentType = "application/octet-stream";
215                 ASSERT(Blob::isNormalizedContentType(contentType));
216                 FormDataBuilder::addContentTypeToMultiPartHeader(header, contentType.ascii());
217             }
218
219             FormDataBuilder::finishMultiPartHeader(header);
220
221             // Append body
222             appendData(header.data(), header.size());
223             if (value.blob()) {
224                 if (is<File>(*value.blob())) {
225                     File& file = downcast<File>(*value.blob());
226                     // Do not add the file if the path is empty.
227                     if (!file.path().isEmpty())
228                         appendFile(file.path(), shouldGenerateFile);
229                 }
230                 else
231                     appendBlob(value.blob()->url());
232             } else
233                 appendData(value.data().data(), value.data().length());
234             appendData("\r\n", 2);
235         } else {
236             // Omit the name "isindex" if it's the first form data element.
237             // FIXME: Why is this a good rule? Is this obsolete now?
238             if (encodedData.isEmpty() && key.data() == "isindex")
239                 FormDataBuilder::encodeStringAsFormData(encodedData, value.data());
240             else
241                 FormDataBuilder::addKeyValuePairAsFormData(encodedData, key.data(), value.data(), encodingType);
242         }
243     }
244
245     if (isMultiPartForm)
246         FormDataBuilder::addBoundaryToMultiPartHeader(encodedData, m_boundary.data(), true);
247
248     appendData(encodedData.data(), encodedData.size());
249 }
250
251 char* FormData::expandDataStore(size_t size)
252 {
253     if (m_elements.isEmpty() || m_elements.last().m_type != FormDataElement::Type::Data)
254         m_elements.append(FormDataElement());
255     FormDataElement& e = m_elements.last();
256     size_t oldSize = e.m_data.size();
257     e.m_data.grow(oldSize + size);
258     return e.m_data.data() + oldSize;
259 }
260
261 void FormData::flatten(Vector<char>& data) const
262 {
263     // Concatenate all the byte arrays, but omit any files.
264     data.clear();
265     size_t n = m_elements.size();
266     for (size_t i = 0; i < n; ++i) {
267         const FormDataElement& e = m_elements[i];
268         if (e.m_type == FormDataElement::Type::Data)
269             data.append(e.m_data.data(), static_cast<size_t>(e.m_data.size()));
270     }
271 }
272
273 String FormData::flattenToString() const
274 {
275     Vector<char> bytes;
276     flatten(bytes);
277     return Latin1Encoding().decode(reinterpret_cast<const char*>(bytes.data()), bytes.size());
278 }
279
280 static void appendBlobResolved(FormData* formData, const URL& url)
281 {
282     if (!blobRegistry().isBlobRegistryImpl()) {
283         LOG_ERROR("Tried to resolve a blob without a usable registry");
284         return;
285     }
286     BlobData* blobData = static_cast<BlobRegistryImpl&>(blobRegistry()).getBlobDataFromURL(URL(ParsedURLString, url));
287     if (!blobData) {
288         LOG_ERROR("Could not get blob data from a registry");
289         return;
290     }
291
292     BlobDataItemList::const_iterator it = blobData->items().begin();
293     const BlobDataItemList::const_iterator itend = blobData->items().end();
294     for (; it != itend; ++it) {
295         const BlobDataItem& blobItem = *it;
296         if (blobItem.type == BlobDataItem::Data)
297             formData->appendData(blobItem.data->data() + static_cast<int>(blobItem.offset()), static_cast<int>(blobItem.length()));
298         else if (blobItem.type == BlobDataItem::File)
299             formData->appendFileRange(blobItem.file->path(), blobItem.offset(), blobItem.length(), blobItem.file->expectedModificationTime());
300         else
301             ASSERT_NOT_REACHED();
302     }
303 }
304
305 PassRefPtr<FormData> FormData::resolveBlobReferences()
306 {
307     // First check if any blobs needs to be resolved, or we can take the fast path.
308     bool hasBlob = false;
309     Vector<FormDataElement>::const_iterator it = elements().begin();
310     const Vector<FormDataElement>::const_iterator itend = elements().end();
311     for (; it != itend; ++it) {
312         if (it->m_type == FormDataElement::Type::EncodedBlob) {
313             hasBlob = true;
314             break;
315         }
316     }
317
318     if (!hasBlob)
319         return this;
320
321     // Create a copy to append the result into.
322     RefPtr<FormData> newFormData = FormData::create();
323     newFormData->setAlwaysStream(alwaysStream());
324     newFormData->setIdentifier(identifier());
325     it = elements().begin();
326     for (; it != itend; ++it) {
327         const FormDataElement& element = *it;
328         if (element.m_type == FormDataElement::Type::Data)
329             newFormData->appendData(element.m_data.data(), element.m_data.size());
330         else if (element.m_type == FormDataElement::Type::EncodedFile)
331             newFormData->appendFileRange(element.m_filename, element.m_fileStart, element.m_fileLength, element.m_expectedFileModificationTime, element.m_shouldGenerateFile);
332         else if (element.m_type == FormDataElement::Type::EncodedBlob)
333             appendBlobResolved(newFormData.get(), element.m_url);
334         else
335             ASSERT_NOT_REACHED();
336     }
337     return newFormData.release();
338 }
339
340 void FormData::generateFiles(Document* document)
341 {
342     Page* page = document->page();
343     if (!page)
344         return;
345
346     for (FormDataElement& element : m_elements) {
347         if (element.m_type == FormDataElement::Type::EncodedFile && element.m_shouldGenerateFile) {
348             ASSERT(!element.m_ownsGeneratedFile);
349             ASSERT(element.m_generatedFilename.isEmpty());
350             if (!element.m_generatedFilename.isEmpty())
351                 continue;
352             element.m_generatedFilename = page->chrome().client().generateReplacementFile(element.m_filename);
353             if (!element.m_generatedFilename.isEmpty())
354                 element.m_ownsGeneratedFile = true;
355         }
356     }
357 }
358
359 bool FormData::hasGeneratedFiles() const
360 {
361     for (const FormDataElement& element : m_elements) {
362         if (element.m_type == FormDataElement::Type::EncodedFile && !element.m_generatedFilename.isEmpty())
363             return true;
364     }
365     return false;
366 }
367
368 bool FormData::hasOwnedGeneratedFiles() const
369 {
370     for (const FormDataElement& element : m_elements) {
371         if (element.m_type == FormDataElement::Type::EncodedFile && element.m_ownsGeneratedFile) {
372             ASSERT(!element.m_generatedFilename.isEmpty());
373             return true;
374         }
375     }
376     return false;
377 }
378
379 void FormData::removeGeneratedFilesIfNeeded()
380 {
381     for (FormDataElement& element : m_elements) {
382         if (element.m_type == FormDataElement::Type::EncodedFile && element.m_ownsGeneratedFile) {
383             ASSERT(!element.m_generatedFilename.isEmpty());
384             ASSERT(element.m_shouldGenerateFile);
385             String directory = directoryName(element.m_generatedFilename);
386             deleteFile(element.m_generatedFilename);
387             deleteEmptyDirectory(directory);
388             element.m_generatedFilename = String();
389             element.m_ownsGeneratedFile = false;
390         }
391     }
392 }
393
394 } // namespace WebCore