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>
33 #ifdef HAVE_LIBREADLINE
34 #include <readline/readline.h>
35 #include <readline/history.h>
47 char *filename; /* disk filename (for -a or -N options) */
48 prep_data *data; /* prepared type (for -N option only) */
49 char *device; /* device inside the appliance */
58 static void add_drives (struct drv *drv);
59 static void prepare_drives (struct drv *drv);
60 static void mount_mps (struct mp *mp);
61 static int launch (void);
62 static void interactive (void);
63 static void shell_script (void);
64 static void script (int prompt);
65 static void cmdline (char *argv[], int optind, int argc);
66 static void initialize_readline (void);
67 static void cleanup_readline (void);
68 #ifdef HAVE_LIBREADLINE
69 static void add_history_line (const char *);
71 static void print_shell_quote (FILE *stream, const char *str);
73 /* Currently open libguestfs handle. */
79 int remote_control_listen = 0;
80 int remote_control = 0;
81 int exit_on_error = 1;
84 static void __attribute__((noreturn))
87 if (status != EXIT_SUCCESS)
88 fprintf (stderr, _("Try `%s --help' for more information.\n"),
92 _("%s: guest filesystem shell\n"
93 "%s lets you edit virtual machine filesystems\n"
94 "Copyright (C) 2009 Red Hat Inc.\n"
96 " %s [--options] cmd [: cmd : cmd ...]\n"
97 " %s -i libvirt-domain\n"
98 " %s -i disk-image(s)\n"
99 "or for interactive use:\n"
101 "or from a shell script:\n"
107 " -h|--cmd-help List available commands\n"
108 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
109 " -a|--add image Add image\n"
110 " -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
111 " -f|--file file Read commands from file\n"
112 " -i|--inspector Run virt-inspector to get disk mountpoints\n"
113 " --listen Listen for remote commands\n"
114 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
115 " -n|--no-sync Don't autosync\n"
116 " -N|--new type Create prepared disk (test1.img, ...)\n"
117 " --remote[=pid] Send commands to remote %s\n"
118 " -r|--ro Mount read-only\n"
119 " --selinux Enable SELinux support\n"
120 " -v|--verbose Verbose messages\n"
121 " -x Echo each command before executing it\n"
122 " -V|--version Display version and exit\n"
123 "For more information, see the manpage %s(1).\n"),
124 program_name, program_name, program_name,
125 program_name, program_name, program_name,
126 program_name, program_name, program_name);
132 main (int argc, char *argv[])
134 /* Set global program name that is not polluted with libtool artifacts. */
135 set_program_name (argv[0]);
137 atexit (close_stdout);
139 setlocale (LC_ALL, "");
140 bindtextdomain (PACKAGE, LOCALEBASEDIR);
141 textdomain (PACKAGE);
143 enum { HELP_OPTION = CHAR_MAX + 1 };
145 static const char *options = "a:Df:h::im:nN:rv?Vx";
146 static const struct option long_options[] = {
147 { "add", 1, 0, 'a' },
148 { "cmd-help", 2, 0, 'h' },
149 { "file", 1, 0, 'f' },
150 { "help", 0, 0, HELP_OPTION },
151 { "inspector", 0, 0, 'i' },
152 { "listen", 0, 0, 0 },
153 { "mount", 1, 0, 'm' },
154 { "new", 1, 0, 'N' },
155 { "no-dest-paths", 0, 0, 'D' },
156 { "no-sync", 0, 0, 'n' },
157 { "remote", 2, 0, 0 },
159 { "selinux", 0, 0, 0 },
160 { "verbose", 0, 0, 'v' },
161 { "version", 0, 0, 'V' },
164 struct drv *drvs = NULL;
166 struct mp *mps = NULL;
168 char *p, *file = NULL;
173 char next_drive = 'a';
174 int next_prepared_drive = 1;
176 initialize_readline ();
178 memset (&sa, 0, sizeof sa);
179 sa.sa_handler = SIG_IGN;
180 sa.sa_flags = SA_RESTART;
181 sigaction (SIGPIPE, &sa, NULL);
183 /* guestfs_create is meant to be a lightweight operation, so
184 * it's OK to do it early here.
186 g = guestfs_create ();
188 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
192 guestfs_set_autosync (g, 1);
194 /* If developing, add ./appliance to the path. Note that libtools
195 * interferes with this because uninstalled guestfish is a shell
196 * script that runs the real program with an absolute path. Detect
199 * BUT if LIBGUESTFS_PATH environment variable is already set by
200 * the user, then don't override it.
202 if (getenv ("LIBGUESTFS_PATH") == NULL &&
204 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
205 guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
207 /* CAUTION: we are careful to modify argv[0] here, only after
208 * using it just above.
210 * getopt_long uses argv[0], so give it the sanitized name. Save a copy
211 * of the original, in case it's needed in virt-inspector mode, below.
213 char *real_argv0 = argv[0];
214 argv[0] = bad_cast (program_name);
217 c = getopt_long (argc, argv, options, long_options, &option_index);
221 case 0: /* options which are long only */
222 if (STREQ (long_options[option_index].name, "listen"))
223 remote_control_listen = 1;
224 else if (STREQ (long_options[option_index].name, "remote")) {
226 if (sscanf (optarg, "%d", &remote_control) != 1) {
227 fprintf (stderr, _("%s: --listen=PID: PID was not a number: %s\n"),
228 program_name, optarg);
232 p = getenv ("GUESTFISH_PID");
233 if (!p || sscanf (p, "%d", &remote_control) != 1) {
234 fprintf (stderr, _("%s: remote: $GUESTFISH_PID must be set"
235 " to the PID of the remote process\n"),
240 } else if (STREQ (long_options[option_index].name, "selinux")) {
241 guestfs_set_selinux (g, 1);
243 fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
244 program_name, long_options[option_index].name, option_index);
250 if (access (optarg, R_OK) != 0) {
254 drv = malloc (sizeof (struct drv));
259 drv->filename = optarg;
261 /* We could fill the device field in, but in fact we
262 * only use it for the -N option at present.
271 if (STRCASEEQ (optarg, "list")) {
272 list_prepared_drives ();
275 drv = malloc (sizeof (struct drv));
280 if (asprintf (&drv->filename, "test%d.img",
281 next_prepared_drive++) == -1) {
285 drv->data = create_prepared_file (optarg, drv->filename);
286 if (asprintf (&drv->device, "/dev/sd%c", next_drive++) == -1) {
295 complete_dest_paths = 0;
300 fprintf (stderr, _("%s: only one -f parameter can be given\n"),
311 r = display_command (optarg);
312 else if (argv[optind] && argv[optind][0] != '-')
313 r = display_command (argv[optind++]);
317 exit (r == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
325 mp = malloc (sizeof (struct mp));
330 p = strchr (optarg, ':');
333 mp->mountpoint = p+1;
335 mp->mountpoint = bad_cast ("/");
342 guestfs_set_autosync (g, 0);
351 guestfs_set_verbose (g, verbose);
355 printf ("%s %s\n", program_name, PACKAGE_VERSION);
359 guestfs_set_trace (g, 1);
363 usage (EXIT_SUCCESS);
366 usage (EXIT_FAILURE);
370 /* Inspector mode invalidates most of the other arguments. */
372 if (drvs || mps || remote_control_listen || remote_control ||
373 guestfs_get_selinux (g)) {
374 fprintf (stderr, _("%s: cannot use -i option with -a, -m, -N, "
375 "--listen, --remote or --selinux\n"),
379 if (optind >= argc) {
381 _("%s: -i requires a libvirt domain or path(s) to disk image(s)\n"),
388 FILE *fp = open_memstream (&cmd, &cmdlen);
390 perror ("open_memstream");
394 fprintf (fp, "virt-inspector");
395 while (optind < argc) {
397 print_shell_quote (fp, argv[optind]);
402 fprintf (fp, " --ro-fish");
404 fprintf (fp, " --fish");
406 if (fclose (fp) == -1) {
413 "%s -i: running: %s\n", program_name, cmd);
415 FILE *pp = popen (cmd, "r");
422 fp = open_memstream (&cmd2, &cmdlen);
424 perror ("open_memstream");
428 fprintf (fp, "%s", real_argv0);
430 if (guestfs_get_verbose (g))
432 if (!guestfs_get_autosync (g))
434 if (guestfs_get_trace (g))
439 if (getline (&insp, &insplen, pp) == -1) {
443 fprintf (fp, " %s", insp);
445 if (pclose (pp) == -1) {
450 if (fclose (fp) == -1) {
457 "%s -i: running: %s\n", program_name, cmd2);
459 int r = system (cmd2);
469 exit (WEXITSTATUS (r));
472 /* If we've got drives to add, add them now. */
475 /* If we've got mountpoints or prepared drives, we must launch the
476 * guest and mount them.
478 if (next_prepared_drive > 1 || mps != NULL) {
479 /* RHBZ#612178: If --listen flag is given, then we will fork into
480 * the background in rc_listen(). However you can't do this while
481 * holding a libguestfs handle open because the recovery process
482 * will think the main program has died and kill qemu. Therefore
483 * don't use the recovery process for this case. (A better
484 * solution would be to call launch () etc after the fork, but
485 * that greatly complicates the code here).
487 if (remote_control_listen)
488 guestfs_set_recovery_proc (g, 0);
490 if (launch () == -1) exit (EXIT_FAILURE);
491 prepare_drives (drvs);
495 /* Remote control? */
496 if (remote_control_listen && remote_control) {
498 _("%s: cannot use --listen and --remote options at the same time\n"),
503 if (remote_control_listen) {
506 _("%s: extra parameters on the command line with --listen flag\n"),
512 _("%s: cannot use --listen and --file options at the same time\n"),
519 /* -f (file) parameter? */
522 if (open (file, O_RDONLY) == -1) {
528 /* Interactive, shell script, or command(s) on the command line? */
529 if (optind >= argc) {
536 cmdline (argv, optind, argc);
544 pod2text (const char *name, const char *shortdesc, const char *str)
548 fp = popen ("pod2text", "w");
550 /* pod2text failed, maybe not found, so let's just print the
551 * source instead, since that's better than doing nothing.
553 printf ("%s - %s\n\n%s\n", name, shortdesc, str);
556 fprintf (fp, "=head1 NAME\n\n%s - %s\n\n", name, shortdesc);
561 /* List is built in reverse order, so mount them in reverse order. */
563 mount_mps (struct mp *mp)
568 mount_mps (mp->next);
570 /* Don't use guestfs_mount here because that will default to mount
571 * options -o sync,noatime. For more information, see guestfs(3)
572 * section "LIBGUESTFS GOTCHAS".
574 const char *options = read_only ? "ro" : "";
575 r = guestfs_mount_options (g, options, mp->device, mp->mountpoint);
582 add_drives (struct drv *drv)
587 add_drives (drv->next);
589 if (drv->data /* -N option is not affected by --ro */ || !read_only)
590 r = guestfs_add_drive (g, drv->filename);
592 r = guestfs_add_drive_ro (g, drv->filename);
599 prepare_drives (struct drv *drv)
602 prepare_drives (drv->next);
604 prepare_drive (drv->filename, drv->data, drv->device);
611 if (guestfs_is_config (g)) {
612 if (guestfs_launch (g) == -1)
630 #define FISH "><fs> "
632 static char *line_read = NULL;
637 #ifdef HAVE_LIBREADLINE
645 line_read = readline (prompt ? FISH : "");
647 if (line_read && *line_read)
648 add_history_line (line_read);
653 #endif /* HAVE_LIBREADLINE */
655 static char buf[8192];
658 if (prompt) printf (FISH);
659 line_read = fgets (buf, sizeof buf, stdin);
662 len = strlen (line_read);
663 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
677 int global_exit_on_error = !prompt;
682 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
683 "editing virtual machine filesystems.\n"
685 "Type: 'help' for a list of commands\n"
686 " 'man' to read the manual\n"
687 " 'quit' to quit the shell\n"
693 exit_on_error = global_exit_on_error;
695 buf = rl_gets (prompt);
701 /* Skip any initial whitespace before the command. */
703 while (*buf && c_isspace (*buf))
708 /* If the next character is '#' then this is a comment. */
709 if (*buf == '#') continue;
711 /* If the next character is '!' then pass the whole lot to system(3). */
719 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
720 WEXITSTATUS (r) != 0)
726 /* If the next character is '-' allow the command to fail without
727 * exiting on error (just for this one command though).
735 /* Get the command (cannot be quoted). */
736 len = strcspn (buf, " \t");
738 if (len == 0) continue;
742 if (buf[len] == '\0') {
749 p += strspn (p, " \t");
751 /* Get the parameters. */
752 while (*p && i < sizeof argv / sizeof argv[0]) {
755 /* Parameters which start with quotes or pipes are treated
756 * specially. Bare parameters are delimited by whitespace.
760 len = strcspn (p, "\"");
761 if (p[len] == '\0') {
762 fprintf (stderr, _("%s: unterminated double quote\n"), program_name);
763 if (exit_on_error) exit (EXIT_FAILURE);
766 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
768 _("%s: command arguments not separated by whitespace\n"),
770 if (exit_on_error) exit (EXIT_FAILURE);
774 pend = p[len+1] ? &p[len+2] : &p[len+1];
775 } else if (*p == '\'') {
777 len = strcspn (p, "'");
778 if (p[len] == '\0') {
779 fprintf (stderr, _("%s: unterminated single quote\n"), program_name);
780 if (exit_on_error) exit (EXIT_FAILURE);
783 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
785 _("%s: command arguments not separated by whitespace\n"),
787 if (exit_on_error) exit (EXIT_FAILURE);
791 pend = p[len+1] ? &p[len+2] : &p[len+1];
792 } else if (*p == '|') {
797 } else if (*p == '[') {
801 while (*pend && c != 0) {
802 if (*pend == '[') c++;
803 else if (*pend == ']') c--;
808 _("%s: unterminated \"[...]\" sequence\n"), program_name);
809 if (exit_on_error) exit (EXIT_FAILURE);
812 if (*pend && (*pend != ' ' && *pend != '\t')) {
814 _("%s: command arguments not separated by whitespace\n"),
816 if (exit_on_error) exit (EXIT_FAILURE);
821 } else if (*p != ' ' && *p != '\t') {
822 /* If the first character is a ~ then note that this parameter
823 * is a candidate for ~username expansion. NB this does not
824 * apply to quoted parameters.
826 tilde_candidate = *p == '~';
827 len = strcspn (p, " \t");
834 fprintf (stderr, _("%s: internal error parsing string at '%s'\n"),
839 if (!tilde_candidate)
842 argv[i] = try_tilde_expansion (p);
847 p += strspn (p, " \t");
850 if (i == sizeof argv / sizeof argv[0]) {
851 fprintf (stderr, _("%s: too many arguments\n"), program_name);
852 if (exit_on_error) exit (EXIT_FAILURE);
859 if (issue_command (cmd, argv, pipe) == -1) {
860 if (exit_on_error) exit (EXIT_FAILURE);
865 if (prompt) printf ("\n");
869 cmdline (char *argv[], int optind, int argc)
876 if (optind >= argc) return;
878 cmd = argv[optind++];
879 if (STREQ (cmd, ":")) {
880 fprintf (stderr, _("%s: empty command on command line\n"), program_name);
884 /* Allow -cmd on the command line to mean (temporarily) override
885 * the normal exit on error (RHBZ#578407).
892 params = &argv[optind];
894 /* Search for end of command list or ":" ... */
895 while (optind < argc && STRNEQ (argv[optind], ":"))
898 if (optind == argc) {
899 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
903 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
905 cmdline (argv, optind+1, argc);
910 issue_command (const char *cmd, char *argv[], const char *pipecmd)
913 int stdout_saved_fd = -1;
917 /* This counts the commands issued, starting at 1. */
920 /* For | ... commands. Annoyingly we can't use popen(3) here. */
924 if (fflush (stdout) == EOF) {
925 perror ("failed to flush standard output");
929 perror ("pipe failed");
938 if (pid == 0) { /* Child process. */
940 if (dup2 (fd[0], 0) < 0) {
941 perror ("dup2 of stdin failed");
945 r = system (pipecmd);
950 _exit (WEXITSTATUS (r));
953 if ((stdout_saved_fd = dup (1)) < 0) {
954 perror ("failed to dup stdout");
958 if (dup2 (fd[1], 1) < 0) {
959 perror ("failed to dup stdout");
960 close (stdout_saved_fd);
966 for (argc = 0; argv[argc] != NULL; ++argc)
969 /* If --remote was set, then send this command to a remote process. */
971 r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
973 /* Otherwise execute it locally. */
974 else if (STRCASEEQ (cmd, "help")) {
979 r = display_command (argv[0]);
981 else if (STRCASEEQ (cmd, "quit") ||
982 STRCASEEQ (cmd, "exit") ||
983 STRCASEEQ (cmd, "q")) {
987 else if (STRCASEEQ (cmd, "alloc") ||
988 STRCASEEQ (cmd, "allocate"))
989 r = do_alloc (cmd, argc, argv);
990 else if (STRCASEEQ (cmd, "echo"))
991 r = do_echo (cmd, argc, argv);
992 else if (STRCASEEQ (cmd, "edit") ||
993 STRCASEEQ (cmd, "vi") ||
994 STRCASEEQ (cmd, "emacs"))
995 r = do_edit (cmd, argc, argv);
996 else if (STRCASEEQ (cmd, "lcd"))
997 r = do_lcd (cmd, argc, argv);
998 else if (STRCASEEQ (cmd, "glob"))
999 r = do_glob (cmd, argc, argv);
1000 else if (STRCASEEQ (cmd, "man") ||
1001 STRCASEEQ (cmd, "manual"))
1002 r = do_man (cmd, argc, argv);
1003 else if (STRCASEEQ (cmd, "more") ||
1004 STRCASEEQ (cmd, "less"))
1005 r = do_more (cmd, argc, argv);
1006 else if (STRCASEEQ (cmd, "reopen"))
1007 r = do_reopen (cmd, argc, argv);
1008 else if (STRCASEEQ (cmd, "sparse"))
1009 r = do_sparse (cmd, argc, argv);
1010 else if (STRCASEEQ (cmd, "supported"))
1011 r = do_supported (cmd, argc, argv);
1012 else if (STRCASEEQ (cmd, "time"))
1013 r = do_time (cmd, argc, argv);
1015 r = run_action (cmd, argc, argv);
1017 /* Always flush stdout after every command, so that messages, results
1018 * etc appear immediately.
1020 if (fflush (stdout) == EOF) {
1021 perror ("failed to flush standard output");
1027 if (dup2 (stdout_saved_fd, 1) < 0) {
1028 perror ("failed to dup2 standard output");
1031 close (stdout_saved_fd);
1032 if (waitpid (pid, NULL, 0) < 0) {
1033 perror ("waiting for command to complete");
1042 list_builtin_commands (void)
1044 /* help, man and quit should appear at the top */
1045 printf ("%-20s %s\n",
1046 "help", _("display a list of commands or help on a command"));
1047 printf ("%-20s %s\n",
1048 "man", _("read the manual"));
1049 printf ("%-20s %s\n",
1050 "quit", _("quit guestfish"));
1052 printf ("%-20s %s\n",
1053 "alloc", _("allocate an image"));
1054 printf ("%-20s %s\n",
1055 "echo", _("display a line of text"));
1056 printf ("%-20s %s\n",
1057 "edit", _("edit a file in the image"));
1058 printf ("%-20s %s\n",
1059 "lcd", _("local change directory"));
1060 printf ("%-20s %s\n",
1061 "glob", _("expand wildcards in command"));
1062 printf ("%-20s %s\n",
1063 "more", _("view a file in the pager"));
1064 printf ("%-20s %s\n",
1065 "reopen", _("close and reopen libguestfs handle"));
1066 printf ("%-20s %s\n",
1067 "sparse", _("allocate a sparse image file"));
1068 printf ("%-20s %s\n",
1069 "supported", _("list supported groups of commands"));
1070 printf ("%-20s %s\n",
1071 "time", _("measure time taken to run command"));
1073 /* actions are printed after this (see list_commands) */
1077 display_builtin_command (const char *cmd)
1079 /* help for actions is auto-generated, see display_command */
1081 if (STRCASEEQ (cmd, "alloc") ||
1082 STRCASEEQ (cmd, "allocate")) {
1083 printf (_("alloc - allocate an image\n"
1084 " alloc <filename> <size>\n"
1086 " This creates an empty (zeroed) file of the given size,\n"
1087 " and then adds so it can be further examined.\n"
1089 " For more advanced image creation, see qemu-img utility.\n"
1091 " Size can be specified using standard suffixes, eg. '1M'.\n"
1095 else if (STRCASEEQ (cmd, "echo")) {
1096 printf (_("echo - display a line of text\n"
1097 " echo [<params> ...]\n"
1099 " This echos the parameters to the terminal.\n"));
1102 else if (STRCASEEQ (cmd, "edit") ||
1103 STRCASEEQ (cmd, "vi") ||
1104 STRCASEEQ (cmd, "emacs")) {
1105 printf (_("edit - edit a file in the image\n"
1106 " edit <filename>\n"
1108 " This is used to edit a file.\n"
1110 " It is the equivalent of (and is implemented by)\n"
1111 " running \"cat\", editing locally, and then \"write\".\n"
1113 " Normally it uses $EDITOR, but if you use the aliases\n"
1114 " \"vi\" or \"emacs\" you will get those editors.\n"
1116 " NOTE: This will not work reliably for large files\n"
1117 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1120 else if (STRCASEEQ (cmd, "lcd")) {
1121 printf (_("lcd - local change directory\n"
1122 " lcd <directory>\n"
1124 " Change guestfish's current directory. This command is\n"
1125 " useful if you want to download files to a particular\n"
1129 else if (STRCASEEQ (cmd, "glob")) {
1130 printf (_("glob - expand wildcards in command\n"
1131 " glob <command> [<args> ...]\n"
1133 " Glob runs <command> with wildcards expanded in any\n"
1134 " command args. Note that the command is run repeatedly\n"
1135 " once for each expanded argument.\n"));
1138 else if (STRCASEEQ (cmd, "man") ||
1139 STRCASEEQ (cmd, "manual")) {
1140 printf (_("man - read the manual\n"
1143 " Opens the manual page for guestfish.\n"));
1146 else if (STRCASEEQ (cmd, "help")) {
1147 printf (_("help - display a list of commands or help on a command\n"
1152 else if (STRCASEEQ (cmd, "more") ||
1153 STRCASEEQ (cmd, "less")) {
1154 printf (_("more - view a file in the pager\n"
1155 " more <filename>\n"
1157 " This is used to view a file in the pager.\n"
1159 " It is the equivalent of (and is implemented by)\n"
1160 " running \"cat\" and using the pager.\n"
1162 " Normally it uses $PAGER, but if you use the alias\n"
1163 " \"less\" then it always uses \"less\".\n"
1165 " NOTE: This will not work reliably for large files\n"
1166 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1169 else if (STRCASEEQ (cmd, "quit") ||
1170 STRCASEEQ (cmd, "exit") ||
1171 STRCASEEQ (cmd, "q")) {
1172 printf (_("quit - quit guestfish\n"
1176 else if (STRCASEEQ (cmd, "reopen")) {
1177 printf (_("reopen - close and reopen the libguestfs handle\n"
1180 "Close and reopen the libguestfs handle. It is not necessary to use\n"
1181 "this normally, because the handle is closed properly when guestfish\n"
1182 "exits. However this is occasionally useful for testing.\n"));
1185 else if (STRCASEEQ (cmd, "sparse")) {
1186 printf (_("sparse - allocate a sparse image file\n"
1187 " sparse <filename> <size>\n"
1189 " This creates an empty sparse file of the given size,\n"
1190 " and then adds so it can be further examined.\n"
1192 " In all respects it works the same as the 'alloc'\n"
1193 " command, except that the image file is allocated\n"
1194 " sparsely, which means that disk blocks are not assigned\n"
1195 " to the file until they are needed. Sparse disk files\n"
1196 " only use space when written to, but they are slower\n"
1197 " and there is a danger you could run out of real disk\n"
1198 " space during a write operation.\n"
1200 " For more advanced image creation, see qemu-img utility.\n"
1202 " Size can be specified using standard suffixes, eg. '1M'.\n"
1206 else if (STRCASEEQ (cmd, "supported")) {
1207 printf (_("supported - list supported groups of commands\n"
1210 " This command returns a list of the optional groups\n"
1211 " known to the daemon, and indicates which ones are\n"
1212 " supported by this build of the libguestfs appliance.\n"
1214 " See also guestfs(3) section AVAILABILITY.\n"
1218 else if (STRCASEEQ (cmd, "time")) {
1219 printf (_("time - measure time taken to run command\n"
1220 " time <command> [<args> ...]\n"
1222 " This runs <command> as usual, and prints the elapsed\n"
1223 " time afterwards.\n"));
1227 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
1233 /* This is printed when the user types in an unknown command for the
1234 * first command issued. A common case is the user doing:
1235 * guestfish disk.img
1236 * expecting guestfish to open 'disk.img' (in fact, this tried to
1237 * run a command 'disk.img').
1240 extended_help_message (void)
1243 _("Did you mean to open a disk image? guestfish -a disk.img\n"
1244 "For a list of commands: guestfish -h\n"
1245 "For complete documentation: man guestfish\n"));
1249 free_strings (char **argv)
1253 for (argc = 0; argv[argc] != NULL; ++argc)
1259 count_strings (char *const *argv)
1263 for (c = 0; argv[c]; ++c)
1269 print_strings (char *const *argv)
1273 for (argc = 0; argv[argc] != NULL; ++argc)
1274 printf ("%s\n", argv[argc]);
1278 print_table (char *const *argv)
1282 for (i = 0; argv[i] != NULL; i += 2)
1283 printf ("%s: %s\n", argv[i], argv[i+1]);
1287 is_true (const char *str)
1290 STRCASENEQ (str, "0") &&
1291 STRCASENEQ (str, "f") &&
1292 STRCASENEQ (str, "false") &&
1293 STRCASENEQ (str, "n") &&
1294 STRCASENEQ (str, "no");
1297 /* Free strings from a non-NULL terminated char** */
1299 free_n_strings (char **str, size_t len)
1303 for (i = 0; i < len; i++) {
1310 parse_string_list (const char *str)
1313 size_t argv_len = 0;
1315 /* Current position pointer */
1316 const char *p = str;
1318 /* Token might be simple:
1321 * 'This is a single token'
1322 * or contain embedded single-quoted sections:
1323 * This' is a sing'l'e to'ken
1325 * The latter may seem over-complicated, but it's what a normal shell does.
1326 * Not doing it risks surprising somebody.
1328 * This outer loop is over complete tokens.
1334 /* Skip leading whitespace */
1335 p += strspn (p, " \t");
1339 /* This loop is over token 'fragments'. A token can be in multiple bits if
1340 * it contains single quotes. We also treat both sides of an escaped quote
1341 * as separate fragments because we can't just copy it: we have to remove
1344 while (*p && (!c_isblank (*p) || in_quote)) {
1345 const char *end = p;
1347 /* Check if the fragment starts with a quote */
1349 /* Toggle in_quote */
1350 in_quote = !in_quote;
1352 /* Skip the quote */
1356 /* If we're in a quote, look for an end quote */
1358 end += strcspn (end, "'");
1361 /* Otherwise, look for whitespace or a quote */
1363 end += strcspn (end, " \t'");
1366 /* Grow the token to accommodate the fragment */
1367 size_t tok_end = tok_len;
1369 char *tok_new = realloc (tok, tok_len + 1);
1370 if (NULL == tok_new) {
1372 free_n_strings (argv, argv_len);
1374 exit (EXIT_FAILURE);
1378 /* Check if we stopped on an escaped quote */
1379 if ('\'' == *end && end != p && *(end-1) == '\\') {
1380 /* Add everything before \' to the token */
1381 memcpy (&tok[tok_end], p, end - p - 1);
1384 tok[tok_len-1] = '\'';
1386 /* Already processed the quote */
1391 /* Add the whole fragment */
1392 memcpy (&tok[tok_end], p, end - p);
1398 /* We've reached the end of a token. We shouldn't still be in quotes. */
1400 fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str);
1402 free_n_strings (argv, argv_len);
1407 /* Add this token if there is one. There might not be if there was
1408 * whitespace at the end of the input string */
1410 /* Add the NULL terminator */
1411 tok[tok_len] = '\0';
1413 /* Add the argument to the argument list */
1415 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1416 if (NULL == argv_new) {
1418 free_n_strings (argv, argv_len-1);
1420 exit (EXIT_FAILURE);
1424 argv[argv_len-1] = tok;
1428 /* NULL terminate the argument list */
1430 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1431 if (NULL == argv_new) {
1433 free_n_strings (argv, argv_len-1);
1434 exit (EXIT_FAILURE);
1438 argv[argv_len-1] = NULL;
1443 #ifdef HAVE_LIBREADLINE
1444 static char histfile[1024];
1445 static int nr_history_lines = 0;
1449 initialize_readline (void)
1451 #ifdef HAVE_LIBREADLINE
1454 home = getenv ("HOME");
1456 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1458 (void) read_history (histfile);
1461 rl_readline_name = "guestfish";
1462 rl_attempted_completion_function = do_completion;
1464 /* Note that .inputrc (or /etc/inputrc) is not read until the first
1465 * call the readline(), which happens later. Therefore, these
1466 * provide default values which can be overridden by the user if
1469 (void) rl_variable_bind ("completion-ignore-case", "on");
1474 cleanup_readline (void)
1476 #ifdef HAVE_LIBREADLINE
1479 if (histfile[0] != '\0') {
1480 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1487 #ifdef HAVE_APPEND_HISTORY
1488 (void) append_history (nr_history_lines, histfile);
1490 (void) write_history (histfile);
1496 #ifdef HAVE_LIBREADLINE
1498 add_history_line (const char *line)
1506 xwrite (int fd, const void *v_buf, size_t len)
1509 const char *buf = v_buf;
1512 r = write (fd, buf, len);
1524 /* Resolve the special "win:..." form for Windows-specific paths.
1525 * This always returns a newly allocated string which is freed by the
1526 * caller function in "cmds.c".
1529 resolve_win_path (const char *path)
1534 if (STRCASENEQLEN (path, "win:", 4)) {
1535 ret = strdup (path);
1543 /* Drop drive letter, if it's "C:". */
1544 if (STRCASEEQLEN (path, "c:", 2))
1554 ret = strdup (path);
1560 /* Blindly convert any backslashes into forward slashes. Is this good? */
1561 for (i = 0; i < strlen (ret); ++i)
1565 char *t = guestfs_case_sensitive_path (g, ret);
1572 /* Resolve the special FileIn paths ("-" or "-<<END" or filename).
1573 * The caller (cmds.c) will call free_file_in after the command has
1574 * run which should clean up resources.
1576 static char *file_in_heredoc (const char *endmarker);
1577 static char *file_in_tmpfile = NULL;
1580 file_in (const char *arg)
1584 if (STREQ (arg, "-")) {
1585 ret = strdup ("/dev/stdin");
1591 else if (STRPREFIX (arg, "-<<")) {
1592 const char *endmarker = &arg[3];
1593 if (*endmarker == '\0') {
1594 fprintf (stderr, "%s: missing end marker in -<< expression\n",
1598 ret = file_in_heredoc (endmarker);
1614 file_in_heredoc (const char *endmarker)
1616 static const char template[] = "/tmp/heredocXXXXXX";
1617 file_in_tmpfile = strdup (template);
1618 if (file_in_tmpfile == NULL) {
1623 int fd = mkstemp (file_in_tmpfile);
1629 size_t markerlen = strlen (endmarker);
1631 char buffer[BUFSIZ];
1632 int write_error = 0;
1633 while (fgets (buffer, sizeof buffer, stdin) != NULL) {
1634 /* Look for "END"<EOF> or "END\n" in input. */
1635 size_t blen = strlen (buffer);
1636 if (STREQLEN (buffer, endmarker, markerlen) &&
1637 (blen == markerlen ||
1638 (blen == markerlen+1 && buffer[markerlen] == '\n')))
1641 if (xwrite (fd, buffer, blen) == -1) {
1642 if (!write_error) perror ("write");
1644 /* continue reading up to the end marker */
1648 /* Reached EOF of stdin without finding the end marker, which
1649 * is likely to be an error.
1651 fprintf (stderr, "%s: end of input reached without finding '%s'\n",
1652 program_name, endmarker);
1661 if (close (fd) == -1) {
1666 return file_in_tmpfile;
1669 unlink (file_in_tmpfile);
1672 free (file_in_tmpfile);
1673 file_in_tmpfile = NULL;
1678 free_file_in (char *s)
1680 if (file_in_tmpfile) {
1681 if (unlink (file_in_tmpfile) == -1)
1682 perror (file_in_tmpfile);
1683 file_in_tmpfile = NULL;
1686 /* Free the device or file name which was strdup'd in file_in().
1687 * Note it's not immediately clear, but for -<< heredocs,
1688 * s == file_in_tmpfile, so this frees up that buffer.
1693 /* Resolve the special FileOut paths ("-" or filename).
1694 * The caller (cmds.c) will call free (str) after the command has run.
1697 file_out (const char *arg)
1701 if (STREQ (arg, "-"))
1702 ret = strdup ("/dev/stdout");
1714 print_shell_quote (FILE *stream, const char *str)
1716 #define SAFE(c) (c_isalnum((c)) || \
1717 (c) == '/' || (c) == '-' || (c) == '_' || (c) == '.')
1720 for (i = 0; str[i]; ++i) {
1722 putc ('\\', stream);
1723 putc (str[i], stream);