#550 Submit publications to HISinOne

.github/workflows/maven-pr.yml

@@ -22,4 +22,4 @@ jobs:
           server-id: ossrh # Value of the distributionManagement/repository/id field of the pom.xml
           settings-path: ${{ github.workspace }} # location for the settings.xml file
       - name: Build with Maven
-        run: mvn -B package --file pom.xml
+        run: mvn -B package -Dmaven.javadoc.skip=true --file pom.xml

common/pom.xml

@@ -12,6 +12,18 @@
   <name>ThUniBib Common Files</name>
 
   <dependencies>
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-annotations</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-core</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-databind</artifactId>
+    </dependency>
     <dependency>
       <groupId>jakarta.servlet</groupId>
       <artifactId>jakarta.servlet-api</artifactId>
@@ -20,6 +32,18 @@
       <groupId>org.apache.solr</groupId>
       <artifactId>solr-solrj</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.glassfish.jersey.core</groupId>
+      <artifactId>jersey-client</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.glassfish.jersey.media</groupId>
+      <artifactId>jersey-media-sse</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.jdom</groupId>
+      <artifactId>jdom2</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.mycore</groupId>
       <artifactId>mycore-base</artifactId>

common/src/main/java/de/uni_jena/thunibib/HISinOneCommandConfiguration.java

@@ -0,0 +1,63 @@
+package de.uni_jena.thunibib;
+
+import de.uni_jena.thunibib.his.api.v1.cs.sys.values.SysValue;
+import de.uni_jena.thunibib.his.api.v1.fs.res.publication.Journal;
+import de.uni_jena.thunibib.his.api.v1.fs.res.publication.Publication;
+import org.jdom2.filter.Filters;
+import org.mycore.common.config.MCRConfiguration2;
+import org.mycore.datamodel.metadata.MCRObject;
+
+import static org.mycore.common.MCRConstants.MODS_NAMESPACE;
+import static org.mycore.common.MCRConstants.XPATH_FACTORY;
+
+/**
+ * Class can be used to determine and store configuration values for publishing and updating publications in HISinOne.
+ *
+ * @author shermann (Silvio Hermann)
+ */
+class HISinOneCommandConfiguration {
+    static final String PUBLICATION_TRANSFORMER = MCRConfiguration2.getStringOrThrow(
+        "ThUniBib.HISinOne.Publication.Transformer.Name");
+
+    static final String JOURNAL_TRANSFORMER = MCRConfiguration2.getStringOrThrow(
+        "ThUniBib.HISinOne.Journal.Transformer.Name");
+
+    final private boolean isJournal;
+
+    public HISinOneCommandConfiguration(MCRObject obj) {
+        isJournal = XPATH_FACTORY.compile(
+                "//mods:mods/mods:genre[@type='intern'][contains('journal newspaper', substring-after(@valueURI, '#'))]",
+                Filters.element(), null, MODS_NAMESPACE)
+            .evaluateFirst(obj.createXML()) != null;
+    }
+
+    /**
+     * Determines the name of the required transformer for building the JSON object.
+     * */
+    public String getTransformerName() {
+        if (isJournal) {
+            return JOURNAL_TRANSFORMER;
+        }
+        return PUBLICATION_TRANSFORMER;
+    }
+
+    /**
+     * Determines the path for posting the JSON to.
+     * */
+    public String getPath() {
+        if (isJournal) {
+            return Journal.getPath();
+        }
+        return Publication.getPath();
+    }
+
+    /**
+     * Determines the class to read the response to.
+     * */
+    public Class<? extends SysValue> getResponseEntityClass() {
+        if (isJournal) {
+            return Journal.class;
+        }
+        return Publication.class;
+    }
+}

common/src/main/java/de/uni_jena/thunibib/HISinOneCommands.java

