Release 4.0

.gitignore

@@ -14,6 +14,7 @@ __pycache__/
 # internal
 edoc/resources/xsl/xspec/
 .existdb.json
+edoc/rest2/v2.json
 
 # node-reladted stuff
 node_modules/

README.md

@@ -6,6 +6,47 @@ This framework still lacks a good name. If you have an idea, please let me know!
 
 ## Incompatible changes
 
+### 25Q3
+
+Release 25Q3 dropped support for more unsued functions:
+- `wdb:getFilePath ( $id as xs:string )`: use the map from `wdbFiles:getFullPath` instead
+- the default layout of all `resources` collections has changed to group files by type. This also affects the main
+  project specific overrides, i.e. `project.js` and `project.css`. An XQuery is provided to move all files to their
+  appropriate new locations (TODO: add file name here).
+  This also affects `edoc/data/resources` and `edoc/resources` so you might have to change imports manually if you make
+  use of any file in these collections.
+
+Changes in standard behaviour
+- sub-projects will now make use of process inheritance; i.e., they only define empty `processes` with no `command`. A
+  `command` is then picked by traversing up through parent `wdbmeta.xml` (i.e., one that is pointed to by a
+  `struct/import`; worst case: data). This way, you can still have  different `command` defined for sub-projects (and
+  their children) but do not need to change the path for every sub-project.
+- as part of this, no XSLTs are being copied to `{$subproject}/resources` as inheritance is now the standard. This way,
+  surplus XSLTs do not have to be deleted or kept up to date. As said above, it is still possible to create a `command`
+  for this sub-project tree and create specific XSLTs (usually by including the main XSLTs)
+- standard XSLTs for a new project are now bare: they only include `/edoc/data/resources/xslt/{$currentFileName}`, and
+  `tei-common.xsl` (unless it’s common itself).
+
+### 24Q4
+
+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`
+- `wdb:getProjectPathFromId ( $ed )`:  use `(wdbFiles:getFullPath($ed))?projectPath` instead
+
+### 24Q2
+
+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
+`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`.
+
+### 24Q1
+
 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
 installations use wdb+’s native wdbmeta system as this is what the admin functions work with.
@@ -64,9 +105,11 @@ into `/db/apps/edoc` and want to put your projects into `/db/apps/edoc/data/your
         <files>
             <file path="pathTo.xml" xml:id="xml-id" />
         </files>
-        <process target="html">
-            <command type="xsl">/db/apps/edoc/resources/xsl/tei-transcript.xsl</command>
-        </process>
+        <processes>
+            <process target="html">
+                <command type="xsl">/db/apps/edoc/resources/xsl/tei-transcript.xsl</command>
+            </process>
+        </processes>
         <struct label="1722" order="1722">
             <view file="xml-id" label="Title of File" />
         </struct>
@@ -96,5 +139,12 @@ See the Wiki for details!
 * Akademie der Wissenschaften, Heidelberg
   * Theologenbriefwechsel
 * ULB Darmstadt
+  * TUEditions
+  * WDM
 
 If you use wdbplus for your editions, please drop me a message so I can add you to this list.
+
+## Sponsoring
+
+Development of wdb+ is chiefly done in projects funded by DFG and the German BMBF.
+Additionally, we would like to say thank you to BrowserStack for giving us sponsored access!

build.xml

@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project>
-  <xmlproperty file="edoc/expath-pkg.xml"/>
-
-  <target name="clean">
-    <delete dir="edoc/build/" />
-    <delete dir="build" />
-  </target>
-
-  <target name="compile" depends="clean">
-    <ant dir="edoc" antfile="build.xml" />
-    <move file="edoc/build" tofile="build" />
-  </target>
-
-  <target name="docker" depends="compile">
-    <copy file="build/${package(abbrev)}-${package(version)}.xar" tofile="docker/wdb.xar" />
-    <exec executable="docker" dir="docker">
-      <arg value="build" />
-      <arg value="--tag=wdbplus" />
-      <arg value="." />
-    </exec>
-  </target>
+   <xmlproperty file="edoc/expath-pkg.xml"/>
+   <property name="project.version" value="${package(version)}"/>
+   <property name="project.app" value="wdb"/>
+   <property name="build.dir" value="build"/>
+
+   <target name="clean">
+      <delete dir="build" />
+   </target>
+
+   <target name="compile" depends="clean">
+      <ant dir="edoc" antfile="build.xml" />
+      <move file="edoc/build" tofile="build" />
+   </target>
+
+   <target name="docker" depends="compile">
+      <copy file="build/${package(abbrev)}-${package(version)}.xar" tofile="docker/wdb.xar" />
+      <exec executable="docker" dir="docker">
+         <arg value="build" />
+         <arg value="--tag=wdbplus" />
+         <arg value="." />
+      </exec>
+   </target>
 </project>

