Merge lp:~fboucault/unity-2d/panel_whitelist into lp:unity-2d

[Florian Boucault]

[panel] legacytray applet: implement a whitelist of applications that are allowed to be shown.

Whitelist is shared with Unity 3D and stored in D-Conf.

[Alberto Mardegan (mardy)]

Code is good and the feature works properly.

But it seems to me that libwnck is not necessary here (at least, the code seems to work as well without it). I assume it's something that you forgot to remove?

review: Needs Fixing

[Florian Boucault (fboucault)]

> Code is good and the feature works properly.
>
> But it seems to me that libwnck is not necessary here (at least, the code
> seems to work as well without it). I assume it's something that you forgot to
> remove?

Absolutely! I wanted to use the newly introduced API of wnck that gives us the WM_CLASS for a given xid but it did not work reliably in my experiments.

[Florian Boucault (fboucault)]

And fixed.

[lp:~fboucault/unity-2d/panel_whitelist]

686. By Florian Boucault on 2011-09-01

Removed unused dependency on libwnck.

[Alberto Mardegan (mardy)]

Excellent, thanks!

review: Approve

=== modified file 'panel/applets/legacytray/CMakeLists.txt'
--- panel/applets/legacytray/CMakeLists.txt	2011-08-12 15:17:23 +0000
+++ panel/applets/legacytray/CMakeLists.txt	2011-09-01 09:04:30 +0000
@@ -15,6 +15,7 @@
 include_directories(
     ${CMAKE_CURRENT_SOURCE_DIR}
     ${CMAKE_CURRENT_BINARY_DIR}
+    ${DCONFQT_INCLUDE_DIRS}
     ${X11_INCLUDE_DIR}
     ${libunity-2d-private_SOURCE_DIR}/src
     )
@@ -30,6 +31,7 @@
 target_link_libraries(panelplugin-legacytray
     ${QT_QTGUI_LIBRARIES}
     ${QT_QTCORE_LIBRARIES}
+    ${DCONFQT_LIBRARIES}
     ${X11_LIBRARIES}
     ${X11_Xrender_LIB}
     ${X11_Xcomposite_LIB}
 
=== modified file 'panel/applets/legacytray/fdotask.cpp'
--- panel/applets/legacytray/fdotask.cpp	2011-02-02 16:57:00 +0000
+++ panel/applets/legacytray/fdotask.cpp	2011-09-01 09:04:30 +0000
@@ -31,6 +31,10 @@
 
 // Qt
 #include <QEvent>
+#include <QX11Info>
+
+// Others
+#include <X11/Xutil.h>
 
 namespace SystemTray
 {
@@ -54,6 +58,34 @@
     QMetaObject::invokeMethod(this, "setupXEmbedDelegate", Qt::QueuedConnection);
 }
 
+static void get_xwindow_wmclass(Window xwindow, QString& wmClass, QString& wmName)
+{
+    Display *xdisplay = QX11Info::display();
+
+    XClassHint hint;
+    hint.res_name = NULL;
+    hint.res_class = NULL;
+
+    XGetClassHint (xdisplay, xwindow, &hint);
+
+    if (hint.res_name) {
+        wmName = QString::fromAscii(hint.res_name);
+        XFree (hint.res_name);
+    }
+
+    if (hint.res_class) {
+        wmClass = QString::fromAscii(hint.res_class);
+        XFree (hint.res_class);
+    }
+}
+
+QString FdoTask::name()
+{
+    QString wmName, wmClass;
+    get_xwindow_wmclass(m_id, wmClass, wmName);
+    return wmClass;
+}
+
 void FdoTask::setupXEmbedDelegate()
 {
     if (m_widget) {
 
=== modified file 'panel/applets/legacytray/fdotask.h'
--- panel/applets/legacytray/fdotask.h	2011-01-15 01:41:03 +0000
+++ panel/applets/legacytray/fdotask.h	2011-09-01 09:04:30 +0000
@@ -42,6 +42,7 @@
     {}
 
     virtual void createWidget() = 0;
+    virtual QString name() = 0;
 };
 
 class FdoTask : public Task
@@ -52,6 +53,7 @@
     ~FdoTask();
 
     virtual void createWidget();
+    virtual QString name();
 
 Q_SIGNALS:
     void taskDeleted(WId);
 
=== modified file 'panel/applets/legacytray/legacytrayapplet.cpp'
--- panel/applets/legacytray/legacytrayapplet.cpp	2011-08-22 09:17:03 +0000
+++ panel/applets/legacytray/legacytrayapplet.cpp	2011-09-01 09:04:30 +0000
@@ -29,13 +29,20 @@
 // libunity-2d-private
 #include <debug_p.h>
 
+// libdconf-qt
+#include <qconf.h>
+
 // Qt
 #include <QApplication>
 #include <QHBoxLayout>
+#include <QVariant>
+
+#define PANEL_DCONF_SCHEMA QString("com.canonical.Unity.Panel")
 
 LegacyTrayApplet::LegacyTrayApplet(Unity2dPanel* panel)
 : Unity2d::PanelApplet(panel)
 , m_selectionManager(new SystemTray::FdoSelectionManager)
+, m_dconfPanel(new QConf(PANEL_DCONF_SCHEMA))
 {
     QApplication::setAttribute(Qt::AA_DontCreateNativeWidgetSiblings);
 
@@ -45,15 +52,27 @@
 
     connect(m_selectionManager, SIGNAL(taskCreated(SystemTray::Task*)),
         SLOT(slotTaskCreated(SystemTray::Task*)));
+
+    m_whitelist = m_dconfPanel->property("systrayWhitelist").toStringList();
 }
 
 LegacyTrayApplet::~LegacyTrayApplet()
 {
     delete m_selectionManager;
+    delete m_dconfPanel;
 }
 
 void LegacyTrayApplet::slotTaskCreated(SystemTray::Task* task)
 {
+    /* Only accept tasks whose name is in the whitelist.
+       The whitelist contains a "List of client names, resource classes or wm
+       classes to allow in the Panel's systray implementation." but here we only
+       support matching on WM_CLASS.
+    */
+    if (!m_whitelist.contains(task->name())) {
+        return;
+    }
+
     task->createWidget();
     connect(task, SIGNAL(widgetCreated(QWidget*)), SLOT(slotWidgetCreated(QWidget*)));
 }
 
=== modified file 'panel/applets/legacytray/legacytrayapplet.h'
--- panel/applets/legacytray/legacytrayapplet.h	2011-08-22 09:17:03 +0000
+++ panel/applets/legacytray/legacytrayapplet.h	2011-09-01 09:04:30 +0000
@@ -31,6 +31,8 @@
 class Task;
 }
 
+class QConf;
+
 class LegacyTrayApplet : public Unity2d::PanelApplet
 {
 Q_OBJECT
@@ -46,6 +48,8 @@
     Q_DISABLE_COPY(LegacyTrayApplet)
     
     SystemTray::FdoSelectionManager* m_selectionManager;
+    QConf* m_dconfPanel;
+    QStringList m_whitelist;
 };
 
 #endif /* LEGACYTRAYAPPLET_H */