correct test for wxDEBUG_LEVEL in last commit

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

diff --git a/src/common/ftp.cpp b/src/common/ftp.cpp
index 27b3e70cdf3af1bd18a02b4d5065f03205cd28f1..235a29d3db85981622f0c258fffe81c482eef0ee 100644 (file)
--- a/src/common/ftp.cpp
+++ b/src/common/ftp.cpp
@@ -76,17 +76,15 @@ IMPLEMENT_PROTOCOL(wxFTP, wxT("ftp"), wxT("ftp"), true)
 
 wxFTP::wxFTP()
 {
 
 wxFTP::wxFTP()
 {

-    m_lastError = wxPROTO_NOERR;

     m_streaming = false;
     m_currentTransfermode = NONE;
 
     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_NOWAIT);
     m_bPassive = true;
 
     SetNotify(0);
     SetFlags(wxSOCKET_NOWAIT);
     m_bPassive = true;

-    SetDefaultTimeout(60); // Default is Sixty Seconds

     m_bEncounteredError = false;
 }
 
     m_bEncounteredError = false;
 }
 


@@ -107,7 +105,7 @@ wxFTP::~wxFTP()
 // wxFTP connect and login methods
 // ----------------------------------------------------------------------------
 
 // 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) )
     {
 {
     if ( !wxProtocol::Connect(addr) )
     {


@@ -115,7 +113,7 @@ bool wxFTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait))
         return false;
     }
 
         return false;
     }
 

-    if ( !m_user )
+    if ( !m_username )

     {
         m_lastError = wxPROTO_CONNERR;
         return false;
     {
         m_lastError = wxPROTO_CONNERR;
         return false;


@@ -129,27 +127,31 @@ bool wxFTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait))
     }
 
     wxString command;
     }
 
     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
     char rc = SendCommand(command);
     if ( rc == '2' )
     {
         // 230 return: user accepted without password

+        m_lastError = wxPROTO_NOERR;

         return true;
     }
 
     if ( rc != '3' )
     {
         return true;
     }
 
     if ( rc != '3' )
     {

+        m_lastError = wxPROTO_CONNERR;

         Close();
         return false;
     }
 
         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') )
     {
     if ( !CheckCommand(command, '2') )
     {

+        m_lastError = wxPROTO_CONNERR;

         Close();
         return false;
     }
 
         Close();
         return false;
     }
 

+    m_lastError = wxPROTO_NOERR;

     return true;
 }
 
     return true;
 }
 


@@ -174,6 +176,7 @@ bool wxFTP::Close()
     {
         if ( !CheckCommand(wxT("QUIT"), '2') )
         {
     {
         if ( !CheckCommand(wxT("QUIT"), '2') )
         {

+            m_lastError = wxPROTO_CONNERR;

             wxLogDebug(_T("Failed to close connection gracefully."));
         }
     }
             wxLogDebug(_T("Failed to close connection gracefully."));
         }
     }


@@ -185,6 +188,43 @@ bool wxFTP::Close()
 // low level methods
 // ============================================================================
 
 // 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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Send command to FTP server
 // ----------------------------------------------------------------------------


@@ -205,7 +245,6 @@ char wxFTP::SendCommand(const wxString& command)
         return 0;
     }
 
         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) )
     // don't show the passwords in the logs (even in debug ones)
     wxString cmd, password;
     if ( command.Upper().StartsWith(_T("PASS "), &password) )


@@ -217,14 +256,14 @@ char wxFTP::SendCommand(const wxString& command)
         cmd = command;
     }
 
         cmd = command;
     }
 

-    wxLogTrace(FTP_TRACE_MASK, _T("==> %s"), cmd.c_str());
-#endif // __WXDEBUG__
+    LogRequest(cmd);

 
 

+    m_lastError = wxPROTO_NOERR;

     return GetResult();
 }
 
 // ----------------------------------------------------------------------------
     return GetResult();
 }
 
 // ----------------------------------------------------------------------------

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

 // ----------------------------------------------------------------------------
 
 char wxFTP::GetResult()
 // ----------------------------------------------------------------------------
 
 char wxFTP::GetResult()


