You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by kw...@apache.org on 2024/04/30 08:59:06 UTC

(jackrabbit-filevault) 01/01: Clarify where platform format names/paths are used

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch bugfix/fix-filename-escaping-in-user-export
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault.git

commit 28c41fecbe45b252dac20d97716862a5d7b2ee0a
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Tue Apr 30 10:58:59 2024 +0200

    Clarify where platform format names/paths are used
    
    Fix translation of filter rules
---
 .../vault/packaging/integration/UserExportIT.java          |  9 +++++----
 .../java/org/apache/jackrabbit/vault/fs/api/VaultFile.java | 14 +++++++++++++-
 .../apache/jackrabbit/vault/fs/api/VaultFileSystem.java    |  6 +++++-
 .../apache/jackrabbit/vault/fs/impl/DirectoryArtifact.java |  2 +-
 .../org/apache/jackrabbit/vault/fs/impl/VaultFileImpl.java |  2 +-
 .../apache/jackrabbit/vault/fs/io/AbstractExporter.java    |  3 ++-
 .../apache/jackrabbit/vault/packaging/ExportOptions.java   |  9 +++++----
 7 files changed, 32 insertions(+), 13 deletions(-)

diff --git a/vault-core-it/vault-core-integration-tests/src/main/java/org/apache/jackrabbit/vault/packaging/integration/UserExportIT.java b/vault-core-it/vault-core-integration-tests/src/main/java/org/apache/jackrabbit/vault/packaging/integration/UserExportIT.java
index 4ff5499f..f2d79c87 100644
--- a/vault-core-it/vault-core-integration-tests/src/main/java/org/apache/jackrabbit/vault/packaging/integration/UserExportIT.java
+++ b/vault-core-it/vault-core-integration-tests/src/main/java/org/apache/jackrabbit/vault/packaging/integration/UserExportIT.java
@@ -46,6 +46,7 @@ import org.apache.jackrabbit.vault.packaging.ExportOptions;
 import org.apache.jackrabbit.vault.packaging.PackageException;
 import org.apache.jackrabbit.vault.packaging.PackageProperties;
 import org.apache.jackrabbit.vault.packaging.VaultPackage;
+import org.apache.jackrabbit.vault.util.PlatformNameFormat;
 import org.junit.Before;
 import org.junit.Test;
 import org.slf4j.Logger;
@@ -81,12 +82,12 @@ public class UserExportIT extends IntegrationTestBase {
         try (FileOutputStream fso = new FileOutputStream(tmpFile)) {
             fso.write(serialised);
         }
-        log.info("Test user exported at path {}", tmpFile.getAbsolutePath());
+        log.info("Test user package exported to path {}", tmpFile.getAbsolutePath());
         clean(TEST_USER_PATH);
         assertNull(getTestUser());
         log.info("Test user removed from the repository");
         importPackage(admin, new ByteArrayInputStream(serialised));
-        assertNotNull(getTestUser());
+        assertNotNull("Could not find test user after import", getTestUser());
         log.info("Test user imported");
     }
 
