Changeset 74431 in vbox for trunk/src/VBox/Main/xml

Timestamp:

Sep 24, 2018 9:16:17 AM (7 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

125272

Message:

Main,GUI,VBoxManage: Provide API for proxy settings that picks up the current GUI settings and converts it to SystemProperties XML attributes. Adjusted GUI to use it. Updated VBoxMangage system properties handling accordingly. bugref:9249

File:

• trunk/src/VBox/Main/xml/Settings.cpp (modified) (7 diffs)

trunk/src/VBox/Main/xml/Settings.cpp

@@ -79 +79 @@
 #include <iprt/ldr.h>
 #include <iprt/base64.h>
+#include <iprt/uri.h>
 #include <iprt/cpp/lock.h>
 
@@ -1579 +1580 @@
  * Constructor. Needs to set sane defaults which stand the test of time.
  */
-SystemProperties::SystemProperties() :
-    ulLogHistoryCount(3),
-    fExclusiveHwVirt(true)
+SystemProperties::SystemProperties()
+    : uLogHistoryCount(3)
+    , uProxyMode(ProxyMode_System)
+    , fExclusiveHwVirt(true)
 {
 #if defined(RT_OS_DARWIN) || defined(RT_OS_WINDOWS) || defined(RT_OS_SOLARIS)
@@ -1867 +1869 @@
 
 /**
+ * Converts old style Proxy settings from ExtraData/UI section.
+ *
+ * Saves proxy settings directly to systemProperties structure.
+ *
+ * @returns true if conversion was successfull, false if not.
+ * @param strUIProxySettings The GUI settings string to convert.
+ */
+bool MainConfigFile::convertGuiProxySettings(const com::Utf8Str &strUIProxySettings)
+{
+    /*
+     * Possible variants:
+     *    - "ProxyAuto,proxyserver.url,1080,authDisabled,,"
+     *    - "ProxyDisabled,proxyserver.url,1080,authDisabled,,"
+     *    - "ProxyEnabled,proxyserver.url,1080,authDisabled,,"
+     *
+     * Note! We only need to bother with the first three fields as the last
+     *       three was never really used or ever actually passed to the HTTP
+     *       client code.
+     */
+    /* First field: The proxy mode. */
+    const char *psz = RTStrStripL(strUIProxySettings.c_str());
+    static const struct { const char *psz; size_t cch; ProxyMode_T enmMode; } s_aModes[] =
+    {
+        { RT_STR_TUPLE("ProxyAuto"),     ProxyMode_System },
+        { RT_STR_TUPLE("ProxyDisabled"), ProxyMode_NoProxy },
+        { RT_STR_TUPLE("ProxyEnabled"),  ProxyMode_Manual },
+    };
+    for (size_t i = 0; i < RT_ELEMENTS(s_aModes); i++)
+        if (RTStrNICmpAscii(psz, s_aModes[i].psz, s_aModes[i].cch) == 0)
+        {
+            systemProperties.uProxyMode = s_aModes[i].enmMode;
+            psz = RTStrStripL(psz + s_aModes[i].cch);
+            if (*psz == ',')
+            {
+                /* Second field: The proxy host, possibly fully fledged proxy URL. */
+                psz = RTStrStripL(psz + 1);
+                if (*psz != '\0' && *psz != ',')
+                {
+                    const char *pszEnd  = strchr(psz, ',');
+                    size_t      cchHost = pszEnd ? pszEnd - psz : strlen(psz);
+                    while (cchHost > 0 && RT_C_IS_SPACE(psz[cchHost - 1]))
+                        cchHost--;
+                    systemProperties.strProxyUrl.assign(psz, cchHost);
+                    if (systemProperties.strProxyUrl.find("://") == RTCString::npos)
+                        systemProperties.strProxyUrl.replace(0, 0, "http://");
+
+                    /* Third field: The proxy port. Defaulted to 1080 for all proxies.
+                                    The new settings has type specific default ports.  */
+                    uint16_t uPort = 1080;
+                    if (pszEnd)
+                    {
+                        int rc = RTStrToUInt16Ex(RTStrStripL(pszEnd + 1), NULL, 10, &uPort);
+                        if (RT_FAILURE(rc))
+                            uPort = 1080;
+                    }
+                    RTURIPARSED Parsed;
+                    int rc = RTUriParse(systemProperties.strProxyUrl.c_str(), &Parsed);
+                    if (RT_SUCCESS(rc))
+                    {
+                        if (Parsed.uAuthorityPort == UINT32_MAX)
+                            systemProperties.strProxyUrl.appendPrintf(systemProperties.strProxyUrl.endsWith(":")
+                                                                      ? "%u" : ":%u", uPort);
+                    }
+                    else
+                    {
+                        LogRelFunc(("Dropping invalid proxy URL for %u: %s\n",
+                                    systemProperties.uProxyMode, systemProperties.strProxyUrl.c_str()));
+                        systemProperties.strProxyUrl.setNull();
+                    }
+                }
+                /* else: don't bother with the rest if we haven't got a host. */
+            }
+            if (   systemProperties.strProxyUrl.isEmpty()
+                && systemProperties.uProxyMode == ProxyMode_Manual)
+            {
+                systemProperties.uProxyMode = ProxyMode_System;
+                return false;
+            }
+            return true;
+        }
+    LogRelFunc(("Unknown proxy type: %s\n", psz));
+    return false;
+}
+
+/**
  * Constructor.
  *
@@ -1888 +1975 @@
         xml::NodesLoop nlRootChildren(*m->pelmRoot);
         const xml::ElementNode *pelmRootChild;
+        bool fCopyProxySettingsFromExtraData = false;
         while ((pelmRootChild = nlRootChildren.forAllNodes()))
         {
@@ -1906 +1994 @@
                         pelmGlobalChild->getAttributeValue("webServiceAuthLibrary", systemProperties.strWebServiceAuthLibrary);
                         pelmGlobalChild->getAttributeValue("defaultVRDEExtPack", systemProperties.strDefaultVRDEExtPack);
-                        pelmGlobalChild->getAttributeValue("LogHistoryCount", systemProperties.ulLogHistoryCount);
+                        pelmGlobalChild->getAttributeValue("LogHistoryCount", systemProperties.uLogHistoryCount);
                         pelmGlobalChild->getAttributeValue("autostartDatabasePath", systemProperties.strAutostartDatabasePath);
                         pelmGlobalChild->getAttributeValue("defaultFrontend", systemProperties.strDefaultFrontend);
                         pelmGlobalChild->getAttributeValue("exclusiveHwVirt", systemProperties.fExclusiveHwVirt);
+                        if (!pelmGlobalChild->getAttributeValue("proxyMode", systemProperties.uProxyMode))
+                            fCopyProxySettingsFromExtraData = true;
+                        pelmGlobalChild->getAttributeValue("proxyUrl", systemProperties.strProxyUrl);
                     }
                     else if (pelmGlobalChild->nameEquals("ExtraData"))
@@ -1941 +2032 @@
         }
 
+        if (fCopyProxySettingsFromExtraData)
+            for (StringsMap::const_iterator it = mapExtraDataItems.begin(); it != mapExtraDataItems.end(); ++it)
+                if (it->first.equals("GUI/ProxySettings"))
+                {
+                    convertGuiProxySettings(it->second);
+                    break;
+                }
+
         clearDocument();
     }
@@ -2141 +2240 @@
     if (systemProperties.strDefaultVRDEExtPack.length())
         pelmSysProps->setAttribute("defaultVRDEExtPack", systemProperties.strDefaultVRDEExtPack);
-    pelmSysProps->setAttribute("LogHistoryCount", systemProperties.ulLogHistoryCount);
+    pelmSysProps->setAttribute("LogHistoryCount", systemProperties.uLogHistoryCount);
     if (systemProperties.strAutostartDatabasePath.length())
         pelmSysProps->setAttribute("autostartDatabasePath", systemProperties.strAutostartDatabasePath);
     if (systemProperties.strDefaultFrontend.length())
         pelmSysProps->setAttribute("defaultFrontend", systemProperties.strDefaultFrontend);
+    if (systemProperties.strProxyUrl.length())
+        pelmSysProps->setAttribute("proxyUrl", systemProperties.strProxyUrl);
+    pelmSysProps->setAttribute("proxyMode", systemProperties.uProxyMode);
     pelmSysProps->setAttribute("exclusiveHwVirt", systemProperties.fExclusiveHwVirt);