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
32 #ifdef HAVE_LIBREADLINE
33 #include <readline/readline.h>
34 #include <readline/history.h>
47 static void mount_mps (struct mp *mp);
48 static void interactive (void);
49 static void shell_script (void);
50 static void script (int prompt);
51 static void cmdline (char *argv[], int optind, int argc);
52 static int issue_command (const char *cmd, char *argv[]);
53 static void initialize_readline (void);
54 static void cleanup_readline (void);
55 static void add_history_line (const char *);
57 /* Currently open libguestfs handle. */
66 launch (guestfs_h *_g)
71 if (guestfs_launch (g) == -1)
73 if (guestfs_wait_ready (g) == -1)
84 "guestfish: guest filesystem shell\n"
85 "guestfish lets you edit virtual machine filesystems\n"
86 "Copyright (C) 2009 Red Hat Inc.\n"
88 " guestfish [--options] cmd [: cmd : cmd ...]\n"
89 "or for interactive use:\n"
91 "or from a shell script:\n"
97 " -h|--cmd-help List available commands\n"
98 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
99 " -a|--add image Add image\n"
100 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
101 " -n|--no-sync Don't autosync\n"
102 " -r|--ro Mount read-only\n"
103 " -v|--verbose Verbose messages\n"
104 " -V|--version Display version and exit\n"
105 "For more information, see the manpage guestfish(1).\n");
109 main (int argc, char *argv[])
111 static const char *options = "a:h::m:nrv?V";
112 static struct option long_options[] = {
113 { "add", 1, 0, 'a' },
114 { "cmd-help", 2, 0, 'h' },
115 { "help", 0, 0, '?' },
116 { "mount", 1, 0, 'm' },
117 { "no-sync", 0, 0, 'n' },
119 { "verbose", 0, 0, 'v' },
120 { "version", 0, 0, 'V' },
123 struct mp *mps = NULL;
128 initialize_readline ();
130 /* guestfs_create is meant to be a lightweight operation, so
131 * it's OK to do it early here.
133 g = guestfs_create ();
135 fprintf (stderr, "guestfs_create: failed to create handle\n");
139 guestfs_set_autosync (g, 1);
141 /* If developing, add . to the path. Note that libtools interferes
142 * with this because uninstalled guestfish is a shell script that runs
143 * the real program with an absolute path. Detect that too.
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, ".:" 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", c);
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';
340 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
341 "editing virtual machine filesystems.\n"
343 "Type: 'help' for help with commands\n"
344 " 'quit' to quit the shell\n"
348 buf = rl_gets (prompt);
354 /* Skip any initial whitespace before the command. */
355 while (*buf && isspace (*buf))
360 /* If the next character is '#' then this is a comment. */
361 if (*buf == '#') continue;
363 /* If the next character is '!' then pass the whole lot to system(3). */
371 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
372 WEXITSTATUS (r) != 0)
378 /* Get the command (cannot be quoted). */
379 len = strcspn (buf, " \t");
381 if (len == 0) continue;
385 if (buf[len] == '\0') {
392 p += strspn (p, " \t");
394 /* Get the parameters. */
395 while (*p && i < sizeof argv / sizeof argv[0]) {
396 /* Parameters which start with quotes or square brackets
397 * are treated specially. Bare parameters are delimited
402 len = strcspn (p, "\"");
403 if (p[len] == '\0') {
404 fprintf (stderr, "guestfish: unterminated double quote\n");
405 if (!prompt) exit (1);
408 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
409 fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
410 if (!prompt) exit (1);
414 pend = p[len+1] ? &p[len+2] : &p[len+1];
415 } else if (*p == '\'') {
417 len = strcspn (p, "'");
418 if (p[len] == '\0') {
419 fprintf (stderr, "guestfish: unterminated single quote\n");
420 if (!prompt) 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 (!prompt) exit (1);
429 pend = p[len+1] ? &p[len+2] : &p[len+1];
431 } else if (*p == '[') {
435 while (*pend && c != 0) {
436 if (*pend == '[') c++;
437 else if (*pend == ']') c--;
441 fprintf (stderr, "guestfish: unterminated \"[...]\" sequence\n");
442 if (!prompt) exit (1);
445 if (*pend && (*pend != ' ' && *pend != '\t')) {
446 fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
447 if (!prompt) exit (1);
452 } else if (*p != ' ' && *p != '\t') {
453 len = strcspn (p, " \t");
460 fprintf (stderr, "guestfish: internal error parsing string at '%s'\n",
469 p += strspn (p, " \t");
472 if (i == sizeof argv / sizeof argv[0]) {
473 fprintf (stderr, "guestfish: too many arguments\n");
474 if (!prompt) exit (1);
481 if (issue_command (cmd, argv) == -1) {
482 if (!prompt) exit (1);
487 if (prompt) printf ("\n");
491 cmdline (char *argv[], int optind, int argc)
496 if (optind >= argc) return;
498 cmd = argv[optind++];
499 if (strcmp (cmd, ":") == 0) {
500 fprintf (stderr, "guestfish: empty command on command line\n");
503 params = &argv[optind];
505 /* Search for end of command list or ":" ... */
506 while (optind < argc && strcmp (argv[optind], ":") != 0)
509 if (optind == argc) {
510 if (issue_command (cmd, params) == -1) exit (1);
513 if (issue_command (cmd, params) == -1) exit (1);
514 cmdline (argv, optind+1, argc);
519 issue_command (const char *cmd, char *argv[])
523 for (argc = 0; argv[argc] != NULL; ++argc)
526 if (strcasecmp (cmd, "help") == 0) {
530 display_command (argv[0]);
533 else if (strcasecmp (cmd, "quit") == 0 ||
534 strcasecmp (cmd, "exit") == 0 ||
535 strcasecmp (cmd, "q") == 0) {
539 else if (strcasecmp (cmd, "alloc") == 0 ||
540 strcasecmp (cmd, "allocate") == 0)
541 return do_alloc (cmd, argc, argv);
542 else if (strcasecmp (cmd, "echo") == 0)
543 return do_echo (cmd, argc, argv);
544 else if (strcasecmp (cmd, "edit") == 0 ||
545 strcasecmp (cmd, "vi") == 0 ||
546 strcasecmp (cmd, "emacs") == 0)
547 return do_edit (cmd, argc, argv);
549 return run_action (cmd, argc, argv);
553 list_builtin_commands (void)
555 /* help and quit should appear at the top */
556 printf ("%-20s %s\n",
557 "help", "display a list of commands or help on a command");
558 printf ("%-20s %s\n",
559 "quit", "quit guestfish");
561 printf ("%-20s %s\n",
562 "alloc", "allocate an image");
563 printf ("%-20s %s\n",
564 "echo", "display a line of text");
565 printf ("%-20s %s\n",
566 "edit", "edit a file in the image");
568 /* actions are printed after this (see list_commands) */
572 display_builtin_command (const char *cmd)
574 /* help for actions is auto-generated, see display_command */
576 if (strcasecmp (cmd, "alloc") == 0 ||
577 strcasecmp (cmd, "allocate") == 0)
578 printf ("alloc - allocate an image\n"
579 " alloc <filename> <size>\n"
581 " This creates an empty (zeroed) file of the given size,\n"
582 " and then adds so it can be further examined.\n"
584 " For more advanced image creation, see qemu-img utility.\n"
586 " Size can be specified (where <nn> means a number):\n"
587 " <nn> number of kilobytes\n"
588 " eg: 1440 standard 3.5\" floppy\n"
589 " <nn>K or <nn>KB number of kilobytes\n"
590 " <nn>M or <nn>MB number of megabytes\n"
591 " <nn>G or <nn>GB number of gigabytes\n"
592 " <nn>sects number of 512 byte sectors\n");
593 else if (strcasecmp (cmd, "echo") == 0)
594 printf ("echo - display a line of text\n"
595 " echo [<params> ...]\n"
597 " This echos the parameters to the terminal.\n");
598 else if (strcasecmp (cmd, "edit") == 0 ||
599 strcasecmp (cmd, "vi") == 0 ||
600 strcasecmp (cmd, "emacs") == 0)
601 printf ("edit - edit a file in the image\n"
604 " This is used to edit a file.\n"
606 " It is the equivalent of (and is implemented by)\n"
607 " running \"cat\", editing locally, and then \"write-file\".\n"
609 " Normally it uses $EDITOR, but if you use the aliases\n"
610 " \"vi\" or \"emacs\" you will get those editors.\n"
612 " NOTE: This will not work reliably for large files\n"
613 " (> 2 MB) or binary files containing \\0 bytes.\n");
614 else if (strcasecmp (cmd, "help") == 0)
615 printf ("help - display a list of commands or help on a command\n"
618 else if (strcasecmp (cmd, "quit") == 0 ||
619 strcasecmp (cmd, "exit") == 0 ||
620 strcasecmp (cmd, "q") == 0)
621 printf ("quit - quit guestfish\n"
624 fprintf (stderr, "%s: command not known, use -h to list all commands\n",
629 free_strings (char **argv)
633 for (argc = 0; argv[argc] != NULL; ++argc)
639 print_strings (char * const * const argv)
643 for (argc = 0; argv[argc] != NULL; ++argc)
644 printf ("%s\n", argv[argc]);
648 print_table (char * const * const argv)
652 for (i = 0; argv[i] != NULL; i += 2)
653 printf ("%s: %s\n", argv[i], argv[i+1]);
657 is_true (const char *str)
660 strcasecmp (str, "0") != 0 &&
661 strcasecmp (str, "f") != 0 &&
662 strcasecmp (str, "false") != 0 &&
663 strcasecmp (str, "n") != 0 &&
664 strcasecmp (str, "no") != 0;
667 /* XXX We could improve list parsing. */
669 parse_string_list (const char *str)
672 const char *p, *pend;
676 for (i = 0; str[i]; ++i)
677 if (str[i] == ' ') argc++;
679 argv = malloc (sizeof (char *) * (argc+1));
680 if (argv == NULL) { perror ("malloc"); exit (1); }
685 pend = strchrnul (p, ' ');
686 argv[i] = strndup (p, pend-p);
688 p = *pend == ' ' ? pend+1 : pend;
695 #ifdef HAVE_LIBREADLINE
696 static char histfile[1024];
697 static int nr_history_lines = 0;
701 initialize_readline (void)
703 #ifdef HAVE_LIBREADLINE
706 home = getenv ("HOME");
708 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
710 (void) read_history (histfile);
713 rl_readline_name = "guestfish";
714 rl_attempted_completion_function = do_completion;
719 cleanup_readline (void)
721 #ifdef HAVE_LIBREADLINE
724 if (histfile[0] != '\0') {
725 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
732 (void) append_history (nr_history_lines, histfile);
738 add_history_line (const char *line)
740 #ifdef HAVE_LIBREADLINE