X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=fish%2Ffish.c;h=a758810682bea134bd7ed7663b4bb702e2e08745;hp=5b0a06560ee9c11f2d11c15f8896170a4ee344df;hb=b9a691af0fa468873eda3706a1c797568857785b;hpb=88da5cf8a32e683ed1d78419fcde609a389a2f65 diff --git a/fish/fish.c b/fish/fish.c index 5b0a065..a758810 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 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 @@ -40,6 +40,8 @@ #include #include "fish.h" +#include "closeout.h" +#include "progname.h" struct mp { struct mp *next; @@ -68,6 +70,10 @@ 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) @@ -83,53 +89,76 @@ launch (guestfs_h *_g) return 0; } -static void -usage (void) +static void __attribute__((noreturn)) +usage (int status) { - fprintf (stderr, - _("guestfish: guest filesystem shell\n" - "guestfish lets you edit virtual machine filesystems\n" - "Copyright (C) 2009 Red Hat Inc.\n" - "Usage:\n" - " guestfish [--options] cmd [: cmd : cmd ...]\n" - " guestfish -i libvirt-domain\n" - " guestfish -i disk-image(s)\n" - "or for interactive use:\n" - " guestfish\n" - "or from a shell script:\n" - " guestfish <mountpoint = p+1; + *p = '\0'; + mp->mountpoint = p+1; } else - mp->mountpoint = "/"; + mp->mountpoint = bad_cast ("/"); mp->device = optarg; mp->next = mps; mps = mp; @@ -249,17 +318,18 @@ main (int argc, char *argv[]) break; case 'V': - printf ("guestfish %s\n", PACKAGE_VERSION); + printf ("%s %s\n", program_name, PACKAGE_VERSION); exit (0); - case '?': - usage (); - exit (0); + case 'x': + echo_commands = 1; + break; + + case HELP_OPTION: + usage (0); default: - fprintf (stderr, _("guestfish: unexpected command line option 0x%x\n"), - c); - exit (1); + usage (1); } } @@ -268,21 +338,28 @@ main (int argc, char *argv[]) char cmd[1024]; int r; - if (drvs || mps) { - fprintf (stderr, _("guestfish: cannot use -i option with -a or -m\n")); + 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, _("guestfish -i requires a libvirt domain or path(s) to disk image(s)\n")); + fprintf (stderr, + _("%s: -i requires a libvirt domain or path(s) to disk image(s)\n"), + program_name); exit (1); } strcpy (cmd, "a=`virt-inspector"); 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 (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); } strcat (cmd, " '"); strcat (cmd, argv[optind]); @@ -295,14 +372,16 @@ main (int argc, char *argv[]) else strcat (cmd, " --fish"); - sprintf (&cmd[strlen(cmd)], "` && %s $a", argv[0]); + sprintf (&cmd[strlen(cmd)], "` && %s $a", real_argv0); if (guestfs_get_verbose (g)) strcat (cmd, " -v"); if (!guestfs_get_autosync (g)) strcat (cmd, " -n"); - /*printf ("%s\n", cmd);*/ + if (verbose) + fprintf (stderr, + "%s -i: running virt-inspector command:\n%s\n", program_name, cmd); r = system (cmd); if (r == -1) { @@ -321,6 +400,30 @@ main (int argc, char *argv[]) mount_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); + } + + if (remote_control_listen) { + if (optind < argc) { + fprintf (stderr, + _("%s: extra parameters on the command line with --listen flag\n"), + program_name); + exit (1); + } + if (file) { + fprintf (stderr, + _("%s: cannot use --listen and --file options at the same time\n"), + program_name); + exit (1); + } + rc_listen (); + } + /* -f (file) parameter? */ if (file) { close (0); @@ -346,7 +449,7 @@ main (int argc, char *argv[]) } void -pod2text (const char *heading, const char *str) +pod2text (const char *name, const char *shortdesc, const char *str) { FILE *fp; @@ -355,12 +458,10 @@ pod2text (const char *heading, const char *str) /* pod2text failed, maybe not found, so let's just print the * source instead, since that's better than doing nothing. */ - printf ("%s\n\n%s\n", heading, str); + printf ("%s - %s\n\n%s\n", name, shortdesc, str); return; } - fputs ("=head1 ", fp); - fputs (heading, fp); - fputs ("\n\n", fp); + fprintf (fp, "=head1 %s - %s\n\n", name, shortdesc); fputs (str, fp); pclose (fp); } @@ -456,18 +557,18 @@ script (int prompt) char *cmd; char *p, *pend; char *argv[64]; - int i, len; + int len; int global_exit_on_error = !prompt; - int exit_on_error; + int tilde_candidate; 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 help with commands\n" + " 'quit' to quit the shell\n" + "\n")); while (!quit) { char *pipe = NULL; @@ -496,11 +597,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 (1); } continue; } @@ -520,7 +621,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; @@ -532,87 +633,105 @@ script (int prompt) /* Get the parameters. */ while (*p && i < sizeof argv / sizeof argv[0]) { + tilde_candidate = 0; + /* Parameters which start with quotes or pipes are treated * 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 (1); + 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 (1); + 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 (1); + 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 (1); + 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 (1); + 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 (1); + goto next_command; + } + *(pend-1) = '\0'; + */ } else if (*p != ' ' && *p != '\t') { - 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 (); } - argv[i++] = p; + if (!tilde_candidate) + argv[i] = p; + else + 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")); + fprintf (stderr, _("%s: too many arguments\n"), program_name); if (exit_on_error) exit (1); goto next_command; } @@ -635,11 +754,13 @@ cmdline (char *argv[], int optind, int argc) const char *cmd; char **params; + exit_on_error = 1; + if (optind >= argc) return; cmd = argv[optind++]; if (strcmp (cmd, ":") == 0) { - fprintf (stderr, _("guestfish: empty command on command line\n")); + fprintf (stderr, _("%s: empty command on command line\n"), program_name); exit (1); } params = &argv[optind]; @@ -663,14 +784,27 @@ issue_command (const char *cmd, char *argv[], const char *pipecmd) int argc; int stdout_saved_fd = -1; int pid = 0; - int r; + int i, r; + + if (echo_commands) { + printf ("%s", cmd); + for (i = 0; argv[i] != NULL; ++i) + printf (" %s", argv[i]); + printf ("\n"); + } /* 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"); @@ -679,26 +813,41 @@ 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]); } for (argc = 0; argv[argc] != NULL; ++argc) ; - if (strcasecmp (cmd, "help") == 0) { + /* 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); + + /* Otherwise execute it locally. */ + else if (strcasecmp (cmd, "help") == 0) { if (argc == 0) list_commands (); else @@ -706,33 +855,53 @@ issue_command (const char *cmd, char *argv[], const char *pipecmd) r = 0; } else if (strcasecmp (cmd, "quit") == 0 || - strcasecmp (cmd, "exit") == 0 || - strcasecmp (cmd, "q") == 0) { + strcasecmp (cmd, "exit") == 0 || + strcasecmp (cmd, "q") == 0) { quit = 1; r = 0; } else if (strcasecmp (cmd, "alloc") == 0 || - strcasecmp (cmd, "allocate") == 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) + 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. + */ + if (fflush (stdout) == EOF) { + perror ("failed to flush standard output"); + return -1; + } + if (pipecmd) { - fflush (stdout); 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; @@ -743,20 +912,26 @@ 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")); + "quit", _("quit guestfish")); printf ("%-20s %s\n", - "alloc", _("allocate an image")); + "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", - "echo", _("display a line of text")); + "glob", _("expand wildcards in command")); printf ("%-20s %s\n", - "edit", _("edit a file in the image")); + "more", _("view a file in the pager")); printf ("%-20s %s\n", - "lcd", _("local change directory")); + "reopen", _("close and reopen libguestfs handle")); printf ("%-20s %s\n", - "glob", _("expand wildcards in command")); + "time", _("measure time taken to run command")); /* actions are printed after this (see list_commands) */ } @@ -769,67 +944,95 @@ display_builtin_command (const char *cmd) 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")); + " 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")); + " 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) + 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")); + " 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")); + " 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")); + " 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) printf (_("help - display a list of commands or help on a command\n" - " help cmd\n" - " help\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) + strcasecmp (cmd, "exit") == 0 || + strcasecmp (cmd, "q") == 0) printf (_("quit - quit guestfish\n" - " quit\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 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"), - cmd); + cmd); } void @@ -843,7 +1046,7 @@ free_strings (char **argv) } int -count_strings (char * const * const argv) +count_strings (char *const *argv) { int c; @@ -853,7 +1056,7 @@ count_strings (char * const * const argv) } void -print_strings (char * const * const argv) +print_strings (char *const *argv) { int argc; @@ -862,7 +1065,7 @@ print_strings (char * const * const argv) } void -print_table (char * const * const argv) +print_table (char *const *argv) { int i; @@ -959,3 +1162,22 @@ add_history_line (const char *line) nr_history_lines++; #endif } + +int +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); + if (r == -1) { + perror ("write"); + return -1; + } + buf += r; + len -= r; + } + + return 0; +}