Merge pull request #67 from dvzgeo/feature-wms-exception-formats

Add support for retrieving exception formats from WMS capabilities
camptocamp · Oct 25, 2024 · ecb3450 · ecb3450
2 parents bf94a45 + 29a465e
commit ecb3450
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 1 deletion.
diff --git a/src/shared/models.ts b/src/shared/models.ts
@@ -19,9 +19,14 @@ export type GenericEndpointInfo = {
   outputFormats?: MimeType[];
   /**
    * Contains a list of formats that can be used for WMS GetFeatureInfo,
-   * or null for other services such as WFS
+   * or undefined for other services such as WFS
    */
   infoFormats?: MimeType[];
+  /**
+   * Contains a list of formats that can be used for Exceptions for WMS GetMap,
+   * or undefined for other services such as WFS
+   */
+  exceptionFormats?: MimeType[] | string[];
 };
 
 export type MimeType = string;

diff --git a/src/wms/capabilities.spec.ts b/src/wms/capabilities.spec.ts
@@ -298,6 +298,9 @@ describe('WMS capabilities', () => {
         'image/svg+xml',
       ],
       infoFormats: ['text/plain', 'application/vnd.ogc.gml'],
+      exceptionFormats: [
+        /* these differ depending on the WMS version used */
+      ],
       keywords: [
         'Géologie',
         'BRGM',
@@ -311,11 +314,17 @@ describe('WMS capabilities', () => {
 
     it('reads the service info (1.3.0)', () => {
       const doc = parseXmlString(capabilities130);
+      expectedInfo.exceptionFormats = ['XML', 'INIMAGE', 'BLANK'];
       expect(readInfoFromCapabilities(doc)).toEqual(expectedInfo);
     });
 
     it('reads the service info (1.1.1)', () => {
       const doc = parseXmlString(capabilities111);
+      expectedInfo.exceptionFormats = [
+        'application/vnd.ogc.se_xml',
+        'application/vnd.ogc.se_inimage',
+        'application/vnd.ogc.se_blank',
+      ];
       expect(readInfoFromCapabilities(doc)).toEqual(expectedInfo);
     });
   });

diff --git a/src/wms/capabilities.ts b/src/wms/capabilities.ts
@@ -72,6 +72,25 @@ export function readInfoFormatsFromCapabilities(capabilitiesDoc: XmlDocument) {
   return outputFormats;
 }
 
+/**
+ * Will return all available exception formats
+ * @param capabilitiesDoc Capabiliites document
+ * @return Available exception formats
+ */
+export function readExceptionFormatsFromCapabilities(
+  capabilitiesDoc: XmlDocument
+) {
+  const capability = findChildElement(
+    getRootElement(capabilitiesDoc),
+    'Capability'
+  );
+  const exception = findChildElement(capability, 'Exception');
+  const exceptionFormats = findChildrenElement(exception, 'Format').map(
+    getElementText
+  );
+  return exceptionFormats;
+}
+
 /**
  * Will read service-related info from the capabilities doc
  * @param capabilitiesDoc Capabilities document
@@ -83,6 +102,8 @@ export function readInfoFromCapabilities(
   const service = findChildElement(getRootElement(capabilitiesDoc), 'Service');
   const outputFormats = readOutputFormatsFromCapabilities(capabilitiesDoc);
   const infoFormats = readInfoFormatsFromCapabilities(capabilitiesDoc);
+  const exceptionFormats =
+    readExceptionFormatsFromCapabilities(capabilitiesDoc);
   const keywords = findChildrenElement(
     findChildElement(service, 'KeywordList'),
     'Keyword'
@@ -96,6 +117,7 @@ export function readInfoFromCapabilities(
     abstract: getElementText(findChildElement(service, 'Abstract')),
     outputFormats: outputFormats,
     infoFormats: infoFormats,
+    exceptionFormats: exceptionFormats,
     fees: getElementText(findChildElement(service, 'Fees')),
     constraints: getElementText(findChildElement(service, 'AccessConstraints')),
     keywords,

diff --git a/src/wms/endpoint.spec.ts b/src/wms/endpoint.spec.ts
@@ -188,6 +188,7 @@ describe('WmsEndpoint', () => {
           'image/svg+xml',
         ],
         infoFormats: ['text/plain', 'application/vnd.ogc.gml'],
+        exceptionFormats: ['XML', 'INIMAGE', 'BLANK'],
         keywords: [
           'Géologie',
           'BRGM',