Changeset 13358 in josm

Timestamp:

2018-01-26T23:21:57+01:00 (7 years ago)

Author:

Don-vip

Message:

fix #15830 - Support (and autodetect) WMS 1.3.0

Location:

trunk

Files:

• src/org/openstreetmap/josm/data/cache/JCSCachedTileLoaderJob.java (modified) (3 diffs)
• src/org/openstreetmap/josm/io/imagery/WMSImagery.java (modified) (5 diffs)
• src/org/openstreetmap/josm/tools/HttpClient.java (modified) (2 diffs)
• test/functional/org/openstreetmap/josm/tools/HttpClientTest.java (modified) (3 diffs)
• test/unit/org/openstreetmap/josm/data/cache/JCSCachedTileLoaderJobTest.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/data/cache/JCSCachedTileLoaderJob.java

@@ -17 +17 @@
 import java.util.concurrent.TimeUnit;
 import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
 import org.apache.commons.jcs.access.behavior.ICacheAccess;
@@ -52 +51 @@
     protected static final long ABSOLUTE_EXPIRE_TIME_LIMIT = TimeUnit.DAYS.toMillis(365);
 
-    // Pattern to detect Tomcat error message. Be careful with change of format:
-    // CHECKSTYLE.OFF: LineLength
-    // https://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/valves/ErrorReportValve.java?r1=1740707&r2=1779641&pathrev=1779641&diff_format=h
-    // CHECKSTYLE.ON: LineLength
-    protected static final Pattern TOMCAT_ERR_MESSAGE = Pattern.compile(
-        ".*<p><b>[^<]+</b>[^<]+</p><p><b>[^<]+</b> (?:<u>)?([^<]*)(?:</u>)?</p><p><b>[^<]+</b> (?:<u>)?[^<]*(?:</u>)?</p>.*",
-        Pattern.CASE_INSENSITIVE);
-
     /**
      * maximum download threads that will be started
@@ -370 +361 @@
                         String data = urlConn.fetchContent();
                         if (!data.isEmpty()) {
-                            Matcher m = TOMCAT_ERR_MESSAGE.matcher(data);
+                            Matcher m = HttpClient.getTomcatErrorMatcher(data);
                             if (m.matches()) {
                                 attributes.setErrorMessage(m.group(1).replace("'", "''"));

trunk/src/org/openstreetmap/josm/io/imagery/WMSImagery.java

@@ -18 +18 @@
 import java.util.NoSuchElementException;
 import java.util.Set;
+import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -121 +122 @@
     private URL serviceUrl;
     private List<String> formats;
+    private String version = "1.1.1";
 
     /**
@@ -136 +138 @@
     public URL getServiceUrl() {
         return serviceUrl;
+    }
+
+    /**
+     * Returns the WMS version used.
+     * @return the WMS version used (1.1.1 or 1.3.0)
+     * @since 13358
+     */
+    public String getVersion() {
+        return version;
     }
 
@@ -198 +209 @@
     public String buildGetMapUrl(Collection<LayerDetails> selectedLayers, String format) {
         return buildRootUrl() + "FORMAT=" + format + (imageFormatHasTransparency(format) ? "&TRANSPARENT=TRUE" : "")
-                + "&VERSION=1.1.1&SERVICE=WMS&REQUEST=GetMap&LAYERS="
+                + "&VERSION=" + version + "&SERVICE=WMS&REQUEST=GetMap&LAYERS="
                 + selectedLayers.stream().map(x -> x.ident).collect(Collectors.joining(","))
-                + "&STYLES=&SRS={proj}&WIDTH={width}&HEIGHT={height}&BBOX={bbox}";
+                + "&STYLES=&" + ("1.3.0".equals(version) ? "CRS" : "SRS") + "={proj}&WIDTH={width}&HEIGHT={height}&BBOX={bbox}";
     }
 
@@ -238 +249 @@
     }
 
