1 /* Proxy shell designed for use with Emacs on Windows 95 and NT.
2 Copyright (C) 1997, 2001-2015 Free Software Foundation, Inc.
4 Accepts subset of Unix sh(1) command-line options, for compatibility
5 with elisp code written for Unix. When possible, executes external
6 programs directly (a common use of /bin/sh by Emacs), otherwise
7 invokes the user-specified command processor to handle built-in shell
8 commands, batch files and interactive mode.
10 The main function is simply to process the "-c string" option in the
11 way /bin/sh does, since the standard Windows command shells use the
12 convention that everything after "/c" (the Windows equivalent of
13 "-c") is the input string.
15 This file is part of GNU Emacs.
17 GNU Emacs is free software: you can redistribute it and/or modify
18 it under the terms of the GNU General Public License as published by
19 the Free Software Foundation, either version 3 of the License, or
20 (at your option) any later version.
22 GNU Emacs is distributed in the hope that it will be useful,
23 but WITHOUT ANY WARRANTY; without even the implied warranty of
24 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 GNU General Public License for more details.
27 You should have received a copy of the GNU General Public License
28 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
32 #include <stdarg.h> /* va_args */
33 #include <malloc.h> /* alloca */
34 #include <stdlib.h> /* getenv */
35 #include <string.h> /* strlen */
36 #include <ctype.h> /* isspace, isalpha */
38 /* We don't want to include stdio.h because we are already duplicating
40 extern int _snprintf (char *buffer
, size_t count
, const char *format
, ...);
42 /******* Mock C library routines *********************************/
44 /* These routines are used primarily to minimize the executable size. */
46 #define stdout GetStdHandle (STD_OUTPUT_HANDLE)
47 #define stderr GetStdHandle (STD_ERROR_HANDLE)
50 vfprintf (HANDLE hnd
, const char * msg
, va_list args
)
55 wvsprintf (buf
, msg
, args
);
56 return WriteFile (hnd
, buf
, strlen (buf
), &bytes_written
, NULL
);
60 fprintf (HANDLE hnd
, const char * msg
, ...)
66 rc
= vfprintf (hnd
, msg
, args
);
73 printf (const char * msg
, ...)
79 rc
= vfprintf (stdout
, msg
, args
);
86 fail (const char * msg
, ...)
91 vfprintf (stderr
, msg
, args
);
98 warn (const char * msg
, ...)
102 va_start (args
, msg
);
103 vfprintf (stderr
, msg
, args
);
107 /******************************************************************/
110 canon_filename (char *fname
)
125 skip_space (const char *str
)
127 while (isspace (*str
)) str
++;
132 skip_nonspace (const char *str
)
134 while (*str
&& !isspace (*str
)) str
++;
138 int escape_char
= '\\';
140 /* Get next token from input, advancing pointer. */
142 get_next_token (char * buf
, const char ** pSrc
)
144 const char * p
= *pSrc
;
150 int escape_char_run
= 0;
152 /* Go through src until an ending quote is found, unescaping
153 quotes along the way. If the escape char is not quote, then do
154 special handling of multiple escape chars preceding a quote
155 char (ie. the reverse of what Emacs does to escape quotes). */
159 if (p
[0] == escape_char
&& escape_char
!= '"')
165 else if (p
[0] == '"')
167 while (escape_char_run
> 1)
170 escape_char_run
-= 2;
173 if (escape_char_run
> 0)
179 else if (p
[1] == escape_char
&& escape_char
== '"')
181 /* quote escaped by doubling */
187 /* The ending quote. */
189 /* Leave input pointer after token. */
194 else if (p
[0] == '\0')
196 /* End of string, but no ending quote found. We might want to
197 flag this as an error, but for now will consider the end as
198 the end of the token. */
210 /* Next token is delimited by whitespace. */
211 const char * p1
= skip_nonspace (p
);
212 memcpy (o
, p
, p1
- p
);
223 /* Return TRUE if PROGNAME is a batch file. */
225 batch_file_p (const char *progname
)
227 const char *exts
[] = {".bat", ".cmd"};
228 int n_exts
= sizeof (exts
) / sizeof (char *);
231 const char *ext
= strrchr (progname
, '.');
235 for (i
= 0; i
< n_exts
; i
++)
237 if (stricmp (ext
, exts
[i
]) == 0)
245 /* Search for EXEC file in DIR. If EXEC does not have an extension,
246 DIR is searched for EXEC with the standard extensions appended. */
248 search_dir (const char *dir
, const char *exec
, int bufsize
, char *buffer
)
250 const char *exts
[] = {".bat", ".cmd", ".exe", ".com"};
251 int n_exts
= sizeof (exts
) / sizeof (char *);
255 /* Search the directory for the program. */
256 for (i
= 0; i
< n_exts
; i
++)
258 rc
= SearchPath (dir
, exec
, exts
[i
], bufsize
, buffer
, &dummy
);
266 /* Return the absolute name of executable file PROG, including
267 any file extensions. If an absolute name for PROG cannot be found,
270 make_absolute (const char *prog
)
272 char absname
[MAX_PATH
];
274 char curdir
[MAX_PATH
];
278 /* At least partial absolute path specified; search there. */
279 if ((isalpha (prog
[0]) && prog
[1] == ':') ||
282 /* Split the directory from the filename. */
283 fname
= strrchr (prog
, '\\');
285 /* Only a drive specifier is given. */
287 strncpy (dir
, prog
, fname
- prog
);
288 dir
[fname
- prog
] = '\0';
290 /* Search the directory for the program. */
291 if (search_dir (dir
, prog
, MAX_PATH
, absname
) > 0)
292 return strdup (absname
);
297 if (GetCurrentDirectory (MAX_PATH
, curdir
) <= 0)
300 /* Relative path; search in current dir. */
301 if (strpbrk (prog
, "\\"))
303 if (search_dir (curdir
, prog
, MAX_PATH
, absname
) > 0)
304 return strdup (absname
);
309 /* Just filename; search current directory then PATH. */
310 path
= alloca (strlen (getenv ("PATH")) + strlen (curdir
) + 2);
311 strcpy (path
, curdir
);
313 strcat (path
, getenv ("PATH"));
319 /* Get next directory from path. */
321 while (*p
&& *p
!= ';') p
++;
322 /* A broken PATH could have too long directory names in it. */
323 len
= min (p
- path
, sizeof (dir
) - 1);
324 strncpy (dir
, path
, len
);
327 /* Search the directory for the program. */
328 if (search_dir (dir
, prog
, MAX_PATH
, absname
) > 0)
329 return strdup (absname
);
331 /* Move to the next directory. */
338 /* Try to decode the given command line the way cmd would do it. On
339 success, return 1 with cmdline dequoted. Otherwise, when we've
340 found constructs only cmd can properly interpret, return 0 and
341 leave cmdline unchanged. */
343 try_dequote_cmdline (char* cmdline
)
345 /* Dequoting can only subtract characters, so the length of the
346 original command line is a bound on the amount of scratch space
347 we need. This length, in turn, is bounded by the 32k
348 CreateProcess limit. */
349 char * old_pos
= cmdline
;
350 char * new_cmdline
= alloca (strlen(cmdline
));
351 char * new_pos
= new_cmdline
;
360 while ((c
= *old_pos
++))
369 state
= INSIDE_QUOTE
;
378 /* We saw an unquoted shell metacharacter and we don't
379 understand it. Bail out. */
399 /* Variable substitution inside quote. Bail out. */
409 /* We were able to dequote the entire string. Copy our scratch
410 buffer on top of the original buffer and return success. */
411 memcpy (cmdline
, new_cmdline
, new_pos
- new_cmdline
);
412 cmdline
[new_pos
- new_cmdline
] = '\0';
416 /*****************************************************************/
422 /* Parse commandline into argv array, allowing proper quoting of args. */
426 char * cmdline
= GetCommandLine ();
433 /* Information about child proc is global, to allow for automatic
434 termination when interrupted. At the moment, only one child process
435 can be running at any one time. */
437 PROCESS_INFORMATION child
;
438 int interactive
= TRUE
;
441 console_event_handler (DWORD event
)
446 case CTRL_BREAK_EVENT
:
449 /* Both command.com and cmd.exe have the annoying behavior of
450 prompting "Terminate batch job (y/n)?" when interrupted
451 while running a batch file, even if running in
452 non-interactive (-c) mode. Try to make up for this
453 deficiency by forcibly terminating the subprocess if
454 running non-interactively. */
455 if (child
.hProcess
&&
456 WaitForSingleObject (child
.hProcess
, 500) != WAIT_OBJECT_0
)
457 TerminateProcess (child
.hProcess
, 0);
458 exit (STATUS_CONTROL_C_EXIT
);
464 /* CLOSE, LOGOFF and SHUTDOWN events - actually we don't get these
466 fail ("cmdproxy: received %d event\n", event
);
468 TerminateProcess (child
.hProcess
, 0);
474 /* Change from normal usage; return value indicates whether spawn
475 succeeded or failed - program return code is returned separately. */
477 spawn (const char *progname
, char *cmdline
, const char *dir
, int *retcode
)
479 BOOL success
= FALSE
;
480 SECURITY_ATTRIBUTES sec_attrs
;
482 /* In theory, passing NULL for the environment block to CreateProcess
483 is the same as passing the value of GetEnvironmentStrings, but
484 doing this explicitly seems to cure problems running DOS programs
486 char * envblock
= GetEnvironmentStrings ();
488 sec_attrs
.nLength
= sizeof (sec_attrs
);
489 sec_attrs
.lpSecurityDescriptor
= NULL
;
490 sec_attrs
.bInheritHandle
= FALSE
;
492 memset (&start
, 0, sizeof (start
));
493 start
.cb
= sizeof (start
);
495 /* CreateProcess handles batch files as progname specially. This
496 special handling fails when both the batch file and arguments are
497 quoted. We pass NULL as progname to avoid the special
499 if (progname
!= NULL
&& cmdline
[0] == '"' && batch_file_p (progname
))
502 if (CreateProcess (progname
, cmdline
, &sec_attrs
, NULL
, TRUE
,
503 0, envblock
, dir
, &start
, &child
))
506 /* wait for completion and pass on return code */
507 WaitForSingleObject (child
.hProcess
, INFINITE
);
509 GetExitCodeProcess (child
.hProcess
, (DWORD
*)retcode
);
510 CloseHandle (child
.hThread
);
511 CloseHandle (child
.hProcess
);
512 child
.hProcess
= NULL
;
515 FreeEnvironmentStrings (envblock
);
520 /* Return size of current environment block. */
524 char * start
= GetEnvironmentStrings ();
527 while (tmp
[0] || tmp
[1])
529 FreeEnvironmentStrings (start
);
530 return tmp
+ 2 - start
;
533 /******* Main program ********************************************/
536 main (int argc
, char ** argv
)
543 char **pass_through_args
;
544 int num_pass_through_args
;
545 char modname
[MAX_PATH
];
552 SetConsoleCtrlHandler ((PHANDLER_ROUTINE
) console_event_handler
, TRUE
);
554 if (!GetCurrentDirectory (sizeof (dir
), dir
))
555 fail ("error: GetCurrentDirectory failed\n");
557 /* We serve double duty: we can be called either as a proxy for the
558 real shell (that is, because we are defined to be the user shell),
559 or in our role as a helper application for running DOS programs.
560 In the former case, we interpret the command line options as if we
561 were a Unix shell, but in the latter case we simply pass our
562 command line to CreateProcess. We know which case we are dealing
563 with by whether argv[0] refers to ourself or to some other program.
564 (This relies on an arcane feature of CreateProcess, where we can
565 specify cmdproxy as the module to run, but specify a different
566 program in the command line - the MSVC startup code sets argv[0]
567 from the command line.) */
569 if (!GetModuleFileName (NULL
, modname
, sizeof (modname
)))
570 fail ("error: GetModuleFileName failed\n");
572 /* Change directory to location of .exe so startup directory can be
574 progname
= strrchr (modname
, '\\');
576 SetCurrentDirectory (modname
);
579 /* Due to problems with interaction between API functions that use "OEM"
580 codepage vs API functions that use the "ANSI" codepage, we need to
581 make things consistent by choosing one and sticking with it. */
582 SetConsoleCP (GetACP ());
583 SetConsoleOutputCP (GetACP ());
585 /* Although Emacs always sets argv[0] to an absolute pathname, we
586 might get run in other ways as well, so convert argv[0] to an
587 absolute name before comparing to the module name. */
589 /* The call to SearchPath will find argv[0] in the current
590 directory, append ".exe" to it if needed, and also canonicalize
591 it, to resolve references to ".", "..", etc. */
592 status
= SearchPath (NULL
, argv
[0], ".exe", sizeof (path
), path
,
594 if (!(status
> 0 && stricmp (modname
, path
) == 0))
600 /* Make sure we have argv[0] in path[], as the failed
601 SearchPath might not have copied it there. */
602 strcpy (path
, argv
[0]);
603 /* argv[0] could include forward slashes; convert them all
604 to backslashes, for strrchr calls below to DTRT. */
605 for (s
= path
; *s
; s
++)
609 /* Perhaps MODNAME and PATH use mixed short and long file names. */
610 if (!(GetShortPathName (modname
, modname
, sizeof (modname
))
611 && GetShortPathName (path
, path
, sizeof (path
))
612 && stricmp (modname
, path
) == 0))
614 /* Sometimes GetShortPathName fails because one or more
615 directories leading to argv[0] have issues with access
616 rights. In that case, at least we can compare the
617 basenames. Note: this disregards the improbable case of
618 invoking a program of the same name from another
619 directory, since the chances of that other executable to
620 be both our namesake and a 16-bit DOS application are nil. */
621 char *p
= strrchr (path
, '\\');
622 char *q
= strrchr (modname
, '\\');
626 p
= strchr (path
, ':');
632 q
= strchr (modname
, ':');
638 pdot
= strrchr (p
, '.');
639 if (!pdot
|| stricmp (pdot
, ".exe") != 0)
640 pdot
= p
+ strlen (p
);
641 qdot
= strrchr (q
, '.');
642 if (!qdot
|| stricmp (qdot
, ".exe") != 0)
643 qdot
= q
+ strlen (q
);
644 if (pdot
- p
!= qdot
- q
|| strnicmp (p
, q
, pdot
- p
) != 0)
646 /* We are being used as a helper to run a DOS app; just
647 pass command line to DOS app without change. */
648 /* TODO: fill in progname. */
649 if (spawn (NULL
, GetCommandLine (), dir
, &rc
))
651 fail ("Could not run %s\n", GetCommandLine ());
656 /* Process command line. If running interactively (-c or /c not
657 specified) then spawn a real command shell, passing it the command
660 If not running interactively, then attempt to execute the specified
661 command directly. If necessary, spawn a real shell to execute the
668 /* If no args, spawn real shell for interactive use. */
671 /* Ask command.com to create an environment block with a reasonable
672 amount of free space. */
673 envsize
= get_env_size () + 300;
674 pass_through_args
= (char **) alloca (argc
* sizeof (char *));
675 num_pass_through_args
= 0;
680 /* Act on switches we recognize (mostly single letter switches,
681 except for -e); all unrecognized switches and extra args are
682 passed on to real shell if used (only really of benefit for
683 interactive use, but allow for batch use as well). Accept / as
684 switch char for compatibility with cmd.exe. */
685 if (((*argv
)[0] == '-' || (*argv
)[0] == '/') && (*argv
)[1] != '\0')
687 if (((*argv
)[1] == 'c' || (*argv
)[1] == 'C') && ((*argv
)[2] == '\0'))
690 fail ("error: expecting arg for %s\n", *argv
);
694 else if (((*argv
)[1] == 'i' || (*argv
)[1] == 'I') && ((*argv
)[2] == '\0'))
697 warn ("warning: %s ignored because of -c\n", *argv
);
699 else if (((*argv
)[1] == 'e' || (*argv
)[1] == 'E') && ((*argv
)[2] == ':'))
701 int requested_envsize
= atoi (*argv
+ 3);
702 /* Enforce a reasonable minimum size, as above. */
703 if (requested_envsize
> envsize
)
704 envsize
= requested_envsize
;
705 /* For sanity, enforce a reasonable maximum. */
711 /* warn ("warning: unknown option %s ignored", *argv); */
712 pass_through_args
[num_pass_through_args
++] = *argv
;
720 /* I think this is probably not useful - cmd.exe ignores extra
721 (non-switch) args in interactive mode, and they cannot be passed on
722 when -c was given. */
724 /* Collect any remaining args after (initial) switches. */
727 pass_through_args
[num_pass_through_args
++] = *argv
++;
730 /* Probably a mistake for there to be extra args; not fatal. */
732 warn ("warning: extra args ignored after '%s'\n", argv
[-1]);
735 pass_through_args
[num_pass_through_args
] = NULL
;
737 /* If -c option, determine if we must spawn a real shell, or if we can
738 execute the command directly ourself. */
743 /* The program name is the first token of cmdline. Since
744 filenames cannot legally contain embedded quotes, the value
745 of escape_char doesn't matter. */
747 if (!get_next_token (path
, &args
))
748 fail ("error: no program name specified.\n");
750 canon_filename (path
);
751 progname
= make_absolute (path
);
753 /* If we found the program and the rest of the command line does
754 not contain unquoted shell metacharacters, run the program
755 directly (if not found it might be an internal shell command,
757 if (progname
!= NULL
&& try_dequote_cmdline (cmdline
))
767 int extra_arg_space
= 0;
769 int run_command_dot_com
;
771 progname
= getenv ("COMSPEC");
773 fail ("error: COMSPEC is not set\n");
775 canon_filename (progname
);
776 progname
= make_absolute (progname
);
778 if (progname
== NULL
|| strchr (progname
, '\\') == NULL
)
779 fail ("error: the program %s could not be found.\n", getenv ("COMSPEC"));
781 /* Need to set environment size when running command.com. */
782 run_command_dot_com
=
783 (stricmp (strrchr (progname
, '\\'), "command.com") == 0);
785 /* Work out how much extra space is required for
786 pass_through_args. */
787 for (argv
= pass_through_args
; *argv
!= NULL
; ++argv
)
788 /* We don't expect to have to quote switches. */
789 extra_arg_space
+= strlen (*argv
) + 2;
795 /* Convert to syntax expected by cmd.exe/command.com for
796 running non-interactively. Always quote program name in
797 case path contains spaces (fortunately it can't contain
798 quotes, since they are illegal in path names). */
801 strlen (progname
) + extra_arg_space
+ strlen (cmdline
) + 16;
802 buf
= p
= alloca (maxlen
+ 1);
804 /* Quote progname in case it contains spaces. */
805 p
+= _snprintf (p
, remlen
, "\"%s\"", progname
);
806 remlen
= maxlen
- (p
- buf
);
808 /* Include pass_through_args verbatim; these are just switches
809 so should not need quoting. */
810 for (argv
= pass_through_args
; *argv
!= NULL
; ++argv
)
812 p
+= _snprintf (p
, remlen
, " %s", *argv
);
813 remlen
= maxlen
- (p
- buf
);
816 if (run_command_dot_com
)
817 _snprintf (p
, remlen
, " /e:%d /c %s", envsize
, cmdline
);
819 _snprintf (p
, remlen
, " /c %s", cmdline
);
824 if (run_command_dot_com
)
826 /* Provide dir arg expected by command.com when first
827 started interactively (the "command search path"). To
828 avoid potential problems with spaces in command dir
829 (which cannot be quoted - command.com doesn't like it),
830 we always use the 8.3 form. */
831 GetShortPathName (progname
, path
, sizeof (path
));
832 p
= strrchr (path
, '\\');
833 /* Trailing slash is acceptable, so always leave it. */
840 strlen (progname
) + extra_arg_space
+ strlen (path
) + 13;
841 cmdline
= p
= alloca (maxlen
+ 1);
843 /* Quote progname in case it contains spaces. */
844 p
+= _snprintf (p
, remlen
, "\"%s\" %s", progname
, path
);
845 remlen
= maxlen
- (p
- cmdline
);
847 /* Include pass_through_args verbatim; these are just switches
848 so should not need quoting. */
849 for (argv
= pass_through_args
; *argv
!= NULL
; ++argv
)
851 p
+= _snprintf (p
, remlen
, " %s", *argv
);
852 remlen
= maxlen
- (p
- cmdline
);
855 if (run_command_dot_com
)
856 _snprintf (p
, remlen
, " /e:%d", envsize
);
861 fail ("Internal error: program name not defined\n");
866 if (spawn (progname
, cmdline
, dir
, &rc
))
875 fail ("Could not run %s\n", progname
);