Merge lp:~mir-team/mir/backport-1355173.trust-prompt-suspend into lp:mir/0.8

[Cemil Azizoglu]

Backport of dednick's 1355173.trust-prompt-suspend branch into mir/0.8.
(LP: #1355173)

.

[Cemil Azizoglu (cemil-azizoglu)]

TODO: Need to carefully identify the broken ABIs.

(Server ABI is definitely broken.)

review: Needs Fixing

[Daniel van Vugt (vanvugt)]

Alright, this is adding features to the server ABI. That seems to be its purpose.

In that case we have little choice but to branch the server ABI string and make all downstream projects in RTM rebuild.

review: Needs Fixing

[lp:~mir-team/mir/backport-1355173.trust-prompt-suspend]

1969. By Chris Halse Rogers on 2015-01-12

Bump server SONAME for ABI break.

We've already got a libmirserver27, so append “rtm1” instead

[Chris Halse Rogers (raof)]

This now looks correct to me

review: Approve

[Daniel van Vugt (vanvugt)]

"26rtm1" is wrong. This is not a distro branch so should not contain any distro names.

review: Needs Fixing

[lp:~mir-team/mir/backport-1355173.trust-prompt-suspend]

1970. By Daniel van Vugt on 2015-01-12

Merge latest upstream branch and convert to distro-agnostic versioning
(since this is a distro-agnostic branch in theory).

[Daniel van Vugt (vanvugt)]

Fixed SONAME so that any other distro using lp:mir/0.8 isn't forced to use "rtm" it is names.

Haven't reviewed the rest yet though.

review: Abstain

[lp:~mir-team/mir/backport-1355173.trust-prompt-suspend]

1971. By Daniel van Vugt on 2015-01-12

And bump the version too: 0.8.1

[Chris Halse Rogers (raof)]

Fair chop.

Although I very much hope that no other distros are using lp:mir/0.8,
because this is both an ABI and API break, and totally unacceptable for
a real stable branch :).

Possibly this should be proposed to a new mir/rtm-krillin branch or
something, but I'm happy with mir/0.8 as a practical matter.

[Daniel van Vugt (vanvugt)]

Do we have all the external linkage required? No one's updated symbols.map for this...

review: Needs Information

[lp:~mir-team/mir/backport-1355173.trust-prompt-suspend]

1972. By Michał Sawicz on 2015-01-12

And bump the changelog too: 0.8.1

[Daniel van Vugt (vanvugt)]

Changelog needs to mention at least two fixes that have landed (including this one). Possibly more are desirable too:
https://launchpad.net/mir/+milestone/0.8.1

review: Needs Fixing

[lp:~mir-team/mir/backport-1355173.trust-prompt-suspend]

1973. By Daniel van Vugt on 2015-01-12

Document changelog in detail

[Daniel van Vugt (vanvugt)]

review: Abstain

[Daniel van Vugt (vanvugt)]

FYI, still missing two more important fixes (IMHO) after this one. Listed in:
https://launchpad.net/mir/+milestone/0.8.1

[lp:~mir-team/mir/backport-1355173.trust-prompt-suspend]

1974. By Daniel van Vugt on 2015-01-12

Match up parentheses

1975. By Cemil Azizoglu on 2015-01-12

Remove the comment for fix #1379478 as it already exists in mi 0.8.0 changelog.

[Cemil Azizoglu (cemil-azizoglu)]

ABI bumps and changelog look good now.

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-09-30 06:11:33 +0000
+++ CMakeLists.txt	2015-01-12 15:38:36 +0000
@@ -28,7 +28,7 @@
 
 set(MIR_VERSION_MAJOR 0)
 set(MIR_VERSION_MINOR 8) # This should change at least with every MIRSERVER_ABI
-set(MIR_VERSION_PATCH 0)
+set(MIR_VERSION_PATCH 1)
 
 set(MIR_VERSION ${MIR_VERSION_MAJOR}.${MIR_VERSION_MINOR}.${MIR_VERSION_PATCH})
 

=== modified file 'client-ABI-sha1sums'
--- client-ABI-sha1sums	2014-09-30 06:11:33 +0000
+++ client-ABI-sha1sums	2015-01-12 15:38:36 +0000
@@ -9,7 +9,7 @@
 8609754db3be20e11e43858dd2c36b5bd480d5ec  include/client/mir_toolkit/mir_surface.h
 b141c4d79802ad626d969249c0004744e5c2a525  include/client/mir_toolkit/mir_wait.h
 9907751d046e4aea81881cf19e5df52c7a6a813e  include/common/mir_toolkit/client_types.h
-183d9e5e6cfe48b3d9145a28541dd4202ff6137b  include/common/mir_toolkit/common.h
+e0e0a814b0b4da74f78b1216af0cd62e51f79673  include/common/mir_toolkit/common.h
 fce4c1a9e0d037244f7e9e96ea2d8eaab4fc404c  include/common/mir_toolkit/cursors.h
 bdaceadd56e41d2cb708f7c4da97acf84dfc75b7  include/common/mir_toolkit/event.h
 99ef5f3bf548508fae24c60f74be1dea018a6e8c  include/common/mir_toolkit/mesa/native_display.h

=== modified file 'common-ABI-sha1sums'
--- common-ABI-sha1sums	2014-09-30 06:11:33 +0000
+++ common-ABI-sha1sums	2015-01-12 15:38:36 +0000
@@ -11,7 +11,7 @@
 be7d58c9fde2ce91cc66dd6144b76e08b536266b  include/common/mir/int_wrapper.h
 48015c67ddc4998ed5a2e8bb04ff3a4bfdd6a613  include/common/mir/time/clock.h
 9907751d046e4aea81881cf19e5df52c7a6a813e  include/common/mir_toolkit/client_types.h
