561e4e6b8807e03f00e04cfe2ffa0bf2c9319e5c
[WebKit.git] / Source / WebKit / NetworkProcess / cache / NetworkCacheSubresourcesEntry.cpp
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 #include "config.h"
27
28 #if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
29 #include "NetworkCacheSubresourcesEntry.h"
30
31 #include "Logging.h"
32 #include "NetworkCacheCoders.h"
33
34 using namespace std::chrono;
35
36 namespace WebKit {
37 namespace NetworkCache {
38
39 void SubresourceInfo::encode(WTF::Persistence::Encoder& encoder) const
40 {
41     encoder << m_key;
42     encoder << m_lastSeen;
43     encoder << m_firstSeen;
44     encoder << m_isTransient;
45
46     // Do not bother serializing other data members of transient resources as they are empty.
47     if (m_isTransient)
48         return;
49
50     encoder << m_firstPartyForCookies;
51     encoder << m_requestHeaders;
52     encoder.encodeEnum(m_priority);
53 }
54
55 bool SubresourceInfo::decode(WTF::Persistence::Decoder& decoder, SubresourceInfo& info)
56 {
57     if (!decoder.decode(info.m_key))
58         return false;
59     if (!decoder.decode(info.m_lastSeen))
60         return false;
61     if (!decoder.decode(info.m_firstSeen))
62         return false;
63     
64     if (!decoder.decode(info.m_isTransient))
65         return false;
66     
67     if (info.m_isTransient)
68         return true;
69     
70     if (!decoder.decode(info.m_firstPartyForCookies))
71         return false;
72
73     if (!decoder.decode(info.m_requestHeaders))
74         return false;
75
76     if (!decoder.decodeEnum(info.m_priority))
77         return false;
78     
79     return true;
80 }
81
82 Storage::Record SubresourcesEntry::encodeAsStorageRecord() const
83 {
84     WTF::Persistence::Encoder encoder;
85     encoder << m_subresources;
86
87     encoder.encodeChecksum();
88
89     return { m_key, m_timeStamp, { encoder.buffer(), encoder.bufferSize() }, { }, { }};
90 }
91
92 std::unique_ptr<SubresourcesEntry> SubresourcesEntry::decodeStorageRecord(const Storage::Record& storageEntry)
93 {
94     auto entry = std::make_unique<SubresourcesEntry>(storageEntry);
95
96     WTF::Persistence::Decoder decoder(storageEntry.header.data(), storageEntry.header.size());
97     if (!decoder.decode(entry->m_subresources))
98         return nullptr;
99
100     if (!decoder.verifyChecksum()) {
101         LOG(NetworkCache, "(NetworkProcess) checksum verification failure\n");
102         return nullptr;
103     }
104
105     return entry;
106 }
107
108 SubresourcesEntry::SubresourcesEntry(const Storage::Record& storageEntry)
109     : m_key(storageEntry.key)
110     , m_timeStamp(storageEntry.timeStamp)
111 {
112     ASSERT(m_key.type() == "SubResources");
113 }
114
115 SubresourceInfo::SubresourceInfo(const Key& key, const WebCore::ResourceRequest& request, const SubresourceInfo* previousInfo)
116     : m_key(key)
117     , m_lastSeen(std::chrono::system_clock::now())
118     , m_firstSeen(previousInfo ? previousInfo->firstSeen() : m_lastSeen)
119     , m_isTransient(!previousInfo)
120     , m_firstPartyForCookies(request.firstPartyForCookies())
121     , m_requestHeaders(request.httpHeaderFields())
122     , m_priority(request.priority())
123 {
124 }
125
126 static Vector<SubresourceInfo> makeSubresourceInfoVector(const Vector<std::unique_ptr<SubresourceLoad>>& subresourceLoads, Vector<SubresourceInfo>* previousSubresources)
127 {
128     Vector<SubresourceInfo> result;
129     result.reserveInitialCapacity(subresourceLoads.size());
130     
131     HashMap<Key, unsigned> previousMap;
132     if (previousSubresources) {
133         for (unsigned i = 0; i < previousSubresources->size(); ++i)
134             previousMap.add(previousSubresources->at(i).key(), i);
135     }
136
137     HashSet<Key> deduplicationSet;
138     for (auto& load : subresourceLoads) {
139         if (!deduplicationSet.add(load->key).isNewEntry)
140             continue;
141         
142         SubresourceInfo* previousInfo = nullptr;
143         if (previousSubresources) {
144             auto it = previousMap.find(load->key);
145             if (it != previousMap.end())
146                 previousInfo = &(*previousSubresources)[it->value];
147         }
148         
149         result.uncheckedAppend({ load->key, load->request, previousInfo });
150         
151         // FIXME: We should really consider all resources seen for the first time transient.
152         if (!previousSubresources)
153             result.last().setNonTransient();
154     }
155
156     return result;
157 }
158
159 SubresourcesEntry::SubresourcesEntry(Key&& key, const Vector<std::unique_ptr<SubresourceLoad>>& subresourceLoads)
160     : m_key(WTFMove(key))
161     , m_timeStamp(std::chrono::system_clock::now())
162     , m_subresources(makeSubresourceInfoVector(subresourceLoads, nullptr))
163 {
164     ASSERT(m_key.type() == "SubResources");
165 }
166     
167 void SubresourcesEntry::updateSubresourceLoads(const Vector<std::unique_ptr<SubresourceLoad>>& subresourceLoads)
168 {
169     m_subresources = makeSubresourceInfoVector(subresourceLoads, &m_subresources);
170 }
171
172 } // namespace WebKit
173 } // namespace NetworkCache
174
175 #endif // ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)