/* **********************************************************************
 * $Source: /net/bitburg/u4/distapps/rcs/openmap/com/bbn/openmap/plugin/wms/WMSPlugIn.java,v $
 * $Revision: 1.1.2.1 $ * $Date: 2001/07/11 22:53:00 $ * $Author: dietrick $
 *
 * Code provided by Raj Singh from Syncline, rs@syncline.com
 * *********************************************************************
 */

package com.bbn.openmap.plugin.wms;

import java.awt.Component;
import java.util.Properties;
import java.util.StringTokenizer;
import java.util.NoSuchElementException;
import javax.swing.ImageIcon;

import com.bbn.openmap.PropertyConsumer;
import com.bbn.openmap.event.MapMouseListener;
import com.bbn.openmap.image.ImageServerConstants;
import com.bbn.openmap.image.WMTConstants;
import com.bbn.openmap.omGraphics.*;
import com.bbn.openmap.plugin.*;
import com.bbn.openmap.proj.Projection;
import com.bbn.openmap.util.Debug;

/**
 * This class asks for an image from an OpenGIS compliant Web Map
 * Server (WMS). Make sure that OpenMap is using the LLXY projection,
 * because this plugin is only asking for images that are in the
 * Spatial Reference System EPS 4326 projection, and anything else
 * won't match up.  This class will be growing to be more interactive
 * with the WMS.
 *
 * It has some properties that you can set in the openmap.properties file:
 * <pre>
 * #For the plugin layer
 * pluginlayer.class=com.bbn.openmap.plugin.PlugInLayer
 * pluginlayer.prettyName=Whatever
 * pluginlayer.plugin=com.bbn.openmap.plugin.wms.WMSPlugIn
 * pluginlayer.plugin.wmsserver=A URL for the WMS server (eg. http://host.domain.name/servlet/com.esri.wms.Esrimap)
 * pluginlayer.plugin.wmsversion=OpenGIS WMS version number (eg. 1.0.7)
 * pluginlayer.plugin.format=image format (eg. JPEG, GIF, PNG from WMTConstants.java)
 * pluginlayer.plugin.transparent=true or false, depends on imageformat
 * pluginlayer.plugin.backgroundcolor=RGB hex string (RRGGBB)
 * pluginlayer.plugin.layers=comma separated list of map layer names (eg. SDE.SASAUS_BND_COASTL,SDE.SASAUS_BND_POLBNDL)
 * pluginlayer.plugin.styles=comma separated list of layer rendering styles corresponding to the layers listed
 * pluginlayer.plugin.vendorspecificnames=comma separated list of vendor specific parameter names in order (eg. SERVICENAME)
 * pluginlayer.plugin.vendorspecificvalues=comma separated list of vendor specific parameter values in order (eg. default)
 * pluginlayer.plugin.wmsname=???
 * </pre>
 */
public class WMSPlugIn extends AbstractPlugIn implements ImageServerConstants {

    /** URL to the server script that responds to WMS map requests */
    protected String wmsName = null;
    /** URL to the server script that responds to WMS map requests */
    protected String wmsServer = null;
    /** GIF, PNG, JPEG, etc. (anything the server supports) */
    protected String imageFormat = null;
    /** Specify the color for non-data areas of the image in r,g,b */
    protected String backgroundColor = null;
    /** true=make the backgroundColor transparent */
    protected String transparent = null;
    /** version of the Web map server spec the server supports */
    protected String wmsVersion = null;
    /** Comma-separated list of layer names */
    protected String layers = null;
    /** Comma-separated list of style names */
    protected String styles = null;
    /** Comma-separated list of vendor specific parameter names */
    protected String vendorSpecificNames = null;
    /** Comma-separated list of vendor specific parameter values */
    protected String vendorSpecificValues = null;
    /** Same as wmsServer */
    protected String queryHeader = null;

    protected String MAPREQUESTNAME = GETMAP;

