1 /* guestfish - the filesystem interactive shell
2 * Copyright (C) 2009-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #include <sys/types.h>
34 #ifdef HAVE_LIBREADLINE
35 #include <readline/readline.h>
36 #include <readline/history.h>
49 /* Return from parse_command_line. See description below. */
50 struct parsed_command {
57 static void user_cancel (int);
58 static void prepare_drives (struct drv *drv);
59 static int launch (void);
60 static void interactive (void);
61 static void shell_script (void);
62 static void script (int prompt);
63 static void cmdline (char *argv[], int optind, int argc);
64 static struct parsed_command parse_command_line (char *buf, int *exit_on_error_rtn);
65 static int parse_quoted_string (char *p);
66 static int execute_and_inline (const char *cmd, int exit_on_error);
67 static void error_cb (guestfs_h *g, void *data, const char *msg);
68 static void initialize_readline (void);
69 static void cleanup_readline (void);
70 #ifdef HAVE_LIBREADLINE
71 static void add_history_line (const char *);
74 static int override_progress_bars = -1;
75 static struct progress_bar *bar = NULL;
77 /* Currently open libguestfs handle. */
84 int remote_control_listen = 0;
85 int remote_control_csh = 0;
86 int remote_control = 0;
88 int keys_from_stdin = 0;
90 const char *libvirt_uri = NULL;
92 int progress_bars = 0;
93 int is_interactive = 0;
94 const char *input_file = NULL;
97 static void __attribute__((noreturn))
100 if (status != EXIT_SUCCESS)
101 fprintf (stderr, _("Try `%s --help' for more information.\n"),
105 _("%s: guest filesystem shell\n"
106 "%s lets you edit virtual machine filesystems\n"
107 "Copyright (C) 2009-2011 Red Hat Inc.\n"
109 " %s [--options] cmd [: cmd : cmd ...]\n"
111 " -h|--cmd-help List available commands\n"
112 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
113 " -a|--add image Add image\n"
114 " -c|--connect uri Specify libvirt URI for -d option\n"
115 " --csh Make --listen csh-compatible\n"
116 " -d|--domain guest Add disks from libvirt guest\n"
117 " -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
118 " --echo-keys Don't turn off echo for passphrases\n"
119 " -f|--file file Read commands from file\n"
120 " --format[=raw|..] Force disk format for -a option\n"
121 " -i|--inspector Automatically mount filesystems\n"
122 " --keys-from-stdin Read passphrases from stdin\n"
123 " --listen Listen for remote commands\n"
124 " --live Connect to a live virtual machine\n"
125 " -m|--mount dev[:mnt[:opts]] Mount dev on mnt (if omitted, /)\n"
126 " -n|--no-sync Don't autosync\n"
127 " -N|--new type Create prepared disk (test1.img, ...)\n"
128 " --progress-bars Enable progress bars even when not interactive\n"
129 " --no-progress-bars Disable progress bars\n"
130 " --remote[=pid] Send commands to remote %s\n"
131 " -r|--ro Mount read-only\n"
132 " --selinux Enable SELinux support\n"
133 " -v|--verbose Verbose messages\n"
134 " -V|--version Display version and exit\n"
135 " -w|--rw Mount read-write\n"
136 " -x Echo each command before executing it\n"
138 "To examine a disk image, ISO, hard disk, filesystem etc:\n"
139 " %s [--ro|--rw] -i -a /path/to/disk.img\n"
141 " %s [--ro|--rw] -i -d name-of-libvirt-domain\n"
143 "--ro recommended to avoid any writes to the disk image. If -i option fails\n"
144 "run again without -i and use 'run' + 'list-filesystems' + 'mount' cmds.\n"
146 "For more information, see the manpage %s(1).\n"),
147 program_name, program_name, program_name,
148 program_name, program_name, program_name,
155 main (int argc, char *argv[])
157 /* Set global program name that is not polluted with libtool artifacts. */
158 set_program_name (argv[0]);
160 atexit (close_stdout);
162 setlocale (LC_ALL, "");
163 bindtextdomain (PACKAGE, LOCALEBASEDIR);
164 textdomain (PACKAGE);
168 enum { HELP_OPTION = CHAR_MAX + 1 };
170 static const char *options = "a:c:d:Df:h::im:nN:rv?Vwx";
171 static const struct option long_options[] = {
172 { "add", 1, 0, 'a' },
173 { "cmd-help", 2, 0, 'h' },
174 { "connect", 1, 0, 'c' },
176 { "domain", 1, 0, 'd' },
177 { "echo-keys", 0, 0, 0 },
178 { "file", 1, 0, 'f' },
179 { "format", 2, 0, 0 },
180 { "help", 0, 0, HELP_OPTION },
181 { "inspector", 0, 0, 'i' },
182 { "keys-from-stdin", 0, 0, 0 },
183 { "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 },
194 { "selinux", 0, 0, 0 },
195 { "verbose", 0, 0, 'v' },
196 { "version", 0, 0, 'V' },
199 struct drv *drvs = NULL;
201 struct mp *mps = NULL;
203 char *p, *file = NULL;
204 const char *format = NULL;
208 int next_prepared_drive = 1;
210 initialize_readline ();
211 init_event_handlers ();
213 memset (&sa, 0, sizeof sa);
214 sa.sa_handler = SIG_IGN;
215 sa.sa_flags = SA_RESTART;
216 sigaction (SIGPIPE, &sa, NULL);
218 /* guestfs_create is meant to be a lightweight operation, so
219 * it's OK to do it early here.
221 g = guestfs_create ();
223 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
227 /* CAUTION: we are careful to modify argv[0] here, only after
228 * using it just above.
230 * getopt_long uses argv[0], so give it the sanitized name. Save a copy
231 * of the original, in case it's needed below.
233 //char *real_argv0 = argv[0];
234 argv[0] = bad_cast (program_name);
237 c = getopt_long (argc, argv, options, long_options, &option_index);
241 case 0: /* options which are long only */
242 if (STREQ (long_options[option_index].name, "listen"))
243 remote_control_listen = 1;
244 else if (STREQ (long_options[option_index].name, "remote")) {
246 if (sscanf (optarg, "%d", &remote_control) != 1) {
247 fprintf (stderr, _("%s: --listen=PID: PID was not a number: %s\n"),
248 program_name, optarg);
252 p = getenv ("GUESTFISH_PID");
253 if (!p || sscanf (p, "%d", &remote_control) != 1) {
254 fprintf (stderr, _("%s: remote: $GUESTFISH_PID must be set"
255 " to the PID of the remote process\n"),
260 } else if (STREQ (long_options[option_index].name, "selinux")) {
261 guestfs_set_selinux (g, 1);
262 } else if (STREQ (long_options[option_index].name, "keys-from-stdin")) {
264 } else if (STREQ (long_options[option_index].name, "progress-bars")) {
265 override_progress_bars = 1;
266 } else if (STREQ (long_options[option_index].name, "no-progress-bars")) {
267 override_progress_bars = 0;
268 } else if (STREQ (long_options[option_index].name, "echo-keys")) {
270 } else if (STREQ (long_options[option_index].name, "format")) {
271 if (!optarg || STREQ (optarg, ""))
275 } else if (STREQ (long_options[option_index].name, "csh")) {
276 remote_control_csh = 1;
277 } else if (STREQ (long_options[option_index].name, "live")) {
280 fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
281 program_name, long_options[option_index].name, option_index);
299 complete_dest_paths = 0;
304 fprintf (stderr, _("%s: only one -f parameter can be given\n"),
315 r = display_command (optarg);
316 else if (argv[optind] && argv[optind][0] != '-')
317 r = display_command (argv[optind++]);
321 exit (r == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
337 if (STRCASEEQ (optarg, "list") ||
338 STRCASEEQ (optarg, "help") ||
339 STRCASEEQ (optarg, "h") ||
340 STRCASEEQ (optarg, "?")) {
341 list_prepared_drives ();
344 drv = malloc (sizeof (struct drv));
352 if (asprintf (&drv->N.filename, "test%d.img",
353 next_prepared_drive++) == -1) {
357 drv->N.data = create_prepared_file (optarg, drv->N.filename);
358 drv->N.data_free = free_prep_data;
384 usage (EXIT_SUCCESS);
387 usage (EXIT_FAILURE);
391 /* Decide here if this will be an interactive session. We have to
392 * do this as soon as possible after processing the command line
395 is_interactive = !file && isatty (0);
397 /* Register a ^C handler. We have to do this before launch could
398 * possibly be called below.
400 if (is_interactive) {
401 memset (&sa, 0, sizeof sa);
402 sa.sa_handler = user_cancel;
403 sa.sa_flags = SA_RESTART;
404 sigaction (SIGINT, &sa, NULL);
406 guestfs_set_pgroup (g, 1);
409 /* Old-style -i syntax? Since -a/-d/-N and -i was disallowed
410 * previously, if we have -i without any drives but with something
411 * on the command line, it must be old-style syntax.
413 if (inspector && drvs == NULL && optind < argc) {
414 while (optind < argc) {
415 if (strchr (argv[optind], '/') ||
416 access (argv[optind], F_OK) == 0) { /* simulate -a option */
417 drv = malloc (sizeof (struct drv));
423 drv->a.filename = argv[optind];
424 drv->a.format = NULL;
427 } else { /* simulate -d option */
428 drv = malloc (sizeof (struct drv));
434 drv->d.guest = argv[optind];
443 /* If we've got drives to add, add them now. */
444 add_drives (drvs, 'a');
446 /* If we've got mountpoints or prepared drives or -i option, we must
447 * launch the guest and mount them.
449 if (next_prepared_drive > 1 || mps != NULL || inspector) {
450 /* RHBZ#612178: If --listen flag is given, then we will fork into
451 * the background in rc_listen(). However you can't do this while
452 * holding a libguestfs handle open because the recovery process
453 * will think the main program has died and kill qemu. Therefore
454 * don't use the recovery process for this case. (A better
455 * solution would be to call launch () etc after the fork, but
456 * that greatly complicates the code here).
458 if (remote_control_listen)
459 guestfs_set_recovery_proc (g, 0);
461 if (launch () == -1) exit (EXIT_FAILURE);
466 prepare_drives (drvs);
470 /* Free up data structures, no longer needed after this point. */
474 /* Remote control? */
475 if (remote_control_listen && remote_control) {
477 _("%s: cannot use --listen and --remote options at the same time\n"),
482 if (remote_control_listen) {
485 _("%s: extra parameters on the command line with --listen flag\n"),
491 _("%s: cannot use --listen and --file options at the same time\n"),
498 /* -f (file) parameter? */
501 if (open (file, O_RDONLY) == -1) {
507 /* Get the name of the input file, for error messages, and replace
508 * the default error handler.
510 if (!is_interactive) {
514 input_file = "*stdin*";
515 guestfs_set_error_handler (g, error_cb, NULL);
519 /* Decide if we display progress bars. */
521 override_progress_bars >= 0
522 ? override_progress_bars
523 : (optind >= argc && is_interactive);
526 bar = progress_bar_init (0);
528 perror ("progress_bar_init");
532 guestfs_set_event_callback (g, progress_callback,
533 GUESTFS_EVENT_PROGRESS, 0, NULL);
536 /* Interactive, shell script, or command(s) on the command line? */
537 if (optind >= argc) {
544 cmdline (argv, optind, argc);
549 progress_bar_free (bar);
552 free_event_handlers ();
558 user_cancel (int sig)
561 guestfs_user_cancel (g);
565 prepare_drives (struct drv *drv)
568 prepare_drives (drv->next);
569 if (drv->type == drv_N)
570 prepare_drive (drv->N.filename, drv->N.data, drv->device);
577 if (guestfs_is_config (g)) {
578 if (guestfs_launch (g) == -1)
596 #define FISH "><fs> "
598 static char *line_read = NULL;
603 #ifdef HAVE_LIBREADLINE
611 line_read = readline (prompt ? FISH : "");
613 if (line_read && *line_read)
614 add_history_line (line_read);
619 #endif /* HAVE_LIBREADLINE */
621 static char buf[8192];
624 if (prompt) printf (FISH);
625 line_read = fgets (buf, sizeof buf, stdin);
628 len = strlen (line_read);
629 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
639 int global_exit_on_error = !prompt;
641 struct parsed_command pcmd;
645 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
646 "editing virtual machine filesystems.\n"
648 "Type: 'help' for help on commands\n"
649 " 'man' to read the manual\n"
650 " 'quit' to quit the shell\n"
654 print_inspect_prompt ();
660 exit_on_error = global_exit_on_error;
662 buf = rl_gets (prompt);
670 pcmd = parse_command_line (buf, &exit_on_error);
671 if (pcmd.status == -1 && exit_on_error)
673 if (pcmd.status == 1) {
674 if (issue_command (pcmd.cmd, pcmd.argv, pcmd.pipe, exit_on_error) == -1) {
675 if (exit_on_error) exit (EXIT_FAILURE);
679 if (prompt) printf ("\n");
682 /* Parse a command string, splitting at whitespace, handling '!', '#' etc.
683 * This destructively updates 'buf'.
685 * 'exit_on_error_rtn' is used to pass in the global exit_on_error
686 * setting and to return the local setting (eg. if the command begins
689 * Returns in parsed_command.status:
690 * 1 = got a guestfish command (returned in cmd_rtn/argv_rtn/pipe_rtn)
691 * 0 = no guestfish command, but otherwise OK
694 static struct parsed_command
695 parse_command_line (char *buf, int *exit_on_error_rtn)
697 struct parsed_command pcmd;
702 const size_t argv_len = sizeof pcmd.argv / sizeof pcmd.argv[0];
704 /* Note that pcmd.pipe must be set to NULL for correct usage. Other
705 * fields do not need to be, but this silences a gcc warning.
707 memset (&pcmd, 0, sizeof pcmd);
710 /* Skip any initial whitespace before the command. */
711 while (*buf && c_isspace (*buf))
719 /* If the next character is '#' then this is a comment. */
725 /* If the next character is '!' then pass the whole lot to system(3). */
730 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
731 WEXITSTATUS (r) != 0)
738 /* If the next two characters are "<!" then pass the command to
739 * popen(3), read the result and execute it as guestfish commands.
741 if (buf[0] == '<' && buf[1] == '!') {
742 int r = execute_and_inline (&buf[2], *exit_on_error_rtn);
750 /* If the next character is '-' allow the command to fail without
751 * exiting on error (just for this one command though).
754 *exit_on_error_rtn = 0;
759 /* Get the command (cannot be quoted). */
760 len = strcspn (buf, " \t");
769 if (buf[len] == '\0') {
777 p += strspn (p, " \t");
779 /* Get the parameters. */
780 while (*p && i < argv_len) {
783 /* Parameters which start with quotes or pipes are treated
784 * specially. Bare parameters are delimited by whitespace.
788 len = parse_quoted_string (p);
793 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
795 _("%s: command arguments not separated by whitespace\n"),
800 pend = p[len+1] ? &p[len+2] : &p[len+1];
801 } else if (*p == '\'') {
803 len = strcspn (p, "'");
804 if (p[len] == '\0') {
805 fprintf (stderr, _("%s: unterminated single quote\n"), program_name);
809 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
811 _("%s: command arguments not separated by whitespace\n"),
817 pend = p[len+1] ? &p[len+2] : &p[len+1];
818 } else if (*p == '|') {
822 } else if (*p != ' ' && *p != '\t') {
823 /* If the first character is a ~ then note that this parameter
824 * is a candidate for ~username expansion. NB this does not
825 * apply to quoted parameters.
827 tilde_candidate = *p == '~';
828 len = strcspn (p, " \t");
835 fprintf (stderr, _("%s: internal error parsing string at '%s'\n"),
840 if (!tilde_candidate)
843 pcmd.argv[i] = try_tilde_expansion (p);
848 p += strspn (p, " \t");
852 fprintf (stderr, _("%s: too many arguments\n"), program_name);
867 case '0'...'9': return d - '0';
868 case 'a'...'f': return d - 'a' + 10;
869 case 'A'...'F': return d - 'A' + 10;
874 /* Parse double-quoted strings, replacing backslash escape sequences
875 * with the true character. Since the string is returned in place,
876 * the escapes must make the string shorter.
879 parse_quoted_string (char *p)
883 for (; *p && *p != '"'; p++) {
889 case 'a': *p = '\a'; break;
890 case 'b': *p = '\b'; break;
891 case 'f': *p = '\f'; break;
892 case 'n': *p = '\n'; break;
893 case 'r': *p = '\r'; break;
894 case 't': *p = '\t'; break;
895 case 'v': *p = '\v'; break;
896 case '"': *p = '"'; break;
897 case '\'': *p = '\''; break;
898 case '?': *p = '?'; break;
900 case '0'...'7': /* octal escape - always 3 digits */
902 if (p[2] >= '0' && p[2] <= '7' &&
903 p[3] >= '0' && p[3] <= '7') {
904 c = (p[1] - '0') * 0100 + (p[2] - '0') * 010 + (p[3] - '0');
905 if (c < 1 || c > 255)
913 case 'x': /* hex escape - always 2 digits */
915 if (c_isxdigit (p[2]) && c_isxdigit (p[3])) {
916 c = hexdigit (p[2]) * 0x10 + hexdigit (p[3]);
917 if (c < 1 || c > 255)
927 fprintf (stderr, _("%s: invalid escape sequence in string (starting at offset %d)\n"),
928 program_name, (int) (p - start));
931 memmove (p+1, p+1+m, strlen (p+1+m) + 1);
936 fprintf (stderr, _("%s: unterminated double quote\n"), program_name);
944 /* Used to handle "<!" (execute command and inline result). */
946 execute_and_inline (const char *cmd, int global_exit_on_error)
953 struct parsed_command pcmd;
955 pp = popen (cmd, "r");
961 while ((n = getline (&line, &len, pp)) != -1) {
962 exit_on_error = global_exit_on_error;
964 /* Chomp final line ending which parse_command_line would not expect. */
965 if (n > 0 && line[n-1] == '\n')
968 pcmd = parse_command_line (line, &exit_on_error);
969 if (pcmd.status == -1 && exit_on_error)
971 if (pcmd.status == 1) {
972 if (issue_command (pcmd.cmd, pcmd.argv, pcmd.pipe, exit_on_error) == -1) {
973 if (exit_on_error) exit (EXIT_FAILURE);
980 if (pclose (pp) != 0) {
989 cmdline (char *argv[], int optind, int argc)
997 if (optind >= argc) return;
999 cmd = argv[optind++];
1000 if (STREQ (cmd, ":")) {
1001 fprintf (stderr, _("%s: empty command on command line\n"), program_name);
1002 exit (EXIT_FAILURE);
1005 /* Allow -cmd on the command line to mean (temporarily) override
1006 * the normal exit on error (RHBZ#578407).
1008 if (cmd[0] == '-') {
1013 params = &argv[optind];
1015 /* Search for end of command list or ":" ... */
1016 while (optind < argc && STRNEQ (argv[optind], ":"))
1019 if (optind == argc) {
1020 if (issue_command (cmd, params, NULL, exit_on_error) == -1 && exit_on_error)
1021 exit (EXIT_FAILURE);
1023 argv[optind] = NULL;
1024 if (issue_command (cmd, params, NULL, exit_on_error) == -1 && exit_on_error)
1025 exit (EXIT_FAILURE);
1026 cmdline (argv, optind+1, argc);
1030 /* Note: 'rc_exit_on_error_flag' is the exit_on_error flag that we
1031 * pass to the remote server (when issuing --remote commands). It
1032 * does not cause issue_command itself to exit on error.
1035 issue_command (const char *cmd, char *argv[], const char *pipecmd,
1036 int rc_exit_on_error_flag)
1039 int stdout_saved_fd = -1;
1044 progress_bar_reset (bar);
1046 /* This counts the commands issued, starting at 1. */
1049 /* For | ... commands. Annoyingly we can't use popen(3) here. */
1053 if (fflush (stdout) == EOF) {
1054 perror ("failed to flush standard output");
1057 if (pipe (fd) < 0) {
1058 perror ("pipe failed");
1067 if (pid == 0) { /* Child process. */
1069 if (dup2 (fd[0], 0) < 0) {
1070 perror ("dup2 of stdin failed");
1074 r = system (pipecmd);
1079 _exit (WEXITSTATUS (r));
1082 if ((stdout_saved_fd = dup (1)) < 0) {
1083 perror ("failed to dup stdout");
1087 if (dup2 (fd[1], 1) < 0) {
1088 perror ("failed to dup stdout");
1089 close (stdout_saved_fd);
1095 for (argc = 0; argv[argc] != NULL; ++argc)
1098 /* If --remote was set, then send this command to a remote process. */
1100 r = rc_remote (remote_control, cmd, argc, argv, rc_exit_on_error_flag);
1102 /* Otherwise execute it locally. */
1103 else if (STRCASEEQ (cmd, "help")) {
1108 r = display_command (argv[0]);
1110 else if (STRCASEEQ (cmd, "quit") ||
1111 STRCASEEQ (cmd, "exit") ||
1112 STRCASEEQ (cmd, "q")) {
1117 r = run_action (cmd, argc, argv);
1119 /* Always flush stdout after every command, so that messages, results
1120 * etc appear immediately.
1122 if (fflush (stdout) == EOF) {
1123 perror ("failed to flush standard output");
1129 if (dup2 (stdout_saved_fd, 1) < 0) {
1130 perror ("failed to dup2 standard output");
1133 close (stdout_saved_fd);
1134 if (waitpid (pid, NULL, 0) < 0) {
1135 perror ("waiting for command to complete");
1144 list_builtin_commands (void)
1146 /* help and quit should appear at the top */
1147 printf ("%-20s %s\n",
1148 "help", _("display a list of commands or help on a command"));
1149 printf ("%-20s %s\n",
1150 "quit", _("quit guestfish"));
1152 /* actions are printed after this (see list_commands) */
1156 display_builtin_command (const char *cmd)
1158 /* help for actions is auto-generated, see display_command */
1160 if (STRCASEEQ (cmd, "help")) {
1161 printf (_("help - display a list of commands or help on a command\n"
1166 else if (STRCASEEQ (cmd, "quit") ||
1167 STRCASEEQ (cmd, "exit") ||
1168 STRCASEEQ (cmd, "q")) {
1169 printf (_("quit - quit guestfish\n"
1174 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
1180 /* This is printed when the user types in an unknown command for the
1181 * first command issued. A common case is the user doing:
1182 * guestfish disk.img
1183 * expecting guestfish to open 'disk.img' (in fact, this tried to
1184 * run a command 'disk.img').
1187 extended_help_message (void)
1190 _("Did you mean to open a disk image? guestfish -a disk.img\n"
1191 "For a list of commands: guestfish -h\n"
1192 "For complete documentation: man guestfish\n"));
1195 /* Error callback. This replaces the standard libguestfs error handler. */
1197 error_cb (guestfs_h *g, void *data, const char *msg)
1199 fprintf (stderr, _("%s:%d: libguestfs: error: %s\n"),
1200 input_file, input_lineno, msg);
1204 free_strings (char **argv)
1208 for (argc = 0; argv[argc] != NULL; ++argc)
1214 count_strings (char *const *argv)
1218 for (c = 0; argv[c]; ++c)
1224 print_strings (char *const *argv)
1228 for (argc = 0; argv[argc] != NULL; ++argc)
1229 printf ("%s\n", argv[argc]);
1233 print_table (char *const *argv)
1237 for (i = 0; argv[i] != NULL; i += 2)
1238 printf ("%s: %s\n", argv[i], argv[i+1]);
1242 is_true (const char *str)
1245 STRCASENEQ (str, "0") &&
1246 STRCASENEQ (str, "f") &&
1247 STRCASENEQ (str, "false") &&
1248 STRCASENEQ (str, "n") &&
1249 STRCASENEQ (str, "no");
1252 /* Free strings from a non-NULL terminated char** */
1254 free_n_strings (char **str, size_t len)
1258 for (i = 0; i < len; i++) {
1265 parse_string_list (const char *str)
1268 size_t argv_len = 0;
1270 /* Current position pointer */
1271 const char *p = str;
1273 /* Token might be simple:
1276 * 'This is a single token'
1277 * or contain embedded single-quoted sections:
1278 * This' is a sing'l'e to'ken
1280 * The latter may seem over-complicated, but it's what a normal shell does.
1281 * Not doing it risks surprising somebody.
1283 * This outer loop is over complete tokens.
1289 /* Skip leading whitespace */
1290 p += strspn (p, " \t");
1294 /* This loop is over token 'fragments'. A token can be in multiple bits if
1295 * it contains single quotes. We also treat both sides of an escaped quote
1296 * as separate fragments because we can't just copy it: we have to remove
1299 while (*p && (!c_isblank (*p) || in_quote)) {
1300 const char *end = p;
1302 /* Check if the fragment starts with a quote */
1304 /* Toggle in_quote */
1305 in_quote = !in_quote;
1307 /* Skip the quote */
1311 /* If we're in a quote, look for an end quote */
1313 end += strcspn (end, "'");
1316 /* Otherwise, look for whitespace or a quote */
1318 end += strcspn (end, " \t'");
1321 /* Grow the token to accommodate the fragment */
1322 size_t tok_end = tok_len;
1324 char *tok_new = realloc (tok, tok_len + 1);
1325 if (NULL == tok_new) {
1327 free_n_strings (argv, argv_len);
1329 exit (EXIT_FAILURE);
1333 /* Check if we stopped on an escaped quote */
1334 if ('\'' == *end && end != p && *(end-1) == '\\') {
1335 /* Add everything before \' to the token */
1336 memcpy (&tok[tok_end], p, end - p - 1);
1339 tok[tok_len-1] = '\'';
1341 /* Already processed the quote */
1346 /* Add the whole fragment */
1347 memcpy (&tok[tok_end], p, end - p);
1353 /* We've reached the end of a token. We shouldn't still be in quotes. */
1355 fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str);
1356 free_n_strings (argv, argv_len);
1361 /* Add this token if there is one. There might not be if there was
1362 * whitespace at the end of the input string */
1364 /* Add the NULL terminator */
1365 tok[tok_len] = '\0';
1367 /* Add the argument to the argument list */
1369 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1370 if (NULL == argv_new) {
1372 free_n_strings (argv, argv_len-1);
1374 exit (EXIT_FAILURE);
1378 argv[argv_len-1] = tok;
1382 /* NULL terminate the argument list */
1384 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1385 if (NULL == argv_new) {
1387 free_n_strings (argv, argv_len-1);
1388 exit (EXIT_FAILURE);
1392 argv[argv_len-1] = NULL;
1397 #ifdef HAVE_LIBREADLINE
1398 static char histfile[1024];
1399 static int nr_history_lines = 0;
1403 initialize_readline (void)
1405 #ifdef HAVE_LIBREADLINE
1408 home = getenv ("HOME");
1410 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1412 (void) read_history (histfile);
1415 rl_readline_name = "guestfish";
1416 rl_attempted_completion_function = do_completion;
1418 /* Note that .inputrc (or /etc/inputrc) is not read until the first
1419 * call the readline(), which happens later. Therefore, these
1420 * provide default values which can be overridden by the user if
1423 (void) rl_variable_bind ("completion-ignore-case", "on");
1428 cleanup_readline (void)
1430 #ifdef HAVE_LIBREADLINE
1433 if (histfile[0] != '\0') {
1434 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1441 #ifdef HAVE_APPEND_HISTORY
1442 (void) append_history (nr_history_lines, histfile);
1444 (void) write_history (histfile);
1451 #ifdef HAVE_LIBREADLINE
1453 add_history_line (const char *line)
1461 xwrite (int fd, const void *v_buf, size_t len)
1464 const char *buf = v_buf;
1467 r = write (fd, buf, len);
1479 /* Resolve the special "win:..." form for Windows-specific paths. The
1480 * generated code calls this for all device or path arguments.
1482 * The function returns a newly allocated string, and the caller must
1483 * free this string; else display an error and return NULL.
1485 static char *win_prefix_drive_letter (char drive_letter, const char *path);
1488 win_prefix (const char *path)
1493 /* If there is not a "win:..." prefix on the path, return strdup'd string. */
1494 if (STRCASENEQLEN (path, "win:", 4)) {
1495 ret = strdup (path);
1503 /* If there is a drive letter, rewrite the path. */
1504 if (c_isalpha (path[0]) && path[1] == ':') {
1505 char drive_letter = c_tolower (path[0]);
1506 /* This returns the newly allocated string. */
1507 ret = win_prefix_drive_letter (drive_letter, path + 2);
1519 ret = strdup (path);
1526 /* Blindly convert any backslashes into forward slashes. Is this good? */
1527 for (i = 0; i < strlen (ret); ++i)
1531 char *t = guestfs_case_sensitive_path (g, ret);
1539 win_prefix_drive_letter (char drive_letter, const char *path)
1541 char **roots = NULL;
1542 char **drives = NULL;
1543 char **mountpoints = NULL;
1544 char *device, *mountpoint, *ret = NULL;
1547 /* Resolve the drive letter using the drive mappings table. */
1548 roots = guestfs_inspect_get_roots (g);
1551 if (roots[0] == NULL) {
1552 fprintf (stderr, _("%s: to use Windows drive letters, you must inspect the guest (\"-i\" option or run \"inspect-os\" command)\n"),
1556 drives = guestfs_inspect_get_drive_mappings (g, roots[0]);
1557 if (drives == NULL || drives[0] == NULL) {
1558 fprintf (stderr, _("%s: to use Windows drive letters, this must be a Windows guest\n"),
1564 for (i = 0; drives[i] != NULL; i += 2) {
1565 if (c_tolower (drives[i][0]) == drive_letter && drives[i][1] == '\0') {
1566 device = drives[i+1];
1571 if (device == NULL) {
1572 fprintf (stderr, _("%s: drive '%c:' not found. To list available drives do:\n inspect-get-drive-mappings %s\n"),
1573 program_name, drive_letter, roots[0]);
1577 /* This drive letter must be mounted somewhere (we won't do it). */
1578 mountpoints = guestfs_mountpoints (g);
1579 if (mountpoints == NULL)
1583 for (i = 0; mountpoints[i] != NULL; i += 2) {
1584 if (STREQ (mountpoints[i], device)) {
1585 mountpoint = mountpoints[i+1];
1590 if (mountpoint == NULL) {
1591 fprintf (stderr, _("%s: to access '%c:', mount %s first. One way to do this is:\n umount-all\n mount %s /\n"),
1592 program_name, drive_letter, device, device);
1596 /* Rewrite the path, eg. if C: => /c then C:/foo => /c/foo */
1597 if (asprintf (&ret, "%s%s%s",
1598 mountpoint, STRNEQ (mountpoint, "/") ? "/" : "", path) == -1) {
1599 perror ("asprintf");
1605 free_strings (roots);
1607 free_strings (drives);
1609 free_strings (mountpoints);
1614 /* Resolve the special FileIn paths ("-" or "-<<END" or filename).
1615 * The caller (cmds.c) will call free_file_in after the command has
1616 * run which should clean up resources.
1618 static char *file_in_heredoc (const char *endmarker);
1619 static char *file_in_tmpfile = NULL;
1622 file_in (const char *arg)
1626 if (STREQ (arg, "-")) {
1627 ret = strdup ("/dev/stdin");
1633 else if (STRPREFIX (arg, "-<<")) {
1634 const char *endmarker = &arg[3];
1635 if (*endmarker == '\0') {
1636 fprintf (stderr, "%s: missing end marker in -<< expression\n",
1640 ret = file_in_heredoc (endmarker);
1656 file_in_heredoc (const char *endmarker)
1658 TMP_TEMPLATE_ON_STACK (template);
1659 file_in_tmpfile = strdup (template);
1660 if (file_in_tmpfile == NULL) {
1665 int fd = mkstemp (file_in_tmpfile);
1671 size_t markerlen = strlen (endmarker);
1673 char buffer[BUFSIZ];
1674 int write_error = 0;
1675 while (fgets (buffer, sizeof buffer, stdin) != NULL) {
1676 /* Look for "END"<EOF> or "END\n" in input. */
1677 size_t blen = strlen (buffer);
1678 if (STREQLEN (buffer, endmarker, markerlen) &&
1679 (blen == markerlen ||
1680 (blen == markerlen+1 && buffer[markerlen] == '\n')))
1683 if (xwrite (fd, buffer, blen) == -1) {
1684 if (!write_error) perror ("write");
1686 /* continue reading up to the end marker */
1690 /* Reached EOF of stdin without finding the end marker, which
1691 * is likely to be an error.
1693 fprintf (stderr, "%s: end of input reached without finding '%s'\n",
1694 program_name, endmarker);
1703 if (close (fd) == -1) {
1708 return file_in_tmpfile;
1711 unlink (file_in_tmpfile);
1714 free (file_in_tmpfile);
1715 file_in_tmpfile = NULL;
1720 free_file_in (char *s)
1722 if (file_in_tmpfile) {
1723 if (unlink (file_in_tmpfile) == -1)
1724 perror (file_in_tmpfile);
1725 file_in_tmpfile = NULL;
1728 /* Free the device or file name which was strdup'd in file_in().
1729 * Note it's not immediately clear, but for -<< heredocs,
1730 * s == file_in_tmpfile, so this frees up that buffer.
1735 /* Resolve the special FileOut paths ("-" or filename).
1736 * The caller (cmds.c) will call free (str) after the command has run.
1739 file_out (const char *arg)
1743 if (STREQ (arg, "-"))
1744 ret = strdup ("/dev/stdout");
1755 /* Callback which displays a progress bar. */
1757 progress_callback (guestfs_h *g, void *data,
1758 uint64_t event, int event_handle, int flags,
1759 const char *buf, size_t buf_len,
1760 const uint64_t *array, size_t array_len)
1765 /*uint64_t proc_nr = array[0];*/
1766 /*uint64_t serial = array[1];*/
1767 uint64_t position = array[2];
1768 uint64_t total = array[3];
1770 progress_bar_set (bar, position, total);