Add basic support for WMS layers < 1.3.0, improve bbox handling #5266

GeoSander · 2020-12-15T15:27:55Z

This PR adds basic support for WMS services prior to version 1.3.0, which are not supported by OpenLayers out-of-the-box.

Parse missing properties

Some GetCapabilities properties of these older WMS services are ignored by the OL parser. This PR uses the xml2json lib to scan for and add the missing properties.

Improve BBOX creation

WMS requests require a valid bounding box. Unfortunately, even though some EPSG codes might be standard, a user could define their own Proj4 definition for it. Because of that, this could result in an invalid BBOX and therefore invalid WMS request.
This PR checks if the Proj4 definition set by the user is a custom one. If it is, it will use the geographic bounds of the WMS layer GetCapabilities and reproject these to a valid BBOX. If it's not custom, it will use the bounds from the GetCapabilities CRS list (if a match is found).

Maintain WMS layers after projection switch

Currently, WMS layers are not reprojected if the user uses the Projection Switcher in the viewer map. They are simply being ignored and re-appear if the user switches back to the original projection.
This PR tries to re-add all WMS layers once the projection has been switched.

GeoSander · 2020-12-15T15:29:56Z

web-ui/src/main/resources/catalog/components/admin/uiconfig/ProjectionService.js

+        if (!(code in proj4.defs) || isDefaultProjection(code)) {
+          return;
+        }
+        return _cachedDefs[code];


We don't want to exhaust EPSG.io, so we keep a dictionary of cached Proj4 definitions

GeoSander · 2020-12-15T15:36:29Z

web-ui/src/main/resources/catalog/components/common/map/mapService.js

-          /**
-           * @ngdoc method
-           * @methodOf gn_map.service:gnMap
-           * @name gnMap#importProj4js
-           *
-           * @description
-           * Import the proj4js projection that are specified in DB config.
-           */
-          importProj4js: function() {
-            proj4.defs('EPSG:2154', '+proj=lcc +lat_1=49 +lat_2=44 +lat_0' +
-                '=46.5 +lon_0=3 +x_0=700000 +y_0=6600000 +ellps=GRS80 +' +
-                'towgs84=0,0,0,0,0,0,0 +units=m +no_defs');
-            if (proj4 && angular.isArray(gnConfig['map.proj4js'])) {
-              angular.forEach(gnConfig['map.proj4js'], function(item) {
-                proj4.defs(item.code, item.value);
-              });
-            }
-            ol.proj.proj4.register(proj4);
-          },
-


This is no longer used anywhere.

GeoSander · 2020-12-15T15:39:13Z

web-ui/src/main/resources/catalog/components/common/map/mapService.js

@@ -785,7 +808,7 @@
              advanced: options.advanced,
              minResolution: options.minResolution,
              maxResolution: options.maxResolution,
-              cextent: options.extent,


cextent is only used by GeoNetwork internally, but OpenLayers does not expect this property. Therefore, we replace it by extent instead.

GeoSander · 2020-12-15T15:40:30Z

web-ui/src/main/resources/catalog/components/common/map/mapService.js

