geonetwork-ui 2.3.2 → 2.4.0-alpha.1

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 : ''
   }
 }
 
@@ -193,6 +199,12 @@ export function xmlToString(
   el: XmlElement | XmlText | XmlComment | XmlDocument,
   indentationLevel = 0
 ) {
+  const encodeEntities = (text: string) => {
+    return text
+      .replace(/&/g, '&amp;')
+      .replace(/</g, '&lt;')
+      .replace(/>/g, '&gt;')
+  }
   if (el instanceof XmlDocument)
     return `<?xml version="1.0" encoding="UTF-8"?>${xmlToString(
       el.children[0]
@@ -201,10 +213,7 @@ export function xmlToString(
     const text = el.text
     const isEmpty = !text || text.replace(/^\s+|\s+$/g, '') === ''
     if (isEmpty) return ''
-    return text
-      .replace(/&/g, '&amp;')
-      .replace(/</g, '&lt;')
-      .replace(/>/g, '&gt;')
+    return encodeEntities(text)
   }
   if (!(el instanceof XmlElement)) return `<!-- unknown -->`
 
@@ -219,7 +228,7 @@ export function xmlToString(
         .join('')
     : ''
   const attrs = Object.keys(el.attributes).reduce(
-    (prev, curr) => prev + ` ${curr}="${el.attributes[curr]}"`,
+    (prev, curr) => prev + ` ${curr}="${encodeEntities(el.attributes[curr])}"`,
     ''
   )
   const parentPadding = '    '.repeat(Math.max(0, indentationLevel - 1))
@@ -228,6 +237,7 @@ export function xmlToString(
 ${padding}<${el.name}${attrs}/>
 ${parentPadding}`
   }
+
   return `
 ${padding}<${el.name}${attrs}>${children}</${el.name}>
 ${parentPadding}`
@@ -242,7 +252,7 @@ function extractNamespace(name: string): string | null {
   return colon > -1 ? name.substring(0, colon) : null
 }
 
