Use file or project index instead of collection() where possible

Cf. #555

Author: dariok

README.md

@@ -6,11 +6,17 @@ This framework still lacks a good name. If you have an idea, please let me know!
 
 ## Incompatible changes
 
+Release 24Q4 dropped another set of functions that were unused:
+- `wdb:getEdFromFileID( $id as xs:string )`: `(wdbFiles:getFullPath($id))?projectPath` returns the base path to `wdbmeta.xml`
+- `wdb:getMetaElementFromEd ( $ed as xs:string )`: use `doc( (doc("/db/apps/edoc/index/project-index.xml")/id($ed))/@path || '/wdbmeta.xml' )/id($ed)[self::meta:projectMD]` instead
+- `wdb:getMetaFile( $pathToEd )`: `(wdbFiles:getFullPath($ed))?projectPath` returns the base path to `wdbmeta.xml`
+
 Release 24Q2 dropped functions `wdb:getEdPath( $ed as xs:string , $absolute as xs:boolean() )`,
 `wdb:getEdPath( $ed as xs:string )`, and `wdb:findProjectXQM( $project )`. These queries can be replaced by
 `(wdbFiles:getFullPath($id))` which returns a map with `projectPath` (the path to the project, i.e. the collection where
-`project.xqm` is stored), `collectionPath` (for the subcollection where a file is actually located), `mainProject` for
+`wdbmeta.xml`¹ is stored), `collectionPath` (for the subcollection where a file is actually located), `mainProject` for
 the path to the project containing `project.xqm`, and `fileName`.
+1) (24Q4): this corrects a typo as previous versions incorrectly read `project.xqm`.
 
 Release 24Q1 dropped support for METS-based projects. As METS files can have a number of very different ways of encoding
 information, especially when it comes to behaviours, native support is hard to achieve. At the same time, most

edoc/modules/app.xqm

@@ -538,17 +538,6 @@ declare function wdb:getAbsolutePath ( $ed as xs:string, $path as xs:string ) {
     else (wdbFiles:getFullPath($ed))?projectPath || "/" || $path
 };
 
