Changeset 89815 in vbox

Timestamp:

Jun 21, 2021 12:06:22 PM (3 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:3355. Dynamically introrespecting DBus screen saver interfaces.

Location:

trunk/src/VBox/Frontends/VirtualBox

Files:

• Makefile.kmk (modified) (1 diff)
• src/platform/x11/VBoxX11Helper.cpp (modified) (4 diffs)
• src/platform/x11/VBoxX11Helper.h (modified) (3 diffs)
• src/runtime/UIMachineLogic.cpp (modified) (2 diffs)
• src/runtime/UIMachineLogic.h (modified) (3 diffs)

trunk/src/VBox/Frontends/VirtualBox/Makefile.kmk

@@ -1557 +1557 @@
 UICommon_QT_MODULES.linux   += X11Extras
 UICommon_QT_MODULES.linux   += DBus
+UICommon_QT_MODULES.linux   += Xml
 UICommon_QT_MODULES.solaris += X11Extras
 UICommon_QT_MODULES.solaris += DBus
+UICommon_QT_MODULES.solaris += Xml
 UICommon_QT_MODULES.freebsd += X11Extras
 UICommon_QT_MODULES.freebsd += DBus
+UICommon_QT_MODULES.freebsd += Xml
 UICommon_QT_MODULES.darwin  += MacExtras
 UICommon_QT_MODULES.win     += WinExtras

trunk/src/VBox/Frontends/VirtualBox/src/platform/x11/VBoxX11Helper.cpp

@@ -17 +17 @@
 
 /* Qt includes: */
-#include <QString>
 #include <QX11Info>
 #include <QtDBus/QDBusConnection>
@@ -23 +22 @@
 #include <QtDBus/QDBusInterface>
 #include <QtDBus/QDBusConnectionInterface>
+#include <QtXml/QDomDocument>
+#include <QtXml/QDomElement>
 
 /* GUI includes: */
@@ -162 +163 @@
 }
 
-QStringList X11ScrenSaverServices()
+static QStringList X11FindDBusScreenSaverServices(const QDBusConnection &connection)
 {
     QStringList serviceNames;
-    QDBusConnection bus = QDBusConnection::sessionBus();
-    QDBusReply<QStringList> replyr = bus.interface()->registeredServiceNames();
+
+    QDBusReply<QStringList> replyr = connection.interface()->registeredServiceNames();
     if (!replyr.isValid())
+    {
+        const QDBusError replyError = replyr.error();
+        LogRel(("QDBus error. Could not query registered service names %s %s",
+                replyError.name().toUtf8().constData(), replyError.message().toUtf8().constData()));
         return serviceNames;
+    }
+
     for (int i = 0; i < replyr.value().size(); ++i)
     {
@@ -176 +183 @@
     }
     if (serviceNames.isEmpty())
-        LogRel(("No screen saver service found among registered DBus services."));
+        LogRel(("QDBus error. No screen saver service found among registered DBus services."));
 
     return serviceNames;
 }
 
