Minor header cleaning.

[wxWidgets.git] / src / common / url.cpp

diff --git a/src/common/url.cpp b/src/common/url.cpp
index 6df0b8ff580ab6bd6968a4389dd4cf1c92264a04..700cb18d7e59202335109af9dadf37250b61099f 100644 (file)
--- a/src/common/url.cpp
+++ b/src/common/url.cpp
@@ -1,316 +1,524 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        url.cpp
+// Name:        src/common/url.cpp

 // Purpose:     URL parser
 // Author:      Guilhem Lavaux
 // Modified by:
 // Created:     20/07/1997
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997, 1998 Guilhem Lavaux
 // Purpose:     URL parser
 // Author:      Guilhem Lavaux
 // Modified by:
 // Created:     20/07/1997
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997, 1998 Guilhem Lavaux

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "url.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

+#if wxUSE_URL
+
+#include "wx/url.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

+    #include "wx/list.h"
+    #include "wx/string.h"
+    #include "wx/utils.h"
+    #include "wx/module.h"

 #endif
 
 #include <string.h>
 #include <ctype.h>
 
 #endif
 
 #include <string.h>
 #include <ctype.h>
 

-// wxWindows headers
-#include <wx/string.h>
-#include <wx/list.h>
-#include <wx/utils.h>
+IMPLEMENT_CLASS(wxProtoInfo, wxObject)
+IMPLEMENT_CLASS(wxURL, wxURI)

 
 

-// wxSocket header
-#include "wx/url.h"
+// Protocols list
+wxProtoInfo *wxURL::ms_protocols = NULL;

 
 

-#if !USE_SHARED_LIBRARY
-IMPLEMENT_CLASS(wxProtoInfo, wxObject)
-IMPLEMENT_CLASS(wxURL, wxObject)
+// Enforce linking of protocol classes:
+USE_PROTOCOL(wxFileProto)
+
+#if wxUSE_PROTOCOL_HTTP
+USE_PROTOCOL(wxHTTP)
+
+    wxHTTP *wxURL::ms_proxyDefault = NULL;
+    bool wxURL::ms_useDefaultProxy = false;

 #endif
 
 #endif
 

-// Protocols list
-wxProtoInfo *wxURL::g_protocols = NULL;
-wxHTTP *wxURL::g_proxy;
+#if wxUSE_PROTOCOL_FTP
+USE_PROTOCOL(wxFTP)
+#endif

 
 

-/////////////////////////////////////////////////////////////////
-// wxURL ////////////////////////////////////////////////////////
-/////////////////////////////////////////////////////////////////
+// --------------------------------------------------------------
+//
+//                          wxURL
+//
+// --------------------------------------------------------------

 
 

-/*
- * --------------------------------------------------------------
- * --------- wxURL CONSTRUCTOR DESTRUCTOR -----------------------
- * --------------------------------------------------------------
- */
+// --------------------------------------------------------------
+// Construction
+// --------------------------------------------------------------

 
 

-wxURL::wxURL(const wxString& url)
+wxURL::wxURL(const wxString& url) : wxURI(url)

 {
 {

-  m_protocol = NULL;
-  if (g_proxy->IsConnected()) {
-    m_protocol = g_proxy;
-    m_protoname = "proxy";
-    m_path = url;
-    return;
-  }
-  m_url = url;
-  m_error = wxURL_NOERR;
-  ParseURL();
+    Init(url);
+    ParseURL();

 }
 
 }
 

-bool wxURL::ParseURL()
+wxURL::wxURL(const wxURI& url) : wxURI(url)

 {
 {

-  wxString last_url = m_url;
-
-  // Clean up
-  CleanData();
+    Init(url.BuildURI());
+    ParseURL();
+}

 
 

-  // Extract protocol name
-  if (!PrepProto(last_url)) {
-    m_error = wxURL_SNTXERR;
-    return FALSE;
-  }
+void wxURL::Init(const wxString& url)
+{
+    m_protocol = NULL;
+    m_error = wxURL_NOERR;
+    m_url = url;
+#if wxUSE_URL_NATIVE
+    m_nativeImp = CreateNativeImpObject();
+#endif

 
 

-  // Find and create the protocol object
-  if (!FetchProtocol()) {
-    m_error = wxURL_NOPROTO;
-    return FALSE;
-  }
+#if wxUSE_PROTOCOL_HTTP
+    if ( ms_useDefaultProxy && !ms_proxyDefault )
+    {
+        SetDefaultProxy( wxGetenv(wxT("HTTP_PROXY")) );

 
 

-  // Do we need a host name ?
-  if (m_protoinfo->m_needhost) {
-    // Extract it
-    if (!PrepHost(last_url)) {
-      m_error = wxURL_SNTXERR;
-      return FALSE;
+        if ( !ms_proxyDefault )
+        {
+            // don't try again
+            ms_useDefaultProxy = false;
+        }

     }
     }

-  }

 
 

-  // Extract full path
-  if (!PrepPath(last_url)) {
-    m_error = wxURL_NOPATH;
-    return FALSE;
-  }
+    m_useProxy = ms_proxyDefault != NULL;
+    m_proxy = ms_proxyDefault;
+#endif // wxUSE_PROTOCOL_HTTP

 
 

-  m_error = wxURL_NOERR;
-  return TRUE;

 }
 
 }
 

