// Created: 07/07/1997
// RCS-ID: $Id$
// Copyright: (c) 1997, 1998 Guilhem Lavaux
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
#pragma hdrstop
#endif
-#if wxUSE_SOCKETS && wxUSE_STREAMS
+#if wxUSE_PROTOCOL_FTP
#ifndef WX_PRECOMP
#include <stdlib.h>
#include "wx/protocol/ftp.h"
#if defined(__WXMAC__)
- #include "/wx/mac/macsock.h"
+ #include "wx/mac/macsock.h"
#endif
#ifndef __MWERKS__
{
m_lastError = wxPROTO_NOERR;
m_streaming = FALSE;
- m_modeSet = FALSE;
+ m_currentTransfermode = NONE;
m_user = wxT("anonymous");
m_passwd << wxGetUserId() << wxT('@') << wxGetFullHostName();
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();
}
}
else
{
- wxLogTrace(_T("ftp"), _T("<== %s %s"),
+ wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"),
code.c_str(), line.c_str());
}
}
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 )
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());
}
}
bool wxFTP::SetTransferMode(TransferMode transferMode)
{
+ if ( transferMode == m_currentTransfermode )
+ {
+ // nothing to do
+ return TRUE;
+ }
+
wxString mode;
switch ( 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;
}
- m_modeSet = TRUE;
+ // If we get here the operation has been succesfully completed
+ // Set the status-member
+ m_currentTransfermode = transferMode;
return TRUE;
}
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; }
{
delete m_i_socket;
- if ( LastError() == wxStream_NOERROR )
+ if ( IsOk() )
{
// wait for "226 transfer completed"
m_ftp->CheckResult('2');
{
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
}
wxFTP *m_ftp;
+
+ DECLARE_NO_COPY_CLASS(wxOutputFTPStream)
};
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;
return NULL;
}
- const char *addrEnd = wxStrchr(addrStart, _T(')'));
+ const wxChar *addrEnd = wxStrchr(addrStart, _T(')'));
if ( !addrEnd )
{
m_lastError = wxPROTO_PROTERR;
int pos_size;
wxInputFTPStream *in_stream;
- if ( !m_modeSet && !SetTransferMode(BINARY) )
+ if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) )
return NULL;
wxSocketClient *sock = GetPort();
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;
return TRUE;
}
-#ifdef WXWIN_COMPATIBILITY_2
+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;
+}
+
+// ----------------------------------------------------------------------------
+// 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 <filesize>\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(),
+ _T("%*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;
+ return NULL;
wxList *file_list = new wxList;
wxString line;
// NLST : List of Filenames (including Directory's !)
}
#endif // WXWIN_COMPATIBILITY_2
-#endif
- // wxUSE_SOCKETS
+#endif // wxUSE_PROTOCOL_FTP
+
projects / wxWidgets.git / blobdiff