OS/2 VisualAge doesn't know about lower case true and false and redefine a for loop...

[wxWidgets.git] / src / common / ftp.cpp

diff --git a/src/common/ftp.cpp b/src/common/ftp.cpp
index 70e4e9a688e42d2508bbb2409724407362e59bc2..1d5e8019650be839ac0464e0dcd43b6559d3540a 100644 (file)
--- a/src/common/ftp.cpp
+++ b/src/common/ftp.cpp
@@ -20,7 +20,9 @@
   #pragma hdrstop
 #endif
 
   #pragma hdrstop
 #endif
 

-#if wxUSE_SOCKETS
+#include "wx/setup.h"
+
+#if wxUSE_SOCKETS && wxUSE_STREAMS

 
 #ifndef __MWERKS__
 #include <memory.h>
 
 #ifndef __MWERKS__
 #include <memory.h>


@@ -32,20 +34,21 @@
 #include <stdlib.h>
 #include "wx/string.h"
 #include "wx/utils.h"
 #include <stdlib.h>
 #include "wx/string.h"
 #include "wx/utils.h"

-// #include "wx/data.h"
-#define WXSOCK_INTERNAL

 #include "wx/sckaddr.h"
 #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"
 #include "wx/socket.h"
 #include "wx/url.h"
 #include "wx/sckstrm.h"
 #include "wx/protocol/protocol.h"
 #include "wx/protocol/ftp.h"

+#include "wx/log.h"

 
 #ifdef __BORLANDC__
 #pragma hdrstop
 #endif
 
 
 #ifdef __BORLANDC__
 #pragma hdrstop
 #endif
 

+// the length of FTP status code (3 digits)
+static const size_t LEN_CODE = 3;
+

 #define FTP_BSIZE 1024
 
 IMPLEMENT_DYNAMIC_CLASS(wxFTP, wxProtocol)
 #define FTP_BSIZE 1024
 
 IMPLEMENT_DYNAMIC_CLASS(wxFTP, wxProtocol)


@@ -56,23 +59,26 @@ IMPLEMENT_PROTOCOL(wxFTP, wxT("ftp"), wxT("ftp"), TRUE)
 ////////////////////////////////////////////////////////////////
 
 wxFTP::wxFTP()
 ////////////////////////////////////////////////////////////////
 
 wxFTP::wxFTP()

-  : wxProtocol()
+     : wxProtocol()

 {
 {

-  m_lastError = wxPROTO_NOERR;
-  m_streaming = FALSE;
+    m_lastError = wxPROTO_NOERR;
+    m_streaming = FALSE;

 
 

-  m_user = wxT("anonymous");
-  m_passwd = wxGetUserId();
-  m_passwd += wxT('@');
-  m_passwd += wxGetHostName();
+    m_user = wxT("anonymous");
+    m_passwd << wxGetUserId() << wxT('@') << wxGetFullHostName();

 
 

-  SetNotify(0);
-  SetFlags(NONE);
+    SetNotify(0);
+    SetFlags(wxSOCKET_NONE);

 }
 
 wxFTP::~wxFTP()
 {
 }
 
 wxFTP::~wxFTP()
 {

-  SendCommand("QUIT", '2');
+    if ( m_streaming )
+    {
+        (void)Abort();
+    }
+
+    Close();

 }
 
 ////////////////////////////////////////////////////////////////
 }
 
 ////////////////////////////////////////////////////////////////


@@ -125,57 +131,153 @@ bool wxFTP::Connect(const wxString& host)
 
 bool wxFTP::Close()
 {
 
 bool wxFTP::Close()
 {

-  if (m_streaming) {
-    m_lastError = wxPROTO_STREAMING;
-    return FALSE;
-  }
-  if (m_connected)
-    SendCommand(wxString(wxT("QUIT")), '2');
-  return wxSocketClient::Close();
+    if ( m_streaming )
+    {
+        m_lastError = wxPROTO_STREAMING;
+        return FALSE;
+    }
+
+    if ( IsConnected() )
+        SendCommand(wxT("QUIT"), '2');
+
+    return wxSocketClient::Close();

 }
 
 }
 