-void wxURL::CleanData()
+// --------------------------------------------------------------
+// Assignment
+// --------------------------------------------------------------
+
+wxURL& wxURL::operator = (const wxURI& url)

 {
 {

-  if (m_protoname != "proxy")
-    delete m_protocol;
+    wxURI::operator = (url);
+    Init(url.BuildURI());
+    ParseURL();
+    return *this;

 }
 }

-
-wxURL::~wxURL()
+wxURL& wxURL::operator = (const wxString& url)

 {
 {

-  CleanData();
+    wxURI::operator = (url);
+    Init(url);
+    ParseURL();
+    return *this;

 }
 
 }
 

-/*
- * --------------------------------------------------------------
- * --------- wxURL urls decoders --------------------------------
- * --------------------------------------------------------------
- */
-bool wxURL::PrepProto(wxString& url)
+// --------------------------------------------------------------
+// ParseURL
+//
+// Builds the URL and takes care of the old protocol stuff
+// --------------------------------------------------------------
+
+bool wxURL::ParseURL()

 {
 {

-  int pos;
+    // If the URL was already parsed (m_protocol != NULL), pass this section.
+    if (!m_protocol)
+    {
+        // Clean up
+        CleanData();
+
+        // Make sure we have a protocol/scheme
+        if (!HasScheme())
+        {
+            m_error = wxURL_SNTXERR;
+            return false;
+        }
+
+        // Find and create the protocol object
+        if (!FetchProtocol())
+        {
+            m_error = wxURL_NOPROTO;
+            return false;
+        }
+
+        // Do we need a host name ?
+        if (m_protoinfo->m_needhost)
+        {
+            //  Make sure we have one, then
+            if (!HasServer())
+            {
+                m_error = wxURL_SNTXERR;
+                return false;
+            }
+        }
+    }
+
+#if wxUSE_PROTOCOL_HTTP
+    if (m_useProxy)
+    {
+        // Third, we rebuild the URL.
+        m_url = m_scheme + wxT(":");
+        if (m_protoinfo->m_needhost)
+            m_url = m_url + wxT("//") + m_server;

 
 

-  // Find end
-  pos = url.Find(':');
-  if (pos == -1)
-    return FALSE;
+        // We initialize specific variables.
+        m_protocol = m_proxy; // FIXME: we should clone the protocol
+    }
+#endif // wxUSE_PROTOCOL_HTTP

 
 

-  m_protoname = url(0, pos);
+    m_error = wxURL_NOERR;
+    return true;
+}

 
 

-  url = url(pos+1, url.Length());
+// --------------------------------------------------------------
+// Destruction/Cleanup
+// --------------------------------------------------------------

 
 

-  return TRUE;
+void wxURL::CleanData()
+{
+#if wxUSE_PROTOCOL_HTTP
+    if (!m_useProxy)
+#endif // wxUSE_PROTOCOL_HTTP
+        if (m_protocol)
+            // Need to safely delete the socket (pending events)
+            m_protocol->Destroy();

 }
 
 }
 

