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.
21 #define _GNU_SOURCE // for strchrnul
33 #ifdef HAVE_LIBREADLINE
34 #include <readline/readline.h>
35 #include <readline/history.h>
48 static void mount_mps (struct mp *mp);
49 static void interactive (void);
50 static void shell_script (void);
51 static void script (int prompt);
52 static void cmdline (char *argv[], int optind, int argc);
53 static int issue_command (const char *cmd, char *argv[]);
54 static void initialize_readline (void);
55 static void cleanup_readline (void);
56 static void add_history_line (const char *);
58 /* Currently open libguestfs handle. */
66 launch (guestfs_h *_g)
70 if (guestfs_is_config (g)) {
71 if (guestfs_launch (g) == -1)
73 if (guestfs_wait_ready (g) == -1)
83 _("guestfish: guest filesystem shell\n"
84 "guestfish lets you edit virtual machine filesystems\n"
85 "Copyright (C) 2009 Red Hat Inc.\n"
87 " guestfish [--options] cmd [: cmd : cmd ...]\n"
88 "or for interactive use:\n"
90 "or from a shell script:\n"
96 " -h|--cmd-help List available commands\n"
97 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
98 " -a|--add image Add image\n"
99 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
100 " -n|--no-sync Don't autosync\n"
101 " -r|--ro Mount read-only\n"
102 " -v|--verbose Verbose messages\n"
103 " -V|--version Display version and exit\n"
104 "For more information, see the manpage guestfish(1).\n"));
108 main (int argc, char *argv[])
110 static const char *options = "a:h::m:nrv?V";
111 static struct option long_options[] = {
112 { "add", 1, 0, 'a' },
113 { "cmd-help", 2, 0, 'h' },
114 { "help", 0, 0, '?' },
115 { "mount", 1, 0, 'm' },
116 { "no-sync", 0, 0, 'n' },
118 { "verbose", 0, 0, 'v' },
119 { "version", 0, 0, 'V' },
122 struct mp *mps = NULL;
127 initialize_readline ();
129 /* guestfs_create is meant to be a lightweight operation, so
130 * it's OK to do it early here.
132 g = guestfs_create ();
134 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
138 guestfs_set_autosync (g, 1);
140 /* If developing, add ./appliance to the path. Note that libtools
141 * interferes with this because uninstalled guestfish is a shell
142 * script that runs the real program with an absolute path. Detect
145 * BUT if LIBGUESTFS_PATH environment variable is already set by
146 * the user, then don't override it.
148 if (getenv ("LIBGUESTFS_PATH") == NULL &&
150 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
151 guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
154 c = getopt_long (argc, argv, options, long_options, NULL);
159 if (access (optarg, R_OK) != 0) {
163 if (guestfs_add_drive (g, optarg) == -1)
169 display_command (optarg);
170 else if (argv[optind] && argv[optind][0] != '-')
171 display_command (argv[optind++]);
177 mp = malloc (sizeof (struct mp));
182 p = strchr (optarg, ':');
185 mp->mountpoint = p+1;
187 mp->mountpoint = "/";
194 guestfs_set_autosync (g, 0);
203 guestfs_set_verbose (g, verbose);
207 printf ("guestfish %s\n", PACKAGE_VERSION);
215 fprintf (stderr, _("guestfish: unexpected command line option 0x%x\n"),
221 /* If we've got mountpoints, we must launch the guest and mount them. */
223 if (launch (g) == -1) exit (1);
227 /* Interactive, shell script, or command(s) on the command line? */
228 if (optind >= argc) {
235 cmdline (argv, optind, argc);
243 pod2text (const char *heading, const char *str)
247 fp = popen ("pod2text", "w");
249 /* pod2text failed, maybe not found, so let's just print the
250 * source instead, since that's better than doing nothing.
252 printf ("%s\n\n%s\n", heading, str);
255 fputs ("=head1 ", fp);
262 /* List is built in reverse order, so mount them in reverse order. */
264 mount_mps (struct mp *mp)
269 mount_mps (mp->next);
271 r = guestfs_mount (g, mp->device, mp->mountpoint);
273 r = guestfs_mount_ro (g, mp->device, mp->mountpoint);
291 #define FISH "><fs> "
293 static char *line_read = NULL;
298 #ifdef HAVE_LIBREADLINE
306 line_read = readline (prompt ? FISH : "");
308 if (line_read && *line_read)
309 add_history_line (line_read);
314 #endif /* HAVE_LIBREADLINE */
316 static char buf[8192];
319 if (prompt) printf (FISH);
320 line_read = fgets (buf, sizeof buf, stdin);
323 len = strlen (line_read);
324 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
338 int global_exit_on_error = !prompt;
343 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
344 "editing virtual machine filesystems.\n"
346 "Type: 'help' for help with commands\n"
347 " 'quit' to quit the shell\n"
351 exit_on_error = global_exit_on_error;
353 buf = rl_gets (prompt);
359 /* Skip any initial whitespace before the command. */
361 while (*buf && isspace (*buf))
366 /* If the next character is '#' then this is a comment. */
367 if (*buf == '#') continue;
369 /* If the next character is '!' then pass the whole lot to system(3). */
377 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
378 WEXITSTATUS (r) != 0)
384 /* If the next character is '-' allow the command to fail without
385 * exiting on error (just for this one command though).
393 /* Get the command (cannot be quoted). */
394 len = strcspn (buf, " \t");
396 if (len == 0) continue;
400 if (buf[len] == '\0') {
407 p += strspn (p, " \t");
409 /* Get the parameters. */
410 while (*p && i < sizeof argv / sizeof argv[0]) {
411 /* Parameters which start with quotes or square brackets
412 * are treated specially. Bare parameters are delimited
417 len = strcspn (p, "\"");
418 if (p[len] == '\0') {
419 fprintf (stderr, _("guestfish: unterminated double quote\n"));
420 if (exit_on_error) exit (1);
423 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
424 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
425 if (exit_on_error) exit (1);
429 pend = p[len+1] ? &p[len+2] : &p[len+1];
430 } else if (*p == '\'') {
432 len = strcspn (p, "'");
433 if (p[len] == '\0') {
434 fprintf (stderr, _("guestfish: unterminated single quote\n"));
435 if (exit_on_error) exit (1);
438 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
439 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
440 if (exit_on_error) exit (1);
444 pend = p[len+1] ? &p[len+2] : &p[len+1];
446 } else if (*p == '[') {
450 while (*pend && c != 0) {
451 if (*pend == '[') c++;
452 else if (*pend == ']') c--;
456 fprintf (stderr, _("guestfish: unterminated \"[...]\" sequence\n"));
457 if (exit_on_error) exit (1);
460 if (*pend && (*pend != ' ' && *pend != '\t')) {
461 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
462 if (exit_on_error) exit (1);
467 } else if (*p != ' ' && *p != '\t') {
468 len = strcspn (p, " \t");
475 fprintf (stderr, _("guestfish: internal error parsing string at '%s'\n"),
484 p += strspn (p, " \t");
487 if (i == sizeof argv / sizeof argv[0]) {
488 fprintf (stderr, _("guestfish: too many arguments\n"));
489 if (exit_on_error) exit (1);
496 if (issue_command (cmd, argv) == -1) {
497 if (exit_on_error) exit (1);
502 if (prompt) printf ("\n");
506 cmdline (char *argv[], int optind, int argc)
511 if (optind >= argc) return;
513 cmd = argv[optind++];
514 if (strcmp (cmd, ":") == 0) {
515 fprintf (stderr, _("guestfish: empty command on command line\n"));
518 params = &argv[optind];
520 /* Search for end of command list or ":" ... */
521 while (optind < argc && strcmp (argv[optind], ":") != 0)
524 if (optind == argc) {
525 if (issue_command (cmd, params) == -1) exit (1);
528 if (issue_command (cmd, params) == -1) exit (1);
529 cmdline (argv, optind+1, argc);
534 issue_command (const char *cmd, char *argv[])
538 for (argc = 0; argv[argc] != NULL; ++argc)
541 if (strcasecmp (cmd, "help") == 0) {
545 display_command (argv[0]);
548 else if (strcasecmp (cmd, "quit") == 0 ||
549 strcasecmp (cmd, "exit") == 0 ||
550 strcasecmp (cmd, "q") == 0) {
554 else if (strcasecmp (cmd, "alloc") == 0 ||
555 strcasecmp (cmd, "allocate") == 0)
556 return do_alloc (cmd, argc, argv);
557 else if (strcasecmp (cmd, "echo") == 0)
558 return do_echo (cmd, argc, argv);
559 else if (strcasecmp (cmd, "edit") == 0 ||
560 strcasecmp (cmd, "vi") == 0 ||
561 strcasecmp (cmd, "emacs") == 0)
562 return do_edit (cmd, argc, argv);
564 return run_action (cmd, argc, argv);
568 list_builtin_commands (void)
570 /* help and quit should appear at the top */
571 printf ("%-20s %s\n",
572 "help", _("display a list of commands or help on a command"));
573 printf ("%-20s %s\n",
574 "quit", _("quit guestfish"));
576 printf ("%-20s %s\n",
577 "alloc", _("allocate an image"));
578 printf ("%-20s %s\n",
579 "echo", _("display a line of text"));
580 printf ("%-20s %s\n",
581 "edit", _("edit a file in the image"));
583 /* actions are printed after this (see list_commands) */
587 display_builtin_command (const char *cmd)
589 /* help for actions is auto-generated, see display_command */
591 if (strcasecmp (cmd, "alloc") == 0 ||
592 strcasecmp (cmd, "allocate") == 0)
593 printf (_("alloc - allocate an image\n"
594 " alloc <filename> <size>\n"
596 " This creates an empty (zeroed) file of the given size,\n"
597 " and then adds so it can be further examined.\n"
599 " For more advanced image creation, see qemu-img utility.\n"
601 " Size can be specified (where <nn> means a number):\n"
602 " <nn> number of kilobytes\n"
603 " eg: 1440 standard 3.5\" floppy\n"
604 " <nn>K or <nn>KB number of kilobytes\n"
605 " <nn>M or <nn>MB number of megabytes\n"
606 " <nn>G or <nn>GB number of gigabytes\n"
607 " <nn>sects number of 512 byte sectors\n"));
608 else if (strcasecmp (cmd, "echo") == 0)
609 printf (_("echo - display a line of text\n"
610 " echo [<params> ...]\n"
612 " This echos the parameters to the terminal.\n"));
613 else if (strcasecmp (cmd, "edit") == 0 ||
614 strcasecmp (cmd, "vi") == 0 ||
615 strcasecmp (cmd, "emacs") == 0)
616 printf (_("edit - edit a file in the image\n"
619 " This is used to edit a file.\n"
621 " It is the equivalent of (and is implemented by)\n"
622 " running \"cat\", editing locally, and then \"write-file\".\n"
624 " Normally it uses $EDITOR, but if you use the aliases\n"
625 " \"vi\" or \"emacs\" you will get those editors.\n"
627 " NOTE: This will not work reliably for large files\n"
628 " (> 2 MB) or binary files containing \\0 bytes.\n"));
629 else if (strcasecmp (cmd, "help") == 0)
630 printf (_("help - display a list of commands or help on a command\n"
633 else if (strcasecmp (cmd, "quit") == 0 ||
634 strcasecmp (cmd, "exit") == 0 ||
635 strcasecmp (cmd, "q") == 0)
636 printf (_("quit - quit guestfish\n"
639 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
644 free_strings (char **argv)
648 for (argc = 0; argv[argc] != NULL; ++argc)
654 print_strings (char * const * const argv)
658 for (argc = 0; argv[argc] != NULL; ++argc)
659 printf ("%s\n", argv[argc]);
663 print_table (char * const * const argv)
667 for (i = 0; argv[i] != NULL; i += 2)
668 printf ("%s: %s\n", argv[i], argv[i+1]);
672 is_true (const char *str)
675 strcasecmp (str, "0") != 0 &&
676 strcasecmp (str, "f") != 0 &&
677 strcasecmp (str, "false") != 0 &&
678 strcasecmp (str, "n") != 0 &&
679 strcasecmp (str, "no") != 0;
682 /* XXX We could improve list parsing. */
684 parse_string_list (const char *str)
687 const char *p, *pend;
691 for (i = 0; str[i]; ++i)
692 if (str[i] == ' ') argc++;
694 argv = malloc (sizeof (char *) * (argc+1));
695 if (argv == NULL) { perror ("malloc"); exit (1); }
700 pend = strchrnul (p, ' ');
701 argv[i] = strndup (p, pend-p);
703 p = *pend == ' ' ? pend+1 : pend;
710 #ifdef HAVE_LIBREADLINE
711 static char histfile[1024];
712 static int nr_history_lines = 0;
716 initialize_readline (void)
718 #ifdef HAVE_LIBREADLINE
721 home = getenv ("HOME");
723 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
725 (void) read_history (histfile);
728 rl_readline_name = "guestfish";
729 rl_attempted_completion_function = do_completion;
734 cleanup_readline (void)
736 #ifdef HAVE_LIBREADLINE
739 if (histfile[0] != '\0') {
740 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
747 (void) append_history (nr_history_lines, histfile);
753 add_history_line (const char *line)
755 #ifdef HAVE_LIBREADLINE