Fix the URL generated by Doxygen @sampledir macro.

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

diff --git a/src/common/protocol.cpp b/src/common/protocol.cpp
index 875ad85af0bc02e7a45c44170415a8b7a9b1cf95..0173b097b74a1c5f214bd52841b3f14bd321ce2b 100644 (file)
--- a/src/common/protocol.cpp
+++ b/src/common/protocol.cpp
@@ -1,55 +1,60 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        protocol.cpp
+// Name:        src/common/protocol.cpp

 // Purpose:     Implement protocol base class
 // Author:      Guilhem Lavaux
 // Modified by:
 // Created:     07/07/1997
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997, 1998 Guilhem Lavaux
 // Purpose:     Implement protocol base class
 // Author:      Guilhem Lavaux
 // Modified by:
 // Created:     07/07/1997
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997, 1998 Guilhem Lavaux

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "protocol.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-  #pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

+#if wxUSE_PROTOCOL
+

 #include "wx/protocol/protocol.h"
 #include "wx/protocol/protocol.h"

+#include "wx/protocol/log.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/module.h"
+#endif
+

 #include "wx/url.h"
 #include "wx/url.h"

-#include "wx/module.h"
+#include "wx/log.h"

 
 #include <stdlib.h>
 
 
 #include <stdlib.h>
 

-/////////////////////////////////////////////////////////////////
+// ----------------------------------------------------------------------------

 // wxProtoInfo
 // wxProtoInfo

-/////////////////////////////////////////////////////////////////
+// ----------------------------------------------------------------------------

 
 

-/*
- * --------------------------------------------------------------
- * --------- wxProtoInfo CONSTRUCTOR ----------------------------
- * --------------------------------------------------------------
- */
+IMPLEMENT_CLASS(wxProtoInfo, wxObject)

 
 wxProtoInfo::wxProtoInfo(const wxChar *name, const wxChar *serv,
                          const bool need_host1, wxClassInfo *info)
 
 wxProtoInfo::wxProtoInfo(const wxChar *name, const wxChar *serv,
                          const bool need_host1, wxClassInfo *info)

+           : m_protoname(name),
+             m_servname(serv)

 {
 {

-  m_protoname = name;
-  m_servname = serv;
-  m_cinfo = info;
-  m_needhost = need_host1;
-  next = wxURL::g_protocols;
-  wxURL::g_protocols = this;
+    m_cinfo = info;
+    m_needhost = need_host1;
+#if wxUSE_URL
+    next = wxURL::ms_protocols;
+    wxURL::ms_protocols = this;
+#else
+    next = NULL;
+#endif

 }
 
 }
 

-/////////////////////////////////////////////////////////////////
-// wxProtocol ///////////////////////////////////////////////////
-/////////////////////////////////////////////////////////////////
+
+// ----------------------------------------------------------------------------
+// wxProtocol
+// ----------------------------------------------------------------------------

 
 #if wxUSE_SOCKETS
 IMPLEMENT_ABSTRACT_CLASS(wxProtocol, wxSocketClient)
 
 #if wxUSE_SOCKETS
 IMPLEMENT_ABSTRACT_CLASS(wxProtocol, wxSocketClient)


