CachedResourceLoader should set headers of the HTTP request prior checking for the...
[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 "SessionID.h"
34 #include "Timer.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 InspectorResource;
49 class MemoryCache;
50 class SecurityOrigin;
51 class SharedBuffer;
52 class SubresourceLoader;
53 class TextResourceDecoder;
54
55 // A resource that is held in the cache. Classes who want to use this object should derive
56 // from CachedResourceClient, to get the function calls in case the requested data has arrived.
57 // This class also does the actual communication with the loader to obtain the resource from the network.
58 class CachedResource {
59     WTF_MAKE_NONCOPYABLE(CachedResource); WTF_MAKE_FAST_ALLOCATED;
60     friend class MemoryCache;
61     friend class InspectorResource;
62
63 public:
64     enum Type {
65         MainResource,
66         ImageResource,
67         CSSStyleSheet,
68         Script,
69         FontResource,
70 #if ENABLE(SVG_FONTS)
71         SVGFontResource,
72 #endif
73         MediaResource,
74         RawResource,
75         SVGDocumentResource
76 #if ENABLE(XSLT)
77         , XSLStyleSheet
78 #endif
79 #if ENABLE(LINK_PREFETCH)
80         , LinkPrefetch
81         , LinkSubresource
82 #endif
83 #if ENABLE(VIDEO_TRACK)
84         , TextTrackResource
85 #endif
86     };
87
88     enum Status {
89         Unknown,      // let cache decide what to do with it
90         Pending,      // only partially loaded
91         Cached,       // regular case
92         LoadError,
93         DecodeError
94     };
95
96     CachedResource(CachedResourceRequest&&, Type, SessionID);
97     virtual ~CachedResource();
98
99     virtual void load(CachedResourceLoader&);
100
101     virtual void setEncoding(const String&) { }
102     virtual String encoding() const { return String(); }
103     virtual const TextResourceDecoder* textResourceDecoder() const { return nullptr; }
104     virtual void addDataBuffer(SharedBuffer&);
105     virtual void addData(const char* data, unsigned length);
106     virtual void finishLoading(SharedBuffer*);
107     virtual void error(CachedResource::Status);
108
109     void setResourceError(const ResourceError& error) { m_error = error; }
110     const ResourceError& resourceError() const { return m_error; }
111
112     virtual bool shouldIgnoreHTTPStatusCodeErrors() const { return false; }
113
114     const ResourceRequest& resourceRequest() const { return m_resourceRequest; }
115     ResourceRequest& resourceRequest() { return m_resourceRequest; }
116     const URL& url() const { return m_resourceRequest.url();}
117 #if ENABLE(CACHE_PARTITIONING)
118     const String& cachePartition() const { return m_resourceRequest.cachePartition(); }
119 #endif
120     SessionID sessionID() const { return m_sessionID; }
121     Type type() const { return m_type; }
122
123     ResourceLoadPriority loadPriority() const { return m_loadPriority; }
124     void setLoadPriority(const Optional<ResourceLoadPriority>&);
125
126     WEBCORE_EXPORT void addClient(CachedResourceClient&);
127     WEBCORE_EXPORT void removeClient(CachedResourceClient&);
128     bool hasClients() const { return !m_clients.isEmpty() || !m_clientsAwaitingCallback.isEmpty(); }
129     bool hasClient(CachedResourceClient& client) { return m_clients.contains(&client) || m_clientsAwaitingCallback.contains(&client); }
130     bool deleteIfPossible();
131
132     enum PreloadResult {
133         PreloadNotReferenced,
134         PreloadReferenced,
135         PreloadReferencedWhileLoading,
136         PreloadReferencedWhileComplete
137     };
138     PreloadResult preloadResult() const { return static_cast<PreloadResult>(m_preloadResult); }
139
140     virtual void didAddClient(CachedResourceClient&);
141     virtual void didRemoveClient(CachedResourceClient&) { }
142     virtual void allClientsRemoved() { }
143     void destroyDecodedDataIfNeeded();
144
145     unsigned count() const { return m_clients.size(); }
146
147     Status status() const { return static_cast<Status>(m_status); }
148     void setStatus(Status status) { m_status = status; }
149
150     unsigned size() const { return encodedSize() + decodedSize() + overheadSize(); }
151     unsigned encodedSize() const { return m_encodedSize; }
152     unsigned decodedSize() const { return m_decodedSize; }
153     unsigned overheadSize() const;
154
155     bool isLoaded() const { return !m_loading; } // FIXME. Method name is inaccurate. Loading might not have started yet.
156
157     bool isLoading() const { return m_loading; }
158     void setLoading(bool b) { m_loading = b; }
159     virtual bool stillNeedsLoad() const { return false; }
160
161     SubresourceLoader* loader() { return m_loader.get(); }
162
163     bool areAllClientsXMLHttpRequests() const;
164
165     bool isImage() const { return type() == ImageResource; }
166     // FIXME: CachedRawResource could be a main resource, an audio/video resource, or a raw XHR/icon resource.
167     bool isMainOrMediaOrRawResource() const { return type() == MainResource || type() == MediaResource || type() == RawResource; }
168     bool ignoreForRequestCount() const
169     {
170         return m_resourceRequest.ignoreForRequestCount()
171             || type() == MainResource
172 #if ENABLE(LINK_PREFETCH)
173             || type() == LinkPrefetch
174             || type() == LinkSubresource
175 #endif
176             || type() == RawResource;
177     }
178
179     unsigned accessCount() const { return m_accessCount; }
180     void increaseAccessCount() { m_accessCount++; }
181
182     // Computes the status of an object after loading.
183     // Updates the expire date on the cache entry file
184     void finish();
185
186     // Called by the cache if the object has been removed from the cache
187     // while still being referenced. This means the object should delete itself
188     // if the number of clients observing it ever drops to 0.
189     // The resource can be brought back to cache after successful revalidation.
190     void setInCache(bool inCache) { m_inCache = inCache; }
191     bool inCache() const { return m_inCache; }
192
193     void clearLoader();
194
195     SharedBuffer* resourceBuffer() const { return m_data.get(); }
196
197     virtual void redirectReceived(ResourceRequest&, const ResourceResponse&);
198     virtual void responseReceived(const ResourceResponse&);
199     virtual bool shouldCacheResponse(const ResourceResponse&) { return true; }
200     void setResponse(const ResourceResponse&);
201     const ResourceResponse& response() const { return m_response; }
202
203     void setCrossOrigin();
204     bool isCrossOrigin() const;
205     bool isCORSSameOrigin() const;
206     ResourceResponse::Tainting responseTainting() const { return m_responseTainting; }
207
208     void loadFrom(const CachedResource&);
209
210     SecurityOrigin* origin() const { return m_origin.get(); }
211
212     bool canDelete() const { return !hasClients() && !m_loader && !m_preloadCount && !m_handleCount && !m_resourceToRevalidate && !m_proxyResource; }
213     bool hasOneHandle() const { return m_handleCount == 1; }
214
215     bool isExpired() const;
216
217     void cancelLoad();
218     bool wasCanceled() const { return m_error.isCancellation(); }
219     bool errorOccurred() const { return m_status == LoadError || m_status == DecodeError; }
220     bool loadFailedOrCanceled() const { return !m_error.isNull(); }
221
222     bool shouldSendResourceLoadCallbacks() const { return m_options.sendLoadCallbacks == SendCallbacks; }
223     DataBufferingPolicy dataBufferingPolicy() const { return m_options.dataBufferingPolicy; }
224
225     bool allowsCaching() const { return m_options.cachingPolicy == CachingPolicy::AllowCaching; }
226     const FetchOptions& options() const { return m_options; }
227
228     virtual void destroyDecodedData() { }
229
230     void setOwningCachedResourceLoader(CachedResourceLoader* cachedResourceLoader) { m_owningCachedResourceLoader = cachedResourceLoader; }
231
232     bool isPreloaded() const { return m_preloadCount; }
233     void increasePreloadCount() { ++m_preloadCount; }
234     void decreasePreloadCount() { ASSERT(m_preloadCount); --m_preloadCount; }
235
236     void registerHandle(CachedResourceHandleBase*);
237     WEBCORE_EXPORT void unregisterHandle(CachedResourceHandleBase*);
238
239     bool canUseCacheValidator() const;
240
241     enum class RevalidationDecision { No, YesDueToCachePolicy, YesDueToNoStore, YesDueToNoCache, YesDueToExpired };
242     virtual RevalidationDecision makeRevalidationDecision(CachePolicy) const;
243     bool redirectChainAllowsReuse(ReuseExpiredRedirectionOrNot) const;
244     bool hasRedirections() const { return m_redirectChainCacheStatus.status != RedirectChainCacheStatus::Status::NoRedirection;  }
245
246     bool varyHeaderValuesMatch(const ResourceRequest&);
247
248     bool isCacheValidator() const { return m_resourceToRevalidate; }
249     CachedResource* resourceToRevalidate() const { return m_resourceToRevalidate; }
250
251     // HTTP revalidation support methods for CachedResourceLoader.
252     void setResourceToRevalidate(CachedResource*);
253     virtual void switchClientsToRevalidatedResource();
254     void clearResourceToRevalidate();
255     void updateResponseAfterRevalidation(const ResourceResponse& validatingResponse);
256     bool validationInProgress() const { return m_proxyResource; }
257     bool validationCompleting() const { return m_proxyResource && m_proxyResource->m_switchingClientsToRevalidatedResource; }
258
259     virtual void didSendData(unsigned long long /* bytesSent */, unsigned long long /* totalBytesToBeSent */) { }
260
261     void setLoadFinishTime(double finishTime) { m_loadFinishTime = finishTime; }
262     double loadFinishTime() const { return m_loadFinishTime; }
263
264 #if USE(FOUNDATION) || USE(SOUP)
265     WEBCORE_EXPORT void tryReplaceEncodedData(SharedBuffer&);
266 #endif
267
268 #if USE(SOUP)
269     virtual char* getOrCreateReadBuffer(size_t /* requestedSize */, size_t& /* actualSize */) { return nullptr; }
270 #endif
271
272     unsigned long identifierForLoadWithoutResourceLoader() const { return m_identifierForLoadWithoutResourceLoader; }
273     static ResourceLoadPriority defaultPriorityForResourceType(Type);
274
275 protected:
276     // CachedResource constructor that may be used when the CachedResource can already be filled with response data.
277     CachedResource(const URL&, Type, SessionID);
278
279     void setEncodedSize(unsigned);
280     void setDecodedSize(unsigned);
281     void didAccessDecodedData(double timeStamp);
282
283     virtual void didReplaceSharedBufferContents() { }
284
285     // FIXME: Make the rest of these data members private and use functions in derived classes instead.
286     HashCountedSet<CachedResourceClient*> m_clients;
287     ResourceRequest m_resourceRequest;
288     RefPtr<SubresourceLoader> m_loader;
289     ResourceLoaderOptions m_options;
290     ResourceResponse m_response;
291     ResourceResponse::Tainting m_responseTainting { ResourceResponse::Tainting::Basic };
292     RefPtr<SharedBuffer> m_data;
293     DeferrableOneShotTimer m_decodedDataDeletionTimer;
294
295 private:
296     class Callback;
297
298     bool addClientToSet(CachedResourceClient&);
299
300     void decodedDataDeletionTimerFired();
301
302     virtual void checkNotify();
303     virtual bool mayTryReplaceEncodedData() const { return false; }
304     virtual void setBodyDataFrom(const CachedResource&);
305
306     std::chrono::microseconds freshnessLifetime(const ResourceResponse&) const;
307
308     void addAdditionalRequestHeaders(CachedResourceLoader&);
309     void failBeforeStarting();
310
311     HashMap<CachedResourceClient*, std::unique_ptr<Callback>> m_clientsAwaitingCallback;
312     SessionID m_sessionID;
313     ResourceLoadPriority m_loadPriority;
314     std::chrono::system_clock::time_point m_responseTimestamp;
315
316     String m_fragmentIdentifierForRequest;
317
318     ResourceError m_error;
319     RefPtr<SecurityOrigin> m_origin;
320
321     double m_lastDecodedAccessTime { 0 }; // Used as a "thrash guard" in the cache
322     double m_loadFinishTime { 0 };
323
324     unsigned m_encodedSize { 0 };
325     unsigned m_decodedSize { 0 };
326     unsigned m_accessCount { 0 };
327     unsigned m_handleCount { 0 };
328     unsigned m_preloadCount { 0 };
329
330     PreloadResult m_preloadResult { PreloadNotReferenced };
331
332     bool m_requestedFromNetworkingLayer { false };
333
334     bool m_inCache { false };
335     bool m_loading { false };
336
337     bool m_switchingClientsToRevalidatedResource { false };
338
339     Type m_type; // Type
340     unsigned m_status { Pending }; // Status
341
342 #ifndef NDEBUG
343     bool m_deleted { false };
344     unsigned m_lruIndex { 0 };
345 #endif
346
347     CachedResourceLoader* m_owningCachedResourceLoader { nullptr }; // only non-null for resources that are not in the cache
348
349     // 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
350     // using HTTP If-Modified-Since/If-None-Match headers. If the response is 304 all clients of this resource are moved
351     // to to be clients of m_resourceToRevalidate and the resource is deleted. If not, the field is zeroed and this
352     // resources becomes normal resource load.
353     CachedResource* m_resourceToRevalidate { nullptr };
354
355     // If this field is non-null, the resource has a proxy for checking whether it is still up to date (see m_resourceToRevalidate).
356     CachedResource* m_proxyResource { nullptr };
357
358     // These handles will need to be updated to point to the m_resourceToRevalidate in case we get 304 response.
359     HashSet<CachedResourceHandleBase*> m_handlesToRevalidate;
360
361     RedirectChainCacheStatus m_redirectChainCacheStatus;
362
363     Vector<std::pair<String, String>> m_varyingHeaderValues;
364
365     unsigned long m_identifierForLoadWithoutResourceLoader { 0 };
366 };
367
368 class CachedResource::Callback {
369 #if !COMPILER(MSVC)
370     WTF_MAKE_FAST_ALLOCATED;
371 #endif
372 public:
373     Callback(CachedResource&, CachedResourceClient&);
374
375     void cancel();
376
377 private:
378     void timerFired();
379
380     CachedResource& m_resource;
381     CachedResourceClient& m_client;
382     Timer m_timer;
383 };
384
385 } // namespace WebCore
386
387 #define SPECIALIZE_TYPE_TRAITS_CACHED_RESOURCE(ToClassName, CachedResourceType) \
388 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToClassName) \
389     static bool isType(const WebCore::CachedResource& resource) { return resource.type() == WebCore::CachedResourceType; } \
390 SPECIALIZE_TYPE_TRAITS_END()