FTP client functionality shared among FTP Gateway and Relay clients. More...

#include <FtpClient.h>

Inheritance diagram for Ftp::Client:
Collaboration diagram for Ftp::Client:

Public Types

enum  {
  BEGIN,
  SENT_USER,
  SENT_PASS,
  SENT_TYPE,
  SENT_MDTM,
  SENT_SIZE,
  SENT_EPRT,
  SENT_PORT,
  SENT_EPSV_ALL,
  SENT_EPSV_1,
  SENT_EPSV_2,
  SENT_PASV,
  SENT_CWD,
  SENT_LIST,
  SENT_NLST,
  SENT_REST,
  SENT_RETR,
  SENT_STOR,
  SENT_QUIT,
  READING_DATA,
  WRITING_DATA,
  SENT_MKDIR,
  SENT_FEAT,
  SENT_PWD,
  SENT_CDUP,
  SENT_DATA_REQUEST,
  SENT_COMMAND,
  END
}
 
typedef CbcPointer< AsyncJobPointer
 
typedef CbcPointer< BodyProducerPointer
 
typedef CbcPointer< BodyConsumerPointer
 

Public Member Functions

 Client (FwdState *fwdState)
 
virtual ~Client ()
 
virtual void failed (err_type error=ERR_NONE, int xerrno=0, ErrorState *ftperr=nullptr)
 handle a fatal transaction error, closing the control connection More...
 
virtual void timeout (const CommTimeoutCbParams &io)
 read timeout handler More...
 
virtual void maybeReadVirginBody ()
 read response data from the network More...
 
void writeCommand (const char *buf)
 
bool handlePasvReply (Ip::Address &remoteAddr)
 
bool handleEpsvReply (Ip::Address &remoteAddr)
 
bool sendEprt ()
 
bool sendPort ()
 
bool sendPassive ()
 
void connectDataChannel ()
 
bool openListenSocket ()
 
void switchTimeoutToDataChannel ()
 
virtual void noteMoreBodyDataAvailable (BodyPipe::Pointer)
 
virtual void noteBodyProductionEnded (BodyPipe::Pointer)
 
virtual void noteBodyProducerAborted (BodyPipe::Pointer)
 
virtual bool abortOnData (const char *reason)
 
virtual HttpRequestPointer originalRequest ()
 a hack to reach HttpStateData::orignal_request More...
 
virtual void noteAdaptationAnswer (const Adaptation::Answer &answer)
 
virtual void noteAdaptationAclCheckDone (Adaptation::ServiceGroupPointer group)
 
virtual void noteMoreBodySpaceAvailable (BodyPipe::Pointer)
 
virtual void noteBodyConsumerAborted (BodyPipe::Pointer)
 
virtual bool getMoreRequestBody (MemBuf &buf)
 either fill buf with available [encoded] request body bytes or return false More...
 
virtual void processReplyBody ()=0
 
virtual void swanSong ()
 
virtual bool doneAll () const
 whether positive goal has been reached More...
 
void serverComplete ()
 
bool canBeCalled (AsyncCall &call) const
 whether we can be called More...
 
void callStart (AsyncCall &call)
 
virtual void callEnd ()
 called right after the called job method More...
 
virtual void callException (const std::exception &e)
 called when the job throws during an async call More...
 
virtual void * toCbdata ()=0
 

Static Public Member Functions

static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...
 

Public Attributes

CtrlChannel ctrl
 FTP control channel state. More...
 
DataChannel data
 FTP data channel state. More...
 
enum Ftp::Client:: { ... }  ftp_state_t
 
int state
 
char * old_request
 
char * old_reply
 
StoreEntryentry = nullptr
 
FwdState::Pointer fwd
 
HttpRequestPointer request
 

Protected Member Functions

virtual void start ()
 called by AsyncStart; do not call directly More...
 
virtual void closeServer ()
 
virtual bool doneWithServer () const
 
virtual const
Comm::ConnectionPointer
dataConnection () const
 
virtual void abortAll (const char *reason)
 abnormal transaction termination; reason is for debugging only More...
 
virtual Http::StatusCode failedHttpStatus (err_type &error)
 
void ctrlClosed (const CommCloseCbParams &io)
 handler called by Comm when FTP control channel is closed unexpectedly More...
 