@@ -0,0 +1,147 @@
+package de.uni_jena.thunibib;
+
+import de.uni_jena.thunibib.his.api.client.HISInOneClient;
+import de.uni_jena.thunibib.his.api.client.HISinOneClientFactory;
+import de.uni_jena.thunibib.his.api.v1.cs.sys.values.SysValue;
+import de.uni_jena.thunibib.his.xml.HISInOneServiceFlag;
+import jakarta.ws.rs.core.Response;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.mycore.access.MCRAccessException;
+import org.mycore.datamodel.metadata.MCRMetadataManager;
+import org.mycore.datamodel.metadata.MCRObject;
+import org.mycore.datamodel.metadata.MCRObjectID;
+import org.mycore.frontend.cli.annotation.MCRCommand;
+import org.mycore.frontend.cli.annotation.MCRCommandGroup;
+
+import java.io.IOException;
+import java.util.Optional;
+
+import static de.uni_jena.thunibib.his.api.client.HISInOneClient.HIS_IN_ONE_BASE_URL;
+
+@MCRCommandGroup(name = "HISinOne Commands")
+public class HISinOneCommands {
+    private static final Logger LOGGER = LogManager.getLogger(HISinOneCommands.class);
+
+    @MCRCommand(syntax = "publish {0}", help = "Publishes the object given by its id to HISinOne")
+    public static SysValue publish(String mcrid) {
+        LOGGER.info("Publishing {}", mcrid);
+
+        Optional<SysValue> sysVal = isValid(mcrid);
+        if (sysVal.isPresent()) {
+            return sysVal.get();
+        }
+
+        MCRObject mcrObject = MCRMetadataManager.retrieveMCRObject(MCRObjectID.getInstance(mcrid));
+        if (mcrObject.getService().getFlags(HISInOneServiceFlag.getName()).size() > 0) {
+            LOGGER.warn("{} is already published. Try command 'update {0}' instead?", mcrid);
+            return SysValue.ErroneousSysValue;
+        }
+
+        HISinOneCommandConfiguration conf = new HISinOneCommandConfiguration(mcrObject);
+
+        try {
+            String json = Utilities.transform(mcrObject, conf.getTransformerName());
+            LOGGER.debug("JSON: {}", json);
+
+            try (HISInOneClient client = HISinOneClientFactory.create();
+                Response response = client.post(conf.getPath(), json)) {
+
+                if (response.getStatusInfo().getFamily() != Response.Status.Family.SUCCESSFUL) {
+                    LOGGER.error("{}: {}", conf.getPath(), response.readEntity(String.class));
+                    return SysValue.ErroneousSysValue;
+                }
+
+                SysValue publication = response.readEntity(conf.getResponseEntityClass());
+                if (publication.getId() == 0) {
+                    LOGGER.error("MCRObject {} was not published at {} with id {}", mcrid,
+                        HIS_IN_ONE_BASE_URL + conf.getPath(), publication.getId());
+                    return SysValue.ErroneousSysValue;
+                }
+
+                LOGGER.info("MCRObject {} published at {} with id {}", mcrid, HIS_IN_ONE_BASE_URL + conf.getPath(),
+                    publication.getId());
+
+                // Update MCRObject
+                mcrObject.getService().addFlag(HISInOneServiceFlag.getName(), String.valueOf(publication.getId()));
+                MCRMetadataManager.update(mcrObject);
+
+                return publication;
+            }
+        } catch (IOException | MCRAccessException e) {
+            LOGGER.error("Could not publish {} to {}", mcrid, HIS_IN_ONE_BASE_URL, e);
+        }
+
+        return SysValue.UnresolvedSysValue;
+    }
+
+    @MCRCommand(syntax = "update {0}", help = "Updates the object given by its id in HISinOne")
+    public static SysValue update(String mcrid) {
+        LOGGER.info("Updating {}", mcrid);
+        Optional<SysValue> sysVal = isValid(mcrid);
+        if (sysVal.isPresent()) {
+            return sysVal.get();
+        }
+
+        MCRObject mcrObject = MCRMetadataManager.retrieveMCRObject(MCRObjectID.getInstance(mcrid));
+        if (mcrObject.getService().getFlags(HISInOneServiceFlag.getName()).size() == 0) {
+            LOGGER.warn("{} is not published. Try command 'publish {0}' first", mcrid);
+            return SysValue.ErroneousSysValue;
+        }
+
+        HISinOneCommandConfiguration conf = new HISinOneCommandConfiguration(mcrObject);
+        try {
+            String hisId = mcrObject.getService().getFlags(HISInOneServiceFlag.getName()).get(0);
+            String json = Utilities.transform(mcrObject, conf.getTransformerName());
+
+            try (HISInOneClient client = HISinOneClientFactory.create();
+                Response response = client.put(conf.getPath() + "/" + hisId, json)) {
+
+                if (response.getStatusInfo().getFamily() != Response.Status.Family.SUCCESSFUL) {
+                    LOGGER.error("{}: {}", conf.getPath(), response.readEntity(String.class));
+                    return SysValue.ErroneousSysValue;
+                }
+
+                SysValue p = response.readEntity(conf.getResponseEntityClass());
+                if (p.getId() == 0) {
+                    LOGGER.error("MCRObject {} was not updated at {} with id {}", mcrid,
+                        HIS_IN_ONE_BASE_URL + conf.getPath(), p.getId());
+                    return SysValue.ErroneousSysValue;
+                }
+                LOGGER.info("MCRObject {} updated at {} with id {} and new lockVersion {}", mcrid,
+                    HIS_IN_ONE_BASE_URL + conf.getPath(), hisId, p.getLockVersion());
+                return p;
+            }
+        } catch (IOException e) {
+            LOGGER.error("Could not update {} to {}", mcrid, HIS_IN_ONE_BASE_URL, e);
+        }
+        return SysValue.ErroneousSysValue;
+    }
+
+    @MCRCommand(syntax = "delete {0}", help = "Deletes the object given by its id from HISinOne")
+    public static void delete(String mcrid) {
+        LOGGER.info("Deleting {}", mcrid);
+    }
+
+    /**
+     * Checks if the provided mcr id is valid and the related mycoreobject actually exists.
+     *
+     * @param mcrid the id of the mycoreobject
+     *
+     * @return either an empty {@link Optional} or an {@link Optional} wrapping a {@link SysValue}
+     */
+    protected final static Optional<SysValue> isValid(String mcrid) {
+        if (!MCRObjectID.isValid(mcrid)) {
+            LOGGER.error("{} is not a valid {}", mcrid, MCRObjectID.class.getSimpleName());
+            return Optional.of(SysValue.ErroneousSysValue);
+        }
+
+        MCRObjectID mcrObjectID = MCRObjectID.getInstance(mcrid);
+        if (!MCRMetadataManager.exists(mcrObjectID)) {
+            LOGGER.error("{} does not exist", mcrid);
+            return Optional.of(SysValue.UnresolvedSysValue);
+        }
+
+        return Optional.empty();
+    }
+}

