]> git.saurik.com Git - apple/shell_cmds.git/blobdiff - script/script.c
shell_cmds-198.tar.gz
[apple/shell_cmds.git] / script / script.c
index dc980ce928084c48740f77c2cc41848fa0b982bb..90e895ef0129f311c1f95a66dc8e071a9dbbe003 100644 (file)
@@ -1,6 +1,5 @@
-/*     $NetBSD: script.c,v 1.6 1998/04/02 11:08:34 kleink Exp $        */
-
 /*
+ * Copyright (c) 2010, 2012  David E. O'Brien
  * Copyright (c) 1980, 1992, 1993
  *     The Regents of the University of California.  All rights reserved.
  *
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
- * 3. All advertising materials mentioning features or use of this software
- *    must display the following acknowledgement:
- *     This product includes software developed by the University of
- *     California, Berkeley and its contributors.
  * 4. Neither the name of the University nor the names of its contributors
  *    may be used to endorse or promote products derived from this software
  *    without specific prior written permission.
  * SUCH DAMAGE.
  */
 
-#include <sys/cdefs.h>
+#include <sys/param.h>
+__FBSDID("$FreeBSD$");
 #ifndef lint
-__COPYRIGHT("@(#) Copyright (c) 1980, 1992, 1993\n\
-       The Regents of the University of California.  All rights reserved.\n");
-#endif /* not lint */
-
+static const char copyright[] =
+"@(#) Copyright (c) 1980, 1992, 1993\n\
+       The Regents of the University of California.  All rights reserved.\n";
+#endif
 #ifndef lint
-#if 0
-static char sccsid[] = "@(#)script.c   8.1 (Berkeley) 6/6/93";
+static const char sccsid[] = "@(#)script.c     8.1 (Berkeley) 6/6/93";
 #endif
-__RCSID("$NetBSD: script.c,v 1.6 1998/04/02 11:08:34 kleink Exp $");
-#endif /* not lint */
 
-#include <sys/types.h>
 #include <sys/wait.h>
 #include <sys/stat.h>
 #include <sys/ioctl.h>
 #include <sys/time.h>
+#include <sys/uio.h>
+#ifdef __APPLE__
+#include <libkern/OSByteOrder.h>
+#else
+#include <sys/endian.h>
+#endif
+#ifdef ENABLE_FILEMON
+#include <dev/filemon/filemon.h>
+#endif /* ENABLE_FILEMON */
 
 #include <err.h>
 #include <errno.h>
 #include <fcntl.h>
+#ifdef __APPLE__
+#include <util.h>
+#else
+#include <libutil.h>
+#endif
 #include <paths.h>
 #include <signal.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <termios.h>
-#include <time.h>
-#include <tzfile.h>
 #include <unistd.h>
-#include <util.h>
 
-FILE   *fscript;
-int    master, slave;
-int    child, subchild;
-int    outcc;
-char   *fname;
+#define DEF_BUF 65536
+
+struct stamp {
+       uint64_t scr_len;       /* amount of data */
+       uint64_t scr_sec;       /* time it arrived in seconds... */
+       uint32_t scr_usec;      /* ...and microseconds */
+       uint32_t scr_direction; /* 'i', 'o', etc (also indicates endianness) */
+};
+
+static FILE *fscript;
+static int master, slave;
+static int child;
+static const char *fname;
+static char *fmfname;
+#ifdef ENABLE_FILEMON
+static int fflg, qflg, ttyflg;
+#else /* !ENABLE_FILEMON */
+static int qflg, ttyflg;
+#endif /* ENABLE_FILEMON */
+static int usesleep, rawout;
 
-struct termios tt;
+static struct termios tt;
 
-void   done __P((void));
-void   dooutput __P((void));
-void   doshell __P((void));
-void   fail __P((void));
-void   finish __P((int));
-int    main __P((int, char **));
-void   scriptflush __P((int));
+static void done(int) __dead2;
+static void doshell(char **);
+static void fail(void);
+static void finish(void);
+static void record(FILE *, char *, size_t, int);
+static void consume(FILE *, off_t, char *, int);
+static void playback(FILE *) __dead2;
+static void usage(void);
 
 int
