Merge lp:~osomon/unity-2d/custom-quicklists-dynamic into lp:unity-2d/3.0

[Olivier Tilloy]

[launcher] Support dynamic shortcuts in the quicklists.

Dynamic shortcuts are exposed over D-Bus by the application through the use of libunity.
See https://wiki.ubuntu.com/Unity/LauncherAPI#Dynamic%20Quicklist%20entries for documentation.

Note: at the moment, it seems the only application in the archive that implements dynamic quicklists is deja-dup.
To test, you will need to install deja-dup, start a backup, and observe the quicklist while backing up.
Alternatively, you can run example programs that pretend to be another application and expose dynamic a quicklist for it, see https://wiki.ubuntu.com/Unity/LauncherAPI#Example%20Code for details.

[Ugo Riboni (uriboni)]

Functionally it works OK. I tested it both with dejadup and with the example code.

The only issue that might be interesting to fix is that if the menu is already open, it's not updated. This leads to having some menu items that are not necessarily valid anymore. Not sure what will happen if you try to activate a menu item that the application has removed already.

review: Approve

[Ugo Riboni (uriboni)]

208 LauncherApplicationsList::onRemoteEntryUpdated(QString applicationURI, QMap<QString, QVariant> properties)
209 {
210 + QString sender = message().service();

For safety I would would check the result of calledFromDBus() before proceeding to access message()

Other than that, code looks good.

[Olivier Tilloy (osomon)]

> The only issue that might be interesting to fix is that if the menu is already
> open, it's not updated. This leads to having some menu items that are not
> necessarily valid anymore. Not sure what will happen if you try to activate a
> menu item that the application has removed already.

It is actually updated auto-magically :) (yes, I was surprised myself)
Try with the example code: launch the executable/script, open the contextual menu for evolution, and while it’s open, kill the example application: the menu items it added will disappear.

[Olivier Tilloy (osomon)]

> 208 LauncherApplicationsList::onRemoteEntryUpdated(QString
> applicationURI, QMap<QString, QVariant> properties)
> 209 {
> 210 + QString sender = message().service();
>
> For safety I would would check the result of calledFromDBus() before
> proceeding to access message()

This is true on principle (better safe than sorry). However onRemoteEntryUpdated is a private slot and it is only connected to D-Bus signals, so we are guaranteed that it is actually called from DBus.

[lp:~osomon/unity-2d/custom-quicklists-dynamic]

559. By Olivier Tilloy on 2011-05-18

For safety, always make sure we are called from DBus.

560. By Olivier Tilloy on 2011-05-18

Add a FIXME to explain a current limitation of the implementation.

[Ugo Riboni (uriboni)]

Good to go now. Good job, and please open a bug for the missing feature in the FIXME.

review: Approve

=== modified file 'launcher/UnityApplications/launcherapplication.cpp'
--- launcher/UnityApplications/launcherapplication.cpp	2011-04-28 13:09:25 +0000
+++ launcher/UnityApplications/launcherapplication.cpp	2011-05-18 10:59:25 +0000
@@ -54,9 +54,9 @@
 #include <QAction>
 #include <QDBusInterface>
 #include <QDBusReply>
+#include <QDBusServiceWatcher>
 #include <QFile>
 #include <QFileSystemWatcher>
-#include <QScopedPointer>
 
 extern "C" {
 #include <libsn/sn.h>
@@ -73,6 +73,7 @@
     , m_counter(0), m_counterVisible(false)
     , m_emblem(QString()), m_emblemVisible(false)
     , m_forceUrgent(false)
+    , m_dynamicQuicklistServiceWatcher(NULL)
 {
     m_launching_timer.setSingleShot(true);
     m_launching_timer.setInterval(8000);
@@ -840,15 +841,34 @@
             importer->updateMenu();
         }
     } else {
+        createDynamicMenuActions();
         createStaticMenuActions();
     }
 }
 
 void
+LauncherApplication::createDynamicMenuActions()
+{
+    if (!m_dynamicQuicklistImporter.isNull()) {
+        /* FIXME: the menu is only partially updated while visible: stale
+           actions will correctly be removed from the menu, but new actions
+           will not be added until the menu is closed and opened again.
+           This is an acceptable limitation for now. */
+        QList<QAction*> actions = m_dynamicQuicklistImporter->menu()->actions();
+        Q_FOREACH(QAction* action, actions) {
+            if (action->isSeparator()) {
+                m_menu->insertSeparatorBeforeTitle();
+            } else {
+                connect(action, SIGNAL(triggered()), m_menu, SLOT(hide()));
+                m_menu->insertActionBeforeTitle(action);
+            }
+        }
+    }
+}
+
+void
 LauncherApplication::createStaticMenuActions()
 {
-    QList<QAction*> actions;
-
     /* Custom menu actions from the desktop file. */
     if (!m_staticShortcuts.isNull()) {
         const gchar** nicks = indicator_desktop_shortcuts_get_nicks(m_staticShortcuts.data());
@@ -859,15 +879,15 @@
                 QAction* action = new QAction(m_menu);
                 action->setText(QString::fromUtf8(indicator_desktop_shortcuts_nick_get_name(m_staticShortcuts.data(), nick)));
                 action->setProperty(SHORTCUT_NICK_PROPERTY, QVariant(nick));
-                actions.append(action);
+                m_menu->insertActionBeforeTitle(action);
                 connect(action, SIGNAL(triggered()), SLOT(onStaticShortcutTriggered()));
                 ++i;
             }
         }
     }
