OsmAnd/DataExtractionOSM/src/net/osmand/map/TileSourceManager.java

package net.osmand.map;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.regex.Pattern;

import net.osmand.Algoritms;
import net.osmand.LogUtil;
import net.osmand.osm.MapUtils;

import org.apache.commons.logging.Log;



public class TileSourceManager {
	private static final Log log = LogUtil.getLog(TileSourceManager.class);

	public static class TileSourceTemplate implements ITileSource {
		private int maxZoom;
		private int minZoom;
		private String name;
		protected int tileSize;
		protected String urlToLoad;
		protected String ext;
		private int avgSize;
		private int bitDensity;
		
		// default constructor
		public TileSourceTemplate(String name, String urlToLoad){
			this(name, urlToLoad, ".jpg", 18, 1, 256, 16, 20000); //$NON-NLS-1$
		}
		
		public TileSourceTemplate(String name, String urlToLoad, String ext, int maxZoom, int minZoom, int tileSize, int bitDensity, int avgSize) {
			this.maxZoom = maxZoom;
			this.minZoom = minZoom;
			this.name = name;
			this.tileSize = tileSize;
			this.urlToLoad = urlToLoad;
			this.ext = ext;
			this.avgSize = avgSize;
			this.bitDensity = bitDensity;
		}

		@Override
		public int getBitDensity() {
			return bitDensity;
		}
		
		public int getAverageSize(){
			return avgSize;
		}
		
		@Override
		public int getMaximumZoomSupported() {
			return maxZoom;
		}

		@Override
		public int getMinimumZoomSupported() {
			return minZoom;
		}

		@Override
		public String getName() {
			return name;
		}

		@Override
		public int getTileSize() {
			return tileSize;
		}
		
		public String getTileFormat(){
			return ext;
		}

		@Override
		public String getUrlToLoad(int x, int y, int zoom) {
			// use int to string not format numbers! (non-nls)
			if(urlToLoad == null){
				return null;
			}
			return MessageFormat.format(urlToLoad, zoom+"", x+"", y+""); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
		}
		
		
		public String getUrlTemplate(){
			return urlToLoad;
		}
		@Override
		public boolean couldBeDownloadedFromInternet() {
			return urlToLoad != null;
		}


		@Override
		public int hashCode() {
			final int prime = 31;
			int result = 1;
			result = prime * result + ((name == null) ? 0 : name.hashCode());
			return result;
		}


		@Override
		public boolean equals(Object obj) {
			if (this == obj)
				return true;
			if (obj == null)
				return false;
			if (getClass() != obj.getClass())
				return false;
			TileSourceTemplate other = (TileSourceTemplate) obj;
			if (name == null) {
				if (other.name != null)
					return false;
			} else if (!name.equals(other.name))
				return false;
			return true;
		}
		
	}
	
	public static class WMSSourceTemplate extends TileSourceTemplate {

		public WMSSourceTemplate(String name, String wmsUrl) {
			super("WMS " + name, wmsUrl, ".jpg", 18, 3, 256, 16, 20000); //$NON-NLS-1$ //$NON-NLS-2$
		}
		
		@Override
		public String getUrlToLoad(int x, int y, int zoom) {
			double yEnd = MapUtils.getLatitudeFromTile(zoom, y + 1);
			double yStart = MapUtils.getLatitudeFromTile(zoom, y );
			double xStart = MapUtils.getLongitudeFromTile(zoom, x);
			double xEnd = MapUtils.getLongitudeFromTile(zoom, x + 1);
			StringBuilder load = new StringBuilder();
			load.append(urlToLoad).append("bbox=").append(xStart).append(','). //$NON-NLS-1$
				 append(yEnd).append(',').append(xEnd).append(',').append(yStart);
			load.append("&srs=EPSG:4326").append("&width=").append(tileSize).append("&height=").append(tileSize); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
			return load.toString();
		}
		
	}
	
