Changeset 2957 in vbox for trunk/src

Timestamp:

May 31, 2007 10:09:04 AM (18 years ago)

Author:

vboxsync

Message:

Made IHostFloppyDrive use libhal on Linux and added UDI strings to the host floppy and DVD devices

Location:

trunk/src/VBox

Files:

• Frontends/VirtualBox/src/VBoxConsoleWnd.cpp (modified) (2 diffs)
• Frontends/VirtualBox/src/VBoxGlobal.cpp (modified) (1 diff)
• Frontends/VirtualBox/ui/VBoxVMSettingsDlg.ui.h (modified) (3 diffs)
• Main/HostDVDDriveImpl.cpp (modified) (4 diffs)
• Main/HostFloppyDriveImpl.cpp (modified) (4 diffs)
• Main/HostImpl.cpp (modified) (7 diffs)
• Main/idl/VirtualBox.xidl (modified) (2 diffs)
• Main/include/HostDVDDriveImpl.h (modified) (3 diffs)
• Main/include/HostFloppyDriveImpl.h (modified) (3 diffs)
• Main/include/HostImpl.h (modified) (2 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/VBoxConsoleWnd.cpp

@@ -1522 +1522 @@
         {
             case CEnums::HostDriveCaptured:
+            {
+                CHostFloppyDrive drv = floppy.GetHostDrive();
+                QString drvName = drv.GetName();
+                QString description = drv.GetDescription();
+                QString fullName = description.isEmpty() ?
+                    drvName :
+                    QString ("<nobr>%1 (%2)</nobr>").arg (description, drvName);
                 name = tr ("Host&nbsp;Drive&nbsp;", "Floppy tooltip") +
-                    floppy.GetHostDrive().GetName();
+                    fullName;
                 break;
+            }
             case CEnums::ImageMounted:
                 name = floppy.GetImage().GetFilePath();
@@ -2157 +2165 @@
         CHostFloppyDrive hostFloppy = en.GetNext();
         /** @todo set icon */
+        QString drvName = hostFloppy.GetName();
+        QString description = hostFloppy.GetDescription();
+        QString fullName = description.isEmpty() ?
+            drvName :
+            QString ("%1 (%2)").arg (description, drvName);
         int id = devicesMountFloppyMenu->insertItem (
-            tr ("Host Drive ") + hostFloppy.GetName()
-        );
+            tr ("Host Drive ") + fullName);
         hostFloppyMap [id] = hostFloppy;
         if (machine_state != CEnums::Running)

trunk/src/VBox/Frontends/VirtualBox/src/VBoxGlobal.cpp

@@ -1136 +1136 @@
             {
                 CHostFloppyDrive drv = floppy.GetHostDrive();
+                QString drvName = drv.GetName();
+                QString description = drv.GetDescription();
+                QString fullName = description.isEmpty() ?
+                    drvName :
+                    QString ("%1 (%2)").arg (description, drvName);
                 item = item.arg (tr ("Host Drive", "details report (floppy)"),
-                                 drv.GetName());
+                                 fullName);
                 break;
             }

trunk/src/VBox/Frontends/VirtualBox/ui/VBoxVMSettingsDlg.ui.h

@@ -1364 +1364 @@
             CHostFloppyDrive hostFloppy = en.GetNext();
             /** @todo set icon? */
-            cbHostFloppy->insertItem (hostFloppy.GetName(), id);
+            QString name = hostFloppy.GetName();
+            QString description = hostFloppy.GetDescription();
+            QString fullName = description.isEmpty() ?
+                name :
+                QString ("%1 (%2)").arg (description, name);
+            cbHostFloppy->insertItem (fullName, id);
             hostFloppies [id] = hostFloppy;
             ++ id;
@@ -1376 +1381 @@
                 CHostFloppyDrive drv = floppy.GetHostDrive();
                 QString name = drv.GetName();