-183d9e5e6cfe48b3d9145a28541dd4202ff6137b  include/common/mir_toolkit/common.h
+e0e0a814b0b4da74f78b1216af0cd62e51f79673  include/common/mir_toolkit/common.h
 fce4c1a9e0d037244f7e9e96ea2d8eaab4fc404c  include/common/mir_toolkit/cursors.h
 bdaceadd56e41d2cb708f7c4da97acf84dfc75b7  include/common/mir_toolkit/event.h
 99ef5f3bf548508fae24c60f74be1dea018a6e8c  include/common/mir_toolkit/mesa/native_display.h

=== modified file 'debian/changelog'
--- debian/changelog	2014-10-10 14:01:27 +0000
+++ debian/changelog	2015-01-12 15:38:36 +0000
@@ -1,3 +1,19 @@
+mir (0.8.1-0ubuntu1) UNRELEASED; urgency=medium
+
+  * Bug fix release 0.8.1 (https://launchpad.net/mir/+milestone/0.8.1)
+    - ABI summary: Servers need rebuilding, but clients do not;
+      . Mirclient ABI unchanged at 8
+      . Mircommon ABI unchanged at 2
+      . Mirplatform ABI unchanged to 3
+      . Mirserver ABI bumped to 26.1 (due to breakage in LP: #1355173)
+    - Fixes bugs:
+      . Switching windows with a Trusted Prompt Session active loses the
+        trusted prompt session (LP: #1355173)
+      . a prompt session with an invalid application pid should be an error
+        (LP: #1377968)
+
+ -- Daniel van Vugt <[e-mail]>  Mon, 12 Jan 2015 17:44:57 +0800
+
 mir (0.8.0+14.10.20141010-0ubuntu1) utopic; urgency=medium
 
   [ Daniel van Vugt ]

=== modified file 'debian/control'
--- debian/control	2014-10-01 03:41:21 +0000
+++ debian/control	2015-01-12 15:38:36 +0000
@@ -45,7 +45,7 @@
 # just go ahead. ~mir-team will notice and sync up the code again.
 Vcs-Bzr: https://code.launchpad.net/~mir-team/mir/trunk
 
-Package: libmirserver26
+Package: libmirserver26.1
 Section: libs
 Architecture: i386 amd64 armhf arm64
 Multi-Arch: same
@@ -139,7 +139,7 @@
 Architecture: i386 amd64 armhf arm64
 Multi-Arch: same
 Pre-Depends: ${misc:Pre-Depends}
-Depends: libmirserver26 (= ${binary:Version}),
+Depends: libmirserver26.1 (= ${binary:Version}),
          libmirplatform-dev (= ${binary:Version}),
          libmircommon-dev (= ${binary:Version}),
          libglm-dev,

=== renamed file 'debian/libmirserver26.install' => 'debian/libmirserver26.1.install'
--- debian/libmirserver26.install	2014-09-30 06:11:33 +0000
+++ debian/libmirserver26.1.install	2015-01-12 15:38:36 +0000
@@ -1,1 +1,1 @@
-usr/lib/*/libmirserver.so.26
+usr/lib/*/libmirserver.so.26.1

=== modified file 'include/common/mir_toolkit/common.h'
--- include/common/mir_toolkit/common.h	2014-09-11 05:51:44 +0000
+++ include/common/mir_toolkit/common.h	2015-01-12 15:38:36 +0000
@@ -104,7 +104,8 @@
 typedef enum MirPromptSessionState
 {
     mir_prompt_session_state_stopped = 0,
-    mir_prompt_session_state_started
+    mir_prompt_session_state_started,
+    mir_prompt_session_state_suspended
 } MirPromptSessionState;
 
 /**

=== modified file 'include/server/mir/scene/prompt_session.h'
--- include/server/mir/scene/prompt_session.h	2014-06-12 10:24:08 +0000
+++ include/server/mir/scene/prompt_session.h	2015-01-12 15:38:36 +0000
@@ -29,6 +29,30 @@
 
 class PromptSession : public frontend::PromptSession
 {
+public:
+    /**
+     * Start a prompt session
+     *   \param [in] helper  The prompt session helper session
+     */
+    virtual void start(std::shared_ptr<Session> const& helper_session) = 0;
+
+    /**
+     * Stop a prompt session
+     *   \param [in] helper  The prompt session helper session
+     */
+    virtual void stop(std::shared_ptr<Session> const& helper_session) = 0;
+
+    /**
+     * Suspend a prompt session
+     *   \param [in] helper  The prompt session helper session
+     */
+    virtual void suspend(std::shared_ptr<Session> const& helper_session) = 0;
+
+    /**
+     * Resume a prompt session
+     *   \param [in] helper  The prompt session helper session
+     */
+    virtual void resume(std::shared_ptr<Session> const& helper_session) = 0;
 };
 
 }

=== modified file 'include/server/mir/scene/prompt_session_listener.h'
--- include/server/mir/scene/prompt_session_listener.h	2014-06-12 10:06:11 +0000
+++ include/server/mir/scene/prompt_session_listener.h	2015-01-12 15:38:36 +0000
@@ -33,6 +33,8 @@
 public:
     virtual void starting(std::shared_ptr<PromptSession> const& prompt_session) = 0;
     virtual void stopping(std::shared_ptr<PromptSession> const& prompt_session) = 0;
+    virtual void suspending(std::shared_ptr<PromptSession> const& prompt_session) = 0;
+    virtual void resuming(std::shared_ptr<PromptSession> const& prompt_session) = 0;
 
     virtual void prompt_provider_added(PromptSession const& prompt_session, std::shared_ptr<Session> const& prompt_provider) = 0;
     virtual void prompt_provider_removed(PromptSession const& prompt_session, std::shared_ptr<Session> const& prompt_provider) = 0;

=== modified file 'include/server/mir/scene/prompt_session_manager.h'
--- include/server/mir/scene/prompt_session_manager.h	2014-09-11 05:51:44 +0000
+++ include/server/mir/scene/prompt_session_manager.h	2015-01-12 15:38:36 +0000
@@ -51,6 +51,18 @@
     virtual void stop_prompt_session(std::shared_ptr<PromptSession> const& prompt_session) const = 0;
 
     /**
+     * Suspend a prompt session
+     *   \param [in] prompt_session  The prompt session
+     */
+    virtual void suspend_prompt_session(std::shared_ptr<PromptSession> const& prompt_session) const = 0;
+
+    /**
+     * Resume a suspended prompt session
+     *   \param [in] prompt_session  The prompt session
+     */
+    virtual void resume_prompt_session(std::shared_ptr<PromptSession> const& prompt_session) const = 0;
+
+    /**
      * Add a prompt provider to an existing prompt session
      *   \param [in] prompt_session  The prompt session
      *   \param [in] prompt_provider The prompt provider to add to the prompt session

=== modified file 'include/server/mir/scene/session.h'
--- include/server/mir/scene/session.h	2014-09-11 05:51:44 +0000
+++ include/server/mir/scene/session.h	2015-01-12 15:38:36 +0000
@@ -43,6 +43,8 @@
 
     virtual void start_prompt_session() = 0;
     virtual void stop_prompt_session() = 0;
+    virtual void suspend_prompt_session() = 0;
+    virtual void resume_prompt_session() = 0;
 };
 }
 }

=== modified file 'platform-ABI-sha1sums'
--- platform-ABI-sha1sums	2014-10-03 03:02:09 +0000
+++ platform-ABI-sha1sums	2015-01-12 15:38:36 +0000
@@ -11,7 +11,7 @@
 be7d58c9fde2ce91cc66dd6144b76e08b536266b  include/common/mir/int_wrapper.h
 48015c67ddc4998ed5a2e8bb04ff3a4bfdd6a613  include/common/mir/time/clock.h
 9907751d046e4aea81881cf19e5df52c7a6a813e  include/common/mir_toolkit/client_types.h
-183d9e5e6cfe48b3d9145a28541dd4202ff6137b  include/common/mir_toolkit/common.h
+e0e0a814b0b4da74f78b1216af0cd62e51f79673  include/common/mir_toolkit/common.h
 fce4c1a9e0d037244f7e9e96ea2d8eaab4fc404c  include/common/mir_toolkit/cursors.h
 bdaceadd56e41d2cb708f7c4da97acf84dfc75b7  include/common/mir_toolkit/event.h
 99ef5f3bf548508fae24c60f74be1dea018a6e8c  include/common/mir_toolkit/mesa/native_display.h

=== modified file 'server-ABI-sha1sums'
--- server-ABI-sha1sums	2014-10-03 03:02:09 +0000
+++ server-ABI-sha1sums	2015-01-12 15:38:36 +0000
@@ -11,7 +11,7 @@
 be7d58c9fde2ce91cc66dd6144b76e08b536266b  include/common/mir/int_wrapper.h
 48015c67ddc4998ed5a2e8bb04ff3a4bfdd6a613  include/common/mir/time/clock.h
 9907751d046e4aea81881cf19e5df52c7a6a813e  include/common/mir_toolkit/client_types.h
-183d9e5e6cfe48b3d9145a28541dd4202ff6137b  include/common/mir_toolkit/common.h
+e0e0a814b0b4da74f78b1216af0cd62e51f79673  include/common/mir_toolkit/common.h
 fce4c1a9e0d037244f7e9e96ea2d8eaab4fc404c  include/common/mir_toolkit/cursors.h
 bdaceadd56e41d2cb708f7c4da97acf84dfc75b7  include/common/mir_toolkit/event.h
 99ef5f3bf548508fae24c60f74be1dea018a6e8c  include/common/mir_toolkit/mesa/native_display.h
@@ -88,11 +88,11 @@
 d5273f3363b0b776427d5e3f1af99f0f2bcf3fa6  include/server/mir/scene/observer.h
 10db25fbaefcabb3b191177ed70f5972df7f05f0  include/server/mir/scene/placement_strategy.h
 74f7f66ffc3e15c428082fb961e748cb4f39dafc  include/server/mir/scene/prompt_session_creation_parameters.h
-4e8269c822ad2daddd92115cbe5332caaa9ef4cc  include/server/mir/scene/prompt_session.h
-79adf11e2b1778897ed97d1713ba4c3d34eb1f31  include/server/mir/scene/prompt_session_listener.h
-27f614f98ad7c249d9b12dcca30a324220cdd25b  include/server/mir/scene/prompt_session_manager.h
+b657cfb8fb31140b83b78fc19135dd0165ede67b  include/server/mir/scene/prompt_session.h
+a745a63d413ced63b82350b8c253b65dffd5bf44  include/server/mir/scene/prompt_session_listener.h
+a09a3f18ecea53dc45386c1e2baf545c4177c047  include/server/mir/scene/prompt_session_manager.h
 5edf446380070f567500069e422d293e88468ee5  include/server/mir/scene/session_coordinator.h
-f148a69caa39756d43cfaf7cc868ad681bda9ef6  include/server/mir/scene/session.h
+cf13a79b20acf9e53db6e0078df085b9a023d8da  include/server/mir/scene/session.h
 ee94083f10f890e24c0e0bbdb94842e2dd788deb  include/server/mir/scene/session_listener.h
 7f5f26000fd2312373817d05c488a6a950a47c82  include/server/mir/scene/snapshot.h
 5bab4dc0a6488b8b9d47e958c6bab94f1dcf2c57  include/server/mir/scene/surface_buffer_access.h

=== modified file 'src/include/server/mir/scene/null_prompt_session_listener.h'
--- src/include/server/mir/scene/null_prompt_session_listener.h	2014-09-11 05:51:44 +0000
+++ src/include/server/mir/scene/null_prompt_session_listener.h	2015-01-12 15:38:36 +0000
@@ -30,6 +30,8 @@
 public:
     void starting(std::shared_ptr<PromptSession> const&) override {}
     void stopping(std::shared_ptr<PromptSession> const&) override {}
+    void suspending(std::shared_ptr<PromptSession> const&) override {}
+    void resuming(std::shared_ptr<PromptSession> const&) override {}
 
     void prompt_provider_added(PromptSession const&, std::shared_ptr<Session> const&) override {}
     void prompt_provider_removed(PromptSession const&, std::shared_ptr<Session> const&) override {}

=== modified file 'src/server/CMakeLists.txt'
--- src/server/CMakeLists.txt	2014-09-30 06:11:33 +0000
+++ src/server/CMakeLists.txt	2015-01-12 15:38:36 +0000
@@ -90,7 +90,7 @@
   ${CMAKE_SOURCE_DIR}/include/server/mir DESTINATION "include/mirserver"
 )
 
-set(MIRSERVER_ABI 26) # Be sure to increment MIR_VERSION_MINOR at the same time
+set(MIRSERVER_ABI 26.1) # Be sure to increment MIR_VERSION_MINOR at the same time
 set(symbol_map ${CMAKE_CURRENT_SOURCE_DIR}/symbols.map)
 
 set_target_properties(

=== modified file 'src/server/scene/CMakeLists.txt'
--- src/server/scene/CMakeLists.txt	2014-09-30 06:11:33 +0000
+++ src/server/scene/CMakeLists.txt	2015-01-12 15:38:36 +0000
@@ -21,6 +21,7 @@
   legacy_scene_change_notification.cpp
   legacy_surface_change_notification.cpp
   prompt_session_container.cpp
+  prompt_session_impl.cpp
   prompt_session_manager_impl.cpp
   rendering_tracker.cpp
 )

=== modified file 'src/server/scene/application_session.cpp'
--- src/server/scene/application_session.cpp	2014-09-11 05:51:44 +0000
+++ src/server/scene/application_session.cpp	2015-01-12 15:38:36 +0000
@@ -202,3 +202,21 @@
     stop_event.prompt_session.new_state = mir_prompt_session_state_stopped;
     event_sink->handle_event(stop_event);
 }
+
+void ms::ApplicationSession::suspend_prompt_session()
+{
+    MirEvent start_event;
+    memset(&start_event, 0, sizeof start_event);
+    start_event.type = mir_event_type_prompt_session_state_change;
+    start_event.prompt_session.new_state = mir_prompt_session_state_suspended;
+    event_sink->handle_event(start_event);
+}
+
+void ms::ApplicationSession::resume_prompt_session()
+{
+    MirEvent start_event;
+    memset(&start_event, 0, sizeof start_event);
+    start_event.type = mir_event_type_prompt_session_state_change;
+    start_event.prompt_session.new_state = mir_prompt_session_state_started;
+    event_sink->handle_event(start_event);
+}

=== modified file 'src/server/scene/application_session.h'
--- src/server/scene/application_session.h	2014-09-11 05:51:44 +0000
+++ src/server/scene/application_session.h	2015-01-12 15:38:36 +0000
@@ -73,6 +73,8 @@
 
     void start_prompt_session() override;
     void stop_prompt_session() override;
+    void suspend_prompt_session() override;
+    void resume_prompt_session() override;
 
 protected:
     ApplicationSession(ApplicationSession const&) = delete;

=== added file 'src/server/scene/prompt_session_impl.cpp'
--- src/server/scene/prompt_session_impl.cpp	1970-01-01 00:00:00 +0000
+++ src/server/scene/prompt_session_impl.cpp	2015-01-12 15:38:36 +0000
@@ -0,0 +1,81 @@
+/*
+ * Copyright © 2014 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU 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 warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Nick Dedekind <[e-mail]>
+ */
+
+#include "prompt_session_impl.h"
+
+#include "mir/scene/session.h"
+
+namespace ms = mir::scene;
+
+ms::PromptSessionImpl::PromptSessionImpl() :
+    current_state(mir_prompt_session_state_stopped)
+{
+}
+
+void ms::PromptSessionImpl::start(std::shared_ptr<Session> const& helper_session)
+{
+    std::lock_guard<std::mutex> lk(guard);
+
+    if (current_state == mir_prompt_session_state_stopped)
+    {
+        current_state = mir_prompt_session_state_started;
+        if (helper_session)
+            helper_session->start_prompt_session();
+    }
+}
+
+void ms::PromptSessionImpl::stop(std::shared_ptr<Session> const& helper_session)
+{
+    std::lock_guard<std::mutex> lk(guard);
+
+    if (current_state != mir_prompt_session_state_stopped)
+    {
+        current_state = mir_prompt_session_state_stopped;
+        if (helper_session)
+            helper_session->stop_prompt_session();
+    }
+}
+
+void ms::PromptSessionImpl::suspend(std::shared_ptr<Session> const& helper_session)
+{
+    std::lock_guard<std::mutex> lk(guard);
+
+    if (current_state == mir_prompt_session_state_started)
+    {
+        current_state = mir_prompt_session_state_suspended;
+        if (helper_session)
+            helper_session->suspend_prompt_session();
+    }
+}
+
+void ms::PromptSessionImpl::resume(std::shared_ptr<Session> const& helper_session)
+{
+    std::lock_guard<std::mutex> lk(guard);
+
+    if (current_state == mir_prompt_session_state_suspended)
+    {
+        current_state = mir_prompt_session_state_started;
+        if (helper_session)
+            helper_session->resume_prompt_session();
+    }
+}
+
+MirPromptSessionState ms::PromptSessionImpl::state() const
+{
+    return current_state;
+}

=== added file 'src/server/scene/prompt_session_impl.h'
--- src/server/scene/prompt_session_impl.h	1970-01-01 00:00:00 +0000
+++ src/server/scene/prompt_session_impl.h	2015-01-12 15:38:36 +0000
@@ -0,0 +1,50 @@
+/*
+ * Copyright © 2014 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU 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 warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Nick Dedekind <[e-mail]>
+ */
+
+#ifndef MIR_SCENE_PROMPT_SESSION_IMPL_H_
+#define MIR_SCENE_PROMPT_SESSION_IMPL_H_
+
+#include "mir/scene/prompt_session.h"
+
+#include <mutex>
+
+namespace mir
+{
+namespace scene
+{
+
+class PromptSessionImpl : public scene::PromptSession
+{
+public:
+    explicit PromptSessionImpl();
+
+    void start(std::shared_ptr<Session> const& helper_session) override;
+    void stop(std::shared_ptr<Session> const& helper_session) override;
+    void suspend(std::shared_ptr<Session> const& helper_session) override;
+    void resume(std::shared_ptr<Session> const& helper_session) override;
+
+    MirPromptSessionState state() const;
+
+private:
+    std::mutex mutable guard;
+    MirPromptSessionState current_state;
+};
+}
+}
+
+#endif // MIR_SCENE_PROMPT_SESSION_IMPL_H_

=== modified file 'src/server/scene/prompt_session_manager_impl.cpp'
--- src/server/scene/prompt_session_manager_impl.cpp	2014-12-04 10:59:04 +0000
+++ src/server/scene/prompt_session_manager_impl.cpp	2015-01-12 15:38:36 +0000
@@ -21,9 +21,9 @@
 #include "mir/scene/prompt_session_creation_parameters.h"
 #include "mir/scene/prompt_session_listener.h"
 #include "mir/scene/session.h"
-#include "mir/scene/prompt_session.h"
 #include "session_container.h"
 #include "prompt_session_container.h"
+#include "prompt_session_impl.h"
 
 namespace ms = mir::scene;
 
@@ -45,12 +45,7 @@
     prompt_session_container->for_each_participant_in_prompt_session(prompt_session.get(),
         [&](std::weak_ptr<Session> const& session, PromptSessionContainer::ParticipantType type)
         {
-            if (type == PromptSessionContainer::ParticipantType::helper)
-            {
-                if (auto locked_session = session.lock())
-                    locked_session->stop_prompt_session();
-            }
-            else if (type == PromptSessionContainer::ParticipantType::prompt_provider)
+            if (type == PromptSessionContainer::ParticipantType::prompt_provider)
             {
                 if (auto locked_session = session.lock())
                     participants.push_back(locked_session);
@@ -63,6 +58,8 @@
             prompt_session_listener->prompt_provider_removed(*prompt_session, participant);
     }
 
+    prompt_session->stop(helper_for(prompt_session));
+
     prompt_session_container->remove_prompt_session(prompt_session);
 
     prompt_session_listener->stopping(prompt_session);
@@ -104,11 +101,27 @@
     stop_prompt_session_locked(lock, prompt_session);
 }
 
+void ms::PromptSessionManagerImpl::suspend_prompt_session(std::shared_ptr<PromptSession> const& prompt_session) const
+{
+    std::lock_guard<std::mutex> lock(prompt_sessions_mutex);
+
+    prompt_session->suspend(helper_for(prompt_session));
+    prompt_session_listener->suspending(prompt_session);
+}
+
+void ms::PromptSessionManagerImpl::resume_prompt_session(std::shared_ptr<PromptSession> const& prompt_session) const
+{
+    std::lock_guard<std::mutex> lock(prompt_sessions_mutex);
+
+    prompt_session->resume(helper_for(prompt_session));
+    prompt_session_listener->resuming(prompt_session);
+}
+
 std::shared_ptr<ms::PromptSession> ms::PromptSessionManagerImpl::start_prompt_session_for(
     std::shared_ptr<Session> const& session,
     PromptSessionCreationParameters const& params) const
 {
-    auto prompt_session = std::make_shared<PromptSession>();
+    auto prompt_session = std::make_shared<PromptSessionImpl>();
     std::shared_ptr<Session> application_session;
 
     app_container->for_each(
@@ -129,7 +142,7 @@
     if (!prompt_session_container->insert_participant(prompt_session.get(), session, PromptSessionContainer::ParticipantType::helper))
         BOOST_THROW_EXCEPTION(std::runtime_error("Could not set prompt session helper"));
 
-    session->start_prompt_session();
+    prompt_session->start(session);
     prompt_session_listener->starting(prompt_session);
 
     prompt_session_container->insert_participant(prompt_session.get(), application_session, PromptSessionContainer::ParticipantType::application);

=== modified file 'src/server/scene/prompt_session_manager_impl.h'
--- src/server/scene/prompt_session_manager_impl.h	2014-09-11 05:51:44 +0000
+++ src/server/scene/prompt_session_manager_impl.h	2015-01-12 15:38:36 +0000
@@ -50,6 +50,12 @@
     void stop_prompt_session(
         std::shared_ptr<PromptSession> const& prompt_session) const override;
 
+    void suspend_prompt_session(
+        std::shared_ptr<PromptSession> const& prompt_session) const override;
+
+    void resume_prompt_session(
+        std::shared_ptr<PromptSession> const& prompt_session) const override;
+
     void add_prompt_provider(
         std::shared_ptr<PromptSession> const& prompt_session,
         std::shared_ptr<Session> const& prompt_provider) const override;

=== modified file 'tests/acceptance-tests/test_prompt_session_client_api.cpp'
--- tests/acceptance-tests/test_prompt_session_client_api.cpp	2014-12-04 10:59:04 +0000
+++ tests/acceptance-tests/test_prompt_session_client_api.cpp	2015-01-12 15:38:36 +0000
@@ -26,6 +26,7 @@
 #include "mir/fd.h"
 
 #include "mir_test_doubles/stub_session_authorizer.h"
+#include "mir_test_doubles/mock_prompt_session_listener.h"
 #include "mir_test_framework/stubbed_server_configuration.h"
 #include "mir_test_framework/in_process_server.h"
 #include "mir_test_framework/using_stub_client_platform.h"
@@ -36,6 +37,7 @@
 
 #include <condition_variable>
 #include <mutex>
+#include <atomic>
 
 namespace mtd = mir::test::doubles;
 namespace mtf = mir_test_framework;
@@ -46,35 +48,6 @@
 
 namespace
 {
-struct MockPromptSessionListener : ms::PromptSessionListener
-{
-    MockPromptSessionListener(std::shared_ptr<ms::PromptSessionListener> const& wrapped) :
-        wrapped(wrapped)
-    {
-        ON_CALL(*this, starting(_)).WillByDefault(Invoke(
-            wrapped.get(), &ms::PromptSessionListener::starting));
-
-        ON_CALL(*this, stopping(_)).WillByDefault(Invoke(
-            wrapped.get(), &ms::PromptSessionListener::stopping));
-
-        ON_CALL(*this, prompt_provider_added(_, _)).WillByDefault(Invoke(
-            wrapped.get(), &ms::PromptSessionListener::prompt_provider_added));
-
-        ON_CALL(*this, prompt_provider_removed(_, _)).WillByDefault(Invoke(
-            wrapped.get(), &ms::PromptSessionListener::prompt_provider_removed));
-    }
-
-    MOCK_METHOD1(starting, void(std::shared_ptr<ms::PromptSession> const& prompt_session));
-    MOCK_METHOD1(stopping, void(std::shared_ptr<ms::PromptSession> const& prompt_session));
-
-    MOCK_METHOD2(prompt_provider_added,
-        void(ms::PromptSession const& session, std::shared_ptr<ms::Session> const& provider));
-
-    MOCK_METHOD2(prompt_provider_removed,
-        void(ms::PromptSession const& session, std::shared_ptr<ms::Session> const& provider));
-
-    std::shared_ptr<ms::PromptSessionListener> const wrapped;
-};
 
 struct MockSessionAuthorizer : public mtd::StubSessionAuthorizer
 {
@@ -99,12 +72,11 @@
            });
     }
 
-    std::shared_ptr<MockPromptSessionListener> the_mock_prompt_session_listener()
+    std::shared_ptr<mtd::MockPromptSessionListener> the_mock_prompt_session_listener()
     {
-        return mock_prompt_session_listener([this]
+        return mock_prompt_session_listener([]
             {
-                return std::make_shared<NiceMock<MockPromptSessionListener>>(
-                    mtf::StubbedServerConfiguration::the_prompt_session_listener());
+                return std::make_shared<NiceMock<mtd::MockPromptSessionListener>>();
             });
     }
 
@@ -125,7 +97,7 @@
             });
     }
 
-    mir::CachedPtr<MockPromptSessionListener> mock_prompt_session_listener;
+    mir::CachedPtr<mtd::MockPromptSessionListener> mock_prompt_session_listener;
     mir::CachedPtr<MockSessionAuthorizer> mock_prompt_session_authorizer;
 };
 
@@ -143,6 +115,7 @@
 
     std::shared_ptr<ms::PromptSession> server_prompt_session;
     mtf::UsingStubClientPlatform using_stub_client_platform;
+    std::atomic<bool> prompt_session_state_change_callback_called;
 
     void SetUp() override
     {
@@ -158,11 +131,18 @@
     void capture_server_prompt_session()
     {
         EXPECT_CALL(*the_mock_prompt_session_listener(), starting(_)).
-            WillOnce(DoAll(
-                Invoke(
-                    the_mock_prompt_session_listener()->wrapped.get(),
-                    &ms::PromptSessionListener::starting),
-                SaveArg<0>(&server_prompt_session)));
+            WillOnce(SaveArg<0>(&server_prompt_session));
+    }
+
+    void wait_for_state_change_callback()
+    {
+        for (int i = 0; !prompt_session_state_change_callback_called.load() && i < 5000; ++i)
+        {
+            std::this_thread::sleep_for(std::chrono::milliseconds(1));
+            std::this_thread::yield();
+        }
+
+        prompt_session_state_change_callback_called.store(false);
     }
 
     void TearDown() override
@@ -179,7 +159,7 @@
         mtf::InProcessServer::TearDown();
     }
 
-    MockPromptSessionListener* the_mock_prompt_session_listener()
+    mtd::MockPromptSessionListener* the_mock_prompt_session_listener()
     {
         return server_configuration.the_mock_prompt_session_listener().get();
     }
@@ -250,6 +230,7 @@
 {
     PromptSessionClientAPI* self = static_cast<PromptSessionClientAPI*>(context);
     self->prompt_session_state_change(prompt_provider, state);
+    self->prompt_session_state_change_callback_called.store(true);
 }
 
 void client_fd_callback(MirPromptSession*, size_t count, int const* fds, void* context)
@@ -405,20 +386,49 @@
 {
     connection = mir_connect_sync(new_connection().c_str(), __PRETTY_FUNCTION__);
 
-    EXPECT_CALL(*this, prompt_session_state_change(_, mir_prompt_session_state_started));
+    {
+        InSequence seq;
+        EXPECT_CALL(*this, prompt_session_state_change(_, mir_prompt_session_state_started));
+        EXPECT_CALL(*this, prompt_session_state_change(_, mir_prompt_session_state_stopped));
+    }
 
     capture_server_prompt_session();
 
     MirPromptSession* prompt_session = mir_connection_create_prompt_session_sync(
         connection, application_session_pid, prompt_session_state_change_callback, this);
-
-    EXPECT_CALL(*this, prompt_session_state_change(_, mir_prompt_session_state_stopped));
+    wait_for_state_change_callback();
 
     the_prompt_session_manager()->stop_prompt_session(server_prompt_session);
+    wait_for_state_change_callback();
 
     // Verify we have got the "stopped" notification before we go on and release the session
-    Mock::VerifyAndClearExpectations(the_mock_prompt_session_listener());
-
+    Mock::VerifyAndClearExpectations(this);
+
+    mir_prompt_session_release_sync(prompt_session);
+}
+
+TEST_F(PromptSessionClientAPI, notifies_when_server_suspends_prompt_session)
+{
+    connection = mir_connect_sync(new_connection().c_str(), __PRETTY_FUNCTION__);
+    {
+        InSequence seq;
+        EXPECT_CALL(*this, prompt_session_state_change(_, mir_prompt_session_state_started));
+        EXPECT_CALL(*this, prompt_session_state_change(_, mir_prompt_session_state_suspended));
+    }
+
+    capture_server_prompt_session();
+
+    MirPromptSession* prompt_session = mir_connection_create_prompt_session_sync(
+        connection, application_session_pid, prompt_session_state_change_callback, this);
+    wait_for_state_change_callback();
+
+    the_prompt_session_manager()->suspend_prompt_session(server_prompt_session);
+    wait_for_state_change_callback();
+
+    // Verify we have got the "suspend" notification before we go on and release the session
+    Mock::VerifyAndClearExpectations(this);
+
+    EXPECT_CALL(*this, prompt_session_state_change(_, mir_prompt_session_state_stopped));
     mir_prompt_session_release_sync(prompt_session);
 }
 

=== modified file 'tests/include/mir_test_doubles/mock_prompt_session_listener.h'
--- tests/include/mir_test_doubles/mock_prompt_session_listener.h	2014-06-12 10:06:11 +0000
+++ tests/include/mir_test_doubles/mock_prompt_session_listener.h	2015-01-12 15:38:36 +0000
@@ -36,6 +36,8 @@
 
     MOCK_METHOD1(starting, void(std::shared_ptr<scene::PromptSession> const&));
     MOCK_METHOD1(stopping, void(std::shared_ptr<scene::PromptSession> const&));
+    MOCK_METHOD1(suspending, void(std::shared_ptr<scene::PromptSession> const&));
+    MOCK_METHOD1(resuming, void(std::shared_ptr<scene::PromptSession> const&));
 
     MOCK_METHOD2(prompt_provider_added, void(scene::PromptSession const&, std::shared_ptr<scene::Session> const&));
     MOCK_METHOD2(prompt_provider_removed, void(scene::PromptSession const&, std::shared_ptr<scene::Session> const&));

=== modified file 'tests/include/mir_test_doubles/mock_scene_session.h'
--- tests/include/mir_test_doubles/mock_scene_session.h	2014-09-11 05:51:44 +0000
+++ tests/include/mir_test_doubles/mock_scene_session.h	2015-01-12 15:38:36 +0000
@@ -55,6 +55,8 @@
 
     MOCK_METHOD0(start_prompt_session, void());
     MOCK_METHOD0(stop_prompt_session, void());
+    MOCK_METHOD0(suspend_prompt_session, void());
+    MOCK_METHOD0(resume_prompt_session, void());
 };
 
 }

