Merge lp:~mterry/unity-api/warn-on-xapp into lp:unity-api

[Michael Terry]

Add support for isTouchApp property on LauncherItems and support for approving an application before it starts.

This is part of a larger effort to allow warning users before a legacy app is started [1].

==

isTouchApp on LauncherItems may be used by unity8 to render the launcher icons differently (though it isn't used now... waiting on design feedback).

This is a distinct setting from the isTouchApp property on ApplicationInfo since LauncherItems represent a potentially-running app, while ApplicationInfos represent a running app.

I considered making a more generic property. Something like "type" which could be "touch", "legacy", or something new and weird in the future. ("gnome" or "android" or something)

However, I felt that a launcher item backend was not necessarily the best place to condense the various information sources into one single answer (what if the .desktop file somehow indicates touch and android support?).

Plus, I felt that the interface should be as dumb as possible, which helps .desktop file backends simply pass the info they see through.

(And it matches the existing ApplicationInfo property)

==

The approveApplicationStart API is used to support the new upstart-app-launch round trip blocking when an application is starting (it waits for approval before actually finishing the application startup).

==

[1] https://code.launchpad.net/~mterry/unity8/warn-on-xapp/+merge/277915
    https://code.launchpad.net/~mterry/qtmir/warn-on-xapp/+merge/279172
    https://code.launchpad.net/~mterry/ubuntu-app-launch/warn-on-xapp/+merge/278497

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:195
http://jenkins.qa.ubuntu.com/job/unity-api-ci/361/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-amd64-ci/49
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/50
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/50/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-i386-ci/49
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-amd64-ci/60
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/60
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/60/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-i386-ci/60

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-api-ci/361/rebuild

review: Approve (continuous-integration)

[lp:~mterry/unity-api/warn-on-xapp]

196. By Michael Terry on 2015-12-01

Add new ApplicationManager methods for approving an interface

197. By Michael Terry on 2015-12-01

Merge from trunk

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:197
http://jenkins.qa.ubuntu.com/job/unity-api-ci/368/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-amd64-ci/56
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/57
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/57/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-i386-ci/56
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-amd64-ci/67
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/67
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/67/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-i386-ci/67

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-api-ci/368/rebuild

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

nitpick:
+ * @brief Allow (or not) an application to finish starting.
this is very upstart terminology. Simpler just to say "Allow (or not) an application to start"

Rest looks good to me

[Gerry Boland (gerboland)]

review: Needs Fixing

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

PASSED: Continuous integration, rev:197
https://unity8-jenkins.ubuntu.com/job/lp-unity-api-1-ci/3/
Executed test runs:

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-unity-api-1-ci/3/rebuild

review: Approve (continuous-integration)

[lp:~mterry/unity-api/warn-on-xapp]

198. By Michael Terry on 2016-05-16

Merge from trunk

199. By Michael Terry on 2016-05-16

Fix documentation nit from review

200. By Michael Terry on 2016-05-16

Fix changelog/version

Unmerged revisions

200. By Michael Terry on 2016-05-16

Fix changelog/version

199. By Michael Terry on 2016-05-16

Fix documentation nit from review

198. By Michael Terry on 2016-05-16

Merge from trunk

197. By Michael Terry on 2015-12-01

Merge from trunk

196. By Michael Terry on 2015-12-01

Add new ApplicationManager methods for approving an interface

195. By Michael Terry on 2015-11-09

Add isTouchApp to LauncherItemInterface

=== modified file 'debian/changelog'
--- debian/changelog	2016-04-26 15:31:50 +0000
+++ debian/changelog	2016-05-16 18:05:24 +0000
@@ -1,3 +1,10 @@
+unity-api (7.112) UNRELEASED; urgency=medium
+
+  * Add isTouchApp to LauncherItemInterface
+  * Add approveApplicationStart to ApplicationManagerInterface
+
+ -- Michael Terry <[e-mail]>  Mon, 09 Nov 2015 16:57:25 -0500
+
 unity-api (7.111+16.04.20160426.2-0ubuntu1) xenial; urgency=medium
 
   [ Pawel Stolowski ]

=== modified file 'include/unity/shell/application/ApplicationManagerInterface.h'
--- include/unity/shell/application/ApplicationManagerInterface.h	2016-04-13 16:47:27 +0000
+++ include/unity/shell/application/ApplicationManagerInterface.h	2016-05-16 18:05:24 +0000
@@ -156,6 +156,15 @@
     Q_INVOKABLE virtual unity::shell::application::ApplicationInfoInterface *startApplication(const QString &appId, const QStringList &arguments) = 0;
 
     /**
+     * @brief Allow (or not) an application to start.
+     *
+     * @param appId The appId for the application to allow.
+     * @param approved Whether the application is allowed or not.
+     * @returns True if application approval was successful, else false.
+     */
+    Q_INVOKABLE virtual bool approveApplicationStart(const QString &appId, bool approved) = 0;
+
+    /**
       * @brief Stops an application.
       *
       * @param appId The application to be stopped.
@@ -177,6 +186,16 @@
     void focusRequested(const QString &appId);
 
     /**
+     * @brief Will be emitted when an application wants to start.
+     *
+     * This can be used to approve or deny the application with
+     * approveApplicationStart(). For example, maybe an application requires
+     * further permission.  Or an application can't start right now because
+     * the device is in the wrong mode (phone vs desktop).
+     */
+    void applicationStartApprovalRequested(const QString &appId);
+
+    /**
      * @brief Will be emitted whenever the focused application changes.
      */
     void focusedApplicationIdChanged();

=== modified file 'include/unity/shell/application/CMakeLists.txt'
--- include/unity/shell/application/CMakeLists.txt	2016-04-13 16:40:06 +0000
+++ include/unity/shell/application/CMakeLists.txt	2016-05-16 18:05:24 +0000
@@ -7,7 +7,7 @@
 
 set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE)
 
