001 //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/branches/2.4_testing/src/org/deegree/portal/standard/wms/control/AddLayerListener.java $
002 /*----------------------------------------------------------------------------
003 This file is part of deegree, http://deegree.org/
004 Copyright (C) 2001-2009 by:
005 - Department of Geography, University of Bonn -
006 and
007 - lat/lon GmbH -
008
009 This library is free software; you can redistribute it and/or modify it under
010 the terms of the GNU Lesser General Public License as published by the Free
011 Software Foundation; either version 2.1 of the License, or (at your option)
012 any later version.
013 This library is distributed in the hope that it will be useful, but WITHOUT
014 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016 details.
017 You should have received a copy of the GNU Lesser General Public License
018 along with this library; if not, write to the Free Software Foundation, Inc.,
019 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020
021 Contact information:
022
023 lat/lon GmbH
024 Aennchenstr. 19, 53177 Bonn
025 Germany
026 http://lat-lon.de/
027
028 Department of Geography, University of Bonn
029 Prof. Dr. Klaus Greve
030 Postfach 1147, 53001 Bonn
031 Germany
032 http://www.geographie.uni-bonn.de/deegree/
033
034 e-mail: info@deegree.org
035 ----------------------------------------------------------------------------*/
036 package org.deegree.portal.standard.wms.control;
037
038 import java.io.IOException;
039 import java.io.InputStream;
040 import java.net.URL;
041 import java.util.ArrayList;
042 import java.util.Collections;
043 import java.util.List;
044 import java.util.Map;
045 import java.util.UUID;
046
047 import org.deegree.enterprise.control.ajax.AbstractListener;
048 import org.deegree.enterprise.control.ajax.ResponseHandler;
049 import org.deegree.enterprise.control.ajax.WebEvent;
050 import org.deegree.framework.log.ILogger;
051 import org.deegree.framework.log.LoggerFactory;
052 import org.deegree.framework.util.HttpUtils;
053 import org.deegree.framework.util.StringTools;
054 import org.deegree.framework.xml.XMLFragment;
055 import org.deegree.ogcbase.BaseURL;
056 import org.deegree.ogcbase.ImageURL;
057 import org.deegree.ogcwebservices.getcapabilities.MetadataURL;
058 import org.deegree.ogcwebservices.wms.capabilities.LegendURL;
059 import org.deegree.ogcwebservices.wms.capabilities.WMSCapabilities;
060 import org.deegree.ogcwebservices.wms.capabilities.WMSCapabilitiesDocument;
061 import org.deegree.ogcwebservices.wms.capabilities.WMSCapabilitiesDocumentFactory;
062 import org.deegree.portal.Constants;
063 import org.deegree.portal.context.Format;
064 import org.deegree.portal.context.FormatList;
065 import org.deegree.portal.context.Layer;
066 import org.deegree.portal.context.LayerExtension;
067 import org.deegree.portal.context.LayerGroup;
068 import org.deegree.portal.context.LayerList;
069 import org.deegree.portal.context.MMLayer;
070 import org.deegree.portal.context.MapModel;
071 import org.deegree.portal.context.Server;
072 import org.deegree.portal.context.Style;
073 import org.deegree.portal.context.StyleList;
074 import org.deegree.portal.context.ViewContext;
075
076 /**
077 * TODO add class documentation here
078 *
079 * @author <a href="mailto:name@deegree.org">Andreas Poth</a>
080 * @author last edited by: $Author: jmays $
081 *
082 * @version $Revision: 25795 $, $Date: 2010-08-10 12:00:31 +0200 (Di, 10. Aug 2010) $
083 */
084 public class AddLayerListener extends AbstractListener {
085
086 private static final ILogger LOG = LoggerFactory.getLogger( AddLayerListener.class );
087
088 /**
089 * structure of incoming data:
090 * <p>
091 * {action=addLayer, layerGroup={bgColor=0xFFFFFF, transparency=true, id=deegree wms,
092 * serviceURL=http:*demo.deegree.org/deegree-wms/services, format=image/gif, serviceType=OGC:WMS 1.1.1,
093 * serviceName=deegree wms, layers=[{dsResource=null, visible=false, wmsName=deegree wms,dsGeomType=null,
094 * changed=true, styleName=default, title=Energy Resources, selected=false, metadataURL=, minScale=0.0,
095 * name=EnergyResources, legendURL=null, dsFeatureType=null, maxScale=1000000.0, sldRef=null, queryable=true},
096 * {dsResource=null, visible=false, wmsName=deegree wms, dsGeomType=null, changed=true, styleName=default,
097 * title=Airports of Utah, selected=false, metadataURL=, minScale=0.0, name=Airports, legendURL=null,
098 * dsFeatureType=null, maxScale=1000000.0, sldRef=null, queryable=true}]} }
099 * </p>
100 */
101 @SuppressWarnings("unchecked")
102 public void actionPerformed( WebEvent event, ResponseHandler responseHandler )
103 throws IOException {
104 ViewContext vc = (ViewContext) event.getSession().getAttribute( Constants.CURRENTMAPCONTEXT );
105 LayerList layerList = vc.getLayerList();
106 MapModel mapModel = vc.getGeneral().getExtension().getMapModel();
107 List<String> ids = new ArrayList<String>();
108 try {
109 Map<String, Object> parameter = event.getParameter();
110 Map<String, Object> layerGroup = (Map<String, Object>) parameter.get( "layerGroup" );
111 String[] srs = new String[] { (String) parameter.get( "srs" ) };
112 String wmsName = (String) layerGroup.get( "id" );
113 String serviceType = (String) layerGroup.get( "serviceType" );
114 String[] service = StringTools.toArray( serviceType, " ", false );
115 String format = (String) layerGroup.get( "format" );
116 Format frmt = new Format( format, true );
117 FormatList formatList = new FormatList( new Format[] { frmt } );
118 List<?> layers = (List<?>) layerGroup.get( "layers" );
119 Collections.reverse( layers );
120 // read capabilities from WMS where new layers are defined and create Server instance
121 // which is the same for all new layers
122 String serviceURL = (String) layerGroup.get( "serviceURL" );
123 String sessionID = (String) event.getSession().getAttribute( "SESSIONID" );
124 WMSCapabilities capabilities = readCapabilities( serviceURL, service[1], sessionID );
125 Server server = new Server( wmsName, service[1], service[0], new URL( serviceURL ), capabilities );
126 LayerGroup lg = null;
127 if ( mapModel != null && (Boolean) parameter.get( "createLayerGroup" ) ) {
128 // add a new group for added layers
129 lg = addLayerGroup( mapModel, wmsName );
130 } else {
131 lg = mapModel.getLayerGroups().get( 0 );
132 }
133 for ( Object object : layers ) {
134 Map<String, Object> layer = (Map<String, Object>) object;
135 org.deegree.ogcwebservices.wms.capabilities.Layer wmsLayer = capabilities.getLayer( (String) layer.get( "name" ) );
136 // if no legend URL is defined try reading it from WMS capabilities
137 ImageURL legendURL = null;
138 if ( layer.get( "legendURL" ) != null ) {
139 legendURL = new ImageURL( 25, 25, format, new URL( (String) layer.get( "legendURL" ) ) );
140 } else {
141 legendURL = readLegendURL( wmsLayer, layer );
142 }
143 Style style = new Style( (String) layer.get( "styleName" ), (String) layer.get( "styleName" ),
144 (String) layer.get( "abstract" ), legendURL, true );
145 StyleList styleList = new StyleList( new Style[] { style } );
146
147 // if no meta data URL is defined try reading it from WMS capabilities
148 BaseURL metadataURL = null;
149 String tmp = (String) layer.get( "metadataURL" );
150 if ( tmp != null && tmp.length() > 4 ) {
151 metadataURL = new BaseURL( "text/xml", new URL( tmp ) );
152 } else {
153 metadataURL = readMetadataURL( wmsLayer );
154 }
155 LayerExtension extension = new LayerExtension();
156 // ensures that each layer part of WMC layer list has one unique identifier
157 extension.setIdentifier( UUID.randomUUID().toString() );
158 ids.add( extension.getIdentifier() );
159 // read scale hints from WMS capabilities
160 extension.setMinScaleHint( wmsLayer.getScaleHint().getMin() );
161 extension.setMaxScaleHint( wmsLayer.getScaleHint().getMax() );
162
163 Layer lay = new Layer( server, (String) layer.get( "name" ), (String) layer.get( "title" ),
164 (String) layer.get( "abstract" ), srs, null, metadataURL, formatList, styleList,
165 (Boolean) layer.get( "queryable" ), !(Boolean) layer.get( "visible" ), extension );
166 layerList.addLayer( lay );
167 if ( mapModel != null ) {
168 // because a MapModel is optional and only must exist if layer tree module is
169 // included, we have to check availability of a MapModel
170 addToMapModel( lay, mapModel, lg );
171 }
172 }
173 } catch ( Exception e ) {
174 e.printStackTrace();
175 responseHandler.writeAndClose( "ERROR: could not add layer(s) to map model: "
176 + StringTools.stackTraceToString( e ) );
177 }
178 responseHandler.writeAndClose( false, ids );
179 }
180
181 private BaseURL readMetadataURL( org.deegree.ogcwebservices.wms.capabilities.Layer wmsLayer ) {
182 BaseURL metadataURL = null;
183 MetadataURL[] metadataURLs = wmsLayer.getMetadataURL();
184 if ( metadataURLs != null && metadataURLs.length > 0 ) {
185 metadataURL = new BaseURL( metadataURLs[0].getFormat(), metadataURLs[0].getOnlineResource() );
186 }
187 return metadataURL;
188 }
189
190 private ImageURL readLegendURL( org.deegree.ogcwebservices.wms.capabilities.Layer wmsLayer,
191 Map<String, Object> layer ) {
192 ImageURL legendURL = null;
193 org.deegree.ogcwebservices.wms.capabilities.Style wmsStyles[] = wmsLayer.getStyles();
194 for ( org.deegree.ogcwebservices.wms.capabilities.Style style : wmsStyles ) {
195 if ( style.getName().equalsIgnoreCase( "default" ) || style.getName().toLowerCase().startsWith( "default:" ) ) {
196 LegendURL[] legendURLs = style.getLegendURL();
197 if ( legendURLs != null && legendURLs.length > 0 ) {
198 legendURL = new ImageURL( legendURLs[0].getWidth(), legendURLs[0].getHeight(),
199 legendURLs[0].getFormat(), legendURLs[0].getOnlineResource() );
200 break;
201 }
202 }
203 }
204 return legendURL;
205 }
206
207 private LayerGroup addLayerGroup( MapModel mapModel, String wmsName )
208 throws Exception {
209 LayerGroup lg = new LayerGroup( UUID.randomUUID().toString(), wmsName, false, true, null, mapModel );
210 // add to root layer group
211 mapModel.insert( lg, mapModel.getLayerGroups().get( 0 ), null, true );
212 return lg;
213 }
214
215 /**
216 * update {@link MapModel} with new layer by inserting it at first position
217 *
218 * @param lay
219 * @param mapModel
220 * @throws Exception
221 */
222 private void addToMapModel( Layer lay, MapModel mapModel, LayerGroup parent )
223 throws Exception {
224 MMLayer layer = new MMLayer( lay.getExtension().getIdentifier(), null, mapModel, lay );
225 mapModel.insert( layer, parent, null, true );
226 }
227
228 /**
229 * @param serviceURL
230 * @param version
231 * @param sessionID
232 * @return WMS capabilities
233 * @throws Exception
234 */
235 private WMSCapabilities readCapabilities( String serviceURL, String version, String sessionID )
236 throws Exception {
237 String s = "service=WMS&request=GetCapabilities";
238 if ( version != null ) {
239 s += ( "&version=" + version );
240 }
241 if ( sessionID != null ) {
242 s += ( "&sessionID=" + sessionID );
243 }
244 LOG.logDebug( "service URL: ", serviceURL );
245 LOG.logDebug( "request: ", s );
246 XMLFragment xml = new XMLFragment();
247 InputStream is = HttpUtils.performHttpGet( serviceURL, s, timeout, null, null, null ).getResponseBodyAsStream();
248 xml.load( is, serviceURL );
249 WMSCapabilitiesDocument doc = WMSCapabilitiesDocumentFactory.getWMSCapabilitiesDocument( xml.getRootElement() );
250 return (WMSCapabilities) doc.parseCapabilities();
251 }
252
253 }