update cached tiles if they're older than two weeks; add a button to clear the cache
[lantea.git] / js / map.js
index ea3b62256c5d54ce23511f004445afc600ef0c73..9ffc81c3f3c99bd90c701384d179a7042b9d0587 100644 (file)
--- a/js/map.js
+++ b/js/map.js
@@ -3,7 +3,7 @@
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 var gMapCanvas, gMapContext, gTrackCanvas, gTrackContext, gGeolocation;
-var gDebug = true;
+var gDebug = false;
 
 var gTileSize = 256;
 var gMaxZoom = 18; // The minimum is 0.
@@ -35,7 +35,7 @@ var gMapStyles = {
      copyright: 'Map data &copy; <a href="http://www.openstreetmap.org/">OpenStreetMap</a> and contributors (<a href="http://www.openstreetmap.org/copyright">ODbL/CC-BY-SA</a>), tiles Courtesy of <a href="http://www.mapquest.com/">MapQuest</a>.'},
   mapquest_aerial:
     {name: "MapQuest Open Aerial",
-     url: "http://oatile[1-4].mqcdn.com/tiles/1.0.0/sat/{z}/{x}/{y}.jpg",
+     url: "http://otile[1-4].mqcdn.com/tiles/1.0.0/sat/{z}/{x}/{y}.jpg",
      copyright: 'Tiles Courtesy of <a href="http://www.mapquest.com/">MapQuest</a>, portions Courtesy NASA/JPL-Caltech and U.S. Depart. of Agriculture, Farm Service Agency.'},
   opengeoserver_arial:
     {name: "OpenGeoServer Aerial",
@@ -56,9 +56,6 @@ var gLastMouseX = 0;
 var gLastMouseY = 0;
 var gZoomFactor;
 
-// Used as an associative array.
-// The keys have to be strings, ours will be "xindex,yindex,zindex" e.g. "13,245,12".
-var gTiles = {};
 var gLoadingTile;
 
 var gMapPrefsLoaded = false;
@@ -122,7 +119,7 @@ function initMap() {
       gWaitCounter++;
       gTrackStore.getList(function(aTPoints) {
         if (gDebug)
-          document.getElementById("debug").textContent = aTPoints.length + " points loaded.";
+          console.log(aTPoints.length + " points loaded.");
         if (aTPoints.length) {
           gTrack = aTPoints;
         }
@@ -133,7 +130,7 @@ function initMap() {
       setTimeout(getPersistentPrefs, 100);
     loopCnt++;
     if (loopCnt > 50) {
-      document.getElementById("debug").textContent = "Loading prefs failed.";
+      console.log("Loading prefs failed.");
     }
   };
   getPersistentPrefs();
@@ -165,15 +162,19 @@ function initMap() {
 function resizeAndDraw() {
   var viewportWidth = Math.min(window.innerWidth, window.outerWidth);
   var viewportHeight = Math.min(window.innerHeight, window.outerHeight);
-
-  gMapCanvas.width = viewportWidth;
-  gMapCanvas.height = viewportHeight;
-  gTrackCanvas.width = viewportWidth;
-  gTrackCanvas.height = viewportHeight;
-  drawMap();
-  showUI();
+  if (gMapCanvas && gTrackCanvas) {
+    gMapCanvas.width = viewportWidth;
+    gMapCanvas.height = viewportHeight;
+    gTrackCanvas.width = viewportWidth;
+    gTrackCanvas.height = viewportHeight;
+    drawMap();
+    showUI();
+  }
 }
 
+// Using scale(x, y) together with drawing old data on scaled canvas would be an improvement for zooming.
+// See https://developer.mozilla.org/en-US/docs/Canvas_tutorial/Transformations#Scaling
+
 function zoomIn() {
   if (gPos.z < gMaxZoom) {
     gPos.z++;
@@ -210,7 +211,6 @@ function setMapStyle() {
   var mapSel = document.getElementById("mapSelector");
   if (mapSel.selectedIndex >= 0 && gActiveMap != mapSel.value) {
     gActiveMap = mapSel.value;
-    gTiles = {};
     document.getElementById("copyright").innerHTML =
         gMapStyles[gActiveMap].copyright;
     showUI();
@@ -259,12 +259,17 @@ function decodeIndex(encodedIdx) {
   return {x: ind[0], y: ind[1], z: ind[2]};
 }
 
-function drawMap() {
-  // Go through all the currently loaded tiles. If we don't want any of them remove them.
-  // for (t in gTiles) {
-  //   if (isOutsideWindow(t))
-  //     delete gTiles[t];
-  // }
+function drawMap(aPixels, aOverdraw) {
+  // aPixels is an object with left/right/top/bottom members telling how many
+  //   pixels on the borders should actually be drawn.
+  // aOverdraw is a bool that tells if we should draw placeholders or draw
+  //   straight over the existing content.
+  if (!aPixels)
+    aPixels = {left: gMapCanvas.width, right: gMapCanvas.width,
+               top: gMapCanvas.height, bottom: gMapCanvas.height};
+  if (!aOverdraw)
+    aOverdraw = false;
+
   document.getElementById("zoomLevel").textContent = gPos.z;
   gZoomFactor = Math.pow(2, gMaxZoom - gPos.z);
   var wid = gMapCanvas.width * gZoomFactor; // Width in level 18 pixels.
@@ -279,32 +284,51 @@ function drawMap() {
   if (gMapPrefsLoaded && mainDB)
     gPrefs.set("position", gPos);
 
-  // Go through all the tiles we want.
-  // If any of them aren't loaded or being loaded, do so.
+  var tiles = {left: Math.ceil((xMin + aPixels.left * gZoomFactor) / size) -
+                               (aPixels.left ? 0 : 1),
+               right: Math.floor((xMax - aPixels.right * gZoomFactor) / size) -
+                                 (aPixels.right ? 1 : 0),
+               top: Math.ceil((yMin + aPixels.top * gZoomFactor) / size) -
+                              (aPixels.top ? 0 : 1),
+               bottom: Math.floor((yMax - aPixels.bottom * gZoomFactor) / size) -
+                                  (aPixels.bottom ? 1 : 0)};
+
+  // Go through all the tiles in the map, find out if to draw them and do so.
   for (var x = Math.floor(xMin / size); x < Math.ceil(xMax / size); x++) {
     for (var y = Math.floor(yMin / size); y < Math.ceil(yMax / size); y++) { // slow script warnings on the tablet appear here!
-      // Round here is **CRUCIAL** otherwise the images are filtered
-      // and the performance sucks (more than expected).
-      var xoff = Math.round((x * size - xMin) / gZoomFactor);
-      var yoff = Math.round((y * size - yMin) / gZoomFactor);
-      // Draw placeholder, and then initiate loading/drawing of real one.
-      gMapContext.drawImage(gLoadingTile, xoff, yoff);
-
-      gTileService.get(gActiveMap, {x: x, y: y, z: gPos.z}, function(aImage, aStyle, aCoords) {
-        // Only draw if this applies for the current view.
-        if ((aStyle == gActiveMap) && (aCoords.z == gPos.z)) {
-          var ixMin = gPos.x - wid / 2;
-          var iyMin = gPos.y - ht / 2;
-          var ixoff = Math.round((aCoords.x * size - ixMin) / gZoomFactor);
-          var iyoff = Math.round((aCoords.y * size - iyMin) / gZoomFactor);
-          var URL = window.URL;
-          var imgURL = URL.createObjectURL(aImage);
-          var imgObj = new Image();
-          imgObj.src = imgURL;
-          gMapContext.drawImage(imgObj, ixoff, iyoff);
-          URL.revokeObjectURL(imgURL);
-        }
-      });
+      // Only go to the drawing step if we need to draw this tile.
+      if (x < tiles.left || x > tiles.right ||
+          y < tiles.top || y > tiles.bottom) {
+        // Round here is **CRUCIAL** otherwise the images are filtered
+        // and the performance sucks (more than expected).
+        var xoff = Math.round((x * size - xMin) / gZoomFactor);
+        var yoff = Math.round((y * size - yMin) / gZoomFactor);
+        // Draw placeholder tile unless we overdraw.
+        if (!aOverdraw &&
+            (x < tiles.left -1  || x > tiles.right + 1 ||
+             y < tiles.top -1 || y > tiles.bottom + 1))
+          gMapContext.drawImage(gLoadingTile, xoff, yoff);
+
+        // Initiate loading/drawing of the actual tile.
+        gTileService.get(gActiveMap, {x: x, y: y, z: gPos.z},
+                         function(aImage, aStyle, aCoords) {
+          // Only draw if this applies for the current view.
+          if ((aStyle == gActiveMap) && (aCoords.z == gPos.z)) {
+            var ixMin = gPos.x - wid / 2;
+            var iyMin = gPos.y - ht / 2;
+            var ixoff = Math.round((aCoords.x * size - ixMin) / gZoomFactor);
+            var iyoff = Math.round((aCoords.y * size - iyMin) / gZoomFactor);
+            var URL = window.URL;
+            var imgURL = URL.createObjectURL(aImage);
+            var imgObj = new Image();
+            imgObj.src = imgURL;
+            imgObj.onload = function() {
+              gMapContext.drawImage(imgObj, ixoff, iyoff);
+              URL.revokeObjectURL(imgURL);
+            }
+          }
+        });
+      }
     }
   }
   gLastDrawnPoint = null;
@@ -437,7 +461,13 @@ var mapEvHandler = {
           var dY = y - gLastMouseY;
           gPos.x -= dX * gZoomFactor;
           gPos.y -= dY * gZoomFactor;
-          drawMap();
+          var mapData = gMapContext.getImageData(0, 0, gMapCanvas.width, gMapCanvas.height);
+          gMapContext.clearRect(0, 0, gMapCanvas.width, gMapCanvas.height);
+          gMapContext.putImageData(mapData, dX, dY);
+          drawMap({left: (dX > 0) ? dX : 0,
+                   right: (dX < 0) ? -dX : 0,
+                   top: (dY > 0) ? dY : 0,
+                   bottom: (dY < 0) ? -dY : 0});
           showUI();
         }
         gLastMouseX = x;
@@ -471,10 +501,9 @@ var mapEvHandler = {
                        y: gPos.y + (x - gMapCanvas.height / 2) * gZoomFactor};
         var gpsCoord = xy2gps(ptCoord.x, ptCoord.y);
         var pt2Coord = gps2xy(gpsCoord.latitude, gpsCoord.longitude);
-        document.getElementById("debug").textContent =
-            ptCoord.x + "/" + ptCoord.y + " - " +
-            gpsCoord.latitude + "/" + gpsCoord.longitude + " - " +
-            pt2Coord.x + "/" + pt2Coord.y;
+        console.log(ptCoord.x + "/" + ptCoord.y + " - " +
+                    gpsCoord.latitude + "/" + gpsCoord.longitude + " - " +
+                    pt2Coord.x + "/" + pt2Coord.y);
         */
 
         var newZoomLevel = gPos.z + (delta > 0 ? 1 : -1);
@@ -549,8 +578,14 @@ function setTracking(aCheckbox) {
 
 function startTracking() {
   if (gGeolocation) {
+    gActionLabel.textContent = "Establishing Position";
+    gAction.style.display = "block";
     gGeoWatchID = gGeolocation.watchPosition(
       function(position) {
+        if (gActionLabel.textContent) {
+          gActionLabel.textContent = "";
+          gAction.style.display = "none";
+        }
         // Coords spec: https://developer.mozilla.org/en/XPCOM_Interface_Reference/NsIDOMGeoPositionCoords
         var tPoint = {time: position.timestamp,
                       coords: {latitude: position.coords.latitude,
@@ -587,7 +622,8 @@ function startTracking() {
       function(error) {
         // Ignore erros for the moment, but this is good for debugging.
         // See https://developer.mozilla.org/en/Using_geolocation#Handling_errors
-        document.getElementById("debug").textContent = error.message;
+        if (gDebug)
+          console.log(error.message);
       },
       {enableHighAccuracy: true}
     );
@@ -595,6 +631,10 @@ function startTracking() {
 }
 
 function endTracking() {
+  if (gActionLabel.textContent) {
+    gActionLabel.textContent = "";
+    gAction.style.display = "none";
+  }
   if (gGeoWatchID) {
     gGeolocation.clearWatch(gGeoWatchID);
   }
@@ -609,36 +649,40 @@ function clearTrack() {
 var gTileService = {
   objStore: "tilecache",
 
+  ageLimit: 14 * 86400, // 2 weeks
+
   get: function(aStyle, aCoords, aCallback) {
     var norm = normalizeCoords(aCoords);
     var dbkey = aStyle + "::" + norm.x + "," + norm.y + "," + norm.z;
     this.getDBCache(dbkey, function(aResult, aEvent) {
       if (aResult) {
         // We did get a cached object.
-        // TODO: Look at the timestamp and trigger a reload when it's too old.
         aCallback(aResult.image, aStyle, aCoords);
+        // Look at the timestamp and return if it's not too old.
+        if (aResult.timestamp + this.ageLimit > Date.now())
+          return;
+        // Reload cached tile otherwise.
+        console.log("reload cached tile: " + dbkey);
       }
-      else {
-        // Retrieve image from the web and store it in the cache.
-        var XHR = new XMLHttpRequest();
-        XHR.open("GET",
-                 gMapStyles[aStyle].url
-                   .replace("{x}", norm.x)
-                   .replace("{y}", norm.y)
-                   .replace("{z}", norm.z)
-                   .replace("[a-c]", String.fromCharCode(97 + Math.floor(Math.random() * 2)))
-                   .replace("[1-4]", 1 + Math.floor(Math.random() * 3)),
-                 true);
-        XHR.responseType = "blob";
-        XHR.addEventListener("load", function () {
-          if (XHR.status === 200) {
-            var blob = XHR.response;
-            gTileService.setDBCache(dbkey, {image: blob, timestamp: Date.now()});
-            aCallback(blob, aStyle, aCoords);
-          }
-        }, false);
-        XHR.send();
-      }
+      // Retrieve image from the web and store it in the cache.
+      var XHR = new XMLHttpRequest();
+      XHR.open("GET",
+                gMapStyles[aStyle].url
+                  .replace("{x}", norm.x)
+                  .replace("{y}", norm.y)
+                  .replace("{z}", norm.z)
+                  .replace("[a-c]", String.fromCharCode(97 + Math.floor(Math.random() * 2)))
+                  .replace("[1-4]", 1 + Math.floor(Math.random() * 3)),
+                true);
+      XHR.responseType = "blob";
+      XHR.addEventListener("load", function () {
+        if (XHR.status === 200) {
+          var blob = XHR.response;
+          gTileService.setDBCache(dbkey, {image: blob, timestamp: Date.now()});
+          aCallback(blob, aStyle, aCoords);
+        }
+      }, false);
+      XHR.send();
     });
   },
 
@@ -691,5 +735,23 @@ var gTileService = {
       if (aCallback)
         aCallback(success, event);
     }
+  },
+
+  clearDB: function(aCallback) {
+    if (!mainDB)
+      return;
+    var success = false;
+    var transaction = mainDB.transaction([this.objStore], "readwrite");
+    var request = transaction.objectStore(this.objStore).clear();
+    request.onsuccess = function(event) {
+      success = true;
+      if (aCallback)
+        aCallback(success, event);
+    };
+    request.onerror = function(event) {
+      // Errors can be handled here.
+      if (aCallback)
+        aCallback(success, event);
+    }
   }
 };