Application: gvSIG desktop

package org.gvsig.remoteClient.wms;

import java.io.BufferedOutputStream;

import java.io.DataOutputStream;

import java.io.File;

import java.io.FileOutputStream;

import java.io.FileReader;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.net.ConnectException;

import java.net.URL;

import java.net.UnknownHostException;

import java.util.TreeMap;

import java.util.Vector;

import org.gvsig.remoteClient.exceptions.ServerErrorException;

import org.gvsig.remoteClient.exceptions.WMSException;

import org.gvsig.remoteClient.utils.CapabilitiesTags;

import org.gvsig.remoteClient.utils.Utilities;

import org.kxml2.io.KXmlParser;

import com.devx.io.TempFileManager;

/**

 * <p> Abstract class that represents handlers to comunicate via WMS protocol.

 * </p>

 * 

 */

public abstract class WMSProtocolHandler {

        /**

         * procotol handler name

         */

    protected String name;

    /**

     * protocol handler version

     */

    protected String version;

    /**

     * host of the WMS to connect

     */

    protected String host;

    /**

     *  port number of the comunication channel of the WMS to connect

     */

    protected String port;    

    /**

     * WMS metadata

     */

    protected ServiceInformation serviceInfo;

    public TreeMap layers;

    public WMSLayer rootLayer;

    public Vector srs;

    // abstract methods to implement by the handlers that implement

    // the connection to a WMS with certain version.

    //    public abstract String getName();   

    //    public abstract String getVersion();

    /**

     * parses the data retrieved by the WMS in XML format. 

     * It will be mostly the WMS Capabilities, but the implementation

     * will be placed in the handler implementing certain version of the protocol.

     * 

     */

    public abstract void parse(File f) ;

    public String getName() {        

            return name;

    } 

    public String getVersion() {        

            return version;

    }    

    public ServiceInformation getServiceInformation() {        

        return serviceInfo;

    }  

    public String getHost ()

    {

            return host;

    }

    public void setHost(String _host)

    {

            host = _host;

    }

    public String getPort()

    {

            return port;

    }

    public void setPort(String _port)

    {

            port = _port;

    }

    /**

     * <p>Builds a GetMap request that is sent to the WMS

     * the response (image) will be redirect to the

     * WMS client</p>

     */

    public byte[] getMap(WMSStatus status) throws ServerErrorException, WMSException

    {        

            URL request = null;

                try

                {

                        //TODO:

                        //pass this buildXXXRequest to the WMSProtocolHandlerXXX: The request can depend on the WMS version.

                        request = new URL(buildMapRequest(status));

            System.out.println(request.toString());

                    byte[] imageBytes = null;

                    byte[] buffer = new byte[1024*256];

            InputStream is = request.openStream();

                    int readed = 0;

                    for (int i = is.read(buffer); i>0; i = is.read(buffer)){

                // Creates a new buffer to contain the previous readed bytes and the next bunch of bytes

                            byte[] buffered = new byte[readed+i];

                            for (int j = 0; j < buffered.length; j++) {

                                    if (j<readed){

                        // puts the previously downloaded bytes into the image buffer

                                            buffered[j] = imageBytes[j];

                                    }

                                    else {

                        // appends the recently downloaded bytes to the image buffer.

                                            buffered[j] = buffer[j-readed];

                                    }

                                }

                            imageBytes = (byte[]) buffered.clone();

                            readed += i;

                    }

            System.out.println(imageBytes);

                        if (Utilities.isTextData(imageBytes)){

                String exceptionMessage = parseException(imageBytes);

                if (exceptionMessage!=null)

                    throw new WMSException(exceptionMessage);

                throw new ServerErrorException();

            }

                        return imageBytes;

                }

                catch(IOException e)

                {

                        e.printStackTrace();

            throw new ServerErrorException();

                }

    } 

        /**

     * Parses a WMS exception XML document.

     * @param imageBytes

     * @return

     */

    protected abstract String parseException(byte[] imageBytes) ;

    /**

         * <p>Builds a GetCapabilities request that is sent to the WMS

         * the response will be parse to extract the data needed by the

         * WMS client</p>

         */

    public void getCapabilities()

