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