660a796d0b2d8986251b806d3913bf91454e9e77
[WebKit-https.git] / Source / WebCore / platform / network / BlobRegistry.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2013, 2014, 2016 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #pragma once
33
34 #include <pal/SessionID.h>
35 #include <wtf/Forward.h>
36
37 namespace WebCore {
38
39 class BlobDataFileReference;
40 class BlobPart;
41 class BlobRegistry;
42 class BlobRegistryImpl;
43
44 WEBCORE_EXPORT BlobRegistry& blobRegistry();
45
46 // BlobRegistry is not thread-safe. It should only be called from main thread.
47 class WEBCORE_EXPORT BlobRegistry {
48 public:
49
50     // Registers a blob URL referring to the specified file.
51     virtual void registerFileBlobURL(PAL::SessionID, const URL&, Ref<BlobDataFileReference>&&, const String& contentType) = 0;
52
53     // Registers a blob URL referring to the specified blob data.
54     virtual void registerBlobURL(PAL::SessionID, const URL&, Vector<BlobPart>&&, const String& contentType) = 0;
55     
56     // Registers a new blob URL referring to the blob data identified by the specified srcURL.
57     virtual void registerBlobURL(PAL::SessionID, const URL&, const URL& srcURL) = 0;
58
59     // 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.
60     virtual void registerBlobURLOptionallyFileBacked(PAL::SessionID, const URL&, const URL& srcURL, RefPtr<BlobDataFileReference>&&, const String& contentType) = 0;
61
62     // Negative start and end values select from the end.
63     virtual void registerBlobURLForSlice(PAL::SessionID, const URL&, const URL& srcURL, long long start, long long end) = 0;
64
65     virtual void unregisterBlobURL(PAL::SessionID, const URL&) = 0;
66
67     virtual unsigned long long blobSize(const URL&) = 0;
68
69     virtual void writeBlobsToTemporaryFiles(PAL::SessionID, const Vector<String>& blobURLs, CompletionHandler<void(Vector<String>&& filePaths)>&&) = 0;
70
71     virtual BlobRegistryImpl* blobRegistryImpl() { return nullptr; }
72
73 protected:
74     virtual ~BlobRegistry();
75 };
76
77 } // namespace WebCore