Merge lp:~dandrader/qtmir/focusInfoSurfaceId into lp:qtmir

[Daniel d'Andrada]

DBusFocusInfo: added isSurfaceFocused(serializedId)

* Are there any related MPs required for this MP to build/function as expected? Please list.
https://code.launchpad.net/~unity-team/unity-api/persistent_surface_id/+merge/303552
https://code.launchpad.net/~unity-team/unity8/persistent_surface_id/+merge/303600

For testing you also need:
https://code.launchpad.net/~dandrader/qtubuntu/content-hub-clipboard/+merge/301272
https://code.launchpad.net/~ken-vandine/content-hub/pasteboard/+merge/296352

* Did you perform an exploratory manual test run of your code change and any related functionality?
Yes

* If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
N/A

[Unity8 CI Bot (unity8-ci-bot)]

FAILED: Continuous integration, rev:550
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/344/
Executed test runs:
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build/2646/console
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/2674
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2548
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2548
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2548
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=vivid+overlay/2542/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/2542/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=yakkety/2542/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=vivid+overlay/2542/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/2542/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=yakkety/2542/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=vivid+overlay/2542/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/2542/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=yakkety/2542/console

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/344/rebuild

review: Needs Fixing (continuous-integration)

[Gerry Boland (gerboland)]

+ Enables other processes to check who's the curretly focused application or surface,
typo "currently" and s/who's/what is/

review: Needs Fixing

[Daniel d'Andrada (dandrader)]

On 24/08/2016 06:48, Gerry Boland wrote:
> Review: Needs Fixing
>
> + Enables other processes to check who's the curretly focused application or surface,
> typo "currently" and s/who's/what is/
>
>
Fixed.

[Unity8 CI Bot (unity8-ci-bot)]

FAILED: Continuous integration, rev:551
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/345/
Executed test runs:
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build/2652/console
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/2680
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2553
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2553
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2553
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=vivid+overlay/2547/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/2547/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=yakkety/2547/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=vivid+overlay/2547/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/2547/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=yakkety/2547/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=vivid+overlay/2547/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/2547/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=yakkety/2547/console

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/345/rebuild

review: Needs Fixing (continuous-integration)

[Gerry Boland (gerboland)]

Code looks ok, how can I test?

[Daniel d'Andrada (dandrader)]

> Code looks ok, how can I test?

- Apply this patch http://pastebin.ubuntu.com/23085097/ so that you can conveniently see the persistent surface ids in unity8.log

- Launch an app and copy its surface id by looking into its log entry which should look like this:

qtmir.surfaces: MirSurface[0x204a090,"webbrowser-app"]::MirSurface("1a711701-97a1-417d-b867-586cbb2d8477")

- Call isSurfaceFocused over dbus and check the result when the launched app is focused and when it's not.

$ gdbus call --session --dest com.canonical.Unity.FocusInfo --object-path /com/canonical/Unity/FocusInfo --method com.canonical.Unity.FocusInfo.isSurfaceFocused "1a711701-97a1-417d-b867-586cbb2d8477"

[Tyler Hicks (tyhicks)]

Thank you for implementing this! From a security standpoint, it is much better than the PID based API.

[lp:~dandrader/qtmir/focusInfoSurfaceId]

550. By Daniel d'Andrada on 2016-08-26

DBusFocusInfo.isPidFocused: search sessions recursively (LP: #1612166)

Approved by: Gerry Boland, Unity8 CI Bot

551. By Michał Sawicz on 2016-08-26

Revert r538 that's causing a unity8 crash when launching emergency dialer over greeter (LP: #1616842)

Approved by: Unity8 CI Bot

552. By CI Train Bot Account on 2016-08-26

Releasing 0.4.8+16.10.20160826.1-0ubuntu1

[Michael Terry (mterry)]

Gerry liked the code. Code seems fine to me too. I tested this with silo 37 and it worked fine (was able to confirm dbus call worked with command line gdbus).

review: Approve

[lp:~dandrader/qtmir/focusInfoSurfaceId]

553. By Daniel d'Andrada on 2016-08-30

Merge lp:~unity-team/qtmir/persistent_surface_id

554. By Daniel d'Andrada on 2016-08-30

DBusFocusInfo: added isSurfaceFocused(serializedId)

=== modified file 'src/modules/Unity/Application/dbusfocusinfo.cpp'
--- src/modules/Unity/Application/dbusfocusinfo.cpp	2016-08-25 15:27:47 +0000
+++ src/modules/Unity/Application/dbusfocusinfo.cpp	2016-08-30 12:31:05 +0000
@@ -18,6 +18,9 @@
 
 // local
 #include "cgmanager.h"
+#include "mirsurfacelistmodel.h"
+#include "mirsurfaceinterface.h"
+#include "session_interface.h"
 
 // QPA mirserver
 #include <logging.h>
@@ -93,3 +96,35 @@
     });
     return sessionWithPid;
 }
+
+bool DBusFocusInfo::isSurfaceFocused(const QString &serializedId)
+{
+    MirSurfaceInterface *qmlSurface = findQmlSurface(serializedId);
+    bool result = qmlSurface ? qmlSurface->activeFocus() : false;
+    qCDebug(QTMIR_DBUS).nospace() << "DBusFocusInfo: isSurfaceFocused("<<serializedId<<") -> " << result;
+    return result;
+}
+
+MirSurfaceInterface *DBusFocusInfo::findQmlSurface(const QString &serializedId)
+{
+    for (Application* application : m_applications) {
+        auto session = application->session();
+
+        auto surfaceList = static_cast<MirSurfaceListModel*>(session->surfaceList());
+        for (int i = 0; i < surfaceList->count(); ++i) {
+            auto qmlSurface = static_cast<MirSurfaceInterface*>(surfaceList->get(i));
+            if (qmlSurface->persistentId() == serializedId) {
+                return qmlSurface;
+            }
+        }
+
+        surfaceList = static_cast<MirSurfaceListModel*>(session->promptSurfaceList());
+        for (int i = 0; i < surfaceList->count(); ++i) {
+            auto qmlSurface = static_cast<MirSurfaceInterface*>(surfaceList->get(i));
+            if (qmlSurface->persistentId() == serializedId) {
+                return qmlSurface;
+            }
+        }
+    }
+    return nullptr;
+}

=== modified file 'src/modules/Unity/Application/dbusfocusinfo.h'
--- src/modules/Unity/Application/dbusfocusinfo.h	2016-08-25 15:10:24 +0000
+++ src/modules/Unity/Application/dbusfocusinfo.h	2016-08-30 12:31:05 +0000
@@ -22,10 +22,11 @@
 namespace qtmir {
 
 class CGManager;
+class MirSurfaceInterface;
 
 /*
-  FIXME: This is a hack to provide OSK with needed info for avoiding input snooping.
-         Remove when possible
+   Enables other processes to check what is the currently focused application or surface,
+   normally for security purposes.
  */
 class DBusFocusInfo : public QObject
 {
@@ -39,13 +40,22 @@
 
     /*
         Returns true if the application with the given PID has input focus
+
+        FIXME: Identifying an app through its PID is deemed racy.
+               isSurfaceFocused() is the preferred method.
      */
     Q_SCRIPTABLE bool isPidFocused(unsigned int pid);
 
+    /*
+        Returns true if the surface with the given id has input focus
+     */
+    Q_SCRIPTABLE bool isSurfaceFocused(const QString &surfaceId);
+
 private:
     QSet<pid_t> fetchAssociatedPids(pid_t pid);
     SessionInterface* findSessionWithPid(const QSet<pid_t> &pidSet);
     SessionInterface* findSessionWithPid(SessionInterface* session, const QSet<pid_t> &pidSet);
+    MirSurfaceInterface *findQmlSurface(const QString &serializedId);
 
     const QList<Application*> &m_applications;