/* guestfish - the filesystem interactive shell
- * Copyright (C) 2009 Red Hat Inc.
+ * Copyright (C) 2009-2010 Red Hat Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#include <assert.h>
#include <sys/types.h>
#include <sys/wait.h>
+#include <locale.h>
#ifdef HAVE_LIBREADLINE
#include <readline/readline.h>
#include "closeout.h"
#include "progname.h"
+struct drv {
+ struct drv *next;
+ char *filename; /* disk filename (for -a or -N options) */
+ prep_data *data; /* prepared type (for -N option only) */
+ char *device; /* device inside the appliance */
+};
+
struct mp {
struct mp *next;
char *device;
char *mountpoint;
};
-struct drv {
- struct drv *next;
- char *filename;
-};
-
static void add_drives (struct drv *drv);
+static void prepare_drives (struct drv *drv);
static void mount_mps (struct mp *mp);
+static int launch (void);
static void interactive (void);
static void shell_script (void);
static void script (int prompt);
static void cmdline (char *argv[], int optind, int argc);
static void initialize_readline (void);
static void cleanup_readline (void);
+#ifdef HAVE_LIBREADLINE
static void add_history_line (const char *);
+#endif
+static void print_shell_quote (FILE *stream, const char *str);
/* Currently open libguestfs handle. */
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)
-{
- assert (_g == g);
-
- if (guestfs_is_config (g)) {
- if (guestfs_launch (g) == -1)
- return -1;
- }
- return 0;
-}
+int command_num = 0;
static void __attribute__((noreturn))
usage (int status)
" --listen Listen for remote commands\n"
" -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
" -n|--no-sync Don't autosync\n"
+ " -N|--new type Create prepared disk (test1.img, ...)\n"
" --remote[=pid] Send commands to remote %s\n"
" -r|--ro Mount read-only\n"
" --selinux Enable SELinux support\n"
enum { HELP_OPTION = CHAR_MAX + 1 };
- static const char *options = "a:Df:h::im:nrv?Vx";
+ static const char *options = "a:Df:h::im:nN:rv?Vx";
static const struct option long_options[] = {
{ "add", 1, 0, 'a' },
{ "cmd-help", 2, 0, 'h' },
{ "inspector", 0, 0, 'i' },
{ "listen", 0, 0, 0 },
{ "mount", 1, 0, 'm' },
+ { "new", 1, 0, 'N' },
{ "no-dest-paths", 0, 0, 'D' },
{ "no-sync", 0, 0, 'n' },
{ "remote", 2, 0, 0 },
int inspector = 0;
int option_index;
struct sigaction sa;
+ char next_drive = 'a';
+ int next_prepared_drive = 1;
initialize_readline ();
exit (EXIT_FAILURE);
}
drv->filename = optarg;
+ drv->data = NULL;
+ /* We could fill the device field in, but in fact we
+ * only use it for the -N option at present.
+ */
+ drv->device = NULL;
+ drv->next = drvs;
+ drvs = drv;
+ next_drive++;
+ break;
+
+ case 'N':
+ if (STRCASEEQ (optarg, "list")) {
+ list_prepared_drives ();
+ exit (EXIT_SUCCESS);
+ }
+ drv = malloc (sizeof (struct drv));
+ if (!drv) {
+ perror ("malloc");
+ exit (EXIT_FAILURE);
+ }
+ if (asprintf (&drv->filename, "test%d.img",
+ next_prepared_drive++) == -1) {
+ perror ("asprintf");
+ exit (EXIT_FAILURE);
+ }
+ drv->data = create_prepared_file (optarg, drv->filename);
+ if (asprintf (&drv->device, "/dev/sd%c", next_drive++) == -1) {
+ perror ("asprintf");
+ exit (EXIT_FAILURE);
+ }
drv->next = drvs;
drvs = drv;
break;
exit (EXIT_SUCCESS);
case 'x':
- echo_commands = 1;
+ guestfs_set_trace (g, 1);
break;
case HELP_OPTION:
/* 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"),
+ fprintf (stderr, _("%s: cannot use -i option with -a, -m, -N, "
+ "--listen, --remote or --selinux\n"),
program_name);
exit (EXIT_FAILURE);
}
exit (EXIT_FAILURE);
}
- strcpy (cmd, "a=`virt-inspector");
+ char *cmd;
+ size_t cmdlen;
+ FILE *fp = open_memstream (&cmd, &cmdlen);
+ if (fp == NULL) {
+ perror ("open_memstream");
+ exit (EXIT_FAILURE);
+ }
+
+ fprintf (fp, "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 (EXIT_FAILURE);
- }
- strcat (cmd, " '");
- strcat (cmd, argv[optind]);
- strcat (cmd, "'");
+ fputc (' ', fp);
+ print_shell_quote (fp, argv[optind]);
optind++;
}
if (read_only)
- strcat (cmd, " --ro-fish");
+ fprintf (fp, " --ro-fish");
else
- strcat (cmd, " --fish");
+ fprintf (fp, " --fish");
+
+ if (fclose (fp) == -1) {
+ perror ("fclose");
+ exit (EXIT_FAILURE);
+ }
+
+ if (verbose)
+ fprintf (stderr,
+ "%s -i: running: %s\n", program_name, cmd);
+
+ FILE *pp = popen (cmd, "r");
+ if (pp == NULL) {
+ perror (cmd);
+ exit (EXIT_FAILURE);
+ }
+
+ char *cmd2;
+ fp = open_memstream (&cmd2, &cmdlen);
+ if (fp == NULL) {
+ perror ("open_memstream");
+ exit (EXIT_FAILURE);
+ }
- sprintf (&cmd[strlen(cmd)], "` && %s $a", real_argv0);
+ fprintf (fp, "%s", real_argv0);
if (guestfs_get_verbose (g))
- strcat (cmd, " -v");
+ fprintf (fp, " -v");
if (!guestfs_get_autosync (g))
- strcat (cmd, " -n");
+ fprintf (fp, " -n");
+ if (guestfs_get_trace (g))
+ fprintf (fp, " -x");
+
+ char *insp = NULL;
+ size_t insplen;
+ if (getline (&insp, &insplen, pp) == -1) {
+ perror (cmd);
+ exit (EXIT_FAILURE);
+ }
+ fprintf (fp, " %s", insp);
+
+ if (pclose (pp) == -1) {
+ perror (cmd);
+ exit (EXIT_FAILURE);
+ }
+
+ if (fclose (fp) == -1) {
+ perror ("fclose");
+ exit (EXIT_FAILURE);
+ }
if (verbose)
fprintf (stderr,
- "%s -i: running virt-inspector command:\n%s\n", program_name, cmd);
+ "%s -i: running: %s\n", program_name, cmd2);
- r = system (cmd);
+ int r = system (cmd2);
if (r == -1) {
- perror ("system");
+ perror (cmd2);
exit (EXIT_FAILURE);
}
+
+ free (cmd);
+ free (cmd2);
+ free (insp);
+
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 (EXIT_FAILURE);
+ /* If we've got mountpoints or prepared drives, we must launch the
+ * guest and mount them.
+ */
+ if (next_prepared_drive > 1 || mps != NULL) {
+ if (launch () == -1) exit (EXIT_FAILURE);
+ prepare_drives (drvs);
mount_mps (mps);
}
if (drv) {
add_drives (drv->next);
- if (!read_only)
+
+ if (drv->data /* -N option is not affected by --ro */ || !read_only)
r = guestfs_add_drive (g, drv->filename);
else
r = guestfs_add_drive_ro (g, drv->filename);
}
static void
+prepare_drives (struct drv *drv)
+{
+ if (drv) {
+ prepare_drives (drv->next);
+ if (drv->data)
+ prepare_drive (drv->filename, drv->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)
{
script (1);
"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 a list of commands\n"
+ " 'man' to read the manual\n"
" 'quit' to quit the shell\n"
"\n"));
fprintf (stderr, _("%s: empty command on command line\n"), program_name);
exit (EXIT_FAILURE);
}
+
+ /* Allow -cmd on the command line to mean (temporarily) override
+ * the normal exit on error (RHBZ#578407).
+ */
+ if (cmd[0] == '-') {
+ exit_on_error = 0;
+ cmd++;
+ }
+
params = &argv[optind];
/* Search for end of command list or ":" ... */
optind++;
if (optind == argc) {
- if (issue_command (cmd, params, NULL) == -1) exit (EXIT_FAILURE);
+ if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
+ exit (EXIT_FAILURE);
} else {
argv[optind] = NULL;
- if (issue_command (cmd, params, NULL) == -1) exit (EXIT_FAILURE);
+ if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
+ exit (EXIT_FAILURE);
cmdline (argv, optind+1, argc);
}
}
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");
- }
+ /* This counts the commands issued, starting at 1. */
+ command_num++;
/* For | ... commands. Annoyingly we can't use popen(3) here. */
if (pipecmd) {
r = do_lcd (cmd, argc, argv);
else if (STRCASEEQ (cmd, "glob"))
r = do_glob (cmd, argc, argv);
+ else if (STRCASEEQ (cmd, "man") ||
+ STRCASEEQ (cmd, "manual"))
+ r = do_man (cmd, argc, argv);
else if (STRCASEEQ (cmd, "more") ||
STRCASEEQ (cmd, "less"))
r = do_more (cmd, argc, argv);
void
list_builtin_commands (void)
{
- /* help and quit should appear at the top */
+ /* help, man and quit should appear at the top */
printf ("%-20s %s\n",
"help", _("display a list of commands or help on a command"));
printf ("%-20s %s\n",
+ "man", _("read the manual"));
+ printf ("%-20s %s\n",
"quit", _("quit guestfish"));
printf ("%-20s %s\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"
+ " running \"cat\", editing locally, and then \"write\".\n"
"\n"
" Normally it uses $EDITOR, but if you use the aliases\n"
" \"vi\" or \"emacs\" you will get those editors.\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 (STRCASEEQ (cmd, "man") ||
+ STRCASEEQ (cmd, "manual"))
+ printf (_("man - read the manual\n"
+ " man\n"
+ "\n"
+ " Opens the manual page for guestfish.\n"));
else if (STRCASEEQ (cmd, "help"))
printf (_("help - display a list of commands or help on a command\n"
" help cmd\n"
cmd);
}
+/* This is printed when the user types in an unknown command for the
+ * first command issued. A common case is the user doing:
+ * guestfish disk.img
+ * expecting guestfish to open 'disk.img' (in fact, this tried to
+ * run a command 'disk.img').
+ */
+void
+extended_help_message (void)
+{
+ fprintf (stderr,
+ _("Did you mean to open a disk image? guestfish -a disk.img\n"
+ "For a list of commands: guestfish -h\n"
+ "For complete documentation: man guestfish\n"));
+}
+
void
free_strings (char **argv)
{
#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)
return ret;
}
+
+/* Resolve the special FileIn paths ("-" or "-<<END" or filename).
+ * The caller (cmds.c) will call free_file_in after the command has
+ * run which should clean up resources.
+ */
+static char *file_in_heredoc (const char *endmarker);
+static char *file_in_tmpfile = NULL;
+
+char *
+file_in (const char *arg)
+{
+ char *ret;
+
+ if (STREQ (arg, "-")) {
+ ret = strdup ("/dev/stdin");
+ if (!ret) {
+ perror ("strdup");
+ return NULL;
+ }
+ }
+ else if (STRPREFIX (arg, "-<<")) {
+ const char *endmarker = &arg[3];
+ if (*endmarker == '\0') {
+ fprintf (stderr, "%s: missing end marker in -<< expression\n",
+ program_name);
+ return NULL;
+ }
+ ret = file_in_heredoc (endmarker);
+ if (ret == NULL)
+ return NULL;
+ }
+ else {
+ ret = strdup (arg);
+ if (!ret) {
+ perror ("strdup");
+ return NULL;
+ }
+ }
+
+ return ret;
+}
+
+static char *
+file_in_heredoc (const char *endmarker)
+{
+ static const char template[] = "/tmp/heredocXXXXXX";
+ file_in_tmpfile = strdup (template);
+ if (file_in_tmpfile == NULL) {
+ perror ("strdup");
+ return NULL;
+ }
+
+ int fd = mkstemp (file_in_tmpfile);
+ if (fd == -1) {
+ perror ("mkstemp");
+ goto error1;
+ }
+
+ size_t markerlen = strlen (endmarker);
+
+ char buffer[BUFSIZ];
+ int write_error = 0;
+ while (fgets (buffer, sizeof buffer, stdin) != NULL) {
+ /* Look for "END"<EOF> 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;
+}
+
+static void
+print_shell_quote (FILE *stream, const char *str)
+{
+#define SAFE(c) (c_isalnum((c)) || \
+ (c) == '/' || (c) == '-' || (c) == '_' || (c) == '.')
+ int i;
+
+ for (i = 0; str[i]; ++i) {
+ if (!SAFE(str[i]))
+ putc ('\\', stream);
+ putc (str[i], stream);
+ }
+}
git.annexia.org / libguestfs.git / blobdiff