	public static java.util.List<TileSourceTemplate> getUserDefinedTemplates(File tilesDir){
		java.util.List<TileSourceTemplate> ts = new ArrayList<TileSourceTemplate>();
		if (tilesDir != null) {
			File[] listFiles = tilesDir.listFiles();
			if (listFiles != null) {
				for (File f : listFiles) {
					File ch = new File(f, "url"); //$NON-NLS-1$
					if (f.isDirectory() && ch.exists()) {
						try {
							BufferedReader read = new BufferedReader(new InputStreamReader(new FileInputStream(ch), "UTF-8")); //$NON-NLS-1$
							String url = read.readLine();
							read.close();
							if (!Algoritms.isEmpty(url)) {
								url = url.replaceAll(Pattern.quote("{$x}"), "{1}"); //$NON-NLS-1$ //$NON-NLS-2$
								url = url.replaceAll(Pattern.quote("{$z}"), "{0}"); //$NON-NLS-1$//$NON-NLS-2$
								url = url.replaceAll(Pattern.quote("{$y}"), "{2}"); //$NON-NLS-1$ //$NON-NLS-2$
								TileSourceTemplate t = new TileSourceTemplate(f.getName(), url, ".jpg", 18, 1, 256, 16, 20000); //$NON-NLS-1$
								ts.add(t);
							}
						} catch (IOException e) {
							log.info("Mailformed dir " + f.getName(), e); //$NON-NLS-1$
						}

					}
				}
			}
		}
		return ts;
	}
	