common/src/main/java/de/uni_jena/thunibib/Utilities.java

@@ -7,18 +7,25 @@
 import jakarta.persistence.criteria.SetJoin;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.jdom2.Document;
 import org.mycore.backend.jpa.MCREntityManagerProvider;
 import org.mycore.common.config.MCRConfiguration2;
+import org.mycore.common.content.MCRContent;
+import org.mycore.common.content.MCRJDOMContent;
+import org.mycore.common.content.transformer.MCRContentTransformer;
+import org.mycore.common.content.transformer.MCRContentTransformerFactory;
 import org.mycore.datamodel.classifications2.MCRCategory;
 import org.mycore.datamodel.classifications2.MCRCategoryDAO;
 import org.mycore.datamodel.classifications2.MCRCategoryDAOFactory;
 import org.mycore.datamodel.classifications2.MCRCategoryID;
 import org.mycore.datamodel.classifications2.MCRLabel;
+import org.mycore.datamodel.metadata.MCRObject;
 import org.mycore.user2.MCRUser;
 import org.mycore.user2.MCRUserAttribute;
 import org.mycore.user2.MCRUserAttribute_;
 import org.mycore.user2.MCRUser_;
 
+import java.io.IOException;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Locale;
@@ -39,6 +46,22 @@ public static String toLowerCase(String s) {
         return s.toLowerCase(Locale.ROOT);
     }
 
+    /**
+     * Transforms a given {@link MCRObject} to JSON suitable for HISinOne/RES.
+     *
+     * @param mcrObject the object to transform
+     * @param transformerName the name of the transformer to user
+     *
+     * @return a {@link String} as transformation result
+     * */
+    public static String transform(MCRObject mcrObject, String transformerName) throws IOException {
+        Document mods = mcrObject.createXML();
+        MCRContentTransformer transformer = MCRContentTransformerFactory.getTransformer(transformerName);
+        MCRContent transformed = transformer.transform(new MCRJDOMContent(mods));
+
+        return transformed.asString();
+    }
+
     /**
      * Gets the lead for a given other name identifier for a MCRUser.
      *

common/src/main/java/de/uni_jena/thunibib/his/api/client/HISInOneClient.java

@@ -0,0 +1,39 @@
+package de.uni_jena.thunibib.his.api.client;
+
+import jakarta.ws.rs.core.Response;
+import org.mycore.common.config.MCRConfiguration2;
+import org.mycore.common.events.MCRShutdownHandler;
+
+import java.util.Map;
+
+public interface HISInOneClient extends MCRShutdownHandler.Closeable, AutoCloseable {
+
+    String HIS_IN_ONE_BASE_URL = MCRConfiguration2.getStringOrThrow("ThUniBib.HISinOne.BaseURL");
+    String API_PATH = MCRConfiguration2.getStringOrThrow("ThUniBib.HISinOne.BaseURL.API.Path");
+
+    enum AuthType {
+        Basic, Bearer
+    }
+
+    default Response get(String path) {
+        return get(path, false);
+    }
+
+    default Response get(String path, Map<String, String> params) {
+        return get(path, params, false);
+    }
+
+    default Response get(String path, boolean omitToken) {
+        return get(path, null, omitToken);
+    }
+
+    default Response post(String path, String body) {
+        return post(path, body, null);
+    }
+
+    Response get(String path, Map<String, String> params, boolean omitToken);
+
+    Response post(String path, String body, Map<String, String> params);
+
+    Response put(String path, String body);
+}