+    /**
+     * Attempts WMS GetCapabilities with version 1.1.1 first, then 1.3.0 in case of specific errors.
+     * @param serviceUrlStr WMS service URL
+     * @param getCapabilitiesUrl GetCapabilities URL
+     * @throws IOException if any I/O error occurs
+     * @throws WMSGetCapabilitiesException if any HTTP or parsing error occurs
+     */
     private void doAttemptGetCapabilities(String serviceUrlStr, URL getCapabilitiesUrl)
             throws IOException, WMSGetCapabilitiesException {
+        final String url = getCapabilitiesUrl.toExternalForm();
         final Response response = HttpClient.create(getCapabilitiesUrl).connect();
 
+        // Is the HTTP connection successul ?
         if (response.getResponseCode() >= 400) {
-            throw new WMSGetCapabilitiesException(response.getResponseMessage(), response.fetchContent());
+            // HTTP error for servers handling only WMS 1.3.0 ?
+            String errorMessage = response.getResponseMessage();
+            String errorContent = response.fetchContent();
+            Matcher tomcat = HttpClient.getTomcatErrorMatcher(errorContent);
+            boolean messageAbout130 = errorMessage != null && errorMessage.contains("1.3.0");
+            boolean contentAbout130 = errorContent != null && tomcat != null && tomcat.matches() && tomcat.group(1).contains("1.3.0");
+            if (url.contains("VERSION=1.1.1") && (messageAbout130 || contentAbout130)) {
+                doAttemptGetCapabilities130(serviceUrlStr, url);
+                return;
+            }
+            throw new WMSGetCapabilitiesException(errorMessage, errorContent);
         }
 
         try {
+            // Parse XML capabilities sent by the server
             parseCapabilities(serviceUrlStr, response.getContent());
         } catch (WMSGetCapabilitiesException e) {
-            String url = getCapabilitiesUrl.toExternalForm();
             // ServiceException for servers handling only WMS 1.3.0 ?
             if (e.getCause() == null && url.contains("VERSION=1.1.1")) {
-                doAttemptGetCapabilities(serviceUrlStr, new URL(url.replace("VERSION=1.1.1", "VERSION=1.3.0")));
-                if (serviceUrl.toExternalForm().contains("VERSION=1.1.1")) {
-                    serviceUrl = new URL(serviceUrl.toExternalForm().replace("VERSION=1.1.1", "VERSION=1.3.0"));
-                }
+                doAttemptGetCapabilities130(serviceUrlStr, url);
             } else {
                 throw e;
             }
         }
+    }
+
+    /**
+     * Attempts WMS GetCapabilities with version 1.3.0.
+     * @param serviceUrlStr WMS service URL
+     * @param url GetCapabilities URL
+     * @throws IOException if any I/O error occurs
+     * @throws WMSGetCapabilitiesException if any HTTP or parsing error occurs
+     * @throws MalformedURLException in case of invalid URL
+     */
+    private void doAttemptGetCapabilities130(String serviceUrlStr, final String url)
+            throws IOException, WMSGetCapabilitiesException, MalformedURLException {
+        doAttemptGetCapabilities(serviceUrlStr, new URL(url.replace("VERSION=1.1.1", "VERSION=1.3.0")));
+        if (serviceUrl.toExternalForm().contains("VERSION=1.1.1")) {
+            serviceUrl = new URL(serviceUrl.toExternalForm().replace("VERSION=1.1.1", "VERSION=1.3.0"));
+        }
+        version = "1.3.0";
     }
 

trunk/src/org/openstreetmap/josm/tools/HttpClient.java

@@ -61 +61 @@
     private boolean finishOnCloseOutput = true;
 
+    // Pattern to detect Tomcat error message. Be careful with change of format:
+    // CHECKSTYLE.OFF: LineLength
+    // https://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/valves/ErrorReportValve.java?r1=1740707&r2=1779641&pathrev=1779641&diff_format=h
+    // CHECKSTYLE.ON: LineLength
+    private static final Pattern TOMCAT_ERR_MESSAGE = Pattern.compile(
+        ".*<p><b>[^<]+</b>[^<]+</p><p><b>[^<]+</b> (?:<u>)?([^<]*)(?:</u>)?</p><p><b>[^<]+</b> (?:<u>)?[^<]*(?:</u>)?</p>.*",
+        Pattern.CASE_INSENSITIVE);
+
     static {
         CookieHandler.setDefault(new CookieManager());
@@ -687 +695 @@
         }
     }
