/////////////////////////////////////////////////////////////////////////////
-// 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 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__
- #pragma hdrstop
+ #pragma hdrstop
#endif
#if wxUSE_PROTOCOL_HTTP
#include <stdio.h>
#include <stdlib.h>
-#include "wx/string.h"
+
+#ifndef WX_PRECOMP
+ #include "wx/string.h"
+ #include "wx/app.h"
+#endif
+
#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/thread.h"
-IMPLEMENT_DYNAMIC_CLASS(wxHTTP, wxProtocol)
-IMPLEMENT_PROTOCOL(wxHTTP, wxT("http"), wxT("80"), TRUE)
-#define HTTP_BSIZE 2048
+// ----------------------------------------------------------------------------
+// wxHTTP
+// ----------------------------------------------------------------------------
+
+IMPLEMENT_DYNAMIC_CLASS(wxHTTP, wxProtocol)
+IMPLEMENT_PROTOCOL(wxHTTP, wxT("http"), wxT("80"), true)
wxHTTP::wxHTTP()
- : wxProtocol(),
- m_headers(wxKEY_STRING)
+ : wxProtocol()
{
- m_addr = NULL;
- m_read = FALSE;
- m_proxy_mode = FALSE;
+ m_addr = NULL;
+ m_read = false;
+ m_proxy_mode = false;
+ m_http_response = 0;
- SetNotify(wxSOCKET_LOST_FLAG);
+ SetNotify(wxSOCKET_LOST_FLAG);
}
wxHTTP::~wxHTTP()
void wxHTTP::ClearHeaders()
{
- // wxString isn't a wxObject
- wxNode *node = m_headers.First();
- wxString *string;
-
- while (node) {
- string = (wxString *)node->Data();
- delete string;
- node = node->Next();
- }
+ m_headers.clear();
+}
- m_headers.Clear();
+void wxHTTP::ClearCookies()
+{
+ m_cookies.clear();
}
-wxString wxHTTP::GetContentType()
+wxString wxHTTP::GetContentType() const
{
- return GetHeader(wxT("Content-Type"));
+ return GetHeader(wxT("Content-Type"));
}
void wxHTTP::SetProxyMode(bool on)
{
- m_proxy_mode = on;
+ m_proxy_mode = on;
}
-void wxHTTP::SetHeader(const wxString& header, const wxString& h_data)
+wxHTTP::wxHeaderIterator wxHTTP::FindHeader(const wxString& header)
{
- if (m_read) {
- ClearHeaders();
- m_read = FALSE;
- }
+ wxHeaderIterator it = m_headers.begin();
+ for ( wxHeaderIterator en = m_headers.end(); it != en; ++it )
+ {
+ if ( header.CmpNoCase(it->first) == 0 )
+ break;
+ }
+
+ return it;
+}
- wxNode *node = m_headers.Find(header);
+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;
+}
- if (!node)
- m_headers.Append(header, (wxObject *)(new wxString(h_data)));
- else {
- wxString *str = (wxString *)node->Data();
- (*str) = h_data;
- }
+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;
}
-wxString wxHTTP::GetHeader(const wxString& header)
+wxHTTP::wxCookieConstIterator wxHTTP::FindCookie(const wxString& cookie) const
{
- wxNode *node;
- wxString upper_header;
+ wxCookieConstIterator it = m_cookies.begin();
+ for ( wxCookieConstIterator en = m_cookies.end(); it != en; ++it )
+ {
+ if ( cookie.CmpNoCase(it->first) == 0 )
+ break;
+ }
+
+ return it;
+}
- upper_header = header.Upper();
+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;
+}
- node = m_headers.Find(upper_header);
- if (!node)
- return wxEmptyString;
+wxString wxHTTP::GetHeader(const wxString& header) const
+{
+ wxHeaderConstIterator it = FindHeader(header);
- return *((wxString *)node->Data());
+ return it == m_headers.end() ? wxGetEmptyString() : it->second;
}
-void wxHTTP::SendHeaders()
+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
{
- wxNode *head = m_headers.First();
+ // TODO: Use wxBase64Encode() now that we have it instead of reproducing it
- while (head)
- {
- wxString *str = (wxString *)head->Data();
+ static const char *base64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
wxString buf;
- buf.Printf(wxT("%s: %s\r\n"), head->GetKeyString(), str->GetData());
+ 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;
+}
- const wxWX2MBbuf cbuf = buf.mb_str();
- Write(cbuf, strlen(cbuf));
+void wxHTTP::SetPostBuffer(const wxString& 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;
- head = head->Next();
- }
+ return !m_postBuffer.IsEmpty();
}
-bool wxHTTP::ParseHeaders()
+bool
+wxHTTP::SetPostText(const wxString& contentType,
+ const wxString& data,
+ const wxMBConv& conv)
{
- wxString line;
- wxStringTokenizer tokenzr;
+#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;
+}
- ClearHeaders();
- m_read = TRUE;
+void wxHTTP::SendHeaders()
+{
+ typedef wxStringToStringHashMap::iterator iterator;
+ wxString buf;
-#if defined(__VISAGECPP__)
-// VA just can't stand while(1)
- bool bOs2var = TRUE;
- while(bOs2var) {
-#else
- while (1) {
-#endif
- m_perr = GetLine(this, line);
- if (m_perr != wxPROTO_NOERR)
- 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 (line.Length() == 0)
- break;
+ const wxWX2MBbuf cbuf = buf.mb_str();
+ Write(cbuf, strlen(cbuf));
+ }
+}
- wxString left_str = line.BeforeFirst(':');
- wxString *str = new wxString(line.AfterFirst(':').Strip(wxString::both));
- left_str.MakeUpper();
+bool wxHTTP::ParseHeaders()
+{
+ wxString line;
+ wxStringTokenizer tokenzr;
- m_headers.Append(left_str, (wxObject *) str);
- }
- return TRUE;
+ 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(const wxString& host)
+bool wxHTTP::Connect(const wxString& host, unsigned short port)
{
- wxIPV4address *addr;
+ wxIPV4address *addr;
- if (m_addr) {
- delete m_addr;
- m_addr = NULL;
- Close();
- }
+ if (m_addr) {
+ wxDELETE(m_addr);
+ Close();
+ }
- m_addr = addr = new wxIPV4address();
+ m_addr = addr = new wxIPV4address();
- if (!addr->Hostname(host)) {
- delete m_addr;
- m_addr = NULL;
- m_perr = wxPROTO_NETERR;
- return FALSE;
- }
+ if (!addr->Hostname(host)) {
+ wxDELETE(m_addr);
+ m_lastError = wxPROTO_NETERR;
+ return false;
+ }
- if (!addr->Service(wxT("http")))
- addr->Service(80);
+ if ( port )
+ addr->Service(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);
- return TRUE;
+ 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;
- Close();
- }
-
- m_addr = addr.Clone();
-
- wxIPV4address *ipv4addr = wxDynamicCast(&addr, wxIPV4address);
- if (ipv4addr)
- SetHeader(wxT("Host"), ipv4addr->OrigHostname());
-
- return TRUE;
+ 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, const wxString& method)
{
- const wxChar *request;
-
- switch (req) {
- case wxHTTP_GET:
- request = wxT("GET");
- break;
- default:
- return FALSE;
- }
-
- // If there is no User-Agent defined, define it.
- if (GetHeader(wxT("User-Agent")).IsNull())
- SetHeader(wxT("User-Agent"), wxT("wxWindows 2.x"));
-
- SaveState();
- SetFlags(wxSOCKET_NONE);
- 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));
- SendHeaders();
- Write("\r\n", 2);
-
- wxString tmp_str;
- m_perr = GetLine(this, tmp_str);
- if (m_perr != 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.
- 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();
-
- switch (tmp_str2[0u]) {
- case wxT('1'):
- /* INFORMATION / SUCCESS */
- break;
- case wxT('2'):
- /* SUCCESS */
- break;
- case wxT('3'):
- /* REDIRECTION */
- break;
- default:
- m_perr = wxPROTO_NOFILE;
+ // Use the data in the post buffer, if any.
+ if ( !m_postBuffer.IsEmpty() )
+ {
+ 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")).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
+ 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"), method, path);
+ const wxWX2MBbuf pathbuf = buf.mb_str();
+ Write(pathbuf, strlen(pathbuf));
+ SendHeaders();
+ Write("\r\n", 2);
+
+ if ( !m_postBuffer.IsEmpty() ) {
+ Write(m_postBuffer.GetData(), m_postBuffer.GetDataLen());
+
+ m_postBuffer.Clear();
+ }
+
+ 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();
- return FALSE;
- }
+ return ret_value;
+}
- ret_value = ParseHeaders();
- RestoreState();
- return ret_value;
+bool wxHTTP::Abort(void)
+{
+ return wxSocketClient::Close();
}
+// ----------------------------------------------------------------------------
+// wxHTTPStream and wxHTTP::GetInputStream
+// ----------------------------------------------------------------------------
+
class wxHTTPStream : public wxSocketInputStream
{
public:
- wxHTTP *m_http;
- size_t m_httpsize;
- unsigned long m_read_bytes;
+ wxHTTP *m_http;
+ size_t m_httpsize;
+ unsigned long m_read_bytes;
+
+ wxHTTPStream(wxHTTP *http) : wxSocketInputStream(*http)
+ {
+ m_http = http;
+ m_httpsize = 0;
+ m_read_bytes = 0;
+ }
- wxHTTPStream(wxHTTP *http) : wxSocketInputStream(*http), m_http(http) {}
- size_t GetSize() const { return m_httpsize; }
- virtual ~wxHTTPStream(void) { m_http->Abort(); }
+ size_t GetSize() const { return m_httpsize; }
+ virtual ~wxHTTPStream(void) { m_http->Abort(); }
protected:
- size_t OnSysRead(void *buffer, size_t bufsize);
+ size_t OnSysRead(void *buffer, size_t bufsize);
+
+ wxDECLARE_NO_COPY_CLASS(wxHTTPStream);
};
size_t wxHTTPStream::OnSysRead(void *buffer, size_t bufsize)
{
- size_t ret;
-
- if (m_httpsize > 0 && m_read_bytes >= m_httpsize)
- return 0;
-
- ret = wxSocketInputStream::OnSysRead(buffer, bufsize);
- m_read_bytes += ret;
-
- return ret;
-}
-
-bool wxHTTP::Abort(void)
-{
- 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)
{
- wxHTTPStream *inp_stream;
+ wxHTTPStream *inp_stream;
- wxString new_path;
+ wxString new_path;
- m_perr = wxPROTO_CONNERR;
- if (!m_addr)
- return NULL;
+ m_lastError = wxPROTO_CONNERR; // all following returns share this type of error
+ if (!m_addr)
+ return NULL;
- // We set m_connected back to FALSE so wxSocketBase will know what to do.
+ // We set m_connected back to false so wxSocketBase will know what to do.
#ifdef __WXMAC__
- wxSocketClient::Connect(*m_addr , FALSE );
- wxSocketClient::WaitOnConnect(10);
+ wxSocketClient::Connect(*m_addr , false );
+ wxSocketClient::WaitOnConnect(10);
if (!wxSocketClient::IsConnected())
return NULL;
#else
- if (!wxProtocol::Connect(*m_addr))
- return NULL;
+ if (!wxProtocol::Connect(*m_addr))
+ return NULL;
#endif
- if (!BuildRequest(path, wxHTTP_GET))
- return NULL;
+ // 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);
+ inp_stream = new wxHTTPStream(this);
- if (!GetHeader(wxT("Content-Length")).IsEmpty())
- inp_stream->m_httpsize = wxAtoi(WXSTRINGCAST GetHeader(wxT("Content-Length")));
- else
- inp_stream->m_httpsize = (size_t)-1;
+ 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;
+ inp_stream->m_read_bytes = 0;
- Notify(FALSE);
- SetFlags(wxSOCKET_BLOCK | wxSOCKET_WAITALL);
+ Notify(false);
+ SetFlags(wxSOCKET_BLOCK | wxSOCKET_WAITALL);
- return inp_stream;
+ // no error; reset m_lastError
+ m_lastError = wxPROTO_NOERR;
+ return inp_stream;
}
#endif // wxUSE_PROTOCOL_HTTP
-