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.

* 

*/

package org.gvsig.raster.wmts.app.wmtsclient.gui.wizard;

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.io.FileOutputStream;

import java.io.IOException;

import java.net.MalformedURLException;

import java.net.URL;

import java.util.ArrayList;

import java.util.List;

import java.util.Properties;

import java.util.prefs.Preferences;

import javax.swing.JOptionPane;

import org.cresques.cts.IProjection;

import org.gvsig.andami.Launcher;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.PluginsLocator;

import org.gvsig.andami.persistence.serverData.ServerDataPersistence;

import org.gvsig.andami.ui.mdiManager.IWindow;

import org.gvsig.app.gui.WizardPanel;

import org.gvsig.app.gui.wizards.WizardListener;

import org.gvsig.app.gui.wizards.WizardListenerSupport;

import org.gvsig.app.project.documents.view.gui.AbstractViewPanel;

import org.gvsig.compat.net.ICancellable;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.DataParameters;

import org.gvsig.fmap.dal.DataStoreParameters;

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

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

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

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

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

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

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

import org.gvsig.gui.beans.Messages;

import org.gvsig.raster.util.CancelTaskImpl;

import org.gvsig.raster.wmts.app.wmtsclient.layer.FLyrWMTS;

import org.gvsig.raster.wmts.io.WMTSDataParameters;

import org.gvsig.raster.wmts.io.WMTSServerExplorer;

import org.gvsig.raster.wmts.io.WMTSServerExplorerParameters;

import org.gvsig.raster.wmts.ogc.struct.WMTSServiceIdentification;

import org.gvsig.raster.wmts.swing.AddServerPanel;

import org.gvsig.raster.wmts.swing.NextPrevPanel;

import org.gvsig.raster.wmts.swing.WMTSSwingLocator;

import org.gvsig.raster.wmts.swing.WMTSWizardListener;

import org.gvsig.raster.wmts.swing.WmtsGUI;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.utils.swing.jcomboServer.ServerData;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * The WMTS properties container panel.

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

 */

@SuppressWarnings({ "unused", "deprecation" })

public class WMTSWizard extends WizardPanel implements ActionListener {

        private static final long             serialVersionUID       = 1L;

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

        private String                        pluginName             = "org.gvsig.raster.wmts.app.wmtsclient";

        private File                          pluginPersistenceFile  = null;

        private File                          serverPropertiesFile   = null;

        private ServerDataPersistence         serverDataPersistence  = null;

        private String                        serversPropsFile       = "servers.properties";

        protected int                         page                   = 0;

        protected boolean                     connected              = false;

        private AddServerPanel                serverPanel            = null;

        private NextPrevPanel                 nextPrevPanel          = null;

        protected WmtsGUI                     wmtsParamsPanel        = null;

        private WMTSWizardListenerImpl        listenerSupport        = null;

        private static Preferences            fPrefs                 = Preferences.userRoot().node( "gvsig.wmts-wizard" );

        private boolean                       refreshing             = fPrefs.getBoolean("refresh_capabilities", false);

        protected int                         firstPage              = 0;

        private IProjection                   proj                   = null;

        private ICancellable                  cancel                 = null;

        private WMTSDataParameters            storeParams            = null;

        private WMTSServerExplorer            explorer               = null;

        public class WMTSWizardListenerImpl implements WMTSWizardListener {

                private WizardListenerSupport         gvsigWizardListener    = null;

                public WMTSWizardListenerImpl(WizardListenerSupport gvsigWizardListener) {

                          this.gvsigWizardListener = gvsigWizardListener;

                }

                public void callStateChanged(boolean finishable) {

                        this.gvsigWizardListener.callStateChanged(finishable);

                }

                public void callError(Exception descripcion) {

                        this.gvsigWizardListener.callError(descripcion);

                }

                public void addWizardListener(WizardListener listener) {

                        this.gvsigWizardListener.addWizardListener(listener);

                }

                public void removeWizardListener(WizardListener listener) {

                        this.gvsigWizardListener.removeWizardListener(listener);

                }

        }

        /**

         * This is the default constructor

         */

        public WMTSWizard() {

                super();

                firstPage = 0;

                page = firstPage;

                initialize();

                IWindow[] windows = PluginServices.getMDIManager().getAllWindows();

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

                        if(windows[i] instanceof AbstractViewPanel)

                                proj = ((AbstractViewPanel)windows[i]).getProjection();

                }

