Changeset 68048 in vbox

Timestamp:

Jul 19, 2017 3:02:01 PM (8 years ago)

Author:

vboxsync

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

117072

Message:

Main/Settings.cpp: Use a "Description" XML tag instead of an attribute for the Medium registry entries. Matches what the code should've been doing since day 1 (and the XML schema), but unfortunately since VirtualBox 3.2 the code used the attribute. Not that there was any way to set the description in the API before 5.2.

File:

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

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

@@ -810 +810 @@
             throw ConfigFileError(this, &elmMedium, N_("Required %s/@location attribute is missing"), elmMedium.getName());
 
-    elmMedium.getAttributeValue("Description", med.strDescription);       // optional
-
-    // handle medium properties
-    xml::NodesLoop nl2(elmMedium, "Property");
-    const xml::ElementNode *pelmHDChild;
-    while ((pelmHDChild = nl2.forAllNodes()))
-    {
-        Utf8Str strPropName, strPropValue;
-        if (   pelmHDChild->getAttributeValue("name", strPropName)
-            && pelmHDChild->getAttributeValue("value", strPropValue) )
-            med.properties[strPropName] = strPropValue;
-        else
-            throw ConfigFileError(this, pelmHDChild, N_("Required HardDisk/Property/@name or @value attribute is missing"));
+    // 3.2 builds added Description as an attribute, read it silently
+    // and write it back as an element starting with 5.1.26
+    elmMedium.getAttributeValue("Description", med.strDescription);
+
+    xml::NodesLoop nlMediumChildren(elmMedium);
+    const xml::ElementNode *pelmMediumChild;
+    while ((pelmMediumChild = nlMediumChildren.forAllNodes()))
+    {
+        if (pelmMediumChild->nameEquals("Description"))
+            med.strDescription = pelmMediumChild->getValue();
+        else if (pelmMediumChild->nameEquals("Property"))
+        {
+            // handle medium properties
+            Utf8Str strPropName, strPropValue;
+            if (   pelmMediumChild->getAttributeValue("name", strPropName)
+                && pelmMediumChild->getAttributeValue("value", strPropValue) )
+                med.properties[strPropName] = strPropValue;
+            else
+                throw ConfigFileError(this, pelmMediumChild, N_("Required HardDisk/Property/@name or @value attribute is missing"));
+        }
     }
 }
@@ -1266 +1273 @@
         pelmMedium->setAttribute("autoReset", mdm.fAutoReset);
     if (mdm.strDescription.length())
-        pelmMedium->setAttribute("Description", mdm.strDescription);
+        pelmMedium->createChild("Description")->addContent(mdm.strDescription);
 
     for (StringsMap::const_iterator it = mdm.properties.begin();
@@ -4957 +4964 @@
         throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@name attribute is missing"));
 
-    // earlier 3.1 trunk builds had a bug and added Description as an attribute, read it silently and write it back as an element
+    // 3.1 dev builds added Description as an attribute, read it silently
+    // and write it back as an element
     elmSnapshot.getAttributeValue("Description", snap.strDescription);