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"),
309 display_command (optarg);
310 else if (argv[optind] && argv[optind][0] != '-')
311 display_command (argv[optind++]);
321 mp = malloc (sizeof (struct mp));
326 p = strchr (optarg, ':');
329 mp->mountpoint = p+1;
331 mp->mountpoint = bad_cast ("/");
338 guestfs_set_autosync (g, 0);
347 guestfs_set_verbose (g, verbose);
351 printf ("%s %s\n", program_name, PACKAGE_VERSION);
355 guestfs_set_trace (g, 1);
359 usage (EXIT_SUCCESS);
362 usage (EXIT_FAILURE);
366 /* Inspector mode invalidates most of the other arguments. */
368 if (drvs || mps || remote_control_listen || remote_control ||
369 guestfs_get_selinux (g)) {
370 fprintf (stderr, _("%s: cannot use -i option with -a, -m, -N, "
371 "--listen, --remote or --selinux\n"),
375 if (optind >= argc) {
377 _("%s: -i requires a libvirt domain or path(s) to disk image(s)\n"),
384 FILE *fp = open_memstream (&cmd, &cmdlen);
386 perror ("open_memstream");
390 fprintf (fp, "virt-inspector");
391 while (optind < argc) {
393 print_shell_quote (fp, argv[optind]);
398 fprintf (fp, " --ro-fish");
400 fprintf (fp, " --fish");
402 if (fclose (fp) == -1) {
409 "%s -i: running: %s\n", program_name, cmd);
411 FILE *pp = popen (cmd, "r");
418 fp = open_memstream (&cmd2, &cmdlen);
420 perror ("open_memstream");
424 fprintf (fp, "%s", real_argv0);
426 if (guestfs_get_verbose (g))
428 if (!guestfs_get_autosync (g))
430 if (guestfs_get_trace (g))
435 if (getline (&insp, &insplen, pp) == -1) {
439 fprintf (fp, " %s", insp);
441 if (pclose (pp) == -1) {
446 if (fclose (fp) == -1) {
453 "%s -i: running: %s\n", program_name, cmd2);
455 int r = system (cmd2);
465 exit (WEXITSTATUS (r));
468 /* If we've got drives to add, add them now. */
471 /* If we've got mountpoints or prepared drives, we must launch the
472 * guest and mount them.
474 if (next_prepared_drive > 1 || mps != NULL) {
475 if (launch () == -1) exit (EXIT_FAILURE);
476 prepare_drives (drvs);
480 /* Remote control? */
481 if (remote_control_listen && remote_control) {
483 _("%s: cannot use --listen and --remote options at the same time\n"),
488 if (remote_control_listen) {
491 _("%s: extra parameters on the command line with --listen flag\n"),
497 _("%s: cannot use --listen and --file options at the same time\n"),
504 /* -f (file) parameter? */
507 if (open (file, O_RDONLY) == -1) {
513 /* Interactive, shell script, or command(s) on the command line? */
514 if (optind >= argc) {
521 cmdline (argv, optind, argc);
529 pod2text (const char *name, const char *shortdesc, const char *str)
533 fp = popen ("pod2text", "w");
535 /* pod2text failed, maybe not found, so let's just print the
536 * source instead, since that's better than doing nothing.
538 printf ("%s - %s\n\n%s\n", name, shortdesc, str);
541 fprintf (fp, "=head1 NAME\n\n%s - %s\n\n", name, shortdesc);
546 /* List is built in reverse order, so mount them in reverse order. */
548 mount_mps (struct mp *mp)
553 mount_mps (mp->next);
555 /* Don't use guestfs_mount here because that will default to mount
556 * options -o sync,noatime. For more information, see guestfs(3)
557 * section "LIBGUESTFS GOTCHAS".
559 const char *options = read_only ? "ro" : "";
560 r = guestfs_mount_options (g, options, mp->device, mp->mountpoint);
567 add_drives (struct drv *drv)
572 add_drives (drv->next);
574 if (drv->data /* -N option is not affected by --ro */ || !read_only)
575 r = guestfs_add_drive (g, drv->filename);
577 r = guestfs_add_drive_ro (g, drv->filename);
584 prepare_drives (struct drv *drv)
587 prepare_drives (drv->next);
589 prepare_drive (drv->filename, drv->data, drv->device);
596 if (guestfs_is_config (g)) {
597 if (guestfs_launch (g) == -1)
615 #define FISH "><fs> "
617 static char *line_read = NULL;
622 #ifdef HAVE_LIBREADLINE
630 line_read = readline (prompt ? FISH : "");
632 if (line_read && *line_read)
633 add_history_line (line_read);
638 #endif /* HAVE_LIBREADLINE */
640 static char buf[8192];
643 if (prompt) printf (FISH);
644 line_read = fgets (buf, sizeof buf, stdin);
647 len = strlen (line_read);
648 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
662 int global_exit_on_error = !prompt;
667 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
668 "editing virtual machine filesystems.\n"
670 "Type: 'help' for a list of commands\n"
671 " 'man' to read the manual\n"
672 " 'quit' to quit the shell\n"
678 exit_on_error = global_exit_on_error;
680 buf = rl_gets (prompt);
686 /* Skip any initial whitespace before the command. */
688 while (*buf && c_isspace (*buf))
693 /* If the next character is '#' then this is a comment. */
694 if (*buf == '#') continue;
696 /* If the next character is '!' then pass the whole lot to system(3). */
704 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
705 WEXITSTATUS (r) != 0)
711 /* If the next character is '-' allow the command to fail without
712 * exiting on error (just for this one command though).
720 /* Get the command (cannot be quoted). */
721 len = strcspn (buf, " \t");
723 if (len == 0) continue;
727 if (buf[len] == '\0') {
734 p += strspn (p, " \t");
736 /* Get the parameters. */
737 while (*p && i < sizeof argv / sizeof argv[0]) {
740 /* Parameters which start with quotes or pipes are treated
741 * specially. Bare parameters are delimited by whitespace.
745 len = strcspn (p, "\"");
746 if (p[len] == '\0') {
747 fprintf (stderr, _("%s: unterminated double quote\n"), program_name);
748 if (exit_on_error) exit (EXIT_FAILURE);
751 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
753 _("%s: command arguments not separated by whitespace\n"),
755 if (exit_on_error) exit (EXIT_FAILURE);
759 pend = p[len+1] ? &p[len+2] : &p[len+1];
760 } else if (*p == '\'') {
762 len = strcspn (p, "'");
763 if (p[len] == '\0') {
764 fprintf (stderr, _("%s: unterminated single quote\n"), program_name);
765 if (exit_on_error) exit (EXIT_FAILURE);
768 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
770 _("%s: command arguments not separated by whitespace\n"),
772 if (exit_on_error) exit (EXIT_FAILURE);
776 pend = p[len+1] ? &p[len+2] : &p[len+1];
777 } else if (*p == '|') {
782 } else if (*p == '[') {
786 while (*pend && c != 0) {
787 if (*pend == '[') c++;
788 else if (*pend == ']') c--;
793 _("%s: unterminated \"[...]\" sequence\n"), program_name);
794 if (exit_on_error) exit (EXIT_FAILURE);
797 if (*pend && (*pend != ' ' && *pend != '\t')) {
799 _("%s: command arguments not separated by whitespace\n"),
801 if (exit_on_error) exit (EXIT_FAILURE);
806 } else if (*p != ' ' && *p != '\t') {
807 /* If the first character is a ~ then note that this parameter
808 * is a candidate for ~username expansion. NB this does not
809 * apply to quoted parameters.
811 tilde_candidate = *p == '~';
812 len = strcspn (p, " \t");
819 fprintf (stderr, _("%s: internal error parsing string at '%s'\n"),
824 if (!tilde_candidate)
827 argv[i] = try_tilde_expansion (p);
832 p += strspn (p, " \t");
835 if (i == sizeof argv / sizeof argv[0]) {
836 fprintf (stderr, _("%s: too many arguments\n"), program_name);
837 if (exit_on_error) exit (EXIT_FAILURE);
844 if (issue_command (cmd, argv, pipe) == -1) {
845 if (exit_on_error) exit (EXIT_FAILURE);
850 if (prompt) printf ("\n");
854 cmdline (char *argv[], int optind, int argc)
861 if (optind >= argc) return;
863 cmd = argv[optind++];
864 if (STREQ (cmd, ":")) {
865 fprintf (stderr, _("%s: empty command on command line\n"), program_name);
869 /* Allow -cmd on the command line to mean (temporarily) override
870 * the normal exit on error (RHBZ#578407).
877 params = &argv[optind];
879 /* Search for end of command list or ":" ... */
880 while (optind < argc && STRNEQ (argv[optind], ":"))
883 if (optind == argc) {
884 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
888 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
890 cmdline (argv, optind+1, argc);
895 issue_command (const char *cmd, char *argv[], const char *pipecmd)
898 int stdout_saved_fd = -1;
902 /* This counts the commands issued, starting at 1. */
905 /* For | ... commands. Annoyingly we can't use popen(3) here. */
909 if (fflush (stdout) == EOF) {
910 perror ("failed to flush standard output");
914 perror ("pipe failed");
923 if (pid == 0) { /* Child process. */
925 if (dup2 (fd[0], 0) < 0) {
926 perror ("dup2 of stdin failed");
930 r = system (pipecmd);
935 _exit (WEXITSTATUS (r));
938 if ((stdout_saved_fd = dup (1)) < 0) {
939 perror ("failed to dup stdout");
943 if (dup2 (fd[1], 1) < 0) {
944 perror ("failed to dup stdout");
945 close (stdout_saved_fd);
951 for (argc = 0; argv[argc] != NULL; ++argc)
954 /* If --remote was set, then send this command to a remote process. */
956 r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
958 /* Otherwise execute it locally. */
959 else if (STRCASEEQ (cmd, "help")) {
963 display_command (argv[0]);
966 else if (STRCASEEQ (cmd, "quit") ||
967 STRCASEEQ (cmd, "exit") ||
968 STRCASEEQ (cmd, "q")) {
972 else if (STRCASEEQ (cmd, "alloc") ||
973 STRCASEEQ (cmd, "allocate"))
974 r = do_alloc (cmd, argc, argv);
975 else if (STRCASEEQ (cmd, "echo"))
976 r = do_echo (cmd, argc, argv);
977 else if (STRCASEEQ (cmd, "edit") ||
978 STRCASEEQ (cmd, "vi") ||
979 STRCASEEQ (cmd, "emacs"))
980 r = do_edit (cmd, argc, argv);
981 else if (STRCASEEQ (cmd, "lcd"))
982 r = do_lcd (cmd, argc, argv);
983 else if (STRCASEEQ (cmd, "glob"))
984 r = do_glob (cmd, argc, argv);
985 else if (STRCASEEQ (cmd, "man") ||
986 STRCASEEQ (cmd, "manual"))
987 r = do_man (cmd, argc, argv);
988 else if (STRCASEEQ (cmd, "more") ||
989 STRCASEEQ (cmd, "less"))
990 r = do_more (cmd, argc, argv);
991 else if (STRCASEEQ (cmd, "reopen"))
992 r = do_reopen (cmd, argc, argv);
993 else if (STRCASEEQ (cmd, "sparse"))
994 r = do_sparse (cmd, argc, argv);
995 else if (STRCASEEQ (cmd, "supported"))
996 r = do_supported (cmd, argc, argv);
997 else if (STRCASEEQ (cmd, "time"))
998 r = do_time (cmd, argc, argv);
1000 r = run_action (cmd, argc, argv);
1002 /* Always flush stdout after every command, so that messages, results
1003 * etc appear immediately.
1005 if (fflush (stdout) == EOF) {
1006 perror ("failed to flush standard output");
1012 if (dup2 (stdout_saved_fd, 1) < 0) {
1013 perror ("failed to dup2 standard output");
1016 close (stdout_saved_fd);
1017 if (waitpid (pid, NULL, 0) < 0) {
1018 perror ("waiting for command to complete");
1027 list_builtin_commands (void)
1029 /* help, man and quit should appear at the top */
1030 printf ("%-20s %s\n",
1031 "help", _("display a list of commands or help on a command"));
1032 printf ("%-20s %s\n",
1033 "man", _("read the manual"));
1034 printf ("%-20s %s\n",
1035 "quit", _("quit guestfish"));
1037 printf ("%-20s %s\n",
1038 "alloc", _("allocate an image"));
1039 printf ("%-20s %s\n",
1040 "echo", _("display a line of text"));
1041 printf ("%-20s %s\n",
1042 "edit", _("edit a file in the image"));
1043 printf ("%-20s %s\n",
1044 "lcd", _("local change directory"));
1045 printf ("%-20s %s\n",
1046 "glob", _("expand wildcards in command"));
1047 printf ("%-20s %s\n",
1048 "more", _("view a file in the pager"));
1049 printf ("%-20s %s\n",
1050 "reopen", _("close and reopen libguestfs handle"));
1051 printf ("%-20s %s\n",
1052 "sparse", _("allocate a sparse image file"));
1053 printf ("%-20s %s\n",
1054 "supported", _("list supported groups of commands"));
1055 printf ("%-20s %s\n",
1056 "time", _("measure time taken to run command"));
1058 /* actions are printed after this (see list_commands) */
1062 display_builtin_command (const char *cmd)
1064 /* help for actions is auto-generated, see display_command */
1066 if (STRCASEEQ (cmd, "alloc") ||
1067 STRCASEEQ (cmd, "allocate"))
1068 printf (_("alloc - allocate an image\n"
1069 " alloc <filename> <size>\n"
1071 " This creates an empty (zeroed) file of the given size,\n"
1072 " and then adds so it can be further examined.\n"
1074 " For more advanced image creation, see qemu-img utility.\n"
1076 " Size can be specified using standard suffixes, eg. '1M'.\n"
1078 else if (STRCASEEQ (cmd, "echo"))
1079 printf (_("echo - display a line of text\n"
1080 " echo [<params> ...]\n"
1082 " This echos the parameters to the terminal.\n"));
1083 else if (STRCASEEQ (cmd, "edit") ||
1084 STRCASEEQ (cmd, "vi") ||
1085 STRCASEEQ (cmd, "emacs"))
1086 printf (_("edit - edit a file in the image\n"
1087 " edit <filename>\n"
1089 " This is used to edit a file.\n"
1091 " It is the equivalent of (and is implemented by)\n"
1092 " running \"cat\", editing locally, and then \"write\".\n"
1094 " Normally it uses $EDITOR, but if you use the aliases\n"
1095 " \"vi\" or \"emacs\" you will get those editors.\n"
1097 " NOTE: This will not work reliably for large files\n"
1098 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1099 else if (STRCASEEQ (cmd, "lcd"))
1100 printf (_("lcd - local change directory\n"
1101 " lcd <directory>\n"
1103 " Change guestfish's current directory. This command is\n"
1104 " useful if you want to download files to a particular\n"
1106 else if (STRCASEEQ (cmd, "glob"))
1107 printf (_("glob - expand wildcards in command\n"
1108 " glob <command> [<args> ...]\n"
1110 " Glob runs <command> with wildcards expanded in any\n"
1111 " command args. Note that the command is run repeatedly\n"
1112 " once for each expanded argument.\n"));
1113 else if (STRCASEEQ (cmd, "man") ||
1114 STRCASEEQ (cmd, "manual"))
1115 printf (_("man - read the manual\n"
1118 " Opens the manual page for guestfish.\n"));
1119 else if (STRCASEEQ (cmd, "help"))
1120 printf (_("help - display a list of commands or help on a command\n"
1123 else if (STRCASEEQ (cmd, "more") ||
1124 STRCASEEQ (cmd, "less"))
1125 printf (_("more - view a file in the pager\n"
1126 " more <filename>\n"
1128 " This is used to view a file in the pager.\n"
1130 " It is the equivalent of (and is implemented by)\n"
1131 " running \"cat\" and using the pager.\n"
1133 " Normally it uses $PAGER, but if you use the alias\n"
1134 " \"less\" then it always uses \"less\".\n"
1136 " NOTE: This will not work reliably for large files\n"
1137 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1138 else if (STRCASEEQ (cmd, "quit") ||
1139 STRCASEEQ (cmd, "exit") ||
1140 STRCASEEQ (cmd, "q"))
1141 printf (_("quit - quit guestfish\n"
1143 else if (STRCASEEQ (cmd, "reopen"))
1144 printf (_("reopen - close and reopen the libguestfs handle\n"
1147 "Close and reopen the libguestfs handle. It is not necessary to use\n"
1148 "this normally, because the handle is closed properly when guestfish\n"
1149 "exits. However this is occasionally useful for testing.\n"));
1150 else if (STRCASEEQ (cmd, "sparse"))
1151 printf (_("sparse - allocate a sparse image file\n"
1152 " sparse <filename> <size>\n"
1154 " This creates an empty sparse file of the given size,\n"
1155 " and then adds so it can be further examined.\n"
1157 " In all respects it works the same as the 'alloc'\n"
1158 " command, except that the image file is allocated\n"
1159 " sparsely, which means that disk blocks are not assigned\n"
1160 " to the file until they are needed. Sparse disk files\n"
1161 " only use space when written to, but they are slower\n"
1162 " and there is a danger you could run out of real disk\n"
1163 " space during a write operation.\n"
1165 " For more advanced image creation, see qemu-img utility.\n"
1167 " Size can be specified using standard suffixes, eg. '1M'.\n"
1169 else if (STRCASEEQ (cmd, "supported"))
1170 printf (_("supported - list supported groups of commands\n"
1173 " This command returns a list of the optional groups\n"
1174 " known to the daemon, and indicates which ones are\n"
1175 " supported by this build of the libguestfs appliance.\n"
1177 " See also guestfs(3) section AVAILABILITY.\n"
1179 else if (STRCASEEQ (cmd, "time"))
1180 printf (_("time - measure time taken to run command\n"
1181 " time <command> [<args> ...]\n"
1183 " This runs <command> as usual, and prints the elapsed\n"
1184 " time afterwards.\n"));
1186 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
1190 /* This is printed when the user types in an unknown command for the
1191 * first command issued. A common case is the user doing:
1192 * guestfish disk.img
1193 * expecting guestfish to open 'disk.img' (in fact, this tried to
1194 * run a command 'disk.img').
1197 extended_help_message (void)
1200 _("Did you mean to open a disk image? guestfish -a disk.img\n"
1201 "For a list of commands: guestfish -h\n"
1202 "For complete documentation: man guestfish\n"));
1206 free_strings (char **argv)
1210 for (argc = 0; argv[argc] != NULL; ++argc)
1216 count_strings (char *const *argv)
1220 for (c = 0; argv[c]; ++c)
1226 print_strings (char *const *argv)
1230 for (argc = 0; argv[argc] != NULL; ++argc)
1231 printf ("%s\n", argv[argc]);
1235 print_table (char *const *argv)
1239 for (i = 0; argv[i] != NULL; i += 2)
1240 printf ("%s: %s\n", argv[i], argv[i+1]);
1244 is_true (const char *str)
1247 STRCASENEQ (str, "0") &&
1248 STRCASENEQ (str, "f") &&
1249 STRCASENEQ (str, "false") &&
1250 STRCASENEQ (str, "n") &&
1251 STRCASENEQ (str, "no");
1254 /* Free strings from a non-NULL terminated char** */
1256 free_n_strings (char **str, size_t len)
1260 for (i = 0; i < len; i++) {
1267 parse_string_list (const char *str)
1270 size_t argv_len = 0;
1272 /* Current position pointer */
1273 const char *p = str;
1275 /* Token might be simple:
1278 * 'This is a single token'
1279 * or contain embedded single-quoted sections:
1280 * This' is a sing'l'e to'ken
1282 * The latter may seem over-complicated, but it's what a normal shell does.
1283 * Not doing it risks surprising somebody.
1285 * This outer loop is over complete tokens.
1291 /* Skip leading whitespace */
1292 p += strspn (p, " \t");
1296 /* This loop is over token 'fragments'. A token can be in multiple bits if
1297 * it contains single quotes. We also treat both sides of an escaped quote
1298 * as separate fragments because we can't just copy it: we have to remove
1301 while (*p && (!c_isblank (*p) || in_quote)) {
1302 const char *end = p;
1304 /* Check if the fragment starts with a quote */
1306 /* Toggle in_quote */
1307 in_quote = !in_quote;
1309 /* Skip the quote */
1313 /* If we're in a quote, look for an end quote */
1315 end += strcspn (end, "'");
1318 /* Otherwise, look for whitespace or a quote */
1320 end += strcspn (end, " \t'");
1323 /* Grow the token to accommodate the fragment */
1324 size_t tok_end = tok_len;
1326 char *tok_new = realloc (tok, tok_len + 1);
1327 if (NULL == tok_new) {
1329 free_n_strings (argv, argv_len);
1331 exit (EXIT_FAILURE);
1335 /* Check if we stopped on an escaped quote */
1336 if ('\'' == *end && end != p && *(end-1) == '\\') {
1337 /* Add everything before \' to the token */
1338 memcpy (&tok[tok_end], p, end - p - 1);
1341 tok[tok_len-1] = '\'';
1343 /* Already processed the quote */
1348 /* Add the whole fragment */
1349 memcpy (&tok[tok_end], p, end - p);
1355 /* We've reached the end of a token. We shouldn't still be in quotes. */
1357 fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str);
1359 free_n_strings (argv, argv_len);
1364 /* Add this token if there is one. There might not be if there was
1365 * whitespace at the end of the input string */
1367 /* Add the NULL terminator */
1368 tok[tok_len] = '\0';
1370 /* Add the argument to the argument list */
1372 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1373 if (NULL == argv_new) {
1375 free_n_strings (argv, argv_len-1);
1377 exit (EXIT_FAILURE);
1381 argv[argv_len-1] = tok;
1385 /* NULL terminate the argument list */
1387 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1388 if (NULL == argv_new) {
1390 free_n_strings (argv, argv_len-1);
1391 exit (EXIT_FAILURE);
1395 argv[argv_len-1] = NULL;
1400 #ifdef HAVE_LIBREADLINE
1401 static char histfile[1024];
1402 static int nr_history_lines = 0;
1406 initialize_readline (void)
1408 #ifdef HAVE_LIBREADLINE
1411 home = getenv ("HOME");
1413 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1415 (void) read_history (histfile);
1418 rl_readline_name = "guestfish";
1419 rl_attempted_completion_function = do_completion;
1421 /* Note that .inputrc (or /etc/inputrc) is not read until the first
1422 * call the readline(), which happens later. Therefore, these
1423 * provide default values which can be overridden by the user if
1426 (void) rl_variable_bind ("completion-ignore-case", "on");
1431 cleanup_readline (void)
1433 #ifdef HAVE_LIBREADLINE
1436 if (histfile[0] != '\0') {
1437 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1444 #ifdef HAVE_APPEND_HISTORY
1445 (void) append_history (nr_history_lines, histfile);
1447 (void) write_history (histfile);
1453 #ifdef HAVE_LIBREADLINE
1455 add_history_line (const char *line)
1463 xwrite (int fd, const void *v_buf, size_t len)
1466 const char *buf = v_buf;
1469 r = write (fd, buf, len);
1481 /* Resolve the special "win:..." form for Windows-specific paths.
1482 * This always returns a newly allocated string which is freed by the
1483 * caller function in "cmds.c".
1486 resolve_win_path (const char *path)
1491 if (STRCASENEQLEN (path, "win:", 4)) {
1492 ret = strdup (path);
1500 /* Drop drive letter, if it's "C:". */
1501 if (STRCASEEQLEN (path, "c:", 2))
1511 ret = strdup (path);
1517 /* Blindly convert any backslashes into forward slashes. Is this good? */
1518 for (i = 0; i < strlen (ret); ++i)
1522 char *t = guestfs_case_sensitive_path (g, ret);
1529 /* Resolve the special FileIn paths ("-" or "-<<END" or filename).
1530 * The caller (cmds.c) will call free_file_in after the command has
1531 * run which should clean up resources.
1533 static char *file_in_heredoc (const char *endmarker);
1534 static char *file_in_tmpfile = NULL;
1537 file_in (const char *arg)
1541 if (STREQ (arg, "-")) {
1542 ret = strdup ("/dev/stdin");
1548 else if (STRPREFIX (arg, "-<<")) {
1549 const char *endmarker = &arg[3];
1550 if (*endmarker == '\0') {
1551 fprintf (stderr, "%s: missing end marker in -<< expression\n",
1555 ret = file_in_heredoc (endmarker);
1571 file_in_heredoc (const char *endmarker)
1573 static const char template[] = "/tmp/heredocXXXXXX";
1574 file_in_tmpfile = strdup (template);
1575 if (file_in_tmpfile == NULL) {
1580 int fd = mkstemp (file_in_tmpfile);
1586 size_t markerlen = strlen (endmarker);
1588 char buffer[BUFSIZ];
1589 int write_error = 0;
1590 while (fgets (buffer, sizeof buffer, stdin) != NULL) {
1591 /* Look for "END"<EOF> or "END\n" in input. */
1592 size_t blen = strlen (buffer);
1593 if (STREQLEN (buffer, endmarker, markerlen) &&
1594 (blen == markerlen ||
1595 (blen == markerlen+1 && buffer[markerlen] == '\n')))
1598 if (xwrite (fd, buffer, blen) == -1) {
1599 if (!write_error) perror ("write");
1601 /* continue reading up to the end marker */
1605 /* Reached EOF of stdin without finding the end marker, which
1606 * is likely to be an error.
1608 fprintf (stderr, "%s: end of input reached without finding '%s'\n",
1609 program_name, endmarker);
1618 if (close (fd) == -1) {
1623 return file_in_tmpfile;
1626 unlink (file_in_tmpfile);
1629 free (file_in_tmpfile);
1630 file_in_tmpfile = NULL;
1635 free_file_in (char *s)
1637 if (file_in_tmpfile) {
1638 if (unlink (file_in_tmpfile) == -1)
1639 perror (file_in_tmpfile);
1640 file_in_tmpfile = NULL;
1643 /* Free the device or file name which was strdup'd in file_in().
1644 * Note it's not immediately clear, but for -<< heredocs,
1645 * s == file_in_tmpfile, so this frees up that buffer.
1650 /* Resolve the special FileOut paths ("-" or filename).
1651 * The caller (cmds.c) will call free (str) after the command has run.
1654 file_out (const char *arg)
1658 if (STREQ (arg, "-"))
1659 ret = strdup ("/dev/stdout");
1671 print_shell_quote (FILE *stream, const char *str)
1673 #define SAFE(c) (c_isalnum((c)) || \
1674 (c) == '/' || (c) == '-' || (c) == '_' || (c) == '.')
1677 for (i = 0; str[i]; ++i) {
1679 putc ('\\', stream);
1680 putc (str[i], stream);