Application: gvSIG desktop

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004-2006 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *   Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Iba?ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *   +34 963862235

 *   gvsig@gva.es

 *   www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package org.gvsig.publish.mapserver.model.wms;

import java.awt.Color;

import java.awt.geom.Rectangle2D;

import java.io.File;

import java.io.IOException;

import org.gvsig.publish.PublishLogger;

import org.gvsig.publish.exceptions.PublishException;

import org.gvsig.publish.infoproject.IDataSourceInfo;

import org.gvsig.publish.infoproject.ILayerInfo;

import org.gvsig.publish.infoproject.ISymbolInfo;

import org.gvsig.publish.infoproject.datasources.IDataBaseInfo;

import org.gvsig.publish.infoproject.legends.IIntervalLegendInfo;

import org.gvsig.publish.infoproject.legends.ISingleSymbolLegendInfo;

import org.gvsig.publish.infoproject.legends.IUniqueValuesLegendInfo;

import org.gvsig.publish.infoproject.symbols.IFillSymbolInfo;

import org.gvsig.publish.infoproject.symbols.ILineSymbolInfo;

import org.gvsig.publish.infoproject.symbols.IMarkerSymbolInfo;

import org.gvsig.publish.infoproject.symbols.ITextSymbolInfo;

import org.gvsig.publish.mapserver.conf.MapFile;

import org.gvsig.publish.mapserver.conf.MapFile.CRS;

import org.gvsig.publish.mapserver.conf.MapFile.ConfigFile;

import org.gvsig.publish.mapserver.conf.MapFile.Label;

import org.gvsig.publish.mapserver.conf.MapFile.Layer;

import org.gvsig.publish.mapserver.conf.MapFile.MapClass;

import org.gvsig.publish.mapserver.conf.MapFile.RGB;

import org.gvsig.publish.mapserver.conf.MapFile.StyleMap;

import org.gvsig.publish.mapserver.model.Mapserver;

import org.gvsig.publish.mapserver.model.MapserverLayer;

import org.gvsig.publish.mapserver.util.MapserverUtilities;

import org.gvsig.publish.ogcmetadata.IOGCLayerMetadata;

import org.gvsig.publish.ogcmetadata.OGCLayerMetadata;

import org.gvsig.publish.serversmodel.RemoteResource;

import com.iver.utiles.FileUtils;

import com.iver.utiles.XMLEntity;

/**

 * This class represents a kind of remote resource, a Mapserver-WMS layer.   

 * 

 * @author jvhigon

 *

 */

public class MapserverWMSLayer extends RemoteResource implements IOGCLayerMetadata{

        public static final String REGISTER_TAG="mapserver_wms_layer";

        //Associations        

        private OGCLayerMetadata ogcmetadata = null;

        private MapserverLayer specificParams = null;

        private MapFile.Layer config = null;

        /**

         * Constructor

         * @param service

         */

        public MapserverWMSLayer(MapserverWMS service){

                super(service);                

                ogcmetadata = new OGCLayerMetadata();

                specificParams = new MapserverLayer();                        

        }

        public MapserverLayer getLayerMapserver() {

                return specificParams;

        }

        public void setLayerMapserver(MapserverLayer layerMapserver) {

                this.specificParams = layerMapserver;

        }

        private ConfigFile getMapfile(){

                MapserverWMS wms = (MapserverWMS)getService();

                Mapserver server = (Mapserver) wms.getServer();

                return server.getConfigFile();

        }

        /**

         * Initializes the remote resource name and title with the name and title of the layer

         */

        public void setLayerInfo(ILayerInfo layerInfo) {

                super.setLayerInfo(layerInfo);

                setName(getLayerInfo().getName());

                setTitle(getLayerInfo().getTitle());

                setAbstract("generated by gvSIG");

        }

        private Mapserver getMapServer(){

                //Cast to Mapserver

                Mapserver mapserver = (Mapserver)getService().getServer();

                return mapserver;

        }

        /**

         * Generates a new layer configuration in the mapfile when is invoked

         * @see org.gvsig.publish.serversmodel.RemoteResource#publish()

         */

        public void publish() throws PublishException{

                //only for no group layers

                //TODO: wms_group_abstract ...

                if (getLayerInfo().getDataSource() != null){

                        config = new MapFile.Layer();

                        getMapfile().add(config);

                        generateLayerSection();

                }

                //publish all its childs                

                super.publish();

        }

