From 5fd83771641d15c418f747bd343ba6738d3875f7 Mon Sep 17 00:00:00 2001 From: Cameron Katri Date: Sun, 9 May 2021 14:20:58 -0400 Subject: Import macOS userland adv_cmds-176 basic_cmds-55 bootstrap_cmds-116.100.1 developer_cmds-66 diskdev_cmds-667.40.1 doc_cmds-53.60.1 file_cmds-321.40.3 mail_cmds-35 misc_cmds-34 network_cmds-606.40.1 patch_cmds-17 remote_cmds-63 shell_cmds-216.60.1 system_cmds-880.60.2 text_cmds-106 --- shell_cmds/script/script.1 | 217 ++++++++++++++ shell_cmds/script/script.c | 546 ++++++++++++++++++++++++++++++++++++ shell_cmds/script/script.plist.part | 20 ++ 3 files changed, 783 insertions(+) create mode 100644 shell_cmds/script/script.1 create mode 100644 shell_cmds/script/script.c create mode 100644 shell_cmds/script/script.plist.part (limited to 'shell_cmds/script') diff --git a/shell_cmds/script/script.1 b/shell_cmds/script/script.1 new file mode 100644 index 0000000..ad12c53 --- /dev/null +++ b/shell_cmds/script/script.1 @@ -0,0 +1,217 @@ +.\" Copyright (c) 1980, 1990, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 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. +.\" 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. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)script.1 8.1 (Berkeley) 6/6/93 +.\" $FreeBSD$ +.\" +.Dd December 4, 2013 +.Dt SCRIPT 1 +.Os +.Sh NAME +.Nm script +.Nd make typescript of terminal session +.Sh SYNOPSIS +.Nm +.Op Fl adkpqr +.Op Fl F Ar pipe +.Op Fl t Ar time +.Op Ar file Op Ar command ... +.Sh DESCRIPTION +The +.Nm +utility makes a typescript of everything printed on your terminal. +It is useful for students who need a hardcopy record of an interactive +session as proof of an assignment, as the typescript file +can be printed out later with +.Xr lpr 1 . +.Pp +If the argument +.Ar file +is given, +.Nm +saves all dialogue in +.Ar file . +If no file name is given, the typescript is saved in the file +.Pa typescript . +.Pp +If the argument +.Ar command +is given, +.Nm +will run the specified command with an optional argument vector +instead of an interactive shell. +.Pp +The following options are available: +.Bl -tag -width indent +.It Fl a +Append the output to +.Ar file +or +.Pa typescript , +retaining the prior contents. +.It Fl d +When playing back a session with the +.Fl p +flag, do not sleep between records when playing back a timestamped session. +.It Fl F Ar pipe +Immediately flush output after each write. +This will allow a user to create a named pipe using +.Xr mkfifo 1 +and another user may watch the live session using a utility like +.Xr cat 1 . +.\".It Fl f +.\"Create +.\".Ar file.filemon +.\"or +.\".Pa typescript.filemon +.\"using +.\".Xr filemon 4 . +.It Fl k +Log keys sent to the program as well as output. +.It Fl p +Play back a session recorded with the +.Fl r +flag in real time. +.It Fl q +Run in quiet mode, omit the start, stop and command status messages. +.It Fl r +Record a session with input, output, and timestamping. +.It Fl t Ar time +Specify the interval at which the script output file will be flushed +to disk, in seconds. +A value of 0 +causes +.Nm +to flush after every character I/O event. +The default interval is +30 seconds. +.El +.Pp +The script ends when the forked shell (or command) exits (a +.Em control-D +to exit +the Bourne shell +.Pf ( Xr sh 1 ) , +and +.Em exit , +.Em logout +or +.Em control-D +(if +.Em ignoreeof +is not set) for the +C-shell, +.Xr csh 1 ) . +.Pp +Certain interactive commands, such as +.Xr vi 1 , +create garbage in the typescript file. +The +.Nm +utility works best with commands that do not manipulate the screen. +The results are meant to emulate a hardcopy terminal, not an addressable one. +.Sh ENVIRONMENT +The following environment variables are utilized by +.Nm : +.Bl -tag -width SHELL +.It Ev SCRIPT +The +.Ev SCRIPT +environment variable is added to the sub-shell. +If +.Ev SCRIPT +already existed in the users environment, +its value is overwritten within the sub-shell. +The value of +.Ev SCRIPT +is the name of the +.Ar typescript +file. +.It Ev SHELL +If the variable +.Ev SHELL +exists, the shell forked by +.Nm +will be that shell. +If +.Ev SHELL +is not set, the Bourne shell +is assumed. +.Pq Most shells set this variable automatically . +.El +.Sh SEE ALSO +.Xr csh 1 +.\".Xr filemon 4 +.\".Po +.\"for the +.\".Em history +.\"mechanism +.\".Pc . +.Sh HISTORY +The +.Nm +command appeared in +.Bx 3.0 . +.Pp +The +.Fl d , +.Fl p +and +.Fl r +options first appeared in +.Nx 2.0 +and were ported to +.Fx 9.2 . +.Sh BUGS +The +.Nm +utility places +.Sy everything +in the log file, including linefeeds and backspaces. +This is not what the naive user expects. +.Pp +It is not possible to specify a command without also naming the script file +because of argument parsing compatibility issues. +.Pp +When running in +.Fl k +mode, echo cancelling is far from ideal. +The slave terminal mode is checked +for ECHO mode to check when to avoid manual echo logging. +This does not +work when the terminal is in a raw mode where +the program being run is doing manual echo. +.Pp +If +.Nm +reads zero bytes from the terminal, it switches to a mode when it +only attempts to read +once a second until there is data to read. +This prevents +.Nm +from spinning on zero-byte reads, but might cause a 1-second delay in +processing of user input. diff --git a/shell_cmds/script/script.c b/shell_cmds/script/script.c new file mode 100644 index 0000000..90e895e --- /dev/null +++ b/shell_cmds/script/script.c @@ -0,0 +1,546 @@ +/* + * Copyright (c) 2010, 2012 David E. O'Brien + * Copyright (c) 1980, 1992, 1993 + * The Regents of the University of California. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 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. + * 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. + * + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +#include +__FBSDID("$FreeBSD$"); +#ifndef 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 +static const char sccsid[] = "@(#)script.c 8.1 (Berkeley) 6/6/93"; +#endif + +#include +#include +#include +#include +#include +#ifdef __APPLE__ +#include +#else +#include +#endif +#ifdef ENABLE_FILEMON +#include +#endif /* ENABLE_FILEMON */ + +#include +#include +#include +#ifdef __APPLE__ +#include +#else +#include +#endif +#include +#include +#include +#include +#include +#include +#include + +#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; + +static struct termios tt; + +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(int argc, char *argv[]) +{ + int cc; + struct termios rtt, stt; + struct winsize win; + 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 */ + +#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: + usage(); + } + argc -= optind; + argv += optind; + + if (argc > 0) { + fname = argv[0]; + argv++; + argc--; + } else + fname = "typescript"; + + if ((fscript = fopen(fname, pflg ? "r" : aflg ? "a" : "w")) == NULL) + err(1, "%s", fname); + +#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"); + + /* 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 */ + + if (pflg) + playback(fscript); + + 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"); + } + + if (rawout) + record(fscript, NULL, 0, 's'); + + 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); + } + + child = fork(); + if (child < 0) { + warn("fork"); + done(1); + } + if (child == 0) + doshell(argv); + close(slave); + +#ifdef ENABLE_FILEMON + if (fflg && ioctl(fm_fd, FILEMON_SET_PID, &child) < 0) + err(1, "Cannot set filemon PID"); +#endif /* ENABLE_FILEMON */ + + start = tvec = time(0); + readstdin = 1; + for (;;) { + 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; + 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); + } + 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); +} + +static void +finish(void) +{ + 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); + } +} + +static void +doshell(char **av) +{ + const char *shell; + + shell = getenv("SHELL"); + if (shell == NULL) + shell = _PATH_BSHELL; + + (void)close(master); + (void)fclose(fscript); + free(fmfname); + login_tty(slave); + 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(); +} + +static void +fail(void) +{ + (void)kill(0, SIGTERM); + done(1); +} + +static void +done(int eno) +{ + time_t tvec; + + if (ttyflg) + (void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &tt); + 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); +} diff --git a/shell_cmds/script/script.plist.part b/shell_cmds/script/script.plist.part new file mode 100644 index 0000000..b112d31 --- /dev/null +++ b/shell_cmds/script/script.plist.part @@ -0,0 +1,20 @@ + + OpenSourceProject + script + OpenSourceVersion + 2014-01-17 + OpenSourceWebsiteURL + http://svnweb.freebsd.org/base/head/usr.bin/script/ + OpenSourceSCM + svn co http://svn.freebsd.org/base/head/usr.bin/script/ + OpenSourceImportDate + 2014-09-22 + OpenSourceModifications + + Use OSByteOrder swap functions. + Include util.h instead of libutil.h. + Disable -f (filemon) feature, guarded with ENABLE_FILEMON. + + OpenSourceLicense + bsd + -- cgit v1.2.3-56-ge451