Merge lp:~gerboland/miral/qtmir-555 into lp:miral

[Gerry Boland]

[miral-qt] Merge rev 555 of qtmir: Added implementation for MirSurfaceInterface::persistentId - adapted to suit new arch

Based on https://code.launchpad.net/~unity-team/qtmir/persistent_surface_id/+merge/303580 by Daniel d'Andrada

[lp:~gerboland/miral/qtmir-555]

318. By Gerry Boland on 2016-09-08

Merge miral trunk

Unmerged revisions

=== modified file 'debian/libmiral1.symbols'
--- debian/libmiral1.symbols	2016-09-06 08:05:38 +0000
+++ debian/libmiral1.symbols	2016-09-07 20:36:39 +0000
@@ -163,6 +163,7 @@
  (c++)"miral::WindowManagerTools::focus_next_application()@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowManagerTools::focus_next_within_application()@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowManagerTools::for_each_application(std::function<void (miral::ApplicationInfo&)> const&)@MIRAL_0.1" 0.1.0
+ (c++)"miral::WindowManagerTools::id_for_window[abi:cxx11](miral::Window const&) const@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowManagerTools::info_for(miral::Window const&) const@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowManagerTools::info_for(std::weak_ptr<mir::scene::Session> const&) const@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowManagerTools::info_for(std::weak_ptr<mir::scene::Surface> const&) const@MIRAL_0.1" 0.1.0
 
=== modified file 'include/miral/window_manager_tools.h'
--- include/miral/window_manager_tools.h	2016-08-15 15:36:00 +0000
+++ include/miral/window_manager_tools.h	2016-09-07 20:36:39 +0000
@@ -105,6 +105,13 @@
      */
     auto info_for_window_id(std::string const& id) const -> WindowInfo&;
 
+    /** retrieve the persistent surface id for a window
+     *
+     * @param id        the window
+     * @return          the persistent surface id
+     */
+    auto id_for_window(Window const& window) const -> std::string;
+
     /// Send close request to the window
     void ask_client_to_close(Window const& window);
 
 
=== modified file 'miral-qt/CMakeLists.txt'
--- miral-qt/CMakeLists.txt	2016-08-16 14:21:14 +0000
+++ miral-qt/CMakeLists.txt	2016-09-07 20:36:39 +0000
@@ -90,7 +90,7 @@
 pkg_check_modules(GSETTINGS_QT REQUIRED gsettings-qt)
 pkg_check_modules(QTDBUSTEST libqtdbustest-1 REQUIRED)
 pkg_check_modules(QTDBUSMOCK libqtdbusmock-1 REQUIRED)
-pkg_check_modules(APPLICATION_API REQUIRED unity-shell-application=20)
+pkg_check_modules(APPLICATION_API REQUIRED unity-shell-application=21)
 pkg_check_modules(CGMANAGER libcgmanager REQUIRED)
 
 add_definitions(-DMIR_REQUIRE_DEPRECATED_EVENT_OPT_IN=1)
 
=== modified file 'miral-qt/debian/control'
--- miral-qt/debian/control	2016-08-16 14:21:14 +0000
+++ miral-qt/debian/control	2016-09-07 20:36:39 +0000
@@ -23,7 +23,7 @@
                libubuntu-app-launch2-dev (>= 0.9),
                libubuntu-application-api-dev (>= 2.1.0),
                libudev-dev,
-               libunity-api-dev (>= 7.117),
+               libunity-api-dev (>= 7.118),
                liburl-dispatcher1-dev,
                libxkbcommon-dev,
                libxrender-dev,
@@ -37,6 +37,8 @@
                qtdeclarative5-dev,
                qtdeclarative5-private-dev,
                quilt,
+# libmirserver-dev should have brought this dep. Bug lp:1617435
+               uuid-dev,
 Standards-Version: 3.9.5
 Homepage: https://launchpad.net/qtmir
 # if you don't have have commit access to this branch but would like to upload
@@ -94,7 +96,7 @@
 Conflicts: libqtmir,
            libunity-mir1,
 Provides: unity-application-impl,
-          unity-application-impl-20,
+          unity-application-impl-21,
 Description: Qt plugin for Unity specific Mir APIs
  QtMir provides Qt/QML bindings for Mir features that are exposed through the
  qtmir-desktop or qtmir-android QPA plugin such as Application management
 
=== modified file 'miral-qt/debian/gles-patches/convert-to-gles.patch'
--- miral-qt/debian/gles-patches/convert-to-gles.patch	2016-08-16 14:21:14 +0000
+++ miral-qt/debian/gles-patches/convert-to-gles.patch	2016-09-07 20:36:39 +0000
@@ -9,7 +9,7 @@
  Priority: optional
  Maintainer: Ubuntu Developers <[e-mail]>
 @@ -16,7 +16,13 @@ Build-Depends: cmake,
-                libmirserver-dev (>= 0.19.0),
+                libmirserver-dev (>= 0.24.0),
                 libmtdev-dev,
                 libprocess-cpp-dev,
 +               libqt5gui5-gles,
@@ -84,7 +84,7 @@
 -Conflicts: libqtmir,
 -           libunity-mir1,
 -Provides: unity-application-impl,
