client: Fix exit codes for /help and similar option

Currently, non-zero exit code is returned for /version, /buildconfig, /help,
/monitor-list, /kbd-list and /kbd-lang-list command-line options for several
clients. This is against conventions because 0 is usually returned in
such cases. Also, there is potentially another problem that the returned
codes overflow on UNIX systems (where the exit code is a number between 0
and 255). Let's fix the clients to return 0 in the mentioned cases to honor
conventions and 1 for the command-line parsing errors (or -1 for clients
who already use that value).

Fixes: https://github.com/FreeRDP/FreeRDP/issues/6686
(cherry picked from commit 3ee4cabcfad3a9ccc3c59be21245b57c17e7ae75)

diff --git a/client/Sample/tf_freerdp.c b/client/Sample/tf_freerdp.c
index 3ba82c7..49412cb 100644 (file)
--- a/client/Sample/tf_freerdp.c
+++ b/client/Sample/tf_freerdp.c
@@ -338,12 +338,13 @@ int main(int argc, char* argv[])
                goto fail;
 
        status = freerdp_client_settings_parse_command_line(context->settings, argc, argv, FALSE);
-       status =
-           freerdp_client_settings_command_line_status_print(context->settings, status, argc, argv);
-
        if (status)
        {
-               rc = 0;
+               freerdp_client_settings_command_line_status_print(context->settings, status, argc, argv);
+
+               if (status <= COMMAND_LINE_STATUS_PRINT && status >= COMMAND_LINE_STATUS_PRINT_LAST)
+                       rc = 0;
+
                goto fail;
        }
 

diff --git a/client/Wayland/wlfreerdp.c b/client/Wayland/wlfreerdp.c
index 329d120..d77b479 100644 (file)
--- a/client/Wayland/wlfreerdp.c
+++ b/client/Wayland/wlfreerdp.c
@@ -628,18 +628,19 @@ int main(int argc, char* argv[])
        settings = context->settings;
 
        status = freerdp_client_settings_parse_command_line(settings, argc, argv, FALSE);
-       status = freerdp_client_settings_command_line_status_print(settings, status, argc, argv);
-
        if (status)
        {
                BOOL list = settings->ListMonitors;
+
+               freerdp_client_settings_command_line_status_print(settings, status, argc, argv);
+
                if (list)
                        wlf_list_monitors(wlc);
 
-               freerdp_client_context_free(context);
-               if (list)
-                       return 0;
-               return status;
+               if (status <= COMMAND_LINE_STATUS_PRINT && status >= COMMAND_LINE_STATUS_PRINT_LAST)
+                       rc = 0;
+
+               goto fail;
        }
 
        if (freerdp_client_start(context) != 0)

diff --git a/client/Windows/cli/wfreerdp.c b/client/Windows/cli/wfreerdp.c
index 7a76eeb..b623067 100644 (file)
--- a/client/Windows/cli/wfreerdp.c
+++ b/client/Windows/cli/wfreerdp.c
@@ -108,6 +108,10 @@ INT WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine
        if (status)
        {
                freerdp_client_settings_command_line_status_print(settings, status, argc, argv);
+
+               if (status <= COMMAND_LINE_STATUS_PRINT && status >= COMMAND_LINE_STATUS_PRINT_LAST)
+                       rc = 0;
+
                goto out;
        }
 

diff --git a/client/X11/cli/xfreerdp.c b/client/X11/cli/xfreerdp.c
index c8a77f3..a3505b2 100644 (file)
--- a/client/X11/cli/xfreerdp.c
+++ b/client/X11/cli/xfreerdp.c
@@ -34,6 +34,7 @@
 
 int main(int argc, char* argv[])
 {
+       int rc = 1;
        int status;
        HANDLE thread;
        xfContext* xfc;
@@ -56,31 +57,34 @@ int main(int argc, char* argv[])
        xfc = (xfContext*)context;
 
        status = freerdp_client_settings_parse_command_line(context->settings, argc, argv, FALSE);
-
-       status = freerdp_client_settings_command_line_status_print(settings, status, argc, argv);
-
        if (status)
        {
                BOOL list = settings->ListMonitors;
+
+               freerdp_client_settings_command_line_status_print(settings, status, argc, argv);
+
                if (list)
                        xf_list_monitors(xfc);
 
-               freerdp_client_context_free(context);
-               if (list)
-                       return 0;
-               return status;
+               if (status <= COMMAND_LINE_STATUS_PRINT && status >= COMMAND_LINE_STATUS_PRINT_LAST)
+                       rc = 0;
+
+               goto out;
        }
 
-       freerdp_client_start(context);
+       if (freerdp_client_start(context) != 0)
+               goto out;
 
        thread = freerdp_client_get_thread(context);
 
        WaitForSingleObject(thread, INFINITE);
        GetExitCodeThread(thread, &dwExitCode);
+       rc = xf_exit_code_from_disconnect_reason(dwExitCode);
 
        freerdp_client_stop(context);
 
+out:
        freerdp_client_context_free(context);
 
-       return xf_exit_code_from_disconnect_reason(dwExitCode);
+       return rc;
 }

diff --git a/winpr/include/winpr/cmdline.h b/winpr/include/winpr/cmdline.h
index 865ee8f..9276cda 100644 (file)
--- a/winpr/include/winpr/cmdline.h
+++ b/winpr/include/winpr/cmdline.h
@@ -81,6 +81,7 @@
 #define COMMAND_LINE_STATUS_PRINT_HELP -2002
 #define COMMAND_LINE_STATUS_PRINT_VERSION -2003
 #define COMMAND_LINE_STATUS_PRINT_BUILDCONFIG -2004
+#define COMMAND_LINE_STATUS_PRINT_LAST -2999
 
 /* Command-Line Macros */