@@ -260,6 +299,8 @@ char wxFTP::GetResult()
             return 0;
         }
 
             return 0;
         }
 

+        LogResponse(line);
+

         if ( !m_lastResult.empty() )
         {
             // separate from last line
         if ( !m_lastResult.empty() )
         {
             // separate from last line


@@ -276,11 +317,6 @@ char wxFTP::GetResult()
             {
                 badReply = true;
             }
             {
                 badReply = true;
             }

-            else
-            {
-                wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"),
-                           code.c_str(), line.c_str());
-            }

         }
         else // line has at least 4 chars
         {
         }
         else // line has at least 4 chars
         {


@@ -290,8 +326,6 @@ char wxFTP::GetResult()
             if ( firstLine )
             {
                 code = wxString(line, 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 )
                 {
 
                 switch ( chMarker )
                 {


@@ -316,15 +350,6 @@ char wxFTP::GetResult()
                     {
                         endOfReply = true;
                     }
                     {
                         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());

                 }
             }
         }
                 }
             }
         }


@@ -339,6 +364,8 @@ char wxFTP::GetResult()
 
         return 0;
     }
 
         return 0;
     }

+    else
+        m_lastError = wxPROTO_NOERR;

 
     // if we got here we must have a non empty code string
     return (char)code[0u];
 
     // if we got here we must have a non empty code string
     return (char)code[0u];


@@ -398,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());
     if ( !CheckCommand(fullcmd, '2') )
     {
         wxLogDebug(_T("FTP command '%s' failed."), fullcmd.c_str());

+        m_lastError = wxPROTO_NETERR;

 
         return false;
     }
 
 
         return false;
     }
 

+    m_lastError = wxPROTO_NOERR;

     return true;
 }
 
     return true;
 }
 


@@ -466,6 +495,7 @@ wxString wxFTP::Pwd()
     }
     else
     {
     }
     else
     {

+        m_lastError = wxPROTO_PROTERR;

         wxLogDebug(_T("FTP PWD command failed."));
     }
 
         wxLogDebug(_T("FTP PWD command failed."));
     }
 