-main(argc, argv)
-       int argc;
-       char *argv[];
+main(int argc, char *argv[])
 {
        int cc;
-       struct termios rtt;
+       struct termios rtt, stt;
        struct winsize win;
-       int aflg, ch;
+       struct timeval tv, *tvp;
+       time_t tvec, start;
+       char obuf[BUFSIZ];
        char ibuf[BUFSIZ];
+       fd_set rfd;
+       int aflg, Fflg, kflg, pflg, ch, k, n;
+       int flushtime, readstdin;
+#ifdef ENABLE_FILEMON
+       int fm_fd, fm_log;
+#endif /* ENABLE_FILEMON */
+
+       aflg = Fflg = kflg = pflg = 0;
+       usesleep = 1;
+       rawout = 0;
+       flushtime = 30;
+#ifdef ENABLE_FILEMON
+       fm_fd = -1;     /* Shut up stupid "may be used uninitialized" GCC
+                          warning. (not needed w/clang) */
+#endif /* ENABLE_FILEMON */
 
-       aflg = 0;
-       while ((ch = getopt(argc, argv, "a")) != -1)
+#ifdef ENABLE_FILEMON
+       while ((ch = getopt(argc, argv, "adFfkpqrt:")) != -1)
+#else /* !ENABLE_FILEMON */
+       while ((ch = getopt(argc, argv, "adFkpqrt:")) != -1)
+#endif /* ENABLE_FILEMON */
                switch(ch) {
                case 'a':
                        aflg = 1;
                        break;
+               case 'd':
+                       usesleep = 0;
+                       break;
+               case 'F':
+                       Fflg = 1;
+                       break;
+#ifdef ENABLE_FILEMON
+               case 'f':
+                       fflg = 1;
+                       break;
+#endif /* ENABLE_FILEMON */
+               case 'k':
+                       kflg = 1;
+                       break;
+               case 'p':
+                       pflg = 1;
+                       break;
+               case 'q':
+                       qflg = 1;
+                       break;
+               case 'r':
+                       rawout = 1;
+                       break;
+               case 't':
+                       flushtime = atoi(optarg);
+                       if (flushtime < 0)
+                               err(1, "invalid flush time %d", flushtime);
+                       break;
                case '?':
                default:
-                       (void)fprintf(stderr, "usage: script [-a] [file]\n");
-                       exit(1);
+                       usage();
                }
        argc -= optind;
        argv += optind;
 
-       if (argc > 0)
+       if (argc > 0) {
                fname = argv[0];
-       else
+               argv++;
+               argc--;
+       } else
                fname = "typescript";
 
-       if ((fscript = fopen(fname, aflg ? "a" : "w")) == NULL)
-               err(1, "fopen %s", fname);
-
-       (void)tcgetattr(STDIN_FILENO, &tt);
-       (void)ioctl(STDIN_FILENO, TIOCGWINSZ, &win);
-       if (openpty(&master, &slave, NULL, &tt, &win) == -1)
-               err(1, "openpty");
+       if ((fscript = fopen(fname, pflg ? "r" : aflg ? "a" : "w")) == NULL)
+               err(1, "%s", fname);
 
-       (void)printf("Script started, output file is %s\n", fname);
-       rtt = tt;
-       cfmakeraw(&rtt);
-       rtt.c_lflag &= ~ECHO;
-       (void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &rtt);
+#ifdef ENABLE_FILEMON
+       if (fflg) {
+               asprintf(&fmfname, "%s.filemon", fname);
+               if (!fmfname)
+                       err(1, "%s.filemon", fname);
+               if ((fm_fd = open("/dev/filemon", O_RDWR)) == -1)
+                       err(1, "open(\"/dev/filemon\", O_RDWR)");
+               if ((fm_log = open(fmfname, O_WRONLY | O_CREAT | O_TRUNC,
+                   S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)) == -1)
+                       err(1, "open(%s)", fmfname);
+               if (ioctl(fm_fd, FILEMON_SET_FD, &fm_log) < 0)
+                       err(1, "Cannot set filemon log file descriptor");
 
-       (void)signal(SIGCHLD, finish);
-       child = fork();
-       if (child < 0) {
-               warn("fork");
-               fail();
-       }
-       if (child == 0) {
-               subchild = child = fork();
-               if (child < 0) {
-                       warn("fork");
-                       fail();
-               }
-               if (child)
-                       dooutput();
-               else
-                       doshell();
+               /* Set up these two fd's to close on exec. */
+               (void)fcntl(fm_fd, F_SETFD, FD_CLOEXEC);
+               (void)fcntl(fm_log, F_SETFD, FD_CLOEXEC);
        }
+#endif /* ENABLE_FILEMON */
 
-       (void)fclose(fscript);
-       while ((cc = read(STDIN_FILENO, ibuf, BUFSIZ)) > 0)
-               (void)write(master, ibuf, cc);
-       done();
-       /* NOTREACHED */
-       return (0);
-}
+       if (pflg)
+               playback(fscript);
 
-void
-finish(signo)
-       int signo;
-{
-       int die, pid;
-       union wait status;
+       if ((ttyflg = isatty(STDIN_FILENO)) != 0) {
+               if (tcgetattr(STDIN_FILENO, &tt) == -1)
+                       err(1, "tcgetattr");
+               if (ioctl(STDIN_FILENO, TIOCGWINSZ, &win) == -1)
+                       err(1, "ioctl");
+               if (openpty(&master, &slave, NULL, &tt, &win) == -1)
+                       err(1, "openpty");
+       } else {
+               if (openpty(&master, &slave, NULL, NULL, NULL) == -1)
+                       err(1, "openpty");
+       }
 
-       die = 0;
-       while ((pid = wait3((int *)&status, WNOHANG, 0)) > 0)
-               if (pid == child)
-                       die = 1;
+       if (rawout)
+               record(fscript, NULL, 0, 's');
 
-       if (die)
-               done();
-}
+       if (!qflg) {
+               tvec = time(NULL);
+               (void)printf("Script started, output file is %s\n", fname);
+               if (!rawout) {
+                       (void)fprintf(fscript, "Script started on %s",
+                           ctime(&tvec));
+                       if (argv[0]) {
+                               fprintf(fscript, "command: ");
+                               for (k = 0 ; argv[k] ; ++k)
+                                       fprintf(fscript, "%s%s", k ? " " : "",
+                                               argv[k]);
+                               fprintf(fscript, "\n");
+                       }
+               }
+               fflush(fscript);
+#ifdef ENABLE_FILEMON
+               if (fflg) {
+                       (void)printf("Filemon started, output file is %s\n",
+                           fmfname);
+               }
+#endif /* ENABLE_FILEMON */
+       }
+       if (ttyflg) {
+               rtt = tt;
+               cfmakeraw(&rtt);
+               rtt.c_lflag &= ~ECHO;
+               (void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &rtt);
+       }
 
-void
-dooutput()
-{
-       struct itimerval value;
-       int cc;
-       time_t tvec;
-       char obuf[BUFSIZ];
+       child = fork();
+       if (child < 0) {
+               warn("fork");
+               done(1);
+       }
+       if (child == 0)
+               doshell(argv);
+       close(slave);
 
-       (void)close(STDIN_FILENO);
-       tvec = time(NULL);
-       (void)fprintf(fscript, "Script started on %s", ctime(&tvec));
+#ifdef ENABLE_FILEMON
+       if (fflg && ioctl(fm_fd, FILEMON_SET_PID, &child) < 0)
+               err(1, "Cannot set filemon PID");
+#endif /* ENABLE_FILEMON */
 
-       (void)signal(SIGALRM, scriptflush);
-       value.it_interval.tv_sec = SECSPERMIN / 2;
-       value.it_interval.tv_usec = 0;
-       value.it_value = value.it_interval;
-       (void)setitimer(ITIMER_REAL, &value, NULL);
+       start = tvec = time(0);
+       readstdin = 1;
        for (;;) {
-               cc = read(master, obuf, sizeof (obuf));
-               if (cc <= 0)
+               FD_ZERO(&rfd);
+               FD_SET(master, &rfd);
+               if (readstdin)
+                       FD_SET(STDIN_FILENO, &rfd);
+               if (!readstdin && ttyflg) {
+                       tv.tv_sec = 1;
+                       tv.tv_usec = 0;
+                       tvp = &tv;
+                       readstdin = 1;
+               } else if (flushtime > 0) {
+                       tv.tv_sec = flushtime - (tvec - start);
+                       tv.tv_usec = 0;
+                       tvp = &tv;
+               } else {
+                       tvp = NULL;
+               }
+               n = select(master + 1, &rfd, 0, 0, tvp);
+               if (n < 0 && errno != EINTR)
                        break;
-               (void)write(1, obuf, cc);
-               (void)fwrite(obuf, 1, cc, fscript);
-               outcc += cc;
+               if (n > 0 && FD_ISSET(STDIN_FILENO, &rfd)) {
+                       cc = read(STDIN_FILENO, ibuf, BUFSIZ);
+                       if (cc < 0)
+                               break;
+                       if (cc == 0) {
+                               if (tcgetattr(master, &stt) == 0 &&
+                                   (stt.c_lflag & ICANON) != 0) {
+                                       (void)write(master, &stt.c_cc[VEOF], 1);
+                               }
+                               readstdin = 0;
+                       }
+                       if (cc > 0) {
+                               if (rawout)
+                                       record(fscript, ibuf, cc, 'i');
+                               (void)write(master, ibuf, cc);
+                               if (kflg && tcgetattr(master, &stt) >= 0 &&
+                                   ((stt.c_lflag & ECHO) == 0)) {
+                                       (void)fwrite(ibuf, 1, cc, fscript);
+                               }
+                       }
+               }
+               if (n > 0 && FD_ISSET(master, &rfd)) {
+                       cc = read(master, obuf, sizeof (obuf));
+                       if (cc <= 0)
+                               break;
+                       (void)write(STDOUT_FILENO, obuf, cc);
+                       if (rawout)
+                               record(fscript, obuf, cc, 'o');
+                       else
+                               (void)fwrite(obuf, 1, cc, fscript);
+               }
+               tvec = time(0);
+               if (tvec - start >= flushtime) {
+                       fflush(fscript);
+                       start = tvec;
+               }
+               if (Fflg)
+                       fflush(fscript);
        }
-       done();
+       finish();
+       done(0);
+}
+
+static void
+usage(void)
+{
+       (void)fprintf(stderr,
+#ifdef ENABLE_FILEMON
+           "usage: script [-adfkpqr] [-t time] [file [command ...]]\n");
+#else /* !ENABLE_FILEMON */
+           "usage: script [-adkpqr] [-t time] [file [command ...]]\n");
+#endif /* ENABLE_FILEMON */
+       exit(1);
 }
 
