]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/ftp.cpp
made all Add/Insert/Prepend methods inline
[wxWidgets.git] / src / common / ftp.cpp
index 95d0d739d59a5eef6b52f9d100f8c38849c96e6c..fbb119d4deb26d1c080103d326c70cd759b4f995 100644 (file)
 // 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 <stdlib.h>
@@ -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_currentTransfermode = NONE;
+    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() )
@@ -241,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;
@@ -265,7 +265,7 @@ char wxFTP::GetResult()
         {
             if ( firstLine )
             {
-                badReply = TRUE;
+                badReply = true;
             }
             else
             {
@@ -287,16 +287,16 @@ char wxFTP::GetResult()
                 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
@@ -305,7 +305,7 @@ char wxFTP::GetResult()
                 {
                     if ( chMarker == _T(' ') )
                     {
-                        endOfReply = TRUE;
+                        endOfReply = true;
                     }
 
                     wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"),
@@ -344,7 +344,7 @@ bool wxFTP::SetTransferMode(TransferMode transferMode)
     if ( transferMode == m_currentTransfermode )
     {
         // nothing to do
-        return TRUE;
+        return true;
     }
 
     wxString mode;
@@ -368,14 +368,14 @@ bool wxFTP::SetTransferMode(TransferMode transferMode)
         wxLogError(_("Failed to set FTP transfer mode to %s."), (const wxChar*)
                    (transferMode == ASCII ? _("ASCII") : _("binary")));
 
-        return FALSE;
+        return false;
     }
 
-       // If we get here the operation has been succesfully completed
-       // Set the status-member
-       m_currentTransfermode = transferMode;
+    // 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)
@@ -390,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)
@@ -468,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;
 
@@ -507,12 +507,12 @@ 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
         {
@@ -524,6 +524,8 @@ public:
 
     wxFTP *m_ftp;
     size_t m_ftpsize;
+
+    DECLARE_NO_COPY_CLASS(wxInputFTPStream)
 };
 
 class wxOutputFTPStream : public wxSocketOutputStream
@@ -545,7 +547,7 @@ public:
             // read this reply
             m_ftp->CheckResult('2');
 
-            m_ftp->m_streaming = FALSE;
+            m_ftp->m_streaming = false;
         }
         else
         {
@@ -558,6 +560,8 @@ public:
     }
 
     wxFTP *m_ftp;
+
+    DECLARE_NO_COPY_CLASS(wxOutputFTPStream)
 };
 
 wxSocketClient *wxFTP::GetPort()
@@ -592,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;
@@ -609,7 +613,7 @@ wxSocketClient *wxFTP::GetPort()
         return NULL;
     }
 
-    client->Notify(FALSE);
+    client->Notify(false);
 
     return client;
 }
@@ -617,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');
 }
@@ -631,7 +635,7 @@ wxInputStream *wxFTP::GetInputStream(const wxString& path)
     int pos_size;
     wxInputFTPStream *in_stream;
 
-       if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) )
+    if ( ( m_currentTransfermode == NONE ) && !SetTransferMode(BINARY) )
         return NULL;
 
     wxSocketClient *sock = GetPort();
@@ -646,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);
 
@@ -665,16 +669,16 @@ wxInputStream *wxFTP::GetInputStream(const wxString& path)
 
 wxOutputStream *wxFTP::GetOutputStream(const wxString& path)
 {
-       if ( ( m_currentTransfermode == NONE ) && !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);
 }
@@ -689,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
@@ -697,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 )
@@ -715,34 +719,34 @@ 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;
 }
 
 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
+    // 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;
+    return retval;
 }
 
 // ----------------------------------------------------------------------------
@@ -751,13 +755,13 @@ bool wxFTP::FileExists(const wxString& fileName)
 
 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)
+    // return the filesize of the given file if possible
+    // return -1 otherwise (predominantly if file doesn't exist
+    // in current dir)
+
+    int filesize = -1;
 
-       int filesize = -1;
-       
-       // Check for existance of file via wxFTP::FileExists(...)
+    // Check for existance of file via wxFTP::FileExists(...)
     if ( FileExists(fileName) )
     {
         wxString command;
@@ -767,7 +771,7 @@ int wxFTP::GetFileSize(const wxString& fileName)
         // 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;
+        TransferMode oldTransfermode = m_currentTransfermode;
         SetTransferMode(BINARY);
         command << _T("SIZE ") << fileName;
 
@@ -777,55 +781,57 @@ int wxFTP::GetFileSize(const wxString& fileName)
         {
             // 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"),
+            // "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;
-                       }
+            {
+                // 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
+
+        // 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
+
+        // 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() )
-                               {
+            // 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;
+                    bool foundIt = false;
 
                     size_t i;
-                                       for ( i = 0; !foundIt && i < fileList.Count(); i++ )
-                                       {
-                                               foundIt = fileList[i].Upper().Contains(fileName.Upper());
-                                       }
+                    for ( i = 0; !foundIt && i < fileList.Count(); i++ )
+                    {
+                        foundIt = fileList[i].Upper().Contains(fileName.Upper());
+                    }
 
-                                       if ( foundIt )
-                                       {
+                    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
@@ -841,89 +847,37 @@ int wxFTP::GetFileSize(const wxString& fileName)
                         // 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(),
-                                          _("%*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,
+                        {
+
+                            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(),
+                            }
+                        }
+                        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,
+                                          &filesize) != 4 )
+                            {
+                                // something bad happened..?
+                                wxLogTrace(FTP_TRACE_MASK,
                                            _T("Invalid or unknown LIST response"));
-                                                       }
-                                               }
-                                       }
-                               }
-                       }
+                            }
+                        }
+                    }
+                }
+            }
         }
     }
 
-       // filesize might still be -1 when exiting
-       return filesize;
+    // filesize might still be -1 when exiting
+    return filesize;
 }
 
+#endif // wxUSE_PROTOCOL_FTP
 
-#ifdef WXWIN_COMPATIBILITY_2
-// deprecated
-wxList *wxFTP::GetList(const wxString& wildcard, bool details)
-{
- 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;
-}
-#endif // WXWIN_COMPATIBILITY_2
-
-#endif
-  // wxUSE_SOCKETS