Merge lp:~nik90/ubuntu-clock-app/implement-location-finding into lp:ubuntu-clock-app

[Nekhelesh Ramananthan]

Adds user location finding to the clock app.

Adds user location finding to the clock app.

==== Testing ====

This MP requires extensive testing for different scenarios that I have listed below. Please comment below if any of the scenarios don't work as expected. I will be adding these scenarios to the manual test suite to ensure we don't regress with a new clock release.

### Prerequisites

I tested this on Mako RTM Stable Image #5. I expect it to work reliably with #5 and higher. Please execute the following commands before *each* case for a fresh clean testing environment.

- Clean up the ubuntu location service and clock app files (for a fresh start) by,
"stop ubuntu-location-service-trust-stored"
"rm -r .local/share/UbuntuLocationService"
"rm -r .local/share/com.ubuntu.clock"
"start ubuntu-location-service-trust-stored"

### Case 1: User opens clock app for the first time (previous location unknown and location service enabled)

- Once you open the clock app, you should be prompted the first time for allowing clock app to access GPS. Press "Allow" here. That's the sign it is working.

- The clock app should show "Retrieving Location". After GPS coordinates are obtained (should take few seconds at most), it should show your city or country.

- Restart the clock app. It should show you the last saved city immediately and not "Retrieving location" again.

### Case 2: User opens clock app for the first time (previous location unknown and location services denied)

- Once you open the clock app, in the location service trust store prompt, press "Deny"!.

- The clock app should now show "Location Service Error" to indicate that it cannot access the location service.

- Restart the clock app and it should still read "Location Service Error".

### Case 3: User opens clock app as usual (not first-time)

- Open the clock app and it should prompt as usual for access to GPS. Press "Allow". The user location should then be shown within a few seconds.

- Close clock app

- Run "sudo stop ubuntu-location-service"

- Reopen clock app. It should show previous saved location and *not* "Location Service Error!".

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

FAILED: Continuous integration, rev:65
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/246/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/97
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/97/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-utopic-amd64-ci/246

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/246/rebuild

review: Needs Fixing (continuous-integration)

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

PASSED: Continuous integration, rev:66
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/247/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/98
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/98/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-utopic-amd64-ci/247

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/247/rebuild

review: Approve (continuous-integration)

[Alan Pope 🍺🐧🐱 🦄 (popey)]

#blocked on bug 1359866

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

PASSED: Continuous integration, rev:68
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/410/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/128
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/128/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/57

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

review: Approve (continuous-integration)

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

FAILED: Continuous integration, rev:69
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/413/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/131/console
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/60

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:73
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/414/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/132/console
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/132/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/61

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

review: Needs Fixing (continuous-integration)

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

PASSED: Continuous integration, rev:80
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/484/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/450
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/450/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/131

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

review: Approve (continuous-integration)

[lp:~nik90/ubuntu-clock-app/implement-location-finding]

81. By Nekhelesh Ramananthan on 2014-09-21

Added some comments

82. By Nekhelesh Ramananthan on 2014-09-21

Added more comments and cleaned lat and long calculation

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

PASSED: Continuous integration, rev:82
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/485/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/451
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/451/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/132

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

review: Approve (continuous-integration)

[Alan Pope 🍺🐧🐱 🦄 (popey)]

As bug 1359866 is now fixed, is this unblocked?

[Nekhelesh Ramananthan (nik90)]

#unblocked This was part of the 3 MPs that I requested you to test since they are ready code wise.

[Nekhelesh Ramananthan (nik90)]

#blocked I believe this MP requires silo-001 [1] (ubuntu-rtm) to land in rtm stable otherwise I wouldn't be able to release a new clock app. Unfortunately the person (thomas voss) who requested silo-001 is on vacation.

I did request QA to go ahead and test the silo considering that it is already in utopic, however I was told that due to a regression in the past, QA doesn't test silos which haven't been tested by the lander first.

I will keep updating this MP as I get more details.

 dbus-cpp 4.0.0+14.10.20140917~rtm-0ubuntu1
 location-service 2.1+14.10.20140917.1~rtm-0ubuntu1

