Merge lp:~renatofilho/buteo-syncfw-qml/initial-code into lp:~renatofilho/buteo-syncfw-qml/trunk

[Renato Araujo Oliveira Filho]

Implemented QML bindings for buteo syncfw DBUS service.

Server implementation can be found here: https://github.com/nemomobile/buteo-syncfw

[Michael Sheldon (michael-sheldon)]

Not sure if "gnome" is the best section for the package?

review: Needs Information

[Ken VanDine (ken-vandine)]

I pushed a few packaging fixes to lp:~ken-vandine/buteo-syncfw-qml/packaging_tweaks

review: Needs Fixing

[Ken VanDine (ken-vandine)]

> Not sure if "gnome" is the best section for the package?

Agreed, but those sections aren't really all that useful these days. It seems all the apps with a GUI tend to go in "gnome", not opposed to changing that but also not really concerned.

[Michael Sheldon (michael-sheldon)]

I'm not sure the reinitialization that's done after an owner change will work, see the diff comment for details

review: Needs Fixing

[Michael Sheldon (michael-sheldon)]

Ah, no my mistake; presumably a call to deinitialize() will happen when the original owner is lost, which then calls reset on m_iface, so when the new owner appears it is null again.

[Michael Sheldon (michael-sheldon)]

One small in-line comment added about one of the copyright statements, but otherwise the code for this all looks good to me.

[Michael Sheldon (michael-sheldon)]

Looks good :)

review: Approve

[lp:~renatofilho/buteo-syncfw-qml/initial-code]

2. By Renato Araujo Oliveira Filho on 2015-07-09

Implemented QML bindings for buteo syncfw DBUS service.

=== added directory '.bzr-builddeb'
=== added file '.bzr-builddeb/default.conf'
--- .bzr-builddeb/default.conf	1970-01-01 00:00:00 +0000
+++ .bzr-builddeb/default.conf	2015-07-09 14:03:36 +0000
@@ -0,0 +1,2 @@
+[BUILDDEB]
+split = True
 