-////////////////////////////////////////////////////////////////
-////// wxFTP low-level methods /////////////////////////////////
-////////////////////////////////////////////////////////////////
+// ============================================================================
+// low level methods
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// Send command to FTP server
+// ----------------------------------------------------------------------------
+

 bool wxFTP::SendCommand(const wxString& command, char exp_ret)
 {
 bool wxFTP::SendCommand(const wxString& command, char exp_ret)
 {

-  wxString tmp_str;
+    wxString tmp_str;

 
 

-  if (m_streaming) {
-    m_lastError = wxPROTO_STREAMING;
-    return FALSE;
-  }
-  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 FALSE;
-  }
-  return GetResult(exp_ret);
+    if (m_streaming)
+    {
+        m_lastError = wxPROTO_STREAMING;
+        return FALSE;
+    }
+
+    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 FALSE;
+    }
+
+    wxLogTrace(_T("ftp"), _T("==> %s"), command.c_str());
+
+    return GetResult(exp_ret);

 }
 
 }
 

+// ----------------------------------------------------------------------------
+// Recieve servers reply
+// ----------------------------------------------------------------------------
+

 bool wxFTP::GetResult(char exp)
 {
 bool wxFTP::GetResult(char exp)
 {

-  m_lastError = GetLine(this, m_lastResult);
-  if ( m_lastError )
-    return FALSE;
-  if (m_lastResult.GetChar(0) != exp) {
-    m_lastError = wxPROTO_PROTERR;
-    return FALSE;
-  }
+    wxString code;
+
+    // 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 )
+    {
+        m_lastError = ReadLine(m_lastResult);
+        if ( m_lastError )
+            return FALSE;
+
+        // unless this is an intermediate line of a multiline reply, it must
+        // contain the code in the beginning and '-' or ' ' following it
+        if ( m_lastResult.Len() < LEN_CODE + 1 )
+        {
+            if ( firstLine )
+            {
+                badReply = TRUE;
+            }
+            else
+            {
+                wxLogTrace(_T("ftp"), _T("<== %s %s"),
+                           code.c_str(), m_lastResult.c_str());
+            }
+        }
+        else // line has at least 4 chars
+        {
+            // this is the char which tells us what we're dealing with
+            wxChar chMarker = m_lastResult.GetChar(LEN_CODE);
+
+            if ( firstLine )
+            {
+                code = wxString(m_lastResult, LEN_CODE);
+                wxLogTrace(_T("ftp"), _T("<== %s %s"),
+                           code.c_str(), m_lastResult.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(m_lastResult, code, LEN_CODE) == 0 )
+                {
+                    if ( chMarker == _T(' ') )
+                    {
+                        endOfReply = TRUE;
+                    }
+
+                    wxLogTrace(_T("ftp"), _T("<== %s %s"),
+                               code.c_str(), m_lastResult.c_str() + LEN_CODE + 1);
+                }
+                else
+                {
+                    // just part of reply
+                    wxLogTrace(_T("ftp"), _T("<== %s %s"),
+                               code.c_str(), m_lastResult.c_str());
+                }
+            }
+        }
+    }

 
 

-  if (m_lastResult.GetChar(3) == '-') {
-    wxString key = m_lastResult.Left((size_t)3);
+    if ( badReply )
+    {
+        wxLogDebug(_T("Broken FTP server: '%s' is not a valid reply."),
+                   m_lastResult.c_str());

 
 

-    key += wxT(' ');
+        m_lastError = wxPROTO_PROTERR;

 
 

-    while (m_lastResult.Index(key) != 0) {
-      m_lastError = GetLine(this, m_lastResult);
-      if ( m_lastError )

         return FALSE;
     }
         return FALSE;
     }

-  }
-  return TRUE;
+
+    if ( code.GetChar(0) != exp )
+    {
+        m_lastError = wxPROTO_PROTERR;
+
+        return FALSE;
+    }
+
+    return TRUE;

 }
 
 ////////////////////////////////////////////////////////////////
 }
 
 ////////////////////////////////////////////////////////////////


