Use the term icon instead of favicon
[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 LoadTiming;
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
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         MediaResource,
73         RawResource,
74         Icon,
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     const String& cachePartition() const { return m_resourceRequest.cachePartition(); }
118     SessionID sessionID() const { return m_sessionID; }
119     Type type() const { return m_type; }
120
121     ResourceLoadPriority loadPriority() const { return m_loadPriority; }
122     void setLoadPriority(const std::optional<ResourceLoadPriority>&);
123
124     WEBCORE_EXPORT void addClient(CachedResourceClient&);
125     WEBCORE_EXPORT void removeClient(CachedResourceClient&);
126     bool hasClients() const { return !m_clients.isEmpty() || !m_clientsAwaitingCallback.isEmpty(); }
127     bool hasClient(CachedResourceClient& client) { return m_clients.contains(&client) || m_clientsAwaitingCallback.contains(&client); }
128     bool deleteIfPossible();
129
130     enum PreloadResult {
131         PreloadNotReferenced,
132         PreloadReferenced,
133         PreloadReferencedWhileLoading,
134         PreloadReferencedWhileComplete
135     };
136     PreloadResult preloadResult() const { return static_cast<PreloadResult>(m_preloadResult); }
137
138     virtual void didAddClient(CachedResourceClient&);
139     virtual void didRemoveClient(CachedResourceClient&) { }
140     virtual void allClientsRemoved() { }
141     void destroyDecodedDataIfNeeded();
142
143     unsigned count() const { return m_clients.size(); }
144
145     Status status() const { return static_cast<Status>(m_status); }
146     void setStatus(Status status) { m_status = status; }
147
148     unsigned size() const { return encodedSize() + decodedSize() + overheadSize(); }
149     unsigned encodedSize() const { return m_encodedSize; }
150     unsigned decodedSize() const { return m_decodedSize; }
151     unsigned overheadSize() const;
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 areAllClientsXMLHttpRequests() const;
162
163     bool isImage() const { return type() == ImageResource; }
164     // FIXME: CachedRawResource could be a main resource, an audio/video resource, or a raw XHR/icon resource.
165     bool isMainOrMediaOrIconOrRawResource() const { return type() == MainResource || type() == MediaResource || type() == Icon || type() == RawResource; }
166     bool ignoreForRequestCount() const
167     {
168         return m_resourceRequest.ignoreForRequestCount()
169             || type() == MainResource
170 #if ENABLE(LINK_PREFETCH)
171             || type() == LinkPrefetch
172             || type() == LinkSubresource
173 #endif
174             || type() == Icon
175             || type() == RawResource;
176     }
177
178     unsigned accessCount() const { return m_accessCount; }
179     void increaseAccessCount() { m_accessCount++; }
180
181     // Computes the status of an object after loading.
182     // Updates the expire date on the cache entry file
183     void finish();
184
185     // Called by the cache if the object has been removed from the cache
186     // while still being referenced. This means the object should delete itself
187     // if the number of clients observing it ever drops to 0.
188     // The resource can be brought back to cache after successful revalidation.
189     void setInCache(bool inCache) { m_inCache = inCache; }
190     bool inCache() const { return m_inCache; }
191
192     void clearLoader();
193
194     SharedBuffer* resourceBuffer() const { return m_data.get(); }
195
196     virtual void redirectReceived(ResourceRequest&, const ResourceResponse&);
197     virtual void responseReceived(const ResourceResponse&);
198     virtual bool shouldCacheResponse(const ResourceResponse&) { return true; }
199     void setResponse(const ResourceResponse&);
200     const ResourceResponse& response() const { return m_response; }
201
202     void setCrossOrigin();
203     bool isCrossOrigin() const;
204     bool isCORSSameOrigin() const;
205     ResourceResponse::Tainting responseTainting() const { return m_responseTainting; }
206
207     void loadFrom(const CachedResource&);
208
209     SecurityOrigin* origin() const { return m_origin.get(); }
210     AtomicString initiatorName() const { return m_initiatorName; }
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     bool isLinkPreload() { return m_isLinkPreload; }
236     void setLinkPreload() { m_isLinkPreload = true; }
237     bool hasUnknownEncoding() { return m_hasUnknownEncoding; }
238     void setHasUnknownEncoding(bool hasUnknownEncoding) { m_hasUnknownEncoding = hasUnknownEncoding; }
239
240     void registerHandle(CachedResourceHandleBase*);
241     WEBCORE_EXPORT void unregisterHandle(CachedResourceHandleBase*);
242
243     bool canUseCacheValidator() const;
244
245     enum class RevalidationDecision { No, YesDueToCachePolicy, YesDueToNoStore, YesDueToNoCache, YesDueToExpired };
246     virtual RevalidationDecision makeRevalidationDecision(CachePolicy) const;
247     bool redirectChainAllowsReuse(ReuseExpiredRedirectionOrNot) const;
248     bool hasRedirections() const { return m_redirectChainCacheStatus.status != RedirectChainCacheStatus::Status::NoRedirection;  }
249
250     bool varyHeaderValuesMatch(const ResourceRequest&);
251
252     bool isCacheValidator() const { return m_resourceToRevalidate; }
253     CachedResource* resourceToRevalidate() const { return m_resourceToRevalidate; }
254
255     // HTTP revalidation support methods for CachedResourceLoader.
256     void setResourceToRevalidate(CachedResource*);
257     virtual void switchClientsToRevalidatedResource();
258     void clearResourceToRevalidate();
259     void updateResponseAfterRevalidation(const ResourceResponse& validatingResponse);
260     bool validationInProgress() const { return m_proxyResource; }
261     bool validationCompleting() const { return m_proxyResource && m_proxyResource->m_switchingClientsToRevalidatedResource; }
262
263     virtual void didSendData(unsigned long long /* bytesSent */, unsigned long long /* totalBytesToBeSent */) { }
264
265     virtual void didRetrieveDerivedDataFromCache(const String& /* type */, SharedBuffer&) { }
266
267 #if USE(FOUNDATION) || USE(SOUP)
268     WEBCORE_EXPORT void tryReplaceEncodedData(SharedBuffer&);
269 #endif
270
271 #if USE(SOUP)
272     virtual char* getOrCreateReadBuffer(size_t /* requestedSize */, size_t& /* actualSize */) { return nullptr; }
273 #endif
274
275     unsigned long identifierForLoadWithoutResourceLoader() const { return m_identifierForLoadWithoutResourceLoader; }
276     static ResourceLoadPriority defaultPriorityForResourceType(Type);
277
278 protected:
279     // CachedResource constructor that may be used when the CachedResource can already be filled with response data.
280     CachedResource(const URL&, Type, SessionID);
281
282     void setEncodedSize(unsigned);
283     void setDecodedSize(unsigned);
284     void didAccessDecodedData(double timeStamp);
285
286     virtual void didReplaceSharedBufferContents() { }
287
288     virtual void setBodyDataFrom(const CachedResource&);
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     RefPtr<SharedBuffer> m_data;
298     DeferrableOneShotTimer m_decodedDataDeletionTimer;
299
300 private:
301     class Callback;
302
303     bool addClientToSet(CachedResourceClient&);
304
305     void decodedDataDeletionTimerFired();
306
307     virtual void checkNotify();
308     virtual bool mayTryReplaceEncodedData() const { return false; }
309
310     std::chrono::microseconds freshnessLifetime(const ResourceResponse&) const;
311
312     void addAdditionalRequestHeaders(CachedResourceLoader&);
313     void failBeforeStarting();
314
315     HashMap<CachedResourceClient*, std::unique_ptr<Callback>> m_clientsAwaitingCallback;
316     SessionID m_sessionID;
317     ResourceLoadPriority m_loadPriority;
318     std::chrono::system_clock::time_point m_responseTimestamp;
319
320     String m_fragmentIdentifierForRequest;
321
322     ResourceError m_error;
323     RefPtr<SecurityOrigin> m_origin;
324     AtomicString m_initiatorName;
325
326     double m_lastDecodedAccessTime { 0 }; // Used as a "thrash guard" in the cache
327
328     unsigned m_encodedSize { 0 };
329     unsigned m_decodedSize { 0 };
330     unsigned m_accessCount { 0 };
331     unsigned m_handleCount { 0 };
332     unsigned m_preloadCount { 0 };
333
334     PreloadResult m_preloadResult { PreloadNotReferenced };
335
336     bool m_requestedFromNetworkingLayer { false };
337
338     bool m_inCache { false };
339     bool m_loading { false };
340     bool m_isLinkPreload { false };
341     bool m_hasUnknownEncoding { false };
342
343     bool m_switchingClientsToRevalidatedResource { false };
344
345     Type m_type; // Type
346     unsigned m_status { Pending }; // Status
347
348 #ifndef NDEBUG
349     bool m_deleted { false };
350     unsigned m_lruIndex { 0 };
351 #endif
352
353     CachedResourceLoader* m_owningCachedResourceLoader { nullptr }; // only non-null for resources that are not in the cache
354
355     // 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
356     // using HTTP If-Modified-Since/If-None-Match headers. If the response is 304 all clients of this resource are moved
357     // to to be clients of m_resourceToRevalidate and the resource is deleted. If not, the field is zeroed and this
358     // resources becomes normal resource load.
359     CachedResource* m_resourceToRevalidate { nullptr };
360
361     // If this field is non-null, the resource has a proxy for checking whether it is still up to date (see m_resourceToRevalidate).
362     CachedResource* m_proxyResource { nullptr };
363
364     // These handles will need to be updated to point to the m_resourceToRevalidate in case we get 304 response.
365     HashSet<CachedResourceHandleBase*> m_handlesToRevalidate;
366
367     RedirectChainCacheStatus m_redirectChainCacheStatus;
368
369     Vector<std::pair<String, String>> m_varyingHeaderValues;
370
371     unsigned long m_identifierForLoadWithoutResourceLoader { 0 };
372 };
373
374 class CachedResource::Callback {
375 #if !COMPILER(MSVC)
376     WTF_MAKE_FAST_ALLOCATED;
377 #endif
378 public:
379     Callback(CachedResource&, CachedResourceClient&);
380
381     void cancel();
382
383 private:
384     void timerFired();
385
386     CachedResource& m_resource;
387     CachedResourceClient& m_client;
388     Timer m_timer;
389 };
390
391 } // namespace WebCore
392
393 #define SPECIALIZE_TYPE_TRAITS_CACHED_RESOURCE(ToClassName, CachedResourceType) \
394 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToClassName) \
395     static bool isType(const WebCore::CachedResource& resource) { return resource.type() == WebCore::CachedResourceType; } \
396 SPECIALIZE_TYPE_TRAITS_END()