1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*
* Copyright (C) 2014-2015 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef NetworkCache_h
#define NetworkCache_h
#if ENABLE(NETWORK_CACHE)
#include "NetworkCacheEntry.h"
#include "NetworkCacheStorage.h"
#include "ShareableResource.h"
#include <WebCore/ResourceResponse.h>
#include <wtf/text/WTFString.h>
namespace WebCore {
class ResourceRequest;
class SharedBuffer;
class URL;
}
namespace WebKit {
namespace NetworkCache {
class Cache;
class SpeculativeLoadManager;
class Statistics;
Cache& singleton();
struct MappedBody {
#if ENABLE(SHAREABLE_RESOURCE)
RefPtr<ShareableResource> shareableResource;
ShareableResource::Handle shareableResourceHandle;
#endif
};
enum class RetrieveDecision {
Yes,
NoDueToHTTPMethod,
NoDueToConditionalRequest,
NoDueToReloadIgnoringCache
};
// FIXME: This enum is used in the Statistics code in a way that prevents removing or reordering anything.
enum class StoreDecision {
Yes,
NoDueToProtocol,
NoDueToHTTPMethod,
NoDueToAttachmentResponse, // Unused.
NoDueToNoStoreResponse,
NoDueToHTTPStatusCode,
NoDueToNoStoreRequest,
NoDueToUnlikelyToReuse,
NoDueToStreamingMedia
};
enum class UseDecision {
Use,
Validate,
NoDueToVaryingHeaderMismatch,
NoDueToMissingValidatorFields,
NoDueToDecodeFailure,
NoDueToExpiredRedirect,
};
using GlobalFrameID = std::pair<uint64_t /*webPageID*/, uint64_t /*webFrameID*/>;
class Cache {
WTF_MAKE_NONCOPYABLE(Cache);
friend class WTF::NeverDestroyed<Cache>;
public:
struct Parameters {
bool enableEfficacyLogging;
#if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
bool enableNetworkCacheSpeculativeRevalidation;
#endif
};
bool initialize(const String& cachePath, const Parameters&);
void setCapacity(size_t);
bool isEnabled() const { return !!m_storage; }
// Completion handler may get called back synchronously on failure.
void retrieve(const WebCore::ResourceRequest&, const GlobalFrameID&, std::function<void (std::unique_ptr<Entry>)>);
std::unique_ptr<Entry> store(const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, RefPtr<WebCore::SharedBuffer>&&, std::function<void (MappedBody&)>);
std::unique_ptr<Entry> storeRedirect(const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, const WebCore::ResourceRequest& redirectRequest);
std::unique_ptr<Entry> update(const WebCore::ResourceRequest&, const GlobalFrameID&, const Entry&, const WebCore::ResourceResponse& validatingResponse);
struct TraversalEntry {
const Entry& entry;
const Storage::RecordInfo& recordInfo;
};
void traverse(const std::function<void (const TraversalEntry*)>&);
void remove(const Key&);
void remove(const WebCore::ResourceRequest&);
void clear();
void clear(std::chrono::system_clock::time_point modifiedSince, std::function<void ()>&& completionHandler);
void dumpContentsToFile();
String recordsPath() const;
private:
Cache() = default;
~Cache() = delete;
String dumpFilePath() const;
void deleteDumpFile();
std::unique_ptr<Storage> m_storage;
#if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
std::unique_ptr<SpeculativeLoadManager> m_speculativeLoadManager;
#endif
std::unique_ptr<Statistics> m_statistics;
unsigned m_traverseCount { 0 };
};
}
}
#endif
#endif
|
