1 /* guestfish - the filesystem interactive shell
2 * Copyright (C) 2009 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 static void add_history_line (const char *);
70 /* Currently open libguestfs handle. */
76 int remote_control_listen = 0;
77 int remote_control = 0;
78 int exit_on_error = 1;
81 static void __attribute__((noreturn))
84 if (status != EXIT_SUCCESS)
85 fprintf (stderr, _("Try `%s --help' for more information.\n"),
89 _("%s: guest filesystem shell\n"
90 "%s lets you edit virtual machine filesystems\n"
91 "Copyright (C) 2009 Red Hat Inc.\n"
93 " %s [--options] cmd [: cmd : cmd ...]\n"
94 " %s -i libvirt-domain\n"
95 " %s -i disk-image(s)\n"
96 "or for interactive use:\n"
98 "or from a shell script:\n"
104 " -h|--cmd-help List available commands\n"
105 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
106 " -a|--add image Add image\n"
107 " -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
108 " -f|--file file Read commands from file\n"
109 " -i|--inspector Run virt-inspector to get disk mountpoints\n"
110 " --listen Listen for remote commands\n"
111 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
112 " -n|--no-sync Don't autosync\n"
113 " -N|--new type Create prepared disk (test1.img, ...)\n"
114 " --remote[=pid] Send commands to remote %s\n"
115 " -r|--ro Mount read-only\n"
116 " --selinux Enable SELinux support\n"
117 " -v|--verbose Verbose messages\n"
118 " -x Echo each command before executing it\n"
119 " -V|--version Display version and exit\n"
120 "For more information, see the manpage %s(1).\n"),
121 program_name, program_name, program_name,
122 program_name, program_name, program_name,
123 program_name, program_name, program_name);
129 main (int argc, char *argv[])
131 /* Set global program name that is not polluted with libtool artifacts. */
132 set_program_name (argv[0]);
134 atexit (close_stdout);
136 setlocale (LC_ALL, "");
137 bindtextdomain (PACKAGE, LOCALEBASEDIR);
138 textdomain (PACKAGE);
140 enum { HELP_OPTION = CHAR_MAX + 1 };
142 static const char *options = "a:Df:h::im:nN:rv?Vx";
143 static const struct option long_options[] = {
144 { "add", 1, 0, 'a' },
145 { "cmd-help", 2, 0, 'h' },
146 { "file", 1, 0, 'f' },
147 { "help", 0, 0, HELP_OPTION },
148 { "inspector", 0, 0, 'i' },
149 { "listen", 0, 0, 0 },
150 { "mount", 1, 0, 'm' },
151 { "new", 1, 0, 'N' },
152 { "no-dest-paths", 0, 0, 'D' },
153 { "no-sync", 0, 0, 'n' },
154 { "remote", 2, 0, 0 },
156 { "selinux", 0, 0, 0 },
157 { "verbose", 0, 0, 'v' },
158 { "version", 0, 0, 'V' },
161 struct drv *drvs = NULL;
163 struct mp *mps = NULL;
165 char *p, *file = NULL;
170 char next_drive = 'a';
171 int next_prepared_drive = 1;
173 initialize_readline ();
175 memset (&sa, 0, sizeof sa);
176 sa.sa_handler = SIG_IGN;
177 sa.sa_flags = SA_RESTART;
178 sigaction (SIGPIPE, &sa, NULL);
180 /* guestfs_create is meant to be a lightweight operation, so
181 * it's OK to do it early here.
183 g = guestfs_create ();
185 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
189 guestfs_set_autosync (g, 1);
191 /* If developing, add ./appliance to the path. Note that libtools
192 * interferes with this because uninstalled guestfish is a shell
193 * script that runs the real program with an absolute path. Detect
196 * BUT if LIBGUESTFS_PATH environment variable is already set by
197 * the user, then don't override it.
199 if (getenv ("LIBGUESTFS_PATH") == NULL &&
201 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
202 guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
204 /* CAUTION: we are careful to modify argv[0] here, only after
205 * using it just above.
207 * getopt_long uses argv[0], so give it the sanitized name. Save a copy
208 * of the original, in case it's needed in virt-inspector mode, below.
210 char *real_argv0 = argv[0];
211 argv[0] = bad_cast (program_name);
214 c = getopt_long (argc, argv, options, long_options, &option_index);
218 case 0: /* options which are long only */
219 if (STREQ (long_options[option_index].name, "listen"))
220 remote_control_listen = 1;
221 else if (STREQ (long_options[option_index].name, "remote")) {
223 if (sscanf (optarg, "%d", &remote_control) != 1) {
224 fprintf (stderr, _("%s: --listen=PID: PID was not a number: %s\n"),
225 program_name, optarg);
229 p = getenv ("GUESTFISH_PID");
230 if (!p || sscanf (p, "%d", &remote_control) != 1) {
231 fprintf (stderr, _("%s: remote: $GUESTFISH_PID must be set"
232 " to the PID of the remote process\n"),
237 } else if (STREQ (long_options[option_index].name, "selinux")) {
238 guestfs_set_selinux (g, 1);
240 fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
241 program_name, long_options[option_index].name, option_index);
247 if (access (optarg, R_OK) != 0) {
251 drv = malloc (sizeof (struct drv));
256 drv->filename = optarg;
258 /* We could fill the device field in, but in fact we
259 * only use it for the -N option at present.
268 if (STRCASEEQ (optarg, "list")) {
269 list_prepared_drives ();
272 drv = malloc (sizeof (struct drv));
277 if (asprintf (&drv->filename, "test%d.img",
278 next_prepared_drive++) == -1) {
282 drv->data = create_prepared_file (optarg, drv->filename);
283 if (asprintf (&drv->device, "/dev/sd%c", next_drive++) == -1) {
292 complete_dest_paths = 0;
297 fprintf (stderr, _("%s: only one -f parameter can be given\n"),
306 display_command (optarg);
307 else if (argv[optind] && argv[optind][0] != '-')
308 display_command (argv[optind++]);
318 mp = malloc (sizeof (struct mp));
323 p = strchr (optarg, ':');
326 mp->mountpoint = p+1;
328 mp->mountpoint = bad_cast ("/");
335 guestfs_set_autosync (g, 0);
344 guestfs_set_verbose (g, verbose);
348 printf ("%s %s\n", program_name, PACKAGE_VERSION);
352 guestfs_set_trace (g, 1);
356 usage (EXIT_SUCCESS);
359 usage (EXIT_FAILURE);
363 /* 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"),
382 strcpy (cmd, "a=`virt-inspector");
383 while (optind < argc) {
384 if (strlen (cmd) + strlen (argv[optind]) + strlen (real_argv0) + 60
387 _("%s: virt-inspector command too long for fixed-size buffer\n"),
392 strcat (cmd, argv[optind]);
398 strcat (cmd, " --ro-fish");
400 strcat (cmd, " --fish");
402 sprintf (&cmd[strlen(cmd)], "` && %s $a", real_argv0);
404 if (guestfs_get_verbose (g))
406 if (!guestfs_get_autosync (g))
411 "%s -i: running virt-inspector command:\n%s\n", program_name, cmd);
418 exit (WEXITSTATUS (r));
421 /* If we've got drives to add, add them now. */
424 /* If we've got mountpoints or prepared drives, we must launch the
425 * guest and mount them.
427 if (next_prepared_drive > 1 || mps != NULL) {
428 if (launch () == -1) exit (EXIT_FAILURE);
429 prepare_drives (drvs);
433 /* Remote control? */
434 if (remote_control_listen && remote_control) {
436 _("%s: cannot use --listen and --remote options at the same time\n"),
441 if (remote_control_listen) {
444 _("%s: extra parameters on the command line with --listen flag\n"),
450 _("%s: cannot use --listen and --file options at the same time\n"),
457 /* -f (file) parameter? */
460 if (open (file, O_RDONLY) == -1) {
466 /* Interactive, shell script, or command(s) on the command line? */
467 if (optind >= argc) {
474 cmdline (argv, optind, argc);
482 pod2text (const char *name, const char *shortdesc, const char *str)
486 fp = popen ("pod2text", "w");
488 /* pod2text failed, maybe not found, so let's just print the
489 * source instead, since that's better than doing nothing.
491 printf ("%s - %s\n\n%s\n", name, shortdesc, str);
494 fprintf (fp, "=head1 NAME\n\n%s - %s\n\n", name, shortdesc);
499 /* List is built in reverse order, so mount them in reverse order. */
501 mount_mps (struct mp *mp)
506 mount_mps (mp->next);
508 /* Don't use guestfs_mount here because that will default to mount
509 * options -o sync,noatime. For more information, see guestfs(3)
510 * section "LIBGUESTFS GOTCHAS".
512 const char *options = read_only ? "ro" : "";
513 r = guestfs_mount_options (g, options, mp->device, mp->mountpoint);
520 add_drives (struct drv *drv)
525 add_drives (drv->next);
527 if (drv->data /* -N option is not affected by --ro */ || !read_only)
528 r = guestfs_add_drive (g, drv->filename);
530 r = guestfs_add_drive_ro (g, drv->filename);
537 prepare_drives (struct drv *drv)
540 prepare_drives (drv->next);
542 prepare_drive (drv->filename, drv->data, drv->device);
549 if (guestfs_is_config (g)) {
550 if (guestfs_launch (g) == -1)
568 #define FISH "><fs> "
570 static char *line_read = NULL;
575 #ifdef HAVE_LIBREADLINE
583 line_read = readline (prompt ? FISH : "");
585 if (line_read && *line_read)
586 add_history_line (line_read);
591 #endif /* HAVE_LIBREADLINE */
593 static char buf[8192];
596 if (prompt) printf (FISH);
597 line_read = fgets (buf, sizeof buf, stdin);
600 len = strlen (line_read);
601 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
615 int global_exit_on_error = !prompt;
620 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
621 "editing virtual machine filesystems.\n"
623 "Type: 'help' for a list of commands\n"
624 " 'man' to read the manual\n"
625 " 'quit' to quit the shell\n"
631 exit_on_error = global_exit_on_error;
633 buf = rl_gets (prompt);
639 /* Skip any initial whitespace before the command. */
641 while (*buf && c_isspace (*buf))
646 /* If the next character is '#' then this is a comment. */
647 if (*buf == '#') continue;
649 /* If the next character is '!' then pass the whole lot to system(3). */
657 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
658 WEXITSTATUS (r) != 0)
664 /* If the next character is '-' allow the command to fail without
665 * exiting on error (just for this one command though).
673 /* Get the command (cannot be quoted). */
674 len = strcspn (buf, " \t");
676 if (len == 0) continue;
680 if (buf[len] == '\0') {
687 p += strspn (p, " \t");
689 /* Get the parameters. */
690 while (*p && i < sizeof argv / sizeof argv[0]) {
693 /* Parameters which start with quotes or pipes are treated
694 * specially. Bare parameters are delimited by whitespace.
698 len = strcspn (p, "\"");
699 if (p[len] == '\0') {
700 fprintf (stderr, _("%s: unterminated double quote\n"), program_name);
701 if (exit_on_error) exit (EXIT_FAILURE);
704 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
706 _("%s: command arguments not separated by whitespace\n"),
708 if (exit_on_error) exit (EXIT_FAILURE);
712 pend = p[len+1] ? &p[len+2] : &p[len+1];
713 } else if (*p == '\'') {
715 len = strcspn (p, "'");
716 if (p[len] == '\0') {
717 fprintf (stderr, _("%s: unterminated single quote\n"), program_name);
718 if (exit_on_error) exit (EXIT_FAILURE);
721 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
723 _("%s: command arguments not separated by whitespace\n"),
725 if (exit_on_error) exit (EXIT_FAILURE);
729 pend = p[len+1] ? &p[len+2] : &p[len+1];
730 } else if (*p == '|') {
735 } else if (*p == '[') {
739 while (*pend && c != 0) {
740 if (*pend == '[') c++;
741 else if (*pend == ']') c--;
746 _("%s: unterminated \"[...]\" sequence\n"), program_name);
747 if (exit_on_error) exit (EXIT_FAILURE);
750 if (*pend && (*pend != ' ' && *pend != '\t')) {
752 _("%s: command arguments not separated by whitespace\n"),
754 if (exit_on_error) exit (EXIT_FAILURE);
759 } else if (*p != ' ' && *p != '\t') {
760 /* If the first character is a ~ then note that this parameter
761 * is a candidate for ~username expansion. NB this does not
762 * apply to quoted parameters.
764 tilde_candidate = *p == '~';
765 len = strcspn (p, " \t");
772 fprintf (stderr, _("%s: internal error parsing string at '%s'\n"),
777 if (!tilde_candidate)
780 argv[i] = try_tilde_expansion (p);
785 p += strspn (p, " \t");
788 if (i == sizeof argv / sizeof argv[0]) {
789 fprintf (stderr, _("%s: too many arguments\n"), program_name);
790 if (exit_on_error) exit (EXIT_FAILURE);
797 if (issue_command (cmd, argv, pipe) == -1) {
798 if (exit_on_error) exit (EXIT_FAILURE);
803 if (prompt) printf ("\n");
807 cmdline (char *argv[], int optind, int argc)
814 if (optind >= argc) return;
816 cmd = argv[optind++];
817 if (STREQ (cmd, ":")) {
818 fprintf (stderr, _("%s: empty command on command line\n"), program_name);
822 /* Allow -cmd on the command line to mean (temporarily) override
823 * the normal exit on error (RHBZ#578407).
830 params = &argv[optind];
832 /* Search for end of command list or ":" ... */
833 while (optind < argc && STRNEQ (argv[optind], ":"))
836 if (optind == argc) {
837 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
841 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
843 cmdline (argv, optind+1, argc);
848 issue_command (const char *cmd, char *argv[], const char *pipecmd)
851 int stdout_saved_fd = -1;
855 /* This counts the commands issued, starting at 1. */
858 /* For | ... commands. Annoyingly we can't use popen(3) here. */
862 if (fflush (stdout) == EOF) {
863 perror ("failed to flush standard output");
867 perror ("pipe failed");
876 if (pid == 0) { /* Child process. */
878 if (dup2 (fd[0], 0) < 0) {
879 perror ("dup2 of stdin failed");
883 r = system (pipecmd);
888 _exit (WEXITSTATUS (r));
891 if ((stdout_saved_fd = dup (1)) < 0) {
892 perror ("failed to dup stdout");
896 if (dup2 (fd[1], 1) < 0) {
897 perror ("failed to dup stdout");
898 close (stdout_saved_fd);
904 for (argc = 0; argv[argc] != NULL; ++argc)
907 /* If --remote was set, then send this command to a remote process. */
909 r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
911 /* Otherwise execute it locally. */
912 else if (STRCASEEQ (cmd, "help")) {
916 display_command (argv[0]);
919 else if (STRCASEEQ (cmd, "quit") ||
920 STRCASEEQ (cmd, "exit") ||
921 STRCASEEQ (cmd, "q")) {
925 else if (STRCASEEQ (cmd, "alloc") ||
926 STRCASEEQ (cmd, "allocate"))
927 r = do_alloc (cmd, argc, argv);
928 else if (STRCASEEQ (cmd, "echo"))
929 r = do_echo (cmd, argc, argv);
930 else if (STRCASEEQ (cmd, "edit") ||
931 STRCASEEQ (cmd, "vi") ||
932 STRCASEEQ (cmd, "emacs"))
933 r = do_edit (cmd, argc, argv);
934 else if (STRCASEEQ (cmd, "lcd"))
935 r = do_lcd (cmd, argc, argv);
936 else if (STRCASEEQ (cmd, "glob"))
937 r = do_glob (cmd, argc, argv);
938 else if (STRCASEEQ (cmd, "man") ||
939 STRCASEEQ (cmd, "manual"))
940 r = do_man (cmd, argc, argv);
941 else if (STRCASEEQ (cmd, "more") ||
942 STRCASEEQ (cmd, "less"))
943 r = do_more (cmd, argc, argv);
944 else if (STRCASEEQ (cmd, "reopen"))
945 r = do_reopen (cmd, argc, argv);
946 else if (STRCASEEQ (cmd, "sparse"))
947 r = do_sparse (cmd, argc, argv);
948 else if (STRCASEEQ (cmd, "time"))
949 r = do_time (cmd, argc, argv);
951 r = run_action (cmd, argc, argv);
953 /* Always flush stdout after every command, so that messages, results
954 * etc appear immediately.
956 if (fflush (stdout) == EOF) {
957 perror ("failed to flush standard output");
963 if (dup2 (stdout_saved_fd, 1) < 0) {
964 perror ("failed to dup2 standard output");
967 close (stdout_saved_fd);
968 if (waitpid (pid, NULL, 0) < 0) {
969 perror ("waiting for command to complete");
978 list_builtin_commands (void)
980 /* help, man and quit should appear at the top */
981 printf ("%-20s %s\n",
982 "help", _("display a list of commands or help on a command"));
983 printf ("%-20s %s\n",
984 "man", _("read the manual"));
985 printf ("%-20s %s\n",
986 "quit", _("quit guestfish"));
988 printf ("%-20s %s\n",
989 "alloc", _("allocate an image"));
990 printf ("%-20s %s\n",
991 "echo", _("display a line of text"));
992 printf ("%-20s %s\n",
993 "edit", _("edit a file in the image"));
994 printf ("%-20s %s\n",
995 "lcd", _("local change directory"));
996 printf ("%-20s %s\n",
997 "glob", _("expand wildcards in command"));
998 printf ("%-20s %s\n",
999 "more", _("view a file in the pager"));
1000 printf ("%-20s %s\n",
1001 "reopen", _("close and reopen libguestfs handle"));
1002 printf ("%-20s %s\n",
1003 "sparse", _("allocate a sparse image file"));
1004 printf ("%-20s %s\n",
1005 "time", _("measure time taken to run command"));
1007 /* actions are printed after this (see list_commands) */
1011 display_builtin_command (const char *cmd)
1013 /* help for actions is auto-generated, see display_command */
1015 if (STRCASEEQ (cmd, "alloc") ||
1016 STRCASEEQ (cmd, "allocate"))
1017 printf (_("alloc - allocate an image\n"
1018 " alloc <filename> <size>\n"
1020 " This creates an empty (zeroed) file of the given size,\n"
1021 " and then adds so it can be further examined.\n"
1023 " For more advanced image creation, see qemu-img utility.\n"
1025 " Size can be specified (where <nn> means a number):\n"
1026 " <nn> number of kilobytes\n"
1027 " eg: 1440 standard 3.5\" floppy\n"
1028 " <nn>K or <nn>KB number of kilobytes\n"
1029 " <nn>M or <nn>MB number of megabytes\n"
1030 " <nn>G or <nn>GB number of gigabytes\n"
1031 " <nn>T or <nn>TB number of terabytes\n"
1032 " <nn>P or <nn>PB number of petabytes\n"
1033 " <nn>E or <nn>EB number of exabytes\n"
1034 " <nn>sects number of 512 byte sectors\n"));
1035 else if (STRCASEEQ (cmd, "echo"))
1036 printf (_("echo - display a line of text\n"
1037 " echo [<params> ...]\n"
1039 " This echos the parameters to the terminal.\n"));
1040 else if (STRCASEEQ (cmd, "edit") ||
1041 STRCASEEQ (cmd, "vi") ||
1042 STRCASEEQ (cmd, "emacs"))
1043 printf (_("edit - edit a file in the image\n"
1044 " edit <filename>\n"
1046 " This is used to edit a file.\n"
1048 " It is the equivalent of (and is implemented by)\n"
1049 " running \"cat\", editing locally, and then \"write-file\".\n"
1051 " Normally it uses $EDITOR, but if you use the aliases\n"
1052 " \"vi\" or \"emacs\" you will get those editors.\n"
1054 " NOTE: This will not work reliably for large files\n"
1055 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1056 else if (STRCASEEQ (cmd, "lcd"))
1057 printf (_("lcd - local change directory\n"
1058 " lcd <directory>\n"
1060 " Change guestfish's current directory. This command is\n"
1061 " useful if you want to download files to a particular\n"
1063 else if (STRCASEEQ (cmd, "glob"))
1064 printf (_("glob - expand wildcards in command\n"
1065 " glob <command> [<args> ...]\n"
1067 " Glob runs <command> with wildcards expanded in any\n"
1068 " command args. Note that the command is run repeatedly\n"
1069 " once for each expanded argument.\n"));
1070 else if (STRCASEEQ (cmd, "man") ||
1071 STRCASEEQ (cmd, "manual"))
1072 printf (_("man - read the manual\n"
1075 " Opens the manual page for guestfish.\n"));
1076 else if (STRCASEEQ (cmd, "help"))
1077 printf (_("help - display a list of commands or help on a command\n"
1080 else if (STRCASEEQ (cmd, "more") ||
1081 STRCASEEQ (cmd, "less"))
1082 printf (_("more - view a file in the pager\n"
1083 " more <filename>\n"
1085 " This is used to view a file in the pager.\n"
1087 " It is the equivalent of (and is implemented by)\n"
1088 " running \"cat\" and using the pager.\n"
1090 " Normally it uses $PAGER, but if you use the alias\n"
1091 " \"less\" then it always uses \"less\".\n"
1093 " NOTE: This will not work reliably for large files\n"
1094 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1095 else if (STRCASEEQ (cmd, "quit") ||
1096 STRCASEEQ (cmd, "exit") ||
1097 STRCASEEQ (cmd, "q"))
1098 printf (_("quit - quit guestfish\n"
1100 else if (STRCASEEQ (cmd, "reopen"))
1101 printf (_("reopen - close and reopen the libguestfs handle\n"
1104 "Close and reopen the libguestfs handle. It is not necessary to use\n"
1105 "this normally, because the handle is closed properly when guestfish\n"
1106 "exits. However this is occasionally useful for testing.\n"));
1107 else if (STRCASEEQ (cmd, "sparse"))
1108 printf (_("sparse - allocate a sparse image file\n"
1109 " sparse <filename> <size>\n"
1111 " This creates an empty sparse file of the given size,\n"
1112 " and then adds so it can be further examined.\n"
1114 " In all respects it works the same as the 'alloc'\n"
1115 " command, except that the image file is allocated\n"
1116 " sparsely, which means that disk blocks are not assigned\n"
1117 " to the file until they are needed. Sparse disk files\n"
1118 " only use space when written to, but they are slower\n"
1119 " and there is a danger you could run out of real disk\n"
1120 " space during a write operation.\n"
1122 " For more advanced image creation, see qemu-img utility.\n"
1124 " Size can be specified (where <nn> means a number):\n"
1125 " <nn> number of kilobytes\n"
1126 " eg: 1440 standard 3.5\" floppy\n"
1127 " <nn>K or <nn>KB number of kilobytes\n"
1128 " <nn>M or <nn>MB number of megabytes\n"
1129 " <nn>G or <nn>GB number of gigabytes\n"
1130 " <nn>T or <nn>TB number of terabytes\n"
1131 " <nn>P or <nn>PB number of petabytes\n"
1132 " <nn>E or <nn>EB number of exabytes\n"
1133 " <nn>sects number of 512 byte sectors\n"));
1134 else if (STRCASEEQ (cmd, "time"))
1135 printf (_("time - measure time taken to run command\n"
1136 " time <command> [<args> ...]\n"
1138 " This runs <command> as usual, and prints the elapsed\n"
1139 " time afterwards.\n"));
1141 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
1145 /* This is printed when the user types in an unknown command for the
1146 * first command issued. A common case is the user doing:
1147 * guestfish disk.img
1148 * expecting guestfish to open 'disk.img' (in fact, this tried to
1149 * run a command 'disk.img').
1152 extended_help_message (void)
1155 _("Did you mean to open a disk image? guestfish -a disk.img\n"
1156 "For a list of commands: guestfish -h\n"
1157 "For complete documentation: man guestfish\n"));
1161 free_strings (char **argv)
1165 for (argc = 0; argv[argc] != NULL; ++argc)
1171 count_strings (char *const *argv)
1175 for (c = 0; argv[c]; ++c)
1181 print_strings (char *const *argv)
1185 for (argc = 0; argv[argc] != NULL; ++argc)
1186 printf ("%s\n", argv[argc]);
1190 print_table (char *const *argv)
1194 for (i = 0; argv[i] != NULL; i += 2)
1195 printf ("%s: %s\n", argv[i], argv[i+1]);
1199 is_true (const char *str)
1202 STRCASENEQ (str, "0") &&
1203 STRCASENEQ (str, "f") &&
1204 STRCASENEQ (str, "false") &&
1205 STRCASENEQ (str, "n") &&
1206 STRCASENEQ (str, "no");
1209 /* Free strings from a non-NULL terminated char** */
1211 free_n_strings (char **str, size_t len)
1215 for (i = 0; i < len; i++) {
1222 parse_string_list (const char *str)
1225 size_t argv_len = 0;
1227 /* Current position pointer */
1228 const char *p = str;
1230 /* Token might be simple:
1233 * 'This is a single token'
1234 * or contain embedded single-quoted sections:
1235 * This' is a sing'l'e to'ken
1237 * The latter may seem over-complicated, but it's what a normal shell does.
1238 * Not doing it risks surprising somebody.
1240 * This outer loop is over complete tokens.
1246 /* Skip leading whitespace */
1247 p += strspn (p, " \t");
1251 /* This loop is over token 'fragments'. A token can be in multiple bits if
1252 * it contains single quotes. We also treat both sides of an escaped quote
1253 * as separate fragments because we can't just copy it: we have to remove
1256 while (*p && (!c_isblank (*p) || in_quote)) {
1257 const char *end = p;
1259 /* Check if the fragment starts with a quote */
1261 /* Toggle in_quote */
1262 in_quote = !in_quote;
1264 /* Skip the quote */
1268 /* If we're in a quote, look for an end quote */
1270 end += strcspn (end, "'");
1273 /* Otherwise, look for whitespace or a quote */
1275 end += strcspn (end, " \t'");
1278 /* Grow the token to accommodate the fragment */
1279 size_t tok_end = tok_len;
1281 char *tok_new = realloc (tok, tok_len + 1);
1282 if (NULL == tok_new) {
1284 free_n_strings (argv, argv_len);
1286 exit (EXIT_FAILURE);
1290 /* Check if we stopped on an escaped quote */
1291 if ('\'' == *end && end != p && *(end-1) == '\\') {
1292 /* Add everything before \' to the token */
1293 memcpy (&tok[tok_end], p, end - p - 1);
1296 tok[tok_len-1] = '\'';
1298 /* Already processed the quote */
1303 /* Add the whole fragment */
1304 memcpy (&tok[tok_end], p, end - p);
1310 /* We've reached the end of a token. We shouldn't still be in quotes. */
1312 fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str);
1314 free_n_strings (argv, argv_len);
1319 /* Add this token if there is one. There might not be if there was
1320 * whitespace at the end of the input string */
1322 /* Add the NULL terminator */
1323 tok[tok_len] = '\0';
1325 /* Add the argument to the argument list */
1327 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1328 if (NULL == argv_new) {
1330 free_n_strings (argv, argv_len-1);
1332 exit (EXIT_FAILURE);
1336 argv[argv_len-1] = tok;
1340 /* NULL terminate the argument list */
1342 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1343 if (NULL == argv_new) {
1345 free_n_strings (argv, argv_len-1);
1346 exit (EXIT_FAILURE);
1350 argv[argv_len-1] = NULL;
1355 #ifdef HAVE_LIBREADLINE
1356 static char histfile[1024];
1357 static int nr_history_lines = 0;
1361 initialize_readline (void)
1363 #ifdef HAVE_LIBREADLINE
1366 home = getenv ("HOME");
1368 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1370 (void) read_history (histfile);
1373 rl_readline_name = "guestfish";
1374 rl_attempted_completion_function = do_completion;
1379 cleanup_readline (void)
1381 #ifdef HAVE_LIBREADLINE
1384 if (histfile[0] != '\0') {
1385 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1392 #ifdef HAVE_APPEND_HISTORY
1393 (void) append_history (nr_history_lines, histfile);
1395 (void) write_history (histfile);
1402 add_history_line (const char *line)
1404 #ifdef HAVE_LIBREADLINE
1411 xwrite (int fd, const void *v_buf, size_t len)
1414 const char *buf = v_buf;
1417 r = write (fd, buf, len);
1429 /* Resolve the special "win:..." form for Windows-specific paths.
1430 * This always returns a newly allocated string which is freed by the
1431 * caller function in "cmds.c".
1434 resolve_win_path (const char *path)
1439 if (STRCASENEQLEN (path, "win:", 4)) {
1440 ret = strdup (path);
1448 /* Drop drive letter, if it's "C:". */
1449 if (STRCASEEQLEN (path, "c:", 2))
1459 ret = strdup (path);
1465 /* Blindly convert any backslashes into forward slashes. Is this good? */
1466 for (i = 0; i < strlen (ret); ++i)
1470 char *t = guestfs_case_sensitive_path (g, ret);
1477 /* Resolve the special FileIn paths ("-" or "-<<END" or filename).
1478 * The caller (cmds.c) will call free_file_in after the command has
1479 * run which should clean up resources.
1481 static char *file_in_heredoc (const char *endmarker);
1482 static char *file_in_tmpfile = NULL;
1485 file_in (const char *arg)
1489 if (STREQ (arg, "-")) {
1490 ret = strdup ("/dev/stdin");
1496 else if (STRPREFIX (arg, "-<<")) {
1497 const char *endmarker = &arg[3];
1498 if (*endmarker == '\0') {
1499 fprintf (stderr, "%s: missing end marker in -<< expression\n",
1503 ret = file_in_heredoc (endmarker);
1519 file_in_heredoc (const char *endmarker)
1521 static const char template[] = "/tmp/heredocXXXXXX";
1522 file_in_tmpfile = strdup (template);
1523 if (file_in_tmpfile == NULL) {
1528 int fd = mkstemp (file_in_tmpfile);
1534 size_t markerlen = strlen (endmarker);
1536 char buffer[BUFSIZ];
1537 int write_error = 0;
1538 while (fgets (buffer, sizeof buffer, stdin) != NULL) {
1539 /* Look for "END"<EOF> or "END\n" in input. */
1540 size_t blen = strlen (buffer);
1541 if (STREQLEN (buffer, endmarker, markerlen) &&
1542 (blen == markerlen ||
1543 (blen == markerlen+1 && buffer[markerlen] == '\n')))
1546 if (xwrite (fd, buffer, blen) == -1) {
1547 if (!write_error) perror ("write");
1549 /* continue reading up to the end marker */
1553 /* Reached EOF of stdin without finding the end marker, which
1554 * is likely to be an error.
1556 fprintf (stderr, "%s: end of input reached without finding '%s'\n",
1557 program_name, endmarker);
1566 if (close (fd) == -1) {
1571 return file_in_tmpfile;
1574 unlink (file_in_tmpfile);
1577 free (file_in_tmpfile);
1578 file_in_tmpfile = NULL;
1583 free_file_in (char *s)
1585 if (file_in_tmpfile) {
1586 if (unlink (file_in_tmpfile) == -1)
1587 perror (file_in_tmpfile);
1588 file_in_tmpfile = NULL;
1591 /* Free the device or file name which was strdup'd in file_in().
1592 * Note it's not immediately clear, but for -<< heredocs,
1593 * s == file_in_tmpfile, so this frees up that buffer.
1598 /* Resolve the special FileOut paths ("-" or filename).
1599 * The caller (cmds.c) will call free (str) after the command has run.
1602 file_out (const char *arg)
1606 if (STREQ (arg, "-"))
1607 ret = strdup ("/dev/stdout");