Ticket #11216: jcs-tms-v03.patch

File jcs-tms-v03.patch, 84.4 KB (added by wiktorn, 4 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"
     
    581589        </java>
    582590    </target>
    583591</project>
     592
  • 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.util.Properties;
     7import java.util.logging.Level;
     8import java.util.logging.Logger;
     9
     10import org.apache.commons.jcs.access.CacheAccess;
     11import org.apache.commons.jcs.auxiliary.AuxiliaryCache;
     12import org.apache.commons.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes;
     13import org.apache.commons.jcs.engine.control.CompositeCache;
     14import org.apache.commons.jcs.engine.control.CompositeCacheManager;
     15import org.openstreetmap.josm.Main;
     16
     17
     18/**
     19 * @author Wiktor Niesiobędzki
     20 *
     21 * Wrapper class for JCS Cache. Sets some sane environment and returns instances of cache objects.
     22 * Static configuration for now assumes some small LRU cache in memory and larger LRU cache on disk
     23 *
     24 */
     25public class JCSCacheManager {
     26
     27    private static volatile CompositeCacheManager cacheManager = null;
     28    private static long maxObjectTTL        = Long.MAX_VALUE;
     29
     30    private static int maxObjectsInMemory  = 1000;
     31    private static int maxObjectsOnDisk    = 25000;
     32
     33    private static void initialize() throws IOException {
     34        File cacheDir = new File(Main.pref.getCacheDirectory(), "jcs");
     35
     36        if ((!cacheDir.exists() && !cacheDir.mkdirs()))
     37            throw new IOException("Cannot access cache directory");
     38
     39        // raising logging level gives ~500x performance gain
     40        // http://westsworld.dk/blog/2008/01/jcs-and-performance/
     41        Logger.getLogger("org.apache.commons.jcs").setLevel(Level.INFO);
     42
     43        CompositeCacheManager cm  = CompositeCacheManager.getUnconfiguredInstance();
     44        // this could be moved to external file
     45        Properties props = new Properties();
     46        props.setProperty("jcs.default", "DC");
     47        props.setProperty("jcs.default.cacheattributes",                            org.apache.commons.jcs.engine.CompositeCacheAttributes.class.getCanonicalName());
     48        props.setProperty("jcs.default.cacheattributes.MaxObjects",                 Long.toString(maxObjectsInMemory));
     49        props.setProperty("jcs.default.cacheattributes.UseMemoryShrinker",          "true");
     50        props.setProperty("jcs.default.cacheattributes.DiskUsagePatternName",       "UPDATE"); // store elements on disk on put
     51        props.setProperty("jcs.default.elementattributes",                          CacheEntryAttributes.class.getCanonicalName());
     52        props.setProperty("jcs.default.elementattributes.IsEternal",                "false");
     53        props.setProperty("jcs.default.elementattributes.MaxLife",                  Long.toString(maxObjectTTL));
     54        props.setProperty("jcs.default.elementattributes.IdleTime",                 Long.toString(maxObjectTTL));
     55        props.setProperty("jcs.default.elementattributes.IsSpool",                  "true");
     56        props.setProperty("jcs.auxiliary.DC",                                       org.apache.commons.jcs.auxiliary.disk.indexed.IndexedDiskCacheFactory.class.getCanonicalName());
     57        props.setProperty("jcs.auxiliary.DC.attributes",                            org.apache.commons.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes.class.getCanonicalName());
     58        props.setProperty("jcs.auxiliary.DC.attributes.DiskPath",                   cacheDir.getAbsolutePath());
     59        props.setProperty("jcs.auxiliary.DC.attributes.maxKeySize",                 Long.toString(maxObjectsOnDisk));
     60        //props.setProperty("jcs.auxiliary.DC.attributes.blockSizeBytes",             "1024"); - for BlockDiskCacheAttributes
     61        cm.configure(props);
     62        cacheManager = cm;
     63
     64    }
     65
     66    /**
     67     * Returns configured cache object for named cache region
     68     * @param cacheName region name
     69     * @return cache access object
     70     * @throws IOException if directory is not found
     71     */
     72    public static <K,V> CacheAccess<K, V> getCache(String cacheName) throws IOException {
     73        return getCache(cacheName, maxObjectsInMemory, maxObjectsOnDisk);
     74    }
     75
     76    /**
     77     * Returns configured cache object with defined limits of memory cache and disk cache
     78     * @param cacheName region name
     79     * @param maxMemoryObjects number of objects to keep in memory
     80     * @param maxDiskObjects number of objects to keep on disk
     81     * @return cache access object
     82     * @throws IOException if directory is not found
     83     */
     84    public static <K,V> CacheAccess<K, V> getCache(String cacheName, int maxMemoryObjects, int maxDiskObjects) throws IOException {
     85        if (cacheManager != null)
     86            return getCacheInner(cacheName, maxMemoryObjects, maxDiskObjects);
     87
     88        synchronized (JCSCacheManager.class) {
     89            if (cacheManager == null)
     90                initialize();
     91            return getCacheInner(cacheName, maxMemoryObjects, maxDiskObjects);
     92        }
     93    }
     94
     95    private static <K,V> CacheAccess<K, V> getCacheInner(String cacheName, int maxMemoryObjects, int maxDiskObjects) {
     96        CompositeCache<K, V> cc = cacheManager.getCache(cacheName);
     97        cc.getCacheAttributes().setMaxObjects(maxMemoryObjects);
     98        AuxiliaryCache<K, V> ac[] = cc.getAuxCaches();
     99        if (ac!=null && ac.length > 0) {
     100            if (ac[0].getAuxiliaryCacheAttributes() instanceof IndexedDiskCacheAttributes) {
     101                ((IndexedDiskCacheAttributes) ac[0].getAuxiliaryCacheAttributes()).setMaxKeySize(maxDiskObjects);
     102            }
     103        }
     104        return new CacheAccess<K, V>(cc);
     105    }
     106
     107    /**
     108     * Close all files to ensure, that all indexes and data are properly written
     109     */
     110    public static void shutdown() {
     111        // use volatile semantics to get consistent object
     112        CompositeCacheManager localCacheManager = cacheManager;
     113        if (localCacheManager != null) {
     114            localCacheManager.shutDown();
     115        }
     116
     117    }
     118
     119}
  • src/org/openstreetmap/josm/data/cache/JCSJobDispatcher.java

     
     1// License: GPL. For details, see Readme.txt file.
     2package org.openstreetmap.josm.data.cache;
     3
     4import java.util.concurrent.BlockingDeque;
     5import java.util.concurrent.LinkedBlockingDeque;
     6import java.util.concurrent.TimeUnit;
     7
     8import org.openstreetmap.gui.jmapviewer.interfaces.TileJob;
     9
     10/**
     11 * A generic class that processes a list of {@link Runnable} one-by-one using
     12 * one or more {@link Thread}-instances. The number of instances varies between
     13 * 1 and {@link #workerThreadMaxCount} (default: 8). If an instance is idle
     14 * more than {@link #workerThreadTimeout} seconds (default: 30), the instance
     15 * ends itself.
     16 *
     17 * @author Jan Peter Stotz
     18 */
     19public class JCSJobDispatcher {
     20
     21    private static final JCSJobDispatcher instance = new JCSJobDispatcher();
     22
     23    /**
     24     * @return the singelton instance of the {@link JCSJobDispatcher}
     25     */
     26    public static JCSJobDispatcher getInstance() {
     27        return instance;
     28    }
     29
     30    private JCSJobDispatcher() {
     31        addWorkerThread().firstThread = true;
     32    }
     33
     34    protected BlockingDeque<ICachedLoaderJob> jobQueue = new LinkedBlockingDeque<>();
     35
     36    protected static int workerThreadMaxCount = 8;
     37
     38    /**
     39     * Specifies the time span in seconds that a worker thread waits for new
     40     * jobs to perform. If the time span has elapsed the worker thread
     41     * terminates itself. Only the first worker thread works differently, it
     42     * ignores the timeout and will never terminate itself.
     43     */
     44    protected static int workerThreadTimeout = 30;
     45
     46    /**
     47     * Type of queue, FIFO if <code>false</code>, LIFO if <code>true</code>
     48     */
     49    protected boolean modeLIFO = false;
     50
     51    /**
     52     * Total number of worker threads currently idle or active
     53     */
     54    protected int workerThreadCount = 0;
     55
     56    /**
     57     * Number of worker threads currently idle
     58     */
     59    protected int workerThreadIdleCount = 0;
     60
     61    /**
     62     * Just an id for identifying an worker thread instance
     63     */
     64    protected int workerThreadId = 0;
     65
     66    /**
     67     * Removes all jobs from the queue that are currently not being processed.
     68     */
     69    public void cancelOutstandingJobs() {
     70        jobQueue.clear();
     71    }
     72
     73    /**
     74     * Function to set the maximum number of workers for tile loading.
     75     */
     76    static public void setMaxWorkers(int workers) {
     77        workerThreadMaxCount = workers;
     78    }
     79
     80    /**
     81     * Function to set the LIFO/FIFO mode for tile loading job.
     82     *
     83     * @param lifo <code>true</code> for LIFO mode, <code>false</code> for FIFO mode
     84     */
     85    public void setLIFO(boolean lifo) {
     86        modeLIFO = lifo;
     87    }
     88
     89    /**
     90     * Adds a job to the queue.
     91     * Jobs for tiles already contained in the are ignored (using a <code>null</code> tile
     92     * prevents skipping).
     93     *
     94     * @param job the the job to be added
     95     */
     96    public void addJob(ICachedLoaderJob job) {
     97        try {
     98            if(job.getCacheKey() != null) {
     99                for(ICachedLoaderJob oldJob : jobQueue) {
     100                    if(oldJob.getCacheKey() == job.getCacheKey()) {
     101                        return;
     102                    }
     103                }
     104            }
     105            jobQueue.put(job);
     106            if (workerThreadIdleCount == 0 && workerThreadCount < workerThreadMaxCount)
     107                addWorkerThread();
     108        } catch (InterruptedException e) {
     109        }
     110    }
     111
     112    protected JobThread addWorkerThread() {
     113        JobThread jobThread = new JobThread(++workerThreadId);
     114        synchronized (this) {
     115            workerThreadCount++;
     116        }
     117        jobThread.start();
     118        return jobThread;
     119    }
     120
     121    public class JobThread extends Thread {
     122
     123        ICachedLoaderJob job;
     124        boolean firstThread = false;
     125
     126        public JobThread(int threadId) {
     127            super("OSMJobThread " + threadId);
     128            setDaemon(true);
     129            job = null;
     130        }
     131
     132        @Override
     133        public void run() {
     134            executeJobs();
     135            synchronized (instance) {
     136                workerThreadCount--;
     137            }
     138        }
     139
     140        protected void executeJobs() {
     141            while (!isInterrupted()) {
     142                try {
     143                    synchronized (instance) {
     144                        workerThreadIdleCount++;
     145                    }
     146                    if(modeLIFO) {
     147                        if (firstThread)
     148                            job = jobQueue.takeLast();
     149                        else
     150                            job = jobQueue.pollLast(workerThreadTimeout, TimeUnit.SECONDS);
     151                    } else {
     152                        if (firstThread)
     153                            job = jobQueue.take();
     154                        else
     155                            job = jobQueue.poll(workerThreadTimeout, TimeUnit.SECONDS);
     156                    }
     157                } catch (InterruptedException e1) {
     158                    return;
     159                } finally {
     160                    synchronized (instance) {
     161                        workerThreadIdleCount--;
     162                    }
     163                }
     164                if (job == null)
     165                    return;
     166                try {
     167                    job.run();
     168                    job = null;
     169                } catch (Exception e) {
     170                    e.printStackTrace();
     171                }
     172            }
     173        }
     174    }
     175
     176}
  • 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.IOException;
     6import java.io.InputStream;
     7import java.net.HttpURLConnection;
     8import java.net.MalformedURLException;
     9import java.net.URL;
     10import java.net.URLConnection;
     11import java.util.HashSet;
     12import java.util.Map;
     13import java.util.Random;
     14import java.util.Set;
     15import java.util.concurrent.ConcurrentHashMap;
     16import java.util.concurrent.ConcurrentMap;
     17import java.util.logging.Level;
     18import java.util.logging.Logger;
     19
     20import org.apache.commons.jcs.access.behavior.ICacheAccess;
     21import org.apache.commons.jcs.engine.behavior.ICacheElement;
     22import org.openstreetmap.gui.jmapviewer.FeatureAdapter;
     23
     24/**
     25 * @author Wiktor Niesiobędzki
     26 *
     27 * @param <K> cache entry key type
     28 *
     29 * Generic loader for HTTP based tiles. Uses custom attribute, to check, if entry has expired
     30 * according to HTTP headers sent with tile. If so, it tries to verify using Etags
     31 * or If-Modified-Since / Last-Modified.
     32 *
     33 * If the tile is not valid, it will try to download it from remote service and put it
     34 * to cache. If remote server will fail it will try to use stale entry.
     35 *
     36 * This class will keep only one Job running for specified tile. All others will just finish, but
     37 * listeners will be gathered and notified, once download job will be finished
     38 */
     39public abstract class JCSCachedTileLoaderJob<K> implements ICachedLoaderJob<K> {
     40    private static final Logger log = FeatureAdapter.getLogger(JCSCachedTileLoaderJob.class.getCanonicalName());
     41    protected static final long DEFAULT_EXPIRE_TIME = 1000L * 60 * 60 * 24 * 7; // 7 days
     42    // Limit for the max-age value send by the server.
     43    protected static final long EXPIRE_TIME_SERVER_LIMIT = 1000L * 60 * 60 * 24 * 28; // 4 weeks
     44    // Absolute expire time limit. Cached tiles that are older will not be used,
     45    // even if the refresh from the server fails.
     46    protected static final long ABSOLUTE_EXPIRE_TIME_LIMIT = Long.MAX_VALUE; // unlimited
     47
     48    private ICacheAccess<K, CacheEntry> cache;
     49    private long now;
     50    private ICacheElement<K,CacheEntry> cacheElement;
     51    private int connectTimeout;
     52    private int readTimeout;
     53    private Map<String, String> headers;
     54    private static ConcurrentMap<URL,Set<ICachedLoaderListener>> inProgress = new ConcurrentHashMap<>();
     55
     56    protected CacheEntryAttributes attributes = null;
     57    protected byte[] data = null;
     58    private static ConcurrentMap<String, Boolean> useHead = new ConcurrentHashMap<>();
     59
     60
     61
     62    /**
     63     * @param cache cache instance that we will work on
     64     * @param headers
     65     * @param readTimeout
     66     * @param connectTimeout
     67     */
     68    public JCSCachedTileLoaderJob(ICacheAccess<K,CacheEntry> cache,
     69            int connectTimeout, int readTimeout,
     70            Map<String, String> headers) {
     71
     72        this.cache = cache;
     73        this.now = System.currentTimeMillis();
     74        this.connectTimeout = connectTimeout;
     75        this.readTimeout = readTimeout;
     76        this.headers = headers;
     77    }
     78
     79    private void ensureCacheElement() {
     80        if (cacheElement == null && getCacheKey() != null) {
     81            cacheElement = cache.getCacheElement(getCacheKey());
     82            if (cacheElement != null) {
     83                attributes = (CacheEntryAttributes) cacheElement.getElementAttributes();
     84                data = cacheElement.getVal().getContent();
     85            }
     86        }
     87    }
     88
     89    public byte[] get() {
     90        ensureCacheElement();
     91        if (cacheElement != null) {
     92            return cacheElement.getVal().getContent();
     93        }
     94        return null;
     95    }
     96
     97    @Override
     98    public void submit(ICachedLoaderListener listener) {
     99        boolean first = false;
     100        URL url = getUrl();
     101        if (url == null) {
     102            log.log(Level.WARNING, "No url returned for: {0}, skipping", getCacheKey());
     103            return;
     104        }
     105        synchronized (inProgress) {
     106            Set<ICachedLoaderListener> newListeners = inProgress.get(url);
     107            if (newListeners == null) {
     108                newListeners = new HashSet<>();
     109                inProgress.put(url, newListeners);
     110                first = true;
     111            }
     112            newListeners.add(listener);
     113        }
     114
     115        if (first) {
     116            ensureCacheElement();
     117            if (cacheElement != null && isCacheElementValid() && (isObjectLoadable())) {
     118                // we got something in cache, verify it
     119                log.log(Level.FINE, "JCS - Returning object from cache: {0}", getCacheKey());
     120                finishLoading(true, true);
     121                return;
     122            }
     123            // object not in cache, so submit work to separate thread
     124            JCSJobDispatcher.getInstance().addJob(this);
     125        }
     126
     127    }
     128
     129    /**
     130     *
     131     * @return checks if object from cache has sufficient data to be returned
     132     */
     133    public boolean isObjectLoadable() {
     134        return data != null && data.length > 0;
     135    }
     136
     137    /**
     138     *
     139     * @return cache object as empty, regardless of what remote resource has returned (ex. based on headers)
     140     */
     141    protected boolean cacheAsEmpty() {
     142        return false;
     143    }
     144
     145    public void run() {
     146        // try to load object from remote resource
     147        if (loadObject()) {
     148            finishLoading(true, true);
     149        } else {
     150            // if loading failed - check if we can return stale entry
     151            if (isObjectLoadable()) {
     152                // try to get stale entry in cache
     153                finishLoading(true, true);
     154                log.log(Level.FINE, "JCS - found stale object in cache: {0}", getUrl());
     155            } else {
     156                // failed completely
     157                finishLoading(false, true);
     158            }
     159        }
     160    }
     161
     162
     163    private void finishLoading(boolean success, boolean loaded) {
     164        Set<ICachedLoaderListener> listeners = null;
     165        synchronized (inProgress) {
     166            listeners = inProgress.remove(getUrl());
     167        }
     168        if (listeners == null) {
     169            log.log(Level.WARNING, "Listener not found for URL: {0}. Listener not notified!", getUrl());
     170            return;
     171        }
     172        try {
     173            for (ICachedLoaderListener l: listeners) {
     174                l.loadingFinished(data, success);
     175            }
     176        } catch (Exception e) {
     177            log.log(Level.WARNING, "JCS - Error while loading object from cache: {0}; {1}", new Object[]{e.getMessage(), getUrl()});
     178            log.log(Level.FINE, "Stacktrace", e);
     179            for (ICachedLoaderListener l: listeners) {
     180                l.loadingFinished(data, false);
     181            }
     182
     183        }
     184
     185    }
     186
     187    private boolean isCacheElementValid() {
     188        long expires = attributes.getExpirationTime();
     189
     190        // check by expire date set by server
     191        if (expires != 0L) {
     192            // put a limit to the expire time (some servers send a value
     193            // that is too large)
     194            expires = Math.min(expires, attributes.getCreateTime() + EXPIRE_TIME_SERVER_LIMIT);
     195            if (now > expires) {
     196                log.log(Level.FINE, "JCS - Object {0} has expired -> valid to {1}, now is: {2}", new Object[]{getUrl(), Long.toString(expires), Long.toString(now)});
     197                return false;
     198            }
     199        } else {
     200            // check by file modification date
     201            if (now - attributes.getLastModification() > DEFAULT_EXPIRE_TIME) {
     202                log.log(Level.FINE, "JCS - Object has expired, maximum file age reached {0}", getUrl());
     203                return false;
     204            }
     205        }
     206        return true;
     207    }
     208
     209    private boolean loadObject() {
     210        try {
     211            // if we have object in cache, and host doesn't support If-Modified-Since nor If-None-Match
     212            // then just use HEAD request and check returned values
     213            if (isObjectLoadable() &&
     214                    Boolean.TRUE.equals(useHead.get(getUrl().getHost())) &&
     215                    isCacheValidUsingHead()) {
     216                log.log(Level.FINE, "JCS - cache entry verified using HEAD request: {0}", getUrl());
     217                return true;
     218            }
     219            URLConnection urlConn = getURLConnection();
     220
     221            if (isObjectLoadable()  &&
     222                    (now - attributes.getLastModification()) <= ABSOLUTE_EXPIRE_TIME_LIMIT) {
     223                urlConn.setIfModifiedSince(attributes.getLastModification());
     224            }
     225            if (isObjectLoadable() && attributes.getEtag() != null) {
     226                urlConn.addRequestProperty("If-None-Match", attributes.getEtag());
     227            }
     228            if (urlConn instanceof HttpURLConnection && ((HttpURLConnection)urlConn).getResponseCode() == 304) {
     229                // If isModifiedSince or If-None-Match has been set
     230                // and the server answers with a HTTP 304 = "Not Modified"
     231                log.log(Level.FINE, "JCS - IfModifiedSince/Etag test: local version is up to date: {0}", getUrl());
     232                return true;
     233            } else if (isObjectLoadable()) {
     234                // we have an object in cache, but we haven't received 304 resposne code
     235                // check if we should use HEAD request to verify
     236                if((attributes.getEtag() != null && attributes.getEtag().equals(urlConn.getRequestProperty("ETag"))) ||
     237                        attributes.getLastModification() == urlConn.getLastModified()) {
     238                    // we sent ETag or If-Modified-Since, but didn't get 304 response code
     239                    // for further requests - use HEAD
     240                    String host = getUrl().getHost();
     241                    log.log(Level.INFO, "JCS - Host: {0} found not to return 304 codes for If-Modifed-Since or If-None-Match headers", host);
     242                    useHead.put(host, Boolean.TRUE);
     243                }
     244            }
     245
     246            attributes = parseHeaders(urlConn);
     247
     248            for (int i = 0; i < 5; ++i) {
     249                if (urlConn instanceof HttpURLConnection && ((HttpURLConnection)urlConn).getResponseCode() == 503) {
     250                    Thread.sleep(5000+(new Random()).nextInt(5000));
     251                    continue;
     252                }
     253                data = read(urlConn);
     254                if (!cacheAsEmpty() && data != null && data.length > 0) {
     255                    cache.put(getCacheKey(), new CacheEntry(data), attributes);
     256                    log.log(Level.FINE, "JCS - downloaded key: {0}, length: {1}, url: {2}",
     257                            new Object[] {getCacheKey(), data.length, getUrl()});
     258                    return true;
     259                } else {
     260                    log.log(Level.FINE, "JCS - Caching empty object {0}", getUrl());
     261                    cache.put(getCacheKey(), new CacheEntry(new byte[]{}), attributes);
     262                    return true;
     263                }
     264            }
     265        } catch (Exception e) {
     266            log.log(Level.WARNING, "JCS - Exception during download " + getUrl(), e);
     267        }
     268        log.log(Level.WARNING, "JCS - Silent failure during download: {0}", getUrl());
     269        return false;
     270
     271    }
     272
     273    private CacheEntryAttributes parseHeaders(URLConnection urlConn) {
     274        CacheEntryAttributes ret = new CacheEntryAttributes();
     275        ret.setNoTileAtZoom("no-tile".equals(urlConn.getHeaderField("X-VE-Tile-Info")));
     276
     277        Long lng = urlConn.getExpiration();
     278        if (lng.equals(0L)) {
     279            try {
     280                String str = urlConn.getHeaderField("Cache-Control");
     281                if (str != null) {
     282                    for (String token: str.split(",")) {
     283                        if (token.startsWith("max-age=")) {
     284                            lng = Long.parseLong(token.substring(8)) * 1000 +
     285                                    System.currentTimeMillis();
     286                        }
     287                    }
     288                }
     289            } catch (NumberFormatException e) {} //ignore malformed Cache-Control headers
     290        }
     291
     292        ret.setExpirationTime(lng);
     293        ret.setLastModification(now);
     294        ret.setEtag(urlConn.getHeaderField("ETag"));
     295        return ret;
     296    }
     297
     298    private HttpURLConnection getURLConnection() throws IOException, MalformedURLException {
     299        HttpURLConnection urlConn = (HttpURLConnection) getUrl().openConnection();
     300        urlConn.setRequestProperty("Accept", "text/html, image/png, image/jpeg, image/gif, */*");
     301        urlConn.setReadTimeout(readTimeout); // 30 seconds read timeout
     302        urlConn.setConnectTimeout(connectTimeout);
     303        for(Map.Entry<String, String> e: headers.entrySet()) {
     304            urlConn.setRequestProperty(e.getKey(), e.getValue());
     305        }
     306        return urlConn;
     307    }
     308
     309    private boolean isCacheValidUsingHead() throws IOException {
     310        HttpURLConnection urlConn = (HttpURLConnection) getUrl().openConnection();
     311        urlConn.setRequestMethod("HEAD");
     312        long lastModified = urlConn.getLastModified();
     313        return (
     314                (attributes.getEtag() != null && attributes.getEtag().equals(urlConn.getRequestProperty("ETag"))) ||
     315                (lastModified != 0 && lastModified <= attributes.getLastModification())
     316                );
     317    }
     318
     319    private static byte[] read(URLConnection urlConn) throws IOException {
     320        InputStream input = urlConn.getInputStream();
     321        try {
     322            ByteArrayOutputStream bout = new ByteArrayOutputStream(input.available());
     323            byte[] buffer = new byte[2048];
     324            boolean finished = false;
     325            do {
     326                int read = input.read(buffer);
     327                if (read >= 0) {
     328                    bout.write(buffer, 0, read);
     329                } else {
     330                    finished = true;
     331                }
     332            } while (!finished);
     333            if (bout.size() == 0)
     334                return null;
     335            return bout.toByteArray();
     336        } finally {
     337            input.close();
     338        }
     339    }
     340}
  • 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.josm.data.cache.CacheEntry;
     17import org.openstreetmap.josm.data.cache.ICachedLoaderListener;
     18import org.openstreetmap.josm.data.cache.JCSCachedTileLoaderJob;
     19
     20/**
     21 * @author Wiktor Niesiobędzki
     22 *
     23 * Class bridging TMS requests to JCS cache requests
     24 *
     25 */
     26public class TMSCachedTileLoaderJob extends JCSCachedTileLoaderJob<String> implements TileJob, ICachedLoaderListener  {
     27    private static final Logger log = FeatureAdapter.getLogger(TMSCachedTileLoaderJob.class.getCanonicalName());
     28    private Tile tile;
     29    private TileLoaderListener listener;
     30    private URL url;
     31
     32    /**
     33     * Constructor for creating a job, to get a specific tile from cache
     34     * @param listener
     35     * @param tile to be fetched from cache
     36     * @param cache object
     37     * @param connectTimeout when connecting to remote resource
     38     * @param readTimeout when connecting to remote resource
     39     * @param headers to be sent together with request
     40     */
     41    public TMSCachedTileLoaderJob(TileLoaderListener listener, Tile tile, ICacheAccess<String, CacheEntry> cache, int connectTimeout, int readTimeout,
     42            Map<String, String> headers) {
     43        super(cache, connectTimeout, readTimeout, headers);
     44        this.tile = tile;
     45        this.listener = listener;
     46        // URLs tend to change for some tile providers. Make a static reference here, so the tile URL might be used as a key
     47        // for request deduplication
     48        try {
     49            this.url = new URL(tile.getUrl());
     50        } catch (IOException e) {
     51            log.log(Level.WARNING, "JCS TMS Cache - error creating URL for tile {0}: {1}", new Object[] {tile.getKey(), e.getMessage()});
     52        }
     53
     54    }
     55
     56    @Override
     57    public Tile getTile() {
     58        return tile;
     59    }
     60
     61    @Override
     62    public String getCacheKey() {
     63        if (tile != null)
     64            return tile.getKey();
     65        return null;
     66    }
     67
     68    @Override
     69    public URL getUrl() {
     70        return url;
     71    }
     72
     73    @Override
     74    public boolean isObjectLoadable() {
     75        return (data != null && data.length > 0) || cacheAsEmpty();
     76    }
     77
     78    @Override
     79    protected boolean cacheAsEmpty() {
     80        if (attributes != null && attributes.isNoTileAtZoom()) {
     81            // do not remove file - keep the information, that there is no tile, for further requests
     82            // the code above will check, if this information is still valid
     83            log.log(Level.FINE, "JCS TMS - Tile valid, but no file, as no tiles at this level {0}", tile);
     84            tile.setError("No tile at this zoom level");
     85            tile.putValue("tile-info", "no-tile");
     86            return true;
     87        }
     88        return false;
     89    }
     90
     91    public void submit() {
     92        super.submit(this);
     93    }
     94
     95    @Override
     96    public void loadingFinished(byte[] object, boolean success) {
     97        try {
     98            if (object != null && object.length > 0) {
     99                tile.loadImage(new ByteArrayInputStream(object));
     100            }
     101            tile.setLoaded(true);
     102            if (listener != null) {
     103                listener.tileLoadingFinished(tile, success);
     104            }
     105        } catch (IOException e) {
     106            log.log(Level.WARNING, "JCS TMS - error loading object for tile {0}: {1}", new Object[] {tile.getKey(), e.getMessage()});
     107            tile.setError(e.getMessage());
     108            tile.setLoaded(false);
     109            if (listener != null) {
     110                listener.tileLoadingFinished(tile, false);
     111            }
     112        }
     113    }
     114
     115    /**
     116     * Method for getting the tile from cache only, without trying to reach remote resource
     117     * @return tile or null, if nothing (useful) was found in cache
     118     */
     119    public Tile getCachedTile() {
     120        byte[] data = super.get();
     121        if (isObjectLoadable()) {
     122            loadingFinished(data, true);
     123            return tile;
     124        } else {
     125            return null;
     126        }
     127    }
     128}
  • 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;
     
    6359import org.openstreetmap.josm.data.coor.LatLon;
    6460import org.openstreetmap.josm.data.imagery.ImageryInfo;
    6561import org.openstreetmap.josm.data.imagery.ImageryInfo.ImageryType;
     62import org.openstreetmap.josm.data.imagery.TMSCachedTileLoader;
    6663import org.openstreetmap.josm.data.osm.visitor.BoundingXYVisitor;
    6764import org.openstreetmap.josm.data.preferences.BooleanProperty;
    6865import org.openstreetmap.josm.data.preferences.IntegerProperty;
     
    7572import org.openstreetmap.josm.gui.dialogs.LayerListDialog;
    7673import org.openstreetmap.josm.gui.dialogs.LayerListPopup;
    7774import org.openstreetmap.josm.gui.progress.ProgressMonitor;
    78 import org.openstreetmap.josm.gui.progress.ProgressMonitor.CancelListener;
    7975import org.openstreetmap.josm.io.CacheCustomContent;
    8076import org.openstreetmap.josm.io.OsmTransferException;
    8177import org.openstreetmap.josm.io.UTFInputStreamReader;
     
    122118    }
    123119
    124120    public interface TileLoaderFactory {
    125         OsmTileLoader makeTileLoader(TileLoaderListener listener);
     121        TileLoader makeTileLoader(TileLoaderListener listener);
     122        TileLoader makeTileLoader(TileLoaderListener listener, Map<String, String> headers);
    126123    }
    127124
     125    // MemoryTileCache caches rendered tiles, to reduce latency during map panning
     126    // ImageIO.read() takes a lot of time, so we can't use JCS cache
    128127    protected MemoryTileCache tileCache;
    129128    protected TileSource tileSource;
    130     protected OsmTileLoader tileLoader;
     129    protected TileLoader tileLoader;
     130
    131131
    132132    public static TileLoaderFactory loaderFactory = new TileLoaderFactory() {
    133133        @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                 }
     134        public TileLoader makeTileLoader(TileLoaderListener listener, Map<String, String> inputHeaders) {
     135            Map<String, String> headers = new HashMap<>();
     136            headers.put("User-Agent", Version.getInstance().getFullAgentString());
     137            headers.put("Accept", "text/html, image/png, image/jpeg, image/gif, */*");
     138            if (inputHeaders != null)
     139                headers.putAll(inputHeaders);
     140
     141            try {
     142                return new TMSCachedTileLoader(listener, "TMS",
     143                        Main.pref.getInteger("socket.timeout.connect",15) * 1000,
     144                        Main.pref.getInteger("socket.timeout.read", 30) * 1000,
     145                        headers);
     146            } catch (IOException e) {
     147                Main.warn(e);
    145148            }
    146149            return null;
    147150        }
     151
     152        @Override
     153        public TileLoader makeTileLoader(TileLoaderListener listener) {
     154            return makeTileLoader(listener, null);
     155        }
    148156    };
    149157
    150158    /**
    151159     * Plugins that wish to set custom tile loader should call this method
    152160     */
     161
    153162    public static void setCustomTileLoaderFactory(TileLoaderFactory loaderFactory) {
    154163        TMSLayer.loaderFactory = loaderFactory;
    155164    }
    156165
    157     private Set<Tile> tileRequestsOutstanding = new HashSet<>();
    158 
    159166    @Override
    160167    public synchronized void tileLoadingFinished(Tile tile, boolean success) {
    161168        if (tile.hasError()) {
     
    170177        if (Main.map != null) {
    171178            Main.map.repaint(100);
    172179        }
    173         tileRequestsOutstanding.remove(tile);
    174180        if (Main.isDebugEnabled()) {
    175181            Main.debug("tileLoadingFinished() tile: " + tile + " success: " + success);
    176182        }
    177183    }
    178184
    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 
    220185    /**
    221186     * Clears the tile cache.
    222187     *
     
    231196    void clearTileCache(ProgressMonitor monitor) {
    232197        tileCache.clear();
    233198        if (tileLoader instanceof CachedTileLoader) {
    234             ((CachedTileLoader)tileLoader).clearCache(tileSource, new TmsTileClearController(monitor));
     199            ((CachedTileLoader)tileLoader).clearCache();
    235200        }
    236201    }
    237202
     
    412377    private void initTileSource(TileSource tileSource) {
    413378        this.tileSource = tileSource;
    414379        attribution.initialize(tileSource);
    415 
    416380        currentZoomLevel = getBestZoom();
    417381
    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;
     382        Map<String, String> headers = null;
    426383        if (tileSource instanceof TemplatedTMSTileSource) {
    427             for(Entry<String, String> e : ((TemplatedTMSTileSource)tileSource).getHeaders().entrySet()) {
    428                 tileLoader.headers.put(e.getKey(), e.getValue());
    429             }
     384            headers = (((TemplatedTMSTileSource)tileSource).getHeaders());
    430385        }
    431         tileLoader.headers.put("User-Agent", Version.getInstance().getFullAgentString());
     386
     387        tileCache = new MemoryTileCache();
     388        tileLoader = loaderFactory.makeTileLoader(this, headers);
     389        if (tileLoader == null)
     390            tileLoader = new OsmTileLoader(this);
    432391    }
    433392
    434393    @Override
     
    487446        setMaxWorkers();
    488447        if(!isProjectionSupported(Main.getProjection())) {
    489448            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);
     449                    tr("TMS layers do not support the projection {0}.\n{1}\n"
     450                            + "Change the projection or remove the layer.",
     451                            Main.getProjection().toCode(), nameSupportedProjections()),
     452                            tr("Warning"),
     453                            JOptionPane.WARNING_MESSAGE);
    495454        }
    496455
    497456        setBackgroundLayer(true);
     
    685644        }
    686645        needRedraw = true;
    687646        JobDispatcher.getInstance().cancelOutstandingJobs();
    688         tileRequestsOutstanding.clear();
    689647    }
    690648
    691649    int getMaxZoomLvl() {
     
    770728     * are temporary only and intentionally not inserted
    771729     * into the tileCache.
    772730     */
    773     synchronized Tile tempCornerTile(Tile t) {
     731    Tile tempCornerTile(Tile t) {
    774732        int x = t.getXtile() + 1;
    775733        int y = t.getYtile() + 1;
    776734        int zoom = t.getZoom();
     
    780738        return new Tile(tileSource, x, y, zoom);
    781739    }
    782740
    783     synchronized Tile getOrCreateTile(int x, int y, int zoom) {
     741    Tile getOrCreateTile(int x, int y, int zoom) {
    784742        Tile tile = getTile(x, y, zoom);
    785743        if (tile == null) {
    786744            tile = new Tile(tileSource, x, y, zoom);
     
    794752     * This can and will return null for tiles that are not
    795753     * already in the cache.
    796754     */
    797     synchronized Tile getTile(int x, int y, int zoom) {
     755    Tile getTile(int x, int y, int zoom) {
    798756        int max = (1 << zoom);
    799757        if (x < 0 || x >= max || y < 0 || y >= max)
    800758            return null;
    801759        return tileCache.getTile(tileSource, x, y, zoom);
    802760    }
    803761
    804     synchronized boolean loadTile(Tile tile, boolean force) {
     762    boolean loadTile(Tile tile, boolean force) {
    805763        if (tile == null)
    806764            return false;
    807         if (!force && (tile.hasError() || tile.isLoaded()))
     765        if (!force && (tile.isLoaded() || tile.hasError()))
    808766            return false;
    809767        if (tile.isLoading())
    810768            return false;
    811         if (tileRequestsOutstanding.contains(tile))
    812             return false;
    813         tileRequestsOutstanding.add(tile);
    814         JobDispatcher.getInstance().addJob(tileLoader.createTileLoaderJob(tile));
     769        tileLoader.createTileLoaderJob(tile).submit();
    815770        return true;
    816771    }
    817772
     
    12681223        public TileSet getTileSet(int zoom) {
    12691224            if (zoom < minZoom)
    12701225                return nullTileSet;
    1271             TileSet ts = tileSets[zoom-minZoom];
    1272             if (ts == null) {
    1273                 ts = new TileSet(topLeft, botRight, zoom);
    1274                 tileSets[zoom-minZoom] = ts;
     1226            synchronized (tileSets) {
     1227                TileSet ts = tileSets[zoom-minZoom];
     1228                if (ts == null) {
     1229                    ts = new TileSet(topLeft, botRight, zoom);
     1230                    tileSets[zoom-minZoom] = ts;
     1231                }
     1232                return ts;
    12751233            }
    1276             return ts;
    12771234        }
     1235
    12781236        public TileSetInfo getTileSetInfo(int zoom) {
    12791237            if (zoom < minZoom)
    12801238                return new TileSetInfo();
    1281             TileSetInfo tsi = tileSetInfos[zoom-minZoom];
    1282             if (tsi == null) {
    1283                 tsi = TMSLayer.getTileSetInfo(getTileSet(zoom));
    1284                 tileSetInfos[zoom-minZoom] = tsi;
     1239            synchronized (tileSetInfos) {
     1240                TileSetInfo tsi = tileSetInfos[zoom-minZoom];
     1241                if (tsi == null) {
     1242                    tsi = TMSLayer.getTileSetInfo(getTileSet(zoom));
     1243                    tileSetInfos[zoom-minZoom] = tsi;
     1244                }
     1245                return tsi;
    12851246            }
    1286             return tsi;
    12871247        }
    12881248    }
    12891249
    12901250    @Override
    12911251    public void paint(Graphics2D g, MapView mv, Bounds bounds) {
    1292         //long start = System.currentTimeMillis();
    12931252        EastNorth topLeft = mv.getEastNorth(0, 0);
    12941253        EastNorth botRight = mv.getEastNorth(mv.getWidth(), mv.getHeight());
    12951254
  • 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/interfaces/TileLoader.java

     
    2020     *          action.
    2121     */
    2222    public TileJob createTileLoaderJob(Tile tile);
     23
    2324}
  • 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/OsmTileLoader.java

     
    8585            public Tile getTile() {
    8686                return tile;
    8787            }
     88
     89            @Override
     90            public void submit() {
     91                run();
     92
     93            }
    8894        };
    8995    }
    9096
     
    142148    public String toString() {
    143149        return getClass().getSimpleName();
    144150    }
    145 
    146151}