aa8530d80e1ae2769afb93edfa64342e15ae8517
[WebKit-https.git] / Source / WebCore / loader / cache / CachedResource.h
1 /*
2     Copyright (C) 1998 Lars Knoll (knoll@mpi-hd.mpg.de)
3     Copyright (C) 2001 Dirk Mueller <mueller@kde.org>
4     Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5     Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
6
7     This library is free software; you can redistribute it and/or
8     modify it under the terms of the GNU Library General Public
9     License as published by the Free Software Foundation; either
10     version 2 of the License, or (at your option) any later version.
11
12     This library is distributed in the hope that it will be useful,
13     but WITHOUT ANY WARRANTY; without even the implied warranty of
14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15     Library General Public License for more details.
16
17     You should have received a copy of the GNU Library General Public License
18     along with this library; see the file COPYING.LIB.  If not, write to
19     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20     Boston, MA 02110-1301, USA.
21 */
22
23 #pragma once
24
25 #include "CachePolicy.h"
26 #include "CacheValidation.h"
27 #include "FrameLoaderTypes.h"
28 #include "ResourceError.h"
29 #include "ResourceLoadPriority.h"
30 #include "ResourceLoaderOptions.h"
31 #include "ResourceRequest.h"
32 #include "ResourceResponse.h"
33 #include "Timer.h"
34 #include <pal/SessionID.h>
35 #include <time.h>
36 #include <wtf/HashCountedSet.h>
37 #include <wtf/HashSet.h>
38 #include <wtf/TypeCasts.h>
39 #include <wtf/Vector.h>
40 #include <wtf/text/WTFString.h>
41
42 namespace WebCore {
43
44 class CachedResourceClient;
45 class CachedResourceHandleBase;
46 class CachedResourceLoader;
47 class CachedResourceRequest;
48 class CookieJar;
49 class LoadTiming;
50 class MemoryCache;
51 class SecurityOrigin;
52 class SharedBuffer;
53 class SubresourceLoader;
54 class TextResourceDecoder;
55
56 // A resource that is held in the cache. Classes who want to use this object should derive
57 // from CachedResourceClient, to get the function calls in case the requested data has arrived.
58 // This class also does the actual communication with the loader to obtain the resource from the network.
59 class CachedResource {
60     WTF_MAKE_NONCOPYABLE(CachedResource); WTF_MAKE_FAST_ALLOCATED;
61     friend class MemoryCache;
62
63 public:
64     enum class Type : uint8_t {
65         MainResource,
66         ImageResource,
67         CSSStyleSheet,
68         Script,
69         FontResource,
70 #if ENABLE(SVG_FONTS)
71         SVGFontResource,
72 #endif
73         MediaResource,
74         RawResource,
75         Icon,
76         Beacon,
77         SVGDocumentResource
78 #if ENABLE(XSLT)
79         , XSLStyleSheet
80 #endif
81         , LinkPrefetch
82 #if ENABLE(VIDEO_TRACK)
83         , TextTrackResource
84 #endif
85 #if ENABLE(APPLICATION_MANIFEST)
86         , ApplicationManifest
87 #endif
88     };
89
90     enum Status {
91         Unknown,      // let cache decide what to do with it
92         Pending,      // only partially loaded
93         Cached,       // regular case
94         LoadError,
95         DecodeError
96     };
97
98     CachedResource(CachedResourceRequest&&, Type, const PAL::SessionID&, const CookieJar*);
99     virtual ~CachedResource();
100
101     virtual void load(CachedResourceLoader&);
102
103     virtual void setEncoding(const String&) { }
104     virtual String encoding() const { return String(); }
105     virtual const TextResourceDecoder* textResourceDecoder() const { return nullptr; }
106     virtual void updateBuffer(SharedBuffer&);
107     virtual void updateData(const char* data, unsigned length);
108     virtual void finishLoading(SharedBuffer*);
109     virtual void error(CachedResource::Status);
110
111     void setResourceError(const ResourceError& error) { m_error = error; }
112     const ResourceError& resourceError() const { return m_error; }
113
114     virtual bool shouldIgnoreHTTPStatusCodeErrors() const { return false; }
115
116     const ResourceRequest& resourceRequest() const { return m_resourceRequest; }
117     const URL& url() const { return m_resourceRequest.url();}
118     const String& cachePartition() const { return m_resourceRequest.cachePartition(); }
119     PAL::SessionID sessionID() const { return m_sessionID; }
120     const CookieJar* cookieJar() const { return m_cookieJar.get(); }
121     Type type() const { return m_type; }
122     String mimeType() const { return m_response.mimeType(); }
123     long long expectedContentLength() const { return m_response.expectedContentLength(); }
124
125     static bool shouldUsePingLoad(Type type) { return type == Type::Beacon; }
126
127     ResourceLoadPriority loadPriority() const { return m_loadPriority; }
128     void setLoadPriority(const Optional<ResourceLoadPriority>&);
129
130     WEBCORE_EXPORT void addClient(CachedResourceClient&);
131     WEBCORE_EXPORT void removeClient(CachedResourceClient&);
132     bool hasClients() const { return !m_clients.isEmpty() || !m_clientsAwaitingCallback.isEmpty(); }
133     bool hasClient(CachedResourceClient& client) { return m_clients.contains(&client) || m_clientsAwaitingCallback.contains(&client); }
134     bool deleteIfPossible();
135
136     enum class PreloadResult : uint8_t {
137         PreloadNotReferenced,
138         PreloadReferenced,
139         PreloadReferencedWhileLoading,
140         PreloadReferencedWhileComplete
141     };
142     PreloadResult preloadResult() const { return static_cast<PreloadResult>(m_preloadResult); }
143
144     virtual void didAddClient(CachedResourceClient&);
145     virtual void didRemoveClient(CachedResourceClient&) { }
146     virtual void allClientsRemoved();
147     void destroyDecodedDataIfNeeded();
148
149     unsigned numberOfClients() const { return m_clients.size(); }
150
151     Status status() const { return static_cast<Status>(m_status); }
152     void setStatus(Status status) { m_status = status; }
153
154     unsigned size() const { return encodedSize() + decodedSize() + overheadSize(); }
155     unsigned encodedSize() const { return m_encodedSize; }
156     unsigned decodedSize() const { return m_decodedSize; }
157     unsigned overheadSize() const;
158
159     bool isLoaded() const { return !m_loading; } // FIXME. Method name is inaccurate. Loading might not have started yet.
160
161     bool isLoading() const { return m_loading; }
162     void setLoading(bool b) { m_loading = b; }
163     virtual bool stillNeedsLoad() const { return false; }
164
165     SubresourceLoader* loader() { return m_loader.get(); }
166
167     bool areAllClientsXMLHttpRequests() const;
168
169     bool isImage() const { return type() == Type::ImageResource; }
170     // FIXME: CachedRawResource could be a main resource, an audio/video resource, or a raw XHR/icon resource.
171     bool isMainOrMediaOrIconOrRawResource() const { return type() == Type::MainResource || type() == Type::MediaResource || type() == Type::Icon || type() == Type::RawResource || type() == Type::Beacon; }
172
173     // Whether this request should impact request counting and delay window.onload.
174     bool ignoreForRequestCount() const
175     {
176         return m_ignoreForRequestCount
177             || type() == Type::MainResource
178             || type() == Type::LinkPrefetch
179             || type() == Type::Icon
180             || type() == Type::RawResource;
181     }
182
183     void setIgnoreForRequestCount(bool ignoreForRequestCount) { m_ignoreForRequestCount = ignoreForRequestCount; }
184
185     unsigned accessCount() const { return m_accessCount; }
186     void increaseAccessCount() { m_accessCount++; }
187
188     // Computes the status of an object after loading.
189     // Updates the expire date on the cache entry file
190     void finish();
191
192     // Called by the cache if the object has been removed from the cache
193     // while still being referenced. This means the object should delete itself
194     // if the number of clients observing it ever drops to 0.
195     // The resource can be brought back to cache after successful revalidation.
196     void setInCache(bool inCache) { m_inCache = inCache; }
197     bool inCache() const { return m_inCache; }
198
199     void clearLoader();
200
201     SharedBuffer* resourceBuffer() const { return m_data.get(); }
202
203     virtual void redirectReceived(ResourceRequest&&, const ResourceResponse&, CompletionHandler<void(ResourceRequest&&)>&&);
204     virtual void responseReceived(const ResourceResponse&);
205     virtual bool shouldCacheResponse(const ResourceResponse&) { return true; }
206     void setResponse(const ResourceResponse&);
207     const ResourceResponse& response() const { return m_response; }
208
209     void setCrossOrigin();
210     bool isCrossOrigin() const;
211     bool isCORSSameOrigin() const;
212     ResourceResponse::Tainting responseTainting() const { return m_responseTainting; }
213
214     void loadFrom(const CachedResource&);
215
216     SecurityOrigin* origin() const { return m_origin.get(); }
217     AtomicString initiatorName() const { return m_initiatorName; }
218
219     bool canDelete() const { return !hasClients() && !m_loader && !m_preloadCount && !m_handleCount && !m_resourceToRevalidate && !m_proxyResource; }
220     bool hasOneHandle() const { return m_handleCount == 1; }
221
222     bool isExpired() const;
223
224     void cancelLoad();
225     bool wasCanceled() const { return m_error.isCancellation(); }
226     bool errorOccurred() const { return m_status == LoadError || m_status == DecodeError; }
227     bool loadFailedOrCanceled() const { return !m_error.isNull(); }
228
229     bool shouldSendResourceLoadCallbacks() const { return m_options.sendLoadCallbacks == SendCallbackPolicy::SendCallbacks; }
230     DataBufferingPolicy dataBufferingPolicy() const { return m_options.dataBufferingPolicy; }
231
232     bool allowsCaching() const { return m_options.cachingPolicy == CachingPolicy::AllowCaching; }
233     const ResourceLoaderOptions& options() const { return m_options; }
234
235     virtual void destroyDecodedData() { }
236
237     bool isPreloaded() const { return m_preloadCount; }
238     void increasePreloadCount() { ++m_preloadCount; }
239     void decreasePreloadCount() { ASSERT(m_preloadCount); --m_preloadCount; }
240     bool isLinkPreload() { return m_isLinkPreload; }
241     void setLinkPreload() { m_isLinkPreload = true; }
242     bool hasUnknownEncoding() { return m_hasUnknownEncoding; }
243     void setHasUnknownEncoding(bool hasUnknownEncoding) { m_hasUnknownEncoding = hasUnknownEncoding; }
244
245     void registerHandle(CachedResourceHandleBase*);
246     WEBCORE_EXPORT void unregisterHandle(CachedResourceHandleBase*);
247
248     bool canUseCacheValidator() const;
249
250     enum class RevalidationDecision { No, YesDueToCachePolicy, YesDueToNoStore, YesDueToNoCache, YesDueToExpired };
251     virtual RevalidationDecision makeRevalidationDecision(CachePolicy) const;
252     bool redirectChainAllowsReuse(ReuseExpiredRedirectionOrNot) const;
253     bool hasRedirections() const { return m_redirectChainCacheStatus.status != RedirectChainCacheStatus::Status::NoRedirection;  }
254
255     bool varyHeaderValuesMatch(const ResourceRequest&);
256
257     bool isCacheValidator() const { return m_resourceToRevalidate; }
258     CachedResource* resourceToRevalidate() const { return m_resourceToRevalidate; }
259
260     // HTTP revalidation support methods for CachedResourceLoader.
261     void setResourceToRevalidate(CachedResource*);
262     virtual void switchClientsToRevalidatedResource();
263     void clearResourceToRevalidate();
264     void updateResponseAfterRevalidation(const ResourceResponse& validatingResponse);
265     bool validationInProgress() const { return m_proxyResource; }
266     bool validationCompleting() const { return m_proxyResource && m_proxyResource->m_switchingClientsToRevalidatedResource; }
267
268     virtual void didSendData(unsigned long long /* bytesSent */, unsigned long long /* totalBytesToBeSent */) { }
269
270 #if USE(FOUNDATION) || USE(SOUP)
271     WEBCORE_EXPORT void tryReplaceEncodedData(SharedBuffer&);
272 #endif
273
274     unsigned long identifierForLoadWithoutResourceLoader() const { return m_identifierForLoadWithoutResourceLoader; }
275     static ResourceLoadPriority defaultPriorityForResourceType(Type);
276
277     void setOriginalRequest(std::unique_ptr<ResourceRequest>&& originalRequest) { m_originalRequest = WTFMove(originalRequest); }
278     const std::unique_ptr<ResourceRequest>& originalRequest() const { return m_originalRequest; }
279
280 protected:
281     // CachedResource constructor that may be used when the CachedResource can already be filled with response data.
282     CachedResource(const URL&, Type, const PAL::SessionID&, const CookieJar*);
283
284     void setEncodedSize(unsigned);
285     void setDecodedSize(unsigned);
286     void didAccessDecodedData(MonotonicTime timeStamp);
287
288     virtual void didReplaceSharedBufferContents() { }
289
290     virtual void setBodyDataFrom(const CachedResource&);
291
292 private:
293     class Callback;
294
295     bool addClientToSet(CachedResourceClient&);
296
297     void decodedDataDeletionTimerFired();
298
299     virtual void checkNotify();
300     virtual bool mayTryReplaceEncodedData() const { return false; }
301
302     Seconds freshnessLifetime(const ResourceResponse&) const;
303
304     void addAdditionalRequestHeaders(CachedResourceLoader&);
305     void failBeforeStarting();
306
307 protected:
308     ResourceLoaderOptions m_options;
309     ResourceRequest m_resourceRequest;
310     ResourceResponse m_response;
311
312     DeferrableOneShotTimer m_decodedDataDeletionTimer;
313
314     // FIXME: Make the rest of these data members private and use functions in derived classes instead.
315     HashCountedSet<CachedResourceClient*> m_clients;
316     std::unique_ptr<ResourceRequest> m_originalRequest; // Needed by Ping loads.
317     RefPtr<SubresourceLoader> m_loader;
318     RefPtr<SharedBuffer> m_data;
319
320 private:
321     MonotonicTime m_lastDecodedAccessTime; // Used as a "thrash guard" in the cache
322     PAL::SessionID m_sessionID;
323     RefPtr<const CookieJar> m_cookieJar;
324     WallTime m_responseTimestamp;
325     unsigned long m_identifierForLoadWithoutResourceLoader { 0 };
326
327     HashMap<CachedResourceClient*, std::unique_ptr<Callback>> m_clientsAwaitingCallback;
328
329     // These handles will need to be updated to point to the m_resourceToRevalidate in case we get 304 response.
330     HashSet<CachedResourceHandleBase*> m_handlesToRevalidate;
331
332     Vector<std::pair<String, String>> m_varyingHeaderValues;
333
334     // If this field is non-null we are using the resource as a proxy for checking whether an existing resource is still up to date
335     // using HTTP If-Modified-Since/If-None-Match headers. If the response is 304 all clients of this resource are moved
336     // to to be clients of m_resourceToRevalidate and the resource is deleted. If not, the field is zeroed and this
337     // resources becomes normal resource load.
338     CachedResource* m_resourceToRevalidate { nullptr };
339
340     // If this field is non-null, the resource has a proxy for checking whether it is still up to date (see m_resourceToRevalidate).
341     CachedResource* m_proxyResource { nullptr };
342
343     String m_fragmentIdentifierForRequest;
344
345     ResourceError m_error;
346     RefPtr<SecurityOrigin> m_origin;
347     AtomicString m_initiatorName;
348
349     RedirectChainCacheStatus m_redirectChainCacheStatus;
350
351     unsigned m_encodedSize { 0 };
352     unsigned m_decodedSize { 0 };
353     unsigned m_accessCount { 0 };
354     unsigned m_handleCount { 0 };
355     unsigned m_preloadCount { 0 };
356
357     unsigned m_status { Pending }; // Status
358
359     PreloadResult m_preloadResult { PreloadResult::PreloadNotReferenced };
360
361     ResourceResponse::Tainting m_responseTainting { ResourceResponse::Tainting::Basic };
362     ResourceLoadPriority m_loadPriority;
363
364     Type m_type; // Type
365
366     bool m_requestedFromNetworkingLayer { false };
367     bool m_inCache { false };
368     bool m_loading { false };
369     bool m_isLinkPreload { false };
370     bool m_hasUnknownEncoding { false };
371     bool m_switchingClientsToRevalidatedResource { false };
372     bool m_ignoreForRequestCount { false };
373
374 #ifndef NDEBUG
375     bool m_deleted { false };
376     unsigned m_lruIndex { 0 };
377 #endif
378 };
379
380 class CachedResource::Callback {
381 #if !COMPILER(MSVC)
382     WTF_MAKE_FAST_ALLOCATED;
383 #endif
384 public:
385     Callback(CachedResource&, CachedResourceClient&);
386
387     void cancel();
388
389 private:
390     void timerFired();
391
392     CachedResource& m_resource;
393     CachedResourceClient& m_client;
394     Timer m_timer;
395 };
396
397 } // namespace WebCore
398
399 #define SPECIALIZE_TYPE_TRAITS_CACHED_RESOURCE(ToClassName, CachedResourceType) \
400 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToClassName) \
401     static bool isType(const WebCore::CachedResource& resource) { return resource.type() == WebCore::CachedResourceType; } \
402 SPECIALIZE_TYPE_TRAITS_END()