#ifndef CachedResource_h
#define CachedResource_h
#include "CachePolicy.h"
#include "FrameLoaderTypes.h"
#include "PlatformString.h"
#include "PurgePriority.h"
#include "ResourceLoaderOptions.h"
#include "ResourceLoadPriority.h"
#include "ResourceRequest.h"
#include "ResourceResponse.h"
#include "Timer.h"
#include <wtf/HashCountedSet.h>
#include <wtf/HashSet.h>
#include <wtf/OwnPtr.h>
#include <wtf/Vector.h>
#include <time.h>
#if ENABLE(DISK_IMAGE_CACHE)
#include "SharedBuffer.h"
#endif
namespace WebCore {
class MemoryCache;
class CachedMetadata;
class CachedResourceClient;
class CachedResourceHandleBase;
class CachedResourceLoader;
class Frame;
class InspectorResource;
class PurgeableBuffer;
class SecurityOrigin;
class SubresourceLoader;
class CachedResource {
WTF_MAKE_NONCOPYABLE(CachedResource); WTF_MAKE_FAST_ALLOCATED;
friend class MemoryCache;
friend class InspectorResource;
public:
enum Type {
ImageResource,
CSSStyleSheet,
Script,
FontResource,
RawResource
#if ENABLE(SVG)
, SVGDocumentResource
#endif
#if ENABLE(XSLT)
, XSLStyleSheet
#endif
#if ENABLE(LINK_PREFETCH)
, LinkPrefetch
, LinkPrerender
, LinkSubresource
#endif
#if ENABLE(VIDEO_TRACK)
, TextTrackResource
#endif
#if ENABLE(CSS_SHADERS)
, ShaderResource
#endif
};
enum Status {
Unknown, Pending, Cached, Canceled,
LoadError,
DecodeError
};
CachedResource(const ResourceRequest&, Type);
virtual ~CachedResource();
virtual void load(CachedResourceLoader*, const ResourceLoaderOptions&);
virtual void setEncoding(const String&) { }
virtual String encoding() const { return String(); }
virtual void data(PassRefPtr<SharedBuffer> data, bool allDataReceived);
virtual void error(CachedResource::Status);
virtual bool shouldIgnoreHTTPStatusCodeErrors() const { return false; }
ResourceRequest& resourceRequest() { return m_resourceRequest; }
const KURL& url() const { return m_resourceRequest.url();}
Type type() const { return static_cast<Type>(m_type); }
ResourceLoadPriority loadPriority() const { return m_loadPriority; }
void setLoadPriority(ResourceLoadPriority);
void addClient(CachedResourceClient*);
void removeClient(CachedResourceClient*);
bool hasClients() const { return !m_clients.isEmpty() || !m_clientsAwaitingCallback.isEmpty(); }
void deleteIfPossible();
enum PreloadResult {
PreloadNotReferenced,
PreloadReferenced,
PreloadReferencedWhileLoading,
PreloadReferencedWhileComplete
};
PreloadResult preloadResult() const { return static_cast<PreloadResult>(m_preloadResult); }
virtual void didAddClient(CachedResourceClient*);
virtual void allClientsRemoved() { }
unsigned count() const { return m_clients.size(); }
Status status() const { return static_cast<Status>(m_status); }
void setStatus(Status status) { m_status = status; }
unsigned size() const { return encodedSize() + decodedSize() + overheadSize(); }
unsigned encodedSize() const { return m_encodedSize; }
unsigned decodedSize() const { return m_decodedSize; }
unsigned overheadSize() const;
bool isLoaded() const { return !m_loading; }
bool isLoading() const { return m_loading; }
void setLoading(bool b) { m_loading = b; }
virtual bool isImage() const { return false; }
bool ignoreForRequestCount() const
{
return false
#if ENABLE(LINK_PREFETCH)
|| type() == LinkPrefetch
|| type() == LinkPrerender
|| type() == LinkSubresource
#endif
|| type() == RawResource;
}
unsigned accessCount() const { return m_accessCount; }
void increaseAccessCount() { m_accessCount++; }
void finish();
bool passesAccessControlCheck(SecurityOrigin*);
void setInCache(bool inCache) { m_inCache = inCache; }
bool inCache() const { return m_inCache; }
void setInLiveDecodedResourcesList(bool b) { m_inLiveDecodedResourcesList = b; }
bool inLiveDecodedResourcesList() { return m_inLiveDecodedResourcesList; }
void stopLoading();
SharedBuffer* data() const { ASSERT(!m_purgeableData); return m_data.get(); }
virtual void willSendRequest(ResourceRequest&, const ResourceResponse&) { m_requestedFromNetworkingLayer = true; }
virtual void setResponse(const ResourceResponse&);
const ResourceResponse& response() const { return m_response; }
void setSerializedCachedMetadata(const char*, size_t);
void setCachedMetadata(unsigned dataTypeID, const char*, size_t);
CachedMetadata* cachedMetadata(unsigned dataTypeID) const;
bool canDelete() const { return !hasClients() && !m_loader && !m_preloadCount && !m_handleCount && !m_resourceToRevalidate && !m_proxyResource; }
bool hasOneHandle() const { return m_handleCount == 1; }
bool isExpired() const;
String accept() const { return m_accept; }
void setAccept(const String& accept) { m_accept = accept; }
bool wasCanceled() const { return m_status == Canceled; }
bool errorOccurred() const { return (m_status == LoadError || m_status == DecodeError); }
bool loadFailedOrCanceled() { return m_status == Canceled || m_status == LoadError; }
bool sendResourceLoadCallbacks() const { return m_options.sendLoadCallbacks == SendCallbacks; }
virtual void destroyDecodedData() { }
void setOwningCachedResourceLoader(CachedResourceLoader* cachedResourceLoader) { m_owningCachedResourceLoader = cachedResourceLoader; }
bool isPreloaded() const { return m_preloadCount; }
void increasePreloadCount() { ++m_preloadCount; }
void decreasePreloadCount() { ASSERT(m_preloadCount); --m_preloadCount; }
void registerHandle(CachedResourceHandleBase* h);
void unregisterHandle(CachedResourceHandleBase* h);
bool canUseCacheValidator() const;
void clearLoaderAfterSynchronousCancel();
virtual bool mustRevalidateDueToCacheHeaders(CachePolicy) const;
bool isCacheValidator() const { return m_resourceToRevalidate; }
CachedResource* resourceToRevalidate() const { return m_resourceToRevalidate; }
bool isPurgeable() const;
bool wasPurged() const;
bool makePurgeable(bool purgeable);
void setResourceToRevalidate(CachedResource*);
void switchClientsToRevalidatedResource();
void clearResourceToRevalidate();
void updateResponseAfterRevalidation(const ResourceResponse& validatingResponse);
virtual void didSendData(unsigned long long , unsigned long long ) { }
#if PLATFORM(CHROMIUM)
virtual void didDownloadData(int) { }
#endif
void setLoadFinishTime(double finishTime) { m_loadFinishTime = finishTime; }
double loadFinishTime() const { return m_loadFinishTime; }
#if ENABLE(DISK_IMAGE_CACHE)
bool isUsingDiskImageCache() const { return m_data && m_data->isAllowedToBeMemoryMapped(); }
virtual bool canUseDiskImageCache() const { return false; }
virtual void useDiskImageCache() { ASSERT(canUseDiskImageCache()); }
#endif
protected:
void checkNotify();
void setEncodedSize(unsigned);
void setDecodedSize(unsigned);
void didAccessDecodedData(double timeStamp);
bool isSafeToMakePurgeable() const;
HashCountedSet<CachedResourceClient*> m_clients;
class CachedResourceCallback {
public:
static PassOwnPtr<CachedResourceCallback> schedule(CachedResource* resource, CachedResourceClient* client) { return adoptPtr(new CachedResourceCallback(resource, client)); }
void cancel();
private:
CachedResourceCallback(CachedResource*, CachedResourceClient*);
void timerFired(Timer<CachedResourceCallback>*);
CachedResource* m_resource;
CachedResourceClient* m_client;
Timer<CachedResourceCallback> m_callbackTimer;
};
HashMap<CachedResourceClient*, OwnPtr<CachedResourceCallback> > m_clientsAwaitingCallback;
bool hasClient(CachedResourceClient* client) { return m_clients.contains(client) || m_clientsAwaitingCallback.contains(client); }
ResourceRequest m_resourceRequest;
String m_accept;
RefPtr<SubresourceLoader> m_loader;
ResourceLoaderOptions m_options;
ResourceLoadPriority m_loadPriority;
ResourceResponse m_response;
double m_responseTimestamp;
RefPtr<SharedBuffer> m_data;
OwnPtr<PurgeableBuffer> m_purgeableData;
private:
bool addClientToSet(CachedResourceClient*);
virtual PurgePriority purgePriority() const { return PurgeDefault; }
double currentAge() const;
double freshnessLifetime() const;
RefPtr<CachedMetadata> m_cachedMetadata;
double m_lastDecodedAccessTime; double m_loadFinishTime;
unsigned m_encodedSize;
unsigned m_decodedSize;
unsigned m_accessCount;
unsigned m_handleCount;
unsigned m_preloadCount;
unsigned m_preloadResult : 2;
bool m_inLiveDecodedResourcesList : 1;
bool m_requestedFromNetworkingLayer : 1;
bool m_inCache : 1;
bool m_loading : 1;
bool m_switchingClientsToRevalidatedResource : 1;
unsigned m_type : 4; unsigned m_status : 3;
#ifndef NDEBUG
bool m_deleted;
unsigned m_lruIndex;
#endif
CachedResource* m_nextInAllResourcesList;
CachedResource* m_prevInAllResourcesList;
CachedResource* m_nextInLiveResourcesList;
CachedResource* m_prevInLiveResourcesList;
CachedResourceLoader* m_owningCachedResourceLoader;
CachedResource* m_resourceToRevalidate;
CachedResource* m_proxyResource;
HashSet<CachedResourceHandleBase*> m_handlesToRevalidate;
};
}
#endif