Changeset 60182 in vbox for trunk/src/VBox

Timestamp:

Mar 24, 2016 3:13:06 PM (9 years ago)

Author:

vboxsync

Message:

GUI/UIExtraDataManager: Look both machine and global extra data for simple feature checks like "GUI/HidLedsSync".

• Adds a extraDataStringUnion() method for getting extra data union style.
• Modifies isFeatureRestricted() and isFeatureAllowed() to use extraDataStringUnion() to retrieve the value.

This change allows deployments to use VBoxManage (or similar) to do global
configuration of what used to be VM specific settings. For example the
following will disable keyboard LED synchronization (Windows + OS X)
for all VMs:

VBoxManage setextradata global GUI/HidLedsSync false

Location:

trunk/src/VBox/Frontends/VirtualBox/src/extradata

Files:

• UIExtraDataManager.cpp (modified) (4 diffs)
• UIExtraDataManager.h (modified) (2 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/extradata/UIExtraDataManager.cpp

@@ -1965 +1965 @@
         hotloadMachineExtraDataMap(strID);
 
-    /* Read-only access corresponding map: */
+    /* Make a read-only copy of the corresponding map: */
     const ExtraDataMap data = m_data.value(strID);
 
@@ -1974 +1974 @@
     /* Returns corresponding value: */
     return data[strKey];
+}
+
+QString UIExtraDataManager::extraDataStringUnion(const QString &strKey, const QString &strID)
+{
+    /* Machine extra-data first: */
+    if (strID != GlobalID)
+    {
+        MapOfExtraDataMaps::const_iterator itMap = m_data.constFind(strID);
+
+        /* Hot-load machine extra-data map if necessary: */
+        if (itMap == m_data.constEnd())
+        {
+            hotloadMachineExtraDataMap(strID);
+            itMap = m_data.constFind(strID);
+        }
+        if (itMap != m_data.constEnd())
+        {
+            /* Return string if present in the map: */
+            ExtraDataMap::const_iterator itValue = itMap->constFind(strKey);
+            if (itValue != itMap->constEnd())
+                return *itValue;
+        }
+    }
+
+    /* Global extra-data: */
+    MapOfExtraDataMaps::const_iterator itMap = m_data.constFind(GlobalID);
+    if (itMap != m_data.constEnd())
+    {
+        ExtraDataMap::const_iterator itValue = itMap->constFind(strKey);
+        if (itValue != itMap->constEnd())
+            return *itValue;
+    }
+
+    /* Not found, return null string: */
+    return QString();
 }
 
@@ -4044 +4079 @@
 bool UIExtraDataManager::isFeatureAllowed(const QString &strKey, const QString &strID /* = GlobalID */)
 {
-    /* Hot-load machine extra-data map if necessary: */
-    if (strID != GlobalID && !m_data.contains(strID))
-        hotloadMachineExtraDataMap(strID);
-
-    /* Read-only access corresponding map: */
-    const ExtraDataMap data = m_data.value(strID);
-
-    /* 'false' if value was not set: */
-    if (!data.contains(strKey))
+    /* Get the value. Return 'false' if not found: */
+    const QString strValue = extraDataStringUnion(strKey, strID);
+    if (strValue.isNull())
         return false;
 
     /* Check corresponding value: */
-    const QString &strValue = data[strKey];
     return    strValue.compare("true", Qt::CaseInsensitive) == 0
            || strValue.compare("yes", Qt::CaseInsensitive) == 0
@@ -4065 +4093 @@
 bool UIExtraDataManager::isFeatureRestricted(const QString &strKey, const QString &strID /* = GlobalID */)
 {
-    /* Hot-load machine extra-data map if necessary: */
-    if (strID != GlobalID && !m_data.contains(strID))
-        hotloadMachineExtraDataMap(strID);
-
-    /* Read-only access corresponding map: */
-    const ExtraDataMap data = m_data.value(strID);
-
-    /* 'false' if value was not set: */
-    if (!data.contains(strKey))
+    /* Get the value. Return 'false' if not found: */
+    const QString strValue = extraDataStringUnion(strKey, strID);
+    if (strValue.isNull())
         return false;
 
     /* Check corresponding value: */
-    const QString &strValue = data[strKey];
     return    strValue.compare("false", Qt::CaseInsensitive) == 0
            || strValue.compare("no", Qt::CaseInsensitive) == 0

trunk/src/VBox/Frontends/VirtualBox/src/extradata/UIExtraDataManager.h

@@ -592 +592 @@
 #endif /* DEBUG */
 
+    /**
+     * Retrieves an extra-data key from both machine and global sources.
+     *
+     * If @a strID isn't #GlobalID, this will first check the extra-data associated
+     * with the machine given by @a strID then fallback on the global extra-data.
+     *
+     * @returns String value if found, null string if not.
+     * @param   strKey      The extra-data key to get.
+     * @param   strID       Machine UUID or #GlobalID.
+     * @param   strValue    Where to return the value when found.
+     */
+    QString extraDataStringUnion(const QString &strKey, const QString &strID);
     /** Determines whether feature corresponding to passed @a strKey is allowed.
-      * If valid @a strID is set => applies to machine extra-data, otherwise => to global one. */
+     *  If valid @a strID is set => applies to machine extra-data and global,
+     *  otherwise => only to global one. */
     bool isFeatureAllowed(const QString &strKey, const QString &strID = GlobalID);
     /** Determines whether feature corresponding to passed @a strKey is restricted.
-      * If valid @a strID is set => applies to machine extra-data, otherwise => to global one. */
+     *  If valid @a strID is set => applies to machine extra-data and global,
+     *  otherwise => only to global one. */
     bool isFeatureRestricted(const QString &strKey, const QString &strID = GlobalID);
 
@@ -616 +630 @@
     UIExtraDataEventHandler *m_pHandler;
 
+    /** Maps of extra data maps.  The index is a UUID string. */
+    typedef QMap<QString, ExtraDataMap> MapOfExtraDataMaps;
     /** Holds extra-data map instance. */
-    QMap<QString, ExtraDataMap> m_data;
+    MapOfExtraDataMaps m_data;
 
 #ifdef DEBUG