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. */
67 launch (guestfs_h *_g)
72 if (guestfs_launch (g) == -1)
74 if (guestfs_wait_ready (g) == -1)
85 "guestfish: guest filesystem shell\n"
86 "guestfish lets you edit virtual machine filesystems\n"
87 "Copyright (C) 2009 Red Hat Inc.\n"
89 " guestfish [--options] cmd [: cmd : cmd ...]\n"
90 "or for interactive use:\n"
92 "or from a shell script:\n"
98 " -h|--cmd-help List available commands\n"
99 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
100 " -a|--add image Add image\n"
101 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
102 " -n|--no-sync Don't autosync\n"
103 " -r|--ro Mount read-only\n"
104 " -v|--verbose Verbose messages\n"
105 " -V|--version Display version and exit\n"
106 "For more information, see the manpage guestfish(1).\n");
110 main (int argc, char *argv[])
112 static const char *options = "a:h::m:nrv?V";
113 static struct option long_options[] = {
114 { "add", 1, 0, 'a' },
115 { "cmd-help", 2, 0, 'h' },
116 { "help", 0, 0, '?' },
117 { "mount", 1, 0, 'm' },
118 { "no-sync", 0, 0, 'n' },
120 { "verbose", 0, 0, 'v' },
121 { "version", 0, 0, 'V' },
124 struct mp *mps = NULL;
129 initialize_readline ();
131 /* guestfs_create is meant to be a lightweight operation, so
132 * it's OK to do it early here.
134 g = guestfs_create ();
136 fprintf (stderr, "guestfs_create: failed to create handle\n");
140 guestfs_set_autosync (g, 1);
142 /* If developing, add . to the path. Note that libtools interferes
143 * with this because uninstalled guestfish is a shell script that runs
144 * the real program with an absolute path. Detect that too.
146 * BUT if LIBGUESTFS_PATH environment variable is already set by
147 * the user, then don't override it.
149 if (getenv ("LIBGUESTFS_PATH") == NULL &&
151 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
152 guestfs_set_path (g, ".:" GUESTFS_DEFAULT_PATH);
155 c = getopt_long (argc, argv, options, long_options, NULL);
160 if (access (optarg, R_OK) != 0) {
164 if (guestfs_add_drive (g, optarg) == -1)
170 display_command (optarg);
171 else if (argv[optind] && argv[optind][0] != '-')
172 display_command (argv[optind++]);
178 mp = malloc (sizeof (struct mp));
183 p = strchr (optarg, ':');
186 mp->mountpoint = p+1;
188 mp->mountpoint = "/";
195 guestfs_set_autosync (g, 0);
204 guestfs_set_verbose (g, verbose);
208 printf ("guestfish %s\n", PACKAGE_VERSION);
216 fprintf (stderr, "guestfish: unexpected command line option 0x%x\n", c);
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';
341 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
342 "editing virtual machine filesystems.\n"
344 "Type: 'help' for help with commands\n"
345 " 'quit' to quit the shell\n"
349 buf = rl_gets (prompt);
355 /* Skip any initial whitespace before the command. */
356 while (*buf && isspace (*buf))
361 /* If the next character is '#' then this is a comment. */
362 if (*buf == '#') continue;
364 /* If the next character is '!' then pass the whole lot to system(3). */
372 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
373 WEXITSTATUS (r) != 0)
379 /* Get the command (cannot be quoted). */
380 len = strcspn (buf, " \t");
382 if (len == 0) continue;
386 if (buf[len] == '\0') {
393 p += strspn (p, " \t");
395 /* Get the parameters. */
396 while (*p && i < sizeof argv / sizeof argv[0]) {
397 /* Parameters which start with quotes or square brackets
398 * are treated specially. Bare parameters are delimited
403 len = strcspn (p, "\"");
404 if (p[len] == '\0') {
405 fprintf (stderr, "guestfish: unterminated double quote\n");
406 if (!prompt) exit (1);
409 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
410 fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
411 if (!prompt) exit (1);
415 pend = p[len+1] ? &p[len+2] : &p[len+1];
416 } else if (*p == '\'') {
418 len = strcspn (p, "'");
419 if (p[len] == '\0') {
420 fprintf (stderr, "guestfish: unterminated single quote\n");
421 if (!prompt) exit (1);
424 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
425 fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
426 if (!prompt) exit (1);
430 pend = p[len+1] ? &p[len+2] : &p[len+1];
432 } else if (*p == '[') {
436 while (*pend && c != 0) {
437 if (*pend == '[') c++;
438 else if (*pend == ']') c--;
442 fprintf (stderr, "guestfish: unterminated \"[...]\" sequence\n");
443 if (!prompt) exit (1);
446 if (*pend && (*pend != ' ' && *pend != '\t')) {
447 fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
448 if (!prompt) exit (1);
453 } else if (*p != ' ' && *p != '\t') {
454 len = strcspn (p, " \t");
461 fprintf (stderr, "guestfish: internal error parsing string at '%s'\n",
470 p += strspn (p, " \t");
473 if (i == sizeof argv / sizeof argv[0]) {
474 fprintf (stderr, "guestfish: too many arguments\n");
475 if (!prompt) exit (1);
482 if (issue_command (cmd, argv) == -1) {
483 if (!prompt) exit (1);
488 if (prompt) printf ("\n");
492 cmdline (char *argv[], int optind, int argc)
497 if (optind >= argc) return;
499 cmd = argv[optind++];
500 if (strcmp (cmd, ":") == 0) {
501 fprintf (stderr, "guestfish: empty command on command line\n");
504 params = &argv[optind];
506 /* Search for end of command list or ":" ... */
507 while (optind < argc && strcmp (argv[optind], ":") != 0)
510 if (optind == argc) {
511 if (issue_command (cmd, params) == -1) exit (1);
514 if (issue_command (cmd, params) == -1) exit (1);
515 cmdline (argv, optind+1, argc);
520 issue_command (const char *cmd, char *argv[])
524 for (argc = 0; argv[argc] != NULL; ++argc)
527 if (strcasecmp (cmd, "help") == 0) {
531 display_command (argv[0]);
534 else if (strcasecmp (cmd, "quit") == 0 ||
535 strcasecmp (cmd, "exit") == 0 ||
536 strcasecmp (cmd, "q") == 0) {
540 else if (strcasecmp (cmd, "alloc") == 0 ||
541 strcasecmp (cmd, "allocate") == 0)
542 return do_alloc (cmd, argc, argv);
543 else if (strcasecmp (cmd, "echo") == 0)
544 return do_echo (cmd, argc, argv);
545 else if (strcasecmp (cmd, "edit") == 0 ||
546 strcasecmp (cmd, "vi") == 0 ||
547 strcasecmp (cmd, "emacs") == 0)
548 return do_edit (cmd, argc, argv);
550 return run_action (cmd, argc, argv);
554 list_builtin_commands (void)
556 /* help and quit should appear at the top */
557 printf ("%-20s %s\n",
558 "help", "display a list of commands or help on a command");
559 printf ("%-20s %s\n",
560 "quit", "quit guestfish");
562 printf ("%-20s %s\n",
563 "alloc", "allocate an image");
564 printf ("%-20s %s\n",
565 "echo", "display a line of text");
566 printf ("%-20s %s\n",
567 "edit", "edit a file in the image");
569 /* actions are printed after this (see list_commands) */
573 display_builtin_command (const char *cmd)
575 /* help for actions is auto-generated, see display_command */
577 if (strcasecmp (cmd, "alloc") == 0 ||
578 strcasecmp (cmd, "allocate") == 0)
579 printf ("alloc - allocate an image\n"
580 " alloc <filename> <size>\n"
582 " This creates an empty (zeroed) file of the given size,\n"
583 " and then adds so it can be further examined.\n"
585 " For more advanced image creation, see qemu-img utility.\n"
587 " Size can be specified (where <nn> means a number):\n"
588 " <nn> number of kilobytes\n"
589 " eg: 1440 standard 3.5\" floppy\n"
590 " <nn>K or <nn>KB number of kilobytes\n"
591 " <nn>M or <nn>MB number of megabytes\n"
592 " <nn>G or <nn>GB number of gigabytes\n"
593 " <nn>sects number of 512 byte sectors\n");
594 else if (strcasecmp (cmd, "echo") == 0)
595 printf ("echo - display a line of text\n"
596 " echo [<params> ...]\n"
598 " This echos the parameters to the terminal.\n");
599 else if (strcasecmp (cmd, "edit") == 0 ||
600 strcasecmp (cmd, "vi") == 0 ||
601 strcasecmp (cmd, "emacs") == 0)
602 printf ("edit - edit a file in the image\n"
605 " This is used to edit a file.\n"
607 " It is the equivalent of (and is implemented by)\n"
608 " running \"cat\", editing locally, and then \"write-file\".\n"
610 " Normally it uses $EDITOR, but if you use the aliases\n"
611 " \"vi\" or \"emacs\" you will get those editors.\n"
613 " NOTE: This will not work reliably for large files\n"
614 " (> 2 MB) or binary files containing \\0 bytes.\n");
615 else if (strcasecmp (cmd, "help") == 0)
616 printf ("help - display a list of commands or help on a command\n"
619 else if (strcasecmp (cmd, "quit") == 0 ||
620 strcasecmp (cmd, "exit") == 0 ||
621 strcasecmp (cmd, "q") == 0)
622 printf ("quit - quit guestfish\n"
625 fprintf (stderr, "%s: command not known, use -h to list all commands\n",
630 free_strings (char **argv)
634 for (argc = 0; argv[argc] != NULL; ++argc)
640 print_strings (char * const * const argv)
644 for (argc = 0; argv[argc] != NULL; ++argc)
645 printf ("%s\n", argv[argc]);
649 print_table (char * const * const argv)
653 for (i = 0; argv[i] != NULL; i += 2)
654 printf ("%s: %s\n", argv[i], argv[i+1]);
658 is_true (const char *str)
661 strcasecmp (str, "0") != 0 &&
662 strcasecmp (str, "f") != 0 &&
663 strcasecmp (str, "false") != 0 &&
664 strcasecmp (str, "n") != 0 &&
665 strcasecmp (str, "no") != 0;
668 /* XXX We could improve list parsing. */
670 parse_string_list (const char *str)
673 const char *p, *pend;
677 for (i = 0; str[i]; ++i)
678 if (str[i] == ' ') argc++;
680 argv = malloc (sizeof (char *) * (argc+1));
681 if (argv == NULL) { perror ("malloc"); exit (1); }
686 pend = strchrnul (p, ' ');
687 argv[i] = strndup (p, pend-p);
689 p = *pend == ' ' ? pend+1 : pend;
696 #ifdef HAVE_LIBREADLINE
697 static char histfile[1024];
698 static int nr_history_lines = 0;
702 initialize_readline (void)
704 #ifdef HAVE_LIBREADLINE
707 home = getenv ("HOME");
709 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
711 (void) read_history (histfile);
714 rl_readline_name = "guestfish";
715 rl_attempted_completion_function = do_completion;
720 cleanup_readline (void)
722 #ifdef HAVE_LIBREADLINE
725 if (histfile[0] != '\0') {
726 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
733 (void) append_history (nr_history_lines, histfile);
739 add_history_line (const char *line)
741 #ifdef HAVE_LIBREADLINE