X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b0ad2006750461404c3f04bb6154d033b2873148..f938a756a1c5944f7cc3ee6f2e51effbc06fd9c0:/src/common/ftp.cpp diff --git a/src/common/ftp.cpp b/src/common/ftp.cpp index f485e9a7b0..fbb119d4de 100644 --- a/src/common/ftp.cpp +++ b/src/common/ftp.cpp @@ -10,14 +10,14 @@ // Created: 07/07/1997 // RCS-ID: $Id$ // Copyright: (c) 1997, 1998 Guilhem Lavaux -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ // declarations // ============================================================================ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma implementation "ftp.h" #endif @@ -32,7 +32,7 @@ #pragma hdrstop #endif -#if wxUSE_SOCKETS && wxUSE_STREAMS +#if wxUSE_PROTOCOL_FTP #ifndef WX_PRECOMP #include @@ -50,7 +50,7 @@ #include "wx/protocol/ftp.h" #if defined(__WXMAC__) - #include "/wx/mac/macsock.h" + #include "wx/mac/macsock.h" #endif #ifndef __MWERKS__ @@ -69,7 +69,7 @@ static const size_t LEN_CODE = 3; // ---------------------------------------------------------------------------- IMPLEMENT_DYNAMIC_CLASS(wxFTP, wxProtocol) -IMPLEMENT_PROTOCOL(wxFTP, wxT("ftp"), wxT("ftp"), TRUE) +IMPLEMENT_PROTOCOL(wxFTP, wxT("ftp"), wxT("ftp"), true) // ============================================================================ // implementation @@ -82,8 +82,8 @@ IMPLEMENT_PROTOCOL(wxFTP, wxT("ftp"), wxT("ftp"), TRUE) wxFTP::wxFTP() { m_lastError = wxPROTO_NOERR; - m_streaming = FALSE; - m_modeSet = FALSE; + m_streaming = false; + m_currentTransfermode = NONE; m_user = wxT("anonymous"); m_passwd << wxGetUserId() << wxT('@') << wxGetFullHostName(); @@ -111,20 +111,20 @@ bool wxFTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait)) if ( !wxProtocol::Connect(addr) ) { m_lastError = wxPROTO_NETERR; - return FALSE; + return false; } if ( !m_user ) { m_lastError = wxPROTO_CONNERR; - return FALSE; + return false; } // we should have 220 welcome message if ( !CheckResult('2') ) { Close(); - return FALSE; + return false; } wxString command; @@ -133,23 +133,23 @@ bool wxFTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait)) if ( rc == '2' ) { // 230 return: user accepted without password - return TRUE; + return true; } if ( rc != '3' ) { Close(); - return FALSE; + return false; } command.Printf(wxT("PASS %s"), m_passwd.c_str()); if ( !CheckCommand(command, '2') ) { Close(); - return FALSE; + return false; } - return TRUE; + return true; } bool wxFTP::Connect(const wxString& host) @@ -166,7 +166,7 @@ bool wxFTP::Close() if ( m_streaming ) { m_lastError = wxPROTO_STREAMING; - return FALSE; + return false; } if ( IsConnected() ) @@ -204,7 +204,20 @@ char wxFTP::SendCommand(const wxString& command) return 0; } - wxLogTrace(_T("ftp"), _T("==> %s"), command.c_str()); +#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(); } @@ -228,9 +241,9 @@ char wxFTP::GetResult() // ... // xyz ... // and the intermeidate lines may start with xyz or not - bool badReply = FALSE; - bool firstLine = TRUE; - bool endOfReply = FALSE; + bool badReply = false; + bool firstLine = true; + bool endOfReply = false; while ( !endOfReply && !badReply ) { wxString line; @@ -252,11 +265,11 @@ char wxFTP::GetResult() { if ( firstLine ) { - badReply = TRUE; + badReply = true; } else { - wxLogTrace(_T("ftp"), _T("<== %s %s"), + wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"), code.c_str(), line.c_str()); } } @@ -268,22 +281,22 @@ char wxFTP::GetResult() if ( firstLine ) { code = wxString(line, LEN_CODE); - wxLogTrace(_T("ftp"), _T("<== %s %s"), + wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"), code.c_str(), line.c_str() + LEN_CODE + 1); switch ( chMarker ) { case _T(' '): - endOfReply = TRUE; + endOfReply = true; break; case _T('-'): - firstLine = FALSE; + firstLine = false; break; default: // unexpected - badReply = TRUE; + badReply = true; } } else // subsequent line of multiline reply @@ -292,16 +305,16 @@ char wxFTP::GetResult() { if ( chMarker == _T(' ') ) { - endOfReply = TRUE; + endOfReply = true; } - wxLogTrace(_T("ftp"), _T("<== %s %s"), + wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"), code.c_str(), line.c_str() + LEN_CODE + 1); } else { // just part of reply - wxLogTrace(_T("ftp"), _T("<== %s %s"), + wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"), code.c_str(), line.c_str()); } } @@ -328,6 +341,12 @@ char wxFTP::GetResult() bool wxFTP::SetTransferMode(TransferMode transferMode) { + if ( transferMode == m_currentTransfermode ) + { + // nothing to do + return true; + } + wxString mode; switch ( transferMode ) { @@ -346,15 +365,17 @@ bool wxFTP::SetTransferMode(TransferMode transferMode) if ( !DoSimpleCommand(_T("TYPE"), mode) ) { - wxLogError(_("Failed to set FTP transfer mode to %s."), - transferMode == ASCII ? _("ASCII") : _("binary")); + wxLogError(_("Failed to set FTP transfer mode to %s."), (const wxChar*) + (transferMode == ASCII ? _("ASCII") : _("binary"))); - return FALSE; + return false; } - m_modeSet = TRUE; + // If we get here the operation has been succesfully completed + // Set the status-member + m_currentTransfermode = transferMode; - return TRUE; + return true; } bool wxFTP::DoSimpleCommand(const wxChar *command, const wxString& arg) @@ -369,10 +390,10 @@ bool wxFTP::DoSimpleCommand(const wxChar *command, const wxString& arg) { wxLogDebug(_T("FTP command '%s' failed."), fullcmd.c_str()); - return FALSE; + return false; } - return TRUE; + return true; } bool wxFTP::ChDir(const wxString& dir) @@ -447,7 +468,7 @@ bool wxFTP::Rename(const wxString& src, const wxString& dst) str = wxT("RNFR ") + src; if ( !CheckCommand(str, '3') ) - return FALSE; + return false; str = wxT("RNTO ") + dst; @@ -469,9 +490,15 @@ bool wxFTP::RmFile(const wxString& path) class wxInputFTPStream : public wxSocketInputStream { public: - wxInputFTPStream(wxFTP *ftp_clt, wxSocketBase *sock) - : wxSocketInputStream(*sock), m_ftp(ftp_clt) + 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; } @@ -480,21 +507,25 @@ public: { delete m_i_socket; - if ( LastError() == wxStream_NOERROR ) + if ( IsOk() ) { // wait for "226 transfer completed" m_ftp->CheckResult('2'); - m_ftp->m_streaming = FALSE; + 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; + + DECLARE_NO_COPY_CLASS(wxInputFTPStream) }; class wxOutputFTPStream : public wxSocketOutputStream @@ -516,7 +547,7 @@ public: // read this reply m_ftp->CheckResult('2'); - m_ftp->m_streaming = FALSE; + m_ftp->m_streaming = false; } else { @@ -529,6 +560,8 @@ public: } wxFTP *m_ftp; + + DECLARE_NO_COPY_CLASS(wxOutputFTPStream) }; wxSocketClient *wxFTP::GetPort() @@ -542,7 +575,7 @@ wxSocketClient *wxFTP::GetPort() return NULL; } - const char *addrStart = wxStrchr(m_lastResult, _T('(')); + const wxChar *addrStart = wxStrchr(m_lastResult, _T('(')); if ( !addrStart ) { m_lastError = wxPROTO_PROTERR; @@ -550,7 +583,7 @@ wxSocketClient *wxFTP::GetPort() return NULL; } - const char *addrEnd = wxStrchr(addrStart, _T(')')); + const wxChar *addrEnd = wxStrchr(addrStart, _T(')')); if ( !addrEnd ) { m_lastError = wxPROTO_PROTERR; @@ -563,10 +596,10 @@ wxSocketClient *wxFTP::GetPort() 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]; + wxUint32 hostaddr = (wxUint16)a[2] << 24 | + (wxUint16)a[3] << 16 | + (wxUint16)a[4] << 8 | + a[5]; wxUint16 port = (wxUint16)a[0] << 8 | a[1]; wxIPV4address addr; @@ -580,7 +613,7 @@ wxSocketClient *wxFTP::GetPort() return NULL; } - client->Notify(FALSE); + client->Notify(false); return client; } @@ -588,11 +621,11 @@ wxSocketClient *wxFTP::GetPort() bool wxFTP::Abort() { if ( !m_streaming ) - return TRUE; + return true; - m_streaming = FALSE; + m_streaming = false; if ( !CheckCommand(wxT("ABOR"), '4') ) - return FALSE; + return false; return CheckResult('2'); } @@ -602,7 +635,7 @@ wxInputStream *wxFTP::GetInputStream(const wxString& path) int pos_size; wxInputFTPStream *in_stream; - if ( !m_modeSet && !SetTransferMode(BINARY) ) + if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) ) return NULL; wxSocketClient *sock = GetPort(); @@ -617,7 +650,7 @@ wxInputStream *wxFTP::GetInputStream(const wxString& path) if ( !CheckCommand(tmp_str, '1') ) return NULL; - m_streaming = TRUE; + m_streaming = true; in_stream = new wxInputFTPStream(this, sock); @@ -636,16 +669,16 @@ wxInputStream *wxFTP::GetInputStream(const wxString& path) wxOutputStream *wxFTP::GetOutputStream(const wxString& path) { - if ( !m_modeSet && !SetTransferMode(BINARY) ) + if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) ) return NULL; wxSocketClient *sock = GetPort(); wxString tmp_str = wxT("STOR ") + path; if ( !CheckCommand(tmp_str, '1') ) - return FALSE; + return NULL; - m_streaming = TRUE; + m_streaming = true; return new wxOutputFTPStream(this, sock); } @@ -660,7 +693,7 @@ bool wxFTP::GetList(wxArrayString& files, { wxSocketBase *sock = GetPort(); if (!sock) - return FALSE; + return false; // NLST : List of Filenames (including Directory's !) // LIST : depending on BS of FTP-Server @@ -668,14 +701,14 @@ bool wxFTP::GetList(wxArrayString& files, // - Windows : like "dir" command // - others : ? wxString line(details ? _T("LIST") : _T("NLST")); - if ( !!wildcard ) + if ( !wildcard.IsEmpty() ) { line << _T(' ') << wildcard; } if (!CheckCommand(line, '1')) { - return FALSE; + return false; } files.Empty(); while ( ReadLine(sock, line) == wxPROTO_NOERR ) @@ -686,51 +719,165 @@ bool wxFTP::GetList(wxArrayString& files, // the file list should be terminated by "226 Transfer complete"" if ( !CheckResult('2') ) - return FALSE; + return false; - return TRUE; + return true; } -#ifdef WXWIN_COMPATIBILITY_2 -// deprecated -wxList *wxFTP::GetList(const wxString& wildcard, bool details) +bool wxFTP::FileExists(const wxString& fileName) { - 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; + // 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; } -#endif // WXWIN_COMPATIBILITY_2 -#endif - // wxUSE_SOCKETS +// ---------------------------------------------------------------------------- +// FTP GetSize +// ---------------------------------------------------------------------------- + +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); + } + + // this is not a direct else clause.. The size command might return an + // invalid "2yz" reply + if ( !ok ) + { + // 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(), + _T("%*s %*s %*s %*s %i %*s %*s %*s %*s"), + &filesize) != 9 ) + { + // 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 ) + { + // something bad happened..? + wxLogTrace(FTP_TRACE_MASK, + _T("Invalid or unknown LIST response")); + } + } + } + } + } + } + } + + // filesize might still be -1 when exiting + return filesize; +} + +#endif // wxUSE_PROTOCOL_FTP +