gecko/netwerk/protocol/ftp/nsFTPChannel.h
Ehsan Akhgari 5236854e21 Bug 741059 - Part 1: Add APIs to nsIChannel to allow callers to override the private bit on the channel; r=jduell
This is probably the worst patch that I have ever written!

We add a setPrivate method to nsIPrivateBrowsingChannel which will be
implemented by channels who care about private browsing.  This allows the
client to explicitly override the private bit on the channel.
NS_UsePrivateBrowsing is also taught about this override bit using the
internal nsIPrivateBrowsingChannel::IsPrivateModeOverriden API.  This patch
implements the new API for HTTP, FTP and wyciwyg channels.  This also
modifies the IPC implementations of these channels to correctly transfer that
bit to the parent process if it has been set in the child process channel.
2012-09-04 20:37:45 -04:00

115 lines
3.4 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* vim:set ts=4 sw=4 sts=4 et cindent: */
/* 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 nsFTPChannel_h___
#define nsFTPChannel_h___
#include "nsBaseChannel.h"
#include "nsIIOService.h"
#include "nsIURI.h"
#include "nsString.h"
#include "nsILoadGroup.h"
#include "nsCOMPtr.h"
#include "nsIProtocolHandler.h"
#include "nsIProgressEventSink.h"
#include "nsIInterfaceRequestor.h"
#include "nsIInterfaceRequestorUtils.h"
#include "nsFtpConnectionThread.h"
#include "netCore.h"
#include "nsIStreamListener.h"
#include "nsIFTPChannel.h"
#include "nsIUploadChannel.h"
#include "nsIProxyInfo.h"
#include "nsIProxiedChannel.h"
#include "nsIResumableChannel.h"
#include "nsHashPropertyBag.h"
#include "nsFtpProtocolHandler.h"
#include "nsNetUtil.h"
#include "PrivateBrowsingChannel.h"
class nsFtpChannel : public nsBaseChannel,
public nsIFTPChannel,
public nsIUploadChannel,
public nsIResumableChannel,
public nsIProxiedChannel,
public mozilla::net::PrivateBrowsingChannel<nsFtpChannel>
{
public:
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_NSIUPLOADCHANNEL
NS_DECL_NSIRESUMABLECHANNEL
NS_DECL_NSIPROXIEDCHANNEL
nsFtpChannel(nsIURI *uri, nsIProxyInfo *pi)
: mProxyInfo(pi)
, mStartPos(0)
, mResumeRequested(false)
, mLastModifiedTime(0)
{
SetURI(uri);
}
nsIProxyInfo *ProxyInfo() {
return mProxyInfo;
}
// Were we asked to resume a download?
bool ResumeRequested() { return mResumeRequested; }
// Download from this byte offset
uint64_t StartPos() { return mStartPos; }
// ID of the entity to resume downloading
const nsCString &EntityID() {
return mEntityID;
}
void SetEntityID(const nsCSubstring &entityID) {
mEntityID = entityID;
}
NS_IMETHODIMP GetLastModifiedTime(PRTime* lastModifiedTime) {
*lastModifiedTime = mLastModifiedTime;
return NS_OK;
}
NS_IMETHODIMP SetLastModifiedTime(PRTime lastModifiedTime) {
mLastModifiedTime = lastModifiedTime;
return NS_OK;
}
// Data stream to upload
nsIInputStream *UploadStream() {
return mUploadStream;
}
// Helper function for getting the nsIFTPEventSink.
void GetFTPEventSink(nsCOMPtr<nsIFTPEventSink> &aResult);
protected:
virtual ~nsFtpChannel() {}
virtual nsresult OpenContentStream(bool async, nsIInputStream **result,
nsIChannel** channel);
virtual bool GetStatusArg(nsresult status, nsString &statusArg);
virtual void OnCallbacksChanged();
NS_IMETHOD SetNotificationCallbacks(nsIInterfaceRequestor* aCallbacks);
NS_IMETHOD SetLoadGroup(nsILoadGroup* aLoadGroup);
friend class mozilla::net::PrivateBrowsingChannel<nsFtpChannel>;
private:
nsCOMPtr<nsIProxyInfo> mProxyInfo;
nsCOMPtr<nsIFTPEventSink> mFTPEventSink;
nsCOMPtr<nsIInputStream> mUploadStream;
uint64_t mStartPos;
nsCString mEntityID;
bool mResumeRequested;
PRTime mLastModifiedTime;
};
#endif /* nsFTPChannel_h___ */