[bugfix] Show the correct application name in the Usage help at the CLI

Author: adamretter

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

@@ -31,6 +31,7 @@
 import org.exist.util.Configuration;
 import org.exist.util.MimeTable;
 import org.exist.util.MimeType;
+import org.exist.util.OSUtil;
 import org.exist.util.SystemExitCodes;
 import org.exist.xquery.TerminatedException;
 import se.softhouse.jargo.Argument;
@@ -624,6 +625,7 @@ public static void main(final String[] args) {
             // parse command-line options
             CommandLineParser
                     .withArguments(helpArg)
+                    .programName("export-gui" + (OSUtil.isWindows() ? ".bat" : ".sh"))
                     .parse(args);
 
         } catch (final StartException e) {

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

@@ -30,6 +30,7 @@
 import org.exist.storage.txn.Txn;
 import org.exist.util.Configuration;
 import org.exist.util.DatabaseConfigurationException;
+import org.exist.util.OSUtil;
 import org.exist.util.SystemExitCodes;
 import org.exist.xquery.TerminatedException;
 import se.softhouse.jargo.Argument;
@@ -130,6 +131,7 @@ public static void main(final String[] args) {
                     .withArguments(noCheckArg, checkDocsArg, directAccessArg, exportArg, noExportArg, incrementalArg, zipArg, noZipArg)
                     .andArguments(configArg, outputDirArg)
                     .andArguments(helpArg, verboseArg)
+                    .programName("export" + (OSUtil.isWindows() ? ".bat" : ".sh"))
                     .parse(args);
 
             process(arguments);

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

@@ -26,6 +26,7 @@
 import org.exist.start.StartException;
 import org.exist.util.ConfigurationHelper;
 import org.exist.util.NamedThreadFactory;
+import org.exist.util.OSUtil;
 import org.exist.util.SystemExitCodes;
 import org.exist.xmldb.*;
 import org.xmldb.api.DatabaseManager;
@@ -461,6 +462,7 @@ public static void main(final String[] args) {
                     .andArguments(backupCollectionArg, backupOutputDirArg, backupDeduplicateBlobs)
                     .andArguments(restoreArg, rebuildExpathRepoArg, overwriteAppsArg)
                     .andArguments(helpArg, guiArg, quietArg, optionArg)
+                    .programName("backup" + (OSUtil.isWindows() ? ".bat" : ".sh"))
                     .parse(args);
 
             process(arguments);

exist-core/src/main/java/org/exist/client/CommandlineOptions.java

@@ -26,6 +26,7 @@
 import java.nio.file.Path;
 import java.util.*;
 
+import org.exist.util.OSUtil;
 import org.exist.xmldb.XmldbURI;
 import org.exist.xquery.util.URIUtils;
 import se.softhouse.jargo.*;
@@ -176,6 +177,7 @@ public static CommandlineOptions parse(final String[] args) throws ArgumentExcep
                 .andArguments(setDocArg, xupdateArg)
                 .andArguments(reindexArg, reindexRecurseDirsArg)
                 .andArguments(helpArg, quietArg, verboseArg, outputFileArg, optionArg)
+                .programName("client" + (OSUtil.isWindows() ? ".bat" : ".sh"))
                 .parse(args);
 
         final boolean quiet = getBool(arguments, quietArg);

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

@@ -41,10 +41,7 @@
 import org.exist.start.Main;
 import org.exist.start.StartException;
 import org.exist.storage.BrokerPool;
-import org.exist.util.ConfigurationHelper;
-import org.exist.util.FileUtils;
-import org.exist.util.SingleInstanceConfiguration;
-import org.exist.util.SystemExitCodes;
+import org.exist.util.*;
 import org.exist.validation.XmlLibraryChecker;
 import org.exist.xmldb.DatabaseImpl;
 import org.exist.xmldb.ShutdownListener;
@@ -106,6 +103,7 @@ public static void main(final String[] args) {
 
             CommandLineParser
                     .withArguments(helpArg)
+                    .programName("startup" + (OSUtil.isWindows() ? ".bat" : ".sh"))
                     .parse(args);
 
         } catch (final StartException e) {

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

@@ -26,6 +26,7 @@
 import org.exist.start.CompatibleJavaVersionCheck;
 import org.exist.start.StartException;
 import org.exist.util.ConfigurationHelper;
+import org.exist.util.OSUtil;
 import org.exist.util.SystemExitCodes;
 import org.exist.xmldb.DatabaseInstanceManager;
 import org.exist.xmldb.XmldbURI;
@@ -77,6 +78,7 @@ public static void main(final String[] args) {
             final ParsedArguments arguments = CommandLineParser
                     .withArguments(userArg, passwordArg, uriArg)
                     .andArguments(helpArg)
+                    .programName("shutdown" + (OSUtil.isWindows() ? ".bat" : ".sh"))
                     .parse(args);
 
             process(arguments);

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

@@ -24,6 +24,7 @@
 import org.exist.start.CompatibleJavaVersionCheck;
 import org.exist.start.StartException;
 import org.exist.util.ConfigurationHelper;
+import org.exist.util.OSUtil;
 import org.exist.util.SystemExitCodes;
 import se.softhouse.jargo.Argument;
 import se.softhouse.jargo.ArgumentException;
@@ -54,7 +55,7 @@
 public class LauncherWrapper {
 
     private final static String LAUNCHER = org.exist.launcher.Launcher.class.getName();
-    private final static String OS = System.getProperty("os.name").toLowerCase();
+    private final static String OS = OSUtil.getOS().toLowerCase();
 
     /* general arguments */
     private static final Argument<?> helpArg = helpArgument("-h", "--help");
@@ -66,6 +67,7 @@ public final static void main(final String[] args) {
             // parse command-line options
             CommandLineParser
                     .withArguments(helpArg)
+                    .programName("launcher" + (OSUtil.isWindows() ? ".bat" : ".sh"))
                     .parse(args);
 
         } catch (final StartException e) {

exist-core/src/main/java/org/exist/management/client/JMXClient.java

@@ -23,6 +23,7 @@
 
 import org.exist.start.CompatibleJavaVersionCheck;
 import org.exist.start.StartException;
+import org.exist.util.OSUtil;
 import org.exist.util.SystemExitCodes;
 import se.softhouse.jargo.Argument;
 import se.softhouse.jargo.ArgumentException;
@@ -314,6 +315,7 @@ public static void main(final String[] args) {
                     .andArguments(cacheDisplayArg, locksDisplayArg)
                     .andArguments(dbInfoArg, memoryInfoArg, sanityCheckInfoArg, jobsInfoArg)
                     .andArguments(helpArg)
+                    .programName("jmxclient" + (OSUtil.isWindows() ? ".bat" : ".sh"))
                     .parse(args);
 
             process(arguments);

exist-core/src/main/java/org/exist/util/OSUtil.java

@@ -0,0 +1,43 @@
+/*
+ * eXist-db Open Source Native XML Database
+ * Copyright (C) 2001 The eXist-db Authors
+ *
+ * [email protected]
+ * http://www.exist-db.org
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+package org.exist.util;
+
+public interface OSUtil {
+
+    /**
+     * Return true if the Operating System is Microsoft Windows.
+     *
+     * @return true if the OS is Windows.
+     */
+    static boolean isWindows() {
+        return getOS().toLowerCase().contains("win");
+    }
+
+    /**
+     * Return the OS name from the `os.name` System Property.
+     *
+     * @return the OS name or "unknown".
+     */
+    static String getOS() {
+        return System.getProperty("os.name", "unknown");
+    }
+}