-set(VERSION 15)
+set(VERSION 16)
 set(PKGCONFIG_NAME "unity-shell-application")
 set(PKGCONFIG_DESCRIPTION "Unity shell Application APIs")
 set(PKGCONFIG_REQUIRES "Qt5Core")

=== modified file 'include/unity/shell/launcher/CMakeLists.txt'
--- include/unity/shell/launcher/CMakeLists.txt	2015-06-19 16:13:00 +0000
+++ include/unity/shell/launcher/CMakeLists.txt	2016-05-16 18:05:24 +0000
@@ -7,7 +7,7 @@
 
 set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE)
 
-set(VERSION 7)
+set(VERSION 8)
 set(PKGCONFIG_NAME "unity-shell-launcher")
 set(PKGCONFIG_DESCRIPTION "Unity shell Launcher APIs")
 set(PKGCONFIG_REQUIRES "Qt5Core")

=== modified file 'include/unity/shell/launcher/LauncherItemInterface.h'
--- include/unity/shell/launcher/LauncherItemInterface.h	2015-06-12 11:06:29 +0000
+++ include/unity/shell/launcher/LauncherItemInterface.h	2016-05-16 18:05:24 +0000
@@ -112,6 +112,11 @@
     Q_PROPERTY(bool alerting READ alerting NOTIFY alertingChanged)
 
     /**
+     * @brief Whether the application is designed for Ubuntu Touch
+     */
+    Q_PROPERTY(bool isTouchApp READ isTouchApp NOTIFY isTouchAppChanged)
+
+    /**
      * @brief The quick list menu contents for the item
      *
      * Items can have a quick list menu. This property holds a model for
@@ -138,6 +143,7 @@
     virtual bool countVisible() const = 0;
     virtual bool focused() const = 0;
     virtual bool alerting() const = 0;
+    virtual bool isTouchApp() const = 0;
     virtual unity::shell::launcher::QuickListModelInterface *quickList() const = 0;
 
 Q_SIGNALS:
@@ -151,6 +157,7 @@
     void countVisibleChanged(bool countVisible);
     void focusedChanged(bool focused);
     void alertingChanged(bool alerting);
+    void isTouchAppChanged(bool isTouchApp);
     /// @endcond
 };
 

=== modified file 'include/unity/shell/launcher/LauncherModelInterface.h'
--- include/unity/shell/launcher/LauncherModelInterface.h	2015-06-19 16:13:00 +0000
+++ include/unity/shell/launcher/LauncherModelInterface.h	2016-05-16 18:05:24 +0000
@@ -73,6 +73,7 @@
         m_roleNames.insert(RoleCountVisible, "countVisible");
         m_roleNames.insert(RoleFocused, "focused");
         m_roleNames.insert(RoleAlerting, "alerting");
+        m_roleNames.insert(RoleIsTouchApp, "isTouchApp");
     }
     /// @endcond
 
@@ -93,7 +94,8 @@
         RoleCount,
         RoleCountVisible,
         RoleFocused,
-        RoleAlerting
+        RoleAlerting,
+        RoleIsTouchApp
     };
 
     virtual ~LauncherModelInterface() {}

=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.cpp'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.cpp	2015-12-03 17:07:15 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.cpp	2016-05-16 18:05:24 +0000
@@ -125,6 +125,13 @@
     return item;
 }
 
+bool MockApplicationManager::approveApplicationStart(const QString &appId, bool approved)
+{
+    Q_UNUSED(appId)
+    Q_UNUSED(approved)
+    return true;
+}
+
 bool MockApplicationManager::stopApplication(const QString &appId)
 {
     Q_UNUSED(appId)

=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h	2015-06-19 12:02:05 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h	2016-05-16 18:05:24 +0000
@@ -52,6 +52,8 @@
 
     Q_INVOKABLE unity::shell::application::ApplicationInfoInterface *startApplication(const QString &appId, const QStringList &arguments);
 
+    Q_INVOKABLE bool approveApplicationStart(const QString &appId, bool approved);
+
     Q_INVOKABLE bool stopApplication(const QString &appId);
 
 private:

=== modified file 'test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherItem.cpp'
--- test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherItem.cpp	2015-06-18 17:03:45 +0000
+++ test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherItem.cpp	2016-05-16 18:05:24 +0000
@@ -35,6 +35,7 @@
     m_count(8),
     m_countVisible(false),
     m_alerting(false),
+    m_isTouchApp(false),
     m_quickListModel(new MockQuickListModel(this))
 {
 
@@ -172,6 +173,20 @@
     }
 }
 
+bool MockLauncherItem::isTouchApp() const
+{
+    return m_isTouchApp;
+}
+
+void MockLauncherItem::setIsTouchApp(bool isTouchApp)
+{
+    if (m_isTouchApp != isTouchApp)
+    {
+        m_isTouchApp = isTouchApp;
+        Q_EMIT isTouchAppChanged(isTouchApp);
+    }
+}
+
 QuickListModelInterface *MockLauncherItem::quickList() const
 {
     return m_quickListModel;

=== modified file 'test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherItem.h'
--- test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherItem.h	2015-06-02 13:52:49 +0000
+++ test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherItem.h	2016-05-16 18:05:24 +0000
@@ -59,6 +59,9 @@
     bool alerting() const;
     void setAlerting(bool alerting);
 
+    bool isTouchApp() const;
+    void setIsTouchApp(bool isTouchApp);
+
     unity::shell::launcher::QuickListModelInterface *quickList() const;
 
 private:
@@ -74,6 +77,7 @@
     bool m_countVisible;
     bool m_focused;
     bool m_alerting;
+    bool m_isTouchApp;
     QuickListModelInterface *m_quickListModel;
 };
 

=== modified file 'test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherModel.cpp'
--- test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherModel.cpp	2015-06-19 16:13:00 +0000
+++ test/qmltest/mocks/plugins/Unity/Launcher/Mocks/MockLauncherModel.cpp	2016-05-16 18:05:24 +0000
@@ -90,6 +90,8 @@
         return item->focused();
     case RoleAlerting:
         return item->alerting();
+    case RoleIsTouchApp:
+        return item->isTouchApp();
     }
 
     return QVariant();

=== modified file 'test/qmltest/unity/shell/application/tst_Application.qml'
--- test/qmltest/unity/shell/application/tst_Application.qml	2015-12-03 17:07:15 +0000
+++ test/qmltest/unity/shell/application/tst_Application.qml	2016-05-16 18:05:24 +0000
@@ -114,6 +114,7 @@
                 { tag: "ApplicationManager.methods[focusApplication]", method: "focusApplication" },
                 { tag: "ApplicationManager.methods[unfocusCurrentApplication]", method: "unfocusCurrentApplication" },
                 { tag: "ApplicationManager.methods[startApplication]", method: "startApplication" },
+                { tag: "ApplicationManager.methods[approveApplicationStart]", method: "approveApplicationStart" },
                 { tag: "ApplicationManager.methods[stopApplication]", method: "stopApplication" },
             ];
         }

=== modified file 'test/qmltest/unity/shell/launcher/tst_Launcher.qml'
--- test/qmltest/unity/shell/launcher/tst_Launcher.qml	2015-06-19 16:13:00 +0000
+++ test/qmltest/unity/shell/launcher/tst_Launcher.qml	2016-05-16 18:05:24 +0000
@@ -88,6 +88,7 @@
                         { tag: "Model.roles[countVisible]", role: "countVisible", type: "boolean" },
                         { tag: "Model.roles[focused]", role: "focused", type: "boolean" },
                         { tag: "Model.roles[alerting]", role: "alerting", type: "boolean" },
+                        { tag: "Model.roles[isTouchApp]", role: "isTouchApp", type: "boolean" },
                     ];
         }
 
@@ -146,6 +147,7 @@
                 { tag: "Item.properties[countVisible]", property: "countVisible", type: "boolean" },
                 { tag: "Item.properties[focused]", property: "focused", type: "boolean" },
                 { tag: "Item.properties[alerting]", property: "alerting", type: "boolean" },
+                { tag: "Item.properties[isTouchApp]", property: "isTouchApp", type: "boolean" },
                 { tag: "Item.properties[quickList]", constant: "quickList", type: "object" },
             ];
         }