geonetwork-ui 2.4.0-dev.503109c9 → 2.4.0-dev.575f30f2

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

@@ -36,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]
   }
@@ -456,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
+}

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

@@ -6,6 +6,7 @@ import {
 import { ElasticsearchService } from './elasticsearch'
 import {
   combineLatest,
+  exhaustMap,
   from,
   Observable,
   of,
@@ -25,22 +26,30 @@ import {
 } from '../../../../../../libs/common/domain/src/lib/model/search'
 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 { HttpErrorResponse } from '@angular/common/http'
+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,
@@ -140,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({})
@@ -184,44 +194,12 @@ export class Gn4Repository implements RecordsRepositoryInterface {
       )
   }
 
-  /**
-   * Returns null if the record is not found
-   */
-  private loadRecordAsXml(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 getLocalStorageKeyForRecord(uniqueIdentifier: string) {
-    return `geonetwork-ui-draft-${uniqueIdentifier}`
-  }
-
   openRecordForEdition(
     uniqueIdentifier: string
   ): Observable<[CatalogRecord, string, boolean] | null> {
-    const draft$ = of(
-      window.localStorage.getItem(
-        this.getLocalStorageKeyForRecord(uniqueIdentifier)
-      )
-    )
-    const recordAsXml$ = this.loadRecordAsXml(uniqueIdentifier)
+    const draft$ = of(this.getRecordFromLocalStorage(uniqueIdentifier))
+    const recordAsXml$ = this.getRecordAsXml(uniqueIdentifier)
+
     return combineLatest([draft$, recordAsXml$]).pipe(
       switchMap(([draft, recordAsXml]) => {
         const xml = draft ?? recordAsXml
@@ -239,34 +217,27 @@ export class Gn4Repository implements RecordsRepositoryInterface {
   openRecordForDuplication(
     uniqueIdentifier: string
   ): Observable<[CatalogRecord, string, false] | null> {
-    return this.loadRecordAsXml(uniqueIdentifier).pipe(
-      switchMap(async (recordAsXml) => {
-        const converter = findConverterForDocument(recordAsXml)
-        const record = await converter.readRecord(recordAsXml)
+    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 xml = await converter.writeRecord(record, recordAsXml)
-        window.localStorage.setItem(
-          this.getLocalStorageKeyForRecord(record.uniqueIdentifier),
-          xml
+
+        const recordAsXml = await converter.writeRecord(
+          record,
+          fetchedRecordAsXml
         )
+
+        this.saveRecordToLocalStorage(recordAsXml, record.uniqueIdentifier)
         this._draftsChanged.next()
-        return [record, xml, false] as [CatalogRecord, string, false]
+
+        return [record, recordAsXml, false] as [CatalogRecord, string, false]
       })
     )
   }
 
-  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))
-  }
-
   saveRecord(
     record: CatalogRecord,
     referenceRecordSource?: string
@@ -301,6 +272,32 @@ export class Gn4Repository implements RecordsRepositoryInterface {
     )
   }
 
+  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)
   }
@@ -315,28 +312,19 @@ export class Gn4Repository implements RecordsRepositoryInterface {
   ): Observable<string> {
     return this.serializeRecordToXml(record, referenceRecordSource).pipe(
       tap((recordXml) => {
-        window.localStorage.setItem(
-          this.getLocalStorageKeyForRecord(record.uniqueIdentifier),
-          recordXml
-        )
+        this.saveRecordToLocalStorage(recordXml, record.uniqueIdentifier)
         this._draftsChanged.next()
       })
     )
   }
 
   clearRecordDraft(uniqueIdentifier: string): void {
-    window.localStorage.removeItem(
-      this.getLocalStorageKeyForRecord(uniqueIdentifier)
-    )
+    this.removeRecordFromLocalStorage(uniqueIdentifier)
     this._draftsChanged.next()
   }
 
   recordHasDraft(uniqueIdentifier: string): boolean {
-    return (
-      window.localStorage.getItem(
-        this.getLocalStorageKeyForRecord(uniqueIdentifier)
-      ) !== null
-    )
+    return this.getRecordFromLocalStorage(uniqueIdentifier) !== null
   }
 
   isRecordNotYetSaved(uniqueIdentifier: string): boolean {
@@ -356,4 +344,80 @@ export class Gn4Repository implements RecordsRepositoryInterface {
       )
     )
   }
+
+  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/platform/gn4-platform.service.ts

@@ -1,8 +1,9 @@
 import { Injectable } from '@angular/core'
 import { combineLatest, Observable, of, switchMap } from 'rxjs'
-import { catchError, map, shareReplay, tap } from 'rxjs/operators'
+import { catchError, filter, map, shareReplay, tap } from 'rxjs/operators'
 import {
   MeApiService,
+  RecordsApiService,
   RegistriesApiService,
   SiteApiService,
   ToolsApiService,
@@ -19,7 +20,7 @@ import {
 import { Gn4PlatformMapper } from './gn4-platform.mapper'
 import { ltr } from 'semver'
 import { LangService } from '../../../../../../../libs/util/i18n/src'
-import { HttpClient } from '@angular/common/http'
+import { HttpClient, HttpEventType } from '@angular/common/http'
 import {
   KeywordApiResponse,
   ThesaurusApiResponse,
@@ -77,7 +78,8 @@ export class Gn4PlatformService implements PlatformServiceInterface {
     private registriesApiService: RegistriesApiService,
     private langService: LangService,
     private userfeedbackApiService: UserfeedbackApiService,
-    private httpClient: HttpClient
+    private httpClient: HttpClient,
+    private recordsApiService: RecordsApiService
   ) {
     this.me$ = this.meApi.getMe().pipe(
       switchMap((apiUser) => this.mapper.userFromMeApi(apiUser)),
@@ -274,4 +276,46 @@ export class Gn4PlatformService implements PlatformServiceInterface {
       })
     )
   }
+
+  getRecordAttachments(recordUuid: string) {
+    return this.recordsApiService.getAllResources(recordUuid).pipe(
+      map((resources) =>
+        resources.map((r) => ({
+          url: new URL(r.url),
+          fileName: r.filename,
+        }))
+      )
+    )
+  }
+
+  attachFileToRecord(recordUuid: string, file: File) {
+    let sizeBytes = -1
+    return this.recordsApiService
+      .putResource(recordUuid, file, 'public', undefined, 'events', true)
+      .pipe(
+        map((event) => {
+          if (event.type === HttpEventType.UploadProgress) {
+            sizeBytes = event.total
+            return {
+              type: 'progress',
+              progress: event.total
+                ? Math.round((100 * event.loaded) / event.total)
+                : 0,
+            } as const
+          }
+          if (event.type === HttpEventType.Response) {
+            return {
+              type: 'success',
+              attachment: {
+                url: new URL(event.body.url),
+                fileName: event.body.filename,
+              },
+              sizeBytes,
+            } as const
+          }
+          return undefined
+        }),
+        filter((event) => !!event)
+      )
+  }
 }

package/src/libs/common/domain/src/lib/model/record/metadata.model.ts

@@ -115,7 +115,7 @@ export type ServiceProtocol =
   | 'ogcFeatures'
   | 'other'
 
-export type DatasetDistributionType = 'service' | 'download' | 'link'
+export type OnlineResourceType = 'service' | 'download' | 'link' | 'endpoint'
 
 export interface DatasetServiceDistribution {
   type: 'service'
@@ -146,12 +146,12 @@ export interface OnlineLinkResource {
   description?: string
 }
 
-export type DatasetDistribution = (
+export type DatasetOnlineResource = (
   | DatasetServiceDistribution
   | DatasetDownloadDistribution
   | OnlineLinkResource
 ) & {
-  type: DatasetDistributionType
+  type: OnlineResourceType
 }
 
 export interface GraphicOverview {
@@ -178,14 +178,12 @@ export interface DatasetRecord extends BaseRecord {
   kind: 'dataset'
   status: RecordStatus
   lineage: string // Explanation of the origin of this record (e.g: how, why)"
-  distributions: Array<DatasetDistribution>
+  onlineResources: Array<DatasetOnlineResource>
   spatialExtents: Array<DatasetSpatialExtent>
   temporalExtents: Array<DatasetTemporalExtent>
   spatialRepresentation?: SpatialRepresentationType
 }
 
-export type ServiceOnlineResourceType = 'endpoint' | 'link'
-
 export interface ServiceEndpoint {
   endpointUrl: URL
   protocol: string
@@ -194,7 +192,7 @@ export interface ServiceEndpoint {
 }
 
 export type ServiceOnlineResource = (ServiceEndpoint | OnlineLinkResource) & {
-  type: ServiceOnlineResourceType
+  type: OnlineResourceType
 }
 
 export interface ServiceRecord extends BaseRecord {
@@ -202,6 +200,8 @@ export interface ServiceRecord extends BaseRecord {
   onlineResources: Array<ServiceOnlineResource>
 }
 
+export type OnlineResource = DatasetOnlineResource | ServiceOnlineResource
+
 export type CatalogRecord = ServiceRecord | DatasetRecord
 
 export type CatalogRecordKeys = keyof ServiceRecord | keyof DatasetRecord

package/src/libs/common/domain/src/lib/platform.service.interface.ts

@@ -4,6 +4,21 @@ import type { Organization } from './model/record/organization.model'
 import { Keyword, UserFeedback } from './model/record'
 import { KeywordType } from './model/thesaurus'
 
+interface RecordAttachment {
+  url: URL
+  fileName: string
+}
+type UploadEvent =
+  | {
+      type: 'progress'
+      progress: number // in percent
+    }
+  | {
+      type: 'success'
+      attachment: RecordAttachment
+      sizeBytes: number
+    }
+
 export abstract class PlatformServiceInterface {
   abstract getType(): string
   abstract getApiVersion(): Observable<string>
@@ -15,7 +30,9 @@ export abstract class PlatformServiceInterface {
     organisation: Organization
   ): Observable<UserModel[]>
   abstract getOrganizations(): Observable<Organization[]>
+
   abstract translateKey(key: string): Observable<string>
+
   abstract searchKeywords(
     query: string,
     keywordTypes: KeywordType[]
@@ -25,6 +42,15 @@ export abstract class PlatformServiceInterface {
     query: string,
     thesaurusId: string
   ): Observable<Keyword[]>
+
   abstract getUserFeedbacks(recordUuid: string): Observable<UserFeedback[]>
   abstract postUserFeedbacks(recordUuid: UserFeedback): Observable<void>
+
+  abstract getRecordAttachments(
+    recordUuid: string
+  ): Observable<RecordAttachment[]>
+  abstract attachFileToRecord(
+    recordUuid: string,
+    file: File
+  ): Observable<UploadEvent>
 }

package/src/libs/common/domain/src/lib/repository/records-repository.interface.ts

@@ -52,6 +52,16 @@ export abstract class RecordsRepositoryInterface {
     referenceRecordSource?: string
   ): Observable<string>
 
+  /**
+   * Try to duplicate the external record from given url. If it suceed, then it will save the record as draft and return its temporary id.
+   *
+   * @param recordDownloadUrl
+   * @returns Observable<string>
+   */
+  abstract duplicateExternalRecord(
+    recordDownloadUrl: string
+  ): Observable<string>
+
   /**
    * @param uniqueIdentifier
    * @returns Observable<void> Returns when record is deleted