PTLib  Version 2.10.10
PFTPClient Class Reference

File Transfer Protocol client channel class. More...

#include <ftp.h>

Inheritance diagram for PFTPClient:
PFTP PInternetProtocol PIndirectChannel PChannel PObject

Public Member Functions

 PFTPClient ()
 Declare an FTP client socket. More...
 
 ~PFTPClient ()
 Delete and close the socket. More...
 
Overrides from class PSocket.
virtual PBoolean Close ()
 Close the socket, and if connected as a client, QUITs from server. More...
 
New functions for class
bool OpenHost (const PString &host, WORD port=DefaultPort)
 Open host using TCP. More...
 
PBoolean LogIn (const PString &username, const PString &password)
 Log in to the remote host for FTP. More...
 
PString GetSystemType ()
 Get the type of the remote FTP server system, eg Unix, WindowsNT etc. More...
 
PBoolean SetType (RepresentationType type)
 Set the transfer type. More...
 
PBoolean ChangeDirectory (const PString &dirPath)
 Change the current directory on the remote FTP host. More...
 
PString GetCurrentDirectory ()
 Get the current working directory on the remote FTP host. More...
 
PStringArray GetDirectoryNames (NameTypes type=ShortNames, DataChannelType channel=Passive)
 Get a list of files from the current working directory on the remote FTP host. More...
 
PStringArray GetDirectoryNames (const PString &path, NameTypes type=ShortNames, DataChannelType channel=Passive)
 Get a list of files from the current working directory on the remote FTP host. More...
 
PBoolean CreateDirectory (const PString &path)
 Create a directory on the remote FTP host. More...
 
PString GetFileStatus (const PString &path, DataChannelType channel=Passive)
 Get status information for the file path specified. More...
 
PTCPSocketGetFile (const PString &filename, DataChannelType channel=Passive)
 Begin retreiving a file from the remote FTP server. More...
 
PTCPSocketPutFile (const PString &filename, DataChannelType channel=Passive)
 Begin storing a file to the remote FTP server. More...
 
PTCPSocketGetURL (const PURL &url, RepresentationType type, DataChannelType channel=Passive)
 Begin retreiving a file from the remote FTP server. More...
 
- Public Member Functions inherited from PFTP
PBoolean SendPORT (const PIPSocket::Address &addr, WORD port)
 Send the PORT command for a transfer. More...
 
- Public Member Functions inherited from PInternetProtocol
virtual PBoolean Read (void *buf, PINDEX len)
 Low level read from the channel. More...
 
virtual PBoolean Write (const void *buf, PINDEX len)
 Low level write to the channel. More...
 
void SetReadLineTimeout (const PTimeInterval &t)
 Set the maximum timeout between characters within a line. More...
 
virtual PBoolean Connect (const PString &address, WORD port=0)
 Connect a socket to a remote host for the internet protocol. More...
 
virtual PBoolean Connect (const PString &address, const PString &service)
 
virtual PBoolean Accept (PSocket &listener)
 Accept a server socket to a remote host for the internet protocol. More...
 
const PStringGetDefaultService () const
 Get the default service name or port number to use in socket connections. More...
 
PIPSocketGetSocket () const
 Get the eventual socket for the series of indirect channels that may be between the current protocol and the actual I/O channel. More...
 
virtual PBoolean WriteLine (const PString &line)
 Write a string to the socket channel followed by a CR/LF pair. More...
 
virtual PBoolean ReadLine (PString &line, PBoolean allowContinuation=false)
 Read a string from the socket channel up to a CR/LF pair. More...
 
virtual void UnRead (int ch)
 Put back the characters into the data stream so that the next Read() function call will return them first. More...
 
virtual void UnRead (const PString &str)
 
virtual void UnRead (const void *buffer, PINDEX len)
 
virtual PBoolean WriteCommand (PINDEX cmdNumber)
 Write a single line for a command. More...
 
virtual PBoolean WriteCommand (PINDEX cmdNumber, const PString &param)
 
