change strncasecmp() == 0 to STRCASENEQLEN()
[libguestfs.git] / fish / fish.c
index a758810..0387eb7 100644 (file)
@@ -18,8 +18,6 @@
 
 #include <config.h>
 
-#define _GNU_SOURCE // for strchrnul
-
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -28,7 +26,6 @@
 #include <getopt.h>
 #include <signal.h>
 #include <assert.h>
-#include <ctype.h>
 #include <sys/types.h>
 #include <sys/wait.h>
 
@@ -40,6 +37,7 @@
 #include <guestfs.h>
 
 #include "fish.h"
+#include "c-ctype.h"
 #include "closeout.h"
 #include "progname.h"
 
@@ -83,8 +81,6 @@ launch (guestfs_h *_g)
   if (guestfs_is_config (g)) {
     if (guestfs_launch (g) == -1)
       return -1;
-    if (guestfs_wait_ready (g) == -1)
-      return -1;
   }
   return 0;
 }
@@ -219,9 +215,9 @@ main (int argc, char *argv[])
 
     switch (c) {
     case 0:                    /* options which are long only */
-      if (strcmp (long_options[option_index].name, "listen") == 0)
+      if (STREQ (long_options[option_index].name, "listen"))
         remote_control_listen = 1;
-      else if (strcmp (long_options[option_index].name, "remote") == 0) {
+      else if (STREQ (long_options[option_index].name, "remote")) {
         if (optarg) {
           if (sscanf (optarg, "%d", &remote_control) != 1) {
             fprintf (stderr, _("%s: --listen=PID: PID was not a number: %s\n"),
@@ -237,7 +233,7 @@ main (int argc, char *argv[])
             exit (1);
           }
         }
-      } else if (strcmp (long_options[option_index].name, "selinux") == 0) {
+      } else if (STREQ (long_options[option_index].name, "selinux")) {
         guestfs_set_selinux (g, 1);
       } else {
         fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
@@ -583,7 +579,7 @@ script (int prompt)
 
     /* Skip any initial whitespace before the command. */
   again:
-    while (*buf && isspace (*buf))
+    while (*buf && c_isspace (*buf))
       buf++;
 
     if (!*buf) continue;
@@ -759,14 +755,14 @@ cmdline (char *argv[], int optind, int argc)
   if (optind >= argc) return;
 
   cmd = argv[optind++];
-  if (strcmp (cmd, ":") == 0) {
+  if (STREQ (cmd, ":")) {
     fprintf (stderr, _("%s: empty command on command line\n"), program_name);
     exit (1);
   }
   params = &argv[optind];
 
   /* Search for end of command list or ":" ... */
-  while (optind < argc && strcmp (argv[optind], ":") != 0)
+  while (optind < argc && STRNEQ (argv[optind], ":"))
     optind++;
 
   if (optind == argc) {
@@ -847,38 +843,40 @@ issue_command (const char *cmd, char *argv[], const char *pipecmd)
     r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
 
   /* Otherwise execute it locally. */
-  else if (strcasecmp (cmd, "help") == 0) {
+  else if (STRCASEEQ (cmd, "help")) {
     if (argc == 0)
       list_commands ();
     else
       display_command (argv[0]);
     r = 0;
   }
-  else if (strcasecmp (cmd, "quit") == 0 ||
-           strcasecmp (cmd, "exit") == 0 ||
-           strcasecmp (cmd, "q") == 0) {
+  else if (STRCASEEQ (cmd, "quit") ||
+           STRCASEEQ (cmd, "exit") ||
+           STRCASEEQ (cmd, "q")) {
     quit = 1;
     r = 0;
   }
-  else if (strcasecmp (cmd, "alloc") == 0 ||
-           strcasecmp (cmd, "allocate") == 0)
+  else if (STRCASEEQ (cmd, "alloc") ||
+           STRCASEEQ (cmd, "allocate"))
     r = do_alloc (cmd, argc, argv);
-  else if (strcasecmp (cmd, "echo") == 0)
+  else if (STRCASEEQ (cmd, "echo"))
     r = do_echo (cmd, argc, argv);
-  else if (strcasecmp (cmd, "edit") == 0 ||
-           strcasecmp (cmd, "vi") == 0 ||
-           strcasecmp (cmd, "emacs") == 0)
+  else if (STRCASEEQ (cmd, "edit") ||
+           STRCASEEQ (cmd, "vi") ||
+           STRCASEEQ (cmd, "emacs"))
     r = do_edit (cmd, argc, argv);
-  else if (strcasecmp (cmd, "lcd") == 0)
+  else if (STRCASEEQ (cmd, "lcd"))
     r = do_lcd (cmd, argc, argv);
-  else if (strcasecmp (cmd, "glob") == 0)
+  else if (STRCASEEQ (cmd, "glob"))
     r = do_glob (cmd, argc, argv);
-  else if (strcasecmp (cmd, "more") == 0 ||
-           strcasecmp (cmd, "less") == 0)
+  else if (STRCASEEQ (cmd, "more") ||
+           STRCASEEQ (cmd, "less"))
     r = do_more (cmd, argc, argv);
-  else if (strcasecmp (cmd, "reopen") == 0)
+  else if (STRCASEEQ (cmd, "reopen"))
     r = do_reopen (cmd, argc, argv);
-  else if (strcasecmp (cmd, "time") == 0)
+  else if (STRCASEEQ (cmd, "sparse"))
+    r = do_sparse (cmd, argc, argv);
+  else if (STRCASEEQ (cmd, "time"))
     r = do_time (cmd, argc, argv);
   else
     r = run_action (cmd, argc, argv);
@@ -931,6 +929,8 @@ list_builtin_commands (void)
   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) */
@@ -941,8 +941,8 @@ display_builtin_command (const char *cmd)
 {
   /* help for actions is auto-generated, see display_command */
 
-  if (strcasecmp (cmd, "alloc") == 0 ||
-      strcasecmp (cmd, "allocate") == 0)
+  if (STRCASEEQ (cmd, "alloc") ||
+      STRCASEEQ (cmd, "allocate"))
     printf (_("alloc - allocate an image\n"
               "     alloc <filename> <size>\n"
               "\n"
@@ -957,15 +957,18 @@ display_builtin_command (const char *cmd)
               "    <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)
+  else if (STRCASEEQ (cmd, "echo"))
     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)
+  else if (STRCASEEQ (cmd, "edit") ||
+           STRCASEEQ (cmd, "vi") ||
+           STRCASEEQ (cmd, "emacs"))
     printf (_("edit - edit a file in the image\n"
               "     edit <filename>\n"
               "\n"
@@ -979,26 +982,26 @@ display_builtin_command (const char *cmd)
               "\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)
+  else if (STRCASEEQ (cmd, "lcd"))
     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)
+  else if (STRCASEEQ (cmd, "glob"))
     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)
+  else if (STRCASEEQ (cmd, "help"))
     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)
+  else if (STRCASEEQ (cmd, "more") ||
+           STRCASEEQ (cmd, "less"))
     printf (_("more - view a file in the pager\n"
               "     more <filename>\n"
               "\n"
@@ -1012,19 +1015,46 @@ display_builtin_command (const char *cmd)
               "\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)
+  else if (STRCASEEQ (cmd, "quit") ||
+           STRCASEEQ (cmd, "exit") ||
+           STRCASEEQ (cmd, "q"))
     printf (_("quit - quit guestfish\n"
               "     quit\n"));
-  else if (strcasecmp (cmd, "reopen") == 0)
+  else if (STRCASEEQ (cmd, "reopen"))
     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)
+  else if (STRCASEEQ (cmd, "sparse"))
+    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 (STRCASEEQ (cmd, "time"))
     printf (_("time - measure time taken to run command\n"
               "    time <command> [<args> ...]\n"
               "\n"
@@ -1077,37 +1107,155 @@ int
 is_true (const char *str)
 {
   return
-    strcasecmp (str, "0") != 0 &&
-    strcasecmp (str, "f") != 0 &&
-    strcasecmp (str, "false") != 0 &&
-    strcasecmp (str, "n") != 0 &&
-    strcasecmp (str, "no") != 0;
+    STRCASENEQ (str, "0") &&
+    STRCASENEQ (str, "f") &&
+    STRCASENEQ (str, "false") &&
+    STRCASENEQ (str, "n") &&
+    STRCASENEQ (str, "no");
+}
+
+/* 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);
 }
 
-/* XXX We could improve list parsing. */
 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;
+    }
   }
-  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;
 }
@@ -1181,3 +1329,51 @@ xwrite (int fd, const void *v_buf, size_t len)
 
   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 (STRCASENEQLEN (path, "win:", 4)) {
+    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;
+}