#include <config.h>
-#define _GNU_SOURCE // for strchrnul
-
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <getopt.h>
#include <signal.h>
#include <assert.h>
-#include <ctype.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <guestfs.h>
#include "fish.h"
+#include "c-ctype.h"
+#include "closeout.h"
+#include "progname.h"
struct mp {
struct mp *next;
if (guestfs_is_config (g)) {
if (guestfs_launch (g) == -1)
return -1;
- if (guestfs_wait_ready (g) == -1)
- return -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"
+ 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"
- " guestfish [--options] cmd [: cmd : cmd ...]\n"
- " guestfish -i libvirt-domain\n"
- " guestfish -i disk-image(s)\n"
+ " %s [--options] cmd [: cmd : cmd ...]\n"
+ " %s -i libvirt-domain\n"
+ " %s -i disk-image(s)\n"
"or for interactive use:\n"
- " guestfish\n"
+ " %s\n"
"or from a shell script:\n"
- " guestfish <<EOF\n"
+ " %s <<EOF\n"
" cmd\n"
" ...\n"
" EOF\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"
+ " --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 guestfish(1).\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[])
{
+ /* 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' },
{ "file", 1, 0, 'f' },
- { "help", 0, 0, '?' },
+ { "help", 0, 0, HELP_OPTION },
{ "inspector", 0, 0, 'i' },
{ "listen", 0, 0, 0 },
{ "mount", 1, 0, 'm' },
(argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
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, &option_index);
if (c == -1) break;
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);
+ 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, _("guestfish: remote: $GUESTFISH_PID must be set to the PID of the remote process\n"));
+ 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, _("guestfish: unknown long option: %s (%d)\n"),
- long_options[option_index].name, option_index);
+ fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
+ program_name, long_options[option_index].name, option_index);
exit (1);
}
break;
case 'f':
if (file) {
- fprintf (stderr, _("guestfish: only one -f parameter can be given\n"));
+ fprintf (stderr, _("%s: only one -f parameter can be given\n"),
+ program_name);
exit (1);
}
file = optarg;
break;
case 'V':
- printf ("guestfish %s\n", PACKAGE_VERSION);
+ printf ("%s %s\n", program_name, PACKAGE_VERSION);
exit (0);
case 'x':
echo_commands = 1;
break;
- case '?':
- usage ();
- exit (0);
+ case HELP_OPTION:
+ usage (0);
default:
- fprintf (stderr, _("guestfish: unexpected command line option 0x%x\n"),
- c);
- exit (1);
+ usage (1);
}
}
if (drvs || mps || remote_control_listen || remote_control ||
guestfs_get_selinux (g)) {
- fprintf (stderr, _("guestfish: cannot use -i option with -a, -m, --listen, --remote or --selinux\n"));
+ 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
+ if (strlen (cmd) + strlen (argv[optind]) + strlen (real_argv0) + 60
>= sizeof cmd) {
- fprintf (stderr, _("guestfish: virt-inspector command too long for fixed-size buffer\n"));
+ fprintf (stderr,
+ _("%s: virt-inspector command too long for fixed-size buffer\n"),
+ program_name);
exit (1);
}
strcat (cmd, " '");
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 (verbose)
fprintf (stderr,
- "guestfish -i: running virt-inspector command:\n%s\n", cmd);
+ "%s -i: running virt-inspector command:\n%s\n", program_name, cmd);
r = system (cmd);
if (r == -1) {
/* Remote control? */
if (remote_control_listen && remote_control) {
- fprintf (stderr, _("guestfish: cannot use --listen and --remote options at the same time\n"));
+ 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, _("guestfish: extra parameters on the command line with --listen flag\n"));
+ fprintf (stderr,
+ _("%s: extra parameters on the command line with --listen flag\n"),
+ program_name);
exit (1);
}
if (file) {
- fprintf (stderr, _("guestfish: cannot use --listen and --file options at the same time\n"));
+ fprintf (stderr,
+ _("%s: cannot use --listen and --file options at the same time\n"),
+ program_name);
exit (1);
}
rc_listen ();
/* Skip any initial whitespace before the command. */
again:
- while (*buf && isspace (*buf))
+ while (*buf && c_isspace (*buf))
buf++;
if (!*buf) continue;
p++;
len = strcspn (p, "\"");
if (p[len] == '\0') {
- fprintf (stderr, _("guestfish: unterminated double quote\n"));
+ 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, _("guestfish: command arguments not separated by whitespace\n"));
+ fprintf (stderr,
+ _("%s: command arguments not separated by whitespace\n"),
+ program_name);
if (exit_on_error) exit (1);
goto next_command;
}
p++;
len = strcspn (p, "'");
if (p[len] == '\0') {
- fprintf (stderr, _("guestfish: unterminated single quote\n"));
+ 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, _("guestfish: command arguments not separated by whitespace\n"));
+ fprintf (stderr,
+ _("%s: command arguments not separated by whitespace\n"),
+ program_name);
if (exit_on_error) exit (1);
goto next_command;
}
pend++;
}
if (c != 0) {
- fprintf (stderr, _("guestfish: unterminated \"[...]\" sequence\n"));
+ fprintf (stderr,
+ _("%s: unterminated \"[...]\" sequence\n"), program_name);
if (exit_on_error) exit (1);
goto next_command;
}
if (*pend && (*pend != ' ' && *pend != '\t')) {
- fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
+ fprintf (stderr,
+ _("%s: command arguments not separated by whitespace\n"),
+ program_name);
if (exit_on_error) exit (1);
goto next_command;
}
} else
pend = &p[len];
} else {
- fprintf (stderr, _("guestfish: internal error parsing string at '%s'\n"),
- p);
+ fprintf (stderr, _("%s: internal error parsing string at '%s'\n"),
+ program_name, p);
abort ();
}
}
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;
}
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];
r = do_more (cmd, argc, argv);
else if (strcasecmp (cmd, "reopen") == 0)
r = do_reopen (cmd, argc, argv);
+ else if (strcasecmp (cmd, "sparse") == 0)
+ r = do_sparse (cmd, argc, argv);
else if (strcasecmp (cmd, "time") == 0)
r = do_time (cmd, argc, argv);
else
printf ("%-20s %s\n",
"reopen", _("close and reopen libguestfs handle"));
printf ("%-20s %s\n",
+ "sparse", _("allocate a sparse image file"));
+ printf ("%-20s %s\n",
"time", _("measure time taken to run command"));
/* actions are printed after this (see list_commands) */
" <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>T or <nn>TB number of terabytes\n"
+ " <nn>P or <nn>PB number of petabytes\n"
+ " <nn>E or <nn>EB number of exabytes\n"
" <nn>sects number of 512 byte sectors\n"));
else if (strcasecmp (cmd, "echo") == 0)
printf (_("echo - display a line of text\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, "sparse") == 0)
+ printf (_("sparse - allocate a sparse image file\n"
+ " sparse <filename> <size>\n"
+ "\n"
+ " This creates an empty sparse file of the given size,\n"
+ " and then adds so it can be further examined.\n"
+ "\n"
+ " In all respects it works the same as the 'alloc'\n"
+ " command, except that the image file is allocated\n"
+ " sparsely, which means that disk blocks are not assigned\n"
+ " to the file until they are needed. Sparse disk files\n"
+ " only use space when written to, but they are slower\n"
+ " and there is a danger you could run out of real disk\n"
+ " space during a write operation.\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>T or <nn>TB number of terabytes\n"
+ " <nn>P or <nn>PB number of petabytes\n"
+ " <nn>E or <nn>EB number of exabytes\n"
+ " <nn>sects number of 512 byte sectors\n"));
else if (strcasecmp (cmd, "time") == 0)
printf (_("time - measure time taken to run command\n"
" time <command> [<args> ...]\n"
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)
+{
+ size_t i;
+
+ for (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 && (!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 (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;
}
return 0;
}
+
+/* Resolve the special "win:..." form for Windows-specific paths.
+ * This always returns a newly allocated string which is freed by the
+ * caller function in "cmds.c".
+ */
+char *
+resolve_win_path (const char *path)
+{
+ char *ret;
+ size_t i;
+
+ if (strncasecmp (path, "win:", 4) != 0) {
+ ret = strdup (path);
+ if (ret == NULL)
+ perror ("strdup");
+ return ret;
+ }
+
+ path += 4;
+
+ /* Drop drive letter, if it's "C:". */
+ if (strncasecmp (path, "c:", 2) == 0)
+ path += 2;
+
+ if (!*path) {
+ ret = strdup ("/");
+ if (ret == NULL)
+ perror ("strdup");
+ return ret;
+ }
+
+ 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;
+}