Prompt for operator name

README.md

@@ -79,23 +79,23 @@ The Tabulator includes several example contest configuration files and associate
 
 ## Command-Line Interface
 
-Alternatively, you can run the Tabulator using the command-line interface by including the flag `-cli` and then supplying a path to an existing config file, e.g.:
+Alternatively, you can run the Tabulator using the command-line interface by including the flag `--cli` and then supplying a path to an existing config file, e.g.:
 
-`$ rcv -cli path/to/config`
+`$ rcv --cli path/to/config`
 
 Or, if you're compiling and running using Gradle:
 
-`$ gradlew run --args="-cli path/to/config"`
+`$ gradlew run --args="--cli path/to/config"`
 
 You can also activate a special `convert-to-cdf` function via the command line to export the CVR as a NIST common data format (CDF) .json instead of tabulating the results, e.g.:
 
-`$ rcv -cli path/to/config convert-to-cdf`
+`$ rcv --cli path/to/config convert-to-cdf`
 
 This option is available in the GUI by selecting the "Conversion > Convert CVRs in Current Config to CDF" menu option.
 
 Or, again, if you're compiling and running using Gradle:
 
-`$ gradlew run --args="-cli path/to/config  convert-to-cdf"`
+`$ gradlew run --args="--cli path/to/config  convert-to-cdf"`
 
 Note: if you convert a source to CDF and that source uses an overvoteLabel or an undeclaredWriteInLabel, the label will be represented differently in the generated CDF source file than it was in the original CVR source. When you create a new config using this generated CDF source file and you need to set overvoteLabel, you should use "overvote". If you need to set undeclaredWriteInLabel, you should use "Undeclared Write-ins".
 

build.gradle