virtual PBoolean ReadCommand (PINDEX &num, PString &args)
 Read a single line of a command which ends with a CR/LF pair. More...
 
virtual PBoolean WriteResponse (unsigned numericCode, const PString &info)
 Write a response code followed by a text string describing the response to a command. More...
 
virtual PBoolean WriteResponse (const PString &code, const PString &info)
 
virtual PBoolean ReadResponse ()
 Read a response code followed by a text string describing the response to a command. More...
 
virtual PBoolean ReadResponse (int &code, PString &info)
 
virtual int ExecuteCommand (PINDEX cmdNumber)
 Write a command to the socket, using WriteCommand() and await a response using ReadResponse(). More...
 
virtual int ExecuteCommand (PINDEX cmdNumber, const PString &param)
 
int GetLastResponseCode () const
 Return the code associated with the last response received by the socket. More...
 
PString GetLastResponseInfo () const
 Return the last response received by the socket. More...
 
- Public Member Functions inherited from PIndirectChannel
 PIndirectChannel ()
 Create a new indirect channel without any channels to redirect to. More...
 
 ~PIndirectChannel ()
 Close the indirect channel, deleting read/write channels if desired. More...
 
Comparison Compare (const PObject &obj) const
 Determine if the two objects refer to the same indirect channel. More...
 
virtual PString GetName () const
 Get the name of the channel. More...
 
virtual PBoolean IsOpen () const
 Determine if the channel is currently open and read and write operations can be executed on it. More...
 
virtual PBoolean Shutdown (ShutdownValue option)
 Close one or both of the data streams associated with a channel. More...
 
virtual bool SetLocalEcho (bool localEcho)
 Set local echo mode. More...
 
virtual PChannelGetBaseReadChannel () const
 This function returns the eventual base channel for reading of a series of indirect channels provided by descendents of PIndirectChannel. More...
 
virtual PChannelGetBaseWriteChannel () const
 This function returns the eventual base channel for writing of a series of indirect channels provided by descendents of PIndirectChannel. More...
 
virtual PString GetErrorText (ErrorGroup group=NumErrorGroups) const
 Get error message description. More...
 
PBoolean Open (PChannel &channel)
 Set the channel for both read and write operations. More...
 
PBoolean Open (PChannel *channel, PBoolean autoDelete=true)
 Set the channel for both read and write operations. More...
 
PBoolean Open (PChannel *readChannel, PChannel *writeChannel, PBoolean autoDeleteRead=true, PBoolean autoDeleteWrite=true)
 Set the channel for both read and write operations. More...
 
PChannelGetReadChannel () const
 Get the channel used for read operations. More...
 
bool SetReadChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
 Set the channel for read operations. More...
 
PChannelGetWriteChannel () const
 Get the channel used for write operations. More...
 
PBoolean SetWriteChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
 Set the channel for read operations. More...
 
- Public Member Functions inherited from PChannel
PBoolean SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)
 Set error values to those specified. More...
 
 PChannel ()
 Create the channel. More...
 
 ~PChannel ()
 Close down the channel. More...
 
virtual PINDEX HashFunction () const
 Calculate a hash value for use in sets and dictionaries. More...
 
int GetHandle () const
 Get the integer operating system handle for the channel. More...
 
void SetReadTimeout (const PTimeInterval &time)
 Set the timeout for read operations. More...
 
PTimeInterval GetReadTimeout () const
 Get the timeout for read operations. More...
 
virtual PINDEX GetLastReadCount () const
 Get the number of bytes read by the last Read() call. More...
 
virtual int ReadChar ()
 Read a single 8 bit byte from the channel. More...
 
PBoolean ReadBlock (void *buf, PINDEX len)
 Read len bytes into the buffer from the channel. More...
 
PString ReadString (PINDEX len)
 Read len character into a string from the channel. More...
 
virtual PBoolean ReadAsync (void *buf, PINDEX len)
 Begin an asynchronous read from channel. More...
 
