Blame netwerk/protocol/ftp/nsFTPChannel.h

Packit f0b94e
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
Packit f0b94e
/* vim:set ts=4 sw=4 sts=4 et cindent: */
Packit f0b94e
/* This Source Code Form is subject to the terms of the Mozilla Public
Packit f0b94e
 * License, v. 2.0. If a copy of the MPL was not distributed with this
Packit f0b94e
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
Packit f0b94e
Packit f0b94e
#ifndef nsFTPChannel_h___
Packit f0b94e
#define nsFTPChannel_h___
Packit f0b94e
Packit f0b94e
#include "nsBaseChannel.h"
Packit f0b94e
Packit f0b94e
#include "nsString.h"
Packit f0b94e
#include "nsCOMPtr.h"
Packit f0b94e
#include "nsIChannelWithDivertableParentListener.h"
Packit f0b94e
#include "nsIFTPChannel.h"
Packit f0b94e
#include "nsIForcePendingChannel.h"
Packit f0b94e
#include "nsIUploadChannel.h"
Packit f0b94e
#include "nsIProxyInfo.h"
Packit f0b94e
#include "nsIProxiedChannel.h"
Packit f0b94e
#include "nsIResumableChannel.h"
Packit f0b94e
Packit f0b94e
class nsIURI;
Packit f0b94e
using mozilla::net::ADivertableParentChannel;
Packit f0b94e
Packit f0b94e
class nsFtpChannel final : public nsBaseChannel,
Packit f0b94e
                           public nsIFTPChannel,
Packit f0b94e
                           public nsIUploadChannel,
Packit f0b94e
                           public nsIResumableChannel,
Packit f0b94e
                           public nsIProxiedChannel,
Packit f0b94e
                           public nsIForcePendingChannel,
Packit f0b94e
                           public nsIChannelWithDivertableParentListener {
Packit f0b94e
 public:
Packit f0b94e
  NS_DECL_ISUPPORTS_INHERITED
Packit f0b94e
  NS_DECL_NSIUPLOADCHANNEL
Packit f0b94e
  NS_DECL_NSIRESUMABLECHANNEL
Packit f0b94e
  NS_DECL_NSIPROXIEDCHANNEL
Packit f0b94e
  NS_DECL_NSICHANNELWITHDIVERTABLEPARENTLISTENER
Packit f0b94e
Packit f0b94e
  nsFtpChannel(nsIURI *uri, nsIProxyInfo *pi)
Packit f0b94e
      : mProxyInfo(pi),
Packit f0b94e
        mStartPos(0),
Packit f0b94e
        mResumeRequested(false),
Packit f0b94e
        mLastModifiedTime(0),
Packit f0b94e
        mForcePending(false) {
Packit f0b94e
    SetURI(uri);
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  void UpdateURI(nsIURI *aURI) {
Packit f0b94e
    MOZ_DIAGNOSTIC_ASSERT(NS_IsMainThread(), "Not thread-safe.");
Packit f0b94e
    mURI = aURI;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  nsIProxyInfo *ProxyInfo() { return mProxyInfo; }
Packit f0b94e
Packit f0b94e
  void SetProxyInfo(nsIProxyInfo *pi) { mProxyInfo = pi; }
Packit f0b94e
Packit f0b94e
  NS_IMETHOD IsPending(bool *result) override;
Packit f0b94e
Packit f0b94e
  // This is a short-cut to calling nsIRequest::IsPending().
Packit f0b94e
  // Overrides Pending in nsBaseChannel.
Packit f0b94e
  bool Pending() const override;
Packit f0b94e
Packit f0b94e
  // Were we asked to resume a download?
Packit f0b94e
  bool ResumeRequested() { return mResumeRequested; }
Packit f0b94e
Packit f0b94e
  // Download from this byte offset
Packit f0b94e
  uint64_t StartPos() { return mStartPos; }
Packit f0b94e
Packit f0b94e
  // ID of the entity to resume downloading
Packit f0b94e
  const nsCString &EntityID() { return mEntityID; }
Packit f0b94e
  void SetEntityID(const nsACString &entityID) { mEntityID = entityID; }
Packit f0b94e
Packit f0b94e
  NS_IMETHOD GetLastModifiedTime(PRTime *lastModifiedTime) override {
Packit f0b94e
    *lastModifiedTime = mLastModifiedTime;
Packit f0b94e
    return NS_OK;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  NS_IMETHOD SetLastModifiedTime(PRTime lastModifiedTime) override {
Packit f0b94e
    mLastModifiedTime = lastModifiedTime;
Packit f0b94e
    return NS_OK;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  // Data stream to upload
Packit f0b94e
  nsIInputStream *UploadStream() { return mUploadStream; }
Packit f0b94e
Packit f0b94e
  // Helper function for getting the nsIFTPEventSink.
Packit f0b94e
  void GetFTPEventSink(nsCOMPtr<nsIFTPEventSink> &aResult);
Packit f0b94e
Packit f0b94e
  NS_IMETHOD Suspend() override;
Packit f0b94e
  NS_IMETHOD Resume() override;
Packit f0b94e
Packit f0b94e
 public:
Packit f0b94e
  NS_IMETHOD ForcePending(bool aForcePending) override;
Packit f0b94e
Packit f0b94e
 protected:
Packit f0b94e
  virtual ~nsFtpChannel() {}
Packit f0b94e
  virtual nsresult OpenContentStream(bool async, nsIInputStream **result,
Packit f0b94e
                                     nsIChannel **channel) override;
Packit f0b94e
  virtual bool GetStatusArg(nsresult status, nsString &statusArg) override;
Packit f0b94e
  virtual void OnCallbacksChanged() override;
Packit f0b94e
Packit f0b94e
 private:
Packit f0b94e
  nsCOMPtr<nsIProxyInfo> mProxyInfo;
Packit f0b94e
  nsCOMPtr<nsIFTPEventSink> mFTPEventSink;
Packit f0b94e
  nsCOMPtr<nsIInputStream> mUploadStream;
Packit f0b94e
  uint64_t mStartPos;
Packit f0b94e
  nsCString mEntityID;
Packit f0b94e
  bool mResumeRequested;
Packit f0b94e
  PRTime mLastModifiedTime;
Packit f0b94e
  bool mForcePending;
Packit f0b94e
  RefPtr<ADivertableParentChannel> mParentChannel;
Packit f0b94e
};
Packit f0b94e
Packit f0b94e
#endif /* nsFTPChannel_h___ */