* 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 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_DRAW_DEBUG = new BooleanProperty(PREFERENCE_PREFIX + ".draw_debug", false);

    public static final BooleanProperty PROP_ADD_TO_SLIPPYMAP_CHOOSER = new BooleanProperty(PREFERENCE_PREFIX + ".add_to_slippymap_chooser", true);

    public static final IntegerProperty PROP_TMS_JOBS = new IntegerProperty("tmsloader.maxjobs", 25);

    public static final StringProperty PROP_TILECACHE_DIR;

    static {

        String defPath = null;

        try {

            defPath = OsmFileCacheTileLoader.getDefaultCacheDir().getAbsolutePath();

        } catch (SecurityException e) {

            Main.warn(e);

        }

        PROP_TILECACHE_DIR = new StringProperty(PREFERENCE_PREFIX + ".tilecache_path", defPath);

    }

    public interface TileLoaderFactory {

        OsmTileLoader makeTileLoader(TileLoaderListener listener);

    }

    protected MemoryTileCache tileCache;

    protected TileSource tileSource;

    protected OsmTileLoader tileLoader;

    public static TileLoaderFactory loaderFactory = new TileLoaderFactory() {

        @Override

        public OsmTileLoader makeTileLoader(TileLoaderListener listener) {

            String cachePath = TMSLayer.PROP_TILECACHE_DIR.get();

            if (cachePath != null && !cachePath.isEmpty()) {

                try {

                    OsmFileCacheTileLoader loader = new OsmFileCacheTileLoader(listener, new File(cachePath));

                    loader.headers.put("User-Agent", Version.getInstance().getFullAgentString());

                    return loader;

                } catch (IOException e) {

                    Main.warn(e);

                }

            }

            return null;

        }

    };

    /**

     * Plugins that wish to set custom tile loader should call this method

     */

    public static void setCustomTileLoaderFactory(TileLoaderFactory loaderFactory) {

        TMSLayer.loaderFactory = loaderFactory;

    }

    private Set<Tile> tileRequestsOutstanding = new HashSet<>();

    @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(true);

        needRedraw = true;

        if (Main.map != null) {

            Main.map.repaint(100);

        }

        tileRequestsOutstanding.remove(tile);

        if (Main.isDebugEnabled()) {

            Main.debug("tileLoadingFinished() tile: " + tile + " success: " + success);

        }

    }

    @Override

    public TileCache getTileCache() {

        return tileCache;

    }

    private static class TmsTileClearController implements TileClearController, CancelListener {

        private final ProgressMonitor monitor;

        private boolean cancel = false;

        public TmsTileClearController(ProgressMonitor monitor) {

            this.monitor = monitor;

            this.monitor.addCancelListener(this);

        }

        @Override

        public void initClearDir(File dir) {

        }

        @Override

        public void initClearFiles(File[] files) {

            monitor.setTicksCount(files.length);

            monitor.setTicks(0);

        }

        @Override

        public boolean cancel() {

            return cancel;

        }

        @Override

        public void fileDeleted(File file) {

            monitor.setTicks(monitor.getTicks()+1);

        }

        @Override

        public void clearFinished() {

            monitor.finishTask();

        }

        @Override

        public void operationCanceled() {

            cancel = true;

        }

    }

    /**

     * 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

     * @see MemoryTileCache#clear()

     * @see OsmFileCacheTileLoader#clearCache(org.openstreetmap.gui.jmapviewer.interfaces.TileSource, org.openstreetmap.gui.jmapviewer.interfaces.TileClearController)

     */

    void clearTileCache(ProgressMonitor monitor) {

        tileCache.clear();

        if (tileLoader instanceof CachedTileLoader) {

            ((CachedTileLoader)tileLoader).clearCache(tileSource, new TmsTileClearController(monitor));

        }

    }

    /**

     * 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;

    JCheckBoxMenuItem autoZoomPopup;

    JCheckBoxMenuItem autoLoadPopup;

    JCheckBoxMenuItem showErrorsPopup;

    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()

     */

    void redraw() {

        needRedraw = true;

        Main.map.repaint();

    }

    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) {

        maxZoomLvl = checkMaxZoomLvl(maxZoomLvl, null);

        PROP_MAX_ZOOM_LVL.put(maxZoomLvl);

    }

    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 {

        class BingAttributionData extends CacheCustomContent<IOException> {

            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<List<Attribution>> getAttributionLoaderCallable() {

            return new Callable<List<Attribution>>() {

                @Override

                public List<Attribution> 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

     * @return a new TileSource instance or null if no TileSource for the ImageryInfo/ImageryType could be found.

     * @throws IllegalArgumentException

     */

    public static TileSource getTileSource(ImageryInfo info) throws IllegalArgumentException {

        if (info.getImageryType() == ImageryType.TMS) {

            checkUrl(info.getUrl());

            TMSTileSource t = new TemplatedTMSTileSource(info.getName(), info.getUrl(), info.getMinZoom(), info.getMaxZoom());

            info.setAttribution(t);

            return t;

        } else if (info.getImageryType() == ImageryType.BING)

            return new CachedAttributionBingAerialTileSource();

        else if (info.getImageryType() == ImageryType.SCANEX) {

            return new ScanexTileSource(info.getName(), info.getUrl(), info.getMaxZoom());

        }

        return null;

    }

    public static void checkUrl(String url) throws IllegalArgumentException {

        if (url == null) {

            throw new IllegalArgumentException();

        } else {

            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();

        tileCache = new MemoryTileCache();

        tileLoader = loaderFactory.makeTileLoader(this);

        if (tileLoader == null) {

            tileLoader = new OsmTileLoader(this);

        }

        tileLoader.timeoutConnect = Main.pref.getInteger("socket.timeout.connect",15) * 1000;

        tileLoader.timeoutRead = Main.pref.getInteger("socket.timeout.read", 30) * 1000;

        if (tileSource instanceof TemplatedTMSTileSource) {

            for(Entry<String, String> e : ((TemplatedTMSTileSource)tileSource).getHeaders().entrySet()) {

                tileLoader.headers.put(e.getKey(), e.getValue());

            }

        }

        tileLoader.headers.put("User-Agent", Version.getInstance().getFullAgentString());

    }

    @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);

        double result = Math.log(factor)/Math.log(2)/2+1;

        // 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.

        int intResult = (int)Math.floor(result);

        if (intResult > getMaxZoomLvl())

            return getMaxZoomLvl();

        if (intResult < getMinZoomLvl())

            return getMinZoomLvl();

        return intResult;

    }

    /**

     * Function to set the maximum number of workers for tile loading to the value defined

     * in preferences.

     */

    public static void setMaxWorkers() {

        JobDispatcher.setMaxWorkers(PROP_TMS_JOBS.get());

        JobDispatcher.getInstance().setLIFO(true);

    }

    @SuppressWarnings("serial")

    public TMSLayer(ImageryInfo info) {

        super(info);

        setMaxWorkers();

        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);

    }

    /**

     * Adds a context menu to the mapView.

     */

    @Override

    public void hookUpMapView() {

        tileOptionMenu = new JPopupMenu();

        autoZoom = PROP_DEFAULT_AUTOZOOM.get();

        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();

        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();

        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 AbstractAction(

                tr("Show Tile Info")) {

            @Override

            public void actionPerformed(ActionEvent ae) {

                if (clickedTile != null) {

                    showMetadataTile = clickedTile;

                    redraw();

                }

            }

        }));

        /* FIXME

        tileOptionMenu.add(new JMenuItem(new AbstractAction(

                tr("Request Update")) {

            public void actionPerformed(ActionEvent ae) {

                if (clickedTile != null) {

                    clickedTile.requestUpdate();

                    redraw();

                }

            }

        }));*/

        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 new_factor = Math.sqrt(getScaleFactor(currentZoomLevel));

                Main.map.mapView.zoomToFactor(new_factor);

                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.removeLayerChangeListener(this);

                }

            }

        });

    }

    void zoomChanged() {

        if (Main.isDebugEnabled()) {

            Main.debug("zoomChanged(): " + currentZoomLevel);

        }

        needRedraw = true;

        JobDispatcher.getInstance().cancelOutstandingJobs();

        tileRequestsOutstanding.clear();

    }

    int getMaxZoomLvl() {

        if (info.getMaxZoom() != 0)

            return checkMaxZoomLvl(info.getMaxZoom(), tileSource);

        else

            return getMaxZoomLvl(tileSource);

    }

    int getMinZoomLvl() {

        return getMinZoomLvl(tileSource);

    }

    /**

     * Zoom in, go closer to map.

     *

     * @return    true, if zoom increasing was successfull, false othervise

     */

    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 &gt; 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.

     */

    synchronized 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);

    }

    synchronized 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.

     */

    synchronized 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);

    }

    synchronized boolean loadTile(Tile tile, boolean force) {

        if (tile == null)

            return false;

        if (!force && (tile.hasError() || tile.isLoaded()))

            return false;

        if (tile.isLoading())

            return false;

        if (tileRequestsOutstanding.contains(tile))

            return false;

        tileRequestsOutstanding.add(tile);

        JobDispatcher.getInstance().addJob(tileLoader.createTileLoaderJob(tile));

        return true;

    }

    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);

    }

    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);

    }

    /*

     * Attempt to approximate how much the image is being scaled. For instance,

     * a 100x100 image being scaled to 50x50 would return 0.25.

     */

    Image lastScaledImage = null;

    @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;

    }

    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.

     */

    Image getLoadedTileImage(Tile tile) {

        if (!tile.isLoaded())

            return null;

        Image img = tile.getImage();

        if (!imageLoaded(img))

            return null;

        return img;

    }

    LatLon tileLatLon(Tile t) {

        int zoom = t.getZoom();

        return new LatLon(tileSource.tileYToLat(t.getYtile(), zoom),

                tileSource.tileXToLon(t.getXtile(), zoom));

    }

    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.

    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);

        int img_y_offset = (int)(screen_y_offset * imageYScaling);

        // 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);

        int img_y_end   = img_y_offset + (int)(target.getHeight() * imageYScaling);

        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.

    List<Tile> 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<Tile> 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;

    }

    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);

    }

    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<String, String> meta = tile.getMetadata();

            if (meta != null) {

                for (Map.Entry<String, String> 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 class TileSet {

        int x0, x1, y0, y1;

        int zoom;

        int tileMax = -1;

        /**

         * Create a TileSet by EastNorth bbox taking a layer shift in account

         */

        TileSet(EastNorth topLeft, EastNorth botRight, int zoom) {

            this(getShiftedLatLon(topLeft), getShiftedLatLon(botRight),zoom);

        }

        /**

         * Create a TileSet by known LatLon bbox without layer shift correction

         */

        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;

            }

        }

        boolean tooSmall() {

            return this.tilesSpanned() < 2.1;

        }

        boolean tooLarge() {

            return this.tilesSpanned() > 10;

        }

        boolean insane() {

            return this.tilesSpanned() > 100;

        }

        double tilesSpanned() {

            return Math.sqrt(1.0 * this.size());

        }

        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.

         */

        List<Tile> allExistingTiles() {

            return this.__allTiles(false);

        }

        List<Tile> allTilesCreate() {

            return this.__allTiles(true);

        }

        private List<Tile> __allTiles(boolean create) {

            // Tileset is either empty or too large

            if (zoom == 0 || this.insane())

                return Collections.emptyList();

            List<Tile> 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<Tile> allLoadedTiles() {

            List<Tile> ret = new ArrayList<>();

            for (Tile t : this.allExistingTiles()) {

                if (t.isLoaded())

                    ret.add(t);

            }

            return ret;

        }

        void loadAllTiles(boolean force) {

            if (!autoLoad && !force)

                return;

            for (Tile t : this.allTilesCreate()) {

                loadTile(t, false);

            }

        }

        void loadAllErrorTiles(boolean force) {

            if (!autoLoad && !force)

                return;

            for (Tile t : this.allTilesCreate()) {

                if (t.hasError()) {

                    loadTile(t, true);

                }

            }

        }

    }

        public boolean hasVisibleTiles = false;

        public boolean hasOverzoomedTiles = false;

        public boolean hasLoadingTiles = false;

    }

    private static TileSetInfo getTileSetInfo(TileSet ts) {

        List<Tile> 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 {

        final EastNorth topLeft, botRight;

        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;

            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)