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