Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * 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.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2009 Iver T.I.  {{Task}}

 */

/**

 * This class sends a WMS request and returns the

 * reply in a local File. It tries if the server

 * supports both HTTP Get and Post requests.

 * @author Jorge Piera LLodr? (jorge.piera@iver.es)

 */

package org.gvsig.raster.wmts.ogc.impl.request;

import java.io.BufferedOutputStream;

import java.io.DataInputStream;

import java.io.DataOutputStream;

import java.io.File;

import java.io.FileOutputStream;

import java.io.IOException;

import java.net.ConnectException;

import java.net.HttpURLConnection;

import java.net.MalformedURLException;

import java.net.SocketTimeoutException;

import java.net.URL;

import java.net.UnknownHostException;

import java.security.KeyManagementException;

import java.security.NoSuchAlgorithmException;

import java.util.prefs.Preferences;

import javax.net.ssl.HttpsURLConnection;

import javax.net.ssl.SSLContext;

import javax.net.ssl.TrustManager;

import javax.net.ssl.X509TrustManager;

import org.gvsig.compat.CompatLocator;

import org.gvsig.compat.lang.StringUtils;

import org.gvsig.compat.net.ICancellable;

import org.gvsig.raster.wmts.ogc.impl.Tags;

import org.gvsig.raster.wmts.ogc.impl.Utilities;

import org.gvsig.raster.wmts.ogc.impl.base.WMTSProtocolHandler;

import org.gvsig.raster.wmts.ogc.impl.base.WMTSStatusImpl;

/**

 * Base class for a WMTS request

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

 */

public abstract class WMTSRequest {

        protected static final StringUtils stringUtils = CompatLocator.getStringUtils();

        protected WMTSStatusImpl status = null;

        protected WMTSProtocolHandler protocolHandler = null;

        protected boolean isDeleted = false;

        protected static final String XMLTAG_STARTCHARACTER = "<";

        protected static final String XMLTAG_FINISHCHARACTER = "</";

        protected static final String XMLTAG_ENDCHARACTER = ">";

        public WMTSRequest(WMTSStatusImpl status,

                        WMTSProtocolHandler protocolHandler) {

                this.status = status;

                this.protocolHandler = protocolHandler;

        }

        protected abstract String getHttpGetRequest(String onlineResource);

        protected abstract String getHttpPostRequest(String onlineResource);

        protected abstract String getTempFilePrefix();

        protected abstract String getOperationName();

        /**

         * @return the URL used in the HTTP get operation

         * @throws MalformedURLException

         */

        public URL getURL() throws MalformedURLException{

                String onlineResource = protocolHandler.getServiceInformation().getOnlineResource(getOperationName(), Tags.PROTOCOL_GET);

                if (onlineResource != null){

                        String symbol = getSymbol(onlineResource);

                        onlineResource = onlineResource + symbol;

                        return new URL(getHttpGetRequest(onlineResource));

                }

                //If the online resource doesn't exist, it tries with the server URL and GET

                onlineResource = protocolHandler.getHost();

                String symbol = getSymbol(onlineResource);

                onlineResource = onlineResource + symbol;

                return new URL(getHttpGetRequest(onlineResource));

        }

        protected String getSchemaLocation() {

                return null;

        }

        /**

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

     * @return String request

     */

        protected String getPartialQuery(WMTSStatusImpl status) {

        StringBuffer req = new StringBuffer();

        req.append("Layer=" + status.getLayer())

        .append("&Style=" + status.getStyle())

        .append("&Format=" + status.getFormat())

        .append("&TileMatrixSet=" + status.getTileMatrixSet())

        .append("&TileMatrix=" + status.getTileMatrix())

        .append("&TileRow=" + status. getTileRow())

        .append("&TileCol=" + status.getTileCol());

        return req.toString();

    }

        /**

         * Send a request to the server.

         * @return

         * The server reply

         * @throws IOException 

         * @throws UnknownHostException 

         * @throws ConnectException 

         */

        public void sendRequest(ICancellable cancel, File file) throws ConnectException, UnknownHostException, IOException {

                String onlineResource = protocolHandler.getHost();

                String symbol = getSymbol(onlineResource);

                onlineResource = onlineResource + symbol;

                URL url = new URL(stringUtils.replaceAll(getHttpGetRequest(onlineResource), " ", "%20"));

                //System.out.println(url.toString());

                downloadFile(url, file, cancel);        

                //downloadFile(new URL(protocolHandler.getHost()), getHttpGetRequest(onlineResource), file, cancel);        

        }

        /**

         * Send a request to the server.

         * @return

         * The server reply

         * @throws IOException 

         * @throws UnknownHostException 

         * @throws ConnectException 

         */

        public File sendRequest(ICancellable cancel) throws ConnectException, UnknownHostException, IOException{

                //if the status is null is because is a GetCapabilities operation

                if (status != null){

                        if (status.getProtocol() != Tags.PROTOCOL_UNDEFINED){

                                if (status.getProtocol() == Tags.PROTOCOL_GET){

                                        String onlineResource = protocolHandler.getHost();

                                        String symbol = getSymbol(onlineResource);

                                        onlineResource = onlineResource + symbol;

                                        return sendHttpGetRequest(onlineResource, cancel);

                                }else{

                                        String onlineResource = protocolHandler.getHost();

                                        return sendHttpPostRequest(onlineResource);

                                }

                        }

                }

                //if exists an online resource for the GET operation

                String onlineResource = protocolHandler.getServiceInformation().getOnlineResource(getOperationName(), Tags.PROTOCOL_GET);

                if (onlineResource != null){

                        String symbol = getSymbol(onlineResource);

                        onlineResource = onlineResource + symbol;

                        return sendHttpGetRequest(onlineResource, cancel);

                }

                //if exists an online resource for the POST operation

                onlineResource =  protocolHandler.getServiceInformation().getOnlineResource(getOperationName(), Tags.PROTOCOL_POST);

                if (onlineResource != null){

                        return sendHttpPostRequest(onlineResource);

                }

                //If the online resource doesn't exist, it tries with the server URL and GET

                onlineResource = protocolHandler.getHost();

                String symbol = getSymbol(onlineResource);

                onlineResource = onlineResource + symbol;

                return sendHttpGetRequest(onlineResource, cancel);

        }