+
+    /**
+     * Returns a {@link Matcher} against predefined Tomcat error messages.
+     * If it matches, error message can be extracted from {@code group(1)}.
+     * @param data HTML contents to check
+     * @return a {@link Matcher} against predefined Tomcat error messages
+     * @since 13358
+     */
+    public static Matcher getTomcatErrorMatcher(String data) {
+        return data != null ? TOMCAT_ERR_MESSAGE.matcher(data) : null;
+    }
 }

trunk/test/functional/org/openstreetmap/josm/tools/HttpClientTest.java

@@ -5 +5 @@
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.CoreMatchers.nullValue;
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThat;
+import static org.junit.Assert.assertTrue;
 
 import java.io.BufferedReader;
@@ -15 +17 @@
 import java.util.logging.Handler;
 import java.util.logging.LogRecord;
+import java.util.regex.Matcher;
 
 import javax.json.JsonObject;
@@ -298 +301 @@
         }
     }
+
+    /**
+     * Test that error message sent by Tomcat can be parsed.
+     */
+    @Test
+    public void testTomcatErrorMessage() {
+        Matcher m = HttpClient.getTomcatErrorMatcher(
+            "<html><head><title>Apache Tomcat/DGFiP - Rapport d''erreur</title><style><!--"+
+                "H1 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:22px;} "+
+                "H2 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:16px;} "+
+                "H3 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:14px;} "+
+                "BODY {font-family:Tahoma,Arial,sans-serif;color:black;background-color:white;} "+
+                "B {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;} "+
+                "P {font-family:Tahoma,Arial,sans-serif;background:white;color:black;font-size:12px;}"+
+                "A {color : black;}A.name {color : black;}HR {color : #525D76;}"+
+            "--></style> </head><body><h1>Etat HTTP 400 - La commune demandée n'existe pas ou n'est pas accessible.</h1>"+
+            "<HR size=\"1\" noshade=\"noshade\">"+
+            "<p><b>type</b> Rapport d''état</p><p><b>message</b> <u>La commune demandée n'existe pas ou n'est pas accessible.</u></p>"+
+            "<p><b>description</b> <u>La requête envoyée par le client était syntaxiquement incorrecte.</u></p>"+
+            "<HR size=\"1\" noshade=\"noshade\"><h3>Apache Tomcat/DGFiP</h3></body></html>");
+        assertTrue(m.matches());
+        assertEquals("La commune demandée n'existe pas ou n'est pas accessible.", m.group(1));
+    }
 }

trunk/test/unit/org/openstreetmap/josm/data/cache/JCSCachedTileLoaderJobTest.java

@@ -4 +4 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertTrue;
 
 import java.io.IOException;
@@ -10 +9 @@
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
-import java.util.regex.Matcher;
 
 import org.apache.commons.jcs.access.behavior.ICacheAccess;
@@ -173 +171 @@
         return JCSCacheManager.getCache("test");
     }
-
-    /**
-     * Test that error message sent by Tomcat can be parsed.
-     */
-    @Test
-    public void testTomcatErrorMessage() {
-        Matcher m = JCSCachedTileLoaderJob.TOMCAT_ERR_MESSAGE.matcher(
-            "<html><head><title>Apache Tomcat/DGFiP - Rapport d''erreur</title><style><!--"+
-                "H1 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:22px;} "+
-                "H2 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:16px;} "+
-                "H3 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:14px;} "+
-                "BODY {font-family:Tahoma,Arial,sans-serif;color:black;background-color:white;} "+
-                "B {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;} "+
-                "P {font-family:Tahoma,Arial,sans-serif;background:white;color:black;font-size:12px;}"+
-                "A {color : black;}A.name {color : black;}HR {color : #525D76;}"+
-            "--></style> </head><body><h1>Etat HTTP 400 - La commune demandée n'existe pas ou n'est pas accessible.</h1>"+
-            "<HR size=\"1\" noshade=\"noshade\">"+
-            "<p><b>type</b> Rapport d''état</p><p><b>message</b> <u>La commune demandée n'existe pas ou n'est pas accessible.</u></p>"+
-            "<p><b>description</b> <u>La requête envoyée par le client était syntaxiquement incorrecte.</u></p>"+
-            "<HR size=\"1\" noshade=\"noshade\"><h3>Apache Tomcat/DGFiP</h3></body></html>");
-        assertTrue(m.matches());
-        assertEquals("La commune demandée n'existe pas ou n'est pas accessible.", m.group(1));
-    }
 }