Add some version checks to help compiling on OSX.

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

diff --git a/src/common/http.cpp b/src/common/http.cpp
index bfcd1ad1567824ab098525ce9a9ee11bb22278d2..e238364ece6c0d5fa72ac3609bae3f44ad5247e5 100644 (file)
--- a/src/common/http.cpp
+++ b/src/common/http.cpp
@@ -1,285 +1,506 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     HTTP protocol
 // Author:      Guilhem Lavaux
 // Purpose:     HTTP protocol
 // Author:      Guilhem Lavaux

-// Modified by:
+// Modified by: Simo Virokannas (authentication, Dec 2005)

 // Created:     August 1997
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997, 1998 Guilhem Lavaux
 // Created:     August 1997
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997, 1998 Guilhem Lavaux

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

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

-#ifdef __GNUG__
-#pragma implementation "http.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_SOCKETS
+#if wxUSE_PROTOCOL_HTTP
+
+#include <stdio.h>
+#include <stdlib.h>

 
 #ifndef WX_PRECOMP
 
 #ifndef WX_PRECOMP

+    #include "wx/string.h"
+    #include "wx/app.h"

 #endif
 
 #endif
 

-#include <stdio.h>
-#include <stdlib.h>
-#include "wx/string.h"

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

+#include "wx/url.h"

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

+#include "wx/thread.h"

 
 

-#if !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxHTTP, wxProtocol)
-IMPLEMENT_PROTOCOL(wxHTTP, _T("http"), _T("80"), TRUE)
-#endif

 
 

-#define HTTP_BSIZE 2048
+// ----------------------------------------------------------------------------
+// wxHTTP
+// ----------------------------------------------------------------------------
+
+IMPLEMENT_DYNAMIC_CLASS(wxHTTP, wxProtocol)
+IMPLEMENT_PROTOCOL(wxHTTP, wxT("http"), wxT("80"), true)

 
 wxHTTP::wxHTTP()
 
 wxHTTP::wxHTTP()

-  : wxProtocol(),
-    m_headers(wxKEY_STRING)
+  : wxProtocol()

 {
 {

-  m_addr = NULL;
-  m_read = FALSE;
+    m_addr = NULL;
+    m_read = false;
+    m_proxy_mode = false;
+    m_post_buf = wxEmptyString;
+    m_http_response = 0;

 
 

-  SetNotify(REQ_LOST);
+    SetNotify(wxSOCKET_LOST_FLAG);

 }
 
 wxHTTP::~wxHTTP()
 {
 }
 
 wxHTTP::~wxHTTP()
 {

-  // wxString isn't a wxObject
-  wxNode *node = m_headers.First();
-  wxString *string;
-
-  while (node) {
-    string = (wxString *)node->Data();
-    delete string;
-    node = node->Next();
-  }
+    ClearHeaders();
+
+    delete m_addr;

 }
 
 }
 

-wxString wxHTTP::GetContentType()
+void wxHTTP::ClearHeaders()

 {
 {

-  return GetHeader(_T("Content-Type"));
+    m_headers.clear();

 }
 
 }
 

-void wxHTTP::SetHeader(const wxString& header, const wxString& h_data)
+void wxHTTP::ClearCookies()

 {
 {

-  if (m_read) {
-    m_headers.Clear();
-    m_read = FALSE;
-  }
-
-  wxNode *node = m_headers.Find(header);
-
-  if (!node)
-    m_headers.Append(header, (wxObject *)(new wxString(h_data)));
-  else {
-    wxString *str = (wxString *)node->Data();
-    (*str) = h_data;
-  }
+    m_cookies.clear();

 }
 
 }
 

-wxString wxHTTP::GetHeader(const wxString& header)
+wxString wxHTTP::GetContentType() const

 {
 {

-  wxNode *node = m_headers.Find(header);
-  if (!node)
-    return wxEmptyString;
-
-  return *((wxString *)node->Data());
+    return GetHeader(wxT("Content-Type"));

 }
 
 }
 