-    m_menu->insertActions(m_menu->actions().first(), actions);
+    m_menu->insertSeparatorBeforeTitle();
 
-    actions.clear();
+    QList<QAction*> actions;
     bool is_running = running();
 
     /* Only applications with a corresponding desktop file can be kept in the launcher */
@@ -922,15 +942,16 @@
     QList<QAction*> actions = importer->menu()->actions();
     Q_FOREACH(QAction* action, actions) {
         if (action->isSeparator()) {
-            m_menu->addSeparator();
+            m_menu->insertSeparatorBeforeTitle();
         } else {
             connect(action, SIGNAL(triggered()), m_menu, SLOT(hide()));
-            m_menu->addAction(action);
+            m_menu->insertActionBeforeTitle(action);
         }
     }
 
     if (++m_indicatorMenusReady == m_indicatorMenus.size()) {
         /* All indicator menus have been updated. */
+        createDynamicMenuActions();
         createStaticMenuActions();
     }
 }
@@ -975,7 +996,7 @@
 }
 
 void
-LauncherApplication::updateOverlaysState(QMap<QString, QVariant> properties)
+LauncherApplication::updateOverlaysState(const QString& sender, QMap<QString, QVariant> properties)
 {
     if (updateOverlayState(properties, "progress", &m_progress)) {
         Q_EMIT progressChanged(m_progress);
@@ -995,5 +1016,34 @@
     if (updateOverlayState(properties, "emblem-visible", &m_emblemVisible)) {
         Q_EMIT emblemVisibleChanged(m_emblemVisible);
     }
+    if (updateOverlayState(properties, "quicklist", &m_dynamicQuicklistPath)) {
+        setDynamicQuicklistImporter(sender);
+    }
+}
+
+void
+LauncherApplication::setDynamicQuicklistImporter(const QString& service)
+{
+    if (m_dynamicQuicklistPath.isEmpty() || service.isEmpty()) {
+        m_dynamicQuicklistImporter.reset();
+    } else {
+        m_dynamicQuicklistImporter.reset(new DBusMenuImporter(service, m_dynamicQuicklistPath));
+        m_dynamicQuicklistImporter->updateMenu();
+        if (m_dynamicQuicklistServiceWatcher == NULL) {
+            m_dynamicQuicklistServiceWatcher = new QDBusServiceWatcher(this);
+            m_dynamicQuicklistServiceWatcher->setConnection(QDBusConnection::sessionBus());
+            connect(m_dynamicQuicklistServiceWatcher,
+                    SIGNAL(serviceOwnerChanged(const QString&, const QString&, const QString&)),
+                    SLOT(dynamicQuicklistImporterServiceOwnerChanged(const QString&, const QString&, const QString&)));
+        }
+        m_dynamicQuicklistServiceWatcher->addWatchedService(service);
+    }
+}
+
+void
+LauncherApplication::dynamicQuicklistImporterServiceOwnerChanged(const QString& serviceName, const QString& oldOwner, const QString& newOwner)
+{
+    m_dynamicQuicklistServiceWatcher->removeWatchedService(oldOwner);
+    setDynamicQuicklistImporter(newOwner);
 }
 

=== modified file 'launcher/UnityApplications/launcherapplication.h'
--- launcher/UnityApplications/launcherapplication.h	2011-04-28 06:59:39 +0000
+++ launcher/UnityApplications/launcherapplication.h	2011-05-18 10:59:25 +0000
@@ -36,6 +36,7 @@
 #include <QTimer>
 #include <QHash>
 #include <QPointer>
+#include <QScopedPointer>
 
 #include "bamf-application.h"
 
@@ -46,6 +47,7 @@
 
 class DBusMenuImporter;
 class QFileSystemWatcher;
+class QDBusServiceWatcher;
 
 typedef GObjectScopedPointer<GAppInfo> GAppInfoPointer;
 typedef GObjectScopedPointer<GDesktopAppInfo> GDesktopAppInfoPointer;
@@ -110,7 +112,7 @@
 
     static void showWindow(WnckWindow* window);
     static void moveViewportToWindow(WnckWindow* window);
-    void updateOverlaysState(QMap<QString, QVariant> properties);
+    void updateOverlaysState(const QString& sender, QMap<QString, QVariant> properties);
 
 Q_SIGNALS:
     void stickyChanged(bool);
@@ -154,6 +156,8 @@
     void beginForceUrgent(int duration);
     void endForceUrgent();
 
+    void dynamicQuicklistImporterServiceOwnerChanged(const QString& serviceName, const QString& oldOwner, const QString& newOwner);
+
 private:
     QPointer<BamfApplication> m_application;
     QFileSystemWatcher *m_desktopFileWatcher;
@@ -175,12 +179,17 @@
     void updateBamfApplicationDependentProperties();
     void monitorDesktopFile(const QString&);
     void fetchIndicatorMenus();
+    void createDynamicMenuActions();
     void createStaticMenuActions();
     int windowCountOnCurrentWorkspace();
     template<typename T>
     bool updateOverlayState(QMap<QString, QVariant> properties,
                             QString propertyName, T* member);
 
+    QString m_dynamicQuicklistPath;
+    QScopedPointer<DBusMenuImporter> m_dynamicQuicklistImporter;
+    QDBusServiceWatcher* m_dynamicQuicklistServiceWatcher;
+    void setDynamicQuicklistImporter(const QString& service);
     IndicatorDesktopShortcutsPointer m_staticShortcuts;
 };
 

