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>
56 static void add_drives (struct drv *drv);
57 static void mount_mps (struct mp *mp);
58 static void interactive (void);
59 static void shell_script (void);
60 static void script (int prompt);
61 static void cmdline (char *argv[], int optind, int argc);
62 static void initialize_readline (void);
63 static void cleanup_readline (void);
64 #ifdef HAVE_LIBREADLINE
65 static void add_history_line (const char *);
68 /* Currently open libguestfs handle. */
74 int remote_control_listen = 0;
75 int remote_control = 0;
76 int exit_on_error = 1;
80 launch (guestfs_h *_g)
84 if (guestfs_is_config (g)) {
85 if (guestfs_launch (g) == -1)
91 static void __attribute__((noreturn))
94 if (status != EXIT_SUCCESS)
95 fprintf (stderr, _("Try `%s --help' for more information.\n"),
99 _("%s: guest filesystem shell\n"
100 "%s lets you edit virtual machine filesystems\n"
101 "Copyright (C) 2009 Red Hat Inc.\n"
103 " %s [--options] cmd [: cmd : cmd ...]\n"
104 " %s -i libvirt-domain\n"
105 " %s -i disk-image(s)\n"
106 "or for interactive use:\n"
108 "or from a shell script:\n"
114 " -h|--cmd-help List available commands\n"
115 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
116 " -a|--add image Add image\n"
117 " -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
118 " -f|--file file Read commands from file\n"
119 " -i|--inspector Run virt-inspector to get disk mountpoints\n"
120 " --listen Listen for remote commands\n"
121 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
122 " -n|--no-sync Don't autosync\n"
123 " --remote[=pid] Send commands to remote %s\n"
124 " -r|--ro Mount read-only\n"
125 " --selinux Enable SELinux support\n"
126 " -v|--verbose Verbose messages\n"
127 " -x Echo each command before executing it\n"
128 " -V|--version Display version and exit\n"
129 "For more information, see the manpage %s(1).\n"),
130 program_name, program_name, program_name,
131 program_name, program_name, program_name,
132 program_name, program_name, program_name);
138 main (int argc, char *argv[])
140 /* Set global program name that is not polluted with libtool artifacts. */
141 set_program_name (argv[0]);
143 atexit (close_stdout);
145 setlocale (LC_ALL, "");
146 bindtextdomain (PACKAGE, LOCALEBASEDIR);
147 textdomain (PACKAGE);
149 enum { HELP_OPTION = CHAR_MAX + 1 };
151 static const char *options = "a:Df:h::im:nrv?Vx";
152 static const struct option long_options[] = {
153 { "add", 1, 0, 'a' },
154 { "cmd-help", 2, 0, 'h' },
155 { "file", 1, 0, 'f' },
156 { "help", 0, 0, HELP_OPTION },
157 { "inspector", 0, 0, 'i' },
158 { "listen", 0, 0, 0 },
159 { "mount", 1, 0, 'm' },
160 { "no-dest-paths", 0, 0, 'D' },
161 { "no-sync", 0, 0, 'n' },
162 { "remote", 2, 0, 0 },
164 { "selinux", 0, 0, 0 },
165 { "verbose", 0, 0, 'v' },
166 { "version", 0, 0, 'V' },
169 struct drv *drvs = NULL;
171 struct mp *mps = NULL;
173 char *p, *file = NULL;
179 initialize_readline ();
181 memset (&sa, 0, sizeof sa);
182 sa.sa_handler = SIG_IGN;
183 sa.sa_flags = SA_RESTART;
184 sigaction (SIGPIPE, &sa, NULL);
186 /* guestfs_create is meant to be a lightweight operation, so
187 * it's OK to do it early here.
189 g = guestfs_create ();
191 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
195 guestfs_set_autosync (g, 1);
197 /* If developing, add ./appliance to the path. Note that libtools
198 * interferes with this because uninstalled guestfish is a shell
199 * script that runs the real program with an absolute path. Detect
202 * BUT if LIBGUESTFS_PATH environment variable is already set by
203 * the user, then don't override it.
205 if (getenv ("LIBGUESTFS_PATH") == NULL &&
207 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
208 guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
210 /* CAUTION: we are careful to modify argv[0] here, only after
211 * using it just above.
213 * getopt_long uses argv[0], so give it the sanitized name. Save a copy
214 * of the original, in case it's needed in virt-inspector mode, below.
216 char *real_argv0 = argv[0];
217 argv[0] = bad_cast (program_name);
220 c = getopt_long (argc, argv, options, long_options, &option_index);
224 case 0: /* options which are long only */
225 if (STREQ (long_options[option_index].name, "listen"))
226 remote_control_listen = 1;
227 else if (STREQ (long_options[option_index].name, "remote")) {
229 if (sscanf (optarg, "%d", &remote_control) != 1) {
230 fprintf (stderr, _("%s: --listen=PID: PID was not a number: %s\n"),
231 program_name, optarg);
235 p = getenv ("GUESTFISH_PID");
236 if (!p || sscanf (p, "%d", &remote_control) != 1) {
237 fprintf (stderr, _("%s: remote: $GUESTFISH_PID must be set"
238 " to the PID of the remote process\n"),
243 } else if (STREQ (long_options[option_index].name, "selinux")) {
244 guestfs_set_selinux (g, 1);
246 fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
247 program_name, long_options[option_index].name, option_index);
253 if (access (optarg, R_OK) != 0) {
257 drv = malloc (sizeof (struct drv));
262 drv->filename = optarg;
268 complete_dest_paths = 0;
273 fprintf (stderr, _("%s: only one -f parameter can be given\n"),
284 r = display_command (optarg);
285 else if (argv[optind] && argv[optind][0] != '-')
286 r = display_command (argv[optind++]);
290 exit (r == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
298 mp = malloc (sizeof (struct mp));
303 p = strchr (optarg, ':');
306 mp->mountpoint = p+1;
308 mp->mountpoint = bad_cast ("/");
315 guestfs_set_autosync (g, 0);
324 guestfs_set_verbose (g, verbose);
328 printf ("%s %s\n", program_name, PACKAGE_VERSION);
332 guestfs_set_trace (g, 1);
336 usage (EXIT_SUCCESS);
339 usage (EXIT_FAILURE);
343 /* Inspector mode invalidates most of the other arguments. */
348 if (drvs || mps || remote_control_listen || remote_control ||
349 guestfs_get_selinux (g)) {
350 fprintf (stderr, _("%s: cannot use -i option with -a, -m,"
351 " --listen, --remote or --selinux\n"),
355 if (optind >= argc) {
357 _("%s: -i requires a libvirt domain or path(s) to disk image(s)\n"),
362 strcpy (cmd, "a=`virt-inspector");
363 while (optind < argc) {
364 if (strlen (cmd) + strlen (argv[optind]) + strlen (real_argv0) + 60
367 _("%s: virt-inspector command too long for fixed-size buffer\n"),
372 strcat (cmd, argv[optind]);
378 strcat (cmd, " --ro-fish");
380 strcat (cmd, " --fish");
382 sprintf (&cmd[strlen(cmd)], "` && %s $a", real_argv0);
384 if (guestfs_get_verbose (g))
386 if (!guestfs_get_autosync (g))
388 if (guestfs_get_trace (g))
393 "%s -i: running virt-inspector command:\n%s\n", program_name, cmd);
400 exit (WEXITSTATUS (r));
403 /* If we've got drives to add, add them now. */
406 /* If we've got mountpoints, we must launch the guest and mount them. */
408 if (launch (g) == -1) exit (EXIT_FAILURE);
412 /* Remote control? */
413 if (remote_control_listen && remote_control) {
415 _("%s: cannot use --listen and --remote options at the same time\n"),
420 if (remote_control_listen) {
423 _("%s: extra parameters on the command line with --listen flag\n"),
429 _("%s: cannot use --listen and --file options at the same time\n"),
436 /* -f (file) parameter? */
439 if (open (file, O_RDONLY) == -1) {
445 /* Interactive, shell script, or command(s) on the command line? */
446 if (optind >= argc) {
453 cmdline (argv, optind, argc);
461 pod2text (const char *name, const char *shortdesc, const char *str)
465 fp = popen ("pod2text", "w");
467 /* pod2text failed, maybe not found, so let's just print the
468 * source instead, since that's better than doing nothing.
470 printf ("%s - %s\n\n%s\n", name, shortdesc, str);
473 fprintf (fp, "=head1 NAME\n\n%s - %s\n\n", name, shortdesc);
478 /* List is built in reverse order, so mount them in reverse order. */
480 mount_mps (struct mp *mp)
485 mount_mps (mp->next);
487 /* Don't use guestfs_mount here because that will default to mount
488 * options -o sync,noatime. For more information, see guestfs(3)
489 * section "LIBGUESTFS GOTCHAS".
491 const char *options = read_only ? "ro" : "";
492 r = guestfs_mount_options (g, options, mp->device, mp->mountpoint);
499 add_drives (struct drv *drv)
504 add_drives (drv->next);
506 r = guestfs_add_drive (g, drv->filename);
508 r = guestfs_add_drive_ro (g, drv->filename);
526 #define FISH "><fs> "
528 static char *line_read = NULL;
533 #ifdef HAVE_LIBREADLINE
541 line_read = readline (prompt ? FISH : "");
543 if (line_read && *line_read)
544 add_history_line (line_read);
549 #endif /* HAVE_LIBREADLINE */
551 static char buf[8192];
554 if (prompt) printf (FISH);
555 line_read = fgets (buf, sizeof buf, stdin);
558 len = strlen (line_read);
559 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
573 int global_exit_on_error = !prompt;
578 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
579 "editing virtual machine filesystems.\n"
581 "Type: 'help' for help with commands\n"
582 " 'quit' to quit the shell\n"
588 exit_on_error = global_exit_on_error;
590 buf = rl_gets (prompt);
596 /* Skip any initial whitespace before the command. */
598 while (*buf && c_isspace (*buf))
603 /* If the next character is '#' then this is a comment. */
604 if (*buf == '#') continue;
606 /* If the next character is '!' then pass the whole lot to system(3). */
614 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
615 WEXITSTATUS (r) != 0)
621 /* If the next character is '-' allow the command to fail without
622 * exiting on error (just for this one command though).
630 /* Get the command (cannot be quoted). */
631 len = strcspn (buf, " \t");
633 if (len == 0) continue;
637 if (buf[len] == '\0') {
644 p += strspn (p, " \t");
646 /* Get the parameters. */
647 while (*p && i < sizeof argv / sizeof argv[0]) {
650 /* Parameters which start with quotes or pipes are treated
651 * specially. Bare parameters are delimited by whitespace.
655 len = strcspn (p, "\"");
656 if (p[len] == '\0') {
657 fprintf (stderr, _("%s: unterminated double quote\n"), program_name);
658 if (exit_on_error) exit (EXIT_FAILURE);
661 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
663 _("%s: command arguments not separated by whitespace\n"),
665 if (exit_on_error) exit (EXIT_FAILURE);
669 pend = p[len+1] ? &p[len+2] : &p[len+1];
670 } else if (*p == '\'') {
672 len = strcspn (p, "'");
673 if (p[len] == '\0') {
674 fprintf (stderr, _("%s: unterminated single quote\n"), program_name);
675 if (exit_on_error) exit (EXIT_FAILURE);
678 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
680 _("%s: command arguments not separated by whitespace\n"),
682 if (exit_on_error) exit (EXIT_FAILURE);
686 pend = p[len+1] ? &p[len+2] : &p[len+1];
687 } else if (*p == '|') {
692 } else if (*p == '[') {
696 while (*pend && c != 0) {
697 if (*pend == '[') c++;
698 else if (*pend == ']') c--;
703 _("%s: unterminated \"[...]\" sequence\n"), program_name);
704 if (exit_on_error) exit (EXIT_FAILURE);
707 if (*pend && (*pend != ' ' && *pend != '\t')) {
709 _("%s: command arguments not separated by whitespace\n"),
711 if (exit_on_error) exit (EXIT_FAILURE);
716 } else if (*p != ' ' && *p != '\t') {
717 /* If the first character is a ~ then note that this parameter
718 * is a candidate for ~username expansion. NB this does not
719 * apply to quoted parameters.
721 tilde_candidate = *p == '~';
722 len = strcspn (p, " \t");
729 fprintf (stderr, _("%s: internal error parsing string at '%s'\n"),
734 if (!tilde_candidate)
737 argv[i] = try_tilde_expansion (p);
742 p += strspn (p, " \t");
745 if (i == sizeof argv / sizeof argv[0]) {
746 fprintf (stderr, _("%s: too many arguments\n"), program_name);
747 if (exit_on_error) exit (EXIT_FAILURE);
754 if (issue_command (cmd, argv, pipe) == -1) {
755 if (exit_on_error) exit (EXIT_FAILURE);
760 if (prompt) printf ("\n");
764 cmdline (char *argv[], int optind, int argc)
771 if (optind >= argc) return;
773 cmd = argv[optind++];
774 if (STREQ (cmd, ":")) {
775 fprintf (stderr, _("%s: empty command on command line\n"), program_name);
779 /* Allow -cmd on the command line to mean (temporarily) override
780 * the normal exit on error (RHBZ#578407).
787 params = &argv[optind];
789 /* Search for end of command list or ":" ... */
790 while (optind < argc && STRNEQ (argv[optind], ":"))
793 if (optind == argc) {
794 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
798 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
800 cmdline (argv, optind+1, argc);
805 issue_command (const char *cmd, char *argv[], const char *pipecmd)
808 int stdout_saved_fd = -1;
812 /* This counts the commands issued, starting at 1. */
815 /* For | ... commands. Annoyingly we can't use popen(3) here. */
819 if (fflush (stdout) == EOF) {
820 perror ("failed to flush standard output");
824 perror ("pipe failed");
833 if (pid == 0) { /* Child process. */
835 if (dup2 (fd[0], 0) < 0) {
836 perror ("dup2 of stdin failed");
840 r = system (pipecmd);
845 _exit (WEXITSTATUS (r));
848 if ((stdout_saved_fd = dup (1)) < 0) {
849 perror ("failed to dup stdout");
853 if (dup2 (fd[1], 1) < 0) {
854 perror ("failed to dup stdout");
855 close (stdout_saved_fd);
861 for (argc = 0; argv[argc] != NULL; ++argc)
864 /* If --remote was set, then send this command to a remote process. */
866 r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
868 /* Otherwise execute it locally. */
869 else if (STRCASEEQ (cmd, "help")) {
874 r = display_command (argv[0]);
876 else if (STRCASEEQ (cmd, "quit") ||
877 STRCASEEQ (cmd, "exit") ||
878 STRCASEEQ (cmd, "q")) {
882 else if (STRCASEEQ (cmd, "alloc") ||
883 STRCASEEQ (cmd, "allocate"))
884 r = do_alloc (cmd, argc, argv);
885 else if (STRCASEEQ (cmd, "echo"))
886 r = do_echo (cmd, argc, argv);
887 else if (STRCASEEQ (cmd, "edit") ||
888 STRCASEEQ (cmd, "vi") ||
889 STRCASEEQ (cmd, "emacs"))
890 r = do_edit (cmd, argc, argv);
891 else if (STRCASEEQ (cmd, "lcd"))
892 r = do_lcd (cmd, argc, argv);
893 else if (STRCASEEQ (cmd, "glob"))
894 r = do_glob (cmd, argc, argv);
895 else if (STRCASEEQ (cmd, "more") ||
896 STRCASEEQ (cmd, "less"))
897 r = do_more (cmd, argc, argv);
898 else if (STRCASEEQ (cmd, "reopen"))
899 r = do_reopen (cmd, argc, argv);
900 else if (STRCASEEQ (cmd, "sparse"))
901 r = do_sparse (cmd, argc, argv);
902 else if (STRCASEEQ (cmd, "time"))
903 r = do_time (cmd, argc, argv);
905 r = run_action (cmd, argc, argv);
907 /* Always flush stdout after every command, so that messages, results
908 * etc appear immediately.
910 if (fflush (stdout) == EOF) {
911 perror ("failed to flush standard output");
917 if (dup2 (stdout_saved_fd, 1) < 0) {
918 perror ("failed to dup2 standard output");
921 close (stdout_saved_fd);
922 if (waitpid (pid, NULL, 0) < 0) {
923 perror ("waiting for command to complete");
932 list_builtin_commands (void)
934 /* help and quit should appear at the top */
935 printf ("%-20s %s\n",
936 "help", _("display a list of commands or help on a command"));
937 printf ("%-20s %s\n",
938 "quit", _("quit guestfish"));
940 printf ("%-20s %s\n",
941 "alloc", _("allocate an image"));
942 printf ("%-20s %s\n",
943 "echo", _("display a line of text"));
944 printf ("%-20s %s\n",
945 "edit", _("edit a file in the image"));
946 printf ("%-20s %s\n",
947 "lcd", _("local change directory"));
948 printf ("%-20s %s\n",
949 "glob", _("expand wildcards in command"));
950 printf ("%-20s %s\n",
951 "more", _("view a file in the pager"));
952 printf ("%-20s %s\n",
953 "reopen", _("close and reopen libguestfs handle"));
954 printf ("%-20s %s\n",
955 "sparse", _("allocate a sparse image file"));
956 printf ("%-20s %s\n",
957 "time", _("measure time taken to run command"));
959 /* actions are printed after this (see list_commands) */
963 display_builtin_command (const char *cmd)
965 /* help for actions is auto-generated, see display_command */
967 if (STRCASEEQ (cmd, "alloc") ||
968 STRCASEEQ (cmd, "allocate")) {
969 printf (_("alloc - allocate an image\n"
970 " alloc <filename> <size>\n"
972 " This creates an empty (zeroed) file of the given size,\n"
973 " and then adds so it can be further examined.\n"
975 " For more advanced image creation, see qemu-img utility.\n"
977 " Size can be specified (where <nn> means a number):\n"
978 " <nn> number of kilobytes\n"
979 " eg: 1440 standard 3.5\" floppy\n"
980 " <nn>K or <nn>KB number of kilobytes\n"
981 " <nn>M or <nn>MB number of megabytes\n"
982 " <nn>G or <nn>GB number of gigabytes\n"
983 " <nn>T or <nn>TB number of terabytes\n"
984 " <nn>P or <nn>PB number of petabytes\n"
985 " <nn>E or <nn>EB number of exabytes\n"
986 " <nn>sects number of 512 byte sectors\n"));
989 else if (STRCASEEQ (cmd, "echo")) {
990 printf (_("echo - display a line of text\n"
991 " echo [<params> ...]\n"
993 " This echos the parameters to the terminal.\n"));
996 else if (STRCASEEQ (cmd, "edit") ||
997 STRCASEEQ (cmd, "vi") ||
998 STRCASEEQ (cmd, "emacs")) {
999 printf (_("edit - edit a file in the image\n"
1000 " edit <filename>\n"
1002 " This is used to edit a file.\n"
1004 " It is the equivalent of (and is implemented by)\n"
1005 " running \"cat\", editing locally, and then \"write-file\".\n"
1007 " Normally it uses $EDITOR, but if you use the aliases\n"
1008 " \"vi\" or \"emacs\" you will get those editors.\n"
1010 " NOTE: This will not work reliably for large files\n"
1011 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1014 else if (STRCASEEQ (cmd, "lcd")) {
1015 printf (_("lcd - local change directory\n"
1016 " lcd <directory>\n"
1018 " Change guestfish's current directory. This command is\n"
1019 " useful if you want to download files to a particular\n"
1023 else if (STRCASEEQ (cmd, "glob")) {
1024 printf (_("glob - expand wildcards in command\n"
1025 " glob <command> [<args> ...]\n"
1027 " Glob runs <command> with wildcards expanded in any\n"
1028 " command args. Note that the command is run repeatedly\n"
1029 " once for each expanded argument.\n"));
1032 else if (STRCASEEQ (cmd, "help")) {
1033 printf (_("help - display a list of commands or help on a command\n"
1038 else if (STRCASEEQ (cmd, "more") ||
1039 STRCASEEQ (cmd, "less")) {
1040 printf (_("more - view a file in the pager\n"
1041 " more <filename>\n"
1043 " This is used to view a file in the pager.\n"
1045 " It is the equivalent of (and is implemented by)\n"
1046 " running \"cat\" and using the pager.\n"
1048 " Normally it uses $PAGER, but if you use the alias\n"
1049 " \"less\" then it always uses \"less\".\n"
1051 " NOTE: This will not work reliably for large files\n"
1052 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1055 else if (STRCASEEQ (cmd, "quit") ||
1056 STRCASEEQ (cmd, "exit") ||
1057 STRCASEEQ (cmd, "q")) {
1058 printf (_("quit - quit guestfish\n"
1062 else if (STRCASEEQ (cmd, "reopen")) {
1063 printf (_("reopen - close and reopen the libguestfs handle\n"
1066 "Close and reopen the libguestfs handle. It is not necessary to use\n"
1067 "this normally, because the handle is closed properly when guestfish\n"
1068 "exits. However this is occasionally useful for testing.\n"));
1071 else if (STRCASEEQ (cmd, "sparse")) {
1072 printf (_("sparse - allocate a sparse image file\n"
1073 " sparse <filename> <size>\n"
1075 " This creates an empty sparse file of the given size,\n"
1076 " and then adds so it can be further examined.\n"
1078 " In all respects it works the same as the 'alloc'\n"
1079 " command, except that the image file is allocated\n"
1080 " sparsely, which means that disk blocks are not assigned\n"
1081 " to the file until they are needed. Sparse disk files\n"
1082 " only use space when written to, but they are slower\n"
1083 " and there is a danger you could run out of real disk\n"
1084 " space during a write operation.\n"
1086 " For more advanced image creation, see qemu-img utility.\n"
1088 " Size can be specified (where <nn> means a number):\n"
1089 " <nn> number of kilobytes\n"
1090 " eg: 1440 standard 3.5\" floppy\n"
1091 " <nn>K or <nn>KB number of kilobytes\n"
1092 " <nn>M or <nn>MB number of megabytes\n"
1093 " <nn>G or <nn>GB number of gigabytes\n"
1094 " <nn>T or <nn>TB number of terabytes\n"
1095 " <nn>P or <nn>PB number of petabytes\n"
1096 " <nn>E or <nn>EB number of exabytes\n"
1097 " <nn>sects number of 512 byte sectors\n"));
1100 else if (STRCASEEQ (cmd, "time")) {
1101 printf (_("time - measure time taken to run command\n"
1102 " time <command> [<args> ...]\n"
1104 " This runs <command> as usual, and prints the elapsed\n"
1105 " time afterwards.\n"));
1109 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
1115 /* This is printed when the user types in an unknown command for the
1116 * first command issued. A common case is the user doing:
1117 * guestfish disk.img
1118 * expecting guestfish to open 'disk.img' (in fact, this tried to
1119 * run a command 'disk.img').
1122 extended_help_message (void)
1125 _("Did you mean to open a disk image? guestfish -a disk.img\n"
1126 "For a list of commands: guestfish -h\n"
1127 "For complete documentation: man guestfish\n"));
1131 free_strings (char **argv)
1135 for (argc = 0; argv[argc] != NULL; ++argc)
1141 count_strings (char *const *argv)
1145 for (c = 0; argv[c]; ++c)
1151 print_strings (char *const *argv)
1155 for (argc = 0; argv[argc] != NULL; ++argc)
1156 printf ("%s\n", argv[argc]);
1160 print_table (char *const *argv)
1164 for (i = 0; argv[i] != NULL; i += 2)
1165 printf ("%s: %s\n", argv[i], argv[i+1]);
1169 is_true (const char *str)
1172 STRCASENEQ (str, "0") &&
1173 STRCASENEQ (str, "f") &&
1174 STRCASENEQ (str, "false") &&
1175 STRCASENEQ (str, "n") &&
1176 STRCASENEQ (str, "no");
1179 /* Free strings from a non-NULL terminated char** */
1181 free_n_strings (char **str, size_t len)
1185 for (i = 0; i < len; i++) {
1192 parse_string_list (const char *str)
1195 size_t argv_len = 0;
1197 /* Current position pointer */
1198 const char *p = str;
1200 /* Token might be simple:
1203 * 'This is a single token'
1204 * or contain embedded single-quoted sections:
1205 * This' is a sing'l'e to'ken
1207 * The latter may seem over-complicated, but it's what a normal shell does.
1208 * Not doing it risks surprising somebody.
1210 * This outer loop is over complete tokens.
1216 /* Skip leading whitespace */
1217 p += strspn (p, " \t");
1221 /* This loop is over token 'fragments'. A token can be in multiple bits if
1222 * it contains single quotes. We also treat both sides of an escaped quote
1223 * as separate fragments because we can't just copy it: we have to remove
1226 while (*p && (!c_isblank (*p) || in_quote)) {
1227 const char *end = p;
1229 /* Check if the fragment starts with a quote */
1231 /* Toggle in_quote */
1232 in_quote = !in_quote;
1234 /* Skip the quote */
1238 /* If we're in a quote, look for an end quote */
1240 end += strcspn (end, "'");
1243 /* Otherwise, look for whitespace or a quote */
1245 end += strcspn (end, " \t'");
1248 /* Grow the token to accommodate the fragment */
1249 size_t tok_end = tok_len;
1251 char *tok_new = realloc (tok, tok_len + 1);
1252 if (NULL == tok_new) {
1254 free_n_strings (argv, argv_len);
1256 exit (EXIT_FAILURE);
1260 /* Check if we stopped on an escaped quote */
1261 if ('\'' == *end && end != p && *(end-1) == '\\') {
1262 /* Add everything before \' to the token */
1263 memcpy (&tok[tok_end], p, end - p - 1);
1266 tok[tok_len-1] = '\'';
1268 /* Already processed the quote */
1273 /* Add the whole fragment */
1274 memcpy (&tok[tok_end], p, end - p);
1280 /* We've reached the end of a token. We shouldn't still be in quotes. */
1282 fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str);
1284 free_n_strings (argv, argv_len);
1289 /* Add this token if there is one. There might not be if there was
1290 * whitespace at the end of the input string */
1292 /* Add the NULL terminator */
1293 tok[tok_len] = '\0';
1295 /* Add the argument to the argument list */
1297 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1298 if (NULL == argv_new) {
1300 free_n_strings (argv, argv_len-1);
1302 exit (EXIT_FAILURE);
1306 argv[argv_len-1] = tok;
1310 /* NULL terminate the argument list */
1312 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1313 if (NULL == argv_new) {
1315 free_n_strings (argv, argv_len-1);
1316 exit (EXIT_FAILURE);
1320 argv[argv_len-1] = NULL;
1325 #ifdef HAVE_LIBREADLINE
1326 static char histfile[1024];
1327 static int nr_history_lines = 0;
1331 initialize_readline (void)
1333 #ifdef HAVE_LIBREADLINE
1336 home = getenv ("HOME");
1338 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1340 (void) read_history (histfile);
1343 rl_readline_name = "guestfish";
1344 rl_attempted_completion_function = do_completion;
1346 /* Note that .inputrc (or /etc/inputrc) is not read until the first
1347 * call the readline(), which happens later. Therefore, these
1348 * provide default values which can be overridden by the user if
1351 (void) rl_variable_bind ("completion-ignore-case", "on");
1356 cleanup_readline (void)
1358 #ifdef HAVE_LIBREADLINE
1361 if (histfile[0] != '\0') {
1362 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1369 #ifdef HAVE_APPEND_HISTORY
1370 (void) append_history (nr_history_lines, histfile);
1372 (void) write_history (histfile);
1378 #ifdef HAVE_LIBREADLINE
1380 add_history_line (const char *line)
1388 xwrite (int fd, const void *v_buf, size_t len)
1391 const char *buf = v_buf;
1394 r = write (fd, buf, len);
1406 /* Resolve the special "win:..." form for Windows-specific paths.
1407 * This always returns a newly allocated string which is freed by the
1408 * caller function in "cmds.c".
1411 resolve_win_path (const char *path)
1416 if (STRCASENEQLEN (path, "win:", 4)) {
1417 ret = strdup (path);
1425 /* Drop drive letter, if it's "C:". */
1426 if (STRCASEEQLEN (path, "c:", 2))
1436 ret = strdup (path);
1442 /* Blindly convert any backslashes into forward slashes. Is this good? */
1443 for (i = 0; i < strlen (ret); ++i)
1447 char *t = guestfs_case_sensitive_path (g, ret);