[bugfix] Add missing CLI --help arguments

Author: adamretter

exist-core/src/main/java/org/exist/backup/ExportGUI.java

@@ -33,6 +33,9 @@
 import org.exist.util.MimeType;
 import org.exist.util.SystemExitCodes;
 import org.exist.xquery.TerminatedException;
+import se.softhouse.jargo.Argument;
+import se.softhouse.jargo.ArgumentException;
+import se.softhouse.jargo.CommandLineParser;
 
 import javax.swing.*;
 import javax.swing.filechooser.FileFilter;
@@ -48,6 +51,7 @@
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.exist.util.ThreadUtils.newGlobalThread;
 import static org.exist.util.ThreadUtils.newInstanceThread;
+import static se.softhouse.jargo.Arguments.helpArgument;
 
 
 /**
@@ -58,6 +62,9 @@
 public class ExportGUI extends javax.swing.JFrame {
     private static final long serialVersionUID = -8104424554660744639L;
 
+    /* general arguments */
+    private static final Argument<?> helpArg = helpArgument("-h", "--help");
+
     private BrokerPool pool = null;
     private int documentCount = 0;
     private PrintWriter logWriter = null;
@@ -613,13 +620,26 @@ private void closeLog() {
     public static void main(final String[] args) {
         try {
             CompatibleJavaVersionCheck.checkForCompatibleJavaVersion();
+
+            // parse command-line options
+            CommandLineParser
+                    .withArguments(helpArg)
+                    .parse(args);
+
         } catch (final StartException e) {
             if (e.getMessage() != null && !e.getMessage().isEmpty()) {
                 System.err.println(e.getMessage());
             }
             System.exit(e.getErrorCode());
+        } catch (final ArgumentException e) {
+            consoleOut(e.getMessageAndUsage().toString());
+            System.exit(SystemExitCodes.INVALID_ARGUMENT_EXIT_CODE);
         }
 
         java.awt.EventQueue.invokeLater(() -> new ExportGUI().setVisible(true));
     }
+
+    private static void consoleOut(final String msg) {
+        System.out.println(msg); //NOSONAR this has to go to the console
+    }
 }

exist-core/src/main/java/org/exist/jetty/JettyStart.java

@@ -44,11 +44,15 @@
 import org.exist.util.ConfigurationHelper;
 import org.exist.util.FileUtils;
 import org.exist.util.SingleInstanceConfiguration;
+import org.exist.util.SystemExitCodes;
 import org.exist.validation.XmlLibraryChecker;
 import org.exist.xmldb.DatabaseImpl;
 import org.exist.xmldb.ShutdownListener;
 import org.xmldb.api.DatabaseManager;
 import org.xmldb.api.base.Database;
+import se.softhouse.jargo.Argument;
+import se.softhouse.jargo.ArgumentException;
+import se.softhouse.jargo.CommandLineParser;
 
 import java.io.IOException;
 import java.io.LineNumberReader;
@@ -61,6 +65,7 @@
 import java.util.stream.Collectors;
 
 import static org.exist.util.ThreadUtils.newGlobalThread;