                cancel = new CancelTaskImpl();

        }

        /**

         * This method initializes this

         */

        private void initialize() {

                setTabName("WMTS");

                setLayout(new GridBagLayout());

                GridBagConstraints gridBagConstraints1 = new GridBagConstraints();

                gridBagConstraints1.fill = GridBagConstraints.BOTH;

                gridBagConstraints1.weightx = 1.0;

                gridBagConstraints1.weighty = 1.0;

                gridBagConstraints1.insets = new java.awt.Insets(2, 12, 10, 12);

                setVisible(true);

                add(getIserverPanel(), gridBagConstraints1);

                gridBagConstraints1.insets = new java.awt.Insets(2, 0, 10, 0);

                add(getPanelPage2(), gridBagConstraints1);

                gridBagConstraints1.fill = GridBagConstraints.HORIZONTAL;

                gridBagConstraints1.anchor = GridBagConstraints.EAST;

                gridBagConstraints1.weighty = 0;

                gridBagConstraints1.gridy = 1;

                add(getNextPrevPanel(), gridBagConstraints1);

                activarVisualizarBotones();

                getIserverPanel().getTxtHost().setServerList(getServerDataPersistence().getArrayOfServerData());

        }

        /**

         * This method checks for the options selected within the configuration

         * dialog are correct.

         *

         * @return true if you're done, false if not.

         */

        public boolean areSettingsValid() {

                return getPanelPage2().isCorrectlyConfigured();

        }

        private WMTSWizardListenerImpl getWizardListenerSupport() {

                if(listenerSupport == null)

                        listenerSupport = new WMTSWizardListenerImpl(new WizardListenerSupport());

                return listenerSupport;

        }

        /**

         * Thread to connect to a WMTS server

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

         */

        public class ConnectThread extends Thread {

                private ICancellable              cancel      = null;

                private WMTSServerExplorer        explorer    = null;

                private WMTSWizard                wizard      = null;

                public ConnectThread(ICancellable cancel, WMTSServerExplorer explorer, WMTSWizard wizard) {

                        this.cancel = cancel;

                        this.explorer = explorer;

                        this.wizard = wizard;

                }

            public void run() {

                    if(!checkHostAndNetwork())

                            return;

                    try {

                            explorer.connect(cancel);

                            saveServerListFromComboBox();

                        } catch (ConnectException e) {

                                getIserverPanel().setTextInfo("Connection closed... \n" + e.getMessage());

                                JOptionPane.showMessageDialog(null, Messages.getText("wmts_cant_connect"), Messages.getText("Error"), JOptionPane.ERROR_MESSAGE);

                                return;

                        } finally {

                                ((CancelTaskImpl)cancel).setCanceled(false);

                        }

                        DataStoreParameters parameters = explorer.getStoredParameters();

                        if(parameters instanceof WMTSDataParameters) {

                                storeParams = (WMTSDataParameters) parameters;

                        }

                        if(parameters instanceof TileDataParameters) {

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

                                if(p instanceof WMTSDataParameters)

                                        storeParams = (WMTSDataParameters) p;

                        }

                        wizard.rellenarControles();

            }

        }

        /**

         * Checks if the network and host are reachable

         * @return true if both are reachable and false if they are not

         */

        private boolean checkHostAndNetwork() {

                if(!explorer.isHostReachable()) {

                        JOptionPane.showMessageDialog(null, Messages.getText("host_unreachable"), Messages.getText("Error"), JOptionPane.ERROR_MESSAGE);

                        getIserverPanel().setTextInfo("Connection closed... \n");

                        return false;

                }

                return true;

        }

        /**

         * DOCUMENT ME!

         */

        private void rellenarControles() {

                try {

                        String host = getIserverPanel().getTxtHost().getModel().getSelectedItem().toString();

                        WMTSServiceIdentification id = explorer.getOGCClient().getServiceIdentification();

                        getIserverPanel().setTitle(id.getTitle());

                        getNextPrevPanel().getJLabelServerTypeValue().setText(id.getServiceType());

                        getIserverPanel().setTextInfo(id.getAbstract());

                        getPanelPage2().setWizardData(explorer);

                        connected = true;

                        activarVisualizarBotones();

                } catch (Exception e) {

                        if (e.getMessage() == null) {

                                getIserverPanel().setTextInfo(PluginServices.getText(this,"error"));

                        } else {

                                getIserverPanel().setTextInfo(e.getMessage());

                        }

                        getWizardListenerSupport().callError(e);

                        getNextPrevPanel().getBtnNext().setEnabled(false);

                        getNextPrevPanel().getBtnPrev().setEnabled(true);

                } finally {

                        getIserverPanel().getBtnCancel().setEnabled(false);

                }

        }

        public void actionPerformed(ActionEvent e) {

                if(e.getSource() == getIserverPanel().getBtnConnect()) {

                        getIserverPanel().getBtnCancel().setEnabled(true);

                        getIserverPanel().setTextInfo("Trying to connect...");

                        String host = getIserverPanel().getTxtHost().getModel().getSelectedItem().toString();

                        try {

                                DataManager datamanager = DALLocator.getDataManager();

                                WMTSServerExplorerParameters explorerParams = (WMTSServerExplorerParameters) datamanager.createServerExplorerParameters(WMTSServerExplorer.NAME);

                                explorerParams.setHost(host);

                                explorerParams.setLongitudeFirst(getIserverPanel().getChkInvertAxisOrder().isSelected());

                                explorer = (WMTSServerExplorer) datamanager.createServerExplorer(explorerParams);

                                ((CancelTaskImpl)cancel).setCanceled(false);

                                new ConnectThread(cancel, explorer, this).start();

                        } catch (InitializeException e1) {

                                getIserverPanel().setTextInfo("Error creating WMTS layer");

                        } catch (ProviderNotRegisteredException e1) {

                                getIserverPanel().setTextInfo("Provider not registered. I cannot connect.");

                        } catch (ValidateDataParametersException e1) {

                                getIserverPanel().setTextInfo("Parameters not valid. I cannot connect.");

                        }

                }

                if(e.getSource() == getIserverPanel().getBtnCancel()) {

                        getIserverPanel().setTextInfo("Cancelled...");

                        ((CancelTaskImpl)cancel).setCanceled(true);

                        getIserverPanel().getBtnCancel().setEnabled(false);

                }

                if(e.getSource() == getNextPrevPanel().getBtnPrev()) {

                        page --;

                        if (page > firstPage) {

                                getPanelPage2().setPreviousTab();

                                page = getPanelPage2().currentPage() + 1;

                                activarVisualizarBotones();

                        } else if (page == firstPage){

                                activarVisualizarBotones();

                                page = firstPage +1;

                                getIserverPanel().setTitle("-");

                                getIserverPanel().setTextInfo("");

                                getPanelPage2().setPreviousTab();

                                getIserverPanel().setVisible(true);

                                getPanelPage2().setVisible(false);

                                getNextPrevPanel().getBtnNext().setEnabled(false);

                                connected = false;

                        }

                        getWizardListenerSupport().callStateChanged(getPanelPage2().isCorrectlyConfigured());

                }

                if(e.getSource() == getNextPrevPanel().getBtnNext()) {

                        if (page > firstPage) {

                                // si page es mayor que cero, vamos enfocando las

                                // sucesivas SOLAPAS del WMTSParamsPanel

                                getPanelPage2().setNextTab();

                                page = getPanelPage2().currentPage();

                        }

                        page++;

                        getIserverPanel().setVisible(false);

                        getPanelPage2().setVisible(true);

                        activarVisualizarBotones();

                }

        }

        private AddServerPanel getIserverPanel() {

                if (serverPanel == null) {

                        serverPanel = WMTSSwingLocator.getSwingManager().createAddServerPanel();

                        serverPanel.getBtnCancel().addActionListener(this);

                        serverPanel.getBtnConnect().addActionListener(this);

                }

                return serverPanel;

        }        

        /**

         * This method initializes jPanel

         *

         * @return javax.swing.JPanel

         */

        public NextPrevPanel getNextPrevPanel() {

                if (nextPrevPanel == null) {

                        nextPrevPanel = WMTSSwingLocator.getSwingManager().createNextPrevPanel();

                        nextPrevPanel.getBtnNext().addActionListener(this);

                        nextPrevPanel.getBtnPrev().addActionListener(this);

                }

                return nextPrevPanel;

        }

        protected WmtsGUI getPanelPage2() {

                if (wmtsParamsPanel == null){

                        wmtsParamsPanel = WMTSSwingLocator.getSwingManager().createMainWizard(getWizardListenerSupport());

                        wmtsParamsPanel.addChangeTabListener(new java.awt.event.MouseAdapter() {

                                public void mouseClicked(java.awt.event.MouseEvent e) {

                                        page = wmtsParamsPanel.currentPage() + 1;

                                        activarVisualizarBotones();

                                }

                        });

                }

                return wmtsParamsPanel;

        }

        /**

         * DOCUMENT ME!

         */

        protected void activarVisualizarBotones() {

                if (page == firstPage) {

                        getNextPrevPanel().getBtnPrev().setEnabled(false);

                        getNextPrevPanel().getBtnPrev().setVisible(true);

                        if (connected) {

                                getNextPrevPanel().getBtnNext().setEnabled(true);

                        } else {

                                getNextPrevPanel().getBtnNext().setEnabled(false);

                        }

                } else if (page < getPanelPage2().getNumTabs()) {

                        getNextPrevPanel().getBtnNext().setEnabled(true);

                        getNextPrevPanel().getBtnNext().setVisible(true);

                        getNextPrevPanel().getBtnPrev().setEnabled(true);

                        getNextPrevPanel().getBtnPrev().setVisible(true);

                        if (getPanelPage2().nextEnabledPage()==-1) {

                                getNextPrevPanel().getBtnNext().setEnabled(false);

                        }

                        getWizardListenerSupport().callStateChanged(getPanelPage2().isCorrectlyConfigured());

                } else if (page == getPanelPage2().getNumTabs()) {

                        getNextPrevPanel().getBtnNext().setVisible(false);

                        getNextPrevPanel().getBtnNext().setEnabled(false);

                        getWizardListenerSupport().callStateChanged(getPanelPage2().isCorrectlyConfigured());

                }

        }

        /**

         * Gets the list of servers that have been persisted or added in the properties file

         * @return

         */

        private ServerDataPersistence getServerDataPersistence() {

                if(serverDataPersistence == null) {

                        PersistenceManager persistenceManager = ToolsLocator.getPersistenceManager();

                        //Lee los servidores de la persistencia

                        try {

                                FileInputStream is = new FileInputStream(getPluginPersistenceFile());

                                serverDataPersistence = (ServerDataPersistence) persistenceManager.getObject(is);

                        } catch (FileNotFoundException e) {

                                logger.info("Persistence file not found for WMS plugin", e);

                        }

                        if(serverDataPersistence == null)

                                serverDataPersistence = new ServerDataPersistence(ServerData.SERVER_TYPE_WMTS);

                        //Lee los servidores del properties y los mezcla con los que hay en la persistencia

                        Properties prop = new Properties();

                        try {

                                prop.load(new FileInputStream(getServerPropertiesFile()));

                        } catch (FileNotFoundException e) {

                                logger.info("Properties file not found for WMS plugin", e);

                        } catch (IOException e) {

                                logger.info("Error reading properties file", e);

                        }

                        boolean newProjectServers = false;

                        for (int i = 0; i < prop.size(); i++) {

                                Object value = prop.get("server[" + i + "]");

                                if(!serverDataPersistence.existsServer(value.toString())) {

                                        serverDataPersistence.addServerData(new ServerData(value.toString(), ServerData.SERVER_TYPE_WMTS));

                                        newProjectServers = true;

                                }

                        }

                        //Si hay servidores nuevos los persiste

                        if(newProjectServers) {

                                try {

                                        FileOutputStream os = new FileOutputStream(getPluginPersistenceFile());

                                        persistenceManager.putObject(os, serverDataPersistence);

                                } catch (FileNotFoundException e) {

                                        logger.info("Persistence file not found for WMS plugin", e);

                                }

                        }

                }

                return serverDataPersistence;

        }

        /**

         * Saves the list of server reading from the <code>ComboBox</code>

         */

        private void saveServerListFromComboBox() {

                PersistenceManager persistenceManager = ToolsLocator.getPersistenceManager();

                ServerDataPersistence persistence = new ServerDataPersistence(ServerData.SERVER_TYPE_WMTS);

                String urlSelected = getIserverPanel().getTxtHost().getModel().getSelectedItem().toString();

                boolean isSelectedInModel = false;

                for (int i = 0; i < getIserverPanel().getTxtHost().getItemCount(); i++) {

                        String url = getIserverPanel().getTxtHost().getItemAt(i).toString();

                        persistence.addServerData(new ServerData(url, ServerData.SERVER_TYPE_WMTS));

                        if(url.equals(urlSelected))

                                isSelectedInModel = true;

                }

                if(!isSelectedInModel)

                        persistence.addServerData(new ServerData(urlSelected, ServerData.SERVER_TYPE_WMTS));

                if(getServerDataPersistence().compareTo(persistence) != 0) {

                        try {

                                FileOutputStream os = new FileOutputStream(getPluginPersistenceFile());

                                persistenceManager.putObject(os, persistence);

                        } catch (FileNotFoundException e) {

                                logger.info("Persistence file not found for WMS plugin", e);

                        }

                }

        }

        /**

         * Gets the persistence file of this plugin

         * @return

         */

        private File getPluginPersistenceFile() {

                if(pluginPersistenceFile == null) {

                        File persistenceFolder = new File(Launcher.getAppHomeDir()

                                        + File.separator + "plugins" + File.separator + pluginName);

                        if (!persistenceFolder.exists()) {

                                persistenceFolder.mkdirs();

                        }

                        pluginPersistenceFile = new File(persistenceFolder.getAbsolutePath() + 

                                File.separator + 

                                "plugin-persistence.dat");

                }

                return pluginPersistenceFile;

        }

        /**

         * Gets the file which contains the default list of servers

         * @return

         */

        private File getServerPropertiesFile() {

                if(serverPropertiesFile == null) {

                        File pluginFolder = PluginsLocator.getManager().getPluginsFolder();

                        serverPropertiesFile = new File(pluginFolder.getAbsolutePath() + 

                                        File.separator + 

                                        pluginName + 

                                        File.separator + 

                                        serversPropsFile);

                }

                return serverPropertiesFile;

        }

        /**

         * DOCUMENT ME!

         * @param listener

         */

        public void addWizardListener(WizardListener listener) {

                getWizardListenerSupport().addWizardListener(listener);

                getWizardListenerSupport().callStateChanged(false);

        }

        /**

         * DOCUMENT ME!

         * @param listener

         */

        public void removeWizardListener(WizardListener listener) {

                getWizardListenerSupport().removeWizardListener(listener);

        }

        /**

         * Devuelve el host que est� escrito en el cuadro de texto del host o null

         * en caso de que no haya nada escrito o est� mal escrito

         *

         * @return URL del host

         */

        public URL getHost() {

                try {

                        if ((getIserverPanel().getTxtHost() == null)|| (getIserverPanel().getTxtHost().getModel().getSelectedItem() == null)) {

                                return new URL(explorer.getHost());

                        } else {

                                return new URL(getIserverPanel().getTxtHost().getModel().getSelectedItem().toString());

                        }

                } catch (MalformedURLException e) {

                        return null;

                }

        }

        public void initWizard() {

        }

        @Override

        public DataStoreParameters[] getParameters() {

                return null;

        }

        @Override

        public void close() {

        }

        @Override

        public void execute() {

                try {

                        getPanelPage2().setDeleteCache(getIserverPanel().getChkCaching().isSelected());

                        RasterDataParameters[] paramsList = getPanelPage2().getDataParameters();

                        List<FLyrWMTS> lyrList = getLayerList(paramsList);

                        for (int i = 0; i < lyrList.size(); i++) {

                                getMapCtrl().getMapContext().getLayers().addLayer(lyrList.get(i));        

                        }

                } catch (LoadLayerException e) {

                        logger.info("Persistence file not found for WMS plugin", e);

                }

        }

        public List<FLyrWMTS> getLayerList(RasterDataParameters[] paramsList) throws LoadLayerException {

                List<FLyrWMTS> layerList = new ArrayList<FLyrWMTS>();

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

                        FLyrWMTS layer = new FLyrWMTS();

                        layer.deleteCache(getPanelPage2().getDeleteCache());

                        try {

                                layer.setParameters(paramsList[i]);

                                String title = null;

                                if(paramsList[i] instanceof WMTSDataParameters) {

                                        title = ((WMTSDataParameters) paramsList[i]).getLayer().getTitle();

                                } else if(paramsList[i] instanceof TileDataParameters) {

                                        DataParameters p = ((TileDataParameters) paramsList[i]).getDataParameters();

                                        if(p instanceof WMTSDataParameters)

                                                title = ((WMTSDataParameters) p).getLayer().getTitle();

                                }

                                layer.setName(title);

                                layer.setExplorer(explorer);

                                //Ojo! Pruebas!

                                //layer.setTileServer(FileTileServer.class);

                                layerList.add(layer);

                        } catch (InitializeException e) {

                                throw new LoadLayerException("Error initializating layer", e);

                        }

                }

                return layerList;

        }

}