-bool wxURL::PrepHost(wxString& url)
+wxURL::~wxURL()

 {
 {

-  wxString temp_url;
-  int pos, pos2;
+    CleanData();
+#if wxUSE_PROTOCOL_HTTP
+    if (m_proxy && m_proxy != ms_proxyDefault)
+        delete m_proxy;
+#endif // wxUSE_PROTOCOL_HTTP
+#if wxUSE_URL_NATIVE
+    delete m_nativeImp;
+#endif
+}

 
 

-  if ((url.GetChar(0) != '/') || (url.GetChar(1) != '/'))
-    return FALSE;
+// --------------------------------------------------------------
+// FetchProtocol
+// --------------------------------------------------------------

 
 

-  url = url(2, url.Length());
+bool wxURL::FetchProtocol()
+{
+    wxProtoInfo *info = ms_protocols;

 
 

-  pos = url.Find('/');
-  if (pos == -1)
-    pos = url.Length();
+    while (info)
+    {
+        if (m_scheme == info->m_protoname)
+        {
+            if (m_port.IsNull())
+                m_port = info->m_servname;
+            m_protoinfo = info;
+            m_protocol = (wxProtocol *)m_protoinfo->m_cinfo->CreateObject();
+            return true;
+        }
+        info = info->next;
+    }
+    return false;
+}

 
 

-  if (pos == 0)
-    return FALSE;
+// --------------------------------------------------------------
+// GetInputStream
+// --------------------------------------------------------------

 
 

-  temp_url = url(0, pos);
-  url = url(url.Find('/'), url.Length());
+wxInputStream *wxURL::GetInputStream()
+{
+    if (!m_protocol)
+    {
+        m_error = wxURL_NOPROTO;
+        return NULL;
+    }

 
 

-  // Retrieve service number
-  pos2 = temp_url.Find(':', TRUE);
-  if (pos2 != -1 && pos2 < pos) {
-    m_servname = url(pos2, pos);
-    if (!m_servname.IsNumber())
-      return FALSE;
-    pos2 = pos;
-    temp_url = temp_url(0, pos2);
-  }
+    m_error = wxURL_NOERR;
+    if (HasUserInfo())
+    {
+        size_t dwPasswordPos = m_userinfo.find(':');
+
+        if (dwPasswordPos == wxString::npos)
+            m_protocol->SetUser(m_userinfo);
+        else
+        {
+            m_protocol->SetUser(m_userinfo(0, dwPasswordPos));
+            m_protocol->SetPassword(m_userinfo(dwPasswordPos+1, m_userinfo.length() + 1));
+        }
+    }
+
+#if wxUSE_URL_NATIVE
+    // give the native implementation to return a better stream
+    // such as the native WinINet functionality under MS-Windows
+    if (m_nativeImp)
+    {
+        wxInputStream *rc;
+        rc = m_nativeImp->GetInputStream(this);
+        if (rc != 0)
+            return rc;
+    }
+    // else use the standard behaviour
+#endif // wxUSE_URL_NATIVE
+
+#if wxUSE_SOCKETS
+    wxIPV4address addr;
+
+    // m_protoinfo is NULL when we use a proxy
+    if (!m_useProxy && m_protoinfo->m_needhost)
+    {
+        if (!addr.Hostname(m_server))
+        {
+            m_error = wxURL_NOHOST;
+            return NULL;
+        }
+
+        addr.Service(m_port);
+
+        if (!m_protocol->Connect(addr, true)) // Watcom needs the 2nd arg for some reason
+        {
+            m_error = wxURL_CONNERR;
+            return NULL;
+        }
+    }
+#endif
+
+    wxString fullPath;

 
 

-  // Retrieve user and password.
-  pos2 = temp_url.Find('@');
-  // Even if pos2 equals -1, this code is right.
-  m_hostname = temp_url(pos2+1, temp_url.Length());
+    // When we use a proxy, we have to pass the whole URL to it.
+    if (m_useProxy)
+        fullPath += m_url;

 
 

-  m_user = "";
-  m_password = "";
+    if(m_path.empty())
+        fullPath += wxT("/");
+    else
+        fullPath += m_path;

 
 

-  if (pos2 == -1)
-    return TRUE;
+    if (HasQuery())
+        fullPath += wxT("?") + m_query;

 
 

-  temp_url = temp_url(0, pos2);
-  pos2 = temp_url.Find(':');
+    if (HasFragment())
+        fullPath += wxT("#") + m_fragment;

 
 

-  if (pos2 == -1)
-    return FALSE;
+    wxInputStream *the_i_stream = m_protocol->GetInputStream(fullPath);

 
 

-  m_user = temp_url(0, pos2);
-  m_password = temp_url(pos2+1, url.Length());
+    if (!the_i_stream)
+    {
+        m_error = wxURL_PROTOERR;
+        return NULL;
+    }

 
 

-  return TRUE;
+    return the_i_stream;

 }
 
 }
 

