info.joseluismartin.gtc.AbstractTileCache.java Source code

Introduction

Here is the source code for info.joseluismartin.gtc.AbstractTileCache.java

Source

/*
 * Copyright 20010-2012 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package info.joseluismartin.gtc;

import info.joseluismartin.gtc.model.CacheConfig;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.Calendar;
import java.util.Collections;
import java.util.Map;

import org.apache.commons.collections.map.LRUMap;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.web.util.UriComponents;
import org.springframework.web.util.UriComponentsBuilder;

/**
 * Abstract implementation of TileCache interface.
 * 
 * @author Jose Luis Martin
 */
@SuppressWarnings("unchecked")
public abstract class AbstractTileCache implements TileCache {

    private Map<Integer, Tile> tileMap = Collections.synchronizedMap(new LRUMap(10000));
    private static final Log log = LogFactory.getLog(AbstractTileCache.class);
    private String cachePath = "/tmp";
    private String name;
    private String serverUrl;
    private String path;
    private int age;

    public Tile getTile(String uri) {

        Tile tile = parseTile(uri);

        if (tile == null)
            return null;

        if (tileMap.containsKey(tile.getKey())) { // found in memory cache
            if (log.isDebugEnabled())
                log.debug(name + ": Tile found in memory cache: " + tile.getKey());
            tile = (Tile) tileMap.get(tile.getKey());
        } else {
            if (isTileCached(tile)) { // found in disk
                if (log.isDebugEnabled())
                    log.debug(name + ": Tile found in disk cache:" + tile.getKey());

                tile.load(getCachePath(tile));
                // refresh cache with last tile
                tileMap.put(tile.getKey(), tile);
            }
        }

        return tile;
    }

    /**
     * Write tile to disk cache
     * @param tile tile to store
     * @throws IOException on write faliure
     */
    public void storeTile(Tile tile) throws IOException {
        if (tile.isEmpty()) {
            log.info("Avoid to store empty tile on chache: " + tile.toString());
            return;
        }

        File file = new File(getCachePath(tile));
        FileUtils.writeByteArrayToFile(file, tile.getImage());
        tileMap.put(tile.getKey(), tile);
    }

    public boolean isTileCached(Tile tile) {
        File file = new File(getCachePath(tile));
        Calendar calendar = Calendar.getInstance();
        calendar.add(Calendar.DAY_OF_YEAR, -age);

        if (!file.exists()) {
            log.info("Tile not found in cache: [" + file.getAbsolutePath() + "]");
        } else {
            log.info("Tile found in cache: [" + file.getAbsolutePath() + "]");
        }

        return file.exists(); // && file.lastModified()  < calendar.getTimeInMillis();
    }

    /**
     * @return File path of a tile in disk cache
     */
    protected String getCachePath(Tile tile) {
        int x = tile.getX();
        int y = tile.getY();
        int zoom = tile.getZoom();
        String type = tile.getType();
        String layer = tile.getLayer();

        String path = getCachePath() + File.separator + getPath();
        if (!StringUtils.isBlank(type)) {
            path += File.separator + type;
        }

        if (!StringUtils.isBlank(layer)) {
            path += File.separator + Integer.toHexString(layer.hashCode());
        }

        path += File.separator + zoom + File.separator + x + File.separator + y + ".png";

        //       path += File.separator + zoom + File.separator + x / 1024 + 
        //             File.separator + x % 1024 + File.separator + y / 1024 + 
        //             File.separator + y % 1024 + ".png";

        return path;
    }

    protected abstract Tile parseTile(String uri);

    /**
     * @return the cachePath
     */
    public String getCachePath() {
        return cachePath;
    }

    /**
     * @param cachePath the cachePath to set
     */
    public void setCachePath(String cachePath) {
        this.cachePath = cachePath;
    }

    public void setConfig(CacheConfig config) {
        this.tileMap = Collections.synchronizedMap(new LRUMap(config.getSize()));
        this.name = config.getName();
        this.serverUrl = config.getUrl();
        this.cachePath = config.getDiskCachePath();
        this.path = config.getPath();
        this.age = config.getAge();
    }

    /**
     * @return the name
     */
    public String getName() {
        return name;
    }

    /**
     * @param name the name to set
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * @return the serverUrl
     */
    public String getServerUrl() {
        return serverUrl;
    }

    public String getServerUrl(String query) {
        return serverUrl;
    }

    /**
     * @param serverUrl the serverUrl to set
     */
    public void setServerUrl(String serverUrl) {
        this.serverUrl = serverUrl;
    }

    /**
     * {@inheritDoc}
     * @throws IOException 
     */
    public InputStream parseResponse(InputStream serverStream, String remoteUri, String localUri)
            throws IOException {
        return serverStream;
    }

    /**
     * Create a parameter map from a query string
     * @param uri the query string
     * @return a map with parameters
     */
    protected Map<String, String> getParameterMap(String uri) {
        UriComponentsBuilder b = UriComponentsBuilder.newInstance();
        b.query(uri);
        UriComponents c = b.build();
        return c.getQueryParams().toSingleValueMap();
    }

    /**
     * @return the path
     */
    public String getPath() {
        return path;
    }

    /**
     * @param path the path to set
     */
    public void setPath(String path) {
        this.path = path;
    }

    /**
     * @return the age
     */
    public int getAge() {
        return age;
    }

    /**
     * @param age the age to set
     */
    public void setAge(int age) {
        this.age = age;
    }

}