Changeset 85780 in vbox for trunk/src/VBox/Frontends/VBoxManage

Timestamp:

Aug 14, 2020 9:29:46 PM (5 years ago)

Author:

vboxsync

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

139936

Message:

VBoxManage/checkupdate: machine readable output. bugref:7983

Location:

trunk/src/VBox/Frontends/VBoxManage

Files:

• VBoxManage.h (modified) (1 diff)
• VBoxManageInfo.cpp (modified) (2 diffs)
• VBoxManageUpdateCheck.cpp (modified) (9 diffs)

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

@@ -261 +261 @@
 HRESULT showBandwidthGroups(ComPtr<IBandwidthControl> &bwCtrl,
                             VMINFO_DETAILS details);
+void outputMachineReadableString(const char *pszName, const char *pszValue);
+void outputMachineReadableString(const char *pszName, com::Bstr const *pbstrValue);
+void outputMachineReadableBool(const char *pszName, BOOL const *pfValue);
+void outputMachineReadableBool(const char *pszName, bool const *pfValue);
+void outputMachineReadableULong(const char *pszName, ULONG *uValue);
+void outputMachineReadableLong64(const char *pszName, LONG64 *uValue);
 
 /* VBoxManageList.cpp */

trunk/src/VBox/Frontends/VBoxManage/VBoxManageInfo.cpp

@@ -231 +231 @@
  * @param   pszValue            The value.
  */