        private void generateLayerSection() throws PublishException{                

                config.name = getName();

                config.status = "ON";

                config.debug = getMapServer().isDebug();

                config.type = MapserverUtilities.getTypeParameter(getLayerInfo().getDataSource());

                generateDataParameter();                

                config.connectiontype = MapserverUtilities.getConnectionTypeParameter(getLayerInfo().getDataSource());

                config.connection = MapserverUtilities.getConnectionParameter(getLayerInfo().getDataSource());                

                config.maxscale = new Double(getLayerInfo().getMaxscale()).toString();

                config.minscale = new Double(getLayerInfo().getMinscale()).toString();

                config.transparency = getLayerInfo().getOpacityPercent();

                config.dump = isQueryable();                

                //mosaic 

                generateMosaicSection();

                //labeling

                generateLabelingSection();

                //PROJECTION (I must query the layer to know the shape projection)

                //lyr.layercrs = new CRS(getLayerInfo().getEPSG(),true);

                config.layercrs = new CRS(getLayerInfo().getDataSource().getEPSG(),true);

                //CLASS

                generateClassSection();

                //METADATA

                generateMetadata(config);

        }

        /**

         * Generates the LAYER->DATA parameter 

         *  

         */

        private void generateDataParameter(){

                IDataSourceInfo ds = getLayerInfo().getDataSource();

                if (ds.getType() == IDataSourceInfo.POSTGIS_TYPE){

                        IDataBaseInfo db = (IDataBaseInfo)ds;

                        String table = db.getTableName();

                        String schema = db.getSchemaName();

                        if (schema !=null){

                                table = schema+ "." + table;

                        }

                        config.data ="the_geom from "  + table + " using unique " + db.getGID() + " using srid=" + ds.getSRID(); 

                }else{

                        config.data = getService().getServer().getPublication().getServerSideFilePath(ds);

                }                                

        }

        private void generateMosaicSection(){

                if (getSpecificParams().isMosaic()){

                        config.type = "RASTER";

                        config.tileIndex = getService().getServer().getPublication().getServerSideFilePath(getLayerInfo().getDataSource());

                        config.data = null;

                        config.classList.clear();

                        config.tileItem="location";

                }                

        }

        /**

         * TODO:

         * lyr.labelsizeitem = getLayerInfo().getLabeling().getLabelHeightField();

         * lyr.labelangleitem = getLayerInfo().getLabeling().getLabelRotationField();

         *  

         */

        private void generateLabelingSection(){

                if (getLayerInfo().getLabeling() != null){

                        config.labelitem = getLayerInfo().getLabeling().getLabelField();                        

                }                

        }

        /**

         * Generates object MAP->LAYER->CLASS

         * @throws PublishException 

         * 

         */

        private void generateClassSection() throws PublishException{

                //CLASS

                Object source = getLayerInfo().getLegend();                

                if(source instanceof ISingleSymbolLegendInfo){

                        ISingleSymbolLegendInfo legend = (ISingleSymbolLegendInfo)source;

                        generateSingleLegend(legend, config);                

                }

                if(source instanceof IUniqueValuesLegendInfo){

                        IUniqueValuesLegendInfo legend = (IUniqueValuesLegendInfo)source;

                        generateUniqueLegend(legend, config);                        

                }

                if(source instanceof IIntervalLegendInfo){

                        IIntervalLegendInfo legend = (IIntervalLegendInfo)source;

                        generateIntervalLegend(legend, config);                        

                }

        }

        private void generateSingleLegend(ISingleSymbolLegendInfo legend, Layer lyr) throws PublishException{

                ISymbolInfo isymbol =  legend.getSymbolInfo();                

                lyr.classList.clear();

                MapClass clase = new MapClass();                

                //put name

                clase.name = "default";

                //put the size units

                lyr.sizeunits = isymbol.getUnits();

                generateStyle(isymbol, clase);

                //put labeling if exists

                if ( getLayerInfo().getLabeling().getLabelField() != null){

                        generateSymbol(getLayerInfo().getLabeling().getSymbolInfo(), clase);

                }

                //add the class into the layer

                lyr.addClass(clase);                

        }

        /**

         * Generate an interval legend

         * @param legend

         * The legend

         * @param lyr

         * The layer

         * @throws PublishException 

         * 

         * 

         */

        private void generateIntervalLegend(IIntervalLegendInfo legend, Layer lyr) throws PublishException{

                //check if is labeled

                boolean islabeled = false;

                if ( getLayerInfo().getLabeling().getLabelField() != null){

                        islabeled = true;

                }

                String[] expressions = legend.getExpressions();

                for (int i=0 ; i<expressions.length ; i++){

                        ISymbolInfo isymbol = legend.getSymbolByExpression(expressions[i]);

                        MapClass clase = new MapClass();

                        clase.name = isymbol.getTitle();

                        //TODO: change in infoProject

                        clase.expression = "(" + expressions[i] + ")";

                        generateStyle(isymbol, clase);

                        if (islabeled){

                                generateSymbol(getLayerInfo().getLabeling().getSymbolInfo(), clase);

                        }

                        lyr.addClass(clase);

                }

        }