-void wxHTTP::SendHeaders()
+void wxHTTP::SetProxyMode(bool on)

 {
 {

-  wxNode *head = m_headers.First();
-
-  while (head)
-  {
-    wxString *str = (wxString *)head->Data();
+    m_proxy_mode = on;
+}

 
 

-    wxString buf;
-    buf.Printf(_T("%s: %s\n\r"), head->GetKeyString(), str->GetData());
+wxHTTP::wxHeaderIterator wxHTTP::FindHeader(const wxString& header)
+{
+    wxHeaderIterator it = m_headers.begin();
+    for ( wxHeaderIterator en = m_headers.end(); it != en; ++it )
+    {
+        if ( header.CmpNoCase(it->first) == 0 )
+            break;
+    }
+
+    return it;
+}

 
 

-    wxWX2MBbuf cbuf = buf.mb_str();
-    Write(cbuf, strlen(cbuf));
+wxHTTP::wxHeaderConstIterator wxHTTP::FindHeader(const wxString& header) const
+{
+    wxHeaderConstIterator it = m_headers.begin();
+    for ( wxHeaderConstIterator en = m_headers.end(); it != en; ++it )
+    {
+        if ( header.CmpNoCase(it->first) == 0 )
+            break;
+    }
+
+    return it;
+}

 
 

-    head = head->Next();
-  }
+wxHTTP::wxCookieIterator wxHTTP::FindCookie(const wxString& cookie)
+{
+    wxCookieIterator it = m_cookies.begin();
+    for ( wxCookieIterator en = m_cookies.end(); it != en; ++it )
+    {
+        if ( cookie.CmpNoCase(it->first) == 0 )
+            break;
+    }
+
+    return it;

 }
 
 }
 

-bool wxHTTP::ParseHeaders()
+wxHTTP::wxCookieConstIterator wxHTTP::FindCookie(const wxString& cookie) const

 {
 {

-  wxString line;
+    wxCookieConstIterator it = m_cookies.begin();
+    for ( wxCookieConstIterator en = m_cookies.end(); it != en; ++it )
+    {
+        if ( cookie.CmpNoCase(it->first) == 0 )
+            break;
+    }
+
+    return it;
+}

 
 

-  m_headers.Clear();
-  m_read = TRUE;
+void wxHTTP::SetHeader(const wxString& header, const wxString& h_data)
+{
+    if (m_read) {
+        ClearHeaders();
+        m_read = false;
+    }
+
+    wxHeaderIterator it = FindHeader(header);
+    if (it != m_headers.end())
+        it->second = h_data;
+    else
+        m_headers[header] = h_data;
+}

 
 

-  while (1) {
-    m_error = GetLine(this, line);
-    if (m_error != wxPROTO_NOERR)
-      return FALSE;
+wxString wxHTTP::GetHeader(const wxString& header) const
+{
+    wxHeaderConstIterator it = FindHeader(header);

 
 

-    if (line.Length() == 0)
-      break;
+    return it == m_headers.end() ? wxGetEmptyString() : it->second;
+}

 
 

-    wxPrintf(_T("Header: %s\n"), WXSTRINGCAST line);
-    int pos = line.Find(':');
-    if (pos == -1)
-      return FALSE;
+wxString wxHTTP::GetCookie(const wxString& cookie) const
+{
+    wxCookieConstIterator it = FindCookie(cookie);

 
 

-    wxString left_str = line(0, pos);
-    wxString right_str = line(pos+1, line.Length());
+    return it == m_cookies.end() ? wxGetEmptyString() : it->second;
+}

 
 

-    right_str = right_str.Strip(wxString::leading);
+wxString wxHTTP::GenerateAuthString(const wxString& user, const wxString& pass) const
+{
+    // TODO: Use wxBase64Encode() now that we have it instead of reproducing it

 
 

-    wxString *str = new wxString(right_str);
+    static const char *base64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";

 
 

-    m_headers.Append(left_str, (wxObject *) str);
-  }
-  return TRUE;
+    wxString buf;
+    wxString toencode;
+
+    buf.Printf(wxT("Basic "));
+
+    toencode.Printf(wxT("%s:%s"),user.c_str(),pass.c_str());
+
+    size_t len = toencode.length();
+    const wxChar *from = toencode.c_str();
+    while (len >= 3) { // encode full blocks first
+        buf << wxString::Format(wxT("%c%c"), base64[(from[0] >> 2) & 0x3f], base64[((from[0] << 4) & 0x30) | ((from[1] >> 4) & 0xf)]);
+        buf << wxString::Format(wxT("%c%c"), base64[((from[1] << 2) & 0x3c) | ((from[2] >> 6) & 0x3)], base64[from[2] & 0x3f]);
+        from += 3;
+        len -= 3;
+    }
+    if (len > 0) { // pad the remaining characters
+        buf << wxString::Format(wxT("%c"), base64[(from[0] >> 2) & 0x3f]);
+        if (len == 1) {
+            buf << wxString::Format(wxT("%c="), base64[(from[0] << 4) & 0x30]);
+        } else {
+            buf << wxString::Format(wxT("%c%c"), base64[((from[0] << 4) & 0x30) | ((from[1] >> 4) & 0xf)], base64[(from[1] << 2) & 0x3c]);
+        }
+        buf << wxT("=");
+    }
+
+    return buf;

 }
 
 }
 