void scheduleReadControlReply (int buffered_ok)
 
void readControlReply (const CommIoCbParams &io)
 
virtual void handleControlReply ()
 
void writeCommandCallback (const CommIoCbParams &io)
 
virtual void dataChannelConnected (const CommConnectCbParams &io)=0
 
void dataRead (const CommIoCbParams &io)
 
void dataComplete ()
 
AsyncCall::Pointer dataCloser ()
 creates a data channel Comm close callback More...
 
virtual void dataClosed (const CommCloseCbParams &io)
 handler called by Comm when FTP data channel is closed unexpectedly More...
 
void initReadBuf ()
 
virtual void sentRequestBody (const CommIoCbParams &io)
 
virtual void doneSendingRequestBody ()
 
virtual void haveParsedReplyHeaders ()
 called when we have final (possibly adapted) reply headers; kids extend More...
 
virtual void completeForwarding ()
 
bool startRequestBodyFlow ()
 
void handleMoreRequestBodyAvailable ()
 
void handleRequestBodyProductionEnded ()
 
virtual void handleRequestBodyProducerAborted ()=0
 
void sendMoreRequestBody ()
 
virtual bool mayReadVirginReplyBody () const =0
 whether we may receive more virgin response body bytes More...
 
bool abortOnBadEntry (const char *abortReason)
 Entry-dependent callbacks use this check to quit if the entry went bad. More...
 
bool blockCaching ()
 whether to prevent caching of an otherwise cachable response More...
 
void startAdaptation (const Adaptation::ServiceGroupPointer &group, HttpRequest *cause)
 Initiate an asynchronous adaptation transaction which will call us back. More...
 
void adaptVirginReplyBody (const char *buf, ssize_t len)
 
void cleanAdaptation ()
 
virtual bool doneWithAdaptation () const
 
void handleMoreAdaptedBodyAvailable ()
 
void handleAdaptedBodyProductionEnded ()
 
void handleAdaptedBodyProducerAborted ()
 
void handleAdaptedHeader (Http::Message *msg)
 
void handleAdaptationCompleted ()
 
void handleAdaptationBlocked (const Adaptation::Answer &answer)
 
void handleAdaptationAborted (bool bypassable=false)
 
bool handledEarlyAdaptationAbort ()
 
void resumeBodyStorage ()
 called by StoreEntry when it has more buffer space available More...
 
void endAdaptedBodyConsumption ()
 called when the entire adapted response body is consumed More...
 
const HttpReplyvirginReply () const
 
HttpReplyvirginReply ()
 
HttpReplysetVirginReply (HttpReply *r)
 
HttpReplyfinalReply ()
 
HttpReplysetFinalReply (HttpReply *r)
 
void adaptOrFinalizeReply ()
 
void addVirginReplyBody (const char *buf, ssize_t len)
 
void storeReplyBody (const char *buf, ssize_t len)
 
size_t replyBodySpace (const MemBuf &readBuf, const size_t minSpace) const
 
size_t calcBufferSpaceToReserve (const size_t space, const size_t wantSpace) const
 determine how much space the buffer needs to reserve More...
 
void adjustBodyBytesRead (const int64_t delta)
 initializes bodyBytesRead stats if needed and applies delta More...
 
CbcPointer< Initiate > initiateAdaptation (Initiate *x)
 < starts freshly created initiate and returns a safe pointer to it More...
 
void clearAdaptation (CbcPointer< Initiate > &x)
 clears the pointer (does not call announceInitiatorAbort) More...
 
void announceInitiatorAbort (CbcPointer< Initiate > &x)
 inform the transaction about abnormal termination and clear the pointer More...
 
bool initiated (const CbcPointer< AsyncJob > &job) const
 Must(initiated(initiate)) instead of Must(initiate.set()), for clarity. More...
 
void deleteThis (const char *aReason)
 
void mustStop (const char *aReason)
 
bool done () const
 the job is destroyed in callEnd() when done() More...
 
virtual const char * status () const
 internal cleanup; do not call directly More...
 
void stopProducingFor (RefCount< BodyPipe > &, bool atEof)
 
void stopConsumingFrom (RefCount< BodyPipe > &)
 

