Part 2 of removing PlatformString.h, remove PlatformString.h
[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 "PurgePriority.h"
29 #include "ResourceLoadPriority.h"
30 #include "ResourceLoaderOptions.h"
31 #include "ResourceRequest.h"
32 #include "ResourceResponse.h"
33 #include "Timer.h"
34 #include <time.h>
35 #include <wtf/HashCountedSet.h>
36 #include <wtf/HashSet.h>
37 #include <wtf/OwnPtr.h>
38 #include <wtf/Vector.h>
39 #include <wtf/text/WTFString.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 MemoryObjectInfo;
51 class PurgeableBuffer;
52 class SecurityOrigin;
53 class SubresourceLoader;
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         ImageResource,
66         CSSStyleSheet,
67         Script,
68         FontResource,
69         RawResource
70 #if ENABLE(SVG)
71         , SVGDocumentResource
72 #endif
73 #if ENABLE(XSLT)
74         , XSLStyleSheet
75 #endif
76 #if ENABLE(LINK_PREFETCH)
77         , LinkPrefetch
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     bool 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 didRemoveClient(CachedResourceClient*) { }
131     virtual void allClientsRemoved() { }
132     void destroyDecodedDataIfNeeded();
133
134     unsigned count() const { return m_clients.size(); }
135
136     Status status() const { return static_cast<Status>(m_status); }
137     void setStatus(Status status) { m_status = status; }
138
139     unsigned size() const { return encodedSize() + decodedSize() + overheadSize(); }
140     unsigned encodedSize() const { return m_encodedSize; }
141     unsigned decodedSize() const { return m_decodedSize; }
142     unsigned overheadSize() const;
143     
144     bool isLoaded() const { return !m_loading; } // FIXME. Method name is inaccurate. Loading might not have started yet.
145
146     bool isLoading() const { return m_loading; }
147     void setLoading(bool b) { m_loading = b; }
148
149     virtual bool isImage() const { return false; }
150     bool ignoreForRequestCount() const
151     {
152         return false
153 #if ENABLE(LINK_PREFETCH)
154             || type() == LinkPrefetch
155             || type() == LinkSubresource
156 #endif
157             || type() == RawResource;
158     }
159
160     unsigned accessCount() const { return m_accessCount; }
161     void increaseAccessCount() { m_accessCount++; }
162
163     // Computes the status of an object after loading.  
164     // Updates the expire date on the cache entry file
165     void finish();
166
167     bool passesAccessControlCheck(SecurityOrigin*);
168
169     // Called by the cache if the object has been removed from the cache
170     // while still being referenced. This means the object should delete itself
171     // if the number of clients observing it ever drops to 0.
172     // The resource can be brought back to cache after successful revalidation.
173     void setInCache(bool inCache) { m_inCache = inCache; }
174     bool inCache() const { return m_inCache; }
175     
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     bool loadFailedOrCanceled() { return m_status == Canceled || m_status == LoadError; }
210
211     bool sendResourceLoadCallbacks() const { return m_options.sendLoadCallbacks == SendCallbacks; }
212     
213     virtual void destroyDecodedData() { }
214
215     void setOwningCachedResourceLoader(CachedResourceLoader* cachedResourceLoader) { m_owningCachedResourceLoader = cachedResourceLoader; }
216     
217     // MemoryCache does not destroy the decoded data of a CachedResource if the decoded data will be likely used.
218     virtual bool likelyToBeUsedSoon() { return false; }
219
220     bool isPreloaded() const { return m_preloadCount; }
221     void increasePreloadCount() { ++m_preloadCount; }
222     void decreasePreloadCount() { ASSERT(m_preloadCount); --m_preloadCount; }
223     
224     void registerHandle(CachedResourceHandleBase* h);
225     void unregisterHandle(CachedResourceHandleBase* h);
226     
227     bool canUseCacheValidator() const;
228     bool mustRevalidateDueToCacheHeaders(CachePolicy) const;
229     bool isCacheValidator() const { return m_resourceToRevalidate; }
230     CachedResource* resourceToRevalidate() const { return m_resourceToRevalidate; }
231     
232     bool isPurgeable() const;
233     bool wasPurged() const;
234     
235     // This is used by the archive machinery to get at a purged resource without
236     // triggering a load. We should make it protected again if we can find a
237     // better way to handle the archive case.
238     bool makePurgeable(bool purgeable);
239     
240     // HTTP revalidation support methods for CachedResourceLoader.
241     void setResourceToRevalidate(CachedResource*);
242     void switchClientsToRevalidatedResource();
243     void clearResourceToRevalidate();
244     void updateResponseAfterRevalidation(const ResourceResponse& validatingResponse);
245     
246     virtual void didSendData(unsigned long long /* bytesSent */, unsigned long long /* totalBytesToBeSent */) { }
247 #if PLATFORM(CHROMIUM)
248     virtual void didDownloadData(int) { }
249 #endif
250
251     void setLoadFinishTime(double finishTime) { m_loadFinishTime = finishTime; }
252     double loadFinishTime() const { return m_loadFinishTime; }
253
254     virtual void reportMemoryUsage(MemoryObjectInfo*) const;
255
256 protected:
257     virtual void checkNotify();
258
259     void setEncodedSize(unsigned);
260     void setDecodedSize(unsigned);
261     void didAccessDecodedData(double timeStamp);
262
263     bool isSafeToMakePurgeable() const;
264     
265     HashCountedSet<CachedResourceClient*> m_clients;
266
267     class CachedResourceCallback {
268     public:
269         static PassOwnPtr<CachedResourceCallback> schedule(CachedResource* resource, CachedResourceClient* client) { return adoptPtr(new CachedResourceCallback(resource, client)); }
270         void cancel();
271     private:
272         CachedResourceCallback(CachedResource*, CachedResourceClient*);
273         void timerFired(Timer<CachedResourceCallback>*);
274
275         CachedResource* m_resource;
276         CachedResourceClient* m_client;
277         Timer<CachedResourceCallback> m_callbackTimer;
278     };
279     HashMap<CachedResourceClient*, OwnPtr<CachedResourceCallback> > m_clientsAwaitingCallback;
280
281     bool hasClient(CachedResourceClient* client) { return m_clients.contains(client) || m_clientsAwaitingCallback.contains(client); }
282
283     ResourceRequest m_resourceRequest;
284     String m_accept;
285     RefPtr<SubresourceLoader> m_loader;
286     ResourceLoaderOptions m_options;
287     ResourceLoadPriority m_loadPriority;
288
289     ResourceResponse m_response;
290     double m_responseTimestamp;
291
292     RefPtr<SharedBuffer> m_data;
293     OwnPtr<PurgeableBuffer> m_purgeableData;
294     Timer<CachedResource> m_decodedDataDeletionTimer;
295
296 private:
297     bool addClientToSet(CachedResourceClient*);
298     void decodedDataDeletionTimerFired(Timer<CachedResource>*);
299
300     virtual PurgePriority purgePriority() const { return PurgeDefault; }
301
302     double currentAge() const;
303     double freshnessLifetime() const;
304
305     RefPtr<CachedMetadata> m_cachedMetadata;
306
307     double m_lastDecodedAccessTime; // Used as a "thrash guard" in the cache
308     double m_loadFinishTime;
309
310     unsigned m_encodedSize;
311     unsigned m_decodedSize;
312     unsigned m_accessCount;
313     unsigned m_handleCount;
314     unsigned m_preloadCount;
315
316     unsigned m_preloadResult : 2; // PreloadResult
317
318     bool m_inLiveDecodedResourcesList : 1;
319     bool m_requestedFromNetworkingLayer : 1;
320
321     bool m_inCache : 1;
322     bool m_loading : 1;
323
324     bool m_switchingClientsToRevalidatedResource : 1;
325
326     unsigned m_type : 4; // Type
327     unsigned m_status : 3; // Status
328
329 #ifndef NDEBUG
330     bool m_deleted;
331     unsigned m_lruIndex;
332 #endif
333
334     CachedResource* m_nextInAllResourcesList;
335     CachedResource* m_prevInAllResourcesList;
336     
337     CachedResource* m_nextInLiveResourcesList;
338     CachedResource* m_prevInLiveResourcesList;
339
340     CachedResourceLoader* m_owningCachedResourceLoader; // only non-0 for resources that are not in the cache
341     
342     // 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
343     // using HTTP If-Modified-Since/If-None-Match headers. If the response is 304 all clients of this resource are moved
344     // to to be clients of m_resourceToRevalidate and the resource is deleted. If not, the field is zeroed and this
345     // resources becomes normal resource load.
346     CachedResource* m_resourceToRevalidate;
347
348     // If this field is non-null, the resource has a proxy for checking whether it is still up to date (see m_resourceToRevalidate).
349     CachedResource* m_proxyResource;
350
351     // These handles will need to be updated to point to the m_resourceToRevalidate in case we get 304 response.
352     HashSet<CachedResourceHandleBase*> m_handlesToRevalidate;
353 };
354
355 }
356
357 #endif