/* 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 <config.h>
-#define _GNU_SOURCE // for strchrnul
-
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <getopt.h>
+#include <signal.h>
#include <assert.h>
+#include <ctype.h>
+#include <sys/types.h>
+#include <sys/wait.h>
#ifdef HAVE_LIBREADLINE
#include <readline/readline.h>
#include <guestfs.h>
#include "fish.h"
+#include "closeout.h"
+#include "progname.h"
struct mp {
struct mp *next;
char *mountpoint;
};
+struct drv {
+ struct drv *next;
+ char *filename;
+};
+
+static void add_drives (struct drv *drv);
static void mount_mps (struct mp *mp);
static void interactive (void);
static void shell_script (void);
static void script (int prompt);
static void cmdline (char *argv[], int optind, int argc);
-static int issue_command (const char *cmd, char *argv[]);
static void initialize_readline (void);
static void cleanup_readline (void);
static void add_history_line (const char *);
/* Currently open libguestfs handle. */
guestfs_h *g;
-int g_launched = 0;
+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)
{
assert (_g == g);
- if (!g_launched) {
+ if (guestfs_is_config (g)) {
if (guestfs_launch (g) == -1)
return -1;
if (guestfs_wait_ready (g) == -1)
return -1;
- g_launched = 1;
}
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"
- "or for interactive use:\n"
- " guestfish\n"
- "or from a shell script:\n"
- " guestfish <<EOF\n"
- " cmd\n"
- " ...\n"
- " EOF\n"
- "Options:\n"
- " -h|--cmd-help List available commands\n"
- " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
- " -a|--add image Add image\n"
- " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
- " -n|--no-sync Don't autosync\n"
- /*" --ro|-r All mounts are read-only\n"*/
- " -v|--verbose Verbose messages\n"
- "For more information, see the manpage guestfish(1).\n");
+ 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 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 <<EOF\n"
+ " cmd\n"
+ " ...\n"
+ " EOF\n"
+ "Options:\n"
+ " -h|--cmd-help List available commands\n"
+ " -h|--cmd-help cmd Display detailed help on 'cmd'\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 %s\n"
+ " -r|--ro Mount read-only\n"
+ " --selinux Enable SELinux support\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 %s(1).\n"),
+ program_name, program_name, program_name,
+ program_name, program_name, program_name,
+ program_name, program_name, program_name);
+ }
+ exit (status);
}
int
main (int argc, char *argv[])
{
- static const char *options = "a:h::m:v?";
- static struct option long_options[] = {
+ /* Set global program name that is not polluted with libtool artifacts. */
+ set_program_name (argv[0]);
+
+ atexit (close_stdout);
+
+ enum { HELP_OPTION = CHAR_MAX + 1 };
+
+ static const char *options = "a:Df:h::im:nrv?Vx";
+ static const struct option long_options[] = {
{ "add", 1, 0, 'a' },
{ "cmd-help", 2, 0, 'h' },
- { "help", 0, 0, '?' },
+ { "file", 1, 0, 'f' },
+ { "help", 0, 0, HELP_OPTION },
+ { "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' },
+ { "selinux", 0, 0, 0 },
{ "verbose", 0, 0, 'v' },
+ { "version", 0, 0, 'V' },
{ 0, 0, 0, 0 }
};
+ struct drv *drvs = NULL;
+ struct drv *drv;
struct mp *mps = NULL;
struct mp *mp;
- char *p;
+ 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.
*/
g = guestfs_create ();
if (g == NULL) {
- fprintf (stderr, "guestfs_create: failed to create handle\n");
+ fprintf (stderr, _("guestfs_create: failed to create handle\n"));
exit (1);
}
guestfs_set_autosync (g, 1);
- /* If developing, add . to the path. Note that libtools interferes
- * with this because uninstalled guestfish is a shell script that runs
- * the real program with an absolute path. Detect that too.
+ /* If developing, add ./appliance to the path. Note that libtools
+ * interferes with this because uninstalled guestfish is a shell
+ * script that runs the real program with an absolute path. Detect
+ * that too.
+ *
+ * BUT if LIBGUESTFS_PATH environment variable is already set by
+ * the user, then don't override it.
*/
- if (argv[0] &&
+ if (getenv ("LIBGUESTFS_PATH") == NULL &&
+ argv[0] &&
(argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
- guestfs_set_path (g, ".:" GUESTFS_DEFAULT_PATH);
+ guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
+
+ /* CAUTION: we are careful to modify argv[0] here, only after
+ * using it just above.
+ *
+ * getopt_long uses argv[0], so give it the sanitized name. Save a copy
+ * of the original, in case it's needed in virt-inspector mode, below.
+ */
+ char *real_argv0 = argv[0];
+ argv[0] = bad_cast (program_name);
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, _("%s: --listen=PID: PID was not a number: %s\n"),
+ program_name, optarg);
+ exit (1);
+ }
+ } else {
+ p = getenv ("GUESTFISH_PID");
+ if (!p || sscanf (p, "%d", &remote_control) != 1) {
+ fprintf (stderr, _("%s: remote: $GUESTFISH_PID must be set"
+ " to the PID of the remote process\n"),
+ program_name);
+ exit (1);
+ }
+ }
+ } else if (strcmp (long_options[option_index].name, "selinux") == 0) {
+ guestfs_set_selinux (g, 1);
+ } else {
+ fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
+ program_name, long_options[option_index].name, option_index);
+ exit (1);
+ }
+ break;
+
case 'a':
if (access (optarg, R_OK) != 0) {
- perror (optarg);
- exit (1);
+ perror (optarg);
+ exit (1);
}
- if (guestfs_add_drive (g, optarg) == -1)
- exit (1);
+ drv = malloc (sizeof (struct drv));
+ if (!drv) {
+ perror ("malloc");
+ exit (1);
+ }
+ drv->filename = optarg;
+ drv->next = drvs;
+ drvs = drv;
+ break;
+
+ case 'D':
+ complete_dest_paths = 0;
+ break;
+
+ case 'f':
+ if (file) {
+ fprintf (stderr, _("%s: only one -f parameter can be given\n"),
+ program_name);
+ exit (1);
+ }
+ file = optarg;
break;
case 'h':
if (optarg)
- display_command (optarg);
+ display_command (optarg);
else if (argv[optind] && argv[optind][0] != '-')
- display_command (argv[optind++]);
+ display_command (argv[optind++]);
else
- list_commands ();
+ list_commands ();
exit (0);
+ case 'i':
+ inspector = 1;
+ break;
+
case 'm':
mp = malloc (sizeof (struct mp));
if (!mp) {
- perror ("malloc");
- exit (1);
+ perror ("malloc");
+ exit (1);
}
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;
guestfs_set_autosync (g, 0);
break;
+ case 'r':
+ read_only = 1;
+ break;
+
case 'v':
verbose++;
guestfs_set_verbose (g, verbose);
break;
- case '?':
- usage ();
+ case 'V':
+ printf ("%s %s\n", program_name, PACKAGE_VERSION);
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);
+ usage (1);
+ }
+ }
+
+ /* Inspector mode invalidates most of the other arguments. */
+ if (inspector) {
+ char cmd[1024];
+ int r;
+
+ 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);
+ }
+
+ strcpy (cmd, "a=`virt-inspector");
+ 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);
+ }
+ 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 (verbose)
+ fprintf (stderr,
+ "%s -i: running virt-inspector command:\n%s\n", program_name, 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);
+
/* If we've got mountpoints, we must launch the guest and mount them. */
if (mps != NULL) {
if (launch (g) == -1) exit (1);
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);
+ if (open (file, O_RDONLY) == -1) {
+ perror (file);
+ exit (1);
+ }
+ }
+
/* Interactive, shell script, or command(s) on the command line? */
if (optind >= argc) {
if (isatty (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);
}
static void
mount_mps (struct mp *mp)
{
+ int r;
+
if (mp) {
mount_mps (mp->next);
- if (guestfs_mount (g, mp->device, mp->mountpoint) == -1)
+ 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);
+ }
+}
+
+static void
+add_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);
}
}
{
#ifdef HAVE_LIBREADLINE
- if (line_read) {
- free (line_read);
- line_read = NULL;
- }
+ if (prompt) {
+ if (line_read) {
+ free (line_read);
+ line_read = NULL;
+ }
- line_read = readline (prompt ? FISH : "");
+ line_read = readline (prompt ? FISH : "");
- if (prompt && line_read && *line_read)
- add_history_line (line_read);
+ if (line_read && *line_read)
+ add_history_line (line_read);
-#else /* !HAVE_LIBREADLINE */
+ return line_read;
+ }
+
+#endif /* HAVE_LIBREADLINE */
static char buf[8192];
int len;
if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
}
-#endif /* !HAVE_LIBREADLINE */
-
return line_read;
}
char *cmd;
char *p, *pend;
char *argv[64];
- int i, len;
+ int len;
+ int global_exit_on_error = !prompt;
+ 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");
+ 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"));
while (!quit) {
+ char *pipe = NULL;
+
+ exit_on_error = global_exit_on_error;
+
buf = rl_gets (prompt);
if (!buf) {
quit = 1;
}
/* Skip any initial whitespace before the command. */
+ again:
while (*buf && isspace (*buf))
buf++;
+ if (!*buf) continue;
+
+ /* If the next character is '#' then this is a comment. */
+ if (*buf == '#') continue;
+
+ /* If the next character is '!' then pass the whole lot to system(3). */
+ if (*buf == '!') {
+ int r;
+
+ r = system (buf+1);
+ if (exit_on_error) {
+ if (r == -1 ||
+ (WIFSIGNALED (r) &&
+ (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
+ WEXITSTATUS (r) != 0)
+ exit (1);
+ }
+ continue;
+ }
+
+ /* If the next character is '-' allow the command to fail without
+ * exiting on error (just for this one command though).
+ */
+ if (*buf == '-') {
+ exit_on_error = 0;
+ buf++;
+ goto again;
+ }
+
/* Get the command (cannot be quoted). */
len = strcspn (buf, " \t");
if (len == 0) continue;
cmd = buf;
- i = 0;
+ unsigned int i = 0;
if (buf[len] == '\0') {
argv[0] = NULL;
goto got_command;
/* 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++;
- len = strcspn (p, "\"");
- if (p[len] == '\0') {
- fprintf (stderr, "guestfish: unterminated double quote\n");
- if (!prompt) 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 (!prompt) 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 (!prompt) 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 (!prompt) 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;
+ /*
} 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 (!prompt) exit (1);
- goto next_command;
- }
- if (*pend && (*pend != ' ' && *pend != '\t')) {
- fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
- if (!prompt) 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");
- if (!prompt) exit (1);
+ fprintf (stderr, _("%s: too many arguments\n"), program_name);
+ if (exit_on_error) exit (1);
goto next_command;
}
argv[i] = NULL;
got_command:
- if (issue_command (cmd, argv) == -1) {
- if (!prompt) exit (1);
+ if (issue_command (cmd, argv, pipe) == -1) {
+ if (exit_on_error) exit (1);
}
next_command:;
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];
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);
}
}
-static int
-issue_command (const char *cmd, char *argv[])
+int
+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];
+
+ 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");
+ return -1;
+ }
+
+ if (pid == 0) { /* Child process. */
+ close (fd[1]);
+ if (dup2 (fd[0], 0) < 0) {
+ perror ("dup2 of stdin failed");
+ _exit (1);
+ }
+
+ r = system (pipecmd);
+ if (r == -1) {
+ perror (pipecmd);
+ _exit (1);
+ }
+ _exit (WEXITSTATUS (r));
+ }
+
+ if ((stdout_saved_fd = dup (1)) < 0) {
+ perror ("failed to dup stdout");
+ return -1;
+ }
+ close (fd[0]);
+ 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
display_command (argv[0]);
- return 0;
+ 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;
- return 0;
+ r = 0;
}
else if (strcasecmp (cmd, "alloc") == 0 ||
- strcasecmp (cmd, "allocate") == 0)
- return do_alloc (cmd, argc, argv);
+ 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)
- return do_edit (cmd, argc, argv);
+ 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
- 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.
+ */
+ if (fflush (stdout) == EOF) {
+ perror ("failed to flush standard output");
+ return -1;
+ }
+
+ if (pipecmd) {
+ close (1);
+ if (dup2 (stdout_saved_fd, 1) < 0) {
+ perror ("failed to dup2 standard output");
+ r = -1;
+ }
+ close (stdout_saved_fd);
+ if (waitpid (pid, NULL, 0) < 0) {
+ perror ("waiting for command to complete");
+ r = -1;
+ }
+ }
+
+ return r;
}
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",
+ "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",
- "edit", "edit a file in the image");
+ "time", _("measure time taken to run command"));
/* actions are printed after this (see list_commands) */
}
if (strcasecmp (cmd, "alloc") == 0 ||
strcasecmp (cmd, "allocate") == 0)
- printf ("alloc - allocate an image\n"
- " alloc <filename> <size>\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 <nn> means a number):\n"
- " <nn> number of kilobytes\n"
- " eg: 1440 standard 3.5\" floppy\n"
- " <nn>K or <nn>KB number of kilobytes\n"
- " <nn>M or <nn>MB number of megabytes\n"
- " <nn>G or <nn>GB number of gigabytes\n"
- " <nn>sects number of 512 byte sectors\n");
+ printf (_("alloc - allocate an image\n"
+ " alloc <filename> <size>\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 <nn> means a number):\n"
+ " <nn> number of kilobytes\n"
+ " eg: 1440 standard 3.5\" floppy\n"
+ " <nn>K or <nn>KB number of kilobytes\n"
+ " <nn>M or <nn>MB number of megabytes\n"
+ " <nn>G or <nn>GB number of gigabytes\n"
+ " <nn>sects number of 512 byte sectors\n"));
+ else if (strcasecmp (cmd, "echo") == 0)
+ printf (_("echo - display a line of text\n"
+ " echo [<params> ...]\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 <filename>\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");
+ strcasecmp (cmd, "vi") == 0 ||
+ strcasecmp (cmd, "emacs") == 0)
+ printf (_("edit - edit a file in the image\n"
+ " edit <filename>\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 <directory>\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 <command> [<args> ...]\n"
+ "\n"
+ " Glob runs <command> 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");
+ 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");
+ 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);
+ fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
+ cmd);
}
void
free (argv);
}
+int
+count_strings (char *const *argv)
+{
+ int c;
+
+ for (c = 0; argv[c]; ++c)
+ ;
+ return c;
+}
+
void
-print_strings (char * const * const argv)
+print_strings (char *const *argv)
{
int argc;
}
void
-print_table (char * const * const argv)
+print_table (char *const *argv)
{
int i;
strcasecmp (str, "no") != 0;
}
-/* XXX We could improve list parsing. */
+/* Free strings from a non-NULL terminated char** */
+static void
+free_n_strings (char **str, size_t len)
+{
+ for (size_t i = 0; i < len; i++) {
+ free (str[i]);
+ }
+ free (str);
+}
+
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 && (!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 (1);
+ }
+ 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 (1);
+ }
+ 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 (1);
}
- argv[i] = NULL;
+ argv = argv_new;
+
+ argv[argv_len-1] = NULL;
return argv;
}
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;
+}
git.annexia.org / libguestfs.git / blobdiff