-bool wxHTTP::Connect(const wxString& host)
+void wxHTTP::SetPostBuffer(const wxString& post_buf)

 {
 {

-  wxIPV4address *addr;
-
-  if (m_connected) {
-    delete m_addr;
-    m_addr = NULL;
-    Close();
-  }
+    m_post_buf = post_buf;
+}

 
 

-  m_addr = addr = new wxIPV4address();
+void wxHTTP::SendHeaders()
+{
+    typedef wxStringToStringHashMap::iterator iterator;
+    wxString buf;

 
 

-  if (!addr->Hostname(host)) {
-    delete m_addr;
-    m_addr = NULL;
-    m_error = wxPROTO_NETERR;
-    return FALSE;
-  }
+    for (iterator it = m_headers.begin(), en = m_headers.end(); it != en; ++it )
+    {
+        buf.Printf(wxT("%s: %s\r\n"), it->first.c_str(), it->second.c_str());

 
 

-  if (!addr->Service(_T("http")))
-    addr->Service(80);
+        const wxWX2MBbuf cbuf = buf.mb_str();
+        Write(cbuf, strlen(cbuf));
+    }
+}

 
 

-  return TRUE;
+bool wxHTTP::ParseHeaders()
+{
+    wxString line;
+    wxStringTokenizer tokenzr;
+
+    ClearHeaders();
+    ClearCookies();
+    m_read = true;
+
+    for ( ;; )
+    {
+        m_lastError = ReadLine(this, line);
+        if (m_lastError != wxPROTO_NOERR)
+            return false;
+
+        if ( line.empty() )
+            break;
+
+        wxString left_str = line.BeforeFirst(':');
+        if(!left_str.CmpNoCase("Set-Cookie"))
+        {
+            wxString cookieName = line.AfterFirst(':').Strip(wxString::both).BeforeFirst('=');
+            wxString cookieValue = line.AfterFirst(':').Strip(wxString::both).AfterFirst('=').BeforeFirst(';');
+            m_cookies[cookieName] = cookieValue;
+
+            // For compatibility
+            m_headers[left_str] = line.AfterFirst(':').Strip(wxString::both);
+        }
+        else
+        {
+            m_headers[left_str] = line.AfterFirst(':').Strip(wxString::both);
+        }
+    }
+    return true;

 }
 
 }
 

