001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.data.imagery;
003
004import java.io.File;
005import java.lang.reflect.Constructor;
006import java.util.Map;
007import java.util.concurrent.ConcurrentHashMap;
008import java.util.concurrent.TimeUnit;
009
010import org.apache.commons.jcs.access.behavior.ICacheAccess;
011import org.openstreetmap.gui.jmapviewer.interfaces.TileLoader;
012import org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener;
013import org.openstreetmap.josm.data.Version;
014import org.openstreetmap.josm.data.cache.BufferedImageCacheEntry;
015import org.openstreetmap.josm.data.preferences.StringProperty;
016import org.openstreetmap.josm.spi.preferences.Config;
017import org.openstreetmap.josm.tools.CheckParameterUtil;
018import org.openstreetmap.josm.tools.Logging;
019
020/**
021 * TileLoaderFactory creating JCS cached TileLoaders
022 *
023 * @author Wiktor Niesiobędzki
024 * @since 8526
025 */
026public class CachedTileLoaderFactory implements TileLoaderFactory {
027    /**
028     * Keeps the cache directory where
029     */
030    public static final StringProperty PROP_TILECACHE_DIR = getTileCacheDir();
031    private final ICacheAccess<String, BufferedImageCacheEntry> cache;
032    private Constructor<? extends TileLoader> tileLoaderConstructor;
033
034    /**
035     * @param cache cache instance which will be used by tile loaders created by this tile loader
036     * @param tileLoaderClass tile loader class that will be created
037     * @throws IllegalArgumentException if a suitable constructor cannot be found for {@code tileLoaderClass}
038     */
039    public CachedTileLoaderFactory(ICacheAccess<String, BufferedImageCacheEntry> cache, Class<? extends TileLoader> tileLoaderClass) {
040        CheckParameterUtil.ensureParameterNotNull(cache, "cache");
041        this.cache = cache;
042        try {
043            tileLoaderConstructor = tileLoaderClass.getConstructor(
044                    TileLoaderListener.class,
045                    ICacheAccess.class,
046                    TileJobOptions.class
047                    );
048        } catch (NoSuchMethodException | SecurityException e) {
049            Logging.log(Logging.LEVEL_WARN, "Unable to initialize cache tile loader factory", e);
050            throw new IllegalArgumentException(e);
051        }
052    }
053
054    private static StringProperty getTileCacheDir() {
055        String defPath = null;
056        try {
057            defPath = new File(Config.getDirs().getCacheDirectory(true), "tiles").getAbsolutePath();
058        } catch (SecurityException e) {
059            Logging.log(Logging.LEVEL_WARN, "Unable to get tile cache directory", e);
060        }
061        return new StringProperty("imagery.generic.loader.cachedir", defPath);
062    }
063
064    @Override
065    public TileLoader makeTileLoader(TileLoaderListener listener, Map<String, String> inputHeaders, long minimumExpiryTime) {
066        Map<String, String> headers = new ConcurrentHashMap<>();
067        headers.put("User-Agent", Version.getInstance().getFullAgentString());
068        headers.put("Accept", "text/html, image/png, image/jpeg, image/gif, */*");
069        if (inputHeaders != null)
070            headers.putAll(inputHeaders);
071
072        return getLoader(listener, cache,
073                new TileJobOptions(
074                        (int) TimeUnit.SECONDS.toMillis(Config.getPref().getInt("socket.timeout.connect", 15)),
075                        (int) TimeUnit.SECONDS.toMillis(Config.getPref().getInt("socket.timeout.read", 30)),
076                        headers,
077                        minimumExpiryTime
078                        )
079                );
080    }
081
082    protected TileLoader getLoader(TileLoaderListener listener, ICacheAccess<String, BufferedImageCacheEntry> cache,
083            TileJobOptions options) {
084        try {
085            return tileLoaderConstructor.newInstance(
086                    listener,
087                    cache,
088                    options
089                    );
090        } catch (IllegalArgumentException e) {
091            Logging.warn(e);
092            throw e;
093        } catch (ReflectiveOperationException e) {
094            Logging.warn(e);
095            throw new IllegalArgumentException(e);
096        }
097    }
098}