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 void wxHTTP::ClearCookies()
  70 {
  71     m_cookies.clear();
  72 }
  73
  74 wxString wxHTTP::GetContentType() const
  75 {
  76     return GetHeader(wxT("Content-Type"));
  77 }
  78
  79 void wxHTTP::SetProxyMode(bool on)
  80 {
  81     m_proxy_mode = on;
  82 }
  83
  84 wxHTTP::wxHeaderIterator wxHTTP::FindHeader(const wxString& header)
  85 {
  86     wxHeaderIterator it = m_headers.begin();
  87     for ( wxHeaderIterator en = m_headers.end(); it != en; ++it )
  88     {
  89         if ( header.CmpNoCase(it->first) == 0 )
  90             break;
  91     }
  92
  93     return it;
  94 }
  95
  96 wxHTTP::wxHeaderConstIterator wxHTTP::FindHeader(const wxString& header) const
  97 {
  98     wxHeaderConstIterator it = m_headers.begin();
  99     for ( wxHeaderConstIterator en = m_headers.end(); it != en; ++it )
 100     {
 101         if ( header.CmpNoCase(it->first) == 0 )
 102             break;
 103     }
 104
 105     return it;
 106 }
 107
 108 wxHTTP::wxCookieIterator wxHTTP::FindCookie(const wxString& cookie)
 109 {
 110     wxCookieIterator it = m_cookies.begin();
 111     for ( wxCookieIterator en = m_cookies.end(); it != en; ++it )
 112     {
 113         if ( cookie.CmpNoCase(it->first) == 0 )
 114             break;
 115     }
 116
 117     return it;
 118 }
 119
 120 wxHTTP::wxCookieConstIterator wxHTTP::FindCookie(const wxString& cookie) const
 121 {
 122     wxCookieConstIterator it = m_cookies.begin();
 123     for ( wxCookieConstIterator en = m_cookies.end(); it != en; ++it )
 124     {
 125         if ( cookie.CmpNoCase(it->first) == 0 )
 126             break;
 127     }
 128
 129     return it;
 130 }
 131
 132 void wxHTTP::SetHeader(const wxString& header, const wxString& h_data)
 133 {
 134     if (m_read) {
 135         ClearHeaders();
 136         m_read = false;
 137     }
 138
 139     wxHeaderIterator it = FindHeader(header);
 140     if (it != m_headers.end())
 141         it->second = h_data;
 142     else
 143         m_headers[header] = h_data;
 144 }
 145
 146 wxString wxHTTP::GetHeader(const wxString& header) const
 147 {
 148     wxHeaderConstIterator it = FindHeader(header);
 149
 150     return it == m_headers.end() ? wxGetEmptyString() : it->second;
 151 }
 152
 153 wxString wxHTTP::GetCookie(const wxString& cookie) const
 154 {
 155     wxCookieConstIterator it = FindCookie(cookie);
 156
 157     return it == m_cookies.end() ? wxGetEmptyString() : it->second;
 158 }
 159
 160 wxString wxHTTP::GenerateAuthString(const wxString& user, const wxString& pass) const
 161 {
 162     static const char *base64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 163
 164     wxString buf;
 165     wxString toencode;
 166
 167     buf.Printf(wxT("Basic "));
 168
 169     toencode.Printf(wxT("%s:%s"),user.c_str(),pass.c_str());
 170
 171     size_t len = toencode.length();
 172     const wxChar *from = toencode.c_str();
 173     while (len >= 3) { // encode full blocks first
 174         buf << wxString::Format(wxT("%c%c"), base64[(from[0] >> 2) & 0x3f], base64[((from[0] << 4) & 0x30) | ((from[1] >> 4) & 0xf)]);
 175         buf << wxString::Format(wxT("%c%c"), base64[((from[1] << 2) & 0x3c) | ((from[2] >> 6) & 0x3)], base64[from[2] & 0x3f]);
 176         from += 3;
 177         len -= 3;
 178     }
 179     if (len > 0) { // pad the remaining characters
 180         buf << wxString::Format(wxT("%c"), base64[(from[0] >> 2) & 0x3f]);
 181         if (len == 1) {
 182             buf << wxString::Format(wxT("%c="), base64[(from[0] << 4) & 0x30]);
 183         } else {
 184             buf << wxString::Format(wxT("%c%c"), base64[((from[0] << 4) & 0x30) | ((from[1] >> 4) & 0xf)], base64[(from[1] << 2) & 0x3c]);
 185         }
 186         buf << wxT("=");
 187     }
 188
 189     return buf;
 190 }
 191
 192 void wxHTTP::SetPostBuffer(const wxString& post_buf)
 193 {
 194     m_post_buf = post_buf;
 195 }
 196
 197 void wxHTTP::SendHeaders()
 198 {
 199     typedef wxStringToStringHashMap::iterator iterator;
 200     wxString buf;
 201
 202     for (iterator it = m_headers.begin(), en = m_headers.end(); it != en; ++it )
 203     {
 204         buf.Printf(wxT("%s: %s\r\n"), it->first.c_str(), it->second.c_str());
 205
 206         const wxWX2MBbuf cbuf = buf.mb_str();
 207         Write(cbuf, strlen(cbuf));
 208     }
 209 }
 210
 211 bool wxHTTP::ParseHeaders()
 212 {
 213     wxString line;
 214     wxStringTokenizer tokenzr;
 215
 216     ClearHeaders();
 217     ClearCookies();
 218     m_read = true;
 219
 220     for ( ;; )
 221     {
 222         m_lastError = ReadLine(this, line);
 223         if (m_lastError != wxPROTO_NOERR)
 224             return false;
 225
 226         if (line.length() == 0)
 227             break;
 228
 229         wxString left_str = line.BeforeFirst(':');
 230         if(!left_str.CmpNoCase("Set-Cookie"))
 231         {
 232             wxString cookieName = line.AfterFirst(':').Strip(wxString::both).BeforeFirst('=');
 233             wxString cookieValue = line.AfterFirst(':').Strip(wxString::both).AfterFirst('=').BeforeFirst(';');
 234             m_cookies[cookieName] = cookieValue;
 235
 236             // For compatibility
 237             m_headers[left_str] = line.AfterFirst(':').Strip(wxString::both);
 238         }
 239         else
 240         {
 241             m_headers[left_str] = line.AfterFirst(':').Strip(wxString::both);
 242         }
 243     }
 244     return true;
 245 }
 246
 247 bool wxHTTP::Connect(const wxString& host, unsigned short port)
 248 {
 249     wxIPV4address *addr;
 250
 251     if (m_addr) {
 252         delete m_addr;
 253         m_addr = NULL;
 254         Close();
 255     }
 256
 257     m_addr = addr = new wxIPV4address();
 258
 259     if (!addr->Hostname(host)) {
 260         delete m_addr;
 261         m_addr = NULL;
 262         m_lastError = wxPROTO_NETERR;
 263         return false;
 264     }
 265
 266     if ( port )
 267         addr->Service(port);
 268     else if (!addr->Service(wxT("http")))
 269         addr->Service(80);
 270
 271     wxString hostHdr = host;
 272     if ( port && port != 80 )
 273         hostHdr << wxT(":") << port;
 274     SetHeader(wxT("Host"), hostHdr);
 275
 276     m_lastError = wxPROTO_NOERR;
 277     return true;
 278 }
 279
 280 bool wxHTTP::Connect(const wxSockAddress& addr, bool WXUNUSED(wait))
 281 {
 282     if (m_addr) {
 283         delete m_addr;
 284         Close();
 285     }
 286
 287     m_addr = addr.Clone();
 288
 289     wxIPV4address *ipv4addr = wxDynamicCast(&addr, wxIPV4address);
 290     if ( ipv4addr )
 291     {
 292         wxString hostHdr = ipv4addr->OrigHostname();
 293         unsigned short port = ipv4addr->Service();
 294         if ( port && port != 80 )
 295             hostHdr << wxT(":") << port;
 296         SetHeader(wxT("Host"), hostHdr);
 297     }
 298
 299     m_lastError = wxPROTO_NOERR;
 300     return true;
 301 }
 302
 303 bool wxHTTP::BuildRequest(const wxString& path, wxHTTP_Req req)
 304 {
 305     const wxChar *request;
 306
 307     switch (req)
 308     {
 309         case wxHTTP_GET:
 310             request = wxT("GET");
 311             break;
 312
 313         case wxHTTP_POST:
 314             request = wxT("POST");
 315             if ( GetHeader( wxT("Content-Length") ).IsNull() )
 316                 SetHeader( wxT("Content-Length"), wxString::Format( wxT("%lu"), (unsigned long)m_post_buf.Len() ) );
 317             break;
 318
 319         default:
 320             return false;
 321     }
 322
 323     m_http_response = 0;
 324
 325     // If there is no User-Agent defined, define it.
 326     if (GetHeader(wxT("User-Agent")).IsNull())
 327         SetHeader(wxT("User-Agent"), wxT("wxWidgets 2.x"));
 328
 329     // Send authentication information
 330     if (!m_username.empty() || !m_password.empty()) {
 331         SetHeader(wxT("Authorization"), GenerateAuthString(m_username, m_password));
 332     }
 333
 334     SaveState();
 335
 336     // we may use non blocking sockets only if we can dispatch events from them
 337     SetFlags( wxIsMainThread() && wxApp::IsMainLoopRunning() ? wxSOCKET_NONE
 338                                                              : wxSOCKET_BLOCK );
 339     Notify(false);
 340
 341     wxString buf;
 342     buf.Printf(wxT("%s %s HTTP/1.0\r\n"), request, path.c_str());
 343     const wxWX2MBbuf pathbuf = buf.mb_str();
 344     Write(pathbuf, strlen(pathbuf));
 345     SendHeaders();
 346     Write("\r\n", 2);
 347
 348     if ( req == wxHTTP_POST ) {
 349         Write(m_post_buf.mbc_str(), m_post_buf.Len());
 350         m_post_buf = wxEmptyString;
 351     }
 352
 353     wxString tmp_str;
 354     m_lastError = ReadLine(this, tmp_str);
 355     if (m_lastError != wxPROTO_NOERR) {
 356         RestoreState();
 357         return false;
 358     }
 359
 360     if (!tmp_str.Contains(wxT("HTTP/"))) {
 361         // TODO: support HTTP v0.9 which can have no header.
 362         // FIXME: tmp_str is not put back in the in-queue of the socket.
 363         m_lastError = wxPROTO_NOERR;
 364         SetHeader(wxT("Content-Length"), wxT("-1"));
 365         SetHeader(wxT("Content-Type"), wxT("none/none"));
 366         RestoreState();
 367         return true;
 368     }
 369
 370     wxStringTokenizer token(tmp_str,wxT(' '));
 371     wxString tmp_str2;
 372     bool ret_value;
 373
 374     token.NextToken();
 375     tmp_str2 = token.NextToken();
 376
 377     m_http_response = wxAtoi(tmp_str2);
 378
 379     switch ( tmp_str2[0u].GetValue() )
 380     {
 381         case wxT('1'):
 382             /* INFORMATION / SUCCESS */
 383             break;
 384
 385         case wxT('2'):
 386             /* SUCCESS */
 387             break;
 388
 389         case wxT('3'):
 390             /* REDIRECTION */
 391             break;
 392
 393         default:
 394             m_lastError = wxPROTO_NOFILE;
 395             RestoreState();
 396             return false;
 397     }
 398
 399     m_lastError = wxPROTO_NOERR;
 400     ret_value = ParseHeaders();
 401     RestoreState();
 402     return ret_value;
 403 }
 404
 405 bool wxHTTP::Abort(void)
 406 {
 407     return wxSocketClient::Close();
 408 }
 409
 410 // ----------------------------------------------------------------------------
 411 // wxHTTPStream and wxHTTP::GetInputStream
 412 // ----------------------------------------------------------------------------
 413
 414 class wxHTTPStream : public wxSocketInputStream
 415 {
 416 public:
 417     wxHTTP *m_http;
 418     size_t m_httpsize;
 419     unsigned long m_read_bytes;
 420
 421     wxHTTPStream(wxHTTP *http) : wxSocketInputStream(*http), m_http(http) {}
 422     size_t GetSize() const { return m_httpsize; }
 423     virtual ~wxHTTPStream(void) { m_http->Abort(); }
 424
 425 protected:
 426     size_t OnSysRead(void *buffer, size_t bufsize);
 427
 428     wxDECLARE_NO_COPY_CLASS(wxHTTPStream);
 429 };
 430
 431 size_t wxHTTPStream::OnSysRead(void *buffer, size_t bufsize)
 432 {
 433     if (m_httpsize > 0 && m_read_bytes >= m_httpsize)
 434     {
 435         m_lasterror = wxSTREAM_EOF;
 436         return 0;
 437     }
 438
 439     size_t ret = wxSocketInputStream::OnSysRead(buffer, bufsize);
 440     m_read_bytes += ret;
 441
 442     if (m_httpsize==(size_t)-1 && m_lasterror == wxSTREAM_READ_ERROR )
 443     {
 444         // if m_httpsize is (size_t) -1 this means read until connection closed
 445         // which is equivalent to getting a READ_ERROR, for clients however this
 446         // must be translated into EOF, as it is the expected way of signalling
 447         // end end of the content
 448         m_lasterror = wxSTREAM_EOF;
 449     }
 450
 451     return ret;
 452 }
 453
 454 wxInputStream *wxHTTP::GetInputStream(const wxString& path)
 455 {
 456     wxHTTPStream *inp_stream;
 457
 458     wxString new_path;
 459
 460     m_lastError = wxPROTO_CONNERR;  // all following returns share this type of error
 461     if (!m_addr)
 462         return NULL;
 463
 464     // We set m_connected back to false so wxSocketBase will know what to do.
 465 #ifdef __WXMAC__
 466     wxSocketClient::Connect(*m_addr , false );
 467     wxSocketClient::WaitOnConnect(10);
 468
 469     if (!wxSocketClient::IsConnected())
 470         return NULL;
 471 #else
 472     if (!wxProtocol::Connect(*m_addr))
 473         return NULL;
 474 #endif
 475
 476     if (!BuildRequest(path, m_post_buf.empty() ? wxHTTP_GET : wxHTTP_POST))
 477         return NULL;
 478
 479     inp_stream = new wxHTTPStream(this);
 480
 481     if (!GetHeader(wxT("Content-Length")).empty())
 482         inp_stream->m_httpsize = wxAtoi(GetHeader(wxT("Content-Length")));
 483     else
 484         inp_stream->m_httpsize = (size_t)-1;
 485
 486     inp_stream->m_read_bytes = 0;
 487
 488     Notify(false);
 489     SetFlags(wxSOCKET_BLOCK | wxSOCKET_WAITALL);
 490
 491     // no error; reset m_lastError
 492     m_lastError = wxPROTO_NOERR;
 493     return inp_stream;
 494 }
 495
 496 #endif // wxUSE_PROTOCOL_HTTP