forked from geany/geany
/
spawn.c
1476 lines (1252 loc) · 40.6 KB
/
spawn.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* spawn.c - this file is part of Geany, a fast and lightweight IDE
*
* Copyright 2013 Dimitar Toshkov Zhekov <dimitar(dot)zhekov(at)gmail(dot)com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/* An ongoing effort to improve the tool spawning situation under Windows.
* In particular:
* - There is no g_shell_parse_argv() for windows. It's not hard to write one,
* but the command line recreated by mscvrt may be wrong.
* - GLib converts the argument vector to UNICODE. For non-UTF8 arguments,
* the result is often "Invalid string in argument vector at %d: %s: Invalid
* byte sequence in conversion input" (YMMV). Our tools (make, grep, gcc, ...)
* are "ANSI", so converting to UNICODE and then back only causes problems.
* - For various reasons, GLib uses an intermediate program to start children
* (see gspawn-win32.c), the result being that the grandchildren output (such
* as make -> gcc) is not captured.
* - With non-blocking pipes, the g_io_add_watch() callbacks are never invoked,
* while with blocking pipes, g_io_channel_read_line() blocks.
* - Some other problems are explained in separate comments below.
*
* Even under Unix, using g_io_channel_read_line() is not a good idea, since it may
* buffer lines of unlimited length.
*
* This module does not depend on Geany when compiled for testing (-DSPAWN_TEST).
*/
/** @file spawn.h
* Portable and convenient process spawning and communication.
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <errno.h>
#include <string.h>
#include "spawn.h"
#ifdef G_OS_WIN32
# include <ctype.h> /* isspace() */
# include <fcntl.h> /* _O_RDONLY, _O_WRONLY */
# include <io.h> /* _open_osfhandle, _close */
# include <windows.h>
#else /* G_OS_WIN32 */
# include <signal.h>
#endif /* G_OS_WIN32 */
#ifdef SPAWN_TEST
# define _
# define GEANY_API_SYMBOL
#else
# include "support.h"
#endif
#if ! GLIB_CHECK_VERSION(2, 31, 20) && ! defined(G_SPAWN_ERROR_TOO_BIG)
# define G_SPAWN_ERROR_TOO_BIG G_SPAWN_ERROR_2BIG
#endif
#ifdef G_OS_WIN32
/* Each 4KB under Windows seem to come in 2 portions, so 2K + 2K is more
balanced than 4095 + 1. May be different on the latest Windows/glib? */
# define DEFAULT_IO_LENGTH 2048
#else
# define DEFAULT_IO_LENGTH 4096
/* helper function that cuts glib citing of the original text on bad quoting: it may be long,
and only the caller knows whether it's UTF-8. Thought we lose the ' or " failed info. */
static gboolean spawn_parse_argv(const gchar *command_line, gint *argcp, gchar ***argvp,
GError **error)
{
GError *gerror = NULL;
if (g_shell_parse_argv(command_line, argcp, argvp, &gerror))
return TRUE;
g_set_error_literal(error, gerror->domain, gerror->code,
gerror->code == G_SHELL_ERROR_BAD_QUOTING ?
_("Text ended before matching quote was found") : gerror->message);
g_error_free(gerror);
return FALSE;
}
#endif
#define G_IO_FAILURE (G_IO_ERR | G_IO_HUP | G_IO_NVAL) /* always used together */
/*
* Checks whether a command line is syntactically valid and extracts the program name from it.
*
* See @c spawn_check_command() for details.
*
* @param command_line the command line to check and get the program name from.
* @param error return location for error.
*
* @return allocated string with the program name on success, @c NULL on error.
*/
static gchar *spawn_get_program_name(const gchar *command_line, GError **error)
{
gchar *program;
#ifdef G_OS_WIN32
gboolean open_quote = FALSE;
const gchar *s, *arguments;
g_return_val_if_fail(command_line != NULL, FALSE);
while (*command_line && strchr(" \t\r\n", *command_line))
command_line++;
if (!*command_line)
{
g_set_error_literal(error, G_SHELL_ERROR, G_SHELL_ERROR_EMPTY_STRING,
/* TL note: from glib */
_("Text was empty (or contained only whitespace)"));
return FALSE;
}
/* To prevent Windows from doing something weird, we want to be 100% sure that the
character after the program name is a delimiter, so we allow space and tab only. */
if (*command_line == '"')
{
command_line++;
/* Windows allows "foo.exe, but we may have extra arguments */
if ((s = strchr(command_line, '"')) == NULL)
{
g_set_error_literal(error, G_SHELL_ERROR, G_SHELL_ERROR_BAD_QUOTING,
_("Text ended before matching quote was found"));
return FALSE;
}
if (!strchr(" \t", s[1])) /* strchr() catches s[1] == '\0' */
{
g_set_error_literal(error, G_SHELL_ERROR, G_SHELL_ERROR_BAD_QUOTING,
_("A quoted Windows program name must be entirely inside the quotes"));
return FALSE;
}
}
else
{
const gchar *quote = strchr(command_line, '"');
/* strchr() catches *s == '\0', and the for body is empty */
for (s = command_line; !strchr(" \t", *s); s++);
if (quote && quote < s)
{
g_set_error_literal(error, G_SHELL_ERROR, G_SHELL_ERROR_BAD_QUOTING,
_("A quoted Windows program name must be entirely inside the quotes"));
return FALSE;
}
}
program = g_strndup(command_line, s - command_line);
arguments = s + (*s == '"');
for (s = arguments; *s; s++)
{
if (*s == '"')
{
const char *slash;
for (slash = s; slash > arguments && slash[-1] == '\\'; slash--);
if ((s - slash) % 2 == 0)
open_quote ^= TRUE;
}
}
if (open_quote)
{
g_set_error_literal(error, G_SHELL_ERROR, G_SHELL_ERROR_BAD_QUOTING,
_("Text ended before matching quote was found"));
g_free(program);
return FALSE;
}
#else /* G_OS_WIN32 */
int argc;
char **argv;
if (!spawn_parse_argv(command_line, &argc, &argv, error))
return FALSE;
/* empty string results in parse error, so argv[0] is not NULL */
program = g_strdup(argv[0]);
g_strfreev(argv);
#endif /* G_OS_WIN32 */
return program;
}
/**
* Checks whether a command line is valid.
*
* Checks if @a command_line is syntactically valid.
*
* All OS:
* - any leading spaces, tabs and new lines are skipped
* - an empty command is invalid
*
* Unix:
* - the standard shell quoting and escaping rules are used, see @c g_shell_parse_argv()
* - as a consequence, an unqouted # at the start of an argument comments to the end of line
*
* Windows:
* - leading carriage returns are skipped too
* - a quoted program name must be entirely inside the quotes. No "C:\Foo\Bar".pdf or
* "C:\Foo\Bar".bat, which would be executed by Windows as `C:\Foo\Bar.exe`
* - an unquoted program name may not contain spaces. `Foo Bar Qux` will not be considered
* `"Foo Bar.exe" Qux` or `"Foo Bar Qux.exe"`, depending on what executables exist, as
* Windows normally does.
* - the program name must be separated from the arguments by at least one space or tab
* - the standard Windows quoting and escaping rules are used: double quote is escaped with
* backslash, and any literal backslashes before a double quote must be duplicated.
*
* If @a execute is TRUE, also checks, using @c g_find_program_in_path(), if the program
* specified in @a command_line exists and is executable.
*
* @param command_line the command line to check.
* @param execute whether to check if the command line is really executable.
* @param error return location for error.
*
* @return @c TRUE on success, @c FALSE on error.
*
* @since 1.25
**/
GEANY_API_SYMBOL
gboolean spawn_check_command(const gchar *command_line, gboolean execute, GError **error)
{
gchar *program = spawn_get_program_name(command_line, error);
if (!program)
return FALSE;
if (execute)
{
gchar *executable = g_find_program_in_path(program);
if (!executable)
{
g_set_error_literal(error, G_SHELL_ERROR, G_SHELL_ERROR_FAILED,
_("Program not found"));
g_free(program);
return FALSE;
}
g_free(executable);
}
g_free(program);
return TRUE;
}
/**
* Kills a process.
*
* @param pid id of the process to kill.
* @param error return location for error.
*
* On Unix, sends a SIGTERM to the process.
*
* On Windows, terminates the process with exit code 255 (used sometimes as "generic"
* error code, or for programs terminated with Ctrl+C / Ctrl+Break).
*
* @return @c TRUE on success, @c FALSE on error.
*
* @since 1.25
**/
GEANY_API_SYMBOL
gboolean spawn_kill_process(GPid pid, GError **error)
{
#ifdef G_OS_WIN32
if (!TerminateProcess(pid, 255))
{
gchar *message = g_win32_error_message(GetLastError());
g_set_error_literal(error, G_SPAWN_ERROR, G_SPAWN_ERROR_FAILED, message);
g_free(message);
return FALSE;
}
#else
if (kill(pid, SIGTERM))
{
g_set_error_literal(error, G_SPAWN_ERROR, G_SPAWN_ERROR_FAILED, g_strerror(errno));
return FALSE;
}
#endif
return TRUE;
}
#ifdef G_OS_WIN32
static gchar *spawn_create_process_with_pipes(char *command_line, const char *working_directory,
void *environment, HANDLE *hprocess, int *stdin_fd, int *stdout_fd, int *stderr_fd)
{
enum { WRITE_STDIN, READ_STDOUT, READ_STDERR, READ_STDIN, WRITE_STDOUT, WRITE_STDERR };
wchar_t w_command_line[MAX_PATH];
wchar_t w_working_directory[MAX_PATH];
STARTUPINFOW startup;
PROCESS_INFORMATION process;
HANDLE hpipe[6] = { NULL, NULL, NULL, NULL, NULL, NULL };
int *fd[3] = { stdin_fd, stdout_fd, stderr_fd };
const char *failed; /* failed WIN32/CRTL function, if any */
gchar *message = NULL; /* glib WIN32/CTRL error message */
gchar *failure = NULL; /* full error text */
gboolean pipe_io;
int i;
ZeroMemory(&startup, sizeof startup);
startup.cb = sizeof startup;
pipe_io = stdin_fd || stdout_fd || stderr_fd;
if (pipe_io)
{
startup.dwFlags |= STARTF_USESTDHANDLES;
/* not all programs accept mixed NULL and non-NULL hStd*, so we create all */
for (i = 0; i < 3; i++)
{
static int pindex[3][2] = { { READ_STDIN, WRITE_STDIN },
{ READ_STDOUT, WRITE_STDOUT }, { READ_STDERR, WRITE_STDERR } };
if (!CreatePipe(&hpipe[pindex[i][0]], &hpipe[pindex[i][1]], NULL, 0))
{
hpipe[pindex[i][0]] = hpipe[pindex[i][1]] = NULL;
failed = "create pipe";
goto leave;
}
if (fd[i])
{
static int mode[3] = { _O_WRONLY, _O_RDONLY, _O_RDONLY };
if ((*fd[i] = _open_osfhandle((intptr_t) hpipe[i], mode[i])) == -1)
{
failed = "convert pipe handle to file descriptor";
message = g_strdup(g_strerror(errno));
goto leave;
}
}
else if (!CloseHandle(hpipe[i]))
{
failed = "close pipe";
goto leave;
}
if (!SetHandleInformation(hpipe[i + 3], HANDLE_FLAG_INHERIT,
HANDLE_FLAG_INHERIT))
{
failed = "set pipe handle to inheritable";
goto leave;
}
}
}
startup.hStdInput = hpipe[READ_STDIN];
startup.hStdOutput = hpipe[WRITE_STDOUT];
startup.hStdError = hpipe[WRITE_STDERR];
if (! MultiByteToWideChar(
CP_UTF8, 0, working_directory, -1, w_working_directory, G_N_ELEMENTS(w_working_directory)))
{
gchar *err = g_win32_error_message(GetLastError());
message = g_strdup_printf(
"Failed to convert working directory to multi-byte string: %s", err);
g_free(err);
failed = ""; /* report the message only */
goto leave;
}
if (! MultiByteToWideChar(
CP_UTF8, 0, command_line, -1, w_command_line, G_N_ELEMENTS(w_command_line)))
{
gchar *err = g_win32_error_message(GetLastError());
message = g_strdup_printf(
"Failed to convert command line to multi-byte string: %s", err);
g_free(err);
failed = ""; /* report the message only */
goto leave;
}
if (!CreateProcessW(NULL, w_command_line, NULL, NULL, TRUE, pipe_io ? CREATE_NO_WINDOW : 0,
environment, w_working_directory, &startup, &process))
{
failed = ""; /* report the message only */
/* further errors will not be reported */
}
else
{
failed = NULL;
CloseHandle(process.hThread); /* we don't need this */
if (hprocess)
*hprocess = process.hProcess;
else
CloseHandle(process.hProcess);
}
leave:
if (failed)
{
if (!message)
{
size_t len;
message = g_win32_error_message(GetLastError());
len = strlen(message);
/* unlike g_strerror(), the g_win32_error messages may include a final '.' */
if (len > 0 && message[len - 1] == '.')
message[len - 1] = '\0';
}
if (*failed == '\0')
failure = message;
else
{
failure = g_strdup_printf("Failed to %s (%s)", failed, message);
g_free(message);
}
}
if (pipe_io)
{
for (i = 0; i < 3; i++)
{
if (failed)
{
if (fd[i] && *fd[i] != -1)
_close(*fd[i]);
else if (hpipe[i])
CloseHandle(hpipe[i]);
}
if (hpipe[i + 3])
CloseHandle(hpipe[i + 3]);
}
}
return failure;
}
static void spawn_append_argument(GString *command, const char *text)
{
const char *s;
if (command->len)
g_string_append_c(command, ' ');
for (s = text; *s; s++)
{
/* g_ascii_isspace() fails for '\v', and locale spaces (if any) will do no harm */
if (*s == '"' || isspace(*s))
break;
}
if (*text && !*s)
g_string_append(command, text);
else
{
g_string_append_c(command, '"');
for (s = text; *s; s++)
{
const char *slash;
for (slash = s; *slash == '\\'; slash++);
if (slash > s)
{
g_string_append_len(command, s, slash - s);
if (!*slash || *slash == '"')
{
g_string_append_len(command, s, slash - s);
if (!*slash)
break;
}
s = slash;
}
if (*s == '"')
g_string_append_c(command, '\\');
g_string_append_c(command, *s);
}
g_string_append_c(command, '"');
}
}
#endif /* G_OS_WIN32 */
/*
* Executes a child program asynchronously and setups pipes.
*
* This is the low-level spawning function. Please use @c spawn_with_callbacks() unless
* you need to setup specific event source(s).
*
* A command line or an argument vector must be passed. If both are present, the argument
* vector is appended to the command line. An empty command line is not allowed.
*
* Under Windows, if the child is a console application, and at least one file descriptor is
* specified, the new child console (if any) will be hidden.
*
* If a @a child_pid is passed, it's your responsibility to invoke @c g_spawn_close_pid().
*
* @param working_directory child's current working directory, or @c NULL.
* @param command_line child program and arguments, or @c NULL.
* @param argv child's argument vector, or @c NULL.
* @param envp child's environment, or @c NULL.
* @param child_pid return location for child process ID, or @c NULL.
* @param stdin_fd return location for file descriptor to write to child's stdin, or @c NULL.
* @param stdout_fd return location for file descriptor to read child's stdout, or @c NULL.
* @param stderr_fd return location for file descriptor to read child's stderr, or @c NULL.
* @param error return location for error.
*
* @return @c TRUE on success, @c FALSE on error.
*/
static gboolean spawn_async_with_pipes(const gchar *working_directory, const gchar *command_line,
gchar **argv, gchar **envp, GPid *child_pid, gint *stdin_fd, gint *stdout_fd,
gint *stderr_fd, GError **error)
{
g_return_val_if_fail(command_line != NULL || argv != NULL, FALSE);
#ifdef G_OS_WIN32
GString *command;
GArray *environment;
gchar *failure;
if (command_line)
{
gchar *program = spawn_get_program_name(command_line, error);
const gchar *arguments;
if (!program)
return FALSE;
command = g_string_new(NULL);
arguments = strstr(command_line, program) + strlen(program);
if (*arguments == '"')
{
g_string_append(command, program);
arguments++;
}
else
{
/* quote the first token, to avoid Windows attemps to run two or more
unquoted tokens as a program until an existing file name is found */
g_string_printf(command, "\"%s\"", program);
}
g_string_append(command, arguments);
g_free(program);
}
else
command = g_string_new(NULL);
environment = g_array_new(TRUE, FALSE, sizeof(char));
while (argv && *argv)
spawn_append_argument(command, *argv++);
#ifdef SPAWN_TEST
g_message("full spawn command line: %s\n", command->str);
#endif
while (envp && *envp)
{
g_array_append_vals(environment, *envp, strlen(*envp) + 1);
envp++;
}
failure = spawn_create_process_with_pipes(command->str, working_directory,
envp ? environment->data : NULL, child_pid, stdin_fd, stdout_fd, stderr_fd);
g_string_free(command, TRUE);
g_array_free(environment, TRUE);
if (failure)
{
g_set_error_literal(error, G_SPAWN_ERROR, G_SPAWN_ERROR_FAILED, failure);
g_free(failure);
return FALSE;
}
return TRUE;
#else /* G_OS_WIN32 */
int cl_argc;
char **full_argv;
gboolean spawned;
GError *gerror = NULL;
if (command_line)
{
int argc = 0;
char **cl_argv;
if (!spawn_parse_argv(command_line, &cl_argc, &cl_argv, error))
return FALSE;
if (argv)
for (argc = 0; argv[argc]; argc++);
full_argv = g_renew(gchar *, cl_argv, cl_argc + argc + 1);
memcpy(full_argv + cl_argc, argv, argc * sizeof(gchar *));
full_argv[cl_argc + argc] = NULL;
}
else
full_argv = argv;
spawned = g_spawn_async_with_pipes(working_directory, full_argv, envp,
G_SPAWN_SEARCH_PATH | (child_pid ? G_SPAWN_DO_NOT_REAP_CHILD : 0), NULL, NULL,
child_pid, stdin_fd, stdout_fd, stderr_fd, &gerror);
if (!spawned)
{
gint en = 0;
const gchar *message = gerror->message;
/* try to cut glib citing of the program name or working directory: they may be long,
and only the caller knows whether they're UTF-8. We lose the exact chdir error. */
switch (gerror->code)
{
#ifdef EACCES
case G_SPAWN_ERROR_ACCES : en = EACCES; break;
#endif
#ifdef EPERM
case G_SPAWN_ERROR_PERM : en = EPERM; break;
#endif
#ifdef E2BIG
case G_SPAWN_ERROR_TOO_BIG : en = E2BIG; break;
#endif
#ifdef ENOEXEC
case G_SPAWN_ERROR_NOEXEC : en = ENOEXEC; break;
#endif
#ifdef ENAMETOOLONG
case G_SPAWN_ERROR_NAMETOOLONG : en = ENAMETOOLONG; break;
#endif
#ifdef ENOENT
case G_SPAWN_ERROR_NOENT : en = ENOENT; break;
#endif
#ifdef ENOMEM
case G_SPAWN_ERROR_NOMEM : en = ENOMEM; break;
#endif
#ifdef ENOTDIR
case G_SPAWN_ERROR_NOTDIR : en = ENOTDIR; break;
#endif
#ifdef ELOOP
case G_SPAWN_ERROR_LOOP : en = ELOOP; break;
#endif
#ifdef ETXTBUSY
case G_SPAWN_ERROR_TXTBUSY : en = ETXTBUSY; break;
#endif
#ifdef EIO
case G_SPAWN_ERROR_IO : en = EIO; break;
#endif
#ifdef ENFILE
case G_SPAWN_ERROR_NFILE : en = ENFILE; break;
#endif
#ifdef EMFILE
case G_SPAWN_ERROR_MFILE : en = EMFILE; break;
#endif
#ifdef EINVAL
case G_SPAWN_ERROR_INVAL : en = EINVAL; break;
#endif
#ifdef EISDIR
case G_SPAWN_ERROR_ISDIR : en = EISDIR; break;
#endif
#ifdef ELIBBAD
case G_SPAWN_ERROR_LIBBAD : en = ELIBBAD; break;
#endif
case G_SPAWN_ERROR_CHDIR :
{
message = _("Failed to change to the working directory");
break;
}
case G_SPAWN_ERROR_FAILED :
{
message = _("Unknown error executing child process");
break;
}
}
if (en)
message = g_strerror(en);
g_set_error_literal(error, gerror->domain, gerror->code, message);
g_error_free(gerror);
}
if (full_argv != argv)
{
full_argv[cl_argc] = NULL;
g_strfreev(full_argv);
}
return spawned;
#endif /* G_OS_WIN32 */
}
/**
* Executes a child asynchronously.
*
* A command line or an argument vector must be passed. If both are present, the argument
* vector is appended to the command line. An empty command line is not allowed.
*
* If a @a child_pid is passed, it's your responsibility to invoke @c g_spawn_close_pid().
*
* @param working_directory child's current working directory, or @c NULL.
* @param command_line child program and arguments, or @c NULL.
* @param argv child's argument vector, or @c NULL.
* @param envp child's environment, or @c NULL.
* @param child_pid return location for child process ID, or @c NULL.
* @param error return location for error.
*
* @return @c TRUE on success, @c FALSE on error.
*
* @since 1.25
**/
GEANY_API_SYMBOL
gboolean spawn_async(const gchar *working_directory, const gchar *command_line, gchar **argv,
gchar **envp, GPid *child_pid, GError **error)
{
return spawn_async_with_pipes(working_directory, command_line, argv, envp, child_pid,
NULL, NULL, NULL, error);
}
/*
* Spawn with callbacks - general event sequence:
*
* - Launch the child.
* - Setup any I/O callbacks and a child watch callback.
* - On sync execution, run a main loop.
* - Wait for the child to terminate.
* - Check for active I/O sources. If any, add a timeout source to watch them, they should
* become inactive real soon now that the child is dead. Otherwise, finalize immediately.
* - In the timeout source: check for active I/O sources and finalize if none.
*/
typedef struct _SpawnChannelData
{
GIOChannel *channel; /* NULL if not created / already destroyed */
union
{
GIOFunc write;
SpawnReadFunc read;
} cb;
gpointer cb_data;
/* stdout/stderr only */
GString *buffer; /* NULL if recursive */
GString *line_buffer; /* NULL if char buffered */
gsize max_length;
} SpawnChannelData;
static void spawn_destroy_cb(gpointer data)
{
SpawnChannelData *sc = (SpawnChannelData *) data;
g_io_channel_shutdown(sc->channel, FALSE, NULL);
sc->channel = NULL;
if (sc->buffer)
g_string_free(sc->buffer, TRUE);
if (sc->line_buffer)
g_string_free(sc->line_buffer, TRUE);
}
static gboolean spawn_write_cb(GIOChannel *channel, GIOCondition condition, gpointer data)
{
SpawnChannelData *sc = (SpawnChannelData *) data;
if (!sc->cb.write(channel, condition, sc->cb_data))
return FALSE;
return !(condition & G_IO_FAILURE);
}
static gboolean spawn_read_cb(GIOChannel *channel, GIOCondition condition, gpointer data)
{
SpawnChannelData *sc = (SpawnChannelData *) data;
GString *line_buffer = sc->line_buffer;
GString *buffer = sc->buffer ? sc->buffer : g_string_sized_new(sc->max_length);
GIOCondition input_cond = condition & (G_IO_IN | G_IO_PRI);
GIOCondition failure_cond = condition & G_IO_FAILURE;
/*
* - Normally, read only once. With IO watches, our data processing must be immediate,
* which may give the child time to emit more data, and a read loop may combine it into
* large stdout and stderr portions. Under Windows, looping blocks.
* - On failure, read in a loop. It won't block now, there will be no more data, and the
* IO watch is not guaranteed to be called again (under Windows this is the last call).
*/
if (input_cond)
{
gsize chars_read;
GIOStatus status;
if (line_buffer)
{
gsize n = line_buffer->len;
while ((status = g_io_channel_read_chars(channel, line_buffer->str + n,
DEFAULT_IO_LENGTH, &chars_read, NULL)) == G_IO_STATUS_NORMAL)
{
g_string_set_size(line_buffer, n + chars_read);
while (n < line_buffer->len)
{
gsize line_len = 0;
if (n == sc->max_length)
line_len = n;
else if (strchr("\n", line_buffer->str[n])) /* '\n' or '\0' */
line_len = n + 1;
else if (n < line_buffer->len - 1 && line_buffer->str[n] == '\r')
line_len = n + 1 + (line_buffer->str[n + 1] == '\n');
if (!line_len)
n++;
else
{
g_string_append_len(buffer, line_buffer->str, line_len);
g_string_erase(line_buffer, 0, line_len);
/* input only, failures are reported separately below */
sc->cb.read(buffer, input_cond, sc->cb_data);
g_string_truncate(buffer, 0);
n = 0;
}
}
if (!failure_cond)
break;
}
}
else
{
while ((status = g_io_channel_read_chars(channel, buffer->str, sc->max_length,
&chars_read, NULL)) == G_IO_STATUS_NORMAL)
{
g_string_set_size(buffer, chars_read);
/* input only, failures are reported separately below */
sc->cb.read(buffer, input_cond, sc->cb_data);
if (!failure_cond)
break;
}
}
/* Under OSX, after child death, the read watches receive input conditions instead
of error conditions, so we convert the termination statuses into conditions.
Should not hurt the other OS. */
if (status == G_IO_STATUS_ERROR)
failure_cond |= G_IO_ERR;
else if (status == G_IO_STATUS_EOF)
failure_cond |= G_IO_HUP;
}
if (failure_cond) /* we must signal the callback */
{
if (line_buffer && line_buffer->len) /* flush the line buffer */
{
g_string_append_len(buffer, line_buffer->str, line_buffer->len);
/* all data may be from a previous call */
if (!input_cond)
input_cond = G_IO_IN;
}
else
{
input_cond = 0;
g_string_truncate(buffer, 0);
}
sc->cb.read(buffer, input_cond | failure_cond, sc->cb_data);
}
if (buffer != sc->buffer)
g_string_free(buffer, TRUE);
return !failure_cond;
}
typedef struct _SpawnWatcherData
{
SpawnChannelData sc[3]; /* stdin, stdout, stderr */
GChildWatchFunc exit_cb;
gpointer exit_data;
GPid pid;
gint exit_status;
GMainContext *main_context; /* NULL if async execution */
GMainLoop *main_loop; /* NULL if async execution */
} SpawnWatcherData;
static void spawn_finalize(SpawnWatcherData *sw)
{
if (sw->exit_cb)
sw->exit_cb(sw->pid, sw->exit_status, sw->exit_data);
if (sw->main_loop)
{
g_main_loop_quit(sw->main_loop);
g_main_loop_unref(sw->main_loop);
}
g_spawn_close_pid(sw->pid);
g_slice_free(SpawnWatcherData, sw);
}
static gboolean spawn_timeout_cb(gpointer data)
{
SpawnWatcherData *sw = (SpawnWatcherData *) data;
int i;
for (i = 0; i < 3; i++)
if (sw->sc[i].channel)
return TRUE;
spawn_finalize(sw);
return FALSE;
}
static void spawn_watch_cb(GPid pid, gint status, gpointer data)
{
SpawnWatcherData *sw = (SpawnWatcherData *) data;
int i;
sw->pid = pid;
sw->exit_status = status;
for (i = 0; i < 3; i++)
{
if (sw->sc[i].channel)
{
GSource *source = g_timeout_source_new(50);
g_source_set_callback(source, spawn_timeout_cb, data, NULL);
g_source_attach(source, sw->main_context);
g_source_unref(source);
return;
}
}
spawn_finalize(sw);
}
/**
* Executes a child program and setups callbacks.
*
* A command line or an argument vector must be passed. If both are present, the argument
* vector is appended to the command line. An empty command line is not allowed.
*
* The synchronous execution may not be combined with recursive callbacks.
*
* In line buffered mode, the child input is broken on `\n`, `\r\n`, `\r`, `\0` and max length.
*
* All I/O callbacks are guaranteed to be invoked at least once with @c G_IO_ERR, @c G_IO_HUP
* or @c G_IO_NVAL set (except for a @a stdin_cb which returns @c FALSE before that). For the
* non-recursive callbacks, this is guaranteed to be the last call, and may be used to free any
* resources associated with the callback.
*
* The @a stdin_cb may write to @c channel only once per invocation, only if @c G_IO_OUT is
* set, and only a non-zero number of characters.
*
* @c stdout_cb and @c stderr_cb may modify the received strings in any way, but must not
* free them.
*
* The default max lengths are 24K for line buffered stdout, 8K for line buffered stderr,
* 4K for unbuffered input under Unix, and 2K for unbuffered input under Windows.
*
* @c exit_cb is always invoked last, after all I/O callbacks.