Minor corrections to wxFlexGridSizer ctor documentation.

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

diff --git a/src/common/url.cpp b/src/common/url.cpp
index cbe5866c76ee9705d5afd6e5feef10ae8f3feb94..cbca1ffeb3742858085cb15c53e92479aae99dae 100644 (file)
--- a/src/common/url.cpp
+++ b/src/common/url.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     URL parser
 // Author:      Guilhem Lavaux
 // Modified by:
 // Purpose:     URL parser
 // Author:      Guilhem Lavaux
 // Modified by:


@@ -9,30 +9,28 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#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
 
 #if wxUSE_URL
 
 #endif
 
 #if wxUSE_URL
 

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

 #include "wx/url.h"
 
 #include "wx/url.h"
 

+#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>
 
 #include <string.h>
 #include <ctype.h>
 

-IMPLEMENT_CLASS(wxProtoInfo, wxObject)
-IMPLEMENT_CLASS(wxURL, wxObject)
+IMPLEMENT_CLASS(wxURL, wxURI)

 
 // Protocols list
 wxProtoInfo *wxURL::ms_protocols = NULL;
 
 // Protocols list
 wxProtoInfo *wxURL::ms_protocols = NULL;


@@ -40,23 +38,40 @@ wxProtoInfo *wxURL::ms_protocols = NULL;
 // Enforce linking of protocol classes:
 USE_PROTOCOL(wxFileProto)
 
 // Enforce linking of protocol classes:
 USE_PROTOCOL(wxFileProto)
 

-#if wxUSE_SOCKETS
+#if wxUSE_PROTOCOL_HTTP

 USE_PROTOCOL(wxHTTP)
 USE_PROTOCOL(wxHTTP)

-USE_PROTOCOL(wxFTP)

 
     wxHTTP *wxURL::ms_proxyDefault = NULL;
     bool wxURL::ms_useDefaultProxy = false;
 #endif
 
 
     wxHTTP *wxURL::ms_proxyDefault = NULL;
     bool wxURL::ms_useDefaultProxy = false;
 #endif
 

+#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)
+{
+    Init(url);
+    ParseURL();
+}
+
+wxURL::wxURL(const wxURI& url) : wxURI(url)
+{
+    Init(url.BuildURI());
+    ParseURL();
+}
+
+void wxURL::Init(const wxString& url)

 {
     m_protocol = NULL;
     m_error = wxURL_NOERR;
 {
     m_protocol = NULL;
     m_error = wxURL_NOERR;


@@ -65,7 +80,7 @@ wxURL::wxURL(const wxString& url)
     m_nativeImp = CreateNativeImpObject();
 #endif
 
     m_nativeImp = CreateNativeImpObject();
 #endif
 

-#if wxUSE_SOCKETS
+#if wxUSE_PROTOCOL_HTTP

     if ( ms_useDefaultProxy && !ms_proxyDefault )
     {
         SetDefaultProxy( wxGetenv(wxT("HTTP_PROXY")) );
     if ( ms_useDefaultProxy && !ms_proxyDefault )
     {
         SetDefaultProxy( wxGetenv(wxT("HTTP_PROXY")) );


@@ -79,302 +94,265 @@ wxURL::wxURL(const wxString& url)
 
     m_useProxy = ms_proxyDefault != NULL;
     m_proxy = ms_proxyDefault;
 
     m_useProxy = ms_proxyDefault != NULL;
     m_proxy = ms_proxyDefault;

-#endif // wxUSE_SOCKETS
+#endif // wxUSE_PROTOCOL_HTTP

 
 

+}
+
+// --------------------------------------------------------------
+// Assignment
+// --------------------------------------------------------------
+
+wxURL& wxURL::operator = (const wxURI& url)
+{
+    wxURI::operator = (url);
+    Init(url.BuildURI());
+    ParseURL();
+    return *this;
+}
+wxURL& wxURL::operator = (const wxString& url)
+{
+    wxURI::operator = (url);
+    Init(url);

     ParseURL();
     ParseURL();

+    return *this;

 }
 
 }
 

+// --------------------------------------------------------------
+// ParseURL
+//
+// Builds the URL and takes care of the old protocol stuff
+// --------------------------------------------------------------
+

 bool wxURL::ParseURL()
 {
 bool wxURL::ParseURL()
 {

-  wxString last_url = m_url;
+    // If the URL was already parsed (m_protocol != NULL), pass this section.
+    if (!m_protocol)
+    {
+        // Clean up
+        CleanData();

 
 

-  // 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;
+        }

 
 

-    // Extract protocol name
-    if (!PrepProto(last_url))
-    {
-      m_error = wxURL_SNTXERR;
-      return false;
-    }
+        // Find and create the protocol object
+        if (!FetchProtocol())
+        {
+            m_error = wxURL_NOPROTO;
+            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;
+            }
+        }

     }
 
     }
 

-    // Do we need a host name ?
-    if (m_protoinfo->m_needhost)
+#if wxUSE_PROTOCOL_HTTP
+    if (m_useProxy)

     {
     {

-      // Extract it
-      if (!PrepHost(last_url))
-      {
-        m_error = wxURL_SNTXERR;
-        return false;
-      }
-    }
+        // Third, we rebuild the URL.
+        m_url = m_scheme + wxT(":");
+        if (m_protoinfo->m_needhost)
+            m_url = m_url + wxT("//") + m_server;

 
 

-    // Extract full path
-    if (!PrepPath(last_url))
-    {
-      m_error = wxURL_NOPATH;
-      return false;
+        // We initialize specific variables.
+        m_protocol = m_proxy; // FIXME: we should clone the protocol

     }
     }

-  }
-  // URL parse finished.
-
-#if wxUSE_SOCKETS
-  if (m_useProxy)
-  {
-    // destroy the previously created protocol as we'll be using m_proxy
-    delete m_protocol;
-
-    // Third, we rebuild the URL.
-    m_url = m_protoname + wxT(":");
-    if (m_protoinfo->m_needhost)
-      m_url = m_url + wxT("//") + m_hostname;
-
-    m_url += m_path;
-
-    // We initialize specific variables.
-    m_protocol = m_proxy; // FIXME: we should clone the protocol
-  }
-#endif
+#endif // wxUSE_PROTOCOL_HTTP

 
 