        private void generateUniqueLegend(IUniqueValuesLegendInfo legend, Layer lyr) throws PublishException{

                //check if is labeled

                boolean islabeled = false;

                if ( getLayerInfo().getLabeling().getLabelField() != null){

                        islabeled = true;

                }

                //put the CLASSITEM

                lyr.classitem = legend.getFilterItem();

                //create all CLASS

                String[] uniqueValues = legend.getUniqueValues();

                for (int i =0; i< uniqueValues.length;i++){

                        ISymbolInfo isymbol = legend.getSymbol(uniqueValues[i]);

                        //create a CLASS

                        MapClass clase = new MapClass();

                        clase.name = isymbol.getTitle();

                        //TODO: change in infoProject                        

                        clase.expression = "\"" +  uniqueValues[i] + "\"";

                        generateStyle(isymbol, clase);

                        if (islabeled){

                                generateSymbol(getLayerInfo().getLabeling().getSymbolInfo(), clase);

                        }

                        //add the class into the layer

                        lyr.addClass(clase);

                }

        }

        private void generateStyle(ISymbolInfo isymbol, MapClass clase) throws PublishException{                

                if (getLayerInfo().getDataSource().getDataType() == IDataSourceInfo.POINT_DATA){

                        //I can do a cast to Marker Symbol

                        IMarkerSymbolInfo pointSymbol = (IMarkerSymbolInfo)isymbol;

                        generateSymbol(pointSymbol, clase);

                }

                if (getLayerInfo().getDataSource().getDataType() == IDataSourceInfo.LINE_DATA){

                        //I can do a cast to Line Symbolizer

                        ILineSymbolInfo lineSymbol = (ILineSymbolInfo)isymbol;

                        generateSymbol(lineSymbol, clase);

                }        

                if (getLayerInfo().getDataSource().getDataType() == IDataSourceInfo.POLYGON_DATA){

                        //I can do a cast to Polygon Symbolizer

                        IFillSymbolInfo fillSymbol = (IFillSymbolInfo)isymbol;

                        generateSymbol(fillSymbol, clase);

                }

        }

        private void generateSymbol(ITextSymbolInfo textSymbol, MapClass clase){

                clase.etiqueta = new Label();

                //TODO: change by getColor()

                Color c = textSymbol.getFontColor();

                clase.etiqueta.color = new RGB(c.getRed(), c.getGreen(), c.getBlue());

                clase.etiqueta.angle = getLayerInfo().getLabeling().getLabelRotationField();

                clase.etiqueta.font = "vera";

                String hf = getLayerInfo().getLabeling().getLabelHeightField();

                if (hf ==null){

                        clase.etiqueta.size = new Double(textSymbol.getFontSize()).toString();

                }else{

                        clase.etiqueta.size = "[" + hf + "]";

                }

                clase.etiqueta.type = "truetype";

                if (!getLayerInfo().getLabeling().isVisibleFeatures()){

                        config.type ="ANNOTATION";

                }

        }

        private void generateSymbol(IMarkerSymbolInfo pointSymbol, MapClass clase) throws PublishException {

                clase.estilo = new StyleMap();                

                Color c = pointSymbol.getColor();

                clase.estilo.styleColor = new RGB(c.getRed(), c.getGreen(), c.getBlue());

                clase.estilo.size = pointSymbol.getSize();

                clase.symbol = pointSymbol.getWellKnowMarkerName();

                //if it's an image

                File icon = pointSymbol.getImageIconFile(); 

                if ( icon !=null){

                        clase.symbol = icon.getName();

                        Mapserver m = (Mapserver)getService().getServer();

                        String s = m.getMapfileFile().getParentFile().getAbsolutePath();

                        File dst = new File(s+ File.separator+ icon.getName());

                        try {

                                FileUtils.copy(icon, dst);

                        } catch (IOException e) {                        

                                throw new PublishException("cannot_copy_icons");                        

                        }

                }

        }

        /**

         * In Mapserver is impossible to have a dashed outline 

         * @param fillSymbol

         * @param clase

         */

        private void generateSymbol(IFillSymbolInfo fillSymbol, MapClass clase) {

                clase.estilo = new StyleMap();

                //set outline                

                ILineSymbolInfo linesymbolizer = fillSymbol.getOutline();

                Color c = linesymbolizer.getColor();

                clase.estilo.styleColorOutline = new RGB(c.getRed(), c.getGreen(), c.getBlue());

                clase.estilo.width = new Double(linesymbolizer.getLineWitdth()).intValue();                

                //set fill

                c = fillSymbol.getColor();

                clase.estilo.styleColor = new RGB(c.getRed(), c.getGreen(), c.getBlue());                                

                //if it is a well known polygon

                clase.symbol = fillSymbol.getWellKnowFillName();

        }

