org.dspace.orcid.script.OrcidBulkPush Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
The newest version!
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.orcid.script;

import static org.apache.commons.lang3.StringUtils.isNotEmpty;
import static org.dspace.profile.OrcidSynchronizationMode.BATCH;
import static org.dspace.profile.OrcidSynchronizationMode.MANUAL;

import java.sql.SQLException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.stream.Collectors;

import org.apache.commons.cli.ParseException;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.dspace.content.Item;
import org.dspace.core.Context;
import org.dspace.eperson.EPerson;
import org.dspace.eperson.factory.EPersonServiceFactory;
import org.dspace.orcid.OrcidHistory;
import org.dspace.orcid.OrcidQueue;
import org.dspace.orcid.exception.OrcidValidationException;
import org.dspace.orcid.factory.OrcidServiceFactory;
import org.dspace.orcid.service.OrcidHistoryService;
import org.dspace.orcid.service.OrcidQueueService;
import org.dspace.orcid.service.OrcidSynchronizationService;
import org.dspace.profile.OrcidSynchronizationMode;
import org.dspace.scripts.DSpaceRunnable;
import org.dspace.services.ConfigurationService;
import org.dspace.services.factory.DSpaceServicesFactory;
import org.dspace.utils.DSpace;

/**
 * Script that perform the bulk synchronization with ORCID registry of all the
 * ORCID queue records that has an profileItem that configure the
 * synchronization mode equals to BATCH.
 * @author Luca Giamminonni (luca.giamminonni at 4science.it)
 *
 */
public class OrcidBulkPush extends DSpaceRunnable> {

    private static final Logger LOGGER = LogManager.getLogger();

    private OrcidQueueService orcidQueueService;

    private OrcidHistoryService orcidHistoryService;

    private OrcidSynchronizationService orcidSynchronizationService;

    private ConfigurationService configurationService;

    private Context context;

    /**
     * Cache that stores the synchronization mode set for a specific profile item.
     */
    private final Map synchronizationModeByProfileItem = new HashMap<>();

    private boolean ignoreMaxAttempts = false;

    @Override
    public void setup() throws ParseException {
        OrcidServiceFactory orcidServiceFactory = OrcidServiceFactory.getInstance();
        this.orcidQueueService = orcidServiceFactory.getOrcidQueueService();
        this.orcidHistoryService = orcidServiceFactory.getOrcidHistoryService();
        this.orcidSynchronizationService = orcidServiceFactory.getOrcidSynchronizationService();
        this.configurationService = DSpaceServicesFactory.getInstance().getConfigurationService();

        if (commandLine.hasOption('f')) {
            ignoreMaxAttempts = true;
        }

    }

    @Override
    public void internalRun() throws Exception {

        if (isOrcidSynchronizationDisabled()) {
            handler.logWarning("The ORCID synchronization is disabled. The script cannot proceed");
            return;
        }

        context = new Context();
        assignCurrentUserInContext();

        try {
            context.turnOffAuthorisationSystem();
            performBulkSynchronization();
            context.complete();
        } catch (Exception e) {
            handler.handleException(e);
            context.abort();
        } finally {
            context.restoreAuthSystemState();
        }
    }

    /**
     * Find all the Orcid Queue records that need to be synchronized and perform the
     * synchronization.
     */
    private void performBulkSynchronization() throws SQLException {

        List queueRecords = findQueueRecordsToSynchronize();
        handler.logInfo("Found " + queueRecords.size() + " queue records to synchronize with ORCID");

        for (OrcidQueue queueRecord : queueRecords) {
            performSynchronization(queueRecord);
        }

    }

    /**
     * Returns all the stored Orcid Queue records (ignoring or not the max attempts)
     * related to a profile that has the synchronization mode set to BATCH.
     */
    private List findQueueRecordsToSynchronize() throws SQLException {
        return findQueueRecords().stream()
            .filter(record -> getProfileItemSynchronizationMode(record.getProfileItem()) == BATCH)
            .collect(Collectors.toList());
    }

    /**
     * If the current script execution is configured to ignore the max attempts,
     * returns all the ORCID Queue records, otherwise returns the ORCID Queue
     * records that has an attempts value less than the configured max attempts
     * value.
     */
    private List findQueueRecords() throws SQLException {
        if (ignoreMaxAttempts) {
            return orcidQueueService.findAll(context);
        } else {
            int attempts = configurationService.getIntProperty("orcid.bulk-synchronization.max-attempts");
            return orcidQueueService.findByAttemptsLessThan(context, attempts);
        }
    }

    /**
     * Try to synchronize the given queue record with ORCID, handling any errors.
     */
    private void performSynchronization(OrcidQueue queueRecord) {

        try {

            queueRecord = reload(queueRecord);

            handler.logInfo(getOperationInfoMessage(queueRecord));

            OrcidHistory orcidHistory = orcidHistoryService.synchronizeWithOrcid(context, queueRecord, false);

            handler.logInfo(getSynchronizationResultMessage(orcidHistory));

            commitTransaction();

        } catch (OrcidValidationException ex) {
            rollbackTransaction();
            handler.logError(getValidationErrorMessage(ex));
        } catch (Exception ex) {
            rollbackTransaction();
            String errorMessage = getUnexpectedErrorMessage(ex);
            LOGGER.error(errorMessage, ex);
            handler.logError(errorMessage);
        } finally {
            incrementAttempts(queueRecord);
        }

    }