@@ -16,6 +16,7 @@ repositories {
 dependencies {
     implementation 'org.apache.commons:commons-csv:1.9.0'
     implementation 'org.apache.poi:poi-ooxml:5.2.2'
+    implementation 'commons-cli:commons-cli:1.5.0'
     implementation 'com.fasterxml.jackson.core:jackson-core:2.13.3'
     implementation 'com.fasterxml.jackson.core:jackson-annotations:2.13.3'
     implementation 'com.fasterxml.jackson.core:jackson-databind:2.13.3'
@@ -29,11 +30,11 @@ application {
     mainClass = "${moduleName}.Main"
 }
 
-// Uncomment below to simulate running from the CLI
-//run {
-//    standardInput = System.in
-//    args = ["-cli", "path/to/config"]
-//}
+// Required to accept a name and tiebreak interactively via CLI
+run {
+    standardInput = System.in
+    args = ["-cli", "path/to/config"]
+}
 
 // ### Checkstyle plugin settings
 checkstyle {

src/main/java/module-info.java

@@ -11,6 +11,7 @@
   requires javafx.graphics;
   requires java.xml;
   requires org.apache.poi.ooxml;
+  requires commons.cli;
   // enable reflexive calls from network.brightspots.rcv into javafx.fxml
   opens network.brightspots.rcv;
   // our main module

src/main/java/network/brightspots/rcv/GuiConfigController.java

@@ -68,6 +68,7 @@
 import javafx.scene.control.TableView;
 import javafx.scene.control.TextArea;
 import javafx.scene.control.TextField;
+import javafx.scene.control.TextInputDialog;
 import javafx.scene.control.cell.PropertyValueFactory;
 import javafx.stage.DirectoryChooser;
 import javafx.stage.FileChooser;
@@ -460,6 +461,7 @@ public void menuItemTabulateClicked() {
     if (filePathAndTempStatus != null) {
       if (GuiContext.getInstance().getConfig() != null) {
         setGuiIsBusy(true);
+        askUserForName();
         TabulatorService service = new TabulatorService(
             filePathAndTempStatus.getKey(), filePathAndTempStatus.getValue());
         setUpAndStartService(service);
@@ -478,6 +480,7 @@ public void menuItemConvertToCdfClicked() {
     if (filePathAndTempStatus != null) {
       if (GuiContext.getInstance().getConfig() != null) {
         setGuiIsBusy(true);
+        askUserForName();
         ConvertToCdfService service = new ConvertToCdfService(
             filePathAndTempStatus.getKey(), filePathAndTempStatus.getValue());
         setUpAndStartService(service);
@@ -945,6 +948,21 @@ private ConfigComparisonResult compareConfigs() {
     return comparisonResult;
   }
 
+  private void askUserForName() {
+    TextInputDialog dialog = new TextInputDialog();
+    dialog.setTitle("Enter your name");
+    dialog.setHeaderText("For auditing purposes, enter the name(s) of everyone currently "
+        + "operating this machine.");
+    dialog.setContentText("Name:");
+    Optional<String> result = dialog.showAndWait();
+
+    if (result.isPresent()) {
+      Logger.info("Name(s) of operators, as entered interactively: " + result.get());
+    } else {
+      Logger.info("Operator(s) did not enter a name.");
+    }
+  }
+
   private boolean checkForSaveAndContinue() {
     boolean willContinue = false;
     ConfigComparisonResult comparisonResult = compareConfigs();

src/main/java/network/brightspots/rcv/Main.java

@@ -17,8 +17,17 @@
 
 package network.brightspots.rcv;
 
-import java.util.ArrayList;
-import java.util.List;
+import java.nio.charset.StandardCharsets;
+import java.util.Arrays;
+import java.util.Scanner;
+import java.util.stream.Stream;
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.CommandLineParser;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.HelpFormatter;
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.apache.commons.cli.ParseException;
 
 /**
  * Main entry point to RCTab.
@@ -42,41 +51,36 @@ public static void main(String[] args) {
     Logger.setup();
     logSystemInfo();
 
-    // Determine if user intends to use the command-line interface, and gather args if so
-    boolean useCli = false;
-    List<String> argsCli = new ArrayList<>();
-    for (String arg : args) {
-      if (!useCli && arg.equals("-cli")) {
-        useCli = true;
-      } else if (useCli) {
-        argsCli.add(arg);
-      }
-    }
-
-    if (!useCli) {
-      // Launch the GUI
+    // Check if args contains string "--cli"
+    if (Arrays.stream(args).filter(arg -> arg.equals("--cli")).findAny().isEmpty()) {
+      // --cli not found. Launch the GUI
       launch(args);
     } else {
-      Logger.info("Tabulator is being used via the CLI.");
-      // Check for unexpected input
-      if (argsCli.size() == 0) {
-        Logger.severe(
-            """
-                No config file path provided on command line!
-                Please provide a path to the config file!
-                See README.md for more details.""");
-        System.exit(1);
-      } else if (argsCli.size() > 2) {
-        Logger.severe(
-            "Too many arguments! Max is 2 but got: %d\n" + "See README.md for more details.",
-            argsCli.size());
-        System.exit(2);
+      CommandLine cmd = parseArgsForCli(args);
+      String path = cmd.getOptionValue("cli");
+      String name = cmd.getOptionValue("name");
+      Boolean convertToCdf = cmd.hasOption("convert-to-cdf");
+
+      if (name == null || name.isEmpty()) {
+        // Prompt user for their name
+        System.out.println("Enter name(s) of operators for auditing purposes:");
+
+        Scanner sc = new Scanner(System.in, StandardCharsets.UTF_8);
+        if (sc.hasNextLine()) {
+          name = sc.nextLine();
+          Logger.info("Name(s) of operators, as entered interactively: " + name);
+        } else {
+          Logger.severe("Must supply name(s) as a CLI argument or run on an interactive shell");
+          System.exit(1);
+        }
+      } else {
+        Logger.info("Name(s) of operators, as entered in a command-line argument: " + name);
       }
-      // Path to either: config file for configuring the tabulator, or Dominion JSONs
-      String providedPath = argsCli.get(0);
-      // Session object will manage the tabulation process
-      TabulatorSession session = new TabulatorSession(providedPath);
-      if (argsCli.size() == 2 && argsCli.get(1).equals("convert-to-cdf")) {
+
+      Logger.info("Tabulator is being used via the CLI");
+
+      TabulatorSession session = new TabulatorSession(path);
+      if (convertToCdf) {
         session.convertToCdf();
       } else {
         session.tabulate();
@@ -86,6 +90,44 @@ public static void main(String[] args) {
     System.exit(0);
   }
 
+  // Call this function if using the command line interface. Do not call if --cli
+  // has not been passed as an argument; it will fail.
+  private static CommandLine parseArgsForCli(String[] args) {
+    // Remove all args that start with "-D" -- these are added automatically when running via
+    // IntelliJ
+    Stream<String> filteredArgs = Arrays.stream(args).filter(arg -> !arg.startsWith("-D"));
+    args = filteredArgs.toArray(String[]::new);
+
+    Options options = new Options();
+
+    Option inputPath = new Option("c", "cli", true, "launch command-line version");
+    inputPath.setRequired(true);
+    options.addOption(inputPath);
+
+    Option doConvert = new Option("x", "convert-to-cdf", false, "convert to CDF");
+    doConvert.setRequired(false);
+    options.addOption(doConvert);
+
+    Option name = new Option("n", "name", true, "name of current operator");
+    name.setRequired(false);
+    options.addOption(name);
+
+    CommandLineParser parser = new DefaultParser();
+    CommandLine cmd = null;
+
+    try {
+      cmd = parser.parse(options, args);
+    } catch (ParseException e) {
+      Logger.severe(e.getMessage());
+      HelpFormatter formatter = new HelpFormatter();
+      formatter.printHelp("RCTab", options);
+
+      System.exit(1);
+    }
+
+    return cmd;
+  }
+
   private static void logSystemInfo() {
     Logger.info("Launching %s version %s...", APP_NAME, APP_VERSION);
     Logger.info(

src/main/java/network/brightspots/rcv/TabulatorSession.java

@@ -67,7 +67,7 @@ private static void checkConfigVersionMatchesApp(ContestConfig config) {
         Logger.severe(
             "Can't use a config with older version %s in newer version %s of the app! To "
                 + "automatically migrate the config to the newer version, load it in the graphical "
-                + "version of the app (i.e. don't use the -cli flag when starting the tabulator).",
+                + "version of the app (i.e. don't use the --cli flag when starting the tabulator).",
             version, Main.APP_VERSION);
       }
     }