fish/fish.c

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