Unreviewed, rolling out r112201.
[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 "FrameLoaderTypes.h"
28 #include "PlatformString.h"
29 #include "PurgePriority.h"
30 #include "ResourceLoaderOptions.h"
31 #include "ResourceLoadPriority.h"
32 #include "ResourceRequest.h"
33 #include "ResourceResponse.h"
34 #include "Timer.h"
35 #include <wtf/HashCountedSet.h>
36 #include <wtf/HashSet.h>
37 #include <wtf/OwnPtr.h>
38 #include <wtf/Vector.h>
39 #include <time.h>
40
41 namespace WebCore {
42
43 class MemoryCache;
44 class CachedMetadata;
45 class CachedResourceClient;
46 class CachedResourceHandleBase;
47 class CachedResourceLoader;
48 class Frame;
49 class InspectorResource;
50 class PurgeableBuffer;
51 class SecurityOrigin;
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         ImageResource,
65         CSSStyleSheet,
66         Script,
67         FontResource,
68         RawResource
69 #if ENABLE(SVG)
70         , SVGDocumentResource
71 #endif
72 #if ENABLE(XSLT)
73         , XSLStyleSheet
74 #endif
75 #if ENABLE(LINK_PREFETCH)
76         , LinkPrefetch
77         , LinkPrerender
78         , LinkSubresource
79 #endif
80 #if ENABLE(VIDEO_TRACK)
81         , TextTrackResource
82 #endif
83 #if ENABLE(CSS_SHADERS)
84         , ShaderResource
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         Canceled,
93         LoadError,
94         DecodeError
95     };
96
97     CachedResource(const ResourceRequest&, Type);
98     virtual ~CachedResource();
99
100     virtual void load(CachedResourceLoader*, const ResourceLoaderOptions&);
101
102     virtual void setEncoding(const String&) { }
103     virtual String encoding() const { return String(); }
104     virtual void data(PassRefPtr<SharedBuffer> data, bool allDataReceived);
105     virtual void error(CachedResource::Status);
106
107     virtual bool shouldIgnoreHTTPStatusCodeErrors() const { return false; }
108
109     ResourceRequest& resourceRequest() { return m_resourceRequest; }
110     const KURL& url() const { return m_resourceRequest.url();}
111     Type type() const { return static_cast<Type>(m_type); }
112     
113     ResourceLoadPriority loadPriority() const { return m_loadPriority; }
114     void setLoadPriority(ResourceLoadPriority);
115
116     void addClient(CachedResourceClient*);
117     void removeClient(CachedResourceClient*);
118     bool hasClients() const { return !m_clients.isEmpty() || !m_clientsAwaitingCallback.isEmpty(); }
119     void deleteIfPossible();
120
121     enum PreloadResult {
122         PreloadNotReferenced,
123         PreloadReferenced,
124         PreloadReferencedWhileLoading,
125         PreloadReferencedWhileComplete
126     };
127     PreloadResult preloadResult() const { return static_cast<PreloadResult>(m_preloadResult); }
128
129     virtual void didAddClient(CachedResourceClient*);
130     virtual void allClientsRemoved() { }
131
132     unsigned count() const { return m_clients.size(); }
133
134     Status status() const { return static_cast<Status>(m_status); }
135     void setStatus(Status status) { m_status = status; }
136
137     unsigned size() const { return encodedSize() + decodedSize() + overheadSize(); }
138     unsigned encodedSize() const { return m_encodedSize; }
139     unsigned decodedSize() const { return m_decodedSize; }
140     unsigned overheadSize() const;
141     
142     bool isLoaded() const { return !m_loading; } // FIXME. Method name is inaccurate. Loading might not have started yet.
143
144     bool isLoading() const { return m_loading; }
145     void setLoading(bool b) { m_loading = b; }
146
147     virtual bool isImage() const { return false; }
148     bool ignoreForRequestCount() const
149     {
150         return false
151 #if ENABLE(LINK_PREFETCH)
152             || type() == LinkPrefetch
153             || type() == LinkPrerender
154             || type() == LinkSubresource
155 #endif
156             || type() == RawResource;
157     }
158
159     unsigned accessCount() const { return m_accessCount; }
160     void increaseAccessCount() { m_accessCount++; }
161
162     // Computes the status of an object after loading.  
163     // Updates the expire date on the cache entry file
164     void finish();
165
166     bool passesAccessControlCheck(SecurityOrigin*);
167
168     // Called by the cache if the object has been removed from the cache
169     // while still being referenced. This means the object should delete itself
170     // if the number of clients observing it ever drops to 0.
171     // The resource can be brought back to cache after successful revalidation.
172     void setInCache(bool inCache) { m_inCache = inCache; }
173     bool inCache() const { return m_inCache; }
174     
175     void setInLiveDecodedResourcesList(bool b) { m_inLiveDecodedResourcesList = b; }
176     bool inLiveDecodedResourcesList() { return m_inLiveDecodedResourcesList; }
177     
178     void stopLoading();
179
180     SharedBuffer* data() const { ASSERT(!m_purgeableData); return m_data.get(); }
181
182     virtual void willSendRequest(ResourceRequest&, const ResourceResponse&) { m_requestedFromNetworkingLayer = true; }
183     virtual void setResponse(const ResourceResponse&);
184     const ResourceResponse& response() const { return m_response; }
185
186     // Sets the serialized metadata retrieved from the platform's cache.
187     void setSerializedCachedMetadata(const char*, size_t);
188
189     // Caches the given metadata in association with this resource and suggests
190     // that the platform persist it. The dataTypeID is a pseudo-randomly chosen
191     // identifier that is used to distinguish data generated by the caller.
192     void setCachedMetadata(unsigned dataTypeID, const char*, size_t);
193
194     // Returns cached metadata of the given type associated with this resource.
195     CachedMetadata* cachedMetadata(unsigned dataTypeID) const;
196
197     bool canDelete() const { return !hasClients() && !m_loader && !m_preloadCount && !m_handleCount && !m_resourceToRevalidate && !m_proxyResource; }
198     bool hasOneHandle() const { return m_handleCount == 1; }
199
200     bool isExpired() const;
201
202     // List of acceptable MIME types separated by ",".
203     // A MIME type may contain a wildcard, e.g. "text/*".
204     String accept() const { return m_accept; }
205     void setAccept(const String& accept) { m_accept = accept; }
206
207     bool wasCanceled() const { return m_status == Canceled; }
208     bool errorOccurred() const { return (m_status == LoadError || m_status == DecodeError); }
209
210     bool sendResourceLoadCallbacks() const { return m_options.sendLoadCallbacks == SendCallbacks; }
211     
212     virtual void destroyDecodedData() { }
213
214     void setOwningCachedResourceLoader(CachedResourceLoader* cachedResourceLoader) { m_owningCachedResourceLoader = cachedResourceLoader; }
215     
216     bool isPreloaded() const { return m_preloadCount; }
217     void increasePreloadCount() { ++m_preloadCount; }
218     void decreasePreloadCount() { ASSERT(m_preloadCount); --m_preloadCount; }
219     
220     void registerHandle(CachedResourceHandleBase* h);
221     void unregisterHandle(CachedResourceHandleBase* h);
222     
223     bool canUseCacheValidator() const;
224     bool mustRevalidateDueToCacheHeaders(CachePolicy) const;
225     bool isCacheValidator() const { return m_resourceToRevalidate; }
226     CachedResource* resourceToRevalidate() const { return m_resourceToRevalidate; }
227     
228     bool isPurgeable() const;
229     bool wasPurged() const;
230     
231     // This is used by the archive machinery to get at a purged resource without
232     // triggering a load. We should make it protected again if we can find a
233     // better way to handle the archive case.
234     bool makePurgeable(bool purgeable);
235     
236     // HTTP revalidation support methods for CachedResourceLoader.
237     void setResourceToRevalidate(CachedResource*);
238     void switchClientsToRevalidatedResource();
239     void clearResourceToRevalidate();
240     void updateResponseAfterRevalidation(const ResourceResponse& validatingResponse);
241     
242     virtual void didSendData(unsigned long long /* bytesSent */, unsigned long long /* totalBytesToBeSent */) { }
243 #if PLATFORM(CHROMIUM)
244     virtual void didDownloadData(int) { }
245 #endif
246
247     void setLoadFinishTime(double finishTime) { m_loadFinishTime = finishTime; }
248     double loadFinishTime() const { return m_loadFinishTime; }
249
250 protected:
251     void checkNotify();
252
253     void setEncodedSize(unsigned);
254     void setDecodedSize(unsigned);
255     void didAccessDecodedData(double timeStamp);
256
257     bool isSafeToMakePurgeable() const;
258     
259     HashCountedSet<CachedResourceClient*> m_clients;
260
261     class CachedResourceCallback {
262     public:
263         static PassOwnPtr<CachedResourceCallback> schedule(CachedResource* resource, CachedResourceClient* client) { return adoptPtr(new CachedResourceCallback(resource, client)); }
264         void cancel();
265     private:
266         CachedResourceCallback(CachedResource*, CachedResourceClient*);
267         void timerFired(Timer<CachedResourceCallback>*);
268
269         CachedResource* m_resource;
270         CachedResourceClient* m_client;
271         Timer<CachedResourceCallback> m_callbackTimer;
272     };
273     HashMap<CachedResourceClient*, OwnPtr<CachedResourceCallback> > m_clientsAwaitingCallback;
274
275     bool hasClient(CachedResourceClient* client) { return m_clients.contains(client) || m_clientsAwaitingCallback.contains(client); }
276
277     ResourceRequest m_resourceRequest;
278     String m_accept;
279     RefPtr<SubresourceLoader> m_loader;
280     ResourceLoaderOptions m_options;
281     ResourceLoadPriority m_loadPriority;
282
283     ResourceResponse m_response;
284     double m_responseTimestamp;
285
286     RefPtr<SharedBuffer> m_data;
287     OwnPtr<PurgeableBuffer> m_purgeableData;
288
289 private:
290     bool addClientToSet(CachedResourceClient*);
291
292     virtual PurgePriority purgePriority() const { return PurgeDefault; }
293
294     double currentAge() const;
295     double freshnessLifetime() const;
296
297     RefPtr<CachedMetadata> m_cachedMetadata;
298
299     double m_lastDecodedAccessTime; // Used as a "thrash guard" in the cache
300     double m_loadFinishTime;
301
302     unsigned m_encodedSize;
303     unsigned m_decodedSize;
304     unsigned m_accessCount;
305     unsigned m_handleCount;
306     unsigned m_preloadCount;
307
308     unsigned m_preloadResult : 2; // PreloadResult
309
310     bool m_inLiveDecodedResourcesList : 1;
311     bool m_requestedFromNetworkingLayer : 1;
312
313     bool m_inCache : 1;
314     bool m_loading : 1;
315
316     bool m_switchingClientsToRevalidatedResource : 1;
317
318     unsigned m_type : 4; // Type
319     unsigned m_status : 3; // Status
320
321 #ifndef NDEBUG
322     bool m_deleted;
323     unsigned m_lruIndex;
324 #endif
325
326     CachedResource* m_nextInAllResourcesList;
327     CachedResource* m_prevInAllResourcesList;
328     
329     CachedResource* m_nextInLiveResourcesList;
330     CachedResource* m_prevInLiveResourcesList;
331
332     CachedResourceLoader* m_owningCachedResourceLoader; // only non-0 for resources that are not in the cache
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;
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;
342
343     // These handles will need to be updated to point to the m_resourceToRevalidate in case we get 304 response.
344     HashSet<CachedResourceHandleBase*> m_handlesToRevalidate;
345 };
346
347 }
348
349 #endif