=== added directory 'Buteo'
=== added file 'Buteo/CMakeLists.txt'
--- Buteo/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ Buteo/CMakeLists.txt	2015-07-09 14:03:36 +0000
@@ -0,0 +1,39 @@
+set(BUTEO_SYNC_QML_PLUGIN "buteo-syncfw-qml")
+
+set(BUTEO_SYNC_QML_PLUGIN_SRCS
+    buteo-sync-qml.cpp
+    buteo-sync-qml.h
+    plugin.h
+    plugin.cpp
+)
+
+set(BUTEO_SYNC_QML_PLUGIN_FILES
+    qmldir
+)
+
+add_library(${BUTEO_SYNC_QML_PLUGIN} MODULE
+    ${BUTEO_SYNC_QML_PLUGIN_SRCS}
+)
+
+target_link_libraries(${BUTEO_SYNC_QML_PLUGIN}
+    Qt5::Core
+    Qt5::Qml
+    Qt5::DBus
+    Qt5::Xml
+)
+
+#copy qml files to build dir to make it possible to run without install
+add_custom_target(buteo_components_QmlFiles ALL SOURCES ${BUTEO_SYNC_QML_PLUGIN_FILES})
+if(NOT ${CMAKE_CURRENT_BINARY_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR})
+  add_custom_command(TARGET buteo_components_QmlFiles PRE_BUILD
+                     COMMAND ${CMAKE_COMMAND} -E
+                         copy ${CMAKE_CURRENT_SOURCE_DIR}/qmldir ${CMAKE_CURRENT_BINARY_DIR}/)
+endif()
+
+execute_process(
+    COMMAND qmake -query QT_INSTALL_QML
+    OUTPUT_VARIABLE QT_IMPORTS_DIR
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+install(TARGETS ${BUTEO_SYNC_QML_PLUGIN} DESTINATION ${QT_IMPORTS_DIR}/Buteo/)
+install(FILES ${BUTEO_SYNC_QML_PLUGIN_FILES} DESTINATION ${QT_IMPORTS_DIR}/Buteo/)
 
=== added file 'Buteo/buteo-sync-qml.cpp'
--- Buteo/buteo-sync-qml.cpp	1970-01-01 00:00:00 +0000
+++ Buteo/buteo-sync-qml.cpp	2015-07-09 14:03:36 +0000
@@ -0,0 +1,204 @@
+/*
+ * Copyright (C) 2015 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 "buteo-sync-qml.h"
+
+#include <QtCore/QDebug>
+#include <QtDBus/QDBusInterface>
+#include <QtDBus/QDBusReply>
+#include <QtXml/QDomDocument>
+
+#define BUTEO_DBUS_SERVICE_NAME   "com.meego.msyncd"
+#define BUTEO_DBUS_OBJECT_PATH    "/synchronizer"
+#define BUTEO_DBUS_INTERFACE      "com.meego.msyncd"
+
+ButeoSyncFW::ButeoSyncFW(QObject *parent)
+    : QObject(parent)
+{
+}
+
+bool ButeoSyncFW::syncing() const
+{
+    return !(getRunningSyncList().isEmpty());
+}
+
+QStringList ButeoSyncFW::visibleSyncProfiles() const
+{
+    if (m_iface) {
+        QDBusReply<QStringList> result = m_iface->call("allVisibleSyncProfiles");
+        return result.value();
+    }
+    return QStringList();
+}
+
+void ButeoSyncFW::classBegin()
+{
+}
+
+void ButeoSyncFW::componentComplete()
+{
+    m_serviceWatcher.reset(new QDBusServiceWatcher(BUTEO_DBUS_SERVICE_NAME,
+                                                   QDBusConnection::sessionBus(),
+                                                   QDBusServiceWatcher::WatchForOwnerChange,
+                                                   this));
+    connect(m_serviceWatcher.data(), SIGNAL(serviceOwnerChanged(QString,QString,QString)),
+            this, SLOT(serviceOwnerChanged(QString,QString,QString)));
+
+    initialize();
+}
+
+void ButeoSyncFW::initialize()
+{
+    if (!m_iface.isNull()) {
+        return;
+    }
+
+    m_iface.reset(new QDBusInterface(BUTEO_DBUS_SERVICE_NAME,
+                                     BUTEO_DBUS_OBJECT_PATH,
+                                     BUTEO_DBUS_INTERFACE));
+
+    if (!m_iface->isValid()) {
+        m_iface.reset();
+        qWarning() << "Fail to connect with syncfw";
+        return;
+    }
+
+    connect(m_iface.data(),
+            SIGNAL(syncStatus(QString, int, QString, int)),
+            SIGNAL(syncStatus(QString, int, QString, int)), Qt::QueuedConnection);
+    connect(m_iface.data(),
+            SIGNAL(signalProfileChanged(QString, int, QString)),
+            SIGNAL(profileChanged(QString, int, QString)), Qt::QueuedConnection);
+
+    // notify changes on properties
+    emit syncStatus("", 0, "", 0);
+    emit profileChanged("", 0, "");
+}
+
+bool ButeoSyncFW::startSync(const QString &aProfileId) const
+{
+    if (m_iface) {
+        QDBusReply<bool> result = m_iface->call("startSync", aProfileId);
+        return result.value();
+    }
+    return false;
+}
+
+bool ButeoSyncFW::startSyncByCategory(const QString &category) const
+{
+    foreach(const QString &profile, syncProfilesByCategory(category)) {
+        if (!startSync(profile)) {
+            return false;
+        }
+    }
+    return true;
+}
+
+void ButeoSyncFW::abortSync(const QString &aProfileId) const
+{
+    if (m_iface) {
+        m_iface->call("abortSync", aProfileId);
+    }
+}
+
+QStringList ButeoSyncFW::getRunningSyncList() const
+{
+    if (m_iface) {
+        QDBusReply<QStringList> syncList = m_iface->call("runningSyncs");
+        return syncList;
+    }
+    return QStringList();
+}
+
+QStringList ButeoSyncFW::syncProfilesByCategory(const QString &category) const
+{
+    if (m_iface) {
+         QDBusReply<QStringList> profiles = m_iface->call("syncProfilesByKey", "category", category);
+         // extract ids
+         QStringList ids;
+         foreach(const QString &profile, profiles.value()) {
+            QDomDocument doc;
+            QString errorMsg;
+            int errorLine;
+            int errorColumn;
+            if (doc.setContent(profile, &errorMsg, &errorLine, &errorColumn)) {
+               QDomNodeList profileElements = doc.elementsByTagName("profile");
+               if (!profileElements.isEmpty()) {
+                     //check if is enabled
+                     QDomElement e = profileElements.item(0).toElement();
+                     QDomNodeList values = e.elementsByTagName("key");
+                     bool enabled = true;
+                     for(int i = 0; i < values.count(); i++) {
+                         QDomElement v = values.at(i).toElement();
+                         if ((v.attribute("name") == "enabled") &&
+                             (v.attribute("value") == "false")) {
+                             enabled = false;
+                             continue;
+                         }
+                     }
+                     if (!enabled) {
+                         continue;
+                     }
+                     QString profileName = e.attribute("name", "");
+                     if (!profileName.isEmpty()) {
+                        ids << profileName;
+                     } else {
+                         qWarning() << "Profile name is empty in:" << profile;
+                     }
+               } else {
+                   qWarning() << "Profile not found in:" << profile;
+               }
+            } else {
+                qWarning() << "Fail to parse profile:" << profile;
+                qWarning() << "Error:" << errorMsg << errorLine << errorColumn;
+            }
+         }
+         return ids;
+    }
+    return QStringList();
+}
+
+bool ButeoSyncFW::removeProfile(const QString &profileId) const
+{
+    if (m_iface) {
+        QDBusReply<bool> result = m_iface->call("removeProfile", profileId);
+        return result;
+    }
+    return false;
+}
+
+void ButeoSyncFW::serviceOwnerChanged(const QString &name, const QString &oldOwner, const QString &newOwner)
+{
+    Q_UNUSED(oldOwner);
+
+    if (name == BUTEO_DBUS_SERVICE_NAME) {
+        if (!newOwner.isEmpty()) {
+            // service appear
+            initialize();
+        } else if (!m_iface.isNull()) {
+            // lost service
+            deinitialize();
+        }
+    }
+}
+
+void ButeoSyncFW::deinitialize()
+{
+    m_iface.reset();
+    // notify changes on properties
+    emit syncStatus("", 0, "", 0);
+    emit profileChanged("", 0, "");
+}
 
=== added file 'Buteo/buteo-sync-qml.h'
--- Buteo/buteo-sync-qml.h	1970-01-01 00:00:00 +0000
+++ Buteo/buteo-sync-qml.h	2015-07-09 14:03:36 +0000
@@ -0,0 +1,181 @@
+/*
+ * Copyright (C) 2015 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 <QtCore/QObject>
+#include <QtQml/QQmlParserStatus>
+#include <QtDBus/QDBusInterface>
+#include <QtDBus/QDBusServiceWatcher>
+
+class ButeoSyncFW : public QObject, public QQmlParserStatus
+{
+    Q_OBJECT
+    Q_INTERFACES(QQmlParserStatus)
+
+    Q_PROPERTY(bool syncing READ syncing NOTIFY syncStatus)
+    Q_PROPERTY(QStringList visibleSyncProfiles READ visibleSyncProfiles NOTIFY profileChanged)
+
+public:
+    ButeoSyncFW(QObject *parent = 0);
+
+    bool syncing() const;
+    QStringList visibleSyncProfiles() const;
+
+    // QQmlParserStatus
+    void classBegin();
+    void componentComplete();
+
+    //! \brief  Enum to indicate the change type of the Profile Operation
+    enum ProfileChangeType
+    {
+        //! a New Profile has been added
+        ProfileAdded = 0,
+        //! a Existing Profile has been modified
+        ProfileModified,
+        //! Profile has been Removed
+        ProfileRemoved,
+        //! Profile log file Modified.
+        ProfileLogsModified
+    };
+    Q_ENUMS(ProfileChangeType)
+
+    //! \brief  Enum to indicate the change type of the Profile Operation
+    enum SyncStatus
+    {
+        //! Sync request has been queued
+        SyncQueued = 0,
+        //! Sync session has been started
+        SyncStarted,
+        //! Sync session is progressing
+        SyncProgress,
+        //! Sync session has encountered an error
+        SyncError,
+        //! Sync session was successfully completed
+        SyncDone,
+        //! Sync session was aborted
+        SyncAborted
+    };
+    Q_ENUMS(SyncStatus)
+
+signals:
+    /*! \brief Notifies about a change in profile.
+     *
+     * This signal is sent when the profile data is modified or when a profile
+     * is added or deleted in msyncd.
+     * \param aProfileId Id of the changed profile.
+     * \param aChangeType
+     *      0 (ADDITION): Profile was added.
+     *      1 (MODIFICATION): Profile was modified.
+     *      2 (DELETION): Profile was deleted.
+     * \param aChangedProfile changed sync profie as XMl string.
+     *
+     */
+    void profileChanged(QString aProfileId,int aChangeType, QString aChangedProfile);
+
+    /*!
+     * \brief Notifies about a change in synchronization status.
+     *
+     * \param aProfileId Id of the profile used in the sync session whose
+     *  status has changed.
+     * \param aStatus The new status. One of the following:
+     *      0 (QUEUED): Sync request has been queued or was already in the
+     *          queue when sync start was requested.
+     *      1 (STARTED): Sync session has been started.
+     *      2 (PROGRESS): Sync session is progressing.
+     *      3 (ERROR): Sync session has encountered an error and has been stopped,
+     *          or the session could not be started at all.
+     *      4 (DONE): Sync session was successfully completed.
+     *      5 (ABORTED): Sync session was aborted.
+     *  Statuses 3-5 are final, no more status changes will be sent from the
+     *  same sync session.
+     * \param aMessage A message describing the status change in detail. This
+     *  can for example be shown to the user or written to a log
+         * \param aStatusDetails
+     *  When aStatus is ERROR, this parameter contains a specific error code.
+     *  When aStatus is PROGRESS, this parameter contains more details about the progress
+     *  \see SyncCommonDefs::SyncProgressDetails
+     */
+    void syncStatus(QString aProfileId, int aStatus,
+                    QString aMessage, int aStatusDetails);
+
+public slots:
+    /*!
+     * \brief Requests to starts synchronizing using a profile Id
+     *
+     * A status change signal (QUEUED, STARTED or ERROR) will be sent by the
+     * daemon when the request is processed. If there is a sync already in
+     * progress using the same resources that are needed by the given profile,
+     * adds the sync request to a sync queue. Otherwise a sync session is
+     * started immediately.
+     *
+     * \param aProfileId Id of the profile to use in sync.
+     * \return True if a profile with the Id was found. Otherwise
+     *  false and no status change signals will follow from this request.
+     */
+    bool startSync(const QString &aProfileId) const;
+
+    /*!
+     * \brief Requests to starts synchronizing using a profile category
+     *
+     * \param category Category name of the profile.
+     * \return True if a profile with the Id was found. Otherwise
+     *  false and no status change signals will follow from this request.
+     *
+     * \see ButeoSyncFW::startSync
+     */
+    bool startSyncByCategory(const QString &category) const;
+
+    /*!
+     * \brief Stops synchronizing the profile with the given Id.
+     *
+     * If the sync request is still in queue and not yet started, the queue
+     * entry is removed.
+     *
+     * \param aProfileId Id of the profile to stop syncing.
+     */
+    void abortSync(const QString &aProfileId) const;
+
+    /*!
+     * \brief Gets the list of profile names of currently running syncs.
+     *
+     * \return Profile name list.
+     */
+    QStringList getRunningSyncList() const;
+
+    /*! \brief Gets enabled profiles  matching the profile category.
+     *
+     * \param category Category name of the profile.
+     * \return The sync profile ids as string list.
+     */
+    QStringList syncProfilesByCategory(const QString &category) const;
+
+    /*!
+     * \brief This function should be called when sync profile has to be deleted
+     *
+     * \param aProfileId Id of the profile to be deleted.
+     * \return status of the remove operation
+     */
+    bool removeProfile(const QString &profileId) const;
+
+private slots:
+    void serviceOwnerChanged(const QString &name, const QString &oldOwner, const QString &newOwner);
+
+private:
+    QScopedPointer<QDBusInterface> m_iface;
+    QScopedPointer<QDBusServiceWatcher> m_serviceWatcher;
+
+    void initialize();
+    void deinitialize();
+};
 
