]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/http.cpp
Workaround for #15404: wxRichTextCtrl: caret does not disappear when focus is lost...
[wxWidgets.git] / src / common / http.cpp
index fcab146c82aa4f0d10cc77ad03ed59c72d287ce9..0ecde88c77ce897fd5cd43d388e2c64afdcc6385 100644 (file)
@@ -1,10 +1,9 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        http.cpp
+// Name:        src/common/http.cpp
 // 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
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
@@ -13,7 +12,7 @@
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-  #pragma hdrstop
+    #pragma hdrstop
 #endif
 
 #if wxUSE_PROTOCOL_HTTP
@@ -22,8 +21,8 @@
 #include <stdlib.h>
 
 #ifndef WX_PRECOMP
-#include "wx/string.h"
-#include "wx/app.h"
+    #include "wx/string.h"
+    #include "wx/app.h"
 #endif
 
 #include "wx/tokenzr.h"
 #include "wx/url.h"
 #include "wx/protocol/http.h"
 #include "wx/sckstrm.h"
+#include "wx/thread.h"
+
+
+// ----------------------------------------------------------------------------
+// wxHTTP
+// ----------------------------------------------------------------------------
 
 IMPLEMENT_DYNAMIC_CLASS(wxHTTP, wxProtocol)
 IMPLEMENT_PROTOCOL(wxHTTP, wxT("http"), wxT("80"), true)
@@ -42,7 +47,6 @@ wxHTTP::wxHTTP()
     m_addr = NULL;
     m_read = false;
     m_proxy_mode = false;
-    m_post_buf = wxEmptyString;
     m_http_response = 0;
 
     SetNotify(wxSOCKET_LOST_FLAG);
@@ -57,10 +61,15 @@ wxHTTP::~wxHTTP()
 
 void wxHTTP::ClearHeaders()
 {
-  m_headers.clear();
+    m_headers.clear();
+}
+
+void wxHTTP::ClearCookies()
+{
+    m_cookies.clear();
 }
 
-wxString wxHTTP::GetContentType()
+wxString wxHTTP::GetContentType() const
 {
     return GetHeader(wxT("Content-Type"));
 }
@@ -75,7 +84,7 @@ wxHTTP::wxHeaderIterator wxHTTP::FindHeader(const wxString& header)
     wxHeaderIterator it = m_headers.begin();
     for ( wxHeaderIterator en = m_headers.end(); it != en; ++it )
     {
-        if ( wxStricmp(it->first, header) == 0 )
+        if ( header.CmpNoCase(it->first) == 0 )
             break;
     }
 
@@ -87,7 +96,31 @@ wxHTTP::wxHeaderConstIterator wxHTTP::FindHeader(const wxString& header) const
     wxHeaderConstIterator it = m_headers.begin();
     for ( wxHeaderConstIterator en = m_headers.end(); it != en; ++it )
     {
-        if ( wxStricmp(it->first, header) == 0 )
+        if ( header.CmpNoCase(it->first) == 0 )
+            break;
+    }
+
+    return it;
+}
+
+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;
+}
+
+wxHTTP::wxCookieConstIterator wxHTTP::FindCookie(const wxString& cookie) const
+{
+    wxCookieConstIterator it = m_cookies.begin();
+    for ( wxCookieConstIterator en = m_cookies.end(); it != en; ++it )
+    {
+        if ( cookie.CmpNoCase(it->first) == 0 )
             break;
     }
 
@@ -115,9 +148,92 @@ wxString wxHTTP::GetHeader(const wxString& header) const
     return it == m_headers.end() ? wxGetEmptyString() : it->second;
 }
 
