X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=fish%2Ffish.c;h=9316edaae494dadc34b31528b6f22ad18743ea1d;hp=f31f4ad349588686e6c2f8f950568631e0884ae1;hb=22cee80bc2f631703bf417a54ef4e0f0837e921a;hpb=8249460acfc0ab7298d125b4ea29c72729a4582b

diff --git a/fish/fish.c b/fish/fish.c
index f31f4ad..9316eda 100644
--- a/fish/fish.c
+++ b/fish/fish.c
@@ -18,8 +18,6 @@
 
 #include <config.h>
 
-#define _GNU_SOURCE // for strchrnul
-
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -40,6 +38,8 @@
 #include <guestfs.h>
 
 #include "fish.h"
+#include "closeout.h"
+#include "progname.h"
 
 struct mp {
   struct mp *next;
@@ -87,21 +87,25 @@ 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"
+  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"
@@ -115,24 +119,36 @@ usage (void)
              "  --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' },
@@ -186,6 +202,15 @@ main (int argc, char *argv[])
       (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;
@@ -197,21 +222,24 @@ main (int argc, char *argv[])
       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;
@@ -237,7 +265,8 @@ main (int argc, char *argv[])
 
     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;
@@ -267,7 +296,7 @@ main (int argc, char *argv[])
         *p = '\0';
         mp->mountpoint = p+1;
       } else
-        mp->mountpoint = "/";
+        mp->mountpoint = bad_cast ("/");
       mp->device = optarg;
       mp->next = mps;
       mps = mp;
@@ -287,21 +316,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 '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);
     }
   }
 
@@ -312,19 +338,25 @@ main (int argc, char *argv[])
 
     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, " '");
@@ -338,7 +370,7 @@ 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");
@@ -347,7 +379,7 @@ main (int argc, char *argv[])
 
     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) {
@@ -368,17 +400,23 @@ main (int argc, char *argv[])
 
   /* 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 ();
@@ -517,7 +555,7 @@ script (int prompt)
   char *cmd;
   char *p, *pend;
   char *argv[64];
-  int i, len;
+  int len;
   int global_exit_on_error = !prompt;
   int tilde_candidate;
 
@@ -581,7 +619,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;
@@ -602,12 +640,14 @@ script (int prompt)
         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;
         }
@@ -617,12 +657,14 @@ script (int prompt)
         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;
         }
@@ -643,12 +685,15 @@ script (int prompt)
           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;
         }
@@ -667,8 +712,8 @@ script (int prompt)
         } 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 ();
       }
 
@@ -684,7 +729,7 @@ script (int prompt)
     }
 
     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;
     }
@@ -713,7 +758,7 @@ cmdline (char *argv[], int optind, int argc)
 
   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];
@@ -750,8 +795,14 @@ issue_command (const char *cmd, char *argv[], const char *pipecmd)
   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");
@@ -760,7 +811,10 @@ 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) {
@@ -770,9 +824,16 @@ issue_command (const char *cmd, char *argv[], const char *pipecmd)
       _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]);
   }
 
@@ -823,13 +884,22 @@ issue_command (const char *cmd, char *argv[], const char *pipecmd)
   /* Always flush stdout after every command, so that messages, results
    * etc appear immediately.
    */
-  fflush (stdout);
+  if (fflush (stdout) == EOF) {
+    perror ("failed to flush standard output");
+    return -1;
+  }
 
   if (pipecmd) {
     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;
@@ -974,7 +1044,7 @@ free_strings (char **argv)
 }
 
 int
-count_strings (char * const * const argv)
+count_strings (char *const *argv)
 {
   int c;
 
@@ -984,7 +1054,7 @@ count_strings (char * const * const argv)
 }
 
 void
-print_strings (char * const * const argv)
+print_strings (char *const *argv)
 {
   int argc;
 
@@ -993,7 +1063,7 @@ print_strings (char * const * const argv)
 }
 
 void
-print_table (char * const * const argv)
+print_table (char *const *argv)
 {
   int i;
 
@@ -1012,30 +1082,146 @@ is_true (const char *str)
     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;
+    }
   }
-  argv[i] = NULL;
+
+  /* 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 = argv_new;
+
+  argv[argv_len-1] = NULL;
 
   return argv;
 }
@@ -1092,9 +1278,10 @@ add_history_line (const char *line)
 }
 
 int
-xwrite (int fd, const void *buf, size_t len)
+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);