Changeset 42176 in vbox for trunk/src/VBox

Timestamp:

Jul 17, 2012 12:23:50 PM (13 years ago)

Author:

vboxsync

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

79173

Message:

Main+Frontends/VBoxManage: implement saving the settings, and add the matching VBoxManage support

Location:

trunk/src/VBox

Files:

• Frontends/VBoxManage/VBoxManage.h (modified) (2 diffs)
• Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (3 diffs)
• Frontends/VBoxManage/VBoxManageMisc.cpp (modified) (7 diffs)
• Frontends/VBoxManage/VBoxManageModifyVM.cpp (modified) (4 diffs)
• Main/idl/VirtualBox.xidl (modified) (1 diff)
• Main/xml/Settings.cpp (modified) (9 diffs)

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

@@ -24 +24 @@
 #include <VBox/com/VirtualBox.h>
 #include <VBox/com/string.h>
+#include <VBox/com/array.h>
 #endif /* !VBOX_ONLY_DOCS */
 
@@ -171 +172 @@
 
 /* VBoxManageModifyVM.cpp */
+#ifndef VBOX_ONLY_DOCS
+void parseGroups(const char *pcszGroups, com::SafeArray<BSTR> *pGroups);
+#endif
 int handleModifyVM(HandlerArg *a);
 

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