=== added file 'Buteo/plugin.cpp'
--- Buteo/plugin.cpp	1970-01-01 00:00:00 +0000
+++ Buteo/plugin.cpp	2015-07-09 14:03:36 +0000
@@ -0,0 +1,27 @@
+/*
+ * Copyright (C) 2015 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 "plugin.h"
+#include "buteo-sync-qml.h"
+
+#include <QtQml/qqml.h>
+
+
+void ButeoSyncQmlPlugin::registerTypes(const char *uri)
+{
+    // @uri Buteo.ButeoSync
+    qmlRegisterType<ButeoSyncFW>(uri, 0, 1, "ButeoSync");
+}
 
=== added file 'Buteo/plugin.h'
--- Buteo/plugin.h	1970-01-01 00:00:00 +0000
+++ Buteo/plugin.h	2015-07-09 14:03:36 +0000
@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2015 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 BUTE_SYNC_FW_QML_PLUGIN_H
+#define BUTE_SYNC_FW_QML_PLUGIN_H
+
+#include <QQmlExtensionPlugin>
+
+class ButeoSyncQmlPlugin : public QQmlExtensionPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
+
+public:
+    void registerTypes(const char *uri);
+};
+
+#endif //BUTE_SYNC_FW_QML_PLUGIN_H
 
=== added file 'Buteo/qmldir'
--- Buteo/qmldir	1970-01-01 00:00:00 +0000
+++ Buteo/qmldir	2015-07-09 14:03:36 +0000
@@ -0,0 +1,2 @@
+module Buteo
+plugin buteo-syncfw-qml
 
=== added file 'CMakeLists.txt'
--- CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ CMakeLists.txt	2015-07-09 14:03:36 +0000
@@ -0,0 +1,30 @@
+project(buteo-sync-qml)
+
+cmake_minimum_required(VERSION 2.8.9)
+
+# Find includes in corresponding build directories
+set(CMAKE_INCLUDE_CURRENT_DIR ON)
+
+# Instruct CMake to run moc automatically when needed.
+set(CMAKE_AUTOMOC ON)
+set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -DQT_QML_DEBUG")
+
+# Standard install paths
+include(GNUInstallDirs)
+
+find_package(PkgConfig REQUIRED)
+find_package(Qt5Core REQUIRED)
+find_package(Qt5Qml REQUIRED)
+find_package(Qt5DBus REQUIRED)
+find_package(Qt5Xml REQUIRED)
+
+enable_testing()
+add_subdirectory(Buteo)
+add_subdirectory(tests)
+
+# uninstall target
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake_uninstall.cmake.in"
+               "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake"
+               IMMEDIATE @ONLY)
+add_custom_target(uninstall "${CMAKE_COMMAND}"
+                  -P "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake")
 
=== added file 'cmake_uninstall.cmake.in'
--- cmake_uninstall.cmake.in	1970-01-01 00:00:00 +0000
+++ cmake_uninstall.cmake.in	2015-07-09 14:03:36 +0000
@@ -0,0 +1,21 @@
+IF(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt")
+  MESSAGE(FATAL_ERROR "Cannot find install manifest: \"@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt\"")
+ENDIF(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt")
+
+FILE(READ "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt" files)
+STRING(REGEX REPLACE "\n" ";" files "${files}")
+FOREACH(file ${files})
+  MESSAGE(STATUS "Uninstalling \"$ENV{DESTDIR}${file}\"")
+  IF(EXISTS "$ENV{DESTDIR}${file}")
+    EXEC_PROGRAM(
+      "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\""
+      OUTPUT_VARIABLE rm_out
+      RETURN_VALUE rm_retval
+      )
+    IF(NOT "${rm_retval}" STREQUAL 0)
+      MESSAGE(FATAL_ERROR "Problem when removing \"$ENV{DESTDIR}${file}\"")
+    ENDIF(NOT "${rm_retval}" STREQUAL 0)
+  ELSE(EXISTS "$ENV{DESTDIR}${file}")
+    MESSAGE(STATUS "File \"$ENV{DESTDIR}${file}\" does not exist.")
+  ENDIF(EXISTS "$ENV{DESTDIR}${file}")
+ENDFOREACH(file)
 
=== added directory 'debian'
=== added file 'debian/changelog'
--- debian/changelog	1970-01-01 00:00:00 +0000
+++ debian/changelog	2015-07-09 14:03:36 +0000
@@ -0,0 +1,5 @@
+buteo-syncfw-qml (0.1-0ubuntu1) vivid; urgency=medium
+
+  * New package
+
+ -- Renato Araujo Oliveira Filho <[e-mail]>  Wed, 08 Jul 2015 12:01:34 -0300
 
=== added file 'debian/compat'
--- debian/compat	1970-01-01 00:00:00 +0000
+++ debian/compat	2015-07-09 14:03:36 +0000
@@ -0,0 +1,1 @@
+9
 
=== added file 'debian/control'
--- debian/control	1970-01-01 00:00:00 +0000
+++ debian/control	2015-07-09 14:03:36 +0000
@@ -0,0 +1,34 @@
+Source: buteo-syncfw-qml
+Section: libs
+Priority: optional
+Maintainer: Ubuntu Developers <[e-mail]>
+Build-Depends: cmake,
+               dbus-test-runner,
+               debhelper (>= 9),
+               pkg-config,
+               qml-module-qttest,
+               qtchooser,
+               qt5-default,               
+               qtbase5-dev,
+               qtdeclarative5-dev, 
+Standards-Version: 3.9.5
+Homepage: https://launchpad.net/buteo-syncfw-qml
+# if you don't have have commit access to this branch but would like to upload
+# directly to Ubuntu, don't worry: your changes will be merged back into the
+# upstream branch
+Vcs-Bzr: lp:buteo-syncfw-qml
+X-Ubuntu-Use-Langpack: yes
+
+Package: qtdeclarative5-buteo-syncfw0.1
+Architecture: any
+Multi-Arch: same
+Pre-Depends: ${misc:Pre-Depends}
+Depends: ${misc:Depends},
+         ${shlibs:Depends},
+         buteo-syncfw-qt5,
+Description: Buteo sync framework client - QML bindings
+ buteo-syncfw manages data synchronization
+ .
+ This package contains the QML plugin providing the features from the buteo
+ to applications.
+
 
=== added file 'debian/copyright'
--- debian/copyright	1970-01-01 00:00:00 +0000
+++ debian/copyright	2015-07-09 14:03:36 +0000
@@ -0,0 +1,19 @@
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Source: https://launchpad.net/buteo-syncfw-qml
+Upstream-Name: buteo-syncfw-qml
+
+Files: *
+Copyright: 2015 Canonical Ltd.
+License: GPL-3
+ 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.
+ .
+ On Debian systems, the full text of the GNU General Public
+ License version 3 can be found in the file
+ `/usr/share/common-licenses/GPL-3'.
 
=== added file 'debian/rules'
--- debian/rules	1970-01-01 00:00:00 +0000
+++ debian/rules	2015-07-09 14:03:36 +0000
@@ -0,0 +1,9 @@
+#!/usr/bin/make -f
+# -*- makefile -*-
+export DPKG_GENSYMBOLS_CHECK_LEVEL=4
+
+# Uncomment this to turn on verbose mode.
+#export DH_VERBOSE=1
+
+%:
+	dh $@ --parallel --fail-missing
 
=== added directory 'tests'
=== added file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/CMakeLists.txt	2015-07-09 14:03:36 +0000
@@ -0,0 +1,1 @@
+add_subdirectory(qml)
 
=== added directory 'tests/qml'
=== added file 'tests/qml/CMakeLists.txt'
--- tests/qml/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/qml/CMakeLists.txt	2015-07-09 14:03:36 +0000
@@ -0,0 +1,36 @@
+find_program(QMLTESTRUNNER_BIN
+    NAMES qmltestrunner
+    PATHS /usr/lib/*/qt5/bin
+    NO_DEFAULT_PATH
+)
+
+find_program(DBUS_RUNNER_BIN dbus-test-runner)
+macro(DECLARE_QML_TEST TST_NAME TST_QML_FILE)
+    set(TEST_COMMAND "")
+    add_test(NAME ${TST_NAME}
+        WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+        COMMAND ${DBUS_RUNNER_BIN}
+                --task ${CMAKE_CURRENT_SOURCE_DIR}/buteo-syncfw.py -r -n buteo-syncfw
+                --task ${QMLTESTRUNNER_BIN}
+                    -p -input -p ${CMAKE_CURRENT_SOURCE_DIR}/${TST_QML_FILE}
+                    -p -import -p ${CMAKE_BINARY_DIR}
+                    -p -platform -p offscreen
+                --wait-for=com.meego.msyncd
+                -n ${TST_NAME}
+    )
+endmacro()
+
+if(QMLTESTRUNNER_BIN AND DBUS_RUNNER_BIN)
+    declare_qml_test("buteo_syncfw_component" tst_ButeoSyncFW.qml)
+else()
+    if (NOT QMLTESTRUNNER_BIN)
+        message(WARNING "Qml tests disabled: qmltestrunner not found")
+    else()
+        message(WARNING "Qml tests disabled: dbus-test-runner not found")
+    endif()
+endif()
+
+set(QML_TST_FILES
+    tst_ButeoSyncFW.qml
+)
+add_custom_target(tst_QmlFiles ALL SOURCES ${QML_TST_FILES})
 