-bool wxURL::PrepPath(wxString& url)
+#if wxUSE_PROTOCOL_HTTP
+void wxURL::SetDefaultProxy(const wxString& url_proxy)

 {
 {

-  if (url.Length() != 0)
-    m_path = url;
-  else
-    m_path = "/";
-  return TRUE;
+    if ( !url_proxy )
+    {
+        if ( ms_proxyDefault )
+        {
+            ms_proxyDefault->Close();
+            delete ms_proxyDefault;
+            ms_proxyDefault = NULL;
+        }
+    }
+    else
+    {
+        wxString tmp_str = url_proxy;
+        int pos = tmp_str.Find(wxT(':'));
+        if (pos == wxNOT_FOUND)
+            return;
+
+        wxString hostname = tmp_str(0, pos),
+        port = tmp_str(pos+1, tmp_str.length()-pos);
+        wxIPV4address addr;
+
+        if (!addr.Hostname(hostname))
+            return;
+        if (!addr.Service(port))
+            return;
+
+        if (ms_proxyDefault)
+            // Finally, when all is right, we connect the new proxy.
+            ms_proxyDefault->Close();
+        else
+            ms_proxyDefault = new wxHTTP();
+        ms_proxyDefault->Connect(addr, true); // Watcom needs the 2nd arg for some reason
+    }

 }
 
 }
 

-bool wxURL::FetchProtocol()
+void wxURL::SetProxy(const wxString& url_proxy)

 {
 {

-  wxProtoInfo *info = g_protocols;
-
-  while (info) {
-    if (m_protoname == info->m_protoname) {
-      if (m_servname.IsNull())
-        m_servname = info->m_servname;
+    if ( !url_proxy )
+    {
+        if ( m_proxy && m_proxy != ms_proxyDefault )
+        {
+            m_proxy->Close();
+            delete m_proxy;
+        }

 
 

-      m_protoinfo = info;
-      m_protocol = (wxProtocol *)m_protoinfo->m_cinfo->CreateObject();
-      wxSocketHandler::Master().Register(m_protocol);
-      return TRUE;
+        m_useProxy = false;
+    }
+    else
+    {
+        wxString tmp_str;
+        wxString hostname, port;
+        int pos;
+        wxIPV4address addr;
+
+        tmp_str = url_proxy;
+        pos = tmp_str.Find(wxT(':'));
+        // This is an invalid proxy name.
+        if (pos == wxNOT_FOUND)
+            return;
+
+        hostname = tmp_str(0, pos);
+        port = tmp_str(pos+1, tmp_str.length()-pos);
+
+        addr.Hostname(hostname);
+        addr.Service(port);
+
+        // Finally, create the whole stuff.
+        if (m_proxy && m_proxy != ms_proxyDefault)
+            delete m_proxy;
+        m_proxy = new wxHTTP();
+        m_proxy->Connect(addr, true); // Watcom needs the 2nd arg for some reason
+
+        CleanData();
+        // Reparse url.
+        m_useProxy = true;
+        ParseURL();

     }
     }

-    info = info->next;
-  }
-  return FALSE;

 }
 }

+#endif // wxUSE_PROTOCOL_HTTP

 
 

-/*
- * --------------------------------------------------------------
- * --------- wxURL get ------------------------------------------
- * --------------------------------------------------------------
- */
-wxInputStream *wxURL::GetInputStream(void)
-{
-  wxIPV4address addr;
-  wxInputStream *the_i_stream = NULL;
+// ----------------------------------------------------------------------
+// wxURLModule
+//
+// A module which deletes the default proxy if we created it
+// ----------------------------------------------------------------------

 
 

-  if (!m_protocol)
-    if (!ParseURL())
-      return NULL;
+#if wxUSE_SOCKETS

 
 

-  if (!m_protocol) {
-    m_error = wxURL_NOPROTO;
-    return NULL;
-  }
+class wxURLModule : public wxModule
+{
+public:
+    virtual bool OnInit();
+    virtual void OnExit();

 
 

-  m_error = wxURL_NOERR;
-  if (m_user != "") {
-    m_protocol->SetUser(m_user);
-    m_protocol->SetPassword(m_password);
-  }
+private:
+    DECLARE_DYNAMIC_CLASS(wxURLModule)
+};

 
 

-  if (m_protoinfo->m_needhost) {
-    if (!addr.Hostname(m_hostname)) {
-      m_error = wxURL_NOHOST;
-      return NULL;
-    }
+IMPLEMENT_DYNAMIC_CLASS(wxURLModule, wxModule)

 
 

-    addr.Service(m_servname);
+bool wxURLModule::OnInit()
+{
+#if wxUSE_PROTOCOL_HTTP
+    // env var HTTP_PROXY contains the address of the default proxy to use if
+    // set, but don't try to create this proxy right now because it will slow
+    // down the program startup (especially if there is no DNS server
+    // available, in which case it may take up to 1 minute)

 
 

-    if (!m_protocol->Connect(addr, TRUE)) // Watcom needs the 2nd arg for some reason
+    if ( wxGetenv(_T("HTTP_PROXY")) )

     {
     {

-      m_error = wxURL_CONNERR;
-      return NULL;
+        wxURL::ms_useDefaultProxy = true;

     }
     }

-  }
-
-  the_i_stream = m_protocol->GetInputStream(m_path);
-  if (!the_i_stream) {
-    m_error = wxURL_PROTOERR;
-    return NULL;
-  }
-
-  return the_i_stream;
+#endif // wxUSE_PROTOCOL_HTTP
+    return true;

 }
 
 }
 

