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