Merge lp:~andrewsomething/ubuntu-clock-app/sunrise-sunset-fixes into lp:ubuntu-clock-app/saucy

[Andrew Starr-Bochicchio]

Save sunrise/sunset times to local storage and only update once a day. Fixes: https://bugs.launchpad.net/ubuntu-clock-app/+bug/1200405

Save sunrise/sunset times to local storage and only update once a day. Fixes: https://bugs.launchpad.net/ubuntu-clock-app/+bug/1200405

[Nekhelesh Ramananthan (nik90)]

On a brief look, it is looking great. I will do one last detailed code review tomorrow before approving. Thanks for the merge proposal btw!

[Nekhelesh Ramananthan (nik90)]

Looks good. Just needs some small tweaks to help debugging in the future. I was thinking perhaps some debug output statements can be added so that a user can report the terminal output incase something is going wrong. For instance, in the saveSunTimes (date, sunRise, sunSet) function, can you add an output statement like,

Utils.log("Saving Sunrise/Sunset times to disk");

This way we can be sure that it was saved.

Also in the else case below, can you add an output statement "Retrieving sunrise/sunset times from disk".

88 + else if (status == XmlListModel.Ready) {
89 + sunriseTimeLabel.text = savedData[0][2];
90 + sunsetTimeLabel.text = savedData[0][3];
91 }

In line 22, can you replace "Default Ubuntu Touch Clock" with "Sunrise and Sunset Database"

22 + db = LocalStorage.openDatabaseSync("ubuntu-clock-app", "0.1", "Default Ubuntu touch clock", 1000);

In line 33, can you change that to "Error creating table in Sunrise/Sunset database".

33 + Utils.error("Error creating table in db: " + err);

review: Needs Fixing

[lp:~andrewsomething/ubuntu-clock-app/sunrise-sunset-fixes]

175. By Andrew Starr-Bochicchio on 2013-09-03

Add more verbose debug output.

[Nekhelesh Ramananthan (nik90)]

A small nitpick, can you move,

63 + Utils.log("Saving Sunrise/Sunset times to disk");

into the try statement after tx.executesql step. This way it doesnt trigger until it is *actually* saved into disk.

review: Needs Fixing

[lp:~andrewsomething/ubuntu-clock-app/sunrise-sunset-fixes]

176. By Andrew Starr-Bochicchio on 2013-09-03

Move debug statement after the sql is executed.

[Nekhelesh Ramananthan (nik90)]

lgtm!

review: Approve

Unmerged revisions

=== modified file 'clock/EasterEgg.qml'
--- clock/EasterEgg.qml	2013-07-14 14:39:36 +0000
+++ clock/EasterEgg.qml	2013-09-03 18:35:26 +0000
@@ -20,11 +20,71 @@
 import QtQuick 2.0
 import Ubuntu.Components 0.1
 import QtQuick.XmlListModel 2.0
+import QtQuick.LocalStorage 2.0
+
+import "../common/ClockUtils.js" as Utils
 
 // Qml Element to draw the easter egg (sunrise and sunset) on the analogue clock face.
 Rectangle {
     id: easterEggCircle;
 
+    property var db: null
+
+    // Opens the local db if not already open. On the first call creates the table
+    function openDB () {
+        if(db !== null) return;
+
+        db = LocalStorage.openDatabaseSync("ubuntu-clock-app", "0.1", "Sunrise and Sunset Database", 1000);
+
+        try {
+            db.transaction(function(tx){
+                tx.executeSql('CREATE TABLE IF NOT EXISTS Easteregg(key INTEGER PRIMARY KEY, date TEXT, riseTime TEXT, setTime TEXT)');
+                var table  = tx.executeSql("SELECT * FROM Easteregg");
+                if (table.rows.length == 0) {
+                    tx.executeSql('INSERT INTO Easteregg VALUES(?, ?, ?, ?)', [1, '', '', '']);
+                };
+            });
+        } catch (err) {
+            Utils.error("Error creating table in Sunrise/Sunset database: " + err);
+        };
+    }
+
+    //Read date last checked from DB
+    function getSavedData () {
+
+        openDB();
+
+        var result = new Array();
+        try {
+            db.readTransaction(
+                function(tx){
+                    var res = tx.executeSql('SELECT * FROM Easteregg WHERE key = 1');
+                    if (res.rows.length > 0) {
+                        result[0] = new Array();
+                        result[0][0] = res.rows.item(0).key;
+                        result[0][1] = res.rows.item(0).date;
+                        result[0][2] = res.rows.item(0).riseTime;
+                        result[0][3] = res.rows.item(0).setTime;
+                    };
+                });
+        } catch (err) {
+            Utils.error("Error getting sunrise/sunset last checked date: " + err);
+        }
+        return result;
+    }
+
+    function saveSunTimes (date, sunRise, sunSet) {
+        openDB();
+        Utils.log("Saving Sunrise/Sunset times to disk");
+        try {
+            db.transaction(function(tx){
+                var res = tx.executeSql('UPDATE Easteregg SET date = ?, riseTime = ?, setTime = ? WHERE key = 1', [date, sunRise, sunSet]);
+            });
+        } catch (err) {
+            Utils.error("Error saving sunrise/sunset times: " + err);
+        };
+    }
+
     // 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;
@@ -71,9 +131,18 @@
         XmlRole { name: "sunsetTime"; query: "sunset/string()"; isKey: true  }
 
         onStatusChanged: {
-            if (status == XmlListModel.Ready) {
+            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]){
                 sunriseTimeLabel.text = getSunTime(sunRiseModel.get(0).sunriseTime);
                 sunsetTimeLabel.text = getSunTime(sunRiseModel.get(0).sunsetTime);
+                saveSunTimes(date, sunriseTimeLabel.text, sunsetTimeLabel.text);
+            }
+            else if (status == XmlListModel.Ready) {
+                Utils.log("Retrieving Sunrise/Sunset times from disk");
+                sunriseTimeLabel.text = savedData[0][2];
+                sunsetTimeLabel.text = savedData[0][3];
             }
         }
     }