Protected Attributes

int64_t currentOffset = 0
 
MemBufresponseBodyBuffer = nullptr
 
BodyPipe::Pointer requestBodySource
 
AsyncCall::Pointer requestSender
 
BodyPipe::Pointer virginBodyDestination
 
CbcPointer< Adaptation::InitiateadaptedHeadSource
 
BodyPipe::Pointer adaptedBodySource
 
bool adaptationAccessCheckPending = false
 
bool startedAdaptation = false
 
bool receivedWholeRequestBody = false
 handleRequestBodyProductionEnded called More...
 
const char * doneWithFwd = nullptr
 
const char * stopReason
 reason for forcing done() to be true More...
 
const char * typeName
 kid (leaf) class name, for debugging More...
 
AsyncCall::Pointer inCall
 the asynchronous call being handled, if any More...
 
const InstanceId< AsyncJobid
 job identifier More...
 

Private Member Functions

 CBDATA_CLASS (Client)
 
bool parseControlReply (size_t &bytesUsed)
 

Private Attributes

bool shortenReadTimeout
 

Detailed Description

Definition at line 92 of file FtpClient.h.

Member Typedef Documentation

Definition at line 25 of file BodyPipe.h.

Definition at line 34 of file AsyncJob.h.

Definition at line 45 of file BodyPipe.h.

Member Enumeration Documentation

anonymous enum
Enumerator
BEGIN 
SENT_USER 
SENT_PASS 
SENT_TYPE 
SENT_MDTM 
SENT_SIZE 
SENT_EPRT 
SENT_PORT 
SENT_EPSV_ALL 
SENT_EPSV_1 
SENT_EPSV_2 
SENT_PASV 
SENT_CWD 
SENT_LIST 
SENT_NLST 
SENT_REST 
SENT_RETR 
SENT_STOR 
SENT_QUIT 
READING_DATA 
WRITING_DATA 
SENT_MKDIR 
SENT_FEAT 
SENT_PWD 
SENT_CDUP 
SENT_DATA_REQUEST 
SENT_COMMAND 
END 

Definition at line 127 of file FtpClient.h.

Constructor & Destructor Documentation

Client::~Client ( )
virtual

Reimplemented from Client.

Definition at line 185 of file FtpClient.cc.

References data, NULL, and safe_free.

Member Function Documentation

void Ftp::Client::abortAll ( const char *  reason)
protectedvirtual

Implements Client.

Definition at line 1018 of file FtpClient.cc.

References data, debugs, and NULL.

bool Client::abortOnData ( const char *  reason)
virtualinherited

abnormal data transfer termination

Return values
truethe transaction will be terminated (abortAll called) false the transaction will survive

Reimplemented in Ftp::Relay.

Definition at line 288 of file Client.cc.

References Client::abortAll().

Referenced by Client::abortOnBadEntry(), Client::handleAdaptationBlocked(), Client::sendBodyIsTooLargeError(), and Client::sentRequestBody().

void Client::adaptVirginReplyBody ( const char *  buf,
ssize_t  len 
)
protectedinherited
void Client::adjustBodyBytesRead ( const int64_t  delta)
protectedinherited
void Adaptation::Initiator::announceInitiatorAbort ( CbcPointer< Initiate > &  x)
protectedinherited

Definition at line 38 of file Initiator.cc.

References CallJobHere.

Referenced by Client::cleanAdaptation(), and ClientHttpRequest::~ClientHttpRequest().

size_t Client::calcBufferSpaceToReserve ( const size_t  space,
const size_t  wantSpace 
) const
protectedinherited
void AsyncJob::callEnd ( )
virtualinherited
void AsyncJob::callStart ( AsyncCall call)
inherited
bool AsyncJob::canBeCalled ( AsyncCall call) const
inherited

Definition at line 101 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.

Ftp::Client::CBDATA_CLASS ( Client  )
private
void Adaptation::Initiator::clearAdaptation ( CbcPointer< Initiate > &  x)
protectedinherited
void Ftp::Client::closeServer ( )
protectedvirtual

Close the FTP server connection(s). Used by serverComplete().

Implements Client.

Definition at line 217 of file FtpClient.cc.

References data, debugs, and Comm::IsConnOpen().

