[MOD] QT4TS: Adaptations for file nodule

ChristianGruen · ChristianGruen · commit 138abb992073 · 2026-02-09T13:58:53.000+01:00
diff --git a/basex-core/src/main/java/org/basex/query/QueryResources.java b/basex-core/src/main/java/org/basex/query/QueryResources.java
@@ -3,6 +3,7 @@
 import static org.basex.query.QueryError.*;
 
 import java.io.*;
+import java.nio.file.*;
 import java.util.*;
 
 import org.basex.build.*;
@@ -56,6 +57,9 @@ public final class QueryResources {
   /** Input references. */
   private final ArrayList<InputStream> inputs = new ArrayList<>(1);
 
+  /** Current directory for file operations (can be {@null}). */
+  public Path currentDir;
+
   /**
    * Constructor.
    * @param qc query context
@@ -404,6 +408,14 @@ public void ftmaps(final HashMap<String, IO> sw, final HashMap<String, IO> th) {
     thes = th;
   }
 
+  /**
+   * Assigns a sandpit directory.
+   * @param path path to assign
+   */
+  public void sandpit(final Path path) {
+    currentDir = path;
+  }
+
   // PRIVATE METHODS ==============================================================================
 
   /**
diff --git a/basex-core/src/main/java/org/basex/query/func/StandardFunc.java b/basex-core/src/main/java/org/basex/query/func/StandardFunc.java
@@ -463,18 +463,21 @@ protected final Collation toCollation(final byte[] collation, final QueryContext
    * @throws QueryException query exception
    */
   protected final Path toPath(final Expr expr, final QueryContext qc) throws QueryException {
-    return toPath(toString(expr, qc));
+    return toPath(toString(expr, qc), qc);
   }
 
   /**
    * Converts a path to a file path.
    * @param path path string
+   * @param qc query context
    * @return file path
    * @throws QueryException query exception
    */
-  protected final Path toPath(final String path) throws QueryException {
+  protected final Path toPath(final String path, final QueryContext qc) throws QueryException {
     try {
-      return path.startsWith(IO.FILEPREF) ? Paths.get(new URI(path)) : Paths.get(path);
+      final Path p = path.startsWith(IO.FILEPREF) ? Paths.get(new URI(path)) : Paths.get(path);
+      final Path cd = qc.resources.currentDir;
+      return cd != null ? cd.resolve(p) : p;
     } catch(final IllegalArgumentException | URISyntaxException ex) {
       Util.debug(ex);
       throw FILE_INVALID_PATH_X.get(info, path);
diff --git a/basex-core/src/main/java/org/basex/query/func/file/FileCopy.java b/basex-core/src/main/java/org/basex/query/func/file/FileCopy.java
@@ -5,6 +5,7 @@
 import java.io.*;
 import java.nio.file.*;
 
+import org.basex.core.jobs.*;
 import org.basex.query.*;
 import org.basex.query.value.*;
 import org.basex.query.value.seq.*;
@@ -59,18 +60,18 @@ final void relocate(final boolean copy, final QueryContext qc)
    * @param src source path
    * @param trg target path
    * @param copy copy flag
-   * @param qc query context
+   * @param job job
    * @throws IOException I/O exception
    */
-  private static void relocate(final Path src, final Path trg, final boolean copy,
-      final QueryContext qc) throws IOException {
+  public static void relocate(final Path src, final Path trg, final boolean copy, final Job job)
+      throws IOException {
 
     if(Files.isDirectory(src)) {
       if(!Files.exists(trg)) Files.createDirectory(trg);
       try(DirectoryStream<Path> children = Files.newDirectoryStream(src)) {
-        qc.checkStop();
+        job.checkStop();
         for(final Path child : children) {
-          relocate(child, trg.resolve(child.getFileName()), copy, qc);
+          relocate(child, trg.resolve(child.getFileName()), copy, job);
         }
       }
       if(!copy) Files.delete(src);
diff --git a/basex-core/src/main/java/org/basex/query/func/file/FileCreateTempFile.java b/basex-core/src/main/java/org/basex/query/func/file/FileCreateTempFile.java
@@ -37,7 +37,7 @@ final Str createTemp(final boolean directory, final QueryContext qc)
     final String prefix = toStringOrNull(arg(0), qc);
     final String suffix = toStringOrNull(arg(1), qc);
     final String dir = toStringOrNull(arg(2), qc);
-    final Path root = dir != null ? toPath(dir) : Paths.get(Prop.TEMPDIR);
+    final Path root = dir != null ? toPath(dir, qc) : Paths.get(Prop.TEMPDIR);
 
     if(Files.isRegularFile(root)) throw FILE_NO_DIR_X.get(info, root);
 
diff --git a/basex-core/src/main/java/org/basex/query/func/file/FileCurrentDir.java b/basex-core/src/main/java/org/basex/query/func/file/FileCurrentDir.java
@@ -1,7 +1,5 @@
 package org.basex.query.func.file;
 
-import java.nio.file.*;
-
 import org.basex.query.*;
 import org.basex.query.value.*;
 
@@ -13,7 +11,7 @@
  */
 public final class FileCurrentDir extends FileFn {
   @Override
-  public Value eval(final QueryContext qc) {
-    return get(absolute(Paths.get(".")), true);
+  public Value eval(final QueryContext qc) throws QueryException {
+    return get(absolute(toPath(".", qc)), true);
   }
 }
diff --git a/basex-core/src/main/java/org/basex/query/func/file/FileDelete.java b/basex-core/src/main/java/org/basex/query/func/file/FileDelete.java
@@ -3,6 +3,7 @@
 import java.io.*;
 import java.nio.file.*;
 
+import org.basex.core.jobs.*;
 import org.basex.query.*;
 import org.basex.query.value.*;
 import org.basex.query.value.seq.*;
@@ -30,15 +31,15 @@ public Value eval(final QueryContext qc) throws QueryException, IOException {
   /**
    * Recursively deletes a file path.
    * @param path path to be deleted
-   * @param qc query context
+   * @param job job
    * @throws IOException I/O exception
    */
-  private static void delete(final Path path, final QueryContext qc) throws IOException {
+  public static void delete(final Path path, final Job job) throws IOException {
     if(Files.isDirectory(path)) {
       try(DirectoryStream<Path> children = Files.newDirectoryStream(path)) {
         for(final Path child : children) {
-          qc.checkStop();
-          delete(child, qc);
+          job.checkStop();
+          delete(child, job);
         }
       }
     }
diff --git a/basex-core/src/main/java/org/basex/query/func/file/FileResolvePath.java b/basex-core/src/main/java/org/basex/query/func/file/FileResolvePath.java
@@ -17,10 +17,10 @@
 public final class FileResolvePath extends FileFn {
   @Override
   public Value eval(final QueryContext qc) throws QueryException {
-    final Path path = toPath(toString(arg(0), qc)), abs;
+    final Path path = toPath(toString(arg(0), qc), qc), abs;
     final String base = toStringOrNull(arg(1), qc);
     if(base != null) {
-      Path bs = toPath(base);
+      Path bs = toPath(base, qc);
       if(!bs.isAbsolute()) throw FILE_IS_RELATIVE_X.get(info, bs);
       if(!endsWith(base, '/') && !endsWith(base, '\\')) bs = bs.getParent();
       abs = bs.resolve(path).normalize();
diff --git a/basex-core/src/main/java/org/basex/query/func/proc/ProcFn.java b/basex-core/src/main/java/org/basex/query/func/proc/ProcFn.java
@@ -59,7 +59,7 @@ final ProcResult exec(final QueryContext qc, final boolean fork) throws QueryExc
     final ProcResult result = new ProcResult();
     final Process proc;
     final ProcessBuilder pb = new ProcessBuilder(args.finish());
-    if(dir != null) pb.directory(toPath(dir).toFile());
+    if(dir != null) pb.directory(toPath(dir, qc).toFile());
     if(!env.isEmpty()) {
       pb.environment().clear();
       pb.environment().putAll(env);
diff --git a/basex-tests/src/main/java/org/basex/tests/bxapi/XQuery.java b/basex-tests/src/main/java/org/basex/tests/bxapi/XQuery.java
@@ -1,12 +1,15 @@
 package org.basex.tests.bxapi;
 
 import java.io.*;
+import java.nio.file.*;
 import java.util.*;
 
 import javax.xml.namespace.*;
 
 import org.basex.core.*;
+import org.basex.core.jobs.*;
 import org.basex.query.*;
+import org.basex.query.func.file.*;
 import org.basex.query.iter.*;
 import org.basex.query.util.format.*;
 import org.basex.query.value.*;
@@ -185,6 +188,25 @@ public XQuery baseURI(final String base) {
     return this;
   }
 
+  /**
+   * Prepares a sandpit.
+   * @param source source directory ({@code null} if no files should be copied to the sandpit)
+   * @param target target directory
+   * @throws XQueryException exception
+   */
+  public void sandpit(final Path source, final Path target) {
+    try {
+      if(source != null) {
+        final Job job = new Job() { };
+        if(Files.exists(target)) FileDelete.delete(target, job);
+        FileCopy.relocate(source, target, true, job);
+      }
+      qp.qc.resources.sandpit(target);
+    } catch(final IOException ex) {
+      throw new XQueryException(new QueryException(ex));
+    }
+  }
+
   /**
    * Returns the next item, or {@code null} if all items have been returned.
    * @return next result item
diff --git a/basex-tests/src/main/java/org/basex/tests/w3c/QT3Constants.java b/basex-tests/src/main/java/org/basex/tests/w3c/QT3Constants.java
@@ -28,6 +28,8 @@ interface QT3Constants {
   String STATIC_BASE_URI = "static-base-uri";
   /** QT3TS String. */
   String DECLARED = "declared";
+  /** QT3TS String. */
+  String SANDPIT = "sandpit";
 
   /** QT3TS String. */
   String FILE = "file";
diff --git a/basex-tests/src/main/java/org/basex/tests/w3c/QT3Env.java b/basex-tests/src/main/java/org/basex/tests/w3c/QT3Env.java
@@ -38,6 +38,8 @@ final class QT3Env {
   final HashMap<QName, DecFormatOptions> decFormats;
   /** Static Base URI. */
   final String baseURI;
+  /** Sandpit flag. */
+  final boolean sandpit;
   /** Name. */
   final String name;
 
@@ -68,6 +70,7 @@ final class QT3Env {
     collations = al.isEmpty() ? null : al.get(0);
     final String uri = string(STATIC_BASE_URI, ctx, env);
     baseURI = uri;
+    sandpit = !list(ctx, env, SANDPIT).isEmpty();
 
     // collections
     collURI = XQuery.string("*:collection/@uri", env, ctx);
diff --git a/basex-tests/src/main/java/org/basex/tests/w3c/QT3TS.java b/basex-tests/src/main/java/org/basex/tests/w3c/QT3TS.java
@@ -5,6 +5,7 @@
 import static org.basex.util.Token.*;
 
 import java.io.*;
+import java.nio.file.*;
 import java.util.*;
 import java.util.Map.*;
 import java.util.regex.*;
@@ -327,7 +328,7 @@ private void testCase(final XdmItem test, final ArrayList<QT3Env> envs) throws E
     returned.env = env;
 
     try {
-      environment(query, env);
+      environment(query, env, true);
       if(env != null) {
         // bind documents
         for(final HashMap<String, String> src : env.sources) {
@@ -435,13 +436,25 @@ public IO resolve(final String path, final String uri, final Uri bas) {
     if(report != null) report.addTest(name, exp == null);
   }
 
+
   /**
    * Assigns the query environment.
    * @param query query
    * @param env environment
-   * @return query;
+   * @return query
    */
   private XQuery environment(final XQuery query, final QT3Env env) {
+    return environment(query, env, false);
+  }
+
+  /**
+   * Assigns the query environment.
+   * @param query query
+   * @param env environment
+   * @param init initializes the sandbox
+   * @return query
+   */
+  private XQuery environment(final XQuery query, final QT3Env env, final boolean init) {
     if(env != null) {
       // bind namespaces
       for(final HashMap<String, String> ns : env.namespaces) {
@@ -451,6 +464,12 @@ private XQuery environment(final XQuery query, final QT3Env env) {
       for(final HashMap<String, String> par : env.params) {
         query.variable(par.get(NNAME), new XQuery(par.get(SELECT), ctx).value());
       }
+      // directory with test files
+      if(env.sandpit) {
+        final Path source = init ? Paths.get(baseURI.replaceAll("\\w+\\.xml$", "sandpit")) : null;
+        final Path target = Paths.get(Prop.TEMPDIR, "sandpit");
+        query.sandpit(source, target);
+      }
     }
     return query;
   }