--          unity-application-impl-20,
+-          unity-application-impl-21,
 -Description: Qt plugin for Unity specific Mir APIs
 - QtMir provides Qt/QML bindings for Mir features that are exposed through the
 - qtmir-desktop or qtmir-android QPA plugin such as Application management
 
=== modified file 'miral-qt/src/common/windowmodelnotifierinterface.h'
--- miral-qt/src/common/windowmodelnotifierinterface.h	2016-09-01 11:37:38 +0000
+++ miral-qt/src/common/windowmodelnotifierinterface.h	2016-09-07 20:36:39 +0000
@@ -31,8 +31,7 @@
 public:
     WindowInfo() = default;
     WindowInfo(const miral::WindowInfo &windowInfo)
-      : window(windowInfo.window())
-      , name(windowInfo.name())
+      : name(windowInfo.name())
       , type(windowInfo.type())
       , state(windowInfo.state())
       , restoreRect(windowInfo.restore_rect())
@@ -42,10 +41,8 @@
       , minHeight(windowInfo.min_height())
       , maxWidth(windowInfo.max_width())
       , maxHeight(windowInfo.max_height())
-      , surface(window)
     {}
 
-    miral::Window window;
     mir::optional_value<std::string> name;
     MirSurfaceType type;
     MirSurfaceState state;
@@ -56,6 +53,20 @@
     mir::geometry::Height minHeight;
     mir::geometry::Width maxWidth;
     mir::geometry::Height maxHeight;
+};
+
+class NewWindowInfo : public WindowInfo {
+public:
+    NewWindowInfo() = default;
+    NewWindowInfo(const miral::WindowInfo &windowInfo, const std::string &persistentId = "")
+      : WindowInfo(windowInfo)
+      , window(windowInfo.window())
+      , persistentId(persistentId)
+      , surface(window)
+    {}
+
+    miral::Window window;
+    std::string persistentId;
 
     // hold copy of Surface shared pointer, as miral::Window has just a weak pointer to the Surface
     // but MirSurface needs to share ownership of the Surface with Mir
@@ -71,7 +82,7 @@
     virtual ~WindowModelNotifierInterface() = default;
 
 Q_SIGNALS:
-    void windowAdded(const qtmir::WindowInfo, const int index);
+    void windowAdded(const qtmir::NewWindowInfo, const int index);
     void windowRemoved(const int index);
     void windowMoved(const QPoint topLeft, const int index);
     void windowResized(const QSize size, const int index);
@@ -85,6 +96,7 @@
 
 } // namespace qtmir
 
+Q_DECLARE_METATYPE(qtmir::NewWindowInfo)
 Q_DECLARE_METATYPE(qtmir::WindowInfo)
 
 #endif // WINDOWMODELNOTIFIERINTERFACE_H
 
=== modified file 'miral-qt/src/modules/Unity/Application/dbusfocusinfo.cpp'
--- miral-qt/src/modules/Unity/Application/dbusfocusinfo.cpp	2016-07-26 12:30:51 +0000
+++ miral-qt/src/modules/Unity/Application/dbusfocusinfo.cpp	2016-09-07 20:36:39 +0000
@@ -18,6 +18,9 @@
 
 // local
 #include "cgmanager.h"
+#include "mirsurfacelistmodel.h"
+#include "mirsurfaceinterface.h"
+#include "session_interface.h"
 
 // QPA mirserver
 #include <logging.h>
@@ -87,3 +90,35 @@
     }
     return nullptr;
 }