+wxString wxHTTP::GetCookie(const wxString& cookie) const
+{
+    wxCookieConstIterator it = FindCookie(cookie);
+
+    return it == m_cookies.end() ? wxGetEmptyString() : it->second;
+}
+
+wxString wxHTTP::GenerateAuthString(const wxString& user, const wxString& pass) const
+{
+    // TODO: Use wxBase64Encode() now that we have it instead of reproducing it
+
+    static const char *base64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+
+    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;
+}
+
 void wxHTTP::SetPostBuffer(const wxString& post_buf)
 {
-    m_post_buf = post_buf;
+    // Use To8BitData() for backwards compatibility in this deprecated method.
+    // The new code should use the other overload or SetPostText() and specify
+    // the encoding to use for the text explicitly.
+    wxScopedCharBuffer scb = post_buf.To8BitData();
+    if ( scb.length() )
+    {
+        m_postBuffer.Clear();
+        m_postBuffer.AppendData(scb.data(), scb.length());
+    }
+}
+
+bool
+wxHTTP::SetPostBuffer(const wxString& contentType,
+                      const wxMemoryBuffer& data)
+{
+    m_postBuffer = data;
+    m_contentType = contentType;
+
+    return !m_postBuffer.IsEmpty();
+}
+
+bool
+wxHTTP::SetPostText(const wxString& contentType,
+                    const wxString& data,
+                    const wxMBConv& conv)
+{
+#if wxUSE_UNICODE
+    wxScopedCharBuffer scb = data.mb_str(conv);
+    const size_t len = scb.length();
+    const char* const buf = scb.data();
+#else // !wxUSE_UNICODE
+    const size_t len = data.length();
+    const char* const buf = data.mb_str(conv);
+#endif // wxUSE_UNICODE/!wxUSE_UNICODE
+
+    if ( !len )
+        return false;
+
+    m_postBuffer.Clear();
+    m_postBuffer.AppendData(buf, len);
+    m_contentType = contentType;
+
+    return true;
 }
 
 void wxHTTP::SendHeaders()
@@ -140,25 +256,32 @@ bool wxHTTP::ParseHeaders()
     wxStringTokenizer tokenzr;
 
     ClearHeaders();
+    ClearCookies();
     m_read = true;
 
-#if defined(__VISAGECPP__)
-// VA just can't stand while(1)
-    bool bOs2var = true;
-    while(bOs2var)
-#else
-    while (1)
-#endif
+    for ( ;; )
     {
-        m_perr = ReadLine(this, line);
-        if (m_perr != wxPROTO_NOERR)
+        m_lastError = ReadLine(this, line);
+        if (m_lastError != wxPROTO_NOERR)
             return false;
 
-        if (line.Length() == 0)
+        if ( line.empty() )
             break;
 
         wxString left_str = line.BeforeFirst(':');
-        m_headers[left_str] = line.AfterFirst(':').Strip(wxString::both);
+        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;
 }
@@ -168,17 +291,15 @@ bool wxHTTP::Connect(const wxString& host, unsigned short port)
     wxIPV4address *addr;
 
     if (m_addr) {
-        delete m_addr;
-        m_addr = NULL;
+        wxDELETE(m_addr);
         Close();
     }
 
     m_addr = addr = new wxIPV4address();
 
     if (!addr->Hostname(host)) {
-        delete m_addr;
-        m_addr = NULL;
-        m_perr = wxPROTO_NETERR;
+        wxDELETE(m_addr);
+        m_lastError = wxPROTO_NETERR;
         return false;
     }
 
@@ -187,12 +308,16 @@ bool wxHTTP::Connect(const wxString& host, unsigned short port)
     else if (!addr->Service(wxT("http")))
         addr->Service(80);
 
-    SetHeader(wxT("Host"), host);
+    wxString hostHdr = host;
+    if ( port && port != 80 )
+        hostHdr << wxT(":") << port;
+    SetHeader(wxT("Host"), hostHdr);
 
+    m_lastError = wxPROTO_NOERR;
     return true;
 }
 