@@ -137 +137 @@
         RTStrmPrintf(pStrm,
                      "VBoxManage createvm         --name <name>\n"
+                     "                            [--groups <group>, ...]\n"
                      "                            [--ostype <ostype>]\n"
                      "                            [--register]\n"
@@ -148 +149 @@
                      "VBoxManage modifyvm         <uuid|name>\n"
                      "                            [--name <name>]\n"
+                     "                            [--groups <group>, ...]\n"
                      "                            [--ostype <ostype>]\n"
                      "                            [--memory <memorysize in MB>]\n"
@@ -355 +357 @@
                      "                                       keepdisknames]\n"
                      "                            [--name <name>]\n"
+                     "                            [--groups <group>, ...]\n"
                      "                            [--basefolder <basefolder>]\n"
                      "                            [--uuid <uuid>]\n"

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

@@ -191 +191 @@
     Bstr bstrBaseFolder;
     Bstr bstrName;
-    Bstr bstrGroups;
     Bstr bstrOsTypeId;
     Bstr bstrUuid;
     bool fRegister = false;
+    com::SafeArray<BSTR> groups;
 
     int c;
@@ -211 +211 @@
 
             case 'g':   // --groups
-                bstrGroups = ValueUnion.psz;
-                /// @todo implement group string parsing to safearray
+                parseGroups(ValueUnion.psz, &groups);
                 break;
 
@@ -242 +241 @@
     do
     {
+        Bstr bstrPrimaryGroup;
+        if (groups.size())
+            bstrPrimaryGroup = groups[0];
         Bstr bstrSettingsFile;
         CHECK_ERROR_BREAK(a->virtualBox,
                           ComposeMachineFilename(bstrName.raw(),
-                                                 NULL /* aGroup */,
+                                                 bstrPrimaryGroup.raw(),
                                                  bstrBaseFolder.raw(),
                                                  bstrSettingsFile.asOutParam()));
         ComPtr<IMachine> machine;
-        com::SafeArray<BSTR> groups; /* no groups */
         CHECK_ERROR_BREAK(a->virtualBox,
                           CreateMachine(bstrSettingsFile.raw(),
@@ -347 +348 @@
     com::SafeArray<CloneOptions_T> options;
     const char                    *pszTrgName       = NULL;
-    const char                    *pszTrgGroups     = NULL;
     const char                    *pszTrgBaseFolder = NULL;
     bool                           fRegister        = false;
     Bstr                           bstrUuid;
+    com::SafeArray<BSTR> groups;
 
     int c;
@@ -371 +372 @@
 
             case 'g':   // --groups
-                pszTrgGroups = ValueUnion.psz;
-                /// @todo implement group string parsing to safearray
+                parseGroups(ValueUnion.psz, &groups);
                 break;
 
@@ -435 +435 @@
         pszTrgName = RTStrAPrintf2("%s Clone", pszSrcName);
 
+    Bstr bstrPrimaryGroup;
+    if (groups.size())
+        bstrPrimaryGroup = groups[0];
     Bstr bstrSettingsFile;
     CHECK_ERROR_RET(a->virtualBox,
                     ComposeMachineFilename(Bstr(pszTrgName).raw(),
-                                           NULL /* aGroup */,
+                                           bstrPrimaryGroup.raw(),
                                            Bstr(pszTrgBaseFolder).raw(),
                                            bstrSettingsFile.asOutParam()),
@@ -444 +447 @@
 
     ComPtr<IMachine> trgMachine;
-    com::SafeArray<BSTR> groups; /* no groups */
     CHECK_ERROR_RET(a->virtualBox, CreateMachine(bstrSettingsFile.raw(),
                                                  Bstr(pszTrgName).raw(),

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

@@ -53 +53 @@
 {
     MODIFYVM_NAME = 1000,
+    MODIFYVM_GROUPS,
     MODIFYVM_OSTYPE,
     MODIFYVM_MEMORY,
@@ -196 +197 @@
 {
     { "--name",                     MODIFYVM_NAME,                      RTGETOPT_REQ_STRING },
+    { "--groups",                   MODIFYVM_GROUPS,                    RTGETOPT_REQ_STRING },
     { "--ostype",                   MODIFYVM_OSTYPE,                    RTGETOPT_REQ_STRING },
     { "--memory",                   MODIFYVM_MEMORY,                    RTGETOPT_REQ_UINT32 },
@@ -364 +366 @@
 }
 
+void parseGroups(const char *pcszGroups, com::SafeArray<BSTR> *pGroups)
+{
+    while (pcszGroups)
+    {
+        char *pComma = RTStrStr(pcszGroups, ",");
+        if (pComma)
+        {
+            Bstr(pcszGroups, pComma - pcszGroups).detachTo(pGroups->appendedRaw());
+            pcszGroups = pComma + 1;
+        }
+        else
+        {
+            Bstr(pcszGroups).detachTo(pGroups->appendedRaw());
+            pcszGroups = NULL;
+        }
+    }
+}
+
 int handleModifyVM(HandlerArg *a)
 {
@@ -405 +425 @@
             {
                 CHECK_ERROR(machine, COMSETTER(Name)(Bstr(ValueUnion.psz).raw()));
+                break;
+            }
+            case MODIFYVM_GROUPS:
+            {
+                com::SafeArray<BSTR> groups;
+                parseGroups(ValueUnion.psz, &groups);
+                CHECK_ERROR(machine, COMSETTER(Groups)(ComSafeArrayAsInParam(groups)));
                 break;
             }

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -491 +491 @@
       <desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
       <!--
-          Machine changes: tracing config;
+          Machine changes: tracing config, groups, autostart;
+          NetworkAdapter changes: unit for bandwidth group limits.
       -->
     </const>

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

@@ -17 +17 @@
  *
  * Certainly ConfigFileBase::ConfigFileBase() will. Change VBOX_XML_VERSION below as well.
+ * VBOX_XML_VERSION does not have to be changed if the settings for a default VM do not
+ * touch newly introduced attributes or tags. It has the benefit that older VirtualBox
+ * versions do not trigger their "newer" code path.
  *
  * Once a new settings version has been added, these are the rules for introducing a new
@@ -323 +326 @@
                 else if (ulMinor == 12)
                     m->sv = SettingsVersion_v1_12;
-                else if (ulMinor > 12)
+                else if (ulMinor == 13)
+                    m->sv = SettingsVersion_v1_13;
+                else if (ulMinor > 13)
                     m->sv = SettingsVersion_Future;
             }
@@ -3224 +3229 @@
 
 /**
+ * Called for reading the <Groups> element under <Machine>.
+ */
+void MachineConfigFile::readGroups(const xml::ElementNode *pElmGroups, StringsList *pllGroups)
+{
+    pllGroups->clear();
+    if (!pElmGroups || m->sv < SettingsVersion_v1_13)
+    {
+        pllGroups->push_back("/");
+        return;
+    }
+
+    xml::NodesLoop nlGroups(*pElmGroups);
+    const xml::ElementNode *pelmGroup;
+    while ((pelmGroup = nlGroups.forAllNodes()))
+    {
+        if (pelmGroup->nameEquals("Group"))
+        {
+            Utf8Str strGroup;
+            if (!pelmGroup->getAttributeValue("name", strGroup))
+                throw ConfigFileError(this, pelmGroup, N_("Required Group/@name attribute is missing"));
+            pllGroups->push_back(strGroup);
+        }
+    }
+}
+
+/**
  * Called initially for the <Snapshot> element under <Machine>, if present,
  * to store the snapshot's data into the given Snapshot structure (which is
@@ -3298 +3329 @@
     readDebugging(elmSnapshot.findChildElement("Debugging"), &snap.debugging);
     readAutostart(elmSnapshot.findChildElement("Autostart"), &snap.autostart);
+    // note: Groups exist only for Machine, not for Snapshot
 }
 
@@ -3450 +3482 @@
             else if (pelmMachineChild->nameEquals("Autostart"))
                 readAutostart(pelmMachineChild, &autostart);
+            else if (pelmMachineChild->nameEquals("Groups"))
+                readGroups(pelmMachineChild, &machineUserData.llGroups);
         }
 
@@ -4431 +4465 @@
 
 /**
+ * Creates a <Groups> node under elmParent and then writes out the XML
+ * keys under that. Called for the <Machine> node only.
+ *
+ * @param pElmParent    Pointer to the parent element.
+ * @param pllGroups     Pointer to the groups list.
+ */
+void MachineConfigFile::buildGroupsXML(xml::ElementNode *pElmParent, const StringsList *pllGroups)
+{
+    if (   m->sv < SettingsVersion_v1_13 || pllGroups->size() == 0
+        || (pllGroups->size() == 1 && pllGroups->front() == "/"))
+        return;
+
+    xml::ElementNode *pElmGroups = pElmParent->createChild("Groups");
+    for (StringsList::const_iterator it = pllGroups->begin();
+         it != pllGroups->end();
+         ++it)
+    {
+        const Utf8Str &group = *it;
+        xml::ElementNode *pElmGroup = pElmGroups->createChild("Group");
+        pElmGroup->setAttribute("name", group);
+    }
+}
+
+/**
  * Writes a single snapshot into the DOM tree. Initially this gets called from MachineConfigFile::write()
  * for the root snapshot of a machine, if present; elmParent then points to the <Snapshots> node under the
@@ -4461 +4519 @@
     buildDebuggingXML(pelmSnapshot, &snap.debugging);
     buildAutostartXML(pelmSnapshot, &snap.autostart);
+    // note: Groups exist only for Machine, not for Snapshot
 
     if (snap.llChildSnapshots.size())
@@ -4610 +4669 @@
     buildDebuggingXML(&elmMachine, &debugging);
     buildAutostartXML(&elmMachine, &autostart);
+    buildGroupsXML(&elmMachine, &machineUserData.llGroups);
 }
 
@@ -4727 +4787 @@
     if (m->sv < SettingsVersion_v1_13)
     {
-        // VirtualBox 4.2 adds tracing and autostart.
+        // VirtualBox 4.2 adds tracing, autostart and groups.
         if (   !debugging.areDefaultSettings()
-            || !autostart.areDefaultSettings())
+            || !autostart.areDefaultSettings()
+            || machineUserData.llGroups.size() > 1
+            || machineUserData.llGroups.front() != "/")
             m->sv = SettingsVersion_v1_13;
     }