@@ -104,7 +105,7 @@ public class UserExportIT extends IntegrationTestBase {
         opts.setStrict(true);
         Importer importer = new Importer(opts);
         try (Archive archive = new ZipStreamArchive(is)) {
-            archive.open(false);
+            archive.open(true);
             importer.run(archive, session, "/");
             if (importer.hasErrors() && opts.isStrict(true)) {
                 throw new RuntimeException("Failed to import");
@@ -134,7 +135,7 @@ public class UserExportIT extends IntegrationTestBase {
         ExportOptions opts = new ExportOptions();
         opts.setMetaInf(inf);
 
-        opts.setRootPath(authorizablePath);
+        opts.setRootPath(PlatformNameFormat.getPlatformPath(authorizablePath));
         opts.setMountPath(authorizablePath);
 
         opts.setCompressionLevel(Deflater.BEST_SPEED);
diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/VaultFile.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/VaultFile.java
index 5e8621ec..cd3f15e5 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/VaultFile.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/VaultFile.java
@@ -22,8 +22,12 @@ import java.util.Collection;
 
 import javax.jcr.RepositoryException;
 
+import org.apache.jackrabbit.vault.util.PlatformNameFormat;
+
 /**
- * {@code VaultFile}...
+ * Representation of a node serialization in {@link VaultFileSystem}.
+ * All paths used have the platform format, except if explicitly mentioned otherwise.
+ * @see PlatformNameFormat
  */
 public interface VaultFile extends Dumpable {
     /**
@@ -32,8 +36,16 @@ public interface VaultFile extends Dumpable {
      */
     String getPath();
 
+    /**
+     * 
+     * @return the relative path of this artifact with respect to its parent node (repository format).
+     */
     String getRepoRelPath();
 
+    /**
+     * 
+     * @return the repository path of the artifact's root (repository format).
+     */
     String getAggregatePath();
 
     /**
diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/VaultFileSystem.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/VaultFileSystem.java
index 0d83b144..876b5b21 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/VaultFileSystem.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/VaultFileSystem.java
@@ -21,8 +21,12 @@ import java.io.IOException;
 
 import javax.jcr.RepositoryException;
 
+import org.apache.jackrabbit.vault.util.PlatformNameFormat;
+
 /**
- * {@code VaultFileSystem}...
+ * The file system containing a repository export.
+ * All passed paths are supposed to be in platform format (i.e. with file name escaping applied)
+ * @see PlatformNameFormat
  */
 public interface VaultFileSystem {
 
diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/impl/DirectoryArtifact.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/impl/DirectoryArtifact.java
index e457e199..673c01c8 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/impl/DirectoryArtifact.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/impl/DirectoryArtifact.java
@@ -43,7 +43,7 @@ public class DirectoryArtifact extends AbstractArtifact
      * @param name the repository name for this artifact.
      */
     public DirectoryArtifact(String name) {
-        super(null, name, "", ArtifactType.DIRECTORY);
+        this(name, "");
     }
 
     /**
diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/impl/VaultFileImpl.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/impl/VaultFileImpl.java
index 5d6ca153..0175fc1e 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/impl/VaultFileImpl.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/impl/VaultFileImpl.java
@@ -54,7 +54,7 @@ public class VaultFileImpl implements VaultFile {
     private final VaultFileSystem fs;
 
     /**
-     * the name of this entry
+     * the name of this entry (must be in platform format)
      */
     private final String name;
 
diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/io/AbstractExporter.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/io/AbstractExporter.java
index 61328bf0..61a5ab88 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/io/AbstractExporter.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/io/AbstractExporter.java
@@ -51,6 +51,7 @@ import org.apache.jackrabbit.vault.fs.spi.ServiceProviderFactory;
 import org.apache.jackrabbit.vault.packaging.PackageId;
 import org.apache.jackrabbit.vault.packaging.PackageType;
 import org.apache.jackrabbit.vault.util.Constants;
+import org.apache.jackrabbit.vault.util.PlatformNameFormat;
 import org.apache.jackrabbit.util.Text;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -235,7 +236,7 @@ public abstract class AbstractExporter implements AutoCloseable {
                 rootPath = "";
             }
             if (mountPath.length() > 0 || rootPath.length() > 0) {
-                filter = filter.translate(new SimplePathMapping(mountPath, rootPath));
+                filter = filter.translate(new SimplePathMapping(mountPath, PlatformNameFormat.getRepositoryPath(rootPath)));
             }
 
             // check for package type
diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/ExportOptions.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/ExportOptions.java
index 34bc2115..98fd8b6c 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/ExportOptions.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/ExportOptions.java
@@ -21,6 +21,7 @@ import java.util.zip.Deflater;
 
 import org.apache.jackrabbit.vault.fs.api.ProgressTrackerListener;
 import org.apache.jackrabbit.vault.fs.config.MetaInf;
+import org.apache.jackrabbit.vault.util.PlatformNameFormat;
 
 /**
  * Holds options used for exporting.
@@ -91,7 +92,7 @@ public class ExportOptions {
 
     /**
      * Returns the root path.
-     * @return the root path.
+     * @return the root path in platform format.
      */
     public String getRootPath() {
         return rootPath;
@@ -102,7 +103,7 @@ public class ExportOptions {
      * generate packages that have a virtual root. If a root path different than '/' is set, the workspace filter
      * will be adjusted accordingly, if possible.
      *
-     * @param rootPath the root path
+     * @param rootPath the root path in platform format (compare with {@link PlatformNameFormat})
      */
     public void setRootPath(String rootPath) {
         this.rootPath = rootPath;
@@ -110,7 +111,7 @@ public class ExportOptions {
 
     /**
      * Returns the mount path
-     * @return the mount path
+     * @return the mount path in repository format
      */
     public String getMountPath() {
         return mountPath;
@@ -121,7 +122,7 @@ public class ExportOptions {
      * packages that are not "rooted" at '/'. If a mount path different than '/' is set, the workspace filter
      * will be adjusted accordingly, if possible
      *
-     * @param mountPath the mount path
+     * @param mountPath the mount path in repository format (not in platform format, i.e. not escaped)
      */
     public void setMountPath(String mountPath) {
         this.mountPath = mountPath;