X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/254a21292b0ccf234ed1dbc6acd37708672ffcc0..f253c22f29771e7dfd9ae3e1fe65650da14c8092:/src/common/ftp.cpp diff --git a/src/common/ftp.cpp b/src/common/ftp.cpp index 417849ea00..235a29d3db 100644 --- a/src/common/ftp.cpp +++ b/src/common/ftp.cpp @@ -19,10 +19,6 @@ // declarations // ============================================================================ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "ftp.h" -#endif - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- @@ -42,6 +38,7 @@ #include "wx/utils.h" #include "wx/log.h" #include "wx/intl.h" + #include "wx/wxcrtvararg.h" #endif // WX_PRECOMP #include "wx/sckaddr.h" @@ -51,10 +48,6 @@ #include "wx/protocol/protocol.h" #include "wx/protocol/ftp.h" -#if defined(__WXMAC__) - #include "wx/mac/macsock.h" -#endif - #ifndef __MWERKS__ #include #endif @@ -83,17 +76,15 @@ IMPLEMENT_PROTOCOL(wxFTP, wxT("ftp"), wxT("ftp"), true) wxFTP::wxFTP() { - m_lastError = wxPROTO_NOERR; m_streaming = false; m_currentTransfermode = NONE; - m_user = wxT("anonymous"); - m_passwd << wxGetUserId() << wxT('@') << wxGetFullHostName(); + m_username = wxT("anonymous"); + m_password << wxGetUserId() << wxT('@') << wxGetFullHostName(); SetNotify(0); - SetFlags(wxSOCKET_NONE); + SetFlags(wxSOCKET_NOWAIT); m_bPassive = true; - SetDefaultTimeout(60); // Default is Sixty Seconds m_bEncounteredError = false; } @@ -114,7 +105,7 @@ wxFTP::~wxFTP() // wxFTP connect and login methods // ---------------------------------------------------------------------------- -bool wxFTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait)) +bool wxFTP::Connect(const wxSockAddress& addr, bool WXUNUSED(wait)) { if ( !wxProtocol::Connect(addr) ) { @@ -122,7 +113,7 @@ bool wxFTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait)) return false; } - if ( !m_user ) + if ( !m_username ) { m_lastError = wxPROTO_CONNERR; return false; @@ -136,27 +127,31 @@ bool wxFTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait)) } wxString command; - command.Printf(wxT("USER %s"), m_user.c_str()); + command.Printf(wxT("USER %s"), m_username.c_str()); char rc = SendCommand(command); if ( rc == '2' ) { // 230 return: user accepted without password + m_lastError = wxPROTO_NOERR; return true; } if ( rc != '3' ) { + m_lastError = wxPROTO_CONNERR; Close(); return false; } - command.Printf(wxT("PASS %s"), m_passwd.c_str()); + command.Printf(wxT("PASS %s"), m_password.c_str()); if ( !CheckCommand(command, '2') ) { + m_lastError = wxPROTO_CONNERR; Close(); return false; } + m_lastError = wxPROTO_NOERR; return true; } @@ -181,6 +176,7 @@ bool wxFTP::Close() { if ( !CheckCommand(wxT("QUIT"), '2') ) { + m_lastError = wxPROTO_CONNERR; wxLogDebug(_T("Failed to close connection gracefully.")); } } @@ -192,6 +188,43 @@ bool wxFTP::Close() // low level methods // ============================================================================ +wxSocketBase *wxFTP::AcceptIfActive(wxSocketBase *sock) +{ + if ( m_bPassive ) + return sock; + + // now wait for a connection from server + wxSocketServer *sockSrv = (wxSocketServer *)sock; + if ( !sockSrv->WaitForAccept() ) + { + m_lastError = wxPROTO_CONNERR; + wxLogError(_("Timeout while waiting for FTP server to connect, try passive mode.")); + delete sock; + sock = NULL; + } + else + { + m_lastError = wxPROTO_NOERR; + sock = sockSrv->Accept(true); + delete sockSrv; + } + + return sock; +} + +bool wxFTP::Abort() +{ + if ( !m_streaming ) + return true; + + m_streaming = false; + if ( !CheckCommand(wxT("ABOR"), '4') ) + return false; + + return CheckResult('2'); +} + + // ---------------------------------------------------------------------------- // Send command to FTP server // ---------------------------------------------------------------------------- @@ -212,7 +245,6 @@ char wxFTP::SendCommand(const wxString& command) 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) ) @@ -224,14 +256,14 @@ char wxFTP::SendCommand(const wxString& command) cmd = command; } - wxLogTrace(FTP_TRACE_MASK, _T("==> %s"), cmd.c_str()); -#endif // __WXDEBUG__ + LogRequest(cmd); + m_lastError = wxPROTO_NOERR; return GetResult(); } // ---------------------------------------------------------------------------- -// Recieve servers reply +// Receive servers reply // ---------------------------------------------------------------------------- char wxFTP::GetResult() @@ -267,6 +299,8 @@ char wxFTP::GetResult() return 0; } + LogResponse(line); + if ( !m_lastResult.empty() ) { // separate from last line @@ -283,11 +317,6 @@ char wxFTP::GetResult() { badReply = true; } - else - { - wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"), - code.c_str(), line.c_str()); - } } else // line has at least 4 chars { @@ -297,8 +326,6 @@ char wxFTP::GetResult() 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 ) { @@ -317,21 +344,12 @@ char wxFTP::GetResult() } else // subsequent line of multiline reply { - if ( wxStrncmp(line, code, LEN_CODE) == 0 ) + if ( line.compare(0, LEN_CODE, 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()); } } } @@ -346,9 +364,11 @@ char wxFTP::GetResult() return 0; } + else + m_lastError = wxPROTO_NOERR; // if we got here we must have a non empty code string - return code[0u]; + return (char)code[0u]; } // ---------------------------------------------------------------------------- @@ -381,13 +401,13 @@ bool wxFTP::SetTransferMode(TransferMode transferMode) if ( !DoSimpleCommand(_T("TYPE"), mode) ) { - wxLogError(_("Failed to set FTP transfer mode to %s."), (const wxChar*) + wxLogError(_("Failed to set FTP transfer mode to %s."), (transferMode == ASCII ? _("ASCII") : _("binary"))); return false; } - // If we get here the operation has been succesfully completed + // If we get here the operation has been successfully completed // Set the status-member m_currentTransfermode = transferMode; @@ -405,10 +425,12 @@ bool wxFTP::DoSimpleCommand(const wxChar *command, const wxString& arg) if ( !CheckCommand(fullcmd, '2') ) { wxLogDebug(_T("FTP command '%s' failed."), fullcmd.c_str()); + m_lastError = wxPROTO_NETERR; return false; } + m_lastError = wxPROTO_NOERR; return true; } @@ -438,19 +460,20 @@ wxString wxFTP::Pwd() 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; + wxString::const_iterator p = m_lastResult.begin() + LEN_CODE + 1; if ( *p != _T('"') ) { - wxLogDebug(_T("Missing starting quote in reply for PWD: %s"), p); + wxLogDebug(_T("Missing starting quote in reply for PWD: %s"), + wxString(p, m_lastResult.end())); } else { - for ( p++; *p; p++ ) + for ( ++p; (bool)*p; ++p ) // FIXME-DMARS { if ( *p == _T('"') ) { // check if the quote is doubled - p++; + ++p; if ( !*p || *p != _T('"') ) { // no, this is the end @@ -472,6 +495,7 @@ wxString wxFTP::Pwd() } else { + m_lastError = wxPROTO_PROTERR; wxLogDebug(_T("FTP PWD command failed.")); } @@ -500,100 +524,9 @@ bool wxFTP::RmFile(const wxString& path) } // ---------------------------------------------------------------------------- -// wxFTP download and upload +// wxFTP port methods // ---------------------------------------------------------------------------- -class wxInputFTPStream : public wxSocketInputStream -{ -public: - wxInputFTPStream(wxFTP *ftp, wxSocketBase *sock) - : wxSocketInputStream(*sock) - { - m_ftp = ftp; - // socket timeout automatically set in GetPort function - } - - virtual ~wxInputFTPStream() - { - delete m_i_socket; // keep at top - - // when checking the result, the stream will - // almost always show an error, even if the file was - // properly transfered, thus, lets just grab the result - - // we are looking for "226 transfer completed" - char code = m_ftp->GetResult(); - if ('2' == code) - { - // it was a good transfer. - // we're done! - m_ftp->m_streaming = false; - return; - } - // did we timeout? - if (0 == code) - { - // the connection is probably toast. issue an abort, and - // then a close. there won't be any more waiting - // for this connection - m_ftp->Abort(); - m_ftp->Close(); - return; - } - // There was a problem with the transfer and the server - // has acknowledged it. If we issue an "ABORT" now, the user - // would get the "226" for the abort and think the xfer was - // complete, thus, don't do anything here, just return - } - - wxFTP *m_ftp; - - DECLARE_NO_COPY_CLASS(wxInputFTPStream) -}; - -class wxOutputFTPStream : public wxSocketOutputStream -{ -public: - 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->GetResult(); // save result so user can get to it - - m_ftp->m_streaming = false; - } - else - { - // abort data connection first - m_ftp->Abort(); - - // and close it after - delete m_o_socket; - } - } - - wxFTP *m_ftp; - - DECLARE_NO_COPY_CLASS(wxOutputFTPStream) -}; - -void wxFTP::SetDefaultTimeout(wxUint32 Value) -{ - m_uiDefaultTimeout = Value; - SetTimeout(Value); // sets it for this socket -} - - wxSocketBase *wxFTP::GetPort() { /* @@ -622,31 +555,8 @@ wxSocketBase *wxFTP::GetPort() return socket; } -wxSocketBase *wxFTP::AcceptIfActive(wxSocketBase *sock) -{ - if ( m_bPassive ) - return sock; - - // now wait for a connection from server - wxSocketServer *sockSrv = (wxSocketServer *)sock; - if ( !sockSrv->WaitForAccept() ) - { - m_lastError = wxPROTO_CONNERR; - wxLogError(_("Timeout while waiting for FTP server to connect, try passive mode.")); - delete sock; - sock = NULL; - } - else - { - sock = sockSrv->Accept(true); - delete sockSrv; - } - - return sock; -} - -wxString wxFTP::GetPortCmdArgument(wxIPV4address addrLocal, - wxIPV4address addrNew) +wxString wxFTP::GetPortCmdArgument(const wxIPV4address& addrLocal, + const wxIPV4address& addrNew) { // Just fills in the return value with the local IP // address of the current socket. Also it fill in the @@ -689,7 +599,7 @@ wxSocketBase *wxFTP::GetActivePort() // addresses because the addrNew has an IP of "0.0.0.0", so we need the // value in addrLocal wxString port = GetPortCmdArgument(addrLocal, addrNew); - if ( !DoSimpleCommand(_T("PORT "), port) ) + if ( !DoSimpleCommand(_T("PORT"), port) ) { m_lastError = wxPROTO_PROTERR; delete sockSrv; @@ -697,6 +607,7 @@ wxSocketBase *wxFTP::GetActivePort() return NULL; } + m_lastError = wxPROTO_NOERR; sockSrv->Notify(false); // Don't send any events return sockSrv; } @@ -705,22 +616,25 @@ wxSocketBase *wxFTP::GetPassivePort() { if ( !DoSimpleCommand(_T("PASV")) ) { + m_lastError = wxPROTO_PROTERR; wxLogError(_("The FTP server doesn't support passive mode.")); return NULL; } - const wxChar *addrStart = wxStrchr(m_lastResult, _T('(')); - const wxChar *addrEnd = addrStart ? wxStrchr(addrStart, _T(')')) : NULL; - if ( !addrEnd ) + size_t addrStart = m_lastResult.find(_T('(')); + size_t addrEnd = (addrStart == wxString::npos) + ? wxString::npos + : m_lastResult.find(_T(')'), addrStart); + + if ( addrEnd == wxString::npos ) { m_lastError = wxPROTO_PROTERR; - return NULL; } // get the port number and address int a[6]; - wxString straddr(addrStart + 1, addrEnd); + wxString straddr(m_lastResult, addrStart + 1, addrEnd - (addrStart + 1)); wxSscanf(straddr, wxT("%d,%d,%d,%d,%d,%d"), &a[2],&a[3],&a[4],&a[5],&a[0],&a[1]); @@ -737,31 +651,113 @@ wxSocketBase *wxFTP::GetPassivePort() wxSocketClient *client = new wxSocketClient(); if ( !client->Connect(addr) ) { + m_lastError = wxPROTO_CONNERR; delete client; return NULL; } client->Notify(false); + m_lastError = wxPROTO_NOERR; return client; } -bool wxFTP::Abort() + +// ---------------------------------------------------------------------------- +// wxFTP download and upload +// ---------------------------------------------------------------------------- + +class wxInputFTPStream : public wxSocketInputStream { - if ( !m_streaming ) - return true; +public: + wxInputFTPStream(wxFTP *ftp, wxSocketBase *sock) + : wxSocketInputStream(*sock) + { + m_ftp = ftp; + // socket timeout automatically set in GetPort function + } - m_streaming = false; - if ( !CheckCommand(wxT("ABOR"), '4') ) - return false; + virtual ~wxInputFTPStream() + { + delete m_i_socket; // keep at top - return CheckResult('2'); -} + // when checking the result, the stream will + // almost always show an error, even if the file was + // properly transfered, thus, lets just grab the result + + // we are looking for "226 transfer completed" + char code = m_ftp->GetResult(); + if ('2' == code) + { + // it was a good transfer. + // we're done! + m_ftp->m_streaming = false; + return; + } + // did we timeout? + if (0 == code) + { + // the connection is probably toast. issue an abort, and + // then a close. there won't be any more waiting + // for this connection + m_ftp->Abort(); + m_ftp->Close(); + return; + } + // There was a problem with the transfer and the server + // has acknowledged it. If we issue an "ABORT" now, the user + // would get the "226" for the abort and think the xfer was + // complete, thus, don't do anything here, just return + } + + wxFTP *m_ftp; + + wxDECLARE_NO_COPY_CLASS(wxInputFTPStream); +}; + +class wxOutputFTPStream : public wxSocketOutputStream +{ +public: + 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->GetResult(); // save result so user can get to it + + m_ftp->m_streaming = false; + } + else + { + // abort data connection first + m_ftp->Abort(); + + // and close it after + delete m_o_socket; + } + } + + wxFTP *m_ftp; + + wxDECLARE_NO_COPY_CLASS(wxOutputFTPStream); +}; wxInputStream *wxFTP::GetInputStream(const wxString& path) { if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) ) + { + m_lastError = wxPROTO_CONNERR; return NULL; + } wxSocketBase *sock = GetPort(); @@ -771,13 +767,16 @@ wxInputStream *wxFTP::GetInputStream(const wxString& path) return NULL; } - wxString tmp_str = wxT("RETR ") + wxURL::ConvertFromURI(path); + wxString tmp_str = wxT("RETR ") + wxURI::Unescape(path); if ( !CheckCommand(tmp_str, '1') ) return NULL; sock = AcceptIfActive(sock); if ( !sock ) + { + m_lastError = wxPROTO_CONNERR; return NULL; + } sock->SetFlags(wxSOCKET_WAITALL); @@ -785,13 +784,17 @@ wxInputStream *wxFTP::GetInputStream(const wxString& path) wxInputFTPStream *in_stream = new wxInputFTPStream(this, sock); + m_lastError = wxPROTO_NOERR; return in_stream; } wxOutputStream *wxFTP::GetOutputStream(const wxString& path) { if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) ) + { + m_lastError = wxPROTO_CONNERR; return NULL; + } wxSocketBase *sock = GetPort(); @@ -803,6 +806,7 @@ wxOutputStream *wxFTP::GetOutputStream(const wxString& path) m_streaming = true; + m_lastError = wxPROTO_NOERR; return new wxOutputFTPStream(this, sock); } @@ -815,8 +819,10 @@ bool wxFTP::GetList(wxArrayString& files, bool details) { wxSocketBase *sock = GetPort(); - if (!sock) + if (!sock) { + m_lastError = wxPROTO_NETERR; return false; + } // NLST : List of Filenames (including Directory's !) // LIST : depending on BS of FTP-Server @@ -824,7 +830,7 @@ bool wxFTP::GetList(wxArrayString& files, // - Windows : like "dir" command // - others : ? wxString line(details ? _T("LIST") : _T("NLST")); - if ( !wildcard.IsEmpty() ) + if ( !wildcard.empty() ) { line << _T(' ') << wildcard; } @@ -838,8 +844,10 @@ bool wxFTP::GetList(wxArrayString& files, } sock = AcceptIfActive(sock); - if ( !sock ) + if ( !sock ) { + m_lastError = wxPROTO_CONNERR; return false; + } files.Empty(); while (ReadLine(sock, line) == wxPROTO_NOERR ) @@ -850,6 +858,7 @@ bool wxFTP::GetList(wxArrayString& files, delete sock; // the file list should be terminated by "226 Transfer complete"" + m_lastError = wxPROTO_NOERR; return CheckResult('2'); } @@ -865,7 +874,7 @@ bool wxFTP::FileExists(const wxString& fileName) 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: + // displays this behaviour when queried on a nonexistent file: // NLST this_file_does_not_exist // 150 Opening ASCII data connection for directory listing // (no data transferred) @@ -954,7 +963,7 @@ int wxFTP::GetFileSize(const wxString& fileName) bool foundIt = false; size_t i; - for ( i = 0; !foundIt && i < fileList.Count(); i++ ) + for ( i = 0; !foundIt && i < fileList.GetCount(); i++ ) { foundIt = fileList[i].Upper().Contains(fileName.Upper()); } @@ -983,8 +992,7 @@ int wxFTP::GetFileSize(const wxString& fileName) &filesize) != 9 ) { // Hmm... Invalid response - wxLogTrace(FTP_TRACE_MASK, - _T("Invalid LIST response")); + wxLogDebug(wxT("Invalid LIST response")); } } else // Windows-style response (?) @@ -994,8 +1002,7 @@ int wxFTP::GetFileSize(const wxString& fileName) &filesize) != 4 ) { // something bad happened..? - wxLogTrace(FTP_TRACE_MASK, - _T("Invalid or unknown LIST response")); + wxLogDebug(wxT("Invalid or unknown LIST response")); } } }