Unity 8

Merge lp:~mterry/unity8/is-active into lp:unity8

is-active
Merge into trunk

Proposed by Michael Terry on 2014-06-18

Status:	Merged
Approved by:	Michael Zanetti on 2014-07-15
Approved revision:	979
Merged at revision:	1047
Proposed branch:	lp:~mterry/unity8/is-active
Merge into:	lp:unity8
Diff against target:	335 lines (+180/-1) 10 files modified plugins/LightDM/CMakeLists.txt (+1/-0) plugins/LightDM/DBusGreeter.cpp (+60/-0) plugins/LightDM/DBusGreeter.h (+54/-0) plugins/LightDM/Greeter.cpp (+17/-0) plugins/LightDM/Greeter.h (+4/-0) plugins/LightDM/plugin.cpp (+3/-0) qml/Shell.qml (+6/-0) tests/mocks/LightDM/CMakeLists.txt (+1/-0) tests/plugins/LightDM/CMakeLists.txt (+1/-1) tests/plugins/LightDM/dbus.cpp (+33/-0)
To merge this branch:	bzr merge lp:~mterry/unity8/is-active
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
Seth Arnold (community)			Approve on 2014-07-18
Michael Zanetti (community)		2014-06-18	Approve on 2014-07-15
PS Jenkins bot (community)	continuous-integration		Approve on 2014-07-11
Review via email: mp+223653@code.launchpad.net

Commit message

Expose a new greeter DBus property, IsActive, which tells apps and indicators when the integrated-greeter screen is active. Useful for switching UI modes when the screen is locked.

Description of the change

Expose a new greeter DBus property, IsActive, which tells apps and indicators when the integrated-greeter screen is active. Useful for switching UI modes when the screen is locked.

This property is not relevant when using a split greeter. But for an integrated greeter, it is useful. Both indicators and dialer-app will likely use this property to determine what UI mode to use. (reduced information for indicators, emergency dialer mode for dialer-app)

I also took this opportunity to run the greeter dbus test under xvfb.

== Checklist ==

* Are there any related MPs required for this MP to build/function as expected? Please list.
- No

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

* Did you make sure that your branch does not contain spurious tags?
- Yes

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

* If you changed the UI, has there been a design review?
- NA

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-06-18:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/3173/rebuild

review: Approve (continuous-integration)

Revision history for this message

Michael Terry (mterry) wrote on 2014-06-19:

Hmm, I expect I'll want to let the session write true to this property to lock the screen (but throw an error if the session tries to set false). Will do a bit more work on it.

Revision history for this message

Michael Terry (mterry) wrote on 2014-06-19:

Ugh, upon immediate reflection, that change isn't needed yet. I don't want to block progress on that feature.

lp:~mterry/unity8/is-active updated on 2014-06-22

977. By Michael Terry on 2014-06-22: Merge from trunk

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-06-23:

FAILED: Continuous integration, rev:977
http://jenkins.qa.ubuntu.com/job/unity8-ci/3191/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/1083
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-utopic/195/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-amd64-ci/285
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-armhf-ci/285
        deb: http://jenkins.qa.ubuntu.com/job/unity8-utopic-armhf-ci/285/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-i386-ci/285
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/1453
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/1894
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/1894/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/8703

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/3191/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Michael Zanetti (mzanetti) wrote on 2014-06-27:

Checklist missing

========
I tried:

$ qdbus com.canonical.UnityGreeter

Error: org.freedesktop.DBus.Error.NoReply
Did not receive a reply. Possible causes include: the remote application did not send a reply, the message bus security policy blocked the reply, the reply timeout expired, or the network connection was broken.

It seems like this in trunk too... Can you explain why its not working?

