Merge pull request DSpace#10412 from minurmin/checker-clarifications

tdonohue · web-flow · commit 80758a7692e8 · 2025-11-17T13:49:13.000-06:00
Clarify checker and checker-emailer -related command line options, messages and report formatting
diff --git a/dspace-api/src/main/java/org/dspace/app/checker/ChecksumChecker.java b/dspace-api/src/main/java/org/dspace/app/checker/ChecksumChecker.java
@@ -97,15 +97,15 @@ public static void main(String[] args) throws SQLException {
         options.addOption("h", "help", false, "Help");
         options.addOption("d", "duration", true, "Checking duration");
         options.addOption("c", "count", true, "Check count");
-        options.addOption("a", "handle", true, "Specify a handle to check");
+        options.addOption("i", "handle", true, "Specify a handle to check");
         options.addOption("v", "verbose", false, "Report all processing");
 
         Option option;
 
         option = Option.builder("b")
                 .longOpt("bitstream-ids")
                 .hasArgs()
-                .desc("Space separated list of bitstream ids")
+                .desc("Space separated list of bitstream UUIDs")
                 .build();
         options.addOption(option);
 
@@ -131,6 +131,17 @@ public static void main(String[] args) throws SQLException {
         try {
             context = new Context();
 
+            int mutuallyExclusiveOpts = 0;
+            for (char c : new char[]{'l', 'L', 'd', 'b', 'i','c'}) {
+                if (line.hasOption(c)) {
+                    mutuallyExclusiveOpts++;
+                }
+            }
+            if (mutuallyExclusiveOpts > 1) {
+                System.err.println("Please use only one option of -l, -L, -d, -b, -i, or -c");
+                LOG.error("Please use only one option of -l, -L, -d, -b, -i, or -c");
+                System.exit(1);
+            }
 
             // Prune stage
             if (line.hasOption('p')) {
@@ -168,20 +179,22 @@ public static void main(String[] args) throws SQLException {
                         bitstreams.add(bitstreamService.find(context, UUID.fromString(ids[i])));
                     } catch (NumberFormatException nfe) {
                         System.err.println("The following argument: " + ids[i]
-                                               + " is not an integer");
+                                               + " is not an UUID");
                         System.exit(0);
                     }
                 }
                 dispatcher = new IteratorDispatcher(bitstreams.iterator());
-            } else if (line.hasOption('a')) {
-                dispatcher = new HandleDispatcher(context, line.getOptionValue('a'));
+            } else if (line.hasOption('i')) {
+                dispatcher = new HandleDispatcher(context, line.getOptionValue('i'));
             } else if (line.hasOption('d')) {
                 // run checker process for specified duration
                 try {
                     dispatcher = new LimitedDurationDispatcher(
                         new SimpleDispatcher(context, processStart, true), Instant.ofEpochMilli(
                         Instant.now().toEpochMilli() + Utils.parseDuration(line.getOptionValue('d'))));
                 } catch (Exception e) {
+                    System.err.println("Couldn't parse " + line.getOptionValue('d')
+                                  + " as a duration");
                     LOG.fatal("Couldn't parse " + line.getOptionValue('d')
                                   + " as a duration: ", e);
                     System.exit(0);
@@ -225,18 +238,24 @@ public static void main(String[] args) throws SQLException {
     private static void printHelp(Options options) {
         HelpFormatter myhelp = new HelpFormatter();
 
-        myhelp.printHelp("Checksum Checker\n", options);
-        System.out.println("\nSpecify a duration for checker process, using s(seconds),"
-                               + "m(minutes), or h(hours): ChecksumChecker -d 30s"
-                               + " OR ChecksumChecker -d 30m"
-                               + " OR ChecksumChecker -d 2h");
-        System.out.println("\nSpecify bitstream IDs: ChecksumChecker -b 13 15 17 20");
-        System.out.println("\nLoop once through all bitstreams: "
-                               + "ChecksumChecker -l");
-        System.out.println("\nLoop continuously through all bitstreams: ChecksumChecker -L");
-        System.out.println("\nCheck a defined number of bitstreams: ChecksumChecker -c 10");
-        System.out.println("\nReport all processing (verbose)(default reports only errors): ChecksumChecker -v");
-        System.out.println("\nDefault (no arguments) is equivalent to '-c 1'");
+        myhelp.printHelp("checker\n", options);
+        System.out.println("\nChecksum Checker usage examples:");
+        System.out.println("\nThe following options are mutually exclusive:");
+        System.out.println(" - Specify a duration for checker process, using s(seconds),"
+                               + "m(minutes), or h(hours): checker -d 30s"
+                               + " OR checker -d 30m"
+                               + " OR checker -d 2h");
+        System.out.println(" - Specify bitstream UUIDs: checker -b 550e8400-e29b-41d4-a716-446655440000"
+                               + " f3f2e850-b5d4-11ef-ac7e-96584d5248b2");
+        System.out.println(" - Specify handle: checker -i 12345/100");
+        System.out.println(" - Loop once through all bitstreams: "
+                               + "checker -l");
+        System.out.println(" - Loop continuously through all bitstreams: checker -L");
+        System.out.println(" - Check a defined number of bitstreams: checker -c 10");
+        System.out.println("\nThe following options can be used in combination with others above:");
+        System.out.println(" - Report all processing to checker.log (by default logs only errors): checker -v");
+        System.out.println(" - Prune old results from the database: checker -p");
+        System.out.println("\nDefault (no arguments) is equivalent to 'checker -c 1'\n");
         System.exit(0);
     }
 
diff --git a/dspace-api/src/main/java/org/dspace/checker/DailyReportEmailer.java b/dspace-api/src/main/java/org/dspace/checker/DailyReportEmailer.java
@@ -75,6 +75,7 @@ public void sendReport(File attachment, int numberOfBitstreams)
             email.setContent("Checker Report", "report is attached ...");
             email.addAttachment(attachment, "checksum_checker_report.txt");
             email.addRecipient(configurationService.getProperty("mail.admin"));
+            log.info("Sending checker report email to " + configurationService.getProperty("mail.admin"));
             email.send();
         }
     }
@@ -109,18 +110,19 @@ public static void main(String[] args) {
         Options options = new Options();
 
         options.addOption("h", "help", false, "Help");
-        options.addOption("d", "Deleted", false,
-                          "Send E-mail report for all bitstreams set as deleted for today");
-        options.addOption("m", "Missing", false,
-                          "Send E-mail report for all bitstreams not found in assetstore for today");
-        options.addOption("c", "Changed", false,
-                          "Send E-mail report for all bitstreams where checksum has been changed for today");
-        options.addOption("a", "All", false,
-                          "Send all E-mail reports");
-        options.addOption("u", "Unchecked", false,
-                          "Send the Unchecked bitstream report");
-        options.addOption("n", "Not Processed", false,
-                          "Send E-mail report for all bitstreams set to longer be processed for today");
+        options.addOption("d", "deleted", false,
+                          "Send email report for all bitstreams set as deleted for today");
+        options.addOption("m", "missing", false,
+                          "Send email report for all bitstreams not found in assetstore for today");
+        options.addOption("c", "changed", false,
+                          "Send email report for all bitstreams where checksum has been changed for today");
+        options.addOption("a", "all", false,
+                          "Send all email reports (used by default)");
+        options.addOption("u", "unchecked", false,
+                          "Send the unchecked (i.e. recently added) bitstream email report");
+        options.addOption("n", "not-processed", false,
+                          "Send email report for all bitstreams set to no longer be processed for today (includes"
+                            + " bitstreams marked as deleted or not found)");
 
         try {
             line = parser.parse(options, args);
@@ -133,13 +135,15 @@ public static void main(String[] args) {
         if (line.hasOption('h')) {
             HelpFormatter myhelp = new HelpFormatter();
 
-            myhelp.printHelp("Checksum Reporter\n", options);
-            System.out.println("\nSend Deleted bitstream email report: DailyReportEmailer -d");
-            System.out.println("\nSend Missing bitstreams email report: DailyReportEmailer -m");
-            System.out.println("\nSend Checksum Changed email report: DailyReportEmailer -c");
-            System.out.println("\nSend bitstream not to be processed email report: DailyReportEmailer -n");
-            System.out.println("\nSend Un-checked bitstream report: DailyReportEmailer -u");
-            System.out.println("\nSend All email reports: DailyReportEmailer");
+            myhelp.printHelp("checker-emailer\n", options);
+            System.out.println("\nChecksum Checker Reporter usage examples:\n");
+            System.out.println(" - Send all email reports: checker-emailer -a");
+            System.out.println(" - Send deleted bitstream email report: checker-emailer -d");
+            System.out.println(" - Send missing bitstreams email report: checker-emailer -m");
+            System.out.println(" - Send checksum changed email report: checker-emailer -c");
+            System.out.println(" - Send bitstream not to be processed email report: checker-emailer -n");
+            System.out.println(" - Send unchecked bitstream email report: checker-emailer -u");
+            System.out.println("\nDefault (no arguments) is equivalent to 'checker-emailer -a'\n");
             System.exit(0);
         }
 
@@ -186,7 +190,9 @@ public static void main(String[] args) {
                 writer.write("\n--------------------------------- Report Spacer ---------------------------\n\n");
                 numBitstreams += reporter.getBitstreamNotFoundReport(context, yesterday, tomorrow, writer);
                 writer.write("\n--------------------------------- Report Spacer ---------------------------\n\n");
-                numBitstreams += reporter.getNotToBeProcessedReport(context, yesterday, tomorrow, writer);
+                // not to be processed report includes deleted and not found bitstreams so it is not necessary to
+                // include the sum in the counter
+                reporter.getNotToBeProcessedReport(context, yesterday, tomorrow, writer);
                 writer.write("\n--------------------------------- Report Spacer ---------------------------\n\n");
                 numBitstreams += reporter.getUncheckedBitstreamsReport(context, writer);
                 writer.write("\n--------------------------------- End Report ---------------------------\n\n");
diff --git a/dspace-api/src/main/java/org/dspace/checker/SimpleReporterServiceImpl.java b/dspace-api/src/main/java/org/dspace/checker/SimpleReporterServiceImpl.java
@@ -72,6 +72,7 @@ public int getDeletedBitstreamReport(Context context, Instant startDate, Instant
 
         osw.write("\n");
         osw.write(msg("deleted-bitstream-intro"));
+        osw.write(" ");
         osw.write(applyDateFormatShort(startDate));
         osw.write(" ");
         osw.write(msg("date-range-to"));
@@ -113,7 +114,6 @@ public int getChangedChecksumReport(Context context, Instant startDate, Instant
         osw.write("\n");
         osw.write(msg("checksum-did-not-match"));
         osw.write(" ");
-        osw.write("\n");
         osw.write(applyDateFormatShort(startDate));
         osw.write(" ");
         osw.write(msg("date-range-to"));
diff --git a/dspace-api/src/main/java/org/dspace/checker/service/SimpleReporterService.java b/dspace-api/src/main/java/org/dspace/checker/service/SimpleReporterService.java
@@ -72,7 +72,8 @@ public int getBitstreamNotFoundReport(Context context, Instant startDate, Instan
 
     /**
      * The bitstreams that were set to not be processed report for the specified
-     * date range.
+     * date range. This includes bitstreams that are marked as deleted and bitstreams
+     * that are not found from the assetstore.
      *
      * @param context   context
      * @param startDate the start date range.
diff --git a/dspace-api/src/main/resources/Messages.properties b/dspace-api/src/main/resources/Messages.properties
@@ -70,20 +70,20 @@ org.dspace.checker.ResultsLogger.store-number
 org.dspace.checker.ResultsLogger.to-be-processed                                = To be processed
 org.dspace.checker.ResultsLogger.user-format-description                        = User format description
 org.dspace.checker.SimpleReporterImpl.bitstream-id                              = Bitstream Id
-org.dspace.checker.SimpleReporterImpl.bitstream-not-found-report                = The following is a BITSTREAM NOT FOUND report for
-org.dspace.checker.SimpleReporterImpl.bitstream-will-no-longer-be-processed     = The following is a BITSTREAM WILL NO LONGER BE PROCESSED report for
+org.dspace.checker.SimpleReporterImpl.bitstream-not-found-report                = The following is a BITSTREAM NOT FOUND report from
+org.dspace.checker.SimpleReporterImpl.bitstream-will-no-longer-be-processed     = The following is a BITSTREAM WILL NO LONGER BE PROCESSED report from
 org.dspace.checker.SimpleReporterImpl.check-id                                  = Check Id
 org.dspace.checker.SimpleReporterImpl.checksum                                  = Checksum
 org.dspace.checker.SimpleReporterImpl.checksum-algorithm                        = Checksum Algorithm
 org.dspace.checker.SimpleReporterImpl.checksum-calculated                       = Checksum Calculated
-org.dspace.checker.SimpleReporterImpl.checksum-did-not-match                    = The following is a CHECKSUM DID NOT MATCH report for
+org.dspace.checker.SimpleReporterImpl.checksum-did-not-match                    = The following is a CHECKSUM DID NOT MATCH report from
 org.dspace.checker.SimpleReporterImpl.checksum-expected                         = Checksum Expected
 org.dspace.checker.SimpleReporterImpl.date-range-to                             = to
 org.dspace.checker.SimpleReporterImpl.deleted                                   = Deleted
-org.dspace.checker.SimpleReporterImpl.deleted-bitstream-intro                   = The following is a BITSTREAM SET DELETED report for
+org.dspace.checker.SimpleReporterImpl.deleted-bitstream-intro                   = The following is a BITSTREAM SET DELETED report from
 org.dspace.checker.SimpleReporterImpl.description                               = Description
 org.dspace.checker.SimpleReporterImpl.format-id                                 = Format Id
-org.dspace.checker.SimpleReporterImpl.howto-add-unchecked-bitstreams            = To add these bitstreams to be checked run the checksum checker with the -u option
+org.dspace.checker.SimpleReporterImpl.howto-add-unchecked-bitstreams            = To add these bitstreams to be checked run the checksum checker again
 org.dspace.checker.SimpleReporterImpl.internal-id                               = Internal Id
 org.dspace.checker.SimpleReporterImpl.name                                      = Name
 org.dspace.checker.SimpleReporterImpl.no-bitstreams-changed                     = There were no bitstreams found with changed checksums

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,8 @@ public int getBitstreamNotFoundReport(Context context, Instant startDate, Instan`
`72`	`72`
`73`	`73`	`/**`
`74`	`74`	`* The bitstreams that were set to not be processed report for the specified`
`75`		`- * date range.`
	`75`	`+ * date range. This includes bitstreams that are marked as deleted and bitstreams`
	`76`	`+ * that are not found from the assetstore.`
`76`	`77`	`*`
`77`	`78`	`* @param context context`
`78`	`79`	`* @param startDate the start date range.`