src/third_party/WebKit/Source/core/fetch/ResourceFetcher.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 ResourceFetcher_h
  27 #define ResourceFetcher_h
  28
  29 #include "core/fetch/CachePolicy.h"
  30 #include "core/fetch/FetchInitiatorInfo.h"
  31 #include "core/fetch/FetchRequest.h"
  32 #include "core/fetch/Resource.h"
  33 #include "core/fetch/ResourceLoaderHost.h"
  34 #include "core/fetch/ResourceLoaderOptions.h"
  35 #include "core/fetch/ResourcePtr.h"
  36 #include "platform/Timer.h"
  37 #include "wtf/Deque.h"
  38 #include "wtf/HashMap.h"
  39 #include "wtf/HashSet.h"
  40 #include "wtf/ListHashSet.h"
  41 #include "wtf/text/StringHash.h"
  42
  43 namespace blink {
  44
  45 class CSSStyleSheetResource;
  46 class DocumentResource;
  47 class FetchContext;
  48 class FontResource;
  49 class ImageResource;
  50 class RawResource;
  51 class ScriptResource;
  52 class SubstituteData;
  53 class XSLStyleSheetResource;
  54 class Document;
  55 class DocumentLoader;
  56 class LocalFrame;
  57 class ImageLoader;
  58 class KURL;
  59 class ResourceTimingInfo;
  60 class ResourceLoaderSet;
  61
  62 // The ResourceFetcher provides a per-context interface to the MemoryCache
  63 // and enforces a bunch of security checks and rules for resource revalidation.
  64 // Its lifetime is roughly per-DocumentLoader, in that it is generally created
  65 // in the DocumentLoader constructor and loses its ability to generate network
  66 // requests when the DocumentLoader is destroyed. Documents also hold a
  67 // RefPtr<ResourceFetcher> for their lifetime (and will create one if they
  68 // are initialized without a LocalFrame), so a Document can keep a ResourceFetcher
  69 // alive past detach if scripts still reference the Document.
  70 class ResourceFetcher final : public RefCountedWillBeGarbageCollectedFinalized<ResourceFetcher>, public ResourceLoaderHost {
  71     WTF_MAKE_NONCOPYABLE(ResourceFetcher); WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED;
  72     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(ResourceFetcher);
  73 friend class ImageLoader;
  74 friend class ResourceCacheValidationSuppressor;
  75
  76 public:
  77     static PassRefPtrWillBeRawPtr<ResourceFetcher> create(DocumentLoader* documentLoader) { return adoptRefWillBeNoop(new ResourceFetcher(documentLoader)); }
  78     virtual ~ResourceFetcher();
  79     virtual void trace(Visitor*);
  80
  81 #if !ENABLE(OILPAN)
  82     using RefCounted<ResourceFetcher>::ref;
  83     using RefCounted<ResourceFetcher>::deref;
  84 #endif
  85
  86     ResourcePtr<Resource> fetchSynchronously(FetchRequest&);
  87     ResourcePtr<ImageResource> fetchImage(FetchRequest&);
  88     ResourcePtr<CSSStyleSheetResource> fetchCSSStyleSheet(FetchRequest&);
  89     ResourcePtr<ScriptResource> fetchScript(FetchRequest&);
  90     ResourcePtr<FontResource> fetchFont(FetchRequest&);
  91     ResourcePtr<RawResource> fetchRawResource(FetchRequest&);
  92     ResourcePtr<RawResource> fetchMainResource(FetchRequest&, const SubstituteData&);
  93     ResourcePtr<DocumentResource> fetchSVGDocument(FetchRequest&);
  94     ResourcePtr<XSLStyleSheetResource> fetchXSLStyleSheet(FetchRequest&);
  95     ResourcePtr<Resource> fetchLinkResource(Resource::Type, FetchRequest&);
  96     ResourcePtr<RawResource> fetchImport(FetchRequest&);
  97     ResourcePtr<RawResource> fetchMedia(FetchRequest&);
  98     ResourcePtr<RawResource> fetchTextTrack(FetchRequest&);
  99
 100     // Logs an access denied message to the console for the specified URL.
 101     void printAccessDeniedMessage(const KURL&) const;
 102
 103     Resource* cachedResource(const KURL&) const;
 104
 105     typedef HashMap<String, ResourcePtr<Resource>> DocumentResourceMap;
 106     const DocumentResourceMap& allResources() const { return m_documentResources; }
 107
 108     bool autoLoadImages() const { return m_autoLoadImages; }
 109     void setAutoLoadImages(bool);
 110
 111     void setImagesEnabled(bool);
 112
 113     bool shouldDeferImageLoad(const KURL&) const;
 114
 115     LocalFrame* frame() const; // Can be null
 116     FetchContext& context() const;
 117     Document* document() const { return m_document; } // Can be null
 118     void setDocument(RawPtr<Document> document) { m_document = document; }
 119
 120     DocumentLoader* documentLoader() const { return m_documentLoader; }
 121     void clearDocumentLoader() { m_documentLoader = nullptr; }
 122
 123     void garbageCollectDocumentResources();
 124
 125     int requestCount() const { return m_requestCount; }
 126
 127     bool isPreloaded(const String& urlString) const;
 128     void clearPreloads();
 129     void preload(Resource::Type, FetchRequest&, const String& charset);
 130     void printPreloadStats();
 131
 132     void setDefersLoading(bool);
 133     void stopFetching();
 134     bool isFetching() const;
 135
 136     // ResourceLoaderHost
 137     virtual void incrementRequestCount(const Resource*) override;
 138     virtual void decrementRequestCount(const Resource*) override;
 139     virtual void didLoadResource() override;
 140     virtual void redirectReceived(Resource*, const ResourceResponse&) override;
 141     virtual void didFinishLoading(Resource*, double finishTime, int64_t encodedDataLength) override;
 142     virtual void didChangeLoadingPriority(const Resource*, ResourceLoadPriority, int intraPriorityValue) override;
 143     virtual void didFailLoading(const Resource*, const ResourceError&) override;
 144     virtual void willSendRequest(unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse, const FetchInitiatorInfo&) override;
 145     virtual void didReceiveResponse(const Resource*, const ResourceResponse&) override;
 146     virtual void didReceiveData(const Resource*, const char* data, int dataLength, int encodedDataLength) override;
 147     virtual void didDownloadData(const Resource*, int dataLength, int encodedDataLength) override;
 148     virtual void subresourceLoaderFinishedLoadingOnePart(ResourceLoader*) override;
 149     virtual void didInitializeResourceLoader(ResourceLoader*) override;
 150     virtual void willTerminateResourceLoader(ResourceLoader*) override;
 151     virtual void willStartLoadingResource(Resource*, ResourceRequest&) override;
 152     virtual bool defersLoading() const override;
 153     virtual bool isLoadedBy(ResourceLoaderHost*) const override;
 154     virtual bool canAccessRedirect(Resource*, ResourceRequest&, const ResourceResponse&, ResourceLoaderOptions&) override;
 155     virtual bool canAccessResource(Resource*, SecurityOrigin*, const KURL&) const override;
 156     virtual bool isControlledByServiceWorker() const override;
 157
 158 #if !ENABLE(OILPAN)
 159     virtual void refResourceLoaderHost() override;
 160     virtual void derefResourceLoaderHost() override;
 161 #endif
 162
 163     int64_t serviceWorkerID() const;
 164
 165     enum ResourceLoadStartType {
 166         ResourceLoadingFromNetwork,
 167         ResourceLoadingFromCache
 168     };
 169     void maybeNotifyInsecureContent(const Resource*) const;
 170     void requestLoadStarted(Resource*, const FetchRequest&, ResourceLoadStartType);
 171     static const ResourceLoaderOptions& defaultResourceOptions();
 172
 173     String getCacheIdentifier() const;
 174
 175 private:
 176     explicit ResourceFetcher(DocumentLoader*);
 177
 178     bool shouldLoadNewResource(Resource::Type) const;
 179
 180     ResourcePtr<Resource> requestResource(Resource::Type, FetchRequest&);
 181     ResourcePtr<Resource> createResourceForRevalidation(const FetchRequest&, Resource*);
 182     ResourcePtr<Resource> createResourceForLoading(Resource::Type, FetchRequest&, const String& charset);
 183     void preCacheDataURIImage(const FetchRequest&);
 184     void preCacheSubstituteDataForMainResource(const FetchRequest&, const SubstituteData&);
 185     void storeResourceTimingInitiatorInformation(Resource*);
 186     void requestPreload(Resource::Type, FetchRequest&, const String& charset);
 187
 188     enum RevalidationPolicy { Use, Revalidate, Reload, Load };
 189     RevalidationPolicy determineRevalidationPolicy(Resource::Type, const FetchRequest&, Resource* existingResource) const;
 190
 191     void determineRequestContext(ResourceRequest&, Resource::Type);
 192     ResourceRequestCachePolicy resourceRequestCachePolicy(const ResourceRequest&, Resource::Type);
 193     void addAdditionalRequestHeaders(ResourceRequest&, Resource::Type);
 194
 195     bool canRequest(Resource::Type, const ResourceRequest&, const KURL&, const ResourceLoaderOptions&, bool forPreload, FetchRequest::OriginRestriction) const;
 196
 197     static bool resourceNeedsLoad(Resource*, const FetchRequest&, RevalidationPolicy);
 198
 199     void notifyLoadedFromMemoryCache(Resource*);
 200
 201     void garbageCollectDocumentResourcesTimerFired(Timer<ResourceFetcher>*);
 202     void scheduleDocumentResourcesGC();
 203
 204     void resourceTimingReportTimerFired(Timer<ResourceFetcher>*);
 205
 206     bool clientDefersImage(const KURL&) const;
 207     void reloadImagesIfNotDeferred();
 208
 209     HashSet<String> m_validatedURLs;
 210     mutable DocumentResourceMap m_documentResources;
 211     // FIXME: Oilpan: Ideally this should just be a traced Member but that will
 212     // currently leak because RenderStyle and its data are not on the heap.
 213     // See crbug.com/383860 for details.
 214     RawPtrWillBeWeakMember<Document> m_document;
 215     DocumentLoader* m_documentLoader;
 216
 217     int m_requestCount;
 218
 219     OwnPtr<ListHashSet<Resource*>> m_preloads;
 220
 221     Timer<ResourceFetcher> m_garbageCollectDocumentResourcesTimer;
 222     Timer<ResourceFetcher> m_resourceTimingReportTimer;
 223
 224     typedef HashMap<Resource*, RefPtr<ResourceTimingInfo>> ResourceTimingInfoMap;
 225     ResourceTimingInfoMap m_resourceTimingInfoMap;
 226
 227     HashMap<RefPtr<ResourceTimingInfo>, bool> m_scheduledResourceTimingReports;
 228
 229     OwnPtrWillBeMember<ResourceLoaderSet> m_loaders;
 230     OwnPtrWillBeMember<ResourceLoaderSet> m_multipartLoaders;
 231
 232     // Used in hit rate histograms.
 233     class DeadResourceStatsRecorder {
 234     public:
 235         DeadResourceStatsRecorder();
 236         ~DeadResourceStatsRecorder();
 237
 238         void update(RevalidationPolicy);
 239
 240     private:
 241         int m_useCount;
 242         int m_revalidateCount;
 243         int m_loadCount;
 244     };
 245     DeadResourceStatsRecorder m_deadStatsRecorder;
 246
 247     // 29 bits left
 248     bool m_autoLoadImages : 1;
 249     bool m_imagesEnabled : 1;
 250     bool m_allowStaleResources : 1;
 251 };
 252
 253 class ResourceCacheValidationSuppressor {
 254     WTF_MAKE_NONCOPYABLE(ResourceCacheValidationSuppressor);
 255     WTF_MAKE_FAST_ALLOCATED;
 256 public:
 257     ResourceCacheValidationSuppressor(ResourceFetcher* loader)
 258         : m_loader(loader)
 259         , m_previousState(false)
 260     {
 261         if (m_loader) {
 262             m_previousState = m_loader->m_allowStaleResources;
 263             m_loader->m_allowStaleResources = true;
 264         }
 265     }
 266     ~ResourceCacheValidationSuppressor()
 267     {
 268         if (m_loader)
 269             m_loader->m_allowStaleResources = m_previousState;
 270     }
 271 private:
 272     ResourceFetcher* m_loader;
 273     bool m_previousState;
 274 };
 275
 276 } // namespace blink
 277
 278 #endif