virtual void OnReadComplete (void *buf, PINDEX len)
 User callback function for when a ReadAsync() call has completed or timed out. More...
 
void SetWriteTimeout (const PTimeInterval &time)
 Set the timeout for write operations to complete. More...
 
PTimeInterval GetWriteTimeout () const
 Get the timeout for write operations to complete. More...
 
virtual PBoolean Write (const void *buf, PINDEX len, const void *mark)
 Low level write to the channel with marker. More...
 
virtual PINDEX GetLastWriteCount () const
 Get the number of bytes written by the last Write() call. More...
 
PBoolean WriteChar (int c)
 Write a single character to the channel. More...
 
PBoolean WriteString (const PString &str)
 Write a string to the channel. More...
 
virtual PBoolean WriteAsync (const void *buf, PINDEX len)
 Begin an asynchronous write from channel. More...
 
virtual void OnWriteComplete (const void *buf, PINDEX len)
 User callback function for when a WriteAsync() call has completed or timed out. More...
 
virtual bool FlowControl (const void *flowData)
 Flow Control information Pass data to the channel for flowControl determination. More...
 
PBoolean SetBufferSize (PINDEX newSize)
 Set the iostream buffer size for reads and writes. More...
 
PBoolean SendCommandString (const PString &command)
 Send a command meta-string. More...
 
void AbortCommandString ()
 Abort a command string that is in progress. More...
 
Errors GetErrorCode (ErrorGroup group=NumErrorGroups) const
 Get normalised error code. More...
 
int GetErrorNumber (ErrorGroup group=NumErrorGroups) const
 Get OS errro code. More...
 
virtual PBoolean Read (const VectorOfSlice &slices)
 Low level scattered read from the channel. More...
 
virtual PBoolean Write (const VectorOfSlice &slices)
 Low level scattered write to the channel. More...
 
- Public Member Functions inherited from PObject
virtual ~PObject ()
 
virtual PObjectClone () const
 Create a copy of the class on the heap. More...
 
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects. More...
 
bool operator== (const PObject &obj) const
 Compare the two objects. More...
 
bool operator!= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator< (const PObject &obj) const
 Compare the two objects. More...
 
bool operator> (const PObject &obj) const
 Compare the two objects. More...
 
bool operator<= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator>= (const PObject &obj) const
 Compare the two objects. More...
 
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance. More...
 
PBoolean IsClass (const char *cls) const
 
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class. More...
 
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream. More...
 
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Protected Member Functions

virtual PBoolean OnOpen ()
 Call back to verify open succeeded in an PInternetProtocol class. More...
 
PTCPSocketNormalClientTransfer (Commands cmd, const PString &args)
 
PTCPSocketPassiveClientTransfer (Commands cmd, const PString &args)
 
- Protected Member Functions inherited from PFTP
 PFTP ()
 Construct an ineternal File Transfer Protocol channel. More...
 
- Protected Member Functions inherited from PInternetProtocol
 PInternetProtocol (const char *defaultServiceName, PINDEX cmdCount, char const *const *cmdNames)
 
virtual PINDEX ParseResponse (const PString &line)
 Parse a response line string into a response code and any extra info on the line. More...
 
- Protected Member Functions inherited from PChannel
 PChannel (const PChannel &)
 
PChanneloperator= (const PChannel &)
 
virtual PBoolean ConvertOSError (int libcReturnValue, ErrorGroup group=LastGeneralError)
 Convert an operating system error into platform independent error. More...
 
int ReadCharWithTimeout (PTimeInterval &timeout)
 Read a character with specified timeout. More...
 
PBoolean ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)
 
PBoolean PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)
 
int PXClose ()
 
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own. More...
 

Protected Attributes

WORD remotePort
 Port number on remote system. More...
 
- Protected Attributes inherited from PInternetProtocol
PString defaultServiceName
 
PStringArray commandNames
 
PCharArray unReadBuffer
 
PINDEX unReadCount
 
