b1a85950eb8d93a8d120500f50fea679e3cad3b9
[WebKit.git] / Source / WebCore / platform / network / BlobData.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef BlobData_h
32 #define BlobData_h
33
34 #include "FileSystem.h"
35 #include "URL.h"
36 #include <wtf/Forward.h>
37 #include <wtf/PassOwnPtr.h>
38 #include <wtf/ThreadSafeRefCounted.h>
39 #include <wtf/text/WTFString.h>
40
41 namespace WebCore {
42
43 // FIXME: RawData doesn't need to be ThreadSafeRefCounted any more. We can probably switch to another data buffer type now.
44 class RawData : public ThreadSafeRefCounted<RawData> {
45 public:
46     static PassRefPtr<RawData> create(Vector<char>&& data)
47     {
48         return adoptRef(new RawData(std::move(data)));
49     }
50
51     static PassRefPtr<RawData> create(const char* data, size_t size)
52     {
53         Vector<char> dataVector(size);
54         memcpy(dataVector.data(), data, size);
55         return adoptRef(new RawData(std::move(dataVector)));
56     }
57
58     const char* data() const { return m_data.data(); }
59     size_t length() const { return m_data.size(); }
60
61 private:
62     RawData(Vector<char>&& data)
63         : m_data(std::move(data))
64     {
65     }
66
67     Vector<char> m_data;
68 };
69
70 struct BlobDataItem {
71     static const long long toEndOfFile;
72
73     // Default constructor.
74     BlobDataItem()
75         : type(Data)
76         , offset(0)
77         , length(toEndOfFile)
78         , expectedModificationTime(invalidFileTime())
79     {
80     }
81
82     // Constructor for String type (complete string).
83     explicit BlobDataItem(PassRefPtr<RawData> data)
84         : type(Data)
85         , data(data)
86         , offset(0)
87         , length(toEndOfFile)
88         , expectedModificationTime(invalidFileTime())
89     {
90     }
91
92     // Constructor for File type (complete file).
93     explicit BlobDataItem(const String& path)
94         : type(File)
95         , path(path)
96         , offset(0)
97         , length(toEndOfFile)
98         , expectedModificationTime(invalidFileTime())
99     {
100     }
101
102     // Constructor for File type (partial file).
103     BlobDataItem(const String& path, long long offset, long long length, double expectedModificationTime)
104         : type(File)
105         , path(path)
106         , offset(offset)
107         , length(length)
108         , expectedModificationTime(expectedModificationTime)
109     {
110     }
111
112     // Constructor for Blob type.
113     BlobDataItem(const URL& url, long long offset, long long length)
114         : type(Blob)
115         , url(url)
116         , offset(offset)
117         , length(length)
118         , expectedModificationTime(invalidFileTime())
119     {
120     }
121
122     enum {
123         Data,
124         File,
125         Blob
126     } type;
127
128     // For Data type.
129     RefPtr<RawData> data;
130
131     // For File type.
132     String path;
133
134     // For Blob or URL type.
135     URL url;
136
137     long long offset;
138     long long length;
139     double expectedModificationTime;
140
141 private:
142     friend class BlobData;
143
144     // Constructor for String type (partial string).
145     BlobDataItem(PassRefPtr<RawData> data, long long offset, long long length)
146         : type(Data)
147         , data(data)
148         , offset(offset)
149         , length(length)
150         , expectedModificationTime(invalidFileTime())
151     {
152     }
153 };
154
155 typedef Vector<BlobDataItem> BlobDataItemList;
156
157 class BlobData {
158     WTF_MAKE_FAST_ALLOCATED;
159 public:
160     BlobData() { }
161
162     const String& contentType() const { return m_contentType; }
163     void setContentType(const String&);
164
165     const BlobDataItemList& items() const { return m_items; }
166     void swapItems(BlobDataItemList&);
167
168     void appendData(PassRefPtr<RawData>, long long offset, long long length);
169     void appendFile(const String& path);
170     void appendFile(const String& path, long long offset, long long length, double expectedModificationTime);
171     void appendBlob(const URL&, long long offset, long long length);
172
173 private:
174     friend class BlobRegistryImpl;
175     friend class BlobStorageData;
176
177     // This is only exposed to BlobStorageData.
178     void appendData(const RawData&, long long offset, long long length);
179
180     String m_contentType;
181     String m_contentDisposition;
182     BlobDataItemList m_items;
183 };
184
185 } // namespace WebCore
186
187 #endif // BlobData_h