ResourceRequestBase.h [plain text]
#ifndef ResourceRequestBase_h
#define ResourceRequestBase_h
#include "FormData.h"
#include "HTTPHeaderMap.h"
#include "URL.h"
#include "ResourceLoadPriority.h"
namespace WebCore {
enum ResourceRequestCachePolicy {
UseProtocolCachePolicy, ReloadIgnoringCacheData, ReturnCacheDataElseLoad, ReturnCacheDataDontLoad };
enum HTTPBodyUpdatePolicy {
DoNotUpdateHTTPBody,
UpdateHTTPBody
};
class ResourceRequest;
struct CrossThreadResourceRequestData;
class ResourceRequestBase {
WTF_MAKE_FAST_ALLOCATED;
public:
static std::unique_ptr<ResourceRequest> adopt(std::unique_ptr<CrossThreadResourceRequestData>);
std::unique_ptr<CrossThreadResourceRequestData> copyData() const;
WEBCORE_EXPORT bool isNull() const;
WEBCORE_EXPORT bool isEmpty() const;
WEBCORE_EXPORT const URL& url() const;
WEBCORE_EXPORT void setURL(const URL& url);
void removeCredentials();
WEBCORE_EXPORT ResourceRequestCachePolicy cachePolicy() const;
WEBCORE_EXPORT void setCachePolicy(ResourceRequestCachePolicy cachePolicy);
double timeoutInterval() const; void setTimeoutInterval(double timeoutInterval);
WEBCORE_EXPORT const URL& firstPartyForCookies() const;
void setFirstPartyForCookies(const URL& firstPartyForCookies);
WEBCORE_EXPORT const String& httpMethod() const;
WEBCORE_EXPORT void setHTTPMethod(const String& httpMethod);
WEBCORE_EXPORT const HTTPHeaderMap& httpHeaderFields() const;
WEBCORE_EXPORT void setHTTPHeaderFields(HTTPHeaderMap);
WEBCORE_EXPORT String httpHeaderField(const String& name) const;
WEBCORE_EXPORT String httpHeaderField(HTTPHeaderName) const;
WEBCORE_EXPORT void setHTTPHeaderField(const String& name, const String& value);
WEBCORE_EXPORT void setHTTPHeaderField(HTTPHeaderName, const String& value);
void addHTTPHeaderField(const String& name, const String& value);
template<size_t length> String httpHeaderField(const char (&)[length]) const = delete;
template<size_t length> void setHTTPHeaderField(const char (&)[length], const String&) = delete;
template<size_t length> void addHTTPHeaderField(const char (&)[length], const String&) = delete;
void clearHTTPAuthorization();
WEBCORE_EXPORT String httpContentType() const;
WEBCORE_EXPORT void setHTTPContentType(const String&);
void clearHTTPContentType();
String httpReferrer() const;
WEBCORE_EXPORT void setHTTPReferrer(const String&);
void clearHTTPReferrer();
String httpOrigin() const;
void setHTTPOrigin(const String&);
void clearHTTPOrigin();
String httpUserAgent() const;
void setHTTPUserAgent(const String&);
void clearHTTPUserAgent();
String httpAccept() const;
void setHTTPAccept(const String&);
void clearHTTPAccept();
const Vector<String>& responseContentDispositionEncodingFallbackArray() const { return m_responseContentDispositionEncodingFallbackArray; }
WEBCORE_EXPORT void setResponseContentDispositionEncodingFallbackArray(const String& encoding1, const String& encoding2 = String(), const String& encoding3 = String());
WEBCORE_EXPORT FormData* httpBody() const;
WEBCORE_EXPORT void setHTTPBody(PassRefPtr<FormData> httpBody);
bool allowCookies() const;
void setAllowCookies(bool allowCookies);
WEBCORE_EXPORT ResourceLoadPriority priority() const;
WEBCORE_EXPORT void setPriority(ResourceLoadPriority);
WEBCORE_EXPORT bool isConditional() const;
void makeUnconditional();
bool reportUploadProgress() const { return m_reportUploadProgress; }
void setReportUploadProgress(bool reportUploadProgress) { m_reportUploadProgress = reportUploadProgress; }
bool reportLoadTiming() const { return m_reportLoadTiming; }
void setReportLoadTiming(bool reportLoadTiming) { m_reportLoadTiming = reportLoadTiming; }
bool reportRawHeaders() const { return m_reportRawHeaders; }
void setReportRawHeaders(bool reportRawHeaders) { m_reportRawHeaders = reportRawHeaders; }
bool hiddenFromInspector() const { return m_hiddenFromInspector; }
void setHiddenFromInspector(bool hiddenFromInspector) { m_hiddenFromInspector = hiddenFromInspector; }
enum class Requester { Unspecified, Main, XHR };
Requester requester() const { return m_requester; }
void setRequester(Requester requester) { m_requester = requester; }
#if !PLATFORM(COCOA)
bool encodingRequiresPlatformData() const { return true; }
#endif
template<class Encoder> void encodeWithoutPlatformData(Encoder&) const;
template<class Decoder> bool decodeWithoutPlatformData(Decoder&);
WEBCORE_EXPORT static double defaultTimeoutInterval(); WEBCORE_EXPORT static void setDefaultTimeoutInterval(double);
#if PLATFORM(IOS)
WEBCORE_EXPORT static bool defaultAllowCookies();
WEBCORE_EXPORT static void setDefaultAllowCookies(bool);
#endif
static bool compare(const ResourceRequest&, const ResourceRequest&);
protected:
ResourceRequestBase()
: m_platformRequestUpdated(true)
, m_platformRequestBodyUpdated(true)
{
}
ResourceRequestBase(const URL& url, ResourceRequestCachePolicy policy)
: m_url(url)
, m_timeoutInterval(s_defaultTimeoutInterval)
, m_httpMethod(ASCIILiteral("GET"))
, m_cachePolicy(policy)
#if !PLATFORM(IOS)
, m_allowCookies(true)
#else
, m_allowCookies(ResourceRequestBase::defaultAllowCookies())
#endif
, m_resourceRequestUpdated(true)
, m_resourceRequestBodyUpdated(true)
{
}
void updatePlatformRequest(HTTPBodyUpdatePolicy = DoNotUpdateHTTPBody) const;
void updateResourceRequest(HTTPBodyUpdatePolicy = DoNotUpdateHTTPBody) const;
static bool platformCompare(const ResourceRequest&, const ResourceRequest&) { return true; }
URL m_url;
double m_timeoutInterval; URL m_firstPartyForCookies;
String m_httpMethod;
HTTPHeaderMap m_httpHeaderFields;
Vector<String> m_responseContentDispositionEncodingFallbackArray;
RefPtr<FormData> m_httpBody;
ResourceRequestCachePolicy m_cachePolicy { UseProtocolCachePolicy };
bool m_allowCookies { false };
mutable bool m_resourceRequestUpdated { false };
mutable bool m_platformRequestUpdated { false };
mutable bool m_resourceRequestBodyUpdated { false };
mutable bool m_platformRequestBodyUpdated { false };
bool m_reportUploadProgress { false };
bool m_reportLoadTiming { false };
bool m_reportRawHeaders { false };
bool m_hiddenFromInspector { false };
ResourceLoadPriority m_priority { ResourceLoadPriority::Low };
Requester m_requester { Requester::Unspecified };
private:
const ResourceRequest& asResourceRequest() const;
WEBCORE_EXPORT static double s_defaultTimeoutInterval;
#if PLATFORM(IOS)
static bool s_defaultAllowCookies;
#endif
};
bool equalIgnoringHeaderFields(const ResourceRequestBase&, const ResourceRequestBase&);
inline bool operator==(const ResourceRequest& a, const ResourceRequest& b) { return ResourceRequestBase::compare(a, b); }
inline bool operator!=(ResourceRequest& a, const ResourceRequest& b) { return !(a == b); }
struct CrossThreadResourceRequestDataBase {
URL url;
ResourceRequestCachePolicy cachePolicy;
double timeoutInterval;
URL firstPartyForCookies;
String httpMethod;
std::unique_ptr<CrossThreadHTTPHeaderMapData> httpHeaders;
Vector<String> responseContentDispositionEncodingFallbackArray;
RefPtr<FormData> httpBody;
bool allowCookies;
ResourceLoadPriority priority;
ResourceRequestBase::Requester requester;
};
unsigned initializeMaximumHTTPConnectionCountPerHost();
#if PLATFORM(IOS)
WEBCORE_EXPORT void initializeHTTPConnectionSettingsOnStartup();
#endif
template<class Encoder>
void ResourceRequestBase::encodeWithoutPlatformData(Encoder& encoder) const
{
ASSERT(!m_httpBody);
ASSERT(!m_platformRequestUpdated);
encoder << m_url.string();
encoder << m_timeoutInterval;
encoder << m_firstPartyForCookies.string();
encoder << m_httpMethod;
encoder << m_httpHeaderFields;
encoder << m_responseContentDispositionEncodingFallbackArray;
encoder.encodeEnum(m_cachePolicy);
encoder << m_allowCookies;
encoder.encodeEnum(m_priority);
encoder.encodeEnum(m_requester);
}
template<class Decoder>
bool ResourceRequestBase::decodeWithoutPlatformData(Decoder& decoder)
{
String url;
if (!decoder.decode(url))
return false;
m_url = URL(ParsedURLString, url);
if (!decoder.decode(m_timeoutInterval))
return false;
String firstPartyForCookies;
if (!decoder.decode(firstPartyForCookies))
return false;
m_firstPartyForCookies = URL(ParsedURLString, firstPartyForCookies);
if (!decoder.decode(m_httpMethod))
return false;
if (!decoder.decode(m_httpHeaderFields))
return false;
if (!decoder.decode(m_responseContentDispositionEncodingFallbackArray))
return false;
ResourceRequestCachePolicy cachePolicy;
if (!decoder.decodeEnum(cachePolicy))
return false;
m_cachePolicy = cachePolicy;
bool allowCookies;
if (!decoder.decode(allowCookies))
return false;
m_allowCookies = allowCookies;
ResourceLoadPriority priority;
if (!decoder.decodeEnum(priority))
return false;
m_priority = priority;
if (!decoder.decodeEnum(m_requester))
return false;
return true;
}
}
#endif // ResourceRequestBase_h