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>
53 static void add_drives (struct drv *drv);
54 static void mount_mps (struct mp *mp);
55 static void interactive (void);
56 static void shell_script (void);
57 static void script (int prompt);
58 static void cmdline (char *argv[], int optind, int argc);
59 static void initialize_readline (void);
60 static void cleanup_readline (void);
61 static void add_history_line (const char *);
63 /* Currently open libguestfs handle. */
71 launch (guestfs_h *_g)
75 if (guestfs_is_config (g)) {
76 if (guestfs_launch (g) == -1)
78 if (guestfs_wait_ready (g) == -1)
88 _("guestfish: guest filesystem shell\n"
89 "guestfish lets you edit virtual machine filesystems\n"
90 "Copyright (C) 2009 Red Hat Inc.\n"
92 " guestfish [--options] cmd [: cmd : cmd ...]\n"
93 " guestfish -i libvirt-domain\n"
94 " guestfish -i disk-image(s)\n"
95 "or for interactive use:\n"
97 "or from a shell script:\n"
103 " -h|--cmd-help List available commands\n"
104 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
105 " -a|--add image Add image\n"
106 " -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
107 " -f|--file file Read commands from file\n"
108 " -i|--inspector Run virt-inspector to get disk mountpoints\n"
109 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
110 " -n|--no-sync Don't autosync\n"
111 " -r|--ro Mount read-only\n"
112 " -v|--verbose Verbose messages\n"
113 " -V|--version Display version and exit\n"
114 "For more information, see the manpage guestfish(1).\n"));
118 main (int argc, char *argv[])
120 static const char *options = "a:f:h::im:nrv?V";
121 static struct option long_options[] = {
122 { "add", 1, 0, 'a' },
123 { "cmd-help", 2, 0, 'h' },
124 { "file", 1, 0, 'f' },
125 { "help", 0, 0, '?' },
126 { "inspector", 0, 0, 'i' },
127 { "mount", 1, 0, 'm' },
128 { "no-dest-paths", 0, 0, 'D' },
129 { "no-sync", 0, 0, 'n' },
131 { "verbose", 0, 0, 'v' },
132 { "version", 0, 0, 'V' },
135 struct drv *drvs = NULL;
137 struct mp *mps = NULL;
139 char *p, *file = NULL;
140 int c, inspector = 0;
142 initialize_readline ();
144 /* guestfs_create is meant to be a lightweight operation, so
145 * it's OK to do it early here.
147 g = guestfs_create ();
149 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
153 guestfs_set_autosync (g, 1);
155 /* If developing, add ./appliance to the path. Note that libtools
156 * interferes with this because uninstalled guestfish is a shell
157 * script that runs the real program with an absolute path. Detect
160 * BUT if LIBGUESTFS_PATH environment variable is already set by
161 * the user, then don't override it.
163 if (getenv ("LIBGUESTFS_PATH") == NULL &&
165 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
166 guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
169 c = getopt_long (argc, argv, options, long_options, NULL);
174 if (access (optarg, R_OK) != 0) {
178 drv = malloc (sizeof (struct drv));
183 drv->filename = optarg;
189 complete_dest_paths = 0;
194 fprintf (stderr, _("guestfish: only one -f parameter can be given\n"));
202 display_command (optarg);
203 else if (argv[optind] && argv[optind][0] != '-')
204 display_command (argv[optind++]);
214 mp = malloc (sizeof (struct mp));
219 p = strchr (optarg, ':');
222 mp->mountpoint = p+1;
224 mp->mountpoint = "/";
231 guestfs_set_autosync (g, 0);
240 guestfs_set_verbose (g, verbose);
244 printf ("guestfish %s\n", PACKAGE_VERSION);
252 fprintf (stderr, _("guestfish: unexpected command line option 0x%x\n"),
258 /* Inspector mode invalidates most of the other arguments. */
264 fprintf (stderr, _("guestfish: cannot use -i option with -a or -m\n"));
267 if (optind >= argc) {
268 fprintf (stderr, _("guestfish -i requires a libvirt domain or path(s) to disk image(s)\n"));
272 strcpy (cmd, "a=`virt-inspector");
273 while (optind < argc) {
274 if (strlen (cmd) + strlen (argv[optind]) + strlen (argv[0]) + 60
276 fprintf (stderr, _("guestfish: virt-inspector command too long for fixed-size buffer\n"));
280 strcat (cmd, argv[optind]);
286 strcat (cmd, " --ro-fish");
288 strcat (cmd, " --fish");
290 sprintf (&cmd[strlen(cmd)], "` && %s $a", argv[0]);
292 if (guestfs_get_verbose (g))
294 if (!guestfs_get_autosync (g))
297 /*printf ("%s\n", cmd);*/
304 exit (WEXITSTATUS (r));
307 /* If we've got drives to add, add them now. */
310 /* If we've got mountpoints, we must launch the guest and mount them. */
312 if (launch (g) == -1) exit (1);
316 /* -f (file) parameter? */
319 if (open (file, O_RDONLY) == -1) {
325 /* Interactive, shell script, or command(s) on the command line? */
326 if (optind >= argc) {
333 cmdline (argv, optind, argc);
341 pod2text (const char *heading, const char *str)
345 fp = popen ("pod2text", "w");
347 /* pod2text failed, maybe not found, so let's just print the
348 * source instead, since that's better than doing nothing.
350 printf ("%s\n\n%s\n", heading, str);
353 fputs ("=head1 ", fp);
360 /* List is built in reverse order, so mount them in reverse order. */
362 mount_mps (struct mp *mp)
367 mount_mps (mp->next);
369 r = guestfs_mount (g, mp->device, mp->mountpoint);
371 r = guestfs_mount_ro (g, mp->device, mp->mountpoint);
378 add_drives (struct drv *drv)
383 add_drives (drv->next);
385 r = guestfs_add_drive (g, drv->filename);
387 r = guestfs_add_drive_ro (g, drv->filename);
405 #define FISH "><fs> "
407 static char *line_read = NULL;
412 #ifdef HAVE_LIBREADLINE
420 line_read = readline (prompt ? FISH : "");
422 if (line_read && *line_read)
423 add_history_line (line_read);
428 #endif /* HAVE_LIBREADLINE */
430 static char buf[8192];
433 if (prompt) printf (FISH);
434 line_read = fgets (buf, sizeof buf, stdin);
437 len = strlen (line_read);
438 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
452 int global_exit_on_error = !prompt;
457 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
458 "editing virtual machine filesystems.\n"
460 "Type: 'help' for help with commands\n"
461 " 'quit' to quit the shell\n"
465 exit_on_error = global_exit_on_error;
467 buf = rl_gets (prompt);
473 /* Skip any initial whitespace before the command. */
475 while (*buf && isspace (*buf))
480 /* If the next character is '#' then this is a comment. */
481 if (*buf == '#') continue;
483 /* If the next character is '!' then pass the whole lot to system(3). */
491 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
492 WEXITSTATUS (r) != 0)
498 /* If the next character is '-' allow the command to fail without
499 * exiting on error (just for this one command though).
507 /* Get the command (cannot be quoted). */
508 len = strcspn (buf, " \t");
510 if (len == 0) continue;
514 if (buf[len] == '\0') {
521 p += strspn (p, " \t");
523 /* Get the parameters. */
524 while (*p && i < sizeof argv / sizeof argv[0]) {
525 /* Parameters which start with quotes or square brackets
526 * are treated specially. Bare parameters are delimited
531 len = strcspn (p, "\"");
532 if (p[len] == '\0') {
533 fprintf (stderr, _("guestfish: unterminated double quote\n"));
534 if (exit_on_error) exit (1);
537 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
538 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
539 if (exit_on_error) exit (1);
543 pend = p[len+1] ? &p[len+2] : &p[len+1];
544 } else if (*p == '\'') {
546 len = strcspn (p, "'");
547 if (p[len] == '\0') {
548 fprintf (stderr, _("guestfish: unterminated single quote\n"));
549 if (exit_on_error) exit (1);
552 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
553 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
554 if (exit_on_error) exit (1);
558 pend = p[len+1] ? &p[len+2] : &p[len+1];
560 } else if (*p == '[') {
564 while (*pend && c != 0) {
565 if (*pend == '[') c++;
566 else if (*pend == ']') c--;
570 fprintf (stderr, _("guestfish: unterminated \"[...]\" sequence\n"));
571 if (exit_on_error) exit (1);
574 if (*pend && (*pend != ' ' && *pend != '\t')) {
575 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
576 if (exit_on_error) exit (1);
581 } else if (*p != ' ' && *p != '\t') {
582 len = strcspn (p, " \t");
589 fprintf (stderr, _("guestfish: internal error parsing string at '%s'\n"),
598 p += strspn (p, " \t");
601 if (i == sizeof argv / sizeof argv[0]) {
602 fprintf (stderr, _("guestfish: too many arguments\n"));
603 if (exit_on_error) exit (1);
610 if (issue_command (cmd, argv) == -1) {
611 if (exit_on_error) exit (1);
616 if (prompt) printf ("\n");
620 cmdline (char *argv[], int optind, int argc)
625 if (optind >= argc) return;
627 cmd = argv[optind++];
628 if (strcmp (cmd, ":") == 0) {
629 fprintf (stderr, _("guestfish: empty command on command line\n"));
632 params = &argv[optind];
634 /* Search for end of command list or ":" ... */
635 while (optind < argc && strcmp (argv[optind], ":") != 0)
638 if (optind == argc) {
639 if (issue_command (cmd, params) == -1) exit (1);
642 if (issue_command (cmd, params) == -1) exit (1);
643 cmdline (argv, optind+1, argc);
648 issue_command (const char *cmd, char *argv[])
652 for (argc = 0; argv[argc] != NULL; ++argc)
655 if (strcasecmp (cmd, "help") == 0) {
659 display_command (argv[0]);
662 else if (strcasecmp (cmd, "quit") == 0 ||
663 strcasecmp (cmd, "exit") == 0 ||
664 strcasecmp (cmd, "q") == 0) {
668 else if (strcasecmp (cmd, "alloc") == 0 ||
669 strcasecmp (cmd, "allocate") == 0)
670 return do_alloc (cmd, argc, argv);
671 else if (strcasecmp (cmd, "echo") == 0)
672 return do_echo (cmd, argc, argv);
673 else if (strcasecmp (cmd, "edit") == 0 ||
674 strcasecmp (cmd, "vi") == 0 ||
675 strcasecmp (cmd, "emacs") == 0)
676 return do_edit (cmd, argc, argv);
677 else if (strcasecmp (cmd, "lcd") == 0)
678 return do_lcd (cmd, argc, argv);
679 else if (strcasecmp (cmd, "glob") == 0)
680 return do_glob (cmd, argc, argv);
682 return run_action (cmd, argc, argv);
686 list_builtin_commands (void)
688 /* help and quit should appear at the top */
689 printf ("%-20s %s\n",
690 "help", _("display a list of commands or help on a command"));
691 printf ("%-20s %s\n",
692 "quit", _("quit guestfish"));
694 printf ("%-20s %s\n",
695 "alloc", _("allocate an image"));
696 printf ("%-20s %s\n",
697 "echo", _("display a line of text"));
698 printf ("%-20s %s\n",
699 "edit", _("edit a file in the image"));
700 printf ("%-20s %s\n",
701 "lcd", _("local change directory"));
702 printf ("%-20s %s\n",
703 "glob", _("expand wildcards in command"));
705 /* actions are printed after this (see list_commands) */
709 display_builtin_command (const char *cmd)
711 /* help for actions is auto-generated, see display_command */
713 if (strcasecmp (cmd, "alloc") == 0 ||
714 strcasecmp (cmd, "allocate") == 0)
715 printf (_("alloc - allocate an image\n"
716 " alloc <filename> <size>\n"
718 " This creates an empty (zeroed) file of the given size,\n"
719 " and then adds so it can be further examined.\n"
721 " For more advanced image creation, see qemu-img utility.\n"
723 " Size can be specified (where <nn> means a number):\n"
724 " <nn> number of kilobytes\n"
725 " eg: 1440 standard 3.5\" floppy\n"
726 " <nn>K or <nn>KB number of kilobytes\n"
727 " <nn>M or <nn>MB number of megabytes\n"
728 " <nn>G or <nn>GB number of gigabytes\n"
729 " <nn>sects number of 512 byte sectors\n"));
730 else if (strcasecmp (cmd, "echo") == 0)
731 printf (_("echo - display a line of text\n"
732 " echo [<params> ...]\n"
734 " This echos the parameters to the terminal.\n"));
735 else if (strcasecmp (cmd, "edit") == 0 ||
736 strcasecmp (cmd, "vi") == 0 ||
737 strcasecmp (cmd, "emacs") == 0)
738 printf (_("edit - edit a file in the image\n"
741 " This is used to edit a file.\n"
743 " It is the equivalent of (and is implemented by)\n"
744 " running \"cat\", editing locally, and then \"write-file\".\n"
746 " Normally it uses $EDITOR, but if you use the aliases\n"
747 " \"vi\" or \"emacs\" you will get those editors.\n"
749 " NOTE: This will not work reliably for large files\n"
750 " (> 2 MB) or binary files containing \\0 bytes.\n"));
751 else if (strcasecmp (cmd, "lcd") == 0)
752 printf (_("lcd - local change directory\n"
755 " Change guestfish's current directory. This command is\n"
756 " useful if you want to download files to a particular\n"
758 else if (strcasecmp (cmd, "glob") == 0)
759 printf (_("glob - expand wildcards in command\n"
760 " glob <command> [<args> ...]\n"
762 " Glob runs <command> with wildcards expanded in any\n"
763 " command args. Note that the command is run repeatedly\n"
764 " once for each expanded argument.\n"));
765 else if (strcasecmp (cmd, "help") == 0)
766 printf (_("help - display a list of commands or help on a command\n"
769 else if (strcasecmp (cmd, "quit") == 0 ||
770 strcasecmp (cmd, "exit") == 0 ||
771 strcasecmp (cmd, "q") == 0)
772 printf (_("quit - quit guestfish\n"
775 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
780 free_strings (char **argv)
784 for (argc = 0; argv[argc] != NULL; ++argc)
790 count_strings (char * const * const argv)
794 for (c = 0; argv[c]; ++c)
800 print_strings (char * const * const argv)
804 for (argc = 0; argv[argc] != NULL; ++argc)
805 printf ("%s\n", argv[argc]);
809 print_table (char * const * const argv)
813 for (i = 0; argv[i] != NULL; i += 2)
814 printf ("%s: %s\n", argv[i], argv[i+1]);
818 is_true (const char *str)
821 strcasecmp (str, "0") != 0 &&
822 strcasecmp (str, "f") != 0 &&
823 strcasecmp (str, "false") != 0 &&
824 strcasecmp (str, "n") != 0 &&
825 strcasecmp (str, "no") != 0;
828 /* XXX We could improve list parsing. */
830 parse_string_list (const char *str)
833 const char *p, *pend;
837 for (i = 0; str[i]; ++i)
838 if (str[i] == ' ') argc++;
840 argv = malloc (sizeof (char *) * (argc+1));
841 if (argv == NULL) { perror ("malloc"); exit (1); }
846 pend = strchrnul (p, ' ');
847 argv[i] = strndup (p, pend-p);
849 p = *pend == ' ' ? pend+1 : pend;
856 #ifdef HAVE_LIBREADLINE
857 static char histfile[1024];
858 static int nr_history_lines = 0;
862 initialize_readline (void)
864 #ifdef HAVE_LIBREADLINE
867 home = getenv ("HOME");
869 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
871 (void) read_history (histfile);
874 rl_readline_name = "guestfish";
875 rl_attempted_completion_function = do_completion;
880 cleanup_readline (void)
882 #ifdef HAVE_LIBREADLINE
885 if (histfile[0] != '\0') {
886 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
893 (void) append_history (nr_history_lines, histfile);
899 add_history_line (const char *line)
901 #ifdef HAVE_LIBREADLINE