Merge lp:~marcustomlinson/keeper/qml-plugin into lp:keeper/devel

[Marcus Tomlinson]

Add client QML API

[unity-api-1-bot (unity-api-1-bot)]

FAILED: Continuous integration, rev:108
https://jenkins.canonical.com/unity-api-1/job/lp-keeper-ci/30/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/509/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/515
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-1-sourcepkg/release=vivid+overlay/420
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-1-sourcepkg/release=xenial+overlay/420
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-1-sourcepkg/release=yakkety/420
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=vivid+overlay/350
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=vivid+overlay/350/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=xenial+overlay/350
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=xenial+overlay/350/artifact/output/*zip*/output.zip
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=yakkety/350/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=vivid+overlay/350
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=vivid+overlay/350/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=xenial+overlay/350
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=xenial+overlay/350/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=yakkety/350
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=yakkety/350/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=vivid+overlay/350
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=vivid+overlay/350/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=xenial+overlay/350
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=xenial+overlay/350/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=yakkety/350
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=yakkety/350/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-keeper-ci/30/rebuild

review: Needs Fixing (continuous-integration)

[Charles Kerr (charlesk)]

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2016-08-26 09:36:01 +0000
+++ CMakeLists.txt	2016-08-26 09:36:01 +0000
@@ -1,7 +1,12 @@
 # Version
 set(KEEPER_MAJOR "0")
-set(KEEPER_MINOR "0")
-set(KEEPER_MICRO "1")
+set(KEEPER_MINOR "1")
+set(KEEPER_MICRO "0")
+
+set(
+  KEEPER_CLIENT_LIB
+  keeper-client-${KEEPER_MAJOR}.${KEEPER_MINOR}
+)
 
 # Default install location. Must be set here, before setting the project.
 if(NOT DEFINED CMAKE_INSTALL_PREFIX)
@@ -52,6 +57,7 @@
 find_package(Threads REQUIRED)
 
 set(CMAKE_AUTOMOC ON)