=== modified file 'tests/include/mir_test_doubles/null_prompt_session.h'
--- tests/include/mir_test_doubles/null_prompt_session.h	2014-06-12 10:24:08 +0000
+++ tests/include/mir_test_doubles/null_prompt_session.h	2015-01-12 15:38:36 +0000
@@ -29,6 +29,22 @@
 {
 class NullPromptSession : public scene::PromptSession
 {
+public:
+    void start(std::shared_ptr<scene::Session> const&) override
+    {
+    }
+
+    void stop(std::shared_ptr<scene::Session> const&) override
+    {
+    }
+
+    void suspend(std::shared_ptr<scene::Session> const&) override
+    {
+    }
+
+    void resume(std::shared_ptr<scene::Session> const&) override
+    {
+    }
 };
 }
 }

=== modified file 'tests/include/mir_test_doubles/null_prompt_session_manager.h'
--- tests/include/mir_test_doubles/null_prompt_session_manager.h	2014-09-11 05:51:44 +0000
+++ tests/include/mir_test_doubles/null_prompt_session_manager.h	2015-01-12 15:38:36 +0000
@@ -41,6 +41,14 @@
     {
     }
 
+    void suspend_prompt_session(std::shared_ptr<scene::PromptSession> const&) const override
+    {
+    }
+
+    void resume_prompt_session(std::shared_ptr<scene::PromptSession> const&) const override
+    {
+    }
+
     void add_prompt_provider(std::shared_ptr<scene::PromptSession> const&,
                              std::shared_ptr<scene::Session> const&) const
     {

=== modified file 'tests/include/mir_test_doubles/stub_scene_session.h'
--- tests/include/mir_test_doubles/stub_scene_session.h	2014-09-11 05:51:44 +0000
+++ tests/include/mir_test_doubles/stub_scene_session.h	2015-01-12 15:38:36 +0000
@@ -88,6 +88,14 @@
     {
     }
 
+    void suspend_prompt_session() override
+    {
+    }
+
+    void resume_prompt_session() override
+    {
+    }
+
     pid_t const pid;
 };
 

