add and correct update scripts

Author: philippepons

repo/backend/update/add_collection.xqm

@@ -9,6 +9,12 @@ import module namespace resources = "backend/resources_register_builder";
 
 declare namespace dots = "https://github.com/chartes/dots/";
 
+declare updating function add_coll:handleAddition($dbName as xs:string, $resourceId as xs:string, $parentId as xs:string := "") {
+  add_coll:addCollToResourcesReg($dbName, $resourceId, $parentId),
+  add_coll:updateMaxCiteDepthCollection($dbName, $parentId),
+  add_coll:addCollToSwitcherDots($dbName, $resourceId)
+};
+
 declare updating function add_coll:addCollToResourcesReg($dbName as xs:string, $resourceId as xs:string, $parentId as xs:string := "") {
   let $csv := resources:getCSV-map($dbName, $resourceId)
   let $parent := if ($parentId) then $parentId else utils_dots:getIdProject($dbName)
@@ -18,4 +24,31 @@ declare updating function add_coll:addCollToResourcesReg($dbName as xs:string, $
       <collection xmlns="https://github.com/chartes/dots/" dtsResourceId="{$resourceId}" totalChildren="0" parentIds="{$parent}">{
         resources:getCollectionMetadata($dbName, $resourceId, $csv)
       }</collection> as last into $resources_register
+};
+
+(:~ Update function to increment the number of documents in a collection
+: @param $dbName     db name
+: @param $parentIds  identifier of the collection to update
+: @return updating the value of the @totalChildren attribute in a <collection/> node.
+:)
+declare updating %private function add_coll:updateMaxCiteDepthCollection($dbName as xs:string, $parentIds as xs:string) {
+  let $idParentColl := if ($parentIds = "") then utils_dots:getIdProject($dbName) else $parentIds
+  let $parent := db:get($dbName, $G:resourcesRegister)//dots:collection[@dtsResourceId = $idParentColl]
+  let $totalChildren := $parent/@totalChildren
+  return
+     if ($parent != "")
+     then replace value of node $totalChildren with xs:integer($parent/@totalChildren) + 1
+     else 
+       update:output("La collection parente n'existe pas.")
+};
+
+(:~ Update function to add the collection to the switcher dots
+: @param  $dbName         db name
+: @param  $dtsResourceId  identifier of the collection
+: @return <document/> node
+:)
+declare updating function add_coll:addCollToSwitcherDots($dbName as xs:string, $dtsResourceId as xs:string) {
+  let $switcher := db:get($G:dots, $G:dbSwitcher)//dots:member
+  return
+    insert node <collection dtsResourceId="{$dtsResourceId}" dbName="{$dbName}"/> as last into $switcher
 };

repo/backend/update/add_document.xqm

@@ -15,6 +15,7 @@ import module namespace G = "globals";
 import module namespace dots_error = "error/dots_error";
 import module namespace resources = "backend/resources_register_builder";
 import module namespace fragments = "backend/fragments_register_builder";
+import module namespace dots.update = "backend/TEI_add_id";
 import module namespace script = "script";
 
 declare namespace dots = "https://github.com/chartes/dots/";
@@ -28,7 +29,8 @@ declare updating function add_doc:handleAddition($dbName, $docPath) {
   (
     add_doc:addDocToDB($dbName, $docPath),
     add_doc:addDocToResourcesReg($dbName, $docPath, $csv),
-    add_doc:addFragInReg($dbName, $docPath, $csv-frag)
+    add_doc:addFragInReg($dbName, $docPath, $csv-frag),
+    dots.update:addXmlIdToFragment($dbName)
   )
 };
 

repo/backend/update/delete_collection.xqm

@@ -11,12 +11,17 @@ xquery version "4.0";
 
 module namespace del_coll = "backend/update/delete_collection";
 
+import module namespace functx = 'http://www.functx.com';
 import module namespace utils_dots = "utils_dots"; 
 import module namespace G = "globals";
 import module namespace del_doc = "backend/update/delete_document";
+import module namespace resources = "backend/resources_register_builder";
+import module namespace fragments = "backend/fragments_register_builder";
 
 declare default element namespace "https://github.com/chartes/dots/";
 
+declare namespace tei = "http://www.tei-c.org/ns/1.0";
+
 (:~ This function allows deleting a collection from the DTS resource registry in the BaseX database. 
 : It removes the collection node, updates the parent collection's child count, 
 : handles child documents (deletion or reassignment), and updates the DoTS switcher.
@@ -26,14 +31,14 @@ declare default element namespace "https://github.com/chartes/dots/";
 :                         if false, reassign them to the parent collection
 : @return database updates (delete node, update attributes, trigger document deletion or reassignment)
 :)
-declare updating function del_coll:handleDeleteColl($dbName as xs:string, $collectionId as xs:string, $option as xs:boolean) {
+declare updating function del_coll:handleDeleteColl($dbName as xs:string, $collectionId as xs:string, $option) {
   let $collection := db:get($dbName, $G:resourcesRegister)//member/collection[@dtsResourceId = $collectionId]
   let $docInColl := db:get($dbName, $G:resourcesRegister)//member/document[tokenize(@parentIds) = $collectionId]
   let $parentId := $collection/@parentIds
   return
     (
       delete node $collection,
-      del_coll:changeParentTotalChildren($dbName, $parentId, count($docInColl)),
+      del_coll:changeParentTotalChildren($dbName, $parentId, if ($option ="true") then 0 else count($docInColl)),
       del_doc:updateSwitcherDots($dbName, $collectionId)
     )
 };
@@ -62,22 +67,52 @@ declare updating %private function del_coll:changeParentTotalChildren($dbName as
  : @param $option        boolean: true = delete documents; false = reassign to parent
  : @return database updates (delete or reassign documents)
 :)
-declare updating function del_coll:handleDocInColl($dbName as xs:string, $collectionId as xs:string, $option as xs:boolean) {
+declare updating function del_coll:handleDocInColl($dbName as xs:string, $collectionId as xs:string, $option) {
+  let $csv := resources:getCSV-map($dbName, "fragment")
   for $document in db:get($dbName, $G:resourcesRegister)//document[tokenize(@parentIds) = $collectionId]
   let $resourceId := $document/@dtsResourceId
   let $pathDoc := utils_dots:findPath($dbName, $resourceId)
   let $parentDoc := $document/@parentIds
   let $parentCollId := db:get($dbName, $G:resourcesRegister)//collection[@dtsResourceId = $collectionId]/@parentIds
   return
-    (
-      replace value of node $parentDoc with replace($parentDoc, $collectionId, $parentCollId),
-      db:delete($dbName, $pathDoc),
-      db:put($dbName, $document, replace($pathDoc, concat($collectionId, "/"), "/"))
-    )
+    if ($option = "true")
+    then 
+      (
+        delete node $document,
+        delete nodes db:get($dbName, $G:fragmentsRegister)//fragment[@resourceId = $resourceId],
+        db:delete($dbName, $pathDoc)
+      )
+    else
+      (
+        delete nodes db:get($dbName, $G:fragmentsRegister)//fragment[@resourceId = $resourceId],
+        replace value of node $parentDoc with replace($parentDoc, $collectionId, $parentCollId),
+        db:delete($dbName, $pathDoc),
+        db:put($dbName, utils_dots:findPathDoc($dbName, $resourceId), replace($pathDoc, concat($collectionId, "/"), "/")),
+        del_coll:addFragInReg($dbName, $resourceId, utils_dots:getDocument($dbName, $resourceId), $csv)
+      )
 };
 
-
-
+(:~  Update function to add `<fragment/>` nodes to the fragments register (`dots/fragments_register`).
+: @param $dbName  db name
+: @param $docPath absolute path to the document to add
+: @return sequence of <fragment/> nodes
+:)
+declare updating %private function del_coll:addFragInReg($dbName as xs:string, $resourceId as xs:string, $document, $csv) {
+  let $maxCiteDepth := fragments:getMaxCiteDepth($document//tei:refsDecl, 0)
+  for $citeStructurePosition in $document//tei:refsDecl/tei:citeStructure
+  return 
+    let $fragments_register := db:get($dbName, $G:fragmentsRegister)//member
+    let $fragment := fragments:handleCiteStructure($dbName, $document, "", $citeStructurePosition, 1, $resourceId, "", "", $maxCiteDepth, $csv)
+    let $oldFragments := $fragments_register/fragment[@resourceId = $resourceId]
+    return
+      if ($oldFragments)
+      then
+        (
+          delete nodes $oldFragments,
+          insert node $fragment as last into $fragments_register
+        )
+      else insert node $fragment as last into $fragments_register
+};
 
 
 

repo/backend/update/update_document_content.xqm

@@ -19,6 +19,22 @@ declare function utils_dots:getDbName($resourceId as xs:string) {
   normalize-space(db:get($G:dots)//dots:member/node()[@dtsResourceId = $resourceId]/@dbName)
 };
 
+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)]
+};
+
+declare function utils_dots:findDocId($docPath) {
+  let $document := utils_dots:findDocInFolder($docPath) 
+  let $resourceId := $document/tei:TEI/@xml:id
+  return
+    if ($resourceId)
+    then $resourceId
+    else file:name($docPath)
+};
+
 (:~ This function allows retrieving the document with the $resourceId identifier in the import folder $project_dir_path
 : @param $resourceId             document identifier
 : @param $project_dir_path  absolute path to the data import folder

repo/utils_dots.xqm

@@ -14,31 +14,50 @@ function usage {
     echo ""
     echo "Add a new collection to an existing DoTS project"
     echo ""
-    echo "usage: $programname --db_name string --doc_path string "
+    echo "usage: $programname --basex_path string --db_name string --collection_id string"
     echo ""
+    echo "  --basex_path string     absolute path to the basex folder 'bin'"
+    echo "                          (example: /absolute/path/to/basex/bin)"
     echo "  --db_name string        basex project db name"
     echo "                          (example: theater)"
-    echo "  --collection_id string  collection identifier"
+    echo "  --collection_id string  identifier of the collection"
     echo "                          "
-    echo "  --basex_path string     absolute path to the basex folder 'bin'"
-    echo "                          (example: /absolute/path/to/basex/bin)"
-    echo ""
+    echo "  [--parent_id] string    by default (top_collection_id) : identifier of the parent collection"
+    echo "                          "
+    echo "  [--unit_test] boolean   by default (false) true: launch unit tests"
+    echo "                          (example: false)"echo ""
 }
 
 function die {
     printf "Script failed: %s\n\n" "$1"
     exit 1
 }
 
-if [[ -z $db_name ]]; then
+if [[ -z $basex_path ]]; then
     usage
-    die "Missing parameter --db_name"
-elif [[ -z $collection_id string ]]; then
+    die "Missing parameter --basex_path"
+elif [[ -z $db_name ]]; then
     usage
-    die "Missing parameter --collection_id string"
-elif [[ -z $basex_path ]]; then
+    die "Missing parameter --db_name"
+elif [[ -z $collection_id ]]; then
     usage
-    die "Missing parameter --basex_path"
+    die "Missing parameter --collection_id"
+fi
+
+bash "$basex_path/basex" -b dbName=$db_name -b resourceId=$collection_id -b parentId=$parent_id  scripts/add_collection.xq;
+
+if [[ $unit_test == 'true' ]]; then
+  bash "$basex_path/basex" -b dbName=$db_name -t tests/project_create/project_registers_create_test.xq;
+  bash "$basex_path/basex" -b dbName=$db_name -t tests/project_create/TEI_add_id_test.xq;
+  bash "$basex_path/basex" -b dbName=$db_name -t tests/project_create/dots_switcher_update_test.xq;
 fi
 
-bash "$basex_path/basex" -b dbName=$db_name -b docPath=$doc_path scripts/add_collection.xq
+
+
+
+
+
+
+
+
+

scripts/add_collection.sh

@@ -22,13 +22,13 @@ return
         if ($collParent)
         then
           (
-            add_coll:addCollToResourcesReg($dbName, $resourceId, $parentId),
+            add_coll:handleAddition($dbName, $resourceId),
             script:success(concat("La collection '", $resourceId, "', sous-collection de '", $parentId, "', a bien été ajouté à la db ", $dbName, "."))
           )
         else script:error(concat("La collection parente '", $parentId, "' n'existe pas."))
     else 
       (
-        add_coll:addCollToResourcesReg($dbName, $resourceId),
+        add_coll:handleAddition($dbName, $resourceId),
         script:success(concat("La collection '", $resourceId, "' a bien été ajouté à la db ", $dbName, "."))
       )