common: First take on handling Unicode command line args.

* common/w32-misc.c: New.
* common/t-w32-cmdline.c: New.
* common/init.c: Include w32help.h.
(prepare_w32_commandline): New.
(_init_common_subsystems) [W32]: Call prepare_w32_commandline.

* common/Makefile.am (common_sources) [W32]: Add w32-misc.c
(module_tests): Add t-w32-cmdline
(t_w32_cmdline_LDADD): New.
--

The rules for the command line parser are not cleary specified - if at
all.  See the comment in t-w32-cmdline.c.

We can't use the mingw version because that would require to change
all argv handling to be wchar_t and that only for Windows.  That would
be too ugly.  Parsing the command line into argv by us is much easier
and we can do that only if needed - i.e. if globing is required (we
are prepared for this) or a non-ASCII character has been encountered.
This way we keep things stable and only fix the currently not working
Unicode problem.

GnuPG-bug-id: 4398

1 files changed, 181 insertions, 0 deletions

diff --git a/common/t-w32-cmdline.c b/common/t-w32-cmdline.c
new file mode 100644
index 000000000..8686a376a
--- /dev/null
+++ b/common/t-w32-cmdline.c
@@ -0,0 +1,181 @@
+/* t-w32-cmdline.c - Test the parser for the Windows command line
+ * Copyright (C) 2021 g10 Code GmbH
+ *
+ * This file is part of GnuPG.
+ *
+ * This file is free software; you can redistribute it and/or modify
+ * it under the terms of either
+ *
+ *   - the GNU Lesser General Public License as published by the Free
+ *     Software Foundation; either version 3 of the License, or (at
+ *     your option) any later version.
+ *
+ * or
+ *
+ *   - the GNU General Public License as published by the Free
+ *     Software Foundation; either version 2 of the License, or (at
+ *     your option) any later version.
+ *
+ * or both in parallel, as here.
+ *
+ * This file 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <https://www.gnu.org/licenses/>.
+ */
+
+#include <config.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/stat.h>
+#include <unistd.h>
+
+#include "t-support.h"
+#include "w32help.h"
+
+#define PGM "t-w32-cmdline"
+
+static int verbose;
+static int debug;
+static int errcount;
+
+
+static void
+test_all (void)
+{
+  static struct {
+    const char *cmdline;
+    int argc;        /* Expected number of args.  */
+    char *argv[10];  /* Expected results.  */
+  } tests[] = {
+    /* Examples from "Parsing C++ Command-Line Arguments" dated 11/18/2006.
+     * https://docs.microsoft.com/en-us/previous-versions/17w5ykft(v=vs.85)
+     */
+    { "\"abc\" d e", 3,          { "abc",      "d",     "e" }},
+    { "a\\\\\\b d\"e f\"g h", 3, { "a\\\\\\b", "de fg", "h" }},
+    { "a\\\\\\\"b c d",       3, { "a\\\"b",   "c",     "d" }},
+    { "a\\\\\\\\\"b c\" d e", 3, { "a\\\\b c", "d",     "e" }},
+    /* Some arbitrary tests created using mingw.
+     * But I am nire sure whether their parser is fully correct.
+     */
+    { "e:a  a b\"c\" ",       3, { "e:a", "a", "bc" }},
+    /* { "e:a  a b\"c\"\" d\"\"e \" ", */
+    /*   5, { "e:a", "a", "bc\"", "de", " " }}, */
+    /* { "e:a  a b\"c\"\" d\"\"e\" f\\gh ", */
+    /*   4, { "e:a", "a", "bc\"", "de f\\gh "}}, */
+    /* { "e:a  a b\"c\"\" d\"\"e\" f\\\"gh \" ", */
+    /*   4, { "e:a", "a", "bc\"", "de f\"gh " }},*/
+
+    { "\"foo bar\"", 1 , { "foo bar" }},
+    { "", 1 , { "" }}
+  };
+  int tidx;
+  int i, any, argc;
+  char *cmdline;
+  char **argv;
+
+  for (tidx = 0; tidx < DIM(tests); tidx++)
+    {
+      cmdline = xstrdup (tests[tidx].cmdline);
+      if (verbose && tidx)
+        putchar ('\n');
+      if (verbose)
+        printf ("test %d: line    ->%s<-\n", tidx, cmdline);
+      argv = w32_parse_commandline (cmdline, 0, &argc);
+      if (!argv)
+        {
+          fail (tidx);
+          xfree (cmdline);
+          continue;
+        }
+      if (tests[tidx].argc != argc)
+        {
+          fprintf (stderr, PGM": test %d: argc wrong (want %d, got %d)\n",
+                   tidx, tests[tidx].argc, argc);
+          any = 1;
+        }
+      else
+        any = 0;
+      for (i=0; i < tests[tidx].argc; i++)
+        {
+          if (verbose)
+            printf ("test %d: argv[%d] ->%s<-\n",
+                    tidx, i, tests[tidx].argv[i]);
+          if (i < argc && strcmp (tests[tidx].argv[i], argv[i]))
+            {
+              if (verbose)
+                printf ("test %d:  got[%d] ->%s<- ERROR\n",
+                        tidx, i, argv[i]);
+              any = 1;
+            }
+        }
+      if (any)
+        {
+          fprintf (stderr, PGM": test %d: error%s\n",
+                   tidx, verbose? "":" (use --verbose)");
+          errcount++;
+        }
+      xfree (argv);
+    }
+}
+
+
+
+int
+main (int argc, char **argv)
+{
+  int last_argc = -1;
+
+  no_exit_on_fail = 1;
+
+  if (argc)
+    { argc--; argv++; }
+  while (argc && last_argc != argc )
+    {
+      last_argc = argc;
+      if (!strcmp (*argv, "--"))
+        {
+          argc--; argv++;
+          break;
+        }
+      else if (!strcmp (*argv, "--help"))
+        {
+          fputs ("usage: " PGM " [FILE]\n"
+                 "Options:\n"
+                 "  --verbose         Print timings etc.\n"
+                 "  --debug           Flyswatter\n"
+                 , stdout);
+          exit (0);
+        }
+      else if (!strcmp (*argv, "--verbose"))
+        {
+          verbose++;
+          argc--; argv++;
+        }
+      else if (!strcmp (*argv, "--debug"))
+        {
+          verbose += 2;
+          debug++;
+          argc--; argv++;
+        }
+      else if (!strncmp (*argv, "--", 2))
+        {
+          fprintf (stderr, PGM ": unknown option '%s'\n", *argv);
+          exit (1);
+        }
+    }
+
+  if (argc)
+    {
+      fprintf (stderr, PGM ": no arguments allowed\n");
+      exit (1);
+    }
+
+  test_all ();
+
+  return !!errcount;
+}