-  m_error = wxURL_NOERR;
-  return true;
+    m_error = wxURL_NOERR;
+    return true;

 }
 
 }
 

+// --------------------------------------------------------------
+// Destruction/Cleanup
+// --------------------------------------------------------------
+

 void wxURL::CleanData()
 {
 void wxURL::CleanData()
 {

-#if wxUSE_SOCKETS
-  if (!m_useProxy)
-#endif
-    delete m_protocol;
+#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();

 }
 
 wxURL::~wxURL()
 {
     CleanData();
 }
 
 wxURL::~wxURL()
 {
     CleanData();

-#if wxUSE_SOCKETS
+#if wxUSE_PROTOCOL_HTTP

     if (m_proxy && m_proxy != ms_proxyDefault)
         delete m_proxy;
     if (m_proxy && m_proxy != ms_proxyDefault)
         delete m_proxy;

-#endif
+#endif // wxUSE_PROTOCOL_HTTP

 #if wxUSE_URL_NATIVE
     delete m_nativeImp;
 #endif
 }
 
 // --------------------------------------------------------------
 #if wxUSE_URL_NATIVE
     delete m_nativeImp;
 #endif
 }
 
 // --------------------------------------------------------------

-// --------- wxURL urls decoders --------------------------------
+// FetchProtocol

 // --------------------------------------------------------------
 
 // --------------------------------------------------------------
 

-bool wxURL::PrepProto(wxString& url)
+bool wxURL::FetchProtocol()

 {
 {

-  int pos;
+    wxProtoInfo *info = ms_protocols;

 
 

-  // Find end
-  pos = url.Find(wxT(':'));
-  if (pos == wxNOT_FOUND)
+    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;
     return false;

-
-  m_protoname = url(0, pos);
-
-  url = url(pos+1, url.Length());
-
-  return true;

 }
 
 }
 