=== modified file 'tests/unit-tests/scene/CMakeLists.txt'
--- tests/unit-tests/scene/CMakeLists.txt	2014-09-11 05:51:44 +0000
+++ tests/unit-tests/scene/CMakeLists.txt	2015-01-12 15:38:36 +0000
@@ -10,6 +10,7 @@
   ${CMAKE_CURRENT_SOURCE_DIR}/test_mediating_display_changer.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/test_prompt_session_container.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/test_prompt_session_manager.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/test_prompt_session_impl.cpp
 
   ${CMAKE_CURRENT_SOURCE_DIR}/test_surface.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/test_surface_impl.cpp

=== added file 'tests/unit-tests/scene/test_prompt_session_impl.cpp'
--- tests/unit-tests/scene/test_prompt_session_impl.cpp	1970-01-01 00:00:00 +0000
+++ tests/unit-tests/scene/test_prompt_session_impl.cpp	2015-01-12 15:38:36 +0000
@@ -0,0 +1,110 @@
+/*
+ * Copyright © 2014 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU 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 warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored By: Nick Dedekind <[e-mail]>
+ */
+
+
+#include "src/server/scene/prompt_session_impl.h"
+
+#include "mir_test_doubles/mock_scene_session.h"
+#include "mir_test/fake_shared.h"
+
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+namespace ms = mir::scene;
+namespace mt = mir::test;
+namespace mtd = mir::test::doubles;
+
+using namespace ::testing;
+
+namespace
+{
+
+struct PromptSession : public testing::Test
+{
+    std::shared_ptr<mtd::MockSceneSession> const helper{std::make_shared<::testing::NiceMock<mtd::MockSceneSession>>()};
+};
+
+}
+
+TEST_F(PromptSession, start_when_stopped)
+{
+    ms::PromptSessionImpl prompt_session;
+    EXPECT_EQ(prompt_session.state(), mir_prompt_session_state_stopped);
+
+    EXPECT_CALL(*helper, start_prompt_session()).Times(1);
+    prompt_session.start(helper);
+
+    EXPECT_EQ(prompt_session.state(), mir_prompt_session_state_started);
+}
+
+TEST_F(PromptSession, stop_when_started)
+{
+    ms::PromptSessionImpl prompt_session;
+    prompt_session.start(helper);
+    EXPECT_EQ(prompt_session.state(), mir_prompt_session_state_started);
+
+    EXPECT_CALL(*helper, stop_prompt_session()).Times(1);
+    prompt_session.stop(helper);
+
+    EXPECT_EQ(prompt_session.state(), mir_prompt_session_state_stopped);
+}
+
+TEST_F(PromptSession, suspend_when_started)
+{
+    ms::PromptSessionImpl prompt_session;
+    prompt_session.start(helper);
+    EXPECT_EQ(prompt_session.state(), mir_prompt_session_state_started);
+
+    EXPECT_CALL(*helper, suspend_prompt_session()).Times(1);
+    prompt_session.suspend(helper);
+
+    EXPECT_EQ(prompt_session.state(), mir_prompt_session_state_suspended);
+}
+
+TEST_F(PromptSession, suspend_fails_to_stop_helper_when_not_started)
+{
+    ms::PromptSessionImpl prompt_session;
+
+    EXPECT_CALL(*helper, suspend_prompt_session()).Times(0);
+    prompt_session.suspend(helper);
+
+    EXPECT_EQ(prompt_session.state(), mir_prompt_session_state_stopped);
+}
+
+TEST_F(PromptSession, resume_when_suspended)
+{
+    ms::PromptSessionImpl prompt_session;
+    prompt_session.start(helper);
+    prompt_session.suspend(helper);
+    EXPECT_EQ(prompt_session.state(), mir_prompt_session_state_suspended);
+
+    EXPECT_CALL(*helper, resume_prompt_session()).Times(1);
+    prompt_session.resume(helper);
+
+    EXPECT_EQ(prompt_session.state(), mir_prompt_session_state_started);
+}
+
+TEST_F(PromptSession, resume_fails_to_stop_helper_when_not_started)
+{
+    ms::PromptSessionImpl prompt_session;
+
+    EXPECT_CALL(*helper, resume_prompt_session()).Times(0);
+    prompt_session.resume(helper);
+
+    EXPECT_EQ(prompt_session.state(), mir_prompt_session_state_stopped);
+}

