Changeset 30849 in osm for applications/viewer/jmapviewer/src/org/openstreetmap

Timestamp:

2014-12-14T23:20:23+01:00 (10 years ago)

Author:

bastik

Message:

see #josm10849 - improve TMS imagery caching

Location:

applications/viewer/jmapviewer/src/org/openstreetmap/gui/jmapviewer

Files:

• OsmFileCacheTileLoader.java (modified) (12 diffs)
• tilesources/TMSTileSource.java (modified) (1 diff)

applications/viewer/jmapviewer/src/org/openstreetmap/gui/jmapviewer/OsmFileCacheTileLoader.java

@@ -43 +43 @@
 public class OsmFileCacheTileLoader extends OsmTileLoader implements CachedTileLoader {
 
-    private static final Logger log = Logger.getLogger(OsmFileCacheTileLoader.class.getName());
-
-    private static final String ETAG_FILE_EXT = ".etag";
+    private static final Logger log = FeatureAdapter.getLogger(OsmFileCacheTileLoader.class.getName());
+
     private static final String TAGS_FILE_EXT = ".tags";
 
@@ -57 +56 @@
     protected final Map<TileSource, File> sourceCacheDirMap;
 
-    protected long maxCacheFileAge = FILE_AGE_ONE_WEEK;
-    protected long recheckAfter = FILE_AGE_ONE_DAY;
+    protected long maxCacheFileAge = Long.MAX_VALUE;  // max. age not limited
+    protected long recheckAfter = FILE_AGE_ONE_WEEK;
 
     public static File getDefaultCacheDir() throws SecurityException {
@@ -134 +133 @@
         File tileCacheDir;
         File tileFile = null;
-        long fileAge = 0;
-        boolean fileTilePainted = false;
+        Long fileAge = null;
 
         public FileLoadJob(Tile tile) {
@@ -156 +154 @@
             }
             tileCacheDir = getSourceCacheDir(tile.getSource());
-            if (loadTileFromFile()) {
+            
+            if (loadTileFromFile(recheckAfter)) {
+                log.log(Level.FINEST, "TMS - found in tile cache: {0}", tile);
+                tile.setLoaded(true);
+                listener.tileLoadingFinished(tile, true);
                 return;
             }
-            if (fileTilePainted) {
-                TileJob job = new TileJob() {
-
-                    @Override
-                    public void run() {
-                        loadOrUpdateTile();
-                    }
-                    @Override
-                    public Tile getTile() {
-                        return tile;
-                    }
-                };
-                JobDispatcher.getInstance().addJob(job);
-            } else {
-                loadOrUpdateTile();
-            }
-        }
-
-        protected void loadOrUpdateTile() {
+            TileJob job = new TileJob() {
+
+                @Override
+                public void run() {
+                    if (loadOrUpdateTile()) {
+                        tile.setLoaded(true);
+                        listener.tileLoadingFinished(tile, true);
+                    } else {
+                        // failed to download - use old cache file if available
+                        if (loadTileFromFile(maxCacheFileAge)) {
+                            tile.setLoaded(true);
+                            tile.error = false;
+                            listener.tileLoadingFinished(tile, true);
+                            log.log(Level.FINEST, "TMS - found stale tile in cache: {0}", tile);
+                        } else {
+                            // failed completely
+                            tile.setLoaded(true);
+                            listener.tileLoadingFinished(tile, false);
+                        }
+                    }
+                }
+                @Override
+                public Tile getTile() {
+                    return tile;
+                }
+            };
+            JobDispatcher.getInstance().addJob(job);
+        }
+
+        protected boolean loadOrUpdateTile() {
             try {
                 URLConnection urlConn = loadTileFromOsm(tile);
-                if (tileFile != null) {
+                if (fileAge != null) {
                     switch (tile.getSource().getTileUpdate()) {
                     case IfModifiedSince:
@@ -187 +200 @@
                     case LastModified:
                         if (!isOsmTileNewer(fileAge)) {
-                            log.finest("LastModified test: local version is up to date: " + tile);
-                            tile.setLoaded(true);
-                            tileFile.setLastModified(System.currentTimeMillis() - maxCacheFileAge + recheckAfter);
-                            return;
+                            log.log(Level.FINEST, "TMS - LastModified test: local version is up to date: {0}", tile);
+                            tileFile.setLastModified(System.currentTimeMillis());
+                            return true;
                         }
                         break;
@@ -204 +216 @@
                         case ETag:
                             if (hasOsmTileETag(fileETag)) {
-                                tile.setLoaded(true);
-                                tileFile.setLastModified(System.currentTimeMillis() - maxCacheFileAge
-                                        + recheckAfter);
-                                return;
+                                log.log(Level.FINEST, "TMS - ETag test: local version is up to date: {0}", tile);
+                                tileFile.setLastModified(System.currentTimeMillis());
+                                return true;
                             }
                         }
@@ -216 +227 @@
                     // If we are isModifiedSince or If-None-Match has been set
                     // and the server answers with a HTTP 304 = "Not Modified"
-                    log.finest("ETag test: local version is up to date: " + tile);
-                    tile.setLoaded(true);
-                    tileFile.setLastModified(System.currentTimeMillis() - maxCacheFileAge + recheckAfter);
-                    return;
+                    switch (tile.getSource().getTileUpdate()) {
+                    case IfModifiedSince:
+                        log.log(Level.FINEST, "TMS - IfModifiedSince test: local version is up to date: {0}", tile);
+                        break;
+                    case IfNoneMatch:
+                        log.log(Level.FINEST, "TMS - IfNoneMatch test: local version is up to date: {0}", tile);
+                        break;
+                    }
+                    if (loadTileFromFile(maxCacheFileAge)) {
+                        tileFile.setLastModified(System.currentTimeMillis());
+                        return true;
+                    }
                 }
 
@@ -227 +246 @@
                 if ("no-tile".equals(tile.getValue("tile-info")))
                 {
+                    log.log(Level.FINEST, "TMS - No tile: tile-info=no-tile: {0}", tile);
                     tile.setError("No tile at this zoom level");
-                    listener.tileLoadingFinished(tile, true);
+                    return true;
                 } else {
-                    for(int i = 0; i < 5; ++i) {
+                    for (int i = 0; i < 5; ++i) {
                         if (urlConn instanceof HttpURLConnection && ((HttpURLConnection)urlConn).getResponseCode() == 503) {
                             Thread.sleep(5000+(new Random()).nextInt(5000));
@@ -238 +258 @@
                         if (buffer != null) {
                             tile.loadImage(new ByteArrayInputStream(buffer));
-                            tile.setLoaded(true);
-                            listener.tileLoadingFinished(tile, true);
                             saveTileToFile(buffer);
-                            break;
+                            log.log(Level.FINEST, "TMS - downloaded tile from server: {0}", tile.getUrl());
+                            return true;
                         }
                     }
@@ -247 +266 @@
             } catch (Exception e) {
                 tile.setError(e.getMessage());
-                listener.tileLoadingFinished(tile, false);
                 if (input == null) {
                     try {
-                        System.err.println("Failed loading " + tile.getUrl() +": " + e.getMessage());
+                        log.log(Level.WARNING, "TMS - Failed downloading {0}: {1}", new Object[]{tile.getUrl(), e.getMessage()});
+                        return false;
                     } catch(IOException i) {
                     }
                 }
-            } finally {
-                tile.loading = false;
-                tile.setLoaded(true);
-            }
-        }
-
-        protected boolean loadTileFromFile() {
+            }
+            log.log(Level.WARNING, "TMS - Failed downloading tile: {0}", tile);
+            return false;
+        }
+
+        protected boolean loadTileFromFile(long maxAge) {
             try {
                 tileFile = getTileFile();
                 if (!tileFile.exists())
                     return false;
-
                 loadTagsFromFile();
+
+                fileAge = tileFile.lastModified();
+                if (System.currentTimeMillis() - fileAge > maxAge)
+                    return false;
+
                 if ("no-tile".equals(tile.getValue("tile-info"))) {
                     tile.setError("No tile at this zoom level");
@@ -272 +294 @@
                         tileFile.delete();
                     }
-                    tileFile = getTagsFile();
+                    tileFile = null;
                 } else {
                     try (FileInputStream fin = new FileInputStream(tileFile)) {
@@ -280 +302 @@
                     }
                 }
-
-                fileAge = tileFile.lastModified();
-                boolean oldTile = System.currentTimeMillis() - fileAge > maxCacheFileAge;
-                if (!oldTile) {
-                    tile.setLoaded(true);
-                    listener.tileLoadingFinished(tile, true);
-                    fileTilePainted = true;
-                    return true;
-                }
-                listener.tileLoadingFinished(tile, true);
-                fileTilePainted = true;
+                return true;
+
             } catch (Exception e) {
+                log.log(Level.WARNING, "TMS - Error while loading image from tile cache: {0}; {1}", new Object[]{e.getMessage(), tile});
                 tileFile.delete();
                 tileFile = null;
-                fileAge = 0;
+                fileAge = null;
             }
             return false;

applications/viewer/jmapviewer/src/org/openstreetmap/gui/jmapviewer/tilesources/TMSTileSource.java

@@ -28 +28 @@
     }
 
+    @Override
     public TileUpdate getTileUpdate() {
         return TileUpdate.IfNoneMatch;