-bool wxURL::PrepHost(wxString& url)
-{
-  wxString temp_url;
-  int pos, pos2;
-
-  if ((url.GetChar(0) != wxT('/')) || (url.GetChar(1) != wxT('/')))
-    return false;
+// --------------------------------------------------------------
+// GetInputStream
+// --------------------------------------------------------------

 
 

-  url = url(2, url.Length());
+wxInputStream *wxURL::GetInputStream()
+{
+    if (!m_protocol)
+    {
+        m_error = wxURL_NOPROTO;
+        return NULL;
+    }

 
 

-  pos = url.Find(wxT('/'));
-  if (pos == wxNOT_FOUND)
-    pos = url.Length();
+    m_error = wxURL_NOERR;
+    if (HasUserInfo())
+    {
+        size_t dwPasswordPos = m_userinfo.find(':');

 
 

-  if (pos == 0)
-    return false;
+        if (dwPasswordPos == wxString::npos)
+            m_protocol->SetUser(Unescape(m_userinfo));
+        else
+        {
+            m_protocol->SetUser(Unescape(m_userinfo(0, dwPasswordPos)));
+            m_protocol->SetPassword(Unescape(m_userinfo(dwPasswordPos+1, m_userinfo.length() + 1)));
+        }
+    }

 
 

-  temp_url = url(0, pos);
-  url = url(url.Find(wxT('/')), url.Length());
+#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

 
 

-  // Retrieve service number
-  pos2 = temp_url.Find(wxT(':'), true);
-  if (pos2 != wxNOT_FOUND && pos2 < pos)
-  {
-    m_servname = temp_url(pos2+1, pos);
-    if (!m_servname.IsNumber())
-      return false;
-    temp_url = temp_url(0, pos2);
-  }
+#if wxUSE_SOCKETS
+    wxIPV4address addr;

 
 

-  // Retrieve user and password.
-  pos2 = temp_url.Find(wxT('@'));
-  // Even if pos2 equals wxNOT_FOUND, this code is right.
-  m_hostname = temp_url(pos2+1, temp_url.Length());
+    // m_protoinfo is NULL when we use a proxy
+    if (
+#if wxUSE_PROTOCOL_HTTP
+         !m_useProxy &&
+#endif // wxUSE_PROTOCOL_HTTP
+         m_protoinfo->m_needhost )
+    {
+        if (!addr.Hostname(m_server))
+        {
+            m_error = wxURL_NOHOST;
+            return NULL;
+        }

 
 

-  m_user = wxT("");
-  m_password = wxT("");
+        addr.Service(m_port);

 
 

-  if (pos2 == wxNOT_FOUND)
-    return true;
+        if (!m_protocol->Connect(addr, true)) // Watcom needs the 2nd arg for some reason
+        {
+            m_error = wxURL_CONNERR;
+            return NULL;
+        }
+    }
+#endif // wxUSE_SOCKETS

 
 

-  temp_url = temp_url(0, pos2);
-  pos2 = temp_url.Find(wxT(':'));
+    wxString fullPath;

 
 

-  if (pos2 == wxNOT_FOUND)
-    return false;
+#if wxUSE_PROTOCOL_HTTP
+    // When we use a proxy, we have to pass the whole URL to it.
+    if (m_useProxy)
+        fullPath += m_url;
+#endif // wxUSE_PROTOCOL_HTTP

 
 

-  m_user = temp_url(0, pos2);
-  m_password = temp_url(pos2+1, url.Length());
+    if(m_path.empty())
+        fullPath += wxT("/");
+    else
+        fullPath += m_path;

 
 

-  return true;
-}
+    if (HasQuery())
+        fullPath += wxT("?") + m_query;

 
 

-bool wxURL::PrepPath(wxString& url)
-{
-  if (url.Length() != 0)
-    m_path = ConvertToValidURI(url);
-  else
-    m_path = wxT("/");
-  return true;
-}
+    if (HasFragment())
+        fullPath += wxT("#") + m_fragment;

 
 

-bool wxURL::FetchProtocol()
-{
-  wxProtoInfo *info = ms_protocols;
+    wxInputStream *the_i_stream = m_protocol->GetInputStream(fullPath);

 
 

-  while (info)
-  {
-    if (m_protoname == info->m_protoname)
+    if (!the_i_stream)

     {
     {

-      if (m_servname.IsNull())
-        m_servname = info->m_servname;
-
-      m_protoinfo = info;
-      m_protocol = (wxProtocol *)m_protoinfo->m_cinfo->CreateObject();
-      return true;
+        m_error = wxURL_PROTOERR;
+        return NULL;

     }
     }

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

 
 

-// --------------------------------------------------------------
-// --------- wxURL get ------------------------------------------
-// --------------------------------------------------------------
+    return the_i_stream;
+}

 
 

-wxInputStream *wxURL::GetInputStream()
+#if wxUSE_PROTOCOL_HTTP
+void wxURL::SetDefaultProxy(const wxString& url_proxy)

 {
 {

-  if (!m_protocol)
-  {
-    m_error = wxURL_NOPROTO;
-    return NULL;
-  }
-
-  m_error = wxURL_NOERR;
-  if (m_user != wxT(""))
-  {
-    m_protocol->SetUser(m_user);
-    m_protocol->SetPassword(m_password);
-  }
-
-#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_hostname))
+    if ( !url_proxy )

     {
     {

-      m_error = wxURL_NOHOST;
-      return NULL;
+        if ( ms_proxyDefault )
+        {
+            ms_proxyDefault->Close();
+            delete ms_proxyDefault;
+            ms_proxyDefault = NULL;
+        }

     }
     }

-
-    addr.Service(m_servname);
-
-    if (!m_protocol->Connect(addr, true)) // Watcom needs the 2nd arg for some reason
+    else

     {
     {

-      m_error = wxURL_CONNERR;
-      return NULL;
-    }
-  }
-#endif
-
-  // When we use a proxy, we have to pass the whole URL to it.
-  wxInputStream *the_i_stream =
-       (m_useProxy) ? m_protocol->GetInputStream(m_url) :
-                      m_protocol->GetInputStream(m_path);
+        wxString tmp_str = url_proxy;
+        int pos = tmp_str.Find(wxT(':'));
+        if (pos == wxNOT_FOUND)
+            return;

 
 

-  if (!the_i_stream)
-  {
-    m_error = wxURL_PROTOERR;
-    return NULL;
-  }
+        wxString hostname = tmp_str(0, pos),
+        port = tmp_str(pos+1, tmp_str.length()-pos);
+        wxIPV4address addr;

 
 

-  return the_i_stream;
-}
+        if (!addr.Hostname(hostname))
+            return;
+        if (!addr.Service(port))
+            return;

 
 

-#if wxUSE_SOCKETS
-void wxURL::SetDefaultProxy(const wxString& url_proxy)
-{
-  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
-  }
+        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
+    }

 }
 
 void wxURL::SetProxy(const wxString& url_proxy)
 }
 
 void wxURL::SetProxy(const wxString& url_proxy)