(also note that the other dbus interfaces are com.canonical.Unity.Something. Just the greeter one differs in naming.

review: Needs Information

Revision history for this message

Michael Terry (mterry) wrote on 2014-06-27:

Checklist added.

As for the UnityGreeter vs Unity.Greeter, two reasons. One reason is that the greeter being part of the Unity project itself is new. Before, it was just a greeter designed to look like Unity, so it seemed inappropriate to glom it into the Unity namespace. We felt it was its own entity.

But a much more important reason nowadays is that this is an historical interface, and we need to match what the desktop greeter has been doing for ages.

Finally, as for your qdbus error, running "qdbus com.canonical.UnityGreeter" works for me...:
/
/com
/com/canonical
/list
/org

Revision history for this message

Gustavo Pichorim Boiko (boiko) wrote on 2014-06-27:

I can confirm running "qdbus com.canonical.UnityGreeter" works.

I also tested the value of IsActive and it seems to behave correctly.

lp:~mterry/unity8/is-active updated on 2014-06-27

978. By Michael Terry on 2014-06-27: Merge from trunk

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-06-28:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/3260/rebuild

review: Needs Fixing (continuous-integration)

lp:~mterry/unity8/is-active updated on 2014-07-11

979. By Michael Terry on 2014-07-11: Merge from trunk

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-07-11:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/3412/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-07-11:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/3416/rebuild

review: Approve (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-07-11:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/3420/rebuild

review: Approve (continuous-integration)

Revision history for this message

Michael Zanetti (mzanetti) wrote on 2014-07-15:

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

yes.

* Did CI run pass? If not, please explain why.

yes.

review: Approve

Revision history for this message

Seth Arnold (seth-arnold) wrote on 2014-07-18:

Looks good to me, thanks.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Michael Terry

Mohammad Rakibul Hasan

Unity Team

 === modified file 'plugins/LightDM/CMakeLists.txt'
 --- plugins/LightDM/CMakeLists.txt	2014-06-11 15:36:51 +0000
 +++ plugins/LightDM/CMakeLists.txt	2014-07-11 15:40:06 +0000
@@ -15,6 +15,7 @@
  set(QMLPLUGIN_SRC
      ../Utils/qsortfilterproxymodelqml.cpp # FIXME evaluate a more generic approach for using other plugins
++    DBusGreeter.cpp
      DBusGreeterList.cpp
      Greeter.cpp
      plugin.cpp
 === added file 'plugins/LightDM/DBusGreeter.cpp'
 --- plugins/LightDM/DBusGreeter.cpp	1970-01-01 00:00:00 +0000
 +++ plugins/LightDM/DBusGreeter.cpp	2014-07-11 15:40:06 +0000
@@ -0,0 +1,60 @@
++/*
++ * Copyright (C) 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 as published by
++ * the Free Software Foundation; version 3.
++ *
++ * 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/>.
++ */
++
++#include "DBusGreeter.h"
++#include "Greeter.h"
++
++#include <QDBusMessage>
++#include <QStringList>
++
++DBusGreeter::DBusGreeter(Greeter *greeter, const QDBusConnection &connection, const QString &path)
++ : QObject(greeter),
++   m_greeter(greeter),
++   m_connection(connection),
++   m_path(path)
++{
++    connect(m_greeter, SIGNAL(isActiveChanged()), this, SLOT(isActiveChangedHandler()));
++}
++
++bool DBusGreeter::isActive() const
++{
++    return m_greeter->isActive();
++}
++
++void DBusGreeter::isActiveChangedHandler()
++{
++    notifyPropertyChanged("IsActive", isActive());
++    Q_EMIT isActiveChanged();
++}
++
++// Manually emit a PropertiesChanged signal over DBus, because QtDBus
++// doesn't do it for us on Q_PROPERTIES, oddly enough.
++void DBusGreeter::notifyPropertyChanged(const QString& propertyName, const QVariant &value)
++{
++    QDBusMessage message;
++    QVariantMap changedProps;
++
++    changedProps.insert(propertyName, value);
++
++    message = QDBusMessage::createSignal(m_path,
++                                         "org.freedesktop.DBus.Properties",
++                                         "PropertiesChanged");
++    message << "com.canonical.UnityGreeter";
++    message << changedProps;
++    message << QStringList();
++
++    m_connection.send(message);
++}
 === added file 'plugins/LightDM/DBusGreeter.h'
 --- plugins/LightDM/DBusGreeter.h	1970-01-01 00:00:00 +0000
 +++ plugins/LightDM/DBusGreeter.h	2014-07-11 15:40:06 +0000
@@ -0,0 +1,54 @@
++/*
++ * Copyright (C) 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 as published by
++ * the Free Software Foundation; version 3.
++ *
++ * 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/>.
++ */
++
++#ifndef UNITY_DBUSGREETER_H
++#define UNITY_DBUSGREETER_H
++
++#include <QDBusConnection>
++#include <QObject>
++
++class Greeter;
++class QDBusInterface;
++
++/** This is an internal class used to talk with the indicators.
++  */
++
++class DBusGreeter : public QObject
++{
++    Q_OBJECT
++    Q_CLASSINFO("D-Bus Interface", "com.canonical.UnityGreeter")
++
++    Q_PROPERTY(bool IsActive READ isActive NOTIFY isActiveChanged) // since 14.10
++
++public:
++    explicit DBusGreeter(Greeter *greeter, const QDBusConnection &connection, const QString &path);
++
++    bool isActive() const;
++
++Q_SIGNALS:
++    void isActiveChanged();
++
++private Q_SLOTS:
++    void isActiveChangedHandler();
++    void notifyPropertyChanged(const QString &propertyName, const QVariant &value);
++
++private:
++    Greeter *m_greeter;
++    QDBusConnection m_connection;
++    QString m_path;
++};
++
++#endif
 === modified file 'plugins/LightDM/Greeter.cpp'
 --- plugins/LightDM/Greeter.cpp	2014-06-11 15:36:51 +0000
 +++ plugins/LightDM/Greeter.cpp	2014-07-11 15:40:06 +0000
@@ -25,6 +25,7 @@
      explicit GreeterPrivate(Greeter *parent);
      QLightDM::Greeter *m_greeter;
++    bool m_active;
      bool wasPrompted;
      bool promptless;
@@ -38,6 +39,7 @@
  GreeterPrivate::GreeterPrivate(Greeter* parent)
    : m_greeter(new QLightDM::Greeter(parent)),
++    m_active(false),
      wasPrompted(false),
      promptless(false),
      q_ptr(parent)
@@ -60,6 +62,21 @@
      d->m_greeter->connectSync();
+ }
++bool Greeter::isActive() const
++{
++    Q_D(const Greeter);
++    return d->m_active;
++}
++
++void Greeter::setIsActive(bool active)
++{
++    Q_D(Greeter);
++    if (d->m_active != active) {
++        d->m_active = active;
++        Q_EMIT isActiveChanged();
++    }
++}
++
  bool Greeter::isAuthenticated() const
+ {
      Q_D(const Greeter);
 === modified file 'plugins/LightDM/Greeter.h'
 --- plugins/LightDM/Greeter.h	2014-06-11 15:36:51 +0000
 +++ plugins/LightDM/Greeter.h	2014-07-11 15:40:06 +0000
@@ -34,6 +34,7 @@
+ {
      Q_OBJECT
++    Q_PROPERTY(bool active READ isActive WRITE setIsActive NOTIFY isActiveChanged)
      Q_PROPERTY(bool authenticated READ isAuthenticated)
      Q_PROPERTY(QString authenticationUser READ authenticationUser NOTIFY authenticationUserChanged)
      Q_PROPERTY(bool promptless READ promptless NOTIFY promptlessChanged)
@@ -41,6 +42,7 @@
  public:
      explicit Greeter(QObject* parent=0);
++    bool isActive() const;
      bool isAuthenticated() const;
      QString authenticationUser() const;
      bool promptless() const;
@@ -49,12 +51,14 @@
      void authenticate(const QString &username=QString());
      void respond(const QString &response);
      bool startSessionSync(const QString &session=QString());
++    void setIsActive(bool isActive);
  Q_SIGNALS:
      void showMessage(const QString &text, bool isError);
      void showPrompt(const QString &text, bool isSecret);
      void authenticationComplete();
      void authenticationUserChanged(const QString &user);
++    void isActiveChanged();
      void promptlessChanged();
      // This signal is emitted by external agents like indicators, and the UI
 === modified file 'plugins/LightDM/plugin.cpp'
 --- plugins/LightDM/plugin.cpp	2014-06-11 15:36:51 +0000
 +++ plugins/LightDM/plugin.cpp	2014-07-11 15:40:06 +0000
@@ -18,6 +18,7 @@
   */
  #include "plugin.h"
++#include "DBusGreeter.h"
  #include "DBusGreeterList.h"
  #include "Greeter.h"
  #include "UsersModel.h"
@@ -39,6 +40,8 @@
      Greeter *greeter = new Greeter();
      QDBusConnection connection = QDBusConnection::sessionBus();
++    DBusGreeter *root = new DBusGreeter(greeter, connection, "/");
++    connection.registerObject("/", root, QDBusConnection::ExportScriptableContents);
      DBusGreeterList *list = new DBusGreeterList(greeter, connection, GREETER_LIST_DBUS_PATH);
      connection.registerObject(GREETER_LIST_DBUS_PATH, list, QDBusConnection::ExportScriptableContents);
      connection.registerService(GREETER_DBUS_SERVICE);
 === modified file 'qml/Shell.qml'
 --- qml/Shell.qml	2014-07-09 19:44:14 +0000
 +++ qml/Shell.qml	2014-07-11 15:40:06 +0000
@@ -373,6 +373,12 @@
+         }
+     }
++    Binding {
++        target: LightDM.Greeter
++        property: "active"
++        value: greeter.shown || lockscreen.shown
++    }
++
      Rectangle {
          anchors.fill: parent
          color: "black"
 === modified file 'tests/mocks/LightDM/CMakeLists.txt'
 --- tests/mocks/LightDM/CMakeLists.txt	2014-06-11 15:36:51 +0000
 +++ tests/mocks/LightDM/CMakeLists.txt	2014-07-11 15:40:06 +0000
@@ -18,6 +18,7 @@
+ )
  set(QMLPLUGIN_SRC
++    ${CMAKE_SOURCE_DIR}/plugins/LightDM/DBusGreeter.cpp
      ${CMAKE_SOURCE_DIR}/plugins/LightDM/DBusGreeterList.cpp
      ${CMAKE_SOURCE_DIR}/plugins/LightDM/Greeter.cpp
      ${CMAKE_SOURCE_DIR}/plugins/LightDM/plugin.cpp
 === modified file 'tests/plugins/LightDM/CMakeLists.txt'
 --- tests/plugins/LightDM/CMakeLists.txt	2014-06-11 15:36:51 +0000
 +++ tests/plugins/LightDM/CMakeLists.txt	2014-07-11 15:40:06 +0000
@@ -19,7 +19,7 @@
  add_definitions(-DCURRENT_SOURCE_DIR="${CMAKE_CURRENT_SOURCE_DIR}")
--add_custom_target(testLightDMDBus dbus-launch env QML2_IMPORT_PATH=${CMAKE_BINARY_DIR}/tests/mocks LD_LIBRARY_PATH=${CMAKE_BINARY_DIR}/tests/mocks/LightDM/full ${CMAKE_CURRENT_BINARY_DIR}/test-lightdm-dbus)
++add_custom_target(testLightDMDBus xvfb-run --server-args "-screen 0 1024x768x24" --auto-servernum dbus-launch env QML2_IMPORT_PATH=${CMAKE_BINARY_DIR}/tests/mocks LD_LIBRARY_PATH=${CMAKE_BINARY_DIR}/tests/mocks/LightDM/full ${CMAKE_CURRENT_BINARY_DIR}/test-lightdm-dbus)
  add_dependencies(testLightDMDBus test-lightdm-dbus)
  add_dependencies(qmluitests testLightDMDBus)
 === modified file 'tests/plugins/LightDM/dbus.cpp'
 --- tests/plugins/LightDM/dbus.cpp	2013-12-03 16:55:03 +0000
 +++ tests/plugins/LightDM/dbus.cpp	2014-07-11 15:40:06 +0000
@@ -40,6 +40,13 @@
          // to watch.
          QDBusConnection::sessionBus().connect(
              "com.canonical.UnityGreeter",
++            "/",
++            "org.freedesktop.DBus.Properties",
++            "PropertiesChanged",
++            this,
++            SIGNAL(PropertiesChangedRelay(const QString&, const QVariantMap&, const QStringList&)));
++        QDBusConnection::sessionBus().connect(
++            "com.canonical.UnityGreeter",
              "/list",
              "org.freedesktop.DBus.Properties",
              "PropertiesChanged",
@@ -57,6 +64,12 @@
          view->show();
          QTest::qWaitForWindowExposed(view);
++        dbusMain = new QDBusInterface("com.canonical.UnityGreeter",
++                                      "/",
++                                      "com.canonical.UnityGreeter",
++                                      QDBusConnection::sessionBus(), view);
++        QVERIFY(dbusMain->isValid());
++
          dbusList = new QDBusInterface("com.canonical.UnityGreeter",
                                        "/list",
                                        "com.canonical.UnityGreeter.List",
@@ -155,9 +168,29 @@
          QVERIFY(arguments.at(1).toMap()["EntryIsLocked"] == false);
+     }
++    void testIsActive()
++    {
++        QVERIFY(!greeter->isActive());
++        QVERIFY(!dbusMain->property("IsActive").toBool());
++
++        QSignalSpy spy(this, SIGNAL(PropertiesChangedRelay(QString, QVariantMap, QStringList)));
++        greeter->setIsActive(true);
++        spy.wait();
++
++        QVERIFY(greeter->isActive());
++        QVERIFY(dbusMain->property("IsActive").toBool());
++
++        QCOMPARE(spy.count(), 1);
++        QList<QVariant> arguments = spy.takeFirst();
++        QCOMPARE(arguments.at(0).toString(), QString("com.canonical.UnityGreeter"));
++        QVERIFY(arguments.at(1).toMap().contains("IsActive"));
++        QVERIFY(arguments.at(1).toMap()["IsActive"].toBool());
++    }
++
  private:
      QQuickView *view;
      Greeter *greeter;
++    QDBusInterface *dbusMain;
      QDBusInterface *dbusList;
  };