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 "or for interactive use:\n"
95 "or from a shell script:\n"
101 " -h|--cmd-help List available commands\n"
102 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
103 " -a|--add image Add image\n"
104 " -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
105 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
106 " -n|--no-sync Don't autosync\n"
107 " -r|--ro Mount read-only\n"
108 " -v|--verbose Verbose messages\n"
109 " -V|--version Display version and exit\n"
110 "For more information, see the manpage guestfish(1).\n"));
114 main (int argc, char *argv[])
116 static const char *options = "a:h::m:nrv?V";
117 static struct option long_options[] = {
118 { "add", 1, 0, 'a' },
119 { "cmd-help", 2, 0, 'h' },
120 { "help", 0, 0, '?' },
121 { "mount", 1, 0, 'm' },
122 { "no-dest-paths", 0, 0, 'D' },
123 { "no-sync", 0, 0, 'n' },
125 { "verbose", 0, 0, 'v' },
126 { "version", 0, 0, 'V' },
129 struct drv *drvs = NULL;
131 struct mp *mps = NULL;
136 initialize_readline ();
138 /* guestfs_create is meant to be a lightweight operation, so
139 * it's OK to do it early here.
141 g = guestfs_create ();
143 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
147 guestfs_set_autosync (g, 1);
149 /* If developing, add ./appliance to the path. Note that libtools
150 * interferes with this because uninstalled guestfish is a shell
151 * script that runs the real program with an absolute path. Detect
154 * BUT if LIBGUESTFS_PATH environment variable is already set by
155 * the user, then don't override it.
157 if (getenv ("LIBGUESTFS_PATH") == NULL &&
159 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
160 guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
163 c = getopt_long (argc, argv, options, long_options, NULL);
168 if (access (optarg, R_OK) != 0) {
172 drv = malloc (sizeof (struct drv));
177 drv->filename = optarg;
183 complete_dest_paths = 0;
188 display_command (optarg);
189 else if (argv[optind] && argv[optind][0] != '-')
190 display_command (argv[optind++]);
196 mp = malloc (sizeof (struct mp));
201 p = strchr (optarg, ':');
204 mp->mountpoint = p+1;
206 mp->mountpoint = "/";
213 guestfs_set_autosync (g, 0);
222 guestfs_set_verbose (g, verbose);
226 printf ("guestfish %s\n", PACKAGE_VERSION);
234 fprintf (stderr, _("guestfish: unexpected command line option 0x%x\n"),
240 /* If we've got drives to add, add them now. */
243 /* If we've got mountpoints, we must launch the guest and mount them. */
245 if (launch (g) == -1) exit (1);
249 /* Interactive, shell script, or command(s) on the command line? */
250 if (optind >= argc) {
257 cmdline (argv, optind, argc);
265 pod2text (const char *heading, const char *str)
269 fp = popen ("pod2text", "w");
271 /* pod2text failed, maybe not found, so let's just print the
272 * source instead, since that's better than doing nothing.
274 printf ("%s\n\n%s\n", heading, str);
277 fputs ("=head1 ", fp);
284 /* List is built in reverse order, so mount them in reverse order. */
286 mount_mps (struct mp *mp)
291 mount_mps (mp->next);
293 r = guestfs_mount (g, mp->device, mp->mountpoint);
295 r = guestfs_mount_ro (g, mp->device, mp->mountpoint);
302 add_drives (struct drv *drv)
307 add_drives (drv->next);
309 r = guestfs_add_drive (g, drv->filename);
311 r = guestfs_add_drive_ro (g, drv->filename);
329 #define FISH "><fs> "
331 static char *line_read = NULL;
336 #ifdef HAVE_LIBREADLINE
344 line_read = readline (prompt ? FISH : "");
346 if (line_read && *line_read)
347 add_history_line (line_read);
352 #endif /* HAVE_LIBREADLINE */
354 static char buf[8192];
357 if (prompt) printf (FISH);
358 line_read = fgets (buf, sizeof buf, stdin);
361 len = strlen (line_read);
362 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
376 int global_exit_on_error = !prompt;
381 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
382 "editing virtual machine filesystems.\n"
384 "Type: 'help' for help with commands\n"
385 " 'quit' to quit the shell\n"
389 exit_on_error = global_exit_on_error;
391 buf = rl_gets (prompt);
397 /* Skip any initial whitespace before the command. */
399 while (*buf && isspace (*buf))
404 /* If the next character is '#' then this is a comment. */
405 if (*buf == '#') continue;
407 /* If the next character is '!' then pass the whole lot to system(3). */
415 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
416 WEXITSTATUS (r) != 0)
422 /* If the next character is '-' allow the command to fail without
423 * exiting on error (just for this one command though).
431 /* Get the command (cannot be quoted). */
432 len = strcspn (buf, " \t");
434 if (len == 0) continue;
438 if (buf[len] == '\0') {
445 p += strspn (p, " \t");
447 /* Get the parameters. */
448 while (*p && i < sizeof argv / sizeof argv[0]) {
449 /* Parameters which start with quotes or square brackets
450 * are treated specially. Bare parameters are delimited
455 len = strcspn (p, "\"");
456 if (p[len] == '\0') {
457 fprintf (stderr, _("guestfish: unterminated double quote\n"));
458 if (exit_on_error) exit (1);
461 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
462 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
463 if (exit_on_error) exit (1);
467 pend = p[len+1] ? &p[len+2] : &p[len+1];
468 } else if (*p == '\'') {
470 len = strcspn (p, "'");
471 if (p[len] == '\0') {
472 fprintf (stderr, _("guestfish: unterminated single quote\n"));
473 if (exit_on_error) exit (1);
476 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
477 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
478 if (exit_on_error) exit (1);
482 pend = p[len+1] ? &p[len+2] : &p[len+1];
484 } else if (*p == '[') {
488 while (*pend && c != 0) {
489 if (*pend == '[') c++;
490 else if (*pend == ']') c--;
494 fprintf (stderr, _("guestfish: unterminated \"[...]\" sequence\n"));
495 if (exit_on_error) exit (1);
498 if (*pend && (*pend != ' ' && *pend != '\t')) {
499 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
500 if (exit_on_error) exit (1);
505 } else if (*p != ' ' && *p != '\t') {
506 len = strcspn (p, " \t");
513 fprintf (stderr, _("guestfish: internal error parsing string at '%s'\n"),
522 p += strspn (p, " \t");
525 if (i == sizeof argv / sizeof argv[0]) {
526 fprintf (stderr, _("guestfish: too many arguments\n"));
527 if (exit_on_error) exit (1);
534 if (issue_command (cmd, argv) == -1) {
535 if (exit_on_error) exit (1);
540 if (prompt) printf ("\n");
544 cmdline (char *argv[], int optind, int argc)
549 if (optind >= argc) return;
551 cmd = argv[optind++];
552 if (strcmp (cmd, ":") == 0) {
553 fprintf (stderr, _("guestfish: empty command on command line\n"));
556 params = &argv[optind];
558 /* Search for end of command list or ":" ... */
559 while (optind < argc && strcmp (argv[optind], ":") != 0)
562 if (optind == argc) {
563 if (issue_command (cmd, params) == -1) exit (1);
566 if (issue_command (cmd, params) == -1) exit (1);
567 cmdline (argv, optind+1, argc);
572 issue_command (const char *cmd, char *argv[])
576 for (argc = 0; argv[argc] != NULL; ++argc)
579 if (strcasecmp (cmd, "help") == 0) {
583 display_command (argv[0]);
586 else if (strcasecmp (cmd, "quit") == 0 ||
587 strcasecmp (cmd, "exit") == 0 ||
588 strcasecmp (cmd, "q") == 0) {
592 else if (strcasecmp (cmd, "alloc") == 0 ||
593 strcasecmp (cmd, "allocate") == 0)
594 return do_alloc (cmd, argc, argv);
595 else if (strcasecmp (cmd, "echo") == 0)
596 return do_echo (cmd, argc, argv);
597 else if (strcasecmp (cmd, "edit") == 0 ||
598 strcasecmp (cmd, "vi") == 0 ||
599 strcasecmp (cmd, "emacs") == 0)
600 return do_edit (cmd, argc, argv);
601 else if (strcasecmp (cmd, "lcd") == 0)
602 return do_lcd (cmd, argc, argv);
603 else if (strcasecmp (cmd, "glob") == 0)
604 return do_glob (cmd, argc, argv);
606 return run_action (cmd, argc, argv);
610 list_builtin_commands (void)
612 /* help and quit should appear at the top */
613 printf ("%-20s %s\n",
614 "help", _("display a list of commands or help on a command"));
615 printf ("%-20s %s\n",
616 "quit", _("quit guestfish"));
618 printf ("%-20s %s\n",
619 "alloc", _("allocate an image"));
620 printf ("%-20s %s\n",
621 "echo", _("display a line of text"));
622 printf ("%-20s %s\n",
623 "edit", _("edit a file in the image"));
624 printf ("%-20s %s\n",
625 "lcd", _("local change directory"));
626 printf ("%-20s %s\n",
627 "glob", _("expand wildcards in command"));
629 /* actions are printed after this (see list_commands) */
633 display_builtin_command (const char *cmd)
635 /* help for actions is auto-generated, see display_command */
637 if (strcasecmp (cmd, "alloc") == 0 ||
638 strcasecmp (cmd, "allocate") == 0)
639 printf (_("alloc - allocate an image\n"
640 " alloc <filename> <size>\n"
642 " This creates an empty (zeroed) file of the given size,\n"
643 " and then adds so it can be further examined.\n"
645 " For more advanced image creation, see qemu-img utility.\n"
647 " Size can be specified (where <nn> means a number):\n"
648 " <nn> number of kilobytes\n"
649 " eg: 1440 standard 3.5\" floppy\n"
650 " <nn>K or <nn>KB number of kilobytes\n"
651 " <nn>M or <nn>MB number of megabytes\n"
652 " <nn>G or <nn>GB number of gigabytes\n"
653 " <nn>sects number of 512 byte sectors\n"));
654 else if (strcasecmp (cmd, "echo") == 0)
655 printf (_("echo - display a line of text\n"
656 " echo [<params> ...]\n"
658 " This echos the parameters to the terminal.\n"));
659 else if (strcasecmp (cmd, "edit") == 0 ||
660 strcasecmp (cmd, "vi") == 0 ||
661 strcasecmp (cmd, "emacs") == 0)
662 printf (_("edit - edit a file in the image\n"
665 " This is used to edit a file.\n"
667 " It is the equivalent of (and is implemented by)\n"
668 " running \"cat\", editing locally, and then \"write-file\".\n"
670 " Normally it uses $EDITOR, but if you use the aliases\n"
671 " \"vi\" or \"emacs\" you will get those editors.\n"
673 " NOTE: This will not work reliably for large files\n"
674 " (> 2 MB) or binary files containing \\0 bytes.\n"));
675 else if (strcasecmp (cmd, "lcd") == 0)
676 printf (_("lcd - local change directory\n"
679 " Change guestfish's current directory. This command is\n"
680 " useful if you want to download files to a particular\n"
682 else if (strcasecmp (cmd, "glob") == 0)
683 printf (_("glob - expand wildcards in command\n"
684 " glob <command> [<args> ...]\n"
686 " Glob runs <command> with wildcards expanded in any\n"
687 " command args. Note that the command is run repeatedly\n"
688 " once for each expanded argument.\n"));
689 else if (strcasecmp (cmd, "help") == 0)
690 printf (_("help - display a list of commands or help on a command\n"
693 else if (strcasecmp (cmd, "quit") == 0 ||
694 strcasecmp (cmd, "exit") == 0 ||
695 strcasecmp (cmd, "q") == 0)
696 printf (_("quit - quit guestfish\n"
699 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
704 free_strings (char **argv)
708 for (argc = 0; argv[argc] != NULL; ++argc)
714 count_strings (char * const * const argv)
718 for (c = 0; argv[c]; ++c)
724 print_strings (char * const * const argv)
728 for (argc = 0; argv[argc] != NULL; ++argc)
729 printf ("%s\n", argv[argc]);
733 print_table (char * const * const argv)
737 for (i = 0; argv[i] != NULL; i += 2)
738 printf ("%s: %s\n", argv[i], argv[i+1]);
742 is_true (const char *str)
745 strcasecmp (str, "0") != 0 &&
746 strcasecmp (str, "f") != 0 &&
747 strcasecmp (str, "false") != 0 &&
748 strcasecmp (str, "n") != 0 &&
749 strcasecmp (str, "no") != 0;
752 /* XXX We could improve list parsing. */
754 parse_string_list (const char *str)
757 const char *p, *pend;
761 for (i = 0; str[i]; ++i)
762 if (str[i] == ' ') argc++;
764 argv = malloc (sizeof (char *) * (argc+1));
765 if (argv == NULL) { perror ("malloc"); exit (1); }
770 pend = strchrnul (p, ' ');
771 argv[i] = strndup (p, pend-p);
773 p = *pend == ' ' ? pend+1 : pend;
780 #ifdef HAVE_LIBREADLINE
781 static char histfile[1024];
782 static int nr_history_lines = 0;
786 initialize_readline (void)
788 #ifdef HAVE_LIBREADLINE
791 home = getenv ("HOME");
793 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
795 (void) read_history (histfile);
798 rl_readline_name = "guestfish";
799 rl_attempted_completion_function = do_completion;
804 cleanup_readline (void)
806 #ifdef HAVE_LIBREADLINE
809 if (histfile[0] != '\0') {
810 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
817 (void) append_history (nr_history_lines, histfile);
823 add_history_line (const char *line)
825 #ifdef HAVE_LIBREADLINE