Ticket #11216: jcs-tms-v05.patch

File jcs-tms-v05.patch, 85.1 KB (added by wiktorn, 3 years ago)
  • src/org/apache/commons

  • build.xml

    Property changes on: src/org/apache/commons
    ___________________________________________________________________
    Modified: svn:externals
    ## -1 +1,3 ##
    -codec http://svn.apache.org/repos/asf/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec
    +http://svn.apache.org/repos/asf/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec codec
    +http://svn.apache.org/repos/asf/commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs jcs
    +http://svn.apache.org/repos/asf/commons/proper/logging/trunk/src/main/java/org/apache/commons/logging logging
     
    220220            destdir="build" target="1.7" source="1.7" debug="on" includeantruntime="false" createMissingPackageInfoClass="false" encoding="iso-8859-1">
    221221            <!-- get rid of "internal proprietary API" warning -->
    222222            <compilerarg value="-XDignore.symbol.file"/>
     223                <exclude name="org/apache/commons/jcs/admin/**"/>
     224                <exclude name="org/apache/commons/jcs/auxiliary/disk/jdbc/**"/>
     225                <exclude name="org/apache/commons/jcs/auxiliary/remote/**"/>
     226                <exclude name="org/apache/commons/jcs/utils/servlet/**"/>
     227                <exclude name="org/apache/commons/logging/impl/AvalonLogger.java"/>
     228                <exclude name="org/apache/commons/logging/impl/Log4JLogger.java"/>
     229                <exclude name="org/apache/commons/logging/impl/LogKitLogger.java"/>
     230                <exclude name="org/apache/commons/logging/impl/ServletContextCleaner.java"/>
    223231        </javac>
    224232        <!-- JMapViewer/JOSM -->
    225233        <javac srcdir="${src.dir}" excludes="com/**,oauth/**,org/apache/commons/**,org/glassfish/**,org/openstreetmap/gui/jmapviewer/Demo.java"
  • src/org/openstreetmap/josm/Main.java

     
    6767import org.openstreetmap.josm.data.ProjectionBounds;
    6868import org.openstreetmap.josm.data.UndoRedoHandler;
    6969import org.openstreetmap.josm.data.ViewportData;
     70import org.openstreetmap.josm.data.cache.JCSCacheManager;
    7071import org.openstreetmap.josm.data.coor.CoordinateFormat;
    7172import org.openstreetmap.josm.data.coor.LatLon;
    7273import org.openstreetmap.josm.data.osm.DataSet;
     
    10881089     * @since 3378
    10891090     */
    10901091    public static boolean exitJosm(boolean exit, int exitCode) {
     1092        JCSCacheManager.shutdown();
    10911093        if (Main.saveUnsavedModifications()) {
    10921094            geometry.remember("gui.geometry");
    10931095            if (map != null) {
  • src/org/openstreetmap/josm/data/cache/JCSCacheManager.java

     
     1// License: GPL. For details, see LICENSE file.
     2package org.openstreetmap.josm.data.cache;
     3
     4import java.io.File;
     5import java.io.IOException;
     6import java.text.MessageFormat;
     7import java.util.Properties;
     8import java.util.logging.Handler;
     9import java.util.logging.Level;
     10import java.util.logging.LogRecord;
     11import java.util.logging.Logger;
     12
     13import org.apache.commons.jcs.access.CacheAccess;
     14import org.apache.commons.jcs.auxiliary.AuxiliaryCache;
     15import org.apache.commons.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes;
     16import org.apache.commons.jcs.engine.control.CompositeCache;
     17import org.apache.commons.jcs.engine.control.CompositeCacheManager;
     18import org.openstreetmap.josm.Main;
     19
     20
     21/**
     22 * @author Wiktor Niesiobędzki
     23 *
     24 * Wrapper class for JCS Cache. Sets some sane environment and returns instances of cache objects.
     25 * Static configuration for now assumes some small LRU cache in memory and larger LRU cache on disk
     26 *
     27 */
     28public class JCSCacheManager {
     29
     30    private static volatile CompositeCacheManager cacheManager = null;
     31    private static long maxObjectTTL        = Long.MAX_VALUE;
     32
     33    private static int maxObjectsInMemory  = 1000;
     34    private static int maxObjectsOnDisk    = 25000;
     35
     36    private static void initialize() throws IOException {
     37        File cacheDir = new File(Main.pref.getCacheDirectory(), "jcs");
     38
     39        if ((!cacheDir.exists() && !cacheDir.mkdirs()))
     40            throw new IOException("Cannot access cache directory");
     41
     42        // raising logging level gives ~500x performance gain
     43        // http://westsworld.dk/blog/2008/01/jcs-and-performance/
     44        Logger jcsLog = Logger.getLogger("org.apache.commons.jcs");
     45        jcsLog.setLevel(Level.INFO);
     46        jcsLog.setUseParentHandlers(false);
     47        jcsLog.addHandler(
     48                new Handler() {
     49                    @Override
     50                    public void publish(LogRecord record) {
     51                        String msg = MessageFormat.format(record.getMessage(), record.getParameters());
     52                        if (record.getLevel().intValue() >= Level.SEVERE.intValue()) {
     53                            Main.error(msg);
     54                        } else if (record.getLevel().intValue() >= Level.WARNING.intValue()) {
     55                            Main.warn(msg);
     56                        } else if (record.getLevel().intValue() >= Level.INFO.intValue()) {
     57                            Main.info(msg);
     58                        } else if (record.getLevel().intValue() >= Level.FINE.intValue()) {
     59                            Main.debug(msg);
     60                        } else {
     61                            Main.trace(msg);
     62                        }
     63                    }
     64
     65                    @Override
     66                    public void flush() {
     67                    }
     68
     69                    @Override
     70                    public void close() throws SecurityException {
     71                    }
     72                }
     73                );
     74
     75        CompositeCacheManager cm  = CompositeCacheManager.getUnconfiguredInstance();
     76        // this could be moved to external file
     77        Properties props = new Properties();
     78        props.setProperty("jcs.default", "DC");
     79        props.setProperty("jcs.default.cacheattributes",                            org.apache.commons.jcs.engine.CompositeCacheAttributes.class.getCanonicalName());
     80        props.setProperty("jcs.default.cacheattributes.MaxObjects",                 Long.toString(maxObjectsInMemory));
     81        props.setProperty("jcs.default.cacheattributes.UseMemoryShrinker",          "true");
     82        props.setProperty("jcs.default.cacheattributes.DiskUsagePatternName",       "UPDATE"); // store elements on disk on put
     83        props.setProperty("jcs.default.elementattributes",                          CacheEntryAttributes.class.getCanonicalName());
     84        props.setProperty("jcs.default.elementattributes.IsEternal",                "false");
     85        props.setProperty("jcs.default.elementattributes.MaxLife",                  Long.toString(maxObjectTTL));
     86        props.setProperty("jcs.default.elementattributes.IdleTime",                 Long.toString(maxObjectTTL));
     87        props.setProperty("jcs.default.elementattributes.IsSpool",                  "true");
     88        props.setProperty("jcs.auxiliary.DC",                                       org.apache.commons.jcs.auxiliary.disk.indexed.IndexedDiskCacheFactory.class.getCanonicalName());
     89        props.setProperty("jcs.auxiliary.DC.attributes",                            org.apache.commons.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes.class.getCanonicalName());
     90        //props.setProperty("jcs.auxiliary.DC",                                       org.apache.commons.jcs.auxiliary.disk.block.BlockDiskCacheFactory.class.getCanonicalName());
     91        //props.setProperty("jcs.auxiliary.DC.attributes",                            org.apache.commons.jcs.auxiliary.disk.block.BlockDiskCacheAttributes.class.getCanonicalName());
     92        props.setProperty("jcs.auxiliary.DC.attributes.DiskPath",                   cacheDir.getAbsolutePath());
     93        props.setProperty("jcs.auxiliary.DC.attributes.maxKeySize",                 Long.toString(maxObjectsOnDisk));
     94        //props.setProperty("jcs.auxiliary.DC.attributes.blockSizeBytes",             "1024"); // - for BlockDiskCacheAttributes
     95        cm.configure(props);
     96        cacheManager = cm;
     97
     98    }
     99
     100    /**
     101     * Returns configured cache object for named cache region
     102     * @param cacheName region name
     103     * @return cache access object
     104     * @throws IOException if directory is not found
     105     */
     106    public static <K,V> CacheAccess<K, V> getCache(String cacheName) throws IOException {
     107        return getCache(cacheName, maxObjectsInMemory, maxObjectsOnDisk);
     108    }
     109
     110    /**
     111     * Returns configured cache object with defined limits of memory cache and disk cache
     112     * @param cacheName region name
     113     * @param maxMemoryObjects number of objects to keep in memory
     114     * @param maxDiskObjects number of objects to keep on disk
     115     * @return cache access object
     116     * @throws IOException if directory is not found
     117     */
     118    public static <K,V> CacheAccess<K, V> getCache(String cacheName, int maxMemoryObjects, int maxDiskObjects) throws IOException {
     119        if (cacheManager != null)
     120            return getCacheInner(cacheName, maxMemoryObjects, maxDiskObjects);
     121
     122        synchronized (JCSCacheManager.class) {
     123            if (cacheManager == null)
     124                initialize();
     125            return getCacheInner(cacheName, maxMemoryObjects, maxDiskObjects);
     126        }
     127    }
     128
     129    private static <K,V> CacheAccess<K, V> getCacheInner(String cacheName, int maxMemoryObjects, int maxDiskObjects) {
     130        CompositeCache<K, V> cc = cacheManager.getCache(cacheName);
     131        cc.getCacheAttributes().setMaxObjects(maxMemoryObjects);
     132        AuxiliaryCache<K, V> ac[] = cc.getAuxCaches();
     133        if (ac!=null && ac.length > 0) {
     134            if (ac[0].getAuxiliaryCacheAttributes() instanceof IndexedDiskCacheAttributes) {
     135                ((IndexedDiskCacheAttributes) ac[0].getAuxiliaryCacheAttributes()).setMaxKeySize(maxDiskObjects);
     136            }
     137        }
     138        return new CacheAccess<K, V>(cc);
     139    }
     140
     141    /**
     142     * Close all files to ensure, that all indexes and data are properly written
     143     */
     144     public static void shutdown() {
     145         // use volatile semantics to get consistent object
     146         CompositeCacheManager localCacheManager = cacheManager;
     147         if (localCacheManager != null) {
     148             localCacheManager.shutDown();
     149         }
     150
     151     }
     152
     153}
  • src/org/openstreetmap/josm/data/cache/CacheEntry.java

     
     1// License: GPL. For details, see LICENSE file.
     2package org.openstreetmap.josm.data.cache;
     3
     4import java.io.Serializable;
     5
     6/**
     7 * @author Wiktor Niesiobędzki
     8 *
     9 * Class that will hold JCS cache entries
     10 *
     11 */
     12public class CacheEntry implements Serializable {
     13    private static final long serialVersionUID = 1L; //version
     14    private byte[] content;
     15
     16    /**
     17     * @param content of the cache entry
     18     */
     19    public CacheEntry(byte[] content) {
     20        this.content = content;
     21    }
     22
     23    /**
     24     * @return cache entry content
     25     */
     26    public byte[] getContent() {
     27        return content;
     28    }
     29}
  • src/org/openstreetmap/josm/data/cache/ICachedLoaderListener.java

     
     1// License: GPL. For details, see LICENSE file.
     2package org.openstreetmap.josm.data.cache;
     3
     4public interface ICachedLoaderListener {
     5    /**
     6     * Will be called when K object was successfully downloaded
     7     *
     8     * @param object
     9     * @param success
     10     */
     11    public void loadingFinished(byte[] object, boolean success);
     12
     13}
  • src/org/openstreetmap/josm/data/cache/JCSCachedTileLoaderJob.java

     
     1// License: GPL. For details, see LICENSE file.
     2package org.openstreetmap.josm.data.cache;
     3
     4import java.io.ByteArrayOutputStream;
     5import java.io.FileNotFoundException;
     6import java.io.IOException;
     7import java.io.InputStream;
     8import java.net.HttpURLConnection;
     9import java.net.MalformedURLException;
     10import java.net.URL;
     11import java.net.URLConnection;
     12import java.util.HashSet;
     13import java.util.Map;
     14import java.util.Random;
     15import java.util.Set;
     16import java.util.concurrent.ConcurrentHashMap;
     17import java.util.concurrent.ConcurrentMap;
     18import java.util.concurrent.Executor;
     19import java.util.concurrent.LinkedBlockingDeque;
     20import java.util.concurrent.RejectedExecutionException;
     21import java.util.concurrent.ThreadPoolExecutor;
     22import java.util.concurrent.TimeUnit;
     23import java.util.logging.Level;
     24import java.util.logging.Logger;
     25
     26import org.apache.commons.jcs.access.behavior.ICacheAccess;
     27import org.apache.commons.jcs.engine.behavior.ICacheElement;
     28import org.openstreetmap.gui.jmapviewer.FeatureAdapter;
     29import org.openstreetmap.josm.data.preferences.IntegerProperty;
     30
     31/**
     32 * @author Wiktor Niesiobędzki
     33 *
     34 * @param <K> cache entry key type
     35 *
     36 * Generic loader for HTTP based tiles. Uses custom attribute, to check, if entry has expired
     37 * according to HTTP headers sent with tile. If so, it tries to verify using Etags
     38 * or If-Modified-Since / Last-Modified.
     39 *
     40 * If the tile is not valid, it will try to download it from remote service and put it
     41 * to cache. If remote server will fail it will try to use stale entry.
     42 *
     43 * This class will keep only one Job running for specified tile. All others will just finish, but
     44 * listeners will be gathered and notified, once download job will be finished
     45 */
     46public abstract class JCSCachedTileLoaderJob<K> implements ICachedLoaderJob<K>, Runnable {
     47    private static final Logger log = FeatureAdapter.getLogger(JCSCachedTileLoaderJob.class.getCanonicalName());
     48    protected static final long DEFAULT_EXPIRE_TIME = 1000L * 60 * 60 * 24 * 7; // 7 days
     49    // Limit for the max-age value send by the server.
     50    protected static final long EXPIRE_TIME_SERVER_LIMIT = 1000L * 60 * 60 * 24 * 28; // 4 weeks
     51    // Absolute expire time limit. Cached tiles that are older will not be used,
     52    // even if the refresh from the server fails.
     53    protected static final long ABSOLUTE_EXPIRE_TIME_LIMIT = Long.MAX_VALUE; // unlimited
     54
     55    public static IntegerProperty THREAD_LIMIT = new IntegerProperty("cache.jcs.max_threads", 10);
     56    private static Executor JOB_DISPATCHER = new ThreadPoolExecutor(
     57            THREAD_LIMIT.get().intValue(), // keep the thread number count constant
     58            THREAD_LIMIT.get().intValue(), // do not this number of threads
     59            30, // keepalive for thread
     60            TimeUnit.SECONDS,
     61            // make queue of LIFO type - so recently requested tiles will be loaded first (assuming that these are which user is waiting to see)
     62            new LinkedBlockingDeque<Runnable>(5) {
     63                /* keep the queue size fairly small, we do not want to
     64                 download a lot of tiles, that user is not seeing anyway */
     65                @Override
     66                public boolean offer(Runnable t) {
     67                    return super.offerFirst(t);
     68                }
     69
     70                @Override
     71                public Runnable remove() {
     72                    return super.removeFirst();
     73                }
     74            }
     75            );
     76
     77    private ICacheAccess<K, CacheEntry> cache;
     78    private long now;
     79    private ICacheElement<K,CacheEntry> cacheElement;
     80    private int connectTimeout;
     81    private int readTimeout;
     82    private Map<String, String> headers;
     83    private static ConcurrentMap<URL,Set<ICachedLoaderListener>> inProgress = new ConcurrentHashMap<>();
     84
     85    protected CacheEntryAttributes attributes = null;
     86    protected byte[] data = null;
     87    private static ConcurrentMap<String, Boolean> useHead = new ConcurrentHashMap<>();
     88
     89
     90
     91    /**
     92     * @param cache cache instance that we will work on
     93     * @param headers
     94     * @param readTimeout
     95     * @param connectTimeout
     96     */
     97    public JCSCachedTileLoaderJob(ICacheAccess<K,CacheEntry> cache,
     98            int connectTimeout, int readTimeout,
     99            Map<String, String> headers) {
     100
     101        this.cache = cache;
     102        this.now = System.currentTimeMillis();
     103        this.connectTimeout = connectTimeout;
     104        this.readTimeout = readTimeout;
     105        this.headers = headers;
     106    }
     107
     108    private void ensureCacheElement() {
     109        if (cacheElement == null && getCacheKey() != null) {
     110            cacheElement = cache.getCacheElement(getCacheKey());
     111            if (cacheElement != null) {
     112                attributes = (CacheEntryAttributes) cacheElement.getElementAttributes();
     113                data = cacheElement.getVal().getContent();
     114            }
     115        }
     116    }
     117
     118    public byte[] get() {
     119        ensureCacheElement();
     120        return data;
     121    }
     122
     123    @Override
     124    public void submit(ICachedLoaderListener listener) {
     125        boolean first = false;
     126        URL url = getUrl();
     127        if (url == null) {
     128            log.log(Level.WARNING, "No url returned for: {0}, skipping", getCacheKey());
     129            return;
     130        }
     131        synchronized (inProgress) {
     132            Set<ICachedLoaderListener> newListeners = inProgress.get(url);
     133            if (newListeners == null) {
     134                newListeners = new HashSet<>();
     135                inProgress.put(url, newListeners);
     136                first = true;
     137            }
     138            newListeners.add(listener);
     139        }
     140
     141        if (first) {
     142            ensureCacheElement();
     143            if (cacheElement != null && isCacheElementValid() && (isObjectLoadable())) {
     144                // we got something in cache, verify it
     145                log.log(Level.FINE, "JCS - Returning object from cache: {0}", getCacheKey());
     146                finishLoading(true);
     147                return;
     148            }
     149            // object not in cache, so submit work to separate thread
     150            try {
     151                JOB_DISPATCHER.execute(this);
     152            } catch (RejectedExecutionException e) {
     153                // queue was full, try again later
     154                log.log(Level.FINE, "JCS - rejected job for: {0}", getCacheKey());
     155                finishLoading(false);
     156            }
     157        }
     158
     159    }
     160
     161    /**
     162     *
     163     * @return checks if object from cache has sufficient data to be returned
     164     */
     165    protected boolean isObjectLoadable() {
     166        return data != null && data.length > 0;
     167    }
     168
     169    /**
     170     *
     171     * @return cache object as empty, regardless of what remote resource has returned (ex. based on headers)
     172     */
     173    protected boolean cacheAsEmpty() {
     174        return false;
     175    }
     176
     177    /**
     178     * @return key under which discovered server settings will be kept
     179     */
     180    protected String getServerKey() {
     181        return getUrl().getHost();
     182    }
     183
     184
     185    public void run() {
     186        final Thread currentThread = Thread.currentThread();
     187        final String oldName = currentThread.getName();
     188        currentThread.setName("JCS Downloading: " + getUrl());
     189        try {
     190            // try to load object from remote resource
     191            if (loadObject()) {
     192                finishLoading(true);
     193            } else {
     194                // if loading failed - check if we can return stale entry
     195                if (isObjectLoadable()) {
     196                    // try to get stale entry in cache
     197                    finishLoading(true);
     198                    log.log(Level.FINE, "JCS - found stale object in cache: {0}", getUrl());
     199                } else {
     200                    // failed completely
     201                    finishLoading(false);
     202                }
     203            }
     204        } finally {
     205            currentThread.setName(oldName);
     206        }
     207    }
     208
     209
     210    private void finishLoading(boolean success) {
     211        Set<ICachedLoaderListener> listeners = null;
     212        synchronized (inProgress) {
     213            listeners = inProgress.remove(getUrl());
     214        }
     215        if (listeners == null) {
     216            log.log(Level.WARNING, "Listener not found for URL: {0}. Listener not notified!", getUrl());
     217            return;
     218        }
     219        try {
     220            for (ICachedLoaderListener l: listeners) {
     221                l.loadingFinished(data, success);
     222            }
     223        } catch (Exception e) {
     224            log.log(Level.WARNING, "JCS - Error while loading object from cache: {0}; {1}", new Object[]{e.getMessage(), getUrl()});
     225            log.log(Level.FINE, "Stacktrace", e);
     226            for (ICachedLoaderListener l: listeners) {
     227                l.loadingFinished(data, false);
     228            }
     229
     230        }
     231
     232    }
     233
     234    private boolean isCacheElementValid() {
     235        long expires = attributes.getExpirationTime();
     236
     237        // check by expire date set by server
     238        if (expires != 0L) {
     239            // put a limit to the expire time (some servers send a value
     240            // that is too large)
     241            expires = Math.min(expires, attributes.getCreateTime() + EXPIRE_TIME_SERVER_LIMIT);
     242            if (now > expires) {
     243                log.log(Level.FINE, "JCS - Object {0} has expired -> valid to {1}, now is: {2}", new Object[]{getUrl(), Long.toString(expires), Long.toString(now)});
     244                return false;
     245            }
     246        } else {
     247            // check by file modification date
     248            if (now - attributes.getLastModification() > DEFAULT_EXPIRE_TIME) {
     249                log.log(Level.FINE, "JCS - Object has expired, maximum file age reached {0}", getUrl());
     250                return false;
     251            }
     252        }
     253        return true;
     254    }
     255
     256    private boolean loadObject() {
     257        try {
     258            // if we have object in cache, and host doesn't support If-Modified-Since nor If-None-Match
     259            // then just use HEAD request and check returned values
     260            if (isObjectLoadable() &&
     261                    Boolean.TRUE.equals(useHead.get(getServerKey())) &&
     262                    isCacheValidUsingHead()) {
     263                log.log(Level.FINE, "JCS - cache entry verified using HEAD request: {0}", getUrl());
     264                return true;
     265            }
     266            URLConnection urlConn = getURLConnection();
     267
     268            if (isObjectLoadable()  &&
     269                    (now - attributes.getLastModification()) <= ABSOLUTE_EXPIRE_TIME_LIMIT) {
     270                urlConn.setIfModifiedSince(attributes.getLastModification());
     271            }
     272            if (isObjectLoadable() && attributes.getEtag() != null) {
     273                urlConn.addRequestProperty("If-None-Match", attributes.getEtag());
     274            }
     275            if (urlConn instanceof HttpURLConnection && ((HttpURLConnection)urlConn).getResponseCode() == 304) {
     276                // If isModifiedSince or If-None-Match has been set
     277                // and the server answers with a HTTP 304 = "Not Modified"
     278                log.log(Level.FINE, "JCS - IfModifiedSince/Etag test: local version is up to date: {0}", getUrl());
     279                return true;
     280            } else if (isObjectLoadable()) {
     281                // we have an object in cache, but we haven't received 304 resposne code
     282                // check if we should use HEAD request to verify
     283                if((attributes.getEtag() != null && attributes.getEtag().equals(urlConn.getRequestProperty("ETag"))) ||
     284                        attributes.getLastModification() == urlConn.getLastModified()) {
     285                    // we sent ETag or If-Modified-Since, but didn't get 304 response code
     286                    // for further requests - use HEAD
     287                    String serverKey = getServerKey();
     288                    log.log(Level.INFO, "JCS - Host: {0} found not to return 304 codes for If-Modifed-Since or If-None-Match headers", serverKey);
     289                    useHead.put(serverKey, Boolean.TRUE);
     290                }
     291            }
     292
     293            attributes = parseHeaders(urlConn);
     294
     295            for (int i = 0; i < 5; ++i) {
     296                if (urlConn instanceof HttpURLConnection && ((HttpURLConnection)urlConn).getResponseCode() == 503) {
     297                    Thread.sleep(5000+(new Random()).nextInt(5000));
     298                    continue;
     299                }
     300                data = read(urlConn);
     301                synchronized (cache) { // FIXME: does it protect against corrupted cache files?
     302                    if (!cacheAsEmpty() && data != null && data.length > 0) {
     303                        cache.put(getCacheKey(), new CacheEntry(data), attributes);
     304                        log.log(Level.FINE, "JCS - downloaded key: {0}, length: {1}, url: {2}",
     305                                new Object[] {getCacheKey(), data.length, getUrl()});
     306                        return true;
     307                    } else {
     308                        log.log(Level.FINE, "JCS - Caching empty object {0}", getUrl());
     309                        cache.put(getCacheKey(), new CacheEntry(new byte[]{}), attributes);
     310                        return true;
     311                    }
     312                }
     313            }
     314        } catch (FileNotFoundException e) {
     315            log.log(Level.FINE, "JCS - Caching empty object as server returned 404 for: {0}", getUrl());
     316            cache.put(getCacheKey(), new CacheEntry(new byte[]{}), attributes);
     317            handleNotFound();
     318        } catch (Exception e) {
     319            log.log(Level.WARNING, "JCS - Exception during download " + getUrl(), e);
     320        }
     321        log.log(Level.WARNING, "JCS - Silent failure during download: {0}", getUrl());
     322        return false;
     323
     324    }
     325
     326    protected abstract void handleNotFound();
     327
     328    private CacheEntryAttributes parseHeaders(URLConnection urlConn) {
     329        CacheEntryAttributes ret = new CacheEntryAttributes();
     330        ret.setNoTileAtZoom("no-tile".equals(urlConn.getHeaderField("X-VE-Tile-Info")));
     331
     332        Long lng = urlConn.getExpiration();
     333        if (lng.equals(0L)) {
     334            try {
     335                String str = urlConn.getHeaderField("Cache-Control");
     336                if (str != null) {
     337                    for (String token: str.split(",")) {
     338                        if (token.startsWith("max-age=")) {
     339                            lng = Long.parseLong(token.substring(8)) * 1000 +
     340                                    System.currentTimeMillis();
     341                        }
     342                    }
     343                }
     344            } catch (NumberFormatException e) {} //ignore malformed Cache-Control headers
     345        }
     346
     347        ret.setExpirationTime(lng);
     348        ret.setLastModification(now);
     349        ret.setEtag(urlConn.getHeaderField("ETag"));
     350        return ret;
     351    }
     352
     353    private HttpURLConnection getURLConnection() throws IOException, MalformedURLException {
     354        HttpURLConnection urlConn = (HttpURLConnection) getUrl().openConnection();
     355        urlConn.setRequestProperty("Accept", "text/html, image/png, image/jpeg, image/gif, */*");
     356        urlConn.setReadTimeout(readTimeout); // 30 seconds read timeout
     357        urlConn.setConnectTimeout(connectTimeout);
     358        for(Map.Entry<String, String> e: headers.entrySet()) {
     359            urlConn.setRequestProperty(e.getKey(), e.getValue());
     360        }
     361        return urlConn;
     362    }
     363
     364    private boolean isCacheValidUsingHead() throws IOException {
     365        HttpURLConnection urlConn = (HttpURLConnection) getUrl().openConnection();
     366        urlConn.setRequestMethod("HEAD");
     367        long lastModified = urlConn.getLastModified();
     368        return (
     369                (attributes.getEtag() != null && attributes.getEtag().equals(urlConn.getRequestProperty("ETag"))) ||
     370                (lastModified != 0 && lastModified <= attributes.getLastModification())
     371                );
     372    }
     373
     374    private static byte[] read(URLConnection urlConn) throws IOException {
     375        InputStream input = urlConn.getInputStream();
     376        try {
     377            ByteArrayOutputStream bout = new ByteArrayOutputStream(input.available());
     378            byte[] buffer = new byte[2048];
     379            boolean finished = false;
     380            do {
     381                int read = input.read(buffer);
     382                if (read >= 0) {
     383                    bout.write(buffer, 0, read);
     384                } else {
     385                    finished = true;
     386                }
     387            } while (!finished);
     388            if (bout.size() == 0)
     389                return null;
     390            return bout.toByteArray();
     391        } finally {
     392            input.close();
     393        }
     394    }
     395}
  • src/org/openstreetmap/josm/data/cache/CacheEntryAttributes.java

     
     1// License: GPL. For details, see LICENSE file.
     2package org.openstreetmap.josm.data.cache;
     3
     4import java.util.HashMap;
     5import java.util.Map;
     6
     7import org.apache.commons.jcs.engine.ElementAttributes;
     8
     9public class CacheEntryAttributes extends ElementAttributes {
     10    private static final long serialVersionUID = 1L; //version
     11    private Map<String, String> attrs = new HashMap<String, String>();
     12    private final static String NO_TILE_AT_ZOOM = "noTileAtZoom";
     13    private final static String ETAG = "Etag";
     14    private final static String LAST_MODIFICATION = "lastModification";
     15    private final static String EXPIRATION_TIME = "expirationTime";
     16    //private boolean noTileAtZoom = false;
     17    private String Etag = null;
     18    private long lastModification = 0;
     19    private long expirationTime = 0;
     20
     21
     22    public CacheEntryAttributes() {
     23        super();
     24        attrs.put(NO_TILE_AT_ZOOM, "false");
     25        attrs.put(ETAG, null);
     26        attrs.put(LAST_MODIFICATION, "0");
     27        attrs.put(EXPIRATION_TIME, "0");
     28    }
     29    public boolean isNoTileAtZoom() {
     30        return Boolean.toString(true).equals(attrs.get(NO_TILE_AT_ZOOM));
     31    }
     32    public void setNoTileAtZoom(boolean noTileAtZoom) {
     33        attrs.put(NO_TILE_AT_ZOOM, Boolean.toString(noTileAtZoom));
     34    }
     35    public String getEtag() {
     36        return attrs.get(ETAG);
     37    }
     38    public void setEtag(String etag) {
     39        attrs.put(ETAG, etag);
     40    }
     41
     42    private long getLongAttr(String key) {
     43        try {
     44            return Long.parseLong(attrs.get(key));
     45        } catch (NumberFormatException e) {
     46            attrs.put(key, "0");
     47            return 0;
     48        }
     49    }
     50
     51    public long getLastModification() {
     52        return getLongAttr(LAST_MODIFICATION);
     53    }
     54    public void setLastModification(long lastModification) {
     55        attrs.put(LAST_MODIFICATION, Long.toString(lastModification));
     56    }
     57    public long getExpirationTime() {
     58        return getLongAttr(EXPIRATION_TIME);
     59    }
     60    public void setExpirationTime(long expirationTime) {
     61        attrs.put(EXPIRATION_TIME, Long.toString(expirationTime));
     62    }
     63
     64}
  • src/org/openstreetmap/josm/data/cache/ICachedLoaderJob.java

     
     1// License: GPL. For details, see LICENSE file.
     2package org.openstreetmap.josm.data.cache;
     3
     4import java.net.URL;
     5
     6
     7/**
     8 *
     9 * @author Wiktor Niesiobędzki
     10 *
     11 * @param <K> cache key type
     12 * @param <V> value that is returned from cache
     13 */
     14public interface ICachedLoaderJob<K> {
     15    /**
     16     * returns cache entry key
     17     *
     18     * @param tile
     19     * @return cache key for tile
     20     */
     21    public K getCacheKey();
     22
     23    /**
     24     * method to get download URL for Job
     25     * @return URL that should be fetched
     26     *
     27     */
     28    public URL getUrl();
     29    /**
     30     * implements the main algorithm for fetching
     31     */
     32    public void run();
     33
     34    /**
     35     * fetches object from cache, or returns null when object is not found
     36     *
     37     * @return filled tile with data or null when no cache entry found
     38     */
     39    public byte[] get();
     40
     41    /**
     42     * Submit job for background fetch, and listener will be
     43     * fed with value object
     44     *
     45     * @param listener
     46     */
     47    public void submit(ICachedLoaderListener listener);
     48}
  • src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoader.java

     
     1// License: GPL. For details, see LICENSE file.
     2package org.openstreetmap.josm.data.imagery;
     3
     4import java.io.IOException;
     5import java.util.Map;
     6
     7import org.apache.commons.jcs.access.behavior.ICacheAccess;
     8import org.openstreetmap.gui.jmapviewer.Tile;
     9import org.openstreetmap.gui.jmapviewer.interfaces.CachedTileLoader;
     10import org.openstreetmap.gui.jmapviewer.interfaces.TileJob;
     11import org.openstreetmap.gui.jmapviewer.interfaces.TileLoader;
     12import org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener;
     13import org.openstreetmap.josm.data.cache.CacheEntry;
     14import org.openstreetmap.josm.data.cache.JCSCacheManager;
     15import org.openstreetmap.josm.data.preferences.IntegerProperty;
     16
     17/**
     18 * @author Wiktor Niesiobędzki
     19 *
     20 * Wrapper class that bridges between JCS cache and Tile Loaders
     21 *
     22 */
     23public class TMSCachedTileLoader implements TileLoader, CachedTileLoader {
     24
     25    private ICacheAccess<String, CacheEntry> cache;
     26    private int connectTimeout;
     27    private int readTimeout;
     28    private Map<String, String> headers;
     29    private TileLoaderListener listener;
     30    public static final String PREFERENCE_PREFIX   = "imagery.tms.cache.";
     31    // average tile size is about 20kb
     32    public static IntegerProperty MAX_OBJECTS_IN_MEMORY = new IntegerProperty(PREFERENCE_PREFIX + "max_objects_memory", 1000); // 1000 is around 20MB under this assumptions
     33    public static IntegerProperty MAX_OBJECTS_ON_DISK = new IntegerProperty(PREFERENCE_PREFIX + "max_objects_disk", 25000); // 25000 is around 500MB under this assumptions
     34
     35    /**
     36     * Constructor
     37     * @param name of the cache
     38     * @param connectTimeout to remote resource
     39     * @param readTimeout to remote resource
     40     * @param headers to be sent along with request
     41     * @throws IOException when cache initialization fails
     42     */
     43    public TMSCachedTileLoader(TileLoaderListener listener, String name, int connectTimeout, int readTimeout, Map<String, String> headers) throws IOException {
     44        this.cache = JCSCacheManager.getCache(name, MAX_OBJECTS_IN_MEMORY.get(), MAX_OBJECTS_ON_DISK.get());
     45        this.connectTimeout = connectTimeout;
     46        this.readTimeout = readTimeout;
     47        this.headers = headers;
     48        this.listener = listener;
     49    }
     50
     51    @Override
     52    public TileJob createTileLoaderJob(Tile tile) {
     53        return new TMSCachedTileLoaderJob(listener, tile, cache, connectTimeout, readTimeout, headers);
     54    }
     55
     56    @Override
     57    public void clearCache() {
     58        this.cache.clear();
     59    }
     60}
  • src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoaderJob.java

     
     1// License: GPL. For details, see LICENSE file.
     2package org.openstreetmap.josm.data.imagery;
     3
     4import java.io.ByteArrayInputStream;
     5import java.io.IOException;
     6import java.net.URL;
     7import java.util.Map;
     8import java.util.logging.Level;
     9import java.util.logging.Logger;
     10
     11import org.apache.commons.jcs.access.behavior.ICacheAccess;
     12import org.openstreetmap.gui.jmapviewer.FeatureAdapter;
     13import org.openstreetmap.gui.jmapviewer.Tile;
     14import org.openstreetmap.gui.jmapviewer.interfaces.TileJob;
     15import org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener;
     16import org.openstreetmap.gui.jmapviewer.interfaces.TileSource;
     17import org.openstreetmap.gui.jmapviewer.tilesources.AbstractTMSTileSource;
     18import org.openstreetmap.josm.data.cache.CacheEntry;
     19import org.openstreetmap.josm.data.cache.ICachedLoaderListener;
     20import org.openstreetmap.josm.data.cache.JCSCachedTileLoaderJob;
     21
     22/**
     23 * @author Wiktor Niesiobędzki
     24 *
     25 * Class bridging TMS requests to JCS cache requests
     26 *
     27 */
     28public class TMSCachedTileLoaderJob extends JCSCachedTileLoaderJob<String> implements TileJob, ICachedLoaderListener  {
     29    private static final Logger log = FeatureAdapter.getLogger(TMSCachedTileLoaderJob.class.getCanonicalName());
     30    private Tile tile;
     31    private TileLoaderListener listener;
     32    private URL url;
     33
     34    /**
     35     * Constructor for creating a job, to get a specific tile from cache
     36     * @param listener
     37     * @param tile to be fetched from cache
     38     * @param cache object
     39     * @param connectTimeout when connecting to remote resource
     40     * @param readTimeout when connecting to remote resource
     41     * @param headers to be sent together with request
     42     */
     43    public TMSCachedTileLoaderJob(TileLoaderListener listener, Tile tile, ICacheAccess<String, CacheEntry> cache, int connectTimeout, int readTimeout,
     44            Map<String, String> headers) {
     45        super(cache, connectTimeout, readTimeout, headers);
     46        this.tile = tile;
     47        this.listener = listener;
     48        // URLs tend to change for some tile providers. Make a static reference here, so the tile URL might be used as a key
     49        // for request deduplication
     50        try {
     51            this.url = new URL(tile.getUrl());
     52        } catch (IOException e) {
     53            log.log(Level.WARNING, "JCS TMS Cache - error creating URL for tile {0}: {1}", new Object[] {tile.getKey(), e.getMessage()});
     54        }
     55
     56    }
     57
     58    @Override
     59    public Tile getTile() {
     60        return tile;
     61    }
     62
     63    @Override
     64    public String getCacheKey() {
     65        if (tile != null)
     66            return tile.getKey();
     67        return null;
     68    }
     69
     70    @Override
     71    public URL getUrl() {
     72        return url;
     73    }
     74
     75    @Override
     76    public boolean isObjectLoadable() {
     77        return (data != null && data.length > 0) || cacheAsEmpty();
     78    }
     79
     80    @Override
     81    protected boolean cacheAsEmpty() {
     82        if (attributes != null && attributes.isNoTileAtZoom()) {
     83            // do not remove file - keep the information, that there is no tile, for further requests
     84            // the code above will check, if this information is still valid
     85            log.log(Level.FINE, "JCS TMS - Tile valid, but no file, as no tiles at this level {0}", tile);
     86            tile.setError("No tile at this zoom level");
     87            tile.putValue("tile-info", "no-tile");
     88            return true;
     89        }
     90        return false;
     91    }
     92
     93    public void submit() {
     94        tile.initLoading();
     95        super.submit(this);
     96    }
     97
     98    @Override
     99    public void loadingFinished(byte[] object, boolean success) {
     100        try {
     101            tile.finishLoading();
     102            if (object != null && object.length > 0) {
     103                tile.loadImage(new ByteArrayInputStream(object));
     104            }
     105            if (listener != null) {
     106                listener.tileLoadingFinished(tile, success);
     107            }
     108        } catch (IOException e) {
     109            log.log(Level.WARNING, "JCS TMS - error loading object for tile {0}: {1}", new Object[] {tile.getKey(), e.getMessage()});
     110            tile.setError(e.getMessage());
     111            tile.setLoaded(false);
     112            if (listener != null) {
     113                listener.tileLoadingFinished(tile, false);
     114            }
     115        }
     116    }
     117
     118    /**
     119     * Method for getting the tile from cache only, without trying to reach remote resource
     120     * @return tile or null, if nothing (useful) was found in cache
     121     */
     122    public Tile getCachedTile() {
     123        byte[] data = super.get();
     124        if (isObjectLoadable()) {
     125            loadingFinished(data, true);
     126            return tile;
     127        } else {
     128            return null;
     129        }
     130    }
     131
     132    @Override
     133    protected void handleNotFound() {
     134        tile.setError("No tile at this zoom level");
     135        tile.putValue("tile-info", "no-tile");
     136    }
     137
     138    @Override
     139    protected String getServerKey() {
     140        TileSource ts = tile.getSource();
     141        if (ts instanceof AbstractTMSTileSource) {
     142            return ((AbstractTMSTileSource) ts).getBaseUrl();
     143        }
     144        return super.getServerKey();
     145    }
     146}
  • src/org/openstreetmap/josm/gui/layer/TMSLayer.java

     
    2121import java.net.URL;
    2222import java.util.ArrayList;
    2323import java.util.Collections;
    24 import java.util.HashSet;
     24import java.util.HashMap;
    2525import java.util.LinkedList;
    2626import java.util.List;
    2727import java.util.Map;
    28 import java.util.Map.Entry;
    2928import java.util.Scanner;
    30 import java.util.Set;
    3129import java.util.concurrent.Callable;
    3230import java.util.regex.Matcher;
    3331import java.util.regex.Pattern;
     
    4341import org.openstreetmap.gui.jmapviewer.Coordinate;
    4442import org.openstreetmap.gui.jmapviewer.JobDispatcher;
    4543import org.openstreetmap.gui.jmapviewer.MemoryTileCache;
    46 import org.openstreetmap.gui.jmapviewer.OsmFileCacheTileLoader;
    4744import org.openstreetmap.gui.jmapviewer.OsmTileLoader;
    48 import org.openstreetmap.gui.jmapviewer.TMSFileCacheTileLoader;
    4945import org.openstreetmap.gui.jmapviewer.Tile;
    5046import org.openstreetmap.gui.jmapviewer.interfaces.CachedTileLoader;
    51 import org.openstreetmap.gui.jmapviewer.interfaces.TileClearController;
     47import org.openstreetmap.gui.jmapviewer.interfaces.TileLoader;
    5248import org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener;
    5349import org.openstreetmap.gui.jmapviewer.interfaces.TileSource;
    5450import org.openstreetmap.gui.jmapviewer.tilesources.BingAerialTileSource;
    5551import org.openstreetmap.gui.jmapviewer.tilesources.ScanexTileSource;
    5652import org.openstreetmap.gui.jmapviewer.tilesources.TMSTileSource;
    5753import org.openstreetmap.gui.jmapviewer.tilesources.TemplatedTMSTileSource;
     54import org.openstreetmap.gui.jmapviewer.tilesources.TemplatedWMSTileSource;
    5855import org.openstreetmap.josm.Main;
    5956import org.openstreetmap.josm.actions.RenameLayerAction;
    6057import org.openstreetmap.josm.data.Bounds;
     
    6360import org.openstreetmap.josm.data.coor.LatLon;
    6461import org.openstreetmap.josm.data.imagery.ImageryInfo;
    6562import org.openstreetmap.josm.data.imagery.ImageryInfo.ImageryType;
     63import org.openstreetmap.josm.data.imagery.TMSCachedTileLoader;
    6664import org.openstreetmap.josm.data.osm.visitor.BoundingXYVisitor;
    6765import org.openstreetmap.josm.data.preferences.BooleanProperty;
    6866import org.openstreetmap.josm.data.preferences.IntegerProperty;
     
    7573import org.openstreetmap.josm.gui.dialogs.LayerListDialog;
    7674import org.openstreetmap.josm.gui.dialogs.LayerListPopup;
    7775import org.openstreetmap.josm.gui.progress.ProgressMonitor;
    78 import org.openstreetmap.josm.gui.progress.ProgressMonitor.CancelListener;
    7976import org.openstreetmap.josm.io.CacheCustomContent;
    8077import org.openstreetmap.josm.io.OsmTransferException;
    8178import org.openstreetmap.josm.io.UTFInputStreamReader;
     
    122119    }
    123120
    124121    public interface TileLoaderFactory {
    125         OsmTileLoader makeTileLoader(TileLoaderListener listener);
     122        TileLoader makeTileLoader(TileLoaderListener listener);
     123        TileLoader makeTileLoader(TileLoaderListener listener, Map<String, String> headers);
    126124    }
    127125
     126    // MemoryTileCache caches rendered tiles, to reduce latency during map panning
     127    // ImageIO.read() takes a lot of time, so we can't use JCS cache
    128128    protected MemoryTileCache tileCache;
    129129    protected TileSource tileSource;
    130     protected OsmTileLoader tileLoader;
     130    protected TileLoader tileLoader;
     131
    131132
    132133    public static TileLoaderFactory loaderFactory = new TileLoaderFactory() {
    133134        @Override
    134         public OsmTileLoader makeTileLoader(TileLoaderListener listener) {
    135             String cachePath = TMSLayer.PROP_TILECACHE_DIR.get();
    136             if (cachePath != null && !cachePath.isEmpty()) {
    137                 try {
    138                     OsmFileCacheTileLoader loader;
    139                     loader = new TMSFileCacheTileLoader(listener, new File(cachePath));
    140                     loader.headers.put("User-Agent", Version.getInstance().getFullAgentString());
    141                     return loader;
    142                 } catch (IOException e) {
    143                     Main.warn(e);
    144                 }
     135        public TileLoader makeTileLoader(TileLoaderListener listener, Map<String, String> inputHeaders) {
     136            Map<String, String> headers = new HashMap<>();
     137            headers.put("User-Agent", Version.getInstance().getFullAgentString());
     138            headers.put("Accept", "text/html, image/png, image/jpeg, image/gif, */*");
     139            if (inputHeaders != null)
     140                headers.putAll(inputHeaders);
     141
     142            try {
     143                return new TMSCachedTileLoader(listener, "TMS",
     144                        Main.pref.getInteger("socket.timeout.connect",15) * 1000,
     145                        Main.pref.getInteger("socket.timeout.read", 30) * 1000,
     146                        headers);
     147            } catch (IOException e) {
     148                Main.warn(e);
    145149            }
    146150            return null;
    147151        }
     152
     153        @Override
     154        public TileLoader makeTileLoader(TileLoaderListener listener) {
     155            return makeTileLoader(listener, null);
     156        }
    148157    };
    149158
    150159    /**
    151160     * Plugins that wish to set custom tile loader should call this method
    152161     */
     162
    153163    public static void setCustomTileLoaderFactory(TileLoaderFactory loaderFactory) {
    154164        TMSLayer.loaderFactory = loaderFactory;
    155165    }
    156166
    157     private Set<Tile> tileRequestsOutstanding = new HashSet<>();
    158 
    159167    @Override
    160168    public synchronized void tileLoadingFinished(Tile tile, boolean success) {
    161169        if (tile.hasError()) {
     
    165173        if (sharpenLevel != 0 && success) {
    166174            tile.setImage(sharpenImage(tile.getImage()));
    167175        }
    168         tile.setLoaded(true);
     176        tile.setLoaded(success);
    169177        needRedraw = true;
    170178        if (Main.map != null) {
    171179            Main.map.repaint(100);
    172180        }
    173         tileRequestsOutstanding.remove(tile);
    174181        if (Main.isDebugEnabled()) {
    175182            Main.debug("tileLoadingFinished() tile: " + tile + " success: " + success);
    176183        }
    177184    }
    178185
    179     private static class TmsTileClearController implements TileClearController, CancelListener {
    180 
    181         private final ProgressMonitor monitor;
    182         private boolean cancel = false;
    183 
    184         public TmsTileClearController(ProgressMonitor monitor) {
    185             this.monitor = monitor;
    186             this.monitor.addCancelListener(this);
    187         }
    188 
    189         @Override
    190         public void initClearDir(File dir) {
    191         }
    192 
    193         @Override
    194         public void initClearFiles(File[] files) {
    195             monitor.setTicksCount(files.length);
    196             monitor.setTicks(0);
    197         }
    198 
    199         @Override
    200         public boolean cancel() {
    201             return cancel;
    202         }
    203 
    204         @Override
    205         public void fileDeleted(File file) {
    206             monitor.setTicks(monitor.getTicks()+1);
    207         }
    208 
    209         @Override
    210         public void clearFinished() {
    211             monitor.finishTask();
    212         }
    213 
    214         @Override
    215         public void operationCanceled() {
    216             cancel = true;
    217         }
    218     }
    219 
    220186    /**
    221187     * Clears the tile cache.
    222188     *
     
    231197    void clearTileCache(ProgressMonitor monitor) {
    232198        tileCache.clear();
    233199        if (tileLoader instanceof CachedTileLoader) {
    234             ((CachedTileLoader)tileLoader).clearCache(tileSource, new TmsTileClearController(monitor));
     200            ((CachedTileLoader)tileLoader).clearCache();
    235201        }
    236202    }
    237203
     
    386352        return null;
    387353    }
    388354
     355    public TileSource getTileSourceNonStatic(ImageryInfo info) {
     356        return getTileSource(info);
     357    }
     358
    389359    /**
    390360     * Checks validity of given URL.
    391361     * @param url URL to check
     
    409379        }
    410380    }
    411381
    412     private void initTileSource(TileSource tileSource) {
     382    protected void initTileSource(TileSource tileSource) {
    413383        this.tileSource = tileSource;
    414384        attribution.initialize(tileSource);
    415 
    416385        currentZoomLevel = getBestZoom();
    417386
    418         tileCache = new MemoryTileCache();
    419 
    420         tileLoader = loaderFactory.makeTileLoader(this);
    421         if (tileLoader == null) {
    422             tileLoader = new OsmTileLoader(this);
    423         }
    424         tileLoader.timeoutConnect = Main.pref.getInteger("socket.timeout.connect",15) * 1000;
    425         tileLoader.timeoutRead = Main.pref.getInteger("socket.timeout.read", 30) * 1000;
     387        Map<String, String> headers = null;
    426388        if (tileSource instanceof TemplatedTMSTileSource) {
    427             for(Entry<String, String> e : ((TemplatedTMSTileSource)tileSource).getHeaders().entrySet()) {
    428                 tileLoader.headers.put(e.getKey(), e.getValue());
    429             }
     389            headers = (((TemplatedTMSTileSource)tileSource).getHeaders());
     390        }
     391
     392        if (tileSource instanceof TemplatedWMSTileSource) {
     393            headers = (((TemplatedWMSTileSource)tileSource).getHeaders());
    430394        }
    431         tileLoader.headers.put("User-Agent", Version.getInstance().getFullAgentString());
     395
     396        tileCache = new MemoryTileCache();
     397        tileLoader = loaderFactory.makeTileLoader(this, headers);
     398        if (tileLoader == null)
     399            tileLoader = new OsmTileLoader(this);
    432400    }
    433401
    434402    @Override
     
    487455        setMaxWorkers();
    488456        if(!isProjectionSupported(Main.getProjection())) {
    489457            JOptionPane.showMessageDialog(Main.parent,
    490                 tr("TMS layers do not support the projection {0}.\n{1}\n"
    491                 + "Change the projection or remove the layer.",
    492                 Main.getProjection().toCode(), nameSupportedProjections()),
    493                 tr("Warning"),
    494                 JOptionPane.WARNING_MESSAGE);
     458                    tr("TMS layers do not support the projection {0}.\n{1}\n"
     459                            + "Change the projection or remove the layer.",
     460                            Main.getProjection().toCode(), nameSupportedProjections()),
     461                            tr("Warning"),
     462                            JOptionPane.WARNING_MESSAGE);
    495463        }
    496464
    497465        setBackgroundLayer(true);
    498466        this.setVisible(true);
    499467
    500         TileSource source = getTileSource(info);
     468        TileSource source = getTileSourceNonStatic(info);
    501469        if (source == null)
    502470            throw new IllegalStateException("Cannot create TMSLayer with non-TMS ImageryInfo");
    503471        initTileSource(source);
     
    629597                new PleaseWaitRunnable(tr("Flush Tile Cache")) {
    630598                    @Override
    631599                    protected void realRun() throws SAXException, IOException,
    632                             OsmTransferException {
     600                    OsmTransferException {
    633601                        clearTileCache(getProgressMonitor());
    634602                    }
    635603
     
    685653        }
    686654        needRedraw = true;
    687655        JobDispatcher.getInstance().cancelOutstandingJobs();
    688         tileRequestsOutstanding.clear();
    689656    }
    690657
    691658    int getMaxZoomLvl() {
     
    770737     * are temporary only and intentionally not inserted
    771738     * into the tileCache.
    772739     */
    773     synchronized Tile tempCornerTile(Tile t) {
     740    Tile tempCornerTile(Tile t) {
    774741        int x = t.getXtile() + 1;
    775742        int y = t.getYtile() + 1;
    776743        int zoom = t.getZoom();
     
    780747        return new Tile(tileSource, x, y, zoom);
    781748    }
    782749
    783     synchronized Tile getOrCreateTile(int x, int y, int zoom) {
     750    Tile getOrCreateTile(int x, int y, int zoom) {
    784751        Tile tile = getTile(x, y, zoom);
    785752        if (tile == null) {
    786753            tile = new Tile(tileSource, x, y, zoom);
     
    794761     * This can and will return null for tiles that are not
    795762     * already in the cache.
    796763     */
    797     synchronized Tile getTile(int x, int y, int zoom) {
     764    Tile getTile(int x, int y, int zoom) {
    798765        int max = (1 << zoom);
    799766        if (x < 0 || x >= max || y < 0 || y >= max)
    800767            return null;
    801768        return tileCache.getTile(tileSource, x, y, zoom);
    802769    }
    803770
    804     synchronized boolean loadTile(Tile tile, boolean force) {
     771    boolean loadTile(Tile tile, boolean force) {
    805772        if (tile == null)
    806773            return false;
    807         if (!force && (tile.hasError() || tile.isLoaded()))
     774        if (!force && (tile.isLoaded() || tile.hasError()))
    808775            return false;
    809776        if (tile.isLoading())
    810777            return false;
    811         if (tileRequestsOutstanding.contains(tile))
    812             return false;
    813         tileRequestsOutstanding.add(tile);
    814         JobDispatcher.getInstance().addJob(tileLoader.createTileLoaderJob(tile));
     778        tileLoader.createTileLoaderJob(tile).submit();
    815779        return true;
    816780    }
    817781
     
    12681232        public TileSet getTileSet(int zoom) {
    12691233            if (zoom < minZoom)
    12701234                return nullTileSet;
    1271             TileSet ts = tileSets[zoom-minZoom];
    1272             if (ts == null) {
    1273                 ts = new TileSet(topLeft, botRight, zoom);
    1274                 tileSets[zoom-minZoom] = ts;
     1235            synchronized (tileSets) {
     1236                TileSet ts = tileSets[zoom-minZoom];
     1237                if (ts == null) {
     1238                    ts = new TileSet(topLeft, botRight, zoom);
     1239                    tileSets[zoom-minZoom] = ts;
     1240                }
     1241                return ts;
    12751242            }
    1276             return ts;
    12771243        }
     1244
    12781245        public TileSetInfo getTileSetInfo(int zoom) {
    12791246            if (zoom < minZoom)
    12801247                return new TileSetInfo();
    1281             TileSetInfo tsi = tileSetInfos[zoom-minZoom];
    1282             if (tsi == null) {
    1283                 tsi = TMSLayer.getTileSetInfo(getTileSet(zoom));
    1284                 tileSetInfos[zoom-minZoom] = tsi;
     1248            synchronized (tileSetInfos) {
     1249                TileSetInfo tsi = tileSetInfos[zoom-minZoom];
     1250                if (tsi == null) {
     1251                    tsi = TMSLayer.getTileSetInfo(getTileSet(zoom));
     1252                    tileSetInfos[zoom-minZoom] = tsi;
     1253                }
     1254                return tsi;
    12851255            }
    1286             return tsi;
    12871256        }
    12881257    }
    12891258
    12901259    @Override
    12911260    public void paint(Graphics2D g, MapView mv, Bounds bounds) {
    1292         //long start = System.currentTimeMillis();
    12931261        EastNorth topLeft = mv.getEastNorth(0, 0);
    12941262        EastNorth botRight = mv.getEastNorth(mv.getWidth(), mv.getHeight());
    12951263
  • src/org/openstreetmap/josm/gui/bbox/SlippyMapBBoxChooser.java

     
    2525import org.openstreetmap.gui.jmapviewer.MemoryTileCache;
    2626import org.openstreetmap.gui.jmapviewer.OsmTileLoader;
    2727import org.openstreetmap.gui.jmapviewer.interfaces.MapMarker;
     28import org.openstreetmap.gui.jmapviewer.interfaces.TileLoader;
    2829import org.openstreetmap.gui.jmapviewer.interfaces.TileSource;
    2930import org.openstreetmap.gui.jmapviewer.tilesources.MapQuestOpenAerialTileSource;
    3031import org.openstreetmap.gui.jmapviewer.tilesources.MapQuestOsmTileSource;
     
    113114    private static final StringProperty PROP_MAPSTYLE = new StringProperty("slippy_map_chooser.mapstyle", "Mapnik");
    114115    public static final String RESIZE_PROP = SlippyMapBBoxChooser.class.getName() + ".resize";
    115116
    116     private OsmTileLoader cachedLoader;
     117    private TileLoader cachedLoader;
    117118    private OsmTileLoader uncachedLoader;
    118119
    119120    private final SizeButton iSizeButton;
  • src/org/openstreetmap/gui/jmapviewer/TMSFileCacheTileLoader.java

     
    1 // License: GPL. For details, see Readme.txt file.
    2 package org.openstreetmap.gui.jmapviewer;
    3 
    4 import java.io.File;
    5 import java.io.IOException;
    6 import org.openstreetmap.gui.jmapviewer.interfaces.TileJob;
    7 import org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener;
    8 import org.openstreetmap.gui.jmapviewer.interfaces.TileSource;
    9 
    10 /**
    11  * Reworked version of the OsmFileCacheTileLoader.
    12  *
    13  * When class OsmFileCacheTileLoader is no longer needed, it can be integrated
    14  * here and removed.
    15  */
    16 public class TMSFileCacheTileLoader extends OsmFileCacheTileLoader {
    17 
    18     public TMSFileCacheTileLoader(TileLoaderListener map, File cacheDir) throws IOException {
    19         super(map, cacheDir);
    20     }
    21 
    22     @Override
    23     public TileJob createTileLoaderJob(final Tile tile) {
    24         return new TMSFileLoadJob(tile);
    25     }
    26 
    27     protected class TMSFileLoadJob extends FileLoadJob {
    28 
    29         public TMSFileLoadJob(Tile tile) {
    30             super(tile);
    31         }
    32 
    33         @Override
    34         protected File getTileFile() {
    35             return getDataFile(tile.getSource().getTileType());
    36         }
    37 
    38         @Override
    39         protected File getTagsFile() {
    40             return getDataFile(TAGS_FILE_EXT);
    41         }
    42 
    43         protected File getDataFile(String ext) {
    44             int nDigits = (int) Math.ceil(Math.log10(1 << tile.getZoom()));
    45             String x = String.format("%0" + nDigits + "d", tile.getXtile());
    46             String y = String.format("%0" + nDigits + "d", tile.getYtile());
    47             File path = new File(tileCacheDir, "z" + tile.getZoom());
    48             for (int i=0; i<nDigits; i++) {
    49                 String component = "x" + x.substring(i, i+1) + "y" + y.substring(i, i+1);
    50                 if (i == nDigits -1 ) {
    51                     component += "." + ext;
    52                 }
    53                 path = new File(path, component);
    54             }
    55             return path;
    56         }
    57     }
    58 
    59     @Override
    60     protected File getSourceCacheDir(TileSource source) {
    61         File dir = sourceCacheDirMap.get(source);
    62         if (dir == null) {
    63             String id = source.getId();
    64             if (id != null) {
    65                 dir = new File(cacheDirBase, id);
    66             } else {
    67                 dir = new File(cacheDirBase, source.getName().replaceAll("[\\\\/:*?\"<>|]", "_"));
    68             }
    69             if (!dir.exists()) {
    70                 dir.mkdirs();
    71             }
    72         }
    73         return dir;
    74     }
    75 
    76 }
  • src/org/openstreetmap/gui/jmapviewer/OsmFileCacheTileLoader.java

     
    1 // License: GPL. For details, see Readme.txt file.
    2 package org.openstreetmap.gui.jmapviewer;
    3 
    4 import java.io.BufferedReader;
    5 import java.io.ByteArrayInputStream;
    6 import java.io.ByteArrayOutputStream;
    7 import java.io.File;
    8 import java.io.FileInputStream;
    9 import java.io.FileNotFoundException;
    10 import java.io.FileOutputStream;
    11 import java.io.IOException;
    12 import java.io.InputStream;
    13 import java.io.InputStreamReader;
    14 import java.io.OutputStreamWriter;
    15 import java.io.PrintWriter;
    16 import java.net.HttpURLConnection;
    17 import java.net.URL;
    18 import java.net.URLConnection;
    19 import java.nio.charset.Charset;
    20 import java.util.HashMap;
    21 import java.util.Map;
    22 import java.util.Map.Entry;
    23 import java.util.Random;
    24 import java.util.logging.Level;
    25 import java.util.logging.Logger;
    26 
    27 import org.openstreetmap.gui.jmapviewer.interfaces.CachedTileLoader;
    28 import org.openstreetmap.gui.jmapviewer.interfaces.TileClearController;
    29 import org.openstreetmap.gui.jmapviewer.interfaces.TileJob;
    30 import org.openstreetmap.gui.jmapviewer.interfaces.TileLoader;
    31 import org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener;
    32 import org.openstreetmap.gui.jmapviewer.interfaces.TileSource;
    33 import org.openstreetmap.gui.jmapviewer.interfaces.TileSource.TileUpdate;
    34 
    35 /**
    36  * A {@link TileLoader} implementation that loads tiles from OSM via HTTP and
    37  * saves all loaded files in a directory located in the temporary directory.
    38  * If a tile is present in this file cache it will not be loaded from OSM again.
    39  *
    40  * @author Jan Peter Stotz
    41  * @author Stefan Zeller
    42  */
    43 public class OsmFileCacheTileLoader extends OsmTileLoader implements CachedTileLoader {
    44 
    45     private static final Logger log = FeatureAdapter.getLogger(OsmFileCacheTileLoader.class.getName());
    46 
    47     protected static final String TAGS_FILE_EXT = "tags";
    48 
    49     private static final Charset TAGS_CHARSET = Charset.forName("UTF-8");
    50 
    51     // Default expire time (i.e. maximum age of cached tile before refresh).
    52     // Used when the server does not send an expires or max-age value in the http header.
    53     protected static final long DEFAULT_EXPIRE_TIME = 1000L * 60 * 60 * 24 * 7; // 7 days
    54     // Limit for the max-age value send by the server.
    55     protected static final long EXPIRE_TIME_SERVER_LIMIT = 1000L * 60 * 60 * 24 * 28; // 4 weeks
    56     // Absolute expire time limit. Cached tiles that are older will not be used,
    57     // even if the refresh from the server fails.
    58     protected static final long ABSOLUTE_EXPIRE_TIME_LIMIT = Long.MAX_VALUE; // unlimited
    59 
    60     protected String cacheDirBase;
    61 
    62     protected final Map<TileSource, File> sourceCacheDirMap;
    63 
    64 
    65     public static File getDefaultCacheDir() throws SecurityException {
    66         String tempDir = null;
    67         String userName = System.getProperty("user.name");
    68         try {
    69             tempDir = System.getProperty("java.io.tmpdir");
    70         } catch (SecurityException e) {
    71             log.log(Level.WARNING,
    72                     "Failed to access system property ''java.io.tmpdir'' for security reasons. Exception was: "
    73                         + e.toString());
    74             throw e; // rethrow
    75         }
    76         try {
    77             if (tempDir == null)
    78                 throw new IOException("No temp directory set");
    79             String subDirName = "JMapViewerTiles";
    80             // On Linux/Unix systems we do not have a per user tmp directory.
    81             // Therefore we add the user name for getting a unique dir name.
    82             if (userName != null && userName.length() > 0) {
    83                 subDirName += "_" + userName;
    84             }
    85             File cacheDir = new File(tempDir, subDirName);
    86             return cacheDir;
    87         } catch (Exception e) {
    88         }
    89         return null;
    90     }
    91 
    92     /**
    93      * Create a OSMFileCacheTileLoader with given cache directory.
    94      * If cacheDir is not set or invalid, IOException will be thrown.
    95      * @param map the listener checking for tile load events (usually the map for display)
    96      * @param cacheDir directory to store cached tiles
    97      */
    98     public OsmFileCacheTileLoader(TileLoaderListener map, File cacheDir) throws IOException  {
    99         super(map);
    100         if (cacheDir == null || (!cacheDir.exists() && !cacheDir.mkdirs()))
    101             throw new IOException("Cannot access cache directory");
    102 
    103         log.finest("Tile cache directory: " + cacheDir);
    104         cacheDirBase = cacheDir.getAbsolutePath();
    105         sourceCacheDirMap = new HashMap<>();
    106     }
    107 
    108     /**
    109      * Create a OSMFileCacheTileLoader with system property temp dir.
    110      * If not set an IOException will be thrown.
    111      * @param map the listener checking for tile load events (usually the map for display)
    112      */
    113     public OsmFileCacheTileLoader(TileLoaderListener map) throws SecurityException, IOException {
    114         this(map, getDefaultCacheDir());
    115     }
    116 
    117     @Override
    118     public TileJob createTileLoaderJob(final Tile tile) {
    119         return new FileLoadJob(tile);
    120     }
    121 
    122     protected File getSourceCacheDir(TileSource source) {
    123         File dir = sourceCacheDirMap.get(source);
    124         if (dir == null) {
    125             dir = new File(cacheDirBase, source.getName().replaceAll("[\\\\/:*?\"<>|]", "_"));
    126             if (!dir.exists()) {
    127                 dir.mkdirs();
    128             }
    129         }
    130         return dir;
    131     }
    132 
    133     protected class FileLoadJob implements TileJob {
    134         InputStream input = null;
    135 
    136         Tile tile;
    137         File tileCacheDir;
    138         File tileFile = null;
    139         File tagsFile = null;
    140         Long fileMtime = null;
    141         Long now = null; // current time in milliseconds (keep consistent value for the whole run)
    142 
    143         public FileLoadJob(Tile tile) {
    144             this.tile = tile;
    145         }
    146 
    147         @Override
    148         public Tile getTile() {
    149             return tile;
    150         }
    151 
    152         @Override
    153         public void run() {
    154             synchronized (tile) {
    155                 if ((tile.isLoaded() && !tile.hasError()) || tile.isLoading())
    156                     return;
    157                 tile.loaded = false;
    158                 tile.error = false;
    159                 tile.loading = true;
    160             }
    161             now = System.currentTimeMillis();
    162             tileCacheDir = getSourceCacheDir(tile.getSource());
    163             tileFile = getTileFile();
    164             tagsFile = getTagsFile();
    165 
    166             loadTagsFromFile();
    167 
    168             if (isCacheValid() && (isNoTileAtZoom() || loadTileFromFile())) {
    169                 log.log(Level.FINE, "TMS - found in tile cache: {0}", tile);
    170                 tile.setLoaded(true);
    171                 listener.tileLoadingFinished(tile, true);
    172                 return;
    173             }
    174 
    175             TileJob job = new TileJob() {
    176 
    177                 @Override
    178                 public void run() {
    179                     if (loadOrUpdateTile()) {
    180                         tile.setLoaded(true);
    181                         listener.tileLoadingFinished(tile, true);
    182                     } else {
    183                         // failed to download - use old cache file if available
    184                         if (isNoTileAtZoom() || loadTileFromFile()) {
    185                             tile.setLoaded(true);
    186                             tile.error = false;
    187                             listener.tileLoadingFinished(tile, true);
    188                             log.log(Level.FINE, "TMS - found stale tile in cache: {0}", tile);
    189                         } else {
    190                             // failed completely
    191                             tile.setLoaded(true);
    192                             listener.tileLoadingFinished(tile, false);
    193                         }
    194                     }
    195                 }
    196                 @Override
    197                 public Tile getTile() {
    198                     return tile;
    199                 }
    200             };
    201             JobDispatcher.getInstance().addJob(job);
    202         }
    203 
    204         protected boolean loadOrUpdateTile() {
    205             try {
    206                 URLConnection urlConn = loadTileFromOsm(tile);
    207                 if (fileMtime != null && now - fileMtime <= ABSOLUTE_EXPIRE_TIME_LIMIT) {
    208                     switch (tile.getSource().getTileUpdate()) {
    209                     case IfModifiedSince:
    210                         urlConn.setIfModifiedSince(fileMtime);
    211                         break;
    212                     case LastModified:
    213                         if (!isOsmTileNewer(fileMtime)) {
    214                             log.log(Level.FINE, "TMS - LastModified test: local version is up to date: {0}", tile);
    215                             tileFile.setLastModified(now);
    216                             return true;
    217                         }
    218                         break;
    219                     default:
    220                         break;
    221                     }
    222                 }
    223                 if (tile.getSource().getTileUpdate() == TileUpdate.ETag || tile.getSource().getTileUpdate() == TileUpdate.IfNoneMatch) {
    224                     String fileETag = tile.getValue("etag");
    225                     if (fileETag != null) {
    226                         switch (tile.getSource().getTileUpdate()) {
    227                         case IfNoneMatch:
    228                             urlConn.addRequestProperty("If-None-Match", fileETag);
    229                             break;
    230                         case ETag:
    231                             if (hasOsmTileETag(fileETag)) {
    232                                 log.log(Level.FINE, "TMS - ETag test: local version is up to date: {0}", tile);
    233                                 tileFile.setLastModified(now);
    234                                 return true;
    235                             }
    236                         default:
    237                             break;
    238                         }
    239                     }
    240                     tile.putValue("etag", urlConn.getHeaderField("ETag"));
    241                 }
    242                 if (urlConn instanceof HttpURLConnection && ((HttpURLConnection)urlConn).getResponseCode() == 304) {
    243                     // If isModifiedSince or If-None-Match has been set
    244                     // and the server answers with a HTTP 304 = "Not Modified"
    245                     switch (tile.getSource().getTileUpdate()) {
    246                     case IfModifiedSince:
    247                         log.log(Level.FINE, "TMS - IfModifiedSince test: local version is up to date: {0}", tile);
    248                         break;
    249                     case IfNoneMatch:
    250                         log.log(Level.FINE, "TMS - IfNoneMatch test: local version is up to date: {0}", tile);
    251                         break;
    252                     default:
    253                         break;
    254                     }
    255                     loadTileFromFile();
    256                     tileFile.setLastModified(now);
    257                     return true;
    258                 }
    259 
    260                 loadTileMetadata(tile, urlConn);
    261                 saveTagsToFile();
    262 
    263                 if ("no-tile".equals(tile.getValue("tile-info")))
    264                 {
    265                     log.log(Level.FINE, "TMS - No tile: tile-info=no-tile: {0}", tile);
    266                     tile.setError("No tile at this zoom level");
    267                     return true;
    268                 } else {
    269                     for (int i = 0; i < 5; ++i) {
    270                         if (urlConn instanceof HttpURLConnection && ((HttpURLConnection)urlConn).getResponseCode() == 503) {
    271                             Thread.sleep(5000+(new Random()).nextInt(5000));
    272                             continue;
    273                         }
    274                         byte[] buffer = loadTileInBuffer(urlConn);
    275                         if (buffer != null) {
    276                             tile.loadImage(new ByteArrayInputStream(buffer));
    277                             saveTileToFile(buffer);
    278                             log.log(Level.FINE, "TMS - downloaded tile from server: {0}", tile.getUrl());
    279                             return true;
    280                         }
    281                     }
    282                 }
    283             } catch (Exception e) {
    284                 tile.setError(e.getMessage());
    285                 if (input == null) {
    286                     try {
    287                         log.log(Level.WARNING, "TMS - Failed downloading {0}: {1}", new Object[]{tile.getUrl(), e.getMessage()});
    288                         return false;
    289                     } catch(IOException i) {
    290                     }
    291                 }
    292             }
    293             log.log(Level.WARNING, "TMS - Failed downloading tile: {0}", tile);
    294             return false;
    295         }
    296 
    297         protected boolean isCacheValid() {
    298             Long expires = null;
    299             if (tileFile.exists()) {
    300                 fileMtime = tileFile.lastModified();
    301             } else if (tagsFile.exists()) {
    302                 fileMtime = tagsFile.lastModified();
    303             } else
    304                 return false;
    305 
    306             try {
    307                 expires = Long.parseLong(tile.getValue("expires"));
    308             } catch (NumberFormatException e) {}
    309 
    310             // check by expire date set by server
    311             if (expires != null && !expires.equals(0L)) {
    312                 // put a limit to the expire time (some servers send a value
    313                 // that is too large)
    314                 expires = Math.min(expires, fileMtime + EXPIRE_TIME_SERVER_LIMIT);
    315                 if (now > expires) {
    316                     log.log(Level.FINE, "TMS - Tile has expired -> not valid {0}", tile);
    317                     return false;
    318                 }
    319             } else {
    320                 // check by file modification date
    321                 if (now - fileMtime > DEFAULT_EXPIRE_TIME) {
    322                     log.log(Level.FINE, "TMS - Tile has expired, maximum file age reached {0}", tile);
    323                     return false;
    324                 }
    325             }
    326             return true;
    327         }
    328 
    329         protected boolean isNoTileAtZoom() {
    330             if ("no-tile".equals(tile.getValue("tile-info"))) {
    331                 // do not remove file - keep the information, that there is no tile, for further requests
    332                 // the code above will check, if this information is still valid
    333                 log.log(Level.FINE, "TMS - Tile valid, but no file, as no tiles at this level {0}", tile);
    334                 tile.setError("No tile at this zoom level");
    335                 return true;
    336             }
    337             return false;
    338         }
    339 
    340         protected boolean loadTileFromFile() {
    341             if (!tileFile.exists())
    342                 return false;
    343 
    344             try (FileInputStream fin = new FileInputStream(tileFile)) {
    345                 if (fin.available() == 0)
    346                     throw new IOException("File empty");
    347                 tile.loadImage(fin);
    348                 return true;
    349             } catch (Exception e) {
    350                 log.log(Level.WARNING, "TMS - Error while loading image from tile cache: {0}; {1}", new Object[]{e.getMessage(), tile});
    351                 tileFile.delete();
    352                 if (tagsFile.exists()) {
    353                     tagsFile.delete();
    354                 }
    355                 tileFile = null;
    356                 fileMtime = null;
    357             }
    358             return false;
    359         }
    360 
    361         protected byte[] loadTileInBuffer(URLConnection urlConn) throws IOException {
    362             input = urlConn.getInputStream();
    363             try {
    364                 ByteArrayOutputStream bout = new ByteArrayOutputStream(input.available());
    365                 byte[] buffer = new byte[2048];
    366                 boolean finished = false;
    367                 do {
    368                     int read = input.read(buffer);
    369                     if (read >= 0) {
    370                         bout.write(buffer, 0, read);
    371                     } else {
    372                         finished = true;
    373                     }
    374                 } while (!finished);
    375                 if (bout.size() == 0)
    376                     return null;
    377                 return bout.toByteArray();
    378             } finally {
    379                 input.close();
    380                 input = null;
    381             }
    382         }
    383 
    384         /**
    385          * Performs a <code>HEAD</code> request for retrieving the
    386          * <code>LastModified</code> header value.
    387          *
    388          * Note: This does only work with servers providing the
    389          * <code>LastModified</code> header:
    390          * <ul>
    391          * <li>{@link org.openstreetmap.gui.jmapviewer.tilesources.OsmTileSource.CycleMap} - supported</li>
    392          * <li>{@link org.openstreetmap.gui.jmapviewer.tilesources.OsmTileSource.Mapnik} - not supported</li>
    393          * </ul>
    394          *
    395          * @param fileAge time of the
    396          * @return <code>true</code> if the tile on the server is newer than the
    397          *         file
    398          * @throws IOException
    399          */
    400         protected boolean isOsmTileNewer(long fileAge) throws IOException {
    401             URL url;
    402             url = new URL(tile.getUrl());
    403             HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();
    404             prepareHttpUrlConnection(urlConn);
    405             urlConn.setRequestMethod("HEAD");
    406             urlConn.setReadTimeout(30000); // 30 seconds read timeout
    407             // System.out.println("Tile age: " + new
    408             // Date(urlConn.getLastModified()) + " / "
    409             // + new Date(fileMtime));
    410             long lastModified = urlConn.getLastModified();
    411             if (lastModified == 0)
    412                 return true; // no LastModified time returned
    413             return (lastModified > fileAge);
    414         }
    415 
    416         protected boolean hasOsmTileETag(String eTag) throws IOException {
    417             URL url;
    418             url = new URL(tile.getUrl());
    419             HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();
    420             prepareHttpUrlConnection(urlConn);
    421             urlConn.setRequestMethod("HEAD");
    422             urlConn.setReadTimeout(30000); // 30 seconds read timeout
    423             // System.out.println("Tile age: " + new
    424             // Date(urlConn.getLastModified()) + " / "
    425             // + new Date(fileMtime));
    426             String osmETag = urlConn.getHeaderField("ETag");
    427             if (osmETag == null)
    428                 return true;
    429             return (osmETag.equals(eTag));
    430         }
    431 
    432         protected File getTileFile() {
    433             return new File(tileCacheDir + "/" + tile.getZoom() + "_" + tile.getXtile() + "_" + tile.getYtile() + "."
    434                     + tile.getSource().getTileType());
    435         }
    436 
    437         protected File getTagsFile() {
    438             return new File(tileCacheDir + "/" + tile.getZoom() + "_" + tile.getXtile() + "_" + tile.getYtile() + "."
    439                     + TAGS_FILE_EXT);
    440         }
    441 
    442         protected void saveTileToFile(byte[] rawData) {
    443             File file = getTileFile();
    444             file.getParentFile().mkdirs();
    445             try (FileOutputStream f = new FileOutputStream(file)) {
    446                 f.write(rawData);
    447             } catch (Exception e) {
    448                 log.log(Level.SEVERE, "Failed to save tile content: {0}", e.getLocalizedMessage());
    449             }
    450         }
    451 
    452         protected void saveTagsToFile() {
    453             File tagsFile = getTagsFile();
    454             tagsFile.getParentFile().mkdirs();
    455             if (tile.getMetadata() == null) {
    456                 tagsFile.delete();
    457                 return;
    458             }
    459             try (PrintWriter f = new PrintWriter(new OutputStreamWriter(new FileOutputStream(tagsFile), TAGS_CHARSET))) {
    460                 for (Entry<String, String> entry : tile.getMetadata().entrySet()) {
    461                     f.println(entry.getKey() + "=" + entry.getValue());
    462                 }
    463             } catch (Exception e) {
    464                 System.err.println("Failed to save tile tags: " + e.getLocalizedMessage());
    465             }
    466         }
    467 
    468         protected boolean loadTagsFromFile() {
    469             File tagsFile = getTagsFile();
    470             try (BufferedReader f = new BufferedReader(new InputStreamReader(new FileInputStream(tagsFile), TAGS_CHARSET))) {
    471                 for (String line = f.readLine(); line != null; line = f.readLine()) {
    472                     final int i = line.indexOf('=');
    473                     if (i == -1 || i == 0) {
    474                         System.err.println("Malformed tile tag in file '" + tagsFile.getName() + "':" + line);
    475                         continue;
    476                     }
    477                     tile.putValue(line.substring(0,i),line.substring(i+1));
    478                 }
    479             } catch (FileNotFoundException e) {
    480             } catch (Exception e) {
    481                 System.err.println("Failed to load tile tags: " + e.getLocalizedMessage());
    482             }
    483 
    484             return true;
    485         }
    486     }
    487 
    488     public String getCacheDirBase() {
    489         return cacheDirBase;
    490     }
    491 
    492     public void setTileCacheDir(String tileCacheDir) {
    493         File dir = new File(tileCacheDir);
    494         dir.mkdirs();
    495         this.cacheDirBase = dir.getAbsolutePath();
    496     }
    497 
    498     @Override
    499     public void clearCache(TileSource source) {
    500         clearCache(source, null);
    501     }
    502 
    503     @Override
    504     public void clearCache(TileSource source, TileClearController controller) {
    505         File dir = getSourceCacheDir(source);
    506         if (dir != null) {
    507             if (controller != null) controller.initClearDir(dir);
    508             if (dir.isDirectory()) {
    509                 File[] files = dir.listFiles();
    510                 if (controller != null) controller.initClearFiles(files);
    511                 for (File file : files) {
    512                     if (controller != null && controller.cancel()) return;
    513                     file.delete();
    514                     if (controller != null) controller.fileDeleted(file);
    515                 }
    516             }
    517             dir.delete();
    518         }
    519         if (controller != null) controller.clearFinished();
    520     }
    521 }
  • src/org/openstreetmap/gui/jmapviewer/interfaces/TileJob.java

     
    1717     * @return {@link Tile} to be handled
    1818     */
    1919    public Tile getTile();
     20
     21    /**
     22     * submits download job to backend.
     23     */
     24    void submit();
    2025}
  • src/org/openstreetmap/gui/jmapviewer/interfaces/CachedTileLoader.java

     
    55 * Interface that allow cleaning the tile cache without specifying exact type of loader
    66 */
    77public interface CachedTileLoader {
    8     public void clearCache(TileSource source);
    9     public void clearCache(TileSource source, TileClearController controller);
     8    public void clearCache();
    109}
  • src/org/openstreetmap/gui/jmapviewer/Demo.java

     
    1010import java.awt.event.ItemListener;
    1111import java.awt.event.MouseAdapter;
    1212import java.awt.event.MouseEvent;
    13 import java.io.IOException;
    1413
    1514import javax.swing.JButton;
    1615import javax.swing.JCheckBox;
     
    101100            }
    102101        });
    103102        JComboBox<TileLoader> tileLoaderSelector;
    104         try {
    105             tileLoaderSelector = new JComboBox<>(new TileLoader[] { new OsmFileCacheTileLoader(map()), new OsmTileLoader(map()) });
    106         } catch (IOException e) {
    107             tileLoaderSelector = new JComboBox<>(new TileLoader[] { new OsmTileLoader(map()) });
    108         }
     103        tileLoaderSelector = new JComboBox<>(new TileLoader[] { new OsmTileLoader(map()) });
    109104        tileLoaderSelector.addItemListener(new ItemListener() {
    110105            public void itemStateChanged(ItemEvent e) {
    111106                map().setTileLoader((TileLoader) e.getItem());
  • src/org/openstreetmap/gui/jmapviewer/TileController.java

     
    4545            tile.loadPlaceholderFromCache(tileCache);
    4646        }
    4747        if (!tile.isLoaded()) {
    48             jobDispatcher.addJob(tileLoader.createTileLoaderJob(tile));
     48            tileLoader.createTileLoaderJob(tile).submit();
    4949        }
    5050        return tile;
    5151    }
  • src/org/openstreetmap/gui/jmapviewer/JMapViewer.java

     
    985985    }
    986986
    987987    public void tileLoadingFinished(Tile tile, boolean success) {
     988        tile.setLoaded(success);
    988989        repaint();
    989990    }
    990991
  • src/org/openstreetmap/gui/jmapviewer/OsmTileLoader.java

     
    8585            public Tile getTile() {
    8686                return tile;
    8787            }
     88
     89            @Override
     90            public void submit() {
     91                run();
     92
     93            }
    8894        };
    8995    }
    9096