// License: GPL. For details, see LICENSE file. package org.openstreetmap.josm.gui.layer; import static org.openstreetmap.josm.tools.I18n.tr; import java.awt.Color; import java.awt.Font; import java.awt.Graphics; import java.awt.Graphics2D; import java.awt.GridBagLayout; import java.awt.Image; import java.awt.Point; import java.awt.Rectangle; import java.awt.Toolkit; import java.awt.event.ActionEvent; import java.awt.event.MouseAdapter; import java.awt.event.MouseEvent; import java.awt.image.ImageObserver; import java.io.File; import java.io.IOException; import java.io.StringReader; import java.net.URL; import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Collections; import java.util.Comparator; import java.util.Date; import java.util.HashMap; import java.util.LinkedList; import java.util.List; import java.util.Map; import java.util.Map.Entry; import java.util.Scanner; import java.util.concurrent.Callable; import java.util.regex.Matcher; import java.util.regex.Pattern; import javax.swing.AbstractAction; import javax.swing.Action; import javax.swing.BorderFactory; import javax.swing.JCheckBoxMenuItem; import javax.swing.JLabel; import javax.swing.JMenuItem; import javax.swing.JOptionPane; import javax.swing.JPanel; import javax.swing.JPopupMenu; import javax.swing.JTextField; import org.openstreetmap.gui.jmapviewer.AttributionSupport; import org.openstreetmap.gui.jmapviewer.Coordinate; import org.openstreetmap.gui.jmapviewer.MemoryTileCache; import org.openstreetmap.gui.jmapviewer.OsmTileLoader; import org.openstreetmap.gui.jmapviewer.Tile; import org.openstreetmap.gui.jmapviewer.interfaces.CachedTileLoader; import org.openstreetmap.gui.jmapviewer.interfaces.TileCache; import org.openstreetmap.gui.jmapviewer.interfaces.TileLoader; 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.ScanexTileSource; import org.openstreetmap.gui.jmapviewer.tilesources.TMSTileSource; import org.openstreetmap.gui.jmapviewer.tilesources.TemplatedTMSTileSource; import org.openstreetmap.josm.Main; import org.openstreetmap.josm.actions.RenameLayerAction; import org.openstreetmap.josm.data.Bounds; import org.openstreetmap.josm.data.Version; import org.openstreetmap.josm.data.coor.EastNorth; import org.openstreetmap.josm.data.coor.LatLon; import org.openstreetmap.josm.data.imagery.ImageryInfo; import org.openstreetmap.josm.data.imagery.ImageryInfo.ImageryType; import org.openstreetmap.josm.data.imagery.TMSCachedTileLoader; import org.openstreetmap.josm.data.osm.visitor.BoundingXYVisitor; import org.openstreetmap.josm.data.preferences.BooleanProperty; import org.openstreetmap.josm.data.preferences.IntegerProperty; import org.openstreetmap.josm.data.preferences.StringProperty; import org.openstreetmap.josm.data.projection.Projection; import org.openstreetmap.josm.gui.ExtendedDialog; import org.openstreetmap.josm.gui.MapFrame; import org.openstreetmap.josm.gui.MapView; import org.openstreetmap.josm.gui.MapView.LayerChangeListener; import org.openstreetmap.josm.gui.NavigatableComponent.ZoomChangeListener; import org.openstreetmap.josm.gui.PleaseWaitRunnable; import org.openstreetmap.josm.gui.dialogs.LayerListDialog; import org.openstreetmap.josm.gui.dialogs.LayerListPopup; import org.openstreetmap.josm.gui.progress.ProgressMonitor; import org.openstreetmap.josm.io.CacheCustomContent; import org.openstreetmap.josm.io.OsmTransferException; import org.openstreetmap.josm.io.UTFInputStreamReader; import org.openstreetmap.josm.tools.CheckParameterUtil; import org.openstreetmap.josm.tools.GBC; import org.openstreetmap.josm.tools.Utils; import org.xml.sax.InputSource; import org.xml.sax.SAXException; /** * Class that displays a slippy map layer. * * @author Frederik Ramm * @author LuVar <lubomir.varga@freemap.sk> * @author Dave Hansen <dave@sr71.net> * @author Upliner <upliner@gmail.com> * */ public class TMSLayer extends ImageryLayer implements ImageObserver, TileLoaderListener, ZoomChangeListener { public static final String PREFERENCE_PREFIX = "imagery.tms"; public static final int MAX_ZOOM = 30; public static final int MIN_ZOOM = 2; public static final int DEFAULT_MAX_ZOOM = 20; public static final int DEFAULT_MIN_ZOOM = 2; public static final BooleanProperty PROP_DEFAULT_AUTOZOOM = new BooleanProperty(PREFERENCE_PREFIX + ".default_autozoom", true); public static final BooleanProperty PROP_DEFAULT_AUTOLOAD = new BooleanProperty(PREFERENCE_PREFIX + ".default_autoload", true); public static final BooleanProperty PROP_DEFAULT_SHOWERRORS = new BooleanProperty(PREFERENCE_PREFIX + ".default_showerrors", true); public static final IntegerProperty PROP_MIN_ZOOM_LVL = new IntegerProperty(PREFERENCE_PREFIX + ".min_zoom_lvl", DEFAULT_MIN_ZOOM); public static final IntegerProperty PROP_MAX_ZOOM_LVL = new IntegerProperty(PREFERENCE_PREFIX + ".max_zoom_lvl", DEFAULT_MAX_ZOOM); public static final BooleanProperty PROP_ADD_TO_SLIPPYMAP_CHOOSER = new BooleanProperty(PREFERENCE_PREFIX + ".add_to_slippymap_chooser", true); public static final StringProperty PROP_TILECACHE_DIR; static { String defPath = null; try { defPath = new File(Main.pref.getCacheDirectory(), "tms").getAbsolutePath(); } catch (SecurityException e) { Main.warn(e); } PROP_TILECACHE_DIR = new StringProperty(PREFERENCE_PREFIX + ".tilecache", defPath); } private final class ShowTileInfoAction extends AbstractAction { private ShowTileInfoAction() { super(tr("Show Tile Info")); } private String getSizeString(int size) { return new StringBuilder().append(size).append("x").append(size).toString(); } private JTextField createTextField(String text) { JTextField ret = new JTextField(text); ret.setEditable(false); ret.setBorder(BorderFactory.createEmptyBorder()); return ret; } @Override public void actionPerformed(ActionEvent ae) { if (clickedTile != null) { ExtendedDialog ed = new ExtendedDialog(Main.parent, tr("Tile Info"), new String[]{tr("OK")}); JPanel panel = new JPanel(new GridBagLayout()); Rectangle displaySize = tileToRect(clickedTile); String url = ""; try { url = clickedTile.getUrl(); } catch (IOException e) { // silence exceptions } String[][] content = { {"Tile name", clickedTile.getKey()}, {"Tile url", url}, {"Tile size", getSizeString(clickedTile.getTileSource().getTileSize()) }, {"Tile display size", new StringBuilder().append(displaySize.width).append("x").append(displaySize.height).toString()}, }; for (String[] entry: content) { panel.add(new JLabel(tr(entry[0]) + ":"), GBC.std()); panel.add(GBC.glue(5, 0), GBC.std()); panel.add(createTextField(entry[1]), GBC.eol().fill(GBC.HORIZONTAL)); } for (Entry e: clickedTile.getMetadata().entrySet()) { panel.add(new JLabel(tr("Metadata ") + tr(e.getKey()) + ":"), GBC.std()); panel.add(GBC.glue(5, 0), GBC.std()); String value = e.getValue(); if ("lastModification".equals(e.getKey()) || "expirationTime".equals(e.getKey())) { value = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date(Long.parseLong(value))); } panel.add(createTextField(value), GBC.eol().fill(GBC.HORIZONTAL)); } ed.setIcon(JOptionPane.INFORMATION_MESSAGE); ed.setContent(panel); ed.showDialog(); } } } /** * Interface for creating TileLoaders, ie. classes responsible for loading tiles on map * */ public interface TileLoaderFactory { /** * @param listener object that will be notified, when tile has finished loading * @return TileLoader that will notify the listener */ TileLoader makeTileLoader(TileLoaderListener listener); /** * @param listener object that will be notified, when tile has finished loading * @param headers HTTP headers that should be sent by TileLoader to tile server * @return TileLoader that will notify the listener */ TileLoader makeTileLoader(TileLoaderListener listener, Map headers); } protected TileCache tileCache; protected TileSource tileSource; protected TileLoader tileLoader; public static TileLoaderFactory loaderFactory = new TileLoaderFactory() { @Override public TileLoader makeTileLoader(TileLoaderListener listener, Map inputHeaders) { Map headers = new HashMap<>(); headers.put("User-Agent", Version.getInstance().getFullAgentString()); headers.put("Accept", "text/html, image/png, image/jpeg, image/gif, */*"); if (inputHeaders != null) headers.putAll(inputHeaders); try { return new TMSCachedTileLoader(listener, "TMS", Main.pref.getInteger("socket.timeout.connect", 15) * 1000, Main.pref.getInteger("socket.timeout.read", 30) * 1000, headers, PROP_TILECACHE_DIR.get()); } catch (IOException e) { Main.warn(e); } return null; } @Override public TileLoader makeTileLoader(TileLoaderListener listener) { return makeTileLoader(listener, null); } }; /** * Plugins that wish to set custom tile loader should call this method */ public static void setCustomTileLoaderFactory(TileLoaderFactory loaderFactory) { TMSLayer.loaderFactory = loaderFactory; } @Override public synchronized void tileLoadingFinished(Tile tile, boolean success) { if (tile.hasError()) { success = false; tile.setImage(null); } if (sharpenLevel != 0 && success) { tile.setImage(sharpenImage(tile.getImage())); } tile.setLoaded(success); needRedraw = true; if (Main.map != null) { Main.map.repaint(100); } if (Main.isDebugEnabled()) { Main.debug("tileLoadingFinished() tile: " + tile + " success: " + success); } } /** * Clears the tile cache. * * If the current tileLoader is an instance of OsmTileLoader, a new * TmsTileClearController is created and passed to the according clearCache * method. * * @param monitor not used in this implementation - as cache clear is instaneus */ public void clearTileCache(ProgressMonitor monitor) { tileCache.clear(); if (tileLoader instanceof CachedTileLoader) { ((CachedTileLoader) tileLoader).clearCache(tileSource); } redraw(); } /** * Zoomlevel at which tiles is currently downloaded. * Initial zoom lvl is set to bestZoom */ public int currentZoomLevel; private Tile clickedTile; private boolean needRedraw; private JPopupMenu tileOptionMenu; private Tile showMetadataTile; private AttributionSupport attribution = new AttributionSupport(); private static final Font InfoFont = new Font("sansserif", Font.BOLD, 13); protected boolean autoZoom; protected boolean autoLoad; protected boolean showErrors; /** * Initiates a repaint of Main.map * * @see Main#map * @see MapFrame#repaint() */ protected void redraw() { needRedraw = true; Main.map.repaint(); } protected static int checkMaxZoomLvl(int maxZoomLvl, TileSource ts) { if (maxZoomLvl > MAX_ZOOM) { maxZoomLvl = MAX_ZOOM; } if (maxZoomLvl < PROP_MIN_ZOOM_LVL.get()) { maxZoomLvl = PROP_MIN_ZOOM_LVL.get(); } if (ts != null && ts.getMaxZoom() != 0 && ts.getMaxZoom() < maxZoomLvl) { maxZoomLvl = ts.getMaxZoom(); } return maxZoomLvl; } public static int getMaxZoomLvl(TileSource ts) { return checkMaxZoomLvl(PROP_MAX_ZOOM_LVL.get(), ts); } public static void setMaxZoomLvl(int maxZoomLvl) { Integer newMaxZoom = Integer.valueOf(checkMaxZoomLvl(maxZoomLvl, null)); PROP_MAX_ZOOM_LVL.put(newMaxZoom); } static int checkMinZoomLvl(int minZoomLvl, TileSource ts) { if (minZoomLvl < MIN_ZOOM) { /*Main.debug("Min. zoom level should not be less than "+MIN_ZOOM+"! Setting to that.");*/ minZoomLvl = MIN_ZOOM; } if (minZoomLvl > PROP_MAX_ZOOM_LVL.get()) { /*Main.debug("Min. zoom level should not be more than Max. zoom level! Setting to Max.");*/ minZoomLvl = getMaxZoomLvl(ts); } if (ts != null && ts.getMinZoom() > minZoomLvl) { /*Main.debug("Increasing min. zoom level to match tile source");*/ minZoomLvl = ts.getMinZoom(); } return minZoomLvl; } public static int getMinZoomLvl(TileSource ts) { return checkMinZoomLvl(PROP_MIN_ZOOM_LVL.get(), ts); } public static void setMinZoomLvl(int minZoomLvl) { minZoomLvl = checkMinZoomLvl(minZoomLvl, null); PROP_MIN_ZOOM_LVL.put(minZoomLvl); } private static class CachedAttributionBingAerialTileSource extends BingAerialTileSource { public CachedAttributionBingAerialTileSource(ImageryInfo info) { super(info); } class BingAttributionData extends CacheCustomContent { public BingAttributionData() { super("bing.attribution.xml", CacheCustomContent.INTERVAL_HOURLY); } @Override protected byte[] updateData() throws IOException { URL u = getAttributionUrl(); try (Scanner scanner = new Scanner(UTFInputStreamReader.create(Utils.openURL(u)))) { String r = scanner.useDelimiter("\\A").next(); Main.info("Successfully loaded Bing attribution data."); return r.getBytes("UTF-8"); } } } @Override protected Callable> getAttributionLoaderCallable() { return new Callable>() { @Override public List call() throws Exception { BingAttributionData attributionLoader = new BingAttributionData(); int waitTimeSec = 1; while (true) { try { String xml = attributionLoader.updateIfRequiredString(); return parseAttributionText(new InputSource(new StringReader(xml))); } catch (IOException ex) { Main.warn("Could not connect to Bing API. Will retry in " + waitTimeSec + " seconds."); Thread.sleep(waitTimeSec * 1000L); waitTimeSec *= 2; } } } }; } } /** * Creates and returns a new TileSource instance depending on the {@link ImageryType} * of the passed ImageryInfo object. * * If no appropriate TileSource is found, null is returned. * Currently supported ImageryType are {@link ImageryType#TMS}, * {@link ImageryType#BING}, {@link ImageryType#SCANEX}. * * @param info imagery info * @return a new TileSource instance or null if no TileSource for the ImageryInfo/ImageryType could be found. * @throws IllegalArgumentException if url from imagery info is null or invalid */ public static TileSource getTileSource(ImageryInfo info) { if (info.getImageryType() == ImageryType.TMS) { checkUrl(info.getUrl()); TMSTileSource t = new TemplatedTMSTileSource(info); info.setAttribution(t); return t; } else if (info.getImageryType() == ImageryType.BING) { return new CachedAttributionBingAerialTileSource(info); } else if (info.getImageryType() == ImageryType.SCANEX) { return new ScanexTileSource(info); } return null; } /** * Checks validity of given URL. * @param url URL to check * @throws IllegalArgumentException if url is null or invalid */ public static void checkUrl(String url) { CheckParameterUtil.ensureParameterNotNull(url, "url"); Matcher m = Pattern.compile("\\{[^}]*\\}").matcher(url); while (m.find()) { boolean isSupportedPattern = false; for (String pattern : TemplatedTMSTileSource.ALL_PATTERNS) { if (m.group().matches(pattern)) { isSupportedPattern = true; break; } } if (!isSupportedPattern) { throw new IllegalArgumentException( tr("{0} is not a valid TMS argument. Please check this server URL:\n{1}", m.group(), url)); } } } private void initTileSource(TileSource tileSource) { this.tileSource = tileSource; attribution.initialize(tileSource); currentZoomLevel = getBestZoom(); Map headers = null; if (tileSource instanceof TemplatedTMSTileSource) { headers = (((TemplatedTMSTileSource) tileSource).getHeaders()); } tileLoader = loaderFactory.makeTileLoader(this, headers); if (tileLoader instanceof TMSCachedTileLoader) { tileCache = (TileCache) tileLoader; } else { tileCache = new MemoryTileCache(); } if (tileLoader == null) tileLoader = new OsmTileLoader(this); } /** * Marks layer as needing redraw on offset change */ @Override public void setOffset(double dx, double dy) { super.setOffset(dx, dy); needRedraw = true; } /** * Returns average number of screen pixels per tile pixel for current mapview */ private double getScaleFactor(int zoom) { if (!Main.isDisplayingMapView()) return 1; MapView mv = Main.map.mapView; LatLon topLeft = mv.getLatLon(0, 0); LatLon botRight = mv.getLatLon(mv.getWidth(), mv.getHeight()); double x1 = tileSource.lonToTileX(topLeft.lon(), zoom); double y1 = tileSource.latToTileY(topLeft.lat(), zoom); double x2 = tileSource.lonToTileX(botRight.lon(), zoom); double y2 = tileSource.latToTileY(botRight.lat(), zoom); int screenPixels = mv.getWidth()*mv.getHeight(); double tilePixels = Math.abs((y2-y1)*(x2-x1)*tileSource.getTileSize()*tileSource.getTileSize()); if (screenPixels == 0 || tilePixels == 0) return 1; return screenPixels/tilePixels; } private final int getBestZoom() { double factor = getScaleFactor(1); // check the ratio between area of tilesize at zoom 1 to current view double result = Math.log(factor)/Math.log(2)/2+1; /* * Math.log(factor)/Math.log(2) - gives log base 2 of factor * We divide result by 2, as factor contains ratio between areas. We could do Math.sqrt before log, or just divide log by 2 * In general, smaller zoom levels are more readable. We prefer big, * block, pixelated (but readable) map text to small, smeared, * unreadable underzoomed text. So, use .floor() instead of rounding * to skew things a bit toward the lower zooms. * Remember, that result here, should correspond to TMSLayer.paint(...) * getScaleFactor(...) is supposed to be between 0.75 and 3 */ int intResult = (int) Math.floor(result); if (intResult > getMaxZoomLvl()) return getMaxZoomLvl(); if (intResult < getMinZoomLvl()) return getMinZoomLvl(); return intResult; } @SuppressWarnings("serial") public TMSLayer(ImageryInfo info) { super(info); if (!isProjectionSupported(Main.getProjection())) { JOptionPane.showMessageDialog(Main.parent, tr("TMS layers do not support the projection {0}.\n{1}\n" + "Change the projection or remove the layer.", Main.getProjection().toCode(), nameSupportedProjections()), tr("Warning"), JOptionPane.WARNING_MESSAGE); } setBackgroundLayer(true); this.setVisible(true); TileSource source = getTileSource(info); if (source == null) throw new IllegalStateException("Cannot create TMSLayer with non-TMS ImageryInfo"); initTileSource(source); MapView.addZoomChangeListener(this); } /** * Adds a context menu to the mapView. */ @Override public void hookUpMapView() { tileOptionMenu = new JPopupMenu(); autoZoom = PROP_DEFAULT_AUTOZOOM.get(); JCheckBoxMenuItem autoZoomPopup = new JCheckBoxMenuItem(); autoZoomPopup.setAction(new AbstractAction(tr("Auto Zoom")) { @Override public void actionPerformed(ActionEvent ae) { autoZoom = !autoZoom; } }); autoZoomPopup.setSelected(autoZoom); tileOptionMenu.add(autoZoomPopup); autoLoad = PROP_DEFAULT_AUTOLOAD.get(); JCheckBoxMenuItem autoLoadPopup = new JCheckBoxMenuItem(); autoLoadPopup.setAction(new AbstractAction(tr("Auto load tiles")) { @Override public void actionPerformed(ActionEvent ae) { autoLoad = !autoLoad; } }); autoLoadPopup.setSelected(autoLoad); tileOptionMenu.add(autoLoadPopup); showErrors = PROP_DEFAULT_SHOWERRORS.get(); JCheckBoxMenuItem showErrorsPopup = new JCheckBoxMenuItem(); showErrorsPopup.setAction(new AbstractAction(tr("Show Errors")) { @Override public void actionPerformed(ActionEvent ae) { showErrors = !showErrors; } }); showErrorsPopup.setSelected(showErrors); tileOptionMenu.add(showErrorsPopup); tileOptionMenu.add(new JMenuItem(new AbstractAction(tr("Load Tile")) { @Override public void actionPerformed(ActionEvent ae) { if (clickedTile != null) { loadTile(clickedTile, true); redraw(); } } })); tileOptionMenu.add(new JMenuItem(new ShowTileInfoAction())); tileOptionMenu.add(new JMenuItem(new AbstractAction( tr("Request Update")) { @Override public void actionPerformed(ActionEvent ae) { if (clickedTile != null) { clickedTile.setLoaded(false); tileLoader.createTileLoaderJob(clickedTile).submit(true); } } })); tileOptionMenu.add(new JMenuItem(new AbstractAction( tr("Load All Tiles")) { @Override public void actionPerformed(ActionEvent ae) { loadAllTiles(true); redraw(); } })); tileOptionMenu.add(new JMenuItem(new AbstractAction( tr("Load All Error Tiles")) { @Override public void actionPerformed(ActionEvent ae) { loadAllErrorTiles(true); redraw(); } })); // increase and decrease commands tileOptionMenu.add(new JMenuItem(new AbstractAction( tr("Increase zoom")) { @Override public void actionPerformed(ActionEvent ae) { increaseZoomLevel(); redraw(); } })); tileOptionMenu.add(new JMenuItem(new AbstractAction( tr("Decrease zoom")) { @Override public void actionPerformed(ActionEvent ae) { decreaseZoomLevel(); redraw(); } })); tileOptionMenu.add(new JMenuItem(new AbstractAction( tr("Snap to tile size")) { @Override public void actionPerformed(ActionEvent ae) { double newFactor = Math.sqrt(getScaleFactor(currentZoomLevel)); Main.map.mapView.zoomToFactor(newFactor); redraw(); } })); tileOptionMenu.add(new JMenuItem(new AbstractAction( tr("Flush Tile Cache")) { @Override public void actionPerformed(ActionEvent ae) { new PleaseWaitRunnable(tr("Flush Tile Cache")) { @Override protected void realRun() throws SAXException, IOException, OsmTransferException { clearTileCache(getProgressMonitor()); } @Override protected void finish() { } @Override protected void cancel() { } }.run(); } })); final MouseAdapter adapter = new MouseAdapter() { @Override public void mouseClicked(MouseEvent e) { if (!isVisible()) return; if (e.getButton() == MouseEvent.BUTTON3) { clickedTile = getTileForPixelpos(e.getX(), e.getY()); tileOptionMenu.show(e.getComponent(), e.getX(), e.getY()); } else if (e.getButton() == MouseEvent.BUTTON1) { attribution.handleAttribution(e.getPoint(), true); } } }; Main.map.mapView.addMouseListener(adapter); MapView.addLayerChangeListener(new LayerChangeListener() { @Override public void activeLayerChange(Layer oldLayer, Layer newLayer) { // } @Override public void layerAdded(Layer newLayer) { // } @Override public void layerRemoved(Layer oldLayer) { if (oldLayer == TMSLayer.this) { Main.map.mapView.removeMouseListener(adapter); MapView.removeZoomChangeListener(TMSLayer.this); MapView.removeLayerChangeListener(this); } } }); } /** * This fires every time the user changes the zoom, but also (due to ZoomChangeListener) - on all * changes to visible map (panning/zooming) */ @Override public void zoomChanged() { if (Main.isDebugEnabled()) { Main.debug("zoomChanged(): " + currentZoomLevel); } needRedraw = true; if (tileLoader instanceof TMSCachedTileLoader) { ((TMSCachedTileLoader) tileLoader).cancelOutstandingTasks(); } } protected int getMaxZoomLvl() { if (info.getMaxZoom() != 0) return checkMaxZoomLvl(info.getMaxZoom(), tileSource); else return getMaxZoomLvl(tileSource); } protected int getMinZoomLvl() { return getMinZoomLvl(tileSource); } /** * Zoom in, go closer to map. * * @return true, if zoom increasing was successful, false otherwise */ public boolean zoomIncreaseAllowed() { boolean zia = currentZoomLevel < this.getMaxZoomLvl(); if (Main.isDebugEnabled()) { Main.debug("zoomIncreaseAllowed(): " + zia + " " + currentZoomLevel + " vs. " + this.getMaxZoomLvl()); } return zia; } public boolean increaseZoomLevel() { if (zoomIncreaseAllowed()) { currentZoomLevel++; if (Main.isDebugEnabled()) { Main.debug("increasing zoom level to: " + currentZoomLevel); } zoomChanged(); } else { Main.warn("Current zoom level ("+currentZoomLevel+") could not be increased. "+ "Max.zZoom Level "+this.getMaxZoomLvl()+" reached."); return false; } return true; } public boolean setZoomLevel(int zoom) { if (zoom == currentZoomLevel) return true; if (zoom > this.getMaxZoomLvl()) return false; if (zoom < this.getMinZoomLvl()) return false; currentZoomLevel = zoom; zoomChanged(); return true; } /** * Check if zooming out is allowed * * @return true, if zooming out is allowed (currentZoomLevel > minZoomLevel) */ public boolean zoomDecreaseAllowed() { return currentZoomLevel > this.getMinZoomLvl(); } /** * Zoom out from map. * * @return true, if zoom increasing was successfull, false othervise */ public boolean decreaseZoomLevel() { //int minZoom = this.getMinZoomLvl(); if (zoomDecreaseAllowed()) { if (Main.isDebugEnabled()) { Main.debug("decreasing zoom level to: " + currentZoomLevel); } currentZoomLevel--; zoomChanged(); } else { /*Main.debug("Current zoom level could not be decreased. Min. zoom level "+minZoom+" reached.");*/ return false; } return true; } /* * We use these for quick, hackish calculations. They * are temporary only and intentionally not inserted * into the tileCache. */ private Tile tempCornerTile(Tile t) { int x = t.getXtile() + 1; int y = t.getYtile() + 1; int zoom = t.getZoom(); Tile tile = getTile(x, y, zoom); if (tile != null) return tile; return new Tile(tileSource, x, y, zoom); } private Tile getOrCreateTile(int x, int y, int zoom) { Tile tile = getTile(x, y, zoom); if (tile == null) { tile = new Tile(tileSource, x, y, zoom); tileCache.addTile(tile); tile.loadPlaceholderFromCache(tileCache); } return tile; } /* * This can and will return null for tiles that are not * already in the cache. */ private Tile getTile(int x, int y, int zoom) { int max = 1 << zoom; if (x < 0 || x >= max || y < 0 || y >= max) return null; return tileCache.getTile(tileSource, x, y, zoom); } private boolean loadTile(Tile tile, boolean force) { if (tile == null) return false; if (!force && (tile.isLoaded() || tile.hasError())) return false; if (tile.isLoading()) return false; tileLoader.createTileLoaderJob(tile).submit(force); return true; } private void loadAllTiles(boolean force) { MapView mv = Main.map.mapView; EastNorth topLeft = mv.getEastNorth(0, 0); EastNorth botRight = mv.getEastNorth(mv.getWidth(), mv.getHeight()); TileSet ts = new TileSet(topLeft, botRight, currentZoomLevel); // if there is more than 18 tiles on screen in any direction, do not // load all tiles! if (ts.tooLarge()) { Main.warn("Not downloading all tiles because there is more than 18 tiles on an axis!"); return; } ts.loadAllTiles(force); } private void loadAllErrorTiles(boolean force) { MapView mv = Main.map.mapView; EastNorth topLeft = mv.getEastNorth(0, 0); EastNorth botRight = mv.getEastNorth(mv.getWidth(), mv.getHeight()); TileSet ts = new TileSet(topLeft, botRight, currentZoomLevel); ts.loadAllErrorTiles(force); } @Override public boolean imageUpdate(Image img, int infoflags, int x, int y, int width, int height) { boolean done = (infoflags & (ERROR | FRAMEBITS | ALLBITS)) != 0; needRedraw = true; if (Main.isDebugEnabled()) { Main.debug("imageUpdate() done: " + done + " calling repaint"); } Main.map.repaint(done ? 0 : 100); return !done; } private boolean imageLoaded(Image i) { if (i == null) return false; int status = Toolkit.getDefaultToolkit().checkImage(i, -1, -1, this); if ((status & ALLBITS) != 0) return true; return false; } /** * Returns the image for the given tile if both tile and image are loaded. * Otherwise returns null. * * @param tile the Tile for which the image should be returned * @return the image of the tile or null. */ private Image getLoadedTileImage(Tile tile) { if (!tile.isLoaded()) return null; Image img = tile.getImage(); if (!imageLoaded(img)) return null; return img; } private LatLon tileLatLon(Tile t) { int zoom = t.getZoom(); return new LatLon(tileSource.tileYToLat(t.getYtile(), zoom), tileSource.tileXToLon(t.getXtile(), zoom)); } private Rectangle tileToRect(Tile t1) { /* * We need to get a box in which to draw, so advance by one tile in * each direction to find the other corner of the box. * Note: this somewhat pollutes the tile cache */ Tile t2 = tempCornerTile(t1); Rectangle rect = new Rectangle(pixelPos(t1)); rect.add(pixelPos(t2)); return rect; } // 'source' is the pixel coordinates for the area that // the img is capable of filling in. However, we probably // only want a portion of it. // // 'border' is the screen cordinates that need to be drawn. // We must not draw outside of it. private void drawImageInside(Graphics g, Image sourceImg, Rectangle source, Rectangle border) { Rectangle target = source; // If a border is specified, only draw the intersection // if what we have combined with what we are supposed // to draw. if (border != null) { target = source.intersection(border); if (Main.isDebugEnabled()) { Main.debug("source: " + source + "\nborder: " + border + "\nintersection: " + target); } } // All of the rectangles are in screen coordinates. We need // to how these correlate to the sourceImg pixels. We could // avoid doing this by scaling the image up to the 'source' size, // but this should be cheaper. // // In some projections, x any y are scaled differently enough to // cause a pixel or two of fudge. Calculate them separately. double imageYScaling = sourceImg.getHeight(this) / source.getHeight(); double imageXScaling = sourceImg.getWidth(this) / source.getWidth(); // How many pixels into the 'source' rectangle are we drawing? int screen_x_offset = target.x - source.x; int screen_y_offset = target.y - source.y; // And how many pixels into the image itself does that // correlate to? int img_x_offset = (int) (screen_x_offset * imageXScaling + 0.5); int img_y_offset = (int) (screen_y_offset * imageYScaling + 0.5); // Now calculate the other corner of the image that we need // by scaling the 'target' rectangle's dimensions. int img_x_end = img_x_offset + (int) (target.getWidth() * imageXScaling + 0.5); int img_y_end = img_y_offset + (int) (target.getHeight() * imageYScaling + 0.5); if (Main.isDebugEnabled()) { Main.debug("drawing image into target rect: " + target); } g.drawImage(sourceImg, target.x, target.y, target.x + target.width, target.y + target.height, img_x_offset, img_y_offset, img_x_end, img_y_end, this); if (PROP_FADE_AMOUNT.get() != 0) { // dimm by painting opaque rect... g.setColor(getFadeColorWithAlpha()); g.fillRect(target.x, target.y, target.width, target.height); } } // This function is called for several zoom levels, not just // the current one. It should not trigger any tiles to be // downloaded. It should also avoid polluting the tile cache // with any tiles since these tiles are not mandatory. // // The "border" tile tells us the boundaries of where we may // draw. It will not be from the zoom level that is being // drawn currently. If drawing the displayZoomLevel, // border is null and we draw the entire tile set. private List paintTileImages(Graphics g, TileSet ts, int zoom, Tile border) { if (zoom <= 0) return Collections.emptyList(); Rectangle borderRect = null; if (border != null) { borderRect = tileToRect(border); } List missedTiles = new LinkedList<>(); // The callers of this code *require* that we return any tiles // that we do not draw in missedTiles. ts.allExistingTiles() by // default will only return already-existing tiles. However, we // need to return *all* tiles to the callers, so force creation // here. //boolean forceTileCreation = true; for (Tile tile : ts.allTilesCreate()) { Image img = getLoadedTileImage(tile); if (img == null || tile.hasError()) { if (Main.isDebugEnabled()) { Main.debug("missed tile: " + tile); } missedTiles.add(tile); continue; } Rectangle sourceRect = tileToRect(tile); if (borderRect != null && !sourceRect.intersects(borderRect)) { continue; } drawImageInside(g, img, sourceRect, borderRect); } return missedTiles; } private void myDrawString(Graphics g, String text, int x, int y) { Color oldColor = g.getColor(); g.setColor(Color.black); g.drawString(text, x+1, y+1); g.setColor(oldColor); g.drawString(text, x, y); } private void paintTileText(TileSet ts, Tile tile, Graphics g, MapView mv, int zoom, Tile t) { int fontHeight = g.getFontMetrics().getHeight(); if (tile == null) return; Point p = pixelPos(t); int texty = p.y + 2 + fontHeight; /*if (PROP_DRAW_DEBUG.get()) { myDrawString(g, "x=" + t.getXtile() + " y=" + t.getYtile() + " z=" + zoom + "", p.x + 2, texty); texty += 1 + fontHeight; if ((t.getXtile() % 32 == 0) && (t.getYtile() % 32 == 0)) { myDrawString(g, "x=" + t.getXtile() / 32 + " y=" + t.getYtile() / 32 + " z=7", p.x + 2, texty); texty += 1 + fontHeight; } }*/ if (tile == showMetadataTile) { String md = tile.toString(); if (md != null) { myDrawString(g, md, p.x + 2, texty); texty += 1 + fontHeight; } Map meta = tile.getMetadata(); if (meta != null) { for (Map.Entry entry : meta.entrySet()) { myDrawString(g, entry.getKey() + ": " + entry.getValue(), p.x + 2, texty); texty += 1 + fontHeight; } } } /*String tileStatus = tile.getStatus(); if (!tile.isLoaded() && PROP_DRAW_DEBUG.get()) { myDrawString(g, tr("image " + tileStatus), p.x + 2, texty); texty += 1 + fontHeight; }*/ if (tile.hasError() && showErrors) { myDrawString(g, tr("Error") + ": " + tr(tile.getErrorMessage()), p.x + 2, texty); texty += 1 + fontHeight; } /*int xCursor = -1; int yCursor = -1; if (PROP_DRAW_DEBUG.get()) { if (yCursor < t.getYtile()) { if (t.getYtile() % 32 == 31) { g.fillRect(0, p.y - 1, mv.getWidth(), 3); } else { g.drawLine(0, p.y, mv.getWidth(), p.y); } yCursor = t.getYtile(); } // This draws the vertical lines for the entire // column. Only draw them for the top tile in // the column. if (xCursor < t.getXtile()) { if (t.getXtile() % 32 == 0) { // level 7 tile boundary g.fillRect(p.x - 1, 0, 3, mv.getHeight()); } else { g.drawLine(p.x, 0, p.x, mv.getHeight()); } xCursor = t.getXtile(); } }*/ } private Point pixelPos(LatLon ll) { return Main.map.mapView.getPoint(Main.getProjection().latlon2eastNorth(ll).add(getDx(), getDy())); } private Point pixelPos(Tile t) { double lon = tileSource.tileXToLon(t.getXtile(), t.getZoom()); LatLon tmpLL = new LatLon(tileSource.tileYToLat(t.getYtile(), t.getZoom()), lon); return pixelPos(tmpLL); } private LatLon getShiftedLatLon(EastNorth en) { return Main.getProjection().eastNorth2latlon(en.add(-getDx(), -getDy())); } private Coordinate getShiftedCoord(EastNorth en) { LatLon ll = getShiftedLatLon(en); return new Coordinate(ll.lat(), ll.lon()); } private final TileSet nullTileSet = new TileSet((LatLon) null, (LatLon) null, 0); private final class TileSet { private int x0, x1, y0, y1; private int zoom; private int tileMax = -1; /** * Create a TileSet by EastNorth bbox taking a layer shift in account */ private TileSet(EastNorth topLeft, EastNorth botRight, int zoom) { this(getShiftedLatLon(topLeft), getShiftedLatLon(botRight), zoom); } /** * Create a TileSet by known LatLon bbox without layer shift correction */ private TileSet(LatLon topLeft, LatLon botRight, int zoom) { this.zoom = zoom; if (zoom == 0) return; x0 = (int) tileSource.lonToTileX(topLeft.lon(), zoom); y0 = (int) tileSource.latToTileY(topLeft.lat(), zoom); x1 = (int) tileSource.lonToTileX(botRight.lon(), zoom); y1 = (int) tileSource.latToTileY(botRight.lat(), zoom); if (x0 > x1) { int tmp = x0; x0 = x1; x1 = tmp; } if (y0 > y1) { int tmp = y0; y0 = y1; y1 = tmp; } tileMax = (int) Math.pow(2.0, zoom); if (x0 < 0) { x0 = 0; } if (y0 < 0) { y0 = 0; } if (x1 > tileMax) { x1 = tileMax; } if (y1 > tileMax) { y1 = tileMax; } } private boolean tooSmall() { return this.tilesSpanned() < 2.1; } private boolean tooLarge() { return this.tilesSpanned() > 10; } private boolean insane() { return this.tilesSpanned() > 100; } private double tilesSpanned() { return Math.sqrt(1.0 * this.size()); } private int size() { int x_span = x1 - x0 + 1; int y_span = y1 - y0 + 1; return x_span * y_span; } /* * Get all tiles represented by this TileSet that are * already in the tileCache. */ private List allExistingTiles() { return this.__allTiles(false); } private List allTilesCreate() { return this.__allTiles(true); } private List __allTiles(boolean create) { // Tileset is either empty or too large if (zoom == 0 || this.insane()) return Collections.emptyList(); List ret = new ArrayList<>(); for (int x = x0; x <= x1; x++) { for (int y = y0; y <= y1; y++) { Tile t; if (create) { t = getOrCreateTile(x % tileMax, y % tileMax, zoom); } else { t = getTile(x % tileMax, y % tileMax, zoom); } if (t != null) { ret.add(t); } } } return ret; } private List allLoadedTiles() { List ret = new ArrayList<>(); for (Tile t : this.allExistingTiles()) { if (t.isLoaded()) ret.add(t); } return ret; } private Comparator getTileDistanceComparator() { final int centerX = (int) Math.ceil((x0 + x1) / 2); final int centerY = (int) Math.ceil((y0 + y1) / 2); return new Comparator() { private int getDistance(Tile t) { return Math.abs(t.getXtile() - centerX) + Math.abs(t.getYtile() - centerY); } @Override public int compare(Tile o1, Tile o2) { int distance1 = getDistance(o1); int distance2 = getDistance(o2); return Integer.compare(distance1, distance2); } }; } private void loadAllTiles(boolean force) { if (!autoLoad && !force) return; List allTiles = allTilesCreate(); Collections.sort(allTiles, getTileDistanceComparator()); for (Tile t : allTiles) { loadTile(t, force); } } private void loadAllErrorTiles(boolean force) { if (!autoLoad && !force) return; for (Tile t : this.allTilesCreate()) { if (t.hasError()) { loadTile(t, true); } } } } private static class TileSetInfo { public boolean hasVisibleTiles = false; public boolean hasOverzoomedTiles = false; public boolean hasLoadingTiles = false; } private static TileSetInfo getTileSetInfo(TileSet ts) { List allTiles = ts.allExistingTiles(); TileSetInfo result = new TileSetInfo(); result.hasLoadingTiles = allTiles.size() < ts.size(); for (Tile t : allTiles) { if (t.isLoaded()) { if (!t.hasError()) { result.hasVisibleTiles = true; } if ("no-tile".equals(t.getValue("tile-info"))) { result.hasOverzoomedTiles = true; } } else { result.hasLoadingTiles = true; } } return result; } private class DeepTileSet { private final EastNorth topLeft, botRight; private final int minZoom, maxZoom; private final TileSet[] tileSets; private final TileSetInfo[] tileSetInfos; public DeepTileSet(EastNorth topLeft, EastNorth botRight, int minZoom, int maxZoom) { this.topLeft = topLeft; this.botRight = botRight; this.minZoom = minZoom; this.maxZoom = maxZoom; this.tileSets = new TileSet[maxZoom - minZoom + 1]; this.tileSetInfos = new TileSetInfo[maxZoom - minZoom + 1]; } public TileSet getTileSet(int zoom) { if (zoom < minZoom) return nullTileSet; synchronized (tileSets) { TileSet ts = tileSets[zoom-minZoom]; if (ts == null) { ts = new TileSet(topLeft, botRight, zoom); tileSets[zoom-minZoom] = ts; } return ts; } } public TileSetInfo getTileSetInfo(int zoom) { if (zoom < minZoom) return new TileSetInfo(); synchronized (tileSetInfos) { TileSetInfo tsi = tileSetInfos[zoom-minZoom]; if (tsi == null) { tsi = TMSLayer.getTileSetInfo(getTileSet(zoom)); tileSetInfos[zoom-minZoom] = tsi; } return tsi; } } } @Override public void paint(Graphics2D g, MapView mv, Bounds bounds) { EastNorth topLeft = mv.getEastNorth(0, 0); EastNorth botRight = mv.getEastNorth(mv.getWidth(), mv.getHeight()); if (botRight.east() == 0 || botRight.north() == 0) { /*Main.debug("still initializing??");*/ // probably still initializing return; } needRedraw = false; int zoom = currentZoomLevel; if (autoZoom) { double pixelScaling = getScaleFactor(zoom); if (pixelScaling > 3 || pixelScaling < 0.7) { zoom = getBestZoom(); } } DeepTileSet dts = new DeepTileSet(topLeft, botRight, getMinZoomLvl(), zoom); TileSet ts = dts.getTileSet(zoom); int displayZoomLevel = zoom; boolean noTilesAtZoom = false; if (autoZoom && autoLoad) { // Auto-detection of tilesource maxzoom (currently fully works only for Bing) TileSetInfo tsi = dts.getTileSetInfo(zoom); if (!tsi.hasVisibleTiles && (!tsi.hasLoadingTiles || tsi.hasOverzoomedTiles)) { noTilesAtZoom = true; } // Find highest zoom level with at least one visible tile for (int tmpZoom = zoom; tmpZoom > dts.minZoom; tmpZoom--) { if (dts.getTileSetInfo(tmpZoom).hasVisibleTiles) { displayZoomLevel = tmpZoom; break; } } // Do binary search between currentZoomLevel and displayZoomLevel while (zoom > displayZoomLevel && !tsi.hasVisibleTiles && tsi.hasOverzoomedTiles) { zoom = (zoom + displayZoomLevel)/2; tsi = dts.getTileSetInfo(zoom); } setZoomLevel(zoom); // If all tiles at displayZoomLevel is loaded, load all tiles at next zoom level // to make sure there're really no more zoom levels if (zoom == displayZoomLevel && !tsi.hasLoadingTiles && zoom < dts.maxZoom) { zoom++; tsi = dts.getTileSetInfo(zoom); } // When we have overzoomed tiles and all tiles at current zoomlevel is loaded, // load tiles at previovus zoomlevels until we have all tiles on screen is loaded. while (zoom > dts.minZoom && tsi.hasOverzoomedTiles && !tsi.hasLoadingTiles) { zoom--; tsi = dts.getTileSetInfo(zoom); } ts = dts.getTileSet(zoom); } else if (autoZoom) { setZoomLevel(zoom); } // Too many tiles... refuse to download if (!ts.tooLarge()) { //Main.debug("size: " + ts.size() + " spanned: " + ts.tilesSpanned()); ts.loadAllTiles(false); } if (displayZoomLevel != zoom) { ts = dts.getTileSet(displayZoomLevel); } g.setColor(Color.DARK_GRAY); List missedTiles = this.paintTileImages(g, ts, displayZoomLevel, null); int[] otherZooms = {-1, 1, -2, 2, -3, -4, -5}; for (int zoomOffset : otherZooms) { if (!autoZoom) { break; } int newzoom = displayZoomLevel + zoomOffset; if (newzoom < MIN_ZOOM) { continue; } if (missedTiles.isEmpty()) { break; } List newlyMissedTiles = new LinkedList<>(); for (Tile missed : missedTiles) { if ("no-tile".equals(missed.getValue("tile-info")) && zoomOffset > 0) { // Don't try to paint from higher zoom levels when tile is overzoomed newlyMissedTiles.add(missed); continue; } Tile t2 = tempCornerTile(missed); LatLon topLeft2 = tileLatLon(missed); LatLon botRight2 = tileLatLon(t2); TileSet ts2 = new TileSet(topLeft2, botRight2, newzoom); // Instantiating large TileSets is expensive. If there // are no loaded tiles, don't bother even trying. if (ts2.allLoadedTiles().isEmpty()) { newlyMissedTiles.add(missed); continue; } if (ts2.tooLarge()) { continue; } newlyMissedTiles.addAll(this.paintTileImages(g, ts2, newzoom, missed)); } missedTiles = newlyMissedTiles; } if (Main.isDebugEnabled() && !missedTiles.isEmpty()) { Main.debug("still missed "+missedTiles.size()+" in the end"); } g.setColor(Color.red); g.setFont(InfoFont); // The current zoom tileset should have all of its tiles // due to the loadAllTiles(), unless it to tooLarge() for (Tile t : ts.allExistingTiles()) { this.paintTileText(ts, t, g, mv, displayZoomLevel, t); } attribution.paintAttribution(g, mv.getWidth(), mv.getHeight(), getShiftedCoord(topLeft), getShiftedCoord(botRight), displayZoomLevel, this); //g.drawString("currentZoomLevel=" + currentZoomLevel, 120, 120); g.setColor(Color.lightGray); if (!autoZoom) { if (ts.insane()) { myDrawString(g, tr("zoom in to load any tiles"), 120, 120); } else if (ts.tooLarge()) { myDrawString(g, tr("zoom in to load more tiles"), 120, 120); } else if (ts.tooSmall()) { myDrawString(g, tr("increase zoom level to see more detail"), 120, 120); } } if (noTilesAtZoom) { myDrawString(g, tr("No tiles at this zoom level"), 120, 120); } if (Main.isDebugEnabled()) { myDrawString(g, tr("Current zoom: {0}", currentZoomLevel), 50, 140); myDrawString(g, tr("Display zoom: {0}", displayZoomLevel), 50, 155); myDrawString(g, tr("Pixel scale: {0}", getScaleFactor(currentZoomLevel)), 50, 170); myDrawString(g, tr("Best zoom: {0}", getBestZoom()), 50, 185); if (tileLoader instanceof TMSCachedTileLoader) { TMSCachedTileLoader cachedTileLoader = (TMSCachedTileLoader) tileLoader; int offset = 185; for (String part: cachedTileLoader.getStats().split("\n")) { myDrawString(g, tr("Cache stats: {0}", part), 50, offset += 15); } } } } /** * This isn't very efficient, but it is only used when the * user right-clicks on the map. */ private Tile getTileForPixelpos(int px, int py) { if (Main.isDebugEnabled()) { Main.debug("getTileForPixelpos("+px+", "+py+")"); } MapView mv = Main.map.mapView; Point clicked = new Point(px, py); EastNorth topLeft = mv.getEastNorth(0, 0); EastNorth botRight = mv.getEastNorth(mv.getWidth(), mv.getHeight()); int z = currentZoomLevel; TileSet ts = new TileSet(topLeft, botRight, z); if (!ts.tooLarge()) { ts.loadAllTiles(false); // make sure there are tile objects for all tiles } Tile clickedTile = null; for (Tile t1 : ts.allExistingTiles()) { Tile t2 = tempCornerTile(t1); Rectangle r = new Rectangle(pixelPos(t1)); r.add(pixelPos(t2)); if (Main.isDebugEnabled()) { Main.debug("r: " + r + " clicked: " + clicked); } if (!r.contains(clicked)) { continue; } clickedTile = t1; break; } if (clickedTile == null) return null; /*Main.debug("Clicked on tile: " + clickedTile.getXtile() + " " + clickedTile.getYtile() + " currentZoomLevel: " + currentZoomLevel);*/ return clickedTile; } @Override public Action[] getMenuEntries() { return new Action[] { LayerListDialog.getInstance().createShowHideLayerAction(), LayerListDialog.getInstance().createDeleteLayerAction(), SeparatorLayerAction.INSTANCE, // color, new OffsetAction(), new RenameLayerAction(this.getAssociatedFile(), this), SeparatorLayerAction.INSTANCE, new LayerListPopup.InfoAction(this) }; } @Override public String getToolTipText() { return tr("TMS layer ({0}), downloading in zoom {1}", getName(), currentZoomLevel); } @Override public void visitBoundingBox(BoundingXYVisitor v) { } @Override public boolean isChanged() { return needRedraw; } @Override public final boolean isProjectionSupported(Projection proj) { return "EPSG:3857".equals(proj.toCode()) || "EPSG:4326".equals(proj.toCode()); } @Override public final String nameSupportedProjections() { return tr("EPSG:4326 and Mercator projection are supported"); } }