-bool wxHTTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait))
+bool wxHTTP::Connect(const wxString& host, unsigned short port)

 {
 {

-  struct sockaddr *raw_addr;
-  size_t len;
+    wxIPV4address *addr;
+
+    if (m_addr) {
+        wxDELETE(m_addr);
+        Close();
+    }

 
 

-  m_addr = (wxSockAddress *)(addr.GetClassInfo()->CreateObject());
+    m_addr = addr = new wxIPV4address();

 
 

-  addr.Build(raw_addr, len);
-  m_addr->Disassemble(raw_addr, len);
+    if (!addr->Hostname(host)) {
+        wxDELETE(m_addr);
+        m_lastError = wxPROTO_NETERR;
+        return false;
+    }

 
 

-  return TRUE;
+    if ( port )
+        addr->Service(port);
+    else if (!addr->Service(wxT("http")))
+        addr->Service(80);
+
+    wxString hostHdr = host;
+    if ( port && port != 80 )
+        hostHdr << wxT(":") << port;
+    SetHeader(wxT("Host"), hostHdr);
+
+    m_lastError = wxPROTO_NOERR;
+    return true;
+}
+
+bool wxHTTP::Connect(const wxSockAddress& addr, bool WXUNUSED(wait))
+{
+    if (m_addr) {
+        delete m_addr;
+        Close();
+    }
+
+    m_addr = addr.Clone();
+
+    wxIPV4address *ipv4addr = wxDynamicCast(&addr, wxIPV4address);
+    if ( ipv4addr )
+    {
+        wxString hostHdr = ipv4addr->OrigHostname();
+        unsigned short port = ipv4addr->Service();
+        if ( port && port != 80 )
+            hostHdr << wxT(":") << port;
+        SetHeader(wxT("Host"), hostHdr);
+    }
+
+    m_lastError = wxPROTO_NOERR;
+    return true;

 }
 
 bool wxHTTP::BuildRequest(const wxString& path, wxHTTP_Req req)
 {
 }
 
 bool wxHTTP::BuildRequest(const wxString& path, wxHTTP_Req req)
 {

-  char *tmp_buf;
-  char buf[HTTP_BSIZE];
-  wxWX2MBbuf pathbuf = path.mb_str();
-
-  switch (req) {
-  case wxHTTP_GET:
-    tmp_buf = "GET";
-    break;
-  default:
-    return FALSE;
-  }
-
-  SaveState();
-  Notify(FALSE);
-  SetFlags(WAITALL);
-
-  sprintf(buf, "%s %s HTTP/1.0\n\r", tmp_buf, (const char*)pathbuf);
-  Write(buf, strlen(buf));
-  SendHeaders();
-  sprintf(buf, "\n\r");
-  Write(buf, strlen(buf));
-
-  wxString tmp_str;
-
-  m_error = GetLine(this, tmp_str);
-  if (m_error != wxPROTO_NOERR) {
-    RestoreState();
-    return FALSE;
-  }
+    const wxChar *request;

 
 

-  if (!tmp_str.Contains(_T("HTTP/"))) {
-    // TODO: support HTTP v0.9 which can have no header.
-    SetHeader(_T("Content-Length"), _T("-1"));
-    SetHeader(_T("Content-Type"), _T("none/none"));
-    RestoreState();
-    return TRUE;
-  }
+    switch (req)
+    {
+        case wxHTTP_GET:
+            request = wxT("GET");
+            break;
+
+        case wxHTTP_POST:
+            request = wxT("POST");
+            if ( GetHeader( wxT("Content-Length") ).empty() )
+                SetHeader( wxT("Content-Length"), wxString::Format( wxT("%lu"), (unsigned long)m_post_buf.Len() ) );
+            break;
+
+        default:
+            return false;
+    }

 
 

-  wxStringTokenizer token(tmp_str,_T(' '));
-  wxString tmp_str2;
-  bool ret_value;
+    m_http_response = 0;

 
 

-  token.NextToken();
-  tmp_str2 = token.NextToken();
+    // If there is no User-Agent defined, define it.
+    if ( GetHeader(wxT("User-Agent")).empty() )
+        SetHeader(wxT("User-Agent"), wxT("wxWidgets 2.x"));

 
 

-  switch (wxAtoi(tmp_str2)) {
-  case 200:
-    break;
-  default:
-    m_error = wxPROTO_NOFILE;
+    // Send authentication information
+    if (!m_username.empty() || !m_password.empty()) {
+        SetHeader(wxT("Authorization"), GenerateAuthString(m_username, m_password));
+    }
+
+    SaveState();
+
+    // we may use non blocking sockets only if we can dispatch events from them
+    SetFlags( wxIsMainThread() && wxApp::IsMainLoopRunning() ? wxSOCKET_NONE
+                                                             : wxSOCKET_BLOCK );
+    Notify(false);
+
+    wxString buf;
+    buf.Printf(wxT("%s %s HTTP/1.0\r\n"), request, path.c_str());
+    const wxWX2MBbuf pathbuf = buf.mb_str();
+    Write(pathbuf, strlen(pathbuf));
+    SendHeaders();
+    Write("\r\n", 2);
+
+    if ( req == wxHTTP_POST ) {
+        // Post data can be arbitrary binary data when the "binary" content
+        // transfer encoding is used so don't assume it's ASCII only or
+        // NUL-terminated.
+        {
+            const wxScopedCharBuffer buf(m_post_buf.To8BitData());
+            Write(buf, buf.length());
+        } // delete the buffer before modifying the string it points to, it
+          // wouldn't really be a problem here even if we didn't do this
+          // because we won't use this buffer again but this will avoid any
+          // nasty surprises in the future if this code changes
+
+        m_post_buf = wxEmptyString;
+    }
+
+    wxString tmp_str;
+    m_lastError = ReadLine(this, tmp_str);
+    if (m_lastError != wxPROTO_NOERR) {
+        RestoreState();
+        return false;
+    }
+
+    if (!tmp_str.Contains(wxT("HTTP/"))) {
+        // TODO: support HTTP v0.9 which can have no header.
+        // FIXME: tmp_str is not put back in the in-queue of the socket.
+        m_lastError = wxPROTO_NOERR;
+        SetHeader(wxT("Content-Length"), wxT("-1"));
+        SetHeader(wxT("Content-Type"), wxT("none/none"));
+        RestoreState();
+        return true;
+    }
+
+    wxStringTokenizer token(tmp_str,wxT(' '));
+    wxString tmp_str2;
+    bool ret_value;
+
+    token.NextToken();
+    tmp_str2 = token.NextToken();
+
+    m_http_response = wxAtoi(tmp_str2);
+
+    switch ( tmp_str2[0u].GetValue() )
+    {
+        case wxT('1'):
+            /* INFORMATION / SUCCESS */
+            break;
+
+        case wxT('2'):
+            /* SUCCESS */
+            break;
+
+        case wxT('3'):
+            /* REDIRECTION */
+            break;
+
+        default:
+            m_lastError = wxPROTO_NOFILE;
+            RestoreState();
+            return false;
+    }
+
+    m_lastError = wxPROTO_NOERR;
+    ret_value = ParseHeaders();

     RestoreState();
     RestoreState();

-    return FALSE;
-  }
+    return ret_value;
+}

 
 

-  ret_value = ParseHeaders();
-  RestoreState();
-  return ret_value;
+bool wxHTTP::Abort(void)
+{
+    return wxSocketClient::Close();

 }
 
 }
 

