src/third_party/WebKit/Source/core/fetch/Resource.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 Resource_h
  24 #define Resource_h
  25
  26 #include "core/fetch/CachePolicy.h"
  27 #include "core/fetch/ResourceLoaderOptions.h"
  28 #include "platform/Timer.h"
  29 #include "platform/network/ResourceError.h"
  30 #include "platform/network/ResourceLoadPriority.h"
  31 #include "platform/network/ResourceRequest.h"
  32 #include "platform/network/ResourceResponse.h"
  33 #include "wtf/HashCountedSet.h"
  34 #include "wtf/HashSet.h"
  35 #include "wtf/OwnPtr.h"
  36 #include "wtf/text/WTFString.h"
  37
  38 namespace WebCore {
  39
  40 class MemoryCache;
  41 class CachedMetadata;
  42 class ResourceClient;
  43 class ResourcePtrBase;
  44 class ResourceFetcher;
  45 class InspectorResource;
  46 class PurgeableBuffer;
  47 class ResourceLoader;
  48 class SecurityOrigin;
  49 class SharedBuffer;
  50
  51 // A resource that is held in the cache. Classes who want to use this object should derive
  52 // from ResourceClient, to get the function calls in case the requested data has arrived.
  53 // This class also does the actual communication with the loader to obtain the resource from the network.
  54 class Resource {
  55     WTF_MAKE_NONCOPYABLE(Resource); WTF_MAKE_FAST_ALLOCATED;
  56     friend class MemoryCache;
  57     friend class InspectorResource;
  58
  59 public:
  60     enum Type {
  61         MainResource,
  62         Image,
  63         CSSStyleSheet,
  64         Script,
  65         Font,
  66         Raw,
  67         SVGDocument,
  68         XSLStyleSheet,
  69         LinkPrefetch,
  70         LinkSubresource,
  71         TextTrack,
  72         Shader,
  73         ImportResource
  74     };
  75
  76     enum Status {
  77         Unknown, // let cache decide what to do with it
  78         Pending, // only partially loaded
  79         Cached, // regular case
  80         LoadError,
  81         DecodeError
  82     };
  83
  84     Resource(const ResourceRequest&, Type);
  85     virtual ~Resource();
  86
  87     // Determines the order in which CachedResources are evicted
  88     // from the decoded resources cache.
  89     enum CacheLiveResourcePriority {
  90         CacheLiveResourcePriorityLow = 0,
  91         CacheLiveResourcePriorityHigh
  92     };
  93
  94     virtual void load(ResourceFetcher*, const ResourceLoaderOptions&);
  95
  96     virtual void setEncoding(const String&) { }
  97     virtual String encoding() const { return String(); }
  98     virtual void appendData(const char*, int);
  99     virtual void error(Resource::Status);
 100
 101     void setResourceError(const ResourceError& error) { m_error = error; }
 102     const ResourceError& resourceError() const { return m_error; }
 103
 104     void setIdentifier(unsigned long identifier) { m_identifier = identifier; }
 105     unsigned long identifier() const { return m_identifier; }
 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     const ResourceLoaderOptions& options() const { return m_options; }
 113     void setOptions(const ResourceLoaderOptions& options) { m_options = options; }
 114
 115     void didChangePriority(ResourceLoadPriority);
 116
 117     void addClient(ResourceClient*);
 118     void removeClient(ResourceClient*);
 119     bool hasClients() const { return !m_clients.isEmpty() || !m_clientsAwaitingCallback.isEmpty(); }
 120     bool deleteIfPossible();
 121
 122     enum PreloadResult {
 123         PreloadNotReferenced,
 124         PreloadReferenced,
 125         PreloadReferencedWhileLoading,
 126         PreloadReferencedWhileComplete
 127     };
 128     PreloadResult preloadResult() const { return static_cast<PreloadResult>(m_preloadResult); }
 129
 130     virtual void didAddClient(ResourceClient*);
 131     virtual void didRemoveClient(ResourceClient*) { }
 132     virtual void allClientsRemoved();
 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     virtual bool stillNeedsLoad() const { return false; }
 149
 150     ResourceLoader* loader() const { return m_loader.get(); }
 151
 152     virtual bool isImage() const { return false; }
 153     bool ignoreForRequestCount() const
 154     {
 155         return type() == MainResource
 156             || type() == LinkPrefetch
 157             || type() == LinkSubresource
 158             || type() == Raw;
 159     }
 160
 161     void updateForAccess();
 162     unsigned accessCount() const { return m_accessCount; }
 163
 164     // Computes the status of an object after loading.
 165     // Updates the expire date on the cache entry file
 166     void finish(double finishTime = 0.0);
 167
 168     // FIXME: Remove the stringless variant once all the callsites' error messages are updated.
 169     bool passesAccessControlCheck(SecurityOrigin*);
 170     bool passesAccessControlCheck(SecurityOrigin*, String& errorDescription);
 171
 172     // Called by the cache if the object has been removed from the cache
 173     // while still being referenced. This means the object should delete itself
 174     // if the number of clients observing it ever drops to 0.
 175     // The resource can be brought back to cache after successful revalidation.
 176     void setInCache(bool inCache) { m_inCache = inCache; }
 177     bool inCache() const { return m_inCache; }
 178
 179     void setCacheLiveResourcePriority(CacheLiveResourcePriority);
 180     unsigned cacheLiveResourcePriority() const { return m_cacheLiveResourcePriority; }
 181     bool inLiveDecodedResourcesList() { return m_inLiveDecodedResourcesList; }
 182
 183     void clearLoader();
 184
 185     SharedBuffer* resourceBuffer() const { ASSERT(!m_purgeableData); return m_data.get(); }
 186     void setResourceBuffer(PassRefPtr<SharedBuffer>);
 187
 188     virtual void willSendRequest(ResourceRequest&, const ResourceResponse&) { m_requestedFromNetworkingLayer = true; }
 189     virtual void responseReceived(const ResourceResponse&);
 190     void setResponse(const ResourceResponse& response) { m_response = response; }
 191     const ResourceResponse& response() const { return m_response; }
 192
 193     // Sets the serialized metadata retrieved from the platform's cache.
 194     void setSerializedCachedMetadata(const char*, size_t);
 195
 196     // Caches the given metadata in association with this resource and suggests
 197     // that the platform persist it. The dataTypeID is a pseudo-randomly chosen
 198     // identifier that is used to distinguish data generated by the caller.
 199     void setCachedMetadata(unsigned dataTypeID, const char*, size_t);
 200
 201     // Returns cached metadata of the given type associated with this resource.
 202     CachedMetadata* cachedMetadata(unsigned dataTypeID) const;
 203
 204     bool canDelete() const { return !hasClients() && !m_loader && !m_preloadCount && !m_handleCount && !m_resourceToRevalidate && !m_proxyResource; }
 205     bool hasOneHandle() const { return m_handleCount == 1; }
 206
 207     bool isExpired() const;
 208
 209     // List of acceptable MIME types separated by ",".
 210     // A MIME type may contain a wildcard, e.g. "text/*".
 211     AtomicString accept() const { return m_accept; }
 212     void setAccept(const AtomicString& accept) { m_accept = accept; }
 213
 214     bool wasCanceled() const { return m_error.isCancellation(); }
 215     bool errorOccurred() const { return m_status == LoadError || m_status == DecodeError; }
 216     bool loadFailedOrCanceled() { return !m_error.isNull(); }
 217
 218     bool shouldSendResourceLoadCallbacks() const { return m_options.sendLoadCallbacks == SendCallbacks; }
 219     DataBufferingPolicy dataBufferingPolicy() const { return m_options.dataBufferingPolicy; }
 220
 221     virtual void destroyDecodedData() { }
 222
 223     bool isPreloaded() const { return m_preloadCount; }
 224     void increasePreloadCount() { ++m_preloadCount; }
 225     void decreasePreloadCount() { ASSERT(m_preloadCount); --m_preloadCount; }
 226
 227     void registerHandle(ResourcePtrBase* h);
 228     void unregisterHandle(ResourcePtrBase* h);
 229
 230     bool canUseCacheValidator() const;
 231     bool mustRevalidateDueToCacheHeaders(CachePolicy) const;
 232     bool isCacheValidator() const { return m_resourceToRevalidate; }
 233     Resource* resourceToRevalidate() const { return m_resourceToRevalidate; }
 234     void setResourceToRevalidate(Resource*);
 235
 236     bool isPurgeable() const;
 237     bool wasPurged() const;
 238
 239     // This is used by the archive machinery to get at a purged resource without
 240     // triggering a load. We should make it protected again if we can find a
 241     // better way to handle the archive case.
 242     bool makePurgeable(bool purgeable);
 243
 244     virtual void didSendData(unsigned long long /* bytesSent */, unsigned long long /* totalBytesToBeSent */) { }
 245     virtual void didDownloadData(int) { }
 246
 247     double loadFinishTime() const { return m_loadFinishTime; }
 248
 249     virtual bool canReuse(const ResourceRequest&) const { return true; }
 250
 251 protected:
 252     virtual void checkNotify();
 253     virtual void finishOnePart();
 254
 255     void setEncodedSize(unsigned);
 256     void setDecodedSize(unsigned);
 257     void didAccessDecodedData(double timeStamp);
 258
 259     bool isSafeToMakePurgeable() const;
 260
 261     virtual void switchClientsToRevalidatedResource();
 262     void clearResourceToRevalidate();
 263     void updateResponseAfterRevalidation(const ResourceResponse& validatingResponse);
 264
 265     void finishPendingClients();
 266
 267     HashCountedSet<ResourceClient*> m_clients;
 268     HashCountedSet<ResourceClient*> m_clientsAwaitingCallback;
 269
 270     class ResourceCallback {
 271     public:
 272         static ResourceCallback* callbackHandler();
 273         void schedule(Resource*);
 274         void cancel(Resource*);
 275     private:
 276         ResourceCallback();
 277         void timerFired(Timer<ResourceCallback>*);
 278         Timer<ResourceCallback> m_callbackTimer;
 279         HashSet<Resource*> m_resourcesWithPendingClients;
 280     };
 281
 282     bool hasClient(ResourceClient* client) { return m_clients.contains(client) || m_clientsAwaitingCallback.contains(client); }
 283
 284     ResourceRequest m_resourceRequest;
 285     AtomicString m_accept;
 286     RefPtr<ResourceLoader> m_loader;
 287     ResourceLoaderOptions m_options;
 288
 289     ResourceResponse m_response;
 290     double m_responseTimestamp;
 291
 292     RefPtr<SharedBuffer> m_data;
 293     OwnPtr<PurgeableBuffer> m_purgeableData;
 294     Timer<Resource> m_cancelTimer;
 295
 296 private:
 297     bool addClientToSet(ResourceClient*);
 298     void cancelTimerFired(Timer<Resource>*);
 299
 300     void revalidationSucceeded(const ResourceResponse&);
 301     void revalidationFailed();
 302
 303     double currentAge() const;
 304     double freshnessLifetime() const;
 305
 306     void failBeforeStarting();
 307
 308     String m_fragmentIdentifierForRequest;
 309
 310     RefPtr<CachedMetadata> m_cachedMetadata;
 311
 312     ResourceError m_error;
 313
 314     double m_lastDecodedAccessTime; // Used as a "thrash guard" in the cache
 315     double m_loadFinishTime;
 316
 317     unsigned long m_identifier;
 318
 319     unsigned m_encodedSize;
 320     unsigned m_decodedSize;
 321     unsigned m_accessCount;
 322     unsigned m_handleCount;
 323     unsigned m_preloadCount;
 324
 325     unsigned m_preloadResult : 2; // PreloadResult
 326     unsigned m_cacheLiveResourcePriority : 2; // CacheLiveResourcePriority
 327     unsigned m_inLiveDecodedResourcesList : 1;
 328     unsigned m_requestedFromNetworkingLayer : 1;
 329
 330     unsigned m_inCache : 1;
 331     unsigned m_loading : 1;
 332
 333     unsigned m_switchingClientsToRevalidatedResource : 1;
 334
 335     unsigned m_type : 4; // Type
 336     unsigned m_status : 3; // Status
 337
 338 #ifndef NDEBUG
 339     bool m_deleted;
 340     unsigned m_lruIndex;
 341 #endif
 342
 343     Resource* m_nextInAllResourcesList;
 344     Resource* m_prevInAllResourcesList;
 345
 346     Resource* m_nextInLiveResourcesList;
 347     Resource* m_prevInLiveResourcesList;
 348
 349     // 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
 350     // using HTTP If-Modified-Since/If-None-Match headers. If the response is 304 all clients of this resource are moved
 351     // to to be clients of m_resourceToRevalidate and the resource is deleted. If not, the field is zeroed and this
 352     // resources becomes normal resource load.
 353     Resource* m_resourceToRevalidate;
 354
 355     // If this field is non-null, the resource has a proxy for checking whether it is still up to date (see m_resourceToRevalidate).
 356     Resource* m_proxyResource;
 357
 358     // These handles will need to be updated to point to the m_resourceToRevalidate in case we get 304 response.
 359     HashSet<ResourcePtrBase*> m_handlesToRevalidate;
 360 };
 361
 362 #if !LOG_DISABLED
 363 // Intended to be used in LOG statements.
 364 const char* ResourceTypeName(Resource::Type);
 365 #endif
 366
 367 }
 368
 369 #endif