-(:~
- : Return the ID of a project from a resource ID within the project
- : 
- : @param $id the ID of a resource within a project
- : @return the ID of the project
- :)
-declare function wdb:getEdFromFileId ($id as xs:string) as xs:string {
-  let $file := collection($wdb:data)/id($id)[self::meta:file]
-  return $file/ancestor::meta:projectMD/@xml:id
-};
-
 (: ~
  : Return the path to a project
  : 
@@ -677,27 +666,9 @@ declare function wdb:eval($function as xs:string, $cache-flag as xs:boolean, $ex
  : @return The path to the project 
  :)
 declare function wdb:getProjectPathFromId ( $ed as xs:string ) as xs:string {
-  let $md := collection($wdb:data)/id($ed)[self::meta:projectMD]
-
-  return xstring:substring-before-last(base-uri(($md)[1]), '/')
-};
-
-(:~
- : Get the meta data file from the ed path
- :)
-declare function wdb:getMetaFile($pathToEd) {
-  if ( doc-available($pathToEd||'/wdbmeta.xml') )
-    then $pathToEd || '/wdbmeta.xml'
-    else fn:error(fn:QName('https://github.com/dariok/wdbErr', 'wdbErr:wdb0003'))
-};
-
-(:~
- : Get the meta data file by project ID
- : 
- : @param $ed The project ID to be evaluated
- :)
-declare function wdb:getMetaElementFromEd ( $ed as xs:string ) as element() {
-  collection($wdb:data)/id($ed)[self::meta:projectMD]
+  if ( $ed = ( "", "data" ) )
+    then $wdb:data
+    else string( (doc("/db/apps/edoc/index/project-index.xml")/id($ed))/@path )
 };
 (: END GENERAL HELPER FUNCTIONS :)
 

edoc/modules/wdb-files.xqm

@@ -62,7 +62,9 @@ declare function wdbFiles:getAbsolutePath ( $path as attribute() ) as xs:anyURI
  : @throws wdbErr:wdb0001
 :)
 declare function wdbFiles:getFullPath ( $id as xs:string ) as map( xs:string, xs:string, xs:string?, xs:string? )? {
-  let $file := collection("/db")/id($id)
+  let $file-hint := doc("/db/apps/edoc/index/file-index.xml")/id($id)
+    , $project-hint := doc("/db/apps/edoc/index/project-index.xml")/id($id)
+    , $file := ( doc($file-hint/@project)/id($id), doc($project-hint/@path || "/wdbmeta.xml")/id($id) )
 
   return if ( count($file) = 0 ) then
       error(

edoc/rest/rest-coll.xql

@@ -181,12 +181,12 @@ function wdbRc:createFile ($data as xs:string*, $collection as xs:string, $heade
         then error (QName("https://github.com/dariok/wdbplus/errors", "wdbErr:h400"), "no Content Type declared for file")
       else ()
 
-    let $collectionFile := collection($wdb:data)/id($collection)[self::meta:projectMD]
+    let $collectionPath := wdb:getProjectPathFromId($collection)
+      , $collectionFile := doc($collectionPath || '/wdbmeta.xml')/*[self::meta:projectMD]
     let $err := if (not($collectionFile))
       then error (QName("https://github.com/dariok/wdbplus/errors", "wdbErr:h400"), "collection " || $collection || " not found", 404)
       else ()
-      
-    let $collectionPath := (wdbFiles:getFullPath($collection))?collectionPath
+    
     let $err := if (not(sm:has-access(xs:anyURI($collectionPath), "w")))
       then error (QName("https://github.com/dariok/wdbplus/errors", "wdbErr:h400"), "user " || $user || " has no access to write to collection " || $collectionPath, 403)
       else ()
@@ -311,14 +311,13 @@ declare
   %rest:GET
   %rest:path("/edoc/collection/full/{$id}.zip")
   %output:method("binary")
-function wdb:getResourcesZip ($id as xs:string) {
-  let $meta := collection($wdb:data)/id($id)[self::meta:projectMD]
-  let $base := substring-before(base-uri($meta), 'wdbmeta')
+function wdb:getResourcesZip ( $ed as xs:string ) {
+  let $base := wdb:getProjectPathFromId($ed)
 
-  return if ($meta = "")
-  then <rest:response>
-    <http:response status="404"/>
-      </rest:response>
+  return if ( $base = "" ) then
+    <rest:response>
+      <http:response status="404"/>
+    </rest:response>
   else (
     <rest:response>
       <http:response status="200">
@@ -408,9 +407,8 @@ declare
     %rest:GET
     %rest:path("/edoc/collection/{$ed}/nav.xml")
 function wdbRc:getCollectionNavXML ( $ed as xs:string ) {
-  let $md := collection($wdb:data)/id($ed)[self::meta:projectMD]
-    , $uri := base-uri($md)
-    , $struct := $md/meta:struct
+  let $md := doc(wdb:getProjectPathFromId($collection) || '/wdbmeta.xml')
+    , $struct := $md//meta:struct
 
   let $content := <struct xmlns="https://github.com/dariok/wdbplus/wdbmeta" ed="{$ed}">{(
       $struct/@*,
@@ -510,30 +508,27 @@ function wdbRc:getCollectionNavHTML ( $ed as xs:string, $externalModel as map(*)
     )
 };
 
-declare function wdbRc:getGeneral ($id, $mt, $content) {
+declare function wdbRc:getGeneral ( $ed as xs:string, $mt as xs:string+, $content as xs:string ) as item()+ {
   let $wdbRc:acceptable := ("application/json", "application/xml")
 
   let $content := if ( $mt = $wdbRc:acceptable ) then
     try {
-      let $path := wdb:getProjectPathFromId($id)
-        , $meta := doc(wdb:getMetaFile($path))
+      let $meta := doc(wdb:getProjectPathFromId($ed) || '/wdbmeta.xml')
 
-      return if ( $meta/*[self::meta:projectMD] ) then
-        let $eval := wdb:eval ( $content, false(), (xs:QName("meta"), $meta))
+      return if ( count($meta) = 0 )
+      then
+        ( 404, "no collection with ID " || $ed )
+      else
+        let $eval := wdb:eval($content, false(), (xs:QName("meta"), $meta))
 
         return if ( count($eval) gt 0 ) then (
           200,
-          <collection id="{$id}">{
+          <collection id="{$ed}">{
             $eval
           }</collection>
         )
         else
           ( 204, "" )
-      else
-        ( 400, "no a wdbmeta project" )
-    }
-    catch *:wdb0200 {
-      ( 404, "no collection with ID " || $id )
     }
     catch * {
       ( 400, "" )

edoc/rest/rest-entity.xql

@@ -70,9 +70,9 @@ declare
     %rest:path("/edoc/entities/scan/{$type}/{$collection}.html")
     %rest:query-param("q", "{$q}")
     %output:method("html")
-function wdbRe:scanHtml ($collection as xs:string, $type as xs:string, $q as xs:string*) {
-  let $md := collection($wdb:data)//id($collection)[self::meta:projectMD]
-    , $coll := (wdbFiles:getFullPath($collection))?projectPath
+function wdbRe:scanHtml ( $collection as xs:string, $type as xs:string, $q as xs:string* ) as item()+ {
+  let $coll := (wdbFiles:getFullPath($collection))?projectPath
+    , $md := doc($coll || '/wdbmeta.xml')/*[self::meta:projectMD]
     , $xsl := wdbRCo:getXSLT($coll, 'entity.xsl')
 
   let $params := <parameters>
@@ -124,9 +124,9 @@ declare
     %rest:path("/edoc/entities/collection/{$collection}/{$type}/{$ref}.html")
     %rest:query-param("start", "{$start}", 1)
     %output:method("html")
-function wdbRe:collectionEntityHtml ($collection as xs:string*, $type as xs:string*, $ref as xs:string*, $start as xs:int*) {
-  let $md := collection($wdb:data)//id($collection)[self::meta:projectMD]
-    , $coll := (wdbFiles:getFullPath($collection))?projectPath
+function wdbRe:collectionEntityHtml ( $collection as xs:string*, $type as xs:string*, $ref as xs:string*, $start as xs:int* ) as item()+ {
+  let $coll := (wdbFiles:getFullPath($collection))?projectPath
+    , $md := doc($coll || '/wdbmeta.xml')/*[self::meta:projectMD]
     , $xsl := wdbRCo:getXSLT($coll, 'entity.xsl')
 
   let $params := <parameters>

edoc/rest/rest-files.xql

@@ -2,7 +2,6 @@ xquery version "3.1";
 
 module namespace wdbRf = "https://github.com/dariok/wdbplus/RestFiles";
 
-import module namespace console  = "http://exist-db.org/xquery/console"            at "java:org.exist.console.xquery.ConsoleModule";
 import module namespace json     = "http://www.json.org";
 import module namespace wdb      = "https://github.com/dariok/wdbplus/wdb"         at "/db/apps/edoc/modules/app.xqm";
 import module namespace wdbFiles = "https://github.com/dariok/wdbplus/files"       at "/db/apps/edoc/modules/wdb-files.xqm";
@@ -188,10 +187,10 @@ declare
 function wdbRf:getResource ( $id as xs:string, $modified as xs:string* ) {
   (: Admins are advised by the documentation they REALLY SHOULD NOT have more than one entry for every ID
    : To be on the safe side, we go for the first one anyway :)
-  let $files := collection($wdb:data)//id($id)[self::meta:file]
+  let $file-hint := doc("/db/apps/edoc/index/file-index.xml")/id($id)
+    , $file := doc($file-hint/@project)/id($id)
     , $collectionPath := (wdbFiles:getFullPath($id))?collectionPath
-    , $f := $files[1]
-    , $path := $collectionPath || '/' || $f/@path
+    , $path := $collectionPath || '/' || $file/@path
     , $readable := sm:has-access($path, "r")
 
   let $doc := if ( not($readable) ) then
@@ -216,7 +215,7 @@ function wdbRf:getResource ( $id as xs:string, $modified as xs:string* ) {
     else
       "binary"
 
-  let $respCode := if ( count($files) = 0 ) then
+  let $respCode := if ( count($file) = 0 ) then
       404
     else if ( not($readable) ) then
       401
@@ -460,7 +459,7 @@ declare function wdbRf:processXSL( $id as xs:string, $process as element(), $mod
     } catch * {
       ("error",
         $err:description,
-        console:log("Processing " || $id || ": " || $err:description))
+        util:log("error", "Processing " || $id || ": " || $err:description))
     }
 
   return if ($content[1] = "error")

edoc/rest/rest-search.xql

@@ -88,8 +88,8 @@ function wdbRs:collectionHtml ( $ed as xs:string*, $q as xs:string*, $start as x
     "Error: no query content!"
   )
   else 
-    let $md := collection($wdb:data)//id($ed)[self::meta:projectMD]
-      , $coll := (wdbFiles:getFullPath($ed))?projectPath
+    let $coll := wdbFiles:getProjectPathFromId($ed)
+      , $md := doc($coll || '/wdbmeta.xml')/*[self::meta:projectMD]
       , $xsl := wdbRCo:getXSLT($coll, 'search.xsl')
 
     let $params := 

wdbplus.code-workspace

@@ -8,6 +8,6 @@
       }
    ],
    "settings": {
-      "window.title": "${dirty}${activeEditorShort}${separator}${rootName}${separator}${profileName}${separator}${appName}${separator}[Branch: 24Q3]"
+      "window.title": "${dirty}${activeEditorShort}${separator}${rootName}${separator}${profileName}${separator}${appName}${separator}[Branch: 24Q4]"
    }
 }