-void X11InhibitScrenSaver(const QStringList &serviceNameList, QMap<QString, uint> &outCookies)
-{
-    outCookies.clear();
-    QDBusConnection bus = QDBusConnection::sessionBus();
-
-    foreach(QString service, serviceNameList)
-    {
-        QDBusInterface screenSaverInterface(service, "/ScreenSaver",
-                                            service, bus);
+static void X11IntrorespectInterfaceNode(const QDomElement &interface,
+                                         const QString &strServiceName, QVector<X11ScreenSaverInhibitMethod*> &methods)
+{
+    QDomElement child = interface.firstChildElement();
+    while (!child.isNull()) {
+
+        if (child.tagName() == "method" && child.attribute("name") == "Inhibit")
+        {
+            X11ScreenSaverInhibitMethod *newMethod = new X11ScreenSaverInhibitMethod;
+            newMethod->m_iCookie = 0;
+            newMethod->m_strServiceName = strServiceName;
+            newMethod->m_strInterface = interface.attribute("name");
+            newMethod->m_strPath = "/";
+            newMethod->m_strPath.append(interface.attribute("name"));
+            newMethod->m_strPath.replace(".", "/");
+            methods << newMethod;
+        }
+        child = child.nextSiblingElement();
+    }
+}
+
+static void X11IntrorespectServices(const QDBusConnection &connection,
+                                    const QString &strService, const QString &path, QVector<X11ScreenSaverInhibitMethod*> &methods)
+{
+    QDBusMessage call = QDBusMessage::createMethodCall(strService, path.isEmpty() ? QLatin1String("/") : path,
+                                                       QLatin1String("org.freedesktop.DBus.Introspectable"),
+                                                       QLatin1String("Introspect"));
+    QDBusReply<QString> xmlReply = connection.call(call);
+
+    if (!xmlReply.isValid())
+        return;
+
+    QDomDocument doc;
+    doc.setContent(xmlReply);
+    QDomElement node = doc.documentElement();
+    QDomElement child = node.firstChildElement();
+    while (!child.isNull())
+    {
+        if (child.tagName() == QLatin1String("node"))
+        {
+            QString subPath = path + QLatin1Char('/') + child.attribute(QLatin1String("name"));
+            X11IntrorespectServices(connection, strService, subPath, methods);
+        }
+        else if (child.tagName() == QLatin1String("interface"))
+            X11IntrorespectInterfaceNode(child, strService, methods);
+        child = child.nextSiblingElement();
+    }
+}
+
+static bool X11CheckDBusConnection(const QDBusConnection &connection)
+{
+    if (!connection.isConnected()) {
+        const QDBusError lastError = connection.lastError();
+        if (lastError.isValid())
+        {
+            LogRel(("QDBus error. Could not connect to D-Bus server: %s: %s\n",
+                    lastError.name().toUtf8().constData(),
+                    lastError.message().toUtf8().constData()));
+        }
+        else
+            LogRel(("QDBus error. Could not connect to D-Bus server: Unable to load dbus libraries\n"));
+        return false;
+    }
+    return true;
+}
+
+QVector<X11ScreenSaverInhibitMethod*> X11FindDBusScrenSaverInhibitMethods()
+{
+    QVector<X11ScreenSaverInhibitMethod*> methods;
+
+    QDBusConnection connection = QDBusConnection::sessionBus();
+    if (!X11CheckDBusConnection(connection))
+        return methods;
+
+    foreach(const QString &strServiceName, X11FindDBusScreenSaverServices(connection))
+        X11IntrorespectServices(connection, strServiceName, "", methods);
+
+    return methods;
+}
+
+void X11InhibitUninhibitScrenSaver(bool fInhibit, QVector<X11ScreenSaverInhibitMethod*> &inOutIhibitMethods)
+{
+    QDBusConnection connection = QDBusConnection::sessionBus();
+    if (!X11CheckDBusConnection(connection))
+        return;
+    for (int i = 0; i < inOutIhibitMethods.size(); ++i)
+    {
+        QDBusInterface screenSaverInterface(inOutIhibitMethods[i]->m_strServiceName, inOutIhibitMethods[i]->m_strPath,
+                                            inOutIhibitMethods[i]->m_strInterface, connection);
         if (!screenSaverInterface.isValid())
         {
             QDBusError error = screenSaverInterface.lastError();
-            LogRel(("QDBus error for service %s: %s\n",
-                    service.toUtf8().constData(), error.message().toUtf8().constData()));
+            LogRel(("QDBus error for service %s: %s. %s\n",
+                    inOutIhibitMethods[i]->m_strServiceName.toUtf8().constData(),
+                    error.name().toUtf8().constData(),
+                    error.message().toUtf8().constData()));
             continue;
         }
-        QDBusReply<uint> reply = screenSaverInterface.call("Inhibit", "Oracle VirtualBox", "");
-        if (reply.isValid())
-            outCookies[service] = reply.value();
+        QDBusReply<uint> reply;
+        if (fInhibit)
+        {
+            reply = screenSaverInterface.call("Inhibit", "Oracle VirtualBox", "ScreenSaverInhibit");
+            if (reply.isValid())
+                inOutIhibitMethods[i]->m_iCookie = reply.value();
+        }
         else
         {
-            QDBusError error = screenSaverInterface.lastError();
-            LogRel(("QDBus inhibition call error for service %s: %s\n",
-                    service.toUtf8().constData(), error.message().toUtf8().constData()));
-        }
-    }
-}
-
-void X11UninhibitScrenSaver(const QMap<QString, uint> &cookies)
-{
-
-    QDBusConnection bus = QDBusConnection::sessionBus();
-
-    for (QMap<QString, uint>::const_iterator iterator = cookies.begin(); iterator != cookies.end(); ++iterator)
-    {
-
-        QDBusInterface screenSaverInterface(iterator.key(), "/ScreenSaver",
-                                            iterator.key(), bus);
-        if (!screenSaverInterface.isValid())
-        {
-            QDBusError error = screenSaverInterface.lastError();
-            LogRel(("QDBus error for service %s: %s\n",
-                    iterator.key().toUtf8().constData(), error.message().toUtf8().constData()));
-            continue;
-        }
-        QDBusReply<uint> reply = screenSaverInterface.call("UnInhibit", iterator.value());
+            reply = screenSaverInterface.call("UnInhibit", inOutIhibitMethods[i]->m_iCookie);
+        }
         if (!reply.isValid())
         {
-            QDBusError error = screenSaverInterface.lastError();
-            LogRel(("QDBus uninhibition call error for service %s: %s\n",
-                    iterator.key().toUtf8().constData(), error.message().toUtf8().constData()));
-        }
-    }
-}
-
+            QDBusError error = reply.error();
+            LogRel(("QDBus inhibition call error for service %s: %s. %s\n",
+                    inOutIhibitMethods[i]->m_strServiceName.toUtf8().constData(),
+                    error.name().toUtf8().constData(),
+                    error.message().toUtf8().constData()));
+        }
+    }
+}
 
 #ifdef VBOX_WS_X11