+import static se.softhouse.jargo.Arguments.helpArgument;
 
 /**
  * This class provides a main method to start Jetty with eXist. It registers shutdown
@@ -85,19 +90,32 @@ public class JettyStart extends Observable implements LifeCycle.Listener {
     private final static int STATUS_STOPPING = 2;
     private final static int STATUS_STOPPED = 3;
 
+    /* general arguments */
+    private static final Argument<?> helpArg = helpArgument("-h", "--help");
+
     @GuardedBy("this") private int status = STATUS_STOPPED;
     @GuardedBy("this") private Optional<Thread> shutdownHookThread = Optional.empty();
     @GuardedBy("this") private int primaryPort = 8080;
 
 
     public static void main(final String[] args) {
+        String jettyConfigFile = null;
+        Optional<String> existdbConfigFile = Optional.empty();
         try {
             CompatibleJavaVersionCheck.checkForCompatibleJavaVersion();
+
+            CommandLineParser
+                    .withArguments(helpArg)
+                    .parse(args);
+
         } catch (final StartException e) {
             if (e.getMessage() != null && !e.getMessage().isEmpty()) {
                 System.err.println(e.getMessage());
             }
             System.exit(e.getErrorCode());
+        } catch (final ArgumentException e) {
+            consoleOut(e.getMessageAndUsage().toString());
+            System.exit(SystemExitCodes.INVALID_ARGUMENT_EXIT_CODE);
         }
 
         final JettyStart start = new JettyStart();
@@ -109,6 +127,10 @@ public JettyStart() {
         XmlLibraryChecker.check();
     }
 
+    private static void consoleOut(final String msg) {
+        System.out.println(msg); //NOSONAR this has to go to the console
+    }
+
     public synchronized void run() {
         run(true);
     }

exist-core/src/main/java/org/exist/launcher/LauncherWrapper.java

@@ -24,6 +24,10 @@
 import org.exist.start.CompatibleJavaVersionCheck;
 import org.exist.start.StartException;
 import org.exist.util.ConfigurationHelper;
+import org.exist.util.SystemExitCodes;
+import se.softhouse.jargo.Argument;
+import se.softhouse.jargo.ArgumentException;
+import se.softhouse.jargo.CommandLineParser;
 
 import javax.swing.*;
 import java.io.File;
@@ -37,6 +41,7 @@
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.exist.launcher.ConfigurationUtility.*;
+import static se.softhouse.jargo.Arguments.helpArgument;
 
 /**
  * A wrapper to start a Java process using start.jar with correct VM settings.
@@ -51,14 +56,26 @@ public class LauncherWrapper {
     private final static String LAUNCHER = org.exist.launcher.Launcher.class.getName();
     private final static String OS = System.getProperty("os.name").toLowerCase();
 
+    /* general arguments */
+    private static final Argument<?> helpArg = helpArgument("-h", "--help");
+
     public final static void main(final String[] args) {
         try {
             CompatibleJavaVersionCheck.checkForCompatibleJavaVersion();
+
+            // parse command-line options
+            CommandLineParser
+                    .withArguments(helpArg)
+                    .parse(args);
+
         } catch (final StartException e) {
             if (e.getMessage() != null && !e.getMessage().isEmpty()) {
                 System.err.println(e.getMessage());
             }
             System.exit(e.getErrorCode());
+        } catch (final ArgumentException e) {
+            consoleOut(e.getMessageAndUsage().toString());
+            System.exit(SystemExitCodes.INVALID_ARGUMENT_EXIT_CODE);
         }
 
         final LauncherWrapper wrapper = new LauncherWrapper(LAUNCHER);
@@ -203,4 +220,8 @@ protected void getLauncherOpts(final List<String> args, final Properties launche
             }
         }
     }
+
+    private static void consoleOut(final String msg) {
+        System.out.println(msg); //NOSONAR this has to go to the console
+    }
 }

exist-distribution/pom.xml

@@ -871,7 +871,9 @@
                                 <daemon>
                                     <id>launcher</id>
                                     <mainClass>org.exist.start.Main</mainClass>
-                                    <!-- No arguments needed! Default is to start the launcher -->
+                                    <commandLineArguments>
+                                        <commandLineArgument>launcher</commandLineArgument>
+                                    </commandLineArguments>
                                     <platforms>
                                         <platform>booter-unix</platform>
                                         <platform>booter-windows</platform>

exist-start/src/main/java/org/exist/start/Main.java

@@ -189,6 +189,10 @@ public void runEx(String[] args) throws StartException {
                 _classname = "org.exist.launcher.LauncherWrapper";
                 _mode = "jetty";
 
+            } else if ("launcher".equals(args[0])) {
+                _classname = "org.exist.launcher.LauncherWrapper";
+                _mode = "other";
+
             } else if ("shutdown".equals(args[0])) {
                 _classname = "org.exist.jetty.ServerShutdown";
                 _mode = "other";