Implement RString and RStringList return types.
[libguestfs.git] / fish / fish.c
index a252516..374416e 100644 (file)
@@ -22,7 +22,9 @@
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
+#include <fcntl.h>
 #include <getopt.h>
+#include <inttypes.h>
 
 #include <guestfs.h>
 
@@ -39,24 +41,27 @@ 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 issue_command (const char *cmd, char *argv[]);
+static int issue_command (const char *cmd, char *argv[]);
+static int parse_size (const char *str, off_t *size_rtn);
 
 /* Currently open libguestfs handle. */
 guestfs_h *g;
 int g_launched = 0;
 
 int quit = 0;
+int verbose = 0;
 
-void
+int
 launch (void)
 {
   if (!g_launched) {
     if (guestfs_launch (g) == -1)
-      exit (1);
+      return -1;
     if (guestfs_wait_ready (g) == -1)
-      exit (1);
+      return -1;
     g_launched = 1;
   }
+  return 0;
 }
 
 static void
@@ -67,7 +72,7 @@ usage (void)
           "guestfish lets you edit virtual machine filesystems\n"
           "Copyright (C) 2009 Red Hat Inc.\n"
           "Usage:\n"
-          "  guestfish [--options] cmd [: cmd ...]\n"
+          "  guestfish [--options] cmd [: cmd : cmd ...]\n"
           "or for interactive use:\n"
           "  guestfish\n"
           "or from a shell script:\n"
@@ -76,13 +81,14 @@ usage (void)
           "  ...\n"
           "  EOF\n"
           "Options:\n"
-          "  -h|--cmd-help       List available commands\n"
-          "  -h|--cmd-help cmd   Display detailed help on 'cmd'\n"
-          "  -a image            Add image\n"
-          "  -m dev[:mnt]        Mount dev on mnt (if omitted, /)\n"
-          /*"  --ro|-r             All mounts are read-only\n"*/
-          "  -v|--verbose        Verbose messages\n"
-          "For more information, see the manpage guestfish(1).\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");
 }
 
 int
@@ -94,6 +100,7 @@ main (int argc, char *argv[])
     { "cmd-help", 2, 0, 'h' },
     { "help", 0, 0, '?' },
     { "mount", 1, 0, 'm' },
+    { "no-sync", 0, 0, 'n' },
     { "verbose", 0, 0, 'v' },
     { 0, 0, 0, 0 }
   };
@@ -111,6 +118,16 @@ main (int argc, char *argv[])
     exit (1);
   }
 
