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 . to the path. Note that libtools interferes
141 * with this because uninstalled guestfish is a shell script that runs
142 * the real program with an absolute path. Detect that too.
144 * BUT if LIBGUESTFS_PATH environment variable is already set by
145 * the user, then don't override it.
147 if (getenv ("LIBGUESTFS_PATH") == NULL &&
149 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
150 guestfs_set_path (g, ".:" GUESTFS_DEFAULT_PATH);
153 c = getopt_long (argc, argv, options, long_options, NULL);
158 if (access (optarg, R_OK) != 0) {
162 if (guestfs_add_drive (g, optarg) == -1)
168 display_command (optarg);
169 else if (argv[optind] && argv[optind][0] != '-')
170 display_command (argv[optind++]);
176 mp = malloc (sizeof (struct mp));
181 p = strchr (optarg, ':');
184 mp->mountpoint = p+1;
186 mp->mountpoint = "/";
193 guestfs_set_autosync (g, 0);
202 guestfs_set_verbose (g, verbose);
206 printf ("guestfish %s\n", PACKAGE_VERSION);
214 fprintf (stderr, _("guestfish: unexpected command line option 0x%x\n"),
220 /* If we've got mountpoints, we must launch the guest and mount them. */
222 if (launch (g) == -1) exit (1);
226 /* Interactive, shell script, or command(s) on the command line? */
227 if (optind >= argc) {
234 cmdline (argv, optind, argc);
242 pod2text (const char *heading, const char *str)
246 fp = popen ("pod2text", "w");
248 /* pod2text failed, maybe not found, so let's just print the
249 * source instead, since that's better than doing nothing.
251 printf ("%s\n\n%s\n", heading, str);
254 fputs ("=head1 ", fp);
261 /* List is built in reverse order, so mount them in reverse order. */
263 mount_mps (struct mp *mp)
268 mount_mps (mp->next);
270 r = guestfs_mount (g, mp->device, mp->mountpoint);
272 r = guestfs_mount_ro (g, mp->device, mp->mountpoint);
290 #define FISH "><fs> "
292 static char *line_read = NULL;
297 #ifdef HAVE_LIBREADLINE
305 line_read = readline (prompt ? FISH : "");
307 if (line_read && *line_read)
308 add_history_line (line_read);
313 #endif /* HAVE_LIBREADLINE */
315 static char buf[8192];
318 if (prompt) printf (FISH);
319 line_read = fgets (buf, sizeof buf, stdin);
322 len = strlen (line_read);
323 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
337 int global_exit_on_error = !prompt;
342 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
343 "editing virtual machine filesystems.\n"
345 "Type: 'help' for help with commands\n"
346 " 'quit' to quit the shell\n"
350 exit_on_error = global_exit_on_error;
352 buf = rl_gets (prompt);
358 /* Skip any initial whitespace before the command. */
360 while (*buf && isspace (*buf))
365 /* If the next character is '#' then this is a comment. */
366 if (*buf == '#') continue;
368 /* If the next character is '!' then pass the whole lot to system(3). */
376 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
377 WEXITSTATUS (r) != 0)
383 /* If the next character is '-' allow the command to fail without
384 * exiting on error (just for this one command though).
392 /* Get the command (cannot be quoted). */
393 len = strcspn (buf, " \t");
395 if (len == 0) continue;
399 if (buf[len] == '\0') {
406 p += strspn (p, " \t");
408 /* Get the parameters. */
409 while (*p && i < sizeof argv / sizeof argv[0]) {
410 /* Parameters which start with quotes or square brackets
411 * are treated specially. Bare parameters are delimited
416 len = strcspn (p, "\"");
417 if (p[len] == '\0') {
418 fprintf (stderr, _("guestfish: unterminated double quote\n"));
419 if (exit_on_error) exit (1);
422 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
423 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
424 if (exit_on_error) exit (1);
428 pend = p[len+1] ? &p[len+2] : &p[len+1];
429 } else if (*p == '\'') {
431 len = strcspn (p, "'");
432 if (p[len] == '\0') {
433 fprintf (stderr, _("guestfish: unterminated single quote\n"));
434 if (exit_on_error) exit (1);
437 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
438 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
439 if (exit_on_error) exit (1);
443 pend = p[len+1] ? &p[len+2] : &p[len+1];
445 } else if (*p == '[') {
449 while (*pend && c != 0) {
450 if (*pend == '[') c++;
451 else if (*pend == ']') c--;
455 fprintf (stderr, _("guestfish: unterminated \"[...]\" sequence\n"));
456 if (exit_on_error) exit (1);
459 if (*pend && (*pend != ' ' && *pend != '\t')) {
460 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
461 if (exit_on_error) exit (1);
466 } else if (*p != ' ' && *p != '\t') {
467 len = strcspn (p, " \t");
474 fprintf (stderr, _("guestfish: internal error parsing string at '%s'\n"),
483 p += strspn (p, " \t");
486 if (i == sizeof argv / sizeof argv[0]) {
487 fprintf (stderr, _("guestfish: too many arguments\n"));
488 if (exit_on_error) exit (1);
495 if (issue_command (cmd, argv) == -1) {
496 if (exit_on_error) exit (1);
501 if (prompt) printf ("\n");
505 cmdline (char *argv[], int optind, int argc)
510 if (optind >= argc) return;
512 cmd = argv[optind++];
513 if (strcmp (cmd, ":") == 0) {
514 fprintf (stderr, _("guestfish: empty command on command line\n"));
517 params = &argv[optind];
519 /* Search for end of command list or ":" ... */
520 while (optind < argc && strcmp (argv[optind], ":") != 0)
523 if (optind == argc) {
524 if (issue_command (cmd, params) == -1) exit (1);
527 if (issue_command (cmd, params) == -1) exit (1);
528 cmdline (argv, optind+1, argc);
533 issue_command (const char *cmd, char *argv[])
537 for (argc = 0; argv[argc] != NULL; ++argc)
540 if (strcasecmp (cmd, "help") == 0) {
544 display_command (argv[0]);
547 else if (strcasecmp (cmd, "quit") == 0 ||
548 strcasecmp (cmd, "exit") == 0 ||
549 strcasecmp (cmd, "q") == 0) {
553 else if (strcasecmp (cmd, "alloc") == 0 ||
554 strcasecmp (cmd, "allocate") == 0)
555 return do_alloc (cmd, argc, argv);
556 else if (strcasecmp (cmd, "echo") == 0)
557 return do_echo (cmd, argc, argv);
558 else if (strcasecmp (cmd, "edit") == 0 ||
559 strcasecmp (cmd, "vi") == 0 ||
560 strcasecmp (cmd, "emacs") == 0)
561 return do_edit (cmd, argc, argv);
563 return run_action (cmd, argc, argv);
567 list_builtin_commands (void)
569 /* help and quit should appear at the top */
570 printf ("%-20s %s\n",
571 "help", _("display a list of commands or help on a command"));
572 printf ("%-20s %s\n",
573 "quit", _("quit guestfish"));
575 printf ("%-20s %s\n",
576 "alloc", _("allocate an image"));
577 printf ("%-20s %s\n",
578 "echo", _("display a line of text"));
579 printf ("%-20s %s\n",
580 "edit", _("edit a file in the image"));
582 /* actions are printed after this (see list_commands) */
586 display_builtin_command (const char *cmd)
588 /* help for actions is auto-generated, see display_command */
590 if (strcasecmp (cmd, "alloc") == 0 ||
591 strcasecmp (cmd, "allocate") == 0)
592 printf (_("alloc - allocate an image\n"
593 " alloc <filename> <size>\n"
595 " This creates an empty (zeroed) file of the given size,\n"
596 " and then adds so it can be further examined.\n"
598 " For more advanced image creation, see qemu-img utility.\n"
600 " Size can be specified (where <nn> means a number):\n"
601 " <nn> number of kilobytes\n"
602 " eg: 1440 standard 3.5\" floppy\n"
603 " <nn>K or <nn>KB number of kilobytes\n"
604 " <nn>M or <nn>MB number of megabytes\n"
605 " <nn>G or <nn>GB number of gigabytes\n"
606 " <nn>sects number of 512 byte sectors\n"));
607 else if (strcasecmp (cmd, "echo") == 0)
608 printf (_("echo - display a line of text\n"
609 " echo [<params> ...]\n"
611 " This echos the parameters to the terminal.\n"));
612 else if (strcasecmp (cmd, "edit") == 0 ||
613 strcasecmp (cmd, "vi") == 0 ||
614 strcasecmp (cmd, "emacs") == 0)
615 printf (_("edit - edit a file in the image\n"
618 " This is used to edit a file.\n"
620 " It is the equivalent of (and is implemented by)\n"
621 " running \"cat\", editing locally, and then \"write-file\".\n"
623 " Normally it uses $EDITOR, but if you use the aliases\n"
624 " \"vi\" or \"emacs\" you will get those editors.\n"
626 " NOTE: This will not work reliably for large files\n"
627 " (> 2 MB) or binary files containing \\0 bytes.\n"));
628 else if (strcasecmp (cmd, "help") == 0)
629 printf (_("help - display a list of commands or help on a command\n"
632 else if (strcasecmp (cmd, "quit") == 0 ||
633 strcasecmp (cmd, "exit") == 0 ||
634 strcasecmp (cmd, "q") == 0)
635 printf (_("quit - quit guestfish\n"
638 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
643 free_strings (char **argv)
647 for (argc = 0; argv[argc] != NULL; ++argc)
653 print_strings (char * const * const argv)
657 for (argc = 0; argv[argc] != NULL; ++argc)
658 printf ("%s\n", argv[argc]);
662 print_table (char * const * const argv)
666 for (i = 0; argv[i] != NULL; i += 2)
667 printf ("%s: %s\n", argv[i], argv[i+1]);
671 is_true (const char *str)
674 strcasecmp (str, "0") != 0 &&
675 strcasecmp (str, "f") != 0 &&
676 strcasecmp (str, "false") != 0 &&
677 strcasecmp (str, "n") != 0 &&
678 strcasecmp (str, "no") != 0;
681 /* XXX We could improve list parsing. */
683 parse_string_list (const char *str)
686 const char *p, *pend;
690 for (i = 0; str[i]; ++i)
691 if (str[i] == ' ') argc++;
693 argv = malloc (sizeof (char *) * (argc+1));
694 if (argv == NULL) { perror ("malloc"); exit (1); }
699 pend = strchrnul (p, ' ');
700 argv[i] = strndup (p, pend-p);
702 p = *pend == ' ' ? pend+1 : pend;
709 #ifdef HAVE_LIBREADLINE
710 static char histfile[1024];
711 static int nr_history_lines = 0;
715 initialize_readline (void)
717 #ifdef HAVE_LIBREADLINE
720 home = getenv ("HOME");
722 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
724 (void) read_history (histfile);
727 rl_readline_name = "guestfish";
728 rl_attempted_completion_function = do_completion;
733 cleanup_readline (void)
735 #ifdef HAVE_LIBREADLINE
738 if (histfile[0] != '\0') {
739 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
746 (void) append_history (nr_history_lines, histfile);
752 add_history_line (const char *line)
754 #ifdef HAVE_LIBREADLINE