edoc/admin/admin.xqm

@@ -2,46 +2,26 @@ xquery version "3.1";
 
 module namespace wdbAdmin = "https://github.com/dariok/wdbplus/Admin";
 
-import module namespace console   = "http://exist-db.org/xquery/console"       at "java:org.exist.console.xquery.ConsoleModule";
-import module namespace templates = "http://exist-db.org/xquery/html-templating";
-import module namespace wdb       = "https://github.com/dariok/wdbplus/wdb"    at "/db/apps/edoc/modules/app.xqm";
-import module namespace wdbErr    = "https://github.com/dariok/wdbplus/errors" at "/db/apps/edoc/modules/error.xqm";
+import module namespace config   = "https://github.com/dariok/wdbplus/config" at "../modules/wdb-config.xqm";
+import module namespace wdbErr   = "https://github.com/dariok/wdbplus/errors" at "../modules/error.xqm";
+import module namespace wdbFiles = "https://github.com/dariok/wdbplus/files"  at "../modules/wdb-files.xqm";
+import module namespace wdbm     = "https://github.com/dariok/wdbplus/model"  at "../modules/model.xqm";
 
-declare namespace meta = "https://github.com/dariok/wdbplus/wdbmeta";
-declare namespace sm   = "http://exist-db.org/xquery/securitymanager";
+declare namespace meta      = "https://github.com/dariok/wdbplus/wdbmeta";
+declare namespace sm        = "http://exist-db.org/xquery/securitymanager";
+declare namespace templates = "http://exist-db.org/xquery/html-templating";
+declare namespace wdb       = "https://github.com/dariok/wdbplus/wdb";
 
 (:~
- : populate the model for functions pages (similar but not identical to wdb:populateModel)
+ : populate the model for admin pages
  : 
  : @param $ed The ID of a _project_
  : @return    The model
  :)
 declare