PTimeInterval readLineTimeout
 
enum PInternetProtocol::StuffState stuffingState
 
PBoolean newLineToCRLF
 
int lastResponseCode
 
PString lastResponseInfo
 
- Protected Attributes inherited from PIndirectChannel
PChannelreadChannel
 Channel for read operations. More...
 
PBoolean readAutoDelete
 Automatically delete read channel on destruction. More...
 
PChannelwriteChannel
 Channel for write operations. More...
 
PBoolean writeAutoDelete
 Automatically delete write channel on destruction. More...
 
PReadWriteMutex channelPointerMutex
 Race condition prevention on closing channel. More...
 
- Protected Attributes inherited from PChannel
int os_handle
 The operating system file handle return by standard open() function. More...
 
Errors lastErrorCode [NumErrorGroups+1]
 The platform independant error code. More...
 
int lastErrorNumber [NumErrorGroups+1]
 The operating system error number (eg as returned by errno). More...
 
PINDEX lastReadCount
 Number of byte last read by the Read() function. More...
 
PINDEX lastWriteCount
 Number of byte last written by the Write() function. More...
 
PTimeInterval readTimeout
 Timeout for read operations. More...
 
PTimeInterval writeTimeout
 Timeout for write operations. More...
 
PString channelName
 
PMutex px_threadMutex
 
PXBlockType px_lastBlockType
 
PThreadpx_readThread
 
PThreadpx_writeThread
 
PMutex px_writeMutex
 
PThreadpx_selectThread [3]
 
PMutex px_selectMutex [3]
 

Additional Inherited Members

- Public Types inherited from PFTP
enum  Commands {
  USER, PASS, ACCT, CWD,
  CDUP, SMNT, QUIT, REIN,
  PORT, PASV, TYPE, STRU,
  MODE, RETR, STOR, STOU,
  APPE, ALLO, REST, RNFR,
  RNTO, ABOR, DELE, RMD,
  MKD, PWD, LIST, NLST,
  SITE, SYST, STATcmd, HELP,
  NOOP, NumCommands
}
 FTP commands. More...
 
enum  RepresentationType { ASCII, EBCDIC, Image }
 Types for file transfer. More...
 
enum  DataChannelType { NormalPort, Passive }
 File transfer mode on data channel. More...
 
enum  NameTypes { ShortNames, DetailedNames }
 Listing types. More...
 
enum  { DefaultPort = 21 }
 
- Public Types inherited from PChannel
enum  PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }
 
enum  ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }
 
enum  Errors {
  NoError, NotFound, FileExists, DiskFull,
  AccessDenied, DeviceInUse, BadParameter, NoMemory,
  NotOpen, Timeout, Interrupted, BufferTooSmall,
  Miscellaneous, ProtocolFailure, NumNormalisedErrors
}
 Normalised error codes. More...
 
enum  ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
 Error groups. More...
 
typedef std::vector< SliceVectorOfSlice
 
- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
 
- Static Public Member Functions inherited from PChannel
static PBoolean ConvertOSError (int libcReturnValue, Errors &lastError, int &osError)
 Convert an operating system error into platform independent error. More...
 
static PString GetErrorText (Errors lastError, int osError=0)
 Get error message description. More...
 
- Static Public Member Functions inherited from PObject
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect() More...
 
static const char * Class ()
 Get the name of the class as a C string. More...
 
- Protected Types inherited from PInternetProtocol
enum  StuffState {
  DontStuff, StuffIdle, StuffCR, StuffCRLF,
  StuffCRLFdot, StuffCRLFdotCR
}
 

Detailed Description

File Transfer Protocol client channel class.

Constructor & Destructor Documentation

PFTPClient::PFTPClient ( )

Declare an FTP client socket.

PFTPClient::~PFTPClient ( )

Delete and close the socket.

Member Function Documentation

PBoolean PFTPClient::ChangeDirectory ( const PString dirPath)

Change the current directory on the remote FTP host.