@@ -403,7 +381,7 @@ void wxURL::SetProxy(const wxString& url_proxy)
             return;
 
         hostname = tmp_str(0, pos);
             return;
 
         hostname = tmp_str(0, pos);

-        port = tmp_str(pos+1, tmp_str.Length()-pos);
+        port = tmp_str(pos+1, tmp_str.length()-pos);

 
         addr.Hostname(hostname);
         addr.Service(port);
 
         addr.Hostname(hostname);
         addr.Service(port);


@@ -420,9 +398,11 @@ void wxURL::SetProxy(const wxString& url_proxy)
         ParseURL();
     }
 }
         ParseURL();
     }
 }

-#endif // wxUSE_SOCKETS
+#endif // wxUSE_PROTOCOL_HTTP

 
 // ----------------------------------------------------------------------
 
 // ----------------------------------------------------------------------

+// wxURLModule
+//

 // A module which deletes the default proxy if we created it
 // ----------------------------------------------------------------------
 
 // A module which deletes the default proxy if we created it
 // ----------------------------------------------------------------------
 


@@ -431,6 +411,8 @@ void wxURL::SetProxy(const wxString& url_proxy)
 class wxURLModule : public wxModule
 {
 public:
 class wxURLModule : public wxModule
 {
 public:

+    wxURLModule();
+

     virtual bool OnInit();
     virtual void OnExit();
 
     virtual bool OnInit();
     virtual void OnExit();
 


@@ -440,28 +422,38 @@ private:
 
 IMPLEMENT_DYNAMIC_CLASS(wxURLModule, wxModule)
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxURLModule, wxModule)
 

+wxURLModule::wxURLModule()
+{
+    // we must be cleaned up before wxSocketModule as otherwise deleting
+    // ms_proxyDefault from our OnExit() won't work (and can actually crash)
+    AddDependency(wxClassInfo::FindClass(wxT("wxSocketModule")));
+}
+

 bool wxURLModule::OnInit()
 {
 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)
 
     // 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 ( getenv("HTTP_PROXY") )
+    if ( wxGetenv(wxT("HTTP_PROXY")) )

     {
         wxURL::ms_useDefaultProxy = true;
     }
     {
         wxURL::ms_useDefaultProxy = true;
     }

-
+#endif // wxUSE_PROTOCOL_HTTP

     return true;
 }
 
 void wxURLModule::OnExit()
 {
     return true;
 }
 
 void wxURLModule::OnExit()
 {

+#if wxUSE_PROTOCOL_HTTP

     delete wxURL::ms_proxyDefault;
     wxURL::ms_proxyDefault = NULL;
     delete wxURL::ms_proxyDefault;
     wxURL::ms_proxyDefault = NULL;

+#endif // wxUSE_PROTOCOL_HTTP

 }
 
 #endif // wxUSE_SOCKETS
 
 }
 
 #endif // wxUSE_SOCKETS
 

-#endif // wxUSE_URL

 
 

+#endif // wxUSE_URL