=== modified file 'tests/unit-tests/scene/test_prompt_session_manager.cpp'
--- tests/unit-tests/scene/test_prompt_session_manager.cpp	2014-09-11 05:51:44 +0000
+++ tests/unit-tests/scene/test_prompt_session_manager.cpp	2015-01-12 15:38:36 +0000
@@ -128,10 +128,20 @@
     auto const prompt_session = session_manager.start_prompt_session_for(helper, parameters);
 
     EXPECT_CALL(prompt_session_listener, stopping(Eq(prompt_session))).Times(1);
+
     session_manager.stop_prompt_session(prompt_session);
-
-    // Need to verify explicitly as we see unmatched callbacks during teardown of fixture
-    Mock::VerifyAndClearExpectations(&prompt_session_listener);
+}
+
+TEST_F(PromptSessionManager, notifies_provider_of_suspend_and_resume)
+{
+    InSequence seq;
+    EXPECT_CALL(prompt_session_listener, suspending(_)).Times(1);
+
+    session_manager.suspend_prompt_session(prompt_session);
+
+    EXPECT_CALL(prompt_session_listener, resuming(Eq(prompt_session))).Times(1);
+
+    session_manager.resume_prompt_session(prompt_session);
 }
 
 TEST_F(PromptSessionManager, sets_helper_for)