Changeset 94756 in vbox for trunk/src/VBox/Main/src-server/UpdateAgentImpl.cpp

Timestamp:

Apr 29, 2022 8:55:44 AM (3 years ago)

Author:

vboxsync

Message:

Main/VBoxManage/Update check: More code + docs for proxy settings handling. bugref:7983

File:

• trunk/src/VBox/Main/src-server/UpdateAgentImpl.cpp (modified) (11 diffs)

trunk/src/VBox/Main/src-server/UpdateAgentImpl.cpp

@@ -43 +43 @@
 #include "VirtualBoxImpl.h"
 #include "VBoxEvents.h"
+#include "SystemPropertiesImpl.h"
 #include "ThreadTask.h"
 #include "VirtualBoxImpl.h"
@@ -265 +266 @@
 }
 
+/**
+ * Returns the proxy mode as a string.
+ *
+ * @returns Proxy mode as string.
+ * @param   enmMode             Proxy mode to return as string.
+ */
+/* static */
+const char *UpdateAgentBase::i_proxyModeToStr(ProxyMode_T enmMode)
+{
+    switch (enmMode)
+    {
+        case ProxyMode_System:  return "System";
+        case ProxyMode_Manual:  return "Manual";
+        case ProxyMode_NoProxy: return "None";
+        default:                break;
+    }
+
+    AssertFailed();
+    return "<Invalid>";
+}
+
 
 /*********************************************************************************************************************************
@@ -296 +318 @@
     HRESULT hr = unconst(m_EventSource).createObject();
     if (SUCCEEDED(hr))
+    {
         hr = m_EventSource->init();
+        if (SUCCEEDED(hr))
+            mData.m_fUseOwnProxy = false;
+    }
 
     return hr;
@@ -522 +548 @@
     AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    *aMode = m->enmProxyMode;
-
-    return S_OK;
+    return i_getProxyMode(aMode);
 }
 
@@ -532 +556 @@
 
     m->enmProxyMode = aMode;
+    mData.m_fUseOwnProxy = true;
 
     return i_commitSettings(alock);
@@ -540 +565 @@
     AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    aAddress = m->strProxyUrl;
-
-    return S_OK;
+    return i_getProxyURL(aAddress);
 }
 
@@ -550 +573 @@
 
     m->strProxyUrl = aAddress;
+    mData.m_fUseOwnProxy = true;
 
     return i_commitSettings(alock);
@@ -677 +701 @@
     data = *m;
 
+    /* Cancel out eventually set proxy settings if those were not explicitly set.
+     * This way the ISystemProperties proxy settings will be used then. */
+    if (!mData.m_fUseOwnProxy)
+    {
+        data.strProxyUrl  = "";
+        data.enmProxyMode = ProxyMode_System;
+    }
+
     return S_OK;
 }
@@ -731 +763 @@
     AutoWriteLock vboxLock(m_VirtualBox COMMA_LOCKVAL_SRC_POS);
     return m_VirtualBox->i_saveSettings();