    {                

            URL request = null;

                try

                {

                        request = new URL(buildCapabilitiesRequest());

                }

                catch(Exception e)

                {

                        e.printStackTrace();

                }

//                   File f = null;

//                   f = new File("tochangethis.txt");

//            

//            if (!f.exists())

//            {

//                    try

//                    {

//                            DataOutputStream dos = new DataOutputStream( new BufferedOutputStream(new FileOutputStream(f)));

//                            byte[] buffer = new byte[1024*256];

//                            InputStream is = request.openStream();

//                            long readed = 0;

//                            for (int i = is.read(buffer); i>0; i = is.read(buffer)){

//                                    dos.write(buffer, 0, i);

//                                    readed += i;

//                            }

//                            dos.close();

//                    }

//                    catch(Exception e)

//                    {}

//            }

                try

                {

                File f = downloadFile(request,"wms_capabilities.xml");

            parse(f);

                } catch(Exception e)

                {

                        //TODO

                        e.printStackTrace();

                }

    }

/**

 * <p>It will send a GetFeatureInfo request to the WMS

 * Parsing the response and redirecting the info to the WMS client</p>

 */

    public String getFeatureInfo(WMSStatus status, int x, int y, int featureCount)

    {

            URL request = null;

            StringBuffer  output = new StringBuffer();

                try

                {

                        //TODO:

                        //pass this buildXXXRequest to the WMSProtocolHandlerXXX: The request can depend on the WMS version.

                        request = new URL(buildGetFeatureInfoRequest(status, x, y));

                }

                catch(Exception e)

                {

                        e.printStackTrace();

                }

            try

            {            

                    System.out.println(request.toString());

                    File f = new File("featureInfo.xml");

                    DataOutputStream dos = new DataOutputStream(new FileOutputStream(f));           

                    OutputStream bos = null;

                    byte[] buffer = new byte[1024*256];

                    InputStream is = request.openStream();

                    //long readed = 0;

                    for (int i = is.read(buffer); i>0; i = is.read(buffer)){

                            dos.write(buffer, 0, i);

                            output.append(buffer);

                            //readed += i;

                    }

                    dos.close();

                    StringBuffer sb = new StringBuffer();

                    sb.append("<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>");

                    int tag;

                    KXmlParser kxmlParser = null;

                    kxmlParser = new KXmlParser();            

                    kxmlParser.setInput(new FileReader(f));                

                        tag = kxmlParser.nextTag();

                    if ( kxmlParser.getEventType() != KXmlParser.END_DOCUMENT ) 

                    {                    

                            //tag = kxmlParser.nextTag();

                                 while(tag != KXmlParser.END_DOCUMENT)

                                 {

                                         switch(tag)

                                         {

                                                case KXmlParser.START_TAG:                                                         

                                                        sb.append("<" + kxmlParser.getName() + ">\n");

                                                        break;

                                                case KXmlParser.END_TAG:        

                                                        sb.append("</" + kxmlParser.getName() + ">\n");

                                                        break;

                                                case KXmlParser.TEXT:

                                                        sb.append(kxmlParser.getText());                                                

                                                break;

                                         }

                                     tag = kxmlParser.next();

                             }

                    }        

                    System.out.println(sb.toString());

                return sb.toString();

            //return output.toString() ;

            }

            catch(Exception e)

            {

                    e.printStackTrace();

            return null;

            }

    }

    /**

     * Builds the GetCapabilitiesRequest according to the OGC WMS Specifications

     */

    private String buildCapabilitiesRequest()

    {

                String req = new String();

                String host = getHost();

//                if ((!host.endsWith("?"))&&(host.indexOf("?")==-1))                        

//                        req = req + getHost() + "?REQUEST=GetCapabilities&SERVICE=WMS&";

//                else

//                {

//                        String symbol = (host.endsWith("&")) ? "" : "&";

//                        req = req + getHost() + symbol + "REQUEST=GetCapabilities&SERVICE=WMS&";

//                }

                String symbol = (host.indexOf("?")==-1) ? "?" : "&";

                req = req + getHost() + symbol + "REQUEST=GetCapabilities&SERVICE=WMS&";

                req = req + "VERSION=" + getVersion();

                req += ("&EXCEPTIONS=XML");

                return req;

    }

    /**

     * Builds the GetFeatureInfoRequest according to the OGC WMS Specifications

     */

    private String buildGetFeatureInfoRequest(WMSStatus status, int x, int y)

    {

                String req = new String();

//                if (!host.endsWith("?"))

//                        req = req + getHost() + "?REQUEST=GetFeatureInfo&SERVICE=WMS&";

//                else

//                        req = req + getHost() + "REQUEST=GetFeatureInfo&SERVICE=WMS&";

                String symbol = (host.indexOf("?")==-1) ? "?" : "&";

                req = req + getHost() + symbol + "REQUEST=GetFeatureInfo&SERVICE=WMS&";

                req = req + "QUERY_LAYERS="+Utilities.Vector2CS(status.getLayerNames()); 

                req = req + "&VERSION=" + getVersion() + "&";

                req = req + "INFO_FORMAT=application/vnd.ogc.gml&";

                req = req + getPartialQuery(status);

                req = req + "&x="+x + "&y="+y;

       if (status.getExceptionFormat() != null) {

            req += ("&EXCEPTIONS=" + status.getExceptionFormat());

        } else {

            req += ("&EXCEPTIONS=XML");

        }

                return req;

    }    

