Merge lp:~nik90/ubuntu-clock-app/add-utility-backend into lp:ubuntu-clock-app

[Nekhelesh Ramananthan]

Added a clock utility c++ plugin housing customalarmsound type which is needed for the upcoming custom alarm sound feature.

Added a c++ backend plugin for
a) deleting files
b) returning the QStandardPath /home/phablet/.local/share/com.ubuntu.clock

This is necessary for the upcoming custom-alarm-sound feature implementation which requires the above mentioned functionalities.

[lp:~nik90/ubuntu-clock-app/add-utility-backend]

343. By Nekhelesh Ramananthan on 2015-08-19

removed clock utility import

344. By Nekhelesh Ramananthan on 2015-08-19

Fixed copyright year in backend.h

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:342
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/767/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-vivid-amd64-ci/112/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/767/rebuild

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:344
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/768/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-vivid-amd64-ci/113/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/768/rebuild

review: Needs Fixing (continuous-integration)

[lp:~nik90/ubuntu-clock-app/add-utility-backend]

345. By Nekhelesh Ramananthan on 2015-08-19

Remove qCritical statement

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

PASSED: Continuous integration, rev:345
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/769/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-vivid-amd64-ci/114

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/769/rebuild

review: Approve (continuous-integration)

[Bartosz Kosiorek (gang65)]

some inline comments.

review: Needs Information

[lp:~nik90/ubuntu-clock-app/add-utility-backend]

346. By Nekhelesh Ramananthan on 2015-08-20

Merged standardpath and filemanagement into customalarmsound

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

PASSED: Continuous integration, rev:346
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/778/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-vivid-amd64-ci/123

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/778/rebuild

review: Approve (continuous-integration)

[lp:~nik90/ubuntu-clock-app/add-utility-backend]

347. By Nekhelesh Ramananthan on 2015-08-20

Updated debian changelog

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

PASSED: Continuous integration, rev:347
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/780/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-vivid-amd64-ci/125

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/780/rebuild

review: Approve (continuous-integration)

[lp:~nik90/ubuntu-clock-app/add-utility-backend]

348. By Nekhelesh Ramananthan on 2015-08-20

Removed Quick and GUI module loading for clock utility

349. By Nekhelesh Ramananthan on 2015-08-20

Merged lp:ubuntu-clock-app

[Bartosz Kosiorek (gang65)]

* Does the MP add/remove user visible strings? If Yes, has the pot file been
    updated?

No strings changed.

* Does the MP change the UI? If Yes, has it been approved by design?

No UX change

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

Extensive testing done on desktop and phone

* If the MP fixes a bug or implements a feature, are there accompanying unit
    and autopilot tests?

Not required

* Is the clock app trunk buildable and runnable using Qtcreator?

Yes
* Was the debian changelog updated?

Yes

* Was the copyright years updated if necessary?

Yes

review: Approve

=== modified file 'backend/CMakeLists.txt'
--- backend/CMakeLists.txt	2015-08-18 05:03:59 +0000
+++ backend/CMakeLists.txt	2015-08-20 21:15:16 +0000
@@ -35,6 +35,12 @@
 )
 
 set(
+    clockutility_SRCS
+    modules/Clock/Utility/backend.cpp
+    modules/Clock/Utility/customalarmsound.cpp
+)
+
+set(
     stopwatchlaphistory_SRCS
     modules/Stopwatch/LapHistory/backend.cpp
     modules/Stopwatch/LapHistory/history.cpp
@@ -56,11 +62,14 @@
     ${geolocation_SRCS}
 )
 
+add_library(clockutility MODULE
+    ${clockutility_SRCS}
+)
+
 add_library(stopwatchlaphistory MODULE
     ${stopwatchlaphistory_SRCS}
 )
 
-
 set_target_properties(timezone PROPERTIES
     LIBRARY_OUTPUT_DIRECTORY Timezone
 )
