gvSIG data provider for OpenStreetMap (raster)

/* OSM layers for gvSIG. 

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

package org.gvsig.raster.osm.app.osmclient.layer;

import java.awt.Dimension;

import java.awt.Graphics2D;

import java.awt.Image;

import java.awt.Point;

import java.awt.geom.Point2D;

import java.awt.image.BufferedImage;

import java.lang.ref.WeakReference;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Iterator;

import java.util.List;

import javax.print.attribute.PrintRequestAttributeSet;

import org.cresques.cts.ICoordTrans;

import org.gvsig.andami.PluginServices;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataParameters;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.coverage.RasterLocator;

import org.gvsig.fmap.dal.coverage.RasterManager;

import org.gvsig.fmap.dal.coverage.datastruct.Extent;

import org.gvsig.fmap.dal.coverage.datastruct.NoData;

import org.gvsig.fmap.dal.coverage.datastruct.ViewPortData;

import org.gvsig.fmap.dal.coverage.exception.FilePaletteException;

import org.gvsig.fmap.dal.coverage.exception.InfoByPointException;

import org.gvsig.fmap.dal.coverage.exception.ProcessInterruptedException;

import org.gvsig.fmap.dal.coverage.exception.QueryException;

import org.gvsig.fmap.dal.coverage.grid.RasterFilter;

import org.gvsig.fmap.dal.coverage.store.RasterDataStore;

import org.gvsig.fmap.dal.coverage.store.parameter.RasterDataParameters;

import org.gvsig.fmap.dal.coverage.store.parameter.TileDataParameters;

import org.gvsig.fmap.dal.coverage.store.props.ColorInterpretation;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.exception.InitializeException;

import org.gvsig.fmap.dal.exception.ProviderNotRegisteredException;

import org.gvsig.fmap.dal.exception.ReadException;

import org.gvsig.fmap.dal.exception.ValidateDataParametersException;

import org.gvsig.fmap.dal.spi.DataManagerProviderServices;

import org.gvsig.fmap.geom.Geometry.SUBTYPES;

import org.gvsig.fmap.geom.GeometryLocator;

import org.gvsig.fmap.geom.GeometryManager;

import org.gvsig.fmap.geom.exception.CreateEnvelopeException;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.fmap.mapcontext.ViewPort;

import org.gvsig.fmap.mapcontext.exceptions.LoadLayerException;

import org.gvsig.fmap.mapcontext.layers.FLayer;

import org.gvsig.fmap.mapcontext.layers.operations.IHasImageLegend;

import org.gvsig.fmap.mapcontext.rendering.legend.ILegend;

import org.gvsig.raster.fmap.layers.DefaultFLyrRaster;

import org.gvsig.raster.fmap.layers.IRasterLayerActions;

import org.gvsig.raster.fmap.layers.NotAvailableStateException;

import org.gvsig.raster.osm.io.OSMDataParameters;

import org.gvsig.raster.swing.RasterSwingLibrary;

import org.gvsig.raster.util.CancelTaskImpl;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynObjectSet;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.task.SimpleTaskStatus;

import org.gvsig.tools.task.TaskStatusManager;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Open Street Map layer class.

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public class FLyrOSM extends DefaultFLyrRaster implements IHasImageLegend {

        private static final GeometryManager geomManager               = GeometryLocator.getGeometryManager();

        private static final Logger          logger                    = LoggerFactory.getLogger(FLyrOSM.class);

        private List<WeakReference<Thread>>         disableUpdateDrawVersion;

        private boolean                                                 firstLoad                 = false;

        private RasterManager                rManager                  = RasterLocator.getManager();

        private boolean                      deleteCache               = false;

        public static void registerPersistent() {

                PersistenceManager manager = ToolsLocator.getPersistenceManager();

                DynStruct definition = manager.getDefinition("FLyrOSM_Persistent");

                if( definition == null ) {

                        if (manager.getDefinition(DefaultFLyrRaster.class) == null) {

                                DefaultFLyrRaster.registerPersistent();

                        }

                        definition = manager.addDefinition(

                                        FLyrOSM.class,

                                        "FLyrOSM_Persistent",

                                        "FLyrOSM Persistent Definition",

                                        null, 

                                        null

                        );

                        definition.extend(PersistenceManager.PERSISTENCE_NAMESPACE, DefaultFLyrRaster.PERSISTENT_NAME);

                }

        }

        public FLyrOSM() {

                super();

                this.updateDrawVersion();

                try {

                        enableAwake();

                } catch (NotAvailableStateException e) {

                        logger.error("Fallo el estado de open. Closed=" + isClosed() + " Awake=" + isAwake(), this, e);

                }

        }

        public static DataStore createDataStore(String host) throws InitializeException {

                DataManagerProviderServices dataman = (DataManagerProviderServices) DALLocator.getDataManager();

                RasterDataParameters params = null;

                try {

                        params = (RasterDataParameters)dataman.createStoreParameters("OSM Raster");

                } catch (InitializeException e) {

                        RasterSwingLibrary.messageBoxInfo("error_creating_parameters", PluginServices.getMDIManager().getActiveWindow(), e);

                } catch (ProviderNotRegisteredException e) {

                        RasterSwingLibrary.messageBoxInfo("error_creating_parameters", PluginServices.getMDIManager().getActiveWindow(), e);

                }

                params.setURI(host);

                try {

                        return dataman.openStore(params.getDataStoreName(), params);

                } catch (ValidateDataParametersException e) {

                        throw new InitializeException(e);

                } catch (ProviderNotRegisteredException e) {

                        throw new InitializeException(e);

                }

        }

        public void setDataStore(DataStore dataStore) throws LoadLayerException {

                this.dataStore = (RasterDataStore) dataStore;

                try {

                        enableOpen();

                } catch (NotAvailableStateException e) {

                        logger.error("Fallo el estado de open. Closed=" + isClosed() + " Awake=" + isAwake(), this, e);

                }

                setProjection(this.dataStore.getProjection());

                //setFullExtent(this.dataStore.getExtent().toRectangle2D());

        }

        @SuppressWarnings("deprecation")

        public void draw(BufferedImage image, Graphics2D g, ViewPort viewPort,

                         org.gvsig.tools.task.Cancellable cancel, double scale) throws ReadException {

                TaskStatusManager manager = ToolsLocator.getTaskStatusManager();

                SimpleTaskStatus taskStatus = new RasterTaskStatus("Drawing " + getName() + "...", cancel);

                manager.add(taskStatus);

                taskStatus.setAutoremove(true);

                //Solo el zoom normal recalcula el nivel dependiendo de la escala. El zoom por niveles asigna

                //?l el nivel de zoom por lo que no habr? que recalcularlo.

                if(recalcLevel) {

                        double pixelSize = viewPort.getExtent().getWidth() / (double)viewPort.getImageWidth();

                        zoomLevel = dataStore.getNearestLevel(pixelSize);

                }

                recalcLevel = true;

                if(!firstLoad) {

                        try {

                                initFilters();

                                try {

                                        if(!isOpen())

                                                enableOpen();

                                } catch (NotAvailableStateException e) {

                                        throw new ReadException("Fallo el estado de open. Closed=" + isClosed() + " Awake=" + isAwake(), e);

                                }

                        } catch (FilePaletteException e) {

                                throw new ReadException(e.getMessage(), e);

                        }

                        firstLoad = true;

                }

                enableStopped();

                if (isWithinScale(scale)) {

                        if (!viewPort.getAdjustedExtent().intersects(getFullEnvelope()))

                                return;

                        Envelope adjustedExtent = viewPort.getAdjustedEnvelope();

                        Extent ext = rManager.getDataStructFactory().createExtent(

                                        adjustedExtent.getLowerCorner().getX(),

                                        adjustedExtent.getUpperCorner().getY(), 

                                        adjustedExtent.getUpperCorner().getX(),

                                        adjustedExtent.getLowerCorner().getY());

                        Dimension imgSz = viewPort.getImageSize();

                        ViewPortData vp2 = rManager.getDataStructFactory().createViewPortData(viewPort.getProjection(), ext, imgSz );

                        vp2.setMat(viewPort.getAffineTransform());

                        try {

                                OSMDataParameters par = getOSMParameters(getDataStore().getParameters());

                                par.setWidth((int)viewPort.getImageSize().getWidth());

                                par.setHeight((int)viewPort.getImageSize().getHeight());

                                getRender().drawTiledService(g, vp2, viewPort.getImageSize(), taskStatus);

                        } catch (ProcessInterruptedException e) {

                                throw new ReadException("Problems drawing this layer: " + e.getMessage(), e);

                        } catch (QueryException e) {

                                throw new ReadException("Problems drawing this layer: " + e.getMessage(), e);

                        } finally {

                                taskStatus.terminate();

                        }

                }

                disableStopped();

        }

        /**

         * @see com.iver.cit.gvsig.fmap.layers.FLayer#print(java.awt.Graphics2D,

         *                 com.iver.cit.gvsig.fmap.ViewPort,

         *                 com.iver.cit.gvsig.fmap.operations.Cancellable)

         */

        @SuppressWarnings("deprecation")

        public void print(Graphics2D g, ViewPort viewPort,  org.gvsig.tools.task.Cancellable cancel, 

                        double scale, PrintRequestAttributeSet properties) throws ReadException {

        }

        @SuppressWarnings("deprecation")

        public void _print(Graphics2D g, ViewPort viewPort,  org.gvsig.tools.task.Cancellable cancel,

                        double scale) throws ReadException {

                draw(null, g, viewPort, cancel,scale);

        }

        public HashMap<String, Object> getProperties() {

                HashMap<String, Object> info = new HashMap<String, Object>();

                OSMDataParameters par = getOSMParameters(getDataStore().getParameters());

                String layerName = getName();

                try {

                        info.put("selectedLayer", layerName);

                        info.put("host", par.getURI());

                        info.put("srs", dataStore.getProjection().getAbrev());

                        return info;

                } catch (Exception e) {

                        e.printStackTrace();

                }

                return null;

        }

        public String getTocImageIcon() {

                return "icon-layer-osm";

        }

        public boolean isActionEnabled(int action) {

                switch (action) {

                case IRasterLayerActions.ZOOM_PIXEL_RESOLUTION:

                case IRasterLayerActions.FLYRASTER_BAR_TOOLS:

                case IRasterLayerActions.BANDS_FILE_LIST:

                case IRasterLayerActions.GEOLOCATION:

                case IRasterLayerActions.PANSHARPENING:

                case IRasterLayerActions.SAVE_COLORINTERP:

                case IRasterLayerActions.SAVEAS:

                case IRasterLayerActions.BANDS_RGB:

                case IRasterLayerActions.CLIPPING:

                case IRasterLayerActions.ENHANCED:

                case IRasterLayerActions.STATS:

                case IRasterLayerActions.NODATA:

                case IRasterLayerActions.HISTOGRAM:

                        return false;

                case IRasterLayerActions.COLOR_TABLE:

                case IRasterLayerActions.REMOTE_ACTIONS:

                        return true;

                }

                return super.isActionEnabled(action);

        }

        public ILegend getLegend() {

                return null;

        }

        public boolean isRemote() {

                return true;

        }

        public boolean overviewsSupport() {

                return false;

        }

        protected void updateDrawVersion() {

                if (this.disableUpdateDrawVersion != null){

                        Thread curThread = Thread.currentThread();

                        Thread aThread;

                        Iterator<WeakReference<Thread>> iter = this.disableUpdateDrawVersion.iterator();

                        while (iter.hasNext()){

                                aThread = (Thread) ((WeakReference<?>)iter.next()).get();

                                if (aThread == null){

                                        iter.remove();

                                } else if(aThread.equals(curThread)){

                                        return;

                                }

                        }

                }

                super.updateDrawVersion();

        }

        protected void disableUpdateDrawVersion() {

                if (this.disableUpdateDrawVersion == null) {

                        this.disableUpdateDrawVersion = new ArrayList<WeakReference<Thread>>();

                }

                this.disableUpdateDrawVersion.add(new WeakReference<Thread>(Thread.currentThread()));

        }

        protected void enableUpdateDrawVersion() {

                if (this.disableUpdateDrawVersion == null) {

                        return;

                }

                Thread curThread = Thread.currentThread();

                Thread aThread;

                Iterator<WeakReference<Thread>> iter = this.disableUpdateDrawVersion.iterator();

                while (iter.hasNext()) {

                        aThread = (Thread) ((WeakReference<?>)iter.next()).get();

                        if (aThread == null) {

                                iter.remove();

                        } else if(aThread.equals(curThread)) {

                                iter.remove();

                                break;

                        }

                }

        }

        /*private Rectangle2D.Double getRectable2DFromEnvelope(Envelope env) {

                return new Rectangle2D.Double(env.getMinimum(0), env.getMinimum(1), env

                                .getLength(0), env.getLength(1));

        }

        private Envelope getEnvelopeFromRectable2D(Rectangle2D rect) {

                try {

                        return geomManager.createEnvelope(rect.getMinX(), rect.getMinY(),

                                        rect.getMaxX(), rect.getMaxY(),

                                        SUBTYPES.GEOM2D);

                } catch (CreateEnvelopeException e) {

                        logger.error("Error creating the envelope", e);

                }

                return null;

        }*/

        @Override

        public String getFileFormat() {

                return "OSM";

        }

        /**

         * Devuelve el envelope en la proyeccion de la vista

         */

        public Envelope getFullEnvelope() {

                Extent e1 = getDataStore().getExtent();

                Envelope rAux = null;

                try {

                        rAux = geomManager.createEnvelope(e1.getMin().getX(), e1.getMin().getY(), e1.getMax().getX(), e1.getMax().getY(), SUBTYPES.GEOM2D);

                } catch (CreateEnvelopeException exc) {

                        logger.error("Error creating the envelope", exc);

                }

                // Esto es para cuando se crea una capa nueva con el fullExtent de ancho

                // y alto 0.

                if (rAux == null || rAux.getMaximum(0) - rAux.getMinimum(0) == 0

                                && rAux.getMaximum(1) - rAux.getMinimum(1) == 0) {

                        try {

                                rAux = geomManager.createEnvelope(0, 0, 100, 100, SUBTYPES.GEOM2D);

                        } catch (CreateEnvelopeException e) {

                                logger.error("Error creating the envelope", e);

                        }

                }

                // Si existe reproyecci?n, reproyectar el extent

                ICoordTrans ct = getCoordTrans();

                if (ct != null) {

                        Point2D pt1 = new Point2D.Double(rAux.getMinimum(0), rAux

                                        .getMinimum(1));

                        Point2D pt2 = new Point2D.Double(rAux.getMaximum(0), rAux

                                        .getMaximum(1));

                        pt1 = ct.convert(pt1, null);

                        pt2 = ct.convert(pt2, null);

                        try {

                                rAux = geomManager.createEnvelope(pt1.getX(), pt1.getY(), pt2

                                                .getX(), pt2.getY(), SUBTYPES.GEOM2D);

                        } catch (CreateEnvelopeException e) {

                                logger.error("Error creating the envelope", e);

                        }// new

                        // Rectangle2D.Double();

                }

                return rAux;

        }

        public Extent getFullRasterExtent() {

                Envelope env = getFullEnvelope();

                double minx = env.getMinimum(0);

                double miny = env.getMinimum(1);

                double maxx = env.getMaximum(0);

                double maxy = env.getMaximum(1);

                Point2D ul = new Point2D.Double(minx, maxy);

                Point2D ur = new Point2D.Double(maxx, maxy);

                Point2D ll = new Point2D.Double(minx, miny);

                Point2D lr = new Point2D.Double(maxx, miny);

                return rManager.getDataStructFactory().createExtent(ul, lr, ur, ll);

        }

    @SuppressWarnings("deprecation")

        public DynObjectSet getInfo(Point p, double tolerance, org.gvsig.tools.task.Cancellable cancel)

                throws LoadLayerException, DataException {

                return null;

        }

    @SuppressWarnings("deprecation")

        public DynObjectSet getInfo(Point p, double tolerance, org.gvsig.tools.task.Cancellable cancel, boolean fast)

    throws LoadLayerException, DataException {

            Point2D pReal = getMapContext().getViewPort().toMapPoint(p);

            @SuppressWarnings("unused")

                String fInfo = null;

            try {

                    fInfo = getDataStore().getInfoByPoint(pReal.getX(), pReal.getY(), new CancelTaskImpl(cancel));

            } catch (InfoByPointException e) {

                    throw new LoadLayerException("Error in getInfoByPoint", e);

            }

            return null;

            //return new DynObjectSetWMTSInfo(fInfo, type);

    }

    /**

     * Sets the data store parameters

     * @param params

     * @throws InitializeException

     */

    public void setParameters(DataStoreParameters params) throws InitializeException {

                if(params instanceof TileDataParameters) {

                        ((TileDataParameters)params).deleteCache(deleteCache);

                }

            DataManagerProviderServices dataman = (DataManagerProviderServices) DALLocator.getDataManager();

                try {

                        DataStore dStore = dataman.openStore(params.getDataStoreName(), params);

                        this.setDataStore(dStore);

                        if(params instanceof OSMDataParameters) {

                                this.setName(((OSMDataParameters) params).getURI());

                        }

                        if(params instanceof TileDataParameters) {

                                DataParameters p = ((TileDataParameters) params).getDataParameters();

                                if(p instanceof OSMDataParameters) {

                                        this.setName(((OSMDataParameters) p).getURI());

                                }

                        }

                } catch (ValidateDataParametersException e) {

                        throw new InitializeException(e);

                } catch (ProviderNotRegisteredException e) {

                        throw new InitializeException(e);

                } catch (InitializeException e) {

                        throw new InitializeException(e);

                } catch (LoadLayerException e) {

                        throw new InitializeException(e);

                }

    }

    /**

     * Gets <code>WMTSDataParameters</code>

     * @param parameters

     * @return

     */

    private OSMDataParameters getOSMParameters(DataStoreParameters parameters) {

            OSMDataParameters params = null;

            if(parameters instanceof OSMDataParameters) {

                        params = (OSMDataParameters) parameters;

                }

                if(parameters instanceof TileDataParameters) {

                        DataParameters p = ((TileDataParameters) parameters).getDataParameters();

                        if(p instanceof OSMDataParameters) {

                                params = (OSMDataParameters) p;

                        }

                }

                return params;

    }

        public Image getImageLegend() {

                return null;

        }

        public String getPathImage() {

                return null;

        }

        public FLayer cloneLayer() throws Exception {

                RasterDataStore  ds = dataStore.cloneDataStore();

                FLyrOSM newLayer = new FLyrOSM();

                newLayer.setName(getName());

                newLayer.setOpenRasterStore(ds);

                newLayer.firstLoad = firstLoad;

                List<RasterFilter> filters = getRender().getFilterList().getStatusCloned();

                //Hacemos una copia de las bandas a renderizar

                ColorInterpretation ci = getRender().getRenderColorInterpretation();

                if(ci != null) {

                        newLayer.getRender().setRenderColorInterpretation(ci.cloneColorInterpretation());

                }

                //Asignamos el entorno

                if(newLayer.getRender().getFilterList() == null)

                        newLayer.getRender().setFilterList(RasterLocator.getManager().createEmptyFilterList(getRender().getFilterList().getInitDataType()));

                newLayer.getRender().getFilterList().setEnv(getRender().getFilterList().getEnv());

                newLayer.getRender().getFilterList().setStatus(filters);

                // Asignamos los valores noData del original

                NoData nd = (NoData)getNoDataValue().clone();

                newLayer.setNoDataValue(nd);

                newLayer.enableOpen();

                return newLayer;

        }

        /**

         * Assigns the flag to delete this layer from the cache

         * @param selected

         */

        public void deleteCache(boolean deleteCache) {

                this.deleteCache = deleteCache;

        }

}