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