e23cfc0a9d7ff367ba59552d27dd1c67a072a335
[WebKit-https.git] / Source / WebCore / platform / network / BlobRegistry.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 BlobRegistry_h
32 #define BlobRegistry_h
33
34 #include <functional>
35 #include <wtf/Forward.h>
36 #include <wtf/Vector.h>
37
38 namespace WebCore {
39
40 class BlobDataFileReference;
41 class BlobPart;
42 class BlobRegistry;
43 class URL;
44
45 WEBCORE_EXPORT BlobRegistry& blobRegistry();
46
47 // BlobRegistry is not thread-safe. It should only be called from main thread.
48 class WEBCORE_EXPORT BlobRegistry {
49 public:
50
51     // Registers a blob URL referring to the specified file.
52     virtual void registerFileBlobURL(const URL&, RefPtr<BlobDataFileReference>&&, const String& contentType) = 0;
53
54     // Registers a blob URL referring to the specified blob data.
55     virtual void registerBlobURL(const URL&, Vector<BlobPart>, const String& contentType) = 0;
56     
57     // Registers a new blob URL referring to the blob data identified by the specified srcURL.
58     virtual void registerBlobURL(const URL&, const URL& srcURL) = 0;
59
60     // Registers a new blob URL referring to the blob data identified by the specified srcURL or, if none found, referring to the file found at the given path.
61     virtual void registerBlobURLOptionallyFileBacked(const URL&, const URL& srcURL, RefPtr<BlobDataFileReference>&&) = 0;
62
63     // Negative start and end values select from the end.
64     virtual void registerBlobURLForSlice(const URL&, const URL& srcURL, long long start, long long end) = 0;
65
66     virtual void unregisterBlobURL(const URL&) = 0;
67
68     virtual unsigned long long blobSize(const URL&) = 0;
69
70     virtual void writeBlobsToTemporaryFiles(const Vector<String>& blobURLs, std::function<void (const Vector<String>& filePaths)> completionHandler) = 0;
71
72     virtual bool isBlobRegistryImpl() const { return false; }
73
74 protected:
75     virtual ~BlobRegistry();
76 };
77
78 } // namespace WebCore
79
80 #endif // BlobRegistry_h