Gettextize the source, make library strings translatable.
[libguestfs.git] / fish / fish.c
index 51a3d50..79f77fe 100644 (file)
@@ -26,8 +26,9 @@
 #include <unistd.h>
 #include <fcntl.h>
 #include <getopt.h>
-#include <inttypes.h>
+#include <signal.h>
 #include <assert.h>
+#include <ctype.h>
 
 #ifdef HAVE_LIBREADLINE
 #include <readline/readline.h>
@@ -50,15 +51,14 @@ 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 int parse_size (const char *str, off_t *size_rtn);
 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;
 
@@ -67,12 +67,11 @@ 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;
 }
@@ -81,40 +80,43 @@ static void
 usage (void)
 {
   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");
+          _("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"
+            "  -r|--ro              Mount read-only\n"
+            "  -v|--verbose         Verbose messages\n"
+            "  -V|--version         Display version and exit\n"
+            "For more information,  see the manpage guestfish(1).\n"));
 }
 
 int
 main (int argc, char *argv[])
 {
-  static const char *options = "a:h::m:v?";
+  static const char *options = "a:h::m:nrv?V";
   static struct option long_options[] = {
     { "add", 1, 0, 'a' },
     { "cmd-help", 2, 0, 'h' },
     { "help", 0, 0, '?' },
     { "mount", 1, 0, 'm' },
     { "no-sync", 0, 0, 'n' },
+    { "ro", 0, 0, 'r' },
     { "verbose", 0, 0, 'v' },
+    { "version", 0, 0, 'V' },
     { 0, 0, 0, 0 }
   };
   struct mp *mps = NULL;
@@ -129,7 +131,7 @@ main (int argc, char *argv[])
    */
   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);
   }
 
@@ -138,8 +140,12 @@ main (int argc, char *argv[])
   /* 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.
+   *
+   * 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);
 
@@ -187,17 +193,26 @@ main (int argc, char *argv[])
       guestfs_set_autosync (g, 0);
       break;
 
+    case 'r':
+      read_only = 1;
+      break;
+
     case 'v':
       verbose++;
       guestfs_set_verbose (g, verbose);
       break;
 
+    case 'V':
+      printf ("guestfish %s\n", PACKAGE_VERSION);
+      exit (0);
+
     case '?':
       usage ();
       exit (0);
 
     default:
-      fprintf (stderr, "guestfish: unexpected command line option 0x%x\n", c);
+      fprintf (stderr, _("guestfish: unexpected command line option 0x%x\n"),
+              c);
       exit (1);
     }
   }
@@ -247,9 +262,15 @@ pod2text (const char *heading, const char *str)
 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);
   }
 }
@@ -275,17 +296,21 @@ rl_gets (int prompt)
 {
 #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 (line_read && *line_read)
+      add_history_line (line_read);
 
-  if (prompt && line_read && *line_read)
-    add_history_line (line_read);
+    return line_read;
+  }
 
-#else /* !HAVE_LIBREADLINE */
+#endif /* HAVE_LIBREADLINE */
 
   static char buf[8192];
   int len;
@@ -298,8 +323,6 @@ rl_gets (int prompt)
     if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
   }
 
-#endif /* !HAVE_LIBREADLINE */
-
   return line_read;
 }
 
@@ -308,42 +331,172 @@ script (int prompt)
 {
   char *buf;
   char *cmd;
+  char *p, *pend;
   char *argv[64];
-  int i;
+  int i, len;
+  int global_exit_on_error = !prompt;
+  int exit_on_error;
 
   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) {
+    exit_on_error = global_exit_on_error;
+
     buf = rl_gets (prompt);
     if (!buf) {
       quit = 1;
       break;
     }
 
-    /* Split the buffer up at whitespace. */
-    cmd = strtok (buf, " \t");
-    if (cmd == NULL)
+    /* 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;
-    while (i < sizeof argv / sizeof argv[0] &&
-          (argv[i] = strtok (NULL, " \t")) != NULL)
-      i++;
+    if (buf[len] == '\0') {
+      argv[0] = NULL;
+      goto got_command;
+    }
+
+    buf[len] = '\0';
+    p = &buf[len+1];
+    p += strspn (p, " \t");
+
+    /* 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.
+       */
+      if (*p == '"') {
+       p++;
+       len = strcspn (p, "\"");
+       if (p[len] == '\0') {
+         fprintf (stderr, _("guestfish: unterminated double quote\n"));
+         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"));
+         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 (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"));
+         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 == '[') {
+       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 (exit_on_error) exit (1);
+         goto next_command;
+       }
+       if (*pend && (*pend != ' ' && *pend != '\t')) {
+         fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
+         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];
+      } else {
+       fprintf (stderr, _("guestfish: internal error parsing string at '%s'\n"),
+                p);
+       abort ();
+      }
+
+      argv[i++] = p;
+      p = pend;
+
+      if (*p)
+       p += strspn (p, " \t");
+    }
+
     if (i == sizeof argv / sizeof argv[0]) {
-      fprintf (stderr, "guestfish: too many arguments in command\n");
-      exit (1);
+      fprintf (stderr, _("guestfish: too many arguments\n"));
+      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 (exit_on_error) exit (1);
     }
+
+  next_command:;
   }
   if (prompt) printf ("\n");
 }
@@ -358,7 +511,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, _("guestfish: empty command on command line\n"));
     exit (1);
   }
   params = &argv[optind];