@@ -206,15 +308,45 @@ bool wxFTP::RmDir(const wxString& dir)
 
 wxString wxFTP::Pwd()
 {
 
 wxString wxFTP::Pwd()
 {

-  int beg, end;
-
-  if (!SendCommand(wxT("PWD"), '2'))
-    return wxString((char *)NULL);
-  
-  beg = m_lastResult.Find(wxT('\"'),FALSE);
-  end = m_lastResult.Find(wxT('\"'),TRUE);
+    wxString path;
+
+    if ( SendCommand(wxT("PWD"), '2') )
+    {
+        // the result is at least that long if SendCommand() 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);
+            }
+        }
+    }

 
 

-  return wxString(beg+1, end);
+    return path;

 }
 
 bool wxFTP::Rename(const wxString& src, const wxString& dst)
 }
 
 bool wxFTP::Rename(const wxString& src, const wxString& dst)


@@ -268,11 +400,23 @@ public:
     : wxSocketOutputStream(*sock), m_ftp(ftp_clt) {}
   virtual ~wxOutputFTPStream(void)
   {
     : 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;
+      if ( IsOk() )
+      {
+          // close data connection first, this will generate "transfer
+          // completed" reply
+          delete m_o_socket;
+
+          // read this reply
+          m_ftp->GetResult('2');
+      }
+      else
+      {
+          // abort data connection first
+          m_ftp->Abort();
+
+          // and close it after
+          delete m_o_socket;
+      }

   }
 };
 
   }
 };
 


@@ -314,12 +458,16 @@ wxSocketClient *wxFTP::GetPort()
   return client;
 }
 
   return client;
 }
 

-bool wxFTP::Abort(void)
+bool wxFTP::Abort()

 {
 {

-  m_streaming = FALSE;
-  if (!SendCommand(wxT("ABOR"), '4'))
-    return FALSE;
-  return GetResult('2');
+    if ( !m_streaming )
+        return TRUE;
+        
+    m_streaming = FALSE;
+    if ( !SendCommand(wxT("ABOR"), '4') )
+        return FALSE;
+
+    return GetResult('2');

 }
 
 wxInputStream *wxFTP::GetInputStream(const wxString& path)
 }
 
 wxInputStream *wxFTP::GetInputStream(const wxString& path)


@@ -350,7 +498,7 @@ wxInputStream *wxFTP::GetInputStream(const wxString& path)
 
     in_stream->m_ftpsize = wxAtoi(WXSTRINGCAST str_size);
   }
 
     in_stream->m_ftpsize = wxAtoi(WXSTRINGCAST str_size);
   }

-  sock->SetFlags(WAITALL);
+  sock->SetFlags(wxSOCKET_WAITALL);

 
   return in_stream;
 }
 
   return in_stream;
 }


@@ -371,6 +519,42 @@ wxOutputStream *wxFTP::GetOutputStream(const wxString& path)
   return new wxOutputFTPStream(this, sock);
 }
 
   return new wxOutputFTPStream(this, sock);
 }
 

+bool wxFTP::GetList(wxArrayString& files, const wxString& wildcard)
+{
+    wxSocketBase *sock = GetPort();
+    if ( !sock )
+    {
+        return FALSE;
+    }
+
+    wxString line = _T("NLST");
+    if ( !!wildcard )
+    {
+        // notice that there is no space here
+        line += wildcard;
+    }
+
+    if ( !SendCommand(line, '1') )
+    {
+        return FALSE;
+    }
+
+    files.Empty();
+
+    while ( ReadLine(sock, line) == wxPROTO_NOERR )
+    {
+        files.Add(line);
+    }
+
+    delete sock;
+
+    // the file list should be terminated by "226 Transfer complete""
+    if ( !GetResult('2') )
+        return FALSE;
+
+    return TRUE;
+}
+

 wxList *wxFTP::GetList(const wxString& wildcard)
 {
   wxList *file_list = new wxList;
 wxList *wxFTP::GetList(const wxString& wildcard)
 {
   wxList *file_list = new wxList;