=== added file 'tests/qml/buteo-syncfw.py'
--- tests/qml/buteo-syncfw.py	1970-01-01 00:00:00 +0000
+++ tests/qml/buteo-syncfw.py	2015-07-09 14:03:36 +0000
@@ -0,0 +1,163 @@
+#!/usr/bin/python3
+
+'''buteo syncfw mock template
+
+This creates the expected methods and properties of the main
+com.meego.msyncd object. You can specify D-BUS property values
+'''
+
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation; either version 3 of the License, or (at your option) any
+# later version.  See http://www.gnu.org/copyleft/lgpl.html for the full text
+# of the license.
+
+__author__ = 'Renato Araujo Oliveira Filho'
+__email__ = '[e-mail]'
+__copyright__ = '(c) 2015 Canonical Ltd.'
+__license__ = 'LGPL 3+'
+
+import dbus
+from gi.repository import GObject
+
+import dbus
+import dbus.service
+import dbus.mainloop.glib
+
+BUS_NAME = 'com.meego.msyncd'
+MAIN_OBJ = '/synchronizer'
+MAIN_IFACE = 'com.meego.msyncd'
+SYSTEM_BUS = False
+
+class ButeoSyncFw(dbus.service.Object):
+    PROFILES = [
+"""<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<profile type=\"sync\" name=\"test-profile\">
+    <key value=\"45\" name=\"accountid\"/>
+    <key value=\"contacts\" name=\"category\"/>
+    <key value=\"google.Contacts-\" name=\"displayname\"/>
+    <key value=\"true\" name=\"enabled\"/>
+    <key value=\"true\" name=\"hidden\"/>
+    <key value=\"30\" name=\"sync_since_days_past\"/>
+    <key value=\"true\" name=\"use_accounts\"/>
+    <profile type=\"client\" name=\"googlecontacts\">
+        <key value=\"two-way\" name=\"Sync Direction\"/>
+    </profile>
+    <schedule time=\"05:00:00\" days=\"4,5,2,3,1,6,7\" syncconfiguredtime=\"\" interval=\"0\" enabled=\"true\">
+        <rush end=\"\" externalsync=\"false\" days=\"\" interval=\"15\" begin=\"\" enabled=\"false\"/>
+    </schedule>
+</profile>""",
+"""<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<profile type=\"sync\" name=\"testsync-ovi\">
+    <key value=\"calendar\" name=\"category\"/>
+    <schedule syncconfiguredtime=\"\" interval=\"0\" days=\"\" externalsync=\"true\" time=\"\" enabled=\"false\">
+        <rush interval=\"0\" days=\"\" externalsync=\"false\" begin=\"\" enabled=\"false\" end=\"\"/>
+    </schedule>
+</profile>""",
+"""<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<profile name=\"63807467\" type=\"sync\">
+    <key value=\"110\" name=\"accountid\"/>
+    <key value=\"contacts\" name=\"category\"/>
+    <key value=\"online\" name=\"destinationtype\"/>
+    <key value=\"[e-mail]\" name=\"displayname\"/>
+    <key value=\"true\" name=\"enabled\"/>
+    <key value=\"true\" name=\"hidden\"/>
+    <key value=\"false\" name=\"scheduled\"/>
+    <key value=\"true\" name=\"sync_always_up_to_date\"/>
+    <key value=\"true\" name=\"sync_on_change\"/>
+    <key value=\"30\" name=\"sync_since_days_past\"/>
+    <key value=\"true\" name=\"use_accounts\"/>
+    <profile name=\"googlecontacts\" type=\"client\">
+        <key value=\"two-way\" name=\"Sync Direction\"/>
+        <key value=\"gdata\" name=\"Sync Protocol\"/>
+        <key value=\"HTTP\" name=\"Sync Transport\"/>
+        <key value=\"prefer remote\" name=\"conflictpolicy\"/>
+        <key value=\"true\" name=\"sync_on_change\"/>
+    </profile>
+    <schedule syncconfiguredtime=\"\" days=\"5,4,7,6,1,3,2\" interval=\"60\" enabled=\"false\" time=\"\">
+        <rush begin=\"00:00:00\" end=\"00:00:00\" days=\"\" interval=\"60\" enabled=\"false\" externalsync=\"false\"/>
+    </schedule>
+</profile>""",
+"""<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<profile type=\"sync\" name=\"template-profile\">
+    <key value=\"contacts\" name=\"category\"/>
+    <key value=\"false\" name=\"enabled\"/>
+    <schedule syncconfiguredtime=\"\" interval=\"0\" days=\"\" externalsync=\"true\" time=\"\" enabled=\"false\">
+        <rush interval=\"0\" days=\"\" externalsync=\"false\" begin=\"\" enabled=\"false\" end=\"\"/>
+    </schedule>
+</profile>"""
+    ]
+
+    def __init__(self, object_path):
+        dbus.service.Object.__init__(self, dbus.SessionBus(), object_path)
+        self._activeSync = []
+        self._profiles = ButeoSyncFw.PROFILES
+
+    @dbus.service.method(dbus_interface=MAIN_IFACE,
+                         in_signature='', out_signature='as')
+    def allVisibleSyncProfiles(self):
+        return self._profiles
+
+    @dbus.service.method(dbus_interface=MAIN_IFACE,
+                         in_signature='ss', out_signature='as')
+    def syncProfilesByKey(self, key, value):
+        print ("syncProfilesByKey:", key, value)
+        if key == 'category':
+            if value == 'contacts':
+                return [ButeoSyncFw.PROFILES[0], ButeoSyncFw.PROFILES[2], ButeoSyncFw.PROFILES[3]]
+            if value == 'calendar':
+                return [ButeoSyncFw.PROFILES[1]]
+        return []
+
+    @dbus.service.method(dbus_interface=MAIN_IFACE,
+                         in_signature='s', out_signature='')
+    def abortSync(self, profileId):
+        if profileId in self._activeSync:
+            self._activeSync.remove(profileId)
+            self.syncStatus(profileId, 5, 'aborted by the user', 0)
+        return
+
+    @dbus.service.method(dbus_interface=MAIN_IFACE,
+                         in_signature='s', out_signature='b')
+    def startSync(self, profileId):
+        if profileId in ['63807467', 'testsync-ovi', 'test-profile']:
+            self._activeSync.append(profileId)
+            self.syncStatus(profileId, 1, '', 0)
+            return True
+        return False
+
+    @dbus.service.method(dbus_interface=MAIN_IFACE,
+                         in_signature='', out_signature='as')
+    def runningSyncs(self):
+        return self._activeSync
+
+    @dbus.service.signal(dbus_interface=MAIN_IFACE,
+                         signature='sisi')
+    def syncStatus(self, profileId, status, message, statusDetails):
+        print("SyncStatus called")
+
+    @dbus.service.signal(dbus_interface=MAIN_IFACE,
+                         signature='sis')
+    def signalProfileChanged(self, profileId, status, changedProfile):
+        print("profileChanged called")
+
+    @dbus.service.method(dbus_interface=MAIN_IFACE,
+                         in_signature='s', out_signature='b')
+    def removeProfile(self, profileId):
+        if int(profileId) < len(self._profiles):
+            self._profiles.remove(self._profiles[int(profileId)])
+            self.signalProfileChanged(profileId, 2, 'deleted')
+            return True
+        else:
+            return False
+
+
+
+if __name__ == '__main__':
+    dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
+
+    name = dbus.service.BusName(BUS_NAME)
+    mainloop = GObject.MainLoop()
+    buteo = ButeoSyncFw(MAIN_OBJ)
+    mainloop.run()
+
 
