glib/gspawn.c

   1 /* gspawn.c - Process launching
   2  *
   3  *  Copyright 2000 Red Hat, Inc.
   4  *  g_execvpe implementation based on GNU libc execvp:
   5  *   Copyright 1991, 92, 95, 96, 97, 98, 99 Free Software Foundation, Inc.
   6  *
   7  * GLib is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public License as
   9  * published by the Free Software Foundation; either version 2 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * GLib is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with GLib; see the file COPYING.LIB.  If not, write
  19  * to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #include "config.h"
  24
  25 #include <sys/time.h>
  26 #include <sys/types.h>
  27 #include <sys/wait.h>
  28 #include <unistd.h>
  29 #include <errno.h>
  30 #include <fcntl.h>
  31 #include <signal.h>
  32 #include <string.h>
  33 #include <stdlib.h>   /* for fdwalk */
  34
  35 #ifdef HAVE_SYS_SELECT_H
  36 #include <sys/select.h>
  37 #endif /* HAVE_SYS_SELECT_H */
  38
  39 #include "glib.h"
  40 #include "glibintl.h"
  41 #include "galias.h"
  42
  43 static gint g_execute (const gchar  *file,
  44                        gchar **argv,
  45                        gchar **envp,
  46                        gboolean search_path);
  47
  48 static gboolean make_pipe            (gint                  p[2],
  49                                       GError              **error);
  50 static gboolean fork_exec_with_pipes (gboolean              intermediate_child,
  51                                       const gchar          *working_directory,
  52                                       gchar               **argv,
  53                                       gchar               **envp,
  54                                       gboolean              close_descriptors,
  55                                       gboolean              search_path,
  56                                       gboolean              stdout_to_null,
  57                                       gboolean              stderr_to_null,
  58                                       gboolean              child_inherits_stdin,
  59                                       gboolean              file_and_argv_zero,
  60                                       GSpawnChildSetupFunc  child_setup,
  61                                       gpointer              user_data,
  62                                       GPid                 *child_pid,
  63                                       gint                 *standard_input,
  64                                       gint                 *standard_output,
  65                                       gint                 *standard_error,
  66                                       GError              **error);
  67
  68 GQuark
  69 g_spawn_error_quark (void)
  70 {
  71   return g_quark_from_static_string ("g-exec-error-quark");
  72 }
  73
  74 /**
  75  * g_spawn_async:
  76  * @working_directory: child's current working directory, or %NULL to inherit parent's
  77  * @argv: child's argument vector
  78  * @envp: child's environment, or %NULL to inherit parent's
  79  * @flags: flags from #GSpawnFlags
  80  * @child_setup: function to run in the child just before exec()
  81  * @user_data: user data for @child_setup
  82  * @child_pid: return location for child process ID, or %NULL
  83  * @error: return location for error
  84  *
  85  * See g_spawn_async_with_pipes() for a full description; this function
  86  * simply calls the g_spawn_async_with_pipes() without any pipes.
  87  *
  88  * Return value: %TRUE on success, %FALSE if error is set
  89  **/
  90 gboolean
  91 g_spawn_async (const gchar          *working_directory,
  92                gchar               **argv,
  93                gchar               **envp,
  94                GSpawnFlags           flags,
  95                GSpawnChildSetupFunc  child_setup,
  96                gpointer              user_data,
  97                GPid                 *child_pid,
  98                GError              **error)
  99 {
 100   g_return_val_if_fail (argv != NULL, FALSE);
 101
 102   return g_spawn_async_with_pipes (working_directory,
 103                                    argv, envp,
 104                                    flags,
 105                                    child_setup,
 106                                    user_data,
 107                                    child_pid,
 108                                    NULL, NULL, NULL,
 109                                    error);
 110 }
 111
 112 /* Avoids a danger in threaded situations (calling close()
 113  * on a file descriptor twice, and another thread has
 114  * re-opened it since the first close)
 115  */
 116 static gint
 117 close_and_invalidate (gint *fd)
 118 {
 119   gint ret;
 120
 121   if (*fd < 0)
 122     return -1;
 123   else
 124     {
 125       ret = close (*fd);
 126       *fd = -1;
 127     }
 128
 129   return ret;
 130 }
 131
 132 /* Some versions of OS X define READ_OK in public headers */
 133 #undef READ_OK
 134
 135 typedef enum
 136 {
 137   READ_FAILED = 0, /* FALSE */
 138   READ_OK,
 139   READ_EOF
 140 } ReadResult;
 141
 142 static ReadResult
 143 read_data (GString *str,
 144            gint     fd,
 145            GError **error)
 146 {
 147   gssize bytes;
 148   gchar buf[4096];
 149
 150  again:
 151
 152   bytes = read (fd, buf, 4096);
 153
 154   if (bytes == 0)
 155     return READ_EOF;
 156   else if (bytes > 0)
 157     {
 158       g_string_append_len (str, buf, bytes);
 159       return READ_OK;
 160     }
 161   else if (bytes < 0 && errno == EINTR)
 162     goto again;
 163   else if (bytes < 0)
 164     {
 165       g_set_error (error,
 166                    G_SPAWN_ERROR,
 167                    G_SPAWN_ERROR_READ,
 168                    _("Failed to read data from child process (%s)"),
 169                    g_strerror (errno));
 170
 171       return READ_FAILED;
 172     }
 173   else
 174     return READ_OK;
 175 }
 176
 177 /**
 178  * g_spawn_sync:
 179  * @working_directory: child's current working directory, or %NULL to inherit parent's
 180  * @argv: child's argument vector
 181  * @envp: child's environment, or %NULL to inherit parent's
 182  * @flags: flags from #GSpawnFlags
 183  * @child_setup: function to run in the child just before exec()
 184  * @user_data: user data for @child_setup
 185  * @standard_output: return location for child output
 186  * @standard_error: return location for child error messages
 187  * @exit_status: return location for child exit status, as returned by waitpid()
 188  * @error: return location for error
 189  *
 190  * Executes a child synchronously (waits for the child to exit before returning).
 191  * All output from the child is stored in @standard_output and @standard_error,
 192  * if those parameters are non-%NULL. If @exit_status is non-%NULL, the exit
 193  * status of the child is stored there as it would be returned by
 194  * waitpid(); standard UNIX macros such as WIFEXITED() and WEXITSTATUS()
 195  * must be used to evaluate the exit status. If an error occurs, no data is
 196  * returned in @standard_output, @standard_error, or @exit_status.
 197  *
 198  * This function calls g_spawn_async_with_pipes() internally; see that
 199  * function for full details on the other parameters and details on
 200  * how these functions work on Windows.
 201  *
 202  * Return value: %TRUE on success, %FALSE if an error was set.
 203  **/
 204 gboolean
 205 g_spawn_sync (const gchar          *working_directory,
 206               gchar               **argv,
 207               gchar               **envp,
 208               GSpawnFlags           flags,
 209               GSpawnChildSetupFunc  child_setup,
 210               gpointer              user_data,
 211               gchar               **standard_output,
 212               gchar               **standard_error,
 213               gint                 *exit_status,
 214               GError              **error)
 215 {
 216   gint outpipe = -1;
 217   gint errpipe = -1;
 218   GPid pid;
 219   fd_set fds;
 220   gint ret;
 221   GString *outstr = NULL;
 222   GString *errstr = NULL;
 223   gboolean failed;
 224   gint status;
 225
 226   g_return_val_if_fail (argv != NULL, FALSE);
 227   g_return_val_if_fail (!(flags & G_SPAWN_DO_NOT_REAP_CHILD), FALSE);
 228   g_return_val_if_fail (standard_output == NULL ||
 229                         !(flags & G_SPAWN_STDOUT_TO_DEV_NULL), FALSE);
 230   g_return_val_if_fail (standard_error == NULL ||
 231                         !(flags & G_SPAWN_STDERR_TO_DEV_NULL), FALSE);
 232
 233   /* Just to ensure segfaults if callers try to use
 234    * these when an error is reported.
 235    */
 236   if (standard_output)
 237     *standard_output = NULL;
 238
 239   if (standard_error)
 240     *standard_error = NULL;
 241
 242   if (!fork_exec_with_pipes (FALSE,
 243                              working_directory,
 244                              argv,
 245                              envp,
 246                              !(flags & G_SPAWN_LEAVE_DESCRIPTORS_OPEN),
 247                              (flags & G_SPAWN_SEARCH_PATH) != 0,
 248                              (flags & G_SPAWN_STDOUT_TO_DEV_NULL) != 0,
 249                              (flags & G_SPAWN_STDERR_TO_DEV_NULL) != 0,
 250                              (flags & G_SPAWN_CHILD_INHERITS_STDIN) != 0,
 251                              (flags & G_SPAWN_FILE_AND_ARGV_ZERO) != 0,
 252                              child_setup,
 253                              user_data,
 254                              &pid,
 255                              NULL,
 256                              standard_output ? &outpipe : NULL,
 257                              standard_error ? &errpipe : NULL,
 258                              error))
 259     return FALSE;
 260
 261   /* Read data from child. */
 262
 263   failed = FALSE;
 264
 265   if (outpipe >= 0)
 266     {
 267       outstr = g_string_new (NULL);
 268     }
 269
 270   if (errpipe >= 0)
 271     {
 272       errstr = g_string_new (NULL);
 273     }
 274
 275   /* Read data until we get EOF on both pipes. */
 276   while (!failed &&
 277          (outpipe >= 0 ||
 278           errpipe >= 0))
 279     {
 280       ret = 0;
 281
 282       FD_ZERO (&fds);
 283       if (outpipe >= 0)
 284         FD_SET (outpipe, &fds);
 285       if (errpipe >= 0)
 286         FD_SET (errpipe, &fds);
 287
 288       ret = select (MAX (outpipe, errpipe) + 1,
 289                     &fds,
 290                     NULL, NULL,
 291                     NULL /* no timeout */);
 292
 293       if (ret < 0 && errno != EINTR)
 294         {
 295           failed = TRUE;
 296
 297           g_set_error (error,
 298                        G_SPAWN_ERROR,
 299                        G_SPAWN_ERROR_READ,
 300                        _("Unexpected error in select() reading data from a child process (%s)"),
 301                        g_strerror (errno));
 302
 303           break;
 304         }
 305
 306       if (outpipe >= 0 && FD_ISSET (outpipe, &fds))
 307         {
 308           switch (read_data (outstr, outpipe, error))
 309             {
 310             case READ_FAILED:
 311               failed = TRUE;
 312               break;
 313             case READ_EOF:
 314               close_and_invalidate (&outpipe);
 315               outpipe = -1;
 316               break;
 317             default:
 318               break;
 319             }
 320
 321           if (failed)
 322             break;
 323         }
 324
 325       if (errpipe >= 0 && FD_ISSET (errpipe, &fds))
 326         {
 327           switch (read_data (errstr, errpipe, error))
 328             {
 329             case READ_FAILED:
 330               failed = TRUE;
 331               break;
 332             case READ_EOF:
 333               close_and_invalidate (&errpipe);
 334               errpipe = -1;
 335               break;
 336             default:
 337               break;
 338             }
 339
 340           if (failed)
 341             break;
 342         }
 343     }
 344
 345   /* These should only be open still if we had an error.  */
 346
 347   if (outpipe >= 0)
 348     close_and_invalidate (&outpipe);
 349   if (errpipe >= 0)
 350     close_and_invalidate (&errpipe);
 351
 352   /* Wait for child to exit, even if we have
 353    * an error pending.
 354    */
 355  again:
 356
 357   ret = waitpid (pid, &status, 0);
 358
 359   if (ret < 0)
 360     {
 361       if (errno == EINTR)
 362         goto again;
 363       else if (errno == ECHILD)
 364         {
 365           if (exit_status)
 366             {
 367               g_warning ("In call to g_spawn_sync(), exit status of a child process was requested but SIGCHLD action was set to SIG_IGN and ECHILD was received by waitpid(), so exit status can't be returned. This is a bug in the program calling g_spawn_sync(); either don't request the exit status, or don't set the SIGCHLD action.");
 368             }
 369           else
 370             {
 371               /* We don't need the exit status. */
 372             }
 373         }
 374       else
 375         {
 376           if (!failed) /* avoid error pileups */
 377             {
 378               failed = TRUE;
 379
 380               g_set_error (error,
 381                            G_SPAWN_ERROR,
 382                            G_SPAWN_ERROR_READ,
 383                            _("Unexpected error in waitpid() (%s)"),
 384                            g_strerror (errno));
 385             }
 386         }
 387     }
 388
 389   if (failed)
 390     {
 391       if (outstr)
 392         g_string_free (outstr, TRUE);
 393       if (errstr)
 394         g_string_free (errstr, TRUE);
 395
 396       return FALSE;
 397     }
 398   else
 399     {
 400       if (exit_status)
 401         *exit_status = status;
 402
 403       if (standard_output)
 404         *standard_output = g_string_free (outstr, FALSE);
 405
 406       if (standard_error)
 407         *standard_error = g_string_free (errstr, FALSE);
 408
 409       return TRUE;
 410     }
 411 }
 412
 413 /**
 414  * g_spawn_async_with_pipes:
 415  * @working_directory: child's current working directory, or %NULL to inherit parent's, in the GLib file name encoding
 416  * @argv: child's argument vector, in the GLib file name encoding
 417  * @envp: child's environment, or %NULL to inherit parent's, in the GLib file name encoding
 418  * @flags: flags from #GSpawnFlags
 419  * @child_setup: function to run in the child just before exec()
 420  * @user_data: user data for @child_setup
 421  * @child_pid: return location for child process ID, or %NULL
 422  * @standard_input: return location for file descriptor to write to child's stdin, or %NULL
 423  * @standard_output: return location for file descriptor to read child's stdout, or %NULL
 424  * @standard_error: return location for file descriptor to read child's stderr, or %NULL
 425  * @error: return location for error
 426  *
 427  * Executes a child program asynchronously (your program will not
 428  * block waiting for the child to exit). The child program is
 429  * specified by the only argument that must be provided, @argv. @argv
 430  * should be a %NULL-terminated array of strings, to be passed as the
 431  * argument vector for the child. The first string in @argv is of
 432  * course the name of the program to execute. By default, the name of
 433  * the program must be a full path; the <envar>PATH</envar> shell variable
 434  * will only be searched if you pass the %G_SPAWN_SEARCH_PATH flag.
 435  *
 436  * On Windows, note that all the string or string vector arguments to
 437  * this function and the other g_spawn*() functions are in UTF-8, the
 438  * GLib file name encoding. Unicode characters that are not part of
 439  * the system codepage passed in argument vectors will be correctly
 440  * available in the spawned program only if it uses wide character API
 441  * to retrieve its command line. For C programs built with Microsoft's
 442  * tools it is enough to make the program have a wmain() instead of
 443  * main(). wmain() has a wide character argument vector as parameter.
 444  *
 445  * At least currently, mingw doesn't support wmain(), so if you use
 446  * mingw to develop the spawned program, it will have to call the
 447  * undocumented function __wgetmainargs() to get the wide character
 448  * argument vector and environment. See gspawn-win32-helper.c in the
 449  * GLib sources or init.c in the mingw runtime sources for a prototype
 450  * for that function. Alternatively, you can retrieve the Win32 system
 451  * level wide character command line passed to the spawned program
 452  * using the GetCommandLineW() function.
 453  *
 454  * On Windows the low-level child process creation API
 455  * <function>CreateProcess()</function> doesn't use argument vectors,
 456  * but a command line. The C runtime library's
 457  * <function>spawn*()</function> family of functions (which
 458  * g_spawn_async_with_pipes() eventually calls) paste the argument
 459  * vector elements together into a command line, and the C runtime startup code
 460  * does a corresponding reconstruction of an argument vector from the
 461  * command line, to be passed to main(). Complications arise when you have
 462  * argument vector elements that contain spaces of double quotes. The
 463  * <function>spawn*()</function> functions don't do any quoting or
 464  * escaping, but on the other hand the startup code does do unquoting
 465  * and unescaping in order to enable receiving arguments with embedded
 466  * spaces or double quotes. To work around this asymmetry,
 467  * g_spawn_async_with_pipes() will do quoting and escaping on argument
 468  * vector elements that need it before calling the C runtime
 469  * spawn() function.
 470  *
 471  * @envp is a %NULL-terminated array of strings, where each string
 472  * has the form <literal>KEY=VALUE</literal>. This will become
 473  * the child's environment. If @envp is %NULL, the child inherits its
 474  * parent's environment.
 475  *
 476  * @flags should be the bitwise OR of any flags you want to affect the
 477  * function's behaviour. The %G_SPAWN_DO_NOT_REAP_CHILD means that
 478  * the child will not automatically be reaped; you must use a
 479  * #GChildWatch source to be notified about the death of the child
 480  * process. Eventually you must call g_spawn_close_pid() on the
 481  * @child_pid, in order to free resources which may be associated
 482  * with the child process. (On Unix, using a #GChildWatch source is
 483  * equivalent to calling waitpid() or handling the %SIGCHLD signal
 484  * manually. On Windows, calling g_spawn_close_pid() is equivalent
 485  * to calling CloseHandle() on the process handle returned in
 486  * @child_pid).
 487  *
 488  * %G_SPAWN_LEAVE_DESCRIPTORS_OPEN means that the parent's open file
 489  * descriptors will be inherited by the child; otherwise all
 490  * descriptors except stdin/stdout/stderr will be closed before
 491  * calling exec() in the child. %G_SPAWN_SEARCH_PATH
 492  * means that <literal>argv[0]</literal> need not be an absolute path, it
 493  * will be looked for in the user's <envar>PATH</envar>.
 494  * %G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output will
 495  * be discarded, instead of going to the same location as the parent's
 496  * standard output. If you use this flag, @standard_output must be %NULL.
 497  * %G_SPAWN_STDERR_TO_DEV_NULL means that the child's standard error
 498  * will be discarded, instead of going to the same location as the parent's
 499  * standard error. If you use this flag, @standard_error must be %NULL.
 500  * %G_SPAWN_CHILD_INHERITS_STDIN means that the child will inherit the parent's
 501  * standard input (by default, the child's standard input is attached to
 502  * /dev/null). If you use this flag, @standard_input must be %NULL.
 503  * %G_SPAWN_FILE_AND_ARGV_ZERO means that the first element of @argv is
 504  * the file to execute, while the remaining elements are the
 505  * actual argument vector to pass to the file. Normally
 506  * g_spawn_async_with_pipes() uses @argv[0] as the file to execute, and
 507  * passes all of @argv to the child.
 508  *
 509  * @child_setup and @user_data are a function and user data. On POSIX
 510  * platforms, the function is called in the child after GLib has
 511  * performed all the setup it plans to perform (including creating
 512  * pipes, closing file descriptors, etc.) but before calling
 513  * exec(). That is, @child_setup is called just
 514  * before calling exec() in the child. Obviously
 515  * actions taken in this function will only affect the child, not the
 516  * parent. On Windows, there is no separate fork() and exec()
 517  * functionality. Child processes are created and run with
 518  * a single API call, CreateProcess(). @child_setup is
 519  * called in the parent process just before creating the child
 520  * process. You should carefully consider what you do in @child_setup
 521  * if you intend your software to be portable to Windows.
 522  *
 523  * If non-%NULL, @child_pid will on Unix be filled with the child's
 524  * process ID. You can use the process ID to send signals to the
 525  * child, or to waitpid() if you specified the
 526  * %G_SPAWN_DO_NOT_REAP_CHILD flag. On Windows, @child_pid will be
 527  * filled with a handle to the child process only if you specified the
 528  * %G_SPAWN_DO_NOT_REAP_CHILD flag. You can then access the child
 529  * process using the Win32 API, for example wait for its termination
 530  * with the <function>WaitFor*()</function> functions, or examine its
 531  * exit code with GetExitCodeProcess(). You should close the handle
 532  * with CloseHandle() or g_spawn_close_pid() when you no longer need it.
 533  *
 534  * If non-%NULL, the @standard_input, @standard_output, @standard_error
 535  * locations will be filled with file descriptors for writing to the child's
 536  * standard input or reading from its standard output or standard error.
 537  * The caller of g_spawn_async_with_pipes() must close these file descriptors
 538  * when they are no longer in use. If these parameters are %NULL, the corresponding
 539  * pipe won't be created.
 540  *
 541  * If @standard_input is NULL, the child's standard input is attached to /dev/null
 542  * unless %G_SPAWN_CHILD_INHERITS_STDIN is set.
 543  *
 544  * If @standard_error is NULL, the child's standard error goes to the same location
 545  * as the parent's standard error unless %G_SPAWN_STDERR_TO_DEV_NULL is set.
 546  *
 547  * If @standard_output is NULL, the child's standard output goes to the same location
 548  * as the parent's standard output unless %G_SPAWN_STDOUT_TO_DEV_NULL is set.
 549  *
 550  * @error can be %NULL to ignore errors, or non-%NULL to report errors.
 551  * If an error is set, the function returns %FALSE. Errors
 552  * are reported even if they occur in the child (for example if the
 553  * executable in <literal>argv[0]</literal> is not found). Typically
 554  * the <literal>message</literal> field of returned errors should be displayed
 555  * to users. Possible errors are those from the #G_SPAWN_ERROR domain.
 556  *
 557  * If an error occurs, @child_pid, @standard_input, @standard_output,
 558  * and @standard_error will not be filled with valid values.
 559  *
 560  * If @child_pid is not %NULL and an error does not occur then the returned
 561  * pid must be closed using g_spawn_close_pid().
 562  *
 563  * Return value: %TRUE on success, %FALSE if an error was set
 564  **/
 565 gboolean
 566 g_spawn_async_with_pipes (const gchar          *working_directory,
 567                           gchar               **argv,
 568                           gchar               **envp,
 569                           GSpawnFlags           flags,
 570                           GSpawnChildSetupFunc  child_setup,
 571                           gpointer              user_data,
 572                           GPid                 *child_pid,
 573                           gint                 *standard_input,
 574                           gint                 *standard_output,
 575                           gint                 *standard_error,
 576                           GError              **error)
 577 {
 578   g_return_val_if_fail (argv != NULL, FALSE);
 579   g_return_val_if_fail (standard_output == NULL ||
 580                         !(flags & G_SPAWN_STDOUT_TO_DEV_NULL), FALSE);
 581   g_return_val_if_fail (standard_error == NULL ||
 582                         !(flags & G_SPAWN_STDERR_TO_DEV_NULL), FALSE);
 583   /* can't inherit stdin if we have an input pipe. */
 584   g_return_val_if_fail (standard_input == NULL ||
 585                         !(flags & G_SPAWN_CHILD_INHERITS_STDIN), FALSE);
 586
 587   return fork_exec_with_pipes (!(flags & G_SPAWN_DO_NOT_REAP_CHILD),
 588                                working_directory,
 589                                argv,
 590                                envp,
 591                                !(flags & G_SPAWN_LEAVE_DESCRIPTORS_OPEN),
 592                                (flags & G_SPAWN_SEARCH_PATH) != 0,
 593                                (flags & G_SPAWN_STDOUT_TO_DEV_NULL) != 0,
 594                                (flags & G_SPAWN_STDERR_TO_DEV_NULL) != 0,
 595                                (flags & G_SPAWN_CHILD_INHERITS_STDIN) != 0,
 596                                (flags & G_SPAWN_FILE_AND_ARGV_ZERO) != 0,
 597                                child_setup,
 598                                user_data,
 599                                child_pid,
 600                                standard_input,
 601                                standard_output,
 602                                standard_error,
 603                                error);
 604 }
 605
 606 /**
 607  * g_spawn_command_line_sync:
 608  * @command_line: a command line
 609  * @standard_output: return location for child output
 610  * @standard_error: return location for child errors
 611  * @exit_status: return location for child exit status, as returned by waitpid()
 612  * @error: return location for errors
 613  *
 614  * A simple version of g_spawn_sync() with little-used parameters
 615  * removed, taking a command line instead of an argument vector.  See
 616  * g_spawn_sync() for full details. @command_line will be parsed by
 617  * g_shell_parse_argv(). Unlike g_spawn_sync(), the %G_SPAWN_SEARCH_PATH flag
 618  * is enabled. Note that %G_SPAWN_SEARCH_PATH can have security
 619  * implications, so consider using g_spawn_sync() directly if
 620  * appropriate. Possible errors are those from g_spawn_sync() and those
 621  * from g_shell_parse_argv().
 622  *
 623  * If @exit_status is non-%NULL, the exit status of the child is stored there as
 624  * it would be returned by waitpid(); standard UNIX macros such as WIFEXITED()
 625  * and WEXITSTATUS() must be used to evaluate the exit status.
 626  *
 627  * On Windows, please note the implications of g_shell_parse_argv()
 628  * parsing @command_line. Parsing is done according to Unix shell rules, not
 629  * Windows command interpreter rules.
 630  * Space is a separator, and backslashes are
 631  * special. Thus you cannot simply pass a @command_line containing
 632  * canonical Windows paths, like "c:\\program files\\app\\app.exe", as
 633  * the backslashes will be eaten, and the space will act as a
 634  * separator. You need to enclose such paths with single quotes, like
 635  * "'c:\\program files\\app\\app.exe' 'e:\\folder\\argument.txt'".
 636  *
 637  * Return value: %TRUE on success, %FALSE if an error was set
 638  **/
 639 gboolean
 640 g_spawn_command_line_sync (const gchar  *command_line,
 641                            gchar       **standard_output,
 642                            gchar       **standard_error,
 643                            gint         *exit_status,
 644                            GError      **error)
 645 {
 646   gboolean retval;
 647   gchar **argv = NULL;
 648
 649   g_return_val_if_fail (command_line != NULL, FALSE);
 650
 651   if (!g_shell_parse_argv (command_line,
 652                            NULL, &argv,
 653                            error))
 654     return FALSE;
 655
 656   retval = g_spawn_sync (NULL,
 657                          argv,
 658                          NULL,
 659                          G_SPAWN_SEARCH_PATH,
 660                          NULL,
 661                          NULL,
 662                          standard_output,
 663                          standard_error,
 664                          exit_status,
 665                          error);
 666   g_strfreev (argv);
 667
 668   return retval;
 669 }
 670
 671 /**
 672  * g_spawn_command_line_async:
 673  * @command_line: a command line
 674  * @error: return location for errors
 675  *
 676  * A simple version of g_spawn_async() that parses a command line with
 677  * g_shell_parse_argv() and passes it to g_spawn_async(). Runs a
 678  * command line in the background. Unlike g_spawn_async(), the
 679  * %G_SPAWN_SEARCH_PATH flag is enabled, other flags are not. Note
 680  * that %G_SPAWN_SEARCH_PATH can have security implications, so
 681  * consider using g_spawn_async() directly if appropriate. Possible
 682  * errors are those from g_shell_parse_argv() and g_spawn_async().
 683  *
 684  * The same concerns on Windows apply as for g_spawn_command_line_sync().
 685  *
 686  * Return value: %TRUE on success, %FALSE if error is set.
 687  **/
 688 gboolean
 689 g_spawn_command_line_async (const gchar *command_line,
 690                             GError     **error)
 691 {
 692   gboolean retval;
 693   gchar **argv = NULL;
 694
 695   g_return_val_if_fail (command_line != NULL, FALSE);
 696
 697   if (!g_shell_parse_argv (command_line,
 698                            NULL, &argv,
 699                            error))
 700     return FALSE;
 701
 702   retval = g_spawn_async (NULL,
 703                           argv,
 704                           NULL,
 705                           G_SPAWN_SEARCH_PATH,
 706                           NULL,
 707                           NULL,
 708                           NULL,
 709                           error);
 710   g_strfreev (argv);
 711
 712   return retval;
 713 }
 714
 715 static gint
 716 exec_err_to_g_error (gint en)
 717 {
 718   switch (en)
 719     {
 720 #ifdef EACCES
 721     case EACCES:
 722       return G_SPAWN_ERROR_ACCES;
 723       break;
 724 #endif
 725
 726 #ifdef EPERM
 727     case EPERM:
 728       return G_SPAWN_ERROR_PERM;
 729       break;
 730 #endif
 731
 732 #ifdef E2BIG
 733     case E2BIG:
 734       return G_SPAWN_ERROR_2BIG;
 735       break;
 736 #endif
 737
 738 #ifdef ENOEXEC
 739     case ENOEXEC:
 740       return G_SPAWN_ERROR_NOEXEC;
 741       break;
 742 #endif
 743
 744 #ifdef ENAMETOOLONG
 745     case ENAMETOOLONG:
 746       return G_SPAWN_ERROR_NAMETOOLONG;
 747       break;
 748 #endif
 749
 750 #ifdef ENOENT
 751     case ENOENT:
 752       return G_SPAWN_ERROR_NOENT;
 753       break;
 754 #endif
 755
 756 #ifdef ENOMEM
 757     case ENOMEM:
 758       return G_SPAWN_ERROR_NOMEM;
 759       break;
 760 #endif
 761
 762 #ifdef ENOTDIR
 763     case ENOTDIR:
 764       return G_SPAWN_ERROR_NOTDIR;
 765       break;
 766 #endif
 767
 768 #ifdef ELOOP
 769     case ELOOP:
 770       return G_SPAWN_ERROR_LOOP;
 771       break;
 772 #endif
 773
 774 #ifdef ETXTBUSY
 775     case ETXTBUSY:
 776       return G_SPAWN_ERROR_TXTBUSY;
 777       break;
 778 #endif
 779
 780 #ifdef EIO
 781     case EIO:
 782       return G_SPAWN_ERROR_IO;
 783       break;
 784 #endif
 785
 786 #ifdef ENFILE
 787     case ENFILE:
 788       return G_SPAWN_ERROR_NFILE;
 789       break;
 790 #endif
 791
 792 #ifdef EMFILE
 793     case EMFILE:
 794       return G_SPAWN_ERROR_MFILE;
 795       break;
 796 #endif
 797
 798 #ifdef EINVAL
 799     case EINVAL:
 800       return G_SPAWN_ERROR_INVAL;
 801       break;
 802 #endif
 803
 804 #ifdef EISDIR
 805     case EISDIR:
 806       return G_SPAWN_ERROR_ISDIR;
 807       break;
 808 #endif
 809
 810 #ifdef ELIBBAD
 811     case ELIBBAD:
 812       return G_SPAWN_ERROR_LIBBAD;
 813       break;
 814 #endif
 815
 816     default:
 817       return G_SPAWN_ERROR_FAILED;
 818       break;
 819     }
 820 }
 821
 822 static gssize
 823 write_all (gint fd, gconstpointer vbuf, gsize to_write)
 824 {
 825   gchar *buf = (gchar *) vbuf;
 826
 827   while (to_write > 0)
 828     {
 829       gssize count = write (fd, buf, to_write);
 830       if (count < 0)
 831         {
 832           if (errno != EINTR)
 833             return FALSE;
 834         }
 835       else
 836         {
 837           to_write -= count;
 838           buf += count;
 839         }
 840     }
 841
 842   return TRUE;
 843 }
 844
 845 static void
 846 write_err_and_exit (gint fd, gint msg)
 847 {
 848   gint en = errno;
 849
 850   write_all (fd, &msg, sizeof(msg));
 851   write_all (fd, &en, sizeof(en));
 852
 853   _exit (1);
 854 }
 855
 856 static void
 857 set_cloexec (void *data, gint fd)
 858 {
 859   if (fd > 2)
 860     fcntl (fd, F_SETFD, FD_CLOEXEC);
 861 }
 862
 863 #ifndef HAVE_FDWALK
 864 static int
 865 fdwalk (int (*cb)(void *data, int fd), void *data)
 866 {
 867   gint open_max;
 868   gint fd;
 869   gint res;
 870
 871   res = 0;
 872   open_max = sysconf (_SC_OPEN_MAX);
 873   for (fd = 0; fd < open_max && res == 0; fd++)
 874     res = cb (data, fd);
 875
 876   return res;
 877 }
 878 #endif
 879
 880 static gint
 881 sane_dup2 (gint fd1, gint fd2)
 882 {
 883   gint ret;
 884
 885  retry:
 886   ret = dup2 (fd1, fd2);
 887   if (ret < 0 && errno == EINTR)
 888     goto retry;
 889
 890   return ret;
 891 }
 892
 893 enum
 894 {
 895   CHILD_CHDIR_FAILED,
 896   CHILD_EXEC_FAILED,
 897   CHILD_DUP2_FAILED,
 898   CHILD_FORK_FAILED
 899 };
 900
 901 static void
 902 do_exec (gint                  child_err_report_fd,
 903          gint                  stdin_fd,
 904          gint                  stdout_fd,
 905          gint                  stderr_fd,
 906          const gchar          *working_directory,
 907          gchar               **argv,
 908          gchar               **envp,
 909          gboolean              close_descriptors,
 910          gboolean              search_path,
 911          gboolean              stdout_to_null,
 912          gboolean              stderr_to_null,
 913          gboolean              child_inherits_stdin,
 914          gboolean              file_and_argv_zero,
 915          GSpawnChildSetupFunc  child_setup,
 916          gpointer              user_data)
 917 {
 918   if (working_directory && chdir (working_directory) < 0)
 919     write_err_and_exit (child_err_report_fd,
 920                         CHILD_CHDIR_FAILED);
 921
 922   /* Close all file descriptors but stdin stdout and stderr as
 923    * soon as we exec. Note that this includes
 924    * child_err_report_fd, which keeps the parent from blocking
 925    * forever on the other end of that pipe.
 926    */
 927   if (close_descriptors)
 928     {
 929       fdwalk (set_cloexec, NULL);
 930     }
 931   else
 932     {
 933       /* We need to do child_err_report_fd anyway */
 934       set_cloexec (NULL, child_err_report_fd);
 935     }
 936
 937   /* Redirect pipes as required */
 938
 939   if (stdin_fd >= 0)
 940     {
 941       /* dup2 can't actually fail here I don't think */
 942
 943       if (sane_dup2 (stdin_fd, 0) < 0)
 944         write_err_and_exit (child_err_report_fd,
 945                             CHILD_DUP2_FAILED);
 946
 947       /* ignore this if it doesn't work */
 948       close_and_invalidate (&stdin_fd);
 949     }
 950   else if (!child_inherits_stdin)
 951     {
 952       /* Keep process from blocking on a read of stdin */
 953       gint read_null = open ("/dev/null", O_RDONLY);
 954       sane_dup2 (read_null, 0);
 955       close_and_invalidate (&read_null);
 956     }
 957
 958   if (stdout_fd >= 0)
 959     {
 960       /* dup2 can't actually fail here I don't think */
 961
 962       if (sane_dup2 (stdout_fd, 1) < 0)
 963         write_err_and_exit (child_err_report_fd,
 964                             CHILD_DUP2_FAILED);
 965
 966       /* ignore this if it doesn't work */
 967       close_and_invalidate (&stdout_fd);
 968     }
 969   else if (stdout_to_null)
 970     {
 971       gint write_null = open ("/dev/null", O_WRONLY);
 972       sane_dup2 (write_null, 1);
 973       close_and_invalidate (&write_null);
 974     }
 975
 976   if (stderr_fd >= 0)
 977     {
 978       /* dup2 can't actually fail here I don't think */
 979
 980       if (sane_dup2 (stderr_fd, 2) < 0)
 981         write_err_and_exit (child_err_report_fd,
 982                             CHILD_DUP2_FAILED);
 983
 984       /* ignore this if it doesn't work */
 985       close_and_invalidate (&stderr_fd);
 986     }
 987   else if (stderr_to_null)
 988     {
 989       gint write_null = open ("/dev/null", O_WRONLY);
 990       sane_dup2 (write_null, 2);
 991       close_and_invalidate (&write_null);
 992     }
 993
 994   /* Call user function just before we exec */
 995   if (child_setup)
 996     {
 997       (* child_setup) (user_data);
 998     }
 999
1000   g_execute (argv[0],
1001              file_and_argv_zero ? argv + 1 : argv,
1002              envp, search_path);
1003
1004   /* Exec failed */
1005   write_err_and_exit (child_err_report_fd,
1006                       CHILD_EXEC_FAILED);
1007 }
1008
1009 static gboolean
1010 read_ints (int      fd,
1011            gint*    buf,
1012            gint     n_ints_in_buf,
1013            gint    *n_ints_read,
1014            GError **error)
1015 {
1016   gsize bytes = 0;
1017
1018   while (TRUE)
1019     {
1020       gssize chunk;
1021
1022       if (bytes >= sizeof(gint)*2)
1023         break; /* give up, who knows what happened, should not be
1024                 * possible.
1025                 */
1026
1027     again:
1028       chunk = read (fd,
1029                     ((gchar*)buf) + bytes,
1030                     sizeof(gint) * n_ints_in_buf - bytes);
1031       if (chunk < 0 && errno == EINTR)
1032         goto again;
1033
1034       if (chunk < 0)
1035         {
1036           /* Some weird shit happened, bail out */
1037
1038           g_set_error (error,
1039                        G_SPAWN_ERROR,
1040                        G_SPAWN_ERROR_FAILED,
1041                        _("Failed to read from child pipe (%s)"),
1042                        g_strerror (errno));
1043
1044           return FALSE;
1045         }
1046       else if (chunk == 0)
1047         break; /* EOF */
1048       else /* chunk > 0 */
1049         bytes += chunk;
1050     }
1051
1052   *n_ints_read = (gint)(bytes / sizeof(gint));
1053
1054   return TRUE;
1055 }
1056
1057 static gboolean
1058 fork_exec_with_pipes (gboolean              intermediate_child,
1059                       const gchar          *working_directory,
1060                       gchar               **argv,
1061                       gchar               **envp,
1062                       gboolean              close_descriptors,
1063                       gboolean              search_path,
1064                       gboolean              stdout_to_null,
1065                       gboolean              stderr_to_null,
1066                       gboolean              child_inherits_stdin,
1067                       gboolean              file_and_argv_zero,
1068                       GSpawnChildSetupFunc  child_setup,
1069                       gpointer              user_data,
1070                       GPid                 *child_pid,
1071                       gint                 *standard_input,
1072                       gint                 *standard_output,
1073                       gint                 *standard_error,
1074                       GError              **error)
1075 {
1076   GPid pid = -1;
1077   gint stdin_pipe[2] = { -1, -1 };
1078   gint stdout_pipe[2] = { -1, -1 };
1079   gint stderr_pipe[2] = { -1, -1 };
1080   gint child_err_report_pipe[2] = { -1, -1 };
1081   gint child_pid_report_pipe[2] = { -1, -1 };
1082   gint status;
1083
1084   if (!make_pipe (child_err_report_pipe, error))
1085     return FALSE;
1086
1087   if (intermediate_child && !make_pipe (child_pid_report_pipe, error))
1088     goto cleanup_and_fail;
1089
1090   if (standard_input && !make_pipe (stdin_pipe, error))
1091     goto cleanup_and_fail;
1092
1093   if (standard_output && !make_pipe (stdout_pipe, error))
1094     goto cleanup_and_fail;
1095
1096   if (standard_error && !make_pipe (stderr_pipe, error))
1097     goto cleanup_and_fail;
1098
1099   pid = fork ();
1100
1101   if (pid < 0)
1102     {
1103       g_set_error (error,
1104                    G_SPAWN_ERROR,
1105                    G_SPAWN_ERROR_FORK,
1106                    _("Failed to fork (%s)"),
1107                    g_strerror (errno));
1108
1109       goto cleanup_and_fail;
1110     }
1111   else if (pid == 0)
1112     {
1113       /* Immediate child. This may or may not be the child that
1114        * actually execs the new process.
1115        */
1116
1117       /* Be sure we crash if the parent exits
1118        * and we write to the err_report_pipe
1119        */
1120       signal (SIGPIPE, SIG_DFL);
1121
1122       /* Close the parent's end of the pipes;
1123        * not needed in the close_descriptors case,
1124        * though
1125        */
1126       close_and_invalidate (&child_err_report_pipe[0]);
1127       close_and_invalidate (&child_pid_report_pipe[0]);
1128       close_and_invalidate (&stdin_pipe[1]);
1129       close_and_invalidate (&stdout_pipe[0]);
1130       close_and_invalidate (&stderr_pipe[0]);
1131
1132       if (intermediate_child)
1133         {
1134           /* We need to fork an intermediate child that launches the
1135            * final child. The purpose of the intermediate child
1136            * is to exit, so we can waitpid() it immediately.
1137            * Then the grandchild will not become a zombie.
1138            */
1139           GPid grandchild_pid;
1140
1141           grandchild_pid = fork ();
1142
1143           if (grandchild_pid < 0)
1144             {
1145               /* report -1 as child PID */
1146               write_all (child_pid_report_pipe[1], &grandchild_pid,
1147                          sizeof(grandchild_pid));
1148
1149               write_err_and_exit (child_err_report_pipe[1],
1150                                   CHILD_FORK_FAILED);
1151             }
1152           else if (grandchild_pid == 0)
1153             {
1154               do_exec (child_err_report_pipe[1],
1155                        stdin_pipe[0],
1156                        stdout_pipe[1],
1157                        stderr_pipe[1],
1158                        working_directory,
1159                        argv,
1160                        envp,
1161                        close_descriptors,
1162                        search_path,
1163                        stdout_to_null,
1164                        stderr_to_null,
1165                        child_inherits_stdin,
1166                        file_and_argv_zero,
1167                        child_setup,
1168                        user_data);
1169             }
1170           else
1171             {
1172               write_all (child_pid_report_pipe[1], &grandchild_pid, sizeof(grandchild_pid));
1173               close_and_invalidate (&child_pid_report_pipe[1]);
1174
1175               _exit (0);
1176             }
1177         }
1178       else
1179         {
1180           /* Just run the child.
1181            */
1182
1183           do_exec (child_err_report_pipe[1],
1184                    stdin_pipe[0],
1185                    stdout_pipe[1],
1186                    stderr_pipe[1],
1187                    working_directory,
1188                    argv,
1189                    envp,
1190                    close_descriptors,
1191                    search_path,
1192                    stdout_to_null,
1193                    stderr_to_null,
1194                    child_inherits_stdin,
1195                    file_and_argv_zero,
1196                    child_setup,
1197                    user_data);
1198         }
1199     }
1200   else
1201     {
1202       /* Parent */
1203
1204       gint buf[2];
1205       gint n_ints = 0;
1206
1207       /* Close the uncared-about ends of the pipes */
1208       close_and_invalidate (&child_err_report_pipe[1]);
1209       close_and_invalidate (&child_pid_report_pipe[1]);
1210       close_and_invalidate (&stdin_pipe[0]);
1211       close_and_invalidate (&stdout_pipe[1]);
1212       close_and_invalidate (&stderr_pipe[1]);
1213
1214       /* If we had an intermediate child, reap it */
1215       if (intermediate_child)
1216         {
1217         wait_again:
1218           if (waitpid (pid, &status, 0) < 0)
1219             {
1220               if (errno == EINTR)
1221                 goto wait_again;
1222               else if (errno == ECHILD)
1223                 ; /* do nothing, child already reaped */
1224               else
1225                 g_warning ("waitpid() should not fail in "
1226                            "'fork_exec_with_pipes'");
1227             }
1228         }
1229
1230
1231       if (!read_ints (child_err_report_pipe[0],
1232                       buf, 2, &n_ints,
1233                       error))
1234         goto cleanup_and_fail;
1235
1236       if (n_ints >= 2)
1237         {
1238           /* Error from the child. */
1239
1240           switch (buf[0])
1241             {
1242             case CHILD_CHDIR_FAILED:
1243               g_set_error (error,
1244                            G_SPAWN_ERROR,
1245                            G_SPAWN_ERROR_CHDIR,
1246                            _("Failed to change to directory '%s' (%s)"),
1247                            working_directory,
1248                            g_strerror (buf[1]));
1249
1250               break;
1251
1252             case CHILD_EXEC_FAILED:
1253               g_set_error (error,
1254                            G_SPAWN_ERROR,
1255                            exec_err_to_g_error (buf[1]),
1256                            _("Failed to execute child process \"%s\" (%s)"),
1257                            argv[0],
1258                            g_strerror (buf[1]));
1259
1260               break;
1261
1262             case CHILD_DUP2_FAILED:
1263               g_set_error (error,
1264                            G_SPAWN_ERROR,
1265                            G_SPAWN_ERROR_FAILED,
1266                            _("Failed to redirect output or input of child process (%s)"),
1267                            g_strerror (buf[1]));
1268
1269               break;
1270
1271             case CHILD_FORK_FAILED:
1272               g_set_error (error,
1273                            G_SPAWN_ERROR,
1274                            G_SPAWN_ERROR_FORK,
1275                            _("Failed to fork child process (%s)"),
1276                            g_strerror (buf[1]));
1277               break;
1278
1279             default:
1280               g_set_error (error,
1281                            G_SPAWN_ERROR,
1282                            G_SPAWN_ERROR_FAILED,
1283                            _("Unknown error executing child process \"%s\""),
1284                            argv[0]);
1285               break;
1286             }
1287
1288           goto cleanup_and_fail;
1289         }
1290
1291       /* Get child pid from intermediate child pipe. */
1292       if (intermediate_child)
1293         {
1294           n_ints = 0;
1295
1296           if (!read_ints (child_pid_report_pipe[0],
1297                           buf, 1, &n_ints, error))
1298             goto cleanup_and_fail;
1299
1300           if (n_ints < 1)
1301             {
1302               g_set_error (error,
1303                            G_SPAWN_ERROR,
1304                            G_SPAWN_ERROR_FAILED,
1305                            _("Failed to read enough data from child pid pipe (%s)"),
1306                            g_strerror (errno));
1307               goto cleanup_and_fail;
1308             }
1309           else
1310             {
1311               /* we have the child pid */
1312               pid = buf[0];
1313             }
1314         }
1315
1316       /* Success against all odds! return the information */
1317       close_and_invalidate (&child_err_report_pipe[0]);
1318       close_and_invalidate (&child_pid_report_pipe[0]);
1319
1320       if (child_pid)
1321         *child_pid = pid;
1322
1323       if (standard_input)
1324         *standard_input = stdin_pipe[1];
1325       if (standard_output)
1326         *standard_output = stdout_pipe[0];
1327       if (standard_error)
1328         *standard_error = stderr_pipe[0];
1329
1330       return TRUE;
1331     }
1332
1333  cleanup_and_fail:
1334
1335   /* There was an error from the Child, reap the child to avoid it being
1336      a zombie.
1337    */
1338
1339   if (pid > 0)
1340   {
1341     wait_failed:
1342      if (waitpid (pid, NULL, 0) < 0)
1343        {
1344           if (errno == EINTR)
1345             goto wait_failed;
1346           else if (errno == ECHILD)
1347             ; /* do nothing, child already reaped */
1348           else
1349             g_warning ("waitpid() should not fail in "
1350                        "'fork_exec_with_pipes'");
1351        }
1352    }
1353
1354   close_and_invalidate (&child_err_report_pipe[0]);
1355   close_and_invalidate (&child_err_report_pipe[1]);
1356   close_and_invalidate (&child_pid_report_pipe[0]);
1357   close_and_invalidate (&child_pid_report_pipe[1]);
1358   close_and_invalidate (&stdin_pipe[0]);
1359   close_and_invalidate (&stdin_pipe[1]);
1360   close_and_invalidate (&stdout_pipe[0]);
1361   close_and_invalidate (&stdout_pipe[1]);
1362   close_and_invalidate (&stderr_pipe[0]);
1363   close_and_invalidate (&stderr_pipe[1]);
1364
1365   return FALSE;
1366 }
1367
1368 static gboolean
1369 make_pipe (gint     p[2],
1370            GError **error)
1371 {
1372   if (pipe (p) < 0)
1373     {
1374       g_set_error (error,
1375                    G_SPAWN_ERROR,
1376                    G_SPAWN_ERROR_FAILED,
1377                    _("Failed to create pipe for communicating with child process (%s)"),
1378                    g_strerror (errno));
1379       return FALSE;
1380     }
1381   else
1382     return TRUE;
1383 }
1384
1385 /* Based on execvp from GNU C Library */
1386
1387 static void
1388 script_execute (const gchar *file,
1389                 gchar      **argv,
1390                 gchar      **envp,
1391                 gboolean     search_path)
1392 {
1393   /* Count the arguments.  */
1394   int argc = 0;
1395   while (argv[argc])
1396     ++argc;
1397
1398   /* Construct an argument list for the shell.  */
1399   {
1400     gchar **new_argv;
1401
1402     new_argv = g_new0 (gchar*, argc + 2); /* /bin/sh and NULL */
1403
1404     new_argv[0] = (char *) "/bin/sh";
1405     new_argv[1] = (char *) file;
1406     while (argc > 0)
1407       {
1408         new_argv[argc + 1] = argv[argc];
1409         --argc;
1410       }
1411
1412     /* Execute the shell. */
1413     if (envp)
1414       execve (new_argv[0], new_argv, envp);
1415     else
1416       execv (new_argv[0], new_argv);
1417
1418     g_free (new_argv);
1419   }
1420 }
1421
1422 static gchar*
1423 my_strchrnul (const gchar *str, gchar c)
1424 {
1425   gchar *p = (gchar*) str;
1426   while (*p && (*p != c))
1427     ++p;
1428
1429   return p;
1430 }
1431
1432 static gint
1433 g_execute (const gchar *file,
1434            gchar      **argv,
1435            gchar      **envp,
1436            gboolean     search_path)
1437 {
1438   if (*file == '\0')
1439     {
1440       /* We check the simple case first. */
1441       errno = ENOENT;
1442       return -1;
1443     }
1444
1445   if (!search_path || strchr (file, '/') != NULL)
1446     {
1447       /* Don't search when it contains a slash. */
1448       if (envp)
1449         execve (file, argv, envp);
1450       else
1451         execv (file, argv);
1452
1453       if (errno == ENOEXEC)
1454         script_execute (file, argv, envp, FALSE);
1455     }
1456   else
1457     {
1458       gboolean got_eacces = 0;
1459       const gchar *path, *p;
1460       gchar *name, *freeme;
1461       size_t len;
1462       size_t pathlen;
1463
1464       path = g_getenv ("PATH");
1465       if (path == NULL)
1466         {
1467           /* There is no `PATH' in the environment.  The default
1468            * search path in libc is the current directory followed by
1469            * the path `confstr' returns for `_CS_PATH'.
1470            */
1471
1472           /* In GLib we put . last, for security, and don't use the
1473            * unportable confstr(); UNIX98 does not actually specify
1474            * what to search if PATH is unset. POSIX may, dunno.
1475            */
1476
1477           path = "/bin:/usr/bin:.";
1478         }
1479
1480       len = strlen (file) + 1;
1481       pathlen = strlen (path);
1482       freeme = name = g_malloc (pathlen + len + 1);
1483
1484       /* Copy the file name at the top, including '\0'  */
1485       memcpy (name + pathlen + 1, file, len);
1486       name = name + pathlen;
1487       /* And add the slash before the filename  */
1488       *name = '/';
1489
1490       p = path;
1491       do
1492         {
1493           char *startp;
1494
1495           path = p;
1496           p = my_strchrnul (path, ':');
1497
1498           if (p == path)
1499             /* Two adjacent colons, or a colon at the beginning or the end
1500              * of `PATH' means to search the current directory.
1501              */
1502             startp = name + 1;
1503           else
1504             startp = memcpy (name - (p - path), path, p - path);
1505
1506           /* Try to execute this name.  If it works, execv will not return.  */
1507           if (envp)
1508             execve (startp, argv, envp);
1509           else
1510             execv (startp, argv);
1511
1512           if (errno == ENOEXEC)
1513             script_execute (startp, argv, envp, search_path);
1514
1515           switch (errno)
1516             {
1517             case EACCES:
1518               /* Record the we got a `Permission denied' error.  If we end
1519                * up finding no executable we can use, we want to diagnose
1520                * that we did find one but were denied access.
1521                */
1522               got_eacces = TRUE;
1523
1524               /* FALL THRU */
1525
1526             case ENOENT:
1527 #ifdef ESTALE
1528             case ESTALE:
1529 #endif
1530 #ifdef ENOTDIR
1531             case ENOTDIR:
1532 #endif
1533               /* Those errors indicate the file is missing or not executable
1534                * by us, in which case we want to just try the next path
1535                * directory.
1536                */
1537               break;
1538
1539             default:
1540               /* Some other error means we found an executable file, but
1541                * something went wrong executing it; return the error to our
1542                * caller.
1543                */
1544               g_free (freeme);
1545               return -1;
1546             }
1547         }
1548       while (*p++ != '\0');
1549
1550       /* We tried every element and none of them worked.  */
1551       if (got_eacces)
1552         /* At least one failure was due to permissions, so report that
1553          * error.
1554          */
1555         errno = EACCES;
1556
1557       g_free (freeme);
1558     }
1559
1560   /* Return the error from the last attempt (probably ENOENT).  */
1561   return -1;
1562 }
1563
1564 /**
1565  * g_spawn_close_pid:
1566  * @pid: The process identifier to close
1567  *
1568  * On some platforms, notably WIN32, the #GPid type represents a resource
1569  * which must be closed to prevent resource leaking. g_spawn_close_pid()
1570  * is provided for this purpose. It should be used on all platforms, even
1571  * though it doesn't do anything under UNIX.
1572  **/
1573 void
1574 g_spawn_close_pid (GPid pid)
1575 {
1576 }
1577
1578 #define __G_SPAWN_C__
1579 #include "galiasdef.c"