Ticket #10454: mapbox_no_tiles_handling.patch

src/org/openstreetmap/gui/jmapviewer/Tile.java

@@ -331 +331 @@
         loading = false;
         loaded = true;
     }
+
+    /**
+     *
+     * @return TileSource from which this tile comes
+     */
+    public TileSource getTileSource() {
+        return source;
+    }
 }

src/org/openstreetmap/gui/jmapviewer/interfaces/TileSource.java

@@ -2 +2 @@
 package org.openstreetmap.gui.jmapviewer.interfaces;
 
 import java.io.IOException;
+import java.util.List;
+import java.util.Map;
 
 import org.openstreetmap.gui.jmapviewer.JMapViewer;
 
@@ -155 +157 @@
      * @return [MIN_LAT..MAX_LAT]
      */
     double tileYToLat(int y, int zoom);
+
+    /**
+     * Determines, if the returned data from TileSource represent "no tile at this zoom level" situation. Detection
+     * algorithms differ per TileSource, so each TileSource should implement each own specific way.
+     *
+     * @param headers HTTP headers from response from TileSource server
+     * @param statusCode HTTP status code
+     * @param content byte array representing the data returned from the server
+     * @return true, if "no tile at this zoom level" situation detected
+     */
+    public boolean isNoTileAtZoom(Map<String, List<String>> headers, int statusCode, byte[] content);
 }

src/org/openstreetmap/gui/jmapviewer/tilesources/AbstractTileSource.java

@@ -2 +2 @@
 package org.openstreetmap.gui.jmapviewer.tilesources;
 
 import java.awt.Image;
+import java.util.List;
+import java.util.Map;
 
-import org.openstreetmap.gui.jmapviewer.interfaces.TileSource;
 import org.openstreetmap.gui.jmapviewer.Coordinate;
+import org.openstreetmap.gui.jmapviewer.interfaces.TileSource;
 
 abstract public class AbstractTileSource implements TileSource {
 
@@ -74 +76 @@
         this.termsOfUseURL = termsOfUseURL;
     }
 
+    public boolean isNoTileAtZoom(Map<String, List<String>> headers, int statusCode, byte[] content) {
+        // default handler - when HTTP 404 is returned, then treat this situation as no tile at this zoom level
+        return statusCode == 404;
+    }
 }

src/org/openstreetmap/gui/jmapviewer/tilesources/BingAerialTileSource.java

@@ -9 +9 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
+import java.util.Map;
 import java.util.concurrent.Callable;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Executors;
@@ -302 +303 @@
         }
         return k.toString();
     }
+
+    @Override
+    public boolean isNoTileAtZoom(Map<String, List<String>> headers, int statusCode, byte[] content) {
+        List<String> headerValues = headers.get("X-VE-Tile-Info");
+        if (headerValues != null && headerValues.contains("no-tile")) {
+            return true;
+        }
+        return false;
+    }
 }

src/org/openstreetmap/josm/actions/AddImageryLayerAction.java

@@ -9 +9 @@
 import java.awt.event.ActionEvent;
 import java.io.IOException;
 import java.net.MalformedURLException;
+import java.util.Arrays;
 
 import javax.swing.JComboBox;
 import javax.swing.JOptionPane;