    /**
     * Returns the Synchronization mode related to the given profile item.
     */
    private OrcidSynchronizationMode getProfileItemSynchronizationMode(Item profileItem) {
        OrcidSynchronizationMode synchronizationMode = synchronizationModeByProfileItem.get(profileItem);
        if (synchronizationMode == null) {
            synchronizationMode = orcidSynchronizationService.getSynchronizationMode(profileItem).orElse(MANUAL);
            synchronizationModeByProfileItem.put(profileItem, synchronizationMode);
        }
        return synchronizationMode;
    }

    /**
     * Returns an info log message with the details of the given record's operation.
     * This message is logged before ORCID synchronization.
     */
    private String getOperationInfoMessage(OrcidQueue record) {

        UUID profileItemId = record.getProfileItem().getID();
        String putCode = record.getPutCode();
        String type = record.getRecordType();

        if (record.getOperation() == null) {
            return "Synchronization of " + type + " data for profile with ID: " + profileItemId;
        }

        switch (record.getOperation()) {
            case INSERT:
                return "Addition of " + type + " for profile with ID: " + profileItemId;
            case UPDATE:
                return "Update of " + type + " for profile with ID: " + profileItemId + " by put code " + putCode;
            case DELETE:
                return "Deletion of " + type + " for profile with ID: " + profileItemId + " by put code " + putCode;
            default:
                return "Synchronization of " + type + " data for profile with ID: " + profileItemId;
        }

    }

    /**
     * Returns an info log message with the details of the synchronization result.
     * This message is logged after ORCID synchronization.
     */
    private String getSynchronizationResultMessage(OrcidHistory orcidHistory) {

        String message = "History record created with status " + orcidHistory.getStatus();

        switch (orcidHistory.getStatus()) {
            case 201:
            case 200:
            case 204:
                message += ". The operation was completed successfully";
                break;
            case 400:
                message += ". The resource sent to ORCID registry is not valid";
                break;
            case 404:
                message += ". The resource does not exists anymore on the ORCID registry";
                break;
            case 409:
                message += ". The resource is already present on the ORCID registry";
                break;
            case 500:
                message += ". An internal server error on ORCID registry side occurs";
                break;
            default:
                message += ". Details: " + orcidHistory.getResponseMessage();
                break;
        }

        return message;

    }

    private String getValidationErrorMessage(OrcidValidationException ex) {
        return ex.getMessage();
    }

    private String getUnexpectedErrorMessage(Exception ex) {
        return "An unexpected error occurs during the synchronization: " + getRootMessage(ex);
    }

    private void incrementAttempts(OrcidQueue queueRecord) {
        queueRecord = reload(queueRecord);
        if (queueRecord == null) {
            return;
        }

        try {
            queueRecord.setAttempts(queueRecord.getAttempts() != null ? queueRecord.getAttempts() + 1 : 1);
            orcidQueueService.update(context, queueRecord);
            commitTransaction();
        } catch (SQLException e) {
            throw new RuntimeException(e);
        }

    }

    /**
     * This method will assign the currentUser to the {@link Context}. The instance
     * of the method in this class will fetch the EPersonIdentifier from this class,
     * this identifier was given to this class upon instantiation, it'll then be
     * used to find the {@link EPerson} associated with it and this {@link EPerson}
     * will be set as the currentUser of the created {@link Context}
     */
    private void assignCurrentUserInContext() throws SQLException {
        UUID uuid = getEpersonIdentifier();
        if (uuid != null) {
            EPerson ePerson = EPersonServiceFactory.getInstance().getEPersonService().find(context, uuid);
            context.setCurrentUser(ePerson);
        }
    }

    private OrcidQueue reload(OrcidQueue queueRecord) {
        try {
            return context.reloadEntity(queueRecord);
        } catch (SQLException e) {
            throw new RuntimeException(e);
        }
    }

    private void commitTransaction() {
        try {
            context.commit();
        } catch (SQLException e) {
            throw new RuntimeException(e);
        }
    }

    private void rollbackTransaction() {
        try {
            context.rollback();
        } catch (SQLException e) {
            throw new RuntimeException(e);
        }
    }

    private String getRootMessage(Exception ex) {
        String message = ExceptionUtils.getRootCauseMessage(ex);
        return isNotEmpty(message) ? message.substring(message.indexOf(":") + 1).trim() : "Generic error";
    }

    private boolean isOrcidSynchronizationDisabled() {
        return !configurationService.getBooleanProperty("orcid.synchronization-enabled", true);
    }

    @Override
    @SuppressWarnings("unchecked")
    public OrcidBulkPushScriptConfiguration getScriptConfiguration() {
        return new DSpace().getServiceManager().getServiceByName("orcid-bulk-push",
            OrcidBulkPushScriptConfiguration.class);
    }

}