src/common/http.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/http.cpp
   3 // Purpose:     HTTP protocol
   4 // Author:      Guilhem Lavaux
   5 // Modified by: Simo Virokannas (authentication, Dec 2005)
   6 // Created:     August 1997
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1997, 1998 Guilhem Lavaux
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #if wxUSE_PROTOCOL_HTTP
  20
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23
  24 #ifndef WX_PRECOMP
  25     #include "wx/string.h"
  26     #include "wx/app.h"
  27 #endif
  28
  29 #include "wx/tokenzr.h"
  30 #include "wx/socket.h"
  31 #include "wx/protocol/protocol.h"
  32 #include "wx/url.h"
  33 #include "wx/protocol/http.h"
  34 #include "wx/sckstrm.h"
  35 #include "wx/thread.h"
  36
  37
  38 // ----------------------------------------------------------------------------
  39 // wxHTTP
  40 // ----------------------------------------------------------------------------
  41
  42 IMPLEMENT_DYNAMIC_CLASS(wxHTTP, wxProtocol)
  43 IMPLEMENT_PROTOCOL(wxHTTP, wxT("http"), wxT("80"), true)
  44
  45 wxHTTP::wxHTTP()
  46   : wxProtocol()
  47 {
  48     m_addr = NULL;
  49     m_read = false;
  50     m_proxy_mode = false;
  51     m_post_buf = wxEmptyString;
  52     m_http_response = 0;
  53
  54     SetNotify(wxSOCKET_LOST_FLAG);
  55 }
  56
  57 wxHTTP::~wxHTTP()
  58 {
  59     ClearHeaders();
  60
  61     delete m_addr;
  62 }
  63
  64 void wxHTTP::ClearHeaders()
  65 {
  66     m_headers.clear();
  67 }
  68
  69 wxString wxHTTP::GetContentType() const
  70 {
  71     return GetHeader(wxT("Content-Type"));
  72 }
  73
  74 void wxHTTP::SetProxyMode(bool on)
  75 {
  76     m_proxy_mode = on;
  77 }
  78
  79 wxHTTP::wxHeaderIterator wxHTTP::FindHeader(const wxString& header)
  80 {
  81     wxHeaderIterator it = m_headers.begin();
  82     for ( wxHeaderIterator en = m_headers.end(); it != en; ++it )
  83     {
  84         if ( header.CmpNoCase(it->first) == 0 )
  85             break;
  86     }
  87
  88     return it;
  89 }
  90
  91 wxHTTP::wxHeaderConstIterator wxHTTP::FindHeader(const wxString& header) const
  92 {
  93     wxHeaderConstIterator it = m_headers.begin();
  94     for ( wxHeaderConstIterator en = m_headers.end(); it != en; ++it )
  95     {
  96         if ( header.CmpNoCase(it->first) == 0 )
  97             break;
  98     }
  99
 100     return it;
 101 }
 102
 103 void wxHTTP::SetHeader(const wxString& header, const wxString& h_data)
 104 {
 105     if (m_read) {
 106         ClearHeaders();
 107         m_read = false;
 108     }
 109
 110     wxHeaderIterator it = FindHeader(header);
 111     if (it != m_headers.end())
 112         it->second = h_data;
 113     else
 114         m_headers[header] = h_data;
 115 }
 116
 117 wxString wxHTTP::GetHeader(const wxString& header) const
 118 {
 119     wxHeaderConstIterator it = FindHeader(header);
 120
 121     return it == m_headers.end() ? wxGetEmptyString() : it->second;
 122 }
 123
 124 wxString wxHTTP::GenerateAuthString(const wxString& user, const wxString& pass) const
 125 {
 126     static const char *base64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 127
 128     wxString buf;
 129     wxString toencode;
 130
 131     buf.Printf(wxT("Basic "));
 132
 133     toencode.Printf(wxT("%s:%s"),user.c_str(),pass.c_str());
 134
 135     size_t len = toencode.length();
 136     const wxChar *from = toencode.c_str();
 137     while (len >= 3) { // encode full blocks first
 138         buf << wxString::Format(wxT("%c%c"), base64[(from[0] >> 2) & 0x3f], base64[((from[0] << 4) & 0x30) | ((from[1] >> 4) & 0xf)]);
 139         buf << wxString::Format(wxT("%c%c"), base64[((from[1] << 2) & 0x3c) | ((from[2] >> 6) & 0x3)], base64[from[2] & 0x3f]);
 140         from += 3;
 141         len -= 3;
 142     }
 143     if (len > 0) { // pad the remaining characters
 144         buf << wxString::Format(wxT("%c"), base64[(from[0] >> 2) & 0x3f]);
 145         if (len == 1) {
 146             buf << wxString::Format(wxT("%c="), base64[(from[0] << 4) & 0x30]);
 147         } else {
 148             buf << wxString::Format(wxT("%c%c"), base64[((from[0] << 4) & 0x30) | ((from[1] >> 4) & 0xf)], base64[(from[1] << 2) & 0x3c]);
 149         }
 150         buf << wxT("=");
 151     }
 152
 153     return buf;
 154 }
 155
 156 void wxHTTP::SetPostBuffer(const wxString& post_buf)
 157 {
 158     m_post_buf = post_buf;
 159 }
 160
 161 void wxHTTP::SendHeaders()
 162 {
 163     typedef wxStringToStringHashMap::iterator iterator;
 164     wxString buf;
 165
 166     for (iterator it = m_headers.begin(), en = m_headers.end(); it != en; ++it )
 167     {
 168         buf.Printf(wxT("%s: %s\r\n"), it->first.c_str(), it->second.c_str());
 169
 170         const wxWX2MBbuf cbuf = buf.mb_str();
 171         Write(cbuf, strlen(cbuf));
 172     }
 173 }
 174
 175 bool wxHTTP::ParseHeaders()
 176 {
 177     wxString line;
 178     wxStringTokenizer tokenzr;
 179
 180     ClearHeaders();
 181     m_read = true;
 182
 183     for ( ;; )
 184     {
 185         m_lastError = ReadLine(this, line);
 186         if (m_lastError != wxPROTO_NOERR)
 187             return false;
 188
 189         if (line.length() == 0)
 190             break;
 191
 192         wxString left_str = line.BeforeFirst(':');
 193         m_headers[left_str] = line.AfterFirst(':').Strip(wxString::both);
 194     }
 195     return true;
 196 }
 197
 198 bool wxHTTP::Connect(const wxString& host, unsigned short port)
 199 {
 200     wxIPV4address *addr;
 201
 202     if (m_addr) {
 203         delete m_addr;
 204         m_addr = NULL;
 205         Close();
 206     }
 207
 208     m_addr = addr = new wxIPV4address();
 209
 210     if (!addr->Hostname(host)) {
 211         delete m_addr;
 212         m_addr = NULL;
 213         m_lastError = wxPROTO_NETERR;
 214         return false;
 215     }
 216
 217     if ( port )
 218         addr->Service(port);
 219     else if (!addr->Service(wxT("http")))
 220         addr->Service(80);
 221
 222     wxString hostHdr = host;
 223     if ( port && port != 80 )
 224         hostHdr << wxT(":") << port;
 225     SetHeader(wxT("Host"), hostHdr);
 226
 227     m_lastError = wxPROTO_NOERR;
 228     return true;
 229 }
 230
 231 bool wxHTTP::Connect(const wxSockAddress& addr, bool WXUNUSED(wait))
 232 {
 233     if (m_addr) {
 234         delete m_addr;
 235         Close();
 236     }
 237
 238     m_addr = addr.Clone();
 239
 240     wxIPV4address *ipv4addr = wxDynamicCast(&addr, wxIPV4address);
 241     if ( ipv4addr )
 242     {
 243         wxString hostHdr = ipv4addr->OrigHostname();
 244         unsigned short port = ipv4addr->Service();
 245         if ( port && port != 80 )
 246             hostHdr << wxT(":") << port;
 247         SetHeader(wxT("Host"), hostHdr);
 248     }
 249
 250     m_lastError = wxPROTO_NOERR;
 251     return true;
 252 }
 253
 254 bool wxHTTP::BuildRequest(const wxString& path, wxHTTP_Req req)
 255 {
 256     const wxChar *request;
 257
 258     switch (req)
 259     {
 260         case wxHTTP_GET:
 261             request = wxT("GET");
 262             break;
 263
 264         case wxHTTP_POST:
 265             request = wxT("POST");
 266             if ( GetHeader( wxT("Content-Length") ).IsNull() )
 267                 SetHeader( wxT("Content-Length"), wxString::Format( wxT("%lu"), (unsigned long)m_post_buf.Len() ) );
 268             break;
 269
 270         default:
 271             return false;
 272     }
 273
 274     m_http_response = 0;
 275
 276     // If there is no User-Agent defined, define it.
 277     if (GetHeader(wxT("User-Agent")).IsNull())
 278         SetHeader(wxT("User-Agent"), wxT("wxWidgets 2.x"));
 279
 280     // Send authentication information
 281     if (!m_username.empty() || !m_password.empty()) {
 282         SetHeader(wxT("Authorization"), GenerateAuthString(m_username, m_password));
 283     }
 284
 285     SaveState();
 286
 287     // we may use non blocking sockets only if we can dispatch events from them
 288     SetFlags( wxIsMainThread() && wxApp::IsMainLoopRunning() ? wxSOCKET_NONE
 289                                                              : wxSOCKET_BLOCK );
 290     Notify(false);
 291
 292     wxString buf;
 293     buf.Printf(wxT("%s %s HTTP/1.0\r\n"), request, path.c_str());
 294     const wxWX2MBbuf pathbuf = buf.mb_str();
 295     Write(pathbuf, strlen(pathbuf));
 296     SendHeaders();
 297     Write("\r\n", 2);
 298
 299     if ( req == wxHTTP_POST ) {
 300         Write(m_post_buf.mbc_str(), m_post_buf.Len());
 301         m_post_buf = wxEmptyString;
 302     }
 303
 304     wxString tmp_str;
 305     m_lastError = ReadLine(this, tmp_str);
 306     if (m_lastError != wxPROTO_NOERR) {
 307         RestoreState();
 308         return false;
 309     }
 310
 311     if (!tmp_str.Contains(wxT("HTTP/"))) {
 312         // TODO: support HTTP v0.9 which can have no header.
 313         // FIXME: tmp_str is not put back in the in-queue of the socket.
 314         m_lastError = wxPROTO_NOERR;
 315         SetHeader(wxT("Content-Length"), wxT("-1"));
 316         SetHeader(wxT("Content-Type"), wxT("none/none"));
 317         RestoreState();
 318         return true;
 319     }
 320
 321     wxStringTokenizer token(tmp_str,wxT(' '));
 322     wxString tmp_str2;
 323     bool ret_value;
 324
 325     token.NextToken();
 326     tmp_str2 = token.NextToken();
 327
 328     m_http_response = wxAtoi(tmp_str2);
 329
 330     switch ( tmp_str2[0u].GetValue() )
 331     {
 332         case wxT('1'):
 333             /* INFORMATION / SUCCESS */
 334             break;
 335
 336         case wxT('2'):
 337             /* SUCCESS */
 338             break;
 339
 340         case wxT('3'):
 341             /* REDIRECTION */
 342             break;
 343
 344         default:
 345             m_lastError = wxPROTO_NOFILE;
 346             RestoreState();
 347             return false;
 348     }
 349
 350     m_lastError = wxPROTO_NOERR;
 351     ret_value = ParseHeaders();
 352     RestoreState();
 353     return ret_value;
 354 }
 355
 356 bool wxHTTP::Abort(void)
 357 {
 358     return wxSocketClient::Close();
 359 }
 360
 361 // ----------------------------------------------------------------------------
 362 // wxHTTPStream and wxHTTP::GetInputStream
 363 // ----------------------------------------------------------------------------
 364
 365 class wxHTTPStream : public wxSocketInputStream
 366 {
 367 public:
 368     wxHTTP *m_http;
 369     size_t m_httpsize;
 370     unsigned long m_read_bytes;
 371
 372     wxHTTPStream(wxHTTP *http) : wxSocketInputStream(*http), m_http(http) {}
 373     size_t GetSize() const { return m_httpsize; }
 374     virtual ~wxHTTPStream(void) { m_http->Abort(); }
 375
 376 protected:
 377     size_t OnSysRead(void *buffer, size_t bufsize);
 378
 379     wxDECLARE_NO_COPY_CLASS(wxHTTPStream);
 380 };
 381
 382 size_t wxHTTPStream::OnSysRead(void *buffer, size_t bufsize)
 383 {
 384     if (m_httpsize > 0 && m_read_bytes >= m_httpsize)
 385     {
 386         m_lasterror = wxSTREAM_EOF;
 387         return 0;
 388     }
 389
 390     size_t ret = wxSocketInputStream::OnSysRead(buffer, bufsize);
 391     m_read_bytes += ret;
 392
 393     if (m_httpsize==(size_t)-1 && m_lasterror == wxSTREAM_READ_ERROR )
 394     {
 395         // if m_httpsize is (size_t) -1 this means read until connection closed
 396         // which is equivalent to getting a READ_ERROR, for clients however this
 397         // must be translated into EOF, as it is the expected way of signalling
 398         // end end of the content
 399         m_lasterror = wxSTREAM_EOF;
 400     }
 401
 402     return ret;
 403 }
 404
 405 wxInputStream *wxHTTP::GetInputStream(const wxString& path)
 406 {
 407     wxHTTPStream *inp_stream;
 408
 409     wxString new_path;
 410
 411     m_lastError = wxPROTO_CONNERR;  // all following returns share this type of error
 412     if (!m_addr)
 413         return NULL;
 414
 415     // We set m_connected back to false so wxSocketBase will know what to do.
 416 #ifdef __WXMAC__
 417     wxSocketClient::Connect(*m_addr , false );
 418     wxSocketClient::WaitOnConnect(10);
 419
 420     if (!wxSocketClient::IsConnected())
 421         return NULL;
 422 #else
 423     if (!wxProtocol::Connect(*m_addr))
 424         return NULL;
 425 #endif
 426
 427     if (!BuildRequest(path, m_post_buf.empty() ? wxHTTP_GET : wxHTTP_POST))
 428         return NULL;
 429
 430     inp_stream = new wxHTTPStream(this);
 431
 432     if (!GetHeader(wxT("Content-Length")).empty())
 433         inp_stream->m_httpsize = wxAtoi(GetHeader(wxT("Content-Length")));
 434     else
 435         inp_stream->m_httpsize = (size_t)-1;
 436
 437     inp_stream->m_read_bytes = 0;
 438
 439     Notify(false);
 440     SetFlags(wxSOCKET_BLOCK | wxSOCKET_WAITALL);
 441
 442     // no error; reset m_lastError
 443     m_lastError = wxPROTO_NOERR;
 444     return inp_stream;
 445 }
 446
 447 #endif // wxUSE_PROTOCOL_HTTP