/////////////////////////////////////////////////////////////////////////////
-// Name: ftp.cpp
+// Name: common/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, ...)
+// Randall Fox (support for active mode)
// Created: 07/07/1997
// RCS-ID: $Id$
// Copyright: (c) 1997, 1998 Guilhem Lavaux
-// Licence: wxWindows license
+// (c) 1998-2004 wxWidgets team
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "ftp.h"
-#endif
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// 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_PROTOCOL_FTP
-#ifndef __MWERKS__
-#include <memory.h>
-#endif
-#if defined(__WXMAC__)
-#include "/wx/mac/macsock.h"
-#endif
+#ifndef WX_PRECOMP
+ #include <stdlib.h>
+ #include "wx/string.h"
+ #include "wx/utils.h"
+ #include "wx/log.h"
+ #include "wx/intl.h"
+ #include "wx/wxcrtvararg.h"
+#endif // WX_PRECOMP
-#include <stdlib.h>
-#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
+#ifndef __MWERKS__
+ #include <memory.h>
#endif
-#define FTP_BSIZE 1024
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
-#if !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxFTP, wxProtocol)
-IMPLEMENT_PROTOCOL(wxFTP, "ftp", "ftp", TRUE)
-#endif
+// the length of FTP status code (3 digits)
+static const size_t LEN_CODE = 3;
-////////////////////////////////////////////////////////////////
-////// wxFTP constructor and destructor ////////////////////////
-////////////////////////////////////////////////////////////////
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------
-wxFTP::wxFTP()
- : wxProtocol()
-{
- char tmp[256];
+IMPLEMENT_DYNAMIC_CLASS(wxFTP, wxProtocol)
+IMPLEMENT_PROTOCOL(wxFTP, wxT("ftp"), wxT("ftp"), true)
- m_lastError = wxPROTO_NOERR;
- m_streaming = FALSE;
+// ============================================================================
+// implementation
+// ============================================================================
- m_user = "anonymous";
- wxGetUserName(tmp, 256);
- m_passwd.sprintf("%s@",tmp);
- wxGetHostName(tmp, 256);
- m_passwd += tmp;
+// ----------------------------------------------------------------------------
+// wxFTP constructor and destructor
+// ----------------------------------------------------------------------------
- SetNotify(0);
+wxFTP::wxFTP()
+{
+ m_lastError = wxPROTO_NOERR;
+ m_streaming = false;
+ m_currentTransfermode = NONE;
+
+ m_user = wxT("anonymous");
+ m_passwd << wxGetUserId() << wxT('@') << wxGetFullHostName();
+
+ SetNotify(0);
+ SetFlags(wxSOCKET_NOWAIT);
+ m_bPassive = true;
+ SetDefaultTimeout(60); // Default is Sixty Seconds
+ m_bEncounteredError = false;
}
wxFTP::~wxFTP()
{
- SendCommand("QUIT", '2');
+ if ( m_streaming )
+ {
+ // if we are streaming, this will issue
+ // an FTP ABORT command, to tell the server we are aborting
+ (void)Abort();
+ }
+
+ // now this issues a "QUIT" command to tell the server we are
+ 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("USER %s", (const char *)m_user);
- if (!SendCommand(command, '3')) {
- Close();
- return FALSE;
- }
+ if ( rc != '3' )
+ {
+ Close();
+ return false;
+ }
- command.sprintf("PASS %s", (const char *)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;
-
- addr.Hostname(my_host);
- addr.Service("ftp");
+ wxIPV4address addr;
+ addr.Hostname(host);
+ addr.Service(wxT("ftp"));
- return Connect(addr);
+ return Connect(addr);
}
bool wxFTP::Close()
{
- if (m_streaming) {
- m_lastError = wxPROTO_STREAMING;
- return FALSE;
- }
- if (m_connected)
- SendCommand(wxString("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 + "\r\n";
- if (Write((char *)tmp_str.GetData(), tmp_str.Length()).Error()) {
- m_lastError = wxPROTO_NETERR;
- return FALSE;
- }
- return GetResult(exp_ret);
+ // if we've already had a read or write timeout error, the connection is
+ // probably toast, so don't bother, it just wastes the users time
+ if ( m_bEncounteredError )
+ return 0;
+
+ 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(this,line);
+ if ( m_lastError )
+ {
+ m_bEncounteredError = true;
+ 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 ( 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());
+ }
+ }
+ }
+ }
+
+ 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 (char)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
+
+ case BINARY:
+ mode = _T('I');
+ break;
+
+ case ASCII:
+ mode = _T('A');
+ break;
+ }
+
+ if ( !DoSimpleCommand(_T("TYPE"), mode) )
+ {
+ wxLogError(_("Failed to set FTP transfer mode to %s."),
+ (transferMode == ASCII ? _("ASCII") : _("binary")));
+
+ return false;
+ }
+
+ // If we get here the operation has been successfully completed
+ // Set the status-member
+ m_currentTransfermode = transferMode;
- if (m_lastResult.GetChar(3) == '-') {
- wxString key = m_lastResult.Left((size_t)3);
+ return true;
+}
- key += ' ';
+bool wxFTP::DoSimpleCommand(const wxChar *command, const wxString& arg)
+{
+ wxString fullcmd = command;
+ if ( !arg.empty() )
+ {
+ fullcmd << _T(' ') << arg;
+ }
- while (m_lastResult.Index(key) != 0) {
- if ((m_lastError = GetLine(this, m_lastResult)))
- return FALSE;
+ if ( !CheckCommand(fullcmd, '2') )
+ {
+ wxLogDebug(_T("FTP command '%s' failed."), fullcmd.c_str());
+
+ return false;
}
- }
- return TRUE;
+
+ 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("CWD ");
- return SendCommand(str, '2');
+ return DoSimpleCommand(_T("CWD"), dir);
}
bool wxFTP::MkDir(const wxString& dir)
{
- wxString str = dir;
- str.Prepend("MKD ");
- return SendCommand(str, '2');
+ return DoSimpleCommand(_T("MKD"), dir);
}
bool wxFTP::RmDir(const wxString& dir)
{
- wxString str = dir;
-
- str.Prepend("PWD ");
- return SendCommand(str, '2');
+ return DoSimpleCommand(_T("RMD"), dir);
}
wxString wxFTP::Pwd()
{
- int beg, end;
-
- if (!SendCommand("PWD", '2'))
- return wxString((char *)NULL);
-
- beg = m_lastResult.Find('\"',FALSE);
- end = m_lastResult.Find('\"',TRUE);
+ wxString path;
+
+ if ( CheckCommand(wxT("PWD"), '2') )
+ {
+ // the result is at least that long if CheckCommand() succeeded
+ wxString::const_iterator p = m_lastResult.begin() + LEN_CODE + 1;
+ if ( *p != _T('"') )
+ {
+ wxLogDebug(_T("Missing starting quote in reply for PWD: %s"),
+ wxString(p, m_lastResult.end()));
+ }
+ else
+ {
+ for ( ++p; (bool)*p; ++p ) // FIXME-DMARS
+ {
+ 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 = "RNFR " + src;
- if (!SendCommand(str, '3'))
- return FALSE;
+ str = wxT("RNTO ") + dst;
- str = "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 = "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;
+ // 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 {
+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->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)
};
-wxSocketClient *wxFTP::GetPort()
+void wxFTP::SetDefaultTimeout(wxUint32 Value)
+{
+ m_uiDefaultTimeout = Value;
+ SetTimeout(Value); // sets it for this socket
+}
+
+
+wxSocketBase *wxFTP::GetPort()
+{
+ /*
+ PASSIVE: Client sends a "PASV" to the server. The server responds with
+ an address and port number which it will be listening on. Then
+ the client connects to the server at the specified address and
+ port.
+
+ ACTIVE: Client sends the server a PORT command which includes an
+ address and port number which the client will be listening on.
+ The server then connects to the client at that address and
+ port.
+ */
+
+ wxSocketBase *socket = m_bPassive ? GetPassivePort() : GetActivePort();
+ if ( !socket )
+ {
+ m_bEncounteredError = true;
+ return NULL;
+ }
+
+ // Now set the time for the new socket to the default or user selected
+ // timeout period
+ socket->SetTimeout(m_uiDefaultTimeout);
+
+ 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(const wxIPV4address& addrLocal,
+ const wxIPV4address& addrNew)
{
- wxIPV4address addr;
- wxSocketClient *client;
- struct sockaddr sin;
- int a[6];
- wxString straddr;
- int addr_pos;
-
- if (!SendCommand("PASV", '2'))
- return NULL;
-
- sin.sa_family = AF_INET;
- addr_pos = m_lastResult.Find('(');
- if (addr_pos == -1) {
- m_lastError = wxPROTO_PROTERR;
- return NULL;
- }
- straddr = m_lastResult(addr_pos+1, m_lastResult.Length());
- sscanf((const char *)straddr,"%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;
+ // Just fills in the return value with the local IP
+ // address of the current socket. Also it fill in the
+ // PORT which the client will be listening on
+
+ wxString addrIP = addrLocal.IPAddress();
+ int portNew = addrNew.Service();
+
+ // We need to break the PORT number in bytes
+ addrIP.Replace(_T("."), _T(","));
+ addrIP << _T(',')
+ << wxString::Format(_T("%d"), portNew >> 8) << _T(',')
+ << wxString::Format(_T("%d"), portNew & 0xff);
+
+ // Now we have a value like "10,0,0,1,5,23"
+ return addrIP;
}
-bool wxFTP::Abort(void)
+wxSocketBase *wxFTP::GetActivePort()
{
- m_streaming = FALSE;
- if (!SendCommand("ABOR", '4'))
- return FALSE;
- return GetResult('2');
+ // we need an address to listen on
+ wxIPV4address addrNew, addrLocal;
+ GetLocal(addrLocal);
+ addrNew.AnyAddress();
+ addrNew.Service(0); // pick an open port number.
+
+ wxSocketServer *sockSrv = new wxSocketServer(addrNew);
+ if (!sockSrv->Ok())
+ {
+ // We use Ok() here to see if everything is ok
+ m_lastError = wxPROTO_PROTERR;
+ delete sockSrv;
+ return NULL;
+ }
+
+ //gets the new address, actually it is just the port number
+ sockSrv->GetLocal(addrNew);
+
+ // Now we create the argument of the PORT command, we send in both
+ // 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) )
+ {
+ m_lastError = wxPROTO_PROTERR;
+ delete sockSrv;
+ wxLogError(_("The FTP server doesn't support the PORT command."));
+ return NULL;
+ }
+
+ sockSrv->Notify(false); // Don't send any events
+ return sockSrv;
+}
+
+wxSocketBase *wxFTP::GetPassivePort()
+{
+ if ( !DoSimpleCommand(_T("PASV")) )
+ {
+ wxLogError(_("The FTP server doesn't support passive mode."));
+ return NULL;
+ }
+
+ 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(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]);
+
+ 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;
+ 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()
+{
+ 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;
+ if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) )
+ return NULL;
- if (!SendCommand("TYPE I", '2'))
- return NULL;
+ wxSocketBase *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 ") + wxURI::Unescape(path);
+ if ( !CheckCommand(tmp_str, '1') )
+ return NULL;
- tmp_str = "RETR " + path;
- if (!SendCommand(tmp_str, '1'))
- return NULL;
+ sock = AcceptIfActive(sock);
+ if ( !sock )
+ return NULL;
- in_stream = new wxInputFTPStream(this, sock);
+ sock->SetFlags(wxSOCKET_WAITALL);
- pos_size = m_lastResult.Index('(');
- if (pos_size != wxNOT_FOUND) {
- wxString str_size = m_lastResult(pos_size+1, m_lastResult.Index(')')-1);
+ m_streaming = true;
- in_stream->m_ftpsize = atoi(WXSTRINGCAST str_size);
- }
+ wxInputFTPStream *in_stream = new wxInputFTPStream(this, sock);
- return in_stream;
+ return in_stream;
}
wxOutputStream *wxFTP::GetOutputStream(const wxString& path)
{
- wxString tmp_str;
+ if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) )
+ return NULL;
- if (!SendCommand("TYPE I", '2'))
- return NULL;
+ wxSocketBase *sock = GetPort();
- wxSocketClient *sock = GetPort();
+ wxString tmp_str = wxT("STOR ") + path;
+ if ( !CheckCommand(tmp_str, '1') )
+ return NULL;
- tmp_str = "STOR " + path;
- if (!SendCommand(tmp_str, '1'))
- return FALSE;
+ sock = AcceptIfActive(sock);
- return new wxOutputFTPStream(this, sock);
+ m_streaming = true;
+
+ 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 = "NLST";
+ wxSocketBase *sock = GetPort();
+ if (!sock)
+ return false;
+
+ // 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.empty() )
+ {
+ line << _T(' ') << wildcard;
+ }
- if (!wildcard.IsNull())
- tmp_str += wildcard;
+ if ( !CheckCommand(line, '1') )
+ {
+ m_lastError = wxPROTO_PROTERR;
+ wxLogDebug(_T("FTP 'LIST' command returned unexpected result from server"));
+ delete sock;
+ return false;
+ }
- if (!SendCommand(tmp_str, '1')) {
- delete sock;
- delete file_list;
- return NULL;
- }
+ sock = AcceptIfActive(sock);
+ if ( !sock )
+ return false;
- while (GetLine(sock, tmp_str) == wxPROTO_NOERR) {
- file_list->Append((wxObject *)(new wxString(tmp_str)));
- }
+ files.Empty();
+ while (ReadLine(sock, line) == wxPROTO_NOERR )
+ {
+ files.Add(line);
+ }
- if (!GetResult('2')) {
delete sock;
- file_list->DeleteContents(TRUE);
- delete file_list;
- return NULL;
- }
- sock->SetEventHandler(*GetNextHandler(), m_id);
- sock->Notify(m_notifyme);
- sock->SetNotify(m_neededreq);
+ // the file list should be terminated by "226 Transfer complete""
+ return CheckResult('2');
+}
- return file_list;
+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 nonexistent 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
- // 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 <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);
+ }
+
+ // 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.GetCount(); 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
+
projects / wxWidgets.git / blobdiff