+                QString description = drv.GetDescription();
+                QString fullName = description.isEmpty() ?
+                    name :
+                    QString ("%1 (%2)").arg (description, name);
                 if (coll.FindByName (name).isNull())
                 {
@@ -1382 +1391 @@
                      *  add it to the end of the list with a special mark
                      */
-                    cbHostFloppy->insertItem ("* " + name);
-                    cbHostFloppy->setCurrentItem (cbHostFloppy->count() - 1);
+                    cbHostFloppy->insertItem ("* " + fullName);
+                    cbHostFloppy->setCurrentItem (cbHostDVD->count() - 1);
                 }
                 else
                 {
                     /* this will select the correct item from the prepared list */
-                    cbHostFloppy->setCurrentText (name);
+                    cbHostFloppy->setCurrentText (fullName);
                 }
                 rbHostFloppy->setChecked (true);

trunk/src/VBox/Main/HostDVDDriveImpl.cpp

@@ -49 +49 @@
  */
 HRESULT HostDVDDrive::init (INPTR BSTR aName,
+                            INPTR BSTR aUdi /* = NULL */,
                             INPTR BSTR aDescription /* = NULL */)
 {
@@ -58 +59 @@
 
     unconst (mName) = aName;
+    unconst (mUdi) = aUdi;
     unconst (mDescription) = aDescription;
 
@@ -99 +101 @@
 }
 
+/**
+ * Returns a human readable description of the host drive
+ *
+ * @returns COM status code
+ * @param driveDescription address of result pointer
+ */
 STDMETHODIMP HostDVDDrive::COMGETTER(Description) (BSTR *aDescription)
 {
@@ -113 +121 @@
     return S_OK;
 }
+
+/**
+ * Returns the universal device identifier of the host drive
+ *
+ * @returns COM status code
+ * @param driveDescription address of result pointer
+ */
+STDMETHODIMP HostDVDDrive::COMGETTER(Udi) (BSTR *aUdi)
+{
+    if (!aUdi)
+        return E_POINTER;
+
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    /* mDescription is constant during life time, no need to lock */
+
+    mUdi.cloneTo (aUdi);
+
+    return S_OK;
+}

trunk/src/VBox/Main/HostFloppyDriveImpl.cpp

@@ -44 +44 @@
  *
  * @param aName         Name of the drive.
+ * @param aDescription  Human-readable drive description (may be NULL).
  *
  * @return COM result indicator.
  */
-HRESULT HostFloppyDrive::init (INPTR BSTR aName)
+HRESULT HostFloppyDrive::init (INPTR BSTR aName,
+                               INPTR BSTR aUdi /* = NULL */,
+                               INPTR BSTR aDescription /* = NULL */)
 {
     ComAssertRet (aName, E_INVALIDARG);
@@ -56 +59 @@
 
     unconst (mName) = aName;
+    unconst (mUdi) = aUdi;
+    unconst (mDescription) = aDescription;
 
     /* Confirm the successful initialization */
@@ -62 +67 @@
     return S_OK;
 }
+
 
 /**
@@ -94 +100 @@
     return S_OK;
 }
+
+/**
+ * Returns a human readable description of the host drive
+ *
+ * @returns COM status code
+ * @param driveDescription address of result pointer
+ */
+STDMETHODIMP HostFloppyDrive::COMGETTER(Description) (BSTR *aDescription)
+{
+    if (!aDescription)
+        return E_POINTER;
+
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    /* mDescription is constant during life time, no need to lock */
+
+    mDescription.cloneTo (aDescription);
+
+    return S_OK;
+}
+
+/**
+ * Returns the universal device identifier of the host drive
+ *
+ * @returns COM status code
+ * @param driveDescription address of result pointer
+ */
+STDMETHODIMP HostFloppyDrive::COMGETTER(Udi) (BSTR *aUdi)
+{
+    if (!aUdi)
+        return E_POINTER;
+
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    /* mDescription is constant during life time, no need to lock */
+
+    mUdi.cloneTo (aUdi);
+
+    return S_OK;
+}

