82ed88990a3f298c0bcbaaafb79f1fa8cbd14be9
[WebKit.git] / Source / WebKit / NetworkProcess / cache / NetworkCacheEntry.h
1 /*
2  * Copyright (C) 2015 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef NetworkCacheEntry_h
27 #define NetworkCacheEntry_h
28
29 #include "NetworkCacheStorage.h"
30 #include "ShareableResource.h"
31 #include <WebCore/ResourceRequest.h>
32 #include <WebCore/ResourceResponse.h>
33 #include <wtf/Noncopyable.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WebCore {
37 class SharedBuffer;
38 }
39
40 namespace WebKit {
41 namespace NetworkCache {
42
43 class Entry {
44     WTF_MAKE_FAST_ALLOCATED;
45 public:
46     Entry(const Key&, const WebCore::ResourceResponse&, RefPtr<WebCore::SharedBuffer>&&, const Vector<std::pair<String, String>>& varyingRequestHeaders);
47     Entry(const Key&, const WebCore::ResourceResponse&, const WebCore::ResourceRequest& redirectRequest, const Vector<std::pair<String, String>>& varyingRequestHeaders);
48     explicit Entry(const Storage::Record&);
49     Entry(const Entry&);
50
51     Storage::Record encodeAsStorageRecord() const;
52     static std::unique_ptr<Entry> decodeStorageRecord(const Storage::Record&);
53
54     const Key& key() const { return m_key; }
55     std::chrono::system_clock::time_point timeStamp() const { return m_timeStamp; }
56     const WebCore::ResourceResponse& response() const { return m_response; }
57     const Vector<std::pair<String, String>>& varyingRequestHeaders() const { return m_varyingRequestHeaders; }
58
59     WebCore::SharedBuffer* buffer() const;
60     const std::optional<WebCore::ResourceRequest>& redirectRequest() const { return m_redirectRequest; }
61
62 #if ENABLE(SHAREABLE_RESOURCE)
63     ShareableResource::Handle& shareableResourceHandle() const;
64 #endif
65
66     bool needsValidation() const;
67     void setNeedsValidation(bool);
68
69     const Storage::Record& sourceStorageRecord() const { return m_sourceStorageRecord; }
70
71     void asJSON(StringBuilder&, const Storage::RecordInfo&) const;
72
73 private:
74     void initializeBufferFromStorageRecord() const;
75 #if ENABLE(SHAREABLE_RESOURCE)
76     void initializeShareableResourceHandleFromStorageRecord() const;
77 #endif
78
79     Key m_key;
80     std::chrono::system_clock::time_point m_timeStamp;
81     WebCore::ResourceResponse m_response;
82     Vector<std::pair<String, String>> m_varyingRequestHeaders;
83
84     std::optional<WebCore::ResourceRequest> m_redirectRequest;
85     mutable RefPtr<WebCore::SharedBuffer> m_buffer;
86 #if ENABLE(SHAREABLE_RESOURCE)
87     mutable ShareableResource::Handle m_shareableResourceHandle;
88 #endif
89
90     Storage::Record m_sourceStorageRecord { };
91 };
92
93 }
94 }
95
96 #endif