001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/portal/PortalUtils.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2008 by:
006 EXSE, Department of Geography, University of Bonn
007 http://www.giub.uni-bonn.de/deegree/
008 lat/lon GmbH
009 http://www.lat-lon.de
010
011 This library is free software; you can redistribute it and/or
012 modify it under the terms of the GNU Lesser General Public
013 License as published by the Free Software Foundation; either
014 version 2.1 of the License, or (at your option) any later version.
015
016 This library is distributed in the hope that it will be useful,
017 but WITHOUT ANY WARRANTY; without even the implied warranty of
018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 Lesser General Public License for more details.
020
021 You should have received a copy of the GNU Lesser General Public
022 License along with this library; if not, write to the Free Software
023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024
025 Contact:
026
027 Andreas Poth
028 lat/lon GmbH
029 Aennchenstr. 19
030 53115 Bonn
031 Germany
032 E-Mail: poth@lat-lon.de
033
034 Klaus Greve
035 Department of Geography
036 University of Bonn
037 Meckenheimer Allee 166
038 53115 Bonn
039 Germany
040 E-Mail: greve@giub.uni-bonn.de
041
042
043 ---------------------------------------------------------------------------*/
044 package org.deegree.portal;
045
046 import java.net.URL;
047 import java.net.URLEncoder;
048 import java.util.ArrayList;
049 import java.util.Iterator;
050 import java.util.List;
051
052 import org.deegree.framework.util.CharsetUtils;
053 import org.deegree.model.spatialschema.Point;
054 import org.deegree.ogcwebservices.OWSUtils;
055 import org.deegree.ogcwebservices.wms.operation.GetMap;
056 import org.deegree.portal.context.Format;
057 import org.deegree.portal.context.GeneralExtension;
058 import org.deegree.portal.context.Layer;
059 import org.deegree.portal.context.LayerExtension;
060 import org.deegree.portal.context.LayerList;
061 import org.deegree.portal.context.ViewContext;
062
063 /**
064 *
065 *
066 *
067 * @version $Revision: 11842 $
068 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
069 * @author last edited by: $Author: rbezema $
070 *
071 * @version 1.0. $Revision: 11842 $, $Date: 2008-05-20 15:37:46 +0200 (Di, 20 Mai 2008) $
072 *
073 * @since 2.0
074 */
075 public class PortalUtils {
076
077 /**
078 * returns a comma seperated list of layers marked as sensible for feature info requestes
079 *
080 * @param vc
081 * @return a comma seperated list of layers marked as sensible for feature info requestes
082 */
083 public static List<String> getFeatureInfoLayers( ViewContext vc ) {
084 List<String> list = new ArrayList<String>();
085 LayerList layerList = vc.getLayerList();
086 Layer[] layers = layerList.getLayers();
087 for ( int i = 0; i < layers.length; i++ ) {
088 if ( layers[i].getExtension() != null && layers[i].getExtension().isSelectedForQuery() ) {
089 list.add( layers[i].getName() );
090 }
091 }
092 return list;
093 }
094
095 /**
096 * returns a comma seperated list of visible layers
097 *
098 * @param vc
099 * @return a comma seperated list of visible layers
100 */
101 public static List getVisibleLayers( ViewContext vc ) {
102 List<String[]> list = new ArrayList<String[]>();
103 LayerList layerList = vc.getLayerList();
104 Layer[] layers = layerList.getLayers();
105 for ( int i = 0; i < layers.length; i++ ) {
106 if ( !layers[i].isHidden() ) {
107 String[] s = new String[2];
108 s[0] = layers[i].getName();
109 s[1] = layers[i].getServer().getOnlineResource().toExternalForm();
110 list.add( s );
111 }
112 }
113 return list;
114 }
115
116 /**
117 * returns true if at least one layer of the passed server is visible
118 *
119 * @param vc
120 * @param serverTitle
121 * @return <code>true</code> if at least one layer of the passed server is visible
122 */
123 public static boolean hasServerVisibleLayers( ViewContext vc, String serverTitle ) {
124 LayerList layerList = vc.getLayerList();
125 Layer[] layers = layerList.getLayers();
126 for ( int i = 0; i < layers.length; i++ ) {
127 if ( layers[i].getServer().getTitle().equals( serverTitle ) && !layers[i].isHidden() ) {
128 return true;
129 }
130 }
131 return false;
132 }
133
134 /**
135 * creates the GetMap basic requests required by the JSP page assigned to the MapViewPortlet.
136 *
137 * @param vc
138 * @param user
139 * @param password
140 * @param sessionID
141 * @return list of GetMap requests
142 */
143 public static String[] createBaseRequests( ViewContext vc, String user, String password, String sessionID ) {
144
145 Layer[] layers = vc.getLayerList().getLayers();
146 List<String> list = new ArrayList<String>( layers.length );
147 int i = layers.length - 1;
148 try {
149 while ( i >= 0 ) {
150 GeneralExtension gExt = vc.getGeneral().getExtension();
151 Point[] bbox = vc.getGeneral().getBoundingBox();
152 StringBuffer sb = new StringBuffer( 1000 );
153 URL url = OWSUtils.getHTTPGetOperationURL( layers[i].getServer().getCapabilities(), GetMap.class );
154 if ( url != null ) {
155 String href = url.toExternalForm();
156
157 sb.append( OWSUtils.validateHTTPGetBaseURL( href ) );
158 sb.append( "SRS=" ).append( bbox[0].getCoordinateSystem().getName() );
159 if ( "1.0.0".equals( layers[i].getServer().getVersion() )) {
160 sb.append( "&REQUEST=map" );
161 sb.append( "&exceptions=INIMAGE" );
162 sb.append( "&WMTVER=" ).append( layers[i].getServer().getVersion() );
163 } else {
164 sb.append( "&REQUEST=GetMap" );
165 sb.append( "&exceptions=application/vnd.ogc.se_inimage" );
166 sb.append( "&VERSION=" ).append( layers[i].getServer().getVersion() );
167 }
168 sb.append( "&transparent=" ).append( true );
169 if ( gExt == null ) {
170 sb.append( "&BGCOLOR=0xFFFFFF" );
171 } else {
172 sb.append( "&BGCOLOR=" ).append( gExt.getBgColor() );
173 }
174
175 Format format = layers[i].getFormatList().getCurrentFormat();
176 sb.append( "&FORMAT=" ).append( format.getName() );
177 StringBuffer styles = new StringBuffer( 1000 );
178 styles.append( "&STYLES=" );
179 StringBuffer lyrs = new StringBuffer( 1000 );
180 lyrs.append( "&LAYERS=" );
181 String title = layers[i].getServer().getTitle();
182 int authentication = -1;
183 while ( i >= 0 && title.equals( layers[i].getServer().getTitle() ) ) {
184 if ( !layers[i].isHidden() ) {
185 if ( authentication < 0 ) {
186 // just evaluate if not has already been loaded
187 authentication = layers[i].getExtension().getAuthentication();
188 }
189 lyrs.append( URLEncoder.encode( layers[i].getName(), "UTF-8" ) ).append( ',' );
190 String style = layers[i].getStyleList().getCurrentStyle().getName();
191 if ( style.equalsIgnoreCase( "DEFAULT" ) ) {
192 style = "";
193 }
194 styles.append( style ).append( ',' );
195 }
196 LayerExtension le = layers[i].getExtension();
197 Iterator<String> iterator = le.getVendorspecificParameterNames();
198 while ( iterator.hasNext() ) {
199 sb.append( '&' );
200 String name = iterator.next();
201 String value = le.getVendorspecificParameter( name );
202 sb.append( name ).append( '=' ).append( value );
203 }
204 i--;
205 }
206 if ( authentication == LayerExtension.USERPASSWORD ) {
207 if ( user != null ) {
208 sb.append( "&user=" ).append( URLEncoder.encode( user, CharsetUtils.getSystemCharset() ) );
209 }
210 if ( password != null ) {
211 sb.append( "&password=" );
212 sb.append( URLEncoder.encode( password, CharsetUtils.getSystemCharset() ) );
213 }
214 } else if ( authentication == LayerExtension.SESSIONID ) {
215 if ( sessionID != null ) {
216 sb.append( "&sessionID=" );
217 sb.append( URLEncoder.encode( sessionID, CharsetUtils.getSystemCharset() ) );
218 }
219 }
220 String s1 = lyrs.substring( 0, lyrs.length() - 1 );
221 String s2 = styles.substring( 0, styles.length() - 1 );
222 sb.append( s1 ).append( s2 );
223
224 if ( s1.length() > 7 ) {
225 // ensure that a request will just be created if
226 // at least one layer of a group is visible
227 list.add( sb.toString() );
228 }
229 } else {
230 System.out.println( "no service available for layer: " + layers[i--].getName() );
231 }
232
233 }
234 } catch ( Exception shouldneverhappen ) {
235 shouldneverhappen.printStackTrace();
236 }
237
238 return list.toArray( new String[list.size()] );
239
240 }
241
242 /**
243 * creates the GetMap basic requests required by the JSP page assigned to the MapViewPortlet.
244 *
245 * @param vc
246 * @return
247 */
248 public static String[] createBaseRequests( ViewContext vc ) {
249
250 return createBaseRequests( vc, null, null, null );
251
252 }
253
254 }