@@ -494,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()
 {
     /*
 wxSocketBase *wxFTP::GetPort()
 {
     /*


@@ -616,29 +555,6 @@ wxSocketBase *wxFTP::GetPort()
     return socket;
 }
 
     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)
 {
 wxString wxFTP::GetPortCmdArgument(const wxIPV4address& addrLocal,
                                    const wxIPV4address& addrNew)
 {


@@ -691,6 +607,7 @@ wxSocketBase *wxFTP::GetActivePort()
         return NULL;
     }
 
         return NULL;
     }
 

+    m_lastError = wxPROTO_NOERR;

     sockSrv->Notify(false); // Don't send any events
     return sockSrv;
 }
     sockSrv->Notify(false); // Don't send any events
     return sockSrv;
 }


@@ -699,6 +616,7 @@ wxSocketBase *wxFTP::GetPassivePort()
 {
     if ( !DoSimpleCommand(_T("PASV")) )
     {
 {
     if ( !DoSimpleCommand(_T("PASV")) )
     {

+        m_lastError = wxPROTO_PROTERR;

         wxLogError(_("The FTP server doesn't support passive mode."));
         return NULL;
     }
         wxLogError(_("The FTP server doesn't support passive mode."));
         return NULL;
     }


@@ -733,31 +651,113 @@ wxSocketBase *wxFTP::GetPassivePort()
     wxSocketClient *client = new wxSocketClient();
     if ( !client->Connect(addr) )
     {
     wxSocketClient *client = new wxSocketClient();
     if ( !client->Connect(addr) )
     {

+        m_lastError = wxPROTO_CONNERR;

         delete client;
         return NULL;
     }
 
     client->Notify(false);
 
         delete client;
         return NULL;
     }
 
     client->Notify(false);
 

+    m_lastError = wxPROTO_NOERR;

     return client;
 }
 
     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) )
 
 wxInputStream *wxFTP::GetInputStream(const wxString& path)
 {
     if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) )

+    {
+        m_lastError = wxPROTO_CONNERR;

         return NULL;
         return NULL;

+    }

 
     wxSocketBase *sock = GetPort();
 
 
     wxSocketBase *sock = GetPort();
 


@@ -773,7 +773,10 @@ wxInputStream *wxFTP::GetInputStream(const wxString& path)
 
     sock = AcceptIfActive(sock);
     if ( !sock )
 
     sock = AcceptIfActive(sock);
     if ( !sock )

+    {
+        m_lastError = wxPROTO_CONNERR;

         return NULL;
         return NULL;

+    }

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


@@ -781,13 +784,17 @@ wxInputStream *wxFTP::GetInputStream(const wxString& path)
 
     wxInputFTPStream *in_stream = new wxInputFTPStream(this, sock);
 
 
     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) )
     return in_stream;
 }
 
 wxOutputStream *wxFTP::GetOutputStream(const wxString& path)
 {
     if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) )

+    {
+        m_lastError = wxPROTO_CONNERR;

         return NULL;
         return NULL;

+    }

 
     wxSocketBase *sock = GetPort();
 
 
     wxSocketBase *sock = GetPort();
 


@@ -799,6 +806,7 @@ wxOutputStream *wxFTP::GetOutputStream(const wxString& path)
 
     m_streaming = true;
 
 
     m_streaming = true;
 

+    m_lastError = wxPROTO_NOERR;

     return new wxOutputFTPStream(this, sock);
 }
 
     return new wxOutputFTPStream(this, sock);
 }
 


@@ -811,8 +819,10 @@ bool wxFTP::GetList(wxArrayString& files,
                     bool details)
 {
     wxSocketBase *sock = GetPort();
                     bool details)
 {
     wxSocketBase *sock = GetPort();

-    if (!sock)
+    if (!sock) {
+        m_lastError = wxPROTO_NETERR;

         return false;
         return false;

+    }

 
     // NLST : List of Filenames (including Directory's !)
     // LIST : depending on BS of FTP-Server
 
     // NLST : List of Filenames (including Directory's !)
     // LIST : depending on BS of FTP-Server


@@ -834,8 +844,10 @@ bool wxFTP::GetList(wxArrayString& files,
     }
 
     sock = AcceptIfActive(sock);
     }
 
     sock = AcceptIfActive(sock);

-    if ( !sock )
+    if ( !sock ) {
+        m_lastError = wxPROTO_CONNERR;

         return false;
         return false;

+    }

 
     files.Empty();
     while (ReadLine(sock, line) == wxPROTO_NOERR )
 
     files.Empty();
     while (ReadLine(sock, line) == wxPROTO_NOERR )


@@ -846,6 +858,7 @@ bool wxFTP::GetList(wxArrayString& files,
     delete sock;
 
     // the file list should be terminated by "226 Transfer complete""
     delete sock;
 
     // the file list should be terminated by "226 Transfer complete""

+    m_lastError = wxPROTO_NOERR;

     return CheckResult('2');
 }
 
     return CheckResult('2');
 }
 


@@ -979,8 +992,7 @@ int wxFTP::GetFileSize(const wxString& fileName)
                                           &filesize) != 9 )
                             {
                                 // Hmm... Invalid response
                                           &filesize) != 9 )
                             {
                                 // Hmm... Invalid response

-                                wxLogTrace(FTP_TRACE_MASK,
-                                           _T("Invalid LIST response"));
+                                wxLogDebug(wxT("Invalid LIST response"));

                             }
                         }
                         else // Windows-style response (?)
                             }
                         }
                         else // Windows-style response (?)


@@ -990,8 +1002,7 @@ int wxFTP::GetFileSize(const wxString& fileName)
                                           &filesize) != 4 )
                             {
                                 // something bad happened..?
                                           &filesize) != 4 )
                             {
                                 // something bad happened..?

-                                wxLogTrace(FTP_TRACE_MASK,
-                                           _T("Invalid or unknown LIST response"));
+                                wxLogDebug(wxT("Invalid or unknown LIST response"));

                             }
                         }
                     }
                             }
                         }
                     }