.: Blob.slice support.
[WebKit-https.git] / WebCore / platform / network / FormData.cpp
1 /*
2  * Copyright (C) 2004, 2006, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Google Inc. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB. If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #include "config.h"
22 #include "FormData.h"
23
24 #include "Blob.h"
25 #include "CString.h"
26 #include "ChromeClient.h"
27 #include "FileSystem.h"
28 #include "TextEncoding.h"
29
30 namespace WebCore {
31
32 inline FormData::FormData()
33     : m_identifier(0)
34     , m_hasGeneratedFiles(false)
35     , m_alwaysStream(false)
36 {
37 }
38
39 inline FormData::FormData(const FormData& data)
40     : RefCounted<FormData>()
41     , m_elements(data.m_elements)
42     , m_identifier(data.m_identifier)
43     , m_hasGeneratedFiles(false)
44     , m_alwaysStream(false)
45 {
46     // We shouldn't be copying FormData that hasn't already removed its generated files
47     // but just in case, make sure the new FormData is ready to generate its own files.
48     if (data.m_hasGeneratedFiles) {
49         size_t n = m_elements.size();
50         for (size_t i = 0; i < n; ++i) {
51             FormDataElement& e = m_elements[i];
52             if (e.m_type == FormDataElement::encodedFile)
53                 e.m_generatedFilename = String();
54         }
55     }
56 }
57
58 FormData::~FormData()
59 {
60     // This cleanup should've happened when the form submission finished.
61     // Just in case, let's assert, and do the cleanup anyway in release builds.
62     ASSERT(!m_hasGeneratedFiles);
63     removeGeneratedFilesIfNeeded();
64 }
65
66 PassRefPtr<FormData> FormData::create()
67 {
68     return adoptRef(new FormData);
69 }
70
71 PassRefPtr<FormData> FormData::create(const void* data, size_t size)
72 {
73     RefPtr<FormData> result = create();
74     result->appendData(data, size);
75     return result.release();
76 }
77
78 PassRefPtr<FormData> FormData::create(const CString& string)
79 {
80     RefPtr<FormData> result = create();
81     result->appendData(string.data(), string.length());
82     return result.release();
83 }
84
85 PassRefPtr<FormData> FormData::create(const Vector<char>& vector)
86 {
87     RefPtr<FormData> result = create();
88     result->appendData(vector.data(), vector.size());
89     return result.release();
90 }
91
92 PassRefPtr<FormData> FormData::copy() const
93 {
94     return adoptRef(new FormData(*this));
95 }
96
97 PassRefPtr<FormData> FormData::deepCopy() const
98 {
99     RefPtr<FormData> formData(create());
100
101     formData->m_alwaysStream = m_alwaysStream;
102
103     size_t n = m_elements.size();
104     formData->m_elements.reserveInitialCapacity(n);
105     for (size_t i = 0; i < n; ++i) {
106         const FormDataElement& e = m_elements[i];
107         switch (e.m_type) {
108         case FormDataElement::data:
109             formData->m_elements.append(FormDataElement(e.m_data));
110             break;
111         case FormDataElement::encodedFile:
112 #if ENABLE(BLOB_SLICE)
113             formData->m_elements.append(FormDataElement(e.m_filename, e.m_fileStart, e.m_fileLength, e.m_expectedFileModificationTime, e.m_shouldGenerateFile));
114 #else
115             formData->m_elements.append(FormDataElement(e.m_filename, e.m_shouldGenerateFile));
116 #endif
117             break;
118         }
119     }
120     return formData.release();
121 }
122
123 void FormData::appendData(const void* data, size_t size)
124 {
125     if (m_elements.isEmpty() || m_elements.last().m_type != FormDataElement::data)
126         m_elements.append(FormDataElement());
127     FormDataElement& e = m_elements.last();
128     size_t oldSize = e.m_data.size();
129     e.m_data.grow(oldSize + size);
130     memcpy(e.m_data.data() + oldSize, data, size);
131 }
132
133 void FormData::appendFile(const String& filename, bool shouldGenerateFile)
134 {
135 #if ENABLE(BLOB_SLICE)
136     m_elements.append(FormDataElement(filename, 0, Blob::toEndOfFile, Blob::doNotCheckFileChange, shouldGenerateFile));
137 #else
138     m_elements.append(FormDataElement(filename, shouldGenerateFile));
139 #endif
140 }
141
142 #if ENABLE(BLOB_SLICE)
143 void FormData::appendFileRange(const String& filename, long long start, long long length, double expectedModificationTime, bool shouldGenerateFile)
144 {
145     m_elements.append(FormDataElement(filename, start, length, expectedModificationTime, shouldGenerateFile));
146 }
147 #endif
148
149 void FormData::flatten(Vector<char>& data) const
150 {
151     // Concatenate all the byte arrays, but omit any files.
152     data.clear();
153     size_t n = m_elements.size();
154     for (size_t i = 0; i < n; ++i) {
155         const FormDataElement& e = m_elements[i];
156         if (e.m_type == FormDataElement::data) {
157             size_t oldSize = data.size();
158             size_t delta = e.m_data.size();
159             data.grow(oldSize + delta);
160             memcpy(data.data() + oldSize, e.m_data.data(), delta);
161         }
162     }
163 }
164
165 String FormData::flattenToString() const
166 {
167     Vector<char> bytes;
168     flatten(bytes);
169     return Latin1Encoding().decode(bytes.data(), bytes.size());
170 }
171
172 void FormData::generateFiles(ChromeClient* client)
173 {
174     ASSERT(!m_hasGeneratedFiles);
175     
176     if (m_hasGeneratedFiles)
177         return;
178     
179     size_t n = m_elements.size();
180     for (size_t i = 0; i < n; ++i) {
181         FormDataElement& e = m_elements[i];
182         if (e.m_type == FormDataElement::encodedFile && e.m_shouldGenerateFile) {
183             e.m_generatedFilename = client->generateReplacementFile(e.m_filename);
184             m_hasGeneratedFiles = true;
185         }
186     }
187 }
188
189 void FormData::removeGeneratedFilesIfNeeded()
190 {
191     if (!m_hasGeneratedFiles)
192         return;
193         
194     size_t n = m_elements.size();
195     for (size_t i = 0; i < n; ++i) {
196         FormDataElement& e = m_elements[i];
197         if (e.m_type == FormDataElement::encodedFile && !e.m_generatedFilename.isEmpty()) {
198             ASSERT(e.m_shouldGenerateFile);
199             String directory = directoryName(e.m_generatedFilename);
200             deleteFile(e.m_generatedFilename);
201             deleteEmptyDirectory(directory);
202             e.m_generatedFilename = String();
203         }
204     }
205     m_hasGeneratedFiles = false;
206 }
207
208 } // namespace WebCore