=== modified file 'launcher/UnityApplications/launcherapplicationslist.cpp'
--- launcher/UnityApplications/launcherapplicationslist.cpp	2011-04-28 13:09:25 +0000
+++ launcher/UnityApplications/launcherapplicationslist.cpp	2011-05-18 10:59:25 +0000
@@ -23,9 +23,13 @@
 #include "bamf-application.h"
 #include "gconfitem-qml-wrapper.h"
 
+// unity-2d
+#include <debug_p.h>
+
 #include <QStringList>
 #include <QDir>
 #include <QDBusConnection>
+#include <QDBusMessage>
 #include <QFileInfo>
 #include <QX11Info>
 
@@ -134,6 +138,8 @@
 void
 LauncherApplicationsList::onRemoteEntryUpdated(QString applicationURI, QMap<QString, QVariant> properties)
 {
+    UQ_RETURN_IF_FAIL(calledFromDBus());
+    QString sender = message().service();
     QString desktopFile;
     if (applicationURI.indexOf("application://") == 0) {
         desktopFile = applicationURI.mid(14);
@@ -144,7 +150,7 @@
 
     Q_FOREACH(LauncherApplication *application, m_applications) {
         if (QFileInfo(application->desktop_file()).fileName() == desktopFile) {
-            application->updateOverlaysState(properties);
+            application->updateOverlaysState(sender, properties);
             return;
         }
     }

=== modified file 'launcher/UnityApplications/launcherapplicationslist.h'
--- launcher/UnityApplications/launcherapplicationslist.h	2011-04-15 12:09:09 +0000
+++ launcher/UnityApplications/launcherapplicationslist.h	2011-05-18 10:59:25 +0000
@@ -25,6 +25,7 @@
 #include <QObject>
 #include <QtDeclarative/qdeclarative.h>
 #include <QMap>
+#include <QDBusContext>
 
 #include <unity2dapplication.h>
 
@@ -37,7 +38,7 @@
 class BamfView;
 class GConfItemQmlWrapper;
 
-class LauncherApplicationsList : public QAbstractListModel, protected AbstractX11EventFilter
+class LauncherApplicationsList : public QAbstractListModel, protected AbstractX11EventFilter, protected QDBusContext
 {
     Q_OBJECT
     friend class LauncherApplicationsListDBUS;

=== modified file 'launcher/UnityApplications/launchermenu.cpp'
--- launcher/UnityApplications/launchermenu.cpp	2011-04-28 07:45:05 +0000
+++ launcher/UnityApplications/launchermenu.cpp	2011-05-18 10:59:25 +0000
@@ -203,7 +203,6 @@
             }
         }
     } else {
-        insertSeparator(m_titleAction);
         addSeparator();
         m_launcherItem->createMenuActions();
 
@@ -304,3 +303,15 @@
     }
 }
 
+void
+LauncherContextualMenu::insertActionBeforeTitle(QAction* action)
+{
+    insertAction(m_titleAction, action);
+}
+
+QAction*
+LauncherContextualMenu::insertSeparatorBeforeTitle()
+{
+    return insertSeparator(m_titleAction);
+}
+

=== modified file 'launcher/UnityApplications/launchermenu.h'
--- launcher/UnityApplications/launchermenu.h	2011-03-21 10:33:16 +0000
+++ launcher/UnityApplications/launchermenu.h	2011-05-18 10:59:25 +0000
@@ -55,6 +55,9 @@
     Q_INVOKABLE void hide();
     Q_INVOKABLE void hideWithDelay(int delay);
 
+    void insertActionBeforeTitle(QAction* action);
+    QAction* insertSeparatorBeforeTitle();
+
 protected:
     void resizeEvent(QResizeEvent* event);
     void leaveEvent(QEvent* event);