+
+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 'miral-qt/src/modules/Unity/Application/dbusfocusinfo.h'
--- miral-qt/src/modules/Unity/Application/dbusfocusinfo.h	2016-07-26 12:30:36 +0000
+++ miral-qt/src/modules/Unity/Application/dbusfocusinfo.h	2016-09-07 20:36:39 +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,12 +40,21 @@
 
     /*
         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);
+    MirSurfaceInterface *findQmlSurface(const QString &serializedId);
 
     const QList<Application*> &m_applications;
 
 
=== modified file 'miral-qt/src/modules/Unity/Application/mirsurface.cpp'
--- miral-qt/src/modules/Unity/Application/mirsurface.cpp	2016-09-01 10:58:43 +0000
+++ miral-qt/src/modules/Unity/Application/mirsurface.cpp	2016-09-07 20:36:39 +0000
@@ -44,8 +44,8 @@
 
 using namespace qtmir;
 
-#define DEBUG_MSG qCDebug(QTMIR_SURFACES).nospace() << "MirSurface[" << (void*)this << "," << appId() <<"]::" << __func__
-#define WARNING_MSG qCWarning(QTMIR_SURFACES).nospace() << "MirSurface[" << (void*)this << "," << appId() <<"]::" << __func__
+#define DEBUG_MSG qCDebug(QTMIR_SURFACES).nospace() << "MirSurface[" << (void*)this << "," << appId() << "]::" << __func__
+#define WARNING_MSG qCWarning(QTMIR_SURFACES).nospace() << "MirSurface[" << (void*)this << "," << appId() << "]::" << __func__
 
 namespace {
 
@@ -195,25 +195,28 @@
 
 } // namespace {
 
-MirSurface::MirSurface(WindowInfo windowInfo,
+MirSurface::MirSurface(NewWindowInfo windowInfo,
         WindowControllerInterface* controller)
     : MirSurfaceInterface()
     , m_windowInfo(windowInfo)
+    , m_window(windowInfo.window)
+    , m_surface(windowInfo.surface)
     , m_controller(controller)
+    , m_persistentId(QString::fromStdString(windowInfo.persistentId))
     , m_firstFrameDrawn(false)
     , m_orientationAngle(Mir::Angle0)
     , m_textureUpdated(false)
     , m_currentFrameNumber(0)
     , m_live(true)
     , m_surfaceObserver(std::make_shared<SurfaceObserver>())
-    , m_position(toQPoint(windowInfo.window.top_left()))
-    , m_size(toQSize(windowInfo.window.size()))
+    , m_position(toQPoint(m_window.top_left()))
+    , m_size(toQSize(m_window.size()))
     , m_shellChrome(Mir::NormalChrome)
 {
     DEBUG_MSG << "()";
 
-    SurfaceObserver::registerObserverForSurface(m_surfaceObserver.get(), windowInfo.surface.get());
-    m_windowInfo.surface->add_observer(m_surfaceObserver);
+    SurfaceObserver::registerObserverForSurface(m_surfaceObserver.get(), m_surface.get());
+    m_surface->add_observer(m_surfaceObserver);
 
     //m_shellChrome = creationHints.shellChrome; TODO - where will this come from now?
 
@@ -253,12 +256,12 @@
 
 MirSurface::~MirSurface()
 {
-    qCDebug(QTMIR_SURFACES).nospace() << "MirSurface[" << (void*)this << "]::~MirSurface() viewCount=" << m_views.count();
+    DEBUG_MSG << "() viewCount=" << m_views.count();
 
     Q_ASSERT(m_views.isEmpty());
 
     QMutexLocker locker(&m_mutex);
-    m_windowInfo.surface->remove_observer(m_surfaceObserver);
+    m_surface->remove_observer(m_surfaceObserver);
 
     delete m_closeTimer;
 
@@ -339,7 +342,7 @@
 
     const void* const userId = (void*)123;  // TODO: Multimonitor support
 
-    const int framesPending = m_windowInfo.surface->buffers_ready_for_compositor(userId);
+    const int framesPending = m_surface->buffers_ready_for_compositor(userId);
     if (framesPending > 0) {
         m_textureUpdated = false;
 
@@ -400,10 +403,10 @@
     }
 
     const void* const userId = (void*)123;
-    auto renderables = m_windowInfo.surface->generate_renderables(userId);
+    auto renderables = m_surface->generate_renderables(userId);
 
     if (renderables.size() > 0 &&
-            (m_windowInfo.surface->buffers_ready_for_compositor(userId) > 0 || !texture->hasBuffer())
+            (m_surface->buffers_ready_for_compositor(userId) > 0 || !texture->hasBuffer())
         ) {
         // Avoid holding two buffers for the compositor at the same time. Thus free the current
         // before acquiring the next
@@ -419,7 +422,7 @@
         m_textureUpdated = true;
     }
 
-    if (m_windowInfo.surface->buffers_ready_for_compositor(userId) > 0) {
+    if (m_surface->buffers_ready_for_compositor(userId) > 0) {
         // restart the frame dropper to give MirSurfaceItems enough time to render the next frame.
         // queued since the timer lives in a different thread
         QMetaObject::invokeMethod(&m_frameDropperTimer, "start", Qt::QueuedConnection);
@@ -438,7 +441,7 @@
 {
     QMutexLocker locker(&m_mutex);
     const void* const userId = (void*)123;
-    return m_windowInfo.surface->buffers_ready_for_compositor(userId);
+    return m_surface->buffers_ready_for_compositor(userId);
 }
 
 void MirSurface::setFocused(bool value)
@@ -481,10 +484,10 @@
 
     if (m_activelyFocusedViews.isEmpty()) {
         DEBUG_MSG << "() unfocused";
-        m_controller->setActiveFocus(m_windowInfo.window, false);
+        m_controller->setActiveFocus(m_window, false);
     } else {
         DEBUG_MSG << "() focused";
-        m_controller->setActiveFocus(m_windowInfo.window, true);
+        m_controller->setActiveFocus(m_window, true);
     }
 
     m_neverSetSurfaceFocus = false;
@@ -502,14 +505,14 @@
     Q_EMIT closeRequested();
     m_closeTimer->start();
 
-    if (m_windowInfo.window) {
-        m_windowInfo.surface->request_client_surface_close();
+    if (m_window) {
+        m_surface->request_client_surface_close();
     }
 }
 
 void MirSurface::resize(int width, int height)
 {
-    auto const &window = m_windowInfo.window;
+    auto const &window = m_window;
 
     bool mirSizeIsDifferent = width != m_size.width() || height != m_size.height();
 
@@ -535,7 +538,7 @@
 
 void MirSurface::requestPosition(const QPoint newPosition)
 {
-    m_controller->move(m_windowInfo.window, newPosition);
+    m_controller->move(m_window, newPosition);
 }
 
 void MirSurface::setSize(const QSize newSize)
@@ -608,8 +611,8 @@
         return;
     }
 
-    if (m_windowInfo.window) {
-        m_windowInfo.surface->set_orientation(mirOrientation);
+    if (m_surface) {
+        m_surface->set_orientation(mirOrientation);
     }
 
     Q_EMIT orientationAngleChanged(angle);
@@ -623,6 +626,11 @@
     return QString::fromStdString(m_windowInfo.name.value());
 }
 
+QString MirSurface::persistentId() const
+{
+    return m_persistentId;
+}
+
 void MirSurface::setState(Mir::State qmlState)
 {
     MirSurfaceState mirState;
@@ -662,7 +670,7 @@
         break;
     }
 
-    m_controller->setState(m_windowInfo.window, mirState);
+    m_controller->setState(m_window, mirState);
 }
 
 void MirSurface::setLive(bool value)
@@ -692,7 +700,7 @@
 {
     auto ev = makeMirEvent(event, mir_pointer_action_button_down);
     auto ev1 = reinterpret_cast<MirPointerEvent const*>(ev.get());
-    m_controller->deliverPointerEvent(m_windowInfo.window, ev1);
+    m_controller->deliverPointerEvent(m_window, ev1);
     event->accept();
 }
 
@@ -700,7 +708,7 @@
 {
     auto ev = makeMirEvent(event, mir_pointer_action_motion);
     auto ev1 = reinterpret_cast<MirPointerEvent const*>(ev.get());
-    m_controller->deliverPointerEvent(m_windowInfo.window, ev1);
+    m_controller->deliverPointerEvent(m_window, ev1);
     event->accept();
 }
 
@@ -708,7 +716,7 @@
 {
     auto ev = makeMirEvent(event, mir_pointer_action_button_up);
     auto ev1 = reinterpret_cast<MirPointerEvent const*>(ev.get());
-    m_controller->deliverPointerEvent(m_windowInfo.window, ev1);
+    m_controller->deliverPointerEvent(m_window, ev1);
     event->accept();
 }
 
@@ -716,7 +724,7 @@
 {
     auto ev = makeMirEvent(event, mir_pointer_action_enter);
     auto ev1 = reinterpret_cast<MirPointerEvent const*>(ev.get());
-    m_controller->deliverPointerEvent(m_windowInfo.window, ev1);
+    m_controller->deliverPointerEvent(m_window, ev1);
     event->accept();
 }
 
@@ -724,7 +732,7 @@
 {
     auto ev = makeMirEvent(event, mir_pointer_action_leave);
     auto ev1 = reinterpret_cast<MirPointerEvent const*>(ev.get());
-    m_controller->deliverPointerEvent(m_windowInfo.window, ev1);
+    m_controller->deliverPointerEvent(m_window, ev1);
     event->accept();
 }
 
@@ -732,7 +740,7 @@
 {
     auto ev = makeMirEvent(event, mir_pointer_action_motion);
     auto ev1 = reinterpret_cast<MirPointerEvent const*>(ev.get());
-    m_controller->deliverPointerEvent(m_windowInfo.window, ev1);
+    m_controller->deliverPointerEvent(m_window, ev1);
     event->accept();
 }
 
@@ -740,7 +748,7 @@
 {
     auto ev = makeMirEvent(event);
     auto ev1 = reinterpret_cast<MirPointerEvent const*>(ev.get());
-    m_controller->deliverPointerEvent(m_windowInfo.window, ev1);
+    m_controller->deliverPointerEvent(m_window, ev1);
     event->accept();
 }
 
@@ -748,7 +756,7 @@
 {
     auto ev = makeMirEvent(qtEvent);
     auto ev1 = reinterpret_cast<MirKeyboardEvent const*>(ev.get());
-    m_controller->deliverKeyboardEvent(m_windowInfo.window, ev1);
+    m_controller->deliverKeyboardEvent(m_window, ev1);
     qtEvent->accept();
 }
 
@@ -756,7 +764,7 @@
 {
     auto ev = makeMirEvent(qtEvent);
     auto ev1 = reinterpret_cast<MirKeyboardEvent const*>(ev.get());
-    m_controller->deliverKeyboardEvent(m_windowInfo.window, ev1);
+    m_controller->deliverKeyboardEvent(m_window, ev1);
     qtEvent->accept();
 }
 
@@ -767,7 +775,7 @@
 {
     auto ev = makeMirEvent(mods, touchPoints, touchPointStates, timestamp);
     auto ev1 = reinterpret_cast<MirTouchEvent const*>(ev.get());
-    m_controller->deliverTouchEvent(m_windowInfo.window, ev1);
+    m_controller->deliverTouchEvent(m_window, ev1);
 }
 
 bool MirSurface::clientIsRunning() const
@@ -900,7 +908,7 @@
         return;
     }
 
-    m_windowInfo.surface->set_keymap(MirInputDeviceId(), "", layout.toStdString(), variant.toStdString(), "");
+    m_surface->set_keymap(MirInputDeviceId(), "", layout.toStdString(), variant.toStdString(), "");
 }
 
 QCursor MirSurface::cursor() const
@@ -1054,7 +1062,7 @@
 
     m_closingState = CloseOverdue;
 
-    m_controller->requestClose(m_windowInfo.window);
+    m_controller->requestClose(m_window);
 }
 
 void MirSurface::setCloseTimer(AbstractTimer *timer)
 
=== modified file 'miral-qt/src/modules/Unity/Application/mirsurface.h'
--- miral-qt/src/modules/Unity/Application/mirsurface.h	2016-08-22 22:31:41 +0000
+++ miral-qt/src/modules/Unity/Application/mirsurface.h	2016-09-07 20:36:39 +0000
@@ -49,7 +49,7 @@
     Q_OBJECT
 
 public:
-    MirSurface(WindowInfo windowInfo,
+    MirSurface(NewWindowInfo windowInfo,
                WindowControllerInterface *controller);
     virtual ~MirSurface();
 
@@ -60,6 +60,8 @@
 
     QString name() const override;
 
+    QString persistentId() const override;
+
     QSize size() const override;
     void resize(int width, int height) override;
     Q_INVOKABLE void resize(const QSize &size) override { resize(size.width(), size.height()); }
@@ -158,7 +160,7 @@
     // useful for tests
     void setCloseTimer(AbstractTimer *timer);
     std::shared_ptr<SurfaceObserver> surfaceObserver() const;
-    WindowInfo windowInfo() const { return m_windowInfo; }
+    miral::Window window() const { return m_window; }
 
 public Q_SLOTS:
     void onCompositorSwappedBuffers() override;
@@ -183,8 +185,11 @@
     void updateActiveFocus();
 
     WindowInfo m_windowInfo;
+    miral::Window m_window;
+    std::shared_ptr<mir::scene::Surface> m_surface; // keep copy of the Surface for lifecycle
     QPointer<SessionInterface> m_session;
     WindowControllerInterface *const m_controller;
+    QString m_persistentId;
     bool m_firstFrameDrawn;
 
     //FIXME -  have to save the state as Mir has no getter for it (bug:1357429)
 
=== modified file 'miral-qt/src/modules/Unity/Application/windowmodel.cpp'
--- miral-qt/src/modules/Unity/Application/windowmodel.cpp	2016-09-06 15:21:11 +0000
+++ miral-qt/src/modules/Unity/Application/windowmodel.cpp	2016-09-07 20:36:39 +0000
@@ -69,7 +69,7 @@
     return roleNames;
 }
 
-void WindowModel::onWindowAdded(const WindowInfo windowInfo, const int index)
+void WindowModel::onWindowAdded(const NewWindowInfo windowInfo, const int index)
 {
     auto mirSurface = new MirSurface(windowInfo, m_windowController);
     beginInsertRows(QModelIndex(), index, index);
 
=== modified file 'miral-qt/src/modules/Unity/Application/windowmodel.h'
--- miral-qt/src/modules/Unity/Application/windowmodel.h	2016-08-24 12:40:48 +0000
+++ miral-qt/src/modules/Unity/Application/windowmodel.h	2016-09-07 20:36:39 +0000
@@ -53,7 +53,7 @@
     void countChanged();
 
 private Q_SLOTS:
-    void onWindowAdded(const WindowInfo windowInfo, const int index);
+    void onWindowAdded(const NewWindowInfo windowInfo, const int index);
     void onWindowRemoved(const int index);
     void onWindowMoved(const QPoint topLeft, const int index);
     void onWindowResized(const QSize size, const int index);
 
=== modified file 'miral-qt/src/platforms/mirserver/nativeinterface.h'
--- miral-qt/src/platforms/mirserver/nativeinterface.h	2016-08-16 14:15:26 +0000
+++ miral-qt/src/platforms/mirserver/nativeinterface.h	2016-09-07 20:36:39 +0000
@@ -28,6 +28,7 @@
 
 // mir
 namespace mir { namespace scene { class PromptSessionManager; }}
+namespace mir { namespace shell { class PersistentSurfaceStore; }}
 
 class NativeInterface : public QPlatformNativeInterface
 {
@@ -42,6 +43,7 @@
     QVariant windowProperty(QPlatformWindow *window, const QString &name, const QVariant &defaultValue) const override;
 
     std::shared_ptr<mir::scene::PromptSessionManager> thePromptSessionManager() const;
+    std::shared_ptr<mir::shell::PersistentSurfaceStore> thePersistentSurfaceStore() const;
 
 private:
     QMirServer *m_qMirServer;
 
=== modified file 'miral-qt/src/platforms/mirserver/windowmanagementpolicy.cpp'
--- miral-qt/src/platforms/mirserver/windowmanagementpolicy.cpp	2016-09-06 12:21:43 +0000
+++ miral-qt/src/platforms/mirserver/windowmanagementpolicy.cpp	2016-09-07 20:36:39 +0000
@@ -21,7 +21,7 @@
 #include "miral/window_manager_tools.h"
 #include "miral/window_specification.h"
 
-#include "mir/scene/surface.h"
+#include <mir/scene/surface.h>
 #include <QDebug>
 
 WindowManagementPolicy::WindowManagementPolicy(const miral::WindowManagerTools &tools,
@@ -88,7 +88,9 @@
 void WindowManagementPolicy::advise_new_window(const miral::WindowInfo &windowInfo)
 {
     // TODO: attach surface observer here
-    m_windowModel.addWindow(windowInfo);
+    std::string persistentId = m_tools.id_for_window(windowInfo.window());
+
+    m_windowModel.addWindow(windowInfo, persistentId);
 }
 
 void WindowManagementPolicy::advise_delete_window(const miral::WindowInfo &windowInfo)
 
=== modified file 'miral-qt/src/platforms/mirserver/windowmodelnotifier.cpp'
--- miral-qt/src/platforms/mirserver/windowmodelnotifier.cpp	2016-09-06 15:31:41 +0000
+++ miral-qt/src/platforms/mirserver/windowmodelnotifier.cpp	2016-09-07 20:36:39 +0000
@@ -31,6 +31,7 @@
 
 WindowModelNotifier::WindowModelNotifier()
 {
+    qRegisterMetaType<qtmir::NewWindowInfo>();
     qRegisterMetaType<qtmir::WindowInfo>();
     qRegisterMetaType<QVector<int>>();
 }
@@ -40,12 +41,13 @@
 
 }
 
-void WindowModelNotifier::addWindow(const miral::WindowInfo &windowInfo)
+void WindowModelNotifier::addWindow(const miral::WindowInfo &windowInfo, const std::string &persistentId)
 {
     auto stackPosition = m_windowStack.count();
     m_windowStack.push_back(windowInfo.window()); // ASSUMPTION: Mir should tell us where in stack
 
-    Q_EMIT windowAdded(windowInfo, stackPosition);
+    NewWindowInfo newWindowInfo{windowInfo, persistentId};
+    Q_EMIT windowAdded(newWindowInfo, stackPosition);
 }
 
 void WindowModelNotifier::removeWindow(const miral::WindowInfo &windowInfo)
 
=== modified file 'miral-qt/src/platforms/mirserver/windowmodelnotifier.h'
--- miral-qt/src/platforms/mirserver/windowmodelnotifier.h	2016-08-24 12:30:45 +0000
+++ miral-qt/src/platforms/mirserver/windowmodelnotifier.h	2016-09-07 20:36:39 +0000
@@ -32,7 +32,7 @@
     WindowModelNotifier();
     virtual ~WindowModelNotifier();
 
-    void addWindow(const miral::WindowInfo &windowInfo);
+    void addWindow(const miral::WindowInfo &windowInfo, const std::string &persistentId = "");
     void removeWindow(const miral::WindowInfo &windowInfo);
 
     void moveWindow(const miral::WindowInfo &windowInfo, mir::geometry::Point topLeft);
 
=== modified file 'miral-qt/tests/framework/CMakeLists.txt'
--- miral-qt/tests/framework/CMakeLists.txt	2016-08-22 21:34:31 +0000
+++ miral-qt/tests/framework/CMakeLists.txt	2016-09-07 20:36:39 +0000
@@ -29,6 +29,7 @@
     mock_shared_wakelock.cpp
     mock_surface.cpp
     mock_task_controller.cpp
+    mock_persistent_surface_store.cpp
     stub_input_channel.cpp
     fake_surface.h
     qtmir_test.cpp
 
=== modified file 'miral-qt/tests/framework/fake_mirsurface.cpp'
--- miral-qt/tests/framework/fake_mirsurface.cpp	2016-08-10 15:01:44 +0000
+++ miral-qt/tests/framework/fake_mirsurface.cpp	2016-09-07 20:36:39 +0000
@@ -54,6 +54,8 @@
 
 QString FakeMirSurface::name() const { return QString("Fake MirSurface"); }
 
+QString FakeMirSurface::persistentId() const { return QString("FakeSurfaceId"); }
+
 QSize FakeMirSurface::size() const { return m_size; }
 
 QPoint FakeMirSurface::position() const { return m_position; }
 
=== modified file 'miral-qt/tests/framework/fake_mirsurface.h'
--- miral-qt/tests/framework/fake_mirsurface.h	2016-08-10 15:01:44 +0000
+++ miral-qt/tests/framework/fake_mirsurface.h	2016-09-07 20:36:39 +0000
@@ -53,6 +53,7 @@
     // unity.shell.application.MirSurfaceInterface
     Mir::Type type() const override;
     QString name() const override;
+    QString persistentId() const override;
     QSize size() const override;
     void resize(int width, int height) override;
     void resize(const QSize &size) override;
 
=== added file 'miral-qt/tests/framework/mock_persistent_surface_store.cpp'
--- miral-qt/tests/framework/mock_persistent_surface_store.cpp	1970-01-01 00:00:00 +0000
+++ miral-qt/tests/framework/mock_persistent_surface_store.cpp	2016-09-07 20:36:39 +0000
@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2016 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License version 3, as published by
+ * the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+ * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "mock_persistent_surface_store.h"
+
+namespace mir
+{
+namespace shell
+{
+
+MockPersistentSurfaceStore::MockPersistentSurfaceStore()
+{
+
+}
+
+} // namespace shell
+} // namespace mir
 
=== added file 'miral-qt/tests/framework/mock_persistent_surface_store.h'
--- miral-qt/tests/framework/mock_persistent_surface_store.h	1970-01-01 00:00:00 +0000
+++ miral-qt/tests/framework/mock_persistent_surface_store.h	2016-09-07 20:36:39 +0000
@@ -0,0 +1,24 @@
+#ifndef MOCKPERSISTENTSURFACESTORE_H
+#define MOCKPERSISTENTSURFACESTORE_H
+
+#include <mir/shell/persistent_surface_store.h>
+#include <gmock/gmock.h>
+
+namespace mir
+{
+namespace shell
+{
+
+class MockPersistentSurfaceStore : public PersistentSurfaceStore
+{
+public:
+    MockPersistentSurfaceStore();
+
+    MOCK_METHOD1(id_for_surface, Id(std::shared_ptr<scene::Surface> const& surface));
+    MOCK_CONST_METHOD1(surface_for_id, std::shared_ptr<scene::Surface>(Id const& id));
+};
+
+}
+}
+
+#endif // MOCKPERSISTENTSURFACESTORE_H
 
=== modified file 'miral-qt/tests/framework/qtmir_test.cpp'
--- miral-qt/tests/framework/qtmir_test.cpp	2016-08-23 11:42:28 +0000
+++ miral-qt/tests/framework/qtmir_test.cpp	2016-09-07 20:36:39 +0000
@@ -109,6 +109,7 @@
 
 QtMirTest::QtMirTest()
     : promptSessionManager(std::make_shared<StubPromptSessionManager>())
+    , persistentSurfaceStore(std::make_shared<StubPersistentSurfaceStore>())
     , applicationManager(taskControllerSharedPointer,
                          QSharedPointer<MockSharedWakelock>(&sharedWakelock, [](MockSharedWakelock *){}),
                          QSharedPointer<ProcInfo>(&procInfo,[](ProcInfo *){}),
 
=== modified file 'miral-qt/tests/framework/qtmir_test.h'
--- miral-qt/tests/framework/qtmir_test.h	2016-08-23 11:42:28 +0000
+++ miral-qt/tests/framework/qtmir_test.h	2016-09-07 20:36:39 +0000
@@ -38,6 +38,7 @@
 #include "mock_shared_wakelock.h"
 #include "mock_settings.h"
 #include "mock_task_controller.h"
+#include "mock_persistent_surface_store.h"
 
 namespace ms = mir::scene;
 using namespace qtmir;
@@ -45,6 +46,7 @@
 namespace qtmir {
 
 typedef testing::NiceMock<mir::scene::MockPromptSessionManager> StubPromptSessionManager;
+typedef testing::NiceMock<mir::shell::MockPersistentSurfaceStore> StubPersistentSurfaceStore;
 
 // For better output in ASSERT_* and EXPECT_* error messages
 void PrintTo(const Application::InternalState& state, ::std::ostream* os);
@@ -71,6 +73,7 @@
     testing::NiceMock<MockSharedWakelock> sharedWakelock;
     testing::NiceMock<MockSettings> settings;
     std::shared_ptr<StubPromptSessionManager> promptSessionManager;
+    std::shared_ptr<StubPersistentSurfaceStore> persistentSurfaceStore;
 
     mir::shell::Shell *mirShell{nullptr};
     ApplicationManager applicationManager;
 
=== modified file 'miral-qt/tests/modules/WindowManager/windowmodel_test.cpp'
--- miral-qt/tests/modules/WindowManager/windowmodel_test.cpp	2016-08-25 10:34:52 +0000
+++ miral-qt/tests/modules/WindowManager/windowmodel_test.cpp	2016-09-07 20:36:39 +0000
@@ -66,7 +66,7 @@
 
     miral::Window getMirALWindowFromModel(const WindowModel &model, int index)
     {
-        return getMirSurfaceFromModel(model, index)->windowInfo().window;
+        return getMirSurfaceFromModel(model, index)->window();
     }
 
     const std::shared_ptr<StubSession> stubSession{std::make_shared<StubSession>()};
 
=== modified file 'miral/basic_window_manager.cpp'
--- miral/basic_window_manager.cpp	2016-09-05 15:50:13 +0000
+++ miral/basic_window_manager.cpp	2016-09-07 20:36:39 +0000
@@ -646,6 +646,17 @@
 #endif
 }
 
+auto miral::BasicWindowManager::id_for_window(Window const& window) const -> std::string
+{
+    if (!window)
+        BOOST_THROW_EXCEPTION(std::runtime_error{"Null Window has no Persistent ID"});
+
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 24, 0)
+    return persistent_surface_store->id_for_surface(window).serialize_to_string();
+#else
+    BOOST_THROW_EXCEPTION(std::runtime_error{"Persistent IDs unavailable with this Mir server version"});
+#endif
+}
 
 void miral::BasicWindowManager::place_and_size(WindowInfo& root, Point const& new_pos, Size const& new_size)
 {
 
=== modified file 'miral/basic_window_manager.h'
--- miral/basic_window_manager.h	2016-08-29 16:17:16 +0000
+++ miral/basic_window_manager.h	2016-09-07 20:36:39 +0000
@@ -131,6 +131,8 @@
 
     auto info_for_window_id(std::string const& id) const -> WindowInfo& override;
 
+    auto id_for_window(Window const& window) const -> std::string override;
+
     void invoke_under_lock(std::function<void()> const& callback) override;
 
 private:
 
=== modified file 'miral/symbols.map'
--- miral/symbols.map	2016-09-06 08:05:38 +0000
+++ miral/symbols.map	2016-09-07 20:36:39 +0000
@@ -152,6 +152,7 @@
     miral::WindowManagerTools::focus_next_application*;
     miral::WindowManagerTools::focus_next_within_application*;
     miral::WindowManagerTools::for_each_application*;
+    miral::WindowManagerTools::id_for_window*;
     miral::WindowManagerTools::info_for*;
     miral::WindowManagerTools::info_for_window_id*;
     miral::WindowManagerTools::invoke_under_lock*;
 
=== modified file 'miral/window_manager_tools.cpp'
--- miral/window_manager_tools.cpp	2016-08-15 15:36:00 +0000
+++ miral/window_manager_tools.cpp	2016-09-07 20:36:39 +0000
@@ -80,5 +80,8 @@
 auto miral::WindowManagerTools::info_for_window_id(std::string const& id) const -> WindowInfo&
 { return tools->info_for_window_id(id); }
 
+auto miral::WindowManagerTools::id_for_window(Window const& window) const -> std::string
+{ return tools->id_for_window(window); }
+
 void miral::WindowManagerTools::invoke_under_lock(std::function<void()> const& callback)
 { tools->invoke_under_lock(callback); }
 
=== modified file 'miral/window_manager_tools_implementation.h'
--- miral/window_manager_tools_implementation.h	2016-08-15 15:36:00 +0000
+++ miral/window_manager_tools_implementation.h	2016-09-07 20:36:39 +0000
@@ -63,6 +63,7 @@
     virtual void raise_tree(Window const& root) = 0;
     virtual void modify_window(WindowInfo& window_info, WindowSpecification const& modifications) = 0;
     virtual auto info_for_window_id(std::string const& id) const -> WindowInfo& = 0;
+    virtual auto id_for_window(Window const& window) const -> std::string = 0;
 /** @} */
 
 /** @name Multi-thread support
 
=== modified file 'test/persistent_surface_store.cpp'
--- test/persistent_surface_store.cpp	2016-08-12 11:27:38 +0000
+++ test/persistent_surface_store.cpp	2016-09-07 20:36:39 +0000
@@ -20,6 +20,8 @@
 #include <miral/toolkit/surface.h>
 #include <miral/toolkit/surface_spec.h>
 
+#include <miral/application_info.h>
+
 #include <mir/version.h>
 
 #include <gtest/gtest.h>
@@ -56,6 +58,31 @@
             ASSERT_THAT(window_info.name(), Eq(test_name));
         });
 }
+
+TEST_F(PersistentSurfaceId, server_returns_correct_id_for_window)
+{
+    char const* const test_name = __PRETTY_FUNCTION__;
+    using namespace miral::toolkit;
+
+    auto const connection = connect_client(test_name);
+    auto const spec = SurfaceSpec::for_normal_surface(connection, 50, 50, mir_pixel_format_argb_8888)
+        .set_name(test_name);
+
+    Surface const surface{spec.create_surface()};
+
+    miral::toolkit::PersistentId client_surface_id{surface};
+
+    tools.invoke_under_lock([&]
+        {
+            // Bit of a journey to get the miral::Window for the above surface
+            auto app = tools.find_application([&](miral::ApplicationInfo const& /*info*/){return true;});
+            auto app_info = tools.info_for(app);
+            auto window = app_info.windows()[0];
+            auto id = tools.id_for_window(window);
+
+            ASSERT_THAT(client_surface_id.c_str(), Eq(id));
+        });
+}
 #else
 TEST_F(PersistentSurfaceId, server_fails_gracefully_to_identify_window_specified_by_client)
 {
@@ -75,6 +102,30 @@
             EXPECT_THROW(tools.info_for_window_id(client_surface_id.c_str()), std::runtime_error);
         });
 }
