geonetwork-ui 2.3.0-dev.2c3530dc → 2.3.0-dev.3222f975

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

@@ -36,6 +36,7 @@ import {
 } from '../xml-utils'
 import {
   ChainableFunction,
+  combine,
   fallback,
   filterArray,
   getAtIndex,
@@ -47,8 +48,9 @@ import {
 } from '../function-utils'
 import format from 'date-fns/format'
 import { readKind } from './read-parts'
+import { namePartsToFull } from './utils/individual-name'
 
-function writeCharacterString(
+export function writeCharacterString(
   text: string
 ): ChainableFunction<XmlElement, XmlElement> {
   return tap(
@@ -56,7 +58,9 @@ function writeCharacterString(
   )
 }
 
-function writeLinkage(url: URL): ChainableFunction<XmlElement, XmlElement> {
+export function writeLinkage(
+  url: URL
+): ChainableFunction<XmlElement, XmlElement> {
   return tap(
     pipe(
       findNestedChildOrCreate('gmd:linkage', 'gmd:URL'),
@@ -65,7 +69,7 @@ function writeLinkage(url: URL): ChainableFunction<XmlElement, XmlElement> {
   )
 }
 
-function writeAnchor(
+export function writeAnchor(
   url: URL,
   text?: string
 ): ChainableFunction<XmlElement, XmlElement> {
@@ -78,7 +82,9 @@ function writeAnchor(
   )
 }
 
-function writeDateTime(date: Date): ChainableFunction<XmlElement, XmlElement> {
+export function writeDateTime(
+  date: Date
+): ChainableFunction<XmlElement, XmlElement> {
   return tap(
     pipe(
       findChildOrCreate('gco:DateTime'),
@@ -87,7 +93,9 @@ function writeDateTime(date: Date): ChainableFunction<XmlElement, XmlElement> {
   )
 }
 
-function writeDate(date: Date): ChainableFunction<XmlElement, XmlElement> {
+export function writeDate(
+  date: Date
+): ChainableFunction<XmlElement, XmlElement> {
   return tap(
     pipe(
       findChildOrCreate('gco:Date'),
@@ -96,7 +104,7 @@ function writeDate(date: Date): ChainableFunction<XmlElement, XmlElement> {
   )
 }
 
-function getProgressCode(status: RecordStatus): string {
+export function getProgressCode(status: RecordStatus): string {
   switch (status) {
     case 'completed':
       return 'completed'
@@ -115,7 +123,7 @@ function getProgressCode(status: RecordStatus): string {
   }
 }
 
-function getRoleCode(role: Role): string {
+export function getRoleCode(role: Role): string {
   switch (role) {
     case 'author':
       return 'author'
@@ -164,7 +172,7 @@ function getRoleCode(role: Role): string {
   }
 }
 
-function getDistributionProtocol(
+export function getDistributionProtocol(
   distribution: DatasetServiceDistribution
 ): string {
   switch (distribution.accessServiceProtocol.toLowerCase()) {
@@ -179,7 +187,7 @@ function getDistributionProtocol(
   }
 }
 
-function getMaintenanceFrequencyCode(
+export function getMaintenanceFrequencyCode(
   updateFrequency: UpdateFrequencyCode
 ): string | null {
   switch (updateFrequency) {
@@ -198,7 +206,7 @@ function getMaintenanceFrequencyCode(
   }
 }
 
-function getISODuration(updateFrequency: UpdateFrequencyCustom): string {
+export function getISODuration(updateFrequency: UpdateFrequencyCustom): string {
   const duration = {
     years: 0,
     months: 0,
@@ -227,19 +235,61 @@ function getISODuration(updateFrequency: UpdateFrequencyCustom): string {
   return `P${duration.years}Y${duration.months}M${duration.days}D${hours}`
 }
 
-function appendResponsibleParty(contact: Individual) {
-  const name =
-    contact.lastName && contact.firstName
-      ? `${contact.firstName} ${contact.lastName}`
-      : contact.lastName || contact.firstName || null
+export function appendResponsibleParty(contact: Individual) {
+  const fullName = namePartsToFull(contact.firstName, contact.lastName)
+
+  const createAddress = pipe(
+    createElement('gmd:address'),
+    createChild('gmd:CI_Address'),
+    appendChildren(
+      pipe(
+        createElement('gmd:electronicMailAddress'),
+        writeCharacterString(contact.email)
+      )
+    ),
+    contact.address
+      ? appendChildren(
+          pipe(
+            createElement('gmd:deliveryPoint'),
+            writeCharacterString(contact.address)
+          )
+        )
+      : noop
+  )
+
+  const createContact = pipe(
+    createElement('gmd:contactInfo'),
+    createChild('gmd:CI_Contact'),
+    contact.phone
+      ? appendChildren(
+          pipe(
+            createElement('gmd:phone'),
+            createChild('gmd:CI_Telephone'),
+            createChild('gmd:voice'),
+            writeCharacterString(contact.phone)
+          )
+        )
+      : noop,
+    appendChildren(createAddress),
+    'website' in contact.organization
+      ? appendChildren(
+          pipe(
+            createElement('gmd:onlineResource'),
+            createChild('gmd:CI_OnlineResource'),
+            writeLinkage(contact.organization.website)
+          )
+        )
+      : noop
+  )
+
   return appendChildren(
     pipe(
       createElement('gmd:CI_ResponsibleParty'),
-      name
+      fullName
         ? appendChildren(
             pipe(
               createElement('gmd:individualName'),
-              writeCharacterString(name)
+              writeCharacterString(fullName)
             )
           )
         : noop,
@@ -256,27 +306,7 @@ function appendResponsibleParty(contact: Individual) {
           createElement('gmd:organisationName'),
           writeCharacterString(contact.organization.name)
         ),
-        pipe(
-          createElement('gmd:contactInfo'),
-          createChild('gmd:CI_Contact'),
-          appendChildren(
-            pipe(
-              createElement('gmd:address'),
-              createChild('gmd:CI_Address'),
-              createChild('gmd:electronicMailAddress'),
-              writeCharacterString(contact.email)
-            )
-          ),
-          'website' in contact.organization
-            ? appendChildren(
-                pipe(
-                  createElement('gmd:onlineResource'),
-                  createChild('gmd:CI_OnlineResource'),
-                  writeLinkage(contact.organization.website)
-                )
-              )
-            : noop
-        ),
+        createContact,
         pipe(
           createElement('gmd:role'),
           createChild('gmd:CI_RoleCode'),
@@ -291,7 +321,7 @@ function appendResponsibleParty(contact: Individual) {
   )
 }
 
-function updateCitationDate(
+export function updateCitationDate(
   date: Date,
   type: 'revision' | 'creation' | 'publication'
 ) {
@@ -311,8 +341,8 @@ function updateCitationDate(
   )
 }
 
-function appendCitationDate(
-  date,
+export function appendCitationDate(
+  date: Date,
   type: 'revision' | 'creation' | 'publication'
 ) {
   return appendChildren(
@@ -335,12 +365,12 @@ function appendCitationDate(
   )
 }
 
-function removeKeywords() {
+export function removeKeywords() {
   return removeChildren(pipe(findNestedElements('gmd:descriptiveKeywords')))
 }
 
 // returns a <gmd:thesaurusName> element
-function createThesaurus(thesaurus: KeywordThesaurus) {
+export function createThesaurus(thesaurus: KeywordThesaurus) {
   return pipe(
     createElement('gmd:thesaurusName'),
     createChild('gmd:CI_Citation'),
@@ -365,14 +395,15 @@ function createThesaurus(thesaurus: KeywordThesaurus) {
   )
 }
 
-function appendKeywords(keywords: Keyword[]) {
+export function appendKeywords(keywords: Keyword[]) {
+  // keywords are grouped by thesaurus if they have one, otherwise by type
   const keywordsByThesaurus: Keyword[][] = keywords.reduce((acc, keyword) => {
     const thesaurusId = keyword.thesaurus?.id
     const type = keyword.type
     let existingGroup = acc.find((group) =>
-      group[0].thesaurus
-        ? group[0].thesaurus.id === thesaurusId
-        : group[0].type === type
+      thesaurusId
+        ? group[0].thesaurus?.id === thesaurusId
+        : group[0].type === type && !group[0].thesaurus
     )
     if (!existingGroup) {
       existingGroup = []
@@ -413,7 +444,7 @@ function appendKeywords(keywords: Keyword[]) {
   )
 }
 
-function createConstraint(
+export function createConstraint(
   constraint: Constraint,
   type: 'legal' | 'security' | 'other'
 ) {
@@ -471,7 +502,7 @@ function createConstraint(
   )
 }
 
-function removeOtherConstraints() {
+export function removeOtherConstraints() {
   return removeChildren(
     pipe(
       findChildrenElement('gmd:resourceConstraints'),
@@ -485,7 +516,7 @@ function removeOtherConstraints() {
   )
 }
 
-function removeSecurityConstraints() {
+export function removeSecurityConstraints() {
   return removeChildren(
     pipe(
       findChildrenElement('gmd:resourceConstraints'),
@@ -499,7 +530,7 @@ function removeSecurityConstraints() {
   )
 }
 
-function removeLegalConstraints() {
+export function removeLegalConstraints() {
   return removeChildren(
     pipe(
       findChildrenElement('gmd:resourceConstraints'),
@@ -519,7 +550,7 @@ function removeLegalConstraints() {
   )
 }
 
-function removeLicenses() {
+export function removeLicenses() {
   return removeChildren(
     pipe(
       findChildrenElement('gmd:resourceConstraints'),
@@ -539,7 +570,7 @@ function removeLicenses() {
   )
 }
 
-function createLicense(license: Constraint) {
+export function createLicense(license: Constraint) {
   return pipe(
     createElement('gmd:resourceConstraints'),
     createChild('gmd:MD_LegalConstraints'),
@@ -572,44 +603,52 @@ function createLicense(license: Constraint) {
   )
 }
 
-function removeDistributions() {
+export function removeDistributions() {
   return pipe(removeChildrenByName('gmd:distributionInfo'))
 }
 
-function createDistribution(distribution: DatasetDistribution) {
-  const appendDistributionFormat =
-    'mimeType' in distribution
-      ? appendChildren(
-          pipe(
-            createElement('gmd:distributionFormat'),
-            createChild('gmd:MD_Format'),
-            appendChildren(
-              pipe(
-                createElement('gmd:name'),
-                writeCharacterString(distribution.mimeType)
-              ),
-              pipe(
-                createElement('gmd:version'),
-                writeCharacterString('1.0') // hardcoding this as it most likely won't be used but is mandatory
-              )
-            )
-          )
+function appendDistributionFormat(mimeType: string) {
+  return appendChildren(
+    pipe(
+      createElement('gmd:distributionFormat'),
+      createChild('gmd:MD_Format'),
+      appendChildren(
+        pipe(createElement('gmd:name'), writeCharacterString(mimeType)),
+        pipe(
+          createElement('gmd:version'),
+          writeCharacterString('1.0') // hardcoding this as it most likely won't be used but is mandatory
         )
-      : noop
+      )
+    )
+  )
+}
+
+export function createDistributionInfo() {
+  return pipe(
+    createElement('gmd:distributionInfo'),
+    createChild('gmd:MD_Distribution')
+  )
+}
 
-  let linkageUrl, name, functionCode, protocol
+// apply to MD_Distribution
+export function appendDistribution(
+  distribution: DatasetDistribution,
+  appendFormatFn: (
+    mimeType: string
+  ) => ChainableFunction<XmlElement, XmlElement>
+) {
+  let name: string
+  let functionCode: string
+  let protocol: string
   if (distribution.type === 'service') {
-    linkageUrl = distribution.url.toString()
     name = distribution.identifierInService // this is for GeoNetwork to know the layer name
     functionCode = 'download'
     protocol = getDistributionProtocol(distribution)
   } else if (distribution.type === 'download') {
-    linkageUrl = distribution.url.toString()
     name = distribution.name
     functionCode = 'download'
     protocol = 'WWW:DOWNLOAD'
   } else {
-    linkageUrl = distribution.url.toString()
     name = distribution.name
     functionCode = 'information'
     protocol = 'WWW:LINK'
@@ -620,7 +659,7 @@ function createDistribution(distribution: DatasetDistribution) {
       createChild('gmd:MD_DigitalTransferOptions'),
       createChild('gmd:onLine'),
       createChild('gmd:CI_OnlineResource'),
-      writeLinkage(linkageUrl),
+      writeLinkage(distribution.url),
       'description' in distribution
         ? appendChildren(
             pipe(
@@ -649,9 +688,7 @@ function createDistribution(distribution: DatasetDistribution) {
     )
   )
   return pipe(
-    createElement('gmd:distributionInfo'),
-    createChild('gmd:MD_Distribution'),
-    appendDistributionFormat,
+    'mimeType' in distribution ? appendFormatFn(distribution.mimeType) : noop,
     appendTransferOptions
   )
 }
@@ -660,7 +697,7 @@ function createDistribution(distribution: DatasetDistribution) {
  * Looks for srv:SV_ServiceIdentification or gmd:MD_DataIdentification element
  * depending on record type, create if missing
  */
-function findOrCreateIdentification() {
+export function findOrCreateIdentification() {
   return (rootEl: XmlElement) => {
     const kind = readKind(rootEl)
     let eltName = 'gmd:MD_DataIdentification'
@@ -669,7 +706,7 @@ function findOrCreateIdentification() {
   }
 }
 
-function findOrCreateDistribution() {
+export function findOrCreateDistribution() {
   return (rootEl: XmlElement) => {
     return findNestedChildOrCreate(
       'gmd:distributionInfo',
@@ -763,11 +800,26 @@ export function writeStatus(record: DatasetRecord, rootEl: XmlElement) {
 }
 
 export function writeContacts(record: CatalogRecord, rootEl: XmlElement) {
+  pipe(
+    removeChildrenByName('gmd:contact'),
+    appendChildren(
+      ...record.contacts.map((contact) =>
+        pipe(createElement('gmd:contact'), appendResponsibleParty(contact))
+      )
+    )
+  )(rootEl)
+}
+
+export function writeContactsForResource(
+  record: CatalogRecord,
+  rootEl: XmlElement
+) {
   pipe(
     findOrCreateIdentification(),
     removeChildrenByName('gmd:pointOfContact'),
+    removeChildrenByName('gmd:contact'),
     appendChildren(
-      ...record.contacts.map((contact) =>
+      ...record.contactsForResource.map((contact) =>
         pipe(
           createElement('gmd:pointOfContact'),
           appendResponsibleParty(contact)
@@ -878,26 +930,47 @@ export function writeUpdateFrequency(
   )(rootEl)
 }
 
-export function writeDatasetCreated(record: DatasetRecord, rootEl: XmlElement) {
-  if (!('datasetCreated' in record)) return
+export function writeResourceCreated(
+  record: DatasetRecord,
+  rootEl: XmlElement
+) {
+  if (!('resourceCreated' in record)) return
   pipe(
     findOrCreateIdentification(),
     findNestedChildOrCreate('gmd:citation', 'gmd:CI_Citation'),
     fallback(
-      updateCitationDate(record.datasetCreated, 'creation'),
-      appendCitationDate(record.datasetCreated, 'creation')
+      updateCitationDate(record.resourceCreated, 'creation'),
+      appendCitationDate(record.resourceCreated, 'creation')
     )
   )(rootEl)
 }
 
-export function writeDatasetUpdated(record: DatasetRecord, rootEl: XmlElement) {
-  if (!('datasetUpdated' in record)) return
+export function writeResourceUpdated(
+  record: DatasetRecord,
+  rootEl: XmlElement
+) {
+  if (!('resourceUpdated' in record)) return
   pipe(
     findOrCreateIdentification(),
     findNestedChildOrCreate('gmd:citation', 'gmd:CI_Citation'),
     fallback(
-      updateCitationDate(record.datasetUpdated, 'revision'),
-      appendCitationDate(record.datasetUpdated, 'revision')
+      updateCitationDate(record.resourceUpdated, 'revision'),
+      appendCitationDate(record.resourceUpdated, 'revision')
+    )
+  )(rootEl)
+}
+
+export function writeResourcePublished(
+  record: DatasetRecord,
+  rootEl: XmlElement
+) {
+  if (!('resourcePublished' in record)) return
+  pipe(
+    findOrCreateIdentification(),
+    findNestedChildOrCreate('gmd:citation', 'gmd:CI_Citation'),
+    fallback(
+      updateCitationDate(record.resourcePublished, 'publication'),
+      appendCitationDate(record.resourcePublished, 'publication')
     )
   )(rootEl)
 }
@@ -955,7 +1028,14 @@ export function writeGraphicOverviews(
 export function writeDistributions(record: DatasetRecord, rootEl: XmlElement) {
   pipe(
     removeDistributions(),
-    appendChildren(...record.distributions.map(createDistribution))
+    appendChildren(
+      ...record.distributions.map((d) =>
+        pipe(
+          createDistributionInfo(),
+          appendDistribution(d, appendDistributionFormat)
+        )
+      )
+    )
   )(rootEl)
 }
 
@@ -972,7 +1052,7 @@ export function writeLineage(record: DatasetRecord, rootEl: XmlElement) {
   )(rootEl)
 }
 
-function getServiceEndpointProtocol(endpoint: ServiceEndpoint): string {
+export function getServiceEndpointProtocol(endpoint: ServiceEndpoint): string {
   switch (endpoint.protocol.toLowerCase()) {
     case 'wfs':
       return 'OGC:WFS'
@@ -985,7 +1065,7 @@ function getServiceEndpointProtocol(endpoint: ServiceEndpoint): string {
   }
 }
 
-function createOnlineResource(onlineResource: ServiceOnlineResource) {
+export function createOnlineResource(onlineResource: ServiceOnlineResource) {
   let linkageUrl, functionCode, protocol
   if (onlineResource.type === 'endpoint') {
     linkageUrl = onlineResource.endpointUrl.toString()

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

@@ -33,6 +33,7 @@ export function createDocument(rootEl: XmlElement): XmlDocument {
   function collectNamespaceFromName(name: string) {
     const namespace = extractNamespace(name)
     if (namespace === 'xmlns' || namespace === null) return
+    if (rootEl.attributes[`xmlns:${namespace}`]) return
     if (!NAMESPACES[namespace]) {
       throw new Error(`No known URI for namespace ${namespace}`)
     }
@@ -55,11 +56,16 @@ export function createDocument(rootEl: XmlElement): XmlDocument {
 /**
  * Will do nothing if no namespace present
  */
-function stripNamespace(name: string): string {
+export function stripNamespace(name: string): string {
   const colon = name.indexOf(':')
   return colon > -1 ? name.substring(colon + 1) : name
 }
 
+export function getNamespace(name: string): string {
+  const colon = name.indexOf(':')
+  return colon > -1 ? name.substring(0, colon) : ''
+}
+
 function getElementName(element: XmlElement): string {
   return element.name || ''
 }
@@ -115,7 +121,7 @@ export function allChildrenElement(element: XmlElement): Array<XmlElement> {
  * returns an empty array if no matching element
  */
 export function findNestedElements(
-  ...elementNames
+  ...elementNames: string[]
 ): ChainableFunction<XmlElement, Array<XmlElement>> {
   return (el) => {
     function lookFor(elNameIndex: number) {
@@ -248,6 +254,29 @@ const NAMESPACES = {
   gsr: 'http://www.isotc211.org/2005/gsr',
   gmi: 'http://www.isotc211.org/2005/gmi',
   xlink: 'http://www.w3.org/1999/xlink',
+  mdb: 'http://standards.iso.org/iso/19115/-3/mdb/2.0',
+  mdq: 'http://standards.iso.org/iso/19157/-2/mdq/1.0',
+  msr: 'http://standards.iso.org/iso/19115/-3/msr/2.0',
+  mrs: 'http://standards.iso.org/iso/19115/-3/mrs/1.0',
+  mmi: 'http://standards.iso.org/iso/19115/-3/mmi/1.0',
+  mrl: 'http://standards.iso.org/iso/19115/-3/mrl/2.0',
+  mdt: 'http://standards.iso.org/iso/19115/-3/mdt/2.0',
+  mrd: 'http://standards.iso.org/iso/19115/-3/mrd/1.0',
+  mds: 'http://standards.iso.org/iso/19115/-3/mds/2.0',
+  mpc: 'http://standards.iso.org/iso/19115/-3/mpc/1.0',
+  mcc: 'http://standards.iso.org/iso/19115/-3/mcc/1.0',
+  mac: 'http://standards.iso.org/iso/19115/-3/mac/2.0',
+  mco: 'http://standards.iso.org/iso/19115/-3/mco/1.0',
+  mda: 'http://standards.iso.org/iso/19115/-3/mda/1.0',
+  mex: 'http://standards.iso.org/iso/19115/-3/mex/1.0',
+  gex: 'http://standards.iso.org/iso/19115/-3/gex/1.0',
+  gcx: 'http://standards.iso.org/iso/19115/-3/gcx/1.0',
+  mas: 'http://standards.iso.org/iso/19115/-3/mas/1.0',
+  mri: 'http://standards.iso.org/iso/19115/-3/mri/1.0',
+  cit: 'http://standards.iso.org/iso/19115/-3/cit/2.0',
+  cat: 'http://standards.iso.org/iso/19115/-3/cat/1.0',
+  lan: 'http://standards.iso.org/iso/19115/-3/lan/1.0',
+  mrc: 'http://standards.iso.org/iso/19115/-3/mrc/2.0',
 }
 
 /**
@@ -268,6 +297,13 @@ export function addAttribute(
     return element
   }
 }
+function getTreeRoot(element: XmlElement): XmlElement {
+  let root = element
+  while (root.parent instanceof XmlElement) {
+    root = root.parent
+  }
+  return root
+}
 
 // stays on the parent element
 // if the given elements are part of a subtree, will add the root of subtree
@@ -276,22 +312,26 @@ export function appendChildren(
 ): ChainableFunction<XmlElement, XmlElement> {
   return (element) => {
     if (!element) return null
-    element.children.push(
-      ...childrenFns
-        .map((fn) => fn())
-        .map((el) => {
-          let root = el
-          while (root.parent instanceof XmlElement) {
-            root = root.parent
-          }
-          return root
-        })
-    )
+    element.children.push(...childrenFns.map((fn) => fn()).map(getTreeRoot))
     element.children.forEach((el) => (el.parent = element))
     return element
   }
 }
 
+// switch to the tip of the subtree
+export function appendChildTree(
+  childrenFn: ChainableFunction<void, XmlElement>
+): ChainableFunction<XmlElement, XmlElement> {
+  return (element) => {
+    if (!element) return null
+    const treeTip = childrenFn()
+    const treeRoot = getTreeRoot(treeTip)
+    element.children.push(treeRoot)
+    treeRoot.parent = element
+    return treeTip
+  }
+}
+
 // switches to the child element
 export function createChild(
   childName: string
@@ -349,6 +389,7 @@ export function removeAllChildren(): ChainableFunction<XmlElement, XmlElement> {
   }
 }
 
+// stays on the same element
 export function removeChildrenByName(
   name: string
 ): ChainableFunction<XmlElement, XmlElement> {
@@ -372,11 +413,38 @@ export function removeChildren(
   childrenFn: ChainableFunction<XmlElement, Array<XmlElement>>
 ): ChainableFunction<XmlElement, XmlElement> {
   return (element) => {
-    const children = childrenFn(element)
-    children.forEach((child) => (child.parent = null))
+    const childrenToRemove = childrenFn(element)
+    childrenToRemove.forEach((child) => (child.parent = null))
     element.children = element.children.filter(
-      (child) => child instanceof XmlElement && children.indexOf(child) === -1
+      (child) =>
+        child instanceof XmlElement && childrenToRemove.indexOf(child) === -1
     )
     return element
   }
 }
+
+/**
+ * Renames elements in the XML tree according to the map
+ * Either specify a full element name like 'gmd:MD_Metadata' or simply a namespace like 'gmd'
+ * @param rootElement
+ * @param replaceMap
+ */
+export function renameElements(
+  rootElement: XmlElement,
+  replaceMap: Record<string, string>
+) {
+  function doReplace(element: XmlElement) {
+    if (element.name in replaceMap) {
+      element.name = replaceMap[element.name]
+    } else if (element.name && getNamespace(element.name) in replaceMap) {
+      element.name = `${
+        replaceMap[getNamespace(element.name)]
+      }:${stripNamespace(element.name)}`
+    }
+    if (element.children) {
+      element.children.forEach(doReplace)
+    }
+  }
+  doReplace(rootElement)
+  return rootElement
+}