X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=fish%2Ffish.c;h=bf82b8af936e39c153f6ba16fc8607a2a9ab2252;hp=e0d047069cf6e6d104d715e2c281db59f277fa79;hb=394c8bec21d47b74567a4148fdbf87318c301441;hpb=73d6932ab2dd3f9120a1f4a532621c07cb174705 diff --git a/fish/fish.c b/fish/fish.c index e0d0470..bf82b8a 100644 --- a/fish/fish.c +++ b/fish/fish.c @@ -18,13 +18,22 @@ #include +#define _GNU_SOURCE // for strchrnul + #include #include #include #include #include #include -#include +#include +#include +#include + +#ifdef HAVE_LIBREADLINE +#include +#include +#endif #include @@ -36,30 +45,38 @@ struct mp { char *mountpoint; }; +struct drv { + struct drv *next; + char *filename; +}; + +static void add_drives (struct drv *drv); static void mount_mps (struct mp *mp); static void interactive (void); 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; int -launch (void) +launch (guestfs_h *_g) { - if (!g_launched) { + assert (_g == g); + + 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; } @@ -68,65 +85,79 @@ 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 <filename = optarg; + drv->next = drvs; + drvs = drv; + break; + + case 'D': + complete_dest_paths = 0; break; case 'h': @@ -172,24 +213,36 @@ 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); } } + /* If we've got drives to add, add them now. */ + add_drives (drvs); + /* If we've got mountpoints, we must launch the guest and mount them. */ if (mps != NULL) { - if (launch () == -1) exit (1); + if (launch (g) == -1) exit (1); mount_mps (mps); } @@ -203,6 +256,8 @@ main (int argc, char *argv[]) else cmdline (argv, optind, argc); + cleanup_readline (); + exit (0); } @@ -230,9 +285,31 @@ 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); + } +} + +static void +add_drives (struct drv *drv) +{ + int r; + + if (drv) { + add_drives (drv->next); + if (!read_only) + r = guestfs_add_drive (g, drv->filename); + else + r = guestfs_add_drive_ro (g, drv->filename); + if (r == -1) exit (1); } } @@ -249,50 +326,216 @@ shell_script (void) script (0); } +#define FISH "> " + +static char *line_read = NULL; + +static char * +rl_gets (int prompt) +{ +#ifdef HAVE_LIBREADLINE + + if (prompt) { + if (line_read) { + free (line_read); + line_read = NULL; + } + + line_read = readline (prompt ? FISH : ""); + + if (line_read && *line_read) + add_history_line (line_read); + + return line_read; + } + +#endif /* HAVE_LIBREADLINE */ + + static char buf[8192]; + int len; + + if (prompt) printf (FISH); + line_read = fgets (buf, sizeof buf, stdin); + + if (line_read) { + len = strlen (line_read); + if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0'; + } + + return line_read; +} + static void script (int prompt) { - char buf[8192]; + char *buf; char *cmd; + char *p, *pend; char *argv[64]; - int len, 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) { - if (prompt) printf ("> "); - if (fgets (buf, sizeof buf, stdin) == NULL) { + exit_on_error = global_exit_on_error; + + buf = rl_gets (prompt); + if (!buf) { quit = 1; break; } - len = strlen (buf); - if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0'; + /* 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; - /* Split the buffer up at whitespace. */ - cmd = strtok (buf, " \t"); - if (cmd == NULL) + /* 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"); } @@ -307,7 +550,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]; @@ -325,7 +568,7 @@ cmdline (char *argv[], int optind, int argc) } } -static int +int issue_command (const char *cmd, char *argv[]) { int argc; @@ -346,81 +589,19 @@ issue_command (const char *cmd, char *argv[]) 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 (); - } + 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 if (strcasecmp (cmd, "lcd") == 0) + return do_lcd (cmd, argc, argv); + else if (strcasecmp (cmd, "glob") == 0) + return do_glob (cmd, argc, argv); else return run_action (cmd, argc, argv); } @@ -430,19 +611,20 @@ 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")); - /* then the non-actions, in alphabetical order */ printf ("%-20s %s\n", - "add", "add a guest image to be examined or modified"); + "alloc", _("allocate an image")); printf ("%-20s %s\n", - "alloc", "allocate an image"); + "echo", _("display a line of text")); printf ("%-20s %s\n", - "cdrom", "add a CD-ROM image to be examined"); + "edit", _("edit a file in the image")); printf ("%-20s %s\n", - "launch", "launch the subprocess"); + "lcd", _("local change directory")); + printf ("%-20s %s\n", + "glob", _("expand wildcards in command")); /* actions are printed after this (see list_commands) */ } @@ -452,81 +634,72 @@ 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 \n"); - else if (strcasecmp (cmd, "alloc") == 0) - printf ("alloc - allocate an image\n" - " alloc \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 means a number):\n" - " number of kilobytes\n" - " eg: 1440 standard 3.5\" floppy\n" - " K or KB number of kilobytes\n" - " M or MB number of megabytes\n" - " G or GB number of gigabytes\n" - " 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 \n"); + if (strcasecmp (cmd, "alloc") == 0 || + strcasecmp (cmd, "allocate") == 0) + printf (_("alloc - allocate an image\n" + " alloc \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 means a number):\n" + " number of kilobytes\n" + " eg: 1440 standard 3.5\" floppy\n" + " K or KB number of kilobytes\n" + " M or MB number of megabytes\n" + " G or GB number of gigabytes\n" + " sects number of 512 byte sectors\n")); + else if (strcasecmp (cmd, "echo") == 0) + printf (_("echo - display a line of text\n" + " echo [ ...]\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 \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, "lcd") == 0) + printf (_("lcd - local change directory\n" + " lcd \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) + printf (_("glob - expand wildcards in command\n" + " glob [ ...]\n" + "\n" + " Glob runs 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) - 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"); + 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; - } - - 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) { @@ -537,11 +710,120 @@ free_strings (char **argv) free (argv); } +int +count_strings (char * const * const argv) +{ + int c; + + for (c = 0; argv[c]; ++c) + ; + return c; +} + void -print_strings (char **argv) +print_strings (char * const * const argv) { int argc; for (argc = 0; argv[argc] != NULL; ++argc) 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) +{ + return + strcasecmp (str, "0") != 0 && + strcasecmp (str, "f") != 0 && + strcasecmp (str, "false") != 0 && + strcasecmp (str, "n") != 0 && + strcasecmp (str, "no") != 0; +} + +/* XXX We could improve list parsing. */ +char ** +parse_string_list (const char *str) +{ + char **argv; + const char *p, *pend; + int argc, i; + + argc = 1; + for (i = 0; str[i]; ++i) + if (str[i] == ' ') argc++; + + argv = malloc (sizeof (char *) * (argc+1)); + if (argv == NULL) { perror ("malloc"); exit (1); } + + p = str; + i = 0; + while (*p) { + pend = strchrnul (p, ' '); + argv[i] = strndup (p, pend-p); + i++; + p = *pend == ' ' ? pend+1 : pend; + } + argv[i] = NULL; + + return argv; +} + +#ifdef HAVE_LIBREADLINE +static char histfile[1024]; +static int nr_history_lines = 0; +#endif + +static void +initialize_readline (void) +{ +#ifdef HAVE_LIBREADLINE + const char *home; + + home = getenv ("HOME"); + if (home) { + snprintf (histfile, sizeof histfile, "%s/.guestfish", home); + using_history (); + (void) read_history (histfile); + } + + rl_readline_name = "guestfish"; + rl_attempted_completion_function = do_completion; +#endif +} + +static void +cleanup_readline (void) +{ +#ifdef HAVE_LIBREADLINE + int fd; + + if (histfile[0] != '\0') { + fd = open (histfile, O_WRONLY|O_CREAT, 0644); + if (fd == -1) { + perror (histfile); + return; + } + close (fd); + + (void) append_history (nr_history_lines, histfile); + } +#endif +} + +static void +add_history_line (const char *line) +{ +#ifdef HAVE_LIBREADLINE + add_history (line); + nr_history_lines++; +#endif +}