void Client::completeForwarding ( )
protectedvirtualinherited
void Ftp::Client::ctrlClosed ( const CommCloseCbParams io)
protected

Definition at line 860 of file FtpClient.cc.

References debugs.

Referenced by Client().

virtual void Ftp::Client::dataChannelConnected ( const CommConnectCbParams io)
protectedpure virtual

Implemented in Ftp::Gateway, and Ftp::Relay.

Referenced by connectDataChannel().

void Ftp::Client::dataClosed ( const CommCloseCbParams io)
protectedvirtual

Reimplemented in Ftp::Gateway.

Definition at line 792 of file FtpClient.cc.

References data, debugs, and NULL.

Referenced by Ftp::Gateway::dataClosed(), and dataCloser().

AsyncCall::Pointer Ftp::Client::dataCloser ( )
protected

Definition at line 784 of file FtpClient.cc.

References dataClosed(), and JobCallback.

void Client::dataComplete ( )
protected

Close data channel, if any, to conserve resources while we wait.

Definition at line 989 of file FtpClient.cc.

References data, and debugs.

Referenced by Ftp::Relay::abort().

const Comm::ConnectionPointer & Client::dataConnection ( ) const
protectedvirtual
Returns
primary or "request data connection"

Implements Client.

Definition at line 881 of file FtpClient.cc.

References data.

void AsyncJob::deleteThis ( const char *  aReason)
protectedinherited
bool AsyncJob::done ( ) const
protectedinherited

Definition at line 90 of file AsyncJob.cc.

References AsyncJob::doneAll(), NULL, and AsyncJob::stopReason.

Referenced by AsyncJob::callEnd(), and Downloader::downloadFinished().

bool Client::doneAll ( ) const
virtualinherited

Reimplemented from AsyncJob.

Definition at line 194 of file Client.cc.

References AsyncJob::doneAll(), Client::doneWithAdaptation(), and Client::doneWithServer().

void Ftp::Client::doneSendingRequestBody ( )
protectedvirtual

called after we wrote the last byte of the request body

Implements Client.

Definition at line 1052 of file FtpClient.cc.

References debugs, and Client::doneSendingRequestBody().

bool Client::doneWithAdaptation ( ) const
protectedvirtualinherited
bool Ftp::Client::doneWithServer ( ) const
protectedvirtual

Did we close all FTP server connection(s)?

Return values
trueBoth server control and data channels are closed. And not waiting for a new data connection to open.
falseEither control channel or data is still active.

Implements Client.

Definition at line 240 of file FtpClient.cc.

References data, and Comm::IsConnOpen().

void Client::endAdaptedBodyConsumption ( )
protectedinherited
Http::StatusCode Client::failedHttpStatus ( err_type error)
protectedvirtual
HttpReply * Client::finalReply ( )
protectedinherited

Definition at line 129 of file Client.cc.

References assert, and Client::theFinalReply.

Referenced by HttpStateData::haveParsedReplyHeaders(), and HttpStateData::reusableReply().

bool Client::getMoreRequestBody ( MemBuf buf)
virtualinherited
void Client::handleAdaptationAborted ( bool  bypassable = false)
protectedinherited
void Client::handleAdaptedBodyProductionEnded ( )
protectedinherited
void Client::handleControlReply ( )
protectedvirtual

Reimplemented in Ftp::Gateway, and Ftp::Relay.

Definition at line 403 of file FtpClient.cc.

References assert, debugs, memReallocBuf(), and wordlistDestroy().

Referenced by Ftp::Relay::handleControlReply(), and Ftp::Gateway::handleControlReply().

bool Client::handledEarlyAdaptationAbort ( )
protectedinherited
bool Client::handleEpsvReply ( Ip::Address remoteAddr)
void Client::handleMoreRequestBodyAvailable ( )
protectedinherited
bool Client::handlePasvReply ( Ip::Address remoteAddr)

extracts remoteAddr from PASV response, validates it, sets data address details, and returns true on success

Definition at line 439 of file FtpClient.cc.

References buf, code, Config, data, DBG_IMPORTANT, debugs, fd_table, SquidConfig::Ftp, Comm::IsConnOpen(), NULL, Ftp::ParseIpPort(), and SquidConfig::sanitycheck.

