/* uDig - User Friendly Desktop Internet GIS client
* http://udig.refractions.net
* (C) 2008-2013, Refractions Research Inc.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* (http://www.eclipse.org/legal/epl-v10.html), and the Refractions BSD
* License v1.0 (http://udig.refractions.net/files/bsd3-v10.html).
*/
package org.locationtech.udig.catalog.internal.wmsc.ui;
import java.io.Serializable;
import java.net.ConnectException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.locationtech.udig.catalog.IService;
import org.locationtech.udig.catalog.internal.wms.WmsPlugin;
import org.locationtech.udig.catalog.internal.wmsc.WMSCServiceExtension;
import org.locationtech.udig.catalog.internal.wmsc.WMSCServiceImpl;
import org.locationtech.udig.catalog.ui.AbstractUDIGImportPage;
import org.locationtech.udig.catalog.ui.UDIGConnectionPage;
import org.locationtech.udig.catalog.ui.workflow.EndConnectionState;
import org.locationtech.udig.catalog.wms.internal.Messages;
import org.locationtech.udig.core.RecentHistory;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.wizard.WizardPage;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.ui.PlatformUI;
/**
* WMS-C connection wizard.
*
* @author Emily Gouge (Refractions Research, Inc.)
* @since 1.1.0
*/
public class WMSCWizardPage extends AbstractUDIGImportPage implements ModifyListener, UDIGConnectionPage {
private static final String ID = "org.locationtech.udig.catalog.ui.WMSC"; //$NON-NLS-1$
private String url = new String();
private static final String WMSC_WIZARD = "WMSC_WIZARD"; //$NON-NLS-1$
private static final String WMSC_RECENT = "WMSC_RECENT"; //$NON-NLS-1$
private IDialogSettings settings;
private Combo urlCombo;
/**
* Construct <code>WMSWizardPage</code>.
*
* @param pageName
*/
public WMSCWizardPage() {
super(Messages.WMSCWizardPage_WMSCTitle);
settings = WmsPlugin.getDefault().getDialogSettings().getSection(WMSC_WIZARD);
if (settings == null) {
settings = WmsPlugin.getDefault().getDialogSettings().addNewSection(WMSC_WIZARD);
}
}
public String getId() {
return ID;
}
/** Can be called during createControl */
protected Map<String,Serializable> defaultParams(){
IStructuredSelection selection = (IStructuredSelection)PlatformUI
.getWorkbench() .getActiveWorkbenchWindow().getSelectionService()
.getSelection();
Map<String, Serializable> toParams = toParams( selection );
if( !toParams.isEmpty() ){
return toParams;
}
WMSCConnectionFactory connectionFactory = new WMSCConnectionFactory();
Map<String, Serializable> params = connectionFactory.createConnectionParameters( getState().getWorkflow().getContext() );
if( params !=null )
return params;
return Collections.emptyMap();
}
/** Retrieve "best" WMSC guess of parameters based on provided context */
protected Map<String,Serializable> toParams( IStructuredSelection context){
if( context != null ) {
WMSCConnectionFactory connectionFactory = new WMSCConnectionFactory();
for( Iterator<IStructuredSelection> itr = context.iterator(); itr.hasNext(); ) {
Map<String,Serializable> params = connectionFactory
.createConnectionParameters(itr.next());
if( !params.isEmpty() ) return params;
}
}
return Collections.emptyMap();
}
public void createControl( Composite parent ) {
String[] recentWMSs = settings.getArray(WMSC_RECENT);
if (recentWMSs == null) {
recentWMSs = new String[0];
}
GridData gridData;
Composite composite = new Composite(parent, SWT.NULL);
GridLayout gridLayout = new GridLayout();
int columns = 1;
gridLayout.numColumns = columns;
composite.setLayout(gridLayout);
gridData = new GridData();
Label urlLabel = new Label(composite, SWT.NONE);
urlLabel.setText(Messages.WMSWizardPage_label_url_text);
urlLabel.setLayoutData(gridData);
gridData = new GridData(GridData.FILL_HORIZONTAL);
gridData.widthHint = 400;
// For Drag 'n Drop as well as for general selections
// look for a url as part of the selection
Map<String,Serializable> params = defaultParams(); // based on selection
urlCombo = new Combo(composite, SWT.BORDER);
urlCombo.setItems(recentWMSs);
urlCombo.setVisibleItemCount(15);
urlCombo.setLayoutData(gridData);
URL selectedURL = getURL( params );
if (selectedURL != null) {
urlCombo.setText( selectedURL.toExternalForm() );
url = selectedURL.toExternalForm();
setPageComplete(true);
} else if (url != null && url.length() != 0) {
urlCombo.setText(url);
setPageComplete(true);
} else {
url = null;
urlCombo.setText("http://"); //$NON-NLS-1$
setPageComplete(false);
}
urlCombo.addModifyListener(this);
setControl(composite);
Display.getCurrent().asyncExec(new Runnable() {
public void run() {
EndConnectionState currentState = getState();
Map<IService, Throwable> errors = currentState.getErrors();
if( errors!=null && !errors.isEmpty()){
for (Map.Entry<IService, Throwable> entry : errors.entrySet()) {
if( entry.getKey() instanceof WMSCServiceImpl ){
Throwable value = entry.getValue();
if( value instanceof ConnectException){
setErrorMessage(Messages.WMSWizardPage_serverConnectionError);
}else{
String message = Messages.WMSWizardPage_connectionProblem+value.getLocalizedMessage();
setErrorMessage(message);
}
}
}
}
}
});
}
/**
* Double click in list, or return from url control.
*
* @see org.eclipse.swt.events.SelectionListener#widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent)
* @param e
*/
public void widgetDefaultSelected( SelectionEvent e ) {
// e.getClass();// kill warning
if (getWizard().canFinish()) {
getWizard().performFinish();
}
}
public List<URL> getURLs() {
try {
ArrayList<URL> l = new ArrayList<URL>();
l.add(new URL(url));
return l;
}
catch(MalformedURLException e) {
return null;
}
}
@Override
public void setErrorMessage(String newMessage) {
WizardPage page=(WizardPage) getContainer().getCurrentPage();
page.setErrorMessage(newMessage);
}
@Override
public void setMessage(String newMessage) {
WizardPage page=(WizardPage) getContainer().getCurrentPage();
page.setMessage(newMessage);
}
@Override
public void setMessage(String newMessage, int messageType) {
WizardPage page=(WizardPage) getContainer().getCurrentPage();
page.setMessage(newMessage, messageType);
}
public EndConnectionState getState() {
return (EndConnectionState) super.getState();
}
public URL getURL( Map<String,Serializable> params ){
Object value = params.get( WMSCServiceImpl.WMSC_URL_KEY );
if( value == null ) return null;
if( value instanceof URL ) return (URL) value;
if( value instanceof String) {
try {
URL url = new URL( (String) value );
return url;
}
catch( MalformedURLException erp ){
}
}
return null;
}
@Override
public Collection<URL> getResourceIDs(){
Collection<URL> ids = super.getResourceIDs();
return ids;
}
/**
* This should be called using the Wizard .. job when next/finish is pressed.
*/
public List<IService> getResources( IProgressMonitor monitor ) throws Exception {
URL location = new URL(url);
WMSCServiceExtension creator = new WMSCServiceExtension();
Map<String, Serializable> params = creator.createParams(location);
IService service = creator.createService(location, params);
service.getInfo(monitor); // load it
List<IService> servers = new ArrayList<IService>();
servers.add(service);
/*
* Success! Store the URL in history.
*/
saveWidgetValues();
return servers;
}
public void modifyText( ModifyEvent e ) {
try {
getState().getErrors().clear();
url = ((Combo) e.getSource()).getText();
new URL(url);
setErrorMessage(null);
setPageComplete(true);
} catch (MalformedURLException exception) {
setErrorMessage(Messages.WMSWizardPage_error_invalidURL);
setPageComplete(false);
}
getWizard().getContainer().updateButtons();
}
/**
* Saves the widget values
*/
private void saveWidgetValues() {
// Update history
if (settings != null) {
RecentHistory<String> recent =
new RecentHistory<String>( settings.getArray(WMSC_RECENT) );
recent.add( url);
settings.put(WMSC_RECENT, recent.toArray(new String[recent.size()]));
}
}
@Override
public Map<String, Serializable> getParams() {
try {
URL location = new URL(url);
WMSCServiceExtension creator = new WMSCServiceExtension();
String errorMessage=creator.reasonForFailure(location);
if( errorMessage!=null ){
setErrorMessage(errorMessage);
return Collections.emptyMap();
}else
return creator.createParams(location);
}
catch(MalformedURLException e) {
return null;
}
}
}