script/script.c

   1 /*
   2  * Copyright (c) 2010, 2012  David E. O'Brien
   3  * Copyright (c) 1980, 1992, 1993
   4  *      The Regents of the University of California.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 4. Neither the name of the University nor the names of its contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 #include <sys/param.h>
  32 __FBSDID("$FreeBSD$");
  33 #ifndef lint
  34 static const char copyright[] =
  35 "@(#) Copyright (c) 1980, 1992, 1993\n\
  36         The Regents of the University of California.  All rights reserved.\n";
  37 #endif
  38 #ifndef lint
  39 static const char sccsid[] = "@(#)script.c      8.1 (Berkeley) 6/6/93";
  40 #endif
  41
  42 #include <sys/wait.h>
  43 #include <sys/stat.h>
  44 #include <sys/ioctl.h>
  45 #include <sys/time.h>
  46 #include <sys/uio.h>
  47 #ifdef __APPLE__
  48 #include <libkern/OSByteOrder.h>
  49 #else
  50 #include <sys/endian.h>
  51 #endif
  52 #ifdef ENABLE_FILEMON
  53 #include <dev/filemon/filemon.h>
  54 #endif /* ENABLE_FILEMON */
  55
  56 #include <err.h>
  57 #include <errno.h>
  58 #include <fcntl.h>
  59 #ifdef __APPLE__
  60 #include <util.h>
  61 #else
  62 #include <libutil.h>
  63 #endif
  64 #include <paths.h>
  65 #include <signal.h>
  66 #include <stdio.h>
  67 #include <stdlib.h>
  68 #include <string.h>
  69 #include <termios.h>
  70 #include <unistd.h>
  71
  72 #define DEF_BUF 65536
  73
  74 struct stamp {
  75         uint64_t scr_len;       /* amount of data */
  76         uint64_t scr_sec;       /* time it arrived in seconds... */
  77         uint32_t scr_usec;      /* ...and microseconds */
  78         uint32_t scr_direction; /* 'i', 'o', etc (also indicates endianness) */
  79 };
  80
  81 static FILE *fscript;
  82 static int master, slave;
  83 static int child;
  84 static const char *fname;
  85 static char *fmfname;
  86 #ifdef ENABLE_FILEMON
  87 static int fflg, qflg, ttyflg;
  88 #else /* !ENABLE_FILEMON */
  89 static int qflg, ttyflg;
  90 #endif /* ENABLE_FILEMON */
  91 static int usesleep, rawout;
  92
  93 static struct termios tt;
  94
  95 static void done(int) __dead2;
  96 static void doshell(char **);
  97 static void fail(void);
  98 static void finish(void);
  99 static void record(FILE *, char *, size_t, int);
 100 static void consume(FILE *, off_t, char *, int);
 101 static void playback(FILE *) __dead2;
 102 static void usage(void);
 103
 104 int
 105 main(int argc, char *argv[])
 106 {
 107         int cc;
 108         struct termios rtt, stt;
 109         struct winsize win;
 110         struct timeval tv, *tvp;
 111         time_t tvec, start;
 112         char obuf[BUFSIZ];
 113         char ibuf[BUFSIZ];
 114         fd_set rfd;
 115         int aflg, Fflg, kflg, pflg, ch, k, n;
 116         int flushtime, readstdin;
 117 #ifdef ENABLE_FILEMON
 118         int fm_fd, fm_log;
 119 #endif /* ENABLE_FILEMON */
 120
 121         aflg = Fflg = kflg = pflg = 0;
 122         usesleep = 1;
 123         rawout = 0;
 124         flushtime = 30;
 125 #ifdef ENABLE_FILEMON
 126         fm_fd = -1;     /* Shut up stupid "may be used uninitialized" GCC
 127                            warning. (not needed w/clang) */
 128 #endif /* ENABLE_FILEMON */
 129
 130 #ifdef ENABLE_FILEMON
 131         while ((ch = getopt(argc, argv, "adFfkpqrt:")) != -1)
 132 #else /* !ENABLE_FILEMON */
 133         while ((ch = getopt(argc, argv, "adFkpqrt:")) != -1)
 134 #endif /* ENABLE_FILEMON */
 135                 switch(ch) {
 136                 case 'a':
 137                         aflg = 1;
 138                         break;
 139                 case 'd':
 140                         usesleep = 0;
 141                         break;
 142                 case 'F':
 143                         Fflg = 1;
 144                         break;
 145 #ifdef ENABLE_FILEMON
 146                 case 'f':
 147                         fflg = 1;
 148                         break;
 149 #endif /* ENABLE_FILEMON */
 150                 case 'k':
 151                         kflg = 1;
 152                         break;
 153                 case 'p':
 154                         pflg = 1;
 155                         break;
 156                 case 'q':
 157                         qflg = 1;
 158                         break;
 159                 case 'r':
 160                         rawout = 1;
 161                         break;
 162                 case 't':
 163                         flushtime = atoi(optarg);
 164                         if (flushtime < 0)
 165                                 err(1, "invalid flush time %d", flushtime);
 166                         break;
 167                 case '?':
 168                 default:
 169                         usage();
 170                 }
 171         argc -= optind;
 172         argv += optind;
 173
 174         if (argc > 0) {
 175                 fname = argv[0];
 176                 argv++;
 177                 argc--;
 178         } else
 179                 fname = "typescript";
 180
 181         if ((fscript = fopen(fname, pflg ? "r" : aflg ? "a" : "w")) == NULL)
 182                 err(1, "%s", fname);
 183
 184 #ifdef ENABLE_FILEMON
 185         if (fflg) {
 186                 asprintf(&fmfname, "%s.filemon", fname);
 187                 if (!fmfname)
 188                         err(1, "%s.filemon", fname);
 189                 if ((fm_fd = open("/dev/filemon", O_RDWR)) == -1)
 190                         err(1, "open(\"/dev/filemon\", O_RDWR)");
 191                 if ((fm_log = open(fmfname, O_WRONLY | O_CREAT | O_TRUNC,
 192                     S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)) == -1)
 193                         err(1, "open(%s)", fmfname);
 194                 if (ioctl(fm_fd, FILEMON_SET_FD, &fm_log) < 0)
 195                         err(1, "Cannot set filemon log file descriptor");
 196
 197                 /* Set up these two fd's to close on exec. */
 198                 (void)fcntl(fm_fd, F_SETFD, FD_CLOEXEC);
 199                 (void)fcntl(fm_log, F_SETFD, FD_CLOEXEC);
 200         }
 201 #endif /* ENABLE_FILEMON */
 202
 203         if (pflg)
 204                 playback(fscript);
 205
 206         if ((ttyflg = isatty(STDIN_FILENO)) != 0) {
 207                 if (tcgetattr(STDIN_FILENO, &tt) == -1)
 208                         err(1, "tcgetattr");
 209                 if (ioctl(STDIN_FILENO, TIOCGWINSZ, &win) == -1)
 210                         err(1, "ioctl");
 211                 if (openpty(&master, &slave, NULL, &tt, &win) == -1)
 212                         err(1, "openpty");
 213         } else {
 214                 if (openpty(&master, &slave, NULL, NULL, NULL) == -1)
 215                         err(1, "openpty");
 216         }
 217
 218         if (rawout)
 219                 record(fscript, NULL, 0, 's');
 220
 221         if (!qflg) {
 222                 tvec = time(NULL);
 223                 (void)printf("Script started, output file is %s\n", fname);
 224                 if (!rawout) {
 225                         (void)fprintf(fscript, "Script started on %s",
 226                             ctime(&tvec));
 227                         if (argv[0]) {
 228                                 fprintf(fscript, "command: ");
 229                                 for (k = 0 ; argv[k] ; ++k)
 230                                         fprintf(fscript, "%s%s", k ? " " : "",
 231                                                 argv[k]);
 232                                 fprintf(fscript, "\n");
 233                         }
 234                 }
 235                 fflush(fscript);
 236 #ifdef ENABLE_FILEMON
 237                 if (fflg) {
 238                         (void)printf("Filemon started, output file is %s\n",
 239                             fmfname);
 240                 }
 241 #endif /* ENABLE_FILEMON */
 242         }
 243         if (ttyflg) {
 244                 rtt = tt;
 245                 cfmakeraw(&rtt);
 246                 rtt.c_lflag &= ~ECHO;
 247                 (void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &rtt);
 248         }
 249
 250         child = fork();
 251         if (child < 0) {
 252                 warn("fork");
 253                 done(1);
 254         }
 255         if (child == 0)
 256                 doshell(argv);
 257         close(slave);
 258
 259 #ifdef ENABLE_FILEMON
 260         if (fflg && ioctl(fm_fd, FILEMON_SET_PID, &child) < 0)
 261                 err(1, "Cannot set filemon PID");
 262 #endif /* ENABLE_FILEMON */
 263
 264         start = tvec = time(0);
 265         readstdin = 1;
 266         for (;;) {
 267                 FD_ZERO(&rfd);
 268                 FD_SET(master, &rfd);
 269                 if (readstdin)
 270                         FD_SET(STDIN_FILENO, &rfd);
 271                 if (!readstdin && ttyflg) {
 272                         tv.tv_sec = 1;
 273                         tv.tv_usec = 0;
 274                         tvp = &tv;
 275                         readstdin = 1;
 276                 } else if (flushtime > 0) {
 277                         tv.tv_sec = flushtime - (tvec - start);
 278                         tv.tv_usec = 0;
 279                         tvp = &tv;
 280                 } else {
 281                         tvp = NULL;
 282                 }
 283                 n = select(master + 1, &rfd, 0, 0, tvp);
 284                 if (n < 0 && errno != EINTR)
 285                         break;
 286                 if (n > 0 && FD_ISSET(STDIN_FILENO, &rfd)) {
 287                         cc = read(STDIN_FILENO, ibuf, BUFSIZ);
 288                         if (cc < 0)
 289                                 break;
 290                         if (cc == 0) {
 291                                 if (tcgetattr(master, &stt) == 0 &&
 292                                     (stt.c_lflag & ICANON) != 0) {
 293                                         (void)write(master, &stt.c_cc[VEOF], 1);
 294                                 }
 295                                 readstdin = 0;
 296                         }
 297                         if (cc > 0) {
 298                                 if (rawout)
 299                                         record(fscript, ibuf, cc, 'i');
 300                                 (void)write(master, ibuf, cc);
 301                                 if (kflg && tcgetattr(master, &stt) >= 0 &&
 302                                     ((stt.c_lflag & ECHO) == 0)) {
 303                                         (void)fwrite(ibuf, 1, cc, fscript);
 304                                 }
 305                         }
 306                 }
 307                 if (n > 0 && FD_ISSET(master, &rfd)) {
 308                         cc = read(master, obuf, sizeof (obuf));
 309                         if (cc <= 0)
 310                                 break;
 311                         (void)write(STDOUT_FILENO, obuf, cc);
 312                         if (rawout)
 313                                 record(fscript, obuf, cc, 'o');
 314                         else
 315                                 (void)fwrite(obuf, 1, cc, fscript);
 316                 }
 317                 tvec = time(0);
 318                 if (tvec - start >= flushtime) {
 319                         fflush(fscript);
 320                         start = tvec;
 321                 }
 322                 if (Fflg)
 323                         fflush(fscript);
 324         }
 325         finish();
 326         done(0);
 327 }
 328
 329 static void
 330 usage(void)
 331 {
 332         (void)fprintf(stderr,
 333 #ifdef ENABLE_FILEMON
 334             "usage: script [-adfkpqr] [-t time] [file [command ...]]\n");
 335 #else /* !ENABLE_FILEMON */
 336             "usage: script [-adkpqr] [-t time] [file [command ...]]\n");
 337 #endif /* ENABLE_FILEMON */
 338         exit(1);
 339 }
 340
 341 static void
 342 finish(void)
 343 {
 344         int e, status;
 345
 346         if (waitpid(child, &status, 0) == child) {
 347                 if (WIFEXITED(status))
 348                         e = WEXITSTATUS(status);
 349                 else if (WIFSIGNALED(status))
 350                         e = WTERMSIG(status);
 351                 else /* can't happen */
 352                         e = 1;
 353                 done(e);
 354         }
 355 }
 356
 357 static void
 358 doshell(char **av)
 359 {
 360         const char *shell;
 361
 362         shell = getenv("SHELL");
 363         if (shell == NULL)
 364                 shell = _PATH_BSHELL;
 365
 366         (void)close(master);
 367         (void)fclose(fscript);
 368         free(fmfname);
 369         login_tty(slave);
 370         setenv("SCRIPT", fname, 1);
 371         if (av[0]) {
 372                 execvp(av[0], av);
 373                 warn("%s", av[0]);
 374         } else {
 375                 execl(shell, shell, "-i", (char *)NULL);
 376                 warn("%s", shell);
 377         }
 378         fail();
 379 }
 380
 381 static void
 382 fail(void)
 383 {
 384         (void)kill(0, SIGTERM);
 385         done(1);
 386 }
 387
 388 static void
 389 done(int eno)
 390 {
 391         time_t tvec;
 392
 393         if (ttyflg)
 394                 (void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &tt);
 395         tvec = time(NULL);
 396         if (rawout)
 397                 record(fscript, NULL, 0, 'e');
 398         if (!qflg) {
 399                 if (!rawout)
 400                         (void)fprintf(fscript,"\nScript done on %s",
 401                             ctime(&tvec));
 402                 (void)printf("\nScript done, output file is %s\n", fname);
 403 #ifdef ENABLE_FILEMON
 404                 if (fflg) {
 405                         (void)printf("Filemon done, output file is %s\n",
 406                             fmfname);
 407                 }
 408 #endif /* ENABLE_FILEMON */
 409         }
 410         (void)fclose(fscript);
 411         (void)close(master);
 412         exit(eno);
 413 }
 414
 415 static void
 416 record(FILE *fp, char *buf, size_t cc, int direction)
 417 {
 418         struct iovec iov[2];
 419         struct stamp stamp;
 420         struct timeval tv;
 421
 422         (void)gettimeofday(&tv, NULL);
 423         stamp.scr_len = cc;
 424         stamp.scr_sec = tv.tv_sec;
 425         stamp.scr_usec = tv.tv_usec;
 426         stamp.scr_direction = direction;
 427         iov[0].iov_len = sizeof(stamp);
 428         iov[0].iov_base = &stamp;
 429         iov[1].iov_len = cc;
 430         iov[1].iov_base = buf;
 431         if (writev(fileno(fp), &iov[0], 2) == -1)
 432                 err(1, "writev");
 433 }
 434
 435 static void
 436 consume(FILE *fp, off_t len, char *buf, int reg)
 437 {
 438         size_t l;
 439
 440         if (reg) {
 441                 if (fseeko(fp, len, SEEK_CUR) == -1)
 442                         err(1, NULL);
 443         }
 444         else {
 445                 while (len > 0) {
 446                         l = MIN(DEF_BUF, len);
 447                         if (fread(buf, sizeof(char), l, fp) != l)
 448                                 err(1, "cannot read buffer");
 449                         len -= l;
 450                 }
 451         }
 452 }
 453
 454 #ifdef __APPLE__
 455 #define bswap32 OSSwapInt32
 456 #define bswap64 OSSwapInt64
 457 #endif /* __APPLE__ */
 458 #define swapstamp(stamp) do { \
 459         if (stamp.scr_direction > 0xff) { \
 460                 stamp.scr_len = bswap64(stamp.scr_len); \
 461                 stamp.scr_sec = bswap64(stamp.scr_sec); \
 462                 stamp.scr_usec = bswap32(stamp.scr_usec); \
 463                 stamp.scr_direction = bswap32(stamp.scr_direction); \
 464         } \
 465 } while (0/*CONSTCOND*/)
 466
 467 static void
 468 playback(FILE *fp)
 469 {
 470         struct timespec tsi, tso;
 471         struct stamp stamp;
 472         struct stat pst;
 473         char buf[DEF_BUF];
 474         off_t nread, save_len;
 475         size_t l;
 476         time_t tclock;
 477         int reg;
 478
 479         if (fstat(fileno(fp), &pst) == -1)
 480                 err(1, "fstat failed");
 481
 482         reg = S_ISREG(pst.st_mode);
 483
 484         for (nread = 0; !reg || nread < pst.st_size; nread += save_len) {
 485                 if (fread(&stamp, sizeof(stamp), 1, fp) != 1) {
 486                         if (reg)
 487                                 err(1, "reading playback header");
 488                         else
 489                                 break;
 490                 }
 491                 swapstamp(stamp);
 492                 save_len = sizeof(stamp);
 493
 494                 if (reg && stamp.scr_len >
 495                     (uint64_t)(pst.st_size - save_len) - nread)
 496                         errx(1, "invalid stamp");
 497
 498                 save_len += stamp.scr_len;
 499                 tclock = stamp.scr_sec;
 500                 tso.tv_sec = stamp.scr_sec;
 501                 tso.tv_nsec = stamp.scr_usec * 1000;
 502
 503                 switch (stamp.scr_direction) {
 504                 case 's':
 505                         if (!qflg)
 506                             (void)printf("Script started on %s",
 507                                 ctime(&tclock));
 508                         tsi = tso;
 509                         (void)consume(fp, stamp.scr_len, buf, reg);
 510                         break;
 511                 case 'e':
 512                         if (!qflg)
 513                                 (void)printf("\nScript done on %s",
 514                                     ctime(&tclock));
 515                         (void)consume(fp, stamp.scr_len, buf, reg);
 516                         break;
 517                 case 'i':
 518                         /* throw input away */
 519                         (void)consume(fp, stamp.scr_len, buf, reg);
 520                         break;
 521                 case 'o':
 522                         tsi.tv_sec = tso.tv_sec - tsi.tv_sec;
 523                         tsi.tv_nsec = tso.tv_nsec - tsi.tv_nsec;
 524                         if (tsi.tv_nsec < 0) {
 525                                 tsi.tv_sec -= 1;
 526                                 tsi.tv_nsec += 1000000000;
 527                         }
 528                         if (usesleep)
 529                                 (void)nanosleep(&tsi, NULL);
 530                         tsi = tso;
 531                         while (stamp.scr_len > 0) {
 532                                 l = MIN(DEF_BUF, stamp.scr_len);
 533                                 if (fread(buf, sizeof(char), l, fp) != l)
 534                                         err(1, "cannot read buffer");
 535
 536                                 (void)write(STDOUT_FILENO, buf, l);
 537                                 stamp.scr_len -= l;
 538                         }
 539                         break;
 540                 default:
 541                         errx(1, "invalid direction");
 542                 }
 543         }
 544         (void)fclose(fp);
 545         exit(0);
 546 }