-bool wxHTTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait))
+bool wxHTTP::Connect(const wxSockAddress& addr, bool WXUNUSED(wait))
 {
     if (m_addr) {
         delete m_addr;
@@ -202,60 +327,75 @@ bool wxHTTP::Connect(wxSockAddress& addr, bool WXUNUSED(wait))
     m_addr = addr.Clone();
 
     wxIPV4address *ipv4addr = wxDynamicCast(&addr, wxIPV4address);
-    if (ipv4addr)
-        SetHeader(wxT("Host"), ipv4addr->OrigHostname());
+    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, const wxString& method)
 {
-    const wxChar *request;
-
-    switch (req)
+    // Use the data in the post buffer, if any.
+    if ( !m_postBuffer.IsEmpty() )
     {
-        case wxHTTP_GET:
-            request = wxT("GET");
-            break;
-
-        case wxHTTP_POST:
-            request = wxT("POST");
-            if ( GetHeader( wxT("Content-Length") ).IsNull() )
-                SetHeader( wxT("Content-Length"), wxString::Format( wxT("%lu"), (unsigned long)m_post_buf.Len() ) );
-            break;
-
-        default:
-            return false;
+        wxString len;
+        len << m_postBuffer.GetDataLen();
+
+        // Content length must be correct, so always set, possibly
+        // overriding the value set explicitly by a previous call to
+        // SetHeader("Content-Length").
+        SetHeader(wxS("Content-Length"), len);
+
+        // However if the user had explicitly set the content type, don't
+        // override it with the content type passed to SetPostText().
+        if ( !m_contentType.empty() && GetContentType().empty() )
+            SetHeader(wxS("Content-Type"), m_contentType);
     }
 
     m_http_response = 0;
 
     // If there is no User-Agent defined, define it.
-    if (GetHeader(wxT("User-Agent")).IsNull())
+    if ( GetHeader(wxT("User-Agent")).empty() )
         SetHeader(wxT("User-Agent"), wxT("wxWidgets 2.x"));
 
+    // 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 );
+    int flags = wxIsMainThread() && wxApp::IsMainLoopRunning() ? wxSOCKET_NONE
+                                                               : wxSOCKET_BLOCK;
+    // and we must use wxSOCKET_WAITALL to ensure that all data is sent
+    flags |= wxSOCKET_WAITALL;
+    SetFlags(flags);
     Notify(false);
 
     wxString buf;
-    buf.Printf(wxT("%s %s HTTP/1.0\r\n"), request, path.c_str());
-    const wxWX2MBbuf pathbuf = wxConvLocal.cWX2MB(buf);
-    Write(pathbuf, strlen(wxMBSTRINGCAST pathbuf));
+    buf.Printf(wxT("%s %s HTTP/1.0\r\n"), method, path);
+    const wxWX2MBbuf pathbuf = buf.mb_str();
+    Write(pathbuf, strlen(pathbuf));
     SendHeaders();
     Write("\r\n", 2);
 
-    if ( req == wxHTTP_POST ) {
-        Write(m_post_buf.mbc_str(), m_post_buf.Len());
-        m_post_buf = wxEmptyString;
+    if ( !m_postBuffer.IsEmpty() ) {
+        Write(m_postBuffer.GetData(), m_postBuffer.GetDataLen());
+
+        m_postBuffer.Clear();
     }
 
     wxString tmp_str;
-    m_perr = ReadLine(this, tmp_str);
-    if (m_perr != wxPROTO_NOERR) {
+    m_lastError = ReadLine(this, tmp_str);
+    if (m_lastError != wxPROTO_NOERR) {
         RestoreState();
         return false;
     }
@@ -263,6 +403,7 @@ bool wxHTTP::BuildRequest(const wxString& path, wxHTTP_Req req)
     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();
@@ -278,7 +419,7 @@ bool wxHTTP::BuildRequest(const wxString& path, wxHTTP_Req req)
 
     m_http_response = wxAtoi(tmp_str2);
 
-    switch (tmp_str2[0u])
+    switch ( tmp_str2[0u].GetValue() )
     {
         case wxT('1'):
             /* INFORMATION / SUCCESS */
@@ -293,16 +434,26 @@ bool wxHTTP::BuildRequest(const wxString& path, wxHTTP_Req req)
             break;
 
         default:
-            m_perr = wxPROTO_NOFILE;
+            m_lastError = wxPROTO_NOFILE;
             RestoreState();
             return false;
     }
 
+    m_lastError = wxPROTO_NOERR;
     ret_value = ParseHeaders();
     RestoreState();
     return ret_value;
 }
 
+bool wxHTTP::Abort(void)
+{
+    return wxSocketClient::Close();
+}
+
+// ----------------------------------------------------------------------------
+// wxHTTPStream and wxHTTP::GetInputStream
+// ----------------------------------------------------------------------------
+
 class wxHTTPStream : public wxSocketInputStream
 {
 public:
@@ -310,19 +461,25 @@ public:
     size_t m_httpsize;
     unsigned long m_read_bytes;
 
-    wxHTTPStream(wxHTTP *http) : wxSocketInputStream(*http), m_http(http) {}
+    wxHTTPStream(wxHTTP *http) : wxSocketInputStream(*http)
+    {
+        m_http = http;
+        m_httpsize = 0;
+        m_read_bytes = 0;
+    }
+
     size_t GetSize() const { return m_httpsize; }
     virtual ~wxHTTPStream(void) { m_http->Abort(); }
 
 protected:
     size_t OnSysRead(void *buffer, size_t bufsize);
 
-    DECLARE_NO_COPY_CLASS(wxHTTPStream)
+    wxDECLARE_NO_COPY_CLASS(wxHTTPStream);
 };
 
 size_t wxHTTPStream::OnSysRead(void *buffer, size_t bufsize)
 {
-    if (m_httpsize > 0 && m_read_bytes >= m_httpsize)
+    if (m_read_bytes >= m_httpsize)
     {
         m_lasterror = wxSTREAM_EOF;
         return 0;
@@ -337,24 +494,19 @@ size_t wxHTTPStream::OnSysRead(void *buffer, size_t bufsize)
         // 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 ;
+        m_lasterror = wxSTREAM_EOF;
     }
 
     return ret;
 }
 
-bool wxHTTP::Abort(void)
-{
-    return wxSocketClient::Close();
-}
-
 wxInputStream *wxHTTP::GetInputStream(const wxString& path)
 {
     wxHTTPStream *inp_stream;
 
     wxString new_path;
 
-    m_perr = wxPROTO_CONNERR;
+    m_lastError = wxPROTO_CONNERR;  // all following returns share this type of error
     if (!m_addr)
         return NULL;
 
@@ -370,13 +522,19 @@ wxInputStream *wxHTTP::GetInputStream(const wxString& path)
         return NULL;
 #endif
 
-    if (!BuildRequest(path, m_post_buf.empty() ? wxHTTP_GET : wxHTTP_POST))
+    // Use the user-specified method if any or determine the method to use
+    // automatically depending on whether we have anything to post or not.
+    wxString method = m_method;
+    if (method.empty())
+        method = m_postBuffer.IsEmpty() ? wxS("GET"): wxS("POST");
+
+    if (!BuildRequest(path, method))
         return NULL;
 
     inp_stream = new wxHTTPStream(this);
 
     if (!GetHeader(wxT("Content-Length")).empty())
-        inp_stream->m_httpsize = wxAtoi(WXSTRINGCAST GetHeader(wxT("Content-Length")));
+        inp_stream->m_httpsize = wxAtoi(GetHeader(wxT("Content-Length")));
     else
         inp_stream->m_httpsize = (size_t)-1;
 
@@ -385,8 +543,9 @@ wxInputStream *wxHTTP::GetInputStream(const wxString& path)
     Notify(false);
     SetFlags(wxSOCKET_BLOCK | wxSOCKET_WAITALL);
 
+    // no error; reset m_lastError
+    m_lastError = wxPROTO_NOERR;
     return inp_stream;
 }
 
 #endif // wxUSE_PROTOCOL_HTTP
-