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