fix a bug for updating a document

Author: philippepons

repo/backend/update/delete_document.xqm

@@ -1,4 +1,4 @@
-xquery version "3.1";
+xquery version "4.0";
 
 (:~  
 : This module allows deleting a document to an existing collection.

repo/error/dots_error.xqm

@@ -48,7 +48,13 @@ declare function dots_error:metadata_mapping($dbName, $projectDirPath ) {
   )
 };
 
+declare function dots_error:fileProblem() {
+  error(xs:QName('fileProblem'), "* ❌ Error : file does not exist.")
+};
 
+declare function dots_error:noDocument($resourceId) {
+  error(xs:QName('noDocument'), concat("* ❌ Error : the document '", $resourceId, "' does not exist."))
+};
 
 
 

repo/utils_dots.xqm

@@ -1,12 +1,27 @@
 xquery version "4.0";
 
+
+(:~
+ : Module providing utility functions for DoTS.
+ : These functions facilitate the retrieval of TEI documents,
+ : metadata, paths, and identifiers from a BaseX database or import folder.
+: @version 1
+: @date 2025-06-30 
+: @author École nationale des chartes - Philippe Pons
+:)
+
 module namespace utils_dots = "utils_dots"; 
 
 import module namespace G = "globals";
 
 declare namespace dots = "https://github.com/chartes/dots/";
 declare namespace tei = "http://www.tei-c.org/ns/1.0";
 
