MCR-3126 improve ocfl

* add restore derivate command
* add describe object command
* fix MCRVersionedPath#getParent does not return a versioned path

Author: Mewel

mycore-base/src/main/java/org/mycore/datamodel/niofs/MCRVersionedFileSystem.java

@@ -18,6 +18,9 @@
 
 package org.mycore.datamodel.niofs;
 
+import java.nio.file.FileSystemException;
+import java.nio.file.NoSuchFileException;
+
 /**
  * Represents a file system with versioning capabilities. This class extends {@link MCRAbstractFileSystem}
  * to work with {@link MCRVersionedFileSystemProvider}, thereby enabling handling of paths that
@@ -45,4 +48,16 @@ public MCRVersionedFileSystemProvider provider() {
         return (MCRVersionedFileSystemProvider) super.provider();
     }
 
+    /**
+     * Restores the root with the given version.
+     * <p>
+     * After calling this method, the implementing FileSystem should be ready to accept data for this root.
+     *
+     * @param owner ,e.g. derivate ID
+     * @param version the version
+     * @throws FileSystemException if restoring the root directory fails
+     * @throws NoSuchFileException more specific, if the owner or version never existed
+     */
+    public abstract void restoreRoot(String owner, String version) throws FileSystemException, NoSuchFileException;
+
 }

mycore-base/src/main/java/org/mycore/datamodel/niofs/MCRVersionedPath.java

