#pragma once
#include "CachePolicy.h"
#include "CacheValidation.h"
#include "FrameLoaderTypes.h"
#include "ResourceError.h"
#include "ResourceLoadPriority.h"
#include "ResourceLoaderOptions.h"
#include "ResourceRequest.h"
#include "ResourceResponse.h"
#include "SessionID.h"
#include "Timer.h"
#include <time.h>
#include <wtf/HashCountedSet.h>
#include <wtf/HashSet.h>
#include <wtf/TypeCasts.h>
#include <wtf/Vector.h>
#include <wtf/text/WTFString.h>
namespace WebCore {
class CachedResourceClient;
class CachedResourceHandleBase;
class CachedResourceLoader;
class CachedResourceRequest;
class LoadTiming;
class MemoryCache;
class SecurityOrigin;
class SharedBuffer;
class SubresourceLoader;
class TextResourceDecoder;
class CachedResource {
WTF_MAKE_NONCOPYABLE(CachedResource); WTF_MAKE_FAST_ALLOCATED;
friend class MemoryCache;
public:
enum Type {
MainResource,
ImageResource,
CSSStyleSheet,
Script,
FontResource,
#if ENABLE(SVG_FONTS)
SVGFontResource,
#endif
MediaResource,
RawResource,
Icon,
SVGDocumentResource
#if ENABLE(XSLT)
, XSLStyleSheet
#endif
#if ENABLE(LINK_PREFETCH)
, LinkPrefetch
, LinkSubresource
#endif
#if ENABLE(VIDEO_TRACK)
, TextTrackResource
#endif
};
enum Status {
Unknown, Pending, Cached, LoadError,
DecodeError
};
CachedResource(CachedResourceRequest&&, Type, SessionID);
virtual ~CachedResource();
virtual void load(CachedResourceLoader&);
virtual void setEncoding(const String&) { }
virtual String encoding() const { return String(); }
virtual const TextResourceDecoder* textResourceDecoder() const { return nullptr; }
virtual void addDataBuffer(SharedBuffer&);
virtual void addData(const char* data, unsigned length);
virtual void finishLoading(SharedBuffer*);
virtual void error(CachedResource::Status);
void setResourceError(const ResourceError& error) { m_error = error; }
const ResourceError& resourceError() const { return m_error; }
virtual bool shouldIgnoreHTTPStatusCodeErrors() const { return false; }
const ResourceRequest& resourceRequest() const { return m_resourceRequest; }
ResourceRequest& resourceRequest() { return m_resourceRequest; }
const URL& url() const { return m_resourceRequest.url();}
const String& cachePartition() const { return m_resourceRequest.cachePartition(); }
SessionID sessionID() const { return m_sessionID; }
Type type() const { return m_type; }
ResourceLoadPriority loadPriority() const { return m_loadPriority; }
void setLoadPriority(const std::optional<ResourceLoadPriority>&);
WEBCORE_EXPORT void addClient(CachedResourceClient&);
WEBCORE_EXPORT void removeClient(CachedResourceClient&);
bool hasClients() const { return !m_clients.isEmpty() || !m_clientsAwaitingCallback.isEmpty(); }
bool hasClient(CachedResourceClient& client) { return m_clients.contains(&client) || m_clientsAwaitingCallback.contains(&client); }
bool deleteIfPossible();
enum PreloadResult {
PreloadNotReferenced,
PreloadReferenced,
PreloadReferencedWhileLoading,
PreloadReferencedWhileComplete
};
PreloadResult preloadResult() const { return static_cast<PreloadResult>(m_preloadResult); }
virtual void didAddClient(CachedResourceClient&);
virtual void didRemoveClient(CachedResourceClient&) { }
virtual void allClientsRemoved() { }
void destroyDecodedDataIfNeeded();
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 stillNeedsLoad() const { return false; }
SubresourceLoader* loader() { return m_loader.get(); }
bool areAllClientsXMLHttpRequests() const;
bool isImage() const { return type() == ImageResource; }
bool isMainOrMediaOrIconOrRawResource() const { return type() == MainResource || type() == MediaResource || type() == Icon || type() == RawResource; }
bool ignoreForRequestCount() const
{
return m_resourceRequest.ignoreForRequestCount()
|| type() == MainResource
#if ENABLE(LINK_PREFETCH)
|| type() == LinkPrefetch
|| type() == LinkSubresource
#endif
|| type() == Icon
|| type() == RawResource;
}
unsigned accessCount() const { return m_accessCount; }
void increaseAccessCount() { m_accessCount++; }
void finish();
void setInCache(bool inCache) { m_inCache = inCache; }
bool inCache() const { return m_inCache; }
void clearLoader();
SharedBuffer* resourceBuffer() const { return m_data.get(); }
virtual void redirectReceived(ResourceRequest&, const ResourceResponse&);
virtual void responseReceived(const ResourceResponse&);
virtual bool shouldCacheResponse(const ResourceResponse&) { return true; }
void setResponse(const ResourceResponse&);
const ResourceResponse& response() const { return m_response; }
void setCrossOrigin();
bool isCrossOrigin() const;
bool isCORSSameOrigin() const;
ResourceResponse::Tainting responseTainting() const { return m_responseTainting; }
void loadFrom(const CachedResource&);
SecurityOrigin* origin() const { return m_origin.get(); }
AtomicString initiatorName() const { return m_initiatorName; }
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;
void cancelLoad();
bool wasCanceled() const { return m_error.isCancellation(); }
bool errorOccurred() const { return m_status == LoadError || m_status == DecodeError; }
bool loadFailedOrCanceled() const { return !m_error.isNull(); }
bool shouldSendResourceLoadCallbacks() const { return m_options.sendLoadCallbacks == SendCallbacks; }
DataBufferingPolicy dataBufferingPolicy() const { return m_options.dataBufferingPolicy; }
bool allowsCaching() const { return m_options.cachingPolicy == CachingPolicy::AllowCaching; }
const FetchOptions& options() const { return m_options; }
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; }
bool isLinkPreload() { return m_isLinkPreload; }
void setLinkPreload() { m_isLinkPreload = true; }
bool hasUnknownEncoding() { return m_hasUnknownEncoding; }
void setHasUnknownEncoding(bool hasUnknownEncoding) { m_hasUnknownEncoding = hasUnknownEncoding; }
void registerHandle(CachedResourceHandleBase*);
WEBCORE_EXPORT void unregisterHandle(CachedResourceHandleBase*);
bool canUseCacheValidator() const;
enum class RevalidationDecision { No, YesDueToCachePolicy, YesDueToNoStore, YesDueToNoCache, YesDueToExpired };
virtual RevalidationDecision makeRevalidationDecision(CachePolicy) const;
bool redirectChainAllowsReuse(ReuseExpiredRedirectionOrNot) const;
bool hasRedirections() const { return m_redirectChainCacheStatus.status != RedirectChainCacheStatus::Status::NoRedirection; }
bool varyHeaderValuesMatch(const ResourceRequest&);
bool isCacheValidator() const { return m_resourceToRevalidate; }
CachedResource* resourceToRevalidate() const { return m_resourceToRevalidate; }
void setResourceToRevalidate(CachedResource*);
virtual void switchClientsToRevalidatedResource();
void clearResourceToRevalidate();
void updateResponseAfterRevalidation(const ResourceResponse& validatingResponse);
bool validationInProgress() const { return m_proxyResource; }
bool validationCompleting() const { return m_proxyResource && m_proxyResource->m_switchingClientsToRevalidatedResource; }
virtual void didSendData(unsigned long long , unsigned long long ) { }
virtual void didRetrieveDerivedDataFromCache(const String& , SharedBuffer&) { }
#if USE(FOUNDATION) || USE(SOUP)
WEBCORE_EXPORT void tryReplaceEncodedData(SharedBuffer&);
#endif
#if USE(SOUP)
virtual char* getOrCreateReadBuffer(size_t , size_t& ) { return nullptr; }
#endif
unsigned long identifierForLoadWithoutResourceLoader() const { return m_identifierForLoadWithoutResourceLoader; }
static ResourceLoadPriority defaultPriorityForResourceType(Type);
protected:
CachedResource(const URL&, Type, SessionID);
void setEncodedSize(unsigned);
void setDecodedSize(unsigned);
void didAccessDecodedData(double timeStamp);
virtual void didReplaceSharedBufferContents() { }
virtual void setBodyDataFrom(const CachedResource&);
HashCountedSet<CachedResourceClient*> m_clients;
ResourceRequest m_resourceRequest;
RefPtr<SubresourceLoader> m_loader;
ResourceLoaderOptions m_options;
ResourceResponse m_response;
ResourceResponse::Tainting m_responseTainting { ResourceResponse::Tainting::Basic };
RefPtr<SharedBuffer> m_data;
DeferrableOneShotTimer m_decodedDataDeletionTimer;
private:
class Callback;
bool addClientToSet(CachedResourceClient&);
void decodedDataDeletionTimerFired();
virtual void checkNotify();
virtual bool mayTryReplaceEncodedData() const { return false; }
std::chrono::microseconds freshnessLifetime(const ResourceResponse&) const;
void addAdditionalRequestHeaders(CachedResourceLoader&);
void failBeforeStarting();
HashMap<CachedResourceClient*, std::unique_ptr<Callback>> m_clientsAwaitingCallback;
SessionID m_sessionID;
ResourceLoadPriority m_loadPriority;
std::chrono::system_clock::time_point m_responseTimestamp;
String m_fragmentIdentifierForRequest;
ResourceError m_error;
RefPtr<SecurityOrigin> m_origin;
AtomicString m_initiatorName;
double m_lastDecodedAccessTime { 0 };
unsigned m_encodedSize { 0 };
unsigned m_decodedSize { 0 };
unsigned m_accessCount { 0 };
unsigned m_handleCount { 0 };
unsigned m_preloadCount { 0 };
PreloadResult m_preloadResult { PreloadNotReferenced };
bool m_requestedFromNetworkingLayer { false };
bool m_inCache { false };
bool m_loading { false };
bool m_isLinkPreload { false };
bool m_hasUnknownEncoding { false };
bool m_switchingClientsToRevalidatedResource { false };
Type m_type; unsigned m_status { Pending };
#ifndef NDEBUG
bool m_deleted { false };
unsigned m_lruIndex { 0 };
#endif
CachedResourceLoader* m_owningCachedResourceLoader { nullptr };
CachedResource* m_resourceToRevalidate { nullptr };
CachedResource* m_proxyResource { nullptr };
HashSet<CachedResourceHandleBase*> m_handlesToRevalidate;
RedirectChainCacheStatus m_redirectChainCacheStatus;
Vector<std::pair<String, String>> m_varyingHeaderValues;
unsigned long m_identifierForLoadWithoutResourceLoader { 0 };
};
class CachedResource::Callback {
#if !COMPILER(MSVC)
WTF_MAKE_FAST_ALLOCATED;
#endif
public:
Callback(CachedResource&, CachedResourceClient&);
void cancel();
private:
void timerFired();
CachedResource& m_resource;
CachedResourceClient& m_client;
Timer m_timer;
};
}
#define SPECIALIZE_TYPE_TRAITS_CACHED_RESOURCE(ToClassName, CachedResourceType) \
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToClassName) \
static bool isType(const WebCore::CachedResource& resource) { return resource.type() == WebCore::CachedResourceType; } \
SPECIALIZE_TYPE_TRAITS_END()