    /**

     * Builds the GetMapRequest according to the OGC WMS Specifications

     */

    private String buildMapRequest(WMSStatus status)

    { 

                String req = new String();

//                if (!host.endsWith("?"))

//                        req = req + getHost() + "?REQUEST=GetMap&SERVICE=WMS&";

//                else

//                        req = req + getHost() + "REQUEST=GetMap&SERVICE=WMS&";

                String symbol = (host.indexOf("?")==-1) ? "?" : "&";

                req = req + getHost() + symbol + "REQUEST=GetMap&SERVICE=WMS&";

                req = req + "VERSION=" + getVersion() + "&";

                req = req + getPartialQuery(status);

       if (status.getExceptionFormat() != null) {

            req += ("&EXCEPTIONS=" + status.getExceptionFormat());

        } else {

            req += ("&EXCEPTIONS=XML");

        }

                return req;

    }

    /**

     * Gets the part of the OGC request that share GetMap and GetFeatureInfo

     * @return String request

     */

    public String getPartialQuery(WMSStatus status)

    {            

        String req = "LAYERS=" + Utilities.Vector2CS(status.getLayerNames()) + "&STYLES=" +

        Utilities.Vector2CS(status.getStyles()) + "&SRS=" + status.getSrs() +

            "&BBOX=" + status.getExtent().getMinX()+ "," +

                                    status.getExtent().getMinY()+ "," +

                                    status.getExtent().getMaxX()+ "," +

                                    status.getExtent().getMaxY() +

            "&WIDTH=" + status.getWidth() +

            "&HEIGHT=" + status.getHeight() + "&FORMAT=" + status.getFormat();

//        if (status.getTransparency()) {

//            req += "&TRANSPARENT=TRUE";

//        }

//

//        if (status.getBGColor() != null) {

//            req += ("&COLOR=" + status.getBGColor());

//        }

//

//        if (time != null) {

//            req += ("&TIME=" + time);

//        }

//

//        if (elevation != -1) {

//            req += ("&ELEVATION=" + elevation);

//        }

        return req.replaceAll(" ", "%20");

    }

    public void close() {        

        // your code here

    } 

    /**

     * Inner class that represents the description of the WMS metadata.

     * The first part of the capabilities will return the service information

     * from the WMS, this class will hold this information. 

     * 

     */

    public class ServiceInformation {

        public String online_resource;

        public String version;

        public String name;

        public String scope;

        public String title;

        public String abstr;

        public String keywords;

        public String fees;

        public String operationsInfo;

        public String personname;

        public String organization;

        public String function;

        public String addresstype;

        public String address;

        public String place;

        public String province;

        public String postcode;

        public String country;

        public String phone;

        public String fax;

        public String email;

        public Vector formats;

        public ServiceInformation()

        {

                online_resource = new String();

            version = new String();

            name = new String();

            scope = new String();

            title = new String();

            abstr = new String();

            keywords = new String();

            fees = new String();

            operationsInfo = new String();

            personname = new String();

            organization = new String();

            function = new String();

            addresstype = new String();

            address = new String();

            place = new String();

            province = new String();

            postcode = new String();

            country = new String();

            phone = new String();

            fax = new String();

            email = new String();

            formats = new Vector();               

        }

     }   

    /**

     * Downloads an URL into a temporary file that is removed the next time the 

     * tempFileManager class is called, which means the next time gvSIG is launched.

     * 

     * @param url

     * @param name

     * @return

     * @throws IOException

     * @throws ServerErrorResponseException

     * @throws ConnectException

     * @throws UnknownHostException

     */

    private File downloadFile(URL url, String name) throws IOException,ConnectException, UnknownHostException{

            File f = null;

            try{

                if ((f=Utilities.getPreviousDownloadedURL(url))==null){

                    f = TempFileManager.createTempFile(name, "tmp");

                    System.out.println("downloading '"+url.toString()+"' to: "+f.getAbsolutePath());

                    f.deleteOnExit();

                DataOutputStream dos = new DataOutputStream( new BufferedOutputStream(new FileOutputStream(f)));

                byte[] buffer = new byte[1024*256];

                InputStream is = url.openStream();

                long readed = 0;

                for (int i = is.read(buffer); i>0; i = is.read(buffer)){

                    dos.write(buffer, 0, i);

                    readed += i;

                }

                dos.close();

                Utilities.addDownloadedURL(url, f.getAbsolutePath());

                }

            } catch (IOException io) {

                    io.printStackTrace();

            }

            return f;

        }

 }