-void wxURL::SetDefaultProxy(const wxString& url_proxy)
+void wxURLModule::OnExit()

 {
 {

-  g_proxy->Close();
+#if wxUSE_PROTOCOL_HTTP
+    delete wxURL::ms_proxyDefault;
+    wxURL::ms_proxyDefault = NULL;
+#endif // wxUSE_PROTOCOL_HTTP
+}
+
+#endif // wxUSE_SOCKETS

 
 

-  if (url_proxy.IsNull())
-    return;
+// ---------------------------------------------------------------------------
+//
+//                        wxURL Compatibility
+//
+// ---------------------------------------------------------------------------

 
 

-  wxString tmp_str = url_proxy;
-  int pos = tmp_str.Find(':');
-  wxString hostname = tmp_str(0, pos),
-           port = tmp_str(pos, tmp_str.Length()-pos);
-  wxIPV4address addr;
+#if WXWIN_COMPATIBILITY_2_4

 
 

-  addr.Hostname(hostname);
-  addr.Service(port);
-  
-  g_proxy->Connect(addr, TRUE); // Watcom needs the 2nd arg for some reason
+#include "wx/url.h"
+
+wxString wxURL::GetProtocolName() const
+{
+    return m_scheme;

 }
 
 }
 

-void wxURL::SetProxy(const wxString& url_proxy)
+wxString wxURL::GetHostName() const

 {
 {

-  if (url_proxy.IsNull()) {
-    m_proxy.Close();
-    return;
-  }
+    return m_server;
+}

 
 

-  CleanData();
+wxString wxURL::GetPath() const
+{
+    return m_path;
+}

 
 

-  wxString tmp_str;
-  wxString hostname, port;
-  int pos;
-  wxIPV4address addr;
+//Note that this old code really doesn't convert to a URI that well and looks
+//more like a dirty hack than anything else...

 
 

-  tmp_str = url_proxy;
-  pos = tmp_str.Find(':');
-  hostname = tmp_str(0, pos);
-  port = tmp_str(pos, tmp_str.Length()-pos);
+wxString wxURL::ConvertToValidURI(const wxString& uri, const wxChar* delims)
+{
+  wxString out_str;
+  wxString hexa_code;
+  size_t i;

 
 

-  addr.Hostname(hostname);
-  addr.Service(port);
+  for (i = 0; i < uri.Len(); i++)
+  {
+    wxChar c = uri.GetChar(i);

 
 

-  m_proxy.Connect(addr, TRUE); // Watcom needs the 2nd arg for some reason
+    if (c == wxT(' '))
+    {
+      // GRG, Apr/2000: changed to "%20" instead of '+'

 
 

-  m_protocol = &m_proxy;
-  m_protoname = "proxy";
-  m_path = url_proxy;
+      out_str += wxT("%20");
+    }
+    else
+    {
+      // GRG, Apr/2000: modified according to the URI definition (RFC 2396)
+      //
+      // - Alphanumeric characters are never escaped
+      // - Unreserved marks are never escaped
+      // - Delimiters must be escaped if they appear within a component
+      //     but not if they are used to separate components. Here we have
+      //     no clear way to distinguish between these two cases, so they
+      //     are escaped unless they are passed in the 'delims' parameter
+      //     (allowed delimiters).
+
+      static const wxChar marks[] = wxT("-_.!~*()'");
+
+      if ( !wxIsalnum(c) && !wxStrchr(marks, c) && !wxStrchr(delims, c) )
+      {
+        hexa_code.Printf(wxT("%%%02X"), c);
+        out_str += hexa_code;
+      }
+      else
+      {
+        out_str += c;
+      }
+    }
+  }
+
+  return out_str;
+}
+
+wxString wxURL::ConvertFromURI(const wxString& uri)
+{
+    return wxURI::Unescape(uri);

 }
 }

+
+#endif //WXWIN_COMPATIBILITY_2_4
+
+#endif // wxUSE_URL