Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / fileapi / Blob.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 #pragma once
32
33 #include "BlobPropertyBag.h"
34 #include "ScriptWrappable.h"
35 #include <wtf/URL.h>
36 #include "URLRegistry.h"
37 #include <wtf/Variant.h>
38
39 namespace JSC {
40 class ArrayBufferView;
41 class ArrayBuffer;
42 }
43
44 namespace WebCore {
45
46 class Blob;
47 class ScriptExecutionContext;
48 class SharedBuffer;
49
50 using BlobPartVariant = Variant<RefPtr<JSC::ArrayBufferView>, RefPtr<JSC::ArrayBuffer>, RefPtr<Blob>, String>;
51
52 class Blob : public ScriptWrappable, public URLRegistrable, public RefCounted<Blob> {
53 public:
54     static Ref<Blob> create()
55     {
56         return adoptRef(*new Blob);
57     }
58
59     static Ref<Blob> create(Vector<BlobPartVariant>&& blobPartVariants, const BlobPropertyBag& propertyBag)
60     {
61         return adoptRef(*new Blob(WTFMove(blobPartVariants), propertyBag));
62     }
63
64     static Ref<Blob> create(const SharedBuffer& buffer, const String& contentType)
65     {
66         return adoptRef(*new Blob(buffer, contentType));
67     }
68
69     static Ref<Blob> create(Vector<uint8_t>&& data, const String& contentType)
70     {
71         return adoptRef(*new Blob(WTFMove(data), contentType));
72     }
73
74     static Ref<Blob> deserialize(const URL& srcURL, const String& type, long long size, const String& fileBackedPath)
75     {
76         ASSERT(Blob::isNormalizedContentType(type));
77         return adoptRef(*new Blob(deserializationContructor, srcURL, type, size, fileBackedPath));
78     }
79
80     virtual ~Blob();
81
82     const URL& url() const { return m_internalURL; }
83     const String& type() const { return m_type; }
84
85     WEBCORE_EXPORT unsigned long long size() const;
86     virtual bool isFile() const { return false; }
87
88     // The checks described in the File API spec.
89     static bool isValidContentType(const String&);
90     // The normalization procedure described in the File API spec.
91     static String normalizedContentType(const String&);
92 #if !ASSERT_DISABLED
93     static bool isNormalizedContentType(const String&);
94     static bool isNormalizedContentType(const CString&);
95 #endif
96
97     // URLRegistrable
98     URLRegistry& registry() const override;
99
100     Ref<Blob> slice(long long start = 0, long long end = std::numeric_limits<long long>::max(), const String& contentType = String()) const
101     {
102         return adoptRef(*new Blob(m_internalURL, start, end, contentType));
103     }
104
105 protected:
106     WEBCORE_EXPORT Blob();
107     Blob(Vector<BlobPartVariant>&&, const BlobPropertyBag&);
108     Blob(const SharedBuffer&, const String& contentType);
109     Blob(Vector<uint8_t>&&, const String& contentType);
110
111     enum ReferencingExistingBlobConstructor { referencingExistingBlobConstructor };
112     Blob(ReferencingExistingBlobConstructor, const Blob&);
113
114     enum UninitializedContructor { uninitializedContructor };
115     Blob(UninitializedContructor);
116
117     enum DeserializationContructor { deserializationContructor };
118     Blob(DeserializationContructor, const URL& srcURL, const String& type, long long size, const String& fileBackedPath);
119
120     // For slicing.
121     Blob(const URL& srcURL, long long start, long long end, const String& contentType);
122
123     // This is an internal URL referring to the blob data associated with this object. It serves
124     // as an identifier for this blob. The internal URL is never used to source the blob's content
125     // into an HTML or for FileRead'ing, public blob URLs must be used for those purposes.
126     URL m_internalURL;
127
128     String m_type;
129     mutable long long m_size;
130 };
131
132 } // namespace WebCore