+(:~
+ : This functions returns the DTS project identifier (dtsResourceId) for the root collection in the resources register of the given database. 
+ : @param $dbName the name of the BaseX database
+ : @return the project identifier (dtsResourceId)
+:)
 declare function utils_dots:getIdProject($dbName as xs:string) {
   normalize-space(db:get($dbName, $G:resourcesRegister)//dots:collection[not(@parentIds)]/@dtsResourceId)
 };
@@ -19,13 +34,24 @@ declare function utils_dots:getDbName($resourceId as xs:string) {
   normalize-space(db:get($G:dots)//dots:member/node()[@dtsResourceId = $resourceId]/@dbName)
 };
 
+(:~
+ : This function retrieves a TEI document from the database using its xml:id.
+ : @param $dbName the name of the database
+ : @param $resourceId the document identifier
+ : @return the TEI element
+:)
 declare function utils_dots:getDocument($dbName as xs:string, $resourceId as xs:string) {
   if (db:get($dbName)/tei:TEI[@xml:id = $resourceId])
   then db:get($dbName)/tei:TEI[@xml:id = $resourceId]
   else 
     db:get($dbName)/node() ! db:path(.)[ends-with(., $resourceId)]
 };
 
+(:~
+ : This function retrieves the document identifier (xml:id) from a file path.
+ : @param $docPath the path to the document file
+ : @return the resource ID (xml:id or filename)
+:)
 declare function utils_dots:findDocId($docPath) {
   let $document := utils_dots:findDocInFolder($docPath) 
   let $resourceId := $document/tei:TEI/@xml:id
@@ -44,6 +70,12 @@ declare function utils_dots:findDocInFolder($docPath) {
   doc($docPath)
 };
 
+(:~
+ : This function finds the path of a document in the database based on its identifier.
+ : @param $dbName the name of the database
+ : @param $resourceId the document identifier
+ : @return the database path to the document
+:)
 declare function utils_dots:findPath($dbName as xs:string, $resourceId as xs:string) {
   head((
     db:get($dbName)/*:TEI[@xml:id = $resourceId] ! db:path(.)
@@ -53,7 +85,7 @@ declare function utils_dots:findPath($dbName as xs:string, $resourceId as xs:str
 };
 
 (:~
- : Retrieves the document with the specified id.
+ : This function retrieves the document with the specified id.
  : @param $dbName name of database
  : @param $resourceId resource ID
  : @param $strip strip processing instructions (by default true)
@@ -101,20 +133,38 @@ declare function utils_dots:getDocInRegister($dbName as xs:string, $resourceId a
   db:get($dbName, $G:resourcesRegister)//dots:member/node()[@dtsResourceId = $resourceId]
 };
 
+(:~
+ : This function extracts all parent identifiers from the @parentIds attribute of a <document> element.
+ : @param $dbName the name of the database
+ : @param $docInRegister the <dots:document> element
+ : @return a sequence of parent identifiers
+:)
 declare function utils_dots:getParentIds($dbName as xs:string, $docInRegister as element(dots:document)) {
   for $parentId in tokenize($docInRegister/@parentIds, " ")
   return
     $parentId
 };
 
+(:~
+ : This function retrieves the root identifier of the DTS Collection endpoint.
+ : @return the root identifier as a string
+:)
 declare function utils_dots:getRootId() {
   normalize-space(db:get($G:dots)/dots:metadataMap/dots:root/dots:id)
 };
 
+(:~
+ : This function retrieves the root title of the DTS Collection endpoint.
+ : @return the root title as a string
+:)
 declare function utils_dots:getRootTitle() {
   normalize-space(db:get($G:dots)/dots:metadataMap/dots:root/dots:title)
 };
 
+(:~
+ : Retrieves the root description of the DTS Collection endpoint.
+ : @return the root description as a string
+:)
 declare function utils_dots:getRootDescription() {
   let $desc := db:get($G:dots)/dots:metadataMap/dots:root/dots:description
   return

scripts/add_document.xq

@@ -1,11 +1,6 @@
 xquery version '4.0' ;
 
 import module namespace script = "script";
-import module namespace functx = 'http://www.functx.com';
-import module namespace G = "globals";
-import module namespace add_doc = "backend/update/add_document";
-
-declare namespace dots = "https://github.com/chartes/dots/";
 
 declare variable $dbName external := ();
 declare variable $docPath external := ();

scripts/delete_document.xq

@@ -1,3 +1,4 @@
+xquery version '4.0' ;
 
 import module namespace script = "script";
 import module namespace del_doc = "backend/update/delete_document";
@@ -6,14 +7,13 @@ import module namespace utils_dots = "utils_dots";
 declare variable $dbName external := ();
 declare variable $docId external := ();
 
-
 let $doc := utils_dots:findPath($dbName, $docId)
 return
   if ($doc)
   then 
     (
       del_doc:handleDelete($dbName, $docId),
-      script:success(("Le document", $docId, " a bien été supprimé de la base ", $dbName, ".")) 
+      script:success(("Le document ", $docId, " a bien été supprimé de la base ", $dbName, ".")) 
     )
   else
-    script:error(concat("Le document", $docId, " n'existe pas."))
+    script:error(concat("Le document ", $docId, " n'existe pas."))

scripts/project_create.xq

@@ -1,3 +1,5 @@
+xquery version '4.0' ;
+
 import module namespace script = "script";
 
 declare variable $projectDirPath external := ();

scripts/update_document.xq

@@ -1,46 +1,31 @@
-xquery version "4.0";
+xquery version '4.0';
 
 import module namespace G = "globals";
 import module namespace utils_dots = "utils_dots";
 import module namespace script = "script";
-import module namespace add_doc = "backend/update/add_document";
-import module namespace del_doc = "backend/update/delete_document";
-import module namespace functx = 'http://www.functx.com';
+import module namespace dots_error = "error/dots_error"; 
 
 declare namespace dots = "https://github.com/chartes/dots/";
 
 declare variable $dbName external := ();
 declare variable $docPath external := ();
+declare variable $docId external := ();
 
 
-if (file:exists($docPath))
+if (db:exists($dbName))
 then
-  (
-    let $docId := utils_dots:findDocId($docPath)
-    let $doc := utils_dots:findPath($dbName, $docId)
-    return
-      if ($doc)
-      then 
-        (
-          del_doc:handleDelete($dbName, $docId),
-          let $parentIds := 
-            let $pathInData := substring-after($docPath, "data/")
-            let $pathCollection := functx:substring-before-last($pathInData, "/")
-            let $collectionId := if (contains($pathCollection, "/")) then functx:substring-after-last($pathCollection, "/") else $pathCollection
-            return
-              $collectionId 
-          return 
-              let $coll := if ($parentIds = "") then "project" else db:get($dbName, $G:resourcesRegister)//dots:collection[@dtsResourceId = $parentIds]
-              return
-                if ($parentIds = "project" or $coll)
-                then
-                  (
-                    add_doc:handleAddition($dbName, $docPath),
-                    script:success(("Le document '", $docId, "' a bien été mis à jour dans la base '", $dbName, "'.")) 
-                  )
-                 else script:error(concat("La collection '",  $coll, "' n'existe pas."))
-        )
-      else
-        script:error(concat("Le document '", $docId, "' n'existe pas.")))
-else
-  script:error("Le fichier n'existe pas.")
+  if (file:exists($docPath))
+  then
+    if (db:get($dbName, $G:resourcesRegister)//dots:document[@dtsResourceId = $docId])
+    then
+      for $script in ('../scripts/delete_document.xq', '../scripts/add_document_database.xq', '../scripts/add_document_fragments.xq', '../scripts/TEI_add_id.xq')
+      return script:execute(xs:anyURI($script), map {
+        'dbName': $dbName,
+        'docPath': $docPath,
+        'docId': $docId
+      }) 
+    else dots_error:noDocument($docId)
+  else dots_error:fileProblem()
+else dots_error:dbError($dbName)  
+  
+