-const NAMESPACES = {
+export const NAMESPACES = {
   gmd: 'http://www.isotc211.org/2005/gmd',
   gco: 'http://www.isotc211.org/2005/gco',
   gfc: 'http://www.isotc211.org/2005/gfc',
@@ -277,6 +287,22 @@ const NAMESPACES = {
   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',
+  rdf: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
+  rdfs: 'http://www.w3.org/2000/01/rdf-schema#',
+  foaf: 'http://xmlns.com/foaf/0.1/',
+  xsd: 'http://www.w3.org/2001/XMLSchema#',
+  dcat: 'http://www.w3.org/ns/dcat#',
+  dct: 'http://purl.org/dc/terms/',
+  skos: 'http://www.w3.org/2004/02/skos/core#',
+  schema_org: 'http://schema.org/',
+  spdx: 'https://spdx.org/rdf/terms/#',
+  adms: 'http://www.w3.org/ns/adms#',
+  dqv: 'http://www.w3.org/ns/dqv#',
+  owl: 'http://www.w3.org/2002/07/owl#',
+  vcard: 'http://www.w3.org/2006/vcard/ns#',
+  time: 'http://www.w3.org/2006/time#',
+  locn: 'http://www.w3.org/ns/locn#',
+  mdcat: 'https://data.vlaanderen.be/ns/metadata-dcat#',
 }
 
 /**
@@ -307,11 +333,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 +476,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
+}

package/src/libs/api/repository/src/lib/gn4/gn4-repository.ts

@@ -1,7 +1,19 @@
 import { Injectable } from '@angular/core'
-import { SearchApiService } from '../../../../../../libs/data-access/gn4/src'
+import {
+  RecordsApiService,
+  SearchApiService,
+} from '../../../../../../libs/data-access/gn4/src'
 import { ElasticsearchService } from './elasticsearch'
-import { Observable, of, switchMap } from 'rxjs'
+import {
+  combineLatest,
+  exhaustMap,
+  from,
+  Observable,
+  of,
+  Subject,
+  switchMap,
+  throwError,
+} from 'rxjs'
 import { RecordsRepositoryInterface } from '../../../../../../libs/common/domain/src/lib/repository/records-repository.interface'
 import {
   SearchParams,
@@ -12,19 +24,36 @@ import {
   AggregationsParams,
   FieldFilters,
 } from '../../../../../../libs/common/domain/src/lib/model/search'
-import { map } from 'rxjs/operators'
+import { catchError, map, tap } from 'rxjs/operators'
 import {
+  assertValidXml,
+  findConverterForDocument,
   Gn4Converter,
   Gn4SearchResults,
+  Iso19139Converter,
 } from '../../../../../../libs/api/metadata-converter/src'
 import { CatalogRecord } from '../../../../../../libs/common/domain/src/lib/model/record'
+import {
+  HttpClient,
+  HttpErrorResponse,
+  HttpHeaders,
+} from '@angular/common/http'
+
+const TEMPORARY_ID_PREFIX = 'TEMP-ID-'
+
+export type RecordAsXml = string
 
 @Injectable()
 export class Gn4Repository implements RecordsRepositoryInterface {
+  _draftsChanged = new Subject<void>()
+  draftsChanged$ = this._draftsChanged.asObservable()
+
   constructor(
+    private httpClient: HttpClient,
     private gn4SearchApi: SearchApiService,
     private gn4SearchHelper: ElasticsearchService,
-    private gn4Mapper: Gn4Converter
+    private gn4Mapper: Gn4Converter,
+    private gn4RecordsApi: RecordsApiService
   ) {}
 
   search({
@@ -84,9 +113,7 @@ export class Gn4Repository implements RecordsRepositoryInterface {
       .pipe(map((results: Gn4SearchResults) => results.hits.total?.value || 0))
   }
 
-  getByUniqueIdentifier(
-    uniqueIdentifier: string
-  ): Observable<CatalogRecord | null> {
+  getRecord(uniqueIdentifier: string): Observable<CatalogRecord | null> {
     return this.gn4SearchApi
       .search(
         'bucket',
@@ -122,6 +149,7 @@ export class Gn4Repository implements RecordsRepositoryInterface {
         )
       )
   }
+
   aggregate(params: AggregationsParams): Observable<Aggregations> {
     // if aggregations are empty, return an empty object right away
     if (Object.keys(params).length === 0) return of({})
@@ -165,4 +193,242 @@ export class Gn4Repository implements RecordsRepositoryInterface {
         )
       )
   }
+
+  openRecordForEdition(
+    uniqueIdentifier: string
+  ): Observable<[CatalogRecord, string, boolean] | null> {
+    const draft$ = of(this.getRecordFromLocalStorage(uniqueIdentifier))
+    const recordAsXml$ = this.getRecordAsXml(uniqueIdentifier)
+
+    return combineLatest([draft$, recordAsXml$]).pipe(
+      switchMap(([draft, recordAsXml]) => {
+        const xml = draft ?? recordAsXml
+        const isSavedAlready = recordAsXml !== null
+        return findConverterForDocument(xml)
+          .readRecord(xml)
+          .then(
+            (record) =>
+              [record, xml, isSavedAlready] as [CatalogRecord, string, boolean]
+          )
+      })
+    )
+  }
+
+  openRecordForDuplication(
+    uniqueIdentifier: string
+  ): Observable<[CatalogRecord, string, false] | null> {
+    return this.getRecordAsXml(uniqueIdentifier).pipe(
+      switchMap(async (fetchedRecordAsXml) => {
+        const converter = findConverterForDocument(fetchedRecordAsXml)
+        const record = await converter.readRecord(fetchedRecordAsXml)
+
+        record.uniqueIdentifier = `${TEMPORARY_ID_PREFIX}${Date.now()}`
+        record.title = `${record.title} (Copy)`
+
+        const recordAsXml = await converter.writeRecord(
+          record,
+          fetchedRecordAsXml
+        )
+
+        this.saveRecordToLocalStorage(recordAsXml, record.uniqueIdentifier)
+        this._draftsChanged.next()
+
+        return [record, recordAsXml, false] as [CatalogRecord, string, false]
+      })
+    )
+  }
+
+  saveRecord(
+    record: CatalogRecord,
+    referenceRecordSource?: string
+  ): Observable<string> {
+    return this.serializeRecordToXml(record, referenceRecordSource).pipe(
+      switchMap((recordXml) =>
+        this.gn4RecordsApi
+          .insert(
+            'METADATA',
+            undefined,
+            undefined,
+            undefined,
+            true,
+            undefined,
+            'OVERWRITE',
+            undefined,
+            undefined,
+            undefined,
+            '_none_',
+            undefined,
+            undefined,
+            undefined,
+            recordXml
+          )
+          .pipe(
+            map((response) => {
+              const metadataId = Object.keys(response.metadataInfos)[0]
+              return response.metadataInfos[metadataId][0].uuid
+            })
+          )
+      )
+    )
+  }
+
+  duplicateExternalRecord(recordDownloadUrl: string): Observable<string> {
+    return this.getExternalRecordAsXml(recordDownloadUrl).pipe(
+      exhaustMap(async (fetchedRecordAsXml: string) => {
+        const converter = findConverterForDocument(fetchedRecordAsXml)
+        const record = await converter.readRecord(fetchedRecordAsXml)
+        const tempId = this.generateTemporaryId()
+
+        record.title = `${record.title} (Copy)`
+        record.uniqueIdentifier = tempId
+
+        const recordAsXml = await converter.writeRecord(
+          record,
+          fetchedRecordAsXml
+        )
+
+        this.saveRecordToLocalStorage(recordAsXml, record.uniqueIdentifier)
+        this._draftsChanged.next()
+
+        return tempId
+      }),
+      catchError((error: HttpErrorResponse) => {
+        return throwError(() => error)
+      })
+    )
+  }
+
+  deleteRecord(uniqueIdentifier: string): Observable<void> {
+    return this.gn4RecordsApi.deleteRecord(uniqueIdentifier)
+  }
+
+  generateTemporaryId(): string {
+    return `${TEMPORARY_ID_PREFIX}${Date.now()}`
+  }
+
+  saveRecordAsDraft(
+    record: CatalogRecord,
+    referenceRecordSource?: string
+  ): Observable<string> {
+    return this.serializeRecordToXml(record, referenceRecordSource).pipe(
+      tap((recordXml) => {
+        this.saveRecordToLocalStorage(recordXml, record.uniqueIdentifier)
+        this._draftsChanged.next()
+      })
+    )
+  }
+
+  clearRecordDraft(uniqueIdentifier: string): void {
+    this.removeRecordFromLocalStorage(uniqueIdentifier)
+    this._draftsChanged.next()
+  }
+
+  recordHasDraft(uniqueIdentifier: string): boolean {
+    return this.getRecordFromLocalStorage(uniqueIdentifier) !== null
+  }
+
+  isRecordNotYetSaved(uniqueIdentifier: string): boolean {
+    return uniqueIdentifier.startsWith(TEMPORARY_ID_PREFIX)
+  }
+
+  // generated by copilot
+  getAllDrafts(): Observable<CatalogRecord[]> {
+    const items = { ...window.localStorage }
+    const drafts = Object.keys(items)
+      .filter((key) => key.startsWith('geonetwork-ui-draft-'))
+      .map((key) => window.localStorage.getItem(key))
+      .filter((draft) => draft !== null)
+    return from(
+      Promise.all(
+        drafts.map((draft) => {
+          return findConverterForDocument(draft).readRecord(draft)
+        })
+      )
+    )
+  }
+
+  getDraftsCount(): Observable<number> {
+    const items = { ...window.localStorage }
+    const draftCount = Object.keys(items)
+      .filter((key) => key.startsWith('geonetwork-ui-draft-'))
+      .map((key) => window.localStorage.getItem(key))
+      .filter((draft) => draft !== null).length
+    return of(draftCount)
+  }
+
+  private getRecordAsXml(uniqueIdentifier: string): Observable<string | null> {
+    return this.gn4RecordsApi
+      .getRecordAs(
+        uniqueIdentifier,
+        undefined,
+        false,
+        undefined,
+        undefined,
+        undefined,
+        'application/xml',
+        'response',
+        undefined,
+        { httpHeaderAccept: 'text/xml,application/xml' as 'application/xml' } // this is to make sure that the response is parsed as text
+      )
+      .pipe(
+        map((response) => response.body),
+        catchError((error: HttpErrorResponse) =>
+          error.status === 404 ? of(null) : throwError(() => error)
+        )
+      )
+  }
+
+  private serializeRecordToXml(
+    record: CatalogRecord,
+    referenceRecordSource?: string
+  ): Observable<string> {
+    // if there's a reference record, use that standard; otherwise, use iso19139
+    const converter = referenceRecordSource
+      ? findConverterForDocument(referenceRecordSource)
+      : new Iso19139Converter()
+    return from(converter.writeRecord(record, referenceRecordSource))
+  }
+
+  private getExternalRecordAsXml(
+    recordDownloadUrl: string
+  ): Observable<string> {
+    let headers = new HttpHeaders()
+    const responseType_ = 'text'
+    headers = headers.set('Accept', 'text/xml,application/xml')
+
+    return this.httpClient
+      .get<string>(recordDownloadUrl, {
+        responseType: <any>responseType_,
+        headers: headers,
+        observe: 'body',
+      })
+      .pipe(
+        map((recordAsXmlFile) => {
+          assertValidXml(recordAsXmlFile)
+
+          return recordAsXmlFile
+        })
+      )
+  }
+
+  private getLocalStorageKeyForRecord(recordId: string): string {
+    return `geonetwork-ui-draft-${recordId}` // Never change this prefix as it is a breaking change
+  }
+
+  private saveRecordToLocalStorage(recordAsXml: RecordAsXml, recordId: string) {
+    window.localStorage.setItem(
+      this.getLocalStorageKeyForRecord(recordId),
+      recordAsXml
+    )
+  }
+
+  private getRecordFromLocalStorage(recordId: string): RecordAsXml {
+    return window.localStorage.getItem(
+      this.getLocalStorageKeyForRecord(recordId)
+    )
+  }
+
+  private removeRecordFromLocalStorage(recordId: string): void {
+    window.localStorage.removeItem(this.getLocalStorageKeyForRecord(recordId))
+  }
 }

package/src/libs/api/repository/src/lib/gn4/organizations/organizations-from-groups.service.ts

@@ -76,6 +76,7 @@ export class OrganizationsFromGroupsService
     return {
       name: group.label[lang3],
       ...(group.description && { description: group.description }),
+      ...(group.email && { email: group.email }),
       ...(group.logo && {
         logoUrl: getAsUrl(`${IMAGE_URL}${group.logo}`),
       }),

package/src/libs/api/repository/src/lib/gn4/organizations/organizations-from-metadata.service.ts

@@ -230,10 +230,12 @@ export class OrganizationsFromMetadataService
       if (!group) return fullOrg
       return {
         ...fullOrg,
+        email: emails[0],
         ...(group.description && { description: group.description }),
         ...(group.logo && { logoUrl: getAsUrl(`${IMAGE_URL}${group.logo}`) }),
         ...(group.website && { website: getAsUrl(group.website) }),
-      }
+        ...(group.email && { email: group.email }),
+      } as Organization
     })
   }
 

package/src/libs/api/repository/src/lib/gn4/platform/gn4-platform.mapper.ts

@@ -8,11 +8,16 @@ import { Injectable } from '@angular/core'
 import { AvatarServiceInterface } from '../auth'
 import { map } from 'rxjs/operators'
 import { Observable, of } from 'rxjs'
-import { ThesaurusModel } from '../../../../../../../libs/common/domain/src/lib/model/thesaurus/thesaurus.model'
 import {
+  Keyword,
   UserFeedback,
   UserFeedbackViewModel,
 } from '../../../../../../../libs/common/domain/src/lib/model/record'
+import {
+  KeywordApiResponse,
+  ThesaurusApiResponse,
+} from '../../../../../../../libs/api/metadata-converter/src'
+import { KeywordType } from '../../../../../../../libs/common/domain/src/lib/model/thesaurus'
 
 @Injectable()
 export class Gn4PlatformMapper {
@@ -40,7 +45,7 @@ export class Gn4PlatformMapper {
     const {
       enabled,
       emailAddresses,
-      organisation,
+      organization,
       kind,
       lastLoginDate,
       accountNonExpired,
@@ -52,8 +57,12 @@ export class Gn4PlatformMapper {
     return { ...apiUser, id: id.toString() } as UserModel
   }
 
-  thesaurusFromApi(thesaurus: any[], lang3?: string): ThesaurusModel {
-    return thesaurus.map((keyword) => {
+  keywordsFromApi(
+    keywords: KeywordApiResponse[],
+    thesaurus: ThesaurusApiResponse[],
+    lang3?: string
+  ): Keyword[] {
+    return keywords.map((keyword): Keyword => {
       let key = keyword.uri
       // sometines GN can prefix an URI with an "all thesaurus" URI; only keep the last one
       if (key.indexOf('@@@') > -1) {
@@ -65,11 +74,34 @@ export class Gn4PlatformMapper {
         lang3 && lang3 in keyword.definitions
           ? keyword.definitions[lang3]
           : keyword.definition
+
+      const matchedThesaurus = thesaurus.find(
+        (thes) => keyword.thesaurusKey === thes.key
+      )
+
+      let bbox: [number, number, number, number]
+      if (keyword.coordWest) {
+        bbox = [
+          parseFloat(keyword.coordWest),
+          parseFloat(keyword.coordSouth),
+          parseFloat(keyword.coordEast),
+          parseFloat(keyword.coordNorth),
+        ]
+      }
+
       return {
         key,
         label,
         description,
-      }
+        type: matchedThesaurus?.dname as KeywordType,
+        thesaurus: {
+          id: matchedThesaurus?.key,
+          name: matchedThesaurus?.title,
+          url: new URL(matchedThesaurus?.url),
+          type: matchedThesaurus?.dname as KeywordType,
+        },
+        ...(bbox && { bbox }),
+      } as Keyword
     })
   }