@@ -76,12 +76,29 @@ public String getVersion() {
         return ownerVersion.version();
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public MCRVersionedPath getParent() {
         MCRPath parent = super.getParent();
         return parent != null ? ofPath(parent) : null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public MCRPath getRoot() {
+        if (!isAbsolute()) {
+            return null;
+        }
+        if (getNameCount() == 0) {
+            return this;
+        }
+        return getFileSystem().provider().getPath(this.getOwner(), this.getVersion(), SEPARATOR_STRING);
+    }
+
     @Override
     public MCRVersionedPath subpath(int beginIndex, int endIndex) {
         return ofPath(super.subpath(beginIndex, endIndex));
@@ -99,7 +116,12 @@ public MCRVersionedPath getName(int index) {
 
     @Override
     protected MCRVersionedPath getPath(String owner, String path, MCRAbstractFileSystem fs) {
-        return ofPath(super.getPath(owner, path, fs));
+        MCRVersionedFileSystemProvider provider = getFileSystem().provider();
+        if (owner == null) {
+            return provider.getPath(null, path);
+        } else {
+            return provider.getPath(owner, this.getVersion(), path);
+        }
     }
 
     public String toRelativePath() {

mycore-ocfl/src/main/java/org/mycore/ocfl/commands/MCROCFLCommands.java

@@ -44,7 +44,9 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.jdom2.Document;
 import org.jdom2.JDOMException;
+import org.mycore.access.MCRAccessException;
 import org.mycore.common.MCRUsageException;
 import org.mycore.common.config.MCRConfiguration2;
 import org.mycore.common.config.MCRConfigurationDir;
@@ -59,6 +61,8 @@
 import org.mycore.datamodel.classifications2.utils.MCRXMLTransformer;
 import org.mycore.datamodel.common.MCRAbstractMetadataVersion;
 import org.mycore.datamodel.common.MCRXMLMetadataManager;
+import org.mycore.datamodel.metadata.MCRDerivate;
+import org.mycore.datamodel.metadata.MCRMetadataManager;
 import org.mycore.datamodel.metadata.MCRObjectID;
 import org.mycore.datamodel.niofs.MCRFileAttributes;
 import org.mycore.datamodel.niofs.MCRPath;
@@ -72,17 +76,22 @@
 import org.mycore.ocfl.metadata.migration.MCROCFLMigration;
 import org.mycore.ocfl.metadata.migration.MCROCFLRevisionPruner;
 import org.mycore.ocfl.niofs.MCROCFLFileSystemProvider;
+import org.mycore.ocfl.repository.MCROCFLRepository;
 import org.mycore.ocfl.repository.MCROCFLRepositoryProvider;
 import org.mycore.ocfl.user.MCROCFLXMLUserManager;
 import org.mycore.ocfl.util.MCROCFLObjectIDPrefixHelper;
 import org.mycore.user2.MCRUser;
 import org.mycore.user2.MCRUserManager;
 import org.xml.sax.SAXException;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import com.google.common.collect.MapDifference;
 import com.google.common.collect.Maps;
 
 import io.ocfl.api.OcflRepository;
+import io.ocfl.api.model.ObjectDetails;
 
 @SuppressWarnings("JavaUtilDate")
 @MCRCommandGroup(name = "OCFL Commands")
@@ -153,6 +162,27 @@ protected static void migrateWithPrunersAndRepositoryKeyOrMetadataManager(String
             SUCCESS_BUT_WITHOUT_HISTORY + ": " + withoutHistory.size() + ls);
     }
 
+    @MCRCommand(syntax = "describe ocfl object {0} of repository {1}",
+        help = "Prints all of the details about an object and all of its versions."
+            + "  It is required to add the ocfl prefix like 'mcrobject:' or 'mcracl:' to the object id.")
+    public static void describeObject(String objectId, String repositoryId) {
+        repositoryId = (repositoryId == null || repositoryId.isBlank()) ? "Main" : repositoryId;
+        MCROCFLRepositoryProvider provider = MCROCFLRepositoryProvider.getProvider(repositoryId);
+        MCROCFLRepository repository = provider.getRepository();
+        ObjectDetails objectDetails = repository.describeObject(objectId);
+
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.registerModule(new JavaTimeModule());
+        mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
+        mapper.enable(SerializationFeature.INDENT_OUTPUT);
+        try {
+            String pretty = mapper.writeValueAsString(objectDetails);
+            LOGGER.info("\n{}", pretty);
+        } catch (Exception e) {
+            LOGGER.error("Failed to pretty-print ObjectDetails", e);
+        }
+    }
+
     @MCRCommand(syntax = "migrate metadata to metadatamanager {1} and pruners {2} ",
         help = "migrates all the metadata to the ocfl " +
             "repository with the id {0} and prunes the revisions with the given pruners",
@@ -304,6 +334,21 @@ public static void restoreObjFromOCFLVersioned(String mcridString, String revisi
         }
     }
 
+    @MCRCommand(syntax = "restore derivate {0} from ocfl with version {1}",
+        help = "restore derivate {0} with version {1} to current store from ocfl history")
+    public static List<String> restoreDerivateFromOCFL(String derivateId, String revision)
+        throws IOException, JDOMException, MCRAccessException {
+        // restore ocfl content
+        MCROCFLFileSystemProvider.get().getFileSystem().restoreRoot(derivateId, revision);
+        // update metadata
+        MCRObjectID mcrDerivateId = MCRObjectID.getInstance(derivateId);
+        Document derivateXml = MCRXMLMetadataManager.getInstance().retrieveXML(mcrDerivateId);
+        MCRDerivate mcrDerivate = new MCRDerivate(derivateXml);
+        MCRMetadataManager.update(mcrDerivate);
+        // tile
+        return List.of("tile images of derivate " + derivateId);
+    }
+
     @MCRCommand(syntax = "restore object {0} from ocfl",
         help = "restore latest mcrobject {0} to current store from ocfl history")
     public static void restoreObjFromOCFL(String mcridString) throws IOException {
@@ -498,7 +543,7 @@ public static void validateDerivate(String derivateId) throws IOException {
 
     private static void logConfirm(String type) {
         LOGGER.info(() -> String.format(Locale.ROOT, """
-            
+
             \u001B[93mEnter the command again to confirm \u001B[4mPERMANENTLY\u001B[24m deleting ALL\
              hidden/archived OCFL %s.\u001B[0m
             \u001B[41mTHIS ACTION CANNOT BE UNDONE!\u001B[0m""", type));

mycore-ocfl/src/main/java/org/mycore/ocfl/niofs/MCROCFLFileSystem.java

@@ -18,16 +18,21 @@
 
 package org.mycore.ocfl.niofs;
 
+import static org.mycore.ocfl.util.MCROCFLVersionHelper.MESSAGE_UPDATED;
+
 import java.io.IOException;
 import java.nio.file.FileAlreadyExistsException;
 import java.nio.file.FileStore;
 import java.nio.file.FileSystemException;
+import java.nio.file.NoSuchFileException;
 import java.nio.file.Path;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
 import java.util.stream.Stream;
 
+import io.ocfl.api.model.ObjectVersionId;
+import io.ocfl.api.model.VersionInfo;
 import org.mycore.datamodel.metadata.MCRObjectID;
 import org.mycore.datamodel.niofs.MCRVersionedFileSystem;
 import org.mycore.ocfl.repository.MCROCFLRepository;
@@ -79,8 +84,8 @@ public void createRoot(String owner) throws FileSystemException {
         try {
             virtualObject.create();
         } catch (IOException ioException) {
-            FileSystemException fileSystemException
-                = new FileSystemException(null, null, "Cannot create root of '" + owner + "'.");
+            FileSystemException fileSystemException =
+                new FileSystemException(null, null, "Cannot create root of '" + owner + "'.");
             fileSystemException.initCause(ioException);
             throw fileSystemException;
         }
@@ -102,13 +107,37 @@ public void removeRoot(String owner) throws FileSystemException {
         try {
             virtualObject.purge();
         } catch (IOException ioException) {
-            FileSystemException fileSystemException
-                = new FileSystemException(null, null, "Cannot remove root of '" + owner + "'.");
+            FileSystemException fileSystemException =
+                new FileSystemException(null, null, "Cannot remove root of '" + owner + "'.");
             fileSystemException.initCause(ioException);
             throw fileSystemException;
         }
     }
 
+    /**
+     * {@inheritDoc}
+     * <p>
+     * Be aware that this OCFL implementation works outside the {@link MCROCFLFileSystemTransaction}.
+     */
+    @Override
+    public void restoreRoot(String owner, String version) throws FileSystemException {
+        MCROCFLVirtualObjectProvider virtualObjectProvider = provider().virtualObjectProvider();
+        if (!virtualObjectProvider.exists(owner, version)) {
+            throw new NoSuchFileException(null, null, "No such version '" + version + "' for root '" + owner + "'.");
+        }
+        try {
+            MCROCFLRepository repository = provider().getRepository();
+            String ocflObjectId = MCROCFLObjectIDPrefixHelper.toDerivateObjectId(owner);
+            repository.replicateVersionAsHead(ObjectVersionId.version(ocflObjectId, version),
+                new VersionInfo().setMessage(MESSAGE_UPDATED));
+        } catch (Exception exc) {
+            FileSystemException fileSystemException =
+                new FileSystemException(null, null, "Unable to restore '" + owner + "' to version '" + version + "'.");
+            fileSystemException.initCause(exc);
+            throw fileSystemException;
+        }
+    }
+
     /**
      * Returns an iterable over the root directories in the OCFL file system.
      *

mycore-ocfl/src/main/java/org/mycore/ocfl/niofs/MCROCFLVirtualObjectProvider.java

@@ -182,25 +182,44 @@ private MCROCFLVirtualObject getWritable(ObjectVersionId id) {
      * @return {@code true} if the owner exists, {@code false} otherwise.
      */
     public boolean exists(String owner) {
-        ObjectVersionId head = toObjectVersionId(owner, null);
-        if (this.readMap.containsKey(head)) {
+        return exists(owner, null);
+    }
+
+    /**
+     * Checks if the specified owner and version exists in the repository.
+     * <p>
+     * This also will return true if the owner was marked for purge or was deleted (and not purged),
+     * because the object still exists in the OCFL repository.
+     *
+     * @param owner the owner of the object.
+     * @param version the version of the object
+     * @return {@code true} if the owner and version exists, {@code false} otherwise.
+     */
+    public boolean exists(String owner, String version) {
+        ObjectVersionId objectVersionId = toObjectVersionId(owner, version);
+        if (this.readMap.containsKey(objectVersionId)) {
             return true;
         }
         boolean isActive = MCROCFLFileSystemTransaction.isActive();
         Long transactionId = MCROCFLFileSystemTransaction.getTransactionId();
         if (isActive && this.writeMap.containsKey(transactionId)) {
-            MCROCFLVirtualObject headVirtualObject = this.writeMap.get(transactionId).get(head);
+            MCROCFLVirtualObject headVirtualObject = this.writeMap.get(transactionId).get(objectVersionId);
             if (headVirtualObject != null) {
                 return headVirtualObject.isMarkedForCreate();
+
             }
         }
-        if (!repository.containsObject(head.getObjectId())) {
+        if (!repository.containsObject(objectVersionId.getObjectId())) {
+            return false;
+        }
+        try {
+            OcflObjectVersion object = repository.getObject(objectVersionId);
+            return object.getFiles().stream()
+                .map(OcflObjectVersionFile::getPath)
+                .anyMatch(path -> path.startsWith(MCROCFLVirtualObject.FILES_DIRECTORY));
+        } catch(NotFoundException ignore) {
             return false;
         }
-        OcflObjectVersion object = repository.getObject(head);
-        return object.getFiles().stream()
-            .map(OcflObjectVersionFile::getPath)
-            .anyMatch(path -> path.startsWith(MCROCFLVirtualObject.FILES_DIRECTORY));
     }
 
     /**

mycore-ocfl/src/test/java/org/mycore/ocfl/MCROCFLTestCaseHelper.java

@@ -28,6 +28,11 @@
 import java.nio.file.SimpleFileVisitor;
 import java.nio.file.attribute.BasicFileAttributes;
 
+import org.mycore.datamodel.metadata.MCRDerivate;
+import org.mycore.datamodel.metadata.MCRMetaIFS;
+import org.mycore.datamodel.metadata.MCRMetaLinkID;
+import org.mycore.datamodel.metadata.MCRObject;
+import org.mycore.datamodel.metadata.MCRObjectID;
 import org.mycore.datamodel.niofs.MCRVersionedPath;
 import org.mycore.ocfl.repository.MCROCFLRepository;
 import org.mycore.ocfl.util.MCROCFLObjectIDPrefixHelper;
@@ -74,6 +79,25 @@ public static void loadDerivate(String derivateId) throws URISyntaxException, IO
         Files.walkFileTree(sourcePath, new CopyFileVisitor(targetPath));
     }
 
+    public static MCRObject createObject(String objectId) {
+        MCRObject object = new MCRObject();
+        object.setId(MCRObjectID.getInstance(objectId));
+        object.setSchema("noSchema");
+        return object;
+    }
+
+    public static MCRDerivate createDerivate(String objectId, String derivateId) {
+        MCRDerivate derivate = new MCRDerivate();
+        derivate.setId(MCRObjectID.getInstance(derivateId));
+        derivate.setSchema("datamodel-derivate.xsd");
+        MCRMetaIFS ifs = new MCRMetaIFS("internal", null);
+        derivate.getDerivate().setInternals(ifs);
+        MCRMetaLinkID mcrMetaLinkID = new MCRMetaLinkID("linkmeta", 0);
+        mcrMetaLinkID.setReference(objectId, null, null);
+        derivate.getDerivate().setLinkMeta(mcrMetaLinkID);
+        return derivate;
+    }
+
     private static class CopyFileVisitor extends SimpleFileVisitor<Path> {
 
         private final Path targetPath;