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 int execute_and_inline (const char *cmd, int exit_on_error);
  65 static void initialize_readline (void);
  66 static void cleanup_readline (void);
  67 #ifdef HAVE_LIBREADLINE
  68 static void add_history_line (const char *);
  69 #endif
  70
  71 static int override_progress_bars = -1;
  72
  73 /* Currently open libguestfs handle. */
  74 guestfs_h *g;
  75
  76 int read_only = 0;
  77 int quit = 0;
  78 int verbose = 0;
  79 int remote_control_listen = 0;
  80 int remote_control_csh = 0;
  81 int remote_control = 0;
  82 int command_num = 0;
  83 int keys_from_stdin = 0;
  84 int echo_keys = 0;
  85 const char *libvirt_uri = NULL;
  86 int inspector = 0;
  87 int utf8_mode = 0;
  88 int have_terminfo = 0;
  89 int progress_bars = 0;
  90
  91 static void __attribute__((noreturn))
  92 usage (int status)
  93 {
  94   if (status != EXIT_SUCCESS)
  95     fprintf (stderr, _("Try `%s --help' for more information.\n"),
  96              program_name);
  97   else {
  98     fprintf (stdout,
  99            _("%s: guest filesystem shell\n"
 100              "%s lets you edit virtual machine filesystems\n"
 101              "Copyright (C) 2009-2010 Red Hat Inc.\n"
 102              "Usage:\n"
 103              "  %s [--options] cmd [: cmd : cmd ...]\n"
 104              "  %s [--ro] -i -a disk-image\n"
 105              "  %s [--ro] -i -d libvirt-domain\n"
 106              "or for interactive use:\n"
 107              "  %s\n"
 108              "or from a shell script:\n"
 109              "  %s <<EOF\n"
 110              "  cmd\n"
 111              "  ...\n"
 112              "  EOF\n"
 113              "Options:\n"
 114              "  -h|--cmd-help        List available commands\n"
 115              "  -h|--cmd-help cmd    Display detailed help on 'cmd'\n"
 116              "  -a|--add image       Add image\n"
 117              "  -c|--connect uri     Specify libvirt URI for -d option\n"
 118              "  --csh                Make --listen csh-compatible\n"
 119              "  -d|--domain guest    Add disks from libvirt guest\n"
 120              "  -D|--no-dest-paths   Don't tab-complete paths from guest fs\n"
 121              "  --echo-keys          Don't turn off echo for passphrases\n"
 122              "  -f|--file file       Read commands from file\n"
 123              "  --format[=raw|..]    Force disk format for -a option\n"
 124              "  -i|--inspector       Automatically mount filesystems\n"
 125              "  --keys-from-stdin    Read passphrases from stdin\n"
 126              "  --listen             Listen for remote commands\n"
 127              "  -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
 128              "  -n|--no-sync         Don't autosync\n"
 129              "  -N|--new type        Create prepared disk (test1.img, ...)\n"
 130              "  --progress-bars      Enable progress bars even when not interactive\n"
 131              "  --no-progress-bars   Disable progress bars\n"
 132              "  --remote[=pid]       Send commands to remote %s\n"
 133              "  -r|--ro              Mount read-only\n"
 134              "  --selinux            Enable SELinux support\n"
 135              "  -v|--verbose         Verbose messages\n"
 136              "  -V|--version         Display version and exit\n"
 137              "  -x                   Echo each command before executing it\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, program_name, 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   pcmd.pipe = NULL;
 682
 683  again:
 684   /* Skip any initial whitespace before the command. */
 685   while (*buf && c_isspace (*buf))
 686     buf++;
 687
 688   if (!*buf) {
 689     pcmd.status = 0;
 690     return pcmd;
 691   }
 692
 693   /* If the next character is '#' then this is a comment. */
 694   if (*buf == '#') {
 695     pcmd.status = 0;
 696     return pcmd;
 697   }
 698
 699   /* If the next character is '!' then pass the whole lot to system(3). */
 700   if (*buf == '!') {
 701     r = system (buf+1);
 702     if (r == -1 ||
 703         (WIFSIGNALED (r) &&
 704          (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
 705         WEXITSTATUS (r) != 0)
 706       pcmd.status = -1;
 707     else
 708       pcmd.status = 0;
 709     return pcmd;
 710   }
 711
 712   /* If the next two characters are "<!" then pass the command to
 713    * popen(3), read the result and execute it as guestfish commands.
 714    */
 715   if (buf[0] == '<' && buf[1] == '!') {
 716     int r = execute_and_inline (&buf[2], *exit_on_error_rtn);
 717     if (r == -1)
 718       pcmd.status = -1;
 719     else
 720       pcmd.status = 0;
 721     return pcmd;
 722   }
 723
 724   /* If the next character is '-' allow the command to fail without
 725    * exiting on error (just for this one command though).
 726    */
 727   if (*buf == '-') {
 728     *exit_on_error_rtn = 0;
 729     buf++;
 730     goto again;
 731   }
 732
 733   /* Get the command (cannot be quoted). */
 734   len = strcspn (buf, " \t");
 735
 736   if (len == 0) {
 737     pcmd.status = 0;
 738     return pcmd;
 739   }
 740
 741   pcmd.cmd = buf;
 742   unsigned int i = 0;
 743   if (buf[len] == '\0') {
 744     pcmd.argv[0] = NULL;
 745     pcmd.status = 1;
 746     return pcmd;
 747   }
 748
 749   buf[len] = '\0';
 750   p = &buf[len+1];
 751   p += strspn (p, " \t");
 752
 753   /* Get the parameters. */
 754   while (*p && i < argv_len) {
 755     tilde_candidate = 0;
 756
 757     /* Parameters which start with quotes or pipes are treated
 758      * specially.  Bare parameters are delimited by whitespace.
 759      */
 760     if (*p == '"') {
 761       p++;
 762       len = strcspn (p, "\"");
 763       if (p[len] == '\0') {
 764         fprintf (stderr, _("%s: unterminated double quote\n"), program_name);
 765         pcmd.status = -1;
 766         return pcmd;
 767       }
 768       if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
 769         fprintf (stderr,
 770                  _("%s: command arguments not separated by whitespace\n"),
 771                  program_name);
 772         pcmd.status = -1;
 773         return pcmd;
 774       }
 775       p[len] = '\0';
 776       pend = p[len+1] ? &p[len+2] : &p[len+1];
 777     } else if (*p == '\'') {
 778       p++;
 779       len = strcspn (p, "'");
 780       if (p[len] == '\0') {
 781         fprintf (stderr, _("%s: unterminated single quote\n"), program_name);
 782         pcmd.status = -1;
 783         return pcmd;
 784       }
 785       if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
 786         fprintf (stderr,
 787                  _("%s: command arguments not separated by whitespace\n"),
 788                  program_name);
 789         pcmd.status = -1;
 790         return pcmd;
 791       }
 792       p[len] = '\0';
 793       pend = p[len+1] ? &p[len+2] : &p[len+1];
 794     } else if (*p == '|') {
 795       *p = '\0';
 796       pcmd.pipe = p+1;
 797       continue;
 798     } else if (*p != ' ' && *p != '\t') {
 799       /* If the first character is a ~ then note that this parameter
 800        * is a candidate for ~username expansion.  NB this does not
 801        * apply to quoted parameters.
 802        */
 803       tilde_candidate = *p == '~';
 804       len = strcspn (p, " \t");
 805       if (p[len]) {
 806         p[len] = '\0';
 807         pend = &p[len+1];
 808       } else
 809         pend = &p[len];
 810     } else {
 811       fprintf (stderr, _("%s: internal error parsing string at '%s'\n"),
 812                program_name, p);
 813       abort ();
 814     }
 815
 816     if (!tilde_candidate)
 817       pcmd.argv[i] = p;
 818     else
 819       pcmd.argv[i] = try_tilde_expansion (p);
 820     i++;
 821     p = pend;
 822
 823     if (*p)
 824       p += strspn (p, " \t");
 825   }
 826
 827   if (i == argv_len) {
 828     fprintf (stderr, _("%s: too many arguments\n"), program_name);
 829     pcmd.status = -1;
 830     return pcmd;
 831   }
 832
 833   pcmd.argv[i] = NULL;
 834
 835   pcmd.status = 1;
 836   return pcmd;
 837 }
 838
 839 /* Used to handle "<!" (execute command and inline result). */
 840 static int
 841 execute_and_inline (const char *cmd, int global_exit_on_error)
 842 {
 843   FILE *pp;
 844   char *line = NULL;
 845   size_t len = 0;
 846   ssize_t n;
 847   int exit_on_error;
 848   struct parsed_command pcmd;
 849
 850   pp = popen (cmd, "r");
 851   if (!pp) {
 852     perror ("popen");
 853     return -1;
 854   }
 855
 856   while ((n = getline (&line, &len, pp)) != -1) {
 857     exit_on_error = global_exit_on_error;
 858
 859     /* Chomp final line ending which parse_command_line would not expect. */
 860     if (n > 0 && line[n-1] == '\n')
 861       line[n-1] = '\0';
 862
 863     pcmd = parse_command_line (line, &exit_on_error);
 864     if (pcmd.status == -1 && exit_on_error)
 865       exit (EXIT_FAILURE);
 866     if (pcmd.status == 1) {
 867       if (issue_command (pcmd.cmd, pcmd.argv, pcmd.pipe, exit_on_error) == -1) {
 868         if (exit_on_error) exit (EXIT_FAILURE);
 869       }
 870     }
 871   }
 872
 873   free (line);
 874
 875   if (pclose (pp) == -1) {
 876     perror ("pclose");
 877     return -1;
 878   }
 879
 880   return 0;
 881 }
 882
 883 static void
 884 cmdline (char *argv[], int optind, int argc)
 885 {
 886   const char *cmd;
 887   char **params;
 888   int exit_on_error;
 889
 890   exit_on_error = 1;
 891
 892   if (optind >= argc) return;
 893
 894   cmd = argv[optind++];
 895   if (STREQ (cmd, ":")) {
 896     fprintf (stderr, _("%s: empty command on command line\n"), program_name);
 897     exit (EXIT_FAILURE);
 898   }
 899
 900   /* Allow -cmd on the command line to mean (temporarily) override
 901    * the normal exit on error (RHBZ#578407).
 902    */
 903   if (cmd[0] == '-') {
 904     exit_on_error = 0;
 905     cmd++;
 906   }
 907
 908   params = &argv[optind];
 909
 910   /* Search for end of command list or ":" ... */
 911   while (optind < argc && STRNEQ (argv[optind], ":"))
 912     optind++;
 913
 914   if (optind == argc) {
 915     if (issue_command (cmd, params, NULL, exit_on_error) == -1 && exit_on_error)
 916         exit (EXIT_FAILURE);
 917   } else {
 918     argv[optind] = NULL;
 919     if (issue_command (cmd, params, NULL, exit_on_error) == -1 && exit_on_error)
 920       exit (EXIT_FAILURE);
 921     cmdline (argv, optind+1, argc);
 922   }
 923 }
 924
 925 /* Note: 'rc_exit_on_error_flag' is the exit_on_error flag that we
 926  * pass to the remote server (when issuing --remote commands).  It
 927  * does not cause issue_command itself to exit on error.
 928  */
 929 int
 930 issue_command (const char *cmd, char *argv[], const char *pipecmd,
 931                int rc_exit_on_error_flag)
 932 {
 933   int argc;
 934   int stdout_saved_fd = -1;
 935   int pid = 0;
 936   int r;
 937
 938   reset_progress_bar ();
 939
 940   /* This counts the commands issued, starting at 1. */
 941   command_num++;
 942
 943   /* For | ... commands.  Annoyingly we can't use popen(3) here. */
 944   if (pipecmd) {
 945     int fd[2];
 946
 947     if (fflush (stdout) == EOF) {
 948       perror ("failed to flush standard output");
 949       return -1;
 950     }
 951     if (pipe (fd) < 0) {
 952       perror ("pipe failed");
 953       return -1;
 954     }
 955     pid = fork ();
 956     if (pid == -1) {
 957       perror ("fork");
 958       return -1;
 959     }
 960
 961     if (pid == 0) {             /* Child process. */
 962       close (fd[1]);
 963       if (dup2 (fd[0], 0) < 0) {
 964         perror ("dup2 of stdin failed");
 965         _exit (1);
 966       }
 967
 968       r = system (pipecmd);
 969       if (r == -1) {
 970         perror (pipecmd);
 971         _exit (1);
 972       }
 973       _exit (WEXITSTATUS (r));
 974     }
 975
 976     if ((stdout_saved_fd = dup (1)) < 0) {
 977       perror ("failed to dup stdout");
 978       return -1;
 979     }
 980     close (fd[0]);
 981     if (dup2 (fd[1], 1) < 0) {
 982       perror ("failed to dup stdout");
 983       close (stdout_saved_fd);
 984       return -1;
 985     }
 986     close (fd[1]);
 987   }
 988
 989   for (argc = 0; argv[argc] != NULL; ++argc)
 990     ;
 991
 992   /* If --remote was set, then send this command to a remote process. */
 993   if (remote_control)
 994     r = rc_remote (remote_control, cmd, argc, argv, rc_exit_on_error_flag);
 995
 996   /* Otherwise execute it locally. */
 997   else if (STRCASEEQ (cmd, "help")) {
 998     if (argc == 0) {
 999       display_help ();
1000       r = 0;
1001     } else
1002       r = display_command (argv[0]);
1003   }
1004   else if (STRCASEEQ (cmd, "quit") ||
1005            STRCASEEQ (cmd, "exit") ||
1006            STRCASEEQ (cmd, "q")) {
1007     quit = 1;
1008     r = 0;
1009   }
1010   else
1011     r = run_action (cmd, argc, argv);
1012
1013   /* Always flush stdout after every command, so that messages, results
1014    * etc appear immediately.
1015    */
1016   if (fflush (stdout) == EOF) {
1017     perror ("failed to flush standard output");
1018     return -1;
1019   }
1020
1021   if (pipecmd) {
1022     close (1);
1023     if (dup2 (stdout_saved_fd, 1) < 0) {
1024       perror ("failed to dup2 standard output");
1025       r = -1;
1026     }
1027     close (stdout_saved_fd);
1028     if (waitpid (pid, NULL, 0) < 0) {
1029       perror ("waiting for command to complete");
1030       r = -1;
1031     }
1032   }
1033
1034   return r;
1035 }
1036
1037 void
1038 list_builtin_commands (void)
1039 {
1040   /* help and quit should appear at the top */
1041   printf ("%-20s %s\n",
1042           "help", _("display a list of commands or help on a command"));
1043   printf ("%-20s %s\n",
1044           "quit", _("quit guestfish"));
1045
1046   /* actions are printed after this (see list_commands) */
1047 }
1048
1049 int
1050 display_builtin_command (const char *cmd)
1051 {
1052   /* help for actions is auto-generated, see display_command */
1053
1054   if (STRCASEEQ (cmd, "help")) {
1055     printf (_("help - display a list of commands or help on a command\n"
1056               "     help cmd\n"
1057               "     help\n"));
1058     return 0;
1059   }
1060   else if (STRCASEEQ (cmd, "quit") ||
1061            STRCASEEQ (cmd, "exit") ||
1062            STRCASEEQ (cmd, "q")) {
1063     printf (_("quit - quit guestfish\n"
1064               "     quit\n"));
1065     return 0;
1066   }
1067   else {
1068     fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
1069              cmd);
1070     return -1;
1071   }
1072 }
1073
1074 /* This is printed when the user types in an unknown command for the
1075  * first command issued.  A common case is the user doing:
1076  *   guestfish disk.img
1077  * expecting guestfish to open 'disk.img' (in fact, this tried to
1078  * run a command 'disk.img').
1079  */
1080 void
1081 extended_help_message (void)
1082 {
1083   fprintf (stderr,
1084            _("Did you mean to open a disk image?  guestfish -a disk.img\n"
1085              "For a list of commands:             guestfish -h\n"
1086              "For complete documentation:         man guestfish\n"));
1087 }
1088
1089 void
1090 free_strings (char **argv)
1091 {
1092   int argc;
1093
1094   for (argc = 0; argv[argc] != NULL; ++argc)
1095     free (argv[argc]);
1096   free (argv);
1097 }
1098
1099 int
1100 count_strings (char *const *argv)
1101 {
1102   int c;
1103
1104   for (c = 0; argv[c]; ++c)
1105     ;
1106   return c;
1107 }
1108
1109 void
1110 print_strings (char *const *argv)
1111 {
1112   int argc;
1113
1114   for (argc = 0; argv[argc] != NULL; ++argc)
1115     printf ("%s\n", argv[argc]);
1116 }
1117
1118 void
1119 print_table (char *const *argv)
1120 {
1121   int i;
1122
1123   for (i = 0; argv[i] != NULL; i += 2)
1124     printf ("%s: %s\n", argv[i], argv[i+1]);
1125 }
1126
1127 int
1128 is_true (const char *str)
1129 {
1130   return
1131     STRCASENEQ (str, "0") &&
1132     STRCASENEQ (str, "f") &&
1133     STRCASENEQ (str, "false") &&
1134     STRCASENEQ (str, "n") &&
1135     STRCASENEQ (str, "no");
1136 }
1137
1138 /* Free strings from a non-NULL terminated char** */
1139 static void
1140 free_n_strings (char **str, size_t len)
1141 {
1142   size_t i;
1143
1144   for (i = 0; i < len; i++) {
1145     free (str[i]);
1146   }
1147   free (str);
1148 }
1149
1150 char **
1151 parse_string_list (const char *str)
1152 {
1153   char **argv = NULL;
1154   size_t argv_len = 0;
1155
1156   /* Current position pointer */
1157   const char *p = str;
1158
1159   /* Token might be simple:
1160    *  Token
1161    * or be quoted:
1162    *  'This is a single token'
1163    * or contain embedded single-quoted sections:
1164    *  This' is a sing'l'e to'ken
1165    *
1166    * The latter may seem over-complicated, but it's what a normal shell does.
1167    * Not doing it risks surprising somebody.
1168    *
1169    * This outer loop is over complete tokens.
1170    */
1171   while (*p) {
1172     char *tok = NULL;
1173     size_t tok_len = 0;
1174
1175     /* Skip leading whitespace */
1176     p += strspn (p, " \t");
1177
1178     char in_quote = 0;
1179
1180     /* This loop is over token 'fragments'. A token can be in multiple bits if
1181      * it contains single quotes. We also treat both sides of an escaped quote
1182      * as separate fragments because we can't just copy it: we have to remove
1183      * the \.
1184      */
1185     while (*p && (!c_isblank (*p) || in_quote)) {
1186       const char *end = p;
1187
1188       /* Check if the fragment starts with a quote */
1189       if ('\'' == *p) {
1190         /* Toggle in_quote */
1191         in_quote = !in_quote;
1192
1193         /* Skip the quote */
1194         p++; end++;
1195       }
1196
1197       /* If we're in a quote, look for an end quote */
1198       if (in_quote) {
1199         end += strcspn (end, "'");
1200       }
1201
1202       /* Otherwise, look for whitespace or a quote */
1203       else {
1204         end += strcspn (end, " \t'");
1205       }
1206
1207       /* Grow the token to accommodate the fragment */
1208       size_t tok_end = tok_len;
1209       tok_len += end - p;
1210       char *tok_new = realloc (tok, tok_len + 1);
1211       if (NULL == tok_new) {
1212         perror ("realloc");
1213         free_n_strings (argv, argv_len);
1214         free (tok);
1215         exit (EXIT_FAILURE);
1216       }
1217       tok = tok_new;
1218
1219       /* Check if we stopped on an escaped quote */
1220       if ('\'' == *end && end != p && *(end-1) == '\\') {
1221         /* Add everything before \' to the token */
1222         memcpy (&tok[tok_end], p, end - p - 1);
1223
1224         /* Add the quote */
1225         tok[tok_len-1] = '\'';
1226
1227         /* Already processed the quote */
1228         p = end + 1;
1229       }
1230
1231       else {
1232         /* Add the whole fragment */
1233         memcpy (&tok[tok_end], p, end - p);
1234
1235         p = end;
1236       }
1237     }
1238
1239     /* We've reached the end of a token. We shouldn't still be in quotes. */
1240     if (in_quote) {
1241       fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str);
1242
1243       free_n_strings (argv, argv_len);
1244
1245       return NULL;
1246     }
1247
1248     /* Add this token if there is one. There might not be if there was
1249      * whitespace at the end of the input string */
1250     if (tok) {
1251       /* Add the NULL terminator */
1252       tok[tok_len] = '\0';
1253
1254       /* Add the argument to the argument list */
1255       argv_len++;
1256       char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1257       if (NULL == argv_new) {
1258         perror ("realloc");
1259         free_n_strings (argv, argv_len-1);
1260         free (tok);
1261         exit (EXIT_FAILURE);
1262       }
1263       argv = argv_new;
1264
1265       argv[argv_len-1] = tok;
1266     }
1267   }
1268
1269   /* NULL terminate the argument list */
1270   argv_len++;
1271   char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1272   if (NULL == argv_new) {
1273     perror ("realloc");
1274     free_n_strings (argv, argv_len-1);
1275     exit (EXIT_FAILURE);
1276   }
1277   argv = argv_new;
1278
1279   argv[argv_len-1] = NULL;
1280
1281   return argv;
1282 }
1283
1284 #ifdef HAVE_LIBREADLINE
1285 static char histfile[1024];
1286 static int nr_history_lines = 0;
1287 #endif
1288
1289 static void
1290 initialize_readline (void)
1291 {
1292 #ifdef HAVE_LIBREADLINE
1293   const char *home;
1294
1295   home = getenv ("HOME");
1296   if (home) {
1297     snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1298     using_history ();
1299     (void) read_history (histfile);
1300   }
1301
1302   rl_readline_name = "guestfish";
1303   rl_attempted_completion_function = do_completion;
1304
1305   /* Note that .inputrc (or /etc/inputrc) is not read until the first
1306    * call the readline(), which happens later.  Therefore, these
1307    * provide default values which can be overridden by the user if
1308    * they wish.
1309    */
1310   (void) rl_variable_bind ("completion-ignore-case", "on");
1311 #endif
1312 }
1313
1314 static void
1315 cleanup_readline (void)
1316 {
1317 #ifdef HAVE_LIBREADLINE
1318   int fd;
1319
1320   if (histfile[0] != '\0') {
1321     fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1322     if (fd == -1) {
1323       perror (histfile);
1324       return;
1325     }
1326     close (fd);
1327
1328 #ifdef HAVE_APPEND_HISTORY
1329     (void) append_history (nr_history_lines, histfile);
1330 #else
1331     (void) write_history (histfile);
1332 #endif
1333     clear_history ();
1334   }
1335 #endif
1336 }
1337
1338 #ifdef HAVE_LIBREADLINE
1339 static void
1340 add_history_line (const char *line)
1341 {
1342   add_history (line);
1343   nr_history_lines++;
1344 }
1345 #endif
1346
1347 int
1348 xwrite (int fd, const void *v_buf, size_t len)
1349 {
1350   int r;
1351   const char *buf = v_buf;
1352
1353   while (len > 0) {
1354     r = write (fd, buf, len);
1355     if (r == -1) {
1356       perror ("write");
1357       return -1;
1358     }
1359     buf += r;
1360     len -= r;
1361   }
1362
1363   return 0;
1364 }
1365
1366 /* Resolve the special "win:..." form for Windows-specific paths.
1367  * This always returns a newly allocated string which is freed by the
1368  * caller function in "cmds.c".
1369  */
1370 char *
1371 resolve_win_path (const char *path)
1372 {
1373   char *ret;
1374   size_t i;
1375
1376   if (STRCASENEQLEN (path, "win:", 4)) {
1377     ret = strdup (path);
1378     if (ret == NULL)
1379       perror ("strdup");
1380     return ret;
1381   }
1382
1383   path += 4;
1384
1385   /* Drop drive letter, if it's "C:". */
1386   if (STRCASEEQLEN (path, "c:", 2))
1387     path += 2;
1388
1389   if (!*path) {
1390     ret = strdup ("/");
1391     if (ret == NULL)
1392       perror ("strdup");
1393     return ret;
1394   }
1395
1396   ret = strdup (path);
1397   if (ret == NULL) {
1398     perror ("strdup");
1399     return NULL;
1400   }
1401
1402   /* Blindly convert any backslashes into forward slashes.  Is this good? */
1403   for (i = 0; i < strlen (ret); ++i)
1404     if (ret[i] == '\\')
1405       ret[i] = '/';
1406
1407   char *t = guestfs_case_sensitive_path (g, ret);
1408   free (ret);
1409   ret = t;
1410
1411   return ret;
1412 }
1413
1414 /* Resolve the special FileIn paths ("-" or "-<<END" or filename).
1415  * The caller (cmds.c) will call free_file_in after the command has
1416  * run which should clean up resources.
1417  */
1418 static char *file_in_heredoc (const char *endmarker);
1419 static char *file_in_tmpfile = NULL;
1420
1421 char *
1422 file_in (const char *arg)
1423 {
1424   char *ret;
1425
1426   if (STREQ (arg, "-")) {
1427     ret = strdup ("/dev/stdin");
1428     if (!ret) {
1429       perror ("strdup");
1430       return NULL;
1431     }
1432   }
1433   else if (STRPREFIX (arg, "-<<")) {
1434     const char *endmarker = &arg[3];
1435     if (*endmarker == '\0') {
1436       fprintf (stderr, "%s: missing end marker in -<< expression\n",
1437                program_name);
1438       return NULL;
1439     }
1440     ret = file_in_heredoc (endmarker);
1441     if (ret == NULL)
1442       return NULL;
1443   }
1444   else {
1445     ret = strdup (arg);
1446     if (!ret) {
1447       perror ("strdup");
1448       return NULL;
1449     }
1450   }
1451
1452   return ret;
1453 }
1454
1455 static char *
1456 file_in_heredoc (const char *endmarker)
1457 {
1458   TMP_TEMPLATE_ON_STACK (template);
1459   file_in_tmpfile = strdup (template);
1460   if (file_in_tmpfile == NULL) {
1461     perror ("strdup");
1462     return NULL;
1463   }
1464
1465   int fd = mkstemp (file_in_tmpfile);
1466   if (fd == -1) {
1467     perror ("mkstemp");
1468     goto error1;
1469   }
1470
1471   size_t markerlen = strlen (endmarker);
1472
1473   char buffer[BUFSIZ];
1474   int write_error = 0;
1475   while (fgets (buffer, sizeof buffer, stdin) != NULL) {
1476     /* Look for "END"<EOF> or "END\n" in input. */
1477     size_t blen = strlen (buffer);
1478     if (STREQLEN (buffer, endmarker, markerlen) &&
1479         (blen == markerlen ||
1480          (blen == markerlen+1 && buffer[markerlen] == '\n')))
1481       goto found_end;
1482
1483     if (xwrite (fd, buffer, blen) == -1) {
1484       if (!write_error) perror ("write");
1485       write_error = 1;
1486       /* continue reading up to the end marker */
1487     }
1488   }
1489
1490   /* Reached EOF of stdin without finding the end marker, which
1491    * is likely to be an error.
1492    */
1493   fprintf (stderr, "%s: end of input reached without finding '%s'\n",
1494            program_name, endmarker);
1495   goto error2;
1496
1497  found_end:
1498   if (write_error) {
1499     close (fd);
1500     goto error2;
1501   }
1502
1503   if (close (fd) == -1) {
1504     perror ("close");
1505     goto error2;
1506   }
1507
1508   return file_in_tmpfile;
1509
1510  error2:
1511   unlink (file_in_tmpfile);
1512
1513  error1:
1514   free (file_in_tmpfile);
1515   file_in_tmpfile = NULL;
1516   return NULL;
1517 }
1518
1519 void
1520 free_file_in (char *s)
1521 {
1522   if (file_in_tmpfile) {
1523     if (unlink (file_in_tmpfile) == -1)
1524       perror (file_in_tmpfile);
1525     file_in_tmpfile = NULL;
1526   }
1527
1528   /* Free the device or file name which was strdup'd in file_in().
1529    * Note it's not immediately clear, but for -<< heredocs,
1530    * s == file_in_tmpfile, so this frees up that buffer.
1531    */
1532   free (s);
1533 }
1534
1535 /* Resolve the special FileOut paths ("-" or filename).
1536  * The caller (cmds.c) will call free (str) after the command has run.
1537  */
1538 char *
1539 file_out (const char *arg)
1540 {
1541   char *ret;
1542
1543   if (STREQ (arg, "-"))
1544     ret = strdup ("/dev/stdout");
1545   else
1546     ret = strdup (arg);
1547
1548   if (!ret) {
1549     perror ("strdup");
1550     return NULL;
1551   }
1552   return ret;
1553 }