trunk/src/VBox/Frontends/VirtualBox/src/platform/x11/VBoxX11Helper.h

@@ -22 +22 @@
 #endif
 
+/* Qt includes: */
+#include <QString>
+
 /* GUI includes: */
 #include "UILibraryDefs.h"
@@ -38 +41 @@
 };
 
+struct X11ScreenSaverInhibitMethod
+{
+    QString m_strServiceName;
+    QString m_strInterface;
+    QString m_strPath;
+    uint    m_iCookie;
+};
 
 /** X11: Determines and returns whether the compositing manager is running. */
@@ -54 +64 @@
 SHARED_LIBRARY_STUFF bool X11CheckExtension(const char *extensionName);
 
-/* Returns the list of DBus screensaver services.*/
-SHARED_LIBRARY_STUFF QStringList X11ScrenSaverServices();
+/** Returns the list of Inhibit methods found by introrespecting DBus services. */
+SHARED_LIBRARY_STUFF QVector<X11ScreenSaverInhibitMethod*> X11FindDBusScrenSaverInhibitMethods();
 
-/* Disables Screen Saver through QDBus. */
-SHARED_LIBRARY_STUFF  void X11InhibitScrenSaver(const QStringList &serviceNameList, QMap<QString, uint> &outCookies);
-
-/* Enables Screen Saver through QDBus. */
-SHARED_LIBRARY_STUFF  void X11UninhibitScrenSaver(const QMap<QString, uint> &cookies);
+/** Disables/enables Screen Saver through QDBus. */
+SHARED_LIBRARY_STUFF void X11InhibitUninhibitScrenSaver(bool fInhibit, QVector<X11ScreenSaverInhibitMethod*> &inOutIhibitMethods);
 
 #endif /* !FEQT_INCLUDED_SRC_platform_x11_VBoxX11Helper_h */

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineLogic.cpp

@@ -714 +714 @@
 {
 #if defined(VBOX_WS_X11)
-    QStringList services = X11ScrenSaverServices();
-    if (services.isEmpty())
-        return;
-
-    if (fDisabled)
-        X11InhibitScrenSaver(services, m_screenSaverInhibitionCookies);
-    else
-        X11UninhibitScrenSaver(m_screenSaverInhibitionCookies);
+    if (m_methods.isEmpty())
+        m_methods = X11FindDBusScrenSaverInhibitMethods();
+    X11InhibitUninhibitScrenSaver(fDisabled, m_methods);
 #elif defined(VBOX_WS_WIN)
     NativeWindowSubsystem::setScreenSaverActive(fDisabled);
@@ -887 +882 @@
     , m_pVMInformationDialog(0)
 {
+}
+
+UIMachineLogic::~UIMachineLogic()
+{
+    qDeleteAll(m_methods.begin(), m_methods.end());
+    m_methods.clear();
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineLogic.h

@@ -53 +53 @@
 class CUSBDevice;
 class CVirtualBoxErrorInfo;
+struct X11ScreenSaverInhibitMethod;
 
 #ifdef VBOX_WITH_DEBUGGER_GUI
@@ -207 +208 @@
     /* Constructor: */
     UIMachineLogic(QObject *pParent, UISession *pSession, UIVisualStateType visualStateType);
+    /* Destructor: */
+    ~UIMachineLogic();
 
     /* Protected getters/setters: */
@@ -463 +466 @@
     /* Holds the cookies returnd by QDBus inhibition calls. Map keys are service name. These are required during uninhibition.*/
     QMap<QString, uint> m_screenSaverInhibitionCookies;
-
+    QVector<X11ScreenSaverInhibitMethod*> m_methods;
     /* Friend classes: */
     friend class UIMachineWindow;