mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-06 17:16:12 +00:00
351 lines
15 KiB
C++
351 lines
15 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: */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is Mozilla.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications.
|
|
* Portions created by the Initial Developer are Copyright (C) 2001
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Darin Fisher <darin@netscape.com> (original author)
|
|
* Christian Biesinger <cbiesinger@web.de>
|
|
* Daniel Witte <dwitte@mozilla.com>
|
|
* Jason Duell <jduell.mcbugs@gmail.com>
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#ifndef nsHttpChannel_h__
|
|
#define nsHttpChannel_h__
|
|
|
|
#include "HttpBaseChannel.h"
|
|
|
|
#include "nsHttpTransaction.h"
|
|
#include "nsInputStreamPump.h"
|
|
#include "nsThreadUtils.h"
|
|
#include "nsTArray.h"
|
|
|
|
#include "nsIHttpEventSink.h"
|
|
#include "nsICachingChannel.h"
|
|
#include "nsICacheEntryDescriptor.h"
|
|
#include "nsICacheListener.h"
|
|
#include "nsIApplicationCacheChannel.h"
|
|
#include "nsIPrompt.h"
|
|
#include "nsIResumableChannel.h"
|
|
#include "nsIProtocolProxyCallback.h"
|
|
#include "nsICancelable.h"
|
|
#include "nsIHttpAuthenticableChannel.h"
|
|
#include "nsITraceableChannel.h"
|
|
#include "nsIHttpChannelAuthProvider.h"
|
|
#include "nsIAsyncVerifyRedirectCallback.h"
|
|
|
|
class nsAHttpConnection;
|
|
class AutoRedirectVetoNotifier;
|
|
|
|
using namespace mozilla::net;
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// nsHttpChannel
|
|
//-----------------------------------------------------------------------------
|
|
|
|
class nsHttpChannel : public HttpBaseChannel
|
|
, public nsIStreamListener
|
|
, public nsICachingChannel
|
|
, public nsICacheListener
|
|
, public nsITransportEventSink
|
|
, public nsIProtocolProxyCallback
|
|
, public nsIHttpAuthenticableChannel
|
|
, public nsITraceableChannel
|
|
, public nsIApplicationCacheChannel
|
|
, public nsIAsyncVerifyRedirectCallback
|
|
{
|
|
public:
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_NSIREQUESTOBSERVER
|
|
NS_DECL_NSISTREAMLISTENER
|
|
NS_DECL_NSICACHEINFOCHANNEL
|
|
NS_DECL_NSICACHINGCHANNEL
|
|
NS_DECL_NSICACHELISTENER
|
|
NS_DECL_NSITRANSPORTEVENTSINK
|
|
NS_DECL_NSIPROTOCOLPROXYCALLBACK
|
|
NS_DECL_NSIPROXIEDCHANNEL
|
|
NS_DECL_NSITRACEABLECHANNEL
|
|
NS_DECL_NSIAPPLICATIONCACHECONTAINER
|
|
NS_DECL_NSIAPPLICATIONCACHECHANNEL
|
|
NS_DECL_NSIASYNCVERIFYREDIRECTCALLBACK
|
|
|
|
// nsIHttpAuthenticableChannel. We can't use
|
|
// NS_DECL_NSIHTTPAUTHENTICABLECHANNEL because it duplicates cancel() and
|
|
// others.
|
|
NS_IMETHOD GetIsSSL(PRBool *aIsSSL);
|
|
NS_IMETHOD GetProxyMethodIsConnect(PRBool *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(PRBool 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 ~nsHttpChannel();
|
|
|
|
virtual nsresult Init(nsIURI *aURI, PRUint8 aCaps, nsProxyInfo *aProxyInfo);
|
|
|
|
// 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(PRInt32 value);
|
|
// nsIResumableChannel
|
|
NS_IMETHOD ResumeAt(PRUint64 startPos, const nsACString& entityID);
|
|
|
|
public: /* internal necko use only */
|
|
typedef void (nsHttpChannel:: *nsAsyncCallback)(void);
|
|
|
|
void InternalSetUploadStream(nsIInputStream *uploadStream)
|
|
{ mUploadStream = uploadStream; }
|
|
void SetUploadStreamHasHeaders(PRBool hasHeaders)
|
|
{ mUploadStreamHasHeaders = hasHeaders; }
|
|
|
|
nsresult SetReferrerInternal(nsIURI *referrer) {
|
|
nsCAutoString spec;
|
|
nsresult rv = referrer->GetAsciiSpec(spec);
|
|
if (NS_FAILED(rv)) return rv;
|
|
mReferrer = referrer;
|
|
mRequestHead.SetHeader(nsHttp::Referer, spec);
|
|
return NS_OK;
|
|
}
|
|
|
|
private:
|
|
typedef nsresult (nsHttpChannel::*nsContinueRedirectionFunc)(nsresult result);
|
|
|
|
// AsyncCall may be used to call a member function asynchronously.
|
|
// retval isn't refcounted and is set only when event was successfully
|
|
// posted, the event is returned for the purpose of cancelling when needed
|
|
nsresult AsyncCall(nsAsyncCallback funcPtr,
|
|
nsRunnableMethod<nsHttpChannel> **retval = nsnull);
|
|
|
|
PRBool RequestIsConditional();
|
|
nsresult Connect(PRBool firstTime = PR_TRUE);
|
|
nsresult AsyncAbort(nsresult status);
|
|
// Send OnStartRequest/OnStopRequest to our listener, if any.
|
|
void HandleAsyncNotifyListener();
|
|
void DoNotifyListener();
|
|
nsresult SetupTransaction();
|
|
nsresult CallOnStartRequest();
|
|
nsresult ProcessResponse();
|
|
nsresult ContinueProcessResponse(nsresult);
|
|
nsresult ProcessNormal();
|
|
nsresult ContinueProcessNormal(nsresult);
|
|
nsresult ProcessNotModified();
|
|
nsresult AsyncProcessRedirection(PRUint32 httpStatus);
|
|
nsresult ContinueProcessRedirection(nsresult);
|
|
nsresult ContinueProcessRedirectionAfterFallback(nsresult);
|
|
PRBool ShouldSSLProxyResponseContinue(PRUint32 httpStatus);
|
|
nsresult ProcessFailedSSLConnect(PRUint32 httpStatus);
|
|
nsresult ProcessFallback(PRBool *waitingForRedirectCallback);
|
|
nsresult ContinueProcessFallback(nsresult);
|
|
PRBool ResponseWouldVary();
|
|
|
|
nsresult ContinueOnStartRequest1(nsresult);
|
|
nsresult ContinueOnStartRequest2(nsresult);
|
|
nsresult ContinueOnStartRequest3(nsresult);
|
|
|
|
// redirection specific methods
|
|
void HandleAsyncRedirect();
|
|
nsresult ContinueHandleAsyncRedirect(nsresult);
|
|
void HandleAsyncNotModified();
|
|
void HandleAsyncFallback();
|
|
nsresult ContinueHandleAsyncFallback(nsresult);
|
|
nsresult PromptTempRedirect();
|
|
virtual nsresult SetupReplacementChannel(nsIURI *, nsIChannel *, PRBool preserveMethod);
|
|
|
|
// proxy specific methods
|
|
nsresult ProxyFailover();
|
|
nsresult AsyncDoReplaceWithProxy(nsIProxyInfo *);
|
|
nsresult ContinueDoReplaceWithProxy(nsresult);
|
|
void HandleAsyncReplaceWithProxy();
|
|
nsresult ContinueHandleAsyncReplaceWithProxy(nsresult);
|
|
nsresult ResolveProxy();
|
|
|
|
// cache specific methods
|
|
nsresult OpenCacheEntry();
|
|
nsresult OnOfflineCacheEntryAvailable(nsICacheEntryDescriptor *aEntry,
|
|
nsCacheAccessMode aAccess,
|
|
nsresult aResult,
|
|
PRBool aSync);
|
|
nsresult OpenNormalCacheEntry(PRBool aSync);
|
|
nsresult OnNormalCacheEntryAvailable(nsICacheEntryDescriptor *aEntry,
|
|
nsCacheAccessMode aAccess,
|
|
nsresult aResult,
|
|
PRBool aSync);
|
|
nsresult OpenOfflineCacheEntryForWriting();
|
|
nsresult GenerateCacheKey(PRUint32 postID, nsACString &key);
|
|
nsresult UpdateExpirationTime();
|
|
nsresult CheckCache();
|
|
nsresult ShouldUpdateOfflineCacheEntry(PRBool *shouldCacheForOfflineUse);
|
|
nsresult ReadFromCache();
|
|
void CloseCacheEntry(PRBool doomOnFailure);
|
|
void CloseOfflineCacheEntry();
|
|
nsresult InitCacheEntry();
|
|
nsresult InitOfflineCacheEntry();
|
|
nsresult AddCacheEntryHeaders(nsICacheEntryDescriptor *entry);
|
|
nsresult StoreAuthorizationMetaData(nsICacheEntryDescriptor *entry);
|
|
nsresult FinalizeCacheEntry();
|
|
nsresult InstallCacheListener(PRUint32 offset = 0);
|
|
nsresult InstallOfflineCacheListener();
|
|
void MaybeInvalidateCacheEntryForSubsequentGet();
|
|
nsCacheStoragePolicy DetermineStoragePolicy();
|
|
nsresult DetermineCacheAccess(nsCacheAccessMode *_retval);
|
|
void AsyncOnExamineCachedResponse();
|
|
|
|
// Handle the bogus Content-Encoding Apache sometimes sends
|
|
void ClearBogusContentEncodingIfNeeded();
|
|
|
|
// byte range request specific methods
|
|
nsresult SetupByteRangeRequest(PRUint32 partialLen);
|
|
nsresult ProcessPartialContent();
|
|
nsresult OnDoneReadingPartialCacheEntry(PRBool *streamDone);
|
|
|
|
nsresult DoAuthRetry(nsAHttpConnection *);
|
|
PRBool MustValidateBasedOnQueryUrl();
|
|
|
|
void HandleAsyncRedirectChannelToHttps();
|
|
nsresult AsyncRedirectChannelToHttps();
|
|
nsresult ContinueAsyncRedirectChannelToHttps(nsresult rv);
|
|
|
|
/**
|
|
* A function that takes care of reading STS headers and enforcing STS
|
|
* load rules. After a secure channel is erected, STS requires the channel
|
|
* to be trusted or any STS header data on the channel is ignored.
|
|
* This is called from ProcessResponse.
|
|
*/
|
|
nsresult ProcessSTSHeader();
|
|
|
|
private:
|
|
nsCOMPtr<nsISupports> mSecurityInfo;
|
|
nsCOMPtr<nsICancelable> mProxyRequest;
|
|
|
|
nsRefPtr<nsInputStreamPump> mTransactionPump;
|
|
nsRefPtr<nsHttpTransaction> mTransaction;
|
|
|
|
PRUint64 mLogicalOffset;
|
|
|
|
// cache specific data
|
|
nsCOMPtr<nsICacheEntryDescriptor> mCacheEntry;
|
|
nsRefPtr<nsInputStreamPump> mCachePump;
|
|
nsAutoPtr<nsHttpResponseHead> mCachedResponseHead;
|
|
nsCacheAccessMode mCacheAccess;
|
|
PRUint32 mPostID;
|
|
PRUint32 mRequestTime;
|
|
|
|
typedef nsresult (nsHttpChannel:: *nsOnCacheEntryAvailableCallback)(
|
|
nsICacheEntryDescriptor *, nsCacheAccessMode, nsresult, PRBool);
|
|
nsOnCacheEntryAvailableCallback mOnCacheEntryAvailableCallback;
|
|
PRBool mAsyncCacheOpen;
|
|
|
|
nsCOMPtr<nsICacheEntryDescriptor> mOfflineCacheEntry;
|
|
nsCacheAccessMode mOfflineCacheAccess;
|
|
nsCString mOfflineCacheClientID;
|
|
|
|
// auth specific data
|
|
nsCOMPtr<nsIHttpChannelAuthProvider> mAuthProvider;
|
|
|
|
// Function pointer that can be set to indicate that we got suspended while
|
|
// waiting on an AsyncCall. When we get resumed we should AsyncCall this
|
|
// function.
|
|
nsAsyncCallback mPendingAsyncCallOnResume;
|
|
|
|
// Proxy info to replace with
|
|
nsCOMPtr<nsIProxyInfo> mTargetProxyInfo;
|
|
|
|
// Suspend counter. This is used if someone tries to suspend/resume us
|
|
// before we have either a cache pump or a transaction pump.
|
|
PRUint32 mSuspendCount;
|
|
|
|
// 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;
|
|
nsCOMPtr<nsIURI> mRedirectURI;
|
|
nsCOMPtr<nsIChannel> mRedirectChannel;
|
|
PRUint32 mRedirectType;
|
|
|
|
// state flags
|
|
PRUint32 mCachedContentIsValid : 1;
|
|
PRUint32 mCachedContentIsPartial : 1;
|
|
PRUint32 mTransactionReplaced : 1;
|
|
PRUint32 mAuthRetryPending : 1;
|
|
PRUint32 mResuming : 1;
|
|
PRUint32 mInitedCacheEntry : 1;
|
|
PRUint32 mCacheForOfflineUse : 1;
|
|
// True if mCacheForOfflineUse was set because we were caching
|
|
// opportunistically.
|
|
PRUint32 mCachingOpportunistically : 1;
|
|
// True if we are loading a fallback cache entry from the
|
|
// application cache.
|
|
PRUint32 mFallbackChannel : 1;
|
|
PRUint32 mTracingEnabled : 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.
|
|
PRUint32 mCustomConditionalRequest : 1;
|
|
PRUint32 mFallingBack : 1;
|
|
PRUint32 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).
|
|
PRUint32 mRequestTimeInitialized : 1;
|
|
|
|
nsTArray<nsContinueRedirectionFunc> mRedirectFuncStack;
|
|
|
|
nsresult WaitForRedirectCallback();
|
|
void PushRedirectAsyncFunc(nsContinueRedirectionFunc func);
|
|
void PopRedirectAsyncFunc(nsContinueRedirectionFunc func);
|
|
};
|
|
|
|
#endif // nsHttpChannel_h__
|