X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8e907a13eae0ef1cd0eb4a318c824ba095a64684..4797b0145c81236c08cdee4f05e616ef17924a50:/include/wx/protocol/ftp.h?ds=sidebyside diff --git a/include/wx/protocol/ftp.h b/include/wx/protocol/ftp.h index 459f2bfd6c..21312e87fd 100644 --- a/include/wx/protocol/ftp.h +++ b/include/wx/protocol/ftp.h @@ -2,80 +2,181 @@ // Name: ftp.h // Purpose: FTP protocol // Author: Vadim Zeitlin -// Modified by: +// Modified by: Mark Johnson, wxWindows@mj10777.de +// 20000917 : RmDir, GetLastResult, GetList // Created: 07/07/1997 // RCS-ID: $Id$ // Copyright: (c) 1997, 1998 Guilhem Lavaux -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef __WX_FTP_H__ #define __WX_FTP_H__ -#ifdef __GNUG__ -#pragma interface -#endif +#include "wx/defs.h" + +#if wxUSE_PROTOCOL_FTP -#include "wx/object.h" #include "wx/sckaddr.h" #include "wx/protocol/protocol.h" #include "wx/url.h" -class WXDLLEXPORT wxFTP : public wxProtocol +class WXDLLIMPEXP_NET wxFTP : public wxProtocol { public: - typedef enum { ASCII, BINARY } wxFTPmode; + enum TransferMode + { + NONE, // not set by user explicitly + ASCII, + BINARY + }; + + wxFTP(); + virtual ~wxFTP(); + + // Connecting and disconnecting + void SetUser(const wxString& user) { m_user = user; } + void SetPassword(const wxString& passwd) { m_passwd = passwd; } + + bool Connect(const wxSockAddress& addr, bool wait = true); + bool Connect(const wxString& host); + + // disconnect + virtual bool Close(); + + // Parameters set up + + // set transfer mode now + void SetPassive(bool pasv) { m_bPassive = pasv; } + void SetDefaultTimeout(wxUint32 Value); + bool SetBinary() { return SetTransferMode(BINARY); } + bool SetAscii() { return SetTransferMode(ASCII); } + bool SetTransferMode(TransferMode mode); + + // Generic FTP interface + + // the error code + virtual wxProtocolError GetError() { return m_lastError; } + + // the last FTP server reply + const wxString& GetLastResult() { return m_lastResult; } + + // send any FTP command (should be full FTP command line but without + // trailing "\r\n") and return its return code + char SendCommand(const wxString& command); + + // check that the command returned the given code + bool CheckCommand(const wxString& command, char expectedReturn) + { + return SendCommand(command) == expectedReturn; + } + + // Filesystem commands + bool ChDir(const wxString& dir); + bool MkDir(const wxString& dir); + bool RmDir(const wxString& dir); + wxString Pwd(); + bool Rename(const wxString& src, const wxString& dst); + bool RmFile(const wxString& path); + + // Get the size of a file in the current dir. + // this function tries its best to deliver the size in bytes using BINARY + // (the SIZE command reports different sizes depending on whether + // type is set to ASCII or BINARY) + // returns -1 if file is non-existant or size could not be found + int GetFileSize(const wxString& fileName); + + // Check to see if a file exists in the current dir + bool FileExists(const wxString& fileName); + + // Download methods + bool Abort(); + + virtual wxInputStream *GetInputStream(const wxString& path); + virtual wxOutputStream *GetOutputStream(const wxString& path); + + // Directory listing + + // get the list of full filenames, the format is fixed: one file name per + // line + bool GetFilesList(wxArrayString& files, + const wxString& wildcard = wxEmptyString) + { + return GetList(files, wildcard, false); + } + + // get a directory list in server dependent format - this can be shown + // directly to the user + bool GetDirList(wxArrayString& files, + const wxString& wildcard = wxEmptyString) + { + return GetList(files, wildcard, true); + } + + // equivalent to either GetFilesList() (default) or GetDirList() + bool GetList(wxArrayString& files, + const wxString& wildcard = wxEmptyString, + bool details = false); + +protected: + // this executes a simple ftp command with the given argument and returns + // true if it its return code starts with '2' + bool DoSimpleCommand(const wxChar *command, + const wxString& arg = wxEmptyString); - wxFTP(); - virtual ~wxFTP(); + // get the server reply, return the first character of the reply code, + // '1'..'5' for normal FTP replies, 0 (*not* '0') if an error occurred + char GetResult(); - bool Connect(wxSockAddress& addr, bool wait = TRUE); - bool Connect(const wxString& host); + // check that the result is equal to expected value + bool CheckResult(char ch) { return GetResult() == ch; } - // [forcibly] close the connection - bool Close(bool force = FALSE); + // return the socket to be used, Passive/Active versions are used only by + // GetPort() + wxSocketBase *GetPort(); + wxSocketBase *GetPassivePort(); + wxSocketBase *GetActivePort(); - void SetUser(const wxString& user) { m_user = user; } - void SetPassword(const wxString& passwd) { m_passwd = passwd; } + // helper for GetPort() + wxString GetPortCmdArgument(const wxIPV4address& Local, const wxIPV4address& New); - // Filesystem commands - bool ChDir(const wxString& dir); - bool MkDir(const wxString& dir); - bool RmDir(const wxString& dir); - wxString Pwd(); - bool Rename(const wxString& src, const wxString& dst); - bool RmFile(const wxString& path); + // accept connection from server in active mode, returns the same socket as + // passed in in passive mode + wxSocketBase *AcceptIfActive(wxSocketBase *sock); - // Download methods - bool Abort(); - wxInputStream *GetInputStream(const wxString& path); - wxOutputStream *GetOutputStream(const wxString& path); - // List method - bool GetList(wxArrayString& files, const wxString& wildcard = wxEmptyString); + wxString m_user, + m_passwd; - // Low-level methods - bool SendCommand(const wxString& command, char exp_ret); - virtual wxProtocolError GetError() { return m_lastError; } - const wxString& GetLastResult(); // Get the complete return + wxString m_lastResult; + wxProtocolError m_lastError; - // deprecated - wxList *GetList(const wxString& wildcard); + // true if there is an FTP transfer going on + bool m_streaming; -protected: - wxString m_user, m_passwd; - wxString m_lastResult; - wxProtocolError m_lastError; - bool m_streaming; + // although this should be set to ASCII by default according to STD9, + // we will use BINARY transfer mode by default for backwards compatibility + TransferMode m_currentTransfermode; - friend class wxInputFTPStream; - friend class wxOutputFTPStream; + friend class wxInputFTPStream; + friend class wxOutputFTPStream; - wxSocketClient *GetPort(); - bool GetResult(char exp); + bool m_bPassive; + wxUint32 m_uiDefaultTimeout; - DECLARE_DYNAMIC_CLASS(wxFTP) - DECLARE_PROTOCOL(wxFTP) + // following is true when a read or write times out, we then assume + // the connection is dead and abort. we avoid additional delays this way + bool m_bEncounteredError; + + + DECLARE_DYNAMIC_CLASS_NO_COPY(wxFTP) + DECLARE_PROTOCOL(wxFTP) }; +// the trace mask used by assorted wxLogTrace() in ftp code, do +// wxLog::AddTraceMask(FTP_TRACE_MASK) to see them in output +#define FTP_TRACE_MASK _T("ftp") + +#endif // wxUSE_PROTOCOL_FTP + #endif // __WX_FTP_H__