+set(CMAKE_INCLUDE_CURRENT_DIR ON)
 
 add_definitions(
     -DQT_NO_KEYWORDS=1

=== modified file 'debian/changelog'
--- debian/changelog	2016-06-21 08:04:21 +0000
+++ debian/changelog	2016-08-26 09:36:01 +0000
@@ -1,4 +1,4 @@
-keeper (0.0.1) UNRELEASED; urgency=medium
+keeper (0.1.0) UNRELEASED; urgency=medium
 
   * Initial release. 
 

=== modified file 'debian/control'
--- debian/control	2016-08-12 01:40:55 +0000
+++ debian/control	2016-08-26 09:36:01 +0000
@@ -66,6 +66,16 @@
 Description: Client library for Keeper
  Runtime support for Keeper clients.
 
+Package: qml-keeper
+Architecture: any
+Pre-Depends: ${misc:Pre-Depends}
+Multi-Arch: same
+Depends: ${misc:Depends},
+         ${shlibs:Depends},
+         libkeeper-client (= ${binary:Version}),
+Description: QML bindings for Keeper
+ This package contains the qtdeclarative bindings for Ubuntu Keeper.
+
 Package: keeper-client-dev
 Section: libdevel
 Architecture: any

=== added file 'debian/qml-keeper.install'
--- debian/qml-keeper.install	1970-01-01 00:00:00 +0000
+++ debian/qml-keeper.install	2016-08-26 09:36:01 +0000
@@ -0,0 +1,1 @@
+usr/lib/*/qt5/qml

=== modified file 'include/client/client.h'
--- include/client/client.h	2016-08-11 00:25:59 +0000
+++ include/client/client.h	2016-08-26 09:36:01 +0000
@@ -19,30 +19,58 @@
 
 #pragma once
 
-#define KEEPER_EXPORT __attribute__((visibility("default")))
-
 #include <QObject>
 #include <QScopedPointer>
+#include <QStringList>
 #include <QVariant>
 
 class KeeperClientPrivate;
 
-class KEEPER_EXPORT KeeperClient final : public QObject
+class Q_DECL_EXPORT KeeperClient : public QObject
 {
     Q_OBJECT
     Q_DISABLE_COPY(KeeperClient)
 
+// QML
 public:
     explicit KeeperClient(QObject* parent = nullptr);
     ~KeeperClient();
 
-    QMap<QString, QVariantMap> GetBackupChoices() const;
-    void StartBackup(QStringList const& uuids) const;
-
-    QMap<QString, QVariantMap> GetState() const;
+    Q_PROPERTY(QStringList backupUuids READ backupUuids CONSTANT)
+    QStringList backupUuids();
+
+    Q_PROPERTY(QString status READ status NOTIFY statusChanged)
+    QString status();
+
+    Q_PROPERTY(double progress READ progress NOTIFY progressChanged)
+    double progress();
+
+    Q_PROPERTY(bool readyToBackup READ readyToBackup NOTIFY readyToBackupChanged)
+    bool readyToBackup();
+
+    Q_PROPERTY(bool backupBusy READ backupBusy NOTIFY backupBusyChanged)
+    bool backupBusy();
+
+    Q_INVOKABLE QString getBackupName(QString uuid);
+    Q_INVOKABLE void enableBackup(QString uuid, bool enabled);
+    Q_INVOKABLE void startBackup();
+
+// C++
+public:
+    QMap<QString, QVariantMap> getBackupChoices() const;
+    void startBackup(QStringList const& uuids) const;
+
+    QMap<QString, QVariantMap> getState() const;
 
 Q_SIGNALS:
+    void statusChanged();
+    void progressChanged();
+    void readyToBackupChanged();
+    void backupBusyChanged();
+
+private Q_SLOTS:
+    void stateUpdated();
 
 private:
-    QScopedPointer<KeeperClientPrivate> const d_ptr;
+    QScopedPointer<KeeperClientPrivate> const d;
 };

=== modified file 'src/cli/main.cpp'
--- src/cli/main.cpp	2016-08-10 07:46:28 +0000
+++ src/cli/main.cpp	2016-08-26 09:36:01 +0000
@@ -21,7 +21,7 @@
 #include <dbus-types.h>
 #include <util/logging.h>
 
-#include "keeper_user_interface.h"
+#include <keeper_user_interface.h>
 
 #include <QCoreApplication>
 #include <QDBusConnection>

=== modified file 'src/client/CMakeLists.txt'
--- src/client/CMakeLists.txt	2016-08-10 07:43:36 +0000
+++ src/client/CMakeLists.txt	2016-08-26 09:36:01 +0000
@@ -1,7 +1,4 @@
-set(
-  CLIENT_LIB
-  keeper-client-${KEEPER_MAJOR}.${KEEPER_MINOR}
-)
+add_subdirectory(qml-plugin)
 
 set(
   CLIENT_HEADERS
@@ -9,19 +6,13 @@
 )
 
 add_library(
-  ${CLIENT_LIB} SHARED
+  ${KEEPER_CLIENT_LIB} SHARED
   client.cpp
   ${CLIENT_HEADERS}
 )
 
-set_target_properties(
-  ${CLIENT_LIB}
-  PROPERTIES
-  AUTOMOC TRUE
-)
-
 target_link_libraries(
-  ${CLIENT_LIB}
+  ${KEEPER_CLIENT_LIB}
   qdbus-stubs
   Qt5::Core
   Qt5::DBus
@@ -30,7 +21,7 @@
 set(
   COVERAGE_REPORT_TARGETS
   ${COVERAGE_REPORT_TARGETS}
-  ${CLIENT_LIB}
+  ${KEEPER_CLIENT_LIB}
   PARENT_SCOPE
 )
 
@@ -40,7 +31,7 @@
 )
 
 install(
-  TARGETS ${CLIENT_LIB}
+  TARGETS ${KEEPER_CLIENT_LIB}
   LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
 )
 

=== modified file 'src/client/client.cpp'
--- src/client/client.cpp	2016-08-10 02:06:08 +0000
+++ src/client/client.cpp	2016-08-26 09:36:01 +0000
@@ -17,41 +17,149 @@
  *     Marcus Tomlinson <[e-mail]>
  */
 
+#include <QTimer>
+
 #include <client/client.h>
 
 #include <qdbus-stubs/keeper_user_interface.h>
 
-class KeeperClientPrivate final
+struct KeeperClientPrivate final
 {
     Q_DISABLE_COPY(KeeperClientPrivate)
 
-public:
-    KeeperClientPrivate()
-        : user_iface(new DBusInterfaceKeeperUser(
-                         DBusTypes::KEEPER_SERVICE,
-                         DBusTypes::KEEPER_USER_PATH,
-                         QDBusConnection::sessionBus()
-                         ))
+    KeeperClientPrivate(QObject* parent)
+        : userIface(new DBusInterfaceKeeperUser(
+                          DBusTypes::KEEPER_SERVICE,
+                          DBusTypes::KEEPER_USER_PATH,
+                          QDBusConnection::sessionBus()
+                          )),
+        status(""),
+        progress(0),
+        readyToBackup(false),
+        backupBusy(false),
+        stateTimer(parent)
     {
     }
 
     ~KeeperClientPrivate() = default;
 
-    QScopedPointer<DBusInterfaceKeeperUser> user_iface;
+    QScopedPointer<DBusInterfaceKeeperUser> userIface;
+    QString status;
+    QMap<QString, QVariantMap> backups;
+    double progress;
+    bool readyToBackup;
+    bool backupBusy;
+    QTimer stateTimer;
 };
 
-KeeperClient::KeeperClient(QObject* parent)
-    : QObject{parent}
-    , d_ptr(new KeeperClientPrivate())
+KeeperClient::KeeperClient(QObject* parent) :
+    QObject(parent),
+    d(new KeeperClientPrivate(this))
 {
     DBusTypes::registerMetaTypes();
+
+    // Store backups list locally with an additional "enabled" pair to keep track enabled states
+    // TODO: We should be listening to a backupChoicesChanged signal to keep this list updated
+    d->backups = getBackupChoices();
+    for(auto iter = d->backups.begin(); iter != d->backups.end(); ++iter)
+    {
+        iter.value()["enabled"] = false;
+    }
+
+    connect(&d->stateTimer, &QTimer::timeout, this, &KeeperClient::stateUpdated);
 }
 
 KeeperClient::~KeeperClient() = default;
 
-QMap<QString, QVariantMap> KeeperClient::GetBackupChoices() const
-{
-    QDBusReply<QMap<QString, QVariantMap>> choices = d_ptr->user_iface->call("GetBackupChoices");
+QStringList KeeperClient::backupUuids()
+{
+    QStringList returnList;
+    for(auto iter = d->backups.begin(); iter != d->backups.end(); ++iter)
+    {
+        // TODO: We currently only support "folder" type backups
+        if (iter.value().value("type").toString() == "folder")
+        {
+            returnList.append(iter.key());
+        }
+    }
+    return returnList;
+}
+
+QString KeeperClient::status()
+{
+    return d->status;
+}
+
+double KeeperClient::progress()
+{
+    return d->progress;
+}
+
+bool KeeperClient::readyToBackup()
+{
+    return d->readyToBackup;
+}
+
+bool KeeperClient::backupBusy()
+{
+    return d->backupBusy;
+}
+
+void KeeperClient::enableBackup(QString uuid, bool enabled)
+{
+    d->backups[uuid]["enabled"] = enabled;
+
+    for (auto const& backup : d->backups)
+    {
+        d->readyToBackup = false;
+
+        if (backup.value("enabled") == true)
+        {
+            d->readyToBackup = true;
+            break;
+        }
+    }
+
+    Q_EMIT readyToBackupChanged();
+}
+
+void KeeperClient::startBackup()
+{
+    // TODO: Instead of polling for state, we should be listening to a stateChanged signal
+    if (!d->stateTimer.isActive())
+    {
+        d->stateTimer.start(200);
+    }
+
+    // Determine which backups are enabled, and start only those
+    QStringList backupList;
+    for(auto iter = d->backups.begin(); iter != d->backups.end(); ++iter)
+    {
+        if (iter.value().value("enabled").toBool())
+        {
+            backupList.append(iter.key());
+        }
+    }
+
+    if (!backupList.empty())
+    {
+        startBackup(backupList);
+
+        d->status = "Preparing Backup...";
+        Q_EMIT statusChanged();
+        d->backupBusy = true;
+        Q_EMIT backupBusyChanged();
+    }
+}
+
+QString KeeperClient::getBackupName(QString uuid)
+{
+    return d->backups.value(uuid).value("display-name").toString();
+}
+
+QMap<QString, QVariantMap> KeeperClient::getBackupChoices() const
+{
+    QDBusReply<QMap<QString, QVariantMap>> choices = d->userIface->call("GetBackupChoices");
 
     if (!choices.isValid())
     {
@@ -62,17 +170,61 @@
     return choices.value();
 }
 
-void KeeperClient::StartBackup(const QStringList& uuids) const
-{
-    QDBusReply<void> backup_reply = d_ptr->user_iface->call("StartBackup", uuids);
-
-    if (!backup_reply.isValid())
-    {
-        qWarning() << "Error starting backup:" << backup_reply.error().message();
-    }
-}
-
-QMap<QString, QVariantMap> KeeperClient::GetState() const
-{
-    return d_ptr->user_iface->state();
+void KeeperClient::startBackup(const QStringList& uuids) const
+{
+    QDBusReply<void> backupReply = d->userIface->call("StartBackup", uuids);
+
+    if (!backupReply.isValid())
+    {
+        qWarning() << "Error starting backup:" << backupReply.error().message();
+    }
+}
+
+QMap<QString, QVariantMap> KeeperClient::getState() const
+{
+    return d->userIface->state();
+}
+
+void KeeperClient::stateUpdated()
+{
+    auto states = getState();
+
+    if (!states.empty())
+    {
+        // Calculate current total progress
+        // TODO: May be better to monitor each backup's progress separately instead of total
+        //       to avoid irregular jumps in progress between larger and smaller backups
+        double totalProgress = 0;
+        for (auto const& state : states)
+        {
+            totalProgress += state.value("percent-done").toDouble();
+        }
+
+        d->progress = totalProgress / states.count();
+        Q_EMIT progressChanged();
+
+        // Update backup status
+        if (d->progress > 0 && d->progress < 1)
+        {
+            d->status = "Backup In Progress...";
+            Q_EMIT statusChanged();
+
+            d->backupBusy = true;
+            Q_EMIT backupBusyChanged();
+        }
+        else if (d->progress >= 1)
+        {
+            d->status = "Backup Complete";
+            Q_EMIT statusChanged();
+
+            d->backupBusy = false;
+            Q_EMIT backupBusyChanged();
+
+            // Stop state timer
+            if (d->stateTimer.isActive())
+            {
+                d->stateTimer.stop();
+            }
+        }
+    }
 }

=== added directory 'src/client/qml-plugin'
=== added file 'src/client/qml-plugin/CMakeLists.txt'
--- src/client/qml-plugin/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ src/client/qml-plugin/CMakeLists.txt	2016-08-26 09:36:01 +0000
@@ -0,0 +1,42 @@
+set(
+  QML_KEEPER_CLIENT_LIB
+  keeper-qml
+)
+
+add_definitions(-DKEEPER_MAJOR=${KEEPER_MAJOR})
+add_definitions(-DKEEPER_MINOR=${KEEPER_MINOR})
+
+include(QmlPlugins)
+
+find_package(Qt5Quick REQUIRED)
+
+include_directories(
+  "${CMAKE_SOURCE_DIR}/include/client"
+)
+
+set(KEEPER_QML_SRC
+  plugin.cpp
+)
+
+add_library(
+  ${QML_KEEPER_CLIENT_LIB} SHARED
+  ${KEEPER_QML_SRC}
+)
+
+target_link_libraries(
+  ${QML_KEEPER_CLIENT_LIB}
+  ${KEEPER_CLIENT_LIB}
+)
+
+qt5_use_modules(
+  ${QML_KEEPER_CLIENT_LIB}
+  Qml
+)
+
+add_qmlplugin(
+  Ubuntu.Keeper
+  ${KEEPER_MAJOR}.${KEEPER_MINOR}
+  Ubuntu/Keeper
+  TARGET_PREFIX Keeper
+  TARGETS ${QML_KEEPER_CLIENT_LIB}
+)

=== added file 'src/client/qml-plugin/plugin.cpp'
--- src/client/qml-plugin/plugin.cpp	1970-01-01 00:00:00 +0000
+++ src/client/qml-plugin/plugin.cpp	2016-08-26 09:36:01 +0000
@@ -0,0 +1,37 @@
+/*
+ * Copyright © 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 warranty of
+ * MERCHANTABILITY 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/>.
+ *
+ * Authors:
+ *     Marcus Tomlinson <[e-mail]>
+ */
+
+#include <QtQml>
+#include <QtQml/QQmlContext>
+
+#include <plugin.h>
+
+#include <client.h>
+
+void QmlKeeperPlugin::registerTypes(const char *uri)
+{
+    Q_ASSERT(uri == QLatin1String("Ubuntu.Keeper"));
+
+    qmlRegisterType<KeeperClient>(uri, KEEPER_MAJOR, KEEPER_MINOR, "Keeper");
+}
+
+void QmlKeeperPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
+{
+    QQmlExtensionPlugin::initializeEngine(engine, uri);
+}

=== added file 'src/client/qml-plugin/plugin.h'
--- src/client/qml-plugin/plugin.h	1970-01-01 00:00:00 +0000
+++ src/client/qml-plugin/plugin.h	2016-08-26 09:36:01 +0000
@@ -0,0 +1,33 @@
+/*
+ * Copyright © 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 warranty of
+ * MERCHANTABILITY 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/>.
+ *
+ * Authors:
+ *     Marcus Tomlinson <[e-mail]>
+ */
+
+#pragma once
+
+#include <QtQml/QQmlEngine>
+#include <QtQml/QQmlExtensionPlugin>
+
+class QmlKeeperPlugin : public QQmlExtensionPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
+
+public:
+    void registerTypes(const char *uri) override;
+    void initializeEngine(QQmlEngine *engine, const char *uri) override;
+};

=== added file 'src/client/qml-plugin/qmldir'
--- src/client/qml-plugin/qmldir	1970-01-01 00:00:00 +0000
+++ src/client/qml-plugin/qmldir	2016-08-26 09:36:01 +0000
@@ -0,0 +1,2 @@
+module Ubuntu.Keeper
+plugin keeper-qml