    public final static String WMSNameProperty = "wmsname";
    public final static String WMSServerProperty = "wmsserver";
    public final static String ImageFormatProperty = "format";
    public final static String BackgroundColorProperty = "backgroundcolor";
    public final static String TransparentProperty = "transparent";
    public static final String WMSVersionProperty = "wmsversion";
    public static final String LayersProperty = "layers";
    public static final String StylesProperty = "styles";
    public static final String VendorSpecificNamesProperty = "vendorspecificnames";
    public static final String VendorSpecificValuesProperty = "vendorspecificvalues";

    /**
     * Add new layers to the server request, using the default style.
     */
    public void addLayers(String[] ls) {
        for (int j=0; j<ls.length; j++) {
            layers += ","+ls[j];
            styles += ",default";
        }
    }

    /**
     * The getRectangle call is the main call into the PlugIn module.
     * The module is expected to fill the graphics list with objects
     * that are within the screen parameters passed.
     *
     * @param p projection of the screen, holding scale, center
     * coords, height, width.
     */
    public OMGraphicList getRectangle(Projection p) {
        OMGraphicList list = new OMGraphicList();

        if (queryHeader == null) {
            return list;
        }

        String bbox = Float.toString(p.getUpperLeft().getLongitude()) + "," +
            Float.toString(p.getLowerRight().getLatitude()) + "," +
            Float.toString(p.getLowerRight().getLongitude()) + "," +
            Float.toString(p.getUpperLeft().getLatitude());

        StringBuffer buf = new StringBuffer(queryHeader);
        buf.append("?" + "VERSION" + "=" + wmsVersion +
                   "&" + WMTConstants.REQUEST + "=" + MAPREQUESTNAME +
                   "&" + WMTConstants.SRS + "=" + "EPSG:4326" +
                   "&" + WMTConstants.BBOX + "=" + bbox +
                   "&" + WMTConstants.HEIGHT + "=" + p.getHeight() +
                   "&" + WMTConstants.WIDTH + "=" + p.getWidth() +
                   "&" + WMTConstants.EXCEPTIONS + "=" + "INIMAGE");

        if (imageFormat != null) {
            buf.append("&" + FORMAT + "=" + imageFormat);
            if (imageFormat.equals(WMTConstants.IMAGEFORMAT_JPEG)) {
                buf.append("&quality=MEDIUM");
            }
        }

        if (transparent != null) {
            buf.append("&" + TRANSPARENT + "=" + transparent);
        }

        if (backgroundColor != null) {
            buf.append("&" + BGCOLOR + "=" + backgroundColor);
        }

        if (layers != null) {
            buf.append("&" + LAYERS + "=" + layers);
        }

        if (styles != null) {
            buf.append("&" + STYLES + "=" + styles);
        }

        /**
         * Included to allow for one or more vendor specific parameters to be
         * specified such as ESRI's ArcIMS's "ServiceName" parameter.
         */
        if (vendorSpecificNames != null) {
            if (vendorSpecificValues != null) {
                StringTokenizer nameTokenizer = new StringTokenizer(vendorSpecificNames, ",");
                StringTokenizer valueTokenizer = new StringTokenizer(vendorSpecificValues, ",");
                String paramName = null;
                String paramValue = null;
                while (nameTokenizer.hasMoreTokens()) {
                    try {
                        paramName = nameTokenizer.nextToken();
                        paramValue = valueTokenizer.nextToken();
                        buf.append("&" + paramName +  "=" + paramValue);
                    } catch (NoSuchElementException e) {
                        if (Debug.debugging("plugin")) {
                            Debug.output("WMSPlugIn.getRectangle(): " +
                                "parameter \"" + paramName + "\" has no value");
                        }
                    }
                }
            }
        }

        String urlString = buf.toString();

        if (Debug.debugging("plugin")) {
            Debug.output("WMSPlugIn.getRectangle() with \"" + urlString + "\"");
        }

        java.net.URL url = null;

        try {
            url = new java.net.URL(urlString);
            java.net.HttpURLConnection urlc =
            (java.net.HttpURLConnection)url.openConnection();

            if (Debug.debugging("plugin")) {
                System.out.println("url content type: "+ urlc.getContentType());
            }

            // text
            if ( urlc.getContentType().startsWith("text")) {
                java.io.BufferedReader bin = new java.io.BufferedReader(
                    new java.io.InputStreamReader(urlc.getInputStream())
                );
                String st;
                String message = "";
                while ((st=bin.readLine()) != null) {
                    message += st;
                }
                Debug.error(message);
            // image
            } else if ( urlc.getContentType().startsWith("image")) {
                urlc.disconnect();
                ImageIcon ii = new ImageIcon(url);
                OMRaster image = new OMRaster((int)0, (int)0, ii);
                list.add(image);
            } // end if image
        } catch (java.net.MalformedURLException murle) {
            Debug.error("WMSPlugIn: URL \"" + urlString +
                "\" is malformed.");
        } catch (java.io.IOException ioe) {
            Debug.error("Couldn't connect to "+queryHeader);
        }

        list.generate(p);
        return list;
    } //end getRectangle

