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
31 #ifdef HAVE_LIBREADLINE
32 #include <readline/readline.h>
33 #include <readline/history.h>
46 static void mount_mps (struct mp *mp);
47 static void interactive (void);
48 static void shell_script (void);
49 static void script (int prompt);
50 static void cmdline (char *argv[], int optind, int argc);
51 static int issue_command (const char *cmd, char *argv[]);
52 static void initialize_readline (void);
53 static void cleanup_readline (void);
54 static void add_history_line (const char *);
56 /* Currently open libguestfs handle. */
64 launch (guestfs_h *_g)
69 if (guestfs_launch (g) == -1)
71 if (guestfs_wait_ready (g) == -1)
82 "guestfish: guest filesystem shell\n"
83 "guestfish lets you edit virtual machine filesystems\n"
84 "Copyright (C) 2009 Red Hat Inc.\n"
86 " guestfish [--options] cmd [: cmd : cmd ...]\n"
87 "or for interactive use:\n"
89 "or from a shell script:\n"
95 " -h|--cmd-help List available commands\n"
96 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
97 " -a|--add image Add image\n"
98 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
99 " -n|--no-sync Don't autosync\n"
100 /*" --ro|-r All mounts are read-only\n"*/
101 " -v|--verbose Verbose messages\n"
102 "For more information, see the manpage guestfish(1).\n");
106 main (int argc, char *argv[])
108 static const char *options = "a:h::m:v?";
109 static struct option long_options[] = {
110 { "add", 1, 0, 'a' },
111 { "cmd-help", 2, 0, 'h' },
112 { "help", 0, 0, '?' },
113 { "mount", 1, 0, 'm' },
114 { "no-sync", 0, 0, 'n' },
115 { "verbose", 0, 0, 'v' },
118 struct mp *mps = NULL;
123 initialize_readline ();
125 /* guestfs_create is meant to be a lightweight operation, so
126 * it's OK to do it early here.
128 g = guestfs_create ();
130 fprintf (stderr, "guestfs_create: failed to create handle\n");
134 guestfs_set_autosync (g, 1);
136 /* If developing, add . to the path. Note that libtools interferes
137 * with this because uninstalled guestfish is a shell script that runs
138 * the real program with an absolute path. Detect that too.
141 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
142 guestfs_set_path (g, ".:" GUESTFS_DEFAULT_PATH);
145 c = getopt_long (argc, argv, options, long_options, NULL);
150 if (access (optarg, R_OK) != 0) {
154 if (guestfs_add_drive (g, optarg) == -1)
160 display_command (optarg);
161 else if (argv[optind] && argv[optind][0] != '-')
162 display_command (argv[optind++]);
168 mp = malloc (sizeof (struct mp));
173 p = strchr (optarg, ':');
176 mp->mountpoint = p+1;
178 mp->mountpoint = "/";
185 guestfs_set_autosync (g, 0);
190 guestfs_set_verbose (g, verbose);
198 fprintf (stderr, "guestfish: unexpected command line option 0x%x\n", c);
203 /* If we've got mountpoints, we must launch the guest and mount them. */
205 if (launch (g) == -1) exit (1);
209 /* Interactive, shell script, or command(s) on the command line? */
210 if (optind >= argc) {
217 cmdline (argv, optind, argc);
225 pod2text (const char *heading, const char *str)
229 fp = popen ("pod2text", "w");
231 /* pod2text failed, maybe not found, so let's just print the
232 * source instead, since that's better than doing nothing.
234 printf ("%s\n\n%s\n", heading, str);
237 fputs ("=head1 ", fp);
244 /* List is built in reverse order, so mount them in reverse order. */
246 mount_mps (struct mp *mp)
249 mount_mps (mp->next);
250 if (guestfs_mount (g, mp->device, mp->mountpoint) == -1)
267 #define FISH "><fs> "
269 static char *line_read = NULL;
274 #ifdef HAVE_LIBREADLINE
281 line_read = readline (prompt ? FISH : "");
283 if (prompt && line_read && *line_read)
284 add_history_line (line_read);
286 #else /* !HAVE_LIBREADLINE */
288 static char buf[8192];
291 if (prompt) printf (FISH);
292 line_read = fgets (buf, sizeof buf, stdin);
295 len = strlen (line_read);
296 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
299 #endif /* !HAVE_LIBREADLINE */
315 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
316 "editing virtual machine filesystems.\n"
318 "Type: 'help' for help with commands\n"
319 " 'quit' to quit the shell\n"
323 buf = rl_gets (prompt);
329 /* Skip any initial whitespace before the command. */
330 while (*buf && isspace (*buf))
333 /* Get the command (cannot be quoted). */
334 len = strcspn (buf, " \t");
336 if (len == 0) continue;
340 if (buf[len] == '\0') {
347 p += strspn (p, " \t");
349 /* Get the parameters. */
350 while (*p && i < sizeof argv / sizeof argv[0]) {
351 /* Parameters which start with quotes or square brackets
352 * are treated specially. Bare parameters are delimited
357 len = strcspn (p, "\"");
358 if (p[len] == '\0') {
359 fprintf (stderr, "guestfish: unterminated double quote\n");
360 if (!prompt) exit (1);
363 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
364 fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
365 if (!prompt) exit (1);
369 pend = p[len+1] ? &p[len+2] : &p[len+1];
370 } else if (*p == '\'') {
372 len = strcspn (p, "'");
373 if (p[len] == '\0') {
374 fprintf (stderr, "guestfish: unterminated single quote\n");
375 if (!prompt) exit (1);
378 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
379 fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
380 if (!prompt) exit (1);
384 pend = p[len+1] ? &p[len+2] : &p[len+1];
386 } else if (*p == '[') {
390 while (*pend && c != 0) {
391 if (*pend == '[') c++;
392 else if (*pend == ']') c--;
396 fprintf (stderr, "guestfish: unterminated \"[...]\" sequence\n");
397 if (!prompt) exit (1);
400 if (*pend && (*pend != ' ' && *pend != '\t')) {
401 fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
402 if (!prompt) exit (1);
407 } else if (*p != ' ' && *p != '\t') {
408 len = strcspn (p, " \t");
415 fprintf (stderr, "guestfish: internal error parsing string at '%s'\n",
424 p += strspn (p, " \t");
427 if (i == sizeof argv / sizeof argv[0]) {
428 fprintf (stderr, "guestfish: too many arguments\n");
429 if (!prompt) exit (1);
436 if (issue_command (cmd, argv) == -1) {
437 if (!prompt) exit (1);
442 if (prompt) printf ("\n");
446 cmdline (char *argv[], int optind, int argc)
451 if (optind >= argc) return;
453 cmd = argv[optind++];
454 if (strcmp (cmd, ":") == 0) {
455 fprintf (stderr, "guestfish: empty command on command line\n");
458 params = &argv[optind];
460 /* Search for end of command list or ":" ... */
461 while (optind < argc && strcmp (argv[optind], ":") != 0)
464 if (optind == argc) {
465 if (issue_command (cmd, params) == -1) exit (1);
468 if (issue_command (cmd, params) == -1) exit (1);
469 cmdline (argv, optind+1, argc);
474 issue_command (const char *cmd, char *argv[])
478 for (argc = 0; argv[argc] != NULL; ++argc)
481 if (strcasecmp (cmd, "help") == 0) {
485 display_command (argv[0]);
488 else if (strcasecmp (cmd, "quit") == 0 ||
489 strcasecmp (cmd, "exit") == 0 ||
490 strcasecmp (cmd, "q") == 0) {
494 else if (strcasecmp (cmd, "alloc") == 0 ||
495 strcasecmp (cmd, "allocate") == 0)
496 return do_alloc (cmd, argc, argv);
497 else if (strcasecmp (cmd, "edit") == 0 ||
498 strcasecmp (cmd, "vi") == 0 ||
499 strcasecmp (cmd, "emacs") == 0)
500 return do_edit (cmd, argc, argv);
502 return run_action (cmd, argc, argv);
506 list_builtin_commands (void)
508 /* help and quit should appear at the top */
509 printf ("%-20s %s\n",
510 "help", "display a list of commands or help on a command");
511 printf ("%-20s %s\n",
512 "quit", "quit guestfish");
514 printf ("%-20s %s\n",
515 "alloc", "allocate an image");
516 printf ("%-20s %s\n",
517 "edit", "edit a file in the image");
519 /* actions are printed after this (see list_commands) */
523 display_builtin_command (const char *cmd)
525 /* help for actions is auto-generated, see display_command */
527 if (strcasecmp (cmd, "alloc") == 0 ||
528 strcasecmp (cmd, "allocate") == 0)
529 printf ("alloc - allocate an image\n"
530 " alloc <filename> <size>\n"
532 " This creates an empty (zeroed) file of the given size,\n"
533 " and then adds so it can be further examined.\n"
535 " For more advanced image creation, see qemu-img utility.\n"
537 " Size can be specified (where <nn> means a number):\n"
538 " <nn> number of kilobytes\n"
539 " eg: 1440 standard 3.5\" floppy\n"
540 " <nn>K or <nn>KB number of kilobytes\n"
541 " <nn>M or <nn>MB number of megabytes\n"
542 " <nn>G or <nn>GB number of gigabytes\n"
543 " <nn>sects number of 512 byte sectors\n");
544 else if (strcasecmp (cmd, "edit") == 0 ||
545 strcasecmp (cmd, "vi") == 0 ||
546 strcasecmp (cmd, "emacs") == 0)
547 printf ("edit - edit a file in the image\n"
550 " This is used to edit a file.\n"
552 " It is the equivalent of (and is implemented by)\n"
553 " running \"cat\", editing locally, and then \"write-file\".\n"
555 " Normally it uses $EDITOR, but if you use the aliases\n"
556 " \"vi\" or \"emacs\" you will get those editors.\n"
558 " NOTE: This will not work reliably for large files\n"
559 " (> 2 MB) or binary files containing \\0 bytes.\n");
560 else if (strcasecmp (cmd, "help") == 0)
561 printf ("help - display a list of commands or help on a command\n"
564 else if (strcasecmp (cmd, "quit") == 0 ||
565 strcasecmp (cmd, "exit") == 0 ||
566 strcasecmp (cmd, "q") == 0)
567 printf ("quit - quit guestfish\n"
570 fprintf (stderr, "%s: command not known, use -h to list all commands\n",
575 free_strings (char **argv)
579 for (argc = 0; argv[argc] != NULL; ++argc)
585 print_strings (char * const * const argv)
589 for (argc = 0; argv[argc] != NULL; ++argc)
590 printf ("%s\n", argv[argc]);
594 print_table (char * const * const argv)
598 for (i = 0; argv[i] != NULL; i += 2)
599 printf ("%s: %s\n", argv[i], argv[i+1]);
603 is_true (const char *str)
606 strcasecmp (str, "0") != 0 &&
607 strcasecmp (str, "f") != 0 &&
608 strcasecmp (str, "false") != 0 &&
609 strcasecmp (str, "n") != 0 &&
610 strcasecmp (str, "no") != 0;
613 /* XXX We could improve list parsing. */
615 parse_string_list (const char *str)
618 const char *p, *pend;
622 for (i = 0; str[i]; ++i)
623 if (str[i] == ' ') argc++;
625 argv = malloc (sizeof (char *) * (argc+1));
626 if (argv == NULL) { perror ("malloc"); exit (1); }
631 pend = strchrnul (p, ' ');
632 argv[i] = strndup (p, pend-p);
634 p = *pend == ' ' ? pend+1 : pend;
641 #ifdef HAVE_LIBREADLINE
642 static char histfile[1024];
643 static int nr_history_lines = 0;
647 initialize_readline (void)
649 #ifdef HAVE_LIBREADLINE
652 home = getenv ("HOME");
654 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
656 (void) read_history (histfile);
659 rl_readline_name = "guestfish";
660 rl_attempted_completion_function = do_completion;
665 cleanup_readline (void)
667 #ifdef HAVE_LIBREADLINE
670 if (histfile[0] != '\0') {
671 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
678 (void) append_history (nr_history_lines, histfile);
684 add_history_line (const char *line)
686 #ifdef HAVE_LIBREADLINE