1 /* guestfish - the filesystem interactive shell
2 * Copyright (C) 2009-2010 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 #include <sys/types.h>
35 #ifdef HAVE_LIBREADLINE
36 #include <readline/readline.h>
37 #include <readline/history.h>
47 /* List of drives added via -a, -d or -N options. */
50 enum { drv_a, drv_d, drv_N } type;
53 char *filename; /* disk filename */
56 char *guest; /* guest name */
59 char *filename; /* disk filename (testX.img) */
60 prep_data *data; /* prepared type */
61 char *device; /* device inside the appliance */
72 static void set_up_terminal (void);
73 static char add_drives (struct drv *drv, char next_drive);
74 static void prepare_drives (struct drv *drv);
75 static void mount_mps (struct mp *mp);
76 static int launch (void);
77 static void interactive (void);
78 static void shell_script (void);
79 static void script (int prompt);
80 static void cmdline (char *argv[], int optind, int argc);
81 static void initialize_readline (void);
82 static void cleanup_readline (void);
83 #ifdef HAVE_LIBREADLINE
84 static void add_history_line (const char *);
87 static int override_progress_bars = -1;
89 /* Currently open libguestfs handle. */
95 int remote_control_listen = 0;
96 int remote_control = 0;
97 int exit_on_error = 1;
99 int keys_from_stdin = 0;
100 const char *libvirt_uri = NULL;
103 int have_terminfo = 0;
104 int progress_bars = 0;
106 static void __attribute__((noreturn))
109 if (status != EXIT_SUCCESS)
110 fprintf (stderr, _("Try `%s --help' for more information.\n"),
114 _("%s: guest filesystem shell\n"
115 "%s lets you edit virtual machine filesystems\n"
116 "Copyright (C) 2009-2010 Red Hat Inc.\n"
118 " %s [--options] cmd [: cmd : cmd ...]\n"
119 " %s [--ro] -i -a disk-image\n"
120 " %s [--ro] -i -d libvirt-domain\n"
121 "or for interactive use:\n"
123 "or from a shell script:\n"
129 " -h|--cmd-help List available commands\n"
130 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
131 " -a|--add image Add image\n"
132 " -c|--connect uri Specify libvirt URI for -d option\n"
133 " -d|--domain guest Add disks from libvirt guest\n"
134 " -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
135 " -f|--file file Read commands from file\n"
136 " -i|--inspector Automatically mount filesystems\n"
137 " --keys-from-stdin Read passphrases from stdin\n"
138 " --listen Listen for remote commands\n"
139 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
140 " -n|--no-sync Don't autosync\n"
141 " -N|--new type Create prepared disk (test1.img, ...)\n"
142 " --progress-bars Enable progress bars even when not interactive\n"
143 " --no-progress-bars Disable progress bars\n"
144 " --remote[=pid] Send commands to remote %s\n"
145 " -r|--ro Mount read-only\n"
146 " --selinux Enable SELinux support\n"
147 " -v|--verbose Verbose messages\n"
148 " -x Echo each command before executing it\n"
149 " -V|--version Display version and exit\n"
150 "For more information, see the manpage %s(1).\n"),
151 program_name, program_name, program_name,
152 program_name, program_name, program_name,
153 program_name, program_name, program_name);
159 main (int argc, char *argv[])
161 /* Set global program name that is not polluted with libtool artifacts. */
162 set_program_name (argv[0]);
164 atexit (close_stdout);
166 setlocale (LC_ALL, "");
167 bindtextdomain (PACKAGE, LOCALEBASEDIR);
168 textdomain (PACKAGE);
172 enum { HELP_OPTION = CHAR_MAX + 1 };
174 static const char *options = "a:c:d:Df:h::im:nN:rv?Vx";
175 static const struct option long_options[] = {
176 { "add", 1, 0, 'a' },
177 { "cmd-help", 2, 0, 'h' },
178 { "connect", 1, 0, 'c' },
179 { "domain", 1, 0, 'd' },
180 { "file", 1, 0, 'f' },
181 { "help", 0, 0, HELP_OPTION },
182 { "inspector", 0, 0, 'i' },
183 { "keys-from-stdin", 0, 0, 0 },
184 { "listen", 0, 0, 0 },
185 { "mount", 1, 0, 'm' },
186 { "new", 1, 0, 'N' },
187 { "no-dest-paths", 0, 0, 'D' },
188 { "no-sync", 0, 0, 'n' },
189 { "progress-bars", 0, 0, 0 },
190 { "no-progress-bars", 0, 0, 0 },
191 { "remote", 2, 0, 0 },
193 { "selinux", 0, 0, 0 },
194 { "verbose", 0, 0, 'v' },
195 { "version", 0, 0, 'V' },
198 struct drv *drvs = NULL;
200 struct mp *mps = NULL;
202 char *p, *file = NULL;
206 int next_prepared_drive = 1;
208 initialize_readline ();
210 memset (&sa, 0, sizeof sa);
211 sa.sa_handler = SIG_IGN;
212 sa.sa_flags = SA_RESTART;
213 sigaction (SIGPIPE, &sa, NULL);
215 /* guestfs_create is meant to be a lightweight operation, so
216 * it's OK to do it early here.
218 g = guestfs_create ();
220 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
224 guestfs_set_autosync (g, 1);
226 /* If developing, add ./appliance to the path. Note that libtools
227 * interferes with this because uninstalled guestfish is a shell
228 * script that runs the real program with an absolute path. Detect
231 * BUT if LIBGUESTFS_PATH environment variable is already set by
232 * the user, then don't override it.
234 if (getenv ("LIBGUESTFS_PATH") == NULL &&
236 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
237 guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
239 /* CAUTION: we are careful to modify argv[0] here, only after
240 * using it just above.
242 * getopt_long uses argv[0], so give it the sanitized name. Save a copy
243 * of the original, in case it's needed below.
245 char *real_argv0 = argv[0];
246 argv[0] = bad_cast (program_name);
249 c = getopt_long (argc, argv, options, long_options, &option_index);
253 case 0: /* options which are long only */
254 if (STREQ (long_options[option_index].name, "listen"))
255 remote_control_listen = 1;
256 else if (STREQ (long_options[option_index].name, "remote")) {
258 if (sscanf (optarg, "%d", &remote_control) != 1) {
259 fprintf (stderr, _("%s: --listen=PID: PID was not a number: %s\n"),
260 program_name, optarg);
264 p = getenv ("GUESTFISH_PID");
265 if (!p || sscanf (p, "%d", &remote_control) != 1) {
266 fprintf (stderr, _("%s: remote: $GUESTFISH_PID must be set"
267 " to the PID of the remote process\n"),
272 } else if (STREQ (long_options[option_index].name, "selinux")) {
273 guestfs_set_selinux (g, 1);
274 } else if (STREQ (long_options[option_index].name, "keys-from-stdin")) {
276 } else if (STREQ (long_options[option_index].name, "progress-bars")) {
277 override_progress_bars = 1;
278 } else if (STREQ (long_options[option_index].name, "no-progress-bars")) {
279 override_progress_bars = 0;
281 fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
282 program_name, long_options[option_index].name, option_index);
288 if (access (optarg, R_OK) != 0) {
292 drv = malloc (sizeof (struct drv));
298 drv->a.filename = optarg;
304 libvirt_uri = optarg;
308 drv = malloc (sizeof (struct drv));
314 drv->d.guest = optarg;
320 if (STRCASEEQ (optarg, "list") ||
321 STRCASEEQ (optarg, "help") ||
322 STRCASEEQ (optarg, "h") ||
323 STRCASEEQ (optarg, "?")) {
324 list_prepared_drives ();
327 drv = malloc (sizeof (struct drv));
333 if (asprintf (&drv->N.filename, "test%d.img",
334 next_prepared_drive++) == -1) {
338 drv->N.data = create_prepared_file (optarg, drv->N.filename);
339 drv->N.device = NULL; /* filled in by add_drives */
345 complete_dest_paths = 0;
350 fprintf (stderr, _("%s: only one -f parameter can be given\n"),
361 r = display_command (optarg);
362 else if (argv[optind] && argv[optind][0] != '-')
363 r = display_command (argv[optind++]);
367 exit (r == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
375 mp = malloc (sizeof (struct mp));
380 p = strchr (optarg, ':');
383 mp->mountpoint = p+1;
385 mp->mountpoint = bad_cast ("/");
392 guestfs_set_autosync (g, 0);
401 guestfs_set_verbose (g, verbose);
405 struct guestfs_version *v = guestfs_version (g);
406 printf ("%s %"PRIi64".%"PRIi64".%"PRIi64"%s\n", program_name,
407 v->major, v->minor, v->release, v->extra);
412 guestfs_set_trace (g, 1);
416 usage (EXIT_SUCCESS);
419 usage (EXIT_FAILURE);
423 /* Old-style -i syntax? Since -a/-d/-N and -i was disallowed
424 * previously, if we have -i without any drives but with something
425 * on the command line, it must be old-style syntax.
427 if (inspector && drvs == NULL && optind < argc) {
428 while (optind < argc) {
429 if (strchr (argv[optind], '/') ||
430 access (argv[optind], F_OK) == 0) { /* simulate -a option */
431 drv = malloc (sizeof (struct drv));
437 drv->a.filename = argv[optind];
440 } else { /* simulate -d option */
441 drv = malloc (sizeof (struct drv));
447 drv->d.guest = argv[optind];
456 /* If we've got drives to add, add them now. */
457 add_drives (drvs, 'a');
459 /* If we've got mountpoints or prepared drives or -i option, we must
460 * launch the guest and mount them.
462 if (next_prepared_drive > 1 || mps != NULL || inspector) {
463 /* RHBZ#612178: If --listen flag is given, then we will fork into
464 * the background in rc_listen(). However you can't do this while
465 * holding a libguestfs handle open because the recovery process
466 * will think the main program has died and kill qemu. Therefore
467 * don't use the recovery process for this case. (A better
468 * solution would be to call launch () etc after the fork, but
469 * that greatly complicates the code here).
471 if (remote_control_listen)
472 guestfs_set_recovery_proc (g, 0);
474 if (launch () == -1) exit (EXIT_FAILURE);
479 prepare_drives (drvs);
483 /* Remote control? */
484 if (remote_control_listen && remote_control) {
486 _("%s: cannot use --listen and --remote options at the same time\n"),
491 if (remote_control_listen) {
494 _("%s: extra parameters on the command line with --listen flag\n"),
500 _("%s: cannot use --listen and --file options at the same time\n"),
507 /* -f (file) parameter? */
510 if (open (file, O_RDONLY) == -1) {
516 /* Decide if we display progress bars. */
518 override_progress_bars >= 0
519 ? override_progress_bars
520 : (optind >= argc && isatty (0));
523 guestfs_set_progress_callback (g, progress_callback, NULL);
525 /* Interactive, shell script, or command(s) on the command line? */
526 if (optind >= argc) {
533 cmdline (argv, optind, argc);
540 /* The <term.h> header file which defines this has "issues". */
541 extern int tgetent (char *, const char *);
544 set_up_terminal (void)
546 /* http://www.cl.cam.ac.uk/~mgk25/unicode.html#activate */
547 utf8_mode = STREQ (nl_langinfo (CODESET), "UTF-8");
549 char *term = getenv ("TERM");
551 //fprintf (stderr, _("guestfish: TERM (terminal type) not defined.\n"));
555 int r = tgetent (NULL, term);
557 fprintf (stderr, _("guestfish: could not access termcap or terminfo database.\n"));
561 fprintf (stderr, _("guestfish: terminal type \"%s\" not defined.\n"),
570 pod2text (const char *name, const char *shortdesc, const char *str)
574 fp = popen ("pod2text", "w");
576 /* pod2text failed, maybe not found, so let's just print the
577 * source instead, since that's better than doing nothing.
579 printf ("%s - %s\n\n%s\n", name, shortdesc, str);
582 fprintf (fp, "=head1 NAME\n\n%s - %s\n\n", name, shortdesc);
587 /* List is built in reverse order, so mount them in reverse order. */
589 mount_mps (struct mp *mp)
594 mount_mps (mp->next);
596 /* Don't use guestfs_mount here because that will default to mount
597 * options -o sync,noatime. For more information, see guestfs(3)
598 * section "LIBGUESTFS GOTCHAS".
600 const char *options = read_only ? "ro" : "";
601 r = guestfs_mount_options (g, options, mp->device, mp->mountpoint);
603 /* Display possible mountpoints before exiting. */
604 char **fses = guestfs_list_filesystems (g);
605 if (fses == NULL || fses[0] == NULL)
608 _("guestfish: '%s' could not be mounted. Did you mean one of these?\n"),
611 for (i = 0; fses[i] != NULL; i += 2)
612 fprintf (stderr, "\t%s (%s)\n", fses[i], fses[i+1]);
621 add_drives (struct drv *drv, char next_drive)
625 if (next_drive > 'z') {
627 _("guestfish: too many drives added on the command line\n"));
632 next_drive = add_drives (drv->next, next_drive);
637 r = guestfs_add_drive (g, drv->a.filename);
639 r = guestfs_add_drive_ro (g, drv->a.filename);
647 r = add_libvirt_drives (drv->d.guest);
655 /* -N option is not affected by --ro */
656 r = guestfs_add_drive (g, drv->N.filename);
660 if (asprintf (&drv->N.device, "/dev/sd%c", next_drive) == -1) {
668 default: /* keep GCC happy */
677 prepare_drives (struct drv *drv)
680 prepare_drives (drv->next);
681 if (drv->type == drv_N)
682 prepare_drive (drv->N.filename, drv->N.data, drv->N.device);
689 if (guestfs_is_config (g)) {
690 if (guestfs_launch (g) == -1)
708 #define FISH "><fs> "
710 static char *line_read = NULL;
715 #ifdef HAVE_LIBREADLINE
723 line_read = readline (prompt ? FISH : "");
725 if (line_read && *line_read)
726 add_history_line (line_read);
731 #endif /* HAVE_LIBREADLINE */
733 static char buf[8192];
736 if (prompt) printf (FISH);
737 line_read = fgets (buf, sizeof buf, stdin);
740 len = strlen (line_read);
741 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
755 int global_exit_on_error = !prompt;
760 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
761 "editing virtual machine filesystems.\n"
763 "Type: 'help' for a list of commands\n"
764 " 'man' to read the manual\n"
765 " 'quit' to quit the shell\n"
769 print_inspect_prompt ();
777 exit_on_error = global_exit_on_error;
779 buf = rl_gets (prompt);
785 /* Skip any initial whitespace before the command. */
787 while (*buf && c_isspace (*buf))
792 /* If the next character is '#' then this is a comment. */
793 if (*buf == '#') continue;
795 /* If the next character is '!' then pass the whole lot to system(3). */
803 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
804 WEXITSTATUS (r) != 0)
810 /* If the next character is '-' allow the command to fail without
811 * exiting on error (just for this one command though).
819 /* Get the command (cannot be quoted). */
820 len = strcspn (buf, " \t");
822 if (len == 0) continue;
826 if (buf[len] == '\0') {
833 p += strspn (p, " \t");
835 /* Get the parameters. */
836 while (*p && i < sizeof argv / sizeof argv[0]) {
839 /* Parameters which start with quotes or pipes are treated
840 * specially. Bare parameters are delimited by whitespace.
844 len = strcspn (p, "\"");
845 if (p[len] == '\0') {
846 fprintf (stderr, _("%s: unterminated double quote\n"), program_name);
847 if (exit_on_error) exit (EXIT_FAILURE);
850 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
852 _("%s: command arguments not separated by whitespace\n"),
854 if (exit_on_error) exit (EXIT_FAILURE);
858 pend = p[len+1] ? &p[len+2] : &p[len+1];
859 } else if (*p == '\'') {
861 len = strcspn (p, "'");
862 if (p[len] == '\0') {
863 fprintf (stderr, _("%s: unterminated single quote\n"), program_name);
864 if (exit_on_error) exit (EXIT_FAILURE);
867 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
869 _("%s: command arguments not separated by whitespace\n"),
871 if (exit_on_error) exit (EXIT_FAILURE);
875 pend = p[len+1] ? &p[len+2] : &p[len+1];
876 } else if (*p == '|') {
881 } else if (*p == '[') {
885 while (*pend && c != 0) {
886 if (*pend == '[') c++;
887 else if (*pend == ']') c--;
892 _("%s: unterminated \"[...]\" sequence\n"), program_name);
893 if (exit_on_error) exit (EXIT_FAILURE);
896 if (*pend && (*pend != ' ' && *pend != '\t')) {
898 _("%s: command arguments not separated by whitespace\n"),
900 if (exit_on_error) exit (EXIT_FAILURE);
905 } else if (*p != ' ' && *p != '\t') {
906 /* If the first character is a ~ then note that this parameter
907 * is a candidate for ~username expansion. NB this does not
908 * apply to quoted parameters.
910 tilde_candidate = *p == '~';
911 len = strcspn (p, " \t");
918 fprintf (stderr, _("%s: internal error parsing string at '%s'\n"),
923 if (!tilde_candidate)
926 argv[i] = try_tilde_expansion (p);
931 p += strspn (p, " \t");
934 if (i == sizeof argv / sizeof argv[0]) {
935 fprintf (stderr, _("%s: too many arguments\n"), program_name);
936 if (exit_on_error) exit (EXIT_FAILURE);
943 if (issue_command (cmd, argv, pipe) == -1) {
944 if (exit_on_error) exit (EXIT_FAILURE);
949 if (prompt) printf ("\n");
953 cmdline (char *argv[], int optind, int argc)
960 if (optind >= argc) return;
962 cmd = argv[optind++];
963 if (STREQ (cmd, ":")) {
964 fprintf (stderr, _("%s: empty command on command line\n"), program_name);
968 /* Allow -cmd on the command line to mean (temporarily) override
969 * the normal exit on error (RHBZ#578407).
976 params = &argv[optind];
978 /* Search for end of command list or ":" ... */
979 while (optind < argc && STRNEQ (argv[optind], ":"))
982 if (optind == argc) {
983 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
987 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
989 cmdline (argv, optind+1, argc);
994 issue_command (const char *cmd, char *argv[], const char *pipecmd)
997 int stdout_saved_fd = -1;
1001 reset_progress_bar ();
1003 /* This counts the commands issued, starting at 1. */
1006 /* For | ... commands. Annoyingly we can't use popen(3) here. */
1010 if (fflush (stdout) == EOF) {
1011 perror ("failed to flush standard output");
1014 if (pipe (fd) < 0) {
1015 perror ("pipe failed");
1024 if (pid == 0) { /* Child process. */
1026 if (dup2 (fd[0], 0) < 0) {
1027 perror ("dup2 of stdin failed");
1031 r = system (pipecmd);
1036 _exit (WEXITSTATUS (r));
1039 if ((stdout_saved_fd = dup (1)) < 0) {
1040 perror ("failed to dup stdout");
1044 if (dup2 (fd[1], 1) < 0) {
1045 perror ("failed to dup stdout");
1046 close (stdout_saved_fd);
1052 for (argc = 0; argv[argc] != NULL; ++argc)
1055 /* If --remote was set, then send this command to a remote process. */
1057 r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
1059 /* Otherwise execute it locally. */
1060 else if (STRCASEEQ (cmd, "help")) {
1065 r = display_command (argv[0]);
1067 else if (STRCASEEQ (cmd, "quit") ||
1068 STRCASEEQ (cmd, "exit") ||
1069 STRCASEEQ (cmd, "q")) {
1074 r = run_action (cmd, argc, argv);
1076 /* Always flush stdout after every command, so that messages, results
1077 * etc appear immediately.
1079 if (fflush (stdout) == EOF) {
1080 perror ("failed to flush standard output");
1086 if (dup2 (stdout_saved_fd, 1) < 0) {
1087 perror ("failed to dup2 standard output");
1090 close (stdout_saved_fd);
1091 if (waitpid (pid, NULL, 0) < 0) {
1092 perror ("waiting for command to complete");
1101 list_builtin_commands (void)
1103 /* help and quit should appear at the top */
1104 printf ("%-20s %s\n",
1105 "help", _("display a list of commands or help on a command"));
1106 printf ("%-20s %s\n",
1107 "quit", _("quit guestfish"));
1109 /* actions are printed after this (see list_commands) */
1113 display_builtin_command (const char *cmd)
1115 /* help for actions is auto-generated, see display_command */
1117 if (STRCASEEQ (cmd, "help")) {
1118 printf (_("help - display a list of commands or help on a command\n"
1123 else if (STRCASEEQ (cmd, "quit") ||
1124 STRCASEEQ (cmd, "exit") ||
1125 STRCASEEQ (cmd, "q")) {
1126 printf (_("quit - quit guestfish\n"
1131 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
1137 /* This is printed when the user types in an unknown command for the
1138 * first command issued. A common case is the user doing:
1139 * guestfish disk.img
1140 * expecting guestfish to open 'disk.img' (in fact, this tried to
1141 * run a command 'disk.img').
1144 extended_help_message (void)
1147 _("Did you mean to open a disk image? guestfish -a disk.img\n"
1148 "For a list of commands: guestfish -h\n"
1149 "For complete documentation: man guestfish\n"));
1153 free_strings (char **argv)
1157 for (argc = 0; argv[argc] != NULL; ++argc)
1163 count_strings (char *const *argv)
1167 for (c = 0; argv[c]; ++c)
1173 print_strings (char *const *argv)
1177 for (argc = 0; argv[argc] != NULL; ++argc)
1178 printf ("%s\n", argv[argc]);
1182 print_table (char *const *argv)
1186 for (i = 0; argv[i] != NULL; i += 2)
1187 printf ("%s: %s\n", argv[i], argv[i+1]);
1191 is_true (const char *str)
1194 STRCASENEQ (str, "0") &&
1195 STRCASENEQ (str, "f") &&
1196 STRCASENEQ (str, "false") &&
1197 STRCASENEQ (str, "n") &&
1198 STRCASENEQ (str, "no");
1201 /* Free strings from a non-NULL terminated char** */
1203 free_n_strings (char **str, size_t len)
1207 for (i = 0; i < len; i++) {
1214 parse_string_list (const char *str)
1217 size_t argv_len = 0;
1219 /* Current position pointer */
1220 const char *p = str;
1222 /* Token might be simple:
1225 * 'This is a single token'
1226 * or contain embedded single-quoted sections:
1227 * This' is a sing'l'e to'ken
1229 * The latter may seem over-complicated, but it's what a normal shell does.
1230 * Not doing it risks surprising somebody.
1232 * This outer loop is over complete tokens.
1238 /* Skip leading whitespace */
1239 p += strspn (p, " \t");
1243 /* This loop is over token 'fragments'. A token can be in multiple bits if
1244 * it contains single quotes. We also treat both sides of an escaped quote
1245 * as separate fragments because we can't just copy it: we have to remove
1248 while (*p && (!c_isblank (*p) || in_quote)) {
1249 const char *end = p;
1251 /* Check if the fragment starts with a quote */
1253 /* Toggle in_quote */
1254 in_quote = !in_quote;
1256 /* Skip the quote */
1260 /* If we're in a quote, look for an end quote */
1262 end += strcspn (end, "'");
1265 /* Otherwise, look for whitespace or a quote */
1267 end += strcspn (end, " \t'");
1270 /* Grow the token to accommodate the fragment */
1271 size_t tok_end = tok_len;
1273 char *tok_new = realloc (tok, tok_len + 1);
1274 if (NULL == tok_new) {
1276 free_n_strings (argv, argv_len);
1278 exit (EXIT_FAILURE);
1282 /* Check if we stopped on an escaped quote */
1283 if ('\'' == *end && end != p && *(end-1) == '\\') {
1284 /* Add everything before \' to the token */
1285 memcpy (&tok[tok_end], p, end - p - 1);
1288 tok[tok_len-1] = '\'';
1290 /* Already processed the quote */
1295 /* Add the whole fragment */
1296 memcpy (&tok[tok_end], p, end - p);
1302 /* We've reached the end of a token. We shouldn't still be in quotes. */
1304 fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str);
1306 free_n_strings (argv, argv_len);
1311 /* Add this token if there is one. There might not be if there was
1312 * whitespace at the end of the input string */
1314 /* Add the NULL terminator */
1315 tok[tok_len] = '\0';
1317 /* Add the argument to the argument list */
1319 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1320 if (NULL == argv_new) {
1322 free_n_strings (argv, argv_len-1);
1324 exit (EXIT_FAILURE);
1328 argv[argv_len-1] = tok;
1332 /* NULL terminate the argument list */
1334 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1335 if (NULL == argv_new) {
1337 free_n_strings (argv, argv_len-1);
1338 exit (EXIT_FAILURE);
1342 argv[argv_len-1] = NULL;
1347 #ifdef HAVE_LIBREADLINE
1348 static char histfile[1024];
1349 static int nr_history_lines = 0;
1353 initialize_readline (void)
1355 #ifdef HAVE_LIBREADLINE
1358 home = getenv ("HOME");
1360 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1362 (void) read_history (histfile);
1365 rl_readline_name = "guestfish";
1366 rl_attempted_completion_function = do_completion;
1368 /* Note that .inputrc (or /etc/inputrc) is not read until the first
1369 * call the readline(), which happens later. Therefore, these
1370 * provide default values which can be overridden by the user if
1373 (void) rl_variable_bind ("completion-ignore-case", "on");
1378 cleanup_readline (void)
1380 #ifdef HAVE_LIBREADLINE
1383 if (histfile[0] != '\0') {
1384 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1391 #ifdef HAVE_APPEND_HISTORY
1392 (void) append_history (nr_history_lines, histfile);
1394 (void) write_history (histfile);
1400 #ifdef HAVE_LIBREADLINE
1402 add_history_line (const char *line)
1410 xwrite (int fd, const void *v_buf, size_t len)
1413 const char *buf = v_buf;
1416 r = write (fd, buf, len);
1428 /* Resolve the special "win:..." form for Windows-specific paths.
1429 * This always returns a newly allocated string which is freed by the
1430 * caller function in "cmds.c".
1433 resolve_win_path (const char *path)
1438 if (STRCASENEQLEN (path, "win:", 4)) {
1439 ret = strdup (path);
1447 /* Drop drive letter, if it's "C:". */
1448 if (STRCASEEQLEN (path, "c:", 2))
1458 ret = strdup (path);
1464 /* Blindly convert any backslashes into forward slashes. Is this good? */
1465 for (i = 0; i < strlen (ret); ++i)
1469 char *t = guestfs_case_sensitive_path (g, ret);
1476 /* Resolve the special FileIn paths ("-" or "-<<END" or filename).
1477 * The caller (cmds.c) will call free_file_in after the command has
1478 * run which should clean up resources.
1480 static char *file_in_heredoc (const char *endmarker);
1481 static char *file_in_tmpfile = NULL;
1484 file_in (const char *arg)
1488 if (STREQ (arg, "-")) {
1489 ret = strdup ("/dev/stdin");
1495 else if (STRPREFIX (arg, "-<<")) {
1496 const char *endmarker = &arg[3];
1497 if (*endmarker == '\0') {
1498 fprintf (stderr, "%s: missing end marker in -<< expression\n",
1502 ret = file_in_heredoc (endmarker);
1518 file_in_heredoc (const char *endmarker)
1520 static const char template[] = "/tmp/heredocXXXXXX";
1521 file_in_tmpfile = strdup (template);
1522 if (file_in_tmpfile == NULL) {
1527 int fd = mkstemp (file_in_tmpfile);
1533 size_t markerlen = strlen (endmarker);
1535 char buffer[BUFSIZ];
1536 int write_error = 0;
1537 while (fgets (buffer, sizeof buffer, stdin) != NULL) {
1538 /* Look for "END"<EOF> or "END\n" in input. */
1539 size_t blen = strlen (buffer);
1540 if (STREQLEN (buffer, endmarker, markerlen) &&
1541 (blen == markerlen ||
1542 (blen == markerlen+1 && buffer[markerlen] == '\n')))
1545 if (xwrite (fd, buffer, blen) == -1) {
1546 if (!write_error) perror ("write");
1548 /* continue reading up to the end marker */
1552 /* Reached EOF of stdin without finding the end marker, which
1553 * is likely to be an error.
1555 fprintf (stderr, "%s: end of input reached without finding '%s'\n",
1556 program_name, endmarker);
1565 if (close (fd) == -1) {
1570 return file_in_tmpfile;
1573 unlink (file_in_tmpfile);
1576 free (file_in_tmpfile);
1577 file_in_tmpfile = NULL;
1582 free_file_in (char *s)
1584 if (file_in_tmpfile) {
1585 if (unlink (file_in_tmpfile) == -1)
1586 perror (file_in_tmpfile);
1587 file_in_tmpfile = NULL;
1590 /* Free the device or file name which was strdup'd in file_in().
1591 * Note it's not immediately clear, but for -<< heredocs,
1592 * s == file_in_tmpfile, so this frees up that buffer.
1597 /* Resolve the special FileOut paths ("-" or filename).
1598 * The caller (cmds.c) will call free (str) after the command has run.
1601 file_out (const char *arg)
1605 if (STREQ (arg, "-"))
1606 ret = strdup ("/dev/stdout");
1617 /* Read a passphrase ('Key') from /dev/tty with echo off.
1618 * The caller (cmds.c) will call free on the string afterwards.
1619 * Based on the code in cryptsetup file lib/utils.c.
1622 read_key (const char *param)
1625 struct termios orig, temp;
1628 /* Read and write to /dev/tty if available. */
1629 if (keys_from_stdin ||
1630 (infp = outfp = fopen ("/dev/tty", "w+")) == NULL) {
1635 /* Print the prompt and set no echo. */
1636 int tty = isatty (fileno (infp));
1639 fprintf (outfp, _("Enter key or passphrase (\"%s\"): "), param);
1641 if (tcgetattr (fileno (infp), &orig) == -1) {
1642 perror ("tcgetattr");
1645 memcpy (&temp, &orig, sizeof temp);
1646 temp.c_lflag &= ~ECHO;
1648 tcsetattr (fileno (infp), TCSAFLUSH, &temp);
1654 len = getline (&ret, &n, infp);
1661 /* Remove the terminating \n if there is one. */
1662 if (len > 0 && ret[len-1] == '\n')
1666 /* Restore echo, close file descriptor. */
1669 tcsetattr (fileno (infp), TCSAFLUSH, &orig);
1673 fclose (infp); /* outfp == infp, so this is closed also */