@@ -62,64 +67,114 @@ wxProtocol::wxProtocol()
  : wxSocketClient()
 #endif
 {
  : wxSocketClient()
 #endif
 {

+    m_lastError = wxPROTO_NOERR;
+    m_log = NULL;
+    SetDefaultTimeout(60);      // default timeout is 60 seconds

 }
 
 #if wxUSE_SOCKETS
 bool wxProtocol::Reconnect()
 {
 }
 
 #if wxUSE_SOCKETS
 bool wxProtocol::Reconnect()
 {

-  wxIPV4address addr;
-
-  if (!GetPeer(addr))
-  {
-    Close();
-    return FALSE;
-  }
-  if (!Close())
-    return FALSE;
-  if (!Connect(addr))
-    return FALSE;
-
-  return TRUE;
+    wxIPV4address addr;
+
+    if (!GetPeer(addr))
+    {
+        Close();
+        return false;
+    }
+
+    if (!Close())
+        return false;
+
+    if (!Connect(addr))
+        return false;
+
+    return true;
+}
+
+void wxProtocol::SetDefaultTimeout(wxUint32 Value)
+{
+    m_uiDefaultTimeout = Value;
+#if wxUSE_SOCKETS
+    wxSocketBase::SetTimeout(Value); // sets it for this socket
+#endif
+}
+
+wxProtocol::~wxProtocol()
+{
+    delete m_log;

 }
 
 // ----------------------------------------------------------------------------
 // Read a line from socket
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // Read a line from socket
 // ----------------------------------------------------------------------------
 

-// TODO ReadLine() should use buffers private to wxProtocol for efficiency!
-
-// static
-wxProtocolError wxProtocol::ReadLine(wxSocketBase *socket, wxString& result)
+/* static */
+wxProtocolError wxProtocol::ReadLine(wxSocketBase *sock, wxString& result)

 {
 {

-    result.Empty();
-    char ch, chLast = '\0';
-    while ( !socket->Read(&ch, sizeof(ch)).Error() )
+    static const int LINE_BUF = 4095;
+
+    result.clear();
+
+    wxCharBuffer buf(LINE_BUF);
+    char *pBuf = buf.data();
+    while ( sock->WaitForRead() )

     {
     {

-        switch ( ch )
+        // peek at the socket to see if there is a CRLF
+        sock->Peek(pBuf, LINE_BUF);
+
+        size_t nRead = sock->LastCount();
+        if ( !nRead && sock->Error() )
+            return wxPROTO_NETERR;
+
+        // look for "\r\n" paying attention to a special case: "\r\n" could
+        // have been split by buffer boundary, so check also for \r at the end
+        // of the last chunk and \n at the beginning of this one
+        pBuf[nRead] = '\0';
+        const char *eol = strchr(pBuf, '\n');
+
+        // if we found '\n', is there a '\r' as well?
+        if ( eol )

         {
         {

-            case '\r':
-                // remember it, if the following is '\n', we're done
-                chLast = '\r';
-                break;
-
-            case '\n':
-                // only ends line if the previous character was '\r'
-                if ( chLast == '\r' )
+            if ( eol == pBuf )
+            {
+                // check for case of "\r\n" being split
+                if ( result.empty() || result.Last() != wxT('\r') )

                 {
                 {

-                    // EOL found
-                    return wxPROTO_NOERR;
+                    // ignore the stray '\n'
+                    eol = NULL;

                 }
                 }

-                //else: fall through
+                //else: ok, got real EOL

 
 

-            default:
-                // normal char
-                if ( chLast )
+                // read just this '\n' and restart
+                nRead = 1;
+            }
+            else // '\n' in the middle of the buffer
+            {
+                // in any case, read everything up to and including '\n'
+                nRead = eol - pBuf + 1;
+
+                if ( eol[-1] != '\r' )

                 {
                 {

-                    result += chLast;
-                    chLast = '\0';
+                    // as above, simply ignore stray '\n'
+                    eol = NULL;

                 }
                 }

+            }
+        }
+
+        sock->Read(pBuf, nRead);
+        if ( sock->LastCount() != nRead )
+            return wxPROTO_NETERR;

 
 

-                result += ch;
+        pBuf[nRead] = '\0';
+        result += wxString::FromAscii(pBuf);
+
+        if ( eol )
+        {
+            // remove trailing "\r\n"
+            result.RemoveLast(2);
+
+            return wxPROTO_NOERR;

         }
     }
 
         }
     }
 


@@ -131,78 +186,34 @@ wxProtocolError wxProtocol::ReadLine(wxString& result)
     return ReadLine(this, result);
 }
 
     return ReadLine(this, result);
 }
 

-// old function which only chops '\n' and not '\r\n'
-wxProtocolError GetLine(wxSocketBase *sock, wxString& result) {
-#define PROTO_BSIZE 2048
-  size_t avail, size;
-  char tmp_buf[PROTO_BSIZE], tmp_str[PROTO_BSIZE];
-  char *ret;
-  bool found;
-
-  avail = sock->Read(tmp_buf, PROTO_BSIZE).LastCount();
-  if (sock->Error() || avail == 0)
-    return wxPROTO_NETERR;
-
-  memcpy(tmp_str, tmp_buf, avail);
-
-// Not implemented on all systems
-// ret = (char *)memccpy(tmp_str, tmp_buf, '\n', avail);
-  found = FALSE;
-  for (ret=tmp_str;ret < (tmp_str+avail); ret++)
-     if (*ret == '\n') {
-       found = TRUE;
-       break;
-     }
+#endif // wxUSE_SOCKETS

 
 

-  if (!found)
-    return wxPROTO_PROTERR;
-  *ret = 0;
-
-  result = tmp_str;
-  result = result.Left(result.Length()-1);
+// ----------------------------------------------------------------------------
+// logging
+// ----------------------------------------------------------------------------

 
 

-  size = ret-tmp_str+1;
-  sock->Unread(&tmp_buf[size], avail-size);
-  return wxPROTO_NOERR;
-#undef PROTO_BSIZE
+void wxProtocol::SetLog(wxProtocolLog *log)
+{
+    delete m_log;
+    m_log = log;

 }
 }

-#endif
-
-// ----------------------------------------------------------------------
-// Module
-// ----------------------------------------------------------------------
-
-class wxProtocolModule: public wxModule {
-  DECLARE_DYNAMIC_CLASS(wxProtocolModule)
-public:
-  wxProtocolModule() {}
-  bool OnInit();
-  void OnExit();
-};

 
 

-IMPLEMENT_DYNAMIC_CLASS(wxProtocolModule, wxModule)
-
-bool wxProtocolModule::OnInit()
+void wxProtocol::LogRequest(const wxString& str)

 {
 {

-#if wxUSE_SOCKETS
-  char *env_http_prox;
+    if ( m_log )
+        m_log->LogRequest(str);
+}

 
 

-  wxURL::g_proxy = NULL;
-  // Initialize the proxy when HTTP_PROXY is defined
-  env_http_prox = getenv("HTTP_PROXY");
-  if (env_http_prox)
-    wxURL::SetDefaultProxy(env_http_prox);
-#endif
-  
-  return TRUE;
+void wxProtocol::LogResponse(const wxString& str)
+{
+    if ( m_log )
+        m_log->LogResponse(str);

 }
 
 }
 

-void wxProtocolModule::OnExit()
+void wxProtocolLog::DoLogString(const wxString& str)

 {
 {

-#if wxUSE_SOCKETS
-  if (wxURL::g_proxy)
-    delete wxURL::g_proxy;
-  wxURL::g_proxy = NULL;
-#endif
+    wxUnusedVar(str); // unused if wxLogTrace() is disabled
+    wxLogTrace(m_traceMask, "%s", str);

 }
 
 }
 

+#endif // wxUSE_PROTOCOL