+                function(olEvent, target) {
+                  var url = '[no tile URL found]';
+                  if (olEvent.image) {
+                    if (olEvent.image.getUrl) {
+                      url = olEvent.image.getUrl();
+                    } else if (olEvent.image.src_) {
+                      url = olEvent.image.src_;
+                    }
+                  } else if (olEvent.tile && olEvent.tile.getKey) {
+                    url = olEvent.tile.getKey();
+                  }


Fixed and improved error handling for WMS ImageLayers

GeoSander · 2020-12-15T15:41:06Z

web-ui/src/main/resources/catalog/components/common/map/mapService.js

-              var isLayerAvailableInMapProjection = false;
-              // OL3 only parse CRS from WMS 1.3 (and not SRS in WMS 1.1.x)
-              // so a WMS 1.1.x will always failed on this
-              // https://github.com/openlayers/ol3/blob/master/src/
-              // ol/format/wmscapabilitiesformat.js
-              /*
-              if (layer.CRS) {
-                var mapProjection = map.getView().getProjection().getCode();
-                for (var i = 0; i < layer.CRS.length; i++) {
-                  if (layer.CRS[i] === mapProjection) {
-                    isLayerAvailableInMapProjection = true;
-                    break;
-                  }
-                }
-              } else {
-                errors.push($translate.instant('layerCRSNotFound'));
-                console.warn($translate.instant('layerCRSNotFound'));
-              }
-              if (!isLayerAvailableInMapProjection) {
-                errors.push($translate.instant('layerNotAvailableInMapProj'));
-                console.warn($translate.instant('layerNotAvailableInMapProj'));
-              }
-              */
-


This no longer applies.

GeoSander · 2020-12-15T15:42:53Z

web-ui/src/main/resources/catalog/components/common/map/mapService.js

+              var bboxProps = gnOwsCapabilities.getWmsLayerExtentFromGetCap(map, getCapLayer, isCustomProj4);
+              var mapProj = map.getView().getProjection();
+              var projCode = bboxProps.epsg;
+              if (bboxProps.extent && projCode === 'EPSG:4326') {
+                // If the GetCap CRS list does not include the current map CRS,
+                // and an extent is returned from GetCap, it must be a WGS84 extent.
+                // Explicitly set the BBOX layer parameter in this case.
+                layerParams.BBOX = bboxProps.extent;
+              } else if (!bboxProps.extent) {
+                // If no valid extent could be determined, the WMS does not support the projection
+                // or the WGS84 bounds do not make sense (when reprojecting into a custom projection)
+                var msg = $translate.instant('layerNotAvailableInMapProj',{proj:projCode});
+                if (isCustomProj4) {                           
+                  msg = $translate.instant('layerWmsInvalidExtent',{proj:projCode});
                }
+                errors.push(msg);
              }


Improve extent/BBOX handling for WMS layers and supply user with more useful error messages when something is (still) not right.

GeoSander · 2020-12-17T09:47:32Z

web-ui/src/main/resources/catalog/components/common/map/mapsManager.js

+          var proj = gnMap.getMapConfig().projection;
+          if (type === this.VIEWER_MAP) {
+            gnMap.checkProj4Def(proj);
+          }
+


Whenever the viewer map is created, check if the Proj4 definition string is "standard" or custom.

GeoSander · 2020-12-17T09:50:53Z

web-ui/src/main/resources/catalog/components/common/ows/OWSService.js

              layer.url = url;
              layer.CRS = inheritedCrs;
+              layer.EX_GeographicBoundingBox = layer.EX_GeographicBoundingBox || bbox;


Also inherit the geographic bounding box if the "child" does not have that property.

GeoSander · 2020-12-17T09:51:59Z

web-ui/src/main/resources/catalog/components/common/ows/OWSService.js

@@ -271,7 +341,7 @@
                })
                    .success(function(data) {
                      try {
-                        defer.resolve(displayFileContent(data, withGroupLayer, url));
+                        defer.resolve(parseWMSCapabilities(data, withGroupLayer, url));


Renamed to be more in line with the other function names.

GeoSander · 2020-12-17T09:52:59Z

web-ui/src/main/resources/catalog/components/common/ows/OWSService.js

@@ -390,59 +460,69 @@
            return defer.promise;
          },

-          getLayerExtentFromGetCap: function(map, getCapLayer) {
+          getWmsLayerExtentFromGetCap: function(map, getCapLayer, isCustomDef) {


Since this function is now being used for WMS layers exclusively, its name should reflect that.
Also added the isCustomDef parameter.

GeoSander · 2020-12-17T09:53:36Z

web-ui/src/main/resources/catalog/components/common/ows/OWSService.js


          getLayerInfoFromCap: function(layerName, capObj, uuid) {
            var needles = [];
            var layers = capObj.layers || capObj.Layer;

            // Layer name may be a list of comma separated layers
            layerList = layerName.split(',');
-            layersLoop:


Unused label

GeoSander · 2020-12-17T09:59:50Z

web-ui/src/main/resources/catalog/components/viewer/ViewerDirective.js

+                var proj = map.getView().getProjection();
+                var extent = proj.getExtent();
+                if (gnViewerSettings.initialExtent && gnViewerSettings.mapConfig.projection && 
+                  gnViewerSettings.mapConfig.projection !== proj.getCode()) {
+                  // Use reprojected initial extent if it is defined
+                  extent = ol.proj.transformExtent(
+                    gnViewerSettings.initialExtent, gnViewerSettings.mapConfig.projection, proj, 8)
+                }
+                map.getView().fit(extent, map.getSize());


If an initial extent was defined in the viewer settings and its projection is different from the current map projection, use and reproject the initial extent. This makes more sense when switching to EPSG:3857 for instance, where the projection extent usually encapsulates the whole world.

GeoSander · 2020-12-17T10:00:48Z

web-ui/src/main/resources/catalog/components/viewer/projectionSwitcher/ProjectionSwitcher.js

@@ -69,6 +69,8 @@
                                  this.changeLayerProjection(subLayer, oldProj,
                                      newProj);
                                });
+                          } else if (layer instanceof ol.layer.Image) {
+                            gnMap.updateWmsLayerForProj(scope.map, layer, newProj);


Also update and show WMS layers whenever the projection changes (they were ignored until now).

GeoSander · 2020-12-17T10:01:53Z

web-ui/src/main/resources/catalog/components/viewer/projectionSwitcher/ProjectionSwitcher.js

-                          if (newProj.getExtent()) {
-                            newExtent = newProj.getExtent();
-                          }


It makes more sense to stay at the same place and zoom level.

GeoSander · 2020-12-17T10:02:50Z

web-ui/src/main/resources/catalog/components/viewer/wmsimport/WmsImportDirective.js

+                  msg: $translate.instant('layerAdded',
+                      {
+                        layer: layer.get('label'),
+                        extent: layer.get('extent') ? layer.get('extent').toString() : null


This would throw an error when (c)extent was null.

GeoSander · 2020-12-17T10:05:38Z

web-ui/src/main/resources/catalog/components/common/map/mapService.js

+                      }
+
+                      var style = layer.getSource().getParams().STYLES;
+                      $this.addWmsToMapFromCap(map, lyr, style);


According to the OpenLayers examples and docs, it should be enough to call layer.getSource().updateParams() to redraw the WMS using the new projection. Unfortunately, that didn't seem to do anything, which is why we're removing and re-adding the layer here.

GeoSander · 2020-12-17T10:11:58Z

web-ui/src/main/resources/catalog/components/common/map/mapService.js

-                cextent: gnOwsCapabilities.getLayerExtentFromGetCap(map,
-                    getCapLayer)


Calling the getLayerExtentFromGetCap() function always returns null for WMTS layers from what was observed, so it makes no sense to call it at all.
Note: WMTS layers do have an ows:BoundingBox property sometimes, but this is a deprecated element and it only exists inside TileMatrixSet elements, which are not being fully parsed by OL.

…r order when re-adding

…ght not be equal to projection), improve error handling

…nitial projection

…ayers

…lso redraws WMS layers

CLAassistant · 2024-12-08T03:50:22Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

GeoSander added 11 commits December 14, 2020 09:08

Exclude all *.log files

4ccf057

Use (reprojected) initialExtent for zoomToMaxExtent

c2bed01

Added missing semicolon

96bd332

Added new WMS failure message

9aef45b

Improved alerts for WMS services

49b1ccd

Added suppport for WMS services

ec9a748

Added isCustomProj4Def function

93a84a7

Improved WMS support, removed unused functions

b0d7a0b

Added Proj4 check for viewer map

bf1a3cf

Added minimal support for WMS layers prior to version 1.3.0

cf226bd

Removed cextent leftovers

7334aa8

GeoSander commented Dec 15, 2020

View reviewed changes

josegar74 requested a review from jahow December 15, 2020 15:46

GeoSander commented Dec 17, 2020

View reviewed changes

Pass on WMS version when updating layer

120eb6a

GeoSander added 14 commits December 18, 2020 01:13

Removed console log

f372d4e

Moved style set out of promise

78e1ef8

Loop inside changeLayerProjection, use reverse array to preserve laye…

d4697d6

…r order when re-adding

Let OL figure out the WMTS matrixSet based on the projection (name mi…

f5b7d9e

…ght not be equal to projection), improve error handling

Fixed isCustomProj4Def() function (compare Projection properties)

2bce7e4

Fixed errors when response data is missing

5cd1840

Do not use gnViewerSettings.initialExtent: it is useless without an i…

b1fba1d

…nitial projection

Improved axis orientation handling for certain projections and WMTS l…

1f6bddd

…ayers

Improved new extent calculation, added reloadOwsLayer function that a…

a2a5c09

…lso redraws WMS layers

Remove layer only if promise was successful

7207e26

Removed custom projection functionality

136aa39

Improved getWmsLayerExtentFromGetCap function

9dd92ae

Removed custom projection functionality, simplified WMS extent handling

9588d3a

Fixed axis order check

32b0d3e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add basic support for WMS layers < 1.3.0, improve bbox handling #5266

Add basic support for WMS layers < 1.3.0, improve bbox handling #5266

GeoSander commented Dec 15, 2020 •

edited

Loading

GeoSander Dec 15, 2020

GeoSander Dec 15, 2020

GeoSander Dec 15, 2020

GeoSander Dec 15, 2020

GeoSander Dec 15, 2020

GeoSander Dec 15, 2020

GeoSander Dec 17, 2020

GeoSander Dec 17, 2020

GeoSander Dec 17, 2020

GeoSander Dec 17, 2020 •

edited

Loading

GeoSander Dec 17, 2020

GeoSander Dec 17, 2020

GeoSander Dec 17, 2020

GeoSander Dec 17, 2020

GeoSander Dec 17, 2020

GeoSander Dec 17, 2020

GeoSander Dec 17, 2020 •

edited

Loading

CLAassistant commented Dec 8, 2024

		cextent: gnOwsCapabilities.getLayerExtentFromGetCap(map,
		getCapLayer)

Add basic support for WMS layers < 1.3.0, improve bbox handling #5266

Are you sure you want to change the base?

Add basic support for WMS layers < 1.3.0, improve bbox handling #5266

Conversation

GeoSander commented Dec 15, 2020 • edited Loading

Parse missing properties

Improve BBOX creation

Maintain WMS layers after projection switch

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GeoSander Dec 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GeoSander Dec 17, 2020 • edited Loading

Choose a reason for hiding this comment

CLAassistant commented Dec 8, 2024

GeoSander commented Dec 15, 2020 •

edited

Loading

GeoSander Dec 17, 2020 •

edited

Loading

GeoSander Dec 17, 2020 •

edited

Loading