+
+TEST_F(PersistentSurfaceId, server_fails_gracefully_to_return_id_for_window)
+{
+    char const* const test_name = __PRETTY_FUNCTION__;
+    using namespace miral::toolkit;
+
+    auto const connection = connect_client(test_name);
+    auto const spec = SurfaceSpec::for_normal_surface(connection, 50, 50, mir_pixel_format_argb_8888)
+        .set_name(test_name);
+
+    Surface const surface{spec.create_surface()};
+
+    miral::toolkit::PersistentId client_surface_id{surface};
+
+    tools.invoke_under_lock([&]
+        {
+            // Bit of a journey to get the miral::Window for the above surface
+            auto app = tools.find_application([&](miral::ApplicationInfo const& /*info*/){return true;});
+            auto app_info = tools.info_for(app);
+            auto window = app_info.windows()[0];
+
+            EXPECT_THROW(tools.id_for_window(window), std::runtime_error);
+        });
+}
 #endif
 
 TEST_F(PersistentSurfaceId, server_fails_gracefully_to_identify_window_from_garbage_id)
@@ -95,3 +146,12 @@
             EXPECT_THROW(tools.info_for_window_id("garbage"), std::exception);
         });
 }
+
+TEST_F(PersistentSurfaceId, server_fails_gracefully_when_id_for_null_window_requested)
+{
+    tools.invoke_under_lock([&]
+        {
+            miral::Window window;
+            EXPECT_THROW(tools.id_for_window(window), std::runtime_error);
+        });
+}