-static void outputMachineReadableString(const char *pszName, const char *pszValue)
+void outputMachineReadableString(const char *pszName, const char *pszValue)
 {
     Assert(strpbrk(pszName, "\"\\") == NULL);
@@ -268 +268 @@
  * @param   pbstrValue          The value.
  */
-static void outputMachineReadableString(const char *pszName, Bstr const *pbstrValue)
+void outputMachineReadableString(const char *pszName, Bstr const *pbstrValue)
 {
     com::Utf8Str strValue(*pbstrValue);
     outputMachineReadableString(pszName, strValue.c_str());
 }
+
+
+/**
+ * Machine readable outputting of a boolean value.
+ */
+void outputMachineReadableBool(const char *pszName, BOOL const *pfValue)
+{
+    RTPrintf("%s=\"%s\"\n", pszName, *pfValue ? "on" : "off");
+}
+
+
+/**
+ * Machine readable outputting of a boolean value.
+ */
+void outputMachineReadableBool(const char *pszName, bool const *pfValue)
+{
+    RTPrintf("%s=\"%s\"\n", pszName, *pfValue ? "on" : "off");
+}
+
+
+/**
+ * Machine readable outputting of a ULONG value.
+ */
+void outputMachineReadableULong(const char *pszName, ULONG *puValue)
+{
+    RTPrintf("%s=\"%u\"\n", pszName, *puValue);
+}
+
+
+/**
+ * Machine readable outputting of a LONG64 value.
+ */
+void outputMachineReadableLong64(const char *pszName, LONG64 *puValue)
+{
+    RTPrintf("%s=\"%llu\"\n", pszName, *puValue);
+}
+
 
 /**

trunk/src/VBox/Frontends/VBoxManage/VBoxManageUpdateCheck.cpp

@@ -51 +51 @@
     static const RTGETOPTDEF s_aOptions[] =
     {
-        { "--verbose",       'v',        RTGETOPT_REQ_NOTHING }
+        { "--machine-readable", 'm', RTGETOPT_REQ_NOTHING }
     };
     RTGETOPTSTATE GetState;
@@ -57 +57 @@
     AssertRCReturn(vrc, RTEXITCODE_INIT);
 
+    bool fMachineReadable = false;
+
     int c;
     RTGETOPTUNION ValueUnion;
@@ -63 +65 @@
         switch (c)
         {
+            case 'm':
+                fMachineReadable = true;
+                break;
+
             default:
                 return errorGetOpt(c, &ValueUnion);
@@ -76 +82 @@
     BOOL fVBoxUpdateEnabled;
     CHECK_ERROR2I_RET(pSystemProperties, COMGETTER(VBoxUpdateEnabled)(&fVBoxUpdateEnabled), RTEXITCODE_FAILURE);
-    RTPrintf("Enabled:                %s\n", fVBoxUpdateEnabled ? "yes" : "no");
+    if (fMachineReadable)
+        outputMachineReadableBool("enabled", &fVBoxUpdateEnabled);
+    else
+        RTPrintf("Enabled:                %s\n", fVBoxUpdateEnabled ? "yes" : "no");
 
     ULONG cVBoxUpdateCount;
     CHECK_ERROR2I_RET(pSystemProperties, COMGETTER(VBoxUpdateCount)(&cVBoxUpdateCount), RTEXITCODE_FAILURE);
-    RTPrintf("Count:                  %u\n", cVBoxUpdateCount);
-
-    ULONG uVBoxUpdateFrequency;
-    CHECK_ERROR2I_RET(pSystemProperties, COMGETTER(VBoxUpdateFrequency)(&uVBoxUpdateFrequency), RTEXITCODE_FAILURE);
-    if (uVBoxUpdateFrequency == 0)
-        RTPrintf("Frequency:              never\n");
-    else if (uVBoxUpdateFrequency == 1)
+    if (fMachineReadable)
+        outputMachineReadableULong("count", &cVBoxUpdateCount);
+    else
+        RTPrintf("Count:                  %u\n", cVBoxUpdateCount);
+
+    ULONG cDaysFrequencey;
+    CHECK_ERROR2I_RET(pSystemProperties, COMGETTER(VBoxUpdateFrequency)(&cDaysFrequencey), RTEXITCODE_FAILURE);
+    if (fMachineReadable)
+        outputMachineReadableULong("frequency", &cDaysFrequencey);
+    else if (cDaysFrequencey == 0)
+        RTPrintf("Frequency:              never\n"); /** @todo r=bird: Two inconsistencies here. HostUpdateImpl.cpp code will indicate the need for updating if no last-check-date.  modifysettings cannot set it to zero (I added the error message, you just skipped setting it originally). */
+    else if (cDaysFrequencey == 1)
         RTPrintf("Frequency:              every day\n");
     else
-        RTPrintf("Frequency:              every %u days\n", uVBoxUpdateFrequency);
+        RTPrintf("Frequency:              every %u days\n", cDaysFrequencey);
 
     VBoxUpdateTarget_T enmVBoxUpdateTarget;
     CHECK_ERROR2I_RET(pSystemProperties, COMGETTER(VBoxUpdateTarget)(&enmVBoxUpdateTarget), RTEXITCODE_FAILURE);
     const char *psz;
+    const char *pszMachine;
     switch (enmVBoxUpdateTarget)
     {
         case VBoxUpdateTarget_Stable:
             psz = "Stable - new minor and maintenance releases";
+            pszMachine = "stable";
             break;
         case VBoxUpdateTarget_AllReleases:
             psz = "All releases - new minor, maintenance, and major releases";
+            pszMachine = "all-releases";
             break;
         case VBoxUpdateTarget_WithBetas:
             psz = "With Betas - new minor, maintenance, major, and beta releases";
+            pszMachine = "with-betas";
             break;
         default:
+            AssertFailed();
             psz = "Unset";
+            pszMachine = "invalid";
             break;
     }
-    RTPrintf("Target:                 %s\n", psz);
-
-    Bstr strVBoxUpdateLastCheckDate;
-    CHECK_ERROR2I_RET(pSystemProperties, COMGETTER(VBoxUpdateLastCheckDate)(strVBoxUpdateLastCheckDate.asOutParam()),
+    if (fMachineReadable)
+        outputMachineReadableString("target", pszMachine);
+    else
+        RTPrintf("Target:                 %s\n", psz);
+
+    Bstr bstrLastCheckDate;
+    CHECK_ERROR2I_RET(pSystemProperties, COMGETTER(VBoxUpdateLastCheckDate)(bstrLastCheckDate.asOutParam()),
                       RTEXITCODE_FAILURE);
-    if (!strVBoxUpdateLastCheckDate.isEmpty())
-        RTPrintf("Last Check Date:        %ls\n", strVBoxUpdateLastCheckDate.raw());
+    if (fMachineReadable)
+        outputMachineReadableString("last-check-date", &bstrLastCheckDate);
+    else if (bstrLastCheckDate.isNotEmpty())
+        RTPrintf("Last Check Date:        %ls\n", bstrLastCheckDate.raw());
 
     return RTEXITCODE_SUCCESS;
@@ -220 +245 @@
     static const RTGETOPTDEF s_aOptions[] =
     {
-        { "--verbose",       'v',        RTGETOPT_REQ_NOTHING }
+        { "--machine-readable", 'm', RTGETOPT_REQ_NOTHING }
     };
     RTGETOPTSTATE GetState;
@@ -226 +251 @@
     AssertRCReturn(vrc, RTEXITCODE_INIT);
 
+    bool fMachineReadable = false;
+
     int c;
     RTGETOPTUNION ValueUnion;
@@ -232 +259 @@
         switch (c)
         {
+            case 'm':
+                fMachineReadable = true;
+                break;
+
             default:
                 return errorGetOpt(c, &ValueUnion);
@@ -277 +308 @@
     CHECK_ERROR2I_RET(pHostUpdate, COMGETTER(UpdateResponse)(&fUpdateNeeded), RTEXITCODE_FAILURE);
 
-    if (!fUpdateNeeded)
-        RTPrintf("You are already running the most recent version of VirtualBox.\n");
-    else
+    if (fMachineReadable)
+        outputMachineReadableBool("update-needed", &fUpdateNeeded);
+
+    if (fUpdateNeeded)
     {
         Bstr bstrUpdateVersion;
@@ -286 +318 @@
         CHECK_ERROR2I_RET(pHostUpdate, COMGETTER(UpdateURL)(bstrUpdateURL.asOutParam()), RTEXITCODE_FAILURE);
 
-        RTPrintf("A new version of VirtualBox has been released! Version %ls is available at virtualbox.org.\n"
-                 "You can download this version here: %ls\n", bstrUpdateVersion.raw(), bstrUpdateURL.raw());
-    }
+        if (fMachineReadable)
+            RTPrintf("A new version of VirtualBox has been released! Version %ls is available at virtualbox.org.\n"
+                     "You can download this version here: %ls\n", bstrUpdateVersion.raw(), bstrUpdateURL.raw());
+        else
+        {
+            outputMachineReadableString("update-version", &bstrUpdateVersion);
+            outputMachineReadableString("update-url", &bstrUpdateURL);
+        }
+    }
+    else if (!fMachineReadable)
+        RTPrintf("You are already running the most recent version of VirtualBox.\n");
 
     return RTEXITCODE_SUCCESS;