[1] https://launchpad.net/~ci-train-ppa-service/+archive/ubuntu-rtm/landing-001

review: Needs Fixing

[Alan Pope 🍺🐧🐱 🦄 (popey)]

I gather this is still un-testable due to the location stuff not being complete and landed?

[Nekhelesh Ramananthan (nik90)]

> I gather this is still un-testable due to the location stuff not being
> complete and landed?

Yes, from what I know, the HERE location service is not reliably started on phone reboots, and also the HERE location fixes differ between RTM and Utopic images leading to different testing results. As such, I first would like the HERE service to be available on the different channels reliably before proceeding to fix this MP.

I say wait 1-2 weeks for HERE service to be reliable, after which I am going to postpone this to post-rtm since I am not comfortable landing a big MP this late in the development cycle.

[lp:~nik90/ubuntu-clock-app/implement-location-finding]

83. By Nekhelesh Ramananthan on 2014-10-28

Merged trunk

[Nekhelesh Ramananthan (nik90)]

I tested this on RTM Stable #5 Mako and it worked for all the use cases mentioned above in the MP description. I am a bit nervous about pushing this feature this late in the cycle. I would like some additional people like popey, davmor, and any others that come to mind to test this before we merge to trunk.

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

FAILED: Continuous integration, rev:83
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/571/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/1339/console

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

review: Needs Fixing (continuous-integration)

[Nekhelesh Ramananthan (nik90)]

#unblocked

[lp:~nik90/ubuntu-clock-app/implement-location-finding]

84. By Nekhelesh Ramananthan on 2014-10-28

Fixed qml tests

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

FAILED: Continuous integration, rev:84
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/572/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/1345/console

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

review: Needs Fixing (continuous-integration)

[lp:~nik90/ubuntu-clock-app/implement-location-finding]

85. By Nekhelesh Ramananthan on 2014-10-28

Added missing dependency which caused qml test to fail

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

PASSED: Continuous integration, rev:85
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/573/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/1353
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/1353/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[lp:~nik90/ubuntu-clock-app/implement-location-finding]

86. By Nekhelesh Ramananthan on 2014-10-31

Added comments

87. By Nekhelesh Ramananthan on 2014-10-31

Updated pot file

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

PASSED: Continuous integration, rev:87
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/574/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/1406
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/1406/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[Mihir Soni (mihirsoni)]

I have tested this and it works fine on the first glance,
I'll test more and will update here.

[lp:~nik90/ubuntu-clock-app/implement-location-finding]

88. By Nekhelesh Ramananthan on 2014-11-04

Renamed backend location plugin to geolocation

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

PASSED: Continuous integration, rev:88
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/578/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/1446
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/1446/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[Riccardo Padovani (rpadovani)]

On rtm #6 the app doesn't start, it is stucked on the splash screen, both with gps activated or deasctivated.

Also, it doesn't create a log, so unfortunately I cannot understand what's wrong. I created the click package twice, so I don't think is my failure.

Anyway, I left a inline comment about a doubt on the code.

review: Needs Information

[Riccardo Padovani (rpadovani)]

If I launch it from QTC (instead of creating a clic package) works.

Tests work as expected, but if I launch the app with position deactivate from the indicator it says "Location Service Error" as expected, but when I turn on position service from indicator the app doesn't try to update location, but stays stucked on "Location Service Error"

[Nekhelesh Ramananthan (nik90)]

> If I launch it from QTC (instead of creating a click package) works.
>
> Tests work as expected, but if I launch the app with position deactivate from
> the indicator it says "Location Service Error" as expected, but when I turn on
> position service from indicator the app doesn't try to update location, but
> stays stucked on "Location Service Error"

Yeah that's because the clock app you will need to restart the app to update the location. Currently the location is updated only on 2 conditions,

1. On application startup
2. If the clock app is brought to the foreground 30 mins later

It does not continuously keep searching for the user location since that would be bad for the battery. So in your situation where you disabled the position service and then renabled it, the clock app does not get a signal that you turned it on. So you will need to restart the clock app.

A better way of fixing your situation would be to add a refresh button which the user can press to search for the location, but we are way past UI freezes to get this done.

[Nekhelesh Ramananthan (nik90)]

63 + Stop querying for the user location if it is found to be
64 + the same as the one stored in the app setting database
65 + */
66 + if (userLongitude === userLocationDocument.contents.long ||
67 + userLatitude === userLocationDocument.contents.lat) {

>Riccardo Padovani (rpadovani) wrote 1 hour ago:
>I don't understand that if. Why you use OR and not an AND? If a user takes a plane in Rome, and >lands in Barcellona, the lat is the same, so the position isn'update?

No no that's not what this if loop is for. It is basically there to ensure that no invalid long or lat is supplied the clock app. Normally when the application is started up, the lat and long returned is usually garbage values. So this if loop checks the validity of the coordinates.

So if *either* lat or long is invalid, then it returns. Only if both of them are valid, does it continue to search for the user's location.

Hope this answers your question.

[Riccardo Padovani (rpadovani)]

Yap, thanks Nik, now is definitely better :-)

Great work!

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-09-27 10:36:56 +0000
+++ CMakeLists.txt	2014-11-04 15:58:17 +0000
@@ -111,9 +111,9 @@
 
 add_custom_target("autopilot" chmod +x ${CMAKE_SOURCE_DIR}/tests/autopilot/run
                     COMMAND ${CMAKE_SOURCE_DIR}/tests/autopilot/run
-                    DEPENDS timezone timezone-qmldir alarmsettings alarmsettings-qmldir datetime datetime-qmldir
+                    DEPENDS timezone timezone-qmldir alarmsettings alarmsettings-qmldir datetime datetime-qmldir geolocation geolocation-qmldir
                     WORKING_DIRECTORY ./app)
 
 add_custom_target("run" /usr/bin/qmlscene -I ${CMAKE_BINARY_DIR}/backend  ${CMAKE_SOURCE_DIR}/app/ubuntu-clock-app.qml
-                    DEPENDS timezone timezone-qmldir alarmsettings alarmsettings-qmldir datetime datetime-qmldir
+                    DEPENDS timezone timezone-qmldir alarmsettings alarmsettings-qmldir datetime datetime-qmldir geolocation geolocation-qmldir
                     WORKING_DIRECTORY ./app)

=== modified file 'app/clock/ClockPage.qml'
--- app/clock/ClockPage.qml	2014-10-10 19:58:49 +0000
+++ app/clock/ClockPage.qml	2014-11-04 15:58:17 +0000
@@ -17,7 +17,10 @@
  */
 
 import QtQuick 2.3
+import U1db 1.0 as U1db
+import QtPositioning 5.2
 import Ubuntu.Components 1.1
+import GeoLocation 1.0
 import "../alarm"
 import "../components"
 import "../upstreamcomponents"
@@ -47,6 +50,110 @@
         id: alarmUtils
     }
 
+    PositionSource {
+        id: geoposition
+
+        // Property to store the time of the last GPS location update
+        property var lastUpdate
+
+        readonly property real userLongitude: position.coordinate.longitude
+
+        readonly property real userLatitude: position.coordinate.latitude
+
+        active: true
+        updateInterval: 1000
+
+        onSourceErrorChanged: {
+            // Stop querying user location if location service is not available
+            if (sourceError !== PositionSource.NoError) {
+                console.log("[Source Error]: Location Service Error")
+                geoposition.stop()
+            }
+        }
+
+        onPositionChanged: {
+            // Do not accept an invalid user location
+            if(!position.longitudeValid || !position.latitudeValid) {
+                return
+            }
+
+            /*
+             Stop querying for the user location if it is found to be
+             the same as the one stored in the app setting database
+            */
+            if (userLongitude === userLocationDocument.contents.long ||
+                    userLatitude === userLocationDocument.contents.lat) {
+                if (geoposition.active) {
+                    console.log("[LOG]: Stopping geolocation update service")
+                    geoposition.stop()
+                }
+                return
+            }
+
+            else {
+                // Retrieve user location online after receiving the user's lat and lng.
+                userLocation.setSource(position.coordinate.latitude, position.coordinate.longitude)
+            }
+        }
+    }
+
+    Connections {
+        target: clockApp
+        onApplicationStateChanged: {
+            /*
+             If Clock App is brought from background after more than 30 mins,
+             query the user location to ensure it is up to date.
+            */
+            if(applicationState
+                    && Math.abs(clock.analogTime - geoposition.lastUpdate) > 1800000) {
+                if(!geoposition.active)
+                    geoposition.start()
+            }
+
+            else if (!applicationState) {
+                geoposition.lastUpdate = clock.analogTime
+            }
+        }
+    }
+
+    GeoLocation {
+        id: userLocation
+
+        function setSource(lat, lng) {
+            var url = String("%1%2%3%4%5")
+            .arg("http://api.geonames.org/findNearbyPlaceNameJSON?lat=")
+            .arg(lat)
+            .arg("&lng=")
+            .arg(lng)
+            .arg("&username=krnekhelesh&style=full")
+
+            console.log("[LOG]: Searching online for user location at " + url)
+
+            userLocation.source =  url;
+        }
+
+        onLocationChanged: {
+            var locationData = JSON.parse
+                    (JSON.stringify(userLocationDocument.contents))
+
+            locationData.lat = geoposition.userLatitude
+            locationData.long = geoposition.userLongitude
+            locationData.location = userLocation.location
+
+            userLocationDocument.contents = locationData
+
+            /*
+             Stop querying the user coordinates once the user location has been
+             determined and saved to disk
+           */
+            if(geoposition.active) {
+                console.log("[LOG]: Stopping geolocation update service")
+                geoposition.stop()
+            }
+
+        }
+    }
+
     Flickable {
         id: _flickable
 
@@ -100,6 +207,10 @@
             id: clock
             objectName: "clock"
 
+            Component.onCompleted: {
+                geoposition.lastUpdate = analogTime
+            }
+
             analogTime: clockTime
 
             anchors {
@@ -130,9 +241,6 @@
             opacity: settingsIcon.opacity
             spacing: units.gu(1)
 
-            // TODO: Remove this once user location finding is implemented
-            visible: false
-
             anchors {
                 top: date.bottom
                 topMargin: units.gu(1)
@@ -149,10 +257,24 @@
             Label {
                 id: location
                 objectName: "location"
-                text: i18n.tr("Location")
+
                 fontSize: "medium"
                 anchors.verticalCenter: locationIcon.verticalCenter
                 color: UbuntuColors.midAubergine
+
+                text: {
+                    if (userLocationDocument.contents.location === "Null") {
+                        if(geoposition.sourceError !== PositionSource.NoError) {
+                            return i18n.tr("Location Service Error!")
+                        } else {
+                            return i18n.tr("Retrieving location...")
+                        }
+                    }
+
+                    else {
+                        return userLocationDocument.contents.location
+                    }
+                }
             }
         }
 

=== modified file 'app/ubuntu-clock-app.qml'
--- app/ubuntu-clock-app.qml	2014-10-11 17:53:39 +0000
+++ app/ubuntu-clock-app.qml	2014-11-04 15:58:17 +0000
@@ -71,6 +71,14 @@
         defaults: { "digitalMode": false }
     }
 
+    U1db.Document {
+        id: userLocationDocument
+        create: true
+        database: clockDB
+        docId: "userLocationDocument"
+        defaults: { "lat": "NaN", "long": "Nan", "location": "Null" }
+    }
+
     DateTime {
         id: localTimeSource
         updateInterval: 1000

=== modified file 'backend/CMakeLists.txt'
--- backend/CMakeLists.txt	2014-09-12 05:05:03 +0000
+++ backend/CMakeLists.txt	2014-11-04 15:58:17 +0000
@@ -25,6 +25,12 @@
     modules/Alarm/Settings/alarmsettings.cpp
 )
 
+set(
+    geolocation_SRCS
+    modules/GeoLocation/backend.cpp
+    modules/GeoLocation/geolocation.cpp
+)
+
 add_library(timezone MODULE
     ${timezone_SRCS}
 )
@@ -37,6 +43,10 @@
     ${alarmsettings_SRCS}
 )
 
+add_library(geolocation MODULE
+    ${geolocation_SRCS}
+)
+
 set_target_properties(timezone PROPERTIES
     LIBRARY_OUTPUT_DIRECTORY Timezone
 )
@@ -49,9 +59,14 @@
     LIBRARY_OUTPUT_DIRECTORY Alarm/Settings
 )
 
+set_target_properties(geolocation PROPERTIES
+    LIBRARY_OUTPUT_DIRECTORY GeoLocation
+)
+
 qt5_use_modules(datetime Gui Qml Quick)
 qt5_use_modules(timezone Gui Qml Quick)
 qt5_use_modules(alarmsettings Gui Qml Quick DBus)
+qt5_use_modules(geolocation Gui Qml Quick)
 
 # Copy qmldir file to build dir for running in QtCreator
 add_custom_target(timezone-qmldir ALL
@@ -69,6 +84,11 @@
     DEPENDS ${QMLFILES}
 )
 
+add_custom_target(geolocation-qmldir ALL
+    COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/modules/GeoLocation/qmldir ${CMAKE_CURRENT_BINARY_DIR}/GeoLocation
+    DEPENDS ${QMLFILES}
+)
+
 # Install plugin file
 install(TARGETS timezone DESTINATION ${MODULE_PATH}/Timezone/)
 install(FILES   modules/Timezone/qmldir DESTINATION ${MODULE_PATH}/Timezone/)
@@ -78,3 +98,6 @@
 
 install(TARGETS alarmsettings DESTINATION ${MODULE_PATH}/Alarm/Settings/)
 install(FILES   modules/Alarm/Settings/qmldir DESTINATION ${MODULE_PATH}/Alarm/Settings/)
+
+install(TARGETS geolocation DESTINATION ${MODULE_PATH}/GeoLocation/)
+install(FILES   modules/GeoLocation/qmldir DESTINATION ${MODULE_PATH}/GeoLocation/)

=== added directory 'backend/modules/GeoLocation'
=== added file 'backend/modules/GeoLocation/backend.cpp'
--- backend/modules/GeoLocation/backend.cpp	1970-01-01 00:00:00 +0000
+++ backend/modules/GeoLocation/backend.cpp	2014-11-04 15:58:17 +0000
@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2014 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 "geolocation.h"
+
+void BackendPlugin::registerTypes(const char *uri)
+{
+    Q_ASSERT(uri == QLatin1String("GeoLocation"));
+
+    qmlRegisterType<GeoLocation>(uri, 1, 0, "GeoLocation");
+}
+
+void BackendPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
+{
+    QQmlExtensionPlugin::initializeEngine(engine, uri);
+}

=== added file 'backend/modules/GeoLocation/backend.h'
--- backend/modules/GeoLocation/backend.h	1970-01-01 00:00:00 +0000
+++ backend/modules/GeoLocation/backend.h	2014-11-04 15:58:17 +0000
@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2014 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/GeoLocation/geolocation.cpp'
--- backend/modules/GeoLocation/geolocation.cpp	1970-01-01 00:00:00 +0000
+++ backend/modules/GeoLocation/geolocation.cpp	2014-11-04 15:58:17 +0000
@@ -0,0 +1,100 @@
+/*
+ * Copyright (C) 2014 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 <QDebug>
+#include <QNetworkReply>
+#include <QNetworkRequest>
+#include <QJsonDocument>
+
+#include "geolocation.h"
+
+GeoLocation::GeoLocation(QObject *parent):
+    QObject(parent)
+{
+    m_nam = new QNetworkAccessManager(this);
+    connect(m_nam,
+            SIGNAL(finished(QNetworkReply*)),
+            this,
+            SLOT(networkReplyFinished(QNetworkReply*)));
+}
+
+QUrl GeoLocation::source() const
+{
+    return m_source;
+}
+
+QString GeoLocation::location() const
+{
+    return m_location;
+}
+
+void GeoLocation::setSource(const QUrl &source)
+{
+    if (m_source == source) {
+        // Don't set the source again if it is the same source being set again
+        return;
+    }
+
+    // Update the source and emit the changed signal to let QML know
+    m_source = source;
+    emit sourceChanged();
+
+    retrieveLocationFromJson();
+}
+
+void GeoLocation::retrieveLocationFromJson()
+{
+    // Define the request
+    QNetworkRequest request(m_source);
+
+    // Make the request to retrieve the data
+    m_nam->get(request);
+}
+
+void GeoLocation::networkReplyFinished(QNetworkReply *reply)
+{
+    if(reply->error() != QNetworkReply::NoError) {
+        qDebug() << "[LOG] Network error: " << reply->errorString();
+        return;
+    }
+
+    QByteArray data = reply->readAll();
+
+    QJsonDocument jsonDoc = QJsonDocument::fromJson(data);
+
+    QVariant cityData = jsonDoc.toVariant();
+
+    foreach (const QVariant &entry, cityData.toMap().value("geonames").toList())
+    {
+        auto data = entry.toMap();
+        auto adminName2 = data.value("adminName2").toString();
+        auto adminName1 = data.value("adminName1").toString();
+
+        if (!adminName2.isEmpty()) {
+            m_location = adminName2;
+            emit locationChanged();
+        }
+
+        else if (!adminName1.isEmpty()) {
+            m_location = adminName1;
+            emit locationChanged();
+        }
+    }
+
+    reply->deleteLater();
+}

=== added file 'backend/modules/GeoLocation/geolocation.h'
--- backend/modules/GeoLocation/geolocation.h	1970-01-01 00:00:00 +0000
+++ backend/modules/GeoLocation/geolocation.h	2014-11-04 15:58:17 +0000
@@ -0,0 +1,78 @@
+/*
+ * Copyright (C) 2014 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 LOCATION_H
+#define LOCATION_H
+
+#include <QObject>
+#include <QUrl>
+#include <QNetworkAccessManager>
+
+class GeoLocation : public QObject
+{
+    Q_OBJECT
+
+    // Property to set the user's longitude and latitude
+    Q_PROPERTY(QUrl source
+               READ source
+               WRITE setSource
+               NOTIFY sourceChanged)
+
+    // Property to return the user's location (cityname or countryname)
+    Q_PROPERTY(QString location
+               READ location
+               NOTIFY locationChanged)
+
+public:
+    GeoLocation(QObject *parent = 0);
+
+    // Function to read the json document source
+    QUrl source() const;
+
+    // Function to set the source
+    void setSource(const QUrl &source);
+
+    // Function to read the user's location
+    QString location() const;
+
+signals:
+    // Signal to notify the source has been changed
+    void sourceChanged();
+
+    // Signal to notify the location has been changed
+    void locationChanged();
+
+private slots:
+    // Function to process the json document when a reply is received
+    void networkReplyFinished(QNetworkReply *reply);
+
+private:
+    // Private copy of the source received from QML
+    QUrl m_source;
+
+    // Network access manager to request data from the online source
+    QNetworkAccessManager *m_nam;
+
+    // Private copy of the user location
+    QString m_location;
+
+    // Function to initiate the location retrieval process
+    void retrieveLocationFromJson();
+};
+
+#endif // LOCATION_H

=== added file 'backend/modules/GeoLocation/qmldir'
--- backend/modules/GeoLocation/qmldir	1970-01-01 00:00:00 +0000
+++ backend/modules/GeoLocation/qmldir	2014-11-04 15:58:17 +0000
@@ -0,0 +1,2 @@
+module GeoLocation
+plugin geolocation

=== modified file 'debian/changelog'
--- debian/changelog	2014-10-25 13:32:07 +0000
+++ debian/changelog	2014-11-04 15:58:17 +0000
@@ -55,6 +55,7 @@
   * Updated QtQuick library imports to v2.3
   * Switched bzr branch to lp:ubuntu-clock-app
   * Updated pot file name
+  * Added support for user location retrieval using GPS (LP: #1323198)
   * Added header shortcut to select/deselect all alarm repeat options (LP: #1362089)
   * Added visual tweaks (80% opacity for disabled alarms) and show time to 
     next alarm when enabling an alarm.

=== modified file 'debian/control'
--- debian/control	2014-09-26 10:56:42 +0000
+++ debian/control	2014-11-04 15:58:17 +0000
@@ -12,6 +12,7 @@
                qml-module-qttest,
                qtdeclarative5-u1db1.0,
                qtdeclarative5-qtmultimedia-plugin,
+               qtdeclarative5-qtpositioning-plugin,
                qt5-default,
                qtbase5-dev,
                qtdeclarative5-dev,
@@ -32,6 +33,7 @@
          qtdeclarative5-ubuntu-ui-toolkit-plugin | qt-components-ubuntu,
          qtdeclarative5-xmllistmodel-plugin,
          qtdeclarative5-qtmultimedia-plugin,
+         qtdeclarative5-qtpositioning-plugin,
          ubuntu-touch-sounds,
          suru-icon-theme | ubuntu-mobile-icons,
          ${misc:Depends},

=== modified file 'po/com.ubuntu.clock.pot'
--- po/com.ubuntu.clock.pot	2014-10-15 09:53:08 +0000
+++ po/com.ubuntu.clock.pot	2014-11-04 15:58:17 +0000
@@ -8,7 +8,7 @@
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2014-10-15 11:52+0200\n"
+"POT-Creation-Date: 2014-11-04 16:55+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
@@ -18,11 +18,11 @@
 "Content-Transfer-Encoding: 8bit\n"
 
 #: ../app/alarm/AlarmLabel.qml:30 ../app/alarm/AlarmLabel.qml:56
-#: ../app/alarm/EditAlarmPage.qml:303
+#: ../app/alarm/EditAlarmPage.qml:302
 msgid "Label"
 msgstr ""
 
-#: ../app/alarm/AlarmList.qml:78 ../app/alarm/AlarmPage.qml:108
+#: ../app/alarm/AlarmList.qml:78 ../app/alarm/AlarmPage.qml:117
 #: ../app/worldclock/UserWorldCityList.qml:101
 msgid "Delete"
 msgstr ""
@@ -36,27 +36,27 @@
 msgid "Alarm"
 msgstr ""
 
-#: ../app/alarm/AlarmPage.qml:58 ../app/worldclock/WorldCityList.qml:79
+#: ../app/alarm/AlarmPage.qml:58 ../app/worldclock/WorldCityList.qml:80
 msgid "Back"
 msgstr ""
 
-#: ../app/alarm/AlarmPage.qml:78
+#: ../app/alarm/AlarmPage.qml:87
 msgid "Select None"
 msgstr ""
 
-#: ../app/alarm/AlarmPage.qml:80 ../app/alarm/AlarmRepeat.qml:35
+#: ../app/alarm/AlarmPage.qml:89 ../app/alarm/AlarmRepeat.qml:35
 msgid "Select All"
 msgstr ""
 
-#: ../app/alarm/AlarmPage.qml:138
+#: ../app/alarm/AlarmPage.qml:149
 msgid "No saved alarms"
 msgstr ""
 
-#: ../app/alarm/AlarmPage.qml:139
+#: ../app/alarm/AlarmPage.qml:150
 msgid "Tap the + icon to add an alarm"
 msgstr ""
 
-#: ../app/alarm/AlarmRepeat.qml:31 ../app/alarm/EditAlarmPage.qml:293
+#: ../app/alarm/AlarmRepeat.qml:31 ../app/alarm/EditAlarmPage.qml:292
 msgid "Repeat"
 msgstr ""
 
@@ -68,33 +68,33 @@
 #: ../app/alarm/AlarmSettingsPage.qml:55 ../app/alarm/AlarmSettingsPage.qml:56
 #: ../app/alarm/AlarmSettingsPage.qml:65 ../app/alarm/AlarmSettingsPage.qml:66
 #: ../app/alarm/AlarmSettingsPage.qml:67 ../app/alarm/AlarmSettingsPage.qml:68
-#: ../app/alarm/AlarmSettingsPage.qml:139
-#: ../app/alarm/AlarmSettingsPage.qml:206
+#: ../app/alarm/AlarmSettingsPage.qml:146
+#: ../app/alarm/AlarmSettingsPage.qml:215
 #, qt-format
 msgid "%1 minutes"
 msgstr ""
 
-#: ../app/alarm/AlarmSettingsPage.qml:93
+#: ../app/alarm/AlarmSettingsPage.qml:92
 msgid "Alarm volume"
 msgstr ""
 
-#: ../app/alarm/AlarmSettingsPage.qml:138
+#: ../app/alarm/AlarmSettingsPage.qml:145
 msgid "Silence after"
 msgstr ""
 
-#: ../app/alarm/AlarmSettingsPage.qml:205
+#: ../app/alarm/AlarmSettingsPage.qml:214
 msgid "Snooze for"
 msgstr ""
 
-#: ../app/alarm/AlarmSettingsPage.qml:249
+#: ../app/alarm/AlarmSettingsPage.qml:259
 msgid "Vibration"
 msgstr ""
 
-#: ../app/alarm/AlarmSettingsPage.qml:278
+#: ../app/alarm/AlarmSettingsPage.qml:293
 msgid "Change time and date"
 msgstr ""
 
-#: ../app/alarm/AlarmSound.qml:28 ../app/alarm/EditAlarmPage.qml:316
+#: ../app/alarm/AlarmSound.qml:28 ../app/alarm/EditAlarmPage.qml:315
 msgid "Sound"
 msgstr ""
 
@@ -150,12 +150,16 @@
 msgid "Edit alarm"
 msgstr ""
 
-#: ../app/alarm/EditAlarmPage.qml:337
+#: ../app/alarm/EditAlarmPage.qml:336
 msgid "Delete alarm"
 msgstr ""
 
-#: ../app/clock/ClockPage.qml:152
-msgid "Location"
+#: ../app/clock/ClockPage.qml:268
+msgid "Location Service Error!"
+msgstr ""
+
+#: ../app/clock/ClockPage.qml:270
+msgid "Retrieving location..."
 msgstr ""
 
 #: ../app/worldclock/AddWorldCityButton.qml:30
@@ -207,23 +211,23 @@
 msgid "Select a city"
 msgstr ""
 
-#: ../app/worldclock/WorldCityList.qml:94
+#: ../app/worldclock/WorldCityList.qml:109
 msgid "Search..."
 msgstr ""
 
-#: ../app/worldclock/WorldCityList.qml:205
+#: ../app/worldclock/WorldCityList.qml:214
 msgid "Searching for a city"
 msgstr ""
 
-#: ../app/worldclock/WorldCityList.qml:210
+#: ../app/worldclock/WorldCityList.qml:219
 msgid "No City Found"
 msgstr ""
 
-#: ../app/worldclock/WorldCityList.qml:216
+#: ../app/worldclock/WorldCityList.qml:225
 msgid "Unable to connect."
 msgstr ""
 
-#: ../app/worldclock/WorldCityList.qml:217
+#: ../app/worldclock/WorldCityList.qml:226
 msgid "Please check your network connection and try again"
 msgstr ""
 

=== modified file 'tests/unit/MockClockApp.qml'
--- tests/unit/MockClockApp.qml	2014-10-13 19:57:35 +0000
+++ tests/unit/MockClockApp.qml	2014-11-04 15:58:17 +0000
@@ -21,6 +21,7 @@
 import U1db 1.0 as U1db
 import Ubuntu.Components 1.1
 import "../../app/clock"
+import "../../app/components"
 
 /*
  This file is meant to create a fake but fully fleshed clock app with its
@@ -52,6 +53,14 @@
         defaults: { "digitalMode": false }
     }
 
+    U1db.Document {
+        id: userLocationDocument
+        create: true
+        database: clockDB
+        docId: "userLocationDocument"
+        defaults: { "lat": "NaN", "long": "Nan", "location": "Null" }
+    }
+
     DateTime {
         id: localTimeSource
         updateInterval: 1000

=== modified file 'ubuntu-clock-app.json'
--- ubuntu-clock-app.json	2014-08-18 21:37:23 +0000
+++ ubuntu-clock-app.json	2014-11-04 15:58:17 +0000
@@ -2,7 +2,8 @@
     "policy_groups": [
         "audio",
         "calendar",
-        "networking"
+        "networking",
+        "location"
     ],
     "policy_version": 1.2
 }
\ No newline at end of file