org.dspace.embargo.EmbargoCLITool 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.
There is a newer version: 8.0
/**
 * 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.embargo;

import java.io.IOException;
import java.sql.SQLException;
import java.util.Date;
import java.util.Iterator;
import java.util.List;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.logging.log4j.Logger;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.DCDate;
import org.dspace.content.DSpaceObject;
import org.dspace.content.Item;
import org.dspace.content.MetadataValue;
import org.dspace.core.Constants;
import org.dspace.core.Context;
import org.dspace.embargo.factory.EmbargoServiceFactory;
import org.dspace.embargo.service.EmbargoService;
import org.dspace.handle.factory.HandleServiceFactory;

/**
 * CLI class for the embargo service
 *
 * @author kevinvandevelde at atmire.com
 */
public class EmbargoCLITool {

    /**
     * log4j category
     */
    private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(EmbargoServiceImpl.class);

    private static final EmbargoService embargoService = EmbargoServiceFactory.getInstance().getEmbargoService();

    /**
     * Default constructor
     */
    private EmbargoCLITool() { }

    /**
     * Command-line service to scan for every Item with an expired embargo,
     * and then lift that embargo.
     * 
     * Options:
     * 

     * -c,--check
     *          Function: ONLY check the state of embargoed Items, do
     * NOT lift any embargoes.
     * -h,--help
     *          Help.
     * -i,--identifier
     *          Process ONLY this Handle identifier(s), which must be
     * an Item.  Can be repeated.
     * -l,--lift
     *          Function: ONLY lift embargoes, do NOT check the state
     * of any embargoed Items.
     * -n,--dryrun
     *          Do not change anything in the data model; print
     * message instead.
     * -v,--verbose
     *          Print a line describing action taken for each
     * embargoed Item found.
     * -q,--quiet
     *          No output except upon error.
     * 
     *
     * @param argv the command line arguments given
     */
    public static void main(String argv[]) {
        int status = 0;

        Options options = new Options();
        options.addOption("v", "verbose", false,
                          "Print a line describing action taken for each embargoed Item found.");
        options.addOption("q", "quiet", false,
                          "Do not print anything except for errors.");
        options.addOption("n", "dryrun", false,
                          "Do not change anything in the data model, print message instead.");
        options.addOption("i", "identifier", true,
                          "Process ONLY this Handle identifier(s), which must be an Item.  Can be repeated.");
        options.addOption("c", "check", false,
                          "Function: ONLY check the state of embargoed Items, do NOT lift any embargoes.");
        options.addOption("l", "lift", false,
                          "Function: ONLY lift embargoes, do NOT check the state of any embargoed Items.");

        options.addOption("a", "adjust", false,
                          "Function: Adjust bitstreams policies");

        options.addOption("h", "help", false, "help");
        CommandLine line = null;
        try {
            line = new DefaultParser().parse(options, argv);
        } catch (ParseException e) {
            System.err.println("Command error: " + e.getMessage());
            new HelpFormatter().printHelp(EmbargoServiceImpl.class.getName(), options);
            System.exit(1);
        }

        if (line.hasOption('h')) {
            new HelpFormatter().printHelp(EmbargoServiceImpl.class.getName(), options);
            System.exit(0);
        }

        // sanity check, --lift and --check are mutually exclusive:
        if (line.hasOption('l') && line.hasOption('c')) {
            System.err.println("Command error: --lift and --check are mutually exclusive, try --help for assistance.");
            System.exit(1);
        }

        Context context = null;
        try {
            context = new Context(Context.Mode.BATCH_EDIT);
            context.turnOffAuthorisationSystem();
            Date now = new Date();

            // scan items under embargo
            if (line.hasOption('i')) {
                for (String handle : line.getOptionValues('i')) {
                    DSpaceObject dso = HandleServiceFactory.getInstance().getHandleService()
                                                           .resolveToObject(context, handle);
                    if (dso == null) {
                        System.err.println("Error, cannot resolve handle=" + handle + " to a DSpace Item.");
                        status = 1;
                    } else if (dso.getType() != Constants.ITEM) {
                        System.err.println("Error, the handle=" + handle + " is not a DSpace Item.");
                        status = 1;
                    } else {
                        if (processOneItem(context, (Item) dso, line, now)) {
                            status = 1;
                        }
                    }
                }
            } else {
                Iterator ii = embargoService.findItemsByLiftMetadata(context);
                while (ii.hasNext()) {
                    Item item = ii.next();
                    if (processOneItem(context, item, line, now)) {
                        status = 1;
                    }
                    context.uncacheEntity(item);
                }
            }
            context.complete();
            context = null;
        } catch (Exception e) {
            System.err.println("ERROR, got exception: " + e);
            e.printStackTrace();
            status = 1;
        } finally {
            if (context != null) {
                try {
                    context.abort();
                } catch (Exception e) {
                    // ignore
                }
            }
        }
        System.exit(status);
    }


    // lift or check embargo on one Item, handle exceptions
    // return false on success, true if there was fatal exception.
    protected static boolean processOneItem(Context context, Item item, CommandLine line, Date now)
        throws Exception {
        boolean status = false;
        List lift = embargoService.getLiftMetadata(context, item);

        if (lift.size() > 0) {
            DCDate liftDate = new DCDate(lift.get(0).getValue());
            // need to survive any failure on a single item, go on to process the rest.
            try {
                if (line.hasOption('a')) {
                    embargoService.setEmbargo(context, item);
                } else {
                    log.debug("Testing embargo on item=" + item.getHandle() + ", date=" + liftDate.toString());
                    if (liftDate.toDate().before(now)) {
                        if (line.hasOption('v')) {
                            System.err.println(
                                "Lifting embargo from Item handle=" + item.getHandle() + ", lift date=" +
                                    lift.get(0).getValue());
                        }
                        if (line.hasOption('n')) {
                            if (!line.hasOption('q')) {
                                System.err.println("DRY RUN: would have lifted embargo from Item handle=" + item
                                    .getHandle() + ", lift date=" + lift.get(0).getValue());
                            }
                        } else if (!line.hasOption('c')) {
                            embargoService.liftEmbargo(context, item);
                        }
                    } else if (!line.hasOption('l')) {
                        if (line.hasOption('v')) {
                            System.err.println(
                                "Checking current embargo on Item handle=" + item.getHandle() + ", lift date=" + lift
                                    .get(0).getValue());
                        }
                        embargoService.checkEmbargo(context, item);
                    }
                }
            } catch (IOException | SQLException | AuthorizeException e) {
                log.error("Failed attempting to lift embargo, item=" + item.getHandle() + ": ", e);
                System.err.println("Failed attempting to lift embargo, item=" + item.getHandle() + ": " + e);
                status = true;
            }
        }
        return status;
    }
}