-void
-scriptflush(signo)
-       int signo;
+static void
+finish(void)
 {
-       if (outcc) {
-               (void)fflush(fscript);
-               outcc = 0;
+       int e, status;
+
+       if (waitpid(child, &status, 0) == child) {
+               if (WIFEXITED(status))
+                       e = WEXITSTATUS(status);
+               else if (WIFSIGNALED(status))
+                       e = WTERMSIG(status);
+               else /* can't happen */
+                       e = 1;
+               done(e);
        }
 }
 
-void
-doshell()
+static void
+doshell(char **av)
 {
-       char *shell;
+       const char *shell;
 
        shell = getenv("SHELL");
        if (shell == NULL)
@@ -217,33 +365,182 @@ doshell()
 
        (void)close(master);
        (void)fclose(fscript);
+       free(fmfname);
        login_tty(slave);
-       execl(shell, shell, "-i", NULL);
-       warn("execl %s", shell);
+       setenv("SCRIPT", fname, 1);
+       if (av[0]) {
+               execvp(av[0], av);
+               warn("%s", av[0]);
+       } else {
+               execl(shell, shell, "-i", (char *)NULL);
+               warn("%s", shell);
+       }
        fail();
 }
 
-void
-fail()
+static void
+fail(void)
 {
-
        (void)kill(0, SIGTERM);
-       done();
+       done(1);
 }
 
-void
-done()
+static void
+done(int eno)
 {
        time_t tvec;
 
-       if (subchild) {
-               tvec = time(NULL);
-               (void)fprintf(fscript,"\nScript done on %s", ctime(&tvec));
-               (void)fclose(fscript);
-               (void)close(master);
-       } else {
+       if (ttyflg)
                (void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &tt);
-               (void)printf("Script done, output file is %s\n", fname);
+       tvec = time(NULL);
+       if (rawout)
+               record(fscript, NULL, 0, 'e');
+       if (!qflg) {
+               if (!rawout)
+                       (void)fprintf(fscript,"\nScript done on %s",
+                           ctime(&tvec));
+               (void)printf("\nScript done, output file is %s\n", fname);
+#ifdef ENABLE_FILEMON
+               if (fflg) {
+                       (void)printf("Filemon done, output file is %s\n",
+                           fmfname);
+               }
+#endif /* ENABLE_FILEMON */
+       }
+       (void)fclose(fscript);
+       (void)close(master);
+       exit(eno);
+}
+
+static void
+record(FILE *fp, char *buf, size_t cc, int direction)
+{
+       struct iovec iov[2];
+       struct stamp stamp;
+       struct timeval tv;
+
+       (void)gettimeofday(&tv, NULL);
+       stamp.scr_len = cc;
+       stamp.scr_sec = tv.tv_sec;
+       stamp.scr_usec = tv.tv_usec;
+       stamp.scr_direction = direction;
+       iov[0].iov_len = sizeof(stamp);
+       iov[0].iov_base = &stamp;
+       iov[1].iov_len = cc;
+       iov[1].iov_base = buf;
+       if (writev(fileno(fp), &iov[0], 2) == -1)
+               err(1, "writev");
+}
+
+static void
+consume(FILE *fp, off_t len, char *buf, int reg)
+{
+       size_t l;
+
+       if (reg) {
+               if (fseeko(fp, len, SEEK_CUR) == -1)
+                       err(1, NULL);
+       }
+       else {
+               while (len > 0) {
+                       l = MIN(DEF_BUF, len);
+                       if (fread(buf, sizeof(char), l, fp) != l)
+                               err(1, "cannot read buffer");
+                       len -= l;
+               }
+       }
+}
+
+#ifdef __APPLE__
+#define bswap32 OSSwapInt32
+#define bswap64 OSSwapInt64
+#endif /* __APPLE__ */
+#define swapstamp(stamp) do { \
+       if (stamp.scr_direction > 0xff) { \
+               stamp.scr_len = bswap64(stamp.scr_len); \
+               stamp.scr_sec = bswap64(stamp.scr_sec); \
+               stamp.scr_usec = bswap32(stamp.scr_usec); \
+               stamp.scr_direction = bswap32(stamp.scr_direction); \
+       } \
+} while (0/*CONSTCOND*/)
+
+static void
+playback(FILE *fp)
+{
+       struct timespec tsi, tso;
+       struct stamp stamp;
+       struct stat pst;
+       char buf[DEF_BUF];
+       off_t nread, save_len;
+       size_t l;
+       time_t tclock;
+       int reg;
+
+       if (fstat(fileno(fp), &pst) == -1)
+               err(1, "fstat failed");
+
+       reg = S_ISREG(pst.st_mode);
+
+       for (nread = 0; !reg || nread < pst.st_size; nread += save_len) {
+               if (fread(&stamp, sizeof(stamp), 1, fp) != 1) {
+                       if (reg)
+                               err(1, "reading playback header");
+                       else
+                               break;
+               }
+               swapstamp(stamp);
+               save_len = sizeof(stamp);
+
+               if (reg && stamp.scr_len >
+                   (uint64_t)(pst.st_size - save_len) - nread)
+                       errx(1, "invalid stamp");
+
+               save_len += stamp.scr_len;
+               tclock = stamp.scr_sec;
+               tso.tv_sec = stamp.scr_sec;
+               tso.tv_nsec = stamp.scr_usec * 1000;
+
+               switch (stamp.scr_direction) {
+               case 's':
+                       if (!qflg)
+                           (void)printf("Script started on %s",
+                               ctime(&tclock));
+                       tsi = tso;
+                       (void)consume(fp, stamp.scr_len, buf, reg);
+                       break;
+               case 'e':
+                       if (!qflg)
+                               (void)printf("\nScript done on %s",
+                                   ctime(&tclock));
+                       (void)consume(fp, stamp.scr_len, buf, reg);
+                       break;
+               case 'i':
+                       /* throw input away */
+                       (void)consume(fp, stamp.scr_len, buf, reg);
+                       break;
+               case 'o':
+                       tsi.tv_sec = tso.tv_sec - tsi.tv_sec;
+                       tsi.tv_nsec = tso.tv_nsec - tsi.tv_nsec;
+                       if (tsi.tv_nsec < 0) {
+                               tsi.tv_sec -= 1;
+                               tsi.tv_nsec += 1000000000;
+                       }
+                       if (usesleep)
+                               (void)nanosleep(&tsi, NULL);
+                       tsi = tso;
+                       while (stamp.scr_len > 0) {
+                               l = MIN(DEF_BUF, stamp.scr_len);
+                               if (fread(buf, sizeof(char), l, fp) != l)
+                                       err(1, "cannot read buffer");
+
+                               (void)write(STDOUT_FILENO, buf, l);
+                               stamp.scr_len -= l;
+                       }
+                       break;
+               default:
+                       errx(1, "invalid direction");
+               }
        }
+       (void)fclose(fp);
        exit(0);
 }