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 void interactive (void);
62 static void shell_script (void);
63 static void script (int prompt);
64 static void cmdline (char *argv[], int optind, int argc);
65 static void initialize_readline (void);
66 static void cleanup_readline (void);
67 static void add_history_line (const char *);
69 /* Currently open libguestfs handle. */
75 int echo_commands = 0;
76 int remote_control_listen = 0;
77 int remote_control = 0;
78 int exit_on_error = 1;
82 launch (guestfs_h *_g)
86 if (guestfs_is_config (g)) {
87 if (guestfs_launch (g) == -1)
93 static void __attribute__((noreturn))
96 if (status != EXIT_SUCCESS)
97 fprintf (stderr, _("Try `%s --help' for more information.\n"),
101 _("%s: guest filesystem shell\n"
102 "%s lets you edit virtual machine filesystems\n"
103 "Copyright (C) 2009 Red Hat Inc.\n"
105 " %s [--options] cmd [: cmd : cmd ...]\n"
106 " %s -i libvirt-domain\n"
107 " %s -i disk-image(s)\n"
108 "or for interactive use:\n"
110 "or from a shell script:\n"
116 " -h|--cmd-help List available commands\n"
117 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
118 " -a|--add image Add image\n"
119 " -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
120 " -f|--file file Read commands from file\n"
121 " -i|--inspector Run virt-inspector to get disk mountpoints\n"
122 " --listen Listen for remote commands\n"
123 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
124 " -n|--no-sync Don't autosync\n"
125 " -N|--new type Create prepared disk (test1.img, ...)\n"
126 " --remote[=pid] Send commands to remote %s\n"
127 " -r|--ro Mount read-only\n"
128 " --selinux Enable SELinux support\n"
129 " -v|--verbose Verbose messages\n"
130 " -x Echo each command before executing it\n"
131 " -V|--version Display version and exit\n"
132 "For more information, see the manpage %s(1).\n"),
133 program_name, program_name, program_name,
134 program_name, program_name, program_name,
135 program_name, program_name, program_name);
141 main (int argc, char *argv[])
143 /* Set global program name that is not polluted with libtool artifacts. */
144 set_program_name (argv[0]);
146 atexit (close_stdout);
148 setlocale (LC_ALL, "");
149 bindtextdomain (PACKAGE, LOCALEBASEDIR);
150 textdomain (PACKAGE);
152 enum { HELP_OPTION = CHAR_MAX + 1 };
154 static const char *options = "a:Df:h::im:nN:rv?Vx";
155 static const struct option long_options[] = {
156 { "add", 1, 0, 'a' },
157 { "cmd-help", 2, 0, 'h' },
158 { "file", 1, 0, 'f' },
159 { "help", 0, 0, HELP_OPTION },
160 { "inspector", 0, 0, 'i' },
161 { "listen", 0, 0, 0 },
162 { "mount", 1, 0, 'm' },
163 { "new", 1, 0, 'N' },
164 { "no-dest-paths", 0, 0, 'D' },
165 { "no-sync", 0, 0, 'n' },
166 { "remote", 2, 0, 0 },
168 { "selinux", 0, 0, 0 },
169 { "verbose", 0, 0, 'v' },
170 { "version", 0, 0, 'V' },
173 struct drv *drvs = NULL;
175 struct mp *mps = NULL;
177 char *p, *file = NULL;
182 char next_drive = 'a';
183 int next_prepared_drive = 1;
185 initialize_readline ();
187 memset (&sa, 0, sizeof sa);
188 sa.sa_handler = SIG_IGN;
189 sa.sa_flags = SA_RESTART;
190 sigaction (SIGPIPE, &sa, NULL);
192 /* guestfs_create is meant to be a lightweight operation, so
193 * it's OK to do it early here.
195 g = guestfs_create ();
197 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
201 guestfs_set_autosync (g, 1);
203 /* If developing, add ./appliance to the path. Note that libtools
204 * interferes with this because uninstalled guestfish is a shell
205 * script that runs the real program with an absolute path. Detect
208 * BUT if LIBGUESTFS_PATH environment variable is already set by
209 * the user, then don't override it.
211 if (getenv ("LIBGUESTFS_PATH") == NULL &&
213 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
214 guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
216 /* CAUTION: we are careful to modify argv[0] here, only after
217 * using it just above.
219 * getopt_long uses argv[0], so give it the sanitized name. Save a copy
220 * of the original, in case it's needed in virt-inspector mode, below.
222 char *real_argv0 = argv[0];
223 argv[0] = bad_cast (program_name);
226 c = getopt_long (argc, argv, options, long_options, &option_index);
230 case 0: /* options which are long only */
231 if (STREQ (long_options[option_index].name, "listen"))
232 remote_control_listen = 1;
233 else if (STREQ (long_options[option_index].name, "remote")) {
235 if (sscanf (optarg, "%d", &remote_control) != 1) {
236 fprintf (stderr, _("%s: --listen=PID: PID was not a number: %s\n"),
237 program_name, optarg);
241 p = getenv ("GUESTFISH_PID");
242 if (!p || sscanf (p, "%d", &remote_control) != 1) {
243 fprintf (stderr, _("%s: remote: $GUESTFISH_PID must be set"
244 " to the PID of the remote process\n"),
249 } else if (STREQ (long_options[option_index].name, "selinux")) {
250 guestfs_set_selinux (g, 1);
252 fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
253 program_name, long_options[option_index].name, option_index);
259 if (access (optarg, R_OK) != 0) {
263 drv = malloc (sizeof (struct drv));
268 drv->filename = optarg;
270 /* We could fill the device field in, but in fact we
271 * only use it for the -N option at present.
280 if (STRCASEEQ (optarg, "list")) {
281 list_prepared_drives ();
284 drv = malloc (sizeof (struct drv));
289 if (asprintf (&drv->filename, "test%d.img",
290 next_prepared_drive++) == -1) {
294 drv->data = create_prepared_file (optarg, drv->filename);
295 if (asprintf (&drv->device, "/dev/sd%c", next_drive++) == -1) {
304 complete_dest_paths = 0;
309 fprintf (stderr, _("%s: only one -f parameter can be given\n"),
318 display_command (optarg);
319 else if (argv[optind] && argv[optind][0] != '-')
320 display_command (argv[optind++]);
330 mp = malloc (sizeof (struct mp));
335 p = strchr (optarg, ':');
338 mp->mountpoint = p+1;
340 mp->mountpoint = bad_cast ("/");
347 guestfs_set_autosync (g, 0);
356 guestfs_set_verbose (g, verbose);
360 printf ("%s %s\n", program_name, PACKAGE_VERSION);
368 usage (EXIT_SUCCESS);
371 usage (EXIT_FAILURE);
375 /* Inspector mode invalidates most of the other arguments. */
380 if (drvs || mps || remote_control_listen || remote_control ||
381 guestfs_get_selinux (g)) {
382 fprintf (stderr, _("%s: cannot use -i option with -a, -m, -N, "
383 "--listen, --remote or --selinux\n"),
387 if (optind >= argc) {
389 _("%s: -i requires a libvirt domain or path(s) to disk image(s)\n"),
394 strcpy (cmd, "a=`virt-inspector");
395 while (optind < argc) {
396 if (strlen (cmd) + strlen (argv[optind]) + strlen (real_argv0) + 60
399 _("%s: virt-inspector command too long for fixed-size buffer\n"),
404 strcat (cmd, argv[optind]);
410 strcat (cmd, " --ro-fish");
412 strcat (cmd, " --fish");
414 sprintf (&cmd[strlen(cmd)], "` && %s $a", real_argv0);
416 if (guestfs_get_verbose (g))
418 if (!guestfs_get_autosync (g))
423 "%s -i: running virt-inspector command:\n%s\n", program_name, cmd);
430 exit (WEXITSTATUS (r));
433 /* If we've got drives to add, add them now. */
436 /* If we've got mountpoints or prepared drives, we must launch the
437 * guest and mount them.
439 if (next_prepared_drive > 1 || mps != NULL) {
440 if (launch (g) == -1) exit (EXIT_FAILURE);
441 prepare_drives (drvs);
445 /* Remote control? */
446 if (remote_control_listen && remote_control) {
448 _("%s: cannot use --listen and --remote options at the same time\n"),
453 if (remote_control_listen) {
456 _("%s: extra parameters on the command line with --listen flag\n"),
462 _("%s: cannot use --listen and --file options at the same time\n"),
469 /* -f (file) parameter? */
472 if (open (file, O_RDONLY) == -1) {
478 /* Interactive, shell script, or command(s) on the command line? */
479 if (optind >= argc) {
486 cmdline (argv, optind, argc);
494 pod2text (const char *name, const char *shortdesc, const char *str)
498 fp = popen ("pod2text", "w");
500 /* pod2text failed, maybe not found, so let's just print the
501 * source instead, since that's better than doing nothing.
503 printf ("%s - %s\n\n%s\n", name, shortdesc, str);
506 fprintf (fp, "=head1 NAME\n\n%s - %s\n\n", name, shortdesc);
511 /* List is built in reverse order, so mount them in reverse order. */
513 mount_mps (struct mp *mp)
518 mount_mps (mp->next);
520 /* Don't use guestfs_mount here because that will default to mount
521 * options -o sync,noatime. For more information, see guestfs(3)
522 * section "LIBGUESTFS GOTCHAS".
524 const char *options = read_only ? "ro" : "";
525 r = guestfs_mount_options (g, options, mp->device, mp->mountpoint);
532 add_drives (struct drv *drv)
537 add_drives (drv->next);
539 if (drv->data /* -N option is not affected by --ro */ || !read_only)
540 r = guestfs_add_drive (g, drv->filename);
542 r = guestfs_add_drive_ro (g, drv->filename);
549 prepare_drives (struct drv *drv)
552 prepare_drives (drv->next);
553 prepare_drive (drv->filename, drv->data, drv->device);
569 #define FISH "><fs> "
571 static char *line_read = NULL;
576 #ifdef HAVE_LIBREADLINE
584 line_read = readline (prompt ? FISH : "");
586 if (line_read && *line_read)
587 add_history_line (line_read);
592 #endif /* HAVE_LIBREADLINE */
594 static char buf[8192];
597 if (prompt) printf (FISH);
598 line_read = fgets (buf, sizeof buf, stdin);
601 len = strlen (line_read);
602 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
616 int global_exit_on_error = !prompt;
621 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
622 "editing virtual machine filesystems.\n"
624 "Type: 'help' for help with commands\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. */
860 for (i = 0; argv[i] != NULL; ++i)
861 printf (" %s", argv[i]);
865 /* For | ... commands. Annoyingly we can't use popen(3) here. */
869 if (fflush (stdout) == EOF) {
870 perror ("failed to flush standard output");
874 perror ("pipe failed");
883 if (pid == 0) { /* Child process. */
885 if (dup2 (fd[0], 0) < 0) {
886 perror ("dup2 of stdin failed");
890 r = system (pipecmd);
895 _exit (WEXITSTATUS (r));
898 if ((stdout_saved_fd = dup (1)) < 0) {
899 perror ("failed to dup stdout");
903 if (dup2 (fd[1], 1) < 0) {
904 perror ("failed to dup stdout");
905 close (stdout_saved_fd);
911 for (argc = 0; argv[argc] != NULL; ++argc)
914 /* If --remote was set, then send this command to a remote process. */
916 r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
918 /* Otherwise execute it locally. */
919 else if (STRCASEEQ (cmd, "help")) {
923 display_command (argv[0]);
926 else if (STRCASEEQ (cmd, "quit") ||
927 STRCASEEQ (cmd, "exit") ||
928 STRCASEEQ (cmd, "q")) {
932 else if (STRCASEEQ (cmd, "alloc") ||
933 STRCASEEQ (cmd, "allocate"))
934 r = do_alloc (cmd, argc, argv);
935 else if (STRCASEEQ (cmd, "echo"))
936 r = do_echo (cmd, argc, argv);
937 else if (STRCASEEQ (cmd, "edit") ||
938 STRCASEEQ (cmd, "vi") ||
939 STRCASEEQ (cmd, "emacs"))
940 r = do_edit (cmd, argc, argv);
941 else if (STRCASEEQ (cmd, "lcd"))
942 r = do_lcd (cmd, argc, argv);
943 else if (STRCASEEQ (cmd, "glob"))
944 r = do_glob (cmd, argc, argv);
945 else if (STRCASEEQ (cmd, "more") ||
946 STRCASEEQ (cmd, "less"))
947 r = do_more (cmd, argc, argv);
948 else if (STRCASEEQ (cmd, "reopen"))
949 r = do_reopen (cmd, argc, argv);
950 else if (STRCASEEQ (cmd, "sparse"))
951 r = do_sparse (cmd, argc, argv);
952 else if (STRCASEEQ (cmd, "time"))
953 r = do_time (cmd, argc, argv);
955 r = run_action (cmd, argc, argv);
957 /* Always flush stdout after every command, so that messages, results
958 * etc appear immediately.
960 if (fflush (stdout) == EOF) {
961 perror ("failed to flush standard output");
967 if (dup2 (stdout_saved_fd, 1) < 0) {
968 perror ("failed to dup2 standard output");
971 close (stdout_saved_fd);
972 if (waitpid (pid, NULL, 0) < 0) {
973 perror ("waiting for command to complete");
982 list_builtin_commands (void)
984 /* help and quit should appear at the top */
985 printf ("%-20s %s\n",
986 "help", _("display a list of commands or help on a command"));
987 printf ("%-20s %s\n",
988 "quit", _("quit guestfish"));
990 printf ("%-20s %s\n",
991 "alloc", _("allocate an image"));
992 printf ("%-20s %s\n",
993 "echo", _("display a line of text"));
994 printf ("%-20s %s\n",
995 "edit", _("edit a file in the image"));
996 printf ("%-20s %s\n",
997 "lcd", _("local change directory"));
998 printf ("%-20s %s\n",
999 "glob", _("expand wildcards in command"));
1000 printf ("%-20s %s\n",
1001 "more", _("view a file in the pager"));
1002 printf ("%-20s %s\n",
1003 "reopen", _("close and reopen libguestfs handle"));
1004 printf ("%-20s %s\n",
1005 "sparse", _("allocate a sparse image file"));
1006 printf ("%-20s %s\n",
1007 "time", _("measure time taken to run command"));
1009 /* actions are printed after this (see list_commands) */
1013 display_builtin_command (const char *cmd)
1015 /* help for actions is auto-generated, see display_command */
1017 if (STRCASEEQ (cmd, "alloc") ||
1018 STRCASEEQ (cmd, "allocate"))
1019 printf (_("alloc - allocate an image\n"
1020 " alloc <filename> <size>\n"
1022 " This creates an empty (zeroed) file of the given size,\n"
1023 " and then adds so it can be further examined.\n"
1025 " For more advanced image creation, see qemu-img utility.\n"
1027 " Size can be specified (where <nn> means a number):\n"
1028 " <nn> number of kilobytes\n"
1029 " eg: 1440 standard 3.5\" floppy\n"
1030 " <nn>K or <nn>KB number of kilobytes\n"
1031 " <nn>M or <nn>MB number of megabytes\n"
1032 " <nn>G or <nn>GB number of gigabytes\n"
1033 " <nn>T or <nn>TB number of terabytes\n"
1034 " <nn>P or <nn>PB number of petabytes\n"
1035 " <nn>E or <nn>EB number of exabytes\n"
1036 " <nn>sects number of 512 byte sectors\n"));
1037 else if (STRCASEEQ (cmd, "echo"))
1038 printf (_("echo - display a line of text\n"
1039 " echo [<params> ...]\n"
1041 " This echos the parameters to the terminal.\n"));
1042 else if (STRCASEEQ (cmd, "edit") ||
1043 STRCASEEQ (cmd, "vi") ||
1044 STRCASEEQ (cmd, "emacs"))
1045 printf (_("edit - edit a file in the image\n"
1046 " edit <filename>\n"
1048 " This is used to edit a file.\n"
1050 " It is the equivalent of (and is implemented by)\n"
1051 " running \"cat\", editing locally, and then \"write-file\".\n"
1053 " Normally it uses $EDITOR, but if you use the aliases\n"
1054 " \"vi\" or \"emacs\" you will get those editors.\n"
1056 " NOTE: This will not work reliably for large files\n"
1057 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1058 else if (STRCASEEQ (cmd, "lcd"))
1059 printf (_("lcd - local change directory\n"
1060 " lcd <directory>\n"
1062 " Change guestfish's current directory. This command is\n"
1063 " useful if you want to download files to a particular\n"
1065 else if (STRCASEEQ (cmd, "glob"))
1066 printf (_("glob - expand wildcards in command\n"
1067 " glob <command> [<args> ...]\n"
1069 " Glob runs <command> with wildcards expanded in any\n"
1070 " command args. Note that the command is run repeatedly\n"
1071 " once for each expanded argument.\n"));
1072 else if (STRCASEEQ (cmd, "help"))
1073 printf (_("help - display a list of commands or help on a command\n"
1076 else if (STRCASEEQ (cmd, "more") ||
1077 STRCASEEQ (cmd, "less"))
1078 printf (_("more - view a file in the pager\n"
1079 " more <filename>\n"
1081 " This is used to view a file in the pager.\n"
1083 " It is the equivalent of (and is implemented by)\n"
1084 " running \"cat\" and using the pager.\n"
1086 " Normally it uses $PAGER, but if you use the alias\n"
1087 " \"less\" then it always uses \"less\".\n"
1089 " NOTE: This will not work reliably for large files\n"
1090 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1091 else if (STRCASEEQ (cmd, "quit") ||
1092 STRCASEEQ (cmd, "exit") ||
1093 STRCASEEQ (cmd, "q"))
1094 printf (_("quit - quit guestfish\n"
1096 else if (STRCASEEQ (cmd, "reopen"))
1097 printf (_("reopen - close and reopen the libguestfs handle\n"
1100 "Close and reopen the libguestfs handle. It is not necessary to use\n"
1101 "this normally, because the handle is closed properly when guestfish\n"
1102 "exits. However this is occasionally useful for testing.\n"));
1103 else if (STRCASEEQ (cmd, "sparse"))
1104 printf (_("sparse - allocate a sparse image file\n"
1105 " sparse <filename> <size>\n"
1107 " This creates an empty sparse file of the given size,\n"
1108 " and then adds so it can be further examined.\n"
1110 " In all respects it works the same as the 'alloc'\n"
1111 " command, except that the image file is allocated\n"
1112 " sparsely, which means that disk blocks are not assigned\n"
1113 " to the file until they are needed. Sparse disk files\n"
1114 " only use space when written to, but they are slower\n"
1115 " and there is a danger you could run out of real disk\n"
1116 " space during a write operation.\n"
1118 " For more advanced image creation, see qemu-img utility.\n"
1120 " Size can be specified (where <nn> means a number):\n"
1121 " <nn> number of kilobytes\n"
1122 " eg: 1440 standard 3.5\" floppy\n"
1123 " <nn>K or <nn>KB number of kilobytes\n"
1124 " <nn>M or <nn>MB number of megabytes\n"
1125 " <nn>G or <nn>GB number of gigabytes\n"
1126 " <nn>T or <nn>TB number of terabytes\n"
1127 " <nn>P or <nn>PB number of petabytes\n"
1128 " <nn>E or <nn>EB number of exabytes\n"
1129 " <nn>sects number of 512 byte sectors\n"));
1130 else if (STRCASEEQ (cmd, "time"))
1131 printf (_("time - measure time taken to run command\n"
1132 " time <command> [<args> ...]\n"
1134 " This runs <command> as usual, and prints the elapsed\n"
1135 " time afterwards.\n"));
1137 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
1141 /* This is printed when the user types in an unknown command for the
1142 * first command issued. A common case is the user doing:
1143 * guestfish disk.img
1144 * expecting guestfish to open 'disk.img' (in fact, this tried to
1145 * run a command 'disk.img').
1148 extended_help_message (void)
1151 _("Did you mean to open a disk image? guestfish -a disk.img\n"
1152 "For a list of commands: guestfish -h\n"
1153 "For complete documentation: man guestfish\n"));
1157 free_strings (char **argv)
1161 for (argc = 0; argv[argc] != NULL; ++argc)
1167 count_strings (char *const *argv)
1171 for (c = 0; argv[c]; ++c)
1177 print_strings (char *const *argv)
1181 for (argc = 0; argv[argc] != NULL; ++argc)
1182 printf ("%s\n", argv[argc]);
1186 print_table (char *const *argv)
1190 for (i = 0; argv[i] != NULL; i += 2)
1191 printf ("%s: %s\n", argv[i], argv[i+1]);
1195 is_true (const char *str)
1198 STRCASENEQ (str, "0") &&
1199 STRCASENEQ (str, "f") &&
1200 STRCASENEQ (str, "false") &&
1201 STRCASENEQ (str, "n") &&
1202 STRCASENEQ (str, "no");
1205 /* Free strings from a non-NULL terminated char** */
1207 free_n_strings (char **str, size_t len)
1211 for (i = 0; i < len; i++) {
1218 parse_string_list (const char *str)
1221 size_t argv_len = 0;
1223 /* Current position pointer */
1224 const char *p = str;
1226 /* Token might be simple:
1229 * 'This is a single token'
1230 * or contain embedded single-quoted sections:
1231 * This' is a sing'l'e to'ken
1233 * The latter may seem over-complicated, but it's what a normal shell does.
1234 * Not doing it risks surprising somebody.
1236 * This outer loop is over complete tokens.
1242 /* Skip leading whitespace */
1243 p += strspn (p, " \t");
1247 /* This loop is over token 'fragments'. A token can be in multiple bits if
1248 * it contains single quotes. We also treat both sides of an escaped quote
1249 * as separate fragments because we can't just copy it: we have to remove
1252 while (*p && (!c_isblank (*p) || in_quote)) {
1253 const char *end = p;
1255 /* Check if the fragment starts with a quote */
1257 /* Toggle in_quote */
1258 in_quote = !in_quote;
1260 /* Skip the quote */
1264 /* If we're in a quote, look for an end quote */
1266 end += strcspn (end, "'");
1269 /* Otherwise, look for whitespace or a quote */
1271 end += strcspn (end, " \t'");
1274 /* Grow the token to accommodate the fragment */
1275 size_t tok_end = tok_len;
1277 char *tok_new = realloc (tok, tok_len + 1);
1278 if (NULL == tok_new) {
1280 free_n_strings (argv, argv_len);
1282 exit (EXIT_FAILURE);
1286 /* Check if we stopped on an escaped quote */
1287 if ('\'' == *end && end != p && *(end-1) == '\\') {
1288 /* Add everything before \' to the token */
1289 memcpy (&tok[tok_end], p, end - p - 1);
1292 tok[tok_len-1] = '\'';
1294 /* Already processed the quote */
1299 /* Add the whole fragment */
1300 memcpy (&tok[tok_end], p, end - p);
1306 /* We've reached the end of a token. We shouldn't still be in quotes. */
1308 fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str);
1310 free_n_strings (argv, argv_len);
1315 /* Add this token if there is one. There might not be if there was
1316 * whitespace at the end of the input string */
1318 /* Add the NULL terminator */
1319 tok[tok_len] = '\0';
1321 /* Add the argument to the argument list */
1323 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1324 if (NULL == argv_new) {
1326 free_n_strings (argv, argv_len-1);
1328 exit (EXIT_FAILURE);
1332 argv[argv_len-1] = tok;
1336 /* NULL terminate the argument list */
1338 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1339 if (NULL == argv_new) {
1341 free_n_strings (argv, argv_len-1);
1342 exit (EXIT_FAILURE);
1346 argv[argv_len-1] = NULL;
1351 #ifdef HAVE_LIBREADLINE
1352 static char histfile[1024];
1353 static int nr_history_lines = 0;
1357 initialize_readline (void)
1359 #ifdef HAVE_LIBREADLINE
1362 home = getenv ("HOME");
1364 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1366 (void) read_history (histfile);
1369 rl_readline_name = "guestfish";
1370 rl_attempted_completion_function = do_completion;
1375 cleanup_readline (void)
1377 #ifdef HAVE_LIBREADLINE
1380 if (histfile[0] != '\0') {
1381 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1388 #ifdef HAVE_APPEND_HISTORY
1389 (void) append_history (nr_history_lines, histfile);
1391 (void) write_history (histfile);
1398 add_history_line (const char *line)
1400 #ifdef HAVE_LIBREADLINE
1407 xwrite (int fd, const void *v_buf, size_t len)
1410 const char *buf = v_buf;
1413 r = write (fd, buf, len);
1425 /* Resolve the special "win:..." form for Windows-specific paths.
1426 * This always returns a newly allocated string which is freed by the
1427 * caller function in "cmds.c".
1430 resolve_win_path (const char *path)
1435 if (STRCASENEQLEN (path, "win:", 4)) {
1436 ret = strdup (path);
1444 /* Drop drive letter, if it's "C:". */
1445 if (STRCASEEQLEN (path, "c:", 2))
1455 ret = strdup (path);
1461 /* Blindly convert any backslashes into forward slashes. Is this good? */
1462 for (i = 0; i < strlen (ret); ++i)
1466 char *t = guestfs_case_sensitive_path (g, ret);
1473 /* Resolve the special FileIn paths ("-" or "-<<END" or filename).
1474 * The caller (cmds.c) will call free_file_in after the command has
1475 * run which should clean up resources.
1477 static char *file_in_heredoc (const char *endmarker);
1478 static char *file_in_tmpfile = NULL;
1481 file_in (const char *arg)
1485 if (STREQ (arg, "-")) {
1486 ret = strdup ("/dev/stdin");
1492 else if (STRPREFIX (arg, "-<<")) {
1493 const char *endmarker = &arg[3];
1494 if (*endmarker == '\0') {
1495 fprintf (stderr, "%s: missing end marker in -<< expression\n",
1499 ret = file_in_heredoc (endmarker);
1515 file_in_heredoc (const char *endmarker)
1517 static const char template[] = "/tmp/heredocXXXXXX";
1518 file_in_tmpfile = strdup (template);
1519 if (file_in_tmpfile == NULL) {
1524 int fd = mkstemp (file_in_tmpfile);
1530 size_t markerlen = strlen (endmarker);
1532 char buffer[BUFSIZ];
1533 int write_error = 0;
1534 while (fgets (buffer, sizeof buffer, stdin) != NULL) {
1535 /* Look for "END"<EOF> or "END\n" in input. */
1536 size_t blen = strlen (buffer);
1537 if (STREQLEN (buffer, endmarker, markerlen) &&
1538 (blen == markerlen ||
1539 (blen == markerlen+1 && buffer[markerlen] == '\n')))
1542 if (xwrite (fd, buffer, blen) == -1) {
1543 if (!write_error) perror ("write");
1545 /* continue reading up to the end marker */
1549 /* Reached EOF of stdin without finding the end marker, which
1550 * is likely to be an error.
1552 fprintf (stderr, "%s: end of input reached without finding '%s'\n",
1553 program_name, endmarker);
1562 if (close (fd) == -1) {
1567 return file_in_tmpfile;
1570 unlink (file_in_tmpfile);
1573 free (file_in_tmpfile);
1574 file_in_tmpfile = NULL;
1579 free_file_in (char *s)
1581 if (file_in_tmpfile) {
1582 if (unlink (file_in_tmpfile) == -1)
1583 perror (file_in_tmpfile);
1584 file_in_tmpfile = NULL;
1587 /* Free the device or file name which was strdup'd in file_in().
1588 * Note it's not immediately clear, but for -<< heredocs,
1589 * s == file_in_tmpfile, so this frees up that buffer.
1594 /* Resolve the special FileOut paths ("-" or filename).
1595 * The caller (cmds.c) will call free (str) after the command has run.
1598 file_out (const char *arg)
1602 if (STREQ (arg, "-"))
1603 ret = strdup ("/dev/stdout");