	static java.util.List<TileSourceTemplate> list;
	public static java.util.List<TileSourceTemplate> getKnownSourceTemplates(){
		if(list == null){
			list = new ArrayList<TileSourceTemplate>();
			list.add(getMapnikSource());
			list.add(getOsmaRenderSource());
			list.add(getCycleMapSource());
			list.add(getMapSurferSource());
			list.add(getNavigationDebugSource());
			
			list.add(getCloudMadeSource());
			list.add(getOpenPisteMapSource());
			list.add(getGoogleMapsSource());
			list.add(getGoogleMapsSatelliteSource());
			list.add(getGoogleMapsTerrainSource());
			
			list.add(getMicrosoftMapsSource());
			list.add(getMicrosoftEarthSource());
			list.add(getMicrosoftHybridSource());
			
		}
		return list;
		
	}
	
	
	
	
	public static TileSourceTemplate getMapnikSource(){
		return new TileSourceTemplate("Mapnik", "http://tile.openstreetmap.org/{0}/{1}/{2}.png", ".png", 18, 1, 256, 8, 18000);  //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getOsmaRenderSource(){
		return new TileSourceTemplate("OsmaRender", "http://tah.openstreetmap.org/Tiles/tile/{0}/{1}/{2}.png", ".png", 17, 1, 256, 8, 18000);  //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getCycleMapSource(){
//		return new TileSourceTemplate("CycleMap", "http://b.andy.sandbox.cloudmade.com/tiles/cycle/{0}/{1}/{2}.png", ".png", 17, 0, 256, 32, 18000);  //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$
		return new TileSourceTemplate("CycleMap", "http://b.tile.opencyclemap.org/cycle/{0}/{1}/{2}.png", ".png", 17, 0, 256, 32, 18000);  //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getAerialMapSource(){
		return new TileSourceTemplate("OpenAerialMap", "http://tile.openaerialmap.org/tiles/1.0.0/openaerialmap-900913/{0}/{1}/{2}.jpg", ".jpg", 13, 0, 256, 8, 18000);  //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getCloudMadeSource(){
		return new TileSourceTemplate("Cloudmade", "http://tile.cloudmade.com/7ded028e030c5929b28bf823486ce84f/1/256/{0}/{1}/{2}.png", ".png", 18, 0, 256, 16, 18000);  //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getMapSurferSource(){
		return new TileSourceTemplate("MapSurfer", "http://tiles1.mapsurfer.net/tms_r.ashx?z={0}&x={1}&y={2}", ".png", 19, 0, 256, 16, 18000);//$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getNavigationDebugSource(){
		return new TileSourceTemplate("NavigationDebug", "http://ec2-184-73-15-218.compute-1.amazonaws.com/6700/256/{0}/{1}/{2}.png", ".png", 18, 0, 256, 16, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
	
	public static TileSourceTemplate getOpenPisteMapSource(){
		return new TileSourceTemplate("OpenPisteMap", "http://openpistemap.org/tiles/contours/{0}/{1}/{2}.png", ".png", 17, 0, 256, 32, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getGoogleMapsSource(){
		return new TileSourceTemplate("GoogleMaps", "http://mt3.google.com/vt/v=w2.97&x={1}&y={2}&z={0}", ".png", 19, 0, 256, 16, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getGoogleMapsSatelliteSource(){
		return new TileSourceTemplate("GoogleMaps Satellite", "http://khm1.google.com/kh/v=65&x={1}&y={2}&z={0}", ".jpg", 20, 0, 256, 32, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getGoogleMapsTerrainSource(){
		return new TileSourceTemplate("GoogleMaps Terrain", "http://mt3.google.com/vt/v=w2p.111&hl=en&x={1}&y={2}&z={0}", ".jpg", 15, 0, 256, 32, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}

	// not working
	public static TileSourceTemplate getGoogleMapsHybridSource(){
//		Google Map Earth + Overlay
//		GoogleEarthMapsOverlay.url=http://mt{$servernum}.google.com/vt/lyrs=h@130&hl={$lang}&x={$x}&y={$y}&z={$z}
		return new TileSourceTemplate("Google Hybrid", "http://khm1.google.com/kh/v=59&x={1}&y={2}&z={0}", ".jpg", 20, 0, 256, 32, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}

	
	// wrong projection ???
	public static TileSourceTemplate getYandexMapSource(){
		return new TileSourceTemplate("Yandex map", "http://vec01.maps.yandex.ru/tiles?l=map&v=2.15.0&x={1}&y={2}&z={0}", ".jpg", 18, 0, 256, 16, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getYandexSatSource(){
		return new TileSourceTemplate("Yandex Satellite", "http://sat01.maps.yandex.ru/tiles?l=sat&v=1.19.0&x={1}&y={2}&z={0}", ".jpg", 18, 0, 256, 32, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
	
	public static TileSourceTemplate getMicrosoftMapsSource(){
		return new MicrosoftTileSourceTemplate("Microsoft Maps", 'r', "png", ".png", 19, 1, 256, 16, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getMicrosoftEarthSource(){
		return new MicrosoftTileSourceTemplate("Microsoft Earth", 'a', "jpg", ".jpg", 19, 1, 256, 32, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
	public static TileSourceTemplate getMicrosoftHybridSource(){
		return new MicrosoftTileSourceTemplate("Microsoft Hybrid", 'h', "jpg", ".jpg", 19, 1, 256, 32, 18000); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
	
	// WMS layers : http://whoots.mapwarper.net/tms/{$z}/{$x}/{$y}/ {layer}/{Path}
	// 1. Landsat http://onearth.jpl.nasa.gov/wms.cgi global_mosaic (NOT WORK)
	// 2. Genshtab http://wms.latlon.org gshtab
	
	protected static final char[] NUM_CHAR = { '0', '1', '2', '3' };

	/**
	 * See: http://msdn.microsoft.com/en-us/library/bb259689.aspx
	 * @param zoom
	 * @param tilex
	 * @param tiley
	 * @return quadtree encoded tile number
	 * 
	 */
	public static String encodeQuadTree(int zoom, int tilex, int tiley) {
		char[] tileNum = new char[zoom];
		for (int i = zoom - 1; i >= 0; i--) {
			// Binary encoding using ones for tilex and twos for tiley. if a bit
			// is set in tilex and tiley we get a three.
			int num = (tilex % 2) | ((tiley % 2) << 1);
			tileNum[i] = NUM_CHAR[num];
			tilex >>= 1;
			tiley >>= 1;
		}
		return new String(tileNum);
	}
	
	public static class MicrosoftTileSourceTemplate extends TileSourceTemplate {

		private final char mapTypeChar;
		int serverNum = 0; // 0..3
		protected String urlBase = ".ortho.tiles.virtualearth.net/tiles/"; //$NON-NLS-1$
		protected String urlAppend = "?g=45"; //$NON-NLS-1$
		private final String tileType;

		public MicrosoftTileSourceTemplate(String name, char mapTypeChar , String type, 
				String ext, int maxZoom, int minZoom, int tileSize, int bitDensity, int avgSize) {
			super(name, null, ext, maxZoom, minZoom, tileSize, bitDensity, avgSize);
			this.mapTypeChar = mapTypeChar;
			this.tileType = type;
		}
		
		
		@Override
		public String getUrlToLoad(int x, int y, int zoom) {
			String tileNum = encodeQuadTree(zoom, x, y);
//			serverNum = (serverNum + 1) % serverNumMax;
			return "http://" + mapTypeChar + serverNum + urlBase + mapTypeChar + tileNum + "." //$NON-NLS-1$ //$NON-NLS-2$
					+ tileType + urlAppend;
			
		}
	}

	
}