=== added file 'tests/qml/tst_ButeoSyncFW.qml'
--- tests/qml/tst_ButeoSyncFW.qml	1970-01-01 00:00:00 +0000
+++ tests/qml/tst_ButeoSyncFW.qml	2015-07-09 14:03:36 +0000
@@ -0,0 +1,174 @@
+/*
+ * Copyright (C) 2015 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/>.
+ */
+
+import QtQuick 2.2
+import Buteo 0.1
+import QtTest 1.0
+
+Item {
+    id: root
+
+    property var buteoComponent
+
+    TestCase {
+        id: vcardParser
+        name: 'ButeoSyncFWTestCase'
+
+        function init()
+        {
+            buteoComponent = Qt.createQmlObject('import Buteo 0.1; ButeoSync{ }', root);
+        }
+
+        function cleanup()
+        {
+            if (buteoComponent) {
+                var activeProfiles = buteoComponent.getRunningSyncList()
+                for (var i in activeProfiles) {
+                    buteoComponent.abortSync(activeProfiles[i])
+                }
+                activeProfiles = buteoComponent.getRunningSyncList()
+                compare(activeProfiles.length, 0)
+
+                buteoComponent.destroy()
+                buteoComponent = null
+            }
+        }
+
+        function test_start_sync()
+        {
+            var spy = Qt.createQmlObject('import QtTest 1.0; SignalSpy{ }', root);
+            spy.target = buteoComponent
+            spy.signalName = "syncStatus"
+
+            compare(buteoComponent.startSync('1234'), false)
+            compare(buteoComponent.startSync('63807467'), true)
+
+            tryCompare(spy, "count", 1)
+            compare(spy.signalArguments[0][0], '63807467')
+            compare(spy.signalArguments[0][1], ButeoSync.SyncStarted)
+            compare(spy.signalArguments[0][2], '')
+        }
+
+        function test_abort_sync()
+        {
+            var spy = Qt.createQmlObject('import QtTest 1.0; SignalSpy{ }', root);
+            spy.target = buteoComponent
+            spy.signalName = "syncStatus"
+
+            compare(buteoComponent.startSync('63807467'), true)
+            tryCompare(spy, "count", 1)
+
+            var spy2 = Qt.createQmlObject('import QtTest 1.0; SignalSpy{ }', root);
+            spy2.target = buteoComponent
+            spy2.signalName = "syncStatus"
+
+            buteoComponent.abortSync('63807467')
+
+            tryCompare(spy2, "count", 1)
+            compare(spy2.signalArguments[0][0], '63807467')
+            compare(spy2.signalArguments[0][1], ButeoSync.SyncAborted)
+            compare(spy2.signalArguments[0][2], 'aborted by the user')
+        }
+
+        function test_syncing_property()
+        {
+            // check if no sync is running
+            compare(buteoComponent.syncing, false)
+
+            // start a new sync and check if the property changed to true
+            buteoComponent.startSync('63807467')
+            tryCompare(buteoComponent, 'syncing', true)
+
+            // abort current sync and check if sync property changed to false
+            buteoComponent.abortSync('63807467')
+            tryCompare(buteoComponent, 'syncing', false)
+        }
+
+        function test_visibleSyncProfiles_property()
+        {
+            compare(buteoComponent.visibleSyncProfiles.length, 4)
+            var spy = Qt.createQmlObject('import QtTest 1.0; SignalSpy{ }', root);
+            spy.target = buteoComponent
+            spy.signalName = "profileChanged"
+
+            buteoComponent.removeProfile('3')
+            tryCompare(spy, "count", 1)
+            compare(spy.signalArguments[0][0], '3')
+            compare(spy.signalArguments[0][1], ButeoSync.ProfileRemoved)
+            compare(spy.signalArguments[0][2], 'deleted')
+            compare(buteoComponent.visibleSyncProfiles.length, 3)
+            spy.clear()
+
+            buteoComponent.removeProfile('2')
+            tryCompare(spy, "count", 1)
+            compare(spy.signalArguments[0][0], '2')
+            compare(spy.signalArguments[0][1], ButeoSync.ProfileRemoved)
+            compare(spy.signalArguments[0][2], 'deleted')
+            compare(buteoComponent.visibleSyncProfiles.length, 2)
+            spy.clear()
+
+            buteoComponent.removeProfile('1')
+            tryCompare(spy, "count", 1)
+            compare(spy.signalArguments[0][0], '1')
+            compare(spy.signalArguments[0][1], ButeoSync.ProfileRemoved)
+            compare(spy.signalArguments[0][2], 'deleted')
+            compare(buteoComponent.visibleSyncProfiles.length, 1)
+            spy.clear()
+
+            buteoComponent.removeProfile('0')
+            tryCompare(spy, "count", 1)
+            compare(spy.signalArguments[0][0], '0')
+            compare(spy.signalArguments[0][1], ButeoSync.ProfileRemoved)
+            compare(spy.signalArguments[0][2], 'deleted')
+            compare(buteoComponent.visibleSyncProfiles.length, 0)
+            spy.clear()
+        }
+
+        function test_sync_by_profile_by_category()
+        {
+            var profiles = buteoComponent.syncProfilesByCategory('contacts')
+            compare(profiles.length, 2)
+            compare(profiles[0], 'test-profile')
+            compare(profiles[1], '63807467')
+        }
+
+        function test_sync_by_category()
+        {
+            var spy = Qt.createQmlObject('import QtTest 1.0; SignalSpy{ }', root);
+            spy.target = buteoComponent
+            spy.signalName = "syncStatus"
+
+            compare(buteoComponent.startSyncByCategory('contacts'), true)
+
+            // wait for two signals (since we have two contacts profiles)
+            tryCompare(spy, "count", 2)
+            // first profile
+            compare(spy.signalArguments[0][0], 'test-profile')
+            compare(spy.signalArguments[0][1], ButeoSync.SyncStarted)
+            compare(spy.signalArguments[0][2], '')
+
+            // secound profile
+            compare(spy.signalArguments[1][0], '63807467')
+            compare(spy.signalArguments[1][1], ButeoSync.SyncStarted)
+            compare(spy.signalArguments[1][2], '')
+
+            var activeProfiles = buteoComponent.getRunningSyncList()
+            compare(activeProfiles.length, 2)
+            compare(activeProfiles[0], 'test-profile')
+            compare(activeProfiles[1], '63807467')
+        }
+    }
+}