    /**
     * Method to set the properties in the PropertyConsumer. The
     * prefix is a string that should be prepended to each property
     * key (in addition to a separating '.') in order for the
     * PropertyConsumer to uniquely identify properies meant for it, in
     * the midst of Properties meant for several objects.
     *
     * @param prefix a String used by the PropertyConsumer to prepend
     * to each property value it wants to look up -
     * setList.getProperty(prefix.propertyKey). If the prefix had
     * already been set, then the prefix passed in should replace that
     * previous value.
     *
     * @param setList a Properties object that the PropertyConsumer
     * can use to retrieve expected properties it can use for
     * configuration.
     */
    public void setProperties(String prefix, Properties setList) {
        this.prefix = prefix;

        String realPrefix = (prefix == null?"":prefix + ".");

        wmsName = setList.getProperty(realPrefix + WMSNameProperty);
        if (wmsName == null) {
            wmsName = "wmsName";
        }

        wmsServer = setList.getProperty(realPrefix + WMSServerProperty);
        if (wmsServer == null) {
            Debug.error("WMSPlugIn needs a WMS server.");
        }

        queryHeader = wmsServer;

        imageFormat = setList.getProperty(realPrefix + ImageFormatProperty);

        transparent = setList.getProperty(realPrefix + TransparentProperty);

        backgroundColor = setList.getProperty(realPrefix + BackgroundColorProperty);

        wmsVersion = setList.getProperty(realPrefix + WMSVersionProperty);
        if (wmsVersion == null) {
            wmsVersion = "1.0.7";
            Debug.output("WMSPlugin: wmsVersion is null");
        }

        if (Debug.debugging("plugin")) {
            Debug.output("WMSPlugIn: set up with header \"" + queryHeader + "\"");
        }

        int version = Integer.parseInt(wmsVersion.substring(4));
        if ( version < 3 ) {
            MAPREQUESTNAME = WMTConstants.MAP;
        }

        layers = setList.getProperty(realPrefix + LayersProperty);
        styles = setList.getProperty(realPrefix + StylesProperty);

        /**
         * Include for vendor specific parameters
         */
        vendorSpecificNames = setList.getProperty(realPrefix + VendorSpecificNamesProperty);
        vendorSpecificValues = setList.getProperty(realPrefix + VendorSpecificValuesProperty);

    } //end setProperties

    public String getImageFormat() {
        return imageFormat;
    }

    public void setImageFormat(String imgfmt) {
        if (imgfmt.equals(WMTConstants.IMAGEFORMAT_GIF) ||
            imgfmt.equals(WMTConstants.IMAGEFORMAT_JPEG) ||
            imgfmt.equals(WMTConstants.IMAGEFORMAT_PNG)) {
            imageFormat = imgfmt;
        }
    }

    // make this better!!
    public String getServerName() {
        return wmsServer;
    }

    public String getPrettyName() {
        return wmsName;
    }

    public String getName() {
        return wmsName;
    }

    public WMSPlugIn() {}

//      public WMSPlugIn(Component comp) {
//          super(comp);
//      }

    public java.awt.Component getGUI() {
        return null;
    }

    public String getLayerMarkers() {
        return null;
    }

} //end WMSPlugin