/* 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
#include <signal.h>
#include <assert.h>
#include <ctype.h>
+#include <sys/types.h>
+#include <sys/wait.h>
#ifdef HAVE_LIBREADLINE
#include <readline/readline.h>
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)
"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"
" -a|--add image Add image\n"
" -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
" -f|--file file Read commands from file\n"
+ " -i|--inspector Run virt-inspector to get disk mountpoints\n"
+ " --listen Listen for remote commands\n"
" -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
" -n|--no-sync Don't autosync\n"
+ " --remote[=pid] Send commands to remote guestfish\n"
" -r|--ro Mount read-only\n"
" -v|--verbose Verbose messages\n"
+ " -x Echo each command before executing it\n"
" -V|--version Display version and exit\n"
"For more information, see the manpage guestfish(1).\n"));
}
int
main (int argc, char *argv[])
{
- static const char *options = "a:f:h::m:nrv?V";
+ static const char *options = "a:Df:h::im:nrv?Vx";
static struct option long_options[] = {
{ "add", 1, 0, 'a' },
{ "cmd-help", 2, 0, 'h' },
{ "file", 1, 0, 'f' },
{ "help", 0, 0, '?' },
+ { "inspector", 0, 0, 'i' },
+ { "listen", 0, 0, 0 },
{ "mount", 1, 0, 'm' },
{ "no-dest-paths", 0, 0, 'D' },
{ "no-sync", 0, 0, 'n' },
+ { "remote", 2, 0, 0 },
{ "ro", 0, 0, 'r' },
{ "verbose", 0, 0, 'v' },
{ "version", 0, 0, 'V' },
struct mp *mp;
char *p, *file = NULL;
int c;
+ int inspector = 0;
+ int option_index;
+ struct sigaction sa;
initialize_readline ();
+ memset (&sa, 0, sizeof sa);
+ sa.sa_handler = SIG_IGN;
+ sa.sa_flags = SA_RESTART;
+ sigaction (SIGPIPE, &sa, NULL);
+
/* guestfs_create is meant to be a lightweight operation, so
* it's OK to do it early here.
*/
guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
for (;;) {
- c = getopt_long (argc, argv, options, long_options, NULL);
+ c = getopt_long (argc, argv, options, long_options, &option_index);
if (c == -1) break;
switch (c) {
+ case 0: /* options which are long only */
+ if (strcmp (long_options[option_index].name, "listen") == 0)
+ remote_control_listen = 1;
+ else if (strcmp (long_options[option_index].name, "remote") == 0) {
+ if (optarg) {
+ if (sscanf (optarg, "%d", &remote_control) != 1) {
+ fprintf (stderr, _("guestfish: --listen=PID: PID was not a number: %s\n"), optarg);
+ exit (1);
+ }
+ } else {
+ p = getenv ("GUESTFISH_PID");
+ if (!p || sscanf (p, "%d", &remote_control) != 1) {
+ fprintf (stderr, _("guestfish: remote: $GUESTFISH_PID must be set to the PID of the remote process\n"));
+ exit (1);
+ }
+ }
+ } else {
+ fprintf (stderr, _("guestfish: unknown long option: %s (%d)\n"),
+ long_options[option_index].name, option_index);
+ exit (1);
+ }
+ break;
+
case 'a':
if (access (optarg, R_OK) != 0) {
perror (optarg);
list_commands ();
exit (0);
+ case 'i':
+ inspector = 1;
+ break;
+
case 'm':
mp = malloc (sizeof (struct mp));
if (!mp) {
printf ("guestfish %s\n", PACKAGE_VERSION);
exit (0);
+ case 'x':
+ echo_commands = 1;
+ break;
+
case '?':
usage ();
exit (0);
}
}
+ /* 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");
+ 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);
+ }
+ 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 (verbose)
+ fprintf (stderr,
+ "guestfish -i: running virt-inspector command:\n%s\n", cmd);
+
+ r = system (cmd);
+ if (r == -1) {
+ perror ("system");
+ exit (1);
+ }
+ exit (WEXITSTATUS (r));
+ }
+
/* If we've got drives to add, add them now. */
add_drives (drvs);
mount_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);
+ }
+
+ if (remote_control_listen) {
+ if (optind < argc) {
+ fprintf (stderr, _("guestfish: extra parameters on the command line with --listen flag\n"));
+ exit (1);
+ }
+ if (file) {
+ fprintf (stderr, _("guestfish: cannot use --listen and --file options at the same time\n"));
+ exit (1);
+ }
+ rc_listen ();
+ }
+
/* -f (file) parameter? */
if (file) {
close (0);
}
void
-pod2text (const char *heading, const char *str)
+pod2text (const char *name, const char *shortdesc, const char *str)
{
FILE *fp;
/* 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);
}
char *argv[64];
int i, len;
int global_exit_on_error = !prompt;
- int exit_on_error;
+ int tilde_candidate;
if (prompt)
printf (_("\n"
"\n"));
while (!quit) {
+ char *pipe = NULL;
+
exit_on_error = global_exit_on_error;
buf = rl_gets (prompt);
/* Get the parameters. */
while (*p && i < sizeof argv / sizeof argv[0]) {
- /* Parameters which start with quotes or square brackets
- * are treated specially. Bare parameters are delimited
- * by whitespace.
+ tilde_candidate = 0;
+
+ /* Parameters which start with quotes or pipes are treated
+ * specially. Bare parameters are delimited by whitespace.
*/
if (*p == '"') {
p++;
}
p[len] = '\0';
pend = p[len+1] ? &p[len+2] : &p[len+1];
+ } else if (*p == '|') {
+ *p = '\0';
+ pipe = p+1;
+ continue;
/*
} else if (*p == '[') {
int c = 1;
*(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';
abort ();
}
- argv[i++] = p;
+ if (!tilde_candidate)
+ argv[i] = p;
+ else
+ argv[i] = try_tilde_expansion (p);
+ i++;
p = pend;
if (*p)
argv[i] = NULL;
got_command:
- if (issue_command (cmd, argv) == -1) {
+ if (issue_command (cmd, argv, pipe) == -1) {
if (exit_on_error) exit (1);
}
const char *cmd;
char **params;
+ exit_on_error = 1;
+
if (optind >= argc) return;
cmd = argv[optind++];
optind++;
if (optind == argc) {
- if (issue_command (cmd, params) == -1) exit (1);
+ if (issue_command (cmd, params, NULL) == -1) exit (1);
} else {
argv[optind] = NULL;
- if (issue_command (cmd, params) == -1) exit (1);
+ if (issue_command (cmd, params, NULL) == -1) exit (1);
cmdline (argv, optind+1, argc);
}
}
int
-issue_command (const char *cmd, char *argv[])
+issue_command (const char *cmd, char *argv[], const char *pipecmd)
{
int argc;
+ int stdout_saved_fd = -1;
+ 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");
+ }
+
+ /* For | ... commands. Annoyingly we can't use popen(3) here. */
+ if (pipecmd) {
+ int fd[2];
+
+ fflush (stdout);
+ pipe (fd);
+ pid = fork ();
+ if (pid == -1) {
+ perror ("fork");
+ return -1;
+ }
+
+ if (pid == 0) { /* Child process. */
+ close (fd[1]);
+ dup2 (fd[0], 0);
+
+ r = system (pipecmd);
+ if (r == -1) {
+ perror (pipecmd);
+ _exit (1);
+ }
+ _exit (WEXITSTATUS (r));
+ }
+
+ stdout_saved_fd = dup (1);
+ close (fd[0]);
+ dup2 (fd[1], 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
display_command (argv[0]);
- return 0;
+ r = 0;
}
else if (strcasecmp (cmd, "quit") == 0 ||
strcasecmp (cmd, "exit") == 0 ||
strcasecmp (cmd, "q") == 0) {
quit = 1;
- return 0;
+ r = 0;
}
else if (strcasecmp (cmd, "alloc") == 0 ||
strcasecmp (cmd, "allocate") == 0)
- return do_alloc (cmd, argc, argv);
+ r = do_alloc (cmd, argc, argv);
else if (strcasecmp (cmd, "echo") == 0)
- return do_echo (cmd, argc, argv);
+ r = do_echo (cmd, argc, argv);
else if (strcasecmp (cmd, "edit") == 0 ||
strcasecmp (cmd, "vi") == 0 ||
strcasecmp (cmd, "emacs") == 0)
- return do_edit (cmd, argc, argv);
+ r = do_edit (cmd, argc, argv);
else if (strcasecmp (cmd, "lcd") == 0)
- return do_lcd (cmd, argc, argv);
+ r = do_lcd (cmd, argc, argv);
else if (strcasecmp (cmd, "glob") == 0)
- return do_glob (cmd, argc, argv);
+ 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
- return run_action (cmd, argc, argv);
+ r = run_action (cmd, argc, argv);
+
+ /* Always flush stdout after every command, so that messages, results
+ * etc appear immediately.
+ */
+ fflush (stdout);
+
+ if (pipecmd) {
+ close (1);
+ dup2 (stdout_saved_fd, 1);
+ close (stdout_saved_fd);
+ waitpid (pid, NULL, 0);
+ }
+
+ return r;
}
void
"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) */
}
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 <filename>\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)
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 <command> [<args> ...]\n"
+ "\n"
+ " This runs <command> 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);
nr_history_lines++;
#endif
}
+
+int
+xwrite (int fd, const void *buf, size_t len)
+{
+ int r;
+
+ while (len > 0) {
+ r = write (fd, buf, len);
+ if (r == -1) {
+ perror ("write");
+ return -1;
+ }
+ buf += r;
+ len -= r;
+ }
+
+ return 0;
+}
git.annexia.org / libguestfs.git / blobdiff