        private void generateSymbol(ILineSymbolInfo lineSymbol, MapClass clase) {

                Color c = lineSymbol.getColor();                

                clase.estilo = new StyleMap();

                clase.estilo.width = new Double(lineSymbol.getLineWitdth()).intValue();

                clase.estilo.styleColor = new RGB(c.getRed(), c.getGreen(), c.getBlue());

                //if it is a well know line

                clase.symbol = lineSymbol.getWellKnowLineName();

        }

        /**

         * Generates the METADATA object

         * @param mapLayer

         * 

         */

        private void generateMetadata(Layer mapLayer){

                //add metadata

                mapLayer.metadata.wms_name = getName();

                mapLayer.metadata.wms_title =getTitle();

                mapLayer.metadata.wms_abstract = getAbstract();

                Rectangle2D aux = getLayerInfo().getDataSource().getNativeBBox();

                String bbox = aux.getMinX() + " " + aux.getMinY() + " " + aux.getMaxX() + " " + aux.getMaxY();

                mapLayer.metadata.wms_extent = bbox;

                mapLayer.metadata.gml_include_items = "all";         

                //adding layer_group

                if (getLayerInfo().getPathString().equals("/")==false){

                        String aux2 = getLayerInfo().getPathString();

                        mapLayer.metadata.wms_layer_group = aux2.substring(0,aux2.length()-1);

                }

        }

        /*

         * (non-Javadoc)

         * @see com.iver.utiles.IPersistance#getClassName()

         */

        public String getClassName() {        

                return "MapserverWMSLayer";

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.serversmodel.RemoteResource#getXMLEntity()

         */

        public XMLEntity getXMLEntity() {

                XMLEntity xml=super.getXMLEntity();

                //put version and name

                xml.setName(getClassName());

                xml.putProperty("version", getVersion());

                //put associations

                XMLEntity child = new XMLEntity();

                child.setName("ogcmetadata");

                child.addChild(ogcmetadata.getXMLEntity());

                xml.addChild(child);

                child = new XMLEntity();

                child.setName("mapserverlayer");

                child.addChild(specificParams.getXMLEntity());

                xml.addChild(child);        

                return xml;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.serversmodel.RemoteResource#setXMLEntity(com.iver.utiles.XMLEntity)

         */

        public void setXMLEntity(XMLEntity xml) {

                //check version

                int version = xml.getIntProperty("version");

                if (version != getVersion()){

                        PublishLogger.getLog().error("ERROR: " + getClassName() + ": the version doesn't match!");                        

                        return;

                }

                super.setXMLEntity(xml);                                                

                //set associations

                XMLEntity child = xml.firstChild("name","ogcmetadata");

                ogcmetadata.setXMLEntity(child.getChild(0));                

                child = xml.firstChild("name","mapserverlayer");

                specificParams.setXMLEntity(child.getChild(0));

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.IPublishPersistence#getVersion()

         */

        public int getVersion() {                

                return 1;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.ogcmetadata.IOGCWMSLayerMetadata#isQueryable()

         */

        public boolean isQueryable() {

                return ogcmetadata.isQueryable();

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.ogcmetadata.IOGCWMSLayerMetadata#setQueryable(boolean)

         */

        public void setQueryable(boolean queryable) {

                ogcmetadata.setQueryable(queryable);                

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.ogcmetadata.IOGCCommonMetadata#getAbstract()

         */

        public String getAbstract() {                

                return ogcmetadata.getAbstract();

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.ogcmetadata.IOGCCommonMetadata#getName()

         */

        public String getName() {                

                return ogcmetadata.getName();

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.ogcmetadata.IOGCCommonMetadata#setAbstract(java.lang.String)

         */

        public void setAbstract(String description) {

                ogcmetadata.setAbstract(description);                

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.ogcmetadata.IOGCCommonMetadata#setName(java.lang.String)

         */

        public void setName(String name) {

                ogcmetadata.setName(name);                

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.ogcmetadata.IOGCCommonMetadata#setTitle(java.lang.String)

         */

        public void setTitle(String title) {

                ogcmetadata.setTitle(title);                

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.ogcmetadata.IOGCCommonMetadata#getTitle()

         */

        public String getTitle() {                

                return ogcmetadata.getTitle();

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.publish.serversmodel.RemoteResource#getRegisterTag()

         */

        public String getRegisterTag() {                

                return REGISTER_TAG;

        }

        /*

         * (non-Javadoc)

         * @see java.lang.Object#toString()

         */

        public String toString(){

                return getName();

        }

        /**

         * @return the specificParams

         */

        public MapserverLayer getSpecificParams() {

                return specificParams;

        }

        /**

         * @param specificParams the specificParams to set

         */

        public void setSpecificParams(MapserverLayer specificParams) {

                this.specificParams = specificParams;

        }

}