@@ -77,6 +86,10 @@
     LIBRARY_OUTPUT_DIRECTORY GeoLocation
 )
 
+set_target_properties(clockutility PROPERTIES
+    LIBRARY_OUTPUT_DIRECTORY Clock/Utility
+)
+
 set_target_properties(stopwatchlaphistory PROPERTIES
     LIBRARY_OUTPUT_DIRECTORY Stopwatch/LapHistory
 )
@@ -85,6 +98,7 @@
 qt5_use_modules(timezone Gui Qml Quick)
 qt5_use_modules(alarmsettings Gui Qml Quick DBus)
 qt5_use_modules(geolocation Gui Qml Quick)
+qt5_use_modules(clockutility Qml)
 qt5_use_modules(stopwatchlaphistory Qml)
 
 # Copy qmldir file to build dir for running in QtCreator
@@ -108,12 +122,16 @@
     DEPENDS ${QMLFILES}
 )
 
+add_custom_target(clockutility-qmldir ALL
+    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/modules/Clock/Utility/qmldir ${CMAKE_CURRENT_BINARY_DIR}/Clock/Utility
+    DEPENDS ${QMLFILES}
+)
+
 add_custom_target(stopwatchlaphistory-qmldir ALL
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/modules/Stopwatch/LapHistory/qmldir ${CMAKE_CURRENT_BINARY_DIR}/Stopwatch/LapHistory
     DEPENDS ${QMLFILES}
 )
 
-
 # Install plugin file
 install(TARGETS timezone DESTINATION ${MODULE_PATH}/Timezone/)
 install(FILES   modules/Timezone/qmldir DESTINATION ${MODULE_PATH}/Timezone/)
@@ -127,5 +145,9 @@
 install(TARGETS geolocation DESTINATION ${MODULE_PATH}/GeoLocation/)
 install(FILES   modules/GeoLocation/qmldir DESTINATION ${MODULE_PATH}/GeoLocation/)
 
+install(TARGETS clockutility DESTINATION ${MODULE_PATH}/Clock/Utility/)
+install(FILES   modules/Clock/Utility/qmldir DESTINATION ${MODULE_PATH}/Clock/Utility/)
+
 install(TARGETS stopwatchlaphistory DESTINATION ${MODULE_PATH}/Stopwatch/LapHistory/)
 install(FILES   modules/Stopwatch/LapHistory/qmldir DESTINATION ${MODULE_PATH}/Stopwatch/LapHistory/)
+

=== added directory 'backend/modules/Clock'
=== added directory 'backend/modules/Clock/Utility'
=== added file 'backend/modules/Clock/Utility/backend.cpp'
--- backend/modules/Clock/Utility/backend.cpp	1970-01-01 00:00:00 +0000
+++ backend/modules/Clock/Utility/backend.cpp	2015-08-20 21:15:16 +0000
@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2015 Canonical Ltd
+ *
+ * This file is part of Ubuntu Clock App
+ *
+ * Ubuntu Clock App 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.
+ *
+ * Ubuntu Clock App 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 <QtQml>
+#include <QtQml/QQmlContext>
+#include "backend.h"
+#include "customalarmsound.h"
+
+void BackendPlugin::registerTypes(const char *uri)
+{
+    Q_ASSERT(uri == QLatin1String("Clock.Utility"));
+
+    qmlRegisterType<CustomAlarmSound>(uri, 1, 0, "CustomAlarmSound");
+}
+
+void BackendPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
+{
+    QQmlExtensionPlugin::initializeEngine(engine, uri);
+}

