fish/fish.c

   1 /* guestfish - the filesystem interactive shell
   2  * Copyright (C) 2009 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <config.h>
  20
  21 #define _GNU_SOURCE // for strchrnul
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <unistd.h>
  27 #include <fcntl.h>
  28 #include <getopt.h>
  29 #include <signal.h>
  30 #include <assert.h>
  31 #include <ctype.h>
  32
  33 #ifdef HAVE_LIBREADLINE
  34 #include <readline/readline.h>
  35 #include <readline/history.h>
  36 #endif
  37
  38 #include <guestfs.h>
  39
  40 #include "fish.h"
  41
  42 struct mp {
  43   struct mp *next;
  44   char *device;
  45   char *mountpoint;
  46 };
  47
  48 static void mount_mps (struct mp *mp);
  49 static void interactive (void);
  50 static void shell_script (void);
  51 static void script (int prompt);
  52 static void cmdline (char *argv[], int optind, int argc);
  53 static int issue_command (const char *cmd, char *argv[]);
  54 static void initialize_readline (void);
  55 static void cleanup_readline (void);
  56 static void add_history_line (const char *);
  57
  58 /* Currently open libguestfs handle. */
  59 guestfs_h *g;
  60
  61 int read_only = 0;
  62 int quit = 0;
  63 int verbose = 0;
  64
  65 int
  66 launch (guestfs_h *_g)
  67 {
  68   assert (_g == g);
  69
  70   if (guestfs_is_config (g)) {
  71     if (guestfs_launch (g) == -1)
  72       return -1;
  73     if (guestfs_wait_ready (g) == -1)
  74       return -1;
  75   }
  76   return 0;
  77 }
  78
  79 static void
  80 usage (void)
  81 {
  82   fprintf (stderr,
  83            "guestfish: guest filesystem shell\n"
  84            "guestfish lets you edit virtual machine filesystems\n"
  85            "Copyright (C) 2009 Red Hat Inc.\n"
  86            "Usage:\n"
  87            "  guestfish [--options] cmd [: cmd : cmd ...]\n"
  88            "or for interactive use:\n"
  89            "  guestfish\n"
  90            "or from a shell script:\n"
  91            "  guestfish <<EOF\n"
  92            "  cmd\n"
  93            "  ...\n"
  94            "  EOF\n"
  95            "Options:\n"
  96            "  -h|--cmd-help        List available commands\n"
  97            "  -h|--cmd-help cmd    Display detailed help on 'cmd'\n"
  98            "  -a|--add image       Add image\n"
  99            "  -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
 100            "  -n|--no-sync         Don't autosync\n"
 101            "  -r|--ro              Mount read-only\n"
 102            "  -v|--verbose         Verbose messages\n"
 103            "  -V|--version         Display version and exit\n"
 104            "For more information,  see the manpage guestfish(1).\n");
 105 }
 106
 107 int
 108 main (int argc, char *argv[])
 109 {
 110   static const char *options = "a:h::m:nrv?V";
 111   static struct option long_options[] = {
 112     { "add", 1, 0, 'a' },
 113     { "cmd-help", 2, 0, 'h' },
 114     { "help", 0, 0, '?' },
 115     { "mount", 1, 0, 'm' },
 116     { "no-sync", 0, 0, 'n' },
 117     { "ro", 0, 0, 'r' },
 118     { "verbose", 0, 0, 'v' },
 119     { "version", 0, 0, 'V' },
 120     { 0, 0, 0, 0 }
 121   };
 122   struct mp *mps = NULL;
 123   struct mp *mp;
 124   char *p;
 125   int c;
 126
 127   initialize_readline ();
 128
 129   /* guestfs_create is meant to be a lightweight operation, so
 130    * it's OK to do it early here.
 131    */
 132   g = guestfs_create ();
 133   if (g == NULL) {
 134     fprintf (stderr, "guestfs_create: failed to create handle\n");
 135     exit (1);
 136   }
 137
 138   guestfs_set_autosync (g, 1);
 139
 140   /* If developing, add . to the path.  Note that libtools interferes
 141    * with this because uninstalled guestfish is a shell script that runs
 142    * the real program with an absolute path.  Detect that too.
 143    *
 144    * BUT if LIBGUESTFS_PATH environment variable is already set by
 145    * the user, then don't override it.
 146    */
 147   if (getenv ("LIBGUESTFS_PATH") == NULL &&
 148       argv[0] &&
 149       (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
 150     guestfs_set_path (g, ".:" GUESTFS_DEFAULT_PATH);
 151
 152   for (;;) {
 153     c = getopt_long (argc, argv, options, long_options, NULL);
 154     if (c == -1) break;
 155
 156     switch (c) {
 157     case 'a':
 158       if (access (optarg, R_OK) != 0) {
 159         perror (optarg);
 160         exit (1);
 161       }
 162       if (guestfs_add_drive (g, optarg) == -1)
 163         exit (1);
 164       break;
 165
 166     case 'h':
 167       if (optarg)
 168         display_command (optarg);
 169       else if (argv[optind] && argv[optind][0] != '-')
 170         display_command (argv[optind++]);
 171       else
 172         list_commands ();
 173       exit (0);
 174
 175     case 'm':
 176       mp = malloc (sizeof (struct mp));
 177       if (!mp) {
 178         perror ("malloc");
 179         exit (1);
 180       }
 181       p = strchr (optarg, ':');
 182       if (p) {
 183         *p = '\0';
 184         mp->mountpoint = p+1;
 185       } else
 186         mp->mountpoint = "/";
 187       mp->device = optarg;
 188       mp->next = mps;
 189       mps = mp;
 190       break;
 191
 192     case 'n':
 193       guestfs_set_autosync (g, 0);
 194       break;
 195
 196     case 'r':
 197       read_only = 1;
 198       break;
 199
 200     case 'v':
 201       verbose++;
 202       guestfs_set_verbose (g, verbose);
 203       break;
 204
 205     case 'V':
 206       printf ("guestfish %s\n", PACKAGE_VERSION);
 207       exit (0);
 208
 209     case '?':
 210       usage ();
 211       exit (0);
 212
 213     default:
 214       fprintf (stderr, "guestfish: unexpected command line option 0x%x\n", c);
 215       exit (1);
 216     }
 217   }
 218
 219   /* If we've got mountpoints, we must launch the guest and mount them. */
 220   if (mps != NULL) {
 221     if (launch (g) == -1) exit (1);
 222     mount_mps (mps);
 223   }
 224
 225   /* Interactive, shell script, or command(s) on the command line? */
 226   if (optind >= argc) {
 227     if (isatty (0))
 228       interactive ();
 229     else
 230       shell_script ();
 231   }
 232   else
 233     cmdline (argv, optind, argc);
 234
 235   cleanup_readline ();
 236
 237   exit (0);
 238 }
 239
 240 void
 241 pod2text (const char *heading, const char *str)
 242 {
 243   FILE *fp;
 244
 245   fp = popen ("pod2text", "w");
 246   if (fp == NULL) {
 247     /* pod2text failed, maybe not found, so let's just print the
 248      * source instead, since that's better than doing nothing.
 249      */
 250     printf ("%s\n\n%s\n", heading, str);
 251     return;
 252   }
 253   fputs ("=head1 ", fp);
 254   fputs (heading, fp);
 255   fputs ("\n\n", fp);
 256   fputs (str, fp);
 257   pclose (fp);
 258 }
 259
 260 /* List is built in reverse order, so mount them in reverse order. */
 261 static void
 262 mount_mps (struct mp *mp)
 263 {
 264   int r;
 265
 266   if (mp) {
 267     mount_mps (mp->next);
 268     if (!read_only)
 269       r = guestfs_mount (g, mp->device, mp->mountpoint);
 270     else
 271       r = guestfs_mount_ro (g, mp->device, mp->mountpoint);
 272     if (r == -1)
 273       exit (1);
 274   }
 275 }
 276
 277 static void
 278 interactive (void)
 279 {
 280   script (1);
 281 }
 282
 283 static void
 284 shell_script (void)
 285 {
 286   script (0);
 287 }
 288
 289 #define FISH "><fs> "
 290
 291 static char *line_read = NULL;
 292
 293 static char *
 294 rl_gets (int prompt)
 295 {
 296 #ifdef HAVE_LIBREADLINE
 297
 298   if (prompt) {
 299     if (line_read) {
 300       free (line_read);
 301       line_read = NULL;
 302     }
 303
 304     line_read = readline (prompt ? FISH : "");
 305
 306     if (line_read && *line_read)
 307       add_history_line (line_read);
 308
 309     return line_read;
 310   }
 311
 312 #endif /* HAVE_LIBREADLINE */
 313
 314   static char buf[8192];
 315   int len;
 316
 317   if (prompt) printf (FISH);
 318   line_read = fgets (buf, sizeof buf, stdin);
 319
 320   if (line_read) {
 321     len = strlen (line_read);
 322     if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
 323   }
 324
 325   return line_read;
 326 }
 327
 328 static void
 329 script (int prompt)
 330 {
 331   char *buf;
 332   char *cmd;
 333   char *p, *pend;
 334   char *argv[64];
 335   int i, len;
 336   int global_exit_on_error = !prompt;
 337   int exit_on_error;
 338
 339   if (prompt)
 340     printf ("\n"
 341             "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
 342             "editing virtual machine filesystems.\n"
 343             "\n"
 344             "Type: 'help' for help with commands\n"
 345             "      'quit' to quit the shell\n"
 346             "\n");
 347
 348   while (!quit) {
 349     exit_on_error = global_exit_on_error;
 350
 351     buf = rl_gets (prompt);
 352     if (!buf) {
 353       quit = 1;
 354       break;
 355     }
 356
 357     /* Skip any initial whitespace before the command. */
 358   again:
 359     while (*buf && isspace (*buf))
 360       buf++;
 361
 362     if (!*buf) continue;
 363
 364     /* If the next character is '#' then this is a comment. */
 365     if (*buf == '#') continue;
 366
 367     /* If the next character is '!' then pass the whole lot to system(3). */
 368     if (*buf == '!') {
 369       int r;
 370
 371       r = system (buf+1);
 372       if (exit_on_error) {
 373         if (r == -1 ||
 374             (WIFSIGNALED (r) &&
 375              (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
 376             WEXITSTATUS (r) != 0)
 377           exit (1);
 378       }
 379       continue;
 380     }
 381
 382     /* If the next character is '-' allow the command to fail without
 383      * exiting on error (just for this one command though).
 384      */
 385     if (*buf == '-') {
 386       exit_on_error = 0;
 387       buf++;
 388       goto again;
 389     }
 390
 391     /* Get the command (cannot be quoted). */
 392     len = strcspn (buf, " \t");
 393
 394     if (len == 0) continue;
 395
 396     cmd = buf;
 397     i = 0;
 398     if (buf[len] == '\0') {
 399       argv[0] = NULL;
 400       goto got_command;
 401     }
 402
 403     buf[len] = '\0';
 404     p = &buf[len+1];
 405     p += strspn (p, " \t");
 406
 407     /* Get the parameters. */
 408     while (*p && i < sizeof argv / sizeof argv[0]) {
 409       /* Parameters which start with quotes or square brackets
 410        * are treated specially.  Bare parameters are delimited
 411        * by whitespace.
 412        */
 413       if (*p == '"') {
 414         p++;
 415         len = strcspn (p, "\"");
 416         if (p[len] == '\0') {
 417           fprintf (stderr, "guestfish: unterminated double quote\n");
 418           if (exit_on_error) exit (1);
 419           goto next_command;
 420         }
 421         if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
 422           fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
 423           if (exit_on_error) exit (1);
 424           goto next_command;
 425         }
 426         p[len] = '\0';
 427         pend = p[len+1] ? &p[len+2] : &p[len+1];
 428       } else if (*p == '\'') {
 429         p++;
 430         len = strcspn (p, "'");
 431         if (p[len] == '\0') {
 432           fprintf (stderr, "guestfish: unterminated single quote\n");
 433           if (exit_on_error) exit (1);
 434           goto next_command;
 435         }
 436         if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
 437           fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
 438           if (exit_on_error) exit (1);
 439           goto next_command;
 440         }
 441         p[len] = '\0';
 442         pend = p[len+1] ? &p[len+2] : &p[len+1];
 443         /*
 444       } else if (*p == '[') {
 445         int c = 1;
 446         p++;
 447         pend = p;
 448         while (*pend && c != 0) {
 449           if (*pend == '[') c++;
 450           else if (*pend == ']') c--;
 451           pend++;
 452         }
 453         if (c != 0) {
 454           fprintf (stderr, "guestfish: unterminated \"[...]\" sequence\n");
 455           if (exit_on_error) exit (1);
 456           goto next_command;
 457         }
 458         if (*pend && (*pend != ' ' && *pend != '\t')) {
 459           fprintf (stderr, "guestfish: command arguments not separated by whitespace\n");
 460           if (exit_on_error) exit (1);
 461           goto next_command;
 462         }
 463         *(pend-1) = '\0';
 464         */
 465       } else if (*p != ' ' && *p != '\t') {
 466         len = strcspn (p, " \t");
 467         if (p[len]) {
 468           p[len] = '\0';
 469           pend = &p[len+1];
 470         } else
 471           pend = &p[len];
 472       } else {
 473         fprintf (stderr, "guestfish: internal error parsing string at '%s'\n",
 474                  p);
 475         abort ();
 476       }
 477
 478       argv[i++] = p;
 479       p = pend;
 480
 481       if (*p)
 482         p += strspn (p, " \t");
 483     }
 484
 485     if (i == sizeof argv / sizeof argv[0]) {
 486       fprintf (stderr, "guestfish: too many arguments\n");
 487       if (exit_on_error) exit (1);
 488       goto next_command;
 489     }
 490
 491     argv[i] = NULL;
 492
 493   got_command:
 494     if (issue_command (cmd, argv) == -1) {
 495       if (exit_on_error) exit (1);
 496     }
 497
 498   next_command:;
 499   }
 500   if (prompt) printf ("\n");
 501 }
 502
 503 static void
 504 cmdline (char *argv[], int optind, int argc)
 505 {
 506   const char *cmd;
 507   char **params;
 508
 509   if (optind >= argc) return;
 510
 511   cmd = argv[optind++];
 512   if (strcmp (cmd, ":") == 0) {
 513     fprintf (stderr, "guestfish: empty command on command line\n");
 514     exit (1);
 515   }
 516   params = &argv[optind];
 517
 518   /* Search for end of command list or ":" ... */
 519   while (optind < argc && strcmp (argv[optind], ":") != 0)
 520     optind++;
 521
 522   if (optind == argc) {
 523     if (issue_command (cmd, params) == -1) exit (1);
 524   } else {
 525     argv[optind] = NULL;
 526     if (issue_command (cmd, params) == -1) exit (1);
 527     cmdline (argv, optind+1, argc);
 528   }
 529 }
 530
 531 static int
 532 issue_command (const char *cmd, char *argv[])
 533 {
 534   int argc;
 535
 536   for (argc = 0; argv[argc] != NULL; ++argc)
 537     ;
 538
 539   if (strcasecmp (cmd, "help") == 0) {
 540     if (argc == 0)
 541       list_commands ();
 542     else
 543       display_command (argv[0]);
 544     return 0;
 545   }
 546   else if (strcasecmp (cmd, "quit") == 0 ||
 547            strcasecmp (cmd, "exit") == 0 ||
 548            strcasecmp (cmd, "q") == 0) {
 549     quit = 1;
 550     return 0;
 551   }
 552   else if (strcasecmp (cmd, "alloc") == 0 ||
 553            strcasecmp (cmd, "allocate") == 0)
 554     return do_alloc (cmd, argc, argv);
 555   else if (strcasecmp (cmd, "echo") == 0)
 556     return do_echo (cmd, argc, argv);
 557   else if (strcasecmp (cmd, "edit") == 0 ||
 558            strcasecmp (cmd, "vi") == 0 ||
 559            strcasecmp (cmd, "emacs") == 0)
 560     return do_edit (cmd, argc, argv);
 561   else
 562     return run_action (cmd, argc, argv);
 563 }
 564
 565 void
 566 list_builtin_commands (void)
 567 {
 568   /* help and quit should appear at the top */
 569   printf ("%-20s %s\n",
 570           "help", "display a list of commands or help on a command");
 571   printf ("%-20s %s\n",
 572           "quit", "quit guestfish");
 573
 574   printf ("%-20s %s\n",
 575           "alloc", "allocate an image");
 576   printf ("%-20s %s\n",
 577           "echo", "display a line of text");
 578   printf ("%-20s %s\n",
 579           "edit", "edit a file in the image");
 580
 581   /* actions are printed after this (see list_commands) */
 582 }
 583
 584 void
 585 display_builtin_command (const char *cmd)
 586 {
 587   /* help for actions is auto-generated, see display_command */
 588
 589   if (strcasecmp (cmd, "alloc") == 0 ||
 590       strcasecmp (cmd, "allocate") == 0)
 591     printf ("alloc - allocate an image\n"
 592             "     alloc <filename> <size>\n"
 593             "\n"
 594             "    This creates an empty (zeroed) file of the given size,\n"
 595             "    and then adds so it can be further examined.\n"
 596             "\n"
 597             "    For more advanced image creation, see qemu-img utility.\n"
 598             "\n"
 599             "    Size can be specified (where <nn> means a number):\n"
 600             "    <nn>             number of kilobytes\n"
 601             "      eg: 1440       standard 3.5\" floppy\n"
 602             "    <nn>K or <nn>KB  number of kilobytes\n"
 603             "    <nn>M or <nn>MB  number of megabytes\n"
 604             "    <nn>G or <nn>GB  number of gigabytes\n"
 605             "    <nn>sects        number of 512 byte sectors\n");
 606   else if (strcasecmp (cmd, "echo") == 0)
 607     printf ("echo - display a line of text\n"
 608             "     echo [<params> ...]\n"
 609             "\n"
 610             "    This echos the parameters to the terminal.\n");
 611   else if (strcasecmp (cmd, "edit") == 0 ||
 612            strcasecmp (cmd, "vi") == 0 ||
 613            strcasecmp (cmd, "emacs") == 0)
 614     printf ("edit - edit a file in the image\n"
 615             "     edit <filename>\n"
 616             "\n"
 617             "    This is used to edit a file.\n"
 618             "\n"
 619             "    It is the equivalent of (and is implemented by)\n"
 620             "    running \"cat\", editing locally, and then \"write-file\".\n"
 621             "\n"
 622             "    Normally it uses $EDITOR, but if you use the aliases\n"
 623             "    \"vi\" or \"emacs\" you will get those editors.\n"
 624             "\n"
 625             "    NOTE: This will not work reliably for large files\n"
 626             "    (> 2 MB) or binary files containing \\0 bytes.\n");
 627   else if (strcasecmp (cmd, "help") == 0)
 628     printf ("help - display a list of commands or help on a command\n"
 629             "     help cmd\n"
 630             "     help\n");
 631   else if (strcasecmp (cmd, "quit") == 0 ||
 632            strcasecmp (cmd, "exit") == 0 ||
 633            strcasecmp (cmd, "q") == 0)
 634     printf ("quit - quit guestfish\n"
 635             "     quit\n");
 636   else
 637     fprintf (stderr, "%s: command not known, use -h to list all commands\n",
 638              cmd);
 639 }
 640
 641 void
 642 free_strings (char **argv)
 643 {
 644   int argc;
 645
 646   for (argc = 0; argv[argc] != NULL; ++argc)
 647     free (argv[argc]);
 648   free (argv);
 649 }
 650
 651 void
 652 print_strings (char * const * const argv)
 653 {
 654   int argc;
 655
 656   for (argc = 0; argv[argc] != NULL; ++argc)
 657     printf ("%s\n", argv[argc]);
 658 }
 659
 660 void
 661 print_table (char * const * const argv)
 662 {
 663   int i;
 664
 665   for (i = 0; argv[i] != NULL; i += 2)
 666     printf ("%s: %s\n", argv[i], argv[i+1]);
 667 }
 668
 669 int
 670 is_true (const char *str)
 671 {
 672   return
 673     strcasecmp (str, "0") != 0 &&
 674     strcasecmp (str, "f") != 0 &&
 675     strcasecmp (str, "false") != 0 &&
 676     strcasecmp (str, "n") != 0 &&
 677     strcasecmp (str, "no") != 0;
 678 }
 679
 680 /* XXX We could improve list parsing. */
 681 char **
 682 parse_string_list (const char *str)
 683 {
 684   char **argv;
 685   const char *p, *pend;
 686   int argc, i;
 687
 688   argc = 1;
 689   for (i = 0; str[i]; ++i)
 690     if (str[i] == ' ') argc++;
 691
 692   argv = malloc (sizeof (char *) * (argc+1));
 693   if (argv == NULL) { perror ("malloc"); exit (1); }
 694
 695   p = str;
 696   i = 0;
 697   while (*p) {
 698     pend = strchrnul (p, ' ');
 699     argv[i] = strndup (p, pend-p);
 700     i++;
 701     p = *pend == ' ' ? pend+1 : pend;
 702   }
 703   argv[i] = NULL;
 704
 705   return argv;
 706 }
 707
 708 #ifdef HAVE_LIBREADLINE
 709 static char histfile[1024];
 710 static int nr_history_lines = 0;
 711 #endif
 712
 713 static void
 714 initialize_readline (void)
 715 {
 716 #ifdef HAVE_LIBREADLINE
 717   const char *home;
 718
 719   home = getenv ("HOME");
 720   if (home) {
 721     snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
 722     using_history ();
 723     (void) read_history (histfile);
 724   }
 725
 726   rl_readline_name = "guestfish";
 727   rl_attempted_completion_function = do_completion;
 728 #endif
 729 }
 730
 731 static void
 732 cleanup_readline (void)
 733 {
 734 #ifdef HAVE_LIBREADLINE
 735   int fd;
 736
 737   if (histfile[0] != '\0') {
 738     fd = open (histfile, O_WRONLY|O_CREAT, 0644);
 739     if (fd == -1) {
 740       perror (histfile);
 741       return;
 742     }
 743     close (fd);
 744
 745     (void) append_history (nr_history_lines, histfile);
 746   }
 747 #endif
 748 }
 749
 750 static void
 751 add_history_line (const char *line)
 752 {
 753 #ifdef HAVE_LIBREADLINE
 754   add_history (line);
 755   nr_history_lines++;
 756 #endif
 757 }