script.c revision 296911 
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: stable/10/usr.bin/script/script.c 296911 2016-03-15 17:05:28Z bdrewery $");
33#ifndef lint
34static 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
39static 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#include <sys/endian.h>
48#include <dev/filemon/filemon.h>
49
50#include <err.h>
51#include <errno.h>
52#include <fcntl.h>
53#include <libutil.h>
54#include <paths.h>
55#include <signal.h>
56#include <stdio.h>
57#include <stdlib.h>
58#include <string.h>
59#include <termios.h>
60#include <unistd.h>
61
62#define DEF_BUF 65536
63
64struct stamp {
65	uint64_t scr_len;	/* amount of data */
66	uint64_t scr_sec;	/* time it arrived in seconds... */
67	uint32_t scr_usec;	/* ...and microseconds */
68	uint32_t scr_direction; /* 'i', 'o', etc (also indicates endianness) */
69};
70
71static FILE *fscript;
72static int master, slave;
73static int child;
74static const char *fname;
75static char *fmfname;
76static int fflg, qflg, ttyflg;
77static int usesleep, rawout;
78
79static struct termios tt;
80
81static void done(int) __dead2;
82static void doshell(char **);
83static void fail(void);
84static void finish(void);
85static void record(FILE *, char *, size_t, int);
86static void consume(FILE *, off_t, char *, int);
87static void playback(FILE *) __dead2;
88static void usage(void);
89
90int
91main(int argc, char *argv[])
92{
93	int cc;
94	struct termios rtt, stt;
95	struct winsize win;
96	struct timeval tv, *tvp;
97	time_t tvec, start;
98	char obuf[BUFSIZ];
99	char ibuf[BUFSIZ];
100	fd_set rfd;
101	int aflg, kflg, pflg, ch, k, n;
102	int flushtime, readstdin;
103	int fm_fd, fm_log;
104
105	aflg = kflg = pflg = 0;
106	usesleep = 1;
107	rawout = 0;
108	flushtime = 30;
109	fm_fd = -1;	/* Shut up stupid "may be used uninitialized" GCC
110			   warning. (not needed w/clang) */
111
112	while ((ch = getopt(argc, argv, "adfkpqrt:")) != -1)
113		switch(ch) {
114		case 'a':
115			aflg = 1;
116			break;
117		case 'd':
118			usesleep = 0;
119			break;
120		case 'f':
121			fflg = 1;
122			break;
123		case 'k':
124			kflg = 1;
125			break;
126		case 'p':
127			pflg = 1;
128			break;
129		case 'q':
130			qflg = 1;
131			break;
132		case 'r':
133			rawout = 1;
134			break;
135		case 't':
136			flushtime = atoi(optarg);
137			if (flushtime < 0)
138				err(1, "invalid flush time %d", flushtime);
139			break;
140		case '?':
141		default:
142			usage();
143		}
144	argc -= optind;
145	argv += optind;
146
147	if (argc > 0) {
148		fname = argv[0];
149		argv++;
150		argc--;
151	} else
152		fname = "typescript";
153
154	if ((fscript = fopen(fname, pflg ? "r" : aflg ? "a" : "w")) == NULL)
155		err(1, "%s", fname);
156
157	if (fflg) {
158		asprintf(&fmfname, "%s.filemon", fname);
159		if (!fmfname)
160			err(1, "%s.filemon", fname);
161		if ((fm_fd = open("/dev/filemon", O_RDWR)) == -1)
162			err(1, "open(\"/dev/filemon\", O_RDWR)");
163		if ((fm_log = open(fmfname, O_WRONLY | O_CREAT | O_TRUNC,
164		    S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)) == -1)
165			err(1, "open(%s)", fmfname);
166		if (ioctl(fm_fd, FILEMON_SET_FD, &fm_log) < 0)
167			err(1, "Cannot set filemon log file descriptor");
168
169		/* Set up these two fd's to close on exec. */
170		(void)fcntl(fm_fd, F_SETFD, FD_CLOEXEC);
171		(void)fcntl(fm_log, F_SETFD, FD_CLOEXEC);
172	}
173
174	if (pflg)
175		playback(fscript);
176
177	if ((ttyflg = isatty(STDIN_FILENO)) != 0) {
178		if (tcgetattr(STDIN_FILENO, &tt) == -1)
179			err(1, "tcgetattr");
180		if (ioctl(STDIN_FILENO, TIOCGWINSZ, &win) == -1)
181			err(1, "ioctl");
182		if (openpty(&master, &slave, NULL, &tt, &win) == -1)
183			err(1, "openpty");
184	} else {
185		if (openpty(&master, &slave, NULL, NULL, NULL) == -1)
186			err(1, "openpty");
187	}
188
189	if (rawout)
190		record(fscript, NULL, 0, 's');
191
192	if (!qflg) {
193		tvec = time(NULL);
194		(void)printf("Script started, output file is %s\n", fname);
195		if (!rawout) {
196			(void)fprintf(fscript, "Script started on %s",
197			    ctime(&tvec));
198			if (argv[0]) {
199				fprintf(fscript, "command: ");
200				for (k = 0 ; argv[k] ; ++k)
201					fprintf(fscript, "%s%s", k ? " " : "",
202						argv[k]);
203				fprintf(fscript, "\n");
204			}
205		}
206		fflush(fscript);
207		if (fflg) {
208			(void)printf("Filemon started, output file is %s\n",
209			    fmfname);
210		}
211	}
212	if (ttyflg) {
213		rtt = tt;
214		cfmakeraw(&rtt);
215		rtt.c_lflag &= ~ECHO;
216		(void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &rtt);
217	}
218
219	child = fork();
220	if (child < 0) {
221		warn("fork");
222		done(1);
223	}
224	if (child == 0) {
225		if (fflg) {
226			int pid;
227
228			pid = getpid();
229			if (ioctl(fm_fd, FILEMON_SET_PID, &pid) < 0)
230				err(1, "Cannot set filemon PID");
231		}
232
233		doshell(argv);
234	}
235	close(slave);
236
237	start = tvec = time(0);
238	readstdin = 1;
239	for (;;) {
240		FD_ZERO(&rfd);
241		FD_SET(master, &rfd);
242		if (readstdin)
243			FD_SET(STDIN_FILENO, &rfd);
244		if (!readstdin && ttyflg) {
245			tv.tv_sec = 1;
246			tv.tv_usec = 0;
247			tvp = &tv;
248			readstdin = 1;
249		} else if (flushtime > 0) {
250			tv.tv_sec = flushtime - (tvec - start);
251			tv.tv_usec = 0;
252			tvp = &tv;
253		} else {
254			tvp = NULL;
255		}
256		n = select(master + 1, &rfd, 0, 0, tvp);
257		if (n < 0 && errno != EINTR)
258			break;
259		if (n > 0 && FD_ISSET(STDIN_FILENO, &rfd)) {
260			cc = read(STDIN_FILENO, ibuf, BUFSIZ);
261			if (cc < 0)
262				break;
263			if (cc == 0) {
264				if (tcgetattr(master, &stt) == 0 &&
265				    (stt.c_lflag & ICANON) != 0) {
266					(void)write(master, &stt.c_cc[VEOF], 1);
267				}
268				readstdin = 0;
269			}
270			if (cc > 0) {
271				if (rawout)
272					record(fscript, ibuf, cc, 'i');
273				(void)write(master, ibuf, cc);
274				if (kflg && tcgetattr(master, &stt) >= 0 &&
275				    ((stt.c_lflag & ECHO) == 0)) {
276					(void)fwrite(ibuf, 1, cc, fscript);
277				}
278			}
279		}
280		if (n > 0 && FD_ISSET(master, &rfd)) {
281			cc = read(master, obuf, sizeof (obuf));
282			if (cc <= 0)
283				break;
284			(void)write(STDOUT_FILENO, obuf, cc);
285			if (rawout)
286				record(fscript, obuf, cc, 'o');
287			else
288				(void)fwrite(obuf, 1, cc, fscript);
289		}
290		tvec = time(0);
291		if (tvec - start >= flushtime) {
292			fflush(fscript);
293			start = tvec;
294		}
295	}
296	finish();
297	done(0);
298}
299
300static void
301usage(void)
302{
303	(void)fprintf(stderr,
304	    "usage: script [-adfkpqr] [-t time] [file [command ...]]\n");
305	exit(1);
306}
307
308static void
309finish(void)
310{
311	int e, status;
312
313	if (waitpid(child, &status, 0) == child) {
314		if (WIFEXITED(status))
315			e = WEXITSTATUS(status);
316		else if (WIFSIGNALED(status))
317			e = WTERMSIG(status);
318		else /* can't happen */
319			e = 1;
320		done(e);
321	}
322}
323
324static void
325doshell(char **av)
326{
327	const char *shell;
328
329	shell = getenv("SHELL");
330	if (shell == NULL)
331		shell = _PATH_BSHELL;
332
333	(void)close(master);
334	(void)fclose(fscript);
335	free(fmfname);
336	login_tty(slave);
337	setenv("SCRIPT", fname, 1);
338	if (av[0]) {
339		execvp(av[0], av);
340		warn("%s", av[0]);
341	} else {
342		execl(shell, shell, "-i", (char *)NULL);
343		warn("%s", shell);
344	}
345	fail();
346}
347
348static void
349fail(void)
350{
351	(void)kill(0, SIGTERM);
352	done(1);
353}
354
355static void
356done(int eno)
357{
358	time_t tvec;
359
360	if (ttyflg)
361		(void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &tt);
362	tvec = time(NULL);
363	if (rawout)
364		record(fscript, NULL, 0, 'e');
365	if (!qflg) {
366		if (!rawout)
367			(void)fprintf(fscript,"\nScript done on %s",
368			    ctime(&tvec));
369		(void)printf("\nScript done, output file is %s\n", fname);
370		if (fflg) {
371			(void)printf("Filemon done, output file is %s\n",
372			    fmfname);
373		}
374	}
375	(void)fclose(fscript);
376	(void)close(master);
377	exit(eno);
378}
379
380static void
381record(FILE *fp, char *buf, size_t cc, int direction)
382{
383	struct iovec iov[2];
384	struct stamp stamp;
385	struct timeval tv;
386
387	(void)gettimeofday(&tv, NULL);
388	stamp.scr_len = cc;
389	stamp.scr_sec = tv.tv_sec;
390	stamp.scr_usec = tv.tv_usec;
391	stamp.scr_direction = direction;
392	iov[0].iov_len = sizeof(stamp);
393	iov[0].iov_base = &stamp;
394	iov[1].iov_len = cc;
395	iov[1].iov_base = buf;
396	if (writev(fileno(fp), &iov[0], 2) == -1)
397		err(1, "writev");
398}
399
400static void
401consume(FILE *fp, off_t len, char *buf, int reg)
402{
403	size_t l;
404
405	if (reg) {
406		if (fseeko(fp, len, SEEK_CUR) == -1)
407			err(1, NULL);
408	}
409	else {
410		while (len > 0) {
411			l = MIN(DEF_BUF, len);
412			if (fread(buf, sizeof(char), l, fp) != l)
413				err(1, "cannot read buffer");
414			len -= l;
415		}
416	}
417}
418
419#define swapstamp(stamp) do { \
420	if (stamp.scr_direction > 0xff) { \
421		stamp.scr_len = bswap64(stamp.scr_len); \
422		stamp.scr_sec = bswap64(stamp.scr_sec); \
423		stamp.scr_usec = bswap32(stamp.scr_usec); \
424		stamp.scr_direction = bswap32(stamp.scr_direction); \
425	} \
426} while (0/*CONSTCOND*/)
427
428static void
429playback(FILE *fp)
430{
431	struct timespec tsi, tso;
432	struct stamp stamp;
433	struct stat pst;
434	char buf[DEF_BUF];
435	off_t nread, save_len;
436	size_t l;
437	time_t tclock;
438	int reg;
439
440	if (fstat(fileno(fp), &pst) == -1)
441		err(1, "fstat failed");
442
443	reg = S_ISREG(pst.st_mode);
444
445	for (nread = 0; !reg || nread < pst.st_size; nread += save_len) {
446		if (fread(&stamp, sizeof(stamp), 1, fp) != 1) {
447			if (reg)
448				err(1, "reading playback header");
449			else
450				break;
451		}
452		swapstamp(stamp);
453		save_len = sizeof(stamp);
454
455		if (reg && stamp.scr_len >
456		    (uint64_t)(pst.st_size - save_len) - nread)
457			errx(1, "invalid stamp");
458
459		save_len += stamp.scr_len;
460		tclock = stamp.scr_sec;
461		tso.tv_sec = stamp.scr_sec;
462		tso.tv_nsec = stamp.scr_usec * 1000;
463
464		switch (stamp.scr_direction) {
465		case 's':
466			if (!qflg)
467			    (void)printf("Script started on %s",
468				ctime(&tclock));
469			tsi = tso;
470			(void)consume(fp, stamp.scr_len, buf, reg);
471			break;
472		case 'e':
473			if (!qflg)
474				(void)printf("\nScript done on %s",
475				    ctime(&tclock));
476			(void)consume(fp, stamp.scr_len, buf, reg);
477			break;
478		case 'i':
479			/* throw input away */
480			(void)consume(fp, stamp.scr_len, buf, reg);
481			break;
482		case 'o':
483			tsi.tv_sec = tso.tv_sec - tsi.tv_sec;
484			tsi.tv_nsec = tso.tv_nsec - tsi.tv_nsec;
485			if (tsi.tv_nsec < 0) {
486				tsi.tv_sec -= 1;
487				tsi.tv_nsec += 1000000000;
488			}
489			if (usesleep)
490				(void)nanosleep(&tsi, NULL);
491			tsi = tso;
492			while (stamp.scr_len > 0) {
493				l = MIN(DEF_BUF, stamp.scr_len);
494				if (fread(buf, sizeof(char), l, fp) != l)
495					err(1, "cannot read buffer");
496
497				(void)write(STDOUT_FILENO, buf, l);
498				stamp.scr_len -= l;
499			}
500			break;
501		default:
502			errx(1, "invalid direction");
503		}
504	}
505	(void)fclose(fp);
506	exit(0);
507}
508