Merge pull request #434 from chrismayer/fix-wms-legend-sld-version

Ensure "SLD_VERSION" is set in "GetLegendGraphic" for WMS 1.3.0

Author: chrismayer

src/util/LayerLegend.js

@@ -4,6 +4,7 @@
 
 import TileWmsSource from 'ol/source/TileWMS';
 import ImageWmsSource from 'ol/source/ImageWMS';
+import ObjectUtil from './Object';
 
 const CustomLegend = {
   /**
@@ -45,6 +46,13 @@ const WMSSourceLegend = {
    * @returns {String} The legend URL.
    */
   getUrl (source, resolution, options) {
+    const wmsParams = source.getParams();
+    const wmsVersion = ObjectUtil.getValueIgnoreCase(wmsParams, 'VERSION') || '1.3.0';
+    // apply mandatory SLD_VERSION param for WMS 1.3.0 GetLegendGraphic request
+    if (wmsVersion === '1.3.0' && !ObjectUtil.getValueIgnoreCase(options, 'SLD_VERSION')) {
+      options.SLD_VERSION = '1.1.0';
+    }
+
     return source.getLegendUrl(resolution, options);
   }
 }

src/util/Object.js

@@ -55,6 +55,34 @@ const ObjectUtil = {
       result.push(path);
     }
     return result;
+  },
+
+  /**
+   * Returns the value from an object using a case-insensitive key.
+   *
+   * @param {Object} obj The object to search in
+   * @param {String} key The key to retrieve value for
+   * @returns {*} The value for the given key or undefined, if not found
+   */
+  getValueIgnoreCase (obj, key) {
+    if (typeof obj !== 'object' || obj === null) {
+      console.warn('getValueIgnoreCase: First argument must be a valid object');
+      return;
+    }
+    if (typeof key !== 'string') {
+      console.warn('getValueIgnoreCase: Second argument must be a string');
+      return;
+    }
+
+    const lowerCaseKey = key.toLowerCase();
+
+    for (const objKey in obj) {
+      if (Object.prototype.hasOwnProperty.call(obj, objKey) && objKey.toLowerCase() === lowerCaseKey) {
+        return obj[objKey];
+      }
+    }
+
+    return undefined; // key not found
   }
 }
 

tests/unit/specs/components/layerlist/LayerLegendImage.spec.js

@@ -144,27 +144,27 @@ describe('layerlist/LayerLegendImage.vue', () => {
       await comp.setProps({ layer: wmsLayer });
       expect(vm.legendURL).to.equal('https://ahocevar.com/geoserver/wms?' +
         'SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&FORMAT=image%2Fpng&LAYER=topp%3Astates&' +
-        'SCALE=139770566.00717944&language=en');
+        'SCALE=139770566.00717944&language=en&SLD_VERSION=1.1.0');
     });
 
     it('legendURL supports localization and scale', async () => {
       await comp.setProps({ layer: wmsLayer });
 
       expect(vm.legendURL).to.equal('https://ahocevar.com/geoserver/wms?' +
         'SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&FORMAT=image%2Fpng&LAYER=topp%3Astates&' +
-        'SCALE=139770566.00717944&language=en');
+        'SCALE=139770566.00717944&language=en&SLD_VERSION=1.1.0');
 
       vm.$i18n.locale = 'de';
 
       expect(vm.legendURL).to.equal('https://ahocevar.com/geoserver/wms?' +
         'SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&FORMAT=image%2Fpng&LAYER=topp%3Astates&' +
-        'SCALE=139770566.00717944&language=de');
+        'SCALE=139770566.00717944&language=de&SLD_VERSION=1.1.0');
 
       view.setResolution(1000.0);
 
       expect(vm.legendURL).to.equal('https://ahocevar.com/geoserver/wms?' +
         'SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&FORMAT=image%2Fpng&LAYER=topp%3Astates&' +
-        'SCALE=3571428.571428572&language=de');
+        'SCALE=3571428.571428572&language=de&SLD_VERSION=1.1.0');
     });
 
     afterEach(() => {

tests/unit/specs/util/Object.spec.js

@@ -75,4 +75,31 @@ describe('ObjectUtil', () => {
       '.array[1].prop'
     ]);
   });
+
+  it('getValueIgnoreCase returns correct results', () => {
+    const object = {
+      foo: 1,
+      BAR: 2,
+      KaLLe: 3
+    };
+
+    let result1 = ObjectUtil.getValueIgnoreCase(object, 'foo');
+    expect(result1).to.equal(1);
+    result1 = ObjectUtil.getValueIgnoreCase(object, 'FOO');
+    expect(result1).to.equal(1);
+    result1 = ObjectUtil.getValueIgnoreCase(object, 'fOO');
+    expect(result1).to.equal(1);
+    let result2 = ObjectUtil.getValueIgnoreCase(object, 'bar');
+    expect(result2).to.equal(2);
+    result2 = ObjectUtil.getValueIgnoreCase(object, 'BAR');
+    expect(result2).to.equal(2);
+    result2 = ObjectUtil.getValueIgnoreCase(object, 'bAr');
+    expect(result2).to.equal(2);
+    let result3 = ObjectUtil.getValueIgnoreCase(object, 'kalle');
+    expect(result3).to.equal(3);
+    result3 = ObjectUtil.getValueIgnoreCase(object, 'KALLE');
+    expect(result3).to.equal(3);
+    result3 = ObjectUtil.getValueIgnoreCase(object, 'kAlle');
+    expect(result3).to.equal(3);
+  });
 });