X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=fish%2Ffish.c;h=b782b7cbbe146fdce07a6787477002614d08fc4f;hp=a4069d6dca8aaf79c4b37e89e59bda770a4eca0a;hb=f49a30eba8bb9f352637c3c24138074bbe3f5555;hpb=881770900938595565036b9b191cfdf39ff0dc98 diff --git a/fish/fish.c b/fish/fish.c index a4069d6..b782b7c 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-2011 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 @@ -13,22 +13,23 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #include #include #include +#include #include #include #include #include #include -#include -#include #include #include +#include +#include #ifdef HAVE_LIBREADLINE #include @@ -38,54 +39,60 @@ #include #include "fish.h" +#include "options.h" +#include "progress.h" + +#include "c-ctype.h" #include "closeout.h" #include "progname.h" -struct mp { - struct mp *next; - char *device; - char *mountpoint; -}; - -struct drv { - struct drv *next; - char *filename; +/* Return from parse_command_line. See description below. */ +struct parsed_command { + int status; + char *pipe; + char *cmd; + char *argv[64]; }; -static void add_drives (struct drv *drv); -static void mount_mps (struct mp *mp); +static void user_cancel (int); +static void prepare_drives (struct drv *drv); +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 struct parsed_command parse_command_line (char *buf, int *exit_on_error_rtn); +static int parse_quoted_string (char *p); +static int execute_and_inline (const char *cmd, int exit_on_error); +static void error_cb (guestfs_h *g, void *data, const char *msg); 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; +static struct progress_bar *bar = NULL; /* Currently open libguestfs handle. */ -guestfs_h *g; +guestfs_h *g = NULL; int read_only = 0; +int live = 0; int quit = 0; int verbose = 0; -int echo_commands = 0; int remote_control_listen = 0; +int remote_control_csh = 0; int remote_control = 0; -int exit_on_error = 1; - -int -launch (guestfs_h *_g) -{ - assert (_g == g); - - if (guestfs_is_config (g)) { - if (guestfs_launch (g) == -1) - return -1; - if (guestfs_wait_ready (g) == -1) - return -1; - } - return 0; -} +int command_num = 0; +int keys_from_stdin = 0; +int echo_keys = 0; +const char *libvirt_uri = NULL; +int inspector = 0; +int progress_bars = 0; +int is_interactive = 0; +const char *input_file = NULL; +int input_lineno = 0; static void __attribute__((noreturn)) usage (int status) @@ -97,38 +104,49 @@ usage (int status) fprintf (stdout, _("%s: guest filesystem shell\n" "%s lets you edit virtual machine filesystems\n" - "Copyright (C) 2009 Red Hat Inc.\n" + "Copyright (C) 2009-2011 Red Hat Inc.\n" "Usage:\n" " %s [--options] cmd [: cmd : cmd ...]\n" - " %s -i libvirt-domain\n" - " %s -i disk-image(s)\n" - "or for interactive use:\n" - " %s\n" - "or from a shell script:\n" - " %s <filename = optarg; - drv->next = drvs; - drvs = drv; + OPTION_a; + break; + + case 'c': + OPTION_c; + break; + + case 'd': + OPTION_d; break; case 'D': @@ -267,143 +303,181 @@ main (int argc, char *argv[]) if (file) { fprintf (stderr, _("%s: only one -f parameter can be given\n"), program_name); - exit (1); + 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); + + exit (r == 0 ? EXIT_SUCCESS : EXIT_FAILURE); + } case 'i': - inspector = 1; + OPTION_i; break; case 'm': - mp = malloc (sizeof (struct mp)); - if (!mp) { - perror ("malloc"); - exit (1); - } - p = strchr (optarg, ':'); - if (p) { - *p = '\0'; - mp->mountpoint = p+1; - } else - mp->mountpoint = bad_cast ("/"); - mp->device = optarg; - mp->next = mps; - mps = mp; + OPTION_m; break; case 'n': - guestfs_set_autosync (g, 0); + OPTION_n; + 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; + drv->device = NULL; + drv->nr_drives = -1; + 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.data_free = free_prep_data; + drv->next = drvs; + drvs = drv; break; case 'r': - read_only = 1; + OPTION_r; break; case 'v': - verbose++; - guestfs_set_verbose (g, verbose); + OPTION_v; break; case 'V': - printf ("%s %s\n", program_name, PACKAGE_VERSION); - exit (0); + OPTION_V; + break; + + case 'w': + OPTION_w; + break; case 'x': - echo_commands = 1; + OPTION_x; break; case HELP_OPTION: - usage (0); + usage (EXIT_SUCCESS); default: - usage (1); + usage (EXIT_FAILURE); } } - /* Inspector mode invalidates most of the other arguments. */ - if (inspector) { - char cmd[1024]; - int r; + /* Decide here if this will be an interactive session. We have to + * do this as soon as possible after processing the command line + * args. + */ + is_interactive = !file && isatty (0); - if (drvs || mps || remote_control_listen || remote_control || - guestfs_get_selinux (g)) { - fprintf (stderr, _("%s: cannot use -i option with -a, -m," - " --listen, --remote or --selinux\n"), - program_name); - exit (1); - } - if (optind >= argc) { - fprintf (stderr, - _("%s: -i requires a libvirt domain or path(s) to disk image(s)\n"), - program_name); - exit (1); - } + /* Register a ^C handler. We have to do this before launch could + * possibly be called below. + */ + if (is_interactive) { + memset (&sa, 0, sizeof sa); + sa.sa_handler = user_cancel; + sa.sa_flags = SA_RESTART; + sigaction (SIGINT, &sa, NULL); + sigaction (SIGQUIT, &sa, NULL); + + guestfs_set_pgroup (g, 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 (real_argv0) + 60 - >= sizeof cmd) { - fprintf (stderr, - _("%s: virt-inspector command too long for fixed-size buffer\n"), - program_name); - 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->a.format = NULL; + 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", real_argv0); - - 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, - "%s -i: running virt-inspector command:\n%s\n", program_name, 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, _("%s: cannot use --listen and --remote options at the same time\n"), program_name); - exit (1); + exit (EXIT_FAILURE); } if (remote_control_listen) { @@ -411,13 +485,13 @@ main (int argc, char *argv[]) fprintf (stderr, _("%s: extra parameters on the command line with --listen flag\n"), program_name); - exit (1); + exit (EXIT_FAILURE); } if (file) { fprintf (stderr, _("%s: cannot use --listen and --file options at the same time\n"), program_name); - exit (1); + exit (EXIT_FAILURE); } rc_listen (); } @@ -427,13 +501,42 @@ main (int argc, char *argv[]) close (0); if (open (file, O_RDONLY) == -1) { perror (file); - exit (1); + exit (EXIT_FAILURE); + } + } + + /* Get the name of the input file, for error messages, and replace + * the default error handler. + */ + if (!is_interactive) { + if (file) + input_file = file; + else + input_file = "*stdin*"; + guestfs_set_error_handler (g, error_cb, NULL); + } + input_lineno = 0; + + /* Decide if we display progress bars. */ + progress_bars = + override_progress_bars >= 0 + ? override_progress_bars + : (optind >= argc && is_interactive); + + if (progress_bars) { + bar = progress_bar_init (0); + if (!bar) { + perror ("progress_bar_init"); + exit (EXIT_FAILURE); } + + guestfs_set_event_callback (g, progress_callback, + GUESTFS_EVENT_PROGRESS, 0, NULL); } /* Interactive, shell script, or command(s) on the command line? */ if (optind >= argc) { - if (isatty (0)) + if (is_interactive) interactive (); else shell_script (); @@ -443,60 +546,42 @@ main (int argc, char *argv[]) cleanup_readline (); - exit (0); -} + if (progress_bars) + progress_bar_free (bar); -void -pod2text (const char *name, const char *shortdesc, const char *str) -{ - FILE *fp; + guestfs_close (g); + free_event_handlers (); - fp = popen ("pod2text", "w"); - if (fp == NULL) { - /* pod2text failed, maybe not found, so let's just print the - * source instead, since that's better than doing nothing. - */ - printf ("%s - %s\n\n%s\n", name, shortdesc, str); - return; - } - fprintf (fp, "=head1 %s - %s\n\n", name, shortdesc); - fputs (str, fp); - pclose (fp); + exit (EXIT_SUCCESS); } -/* List is built in reverse order, so mount them in reverse order. */ static void -mount_mps (struct mp *mp) +user_cancel (int sig) { - int r; - - 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); - } + if (g) + guestfs_user_cancel (g); } static void -add_drives (struct drv *drv) +prepare_drives (struct drv *drv) { - int r; - 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); + prepare_drives (drv->next); + if (drv->type == drv_N) + prepare_drive (drv->N.filename, drv->N.data, drv->device); } } +static int +launch (void) +{ + if (guestfs_is_config (g)) { + if (guestfs_launch (g) == -1) + return -1; + } + return 0; +} + static void interactive (void) { @@ -552,25 +637,27 @@ static void script (int prompt) { char *buf; - char *cmd; - char *p, *pend; - char *argv[64]; - int len; int global_exit_on_error = !prompt; - int tilde_candidate; + int exit_on_error; + struct parsed_command pcmd; - 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" + "Type: 'help' for help on commands\n" + " 'man' to read the manual\n" " 'quit' to quit the shell\n" "\n")); - while (!quit) { - char *pipe = NULL; + if (inspector) { + print_inspect_prompt (); + printf ("\n"); + } + } + while (!quit) { exit_on_error = global_exit_on_error; buf = rl_gets (prompt); @@ -579,171 +666,324 @@ script (int prompt) break; } - /* Skip any initial whitespace before the command. */ - again: - while (*buf && isspace (*buf)) - buf++; + input_lineno++; + + pcmd = parse_command_line (buf, &exit_on_error); + if (pcmd.status == -1 && exit_on_error) + exit (EXIT_FAILURE); + if (pcmd.status == 1) { + if (issue_command (pcmd.cmd, pcmd.argv, pcmd.pipe, exit_on_error) == -1) { + if (exit_on_error) exit (EXIT_FAILURE); + } + } + } + if (prompt) printf ("\n"); +} + +/* Parse a command string, splitting at whitespace, handling '!', '#' etc. + * This destructively updates 'buf'. + * + * 'exit_on_error_rtn' is used to pass in the global exit_on_error + * setting and to return the local setting (eg. if the command begins + * with '-'). + * + * Returns in parsed_command.status: + * 1 = got a guestfish command (returned in cmd_rtn/argv_rtn/pipe_rtn) + * 0 = no guestfish command, but otherwise OK + * -1 = an error + */ +static struct parsed_command +parse_command_line (char *buf, int *exit_on_error_rtn) +{ + struct parsed_command pcmd; + char *p, *pend; + int len; + int tilde_candidate; + int r; + const size_t argv_len = sizeof pcmd.argv / sizeof pcmd.argv[0]; + + /* Note that pcmd.pipe must be set to NULL for correct usage. Other + * fields do not need to be, but this silences a gcc warning. + */ + memset (&pcmd, 0, sizeof pcmd); + + again: + /* Skip any initial whitespace before the command. */ + while (*buf && c_isspace (*buf)) + buf++; + + if (!*buf) { + pcmd.status = 0; + return pcmd; + } + + /* If the next character is '#' then this is a comment. */ + if (*buf == '#') { + pcmd.status = 0; + return pcmd; + } + + /* If the next character is '!' then pass the whole lot to system(3). */ + if (*buf == '!') { + r = system (buf+1); + if (r == -1 || + (WIFSIGNALED (r) && + (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) || + WEXITSTATUS (r) != 0) + pcmd.status = -1; + else + pcmd.status = 0; + return pcmd; + } + + /* If the next two characters are "= '0' && p[2] <= '7' && + p[3] >= '0' && p[3] <= '7') { + c = (p[1] - '0') * 0100 + (p[2] - '0') * 010 + (p[3] - '0'); + if (c < 1 || c > 255) + goto error; + *p = c; } - if (*pend && (*pend != ' ' && *pend != '\t')) { - fprintf (stderr, - _("%s: command arguments not separated by whitespace\n"), - program_name); - if (exit_on_error) exit (1); - goto next_command; + else + goto error; + break; + + case 'x': /* hex escape - always 2 digits */ + m = 3; + if (c_isxdigit (p[2]) && c_isxdigit (p[3])) { + c = hexdigit (p[2]) * 0x10 + hexdigit (p[3]); + if (c < 1 || c > 255) + goto error; + *p = c; } - *(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]; - } else { - fprintf (stderr, _("%s: internal error parsing string at '%s'\n"), - program_name, p); - abort (); + else + goto error; + break; + + default: + error: + fprintf (stderr, _("%s: invalid escape sequence in string (starting at offset %d)\n"), + program_name, (int) (p - start)); + return -1; } + memmove (p+1, p+1+m, strlen (p+1+m) + 1); + } + } - if (!tilde_candidate) - argv[i] = p; - else - argv[i] = try_tilde_expansion (p); - i++; - p = pend; + if (!*p) { + fprintf (stderr, _("%s: unterminated double quote\n"), program_name); + return -1; + } - if (*p) - p += strspn (p, " \t"); - } + *p = '\0'; + return p - start; +} - if (i == sizeof argv / sizeof argv[0]) { - fprintf (stderr, _("%s: too many arguments\n"), program_name); - if (exit_on_error) exit (1); - goto next_command; - } +/* Used to handle " 0 && line[n-1] == '\n') + line[n-1] = '\0'; + + pcmd = parse_command_line (line, &exit_on_error); + if (pcmd.status == -1 && exit_on_error) + exit (EXIT_FAILURE); + if (pcmd.status == 1) { + if (issue_command (pcmd.cmd, pcmd.argv, pcmd.pipe, exit_on_error) == -1) { + if (exit_on_error) exit (EXIT_FAILURE); + } } + } + + free (line); - next_command:; + if (pclose (pp) != 0) { + perror ("pclose"); + return -1; } - if (prompt) printf ("\n"); + + return 0; } static void @@ -751,45 +991,61 @@ cmdline (char *argv[], int optind, int argc) { const char *cmd; char **params; + int exit_on_error; exit_on_error = 1; if (optind >= argc) return; cmd = argv[optind++]; - if (strcmp (cmd, ":") == 0) { + if (STREQ (cmd, ":")) { fprintf (stderr, _("%s: empty command on command line\n"), program_name); - exit (1); + 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, exit_on_error) == -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, exit_on_error) == -1 && exit_on_error) + exit (EXIT_FAILURE); cmdline (argv, optind+1, argc); } } +/* Note: 'rc_exit_on_error_flag' is the exit_on_error flag that we + * pass to the remote server (when issuing --remote commands). It + * does not cause issue_command itself to exit on error. + */ int -issue_command (const char *cmd, char *argv[], const char *pipecmd) +issue_command (const char *cmd, char *argv[], const char *pipecmd, + int rc_exit_on_error_flag) { int argc; int stdout_saved_fd = -1; int pid = 0; - int i, r; + int r; - if (echo_commands) { - printf ("%s", cmd); - for (i = 0; argv[i] != NULL; ++i) - printf (" %s", argv[i]); - printf ("\n"); - } + if (progress_bars) + progress_bar_reset (bar); + + /* This counts the commands issued, starting at 1. */ + command_num++; /* For | ... commands. Annoyingly we can't use popen(3) here. */ if (pipecmd) { @@ -842,42 +1098,22 @@ issue_command (const char *cmd, char *argv[], const char *pipecmd) /* If --remote was set, then send this command to a remote process. */ if (remote_control) - r = rc_remote (remote_control, cmd, argc, argv, exit_on_error); + r = rc_remote (remote_control, cmd, argc, argv, rc_exit_on_error_flag); /* Otherwise execute it locally. */ - else if (strcasecmp (cmd, "help") == 0) { - if (argc == 0) - list_commands (); - else - display_command (argv[0]); - r = 0; + else if (STRCASEEQ (cmd, "help")) { + if (argc == 0) { + display_help (); + 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); @@ -914,123 +1150,55 @@ list_builtin_commands (void) 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")); - /* 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) + 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 + return 0; + } + else { fprintf (stderr, _("%s: command not known, use -h to list all commands\n"), 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")); +} + +/* Error callback. This replaces the standard libguestfs error handler. */ +static void +error_cb (guestfs_h *g, void *data, const char *msg) +{ + fprintf (stderr, _("%s:%d: libguestfs: error: %s\n"), + input_file, input_lineno, msg); } void @@ -1075,37 +1243,154 @@ 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); + free (tok); + 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; + } } - argv[i] = NULL; + + /* 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 = argv_new; + + argv[argv_len-1] = NULL; return argv; } @@ -1130,6 +1415,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 } @@ -1147,19 +1439,24 @@ cleanup_readline (void) } close (fd); +#ifdef HAVE_APPEND_HISTORY (void) append_history (nr_history_lines, histfile); +#else + (void) write_history (histfile); +#endif + clear_history (); } #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 *v_buf, size_t len) @@ -1179,3 +1476,297 @@ xwrite (int fd, const void *v_buf, size_t len) return 0; } + +/* Resolve the special "win:..." form for Windows-specific paths. The + * generated code calls this for all device or path arguments. + * + * The function returns a newly allocated string, and the caller must + * free this string; else display an error and return NULL. + */ +static char *win_prefix_drive_letter (char drive_letter, const char *path); + +char * +win_prefix (const char *path) +{ + char *ret; + size_t i; + + /* If there is not a "win:..." prefix on the path, return strdup'd string. */ + if (STRCASENEQLEN (path, "win:", 4)) { + ret = strdup (path); + if (ret == NULL) + perror ("strdup"); + return ret; + } + + path += 4; + + /* If there is a drive letter, rewrite the path. */ + if (c_isalpha (path[0]) && path[1] == ':') { + char drive_letter = c_tolower (path[0]); + /* This returns the newly allocated string. */ + ret = win_prefix_drive_letter (drive_letter, path + 2); + if (ret == NULL) + return NULL; + } + else if (!*path) { + ret = strdup ("/"); + if (ret == NULL) { + perror ("strdup"); + return NULL; + } + } + else { + 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; +} + +static char * +win_prefix_drive_letter (char drive_letter, const char *path) +{ + char **roots = NULL; + char **drives = NULL; + char **mountpoints = NULL; + char *device, *mountpoint, *ret = NULL; + size_t i; + + /* Resolve the drive letter using the drive mappings table. */ + roots = guestfs_inspect_get_roots (g); + if (roots == NULL) + goto out; + if (roots[0] == NULL) { + fprintf (stderr, _("%s: to use Windows drive letters, you must inspect the guest (\"-i\" option or run \"inspect-os\" command)\n"), + program_name); + goto out; + } + drives = guestfs_inspect_get_drive_mappings (g, roots[0]); + if (drives == NULL || drives[0] == NULL) { + fprintf (stderr, _("%s: to use Windows drive letters, this must be a Windows guest\n"), + program_name); + goto out; + } + + device = NULL; + for (i = 0; drives[i] != NULL; i += 2) { + if (c_tolower (drives[i][0]) == drive_letter && drives[i][1] == '\0') { + device = drives[i+1]; + break; + } + } + + if (device == NULL) { + fprintf (stderr, _("%s: drive '%c:' not found. To list available drives do:\n inspect-get-drive-mappings %s\n"), + program_name, drive_letter, roots[0]); + goto out; + } + + /* This drive letter must be mounted somewhere (we won't do it). */ + mountpoints = guestfs_mountpoints (g); + if (mountpoints == NULL) + goto out; + + mountpoint = NULL; + for (i = 0; mountpoints[i] != NULL; i += 2) { + if (STREQ (mountpoints[i], device)) { + mountpoint = mountpoints[i+1]; + break; + } + } + + if (mountpoint == NULL) { + fprintf (stderr, _("%s: to access '%c:', mount %s first. One way to do this is:\n umount-all\n mount %s /\n"), + program_name, drive_letter, device, device); + goto out; + } + + /* Rewrite the path, eg. if C: => /c then C:/foo => /c/foo */ + if (asprintf (&ret, "%s%s%s", + mountpoint, STRNEQ (mountpoint, "/") ? "/" : "", path) == -1) { + perror ("asprintf"); + goto out; + } + + out: + if (roots) + free_strings (roots); + if (drives) + free_strings (drives); + if (mountpoints) + free_strings (mountpoints); + + 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; +} + +/* Callback which displays a progress bar. */ +void +progress_callback (guestfs_h *g, void *data, + uint64_t event, int event_handle, int flags, + const char *buf, size_t buf_len, + const uint64_t *array, size_t array_len) +{ + if (array_len < 4) + return; + + /*uint64_t proc_nr = array[0];*/ + /*uint64_t serial = array[1];*/ + uint64_t position = array[2]; + uint64_t total = array[3]; + + progress_bar_set (bar, position, total); +}