geonetwork-ui 2.4.0-dev.e4dc8777 → 2.4.0-dev.e5f8e61e

package/src/libs/api/metadata-converter/src/lib/iso19139/read-parts.ts

@@ -1,9 +1,10 @@
 import {
   Constraint,
-  DatasetDistribution,
+  DatasetOnlineResource,
   GraphicOverview,
   Individual,
   Keyword,
+  OnlineResource,
   Organization,
   RecordKind,
   RecordStatus,
@@ -13,6 +14,8 @@ import {
   UpdateFrequency,
   UpdateFrequencyCustom,
 } from '../../../../../../libs/common/domain/src/lib/model/record'
+import { ThesaurusModel } from '../../../../../../libs/common/domain/src/lib/model/thesaurus'
+import { Geometry } from 'geojson'
 import { matchMimeType, matchProtocol } from '../common/distribution.mapper'
 import {
   ChainableFunction,
@@ -26,21 +29,22 @@ import {
   pipe,
 } from '../function-utils'
 import {
-  XmlElement,
   findChildElement,
   findChildrenElement,
   findNestedElement,
   findNestedElements,
   findParent,
+  firstChildElement,
   readAttribute,
   readText,
+  XmlElement,
 } from '../xml-utils'
+import { readGeometry } from './utils/geometry'
 import { fullNameToParts } from './utils/individual-name'
 import { getKeywordTypeFromKeywordTypeCode } from './utils/keyword.mapper'
 import { getRoleFromRoleCode } from './utils/role.mapper'
 import { getStatusFromStatusCode } from './utils/status.mapper'
 import { getUpdateFrequencyFromFrequencyCode } from './utils/update-frequency.mapper'
-import { ThesaurusModel } from '../../../../../../libs/common/domain/src/lib/model/thesaurus'
 
 export function extractCharacterString(): ChainableFunction<
   XmlElement,
@@ -66,6 +70,14 @@ export function extractDateTime(): ChainableFunction<XmlElement, Date> {
   )
 }
 
+export function extractDecimal(): ChainableFunction<XmlElement, number> {
+  return pipe(
+    findChildElement('gco:Decimal', false),
+    readText(),
+    map((numberStr) => (numberStr ? Number(numberStr) : null))
+  )
+}
+
 export function extractUrl(): ChainableFunction<XmlElement, URL> {
   const getUrl = pipe(findChildElement('gmd:URL', false), readText())
   const getCharacterString = pipe(
@@ -315,12 +327,12 @@ const getMimeType = pipe(
 )
 
 /**
- * Extract distributions from a MD_Distribution element
+ * Extract online resources from an MD_Distribution element
  * @param getMimeTypeFn This function starts from a gmd:transferOptions element
  */
-export function extractDatasetDistributions(
+export function extractDatasetOnlineResources(
   getMimeTypeFn: ChainableFunction<XmlElement, string>
-): ChainableFunction<XmlElement, DatasetDistribution[]> {
+): ChainableFunction<XmlElement, DatasetOnlineResource[]> {
   const getUrl = pipe(findChildElement('gmd:linkage'), extractMandatoryUrl())
   const getProtocolStr = pipe(
     findChildElement('gmd:protocol'),
@@ -763,14 +775,6 @@ export function readLineage(rootEl: XmlElement): string {
   )(rootEl)
 }
 
-export function readDistributions(rootEl: XmlElement): DatasetDistribution[] {
-  return pipe(
-    findNestedElements('gmd:distributionInfo', 'gmd:MD_Distribution'),
-    mapArray(extractDatasetDistributions(getMimeType)),
-    flattenArray()
-  )(rootEl)
-}
-
 export function readUpdateFrequency(rootEl: XmlElement): UpdateFrequency {
   return pipe(
     findIdentification(),
@@ -834,9 +838,14 @@ export function extractServiceOnlineResources(): ChainableFunction<
   )
 }
 
-export function readOnlineResources(
-  rootEl: XmlElement
-): ServiceOnlineResource[] {
+export function readOnlineResources(rootEl: XmlElement): OnlineResource[] {
+  if (readKind(rootEl) === 'dataset') {
+    return pipe(
+      findNestedElements('gmd:distributionInfo', 'gmd:MD_Distribution'),
+      mapArray(extractDatasetOnlineResources(getMimeType)),
+      flattenArray()
+    )(rootEl)
+  }
   return pipe(
     findNestedElements('gmd:distributionInfo', 'gmd:MD_Distribution'),
     mapArray(extractServiceOnlineResources()),
@@ -895,3 +904,62 @@ export function readTemporalExtents(rootEl: XmlElement) {
     })
   )(rootEl)
 }
+
+export function readSpatialExtents(rootEl: XmlElement) {
+  const extractGeometry = (rootEl: XmlElement): Geometry => {
+    if (!rootEl) return null
+    return pipe(
+      findChildElement('gmd:polygon', false),
+      firstChildElement,
+      map((el) => readGeometry(el))
+    )(rootEl)
+  }
+
+  const extractBBox = (
+    rootEl: XmlElement
+  ): [number, number, number, number] => {
+    if (!rootEl) return null
+    return pipe(
+      combine(
+        pipe(findChildElement('gmd:westBoundLongitude'), extractDecimal()),
+        pipe(findChildElement('gmd:southBoundLatitude'), extractDecimal()),
+        pipe(findChildElement('gmd:eastBoundLongitude'), extractDecimal()),
+        pipe(findChildElement('gmd:northBoundLatitude'), extractDecimal())
+      )
+    )(rootEl)
+  }
+
+  const extractDescription = (rootEl: XmlElement): string => {
+    if (!rootEl) return null
+    return pipe(
+      findNestedElement(
+        'gmd:geographicIdentifier',
+        'gmd:MD_Identifier',
+        'gmd:code'
+      ),
+      extractCharacterString()
+    )(rootEl)
+  }
+
+  return pipe(
+    findIdentification(),
+    findNestedElements('gmd:extent', 'gmd:EX_Extent', 'gmd:geographicElement'),
+    mapArray(
+      combine(
+        pipe(findChildElement('gmd:EX_BoundingPolygon'), extractGeometry),
+        pipe(findChildElement('gmd:EX_GeographicBoundingBox'), extractBBox),
+        pipe(
+          findChildElement('gmd:EX_GeographicDescription'),
+          extractDescription
+        )
+      )
+    ),
+    mapArray(([geometry, bbox, description]) => {
+      return {
+        ...(geometry && { geometry }),
+        ...(bbox && { bbox }),
+        ...(description && { description }),
+      }
+    })
+  )(rootEl)
+}

package/src/libs/api/metadata-converter/src/lib/iso19139/utils/geometry.ts

@@ -0,0 +1,39 @@
+import { XmlElement } from '@rgrove/parse-xml'
+import { Geometry } from 'geojson'
+import GML32 from 'ol/format/GML32'
+import GeoJSON from 'ol/format/GeoJSON'
+import { parse } from 'ol/xml'
+import {
+  createDocument,
+  getRootElement,
+  parseXmlString,
+  xmlToString,
+} from '../../xml-utils'
+
+export function readGeometry(el: XmlElement): Geometry {
+  const xmlDoc = createDocument(el)
+  xmlDoc.root.attributes['xmlns'] = 'http://www.opengis.net/gml/3.2'
+  const gmlString = xmlToString(xmlDoc)
+  const doc = parse(gmlString)
+  // we need an intermediate node to be able to parse the GML
+  const node = document.createElement('pre')
+  node.appendChild(doc.documentElement)
+  const gml32Format = new GML32()
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const geometry = gml32Format.readGeometryFromNode(node)
+  const geojsonFormat = new GeoJSON()
+  return geojsonFormat.writeGeometryObject(geometry)
+}
+
+export function writeGeometry(geometryObject: Geometry): XmlElement {
+  const geojsonFormat = new GeoJSON()
+  const geometry = geojsonFormat.readGeometry(geometryObject)
+  const gml32Format = new GML32()
+  const node = gml32Format.writeGeometryNode(geometry)
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const element = node.firstElementChild as HTMLElement
+  const gmlString = new XMLSerializer().serializeToString(element)
+  return getRootElement(parseXmlString(gmlString))
+}

package/src/libs/api/metadata-converter/src/lib/iso19139/write-parts.ts

@@ -1,7 +1,7 @@
 import {
   CatalogRecord,
   Constraint,
-  DatasetDistribution,
+  DatasetOnlineResource,
   DatasetRecord,
   DatasetServiceDistribution,
   Individual,
@@ -14,7 +14,9 @@ import {
   UpdateFrequencyCode,
   UpdateFrequencyCustom,
 } from '../../../../../../libs/common/domain/src/lib/model/record'
+import { ThesaurusModel } from '../../../../../../libs/common/domain/src/lib/model/thesaurus'
 import format from 'date-fns/format'
+import { Geometry } from 'geojson'
 import {
   ChainableFunction,
   fallback,
@@ -27,7 +29,6 @@ import {
   tap,
 } from '../function-utils'
 import {
-  XmlElement,
   addAttribute,
   appendChildren,
   createChild,
@@ -42,10 +43,11 @@ import {
   removeChildren,
   removeChildrenByName,
   setTextContent,
+  XmlElement,
 } from '../xml-utils'
 import { readKind } from './read-parts'
+import { writeGeometry } from './utils/geometry'
 import { namePartsToFull } from './utils/individual-name'
-import { ThesaurusModel } from '../../../../../../libs/common/domain/src/lib/model/thesaurus'
 
 export function writeCharacterString(
   text: string
@@ -101,6 +103,14 @@ export function writeDate(
   )
 }
 
+export function writeDecimal(
+  decimal: number
+): ChainableFunction<XmlElement, XmlElement> {
+  return tap(
+    pipe(findChildOrCreate('gco:Decimal'), setTextContent(decimal.toString()))
+  )
+}
+
 export function getProgressCode(status: RecordStatus): string {
   switch (status) {
     case 'completed':
@@ -169,7 +179,7 @@ export function getRoleCode(role: Role): string {
   }
 }
 
-export function getDistributionProtocol(
+export function getServiceDistributionProtocol(
   distribution: DatasetServiceDistribution
 ): string {
   switch (distribution.accessServiceProtocol.toLowerCase()) {
@@ -600,11 +610,11 @@ export function createLicense(license: Constraint) {
   )
 }
 
-export function removeDistributions() {
+export function removeOnlineResources() {
   return pipe(removeChildrenByName('gmd:distributionInfo'))
 }
 
-function appendDistributionFormat(mimeType: string) {
+function appendOnlineResourceFormat(mimeType: string) {
   return appendChildren(
     pipe(
       createElement('gmd:distributionFormat'),
@@ -628,8 +638,8 @@ export function createDistributionInfo() {
 }
 
 // apply to MD_Distribution
-export function appendDistribution(
-  distribution: DatasetDistribution,
+export function appendOnlineResource(
+  onlineResource: DatasetOnlineResource,
   appendFormatFn: (
     mimeType: string
   ) => ChainableFunction<XmlElement, XmlElement>
@@ -637,16 +647,16 @@ export function appendDistribution(
   let name: string
   let functionCode: string
   let protocol: string
-  if (distribution.type === 'service') {
-    name = distribution.identifierInService // this is for GeoNetwork to know the layer name
+  if (onlineResource.type === 'service') {
+    name = onlineResource.identifierInService // this is for GeoNetwork to know the layer name
     functionCode = 'download'
-    protocol = getDistributionProtocol(distribution)
-  } else if (distribution.type === 'download') {
-    name = distribution.name
+    protocol = getServiceDistributionProtocol(onlineResource)
+  } else if (onlineResource.type === 'download') {
+    name = onlineResource.name
     functionCode = 'download'
     protocol = 'WWW:DOWNLOAD'
   } else {
-    name = distribution.name
+    name = onlineResource.name
     functionCode = 'information'
     protocol = 'WWW:LINK'
   }
@@ -656,12 +666,12 @@ export function appendDistribution(
       createChild('gmd:MD_DigitalTransferOptions'),
       createChild('gmd:onLine'),
       createChild('gmd:CI_OnlineResource'),
-      writeLinkage(distribution.url),
-      'description' in distribution
+      writeLinkage(onlineResource.url),
+      'description' in onlineResource
         ? appendChildren(
             pipe(
               createElement('gmd:description'),
-              writeCharacterString(distribution.description)
+              writeCharacterString(onlineResource.description)
             )
           )
         : noop,
@@ -685,7 +695,9 @@ export function appendDistribution(
     )
   )
   return pipe(
-    'mimeType' in distribution ? appendFormatFn(distribution.mimeType) : noop,
+    'mimeType' in onlineResource
+      ? appendFormatFn(onlineResource.mimeType)
+      : noop,
     appendTransferOptions
   )
 }
@@ -733,33 +745,6 @@ export function writeKind(record: CatalogRecord, rootEl: XmlElement) {
   )(rootEl)
 }
 
-export function writeOwnerOrganization(
-  record: CatalogRecord,
-  rootEl: XmlElement
-) {
-  // if no contact matches the owner org, create an empty one
-  const ownerContact: Individual = record.contacts.find(
-    (contact) => contact.organization.name === record.ownerOrganization.name
-  )
-  pipe(
-    findChildOrCreate('gmd:contact'),
-    removeAllChildren(),
-    appendResponsibleParty(
-      ownerContact
-        ? {
-            ...ownerContact,
-            // owner responsible party is always point of contact
-            role: 'point_of_contact',
-          }
-        : {
-            organization: record.ownerOrganization,
-            email: '',
-            role: 'point_of_contact',
-          }
-    )
-  )(rootEl)
-}
-
 export function writeRecordUpdated(record: CatalogRecord, rootEl: XmlElement) {
   pipe(
     findChildOrCreate('gmd:dateStamp'),
@@ -1022,20 +1007,6 @@ export function writeGraphicOverviews(
   )(rootEl)
 }
 
-export function writeDistributions(record: DatasetRecord, rootEl: XmlElement) {
-  pipe(
-    removeDistributions(),
-    appendChildren(
-      ...record.distributions.map((d) =>
-        pipe(
-          createDistributionInfo(),
-          appendDistribution(d, appendDistributionFormat)
-        )
-      )
-    )
-  )(rootEl)
-}
-
 export function writeLineage(record: DatasetRecord, rootEl: XmlElement) {
   pipe(
     findNestedChildOrCreate(
@@ -1117,16 +1088,40 @@ export function createOnlineResource(onlineResource: ServiceOnlineResource) {
   )
 }
 
-export function writeOnlineResources(
-  record: ServiceRecord,
+export function appendDatasetOnlineResources(
+  record: DatasetRecord,
   rootEl: XmlElement
 ) {
-  pipe(
-    removeDistributions(),
-    appendChildren(...record.onlineResources.map(createOnlineResource))
+  appendChildren(
+    ...record.onlineResources.map((d) =>
+      pipe(
+        createDistributionInfo(),
+        appendOnlineResource(d, appendOnlineResourceFormat)
+      )
+    )
   )(rootEl)
 }
 
+export function appendServiceOnlineResources(
+  record: ServiceRecord,
+  rootEl: XmlElement
+) {
+  appendChildren(...record.onlineResources.map(createOnlineResource))(rootEl)
+}
+
+export function writeOnlineResources(
+  record: CatalogRecord,
+  rootEl: XmlElement
+) {
+  removeOnlineResources()(rootEl)
+
+  if (record.kind === 'dataset') {
+    appendDatasetOnlineResources(record, rootEl)
+    return
+  }
+  appendServiceOnlineResources(record, rootEl)
+}
+
 export function writeTemporalExtents(
   record: DatasetRecord,
   rootEl: XmlElement
@@ -1184,3 +1179,62 @@ export function writeTemporalExtents(
     )
   )(rootEl)
 }
+
+export function writeSpatialExtents(record: DatasetRecord, rootEl: XmlElement) {
+  const appendBoundingPolygon = (geometry?: Geometry) => {
+    if (!geometry) return null
+    return pipe(
+      createElement('gmd:EX_BoundingPolygon'),
+      appendChildren(
+        pipe(
+          createElement('gmd:polygon'),
+          appendChildren(() => writeGeometry(geometry))
+        )
+      )
+    )
+  }
+
+  const appendGeographicBoundingBox = (
+    bbox?: [number, number, number, number]
+  ) => {
+    if (!bbox) return null
+    return pipe(
+      createElement('gmd:EX_GeographicBoundingBox'),
+      appendChildren(
+        pipe(createElement('gmd:westBoundLongitude'), writeDecimal(bbox[0])),
+        pipe(createElement('gmd:eastBoundLongitude'), writeDecimal(bbox[2])),
+        pipe(createElement('gmd:southBoundLatitude'), writeDecimal(bbox[1])),
+        pipe(createElement('gmd:northBoundLatitude'), writeDecimal(bbox[3]))
+      )
+    )
+  }
+
+  const appendGeographicDescription = (description?: string) => {
+    if (!description) return null
+    return pipe(
+      createElement('gmd:EX_GeographicDescription'),
+      createChild('gmd:geographicIdentifier'),
+      createChild('gmd:MD_Identifier'),
+      createChild('gmd:code'),
+      writeCharacterString(description)
+    )
+  }
+
+  pipe(
+    findOrCreateIdentification(),
+    findNestedChildOrCreate('gmd:extent', 'gmd:EX_Extent'),
+    removeChildrenByName('gmd:geographicElement'),
+    appendChildren(
+      ...record.spatialExtents.map((extent) =>
+        pipe(
+          createElement('gmd:geographicElement'),
+          appendChildren(
+            appendBoundingPolygon(extent.geometry),
+            appendGeographicBoundingBox(extent.bbox),
+            appendGeographicDescription(extent.description)
+          )
+        )
+      )
+    )
+  )(rootEl)
+}

package/src/libs/api/metadata-converter/src/lib/xml-utils.ts

@@ -6,6 +6,7 @@ import {
   XmlText,
 } from '@rgrove/parse-xml'
 import { ChainableFunction, fallback } from './function-utils'
+
 export { XmlDocument, XmlElement } from '@rgrove/parse-xml'
 
 export class XmlParseError extends Error {
@@ -35,7 +36,8 @@ export function createDocument(rootEl: XmlElement): XmlDocument {
     if (namespace === 'xmlns' || namespace === null) return
     if (rootEl.attributes[`xmlns:${namespace}`]) return
     if (!NAMESPACES[namespace]) {
-      throw new Error(`No known URI for namespace ${namespace}`)
+      // the namespace is unknown but it might still be declared correctly: ignore it
+      return
     }
     rootEl.attributes[`xmlns:${namespace}`] = NAMESPACES[namespace]
   }
@@ -115,6 +117,10 @@ export function allChildrenElement(element: XmlElement): Array<XmlElement> {
   ] as Array<XmlElement>
 }
 
+export function firstChildElement(element: XmlElement): XmlElement {
+  return allChildrenElement(element)[0] ?? null
+}
+
 /**
  * Will return all matching elements nested according to the given
  * names (similar to a path), starting form the input element;
@@ -175,11 +181,11 @@ export function findParent(
 
 export function readText(): ChainableFunction<XmlElement, string> {
   return (el) => {
-    const textNode =
-      el && Array.isArray(el.children)
-        ? (el.children.find((node) => node.type === 'text') as XmlText)
-        : null
-    return textNode ? textNode.text : null
+    if (!el) return null
+    const textNode = Array.isArray(el.children)
+      ? (el.children.find((node) => node.type === 'text') as XmlText)
+      : null
+    return textNode ? textNode.text : ''
   }
 }
 
@@ -228,6 +234,7 @@ export function xmlToString(
 ${padding}<${el.name}${attrs}/>
 ${parentPadding}`
   }
+
   return `
 ${padding}<${el.name}${attrs}>${children}</${el.name}>
 ${parentPadding}`
@@ -307,11 +314,13 @@ function getTreeRoot(element: XmlElement): XmlElement {
 
 // stays on the parent element
 // if the given elements are part of a subtree, will add the root of subtree
+// will filter out falsy elements
 export function appendChildren(
   ...childrenFns: Array<ChainableFunction<void, XmlElement>>
 ): ChainableFunction<XmlElement, XmlElement> {
   return (element) => {
     if (!element) return null
+    childrenFns = childrenFns.filter((fn) => fn)
     element.children.push(...childrenFns.map((fn) => fn()).map(getTreeRoot))
     element.children.forEach((el) => (el.parent = element))
     return element
@@ -448,3 +457,21 @@ export function renameElements(
   doReplace(rootElement)
   return rootElement
 }
+
+/**
+ * This function use the DOMParser to check if the given xmlString is a valid XML file or throw an error
+ * (Generated by chatGPT)
+ * @param xmlString
+ */
+export function assertValidXml(xmlString: string): Document {
+  const parser = new DOMParser()
+  const xmlDoc = parser.parseFromString(xmlString, 'application/xml')
+  const parserError = xmlDoc.querySelector('parsererror')
+
+  if (parserError) {
+    console.error(parserError)
+    throw new Error('File is not a valid XML.')
+  }
+
+  return xmlDoc
+}