+}
+
+/**
+ * Returns the proxy mode to use.
+ *
+ * @returns HRESULT
+ * @param   aMode               Where to return the proxy mode.
+ */
+HRESULT UpdateAgent::i_getProxyMode(ProxyMode_T *aMode)
+{
+    HRESULT hrc;
+
+    if (!mData.m_fUseOwnProxy) /* If not explicitly set, use the ISystemProperties proxy settings. */
+    {
+        ComPtr<ISystemProperties> pSystemProperties;
+        hrc = m_VirtualBox->COMGETTER(SystemProperties)(pSystemProperties.asOutParam());
+        if (SUCCEEDED(hrc))
+            hrc = pSystemProperties->COMGETTER(ProxyMode)(aMode);
+    }
+    else
+    {
+        *aMode = m->enmProxyMode;
+        hrc = S_OK;
+    }
+
+    return hrc;
+}
+
+/**
+ * Returns the proxy URL to use.
+ *
+ * @returns HRESULT
+ * @param   aUrl                Where to return the proxy URL to use.
+ */
+HRESULT UpdateAgent::i_getProxyURL(com::Utf8Str &aUrl)
+{
+    HRESULT hrc;
+
+    if (!mData.m_fUseOwnProxy) /* If not explicitly set, use the ISystemProperties proxy settings. */
+    {
+        ComPtr<ISystemProperties> pSystemProperties;
+        hrc = m_VirtualBox->COMGETTER(SystemProperties)(pSystemProperties.asOutParam());
+        if (SUCCEEDED(hrc))
+        {
+            com::Bstr bstrVal;
+            hrc = pSystemProperties->COMGETTER(ProxyURL)(bstrVal.asOutParam());
+            if (SUCCEEDED(hrc))
+                aUrl = bstrVal;
+        }
+    }
+    else
+    {
+        aUrl = m->strProxyUrl;
+        hrc = S_OK;
+    }
+
+    return hrc;
+}
+
+/**
+ * Configures a HTTP client's proxy.
+ *
+ * @returns HRESULT
+ * @param   hHttp               HTTP client to configure proxy for.
+ */
+HRESULT UpdateAgent::i_configureProxy(RTHTTP hHttp)
+{
+    HRESULT rc;
+
+    ProxyMode_T enmProxyMode;
+    rc = i_getProxyMode(&enmProxyMode);
+    ComAssertComRCRetRC(rc);
+    Utf8Str strProxyUrl;
+    rc = i_getProxyURL(strProxyUrl);
+    ComAssertComRCRetRC(rc);
+
+    if (enmProxyMode == ProxyMode_Manual)
+    {
+        int vrc = RTHttpSetProxyByUrl(hHttp, strProxyUrl.c_str());
+        if (RT_FAILURE(vrc))
+            return i_reportError(vrc, tr("RTHttpSetProxyByUrl() failed: %Rrc"), vrc);
+    }
+    else if (enmProxyMode == ProxyMode_System)
+    {
+        int vrc = RTHttpUseSystemProxySettings(hHttp);
+        if (RT_FAILURE(vrc))
+            return i_reportError(vrc, tr("RTHttpUseSystemProxySettings() failed: %Rrc"), vrc);
+    }
+    else
+        Assert(enmProxyMode == ProxyMode_NoProxy);
+
+    LogRel2(("Update agent (%s): Using proxy mode = '%s', URL = '%s'\n",
+             mData.m_strName.c_str(), UpdateAgentBase::i_proxyModeToStr(enmProxyMode), strProxyUrl.c_str()));
+
+    return S_OK;
 }
 
@@ -978 +1105 @@
 HRESULT HostUpdateAgent::i_checkForUpdateInner(RTHTTP hHttp, Utf8Str const &strUrl, Utf8Str const &strUserAgent)
 {
+    /*
+     * Configure the proxy (if any).
+     */
+    HRESULT rc = i_configureProxy(hHttp);
+    if (FAILED(rc))
+        return rc;
+
     /** @todo Are there any other headers needed to be added first via RTHttpSetHeaders()? */
     int vrc = RTHttpAddHeader(hHttp, "User-Agent", strUserAgent.c_str(), strUserAgent.length(), RTHTTPADDHDR_F_BACK);
     if (RT_FAILURE(vrc))
         return i_reportError(vrc, tr("RTHttpAddHeader() failed: %Rrc (user agent)"), vrc);
-
-    /*
-     * Configure proxying.
-     */
-    if (m->enmProxyMode == ProxyMode_Manual)
-    {
-        vrc = RTHttpSetProxyByUrl(hHttp, m->strProxyUrl.c_str());
-        if (RT_FAILURE(vrc))
-            return i_reportError(vrc, tr("RTHttpSetProxyByUrl() failed: %Rrc"), vrc);
-    }
-    else if (m->enmProxyMode == ProxyMode_System)
-    {
-        vrc = RTHttpUseSystemProxySettings(hHttp);
-        if (RT_FAILURE(vrc))
-            return i_reportError(vrc, tr("RTHttpUseSystemProxySettings() failed: %Rrc"), vrc);
-    }
-    else
-        Assert(m->enmProxyMode == ProxyMode_NoProxy);
 
     /*
@@ -1035 +1151 @@
     size_t const cchWord1 = (size_t)(pchResponse - pchWord1);
 
-    HRESULT rc;
-
     /* Decode the two word: */
     static char const s_szUpToDate[] = "UPTODATE";