[kdbus] Add SipHash algorithm
[platform/upstream/glib.git] / glib / gspawn-win32-helper.c
index 0679031..76191f9 100644 (file)
 
 #include "config.h"
 
+#include <fcntl.h>
+
+/* For _CrtSetReportMode, we don't want Windows CRT (2005 and later)
+ * to terminate the process if a bad file descriptor is passed into
+ * _get_osfhandle().  This is necessary because we use _get_osfhandle()
+ * to check the validity of the fd before we try to call close() on
+ * it as attempting to close an invalid fd will cause the Windows CRT
+ * to abort() this program internally.
+ *
+ * Please see http://msdn.microsoft.com/zh-tw/library/ks2530z6%28v=vs.80%29.aspx
+ * for an explanation on this.
+ */
+#if (defined (_MSC_VER) && _MSC_VER >= 1400)
+#include <crtdbg.h>
+#endif
+
 #undef G_LOG_DOMAIN
 #include "glib.h"
 #define GSPAWN_HELPER
 #include "gspawn-win32.c"      /* For shared definitions */
 
 
-static GString *debugstring;
-
 static void
-write_err_and_exit (gint fd,
-                   gint msg)
+write_err_and_exit (gint    fd,
+                   gintptr msg)
 {
-  gint en = errno;
+  gintptr en = errno;
   
-  if (debug)
-    {
-      debugstring = g_string_new (NULL);
-      g_string_append (debugstring,
-                      g_strdup_printf ("writing error code %d and errno %d",
-                                       msg, en));
-      MessageBox (NULL, debugstring->str, "gspawn-win32-helper", 0);
-    }
-
-  write (fd, &msg, sizeof(msg));
-  write (fd, &en, sizeof(en));
+  write (fd, &msg, sizeof(gintptr));
+  write (fd, &en, sizeof(gintptr));
   
   _exit (1);
 }
