X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=fish%2Ffish.c;h=de11b2fef0ec2f9c6d3403566b1a48ea0ba4cb27;hp=bb0762fd2e738930709cef585ec7e47b79d1aeb5;hb=8ea62c8d7f3f7f7e4057b93105cf979271aa13f4;hpb=f8f10578093e926f5f36289a6c11615d067fbcad diff --git a/fish/fish.c b/fish/fish.c index bb0762f..de11b2f 100644 --- a/fish/fish.c +++ b/fish/fish.c @@ -1,5 +1,5 @@ /* guestfish - the filesystem interactive shell - * Copyright (C) 2009 Red Hat Inc. + * Copyright (C) 2009-2010 Red Hat Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -18,19 +18,19 @@ #include -#define _GNU_SOURCE // for strchrnul - #include #include +#include #include #include #include #include #include -#include -#include #include #include +#include +#include +#include #ifdef HAVE_LIBREADLINE #include @@ -40,6 +40,28 @@ #include #include "fish.h" +#include "c-ctype.h" +#include "closeout.h" +#include "progname.h" + +/* List of drives added via -a, -d or -N options. */ +struct drv { + struct drv *next; + enum { drv_a, drv_d, drv_N } type; + union { + struct { + char *filename; /* disk filename */ + } a; + struct { + char *guest; /* guest name */ + } d; + struct { + char *filename; /* disk filename (testX.img) */ + prep_data *data; /* prepared type */ + char *device; /* device inside the appliance */ + } N; + }; +}; struct mp { struct mp *next; @@ -47,20 +69,24 @@ struct mp { char *mountpoint; }; -struct drv { - struct drv *next; - char *filename; -}; - -static void add_drives (struct drv *drv); +static void set_up_terminal (void); +static char add_drives (struct drv *drv, char next_drive); +static void prepare_drives (struct drv *drv); static void mount_mps (struct mp *mp); +static void free_drives (struct drv *drv); +static void free_mps (struct mp *mp); +static int launch (void); static void interactive (void); static void shell_script (void); static void script (int prompt); static void cmdline (char *argv[], int optind, int argc); static void initialize_readline (void); static void cleanup_readline (void); +#ifdef HAVE_LIBREADLINE static void add_history_line (const char *); +#endif + +static int override_progress_bars = -1; /* Currently open libguestfs handle. */ guestfs_h *g; @@ -68,77 +94,108 @@ guestfs_h *g; int read_only = 0; int quit = 0; int verbose = 0; -int echo_commands = 0; int remote_control_listen = 0; int remote_control = 0; int exit_on_error = 1; - -int -launch (guestfs_h *_g) +int command_num = 0; +int keys_from_stdin = 0; +int echo_keys = 0; +const char *libvirt_uri = NULL; +int inspector = 0; +int utf8_mode = 0; +int have_terminfo = 0; +int progress_bars = 0; + +static void __attribute__((noreturn)) +usage (int status) { - assert (_g == g); - - if (guestfs_is_config (g)) { - if (guestfs_launch (g) == -1) - return -1; - if (guestfs_wait_ready (g) == -1) - return -1; + if (status != EXIT_SUCCESS) + fprintf (stderr, _("Try `%s --help' for more information.\n"), + program_name); + else { + fprintf (stdout, + _("%s: guest filesystem shell\n" + "%s lets you edit virtual machine filesystems\n" + "Copyright (C) 2009-2010 Red Hat Inc.\n" + "Usage:\n" + " %s [--options] cmd [: cmd : cmd ...]\n" + " %s [--ro] -i -a disk-image\n" + " %s [--ro] -i -d libvirt-domain\n" + "or for interactive use:\n" + " %s\n" + "or from a shell script:\n" + " %s <filename = optarg; + drv->type = drv_a; + drv->a.filename = optarg; + drv->next = drvs; + drvs = drv; + break; + + case 'c': + libvirt_uri = optarg; + break; + + case 'd': + drv = malloc (sizeof (struct drv)); + if (!drv) { + perror ("malloc"); + exit (EXIT_FAILURE); + } + drv->type = drv_d; + drv->d.guest = optarg; + drv->next = drvs; + drvs = drv; + break; + + case 'N': + if (STRCASEEQ (optarg, "list") || + STRCASEEQ (optarg, "help") || + STRCASEEQ (optarg, "h") || + STRCASEEQ (optarg, "?")) { + list_prepared_drives (); + exit (EXIT_SUCCESS); + } + drv = malloc (sizeof (struct drv)); + if (!drv) { + perror ("malloc"); + exit (EXIT_FAILURE); + } + drv->type = drv_N; + if (asprintf (&drv->N.filename, "test%d.img", + next_prepared_drive++) == -1) { + perror ("asprintf"); + exit (EXIT_FAILURE); + } + drv->N.data = create_prepared_file (optarg, drv->N.filename); + drv->N.device = NULL; /* filled in by add_drives */ drv->next = drvs; drvs = drv; break; @@ -233,20 +354,25 @@ main (int argc, char *argv[]) case 'f': if (file) { - fprintf (stderr, _("guestfish: only one -f parameter can be given\n")); - exit (1); + fprintf (stderr, _("%s: only one -f parameter can be given\n"), + program_name); + exit (EXIT_FAILURE); } file = optarg; break; - case 'h': + case 'h': { + int r = 0; + if (optarg) - display_command (optarg); + r = display_command (optarg); else if (argv[optind] && argv[optind][0] != '-') - display_command (argv[optind++]); + r = display_command (argv[optind++]); else - list_commands (); - exit (0); + list_commands (); + + exit (r == 0 ? EXIT_SUCCESS : EXIT_FAILURE); + } case 'i': inspector = 1; @@ -255,15 +381,15 @@ main (int argc, char *argv[]) case 'm': mp = malloc (sizeof (struct mp)); if (!mp) { - perror ("malloc"); - exit (1); + perror ("malloc"); + exit (EXIT_FAILURE); } p = strchr (optarg, ':'); if (p) { - *p = '\0'; - mp->mountpoint = p+1; + *p = '\0'; + mp->mountpoint = p+1; } else - mp->mountpoint = "/"; + mp->mountpoint = bad_cast ("/"); mp->device = optarg; mp->next = mps; mps = mp; @@ -282,99 +408,109 @@ main (int argc, char *argv[]) guestfs_set_verbose (g, verbose); break; - case 'V': - printf ("guestfish %s\n", PACKAGE_VERSION); - exit (0); + case 'V': { + struct guestfs_version *v = guestfs_version (g); + printf ("%s %"PRIi64".%"PRIi64".%"PRIi64"%s\n", program_name, + v->major, v->minor, v->release, v->extra); + exit (EXIT_SUCCESS); + } case 'x': - echo_commands = 1; + guestfs_set_trace (g, 1); break; - case '?': - usage (); - exit (0); + case HELP_OPTION: + usage (EXIT_SUCCESS); default: - fprintf (stderr, _("guestfish: unexpected command line option 0x%x\n"), - c); - exit (1); + usage (EXIT_FAILURE); } } - /* Inspector mode invalidates most of the other arguments. */ - if (inspector) { - char cmd[1024]; - int r; - - if (drvs || mps || remote_control_listen || remote_control) { - fprintf (stderr, _("guestfish: cannot use -i option with -a, -m, --listen or --remote\n")); - exit (1); - } - if (optind >= argc) { - fprintf (stderr, _("guestfish -i requires a libvirt domain or path(s) to disk image(s)\n")); - exit (1); - } - - strcpy (cmd, "a=`virt-inspector"); + /* Old-style -i syntax? Since -a/-d/-N and -i was disallowed + * previously, if we have -i without any drives but with something + * on the command line, it must be old-style syntax. + */ + if (inspector && drvs == NULL && optind < argc) { while (optind < argc) { - if (strlen (cmd) + strlen (argv[optind]) + strlen (argv[0]) + 60 - >= sizeof cmd) { - fprintf (stderr, _("guestfish: virt-inspector command too long for fixed-size buffer\n")); - exit (1); + if (strchr (argv[optind], '/') || + access (argv[optind], F_OK) == 0) { /* simulate -a option */ + drv = malloc (sizeof (struct drv)); + if (!drv) { + perror ("malloc"); + exit (EXIT_FAILURE); + } + drv->type = drv_a; + drv->a.filename = argv[optind]; + drv->next = drvs; + drvs = drv; + } else { /* simulate -d option */ + drv = malloc (sizeof (struct drv)); + if (!drv) { + perror ("malloc"); + exit (EXIT_FAILURE); + } + drv->type = drv_d; + drv->d.guest = argv[optind]; + drv->next = drvs; + drvs = drv; } - strcat (cmd, " '"); - strcat (cmd, argv[optind]); - strcat (cmd, "'"); + optind++; } + } - if (read_only) - strcat (cmd, " --ro-fish"); - else - strcat (cmd, " --fish"); - - sprintf (&cmd[strlen(cmd)], "` && %s $a", argv[0]); - - if (guestfs_get_verbose (g)) - strcat (cmd, " -v"); - if (!guestfs_get_autosync (g)) - strcat (cmd, " -n"); + /* If we've got drives to add, add them now. */ + add_drives (drvs, 'a'); - if (verbose) - fprintf (stderr, - "guestfish -i: running virt-inspector command:\n%s\n", cmd); + /* If we've got mountpoints or prepared drives or -i option, we must + * launch the guest and mount them. + */ + if (next_prepared_drive > 1 || mps != NULL || inspector) { + /* RHBZ#612178: If --listen flag is given, then we will fork into + * the background in rc_listen(). However you can't do this while + * holding a libguestfs handle open because the recovery process + * will think the main program has died and kill qemu. Therefore + * don't use the recovery process for this case. (A better + * solution would be to call launch () etc after the fork, but + * that greatly complicates the code here). + */ + if (remote_control_listen) + guestfs_set_recovery_proc (g, 0); - r = system (cmd); - if (r == -1) { - perror ("system"); - exit (1); - } - exit (WEXITSTATUS (r)); - } + if (launch () == -1) exit (EXIT_FAILURE); - /* If we've got drives to add, add them now. */ - add_drives (drvs); + if (inspector) + inspect_mount (); - /* If we've got mountpoints, we must launch the guest and mount them. */ - if (mps != NULL) { - if (launch (g) == -1) exit (1); + prepare_drives (drvs); mount_mps (mps); } + /* Free up data structures, no longer needed after this point. */ + free_drives (drvs); + free_mps (mps); + /* Remote control? */ if (remote_control_listen && remote_control) { - fprintf (stderr, _("guestfish: cannot use --listen and --remote options at the same time\n")); - exit (1); + fprintf (stderr, + _("%s: cannot use --listen and --remote options at the same time\n"), + program_name); + exit (EXIT_FAILURE); } if (remote_control_listen) { if (optind < argc) { - fprintf (stderr, _("guestfish: extra parameters on the command line with --listen flag\n")); - exit (1); + fprintf (stderr, + _("%s: extra parameters on the command line with --listen flag\n"), + program_name); + exit (EXIT_FAILURE); } if (file) { - fprintf (stderr, _("guestfish: cannot use --listen and --file options at the same time\n")); - exit (1); + fprintf (stderr, + _("%s: cannot use --listen and --file options at the same time\n"), + program_name); + exit (EXIT_FAILURE); } rc_listen (); } @@ -384,10 +520,19 @@ main (int argc, char *argv[]) close (0); if (open (file, O_RDONLY) == -1) { perror (file); - exit (1); + exit (EXIT_FAILURE); } } + /* Decide if we display progress bars. */ + progress_bars = + override_progress_bars >= 0 + ? override_progress_bars + : (optind >= argc && isatty (0)); + + if (progress_bars) + guestfs_set_progress_callback (g, progress_callback, NULL); + /* Interactive, shell script, or command(s) on the command line? */ if (optind >= argc) { if (isatty (0)) @@ -400,7 +545,36 @@ main (int argc, char *argv[]) cleanup_readline (); - exit (0); + exit (EXIT_SUCCESS); +} + +/* The header file which defines this has "issues". */ +extern int tgetent (char *, const char *); + +static void +set_up_terminal (void) +{ + /* http://www.cl.cam.ac.uk/~mgk25/unicode.html#activate */ + utf8_mode = STREQ (nl_langinfo (CODESET), "UTF-8"); + + char *term = getenv ("TERM"); + if (term == NULL) { + //fprintf (stderr, _("guestfish: TERM (terminal type) not defined.\n")); + return; + } + + int r = tgetent (NULL, term); + if (r == -1) { + fprintf (stderr, _("guestfish: could not access termcap or terminfo database.\n")); + return; + } + if (r == 0) { + fprintf (stderr, _("guestfish: terminal type \"%s\" not defined.\n"), + term); + return; + } + + have_terminfo = 1; } void @@ -416,7 +590,7 @@ pod2text (const char *name, const char *shortdesc, const char *str) printf ("%s - %s\n\n%s\n", name, shortdesc, str); return; } - fprintf (fp, "=head1 %s - %s\n\n", name, shortdesc); + fprintf (fp, "=head1 NAME\n\n%s - %s\n\n", name, shortdesc); fputs (str, fp); pclose (fp); } @@ -429,29 +603,137 @@ mount_mps (struct mp *mp) if (mp) { mount_mps (mp->next); - if (!read_only) - r = guestfs_mount (g, mp->device, mp->mountpoint); - else - r = guestfs_mount_ro (g, mp->device, mp->mountpoint); - if (r == -1) - exit (1); + + /* Don't use guestfs_mount here because that will default to mount + * options -o sync,noatime. For more information, see guestfs(3) + * section "LIBGUESTFS GOTCHAS". + */ + const char *options = read_only ? "ro" : ""; + r = guestfs_mount_options (g, options, mp->device, mp->mountpoint); + if (r == -1) { + /* Display possible mountpoints before exiting. */ + char **fses = guestfs_list_filesystems (g); + if (fses == NULL || fses[0] == NULL) + goto out; + fprintf (stderr, + _("guestfish: '%s' could not be mounted. Did you mean one of these?\n"), + mp->device); + size_t i; + for (i = 0; fses[i] != NULL; i += 2) + fprintf (stderr, "\t%s (%s)\n", fses[i], fses[i+1]); + + out: + exit (EXIT_FAILURE); + } } } -static void -add_drives (struct drv *drv) +static char +add_drives (struct drv *drv, char next_drive) { int r; + if (next_drive > 'z') { + fprintf (stderr, + _("guestfish: too many drives added on the command line\n")); + exit (EXIT_FAILURE); + } + if (drv) { - add_drives (drv->next); - if (!read_only) - r = guestfs_add_drive (g, drv->filename); - else - r = guestfs_add_drive_ro (g, drv->filename); - if (r == -1) - exit (1); + next_drive = add_drives (drv->next, next_drive); + + switch (drv->type) { + case drv_a: + if (!read_only) + r = guestfs_add_drive (g, drv->a.filename); + else + r = guestfs_add_drive_ro (g, drv->a.filename); + if (r == -1) + exit (EXIT_FAILURE); + + next_drive++; + break; + + case drv_d: + r = add_libvirt_drives (drv->d.guest); + if (r == -1) + exit (EXIT_FAILURE); + + next_drive += r; + break; + + case drv_N: + /* -N option is not affected by --ro */ + r = guestfs_add_drive (g, drv->N.filename); + if (r == -1) + exit (EXIT_FAILURE); + + if (asprintf (&drv->N.device, "/dev/sd%c", next_drive) == -1) { + perror ("asprintf"); + exit (EXIT_FAILURE); + } + + next_drive++; + break; + + default: /* keep GCC happy */ + abort (); + } + } + + return next_drive; +} + +static void +prepare_drives (struct drv *drv) +{ + if (drv) { + prepare_drives (drv->next); + if (drv->type == drv_N) + prepare_drive (drv->N.filename, drv->N.data, drv->N.device); + } +} + +static void +free_drives (struct drv *drv) +{ + if (!drv) return; + free_drives (drv->next); + + switch (drv->type) { + case drv_a: free (drv->a.filename); break; + case drv_d: free (drv->d.guest); break; + case drv_N: + free (drv->N.filename); + free (drv->N.device); + free_prep_data (drv->N.data); + break; + default: ; /* keep GCC happy */ + } + free (drv); +} + +static void +free_mps (struct mp *mp) +{ + if (!mp) return; + free_mps (mp->next); + + /* The drive and mountpoint fields are not allocated + * from the heap, so we should not free them here. + */ + + free (mp); +} + +static int +launch (void) +{ + if (guestfs_is_config (g)) { + if (guestfs_launch (g) == -1) + return -1; } + return 0; } static void @@ -512,18 +794,25 @@ script (int prompt) char *cmd; char *p, *pend; char *argv[64]; - int i, len; + int len; int global_exit_on_error = !prompt; int tilde_candidate; - if (prompt) + if (prompt) { printf (_("\n" - "Welcome to guestfish, the libguestfs filesystem interactive shell for\n" - "editing virtual machine filesystems.\n" - "\n" - "Type: 'help' for help with commands\n" - " 'quit' to quit the shell\n" - "\n")); + "Welcome to guestfish, the libguestfs filesystem interactive shell for\n" + "editing virtual machine filesystems.\n" + "\n" + "Type: 'help' for a list of commands\n" + " 'man' to read the manual\n" + " 'quit' to quit the shell\n" + "\n")); + + if (inspector) { + print_inspect_prompt (); + printf ("\n"); + } + } while (!quit) { char *pipe = NULL; @@ -538,7 +827,7 @@ script (int prompt) /* Skip any initial whitespace before the command. */ again: - while (*buf && isspace (*buf)) + while (*buf && c_isspace (*buf)) buf++; if (!*buf) continue; @@ -552,11 +841,11 @@ script (int prompt) r = system (buf+1); if (exit_on_error) { - if (r == -1 || - (WIFSIGNALED (r) && - (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) || - WEXITSTATUS (r) != 0) - exit (1); + if (r == -1 || + (WIFSIGNALED (r) && + (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) || + WEXITSTATUS (r) != 0) + exit (EXIT_FAILURE); } continue; } @@ -576,7 +865,7 @@ script (int prompt) if (len == 0) continue; cmd = buf; - i = 0; + unsigned int i = 0; if (buf[len] == '\0') { argv[0] = NULL; goto got_command; @@ -594,93 +883,100 @@ script (int prompt) * specially. Bare parameters are delimited by whitespace. */ if (*p == '"') { - p++; - len = strcspn (p, "\""); - if (p[len] == '\0') { - fprintf (stderr, _("guestfish: unterminated double quote\n")); - if (exit_on_error) exit (1); - goto next_command; - } - if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) { - fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n")); - if (exit_on_error) exit (1); - goto next_command; - } - p[len] = '\0'; - pend = p[len+1] ? &p[len+2] : &p[len+1]; + p++; + len = strcspn (p, "\""); + if (p[len] == '\0') { + fprintf (stderr, _("%s: unterminated double quote\n"), program_name); + if (exit_on_error) exit (EXIT_FAILURE); + goto next_command; + } + if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) { + fprintf (stderr, + _("%s: command arguments not separated by whitespace\n"), + program_name); + if (exit_on_error) exit (EXIT_FAILURE); + goto next_command; + } + p[len] = '\0'; + pend = p[len+1] ? &p[len+2] : &p[len+1]; } else if (*p == '\'') { - p++; - len = strcspn (p, "'"); - if (p[len] == '\0') { - fprintf (stderr, _("guestfish: unterminated single quote\n")); - if (exit_on_error) exit (1); - goto next_command; - } - if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) { - fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n")); - if (exit_on_error) exit (1); - goto next_command; - } - p[len] = '\0'; - pend = p[len+1] ? &p[len+2] : &p[len+1]; + p++; + len = strcspn (p, "'"); + if (p[len] == '\0') { + fprintf (stderr, _("%s: unterminated single quote\n"), program_name); + if (exit_on_error) exit (EXIT_FAILURE); + goto next_command; + } + if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) { + fprintf (stderr, + _("%s: command arguments not separated by whitespace\n"), + program_name); + if (exit_on_error) exit (EXIT_FAILURE); + goto next_command; + } + p[len] = '\0'; + pend = p[len+1] ? &p[len+2] : &p[len+1]; } else if (*p == '|') { - *p = '\0'; - pipe = p+1; - continue; - /* + *p = '\0'; + pipe = p+1; + continue; + /* } else if (*p == '[') { - int c = 1; - p++; - pend = p; - while (*pend && c != 0) { - if (*pend == '[') c++; - else if (*pend == ']') c--; - pend++; - } - if (c != 0) { - fprintf (stderr, _("guestfish: unterminated \"[...]\" sequence\n")); - if (exit_on_error) exit (1); - goto next_command; - } - if (*pend && (*pend != ' ' && *pend != '\t')) { - fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n")); - if (exit_on_error) exit (1); - goto next_command; - } - *(pend-1) = '\0'; - */ + int c = 1; + p++; + pend = p; + while (*pend && c != 0) { + if (*pend == '[') c++; + else if (*pend == ']') c--; + pend++; + } + if (c != 0) { + fprintf (stderr, + _("%s: unterminated \"[...]\" sequence\n"), program_name); + if (exit_on_error) exit (EXIT_FAILURE); + goto next_command; + } + if (*pend && (*pend != ' ' && *pend != '\t')) { + fprintf (stderr, + _("%s: command arguments not separated by whitespace\n"), + program_name); + if (exit_on_error) exit (EXIT_FAILURE); + goto next_command; + } + *(pend-1) = '\0'; + */ } else if (*p != ' ' && *p != '\t') { - /* If the first character is a ~ then note that this parameter - * is a candidate for ~username expansion. NB this does not - * apply to quoted parameters. - */ - tilde_candidate = *p == '~'; - len = strcspn (p, " \t"); - if (p[len]) { - p[len] = '\0'; - pend = &p[len+1]; - } else - pend = &p[len]; + /* If the first character is a ~ then note that this parameter + * is a candidate for ~username expansion. NB this does not + * apply to quoted parameters. + */ + tilde_candidate = *p == '~'; + len = strcspn (p, " \t"); + if (p[len]) { + p[len] = '\0'; + pend = &p[len+1]; + } else + pend = &p[len]; } else { - fprintf (stderr, _("guestfish: internal error parsing string at '%s'\n"), - p); - abort (); + fprintf (stderr, _("%s: internal error parsing string at '%s'\n"), + program_name, p); + abort (); } if (!tilde_candidate) - argv[i] = p; + argv[i] = p; else - argv[i] = try_tilde_expansion (p); + argv[i] = try_tilde_expansion (p); i++; p = pend; if (*p) - p += strspn (p, " \t"); + p += strspn (p, " \t"); } if (i == sizeof argv / sizeof argv[0]) { - fprintf (stderr, _("guestfish: too many arguments\n")); - if (exit_on_error) exit (1); + fprintf (stderr, _("%s: too many arguments\n"), program_name); + if (exit_on_error) exit (EXIT_FAILURE); goto next_command; } @@ -688,7 +984,7 @@ script (int prompt) got_command: if (issue_command (cmd, argv, pipe) == -1) { - if (exit_on_error) exit (1); + if (exit_on_error) exit (EXIT_FAILURE); } next_command:; @@ -707,21 +1003,32 @@ cmdline (char *argv[], int optind, int argc) if (optind >= argc) return; cmd = argv[optind++]; - if (strcmp (cmd, ":") == 0) { - fprintf (stderr, _("guestfish: empty command on command line\n")); - exit (1); + if (STREQ (cmd, ":")) { + fprintf (stderr, _("%s: empty command on command line\n"), program_name); + exit (EXIT_FAILURE); } + + /* Allow -cmd on the command line to mean (temporarily) override + * the normal exit on error (RHBZ#578407). + */ + if (cmd[0] == '-') { + exit_on_error = 0; + cmd++; + } + params = &argv[optind]; /* Search for end of command list or ":" ... */ - while (optind < argc && strcmp (argv[optind], ":") != 0) + while (optind < argc && STRNEQ (argv[optind], ":")) optind++; if (optind == argc) { - if (issue_command (cmd, params, NULL) == -1) exit (1); + if (issue_command (cmd, params, NULL) == -1 && exit_on_error) + exit (EXIT_FAILURE); } else { argv[optind] = NULL; - if (issue_command (cmd, params, NULL) == -1) exit (1); + if (issue_command (cmd, params, NULL) == -1 && exit_on_error) + exit (EXIT_FAILURE); cmdline (argv, optind+1, argc); } } @@ -734,19 +1041,23 @@ issue_command (const char *cmd, char *argv[], const char *pipecmd) int pid = 0; int i, r; - if (echo_commands) { - printf ("%s", cmd); - for (i = 0; argv[i] != NULL; ++i) - printf (" %s", argv[i]); - printf ("\n"); - } + reset_progress_bar (); + + /* This counts the commands issued, starting at 1. */ + command_num++; /* For | ... commands. Annoyingly we can't use popen(3) here. */ if (pipecmd) { int fd[2]; - fflush (stdout); - pipe (fd); + if (fflush (stdout) == EOF) { + perror ("failed to flush standard output"); + return -1; + } + if (pipe (fd) < 0) { + perror ("pipe failed"); + return -1; + } pid = fork (); if (pid == -1) { perror ("fork"); @@ -755,19 +1066,29 @@ issue_command (const char *cmd, char *argv[], const char *pipecmd) if (pid == 0) { /* Child process. */ close (fd[1]); - dup2 (fd[0], 0); + if (dup2 (fd[0], 0) < 0) { + perror ("dup2 of stdin failed"); + _exit (1); + } r = system (pipecmd); if (r == -1) { - perror (pipecmd); - _exit (1); + perror (pipecmd); + _exit (1); } _exit (WEXITSTATUS (r)); } - stdout_saved_fd = dup (1); + if ((stdout_saved_fd = dup (1)) < 0) { + perror ("failed to dup stdout"); + return -1; + } close (fd[0]); - dup2 (fd[1], 1); + if (dup2 (fd[1], 1) < 0) { + perror ("failed to dup stdout"); + close (stdout_saved_fd); + return -1; + } close (fd[1]); } @@ -779,52 +1100,41 @@ issue_command (const char *cmd, char *argv[], const char *pipecmd) r = rc_remote (remote_control, cmd, argc, argv, exit_on_error); /* Otherwise execute it locally. */ - else if (strcasecmp (cmd, "help") == 0) { - if (argc == 0) + else if (STRCASEEQ (cmd, "help")) { + if (argc == 0) { list_commands (); - else - display_command (argv[0]); - r = 0; + r = 0; + } else + r = display_command (argv[0]); } - else if (strcasecmp (cmd, "quit") == 0 || - strcasecmp (cmd, "exit") == 0 || - strcasecmp (cmd, "q") == 0) { + else if (STRCASEEQ (cmd, "quit") || + STRCASEEQ (cmd, "exit") || + STRCASEEQ (cmd, "q")) { quit = 1; r = 0; } - else if (strcasecmp (cmd, "alloc") == 0 || - strcasecmp (cmd, "allocate") == 0) - r = do_alloc (cmd, argc, argv); - else if (strcasecmp (cmd, "echo") == 0) - r = do_echo (cmd, argc, argv); - else if (strcasecmp (cmd, "edit") == 0 || - strcasecmp (cmd, "vi") == 0 || - strcasecmp (cmd, "emacs") == 0) - r = do_edit (cmd, argc, argv); - else if (strcasecmp (cmd, "lcd") == 0) - r = do_lcd (cmd, argc, argv); - else if (strcasecmp (cmd, "glob") == 0) - r = do_glob (cmd, argc, argv); - else if (strcasecmp (cmd, "more") == 0 || - strcasecmp (cmd, "less") == 0) - r = do_more (cmd, argc, argv); - else if (strcasecmp (cmd, "reopen") == 0) - r = do_reopen (cmd, argc, argv); - else if (strcasecmp (cmd, "time") == 0) - r = do_time (cmd, argc, argv); else r = run_action (cmd, argc, argv); /* Always flush stdout after every command, so that messages, results * etc appear immediately. */ - fflush (stdout); + if (fflush (stdout) == EOF) { + perror ("failed to flush standard output"); + return -1; + } if (pipecmd) { close (1); - dup2 (stdout_saved_fd, 1); + if (dup2 (stdout_saved_fd, 1) < 0) { + perror ("failed to dup2 standard output"); + r = -1; + } close (stdout_saved_fd); - waitpid (pid, NULL, 0); + if (waitpid (pid, NULL, 0) < 0) { + perror ("waiting for command to complete"); + r = -1; + } } return r; @@ -835,127 +1145,51 @@ list_builtin_commands (void) { /* help and quit should appear at the top */ printf ("%-20s %s\n", - "help", _("display a list of commands or help on a command")); + "help", _("display a list of commands or help on a command")); printf ("%-20s %s\n", - "quit", _("quit guestfish")); - - printf ("%-20s %s\n", - "alloc", _("allocate an image")); - printf ("%-20s %s\n", - "echo", _("display a line of text")); - printf ("%-20s %s\n", - "edit", _("edit a file in the image")); - printf ("%-20s %s\n", - "lcd", _("local change directory")); - printf ("%-20s %s\n", - "glob", _("expand wildcards in command")); - printf ("%-20s %s\n", - "more", _("view a file in the pager")); - printf ("%-20s %s\n", - "reopen", _("close and reopen libguestfs handle")); - printf ("%-20s %s\n", - "time", _("measure time taken to run command")); + "quit", _("quit guestfish")); /* actions are printed after this (see list_commands) */ } -void +int display_builtin_command (const char *cmd) { /* help for actions is auto-generated, see display_command */ - if (strcasecmp (cmd, "alloc") == 0 || - strcasecmp (cmd, "allocate") == 0) - printf (_("alloc - allocate an image\n" - " alloc \n" - "\n" - " This creates an empty (zeroed) file of the given size,\n" - " and then adds so it can be further examined.\n" - "\n" - " For more advanced image creation, see qemu-img utility.\n" - "\n" - " Size can be specified (where means a number):\n" - " number of kilobytes\n" - " eg: 1440 standard 3.5\" floppy\n" - " K or KB number of kilobytes\n" - " M or MB number of megabytes\n" - " G or GB number of gigabytes\n" - " sects number of 512 byte sectors\n")); - else if (strcasecmp (cmd, "echo") == 0) - printf (_("echo - display a line of text\n" - " echo [ ...]\n" - "\n" - " This echos the parameters to the terminal.\n")); - else if (strcasecmp (cmd, "edit") == 0 || - strcasecmp (cmd, "vi") == 0 || - strcasecmp (cmd, "emacs") == 0) - printf (_("edit - edit a file in the image\n" - " edit \n" - "\n" - " This is used to edit a file.\n" - "\n" - " It is the equivalent of (and is implemented by)\n" - " running \"cat\", editing locally, and then \"write-file\".\n" - "\n" - " Normally it uses $EDITOR, but if you use the aliases\n" - " \"vi\" or \"emacs\" you will get those editors.\n" - "\n" - " NOTE: This will not work reliably for large files\n" - " (> 2 MB) or binary files containing \\0 bytes.\n")); - else if (strcasecmp (cmd, "lcd") == 0) - printf (_("lcd - local change directory\n" - " lcd \n" - "\n" - " Change guestfish's current directory. This command is\n" - " useful if you want to download files to a particular\n" - " place.\n")); - else if (strcasecmp (cmd, "glob") == 0) - printf (_("glob - expand wildcards in command\n" - " glob [ ...]\n" - "\n" - " Glob runs with wildcards expanded in any\n" - " command args. Note that the command is run repeatedly\n" - " once for each expanded argument.\n")); - else if (strcasecmp (cmd, "help") == 0) + if (STRCASEEQ (cmd, "help")) { printf (_("help - display a list of commands or help on a command\n" - " help cmd\n" - " help\n")); - else if (strcasecmp (cmd, "more") == 0 || - strcasecmp (cmd, "less") == 0) - printf (_("more - view a file in the pager\n" - " more \n" - "\n" - " This is used to view a file in the pager.\n" - "\n" - " It is the equivalent of (and is implemented by)\n" - " running \"cat\" and using the pager.\n" - "\n" - " Normally it uses $PAGER, but if you use the alias\n" - " \"less\" then it always uses \"less\".\n" - "\n" - " NOTE: This will not work reliably for large files\n" - " (> 2 MB) or binary files containing \\0 bytes.\n")); - else if (strcasecmp (cmd, "quit") == 0 || - strcasecmp (cmd, "exit") == 0 || - strcasecmp (cmd, "q") == 0) + " help cmd\n" + " help\n")); + return 0; + } + else if (STRCASEEQ (cmd, "quit") || + STRCASEEQ (cmd, "exit") || + STRCASEEQ (cmd, "q")) { printf (_("quit - quit guestfish\n" - " quit\n")); - else if (strcasecmp (cmd, "reopen") == 0) - printf (_("reopen - close and reopen the libguestfs handle\n" - " reopen\n" - "\n" - "Close and reopen the libguestfs handle. It is not necessary to use\n" - "this normally, because the handle is closed properly when guestfish\n" - "exits. However this is occasionally useful for testing.\n")); - else if (strcasecmp (cmd, "time") == 0) - printf (_("time - measure time taken to run command\n" - " time [ ...]\n" - "\n" - " This runs as usual, and prints the elapsed\n" - " time afterwards.\n")); - else + " quit\n")); + return 0; + } + else { fprintf (stderr, _("%s: command not known, use -h to list all commands\n"), - cmd); + cmd); + return -1; + } +} + +/* This is printed when the user types in an unknown command for the + * first command issued. A common case is the user doing: + * guestfish disk.img + * expecting guestfish to open 'disk.img' (in fact, this tried to + * run a command 'disk.img'). + */ +void +extended_help_message (void) +{ + fprintf (stderr, + _("Did you mean to open a disk image? guestfish -a disk.img\n" + "For a list of commands: guestfish -h\n" + "For complete documentation: man guestfish\n")); } void @@ -969,7 +1203,7 @@ free_strings (char **argv) } int -count_strings (char * const * const argv) +count_strings (char *const *argv) { int c; @@ -979,7 +1213,7 @@ count_strings (char * const * const argv) } void -print_strings (char * const * const argv) +print_strings (char *const *argv) { int argc; @@ -988,7 +1222,7 @@ print_strings (char * const * const argv) } void -print_table (char * const * const argv) +print_table (char *const *argv) { int i; @@ -1000,37 +1234,155 @@ int is_true (const char *str) { return - strcasecmp (str, "0") != 0 && - strcasecmp (str, "f") != 0 && - strcasecmp (str, "false") != 0 && - strcasecmp (str, "n") != 0 && - strcasecmp (str, "no") != 0; + STRCASENEQ (str, "0") && + STRCASENEQ (str, "f") && + STRCASENEQ (str, "false") && + STRCASENEQ (str, "n") && + STRCASENEQ (str, "no"); +} + +/* Free strings from a non-NULL terminated char** */ +static void +free_n_strings (char **str, size_t len) +{ + size_t i; + + for (i = 0; i < len; i++) { + free (str[i]); + } + free (str); } -/* XXX We could improve list parsing. */ char ** parse_string_list (const char *str) { - char **argv; - const char *p, *pend; - int argc, i; + char **argv = NULL; + size_t argv_len = 0; + + /* Current position pointer */ + const char *p = str; + + /* Token might be simple: + * Token + * or be quoted: + * 'This is a single token' + * or contain embedded single-quoted sections: + * This' is a sing'l'e to'ken + * + * The latter may seem over-complicated, but it's what a normal shell does. + * Not doing it risks surprising somebody. + * + * This outer loop is over complete tokens. + */ + while (*p) { + char *tok = NULL; + size_t tok_len = 0; - argc = 1; - for (i = 0; str[i]; ++i) - if (str[i] == ' ') argc++; + /* Skip leading whitespace */ + p += strspn (p, " \t"); - argv = malloc (sizeof (char *) * (argc+1)); - if (argv == NULL) { perror ("malloc"); exit (1); } + char in_quote = 0; - p = str; - i = 0; - while (*p) { - pend = strchrnul (p, ' '); - argv[i] = strndup (p, pend-p); - i++; - p = *pend == ' ' ? pend+1 : pend; + /* This loop is over token 'fragments'. A token can be in multiple bits if + * it contains single quotes. We also treat both sides of an escaped quote + * as separate fragments because we can't just copy it: we have to remove + * the \. + */ + while (*p && (!c_isblank (*p) || in_quote)) { + const char *end = p; + + /* Check if the fragment starts with a quote */ + if ('\'' == *p) { + /* Toggle in_quote */ + in_quote = !in_quote; + + /* Skip the quote */ + p++; end++; + } + + /* If we're in a quote, look for an end quote */ + if (in_quote) { + end += strcspn (end, "'"); + } + + /* Otherwise, look for whitespace or a quote */ + else { + end += strcspn (end, " \t'"); + } + + /* Grow the token to accommodate the fragment */ + size_t tok_end = tok_len; + tok_len += end - p; + char *tok_new = realloc (tok, tok_len + 1); + if (NULL == tok_new) { + perror ("realloc"); + free_n_strings (argv, argv_len); + free (tok); + exit (EXIT_FAILURE); + } + tok = tok_new; + + /* Check if we stopped on an escaped quote */ + if ('\'' == *end && end != p && *(end-1) == '\\') { + /* Add everything before \' to the token */ + memcpy (&tok[tok_end], p, end - p - 1); + + /* Add the quote */ + tok[tok_len-1] = '\''; + + /* Already processed the quote */ + p = end + 1; + } + + else { + /* Add the whole fragment */ + memcpy (&tok[tok_end], p, end - p); + + p = end; + } + } + + /* We've reached the end of a token. We shouldn't still be in quotes. */ + if (in_quote) { + fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str); + + free_n_strings (argv, argv_len); + + return NULL; + } + + /* Add this token if there is one. There might not be if there was + * whitespace at the end of the input string */ + if (tok) { + /* Add the NULL terminator */ + tok[tok_len] = '\0'; + + /* Add the argument to the argument list */ + argv_len++; + char **argv_new = realloc (argv, sizeof (*argv) * argv_len); + if (NULL == argv_new) { + perror ("realloc"); + free_n_strings (argv, argv_len-1); + free (tok); + exit (EXIT_FAILURE); + } + argv = argv_new; + + argv[argv_len-1] = tok; + } + } + + /* NULL terminate the argument list */ + argv_len++; + char **argv_new = realloc (argv, sizeof (*argv) * argv_len); + if (NULL == argv_new) { + perror ("realloc"); + free_n_strings (argv, argv_len-1); + exit (EXIT_FAILURE); } - argv[i] = NULL; + argv = argv_new; + + argv[argv_len-1] = NULL; return argv; } @@ -1055,6 +1407,13 @@ initialize_readline (void) rl_readline_name = "guestfish"; rl_attempted_completion_function = do_completion; + + /* Note that .inputrc (or /etc/inputrc) is not read until the first + * call the readline(), which happens later. Therefore, these + * provide default values which can be overridden by the user if + * they wish. + */ + (void) rl_variable_bind ("completion-ignore-case", "on"); #endif } @@ -1072,24 +1431,29 @@ cleanup_readline (void) } close (fd); +#ifdef HAVE_APPEND_HISTORY (void) append_history (nr_history_lines, histfile); +#else + (void) write_history (histfile); +#endif } #endif } +#ifdef HAVE_LIBREADLINE static void add_history_line (const char *line) { -#ifdef HAVE_LIBREADLINE add_history (line); nr_history_lines++; -#endif } +#endif int -xwrite (int fd, const void *buf, size_t len) +xwrite (int fd, const void *v_buf, size_t len) { int r; + const char *buf = v_buf; while (len > 0) { r = write (fd, buf, len); @@ -1103,3 +1467,255 @@ xwrite (int fd, const void *buf, size_t len) return 0; } + +/* Resolve the special "win:..." form for Windows-specific paths. + * This always returns a newly allocated string which is freed by the + * caller function in "cmds.c". + */ +char * +resolve_win_path (const char *path) +{ + char *ret; + size_t i; + + if (STRCASENEQLEN (path, "win:", 4)) { + ret = strdup (path); + if (ret == NULL) + perror ("strdup"); + return ret; + } + + path += 4; + + /* Drop drive letter, if it's "C:". */ + if (STRCASEEQLEN (path, "c:", 2)) + path += 2; + + if (!*path) { + ret = strdup ("/"); + if (ret == NULL) + perror ("strdup"); + return ret; + } + + ret = strdup (path); + if (ret == NULL) { + perror ("strdup"); + return NULL; + } + + /* Blindly convert any backslashes into forward slashes. Is this good? */ + for (i = 0; i < strlen (ret); ++i) + if (ret[i] == '\\') + ret[i] = '/'; + + char *t = guestfs_case_sensitive_path (g, ret); + free (ret); + ret = t; + + return ret; +} + +/* Resolve the special FileIn paths ("-" or "-< or "END\n" in input. */ + size_t blen = strlen (buffer); + if (STREQLEN (buffer, endmarker, markerlen) && + (blen == markerlen || + (blen == markerlen+1 && buffer[markerlen] == '\n'))) + goto found_end; + + if (xwrite (fd, buffer, blen) == -1) { + if (!write_error) perror ("write"); + write_error = 1; + /* continue reading up to the end marker */ + } + } + + /* Reached EOF of stdin without finding the end marker, which + * is likely to be an error. + */ + fprintf (stderr, "%s: end of input reached without finding '%s'\n", + program_name, endmarker); + goto error2; + + found_end: + if (write_error) { + close (fd); + goto error2; + } + + if (close (fd) == -1) { + perror ("close"); + goto error2; + } + + return file_in_tmpfile; + + error2: + unlink (file_in_tmpfile); + + error1: + free (file_in_tmpfile); + file_in_tmpfile = NULL; + return NULL; +} + +void +free_file_in (char *s) +{ + if (file_in_tmpfile) { + if (unlink (file_in_tmpfile) == -1) + perror (file_in_tmpfile); + file_in_tmpfile = NULL; + } + + /* Free the device or file name which was strdup'd in file_in(). + * Note it's not immediately clear, but for -<< heredocs, + * s == file_in_tmpfile, so this frees up that buffer. + */ + free (s); +} + +/* Resolve the special FileOut paths ("-" or filename). + * The caller (cmds.c) will call free (str) after the command has run. + */ +char * +file_out (const char *arg) +{ + char *ret; + + if (STREQ (arg, "-")) + ret = strdup ("/dev/stdout"); + else + ret = strdup (arg); + + if (!ret) { + perror ("strdup"); + return NULL; + } + return ret; +} + +/* Read a passphrase ('Key') from /dev/tty with echo off. + * The caller (cmds.c) will call free on the string afterwards. + * Based on the code in cryptsetup file lib/utils.c. + */ +char * +read_key (const char *param) +{ + FILE *infp, *outfp; + struct termios orig, temp; + char *ret = NULL; + + /* Read and write to /dev/tty if available. */ + if (keys_from_stdin || + (infp = outfp = fopen ("/dev/tty", "w+")) == NULL) { + infp = stdin; + outfp = stdout; + } + + /* Print the prompt and set no echo. */ + int tty = isatty (fileno (infp)); + int tcset = 0; + if (tty) { + fprintf (outfp, _("Enter key or passphrase (\"%s\"): "), param); + + if (!echo_keys) { + if (tcgetattr (fileno (infp), &orig) == -1) { + perror ("tcgetattr"); + goto error; + } + memcpy (&temp, &orig, sizeof temp); + temp.c_lflag &= ~ECHO; + + tcsetattr (fileno (infp), TCSAFLUSH, &temp); + tcset = 1; + } + } + + size_t n = 0; + ssize_t len; + len = getline (&ret, &n, infp); + if (len == -1) { + perror ("getline"); + ret = NULL; + goto error; + } + + /* Remove the terminating \n if there is one. */ + if (len > 0 && ret[len-1] == '\n') + ret[len-1] = '\0'; + + error: + /* Restore echo, close file descriptor. */ + if (tty && tcset) { + printf ("\n"); + tcsetattr (fileno (infp), TCSAFLUSH, &orig); + } + + if (infp != stdin) + fclose (infp); /* outfp == infp, so this is closed also */ + + return ret; +}