Returns
true if the log in was successfull.
Parameters
dirPathNew directory
virtual PBoolean PFTPClient::Close ( )
virtual

Close the socket, and if connected as a client, QUITs from server.

Returns
true if the channel was closed and the QUIT accepted by the server.

Reimplemented from PIndirectChannel.

PBoolean PFTPClient::CreateDirectory ( const PString path)

Create a directory on the remote FTP host.

Returns
true if the directory was created successfully.
Parameters
pathName of the directory to create.
PString PFTPClient::GetCurrentDirectory ( )

Get the current working directory on the remote FTP host.

Returns
String for the directory path, or empty string if an error occurred.
PStringArray PFTPClient::GetDirectoryNames ( NameTypes  type = ShortNames,
DataChannelType  channel = Passive 
)

Get a list of files from the current working directory on the remote FTP host.

Returns
String array for the files in the directory.
Parameters
typeDetail level on a directory entry.
channelData channel type.
PStringArray PFTPClient::GetDirectoryNames ( const PString path,
NameTypes  type = ShortNames,
DataChannelType  channel = Passive 
)

Get a list of files from the current working directory on the remote FTP host.

Returns
String array for the files in the directory.
Parameters
pathName to get details for.
typeDetail level on a directory entry.
channelData channel type.
PTCPSocket* PFTPClient::GetFile ( const PString filename,
DataChannelType  channel = Passive 
)

Begin retreiving a file from the remote FTP server.

The second parameter indicates that the transfer is on a normal or passive data channel. In short, a normal transfer the server connects to the client and in passive mode the client connects to the server.

Returns
Socket to read data from, or NULL if an error occurred.
Parameters
filenameName of file to get
channelData channel type.
PString PFTPClient::GetFileStatus ( const PString path,
DataChannelType  channel = Passive 
)

Get status information for the file path specified.

Returns
String giving file status.
Parameters
pathPath to get status for.
channelData channel type.
PString PFTPClient::GetSystemType ( )

Get the type of the remote FTP server system, eg Unix, WindowsNT etc.

Returns
String for the type of system.
PTCPSocket* PFTPClient::GetURL ( const PURL url,
RepresentationType  type,
DataChannelType  channel = Passive 
)

Begin retreiving a file from the remote FTP server.

The second parameter indicates that the transfer is on a normal or passive data channel. In short, a normal transfer the server connects to the client and in passive mode the client connects to the server.

Returns
Socket to read data from, or NULL if an error occurred.
Parameters
urlURL of file to get
typeType of transfer (text/binary)
channelData channel type.
PBoolean PFTPClient::LogIn ( const PString username,
const PString password 
)

Log in to the remote host for FTP.

Returns
true if the log in was successfull.
Parameters
usernameUser name for FTP log in.
passwordPassword for the specified user name.
PTCPSocket* PFTPClient::NormalClientTransfer ( Commands  cmd,
const PString args 
)
protected
virtual PBoolean PFTPClient::OnOpen ( )
protectedvirtual

Call back to verify open succeeded in an PInternetProtocol class.

Reimplemented from PIndirectChannel.

bool PFTPClient::OpenHost ( const PString host,
WORD  port = DefaultPort 
)

Open host using TCP.

PTCPSocket* PFTPClient::PassiveClientTransfer ( Commands  cmd,
const PString args 
)
protected
PTCPSocket* PFTPClient::PutFile ( const PString filename,
DataChannelType  channel = Passive 
)

Begin storing a file to the remote FTP server.

The second parameter indicates that the transfer is on a normal or passive data channel. In short, a normal transfer the server connects to the client and in passive mode the client connects to the server.

Returns
Socket to write data to, or NULL if an error occurred.
Parameters
filenameName of file to get
channelData channel type.
PBoolean PFTPClient::SetType ( RepresentationType  type)

Set the transfer type.

Returns
true if transfer type set.
Parameters
typeRepresentationTypeof file to transfer

Member Data Documentation

WORD PFTPClient::remotePort
protected

Port number on remote system.


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