mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
439 lines
18 KiB
C++
439 lines
18 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* vim:set et cin ts=4 sw=4 sts=4: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef nsHttpChannel_h__
|
|
#define nsHttpChannel_h__
|
|
|
|
#include "HttpBaseChannel.h"
|
|
#include "nsTArray.h"
|
|
#include "nsICachingChannel.h"
|
|
#include "nsICacheEntry.h"
|
|
#include "nsICacheEntryOpenCallback.h"
|
|
#include "nsIDNSListener.h"
|
|
#include "nsIApplicationCacheChannel.h"
|
|
#include "nsIProtocolProxyCallback.h"
|
|
#include "nsIHttpAuthenticableChannel.h"
|
|
#include "nsIAsyncVerifyRedirectCallback.h"
|
|
#include "nsIThreadRetargetableRequest.h"
|
|
#include "nsIThreadRetargetableStreamListener.h"
|
|
#include "nsWeakReference.h"
|
|
#include "TimingStruct.h"
|
|
#include "AutoClose.h"
|
|
|
|
class nsIPrincipal;
|
|
class nsDNSPrefetch;
|
|
class nsICancelable;
|
|
class nsIHttpChannelAuthProvider;
|
|
class nsInputStreamPump;
|
|
class nsISSLStatus;
|
|
|
|
namespace mozilla { namespace net {
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// nsHttpChannel
|
|
//-----------------------------------------------------------------------------
|
|
|
|
class nsHttpChannel MOZ_FINAL : public HttpBaseChannel
|
|
, public HttpAsyncAborter<nsHttpChannel>
|
|
, public nsIStreamListener
|
|
, public nsICachingChannel
|
|
, public nsICacheEntryOpenCallback
|
|
, public nsITransportEventSink
|
|
, public nsIProtocolProxyCallback
|
|
, public nsIHttpAuthenticableChannel
|
|
, public nsIApplicationCacheChannel
|
|
, public nsIAsyncVerifyRedirectCallback
|
|
, public nsIThreadRetargetableRequest
|
|
, public nsIThreadRetargetableStreamListener
|
|
, public nsIDNSListener
|
|
, public nsSupportsWeakReference
|
|
{
|
|
public:
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_NSIREQUESTOBSERVER
|
|
NS_DECL_NSISTREAMLISTENER
|
|
NS_DECL_NSITHREADRETARGETABLESTREAMLISTENER
|
|
NS_DECL_NSICACHEINFOCHANNEL
|
|
NS_DECL_NSICACHINGCHANNEL
|
|
NS_DECL_NSICACHEENTRYOPENCALLBACK
|
|
NS_DECL_NSITRANSPORTEVENTSINK
|
|
NS_DECL_NSIPROTOCOLPROXYCALLBACK
|
|
NS_DECL_NSIPROXIEDCHANNEL
|
|
NS_DECL_NSIAPPLICATIONCACHECONTAINER
|
|
NS_DECL_NSIAPPLICATIONCACHECHANNEL
|
|
NS_DECL_NSIASYNCVERIFYREDIRECTCALLBACK
|
|
NS_DECL_NSITHREADRETARGETABLEREQUEST
|
|
NS_DECL_NSIDNSLISTENER
|
|
|
|
// nsIHttpAuthenticableChannel. We can't use
|
|
// NS_DECL_NSIHTTPAUTHENTICABLECHANNEL because it duplicates cancel() and
|
|
// others.
|
|
NS_IMETHOD GetIsSSL(bool *aIsSSL);
|
|
NS_IMETHOD GetProxyMethodIsConnect(bool *aProxyMethodIsConnect);
|
|
NS_IMETHOD GetServerResponseHeader(nsACString & aServerResponseHeader);
|
|
NS_IMETHOD GetProxyChallenges(nsACString & aChallenges);
|
|
NS_IMETHOD GetWWWChallenges(nsACString & aChallenges);
|
|
NS_IMETHOD SetProxyCredentials(const nsACString & aCredentials);
|
|
NS_IMETHOD SetWWWCredentials(const nsACString & aCredentials);
|
|
NS_IMETHOD OnAuthAvailable();
|
|
NS_IMETHOD OnAuthCancelled(bool userCancel);
|
|
// Functions we implement from nsIHttpAuthenticableChannel but are
|
|
// declared in HttpBaseChannel must be implemented in this class. We
|
|
// just call the HttpBaseChannel:: impls.
|
|
NS_IMETHOD GetLoadFlags(nsLoadFlags *aLoadFlags);
|
|
NS_IMETHOD GetURI(nsIURI **aURI);
|
|
NS_IMETHOD GetNotificationCallbacks(nsIInterfaceRequestor **aCallbacks);
|
|
NS_IMETHOD GetLoadGroup(nsILoadGroup **aLoadGroup);
|
|
NS_IMETHOD GetRequestMethod(nsACString& aMethod);
|
|
|
|
nsHttpChannel();
|
|
|
|
virtual nsresult Init(nsIURI *aURI, uint32_t aCaps, nsProxyInfo *aProxyInfo,
|
|
uint32_t aProxyResolveFlags,
|
|
nsIURI *aProxyURI);
|
|
|
|
// Methods HttpBaseChannel didn't implement for us or that we override.
|
|
//
|
|
// nsIRequest
|
|
NS_IMETHOD Cancel(nsresult status);
|
|
NS_IMETHOD Suspend();
|
|
NS_IMETHOD Resume();
|
|
// nsIChannel
|
|
NS_IMETHOD GetSecurityInfo(nsISupports **aSecurityInfo);
|
|
NS_IMETHOD AsyncOpen(nsIStreamListener *listener, nsISupports *aContext);
|
|
// nsIHttpChannelInternal
|
|
NS_IMETHOD SetupFallbackChannel(const char *aFallbackKey);
|
|
// nsISupportsPriority
|
|
NS_IMETHOD SetPriority(int32_t value);
|
|
// nsIResumableChannel
|
|
NS_IMETHOD ResumeAt(uint64_t startPos, const nsACString& entityID);
|
|
|
|
NS_IMETHOD SetNotificationCallbacks(nsIInterfaceRequestor *aCallbacks);
|
|
NS_IMETHOD SetLoadGroup(nsILoadGroup *aLoadGroup);
|
|
// nsITimedChannel
|
|
NS_IMETHOD GetDomainLookupStart(mozilla::TimeStamp *aDomainLookupStart);
|
|
NS_IMETHOD GetDomainLookupEnd(mozilla::TimeStamp *aDomainLookupEnd);
|
|
NS_IMETHOD GetConnectStart(mozilla::TimeStamp *aConnectStart);
|
|
NS_IMETHOD GetConnectEnd(mozilla::TimeStamp *aConnectEnd);
|
|
NS_IMETHOD GetRequestStart(mozilla::TimeStamp *aRequestStart);
|
|
NS_IMETHOD GetResponseStart(mozilla::TimeStamp *aResponseStart);
|
|
NS_IMETHOD GetResponseEnd(mozilla::TimeStamp *aResponseEnd);
|
|
|
|
public: /* internal necko use only */
|
|
|
|
void InternalSetUploadStream(nsIInputStream *uploadStream)
|
|
{ mUploadStream = uploadStream; }
|
|
void SetUploadStreamHasHeaders(bool hasHeaders)
|
|
{ mUploadStreamHasHeaders = hasHeaders; }
|
|
|
|
nsresult SetReferrerInternal(nsIURI *referrer) {
|
|
nsAutoCString spec;
|
|
nsresult rv = referrer->GetAsciiSpec(spec);
|
|
if (NS_FAILED(rv)) return rv;
|
|
mReferrer = referrer;
|
|
mRequestHead.SetHeader(nsHttp::Referer, spec);
|
|
return NS_OK;
|
|
}
|
|
|
|
// This allows cache entry to be marked as foreign even after channel itself
|
|
// is gone. Needed for e10s (see HttpChannelParent::RecvDocumentChannelCleanup)
|
|
class OfflineCacheEntryAsForeignMarker {
|
|
nsCOMPtr<nsIApplicationCache> mApplicationCache;
|
|
nsCOMPtr<nsIURI> mCacheURI;
|
|
public:
|
|
OfflineCacheEntryAsForeignMarker(nsIApplicationCache* appCache,
|
|
nsIURI* aURI)
|
|
: mApplicationCache(appCache)
|
|
, mCacheURI(aURI)
|
|
{}
|
|
|
|
nsresult MarkAsForeign();
|
|
};
|
|
|
|
OfflineCacheEntryAsForeignMarker* GetOfflineCacheEntryAsForeignMarker();
|
|
|
|
// Helper to keep cache callbacks wait flags consistent
|
|
class AutoCacheWaitFlags
|
|
{
|
|
public:
|
|
explicit AutoCacheWaitFlags(nsHttpChannel* channel)
|
|
: mChannel(channel)
|
|
, mKeep(0)
|
|
{
|
|
// Flags must be set before entering any AsyncOpenCacheEntry call.
|
|
mChannel->mCacheEntriesToWaitFor =
|
|
nsHttpChannel::WAIT_FOR_CACHE_ENTRY |
|
|
nsHttpChannel::WAIT_FOR_OFFLINE_CACHE_ENTRY;
|
|
}
|
|
|
|
void Keep(uint32_t flags)
|
|
{
|
|
// Called after successful call to appropriate AsyncOpenCacheEntry call.
|
|
mKeep |= flags;
|
|
}
|
|
|
|
~AutoCacheWaitFlags()
|
|
{
|
|
// Keep only flags those are left to be wait for.
|
|
mChannel->mCacheEntriesToWaitFor &= mKeep;
|
|
}
|
|
|
|
private:
|
|
nsHttpChannel* mChannel;
|
|
uint32_t mKeep : 2;
|
|
};
|
|
|
|
protected:
|
|
virtual ~nsHttpChannel();
|
|
|
|
private:
|
|
typedef nsresult (nsHttpChannel::*nsContinueRedirectionFunc)(nsresult result);
|
|
|
|
bool RequestIsConditional();
|
|
nsresult BeginConnect();
|
|
nsresult Connect();
|
|
nsresult ContinueConnect();
|
|
void SpeculativeConnect();
|
|
nsresult SetupTransaction();
|
|
void SetupTransactionLoadGroupInfo();
|
|
nsresult CallOnStartRequest();
|
|
nsresult ProcessResponse();
|
|
nsresult ContinueProcessResponse(nsresult);
|
|
nsresult ProcessNormal();
|
|
nsresult ContinueProcessNormal(nsresult);
|
|
nsresult ProcessNotModified();
|
|
nsresult AsyncProcessRedirection(uint32_t httpStatus);
|
|
nsresult ContinueProcessRedirection(nsresult);
|
|
nsresult ContinueProcessRedirectionAfterFallback(nsresult);
|
|
nsresult ProcessFailedProxyConnect(uint32_t httpStatus);
|
|
nsresult ProcessFallback(bool *waitingForRedirectCallback);
|
|
nsresult ContinueProcessFallback(nsresult);
|
|
void HandleAsyncAbort();
|
|
nsresult EnsureAssocReq();
|
|
void ProcessSSLInformation();
|
|
bool IsHTTPS();
|
|
void RetrieveSSLOptions();
|
|
|
|
nsresult ContinueOnStartRequest1(nsresult);
|
|
nsresult ContinueOnStartRequest2(nsresult);
|
|
nsresult ContinueOnStartRequest3(nsresult);
|
|
|
|
// redirection specific methods
|
|
void HandleAsyncRedirect();
|
|
void HandleAsyncAPIRedirect();
|
|
nsresult ContinueHandleAsyncRedirect(nsresult);
|
|
void HandleAsyncNotModified();
|
|
void HandleAsyncFallback();
|
|
nsresult ContinueHandleAsyncFallback(nsresult);
|
|
nsresult PromptTempRedirect();
|
|
nsresult StartRedirectChannelToURI(nsIURI *, uint32_t);
|
|
virtual nsresult SetupReplacementChannel(nsIURI *, nsIChannel *, bool preserveMethod);
|
|
|
|
// proxy specific methods
|
|
nsresult ProxyFailover();
|
|
nsresult AsyncDoReplaceWithProxy(nsIProxyInfo *);
|
|
nsresult ContinueDoReplaceWithProxy(nsresult);
|
|
nsresult ResolveProxy();
|
|
|
|
// cache specific methods
|
|
nsresult OpenCacheEntry(bool usingSSL);
|
|
nsresult OnOfflineCacheEntryAvailable(nsICacheEntry *aEntry,
|
|
bool aNew,
|
|
nsIApplicationCache* aAppCache,
|
|
nsresult aResult);
|
|
nsresult OnNormalCacheEntryAvailable(nsICacheEntry *aEntry,
|
|
bool aNew,
|
|
nsresult aResult);
|
|
nsresult OpenOfflineCacheEntryForWriting();
|
|
nsresult OnOfflineCacheEntryForWritingAvailable(nsICacheEntry *aEntry,
|
|
nsIApplicationCache* aAppCache,
|
|
nsresult aResult);
|
|
nsresult OnCacheEntryAvailableInternal(nsICacheEntry *entry,
|
|
bool aNew,
|
|
nsIApplicationCache* aAppCache,
|
|
nsresult status);
|
|
nsresult GenerateCacheKey(uint32_t postID, nsACString &key);
|
|
nsresult UpdateExpirationTime();
|
|
nsresult CheckPartial(nsICacheEntry* aEntry, int64_t *aSize, int64_t *aContentLength);
|
|
bool ShouldUpdateOfflineCacheEntry();
|
|
nsresult ReadFromCache(bool alreadyMarkedValid);
|
|
void CloseCacheEntry(bool doomOnFailure);
|
|
void CloseOfflineCacheEntry();
|
|
nsresult InitCacheEntry();
|
|
void UpdateInhibitPersistentCachingFlag();
|
|
nsresult InitOfflineCacheEntry();
|
|
nsresult AddCacheEntryHeaders(nsICacheEntry *entry);
|
|
nsresult StoreAuthorizationMetaData(nsICacheEntry *entry);
|
|
nsresult FinalizeCacheEntry();
|
|
nsresult InstallCacheListener(int64_t offset = 0);
|
|
nsresult InstallOfflineCacheListener(int64_t offset = 0);
|
|
void MaybeInvalidateCacheEntryForSubsequentGet();
|
|
void AsyncOnExamineCachedResponse();
|
|
|
|
// Handle the bogus Content-Encoding Apache sometimes sends
|
|
void ClearBogusContentEncodingIfNeeded();
|
|
|
|
// byte range request specific methods
|
|
nsresult ProcessPartialContent();
|
|
nsresult OnDoneReadingPartialCacheEntry(bool *streamDone);
|
|
|
|
nsresult DoAuthRetry(nsAHttpConnection *);
|
|
|
|
void HandleAsyncRedirectChannelToHttps();
|
|
nsresult StartRedirectChannelToHttps();
|
|
nsresult ContinueAsyncRedirectChannelToURI(nsresult rv);
|
|
nsresult OpenRedirectChannel(nsresult rv);
|
|
|
|
/**
|
|
* A function that takes care of reading STS and PKP headers and enforcing
|
|
* STS and PKP load rules. After a secure channel is erected, STS and PKP
|
|
* requires the channel to be trusted or any STS or PKP header data on
|
|
* the channel is ignored. This is called from ProcessResponse.
|
|
*/
|
|
nsresult ProcessSecurityHeaders();
|
|
|
|
/**
|
|
* A function to process a single security header (STS or PKP), assumes
|
|
* some basic sanity checks have been applied to the channel. Called
|
|
* from ProcessSecurityHeaders.
|
|
*/
|
|
nsresult ProcessSingleSecurityHeader(uint32_t aType,
|
|
nsISSLStatus *aSSLStatus,
|
|
uint32_t aFlags);
|
|
|
|
void InvalidateCacheEntryForLocation(const char *location);
|
|
void AssembleCacheKey(const char *spec, uint32_t postID, nsACString &key);
|
|
nsresult CreateNewURI(const char *loc, nsIURI **newURI);
|
|
void DoInvalidateCacheEntry(nsIURI* aURI);
|
|
|
|
// Ref RFC2616 13.10: "invalidation... MUST only be performed if
|
|
// the host part is the same as in the Request-URI"
|
|
inline bool HostPartIsTheSame(nsIURI *uri) {
|
|
nsAutoCString tmpHost1, tmpHost2;
|
|
return (NS_SUCCEEDED(mURI->GetAsciiHost(tmpHost1)) &&
|
|
NS_SUCCEEDED(uri->GetAsciiHost(tmpHost2)) &&
|
|
(tmpHost1 == tmpHost2));
|
|
}
|
|
|
|
inline static bool DoNotRender3xxBody(nsresult rv) {
|
|
return rv == NS_ERROR_REDIRECT_LOOP ||
|
|
rv == NS_ERROR_CORRUPTED_CONTENT ||
|
|
rv == NS_ERROR_UNKNOWN_PROTOCOL ||
|
|
rv == NS_ERROR_MALFORMED_URI;
|
|
}
|
|
|
|
// Create a aggregate set of the current notification callbacks
|
|
// and ensure the transaction is updated to use it.
|
|
void UpdateAggregateCallbacks();
|
|
|
|
static bool HasQueryString(nsHttpRequestHead::ParsedMethodType method, nsIURI * uri);
|
|
bool ResponseWouldVary(nsICacheEntry* entry) const;
|
|
bool MustValidateBasedOnQueryUrl() const;
|
|
bool IsResumable(int64_t partialLen, int64_t contentLength,
|
|
bool ignoreMissingPartialLen = false) const;
|
|
nsresult MaybeSetupByteRangeRequest(int64_t partialLen, int64_t contentLength,
|
|
bool ignoreMissingPartialLen = false);
|
|
nsresult SetupByteRangeRequest(int64_t partialLen);
|
|
nsresult OpenCacheInputStream(nsICacheEntry* cacheEntry, bool startBuffering,
|
|
bool checkingAppCacheEntry);
|
|
|
|
private:
|
|
nsCOMPtr<nsISupports> mSecurityInfo;
|
|
nsCOMPtr<nsICancelable> mProxyRequest;
|
|
|
|
nsRefPtr<nsInputStreamPump> mTransactionPump;
|
|
nsRefPtr<nsHttpTransaction> mTransaction;
|
|
|
|
uint64_t mLogicalOffset;
|
|
|
|
// cache specific data
|
|
nsCOMPtr<nsICacheEntry> mCacheEntry;
|
|
// We must close mCacheInputStream explicitly to avoid leaks.
|
|
AutoClose<nsIInputStream> mCacheInputStream;
|
|
nsRefPtr<nsInputStreamPump> mCachePump;
|
|
nsAutoPtr<nsHttpResponseHead> mCachedResponseHead;
|
|
nsCOMPtr<nsISupports> mCachedSecurityInfo;
|
|
uint32_t mPostID;
|
|
uint32_t mRequestTime;
|
|
|
|
nsCOMPtr<nsICacheEntry> mOfflineCacheEntry;
|
|
uint32_t mOfflineCacheLastModifiedTime;
|
|
nsCOMPtr<nsIApplicationCache> mApplicationCacheForWrite;
|
|
|
|
// auth specific data
|
|
nsCOMPtr<nsIHttpChannelAuthProvider> mAuthProvider;
|
|
|
|
// If the channel is associated with a cache, and the URI matched
|
|
// a fallback namespace, this will hold the key for the fallback
|
|
// cache entry.
|
|
nsCString mFallbackKey;
|
|
|
|
friend class AutoRedirectVetoNotifier;
|
|
friend class HttpAsyncAborter<nsHttpChannel>;
|
|
|
|
nsCOMPtr<nsIURI> mRedirectURI;
|
|
nsCOMPtr<nsIChannel> mRedirectChannel;
|
|
uint32_t mRedirectType;
|
|
|
|
static const uint32_t WAIT_FOR_CACHE_ENTRY = 1;
|
|
static const uint32_t WAIT_FOR_OFFLINE_CACHE_ENTRY = 2;
|
|
|
|
// state flags
|
|
uint32_t mCachedContentIsValid : 1;
|
|
uint32_t mCachedContentIsPartial : 1;
|
|
uint32_t mCacheOnlyMetadata : 1;
|
|
uint32_t mTransactionReplaced : 1;
|
|
uint32_t mAuthRetryPending : 1;
|
|
uint32_t mProxyAuthPending : 1;
|
|
uint32_t mResuming : 1;
|
|
uint32_t mInitedCacheEntry : 1;
|
|
// True if we are loading a fallback cache entry from the
|
|
// application cache.
|
|
uint32_t mFallbackChannel : 1;
|
|
// True if consumer added its own If-None-Match or If-Modified-Since
|
|
// headers. In such a case we must not override them in the cache code
|
|
// and also we want to pass possible 304 code response through.
|
|
uint32_t mCustomConditionalRequest : 1;
|
|
uint32_t mFallingBack : 1;
|
|
uint32_t mWaitingForRedirectCallback : 1;
|
|
// True if mRequestTime has been set. In such a case it is safe to update
|
|
// the cache entry's expiration time. Otherwise, it is not(see bug 567360).
|
|
uint32_t mRequestTimeInitialized : 1;
|
|
uint32_t mCacheEntryIsReadOnly : 1;
|
|
uint32_t mCacheEntryIsWriteOnly : 1;
|
|
// see WAIT_FOR_* constants above
|
|
uint32_t mCacheEntriesToWaitFor : 2;
|
|
uint32_t mHasQueryString : 1;
|
|
// whether cache entry data write was in progress during cache entry check
|
|
// when true, after we finish read from cache we must check all data
|
|
// had been loaded from cache. If not, then an error has to be propagated
|
|
// to the consumer.
|
|
uint32_t mConcurentCacheAccess : 1;
|
|
// whether the request is setup be byte-range
|
|
uint32_t mIsPartialRequest : 1;
|
|
// true iff there is AutoRedirectVetoNotifier on the stack
|
|
uint32_t mHasAutoRedirectVetoNotifier : 1;
|
|
|
|
nsTArray<nsContinueRedirectionFunc> mRedirectFuncStack;
|
|
|
|
// Needed for accurate DNS timing
|
|
nsRefPtr<nsDNSPrefetch> mDNSPrefetch;
|
|
|
|
nsresult WaitForRedirectCallback();
|
|
void PushRedirectAsyncFunc(nsContinueRedirectionFunc func);
|
|
void PopRedirectAsyncFunc(nsContinueRedirectionFunc func);
|
|
|
|
protected:
|
|
virtual void DoNotifyListenerCleanup();
|
|
|
|
private: // cache telemetry
|
|
bool mDidReval;
|
|
};
|
|
|
|
} } // namespace mozilla::net
|
|
|
|
#endif // nsHttpChannel_h__
|