=== added file 'backend/modules/Clock/Utility/backend.h'
--- backend/modules/Clock/Utility/backend.h	1970-01-01 00:00:00 +0000
+++ backend/modules/Clock/Utility/backend.h	2015-08-20 21:15:16 +0000
@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2015 Canonical Ltd
+ *
+ * This file is part of Ubuntu Clock App
+ *
+ * Ubuntu Clock App 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.
+ *
+ * Ubuntu Clock App 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 BACKEND_PLUGIN_H
+#define BACKEND_PLUGIN_H
+
+#include <QtQml/QQmlEngine>
+#include <QtQml/QQmlExtensionPlugin>
+
+class BackendPlugin : public QQmlExtensionPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
+
+public:
+    void registerTypes(const char *uri);
+    void initializeEngine(QQmlEngine *engine, const char *uri);
+};
+#endif // BACKEND_PLUGIN_H
+

=== added file 'backend/modules/Clock/Utility/customalarmsound.cpp'
--- backend/modules/Clock/Utility/customalarmsound.cpp	1970-01-01 00:00:00 +0000
+++ backend/modules/Clock/Utility/customalarmsound.cpp	2015-08-20 21:15:16 +0000
@@ -0,0 +1,39 @@
+/*
+ * Copyright (C) 2015 Canonical Ltd
+ *
+ * This file is part of Ubuntu Clock App
+ *
+ * Ubuntu Clock App 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.
+ *
+ * Ubuntu Clock App 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 <QDir>
+#include <QStandardPaths>
+
+#include "customalarmsound.h"
+
+CustomAlarmSound::CustomAlarmSound(QObject *parent):
+    QObject(parent),
+    m_customAlarmDir(QStandardPaths::standardLocations(QStandardPaths::AppDataLocation).first())
+{
+}
+
+QString CustomAlarmSound::alarmSoundDirectory() const
+{
+    return m_customAlarmDir;
+}
+
+void CustomAlarmSound::deleteAlarmSound(const QString &soundName)
+{
+    QDir dir(m_customAlarmDir);
+    dir.remove(soundName);
+}

=== added file 'backend/modules/Clock/Utility/customalarmsound.h'
--- backend/modules/Clock/Utility/customalarmsound.h	1970-01-01 00:00:00 +0000
+++ backend/modules/Clock/Utility/customalarmsound.h	2015-08-20 21:15:16 +0000
@@ -0,0 +1,46 @@
+/*
+ * Copyright (C) 2015 Canonical Ltd
+ *
+ * This file is part of Ubuntu Clock App
+ *
+ * Ubuntu Clock App 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.
+ *
+ * Ubuntu Clock App 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 CUSTOMALARMSOUND_H
+#define CUSTOMALARMSOUND_H
+
+#include <QObject>
+
+class CustomAlarmSound: public QObject
+{
+    Q_OBJECT
+
+    // READONLY Property to return the custom alarm sound directory path
+    Q_PROPERTY( QString alarmSoundDirectory
+                READ alarmSoundDirectory)
+
+public:
+    CustomAlarmSound(QObject *parent = 0);
+
+    // Function to return the custom alarm sound directory path
+    QString alarmSoundDirectory() const;
+
+public slots:
+    // Function to delete a custom alarm sound
+    void deleteAlarmSound(const QString &soundName);
+
+private:
+    QString m_customAlarmDir;
+};
+
+#endif

=== added file 'backend/modules/Clock/Utility/qmldir'
--- backend/modules/Clock/Utility/qmldir	1970-01-01 00:00:00 +0000
+++ backend/modules/Clock/Utility/qmldir	2015-08-20 21:15:16 +0000
@@ -0,0 +1,2 @@
+module Clock.Utility
+plugin clockutility

=== modified file 'debian/changelog'
--- debian/changelog	2015-08-20 20:37:03 +0000
+++ debian/changelog	2015-08-20 21:15:16 +0000
@@ -16,6 +16,8 @@
   * Added README.mergeproposal checklist to help with the review process.
   * Fix alarm interval information being inconsistent (LP: #1466000)
   * Changed default alarm sound (LP: #1354370)
+  * Added Clock Utility C++ plugin housing CustomAlarmSound type required
+    for custom alarm sound feature
 
   [Victor Thompson]
   * Show all README files in QtCreator