trunk/src/VBox/Main/HostImpl.cpp

@@ -304 +304 @@
     delete[] hostDrives;
 #elif defined(__LINUX__)
+#ifdef VBOX_USE_LIBHAL
+    if (!getFloppyInfoFromHal(list)) /* Playing with #defines in this way is nasty, I know. */
+#endif /* USE_LIBHAL defined */
     // As with the CDROMs, on Linux we have to take a multi-level approach
     // involving parsing the mount tables. As this is not bulletproof, we'll
@@ -309 +312 @@
     // variable and skip the detection.
 
-    if (getenv("VBOX_FLOPPY"))
-    {
-        char *floppyEnv = getenv("VBOX_FLOPPY");
-        char *floppyDrive;
-        floppyDrive = strtok(floppyEnv, ":");
-        while (floppyDrive)
-        {
-            // check if this is an acceptable device
-            if (validateDevice(floppyDrive, false))
+    {
+        if (getenv("VBOX_FLOPPY"))
+        {
+            char *floppyEnv = getenv("VBOX_FLOPPY");
+            char *floppyDrive;
+            floppyDrive = strtok(floppyEnv, ":");
+            while (floppyDrive)
             {
-                ComObjPtr <HostFloppyDrive> hostFloppyDriveObj;
-                hostFloppyDriveObj.createObject();
-                hostFloppyDriveObj->init (Bstr (floppyDrive));
-                list.push_back (hostFloppyDriveObj);
+                // check if this is an acceptable device
+                if (validateDevice(floppyDrive, false))
+                {
+                    ComObjPtr <HostFloppyDrive> hostFloppyDriveObj;
+                    hostFloppyDriveObj.createObject();
+                    hostFloppyDriveObj->init (Bstr (floppyDrive));
+                    list.push_back (hostFloppyDriveObj);
+                }
+                floppyDrive = strtok(NULL, ":");
             }
-            floppyDrive = strtok(NULL, ":");
-        }
-    }
-    else
-    {
-        // we assume that a floppy is always /dev/fd[x] with x from 0 to 7
-        char devName[10];
-        for (int i = 0; i <= 7; i++)
-        {
-            sprintf(devName, "/dev/fd%d", i);
-            if (validateDevice(devName, false))
+        }
+        else
+        {
+            // we assume that a floppy is always /dev/fd[x] with x from 0 to 7
+            char devName[10];
+            for (int i = 0; i <= 7; i++)
             {
-                ComObjPtr <HostFloppyDrive> hostFloppyDriveObj;
-                hostFloppyDriveObj.createObject();
-                hostFloppyDriveObj->init (Bstr (devName));
-                list.push_back (hostFloppyDriveObj);
+                sprintf(devName, "/dev/fd%d", i);
+                if (validateDevice(devName, false))
+                {
+                    ComObjPtr <HostFloppyDrive> hostFloppyDriveObj;
+                    hostFloppyDriveObj.createObject();
+                    hostFloppyDriveObj->init (Bstr (devName));
+                    list.push_back (hostFloppyDriveObj);
+                }
             }
         }
@@ -1411 +1416 @@
  * system.
  *
- * @returns true if at least one drive was found, false otherwise
+ * @returns true if information was successfully obtained, false otherwise
  * @retval  list drives found will be attached to this list
  */
@@ -1434 +1439 @@
                     if (halDevices != 0)
                     {
+                        /* Hal is installed and working, so if no devices are reported, assume
+                           that there are none. */
+                        halSuccess = true;
                         for (int i = 0; i < numDevices; i++)
                         {
@@ -1444 +1452 @@
                                     Utf8Str description;
                                     char *vendor, *product;
-                                    /* We have at least one hit, so operation successful :) */
-                                    halSuccess = true;
+                                    /* We do not check the error here, as this field may
+                                       not even exist. */
                                     vendor = libhal_device_get_property_string(halContext,
-                                                    halDevices[i], "info.vendor", &dbusError);
+                                                    halDevices[i], "info.vendor", 0);
                                     product = libhal_device_get_property_string(halContext,
                                                     halDevices[i], "info.product", &dbusError);
                                     if ((product != 0 && product[0] != 0))
                                     {
-                                        if (vendor != 0 && vendor[0] != 0)
+                                        if ((vendor != 0) && (vendor[0] != 0))
                                         {
                                             description = Utf8StrFmt ("%s %s",
@@ -1463 +1471 @@
                                         ComObjPtr <HostDVDDrive> hostDVDDriveObj;
                                         hostDVDDriveObj.createObject();
-                                        hostDVDDriveObj->init (Bstr (devNode), Bstr (description));
+                                        hostDVDDriveObj->init (Bstr (devNode),
+                                                               Bstr (halDevices[i]),
+                                                               Bstr (description));
                                         list.push_back (hostDVDDriveObj);
                                     }
                                     else
                                     {
+                                        if (product == 0)
+                                        {
+                                            LogRel(("Host::COMGETTER(DVDDrives): failed to get property \"info.product\" for device %s.  dbus error: %s (%s)\n",
+                                                    halDevices[i], dbusError.name, dbusError.message));
+                                            dbus_error_free(&dbusError);
+                                        }
                                         ComObjPtr <HostDVDDrive> hostDVDDriveObj;
                                         hostDVDDriveObj.createObject();
-                                        hostDVDDriveObj->init (Bstr (devNode));
+                                        hostDVDDriveObj->init (Bstr (devNode),
+                                                               Bstr (halDevices[i]));
                                         list.push_back (hostDVDDriveObj);
+                                    }
+                                    if (vendor != 0)
+                                    {
+                                        libhal_free_string(vendor);
+                                    }
+                                    if (product != 0)
+                                    {
+                                        libhal_free_string(product);
                                     }
                                 }
@@ -1521 +1546 @@
     {
         LogRel(("Host::COMGETTER(DVDDrives): failed to connect to dbus.  dbus error: %s (%s)\n", dbusError.name, dbusError.message));
+        dbus_error_free(&dbusError);
+    }
+    return halSuccess;
+}
+
+
+/**
+ * Helper function to query the hal subsystem for information about floppy drives attached to the
+ * system.
+ *
+ * @returns true if information was successfully obtained, false otherwise
+ * @retval  list drives found will be attached to this list
+ */
+bool Host::getFloppyInfoFromHal(std::list <ComObjPtr <HostFloppyDrive> > &list)
+{
+    bool halSuccess = false;
+    DBusError dbusError;
+    dbus_error_init (&dbusError);
+    DBusConnection *dbusConnection = dbus_bus_get(DBUS_BUS_SYSTEM, &dbusError);
+    if (dbusConnection != 0)
+    {
+        LibHalContext *halContext = libhal_ctx_new();
+        if (halContext != 0)
+        {
+            if (libhal_ctx_set_dbus_connection (halContext, dbusConnection))
+            {
+                if (libhal_ctx_init(halContext, &dbusError))
+                {
+                    int numDevices;
+                    char **halDevices = libhal_find_device_by_capability(halContext,
+                                                "storage", &numDevices, &dbusError);
+                    if (halDevices != 0)
+                    {
+                        /* Hal is installed and working, so if no devices are reported, assume
+                           that there are none. */
+                        halSuccess = true;
+                        for (int i = 0; i < numDevices; i++)
+                        {
+                            char *driveType = libhal_device_get_property_string(halContext,
+                                                    halDevices[i], "storage.drive_type", 0);
+                            if (driveType != 0)
+                            {
+                                if (strcmp(driveType, "floppy") != 0)
+                                {
+                                    libhal_free_string(driveType);
+                                    continue;
+                                }
+                                libhal_free_string(driveType);
+                            }
+                            else
+                            {
+                                /* An error occurred.  The attribute "storage.drive_type"
+                                   probably didn't exist. */
+                                continue;
+                            }
+                            char *devNode = libhal_device_get_property_string(halContext,
+                                                    halDevices[i], "block.device", &dbusError);
+                            if (devNode != 0)
+                            {
+                                if (validateDevice(devNode, false))
+                                {
+                                    Utf8Str description;
+                                    char *vendor, *product;
+                                    /* We do not check the error here, as this field may
+                                       not even exist. */
+                                    vendor = libhal_device_get_property_string(halContext,
+                                                    halDevices[i], "info.vendor", 0);
+                                    product = libhal_device_get_property_string(halContext,
+                                                    halDevices[i], "info.product", &dbusError);
+                                    if ((product != 0) && (product[0] != 0))
+                                    {
+                                        if ((vendor != 0) && (vendor[0] != 0))
+                                        {
+                                            description = Utf8StrFmt ("%s %s",
+                                                                      vendor, product);
+                                        }
+                                        else
+                                        {
+                                            description = product;
+                                        }
+                                        ComObjPtr <HostFloppyDrive> hostFloppyDrive;
+                                        hostFloppyDrive.createObject();
+                                        hostFloppyDrive->init (Bstr (devNode),
+                                                               Bstr (halDevices[i]),
+                                                               Bstr (description));
+                                        list.push_back (hostFloppyDrive);
+                                    }
+                                    else
+                                    {
+                                        if (product == 0)
+                                        {
+                                            LogRel(("Host::COMGETTER(FloppyDrives): failed to get property \"info.product\" for device %s.  dbus error: %s (%s)\n",
+                                                    halDevices[i], dbusError.name, dbusError.message));
+                                            dbus_error_free(&dbusError);
+                                        }
+                                        ComObjPtr <HostFloppyDrive> hostFloppyDrive;
+                                        hostFloppyDrive.createObject();
+                                        hostFloppyDrive->init (Bstr (devNode),
+                                                               Bstr (halDevices[i]));
+                                        list.push_back (hostFloppyDrive);
+                                    }
+                                    if (vendor != 0)
+                                    {
+                                        libhal_free_string(vendor);
+                                    }
+                                    if (product != 0)
+                                    {
+                                        libhal_free_string(product);
+                                    }
+                                }
+                                else
+                                {
+                                    LogRel(("Host::COMGETTER(FloppyDrives): failed to validate the block device %s as a floppy drive\n"));
+                                }
+                                libhal_free_string(devNode);
+                            }
+                            else
+                            {
+                                LogRel(("Host::COMGETTER(FloppyDrives): failed to get property \"block.device\" for device %s.  dbus error: %s (%s)\n",
+                                        halDevices[i], dbusError.name, dbusError.message));
+                                dbus_error_free(&dbusError);
+                            }
+                        }
+                        libhal_free_string_array(halDevices);
+                    }
+                    else
+                    {
+                        LogRel(("Host::COMGETTER(FloppyDrives): failed to get devices with capability \"storage.cdrom\".  dbus error: %s (%s)\n", dbusError.name, dbusError.message));
+                        dbus_error_free(&dbusError);
+                    }
+                    if (!libhal_ctx_shutdown(halContext, &dbusError))  /* what now? */
+                    {
+                        LogRel(("Host::COMGETTER(FloppyDrives): failed to shutdown the libhal context.  dbus error: %s (%s)\n", dbusError.name, dbusError.message));
+                        dbus_error_free(&dbusError);
+                    }
+                }
+                else
+                {
+                    LogRel(("Host::COMGETTER(FloppyDrives): failed to initialise libhal context.  dbus error: %s (%s)\n", dbusError.name, dbusError.message));
+                    dbus_error_free(&dbusError);
+                }
+                libhal_ctx_free(halContext);
+            }
+            else
+            {
+                LogRel(("Host::COMGETTER(FloppyDrives): failed to set libhal connection to dbus.\n"));
+            }
+        }
+        else
+        {
+            LogRel(("Host::COMGETTER(FloppyDrives): failed to get a libhal context - out of memory?\n"));
+        }
+        dbus_connection_unref(dbusConnection);
+    }
+    else
+    {
+        LogRel(("Host::COMGETTER(FloppyDrives): failed to connect to dbus.  dbus error: %s (%s)\n", dbusError.name, dbusError.message));
         dbus_error_free(&dbusError);
     }

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

@@ -3502 +3502 @@
             <desc>Returns a human readable description for the drive.</desc>
         </attribute>
+        <attribute name="udi" type="wstring" readonly="yes">
+            <desc>Returns the unique device identifier for the drive.</desc>
+        </attribute>
 
     </interface>
@@ -3540 +3543 @@
         <attribute name="name" type="wstring" readonly="yes">
             <desc>Returns the platform device identifier.</desc>
+        </attribute>
+        <attribute name="description" type="wstring" readonly="yes">
+            <desc>Returns a human readable description for the drive.</desc>
+        </attribute>
+        <attribute name="udi" type="wstring" readonly="yes">
+            <desc>Returns the unique device identifier for the drive.</desc>
         </attribute>
     </interface>

trunk/src/VBox/Main/include/HostDVDDriveImpl.h

@@ -53 +53 @@
 
     // public initializer/uninitializer for internal purposes only
-    HRESULT init (INPTR BSTR aName, INPTR BSTR aDescription = NULL);
+    HRESULT init (INPTR BSTR aName, INPTR BSTR aUdi = NULL, INPTR BSTR aDescription = NULL);
     void uninit();
 
     // IHostDVDDrive properties
     STDMETHOD(COMGETTER(Name)) (BSTR *aName);
+    STDMETHOD(COMGETTER(Udi)) (BSTR *aUdi);
     STDMETHOD(COMGETTER(Description)) (BSTR *aDescription);
 
@@ -64 +65 @@
     /* @note Must be called from under the object read lock. */
     const Bstr &name() const { return mName; }
+    const Bstr &udi() const { return mUdi; }
+    const Bstr &description() const { return mDescription; }
 
     // for VirtualBoxSupportErrorInfoImpl
@@ -72 +75 @@
     const Bstr mName;
     const Bstr mDescription;
+    const Bstr mUdi;
 };
 

trunk/src/VBox/Main/include/HostFloppyDriveImpl.h

@@ -53 +53 @@
 
     // public initializer/uninitializer for internal purposes only
-    HRESULT init (INPTR BSTR aName);
+    HRESULT init (INPTR BSTR aName, INPTR BSTR aUdi = NULL, INPTR BSTR aDescription = NULL);
     void uninit();
 
-    // IHostDVDDrive properties
+    // IHostFloppyDrive properties
     STDMETHOD(COMGETTER(Name)) (BSTR *aName);
+    STDMETHOD(COMGETTER(Description)) (BSTR *aDescription);
+    STDMETHOD(COMGETTER(Udi)) (BSTR *aUdi);
 
     // public methods for internal purposes only
@@ -63 +65 @@
     /* @note Must be called from under the object read lock. */
     const Bstr &name() const { return mName; }
+    const Bstr &udi() const { return mUdi; }
+    const Bstr &description() const { return mDescription; }
 
     // for VirtualBoxSupportErrorInfoImpl
@@ -70 +74 @@
 
     const Bstr mName;
+    const Bstr mDescription;
+    const Bstr mUdi;
 };
 

trunk/src/VBox/Main/include/HostImpl.h

@@ -36 +36 @@
 class SessionMachine;
 class HostDVDDrive;
+class HostFloppyDrive;
 class Progress;
 
@@ -133 +134 @@
 # ifdef VBOX_USE_LIBHAL
     bool getDVDInfoFromHal(std::list <ComObjPtr <HostDVDDrive> > &list);
+    bool getFloppyInfoFromHal(std::list <ComObjPtr <HostFloppyDrive> > &list);
 # endif
     void parseMountTable(char *mountTable, std::list <ComObjPtr <HostDVDDrive> > &list);