X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fde7d98ecdb04b84483288bdc269045eb51193fc..d9ff0f91fbddae88286567cab74dcfb59c91fc0f:/src/common/ftp.cpp diff --git a/src/common/ftp.cpp b/src/common/ftp.cpp index 5e8ce27493..5a815e21c8 100644 --- a/src/common/ftp.cpp +++ b/src/common/ftp.cpp @@ -2,413 +2,928 @@ // Name: ftp.cpp // Purpose: FTP protocol // Author: Guilhem Lavaux -// Modified by: +// Modified by: Mark Johnson, wxWindows@mj10777.de +// 20000917 : RmDir, GetLastResult, GetList +// Vadim Zeitlin (numerous fixes and rewrites to all part of the +// code, support ASCII/Binary modes, better error reporting, more +// robust Abort(), support for arbitrary FTP commands, ...) // Created: 07/07/1997 // RCS-ID: $Id$ // Copyright: (c) 1997, 1998 Guilhem Lavaux // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// +// ============================================================================ +// declarations +// ============================================================================ + #ifdef __GNUG__ -#pragma implementation "ftp.h" + #pragma implementation "ftp.h" #endif +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif -#if wxUSE_SOCKETS +#if wxUSE_SOCKETS && wxUSE_STREAMS -#ifndef __MWERKS__ -#include -#endif -#if defined(__WXMAC__) -#include "/wx/mac/macsock.h" -#endif +#ifndef WX_PRECOMP + #include + #include "wx/string.h" + #include "wx/utils.h" + #include "wx/log.h" + #include "wx/intl.h" +#endif // WX_PRECOMP -#include -#include "wx/string.h" -#include "wx/utils.h" -// #include "wx/data.h" -#define WXSOCK_INTERNAL #include "wx/sckaddr.h" -#undef WXSOCK_INTERNAL #include "wx/socket.h" #include "wx/url.h" #include "wx/sckstrm.h" #include "wx/protocol/protocol.h" #include "wx/protocol/ftp.h" -#ifdef __BORLANDC__ -#pragma hdrstop +#if defined(__WXMAC__) + #include "wx/mac/macsock.h" #endif -#define FTP_BSIZE 1024 +#ifndef __MWERKS__ + #include +#endif + +// ---------------------------------------------------------------------------- +// constants +// ---------------------------------------------------------------------------- + +// the length of FTP status code (3 digits) +static const size_t LEN_CODE = 3; + +// ---------------------------------------------------------------------------- +// macros +// ---------------------------------------------------------------------------- -#if !USE_SHARED_LIBRARY IMPLEMENT_DYNAMIC_CLASS(wxFTP, wxProtocol) -IMPLEMENT_PROTOCOL(wxFTP, _T("ftp"), _T("ftp"), TRUE) -#endif +IMPLEMENT_PROTOCOL(wxFTP, wxT("ftp"), wxT("ftp"), TRUE) + +// ============================================================================ +// implementation +// ============================================================================ -//////////////////////////////////////////////////////////////// -////// wxFTP constructor and destructor //////////////////////// -//////////////////////////////////////////////////////////////// +// ---------------------------------------------------------------------------- +// wxFTP constructor and destructor +// ---------------------------------------------------------------------------- wxFTP::wxFTP() - : wxProtocol() { - wxChar tmp[256]; + m_lastError = wxPROTO_NOERR; + m_streaming = FALSE; + m_currentTransfermode = NONE; - m_lastError = wxPROTO_NOERR; - m_streaming = FALSE; + m_user = wxT("anonymous"); + m_passwd << wxGetUserId() << wxT('@') << wxGetFullHostName(); - m_user = _T("anonymous"); - wxGetUserName(tmp, 256); - m_passwd.sprintf(_T("%s@"),tmp); - wxGetHostName(tmp, 256); - m_passwd += tmp; - - SetNotify(0); + SetNotify(0); + SetFlags(wxSOCKET_NONE); } wxFTP::~wxFTP() { - SendCommand("QUIT", '2'); + if ( m_streaming ) + { + (void)Abort(); + } + + Close(); } -//////////////////////////////////////////////////////////////// -////// wxFTP connect and login methods ///////////////////////// -//////////////////////////////////////////////////////////////// +// ---------------------------------------------------------------------------- +// wxFTP connect and login methods +// ---------------------------------------------------------------------------- + bool wxFTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait)) { - if (!m_handler) { - m_lastError = wxPROTO_NOHNDLR; - return FALSE; - } - - if (!wxProtocol::Connect(addr)) { - m_lastError = wxPROTO_NETERR; - return FALSE; - } + if ( !wxProtocol::Connect(addr) ) + { + m_lastError = wxPROTO_NETERR; + return FALSE; + } - if (!m_user || !m_passwd) { - m_lastError = wxPROTO_CONNERR; - return FALSE; - } + if ( !m_user ) + { + m_lastError = wxPROTO_CONNERR; + return FALSE; + } - wxString command; + // we should have 220 welcome message + if ( !CheckResult('2') ) + { + Close(); + return FALSE; + } - if (!GetResult('2')) { - Close(); - return FALSE; - } + wxString command; + command.Printf(wxT("USER %s"), m_user.c_str()); + char rc = SendCommand(command); + if ( rc == '2' ) + { + // 230 return: user accepted without password + return TRUE; + } - command.sprintf(_T("USER %s"), (const wxChar *)m_user); - if (!SendCommand(command, '3')) { - Close(); - return FALSE; - } + if ( rc != '3' ) + { + Close(); + return FALSE; + } - command.sprintf(_T("PASS %s"), (const wxChar *)m_passwd); - if (!SendCommand(command, '2')) { - Close(); - return FALSE; - } + command.Printf(wxT("PASS %s"), m_passwd.c_str()); + if ( !CheckCommand(command, '2') ) + { + Close(); + return FALSE; + } - return TRUE; + return TRUE; } bool wxFTP::Connect(const wxString& host) { - wxIPV4address addr; - wxString my_host = host; + wxIPV4address addr; + addr.Hostname(host); + addr.Service(wxT("ftp")); - addr.Hostname(my_host); - addr.Service(_T("ftp")); - - return Connect(addr); + return Connect(addr); } bool wxFTP::Close() { - if (m_streaming) { - m_lastError = wxPROTO_STREAMING; - return FALSE; - } - if (m_connected) - SendCommand(wxString(_T("QUIT")), '2'); - return wxSocketClient::Close(); + if ( m_streaming ) + { + m_lastError = wxPROTO_STREAMING; + return FALSE; + } + + if ( IsConnected() ) + { + if ( !CheckCommand(wxT("QUIT"), '2') ) + { + wxLogDebug(_T("Failed to close connection gracefully.")); + } + } + + return wxSocketClient::Close(); +} + +// ============================================================================ +// low level methods +// ============================================================================ + +// ---------------------------------------------------------------------------- +// Send command to FTP server +// ---------------------------------------------------------------------------- + +char wxFTP::SendCommand(const wxString& command) +{ + if ( m_streaming ) + { + m_lastError = wxPROTO_STREAMING; + return 0; + } + + wxString tmp_str = command + wxT("\r\n"); + const wxWX2MBbuf tmp_buf = tmp_str.mb_str(); + if ( Write(wxMBSTRINGCAST tmp_buf, strlen(tmp_buf)).Error()) + { + m_lastError = wxPROTO_NETERR; + return 0; + } + +#ifdef __WXDEBUG__ + // don't show the passwords in the logs (even in debug ones) + wxString cmd, password; + if ( command.Upper().StartsWith(_T("PASS "), &password) ) + { + cmd << _T("PASS ") << wxString(_T('*'), password.length()); + } + else + { + cmd = command; + } + + wxLogTrace(FTP_TRACE_MASK, _T("==> %s"), cmd.c_str()); +#endif // __WXDEBUG__ + + return GetResult(); } -//////////////////////////////////////////////////////////////// -////// wxFTP low-level methods ///////////////////////////////// -//////////////////////////////////////////////////////////////// -bool wxFTP::SendCommand(const wxString& command, char exp_ret) +// ---------------------------------------------------------------------------- +// Recieve servers reply +// ---------------------------------------------------------------------------- + +char wxFTP::GetResult() { - wxString tmp_str; - - if (m_streaming) { - m_lastError = wxPROTO_STREAMING; - return FALSE; - } - tmp_str = command + _T("\r\n"); - const wxWX2MBbuf tmp_buf = tmp_str.mb_str(); - if (Write(MBSTRINGCAST tmp_buf, strlen(tmp_buf)).Error()) { - m_lastError = wxPROTO_NETERR; - return FALSE; - } - return GetResult(exp_ret); + wxString code; + + // m_lastResult will contain the entire server response, possibly on + // multiple lines + m_lastResult.clear(); + + // we handle multiline replies here according to RFC 959: it says that a + // reply may either be on 1 line of the form "xyz ..." or on several lines + // in whuch case it looks like + // xyz-... + // ... + // xyz ... + // and the intermeidate lines may start with xyz or not + bool badReply = FALSE; + bool firstLine = TRUE; + bool endOfReply = FALSE; + while ( !endOfReply && !badReply ) + { + wxString line; + m_lastError = ReadLine(line); + if ( m_lastError ) + return 0; + + if ( !m_lastResult.empty() ) + { + // separate from last line + m_lastResult += _T('\n'); + } + + m_lastResult += line; + + // unless this is an intermediate line of a multiline reply, it must + // contain the code in the beginning and '-' or ' ' following it + if ( line.Len() < LEN_CODE + 1 ) + { + if ( firstLine ) + { + badReply = TRUE; + } + else + { + wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"), + code.c_str(), line.c_str()); + } + } + else // line has at least 4 chars + { + // this is the char which tells us what we're dealing with + wxChar chMarker = line.GetChar(LEN_CODE); + + if ( firstLine ) + { + code = wxString(line, LEN_CODE); + wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"), + code.c_str(), line.c_str() + LEN_CODE + 1); + + switch ( chMarker ) + { + case _T(' '): + endOfReply = TRUE; + break; + + case _T('-'): + firstLine = FALSE; + break; + + default: + // unexpected + badReply = TRUE; + } + } + else // subsequent line of multiline reply + { + if ( wxStrncmp(line, code, LEN_CODE) == 0 ) + { + if ( chMarker == _T(' ') ) + { + endOfReply = TRUE; + } + + wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"), + code.c_str(), line.c_str() + LEN_CODE + 1); + } + else + { + // just part of reply + wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"), + code.c_str(), line.c_str()); + } + } + } + } + + if ( badReply ) + { + wxLogDebug(_T("Broken FTP server: '%s' is not a valid reply."), + m_lastResult.c_str()); + + m_lastError = wxPROTO_PROTERR; + + return 0; + } + + // if we got here we must have a non empty code string + return code[0u]; } -bool wxFTP::GetResult(char exp) +// ---------------------------------------------------------------------------- +// wxFTP simple commands +// ---------------------------------------------------------------------------- + +bool wxFTP::SetTransferMode(TransferMode transferMode) { - if ((m_lastError = GetLine(this, m_lastResult))) - return FALSE; - if (m_lastResult.GetChar(0) != exp) { - m_lastError = wxPROTO_PROTERR; - return FALSE; - } + if ( transferMode == m_currentTransfermode ) + { + // nothing to do + return TRUE; + } + + wxString mode; + switch ( transferMode ) + { + default: + wxFAIL_MSG(_T("unknown FTP transfer mode")); + // fall through - if (m_lastResult.GetChar(3) == '-') { - wxString key = m_lastResult.Left((size_t)3); + case BINARY: + mode = _T('I'); + break; - key += _T(' '); + case ASCII: + mode = _T('A'); + break; + } + + if ( !DoSimpleCommand(_T("TYPE"), mode) ) + { + wxLogError(_("Failed to set FTP transfer mode to %s."), (const wxChar*) + (transferMode == ASCII ? _("ASCII") : _("binary"))); - while (m_lastResult.Index(key) != 0) { - if ((m_lastError = GetLine(this, m_lastResult))) return FALSE; } - } - return TRUE; + + // If we get here the operation has been succesfully completed + // Set the status-member + m_currentTransfermode = transferMode; + + return TRUE; +} + +bool wxFTP::DoSimpleCommand(const wxChar *command, const wxString& arg) +{ + wxString fullcmd = command; + if ( !arg.empty() ) + { + fullcmd << _T(' ') << arg; + } + + if ( !CheckCommand(fullcmd, '2') ) + { + wxLogDebug(_T("FTP command '%s' failed."), fullcmd.c_str()); + + return FALSE; + } + + return TRUE; } -//////////////////////////////////////////////////////////////// -////// wxFTP low-level methods ///////////////////////////////// -//////////////////////////////////////////////////////////////// bool wxFTP::ChDir(const wxString& dir) { - wxString str = dir; + // some servers might not understand ".." if they use different directory + // tree conventions, but they always understand CDUP - should we use it if + // dir == ".."? OTOH, do such servers (still) exist? - str.Prepend(_T("CWD ")); - return SendCommand(str, '2'); + return DoSimpleCommand(_T("CWD"), dir); } bool wxFTP::MkDir(const wxString& dir) { - wxString str = dir; - str.Prepend(_T("MKD ")); - return SendCommand(str, '2'); + return DoSimpleCommand(_T("MKD"), dir); } bool wxFTP::RmDir(const wxString& dir) { - wxString str = dir; - - str.Prepend(_T("PWD ")); - return SendCommand(str, '2'); + return DoSimpleCommand(_T("RMD"), dir); } wxString wxFTP::Pwd() { - int beg, end; - - if (!SendCommand(_T("PWD"), '2')) - return wxString((char *)NULL); - - beg = m_lastResult.Find(_T('\"'),FALSE); - end = m_lastResult.Find(_T('\"'),TRUE); + wxString path; + + if ( CheckCommand(wxT("PWD"), '2') ) + { + // the result is at least that long if CheckCommand() succeeded + const wxChar *p = m_lastResult.c_str() + LEN_CODE + 1; + if ( *p != _T('"') ) + { + wxLogDebug(_T("Missing starting quote in reply for PWD: %s"), p); + } + else + { + for ( p++; *p; p++ ) + { + if ( *p == _T('"') ) + { + // check if the quote is doubled + p++; + if ( !*p || *p != _T('"') ) + { + // no, this is the end + break; + } + //else: yes, it is: this is an embedded quote in the + // filename, treat as normal char + } + + path += *p; + } + + if ( !*p ) + { + wxLogDebug(_T("Missing ending quote in reply for PWD: %s"), + m_lastResult.c_str() + LEN_CODE + 1); + } + } + } + else + { + wxLogDebug(_T("FTP PWD command failed.")); + } - return wxString(beg+1, end); + return path; } bool wxFTP::Rename(const wxString& src, const wxString& dst) { - wxString str; + wxString str; + + str = wxT("RNFR ") + src; + if ( !CheckCommand(str, '3') ) + return FALSE; - str = _T("RNFR ") + src; - if (!SendCommand(str, '3')) - return FALSE; + str = wxT("RNTO ") + dst; - str = _T("RNTO ") + dst; - return SendCommand(str, '2'); + return CheckCommand(str, '2'); } bool wxFTP::RmFile(const wxString& path) { - wxString str; + wxString str; + str = wxT("DELE ") + path; - str = _T("DELE "); - str += path; - return SendCommand(str, '2'); + return CheckCommand(str, '2'); } -//////////////////////////////////////////////////////////////// -////// wxFTP download*upload /////////////////////////////////// -//////////////////////////////////////////////////////////////// +// ---------------------------------------------------------------------------- +// wxFTP download and upload +// ---------------------------------------------------------------------------- -class wxInputFTPStream : public wxSocketInputStream { +class wxInputFTPStream : public wxSocketInputStream +{ public: - wxFTP *m_ftp; - size_t m_ftpsize; - - wxInputFTPStream(wxFTP *ftp_clt, wxSocketBase *sock) - : wxSocketInputStream(*sock), m_ftp(ftp_clt) {} - size_t StreamSize() const { return m_ftpsize; } - virtual ~wxInputFTPStream(void) - { - if (LastError() != wxStream_NOERROR) - m_ftp->GetResult('2'); - else - m_ftp->Abort(); - delete m_i_socket; - } + wxInputFTPStream(wxFTP *ftp, wxSocketBase *sock) + : wxSocketInputStream(*sock) + { + m_ftp = ftp; + + // FIXME make the timeout configurable + + // set a shorter than default timeout + m_i_socket->SetTimeout(60); // 1 minute + } + + size_t GetSize() const { return m_ftpsize; } + + virtual ~wxInputFTPStream() + { + delete m_i_socket; + + if ( LastError() == wxStream_NOERROR ) + { + // wait for "226 transfer completed" + m_ftp->CheckResult('2'); + + m_ftp->m_streaming = FALSE; + } + else + { + m_ftp->Abort(); + } + + // delete m_i_socket; // moved to top of destructor to accomodate wu-FTPd >= 2.6.0 + } + + wxFTP *m_ftp; + size_t m_ftpsize; }; -class wxOutputFTPStream : public wxSocketOutputStream { +class wxOutputFTPStream : public wxSocketOutputStream +{ public: - wxFTP *m_ftp; - - wxOutputFTPStream(wxFTP *ftp_clt, wxSocketBase *sock) - : wxSocketOutputStream(*sock), m_ftp(ftp_clt) {} - virtual ~wxOutputFTPStream(void) - { - if (LastError() != wxStream_NOERROR) - m_ftp->GetResult('2'); - else - m_ftp->Abort(); - delete m_o_socket; - } + wxOutputFTPStream(wxFTP *ftp_clt, wxSocketBase *sock) + : wxSocketOutputStream(*sock), m_ftp(ftp_clt) + { + } + + virtual ~wxOutputFTPStream(void) + { + if ( IsOk() ) + { + // close data connection first, this will generate "transfer + // completed" reply + delete m_o_socket; + + // read this reply + m_ftp->CheckResult('2'); + + m_ftp->m_streaming = FALSE; + } + else + { + // abort data connection first + m_ftp->Abort(); + + // and close it after + delete m_o_socket; + } + } + + wxFTP *m_ftp; }; wxSocketClient *wxFTP::GetPort() { - wxIPV4address addr; - wxSocketClient *client; - struct sockaddr sin; - int a[6]; - wxString straddr; - int addr_pos; - - if (!SendCommand(_T("PASV"), '2')) - return NULL; - - sin.sa_family = AF_INET; - addr_pos = m_lastResult.Find(_T('(')); - if (addr_pos == -1) { - m_lastError = wxPROTO_PROTERR; - return NULL; - } - straddr = m_lastResult(addr_pos+1, m_lastResult.Length()); - wxSscanf((const wxChar *)straddr,_T("%d,%d,%d,%d,%d,%d"),&a[2],&a[3],&a[4],&a[5],&a[0],&a[1]); - sin.sa_data[2] = (char)a[2]; - sin.sa_data[3] = (char)a[3]; - sin.sa_data[4] = (char)a[4]; - sin.sa_data[5] = (char)a[5]; - sin.sa_data[0] = (char)a[0]; - sin.sa_data[1] = (char)a[1]; - - addr.Disassemble(&sin, sizeof(sin)); - - client = m_handler->CreateClient(); - if (!client->Connect(addr)) { - delete client; - return NULL; - } - client->Notify(FALSE); - - return client; + int a[6]; + + if ( !DoSimpleCommand(_T("PASV")) ) + { + wxLogError(_("The FTP server doesn't support passive mode.")); + + return NULL; + } + + const wxChar *addrStart = wxStrchr(m_lastResult, _T('(')); + if ( !addrStart ) + { + m_lastError = wxPROTO_PROTERR; + + return NULL; + } + + const wxChar *addrEnd = wxStrchr(addrStart, _T(')')); + if ( !addrEnd ) + { + m_lastError = wxPROTO_PROTERR; + + return NULL; + } + + wxString straddr(addrStart + 1, addrEnd); + + wxSscanf(straddr, wxT("%d,%d,%d,%d,%d,%d"), + &a[2],&a[3],&a[4],&a[5],&a[0],&a[1]); + + wxUint32 hostaddr = (wxUint16)a[5] << 24 | + (wxUint16)a[4] << 16 | + (wxUint16)a[3] << 8 | + a[2]; + wxUint16 port = (wxUint16)a[0] << 8 | a[1]; + + wxIPV4address addr; + addr.Hostname(hostaddr); + addr.Service(port); + + wxSocketClient *client = new wxSocketClient(); + if ( !client->Connect(addr) ) + { + delete client; + return NULL; + } + + client->Notify(FALSE); + + return client; } -bool wxFTP::Abort(void) +bool wxFTP::Abort() { - m_streaming = FALSE; - if (!SendCommand(_T("ABOR"), '4')) - return FALSE; - return GetResult('2'); + if ( !m_streaming ) + return TRUE; + + m_streaming = FALSE; + if ( !CheckCommand(wxT("ABOR"), '4') ) + return FALSE; + + return CheckResult('2'); } wxInputStream *wxFTP::GetInputStream(const wxString& path) { - wxString tmp_str; - int pos_size; - wxInputFTPStream *in_stream; + int pos_size; + wxInputFTPStream *in_stream; - if (!SendCommand(_T("TYPE I"), '2')) - return NULL; + if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) ) + return NULL; - wxSocketClient *sock = GetPort(); + wxSocketClient *sock = GetPort(); - if (!sock) { - m_lastError = wxPROTO_NETERR; - return NULL; - } + if ( !sock ) + { + m_lastError = wxPROTO_NETERR; + return NULL; + } + + wxString tmp_str = wxT("RETR ") + wxURL::ConvertFromURI(path); + if ( !CheckCommand(tmp_str, '1') ) + return NULL; - tmp_str = _T("RETR ") + path; - if (!SendCommand(tmp_str, '1')) - return NULL; + m_streaming = TRUE; - in_stream = new wxInputFTPStream(this, sock); + in_stream = new wxInputFTPStream(this, sock); - pos_size = m_lastResult.Index(_T('(')); - if (pos_size != wxNOT_FOUND) { - wxString str_size = m_lastResult(pos_size+1, m_lastResult.Index(_T(')'))-1); + pos_size = m_lastResult.Index(wxT('(')); + if ( pos_size != wxNOT_FOUND ) + { + wxString str_size = m_lastResult(pos_size+1, m_lastResult.Index(wxT(')'))-1); - in_stream->m_ftpsize = wxAtoi(WXSTRINGCAST str_size); - } + in_stream->m_ftpsize = wxAtoi(WXSTRINGCAST str_size); + } - return in_stream; + sock->SetFlags(wxSOCKET_WAITALL); + + return in_stream; } wxOutputStream *wxFTP::GetOutputStream(const wxString& path) { - wxString tmp_str; + if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) ) + return NULL; - if (!SendCommand(_T("TYPE I"), '2')) - return NULL; + wxSocketClient *sock = GetPort(); - wxSocketClient *sock = GetPort(); + wxString tmp_str = wxT("STOR ") + path; + if ( !CheckCommand(tmp_str, '1') ) + return FALSE; - tmp_str = _T("STOR ") + path; - if (!SendCommand(tmp_str, '1')) - return FALSE; + m_streaming = TRUE; - return new wxOutputFTPStream(this, sock); + return new wxOutputFTPStream(this, sock); } -wxList *wxFTP::GetList(const wxString& wildcard) +// ---------------------------------------------------------------------------- +// FTP directory listing +// ---------------------------------------------------------------------------- + +bool wxFTP::GetList(wxArrayString& files, + const wxString& wildcard, + bool details) { - wxList *file_list = new wxList; - wxSocketBase *sock = GetPort(); - wxString tmp_str = _T("NLST"); + wxSocketBase *sock = GetPort(); + if (!sock) + return FALSE; - if (!wildcard.IsNull()) - tmp_str += wildcard; + // NLST : List of Filenames (including Directory's !) + // LIST : depending on BS of FTP-Server + // - Unix : result like "ls" command + // - Windows : like "dir" command + // - others : ? + wxString line(details ? _T("LIST") : _T("NLST")); + if ( !!wildcard ) + { + line << _T(' ') << wildcard; + } - if (!SendCommand(tmp_str, '1')) { + if (!CheckCommand(line, '1')) + { + return FALSE; + } + files.Empty(); + while ( ReadLine(sock, line) == wxPROTO_NOERR ) + { + files.Add(line); + } delete sock; - delete file_list; - return NULL; - } - while (GetLine(sock, tmp_str) == wxPROTO_NOERR) { - file_list->Append((wxObject *)(new wxString(tmp_str))); - } + // the file list should be terminated by "226 Transfer complete"" + if ( !CheckResult('2') ) + return FALSE; - if (!GetResult('2')) { - delete sock; - file_list->DeleteContents(TRUE); - delete file_list; - return NULL; - } + return TRUE; +} + +bool wxFTP::FileExists(const wxString& fileName) +{ + // This function checks if the file specified in fileName exists in the + // current dir. It does so by simply doing an NLST (via GetList). + // If this succeeds (and the list is not empty) the file exists. + + bool retval = FALSE; + wxArrayString fileList; + + if ( GetList(fileList, fileName, FALSE) ) + { + // Some ftp-servers (Ipswitch WS_FTP Server 1.0.5 does this) + // displays this behaviour when queried on a non-existing file: + // NLST this_file_does_not_exist + // 150 Opening ASCII data connection for directory listing + // (no data transferred) + // 226 Transfer complete + // Here wxFTP::GetList(...) will succeed but it will return an empty + // list. + retval = !fileList.IsEmpty(); + } + + return retval; +} - sock->SetEventHandler(*GetNextHandler(), m_id); - sock->Notify(m_notifyme); - sock->SetNotify(m_neededreq); +// ---------------------------------------------------------------------------- +// FTP GetSize +// ---------------------------------------------------------------------------- - return file_list; +int wxFTP::GetFileSize(const wxString& fileName) +{ + // return the filesize of the given file if possible + // return -1 otherwise (predominantly if file doesn't exist + // in current dir) + + int filesize = -1; + + // Check for existance of file via wxFTP::FileExists(...) + if ( FileExists(fileName) ) + { + wxString command; + + // First try "SIZE" command using BINARY(IMAGE) transfermode + // Especially UNIX ftp-servers distinguish between the different + // transfermodes and reports different filesizes accordingly. + // The BINARY size is the interesting one: How much memory + // will we need to hold this file? + TransferMode oldTransfermode = m_currentTransfermode; + SetTransferMode(BINARY); + command << _T("SIZE ") << fileName; + + bool ok = CheckCommand(command, '2'); + + if ( ok ) + { + // The answer should be one line: "213 \n" + // 213 is File Status (STD9) + // "SIZE" is not described anywhere..? It works on most servers + int statuscode; + if ( wxSscanf(GetLastResult().c_str(), _T("%i %i"), + &statuscode, &filesize) == 2 ) + { + // We've gotten a good reply. + ok = TRUE; + } + else + { + // Something bad happened.. A "2yz" reply with no size + // Fallback + ok = FALSE; + } + } + + // Set transfermode back to the original. Only the "SIZE"-command + // is dependant on transfermode + if ( oldTransfermode != NONE ) + { + SetTransferMode(oldTransfermode); + } + + if ( !ok ) // this is not a direct else clause.. The size command might return an invalid "2yz" reply + { + // The server didn't understand the "SIZE"-command or it + // returned an invalid reply. + // We now try to get details for the file with a "LIST"-command + // and then parse the output from there.. + wxArrayString fileList; + if ( GetList(fileList, fileName, TRUE) ) + { + if ( !fileList.IsEmpty() ) + { + // We _should_ only get one line in return, but just to be + // safe we run through the line(s) returned and look for a + // substring containing the name we are looking for. We + // stop the iteration at the first occurrence of the + // filename. The search is not case-sensitive. + bool foundIt = FALSE; + + size_t i; + for ( i = 0; !foundIt && i < fileList.Count(); i++ ) + { + foundIt = fileList[i].Upper().Contains(fileName.Upper()); + } + + if ( foundIt ) + { + // The index i points to the first occurrence of + // fileName in the array Now we have to find out what + // format the LIST has returned. There are two + // "schools": Unix-like + // + // '-rw-rw-rw- owner group size month day time filename' + // + // or Windows-like + // + // 'date size filename' + + // check if the first character is '-'. This would + // indicate Unix-style (this also limits this function + // to searching for files, not directories) + if ( fileList[i].Mid(0, 1) == _T("-") ) + { + + if ( wxSscanf(fileList[i].c_str(), + _("%*s %*s %*s %*s %i %*s %*s %*s %*s"), + &filesize) == 9 ) + { + // We've gotten a good response + ok = TRUE; + } + else + { + // Hmm... Invalid response + wxLogTrace(FTP_TRACE_MASK, + _T("Invalid LIST response")); + } + } + else // Windows-style response (?) + { + if ( wxSscanf(fileList[i].c_str(), + _T("%*s %*s %i %*s"), + &filesize) == 4 ) + { + // valid response + ok = TRUE; + } + else + { + // something bad happened..? + wxLogTrace(FTP_TRACE_MASK, + _T("Invalid or unknown LIST response")); + } + } + } + } + } + } + } + + // filesize might still be -1 when exiting + return filesize; } + + +#if WXWIN_COMPATIBILITY_2 +// deprecated +wxList *wxFTP::GetList(const wxString& wildcard, bool details) +{ + wxSocketBase *sock = GetPort(); + if (!sock) + return FALSE; + wxList *file_list = new wxList; + wxString line; + // NLST : List of Filenames (including Directory's !) + // LIST : depending on BS of FTP-Server + // - Unix : result like "ls" command + // - Windows : like "dir" command + // - others : ? + if (!details) + line = _T("NLST"); // Default + else + line = _T("LIST"); + if (!wildcard.IsNull()) + line += wildcard; + if (!CheckCommand(line, '1')) + { + delete sock; + delete file_list; + return NULL; + } + while (GetLine(sock, line) == wxPROTO_NOERR) + { + file_list->Append((wxObject *)(new wxString(line))); + } + if (!CheckResult('2')) + { + delete sock; + file_list->DeleteContents(TRUE); + delete file_list; + return NULL; + } + return file_list; +} +#endif // WXWIN_COMPATIBILITY_2 + #endif // wxUSE_SOCKETS