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 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <unistd.h>
  25 #include <fcntl.h>
  26 #include <getopt.h>
  27 #include <signal.h>
  28 #include <assert.h>
  29 #include <sys/types.h>
  30 #include <sys/wait.h>
  31
  32 #ifdef HAVE_LIBREADLINE
  33 #include <readline/readline.h>
  34 #include <readline/history.h>
  35 #endif
  36
  37 #include <guestfs.h>
  38
  39 #include "fish.h"
  40 #include "c-ctype.h"
  41 #include "closeout.h"
  42 #include "progname.h"
  43
  44 struct mp {
  45   struct mp *next;
  46   char *device;
  47   char *mountpoint;
  48 };
  49
  50 struct drv {
  51   struct drv *next;
  52   char *filename;
  53 };
  54
  55 static void add_drives (struct drv *drv);
  56 static void mount_mps (struct mp *mp);
  57 static void interactive (void);
  58 static void shell_script (void);
  59 static void script (int prompt);
  60 static void cmdline (char *argv[], int optind, int argc);
  61 static void initialize_readline (void);
  62 static void cleanup_readline (void);
  63 static void add_history_line (const char *);
  64
  65 /* Currently open libguestfs handle. */
  66 guestfs_h *g;
  67
  68 int read_only = 0;
  69 int quit = 0;
  70 int verbose = 0;
  71 int echo_commands = 0;
  72 int remote_control_listen = 0;
  73 int remote_control = 0;
  74 int exit_on_error = 1;
  75
  76 int
  77 launch (guestfs_h *_g)
  78 {
  79   assert (_g == g);
  80
  81   if (guestfs_is_config (g)) {
  82     if (guestfs_launch (g) == -1)
  83       return -1;
  84   }
  85   return 0;
  86 }
  87
  88 static void __attribute__((noreturn))
  89 usage (int status)
  90 {
  91   if (status != EXIT_SUCCESS)
  92     fprintf (stderr, _("Try `%s --help' for more information.\n"),
  93              program_name);
  94   else {
  95     fprintf (stdout,
  96            _("%s: guest filesystem shell\n"
  97              "%s lets you edit virtual machine filesystems\n"
  98              "Copyright (C) 2009 Red Hat Inc.\n"
  99              "Usage:\n"
 100              "  %s [--options] cmd [: cmd : cmd ...]\n"
 101              "  %s -i libvirt-domain\n"
 102              "  %s -i disk-image(s)\n"
 103              "or for interactive use:\n"
 104              "  %s\n"
 105              "or from a shell script:\n"
 106              "  %s <<EOF\n"
 107              "  cmd\n"
 108              "  ...\n"
 109              "  EOF\n"
 110              "Options:\n"
 111              "  -h|--cmd-help        List available commands\n"
 112              "  -h|--cmd-help cmd    Display detailed help on 'cmd'\n"
 113              "  -a|--add image       Add image\n"
 114              "  -D|--no-dest-paths   Don't tab-complete paths from guest fs\n"
 115              "  -f|--file file       Read commands from file\n"
 116              "  -i|--inspector       Run virt-inspector to get disk mountpoints\n"
 117              "  --listen             Listen for remote commands\n"
 118              "  -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
 119              "  -n|--no-sync         Don't autosync\n"
 120              "  --remote[=pid]       Send commands to remote %s\n"
 121              "  -r|--ro              Mount read-only\n"
 122              "  --selinux            Enable SELinux support\n"
 123              "  -v|--verbose         Verbose messages\n"
 124              "  -x                   Echo each command before executing it\n"
 125              "  -V|--version         Display version and exit\n"
 126              "For more information,  see the manpage %s(1).\n"),
 127              program_name, program_name, program_name,
 128              program_name, program_name, program_name,
 129              program_name, program_name, program_name);
 130   }
 131   exit (status);
 132 }
 133
 134 int
 135 main (int argc, char *argv[])
 136 {
 137   /* Set global program name that is not polluted with libtool artifacts.  */
 138   set_program_name (argv[0]);
 139
 140   atexit (close_stdout);
 141
 142   enum { HELP_OPTION = CHAR_MAX + 1 };
 143
 144   static const char *options = "a:Df:h::im:nrv?Vx";
 145   static const struct option long_options[] = {
 146     { "add", 1, 0, 'a' },
 147     { "cmd-help", 2, 0, 'h' },
 148     { "file", 1, 0, 'f' },
 149     { "help", 0, 0, HELP_OPTION },
 150     { "inspector", 0, 0, 'i' },
 151     { "listen", 0, 0, 0 },
 152     { "mount", 1, 0, 'm' },
 153     { "no-dest-paths", 0, 0, 'D' },
 154     { "no-sync", 0, 0, 'n' },
 155     { "remote", 2, 0, 0 },
 156     { "ro", 0, 0, 'r' },
 157     { "selinux", 0, 0, 0 },
 158     { "verbose", 0, 0, 'v' },
 159     { "version", 0, 0, 'V' },
 160     { 0, 0, 0, 0 }
 161   };
 162   struct drv *drvs = NULL;
 163   struct drv *drv;
 164   struct mp *mps = NULL;
 165   struct mp *mp;
 166   char *p, *file = NULL;
 167   int c;
 168   int inspector = 0;
 169   int option_index;
 170   struct sigaction sa;
 171
 172   initialize_readline ();
 173
 174   memset (&sa, 0, sizeof sa);
 175   sa.sa_handler = SIG_IGN;
 176   sa.sa_flags = SA_RESTART;
 177   sigaction (SIGPIPE, &sa, NULL);
 178
 179   /* guestfs_create is meant to be a lightweight operation, so
 180    * it's OK to do it early here.
 181    */
 182   g = guestfs_create ();
 183   if (g == NULL) {
 184     fprintf (stderr, _("guestfs_create: failed to create handle\n"));
 185     exit (1);
 186   }
 187
 188   guestfs_set_autosync (g, 1);
 189
 190   /* If developing, add ./appliance to the path.  Note that libtools
 191    * interferes with this because uninstalled guestfish is a shell
 192    * script that runs the real program with an absolute path.  Detect
 193    * that too.
 194    *
 195    * BUT if LIBGUESTFS_PATH environment variable is already set by
 196    * the user, then don't override it.
 197    */
 198   if (getenv ("LIBGUESTFS_PATH") == NULL &&
 199       argv[0] &&
 200       (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
 201     guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
 202
 203   /* CAUTION: we are careful to modify argv[0] here, only after
 204    * using it just above.
 205    *
 206    * getopt_long uses argv[0], so give it the sanitized name.  Save a copy
 207    * of the original, in case it's needed in virt-inspector mode, below.
 208    */
 209   char *real_argv0 = argv[0];
 210   argv[0] = bad_cast (program_name);
 211
 212   for (;;) {
 213     c = getopt_long (argc, argv, options, long_options, &option_index);
 214     if (c == -1) break;
 215
 216     switch (c) {
 217     case 0:                     /* options which are long only */
 218       if (strcmp (long_options[option_index].name, "listen") == 0)
 219         remote_control_listen = 1;
 220       else if (strcmp (long_options[option_index].name, "remote") == 0) {
 221         if (optarg) {
 222           if (sscanf (optarg, "%d", &remote_control) != 1) {
 223             fprintf (stderr, _("%s: --listen=PID: PID was not a number: %s\n"),
 224                      program_name, optarg);
 225             exit (1);
 226           }
 227         } else {
 228           p = getenv ("GUESTFISH_PID");
 229           if (!p || sscanf (p, "%d", &remote_control) != 1) {
 230             fprintf (stderr, _("%s: remote: $GUESTFISH_PID must be set"
 231                                " to the PID of the remote process\n"),
 232                      program_name);
 233             exit (1);
 234           }
 235         }
 236       } else if (strcmp (long_options[option_index].name, "selinux") == 0) {
 237         guestfs_set_selinux (g, 1);
 238       } else {
 239         fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
 240                  program_name, long_options[option_index].name, option_index);
 241         exit (1);
 242       }
 243       break;
 244
 245     case 'a':
 246       if (access (optarg, R_OK) != 0) {
 247         perror (optarg);
 248         exit (1);
 249       }
 250       drv = malloc (sizeof (struct drv));
 251       if (!drv) {
 252         perror ("malloc");
 253         exit (1);
 254       }
 255       drv->filename = optarg;
 256       drv->next = drvs;
 257       drvs = drv;
 258       break;
 259
 260     case 'D':
 261       complete_dest_paths = 0;
 262       break;
 263
 264     case 'f':
 265       if (file) {
 266         fprintf (stderr, _("%s: only one -f parameter can be given\n"),
 267                  program_name);
 268         exit (1);
 269       }
 270       file = optarg;
 271       break;
 272
 273     case 'h':
 274       if (optarg)
 275         display_command (optarg);
 276       else if (argv[optind] && argv[optind][0] != '-')
 277         display_command (argv[optind++]);
 278       else
 279         list_commands ();
 280       exit (0);
 281
 282     case 'i':
 283       inspector = 1;
 284       break;
 285
 286     case 'm':
 287       mp = malloc (sizeof (struct mp));
 288       if (!mp) {
 289         perror ("malloc");
 290         exit (1);
 291       }
 292       p = strchr (optarg, ':');
 293       if (p) {
 294         *p = '\0';
 295         mp->mountpoint = p+1;
 296       } else
 297         mp->mountpoint = bad_cast ("/");
 298       mp->device = optarg;
 299       mp->next = mps;
 300       mps = mp;
 301       break;
 302
 303     case 'n':
 304       guestfs_set_autosync (g, 0);
 305       break;
 306
 307     case 'r':
 308       read_only = 1;
 309       break;
 310
 311     case 'v':
 312       verbose++;
 313       guestfs_set_verbose (g, verbose);
 314       break;
 315
 316     case 'V':
 317       printf ("%s %s\n", program_name, PACKAGE_VERSION);
 318       exit (0);
 319
 320     case 'x':
 321       echo_commands = 1;
 322       break;
 323
 324     case HELP_OPTION:
 325       usage (0);
 326
 327     default:
 328       usage (1);
 329     }
 330   }
 331
 332   /* Inspector mode invalidates most of the other arguments. */
 333   if (inspector) {
 334     char cmd[1024];
 335     int r;
 336
 337     if (drvs || mps || remote_control_listen || remote_control ||
 338         guestfs_get_selinux (g)) {
 339       fprintf (stderr, _("%s: cannot use -i option with -a, -m,"
 340                          " --listen, --remote or --selinux\n"),
 341                program_name);
 342       exit (1);
 343     }
 344     if (optind >= argc) {
 345       fprintf (stderr,
 346            _("%s: -i requires a libvirt domain or path(s) to disk image(s)\n"),
 347                program_name);
 348       exit (1);
 349     }
 350
 351     strcpy (cmd, "a=`virt-inspector");
 352     while (optind < argc) {
 353       if (strlen (cmd) + strlen (argv[optind]) + strlen (real_argv0) + 60
 354           >= sizeof cmd) {
 355         fprintf (stderr,
 356                  _("%s: virt-inspector command too long for fixed-size buffer\n"),
 357                  program_name);
 358         exit (1);
 359       }
 360       strcat (cmd, " '");
 361       strcat (cmd, argv[optind]);
 362       strcat (cmd, "'");
 363       optind++;
 364     }
 365
 366     if (read_only)
 367       strcat (cmd, " --ro-fish");
 368     else
 369       strcat (cmd, " --fish");
 370
 371     sprintf (&cmd[strlen(cmd)], "` && %s $a", real_argv0);
 372
 373     if (guestfs_get_verbose (g))
 374       strcat (cmd, " -v");
 375     if (!guestfs_get_autosync (g))
 376       strcat (cmd, " -n");
 377
 378     if (verbose)
 379       fprintf (stderr,
 380                "%s -i: running virt-inspector command:\n%s\n", program_name, cmd);
 381
 382     r = system (cmd);
 383     if (r == -1) {
 384       perror ("system");
 385       exit (1);
 386     }
 387     exit (WEXITSTATUS (r));
 388   }
 389
 390   /* If we've got drives to add, add them now. */
 391   add_drives (drvs);
 392
 393   /* If we've got mountpoints, we must launch the guest and mount them. */
 394   if (mps != NULL) {
 395     if (launch (g) == -1) exit (1);
 396     mount_mps (mps);
 397   }
 398
 399   /* Remote control? */
 400   if (remote_control_listen && remote_control) {
 401     fprintf (stderr,
 402              _("%s: cannot use --listen and --remote options at the same time\n"),
 403              program_name);
 404     exit (1);
 405   }
 406
 407   if (remote_control_listen) {
 408     if (optind < argc) {
 409       fprintf (stderr,
 410                _("%s: extra parameters on the command line with --listen flag\n"),
 411                program_name);
 412       exit (1);
 413     }
 414     if (file) {
 415       fprintf (stderr,
 416                _("%s: cannot use --listen and --file options at the same time\n"),
 417                program_name);
 418       exit (1);
 419     }
 420     rc_listen ();
 421   }
 422
 423   /* -f (file) parameter? */
 424   if (file) {
 425     close (0);
 426     if (open (file, O_RDONLY) == -1) {
 427       perror (file);
 428       exit (1);
 429     }
 430   }
 431
 432   /* Interactive, shell script, or command(s) on the command line? */
 433   if (optind >= argc) {
 434     if (isatty (0))
 435       interactive ();
 436     else
 437       shell_script ();
 438   }
 439   else
 440     cmdline (argv, optind, argc);
 441
 442   cleanup_readline ();
 443
 444   exit (0);
 445 }
 446
 447 void
 448 pod2text (const char *name, const char *shortdesc, const char *str)
 449 {
 450   FILE *fp;
 451
 452   fp = popen ("pod2text", "w");
 453   if (fp == NULL) {
 454     /* pod2text failed, maybe not found, so let's just print the
 455      * source instead, since that's better than doing nothing.
 456      */
 457     printf ("%s - %s\n\n%s\n", name, shortdesc, str);
 458     return;
 459   }
 460   fprintf (fp, "=head1 %s - %s\n\n", name, shortdesc);
 461   fputs (str, fp);
 462   pclose (fp);
 463 }
 464
 465 /* List is built in reverse order, so mount them in reverse order. */
 466 static void
 467 mount_mps (struct mp *mp)
 468 {
 469   int r;
 470
 471   if (mp) {
 472     mount_mps (mp->next);
 473     if (!read_only)
 474       r = guestfs_mount (g, mp->device, mp->mountpoint);
 475     else
 476       r = guestfs_mount_ro (g, mp->device, mp->mountpoint);
 477     if (r == -1)
 478       exit (1);
 479   }
 480 }
 481
 482 static void
 483 add_drives (struct drv *drv)
 484 {
 485   int r;
 486
 487   if (drv) {
 488     add_drives (drv->next);
 489     if (!read_only)
 490       r = guestfs_add_drive (g, drv->filename);
 491     else
 492       r = guestfs_add_drive_ro (g, drv->filename);
 493     if (r == -1)
 494       exit (1);
 495   }
 496 }
 497
 498 static void
 499 interactive (void)
 500 {
 501   script (1);
 502 }
 503
 504 static void
 505 shell_script (void)
 506 {
 507   script (0);
 508 }
 509
 510 #define FISH "><fs> "
 511
 512 static char *line_read = NULL;
 513
 514 static char *
 515 rl_gets (int prompt)
 516 {
 517 #ifdef HAVE_LIBREADLINE
 518
 519   if (prompt) {
 520     if (line_read) {
 521       free (line_read);
 522       line_read = NULL;
 523     }
 524
 525     line_read = readline (prompt ? FISH : "");
 526
 527     if (line_read && *line_read)
 528       add_history_line (line_read);
 529
 530     return line_read;
 531   }
 532
 533 #endif /* HAVE_LIBREADLINE */
 534
 535   static char buf[8192];
 536   int len;
 537
 538   if (prompt) printf (FISH);
 539   line_read = fgets (buf, sizeof buf, stdin);
 540
 541   if (line_read) {
 542     len = strlen (line_read);
 543     if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
 544   }
 545
 546   return line_read;
 547 }
 548
 549 static void
 550 script (int prompt)
 551 {
 552   char *buf;
 553   char *cmd;
 554   char *p, *pend;
 555   char *argv[64];
 556   int len;
 557   int global_exit_on_error = !prompt;
 558   int tilde_candidate;
 559
 560   if (prompt)
 561     printf (_("\n"
 562               "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
 563               "editing virtual machine filesystems.\n"
 564               "\n"
 565               "Type: 'help' for help with commands\n"
 566               "      'quit' to quit the shell\n"
 567               "\n"));
 568
 569   while (!quit) {
 570     char *pipe = NULL;
 571
 572     exit_on_error = global_exit_on_error;
 573
 574     buf = rl_gets (prompt);
 575     if (!buf) {
 576       quit = 1;
 577       break;
 578     }
 579
 580     /* Skip any initial whitespace before the command. */
 581   again:
 582     while (*buf && c_isspace (*buf))
 583       buf++;
 584
 585     if (!*buf) continue;
 586
 587     /* If the next character is '#' then this is a comment. */
 588     if (*buf == '#') continue;
 589
 590     /* If the next character is '!' then pass the whole lot to system(3). */
 591     if (*buf == '!') {
 592       int r;
 593
 594       r = system (buf+1);
 595       if (exit_on_error) {
 596         if (r == -1 ||
 597             (WIFSIGNALED (r) &&
 598              (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
 599             WEXITSTATUS (r) != 0)
 600           exit (1);
 601       }
 602       continue;
 603     }
 604
 605     /* If the next character is '-' allow the command to fail without
 606      * exiting on error (just for this one command though).
 607      */
 608     if (*buf == '-') {
 609       exit_on_error = 0;
 610       buf++;
 611       goto again;
 612     }
 613
 614     /* Get the command (cannot be quoted). */
 615     len = strcspn (buf, " \t");
 616
 617     if (len == 0) continue;
 618
 619     cmd = buf;
 620     unsigned int i = 0;
 621     if (buf[len] == '\0') {
 622       argv[0] = NULL;
 623       goto got_command;
 624     }
 625
 626     buf[len] = '\0';
 627     p = &buf[len+1];
 628     p += strspn (p, " \t");
 629
 630     /* Get the parameters. */
 631     while (*p && i < sizeof argv / sizeof argv[0]) {
 632       tilde_candidate = 0;
 633
 634       /* Parameters which start with quotes or pipes are treated
 635        * specially.  Bare parameters are delimited by whitespace.
 636        */
 637       if (*p == '"') {
 638         p++;
 639         len = strcspn (p, "\"");
 640         if (p[len] == '\0') {
 641           fprintf (stderr, _("%s: unterminated double quote\n"), program_name);
 642           if (exit_on_error) exit (1);
 643           goto next_command;
 644         }
 645         if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
 646           fprintf (stderr,
 647                    _("%s: command arguments not separated by whitespace\n"),
 648                    program_name);
 649           if (exit_on_error) exit (1);
 650           goto next_command;
 651         }
 652         p[len] = '\0';
 653         pend = p[len+1] ? &p[len+2] : &p[len+1];
 654       } else if (*p == '\'') {
 655         p++;
 656         len = strcspn (p, "'");
 657         if (p[len] == '\0') {
 658           fprintf (stderr, _("%s: unterminated single quote\n"), program_name);
 659           if (exit_on_error) exit (1);
 660           goto next_command;
 661         }
 662         if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
 663           fprintf (stderr,
 664                    _("%s: command arguments not separated by whitespace\n"),
 665                    program_name);
 666           if (exit_on_error) exit (1);
 667           goto next_command;
 668         }
 669         p[len] = '\0';
 670         pend = p[len+1] ? &p[len+2] : &p[len+1];
 671       } else if (*p == '|') {
 672         *p = '\0';
 673         pipe = p+1;
 674         continue;
 675         /*
 676       } else if (*p == '[') {
 677         int c = 1;
 678         p++;
 679         pend = p;
 680         while (*pend && c != 0) {
 681           if (*pend == '[') c++;
 682           else if (*pend == ']') c--;
 683           pend++;
 684         }
 685         if (c != 0) {
 686           fprintf (stderr,
 687                    _("%s: unterminated \"[...]\" sequence\n"), program_name);
 688           if (exit_on_error) exit (1);
 689           goto next_command;
 690         }
 691         if (*pend && (*pend != ' ' && *pend != '\t')) {
 692           fprintf (stderr,
 693                    _("%s: command arguments not separated by whitespace\n"),
 694                    program_name);
 695           if (exit_on_error) exit (1);
 696           goto next_command;
 697         }
 698         *(pend-1) = '\0';
 699         */
 700       } else if (*p != ' ' && *p != '\t') {
 701         /* If the first character is a ~ then note that this parameter
 702          * is a candidate for ~username expansion.  NB this does not
 703          * apply to quoted parameters.
 704          */
 705         tilde_candidate = *p == '~';
 706         len = strcspn (p, " \t");
 707         if (p[len]) {
 708           p[len] = '\0';
 709           pend = &p[len+1];
 710         } else
 711           pend = &p[len];
 712       } else {
 713         fprintf (stderr, _("%s: internal error parsing string at '%s'\n"),
 714                  program_name, p);
 715         abort ();
 716       }
 717
 718       if (!tilde_candidate)
 719         argv[i] = p;
 720       else
 721         argv[i] = try_tilde_expansion (p);
 722       i++;
 723       p = pend;
 724
 725       if (*p)
 726         p += strspn (p, " \t");
 727     }
 728
 729     if (i == sizeof argv / sizeof argv[0]) {
 730       fprintf (stderr, _("%s: too many arguments\n"), program_name);
 731       if (exit_on_error) exit (1);
 732       goto next_command;
 733     }
 734
 735     argv[i] = NULL;
 736
 737   got_command:
 738     if (issue_command (cmd, argv, pipe) == -1) {
 739       if (exit_on_error) exit (1);
 740     }
 741
 742   next_command:;
 743   }
 744   if (prompt) printf ("\n");
 745 }
 746
 747 static void
 748 cmdline (char *argv[], int optind, int argc)
 749 {
 750   const char *cmd;
 751   char **params;
 752
 753   exit_on_error = 1;
 754
 755   if (optind >= argc) return;
 756
 757   cmd = argv[optind++];
 758   if (strcmp (cmd, ":") == 0) {
 759     fprintf (stderr, _("%s: empty command on command line\n"), program_name);
 760     exit (1);
 761   }
 762   params = &argv[optind];
 763
 764   /* Search for end of command list or ":" ... */
 765   while (optind < argc && strcmp (argv[optind], ":") != 0)
 766     optind++;
 767
 768   if (optind == argc) {
 769     if (issue_command (cmd, params, NULL) == -1) exit (1);
 770   } else {
 771     argv[optind] = NULL;
 772     if (issue_command (cmd, params, NULL) == -1) exit (1);
 773     cmdline (argv, optind+1, argc);
 774   }
 775 }
 776
 777 int
 778 issue_command (const char *cmd, char *argv[], const char *pipecmd)
 779 {
 780   int argc;
 781   int stdout_saved_fd = -1;
 782   int pid = 0;
 783   int i, r;
 784
 785   if (echo_commands) {
 786     printf ("%s", cmd);
 787     for (i = 0; argv[i] != NULL; ++i)
 788       printf (" %s", argv[i]);
 789     printf ("\n");
 790   }
 791
 792   /* For | ... commands.  Annoyingly we can't use popen(3) here. */
 793   if (pipecmd) {
 794     int fd[2];
 795
 796     if (fflush (stdout) == EOF) {
 797       perror ("failed to flush standard output");
 798       return -1;
 799     }
 800     if (pipe (fd) < 0) {
 801       perror ("pipe failed");
 802       return -1;
 803     }
 804     pid = fork ();
 805     if (pid == -1) {
 806       perror ("fork");
 807       return -1;
 808     }
 809
 810     if (pid == 0) {             /* Child process. */
 811       close (fd[1]);
 812       if (dup2 (fd[0], 0) < 0) {
 813         perror ("dup2 of stdin failed");
 814         _exit (1);
 815       }
 816
 817       r = system (pipecmd);
 818       if (r == -1) {
 819         perror (pipecmd);
 820         _exit (1);
 821       }
 822       _exit (WEXITSTATUS (r));
 823     }
 824
 825     if ((stdout_saved_fd = dup (1)) < 0) {
 826       perror ("failed to dup stdout");
 827       return -1;
 828     }
 829     close (fd[0]);
 830     if (dup2 (fd[1], 1) < 0) {
 831       perror ("failed to dup stdout");
 832       close (stdout_saved_fd);
 833       return -1;
 834     }
 835     close (fd[1]);
 836   }
 837
 838   for (argc = 0; argv[argc] != NULL; ++argc)
 839     ;
 840
 841   /* If --remote was set, then send this command to a remote process. */
 842   if (remote_control)
 843     r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
 844
 845   /* Otherwise execute it locally. */
 846   else if (strcasecmp (cmd, "help") == 0) {
 847     if (argc == 0)
 848       list_commands ();
 849     else
 850       display_command (argv[0]);
 851     r = 0;
 852   }
 853   else if (strcasecmp (cmd, "quit") == 0 ||
 854            strcasecmp (cmd, "exit") == 0 ||
 855            strcasecmp (cmd, "q") == 0) {
 856     quit = 1;
 857     r = 0;
 858   }
 859   else if (strcasecmp (cmd, "alloc") == 0 ||
 860            strcasecmp (cmd, "allocate") == 0)
 861     r = do_alloc (cmd, argc, argv);
 862   else if (strcasecmp (cmd, "echo") == 0)
 863     r = do_echo (cmd, argc, argv);
 864   else if (strcasecmp (cmd, "edit") == 0 ||
 865            strcasecmp (cmd, "vi") == 0 ||
 866            strcasecmp (cmd, "emacs") == 0)
 867     r = do_edit (cmd, argc, argv);
 868   else if (strcasecmp (cmd, "lcd") == 0)
 869     r = do_lcd (cmd, argc, argv);
 870   else if (strcasecmp (cmd, "glob") == 0)
 871     r = do_glob (cmd, argc, argv);
 872   else if (strcasecmp (cmd, "more") == 0 ||
 873            strcasecmp (cmd, "less") == 0)
 874     r = do_more (cmd, argc, argv);
 875   else if (strcasecmp (cmd, "reopen") == 0)
 876     r = do_reopen (cmd, argc, argv);
 877   else if (strcasecmp (cmd, "sparse") == 0)
 878     r = do_sparse (cmd, argc, argv);
 879   else if (strcasecmp (cmd, "time") == 0)
 880     r = do_time (cmd, argc, argv);
 881   else
 882     r = run_action (cmd, argc, argv);
 883
 884   /* Always flush stdout after every command, so that messages, results
 885    * etc appear immediately.
 886    */
 887   if (fflush (stdout) == EOF) {
 888     perror ("failed to flush standard output");
 889     return -1;
 890   }
 891
 892   if (pipecmd) {
 893     close (1);
 894     if (dup2 (stdout_saved_fd, 1) < 0) {
 895       perror ("failed to dup2 standard output");
 896       r = -1;
 897     }
 898     close (stdout_saved_fd);
 899     if (waitpid (pid, NULL, 0) < 0) {
 900       perror ("waiting for command to complete");
 901       r = -1;
 902     }
 903   }
 904
 905   return r;
 906 }
 907
 908 void
 909 list_builtin_commands (void)
 910 {
 911   /* help and quit should appear at the top */
 912   printf ("%-20s %s\n",
 913           "help", _("display a list of commands or help on a command"));
 914   printf ("%-20s %s\n",
 915           "quit", _("quit guestfish"));
 916
 917   printf ("%-20s %s\n",
 918           "alloc", _("allocate an image"));
 919   printf ("%-20s %s\n",
 920           "echo", _("display a line of text"));
 921   printf ("%-20s %s\n",
 922           "edit", _("edit a file in the image"));
 923   printf ("%-20s %s\n",
 924           "lcd", _("local change directory"));
 925   printf ("%-20s %s\n",
 926           "glob", _("expand wildcards in command"));
 927   printf ("%-20s %s\n",
 928           "more", _("view a file in the pager"));
 929   printf ("%-20s %s\n",
 930           "reopen", _("close and reopen libguestfs handle"));
 931   printf ("%-20s %s\n",
 932           "sparse", _("allocate a sparse image file"));
 933   printf ("%-20s %s\n",
 934           "time", _("measure time taken to run command"));
 935
 936   /* actions are printed after this (see list_commands) */
 937 }
 938
 939 void
 940 display_builtin_command (const char *cmd)
 941 {
 942   /* help for actions is auto-generated, see display_command */
 943
 944   if (strcasecmp (cmd, "alloc") == 0 ||
 945       strcasecmp (cmd, "allocate") == 0)
 946     printf (_("alloc - allocate an image\n"
 947               "     alloc <filename> <size>\n"
 948               "\n"
 949               "    This creates an empty (zeroed) file of the given size,\n"
 950               "    and then adds so it can be further examined.\n"
 951               "\n"
 952               "    For more advanced image creation, see qemu-img utility.\n"
 953               "\n"
 954               "    Size can be specified (where <nn> means a number):\n"
 955               "    <nn>             number of kilobytes\n"
 956               "      eg: 1440       standard 3.5\" floppy\n"
 957               "    <nn>K or <nn>KB  number of kilobytes\n"
 958               "    <nn>M or <nn>MB  number of megabytes\n"
 959               "    <nn>G or <nn>GB  number of gigabytes\n"
 960               "    <nn>T or <nn>TB  number of terabytes\n"
 961               "    <nn>sects        number of 512 byte sectors\n"));
 962   else if (strcasecmp (cmd, "echo") == 0)
 963     printf (_("echo - display a line of text\n"
 964               "     echo [<params> ...]\n"
 965               "\n"
 966               "    This echos the parameters to the terminal.\n"));
 967   else if (strcasecmp (cmd, "edit") == 0 ||
 968            strcasecmp (cmd, "vi") == 0 ||
 969            strcasecmp (cmd, "emacs") == 0)
 970     printf (_("edit - edit a file in the image\n"
 971               "     edit <filename>\n"
 972               "\n"
 973               "    This is used to edit a file.\n"
 974               "\n"
 975               "    It is the equivalent of (and is implemented by)\n"
 976               "    running \"cat\", editing locally, and then \"write-file\".\n"
 977               "\n"
 978               "    Normally it uses $EDITOR, but if you use the aliases\n"
 979               "    \"vi\" or \"emacs\" you will get those editors.\n"
 980               "\n"
 981               "    NOTE: This will not work reliably for large files\n"
 982               "    (> 2 MB) or binary files containing \\0 bytes.\n"));
 983   else if (strcasecmp (cmd, "lcd") == 0)
 984     printf (_("lcd - local change directory\n"
 985               "    lcd <directory>\n"
 986               "\n"
 987               "    Change guestfish's current directory. This command is\n"
 988               "    useful if you want to download files to a particular\n"
 989               "    place.\n"));
 990   else if (strcasecmp (cmd, "glob") == 0)
 991     printf (_("glob - expand wildcards in command\n"
 992               "    glob <command> [<args> ...]\n"
 993               "\n"
 994               "    Glob runs <command> with wildcards expanded in any\n"
 995               "    command args.  Note that the command is run repeatedly\n"
 996               "    once for each expanded argument.\n"));
 997   else if (strcasecmp (cmd, "help") == 0)
 998     printf (_("help - display a list of commands or help on a command\n"
 999               "     help cmd\n"
1000               "     help\n"));
1001   else if (strcasecmp (cmd, "more") == 0 ||
1002            strcasecmp (cmd, "less") == 0)
1003     printf (_("more - view a file in the pager\n"
1004               "     more <filename>\n"
1005               "\n"
1006               "    This is used to view a file in the pager.\n"
1007               "\n"
1008               "    It is the equivalent of (and is implemented by)\n"
1009               "    running \"cat\" and using the pager.\n"
1010               "\n"
1011               "    Normally it uses $PAGER, but if you use the alias\n"
1012               "    \"less\" then it always uses \"less\".\n"
1013               "\n"
1014               "    NOTE: This will not work reliably for large files\n"
1015               "    (> 2 MB) or binary files containing \\0 bytes.\n"));
1016   else if (strcasecmp (cmd, "quit") == 0 ||
1017            strcasecmp (cmd, "exit") == 0 ||
1018            strcasecmp (cmd, "q") == 0)
1019     printf (_("quit - quit guestfish\n"
1020               "     quit\n"));
1021   else if (strcasecmp (cmd, "reopen") == 0)
1022     printf (_("reopen - close and reopen the libguestfs handle\n"
1023               "     reopen\n"
1024               "\n"
1025               "Close and reopen the libguestfs handle.  It is not necessary to use\n"
1026               "this normally, because the handle is closed properly when guestfish\n"
1027               "exits.  However this is occasionally useful for testing.\n"));
1028   else if (strcasecmp (cmd, "sparse") == 0)
1029     printf (_("sparse - allocate a sparse image file\n"
1030               "     sparse <filename> <size>\n"
1031               "\n"
1032               "    This creates an empty sparse file of the given size,\n"
1033               "    and then adds so it can be further examined.\n"
1034               "\n"
1035               "    In all respects it works the same as the 'alloc'\n"
1036               "    command, except that the image file is allocated\n"
1037               "    sparsely, which means that disk blocks are not assigned\n"
1038               "    to the file until they are needed.  Sparse disk files\n"
1039               "    only use space when written to, but they are slower\n"
1040               "    and there is a danger you could run out of real disk\n"
1041               "    space during a write operation.\n"
1042               "\n"
1043               "    For more advanced image creation, see qemu-img utility.\n"
1044               "\n"
1045               "    Size can be specified (where <nn> means a number):\n"
1046               "    <nn>             number of kilobytes\n"
1047               "      eg: 1440       standard 3.5\" floppy\n"
1048               "    <nn>K or <nn>KB  number of kilobytes\n"
1049               "    <nn>M or <nn>MB  number of megabytes\n"
1050               "    <nn>G or <nn>GB  number of gigabytes\n"
1051               "    <nn>T or <nn>TB  number of terabytes\n"
1052               "    <nn>sects        number of 512 byte sectors\n"));
1053   else if (strcasecmp (cmd, "time") == 0)
1054     printf (_("time - measure time taken to run command\n"
1055               "    time <command> [<args> ...]\n"
1056               "\n"
1057               "    This runs <command> as usual, and prints the elapsed\n"
1058               "    time afterwards.\n"));
1059   else
1060     fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
1061              cmd);
1062 }
1063
1064 void
1065 free_strings (char **argv)
1066 {
1067   int argc;
1068
1069   for (argc = 0; argv[argc] != NULL; ++argc)
1070     free (argv[argc]);
1071   free (argv);
1072 }
1073
1074 int
1075 count_strings (char *const *argv)
1076 {
1077   int c;
1078
1079   for (c = 0; argv[c]; ++c)
1080     ;
1081   return c;
1082 }
1083
1084 void
1085 print_strings (char *const *argv)
1086 {
1087   int argc;
1088
1089   for (argc = 0; argv[argc] != NULL; ++argc)
1090     printf ("%s\n", argv[argc]);
1091 }
1092
1093 void
1094 print_table (char *const *argv)
1095 {
1096   int i;
1097
1098   for (i = 0; argv[i] != NULL; i += 2)
1099     printf ("%s: %s\n", argv[i], argv[i+1]);
1100 }
1101
1102 int
1103 is_true (const char *str)
1104 {
1105   return
1106     strcasecmp (str, "0") != 0 &&
1107     strcasecmp (str, "f") != 0 &&
1108     strcasecmp (str, "false") != 0 &&
1109     strcasecmp (str, "n") != 0 &&
1110     strcasecmp (str, "no") != 0;
1111 }
1112
1113 /* Free strings from a non-NULL terminated char** */
1114 static void
1115 free_n_strings (char **str, size_t len)
1116 {
1117   size_t i;
1118
1119   for (i = 0; i < len; i++) {
1120     free (str[i]);
1121   }
1122   free (str);
1123 }
1124
1125 char **
1126 parse_string_list (const char *str)
1127 {
1128   char **argv = NULL;
1129   size_t argv_len = 0;
1130
1131   /* Current position pointer */
1132   const char *p = str;
1133
1134   /* Token might be simple:
1135    *  Token
1136    * or be quoted:
1137    *  'This is a single token'
1138    * or contain embedded single-quoted sections:
1139    *  This' is a sing'l'e to'ken
1140    *
1141    * The latter may seem over-complicated, but it's what a normal shell does.
1142    * Not doing it risks surprising somebody.
1143    *
1144    * This outer loop is over complete tokens.
1145    */
1146   while (*p) {
1147     char *tok = NULL;
1148     size_t tok_len = 0;
1149
1150     /* Skip leading whitespace */
1151     p += strspn (p, " \t");
1152
1153     char in_quote = 0;
1154
1155     /* This loop is over token 'fragments'. A token can be in multiple bits if
1156      * it contains single quotes. We also treat both sides of an escaped quote
1157      * as separate fragments because we can't just copy it: we have to remove
1158      * the \.
1159      */
1160     while (*p && (!c_isblank (*p) || in_quote)) {
1161       const char *end = p;
1162
1163       /* Check if the fragment starts with a quote */
1164       if ('\'' == *p) {
1165         /* Toggle in_quote */
1166         in_quote = !in_quote;
1167
1168         /* Skip the quote */
1169         p++; end++;
1170       }
1171
1172       /* If we're in a quote, look for an end quote */
1173       if (in_quote) {
1174         end += strcspn (end, "'");
1175       }
1176
1177       /* Otherwise, look for whitespace or a quote */
1178       else {
1179         end += strcspn (end, " \t'");
1180       }
1181
1182       /* Grow the token to accommodate the fragment */
1183       size_t tok_end = tok_len;
1184       tok_len += end - p;
1185       char *tok_new = realloc (tok, tok_len + 1);
1186       if (NULL == tok_new) {
1187         perror ("realloc");
1188         free_n_strings (argv, argv_len);
1189         free (tok);
1190         exit (1);
1191       }
1192       tok = tok_new;
1193
1194       /* Check if we stopped on an escaped quote */
1195       if ('\'' == *end && end != p && *(end-1) == '\\') {
1196         /* Add everything before \' to the token */
1197         memcpy (&tok[tok_end], p, end - p - 1);
1198
1199         /* Add the quote */
1200         tok[tok_len-1] = '\'';
1201
1202         /* Already processed the quote */
1203         p = end + 1;
1204       }
1205
1206       else {
1207         /* Add the whole fragment */
1208         memcpy (&tok[tok_end], p, end - p);
1209
1210         p = end;
1211       }
1212     }
1213
1214     /* We've reached the end of a token. We shouldn't still be in quotes. */
1215     if (in_quote) {
1216       fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str);
1217
1218       free_n_strings (argv, argv_len);
1219
1220       return NULL;
1221     }
1222
1223     /* Add this token if there is one. There might not be if there was
1224      * whitespace at the end of the input string */
1225     if (tok) {
1226       /* Add the NULL terminator */
1227       tok[tok_len] = '\0';
1228
1229       /* Add the argument to the argument list */
1230       argv_len++;
1231       char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1232       if (NULL == argv_new) {
1233         perror ("realloc");
1234         free_n_strings (argv, argv_len-1);
1235         free (tok);
1236         exit (1);
1237       }
1238       argv = argv_new;
1239
1240       argv[argv_len-1] = tok;
1241     }
1242   }
1243
1244   /* NULL terminate the argument list */
1245   argv_len++;
1246   char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1247   if (NULL == argv_new) {
1248     perror ("realloc");
1249     free_n_strings (argv, argv_len-1);
1250     exit (1);
1251   }
1252   argv = argv_new;
1253
1254   argv[argv_len-1] = NULL;
1255
1256   return argv;
1257 }
1258
1259 #ifdef HAVE_LIBREADLINE
1260 static char histfile[1024];
1261 static int nr_history_lines = 0;
1262 #endif
1263
1264 static void
1265 initialize_readline (void)
1266 {
1267 #ifdef HAVE_LIBREADLINE
1268   const char *home;
1269
1270   home = getenv ("HOME");
1271   if (home) {
1272     snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1273     using_history ();
1274     (void) read_history (histfile);
1275   }
1276
1277   rl_readline_name = "guestfish";
1278   rl_attempted_completion_function = do_completion;
1279 #endif
1280 }
1281
1282 static void
1283 cleanup_readline (void)
1284 {
1285 #ifdef HAVE_LIBREADLINE
1286   int fd;
1287
1288   if (histfile[0] != '\0') {
1289     fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1290     if (fd == -1) {
1291       perror (histfile);
1292       return;
1293     }
1294     close (fd);
1295
1296     (void) append_history (nr_history_lines, histfile);
1297   }
1298 #endif
1299 }
1300
1301 static void
1302 add_history_line (const char *line)
1303 {
1304 #ifdef HAVE_LIBREADLINE
1305   add_history (line);
1306   nr_history_lines++;
1307 #endif
1308 }
1309
1310 int
1311 xwrite (int fd, const void *v_buf, size_t len)
1312 {
1313   int r;
1314   const char *buf = v_buf;
1315
1316   while (len > 0) {
1317     r = write (fd, buf, len);
1318     if (r == -1) {
1319       perror ("write");
1320       return -1;
1321     }
1322     buf += r;
1323     len -= r;
1324   }
1325
1326   return 0;
1327 }
1328
1329 /* Resolve the special "win:..." form for Windows-specific paths.
1330  * This always returns a newly allocated string which is freed by the
1331  * caller function in "cmds.c".
1332  */
1333 char *
1334 resolve_win_path (const char *path)
1335 {
1336   char *ret;
1337   size_t i;
1338
1339   if (strncasecmp (path, "win:", 4) != 0) {
1340     ret = strdup (path);
1341     if (ret == NULL)
1342       perror ("strdup");
1343     return ret;
1344   }
1345
1346   path += 4;
1347
1348   /* Drop drive letter, if it's "C:". */
1349   if (strncasecmp (path, "c:", 2) == 0)
1350     path += 2;
1351
1352   if (!*path) {
1353     ret = strdup ("/");
1354     if (ret == NULL)
1355       perror ("strdup");
1356     return ret;
1357   }
1358
1359   ret = strdup (path);
1360   if (ret == NULL) {
1361     perror ("strdup");
1362     return NULL;
1363   }
1364
1365   /* Blindly convert any backslashes into forward slashes.  Is this good? */
1366   for (i = 0; i < strlen (ret); ++i)
1367     if (ret[i] == '\\')
1368       ret[i] = '/';
1369
1370   char *t = guestfs_case_sensitive_path (g, ret);
1371   free (ret);
1372   ret = t;
1373
1374   return ret;
1375 }