-    %templates:default("ed", "")
-function wdbAdmin:start ( $node as node(), $model as map(*), $ed as xs:string ) {
-  try {
-    let $pathToEd := if ( $ed = "" )
-      then $wdb:data
-      else wdb:getEdPath($ed, true())
-
-    (: The meta data are taken from wdbmeta.xml :)
-    let $infoFileLoc := wdb:getMetaFile($pathToEd)
-      , $title := normalize-space((doc($infoFileLoc)//meta:title)[1])
-
-    return map {
-      "ed":          if ( $pathToEd = $wdb:data ) then "data" else $ed,
-      "infoFileLoc": $infoFileLoc,
-      "page":        substring-after(request:get-uri(), "admin/"),
-      "pathToEd":    $pathToEd,
-      "title":       $title,
-      "auth":        sm:id()/sm:id
-    }
-  } catch * {
-    util:log("error", "No collection found for project ID " || $ed),
-    map {
-      "ed": ""
-    }
-  }
+    %templates:default("ed", "data")
+function wdbAdmin:start ( $node as node(), $model as map(*), $ed as xs:string ) as item()* {
+  wdbm:populateModel((), $ed, "", "", "")
 };
 
 declare function wdbAdmin:getEd ( $node as node(), $model as map(*) ) as element(meta) {
@@ -89,10 +69,10 @@ declare function wdbAdmin:getAside ($node as node(), $model as map(*)) as elemen
 };
 
 declare function wdbAdmin:css ( $node as node(), $model as map(*) ) as element()* {
-  if ( unparsed-text-available($wdb:data || "/resources/wdb.css") )
-    then <link rel="stylesheet" type="text/css" href="../data/resources/wdb.css" />
+  if ( unparsed-text-available($config:data || "/resources/css/wdb.css") )
+    then <link rel="stylesheet" type="text/css" href="../data/resources/css/wdb.css" />
     else (),
-  if ( unparsed-text-available($wdb:data || "/resources/admin.css") )
-    then <link rel="stylesheet" type="text/css" href="../data/resources/admin.css" />
+  if ( unparsed-text-available($config:data || "/resources/css/admin.css") )
+    then <link rel="stylesheet" type="text/css" href="../data/resources/css/admin.css" />
     else ()
 };

edoc/admin/global.xqm

@@ -1,22 +1,19 @@
-xquery version "3.0";
+xquery version "3.1";
 
 module namespace wdbGS = "https://github.com/dariok/wdbplus/GlobalSettings";
 
-import module namespace wdb      = "https://github.com/dariok/wdbplus/wdb" at "../modules/app.xqm";
-import module namespace console  = "http://exist-db.org/xquery/console";
+import module namespace config = "https://github.com/dariok/wdbplus/config" at "../modules/wdb-config.xqm";
 
-declare namespace config = "https://github.com/dariok/wdbplus/config";
 declare namespace exgit  = "http://exist-db.org/xquery/exgit";
 declare namespace meta   = "https://github.com/dariok/wdbplus/wdbmeta";
 declare namespace system = "http://exist-db.org/xquery/system";
 
-declare function wdbGS:getRest ( $node as node(), $model as map(*) ) {
-  <meta name="rest" content="{$wdb:restURL}" />
+declare function wdbGS:getRest ( $node as node(), $model as map(*) ) as element(meta) {
+  <meta name="rest" content="{ $config:restURL }" />
 };
 
 declare function wdbGS:body ( $node as node(), $model as map(*) ) {
   let $param := request:get-parameter('job', 'main')
-  let $metaFile := doc('../config.xml')
 
   return switch ( $param )
     case 'main' return
@@ -32,24 +29,24 @@ declare function wdbGS:body ( $node as node(), $model as map(*) ) {
       </div>
 
     case 'title' return
-      local:titleForm($metaFile)
+      local:titleForm($config:configFile)
 
     case 'chgTitle' return
-      let $u1 := update replace $metaFile//config:meta/config:name
+      let $u1 := update replace $config:configFile//config:meta/config:name
         with <name xmlns="https://github.com/dariok/wdbplus/config">{request:get-parameter('longTitle', '')}</name>
-      let $u1 := update replace $metaFile//config:meta/config:short
+      let $u1 := update replace $config:configFile//config:meta/config:short
         with <short xmlns="https://github.com/dariok/wdbplus/config">{request:get-parameter('shortTitle', '')}</short>
-      return local:titleForm($metaFile)
+      return local:titleForm($config:configFile)
 
     case 'role' return
-      local:roleForm($metaFile)
+      local:roleForm($config:configFile)
 
     case 'chgRole' return
-      let $u1 := update replace $metaFile//config:role/config:type
+      let $u1 := update replace $config:configFile//config:role/config:type
         with <type xmlns="https://github.com/dariok/wdbplus/config">{request:get-parameter('role', '')}</type>
-      let $u1 := update replace $metaFile//config:role/config:other
+      let $u1 := update replace $config:configFile//config:role/config:other
         with <other xmlns="https://github.com/dariok/wdbplus/config">{request:get-parameter('other', '')}</other>
-      return local:roleForm($metaFile)
+      return local:roleForm($config:configFile)
 
     default return
       <div>
@@ -58,23 +55,23 @@ declare function wdbGS:body ( $node as node(), $model as map(*) ) {
       </div>
 };
 
-declare function local:titleForm($metaFile) {
+declare function local:titleForm($config:configFile) {
   <div>
     <h3>Titeldaten verändern</h3>
     <form action="global.html">
       <input type="hidden" name="job" value="chgTitle" />
       <label style="width: 100%">Titel: <input type="text" name="longTitle"
-        value="{$metaFile//config:meta/config:name}" /></label><br />
+        value="{$config:configFile//config:meta/config:name}" /></label><br />
       <label style="width: 100%">Kurztitel: <input type="text" name="shortTitle"
-        value="{$metaFile//config:meta/config:short}" /></label><br />
+        value="{$config:configFile//config:meta/config:short}" /></label><br />
       <input type="submit" />
     </form>
   </div>
 };
 
-declare function local:roleForm($metaFile) {
-  let $role := $metaFile//config:role/config:type
-  let $other := $metaFile//config:role/config:other
+declare function local:roleForm($config:configFile) {
+  let $role := $config:configFile//config:role/config:type
+  let $other := $config:configFile//config:role/config:other
 
   return
   <div>
@@ -85,7 +82,7 @@ declare function local:roleForm($metaFile) {
         <select name="role">
           <option value="standalone">{if ($role = 'standalone') then attribute selected {'selected'} else () }Standalone</option>
           <option value="workbench">{if ($role = 'workbench') then attribute selected {'selected'} else () }Workbench</option>
-          <option value="publisher">{if ($role = 'publisher') then attribute selected {'selected'} else ()}Publikationsumgebung</option>
+          <option value="publisher">{if ($role = 'publisher') then attribute selected {'selected'} else () }Publikationsumgebung</option>
         </select>
       </label><br />
       <label>zugehörige Instanz: <input type="text" name="other" value="{$other}" /></label><br />
@@ -95,5 +92,5 @@ declare function local:roleForm($metaFile) {
 };
 
 declare function wdbGS:ingest($node as node(), $model as map(*)) {
-  <a href="directoryForm.html?ed={doc($wdb:data || '/wdbmeta.xml')/meta:projectMD/@xml:id}">bestehendes Projekt hochladen</a>
-};
+  <a href="directoryForm.html?ed={doc($config:data || '/wdbmeta.xml')/meta:projectMD/@xml:id}">bestehendes Projekt hochladen</a>
+};

edoc/admin/modelFunctions.xql

@@ -2,6 +2,9 @@ xquery version "3.1";
 
 module namespace trigger="http://exist-db.org/xquery/trigger";
 
+declare namespace meta  = "https://github.com/dariok/wdbplus/wdbmeta";
+declare namespace index = "https://github.com/dariok/wdbplus/index";
+
 declare function trigger:after-update-document ( $uri as xs:anyURI ) as xs:string {
   if ( ends-with($uri, 'instance.xqm') or ends-with($uri, 'project.xqm') ) then
     let $projectPath := if ( ends-with($uri, 'instance.xqm') )
@@ -12,5 +15,59 @@ declare function trigger:after-update-document ( $uri as xs:anyURI ) as xs:strin
         else 'project-functions.xml'
 
     return xmldb:store($projectPath, $statFileName, inspect:inspect-module($uri))
+  else if ( ends-with($uri, 'wdbmeta.xml') ) then
+    let $meta := doc($uri)
+      , $projectId := $meta/meta:projectMD/@xml:id
+      , $files := $meta//meta:file
+      , $title := $meta//meta:title[@type='main']
+      , $projectIndex := doc("/db/apps/edoc/index/project-index.xml")
+      , $fileIndex := doc("/db/apps/edoc/index/file-index.xml")
+      , $projectEntry := <project xmlns="https://github.com/dariok/wdbplus/index"
+          xml:id="{ $projectId }"
+          path="{ substring-before($uri, '/wdbmeta.xml') }"
+          title="{ $title }"
+        />
+
+    (: enter or update project :)
+    let $insertProject := if ( exists($projectIndex/id($projectId)) )
+      then update replace $projectIndex/id($projectId) with $projectEntry
+      else update insert $projectEntry into $projectIndex/index:index
+
+    (: enter or update files entries :)
+    let $entries := for $file in $files
+      let $id := $file/@xml:id
+        , $entry := <file xmlns="https://github.com/dariok/wdbplus/index"
+            xml:id="{ $id }"
+            project="{ $meta => base-uri() }"
+          />
+
+      return if ( exists($fileIndex/id($id)) )
+          then update replace $fileIndex/id($id) with $entry
+          else update insert $entry into $fileIndex/index:index
+
+    (: enter or update subcorpora :)
+    let $subcorpora := for $subcorpus in $meta//meta:struct[@xml:id]
+      let $id := $subcorpus/@xml:id
+        , $entry := <file xmlns="https://github.com/dariok/wdbplus/index"
+            xml:id="{ $id }"
+            project="{ $meta => base-uri() }"
+          />
+
+      return if ( exists($fileIndex/id($id)) )
+          then update replace $fileIndex/id($id) with $entry
+          else update insert $entry into $fileIndex/index:index
+
+    return $uri
+  (: else if ( ends-with($uri, '.xml') ) then
+    let $id := doc($uri)/*/@xml:id
+      , $present := doc("/db/apps/edoc/index/file-index.xml")/id($id)
+      , $entry := <file xmlns="https://github.com/dariok/wdbplus/index"
+          xml:id="{ $id }"
+          project="{ collection('/db/apps/edoc/data')/id($id)[self::meta:file] => base-uri() }"
+        />
+      , $insert := if ( $present )
+          then update replace $present with $entry
+          else update insert $entry into doc("/db/apps/edoc/index/file-index.xml")/*
+    return $uri :)
   else ""
 };