-class wxHTTPStream : public wxSocketInputStream {
+// ----------------------------------------------------------------------------
+// wxHTTPStream and wxHTTP::GetInputStream
+// ----------------------------------------------------------------------------
+
+class wxHTTPStream : public wxSocketInputStream
+{

 public:
 public:

-  wxHTTP *m_http;
-  size_t m_httpsize;
+    wxHTTP *m_http;
+    size_t m_httpsize;
+    unsigned long m_read_bytes;
+
+    wxHTTPStream(wxHTTP *http) : wxSocketInputStream(*http), m_http(http) {}
+    size_t GetSize() const { return m_httpsize; }
+    virtual ~wxHTTPStream(void) { m_http->Abort(); }

 
 

-  wxHTTPStream(wxHTTP *http) : wxSocketInputStream(*http), m_http(http) {}
-  size_t StreamSize() const { return m_httpsize; }
-  virtual ~wxHTTPStream(void) { m_http->Abort(); }
+protected:
+    size_t OnSysRead(void *buffer, size_t bufsize);
+
+    wxDECLARE_NO_COPY_CLASS(wxHTTPStream);

 };
 
 };
 

-bool wxHTTP::Abort(void)
+size_t wxHTTPStream::OnSysRead(void *buffer, size_t bufsize)

 {
 {

-  return wxSocketClient::Close();
+    if (m_read_bytes >= m_httpsize)
+    {
+        m_lasterror = wxSTREAM_EOF;
+        return 0;
+    }
+
+    size_t ret = wxSocketInputStream::OnSysRead(buffer, bufsize);
+    m_read_bytes += ret;
+
+    if (m_httpsize==(size_t)-1 && m_lasterror == wxSTREAM_READ_ERROR )
+    {
+        // if m_httpsize is (size_t) -1 this means read until connection closed
+        // which is equivalent to getting a READ_ERROR, for clients however this
+        // must be translated into EOF, as it is the expected way of signalling
+        // end end of the content
+        m_lasterror = wxSTREAM_EOF;
+    }
+
+    return ret;

 }
 
 wxInputStream *wxHTTP::GetInputStream(const wxString& path)
 {
 }
 
 wxInputStream *wxHTTP::GetInputStream(const wxString& path)
 {

-  wxHTTPStream *inp_stream = new wxHTTPStream(this);
+    wxHTTPStream *inp_stream;
+
+    wxString new_path;

 
 

-  if (!m_addr || m_connected) {
-    m_error = wxPROTO_CONNERR;
-    return NULL;
-  }
+    m_lastError = wxPROTO_CONNERR;  // all following returns share this type of error
+    if (!m_addr)
+        return NULL;

 
 

-  if (!wxProtocol::Connect(*m_addr))
-    return NULL;
+    // We set m_connected back to false so wxSocketBase will know what to do.
+#ifdef __WXMAC__
+    wxSocketClient::Connect(*m_addr , false );
+    wxSocketClient::WaitOnConnect(10);
+
+    if (!wxSocketClient::IsConnected())
+        return NULL;
+#else
+    if (!wxProtocol::Connect(*m_addr))
+        return NULL;
+#endif

 
 

-  if (!BuildRequest(path, wxHTTP_GET))
-    return NULL;
+    if (!BuildRequest(path, m_post_buf.empty() ? wxHTTP_GET : wxHTTP_POST))
+        return NULL;

 
 

-  wxPrintf(_T("Len = %s\n"), WXSTRINGCAST GetHeader(_T("Content-Length")));
-  if (!GetHeader(_T("Content-Length")).IsEmpty())
-    inp_stream->m_httpsize = wxAtoi(WXSTRINGCAST GetHeader(_T("Content-Length")));
+    inp_stream = new wxHTTPStream(this);

 
 

-  return inp_stream;
+    if (!GetHeader(wxT("Content-Length")).empty())
+        inp_stream->m_httpsize = wxAtoi(GetHeader(wxT("Content-Length")));
+    else
+        inp_stream->m_httpsize = (size_t)-1;
+
+    inp_stream->m_read_bytes = 0;
+
+    Notify(false);
+    SetFlags(wxSOCKET_BLOCK | wxSOCKET_WAITALL);
+
+    // no error; reset m_lastError
+    m_lastError = wxPROTO_NOERR;
+    return inp_stream;

 }
 
 }
 

-#endif
-   // wxUSE_SOCKETS
+#endif // wxUSE_PROTOCOL_HTTP