@@ -149 +150 @@
         // never enable blacklisted entries. Do not add same imagery layer twice (fix #2519)
         if (info.isBlacklisted() /*|| isLayerAlreadyPresent()*/) { // FIXME check disabled to allow several instances with different settings (see #7981)
             setEnabled(false);
-        } else if (info.getImageryType() == ImageryType.TMS || info.getImageryType() == ImageryType.BING || info.getImageryType() == ImageryType.SCANEX) {
+        } else if (Arrays.asList(
+                ImageryType.BING,
+                ImageryType.MAPBOX,
+                ImageryType.SCANEX,
+                ImageryType.TMS).contains(info.getImageryType())) {
             setEnabled(true);
         } else if (Main.isDisplayingMapView() && !Main.map.mapView.getAllLayers().isEmpty()) {
             setEnabled(true);

src/org/openstreetmap/josm/data/cache/JCSCachedTileLoaderJob.java

@@ -9 +9 @@
 import java.net.URL;
 import java.net.URLConnection;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Random;
 import java.util.Set;
@@ -223 +224 @@
      *
      * @return cache object as empty, regardless of what remote resource has returned (ex. based on headers)
      */
-    protected boolean cacheAsEmpty() {
+    protected boolean cacheAsEmpty(Map<String, List<String>> headers, int statusCode, byte[] content) {
         return false;
     }
 
@@ -328 +329 @@
                 log.log(Level.FINE, "JCS - cache entry verified using HEAD request: {0}", getUrl());
                 return true;
             }
-            URLConnection urlConn = getURLConnection();
+            HttpURLConnection urlConn = getURLConnection();
 
             if (isObjectLoadable()  &&
                     (now - attributes.getLastModification()) <= ABSOLUTE_EXPIRE_TIME_LIMIT) {
@@ -337 +338 @@
             if (isObjectLoadable() && attributes.getEtag() != null) {
                 urlConn.addRequestProperty("If-None-Match", attributes.getEtag());
             }
-            if (urlConn instanceof HttpURLConnection && ((HttpURLConnection)urlConn).getResponseCode() == 304) {
+            if (urlConn.getResponseCode() == 304) {
                 // If isModifiedSince or If-None-Match has been set
                 // and the server answers with a HTTP 304 = "Not Modified"
                 log.log(Level.FINE, "JCS - IfModifiedSince/Etag test: local version is up to date: {0}", getUrl());
@@ -358 +359 @@
             attributes = parseHeaders(urlConn);
 
             for (int i = 0; i < 5; ++i) {
-                if (urlConn instanceof HttpURLConnection && ((HttpURLConnection)urlConn).getResponseCode() == 503) {
+                if (urlConn.getResponseCode() == 503) {
                     Thread.sleep(5000+(new Random()).nextInt(5000));
                     continue;
                 }
                 byte[] raw = read(urlConn);
 
-                if (!cacheAsEmpty() && raw != null && raw.length > 0) {
+                if (!cacheAsEmpty(urlConn.getHeaderFields(), urlConn.getResponseCode(), raw) &&
+                        raw != null && raw.length > 0) {
                     cacheData = createCacheEntry(raw);
                     cache.put(getCacheKey(), cacheData, attributes);
                     log.log(Level.FINE, "JCS - downloaded key: {0}, length: {1}, url: {2}",
@@ -399 +401 @@
 
     private CacheEntryAttributes parseHeaders(URLConnection urlConn) {
         CacheEntryAttributes ret = new CacheEntryAttributes();
-        ret.setNoTileAtZoom("no-tile".equals(urlConn.getHeaderField("X-VE-Tile-Info")));
 
         Long lng = urlConn.getExpiration();
         if (lng.equals(0L)) {

src/org/openstreetmap/josm/data/imagery/ImageryInfo.java

@@ -51 +51 @@
         /** TMS entry for Russian company <a href="https://wiki.openstreetmap.org/wiki/WikiProject_Russia/kosmosnimki">ScanEx</a>. **/
         SCANEX("scanex"),
         /** A WMS endpoint entry only stores the WMS server info, without layer, which are chosen later by the user. **/
-        WMS_ENDPOINT("wms_endpoint");
+        WMS_ENDPOINT("wms_endpoint"),
+        /** TMS entry for Mapbox, so we can have different TileSource class for them*/
+        MAPBOX("mapbox");
+
 
         private final String typeString;
 

src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoaderJob.java

@@ -4 +4 @@
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.net.URL;
+import java.util.List;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
@@ -193 +194 @@
         if (cacheData != null) {
             byte[] content = cacheData.getContent();
             try {
-                return content != null  || cacheData.getImage() != null || cacheAsEmpty();
+                return content != null  || cacheData.getImage() != null || isNoTileAtZoom();
             } catch (IOException e) {
                 log.log(Level.WARNING, "JCS TMS - error loading from cache for tile {0}: {1}", new Object[] {tile.getKey(), e.getMessage()});
             }
@@ -206 +207 @@
     }
 
     @Override
-    protected boolean cacheAsEmpty() {
-        return isNoTileAtZoom();
+    protected boolean cacheAsEmpty(Map<String, List<String>> headers, int statusCode, byte[] content) {
+        if (tile.getTileSource().isNoTileAtZoom(headers, statusCode, content)) {
+            attributes.setNoTileAtZoom(true);
+            return true;
+        }
+        return false;
     }
 
     private boolean handleNoTileAtZoom() {
@@ -315 +320 @@
 
     @Override
     protected boolean handleNotFound() {
+        if (tile.getSource().isNoTileAtZoom(null, 404, null)) {
             tile.setError("No tile at this zoom level");
             tile.putValue("tile-info", "no-tile");
             return true;
         }
+        return false;
+    }
 
     /**
      * For TMS use BaseURL as settings discovery, so for different paths, we will have different settings (useful for developer servers)

src/org/openstreetmap/josm/gui/layer/ImageryLayer.java

@@ -21 +21 @@
 import java.awt.image.Kernel;
 import java.text.AttributedCharacterIterator;
 import java.text.AttributedString;
+import java.util.Arrays;
 import java.util.Hashtable;
 import java.util.List;
 import java.util.Map;
@@ -152 +153 @@
     public static ImageryLayer create(ImageryInfo info) {
         if (info.getImageryType() == ImageryType.WMS || info.getImageryType() == ImageryType.HTML)
             return new WMSLayer(info);
-        else if (info.getImageryType() == ImageryType.TMS || info.getImageryType() == ImageryType.BING || info.getImageryType() == ImageryType.SCANEX)
+        else if (Arrays.asList(
+                ImageryType.BING,
+                ImageryType.MAPBOX,
+                ImageryType.SCANEX,
+                ImageryType.TMS).contains(info.getImageryType()))
             return new TMSLayer(info);
         else throw new AssertionError();
     }

src/org/openstreetmap/josm/gui/layer/TMSLayer.java

@@ -48 +48 @@
 import org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener;
 import org.openstreetmap.gui.jmapviewer.interfaces.TileSource;
 import org.openstreetmap.gui.jmapviewer.tilesources.BingAerialTileSource;
+import org.openstreetmap.gui.jmapviewer.tilesources.MapboxTileSource;
 import org.openstreetmap.gui.jmapviewer.tilesources.ScanexTileSource;
 import org.openstreetmap.gui.jmapviewer.tilesources.TMSTileSource;
 import org.openstreetmap.gui.jmapviewer.tilesources.TemplatedTMSTileSource;
@@ -340 +341 @@
                     info.getCookies());
             info.setAttribution(t);
             return t;
-        } else if (info.getImageryType() == ImageryType.BING)
+        } else if (info.getImageryType() == ImageryType.BING) {
             return new CachedAttributionBingAerialTileSource(info.getId());
-        else if (info.getImageryType() == ImageryType.SCANEX) {
+        } else if (info.getImageryType() == ImageryType.SCANEX) {
             return new ScanexTileSource(info.getName(), info.getUrl(), info.getId(), info.getMaxZoom());
+        } else if (info.getImageryType() == ImageryType.MAPBOX) {
+            return new MapboxTileSource(info.getName(), info.getUrl(), info.getId(), info.getMaxZoom());
         }
         return null;
     }