+  guestfs_set_autosync (g, 1);
+
+  /* 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.
+   */
+  if (argv[0] &&
+      (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
+    guestfs_set_path (g, ".:" GUESTFS_DEFAULT_PATH);
+
   for (;;) {
     c = getopt_long (argc, argv, options, long_options, NULL);
     if (c == -1) break;
@@ -151,6 +168,15 @@ main (int argc, char *argv[])
       mps = mp->next;
       break;
 
+    case 'n':
+      guestfs_set_autosync (g, 0);
+      break;
+
+    case 'v':
+      verbose++;
+      guestfs_set_verbose (g, verbose);
+      break;
+
     case '?':
       usage ();
       exit (0);
@@ -163,7 +189,7 @@ main (int argc, char *argv[])
 
   /* If we've got mountpoints, we must launch the guest and mount them. */
   if (mps != NULL) {
-    launch ();
+    if (launch () == -1) exit (1);
     mount_mps (mps);
   }
 
@@ -232,7 +258,8 @@ script (int prompt)
   int len, i;
 
   if (prompt)
-    printf ("Welcome to guestfish, the libguestfs filesystem interactive shell for\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"
@@ -263,7 +290,9 @@ script (int prompt)
       exit (1);
     }
 
-    issue_command (cmd, argv);
+    if (issue_command (cmd, argv) == -1) {
+      if (!prompt) exit (1);
+    }
   }
   if (prompt) printf ("\n");
 }
@@ -287,27 +316,232 @@ cmdline (char *argv[], int optind, int argc)
   while (optind < argc && strcmp (argv[optind], ":") != 0)
     optind++;
 
-  if (optind == argc)
-    issue_command (cmd, params);
-  else {
+  if (optind == argc) {
+    if (issue_command (cmd, params) == -1) exit (1);
+  else {
     argv[optind] = NULL;
-    issue_command (cmd, params);
+    if (issue_command (cmd, params) == -1) exit (1);
     cmdline (argv, optind+1, argc);
   }
 }
 
-static void
+static int
 issue_command (const char *cmd, char *argv[])
 {
-  int i;
+  int argc;
+
+  for (argc = 0; argv[argc] != NULL; ++argc)
+    ;
+
+  if (strcasecmp (cmd, "help") == 0) {
+    if (argc == 0)
+      list_commands ();
+    else
+      display_command (argv[0]);
+    return 0;
+  }
+  else if (strcasecmp (cmd, "quit") == 0 ||
+          strcasecmp (cmd, "exit") == 0 ||
+          strcasecmp (cmd, "q") == 0) {
+    quit = 1;
+    return 0;
+  }
+  else if (strcasecmp (cmd, "add") == 0 ||
+          strcasecmp (cmd, "drive") == 0 ||
+          strcasecmp (cmd, "add-drive") == 0 ||
+          strcasecmp (cmd, "add_drive") == 0) {
+    if (argc != 1) {
+      fprintf (stderr, "use 'add image' to add a guest image\n");
+      return -1;
+    }
+    else
+      return guestfs_add_drive (g, argv[0]);
+  }
+  else if (strcasecmp (cmd, "cdrom") == 0 ||
+          strcasecmp (cmd, "add-cdrom") == 0 ||
+          strcasecmp (cmd, "add_cdrom") == 0) {
+    if (argc != 1) {
+      fprintf (stderr, "use 'cdrom image' to add a CD-ROM image\n");
+      return -1;
+    }
+    else
+      return guestfs_add_cdrom (g, argv[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;
+    }
+  }
+  else if (strcasecmp (cmd, "launch") == 0 ||
+          strcasecmp (cmd, "run") == 0) {
+    if (argc != 0) {
+      fprintf (stderr, "'launch' command takes no parameters\n");
+      return -1;
+    }
+    else
+      return launch ();
+  }
+  else
+    return run_action (cmd, argc, argv);
+}
+
+void
+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");
+  printf ("%-20s %s\n",
+         "quit", "quit guestfish");
+
+  /* then the non-actions, in alphabetical order */
+  printf ("%-20s %s\n",
+         "add", "add a guest image to be examined or modified");
+  printf ("%-20s %s\n",
+         "alloc", "allocate an image");
+  printf ("%-20s %s\n",
+         "cdrom", "add a CD-ROM image to be examined");
+  printf ("%-20s %s\n",
+         "launch", "launch the subprocess");
+
+  /* actions are printed after this (see list_commands) */
+}
 
-  fprintf (stderr, "cmd = %s", cmd);
-  for (i = 0; argv[i] != NULL; ++i)
-    fprintf (stderr, ", arg[%d]=%s", i, argv[i]);
-  fprintf (stderr, "\n");
+void
+display_builtin_command (const char *cmd)
+{
+  /* help for actions is auto-generated, see display_command */
+
+  if (strcasecmp (cmd, "add") == 0)
+    printf ("add - add a guest image to be examined or modified\n"
+           "     add <image>\n");
+  else 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");
+  else if (strcasecmp (cmd, "cdrom") == 0)
+    printf ("cdrom - add a CD-ROM image to be examined\n"
+           "     cdrom <iso-file>\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");
+  else if (strcasecmp (cmd, "launch") == 0)
+    printf ("launch - launch the subprocess\n"
+           "     launch\n");
+  else
+    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;
+  }
+
+  printf ("size = %lu\n", size);
 
+  /* 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)
+{
+  int argc;
 
+  for (argc = 0; argv[argc] != NULL; ++argc)
+    free (argv[argc]);
+  free (argv);
+}
+
+void
+print_strings (char **argv)
+{
+  int argc;
 
+  for (argc = 0; argv[argc] != NULL; ++argc)
+    printf ("%s\n", argv[argc]);
 }