Referenced by ftpReadPasv().

void Client::handleRequestBodyProductionEnded ( )
protectedinherited
void Client::haveParsedReplyHeaders ( )
protectedvirtualinherited
CbcPointer< Adaptation::Initiate > Adaptation::Initiator::initiateAdaptation ( Initiate x)
protectedinherited
bool Adaptation::Initiator::initiated ( const CbcPointer< AsyncJob > &  job) const
inlineprotectedinherited

Definition at line 52 of file Initiator.h.

References CbcPointer< Cbc >::set().

Referenced by Client::startAdaptation(), and ClientHttpRequest::startAdaptation().

void Client::initReadBuf ( )
protected

Definition at line 205 of file FtpClient.cc.

References data, and NULL.

Referenced by Ftp::Gateway::Gateway().

void Client::maybeReadVirginBody ( )
virtual
virtual bool Client::mayReadVirginReplyBody ( ) const
protectedpure virtualinherited
void Client::noteAdaptationAclCheckDone ( Adaptation::ServiceGroupPointer  group)
virtualinherited

AccessCheck calls this back with a possibly nil service group to signal whether adaptation is needed and where it should start.

Reimplemented from Adaptation::Initiator.

Definition at line 906 of file Client.cc.

References Client::abortOnBadEntry(), Client::adaptationAccessCheckPending, debugs, HERE(), Client::originalRequest(), Client::processReplyBody(), Client::request, Client::sendBodyIsTooLargeError(), Client::setFinalReply(), Client::startAdaptation(), and Client::virginReply().

void Client::noteAdaptationAnswer ( const Adaptation::Answer answer)
virtualinherited
void Client::noteBodyConsumerAborted ( BodyPipe::Pointer  )
virtualinherited
void Client::noteBodyProducerAborted ( BodyPipe::Pointer  bp)
virtualinherited
void Client::noteBodyProductionEnded ( BodyPipe::Pointer  bp)
virtualinherited
void Client::noteMoreBodyDataAvailable ( BodyPipe::Pointer  bp)
virtualinherited
void Client::noteMoreBodySpaceAvailable ( BodyPipe::Pointer  )
virtualinherited
bool Client::openListenSocket ( )

Definition at line 777 of file FtpClient.cc.

bool Ftp::Client::parseControlReply ( size_t bytesUsed)
private

Parses FTP server control response into ctrl structure fields, setting bytesUsed and returning true on success.

Definition at line 1066 of file FtpClient.cc.

References assert, Ftp::crlf, debugs, head, wordlist::key, len, wordlist::next, NULL, safe_free, wordlistDestroy(), xmalloc, xstrdup, and xstrncpy().

virtual void Client::processReplyBody ( )
pure virtualinherited
size_t Client::replyBodySpace ( const MemBuf readBuf,
const size_t  minSpace 
) const
protectedinherited
void Ftp::Client::scheduleReadControlReply ( int  buffered_ok)
protected

DPW 2007-04-23 Looks like there are no longer anymore callers that set buffered_ok=1. Perhaps it can be removed at some point.

Definition at line 309 of file FtpClient.cc.

References comm_read(), commSetConnTimeout(), commUnsetConnTimeout(), Config, SquidConfig::connect, data, debugs, Comm::IsConnOpen(), JobCallback, min(), SquidConfig::read, readControlReply(), timeout(), and SquidConfig::Timeout.

Referenced by Ftp::Relay::scheduleReadControlReply().

bool Client::sendPassive ( )
Checks for EPSV ALL special conditions: If enabled to be sent, squid MUST NOT request any other connect methods. If 'ALL' is sent and fails the entire FTP Session fails. NP: By my reading exact EPSV protocols maybe attempted, but only EPSV method.

Closes any old FTP-Data connection which may exist. */

Checks for previous EPSV/PASV failures on this server/session. Diverts to EPRT immediately if they are not working.
Send EPSV (ALL,2,1) or PASV on the control channel.
  • EPSV ALL is used if enabled.
  • EPSV 2 is used if ALL is disabled and IPv6 is available and ctrl channel is IPv6.
  • EPSV 1 is used if EPSV 2 (IPv6) fails or is not available or ctrl channel is IPv4.
  • PASV is used if EPSV 1 fails.

