26b260a609a16954d1910b2d110a1282f147cdc2
[WebKit-https.git] / Source / WebCore / loader / cache / CachedResourceLoader.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) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
5     Copyright (C) 2009 Torch Mobile Inc. http://www.torchmobile.com/
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     This class provides all functionality needed for loading images, style sheets and html
23     pages from the web. It has a memory cache for these objects.
24 */
25
26 #ifndef CachedResourceLoader_h
27 #define CachedResourceLoader_h
28
29 #include "CachePolicy.h"
30 #include "CachedResource.h"
31 #include "CachedResourceHandle.h"
32 #include "CachedResourceRequest.h"
33 #include "ResourceLoadPriority.h"
34 #include "Timer.h"
35 #include <wtf/Deque.h>
36 #include <wtf/HashMap.h>
37 #include <wtf/HashSet.h>
38 #include <wtf/ListHashSet.h>
39 #include <wtf/text/StringHash.h>
40
41 namespace WebCore {
42
43 class CachedCSSStyleSheet;
44 class CachedSVGDocument;
45 class CachedFont;
46 class CachedImage;
47 class CachedRawResource;
48 class CachedScript;
49 class CachedTextTrack;
50 class CachedXSLStyleSheet;
51 class Document;
52 class DocumentLoader;
53 class Frame;
54 class ImageLoader;
55 class URL;
56
57 // The CachedResourceLoader provides a per-context interface to the MemoryCache
58 // and enforces a bunch of security checks and rules for resource revalidation.
59 // Its lifetime is roughly per-DocumentLoader, in that it is generally created
60 // in the DocumentLoader constructor and loses its ability to generate network
61 // requests when the DocumentLoader is destroyed. Documents also hold a 
62 // RefPtr<CachedResourceLoader> for their lifetime (and will create one if they
63 // are initialized without a Frame), so a Document can keep a CachedResourceLoader
64 // alive past detach if scripts still reference the Document.
65 class CachedResourceLoader : public RefCounted<CachedResourceLoader> {
66     WTF_MAKE_NONCOPYABLE(CachedResourceLoader); WTF_MAKE_FAST_ALLOCATED;
67 friend class ImageLoader;
68 friend class ResourceCacheValidationSuppressor;
69
70 public:
71     static Ref<CachedResourceLoader> create(DocumentLoader* documentLoader) { return adoptRef(*new CachedResourceLoader(documentLoader)); }
72     ~CachedResourceLoader();
73
74     enum class ShouldBypassMainWorldContentSecurityPolicy { No, Yes };
75
76     CachedResourceHandle<CachedImage> requestImage(CachedResourceRequest&, ShouldBypassMainWorldContentSecurityPolicy = ShouldBypassMainWorldContentSecurityPolicy::No);
77     CachedResourceHandle<CachedCSSStyleSheet> requestCSSStyleSheet(CachedResourceRequest&);
78     CachedResourceHandle<CachedCSSStyleSheet> requestUserCSSStyleSheet(CachedResourceRequest&);
79     CachedResourceHandle<CachedScript> requestScript(CachedResourceRequest&);
80     CachedResourceHandle<CachedFont> requestFont(CachedResourceRequest&, bool isSVG);
81     CachedResourceHandle<CachedRawResource> requestRawResource(CachedResourceRequest&);
82     CachedResourceHandle<CachedRawResource> requestMainResource(CachedResourceRequest&);
83     CachedResourceHandle<CachedSVGDocument> requestSVGDocument(CachedResourceRequest&);
84 #if ENABLE(XSLT)
85     CachedResourceHandle<CachedXSLStyleSheet> requestXSLStyleSheet(CachedResourceRequest&);
86 #endif
87 #if ENABLE(LINK_PREFETCH)
88     CachedResourceHandle<CachedResource> requestLinkResource(CachedResource::Type, CachedResourceRequest&);
89 #endif
90 #if ENABLE(VIDEO_TRACK)
91     CachedResourceHandle<CachedTextTrack> requestTextTrack(CachedResourceRequest&);
92 #endif
93
94     // Logs an access denied message to the console for the specified URL.
95     void printAccessDeniedMessage(const URL& url) const;
96
97     CachedResource* cachedResource(const String& url) const;
98     CachedResource* cachedResource(const URL& url) const;
99     
100     typedef HashMap<String, CachedResourceHandle<CachedResource>> DocumentResourceMap;
101     const DocumentResourceMap& allCachedResources() const { return m_documentResources; }
102
103     bool autoLoadImages() const { return m_autoLoadImages; }
104     void setAutoLoadImages(bool);
105
106     void setImagesEnabled(bool);
107
108     bool shouldDeferImageLoad(const URL&) const;
109     bool shouldPerformImageLoad(const URL&) const;
110     
111     CachePolicy cachePolicy(CachedResource::Type) const;
112     
113     Frame* frame() const; // Can be null
114     Document* document() const { return m_document; } // Can be null
115     void setDocument(Document* document) { m_document = document; }
116     void clearDocumentLoader() { m_documentLoader = 0; }
117     SessionID sessionID() const;
118
119     void removeCachedResource(CachedResource&);
120     void addCachedResource(CachedResource&);
121
122     void loadDone(CachedResource*, bool shouldPerformPostLoadActions = true);
123
124     WEBCORE_EXPORT void garbageCollectDocumentResources();
125     
126     void incrementRequestCount(const CachedResource*);
127     void decrementRequestCount(const CachedResource*);
128     int requestCount() const { return m_requestCount; }
129
130     WEBCORE_EXPORT bool isPreloaded(const String& urlString) const;
131     void clearPreloads();
132     void clearPendingPreloads();
133     void preload(CachedResource::Type, CachedResourceRequest&, const String& charset);
134     void checkForPendingPreloads();
135     void printPreloadStats();
136     bool canRequest(CachedResource::Type, const URL&, const ResourceLoaderOptions&, bool forPreload = false, ShouldBypassMainWorldContentSecurityPolicy = ShouldBypassMainWorldContentSecurityPolicy::No);
137
138     static const ResourceLoaderOptions& defaultCachedResourceOptions();
139
140     void documentDidFinishLoadEvent();
141
142 private:
143     explicit CachedResourceLoader(DocumentLoader*);
144
145     CachedResourceHandle<CachedResource> requestResource(CachedResource::Type, CachedResourceRequest&, ShouldBypassMainWorldContentSecurityPolicy = ShouldBypassMainWorldContentSecurityPolicy::No);
146     CachedResourceHandle<CachedResource> revalidateResource(const CachedResourceRequest&, CachedResource*);
147     CachedResourceHandle<CachedResource> loadResource(CachedResource::Type, CachedResourceRequest&);
148 #if ENABLE(RESOURCE_TIMING)
149     void storeResourceTimingInitiatorInformation(const CachedResourceHandle<CachedResource>&, const CachedResourceRequest&);
150 #endif
151     void requestPreload(CachedResource::Type, CachedResourceRequest&, const String& charset);
152
153     enum RevalidationPolicy { Use, Revalidate, Reload, Load };
154     RevalidationPolicy determineRevalidationPolicy(CachedResource::Type, ResourceRequest&, bool forPreload, CachedResource* existingResource, CachedResourceRequest::DeferOption) const;
155     
156     bool shouldContinueAfterNotifyingLoadedFromMemoryCache(const CachedResourceRequest&, CachedResource*);
157     bool checkInsecureContent(CachedResource::Type, const URL&) const;
158
159     void garbageCollectDocumentResourcesTimerFired();
160     void performPostLoadActions();
161
162     bool clientDefersImage(const URL&) const;
163     void reloadImagesIfNotDeferred();
164     
165     HashSet<String> m_validatedURLs;
166     mutable DocumentResourceMap m_documentResources;
167     Document* m_document;
168     DocumentLoader* m_documentLoader;
169     
170     int m_requestCount;
171     
172     std::unique_ptr<ListHashSet<CachedResource*>> m_preloads;
173     struct PendingPreload {
174         CachedResource::Type m_type;
175         CachedResourceRequest m_request;
176         String m_charset;
177     };
178     Deque<PendingPreload> m_pendingPreloads;
179
180     Timer m_garbageCollectDocumentResourcesTimer;
181
182 #if ENABLE(RESOURCE_TIMING)
183     struct InitiatorInfo {
184         AtomicString name;
185         double startTime;
186     };
187     HashMap<CachedResource*, InitiatorInfo> m_initiatorMap;
188 #endif
189
190     // 29 bits left
191     bool m_autoLoadImages : 1;
192     bool m_imagesEnabled : 1;
193     bool m_allowStaleResources : 1;
194 };
195
196 class ResourceCacheValidationSuppressor {
197     WTF_MAKE_NONCOPYABLE(ResourceCacheValidationSuppressor);
198     WTF_MAKE_FAST_ALLOCATED;
199 public:
200     ResourceCacheValidationSuppressor(CachedResourceLoader& loader)
201         : m_loader(loader)
202         , m_previousState(m_loader.m_allowStaleResources)
203     {
204         m_loader.m_allowStaleResources = true;
205     }
206     ~ResourceCacheValidationSuppressor()
207     {
208         m_loader.m_allowStaleResources = m_previousState;
209     }
210 private:
211     CachedResourceLoader& m_loader;
212     bool m_previousState;
213 };
214
215 } // namespace WebCore
216
217 #endif