@@ -59,60 +64,206 @@ write_err_and_exit (gint fd,
 /* We build gspawn-win32-helper.exe as a Windows GUI application
  * to avoid any temporarily flashing console windows in case
  * the gspawn function is invoked by a GUI program. Thus, no main()
- * but a WinMain(). We do, however, still use argc and argv tucked
- * away in the global __argc and __argv by the C runtime startup code.
+ * but a WinMain().
  */
 
+/* Info peeked from mingw runtime's source code. __wgetmainargs() is a
+ * function to get the program's argv in wide char format.
+ */
+
+typedef struct {
+  int newmode;
+} _startupinfo;
+
+extern void __wgetmainargs(int *argc,
+                          wchar_t ***wargv,
+                          wchar_t ***wenviron,
+                          int expand_wildcards,
+                          _startupinfo *startupinfo);
+
+/* Copy of protect_argv that handles wchar_t strings */
+
+static gint
+protect_wargv (wchar_t  **wargv,
+              wchar_t ***new_wargv)
+{
+  gint i;
+  gint argc = 0;
+  
+  while (wargv[argc])
+    ++argc;
+  *new_wargv = g_new (wchar_t *, argc+1);
+
+  /* Quote each argv element if necessary, so that it will get
+   * reconstructed correctly in the C runtime startup code.  Note that
+   * the unquoting algorithm in the C runtime is really weird, and
+   * rather different than what Unix shells do. See stdargv.c in the C
+   * runtime sources (in the Platform SDK, in src/crt).
+   *
+   * Note that an new_wargv[0] constructed by this function should
+   * *not* be passed as the filename argument to a _wspawn* or _wexec*
+   * family function. That argument should be the real file name
+   * without any quoting.
+   */
+  for (i = 0; i < argc; i++)
+    {
+      wchar_t *p = wargv[i];
+      wchar_t *q;
+      gint len = 0;
+      gboolean need_dblquotes = FALSE;
+      while (*p)
+       {
+         if (*p == ' ' || *p == '\t')
+           need_dblquotes = TRUE;
+         else if (*p == '"')
+           len++;
+         else if (*p == '\\')
+           {
+             wchar_t *pp = p;
+             while (*pp && *pp == '\\')
+               pp++;
+             if (*pp == '"')
+               len++;
+           }
+         len++;
+         p++;
+       }
+
+      q = (*new_wargv)[i] = g_new (wchar_t, len + need_dblquotes*2 + 1);
+      p = wargv[i];
+
+      if (need_dblquotes)
+       *q++ = '"';
+
+      while (*p)
+       {
+         if (*p == '"')
+           *q++ = '\\';
+         else if (*p == '\\')
+           {
+             wchar_t *pp = p;
+             while (*pp && *pp == '\\')
+               pp++;
+             if (*pp == '"')
+               *q++ = '\\';
+           }
+         *q++ = *p;
+         p++;
+       }
+
+      if (need_dblquotes)
+       *q++ = '"';
+      *q++ = '\0';
+    }
+  (*new_wargv)[argc] = NULL;
+
+  return argc;
+}
+
+#if (defined (_MSC_VER) && _MSC_VER >= 1400)
+/*
+ * This is the (empty) invalid parameter handler
+ * that is used for Visual C++ 2005 (and later) builds
+ * so that we can use this instead of the system automatically
+ * aborting the process.
+ *
+ * This is necessary as we use _get_oshandle() to check the validity
+ * of the file descriptors as we close them, so when an invalid file
+ * descriptor is passed into that function as we check on it, we get
+ * -1 as the result, instead of the gspawn helper program aborting.
+ *
+ * Please see http://msdn.microsoft.com/zh-tw/library/ks2530z6%28v=vs.80%29.aspx
+ * for an explanation on this.
+ */
+void myInvalidParameterHandler(
+   const wchar_t * expression,
+   const wchar_t * function,
+   const wchar_t * file,
+   unsigned int line,
+   uintptr_t pReserved
+)
+{
+  return;
+}
+#endif
+
+
+#ifndef HELPER_CONSOLE
 int _stdcall
 WinMain (struct HINSTANCE__ *hInstance,
         struct HINSTANCE__ *hPrevInstance,
         char               *lpszCmdLine,
         int                 nCmdShow)
+#else
+int
+main (int ignored_argc, char **ignored_argv)
+#endif
 {
-  int child_err_report_fd;
+  int child_err_report_fd = -1;
+  int helper_sync_fd = -1;
   int i;
   int fd;
   int mode;
-  int handle;
-  int no_error = CHILD_NO_ERROR;
-  int zero = 0;
-  gchar **new_argv;
+  gintptr handle;
+  int saved_errno;
+  gintptr no_error = CHILD_NO_ERROR;
+  gint argv_zero_offset = ARG_PROGRAM;
+  wchar_t **new_wargv;
+  int argc;
+  char **argv;
+  wchar_t **wargv, **wenvp;
+  _startupinfo si = { 0 };
+  char c;
+
+#if (defined (_MSC_VER) && _MSC_VER >= 1400)
+  /* set up our empty invalid parameter handler */
+  _invalid_parameter_handler oldHandler, newHandler;
+  newHandler = myInvalidParameterHandler;
+  oldHandler = _set_invalid_parameter_handler(newHandler);
+
+  /* Disable the message box for assertions. */
+  _CrtSetReportMode(_CRT_ASSERT, 0);
+#endif
 
-  SETUP_DEBUG();
+  /* Fetch the wide-char argument vector */
+  __wgetmainargs (&argc, &wargv, &wenvp, 0, &si);
 
-  if (debug)
-    {
-      debugstring = g_string_new (NULL);
+  g_assert (argc >= ARG_COUNT);
 
-      g_string_append (debugstring,
-                      g_strdup_printf ("g-spawn-win32-helper: "
-                                       "argc = %d, argv: ",
-                                       __argc));
-      for (i = 0; i < __argc; i++)
-       {
-         if (i > 0)
-           g_string_append (debugstring, " ");
-         g_string_append (debugstring, __argv[i]);
-       }
-      
-      MessageBox (NULL, debugstring->str, "gspawn-win32-helper", 0);
-    }
+  /* Convert unicode wargs to utf8 */
+  argv = g_new(char *, argc + 1);
+  for (i = 0; i < argc; i++)
+    argv[i] = g_utf16_to_utf8(wargv[i], -1, NULL, NULL, NULL);
+  argv[i] = NULL;
 
-  g_assert (__argc >= ARG_COUNT);
+  /* argv[ARG_CHILD_ERR_REPORT] is the file descriptor number onto
+   * which write error messages.
+   */
+  child_err_report_fd = atoi (argv[ARG_CHILD_ERR_REPORT]);
 
-  /* argv[ARG_CHILD_ERR_REPORT] is the file descriptor onto which
-   * write error messages.
+  /* Hack to implement G_SPAWN_FILE_AND_ARGV_ZERO. If
+   * argv[ARG_CHILD_ERR_REPORT] is suffixed with a '#' it means we get
+   * the program to run and its argv[0] separately.
+   */
+  if (argv[ARG_CHILD_ERR_REPORT][strlen (argv[ARG_CHILD_ERR_REPORT]) - 1] == '#')
+    argv_zero_offset++;
+
+  /* argv[ARG_HELPER_SYNC] is the file descriptor number we read a
+   * byte that tells us it is OK to exit. We have to wait until the
+   * parent allows us to exit, so that the parent has had time to
+   * duplicate the process handle we sent it. Duplicating a handle
+   * from another process works only if that other process exists.
    */
-  child_err_report_fd = atoi (__argv[ARG_CHILD_ERR_REPORT]);
+  helper_sync_fd = atoi (argv[ARG_HELPER_SYNC]);
 
-  /* argv[ARG_STDIN..ARG_STDERR] are the file descriptors that should
-   * be dup2'd to stdin, stdout and stderr, '-' if the corresponding
-   * std* should be let alone, and 'z' if it should be connected to
-   * the bit bucket NUL:.
+  /* argv[ARG_STDIN..ARG_STDERR] are the file descriptor numbers that
+   * should be dup2'd to 0, 1 and 2. '-' if the corresponding fd
+   * should be left alone, and 'z' if it should be connected to the
+   * bit bucket NUL:.
    */
-  if (__argv[ARG_STDIN][0] == '-')
+  if (argv[ARG_STDIN][0] == '-')
     ; /* Nothing */
-  else if (__argv[ARG_STDIN][0] == 'z')
+  else if (argv[ARG_STDIN][0] == 'z')
     {
       fd = open ("NUL:", O_RDONLY);
       if (fd != 0)
@@ -123,7 +274,7 @@ WinMain (struct HINSTANCE__ *hInstance,
     }
   else
     {
-      fd = atoi (__argv[ARG_STDIN]);
+      fd = atoi (argv[ARG_STDIN]);
       if (fd != 0)
        {
          dup2 (fd, 0);
@@ -131,9 +282,9 @@ WinMain (struct HINSTANCE__ *hInstance,
        }
     }
 
-  if (__argv[ARG_STDOUT][0] == '-')
+  if (argv[ARG_STDOUT][0] == '-')
     ; /* Nothing */
-  else if (__argv[ARG_STDOUT][0] == 'z')
+  else if (argv[ARG_STDOUT][0] == 'z')
     {
       fd = open ("NUL:", O_WRONLY);
       if (fd != 1)
@@ -144,7 +295,7 @@ WinMain (struct HINSTANCE__ *hInstance,
     }
   else
     {
-      fd = atoi (__argv[ARG_STDOUT]);
+      fd = atoi (argv[ARG_STDOUT]);
       if (fd != 1)
        {
          dup2 (fd, 1);
@@ -152,9 +303,9 @@ WinMain (struct HINSTANCE__ *hInstance,
        }
     }
 
-  if (__argv[ARG_STDERR][0] == '-')
+  if (argv[ARG_STDERR][0] == '-')
     ; /* Nothing */
-  else if (__argv[ARG_STDERR][0] == 'z')
+  else if (argv[ARG_STDERR][0] == 'z')
     {
       fd = open ("NUL:", O_WRONLY);
       if (fd != 2)
@@ -165,7 +316,7 @@ WinMain (struct HINSTANCE__ *hInstance,
     }
   else
     {
-      fd = atoi (__argv[ARG_STDERR]);
+      fd = atoi (argv[ARG_STDERR]);
       if (fd != 2)
        {
          dup2 (fd, 2);
@@ -173,87 +324,65 @@ WinMain (struct HINSTANCE__ *hInstance,
        }
     }
 
-  /* __argv[ARG_WORKING_DIRECTORY] is the directory in which to run the
+  /* argv[ARG_WORKING_DIRECTORY] is the directory in which to run the
    * process.  If "-", don't change directory.
    */
-  if (__argv[ARG_WORKING_DIRECTORY][0] == '-' &&
-      __argv[ARG_WORKING_DIRECTORY][1] == 0)
+  if (argv[ARG_WORKING_DIRECTORY][0] == '-' &&
+      argv[ARG_WORKING_DIRECTORY][1] == 0)
     ; /* Nothing */
-  else if (chdir (__argv[ARG_WORKING_DIRECTORY]) < 0)
-    write_err_and_exit (child_err_report_fd,
-                       CHILD_CHDIR_FAILED);
+  else if (_wchdir (wargv[ARG_WORKING_DIRECTORY]) < 0)
+    write_err_and_exit (child_err_report_fd, CHILD_CHDIR_FAILED);
 
-  /* __argv[ARG_CLOSE_DESCRIPTORS] is "y" if file descriptors from 3
+  /* argv[ARG_CLOSE_DESCRIPTORS] is "y" if file descriptors from 3
    *  upwards should be closed
    */
-
-  if (__argv[ARG_CLOSE_DESCRIPTORS][0] == 'y')
+  if (argv[ARG_CLOSE_DESCRIPTORS][0] == 'y')
     for (i = 3; i < 1000; i++) /* FIXME real limit? */
-      if (i != child_err_report_fd)
-       close (i);
+      if (i != child_err_report_fd && i != helper_sync_fd)
+        if (_get_osfhandle (i) != -1)
+          close (i);
 
-  /* __argv[ARG_WAIT] is "w" to wait for the program to exit */
+  /* We don't want our child to inherit the error report and
+   * helper sync fds.
+   */
+  child_err_report_fd = dup_noninherited (child_err_report_fd, _O_WRONLY);
+  helper_sync_fd = dup_noninherited (helper_sync_fd, _O_RDONLY);
 
-  if (__argv[ARG_WAIT][0] == 'w')
+  /* argv[ARG_WAIT] is "w" to wait for the program to exit */
+  if (argv[ARG_WAIT][0] == 'w')
     mode = P_WAIT;
   else
     mode = P_NOWAIT;
 
-  /* __argv[ARG_USE_PATH] is "y" to use PATH, otherwise not */
+  /* argv[ARG_USE_PATH] is "y" to use PATH, otherwise not */
 
-  /* __argv[ARG_PROGRAM] is program file to run,
-   * __argv[ARG_PROGRAM+1]... is its __argv.
+  /* argv[ARG_PROGRAM] is executable file to run,
+   * argv[argv_zero_offset]... is its argv. argv_zero_offset equals
+   * ARG_PROGRAM unless G_SPAWN_FILE_AND_ARGV_ZERO was used, in which
+   * case we have a separate executable name and argv[0].
    */
 
-  protect_argv (__argv, &new_argv);
-
   /* For the program name passed to spawnv(), don't use the quoted
-   * version. */
-
-  if (debug)
-    {
-      debugstring = g_string_new (NULL);
-      g_string_append (debugstring,
-                      g_strdup_printf ("calling %s %s mode=%s argv: ",
-                                       (__argv[ARG_USE_PATH][0] == 'y' ?
-                                        "spawnvp" : "spawnv"),
-                                       __argv[ARG_PROGRAM],
-                                       (mode == P_WAIT ?
-                                        "P_WAIT" : "P_NOWAIT")));
-      i = ARG_PROGRAM+1;
-      while (new_argv[i])
-       {
-         g_string_append (debugstring, new_argv[i++]);
-         if (new_argv[i])
-           g_string_append (debugstring, " ");
-       }
-      MessageBox (NULL, debugstring->str, "gspawn-win32-helper", 0);
-    }
+   * version.
+   */
+  protect_wargv (wargv + argv_zero_offset, &new_wargv);
 
-  if (new_argv[ARG_USE_PATH][0] == 'y')
-    handle = spawnvp (mode, __argv[ARG_PROGRAM], new_argv+ARG_PROGRAM);
+  if (argv[ARG_USE_PATH][0] == 'y')
+    handle = _wspawnvp (mode, wargv[ARG_PROGRAM], (const wchar_t **) new_wargv);
   else
-    handle = spawnv (mode, __argv[ARG_PROGRAM], new_argv+ARG_PROGRAM);
+    handle = _wspawnv (mode, wargv[ARG_PROGRAM], (const wchar_t **) new_wargv);
 
-  if (debug)
-    {
-      debugstring = g_string_new (NULL);
-      g_string_append (debugstring,
-                      g_strdup_printf ("%s returned %#x",
-                                       (__argv[ARG_USE_PATH][0] == 'y' ?
-                                        "spawnvp" : "spawnv"),
-                                       handle));
-      MessageBox (NULL, debugstring->str, "gspawn-win32-helper", 0);
-    }
+  saved_errno = errno;
 
-  if (handle < 0)
+  if (handle == -1 && saved_errno != 0)
     write_err_and_exit (child_err_report_fd, CHILD_SPAWN_FAILED);
 
   write (child_err_report_fd, &no_error, sizeof (no_error));
-  if (mode == P_NOWAIT)
-    write (child_err_report_fd, &handle, sizeof (handle));
-  else
-    write (child_err_report_fd, &zero, sizeof (zero));
+  write (child_err_report_fd, &handle, sizeof (handle));
+
+  read (helper_sync_fd, &c, 1);
+
+  g_strfreev (argv);
+
   return 0;
 }
-