Definition at line 637 of file FtpClient.cc.

References SquidConfig::accessList, allow_t::allowed(), Packable::appendf(), Config, MemBuf::content(), Ftp::crlf, data, DBG_IMPORTANT, debugs, SquidConfig::epsv_all, ERR_FTP_FAILURE, ACLChecklist::fastCheck(), SquidConfig::Ftp, SquidConfig::ftp_epsv, NULL, SquidConfig::passive, MemBuf::reset(), and wordlistDestroy().

Referenced by ftpSendPassive().

bool Client::sendPort ( )

Definition at line 630 of file FtpClient.cc.

References ERR_FTP_FAILURE.

void Client::sentRequestBody ( const CommIoCbParams io)
protectedvirtual
HttpReply * Client::setVirginReply ( HttpReply r)
protectedinherited

Definition at line 118 of file Client.cc.

References assert, debugs, HERE(), HTTPMSGLOCK(), and Client::theVirginReply.

Referenced by HttpStateData::processReplyHeader().

void Client::start ( )
protectedvirtual

Reimplemented from AsyncJob.

Reimplemented in Ftp::Gateway, and Ftp::Relay.

Definition at line 199 of file FtpClient.cc.

Referenced by Ftp::Relay::start(), and Ftp::Gateway::start().

bool Client::startRequestBodyFlow ( )
protectedinherited
void BodyProducer::stopProducingFor ( RefCount< BodyPipe > &  p,
bool  atEof 
)
protectedinherited
void Client::storeReplyBody ( const char *  buf,
ssize_t  len 
)
protectedinherited

Definition at line 994 of file Client.cc.

References Client::currentOffset, Client::entry, len, and StoreEntry::write().

Referenced by Client::addVirginReplyBody().

void Ftp::Client::switchTimeoutToDataChannel ( )

Cancel the timeout on the Control socket and establish one on the data socket

Definition at line 1030 of file FtpClient.cc.

References commSetConnTimeout(), commUnsetConnTimeout(), Config, data, JobCallback, SquidConfig::read, timeout(), and SquidConfig::Timeout.

Referenced by ftpReadList(), and ftpReadRetr().

void Client::timeout ( const CommTimeoutCbParams io)
virtual
virtual void* CbdataParent::toCbdata ( )
pure virtualinherited
HttpReply * Client::virginReply ( )
protectedinherited

Definition at line 104 of file Client.cc.

References assert, and Client::theVirginReply.

Member Data Documentation

CbcPointer<Adaptation::Initiate> Client::adaptedHeadSource
protectedinherited

to get adapted response headers

Definition at line 174 of file Client.h.

Referenced by Client::cleanAdaptation(), Client::doneWithAdaptation(), Client::noteAdaptationAnswer(), and Client::startAdaptation().

int64_t Client::currentOffset = 0
protectedinherited
DataChannel Ftp::Client::data
const char* Client::doneWithFwd = nullptr
protectedinherited

whether we should not be talking to FwdState; XXX: clear fwd instead points to a string literal which is used only for debugging

Definition at line 184 of file Client.h.

Referenced by Client::completeForwarding(), HttpStateData::httpStateConnClosed(), and Client::swanSong().

enum { ... } Ftp::Client::ftp_state_t
const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 70 of file AsyncJob.h.

AsyncCall::Pointer AsyncJob::inCall
protectedinherited
char* Ftp::Client::old_reply

Definition at line 160 of file FtpClient.h.

Referenced by ftpSendReply().

char* Ftp::Client::old_request

Definition at line 159 of file FtpClient.h.

Referenced by ftpSendReply().

bool Client::receivedWholeRequestBody = false
protectedinherited
MemBuf* Client::responseBodyBuffer = nullptr
protectedinherited
bool Ftp::Client::shortenReadTimeout
private

XXX: An old hack for FTP servers like ftp.netscape.com that may not respond to PASV. Use faster connect timeout instead of read timeout.

Definition at line 194 of file FtpClient.h.

bool Client::startedAdaptation = false
protectedinherited
const char* AsyncJob::stopReason
protectedinherited

The documentation for this class was generated from the following files:

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors