Merge lp:~nik90/ubuntu-clock-app/sync-clock-backend into lp:ubuntu-clock-app/saucy

[Nekhelesh Ramananthan]

This commits implements the following,

- Remove the ability to see world clock as current location (since on changing system time, this will not be reflected in the clock app causing a discrepancy)
- Always show current system time to maintain uniformity between clock app, indicator time and welcome screen time
- Change world clock time diff calculation to be based on utc time instead of local time (more reliable)
- Add the ability for the user to edit/set the current location name
- Retrieve current location *automatically* using geoIP from http://geoip.ubuntu.com/lookup

This MP implements the following,

- Remove the ability to see world clock as current location (since on changing system time, this will not be reflected in the clock app causing a discrepancy)
- Always show current system time to maintain uniformity between clock app, indicator time and welcome screen time
- Change world clock time diff calculation to be based on utc time instead of local time (more reliable)
- Add the ability for the user to edit/set the current location name
- Retrieve current location *automatically* using geoIP from http://geoip.ubuntu.com/lookup

GPS Location backend (using qtlocation) will be added in a future MP. This MP is more focused on fixing issues with the clock app not following system time. As a result, dont want these bug fixes waiting on GPS.

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

PASSED: Continuous integration, rev:219
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/35/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests/464
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-precise-amd64-ci/35
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-quantal-amd64-ci/35
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-raring-amd64-ci/35
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-saucy-amd64-ci/35

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

review: Approve (continuous-integration)

[David Planella (dpm)]

Nice work as usual, Nekhelesh. A couple of questions:

121 + text: i18n.tr("Retrieving current location...")

- What's the behaviour if you're offline?

- Is GeoIP a backend that could be accessed via Qt Location instead of querying http://geoip.ubuntu.com directly?

review: Needs Information

[Nekhelesh Ramananthan (nik90)]

> Nice work as usual, Nekhelesh. A couple of questions:
>
> 121 + text: i18n.tr("Retrieving current location...")
>
> - What's the behaviour if you're offline?
>

Nice question. This is something I specifically tested to ensure that when offline, it notifies the user. So when offline, it will set the string to "Set current location name". The user can click the current location list item to set it manually via the same database used to add a world city. You can test this behaviour on your desktop by clearing the clock database and then going offline.

> - Is GeoIP a backend that could be accessed via Qt Location instead of
> querying http://geoip.ubuntu.com directly?

I will look into this. Popey contact bzoltan for sample code to get location via GPS. You can find his branch at https://code.launchpad.net/~bzoltan/+junk/SystemInfo. However bzoltan while testing it came to the conclusion that it takes a long time to find a gps satellite and retrieve the location coordinates. He said that a bug report needs to be reported on this. I was told all this by Popey, so please contact him regarding gps support. As for using qtlocation for geoIP, the same code used by bzoltan can be used as well for geoIP. However on testing it on my desktop and phone, I found it unreliable to get coordinates via geoIP using qtlocation. Sometime it worked and sometime it didnt.

[Nekhelesh Ramananthan (nik90)]

After a discussion with dpm and bzoltan this morning, it was concluded that qtlocation is not able to retrieve location reliably and quickly. And hence until that is worked out, the direct lookup method is acceptable. We will return to the qtlocation method in the near future.

[David Planella (dpm)]

Note that the the initial (long) delay in getting the GPS location is
probably to be expected and it is not a bug in Qt Location.

I'm not an expert on GPS, but I'm told it can take around 12 mins to get a
fix (your position from GPS measurements), as we currently don't have any
AGPS support to speed it. Take this statement with a pinch of salt, but
also bear it in mind when testing GPS support.

Thanks!

On Wed, Sep 25, 2013 at 1:44 PM, Nekhelesh Ramananthan <
<email address hidden>> wrote:

> The proposal to merge lp:~nik90/ubuntu-clock-app/sync-clock-backend into
> lp:ubuntu-clock-app has been updated.
>
> Status: Needs review => Work in progress
>
> For more details, see:
>
> https://code.launchpad.net/~nik90/ubuntu-clock-app/sync-clock-backend/+merge/186923
> --
>
> https://code.launchpad.net/~nik90/ubuntu-clock-app/sync-clock-backend/+merge/186923
> You are reviewing the proposed merge of
> lp:~nik90/ubuntu-clock-app/sync-clock-backend into lp:ubuntu-clock-app.
>

[Nekhelesh Ramananthan (nik90)]

@dpm, thnx for the info. I will be testing the qtlocation this weekend. While using qtlocation, i had a few crashes on the desktop which is not good. Anyways this branch is more focussed on fixing the default time shown by the clock app and ensure it is the same as the system time. As a bonus, I added the geoIP feature for automatic location retrieval. So from the perspective I consider this MP complete and ready for trunk merge.

As said above, I will test qtlocation in the weekend and propose that in a new branch by itself to spot any regression due to qtlocation quicker. Please approve if you agree.

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

222. By Nekhelesh Ramananthan on 2013-09-26

merge from trunk

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

PASSED: Continuous integration, rev:222
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/39/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests/496
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-precise-amd64-ci/39
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-quantal-amd64-ci/39
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-raring-amd64-ci/39
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-saucy-amd64-ci/39

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

review: Approve (continuous-integration)

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

223. By Nekhelesh Ramananthan on 2013-09-27

merged trunk

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

PASSED: Continuous integration, rev:223
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/42/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests/506
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-precise-amd64-ci/42
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-quantal-amd64-ci/42
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-raring-amd64-ci/42
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-saucy-amd64-ci/42

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

review: Approve (continuous-integration)

=== modified file 'clock/ClockPage.qml'
--- clock/ClockPage.qml	2013-09-26 06:14:47 +0000
+++ clock/ClockPage.qml	2013-09-27 08:38:25 +0000
@@ -30,18 +30,23 @@
 
     // Property to hold the formatted time string to show on the screen
     property string currentTimeFormatted
-    property real currentTimeStamp
+    property real currentUTCTime
     property real diff: new Date().getTimezoneOffset()
+    property alias currentCity: currentLocationCity.text
+    property alias currentLat: easterEggCircle.latitude
+    property alias currentLng: easterEggCircle.longitude
 
     Component.onCompleted: {
-        Utils.log("ClockPage loaded");
-        diff = worldModel.timeDiff;
-        currentLocationCity.text = worldModel.city;
-        easterEggCircle.longitude = worldModel.longitude;
-        easterEggCircle.latitude = worldModel.latitude;
+        // TODO: Query GPS for location data
+        Utils.log("ClockPage loaded");        
+        if (worldModel.city !== "undefined") {
+            currentCity = worldModel.city;
+            currentLng = worldModel.longitude;
+            currentLat = worldModel.latitude;
+        }
         Utils.log("Saved Current Location: " + worldModel.city);
-        Utils.log("Saved Current Location Coordinates: " + easterEggCircle.longitude + "," + easterEggCircle.latitude)
-        currentTimeFormatted = Qt.formatTime(new Date(currentTimeStamp + (diff * 60000)), "hh:mm")
+        Utils.log("Saved Current Location Coordinates: " + currentLng + "," + currentLat)
+        currentTimeFormatted = Qt.formatTime(new Date(), "hh:mm")
         updateTime();
     }
 
@@ -53,13 +58,12 @@
             keywords: i18n.tr("Add;Timezone;Timezones;World;City;Cities;Town;Towns;Place;Places;Location;Locations;Time;Locale;Local;Current")
             description: "Add a world city"
             iconSource: Qt.resolvedUrl("../images/add_icon.png")
-            onTriggered: pagestack.push(Qt.resolvedUrl("WorldPage.qml"))
+            onTriggered: pagestack.push(Qt.resolvedUrl("WorldPage.qml"), {"isWorldCity": true})
         }
     ]
 
     function onTimerUpdate(now) {
-        currentTimeFormatted = Qt.formatTime(new Date(currentTimeStamp + (diff * 60000)), "hh:mm")
-        now.setMinutes(now.getMinutes() + diff)
+        currentTimeFormatted = Qt.formatTime(new Date(), "hh:mm")        
         clockFace.timeChanged(now)
         if (now.getUTCSeconds() == 0) {
             updateTime();
@@ -68,15 +72,42 @@
 
     function updateTime() {
         var now = new Date();
-        currentTimeStamp = now.getTime();
-    }    
+        now.setMinutes(now.getMinutes() + diff)
+        currentUTCTime = now.getTime();
+    }
+
+    GeoIPModel {
+        id: geoIP
+        onStatusChanged: {
+            if (status == XmlListModel.Ready && geoIP.get(0).city != worldModel.city && geoIP.get(0).city != "None") {
+                Utils.log("Retrieved current location using GeoIP. Writing into database and setting it as current location")
+                currentCity = geoIP.get(0).city
+                currentLng = geoIP.get(0).lng
+                currentLat = geoIP.get(0).lat
+                worldModel.appendCurrentLocation(currentCity, currentLng, currentLat);
+            }
+            else if (status == XmlListModel.Ready && geoIP.get(0).city == "None") {
+                if (worldModel.city == "undefined") {
+                    currentCity = i18n.tr("Set current location name")
+                    currentLocation.progression = true
+                }
+            }
+            else if(status == XmlListModel.Error) {
+                Utils.error("Unable to retrieve GeoIP Data -> " + geoIP.errorString())
+                if (worldModel.city == "undefined") {
+                    currentCity = i18n.tr("Set current location name")
+                    currentLocation.progression = true
+                }
+            }
+        }
+    }
 
     Flickable {
         id: clockAnimationContainer
 
         clip: true;
         anchors.fill: parent
-        contentWidth: parent.width        
+        contentWidth: parent.width
         contentHeight: clockFace.height + clockFace.anchors.topMargin + savedWorldClock.height + savedWorldClock.anchors.topMargin + units.gu(3)
 
         // Label to show the current time
@@ -108,10 +139,10 @@
             anchors { top: parent.top; topMargin: units.gu(10); horizontalCenter: parent.horizontalCenter }
 
             onClicked: {
-                if (easterEggCircle.isReady == XmlListModel.Ready) {
+                if (easterEggCircle.isReady == XmlListModel.Ready && worldModel.city !== "undefined") {
                     clockFace.state == "" ? clockFace.state = "easteregg" : clockFace.state = "";
                 } else {
-                    Utils.log("Sunrise/Sunset times not yet loaded.")
+                    Utils.error("Sunrise/Sunset times cannot be loaded without setting the current location or without a internet connection.")
                 }
             }
 
@@ -127,7 +158,6 @@
                     name: "easteregg"
                     PropertyChanges { target: easterEggCircle; opacity: 1; }
                     PropertyChanges { target: currentTimeLabel; opacity: 0; }
-                    // TODO: Do some caching of data here. Store data locally to reduce API calls.
                     PropertyChanges { target: easterEggCircle; sunriseLabel: easterEggCircle.getSunTime(easterEggCircle.model.get(0).sunriseTime); }
                     PropertyChanges { target: easterEggCircle; sunsetLabel: easterEggCircle.getSunTime(easterEggCircle.model.get(0).sunsetTime); }
                 },
@@ -161,20 +191,24 @@
 
             ListItem.Standard {
                 id: currentLocation
+
                 Label {
                     id: currentLocationCity
-                    // TRANSLATORS: this refers to Coordinated Universal Time
-                    text: i18n.tr("UTC")
+                    text: i18n.tr("Retrieving current location...")
                     anchors { verticalCenter: parent.verticalCenter; left: parent.left; leftMargin: units.gu(3) }
                     color: Theme.palette.normal.baseText
                     fontSize: "large"
                 }
                 Label {
-                    text: Qt.formatTime(new Date(currentTimeStamp + (diff * 60000)), "hh:mm A")
-                    anchors { verticalCenter: parent.verticalCenter; right: parent.right; rightMargin: units.gu(2) }
+                    id: currentLocationTime
+                    visible: worldModel.city !== "undefined" ? true : false
+                    text: currentTimeFormatted
+                    anchors { verticalCenter: parent.verticalCenter; right: parent.right; rightMargin: currentLocation.progression == true ? units.gu(6) : units.gu(2) }
                     color: Theme.palette.normal.baseText
                     fontSize: "large"
                 }
+
+                onClicked: pagestack.push(Qt.resolvedUrl("WorldPage.qml"), {"isWorldCity": false})
             }
 
             ListItem.Header {
@@ -190,7 +224,7 @@
                 id: listWorldClocks
 
                 clip: true
-                anchors { left: parent.left; right: parent.right }                
+                anchors { left: parent.left; right: parent.right }
                 height: 3 * units.gu(6) + units.gu(1)  // height is defined to show 3 items by default with a small margin
                 model: worldModel
                 currentIndex: -1
@@ -204,7 +238,7 @@
                     }
 
                     Label {
-                        text: Qt.formatTime(new Date(currentTimeStamp + (rawOffSet * 60000)), "hh:mm A")
+                        text: Qt.formatTime(new Date(currentUTCTime + (rawOffSet * 60000)), "hh:mm")
                         anchors { verticalCenter: parent.verticalCenter; right: parent.right; rightMargin: units.gu(2) }
                         color: Theme.palette.normal.baseText
                         fontSize: "large"
@@ -221,14 +255,6 @@
                     onItemRemoved: {
                         worldModel.removePreset(index);
                     }
-
-                    onClicked: {
-                        currentLocationCity.text = cityName;
-                        diff = rawOffSet;
-                        easterEggCircle.longitude = longitude;
-                        easterEggCircle.latitude = latitude;
-                        worldModel.appendCurrentLocation(cityName, diff, longitude, latitude);
-                    }
                 }
             }
         }

=== modified file 'clock/EasterEgg.qml'
--- clock/EasterEgg.qml	2013-09-03 18:55:04 +0000
+++ clock/EasterEgg.qml	2013-09-27 08:38:25 +0000
@@ -86,8 +86,8 @@
     }
 
     // FIXME: Replace these constant values with user's location coordinates when automatic location detection is implemented.
-    property real latitude: 52.01;
-    property real longitude: 4.35;
+    property real latitude: 200;
+    property real longitude: 200;
 
     // properties to set/retrieve the sunrise and sunset times
     property alias sunriseLabel: sunriseTimeLabel.text;
@@ -134,7 +134,7 @@
             var savedData = getSavedData();
             var checkedDate = savedData[0][1].split('T')[0]
             var date = new Date().toISOString();
-            if (status == XmlListModel.Ready && checkedDate != date.split('T')[0]){
+            if (status == XmlListModel.Ready && checkedDate != date.split('T')[0] && longitude != 200 && latitude != 200){
                 sunriseTimeLabel.text = getSunTime(sunRiseModel.get(0).sunriseTime);
                 sunsetTimeLabel.text = getSunTime(sunRiseModel.get(0).sunsetTime);
                 saveSunTimes(date, sunriseTimeLabel.text, sunsetTimeLabel.text);

=== added file 'clock/GeoIPModel.qml'
--- clock/GeoIPModel.qml	1970-01-01 00:00:00 +0000
+++ clock/GeoIPModel.qml	2013-09-27 08:38:25 +0000
@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Nekhelesh Ramananthan <[e-mail]>
+ */
+
+import QtQuick 2.0
+import QtQuick.XmlListModel 2.0
+
+// Xml model to retrieve user's current location based on geoIP
+XmlListModel {
+    id: geoIPModel;
+    
+    source: "http://geoip.ubuntu.com/lookup"
+    query: "/Response"
+    XmlRole { name: "city"; query: "City/string()"; isKey: true }
+    XmlRole { name: "lat"; query: "Latitude/string()"; isKey: true }
+    XmlRole { name: "lng"; query: "Longitude/string()"; isKey: true }
+}

=== modified file 'clock/WorldClockModel.qml'
--- clock/WorldClockModel.qml	2013-07-01 14:40:35 +0000
+++ clock/WorldClockModel.qml	2013-09-27 08:38:25 +0000
@@ -27,31 +27,31 @@
     readonly property string dbVersion: "0.1"
     readonly property string dbDescription: "World Clock"
 
-    property real timeDiff: new Date().getTimezoneOffset()
-    property string city: "UTC";
-    property real longitude: 4.35;
-    property real latitude: 52.01;
+    property string city: "undefined";
+    property real longitude: 200;
+    property real latitude: 200;
 
     property var _db: null
 
-    function appendCurrentLocation(cityname, rawOffSet, longitude, latitude)
+    function appendCurrentLocation(cityname, longitude, latitude)
     {
         try {
             _db.transaction(function(tx){
                 var currentValue;
                 var res = tx.executeSql('SELECT * FROM CurrentClock');
-                if (res.rows.length > 0) {
-                    currentValue = res.rows.item(0).rawOffSet;
-                }
-
-                if (currentValue !== rawOffSet) {
-                    // Update existing value or insert if none                    
-                    if (currentValue !== undefined) {
-                        res = tx.executeSql('UPDATE CurrentClock SET rawOffSet = ?, cityName = ?, longitude = ?, latitude = ?', [rawOffSet, cityname, longitude, latitude]);
-                    } else {
-                        res = tx.executeSql('INSERT INTO CurrentClock VALUES(?, ?, ?, ?)', [cityname, rawOffSet, longitude, latitude]);
-                    }
-                }
+
+                if (res.rows.length > 0)
+                    currentValue = res.rows.item(0).cityName;
+
+                if (currentValue !== undefined)  // Update existing value or insert if none
+                    res = tx.executeSql('UPDATE CurrentClock SET cityName = ?, longitude = ?, latitude = ?', [cityname, longitude, latitude]);
+                else
+                    res = tx.executeSql('INSERT INTO CurrentClock VALUES(?, ?, ?)', [cityname, longitude, latitude]);
+
+                clockPage.currentCity = model.city = cityname
+                clockPage.currentLng = model.longitude = longitude
+                clockPage.currentLat = model.latitude = latitude
+                Utils.log("Updating current location (manually)")
             });
         } catch (err) {
             Utils.error("Error setting current location '" + "': " + err);
@@ -86,7 +86,7 @@
         }
         try {
             _db.transaction(function(tx){
-                tx.executeSql('CREATE TABLE IF NOT EXISTS CurrentClock(cityName TEXT, rawOffSet REAL, longitude REAL, latitude REAL)');
+                tx.executeSql('CREATE TABLE IF NOT EXISTS CurrentClock(cityName TEXT, longitude REAL, latitude REAL)');
             });
         } catch (err) {
             Utils.error("Error creating CurrentClock table in db:" + err);
@@ -108,9 +108,9 @@
                 if (res.rows.length > 0) {
                     for (var i = 0; i < res.rows.length; i++) {
                         model.append({"cityName" : res.rows.item(i).cityName,
-                                      "rawOffSet": res.rows.item(i).rawOffSet,
-                                      "longitude": res.rows.item(i).longitude,
-                                      "latitude" : res.rows.item(i).latitude
+                                         "rawOffSet": res.rows.item(i).rawOffSet,
+                                         "longitude": res.rows.item(i).longitude,
+                                         "latitude" : res.rows.item(i).latitude
                                      });
                     }
                 }
@@ -125,7 +125,6 @@
                 var currentstate = tx.executeSql('SELECT * FROM CurrentClock ORDER BY cityName');
                 if (currentstate.rows.length > 0) {
                     city = currentstate.rows.item(0).cityName;
-                    timeDiff = currentstate.rows.item(0).rawOffSet;
                     longitude = currentstate.rows.item(0).longitude;
                     latitude = currentstate.rows.item(0).latitude;
                 }

=== modified file 'clock/WorldPage.qml'
--- clock/WorldPage.qml	2013-09-04 11:28:52 +0000
+++ clock/WorldPage.qml	2013-09-27 08:38:25 +0000
@@ -23,14 +23,20 @@
 Page {
     id: worldPage
 
+    property bool isWorldCity;
+
     visible: false;
-    title: i18n.tr("Add City")
+    title: isWorldCity ? i18n.tr("Add City") : i18n.tr("Edit Current Location")
 
     function getTimeDifference(data) {
         var worldTime = data.split(' ')[1].split(':');
         var hoursWT = parseInt(worldTime[0]);
         var minutesWT = parseInt(worldTime[1]);
         var now = new Date();
+        var UTCdiff = new Date().getTimezoneOffset()
+        now.setMinutes(now.getMinutes() + UTCdiff)
+
+        // Calculating world city time diff w.r.t UTC
         return ((hoursWT - now.getHours()) * 60 + (minutesWT - now.getMinutes()));
     }
 
@@ -48,7 +54,10 @@
 
             onStatusChanged: {
                 if(status == XmlListModel.Ready && worldClockList.city != "null") {
-                    worldModel.appendPreset(worldClockList.city, getTimeDifference(cityDetailsModel.get(0).time), worldClockList.lng, worldClockList.lat);
+                    if (isWorldCity)
+                        worldModel.appendPreset(worldClockList.city, getTimeDifference(cityDetailsModel.get(0).time), worldClockList.lng, worldClockList.lat);
+                    else
+                        worldModel.appendCurrentLocation(worldClockList.city, worldClockList.lng, worldClockList.lat);
                     worldClockList.clearUserSearch();
                     pageStack.pop()
                 }
@@ -61,7 +70,7 @@
             lat = searchModel.get(index).lat;
             lng = searchModel.get(index).lng;
             city = searchModel.get(index).city;
-            cityDetailsModel.reload()                        
+            cityDetailsModel.reload()
         }
     }
 }