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