        /**

         * Send a Http request using the get protocol

         * @param onlineResource

         * @return

         * @throws ConnectException

         * @throws UnknownHostException

         * @throws IOException

         */

        private File sendHttpGetRequest(String onlineResource, ICancellable cancel) throws ConnectException, UnknownHostException, IOException{

                URL url = new URL(stringUtils.replaceAll(getHttpGetRequest(onlineResource), " ", "%20"));

                if (isDeleted()){

                        Utilities.removeURL(url);

                }

                return Utilities.downloadFile(url, getTempFilePrefix(), cancel);                

        }

        /**

         * Send a Http request using the post protocol

         * @param onlineResource

         * @return

         * @throws ConnectException

         * @throws UnknownHostException

         * @throws IOException

         */

        private File sendHttpPostRequest(String onlineResource) throws ConnectException, UnknownHostException, IOException{

                URL url = new URL(onlineResource);

                String data = getHttpPostRequest(onlineResource);

                if (isDeleted()){

                        Utilities.removeURL(url+data);

                }

                return Utilities.downloadFile(url, data, getTempFilePrefix(), null);                

        }

        public void cancelDownload() {

                if(connection != null) {

                        connection.disconnect();

                        connection = null;        

                }

                if(is != null) {

                        try {

                                is.close();

                        } catch (IOException e) {

                        }

                }

                if(dos != null) {

                        try {

                                dos.close();

                        } catch (IOException e) {

                        }

                }

        }

        HttpURLConnection connection = null;

        DataOutputStream dos = null;

        DataInputStream is = null;

        public void downloadFile(URL url, File dstFile, ICancellable cancel) throws IOException {

                if(cancel != null && cancel.isCanceled())

                        throw new IOException();

                Preferences prefs = Preferences.userRoot().node( "gvsig.downloader" );

                // by default 1 minute (60000 milliseconds.

                int timeout = prefs.getInt("timeout", 20000);

                //If the used protocol is HTTPS

                if (url.getProtocol().equals("https")) {

                        try {

                                disableHttsValidation();

                        } catch (KeyManagementException e) {

                                throw new IOException();

                        } catch (NoSuchAlgorithmException e) {

                                throw new IOException();

                        }

                }

                try {

                        connection = (HttpURLConnection)url.openConnection();

                        connection.setConnectTimeout(timeout);

                        connection.setReadTimeout(timeout);

                        is = new DataInputStream(connection.getInputStream());

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

                        byte[] buffer = new byte[4096];

                        int i = -1;

                        if(cancel != null && cancel.isCanceled()) {

                                throw new IOException();

                        }

                        while((i = is.read(buffer)) > 0) {

                                if(cancel != null && cancel.isCanceled()) {

                                        throw new IOException();

                                }

                                dos.write(buffer, 0, i);

                        }

                } catch (SocketTimeoutException e) {

                        throw new IOException();

                } finally {

                        if(is != null)

                                is.close();

                        if(dos != null)

                                dos.close();

                        if(connection != null)

                                connection.disconnect();

                }

        }

        /**

         * This method disables the Https certificate validation.

         * @throws KeyManagementException

         * @throws NoSuchAlgorithmException

         */

        private void disableHttsValidation() throws KeyManagementException, NoSuchAlgorithmException{

                // Create a trust manager that does not validate certificate chains

                TrustManager[] trustAllCerts = new TrustManager[] {

                                new X509TrustManager() {

                                        public java.security.cert.X509Certificate[] getAcceptedIssuers() {

                                                return null;

                                        }

                                        public void checkClientTrusted(

                                                        java.security.cert.X509Certificate[] certs, String authType) {

                                        }

                                        public void checkServerTrusted(

                                                        java.security.cert.X509Certificate[] certs, String authType) {

                                        }

                                }

                };

                // Install the all-trusting trust manager

                SSLContext sc = SSLContext.getInstance("SSL");

                sc.init(null, trustAllCerts, new java.security.SecureRandom());

                HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());

        }

        /**

         * Just for not repeat code. Gets the correct separator according 

         * to the server URL

         * @param h

         * @return

         */

        protected static String getSymbol(String h) {

                String symbol;

                if (h.indexOf("?")==-1) 

                        symbol = "?";

                else if (h.indexOf("?")!=h.length()-1)

                        symbol = "&";

                else

                        symbol = "";

                return symbol;

        }

        public boolean isDeleted() {

                return isDeleted;

        }

        public void setDeleted(boolean isDeleted) {

                this.isDeleted = isDeleted;

        }

        protected String createXMLStartTag(String tagName){

            return XMLTAG_STARTCHARACTER + tagName + XMLTAG_ENDCHARACTER;

        }

   protected String createXMLEndtTag(String tagName){

        return XMLTAG_FINISHCHARACTER + tagName + XMLTAG_ENDCHARACTER;

    }

}