@@ -398,50 +551,14 @@ issue_command (const char *cmd, char *argv[])
     return 0;
   }
   else if (strcasecmp (cmd, "alloc") == 0 ||
-          strcasecmp (cmd, "allocate") == 0) {
-    if (argc != 2) {
-      fprintf (stderr, "use 'alloc file size' to create an image\n");
-      return -1;
-    }
-    else {
-      off_t size;
-      int fd;
-
-      if (parse_size (argv[1], &size) == -1)
-       return -1;
-
-      if (g_launched) {
-       fprintf (stderr, "can't allocate or add disks after launching\n");
-       return -1;
-      }
-
-      fd = open (argv[0], O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
-      if (fd == -1) {
-       perror (argv[0]);
-       return -1;
-      }
-
-      if (posix_fallocate (fd, 0, size) == -1) {
-       perror ("fallocate");
-       close (fd);
-       unlink (argv[0]);
-       return -1;
-      }
-
-      if (close (fd) == -1) {
-       perror (argv[0]);
-       unlink (argv[0]);
-       return -1;
-      }
-
-      if (guestfs_add_drive (g, argv[0]) == -1) {
-       unlink (argv[0]);
-       return -1;
-      }
-
-      return 0;
-    }
-  }
+          strcasecmp (cmd, "allocate") == 0)
+    return do_alloc (cmd, argc, argv);
+  else if (strcasecmp (cmd, "echo") == 0)
+    return 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);
   else
     return run_action (cmd, argc, argv);
 }
@@ -451,12 +568,16 @@ list_builtin_commands (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"));
 
   /* actions are printed after this (see list_commands) */
 }
@@ -466,70 +587,58 @@ display_builtin_command (const char *cmd)
 {
   /* help for actions is auto-generated, see display_command */
 
-  if (strcasecmp (cmd, "alloc") == 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");
+  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"));
+  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"));
   else if (strcasecmp (cmd, "help") == 0)
-    printf ("help - display a list of commands or help on a command\n"
-           "     help cmd\n"
-           "     help\n");
-  else if (strcasecmp (cmd, "quit") == 0)
-    printf ("quit - quit guestfish\n"
-           "     quit\n");
+    printf (_("help - display a list of commands or help on a command\n"
+             "     help cmd\n"
+             "     help\n"));
+  else if (strcasecmp (cmd, "quit") == 0 ||
+          strcasecmp (cmd, "exit") == 0 ||
+          strcasecmp (cmd, "q") == 0)
+    printf (_("quit - quit guestfish\n"
+             "     quit\n"));
   else
-    fprintf (stderr, "%s: command not known, use -h to list all commands\n",
+    fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
             cmd);
 }
 
-/* Parse size parameter of alloc command. */
-static int
-parse_size (const char *str, off_t *size_rtn)
-{
-  uint64_t size;
-  char type;
-
-  /* Note that the parsing here is looser than what is specified in the
-   * help, but we may tighten it up in future so beware.
-   */
-  if (sscanf (str, "%"SCNu64"%c", &size, &type) == 2) {
-    switch (type) {
-    case 'k': case 'K': size *= 1024; break;
-    case 'm': case 'M': size *= 1024 * 1024; break;
-    case 'g': case 'G': size *= 1024 * 1024 * 1024; break;
-    case 's': size *= 512; break;
-    default:
-      fprintf (stderr, "could not parse size specification '%s'\n", str);
-      return -1;
-    }
-  }
-  else if (sscanf (str, "%"SCNu64, &size) == 1)
-    size *= 1024;
-  else {
-    fprintf (stderr, "could not parse size specification '%s'\n", str);
-    return -1;
-  }
-
-  /* XXX 32 bit file offsets, if anyone uses them?  GCC should give
-   * a warning here anyhow.
-   */
-  *size_rtn = size;
-
-  return 0;
-}
-
 void
 free_strings (char **argv)
 {
@@ -549,6 +658,15 @@ print_strings (char * const * const argv)
     printf ("%s\n", argv[argc]);
 }
 
+void
+print_table (char * const * const argv)
+{
+  int i;
+
+  for (i = 0; argv[i] != NULL; i += 2)
+    printf ("%s: %s\n", argv[i], argv[i+1]);
+}
+
 int
 is_true (const char *str)
 {
@@ -560,10 +678,7 @@ is_true (const char *str)
     strcasecmp (str, "no") != 0;
 }
 
-/* This is quite inadequate for real use.  For example, there is no way
- * to specify an empty list.  We need to use a real parser to allow
- * quoting, empty lists, etc.
- */
+/* XXX We could improve list parsing. */
 char **
 parse_string_list (const char *str)
 {
@@ -573,7 +688,7 @@ parse_string_list (const char *str)
 
   argc = 1;
   for (i = 0; str[i]; ++i)
-    if (str[i] == ':') argc++;
+    if (str[i] == ' ') argc++;
 
   argv = malloc (sizeof (char *) * (argc+1));
   if (argv == NULL) { perror ("malloc"); exit (1); }
@@ -581,10 +696,10 @@ parse_string_list (const char *str)
   p = str;
   i = 0;
   while (*p) {
-    pend = strchrnul (p, ':');
+    pend = strchrnul (p, ' ');
     argv[i] = strndup (p, pend-p);
     i++;
-    p = *pend == ':' ? pend+1 : pend;
+    p = *pend == ' ' ? pend+1 : pend;
   }
   argv[i] = NULL;