xref: /freebsd/usr.bin/script/script.c (revision acc1a9ef)
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, showexit;
78 
79 static struct termios tt;
80 
81 static void done(int) __dead2;
82 static void doshell(char **);
83 static void finish(void);
84 static void record(FILE *, char *, size_t, int);
85 static void consume(FILE *, off_t, char *, int);
86 static void playback(FILE *) __dead2;
87 static void usage(void);
88 
89 int
90 main(int argc, char *argv[])
91 {
92 	int cc;
93 	struct termios rtt, stt;
94 	struct winsize win;
95 	struct timeval tv, *tvp;
96 	time_t tvec, start;
97 	char obuf[BUFSIZ];
98 	char ibuf[BUFSIZ];
99 	fd_set rfd;
100 	int aflg, Fflg, kflg, pflg, ch, k, n;
101 	int flushtime, readstdin;
102 	int fm_fd, fm_log;
103 
104 	aflg = Fflg = kflg = pflg = 0;
105 	usesleep = 1;
106 	rawout = 0;
107 	flushtime = 30;
108 	fm_fd = -1;	/* Shut up stupid "may be used uninitialized" GCC
109 			   warning. (not needed w/clang) */
110 	showexit = 0;
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 				showexit = 1;
203 				fprintf(fscript, "Command: ");
204 				for (k = 0 ; argv[k] ; ++k)
205 					fprintf(fscript, "%s%s", k ? " " : "",
206 						argv[k]);
207 				fprintf(fscript, "\n");
208 			}
209 		}
210 		fflush(fscript);
211 		if (fflg) {
212 			(void)printf("Filemon started, output file is %s\n",
213 			    fmfname);
214 		}
215 	}
216 	if (ttyflg) {
217 		rtt = tt;
218 		cfmakeraw(&rtt);
219 		rtt.c_lflag &= ~ECHO;
220 		(void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &rtt);
221 	}
222 
223 	child = fork();
224 	if (child < 0) {
225 		warn("fork");
226 		done(1);
227 	}
228 	if (child == 0) {
229 		if (fflg) {
230 			int pid;
231 
232 			pid = getpid();
233 			if (ioctl(fm_fd, FILEMON_SET_PID, &pid) < 0)
234 				err(1, "Cannot set filemon PID");
235 		}
236 
237 		doshell(argv);
238 	}
239 	close(slave);
240 
241 	start = tvec = time(0);
242 	readstdin = 1;
243 	for (;;) {
244 		FD_ZERO(&rfd);
245 		FD_SET(master, &rfd);
246 		if (readstdin)
247 			FD_SET(STDIN_FILENO, &rfd);
248 		if (!readstdin && ttyflg) {
249 			tv.tv_sec = 1;
250 			tv.tv_usec = 0;
251 			tvp = &tv;
252 			readstdin = 1;
253 		} else if (flushtime > 0) {
254 			tv.tv_sec = flushtime - (tvec - start);
255 			tv.tv_usec = 0;
256 			tvp = &tv;
257 		} else {
258 			tvp = NULL;
259 		}
260 		n = select(master + 1, &rfd, 0, 0, tvp);
261 		if (n < 0 && errno != EINTR)
262 			break;
263 		if (n > 0 && FD_ISSET(STDIN_FILENO, &rfd)) {
264 			cc = read(STDIN_FILENO, ibuf, BUFSIZ);
265 			if (cc < 0)
266 				break;
267 			if (cc == 0) {
268 				if (tcgetattr(master, &stt) == 0 &&
269 				    (stt.c_lflag & ICANON) != 0) {
270 					(void)write(master, &stt.c_cc[VEOF], 1);
271 				}
272 				readstdin = 0;
273 			}
274 			if (cc > 0) {
275 				if (rawout)
276 					record(fscript, ibuf, cc, 'i');
277 				(void)write(master, ibuf, cc);
278 				if (kflg && tcgetattr(master, &stt) >= 0 &&
279 				    ((stt.c_lflag & ECHO) == 0)) {
280 					(void)fwrite(ibuf, 1, cc, fscript);
281 				}
282 			}
283 		}
284 		if (n > 0 && FD_ISSET(master, &rfd)) {
285 			cc = read(master, obuf, sizeof (obuf));
286 			if (cc <= 0)
287 				break;
288 			(void)write(STDOUT_FILENO, obuf, cc);
289 			if (rawout)
290 				record(fscript, obuf, cc, 'o');
291 			else
292 				(void)fwrite(obuf, 1, cc, fscript);
293 		}
294 		tvec = time(0);
295 		if (tvec - start >= flushtime) {
296 			fflush(fscript);
297 			start = tvec;
298 		}
299 		if (Fflg)
300 			fflush(fscript);
301 	}
302 	finish();
303 	done(0);
304 }
305 
306 static void
307 usage(void)
308 {
309 	(void)fprintf(stderr,
310 	    "usage: script [-adfkpqr] [-t time] [file [command ...]]\n");
311 	exit(1);
312 }
313 
314 static void
315 finish(void)
316 {
317 	int e, status;
318 
319 	if (waitpid(child, &status, 0) == child) {
320 		if (WIFEXITED(status))
321 			e = WEXITSTATUS(status);
322 		else if (WIFSIGNALED(status))
323 			e = WTERMSIG(status);
324 		else /* can't happen */
325 			e = 1;
326 		done(e);
327 	}
328 }
329 
330 static void
331 doshell(char **av)
332 {
333 	const char *shell;
334 
335 	shell = getenv("SHELL");
336 	if (shell == NULL)
337 		shell = _PATH_BSHELL;
338 
339 	(void)close(master);
340 	(void)fclose(fscript);
341 	free(fmfname);
342 	login_tty(slave);
343 	setenv("SCRIPT", fname, 1);
344 	if (av[0]) {
345 		execvp(av[0], av);
346 		warn("%s", av[0]);
347 	} else {
348 		execl(shell, shell, "-i", (char *)NULL);
349 		warn("%s", shell);
350 	}
351 	exit(1);
352 }
353 
354 static void
355 done(int eno)
356 {
357 	time_t tvec;
358 
359 	if (ttyflg)
360 		(void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &tt);
361 	tvec = time(NULL);
362 	if (rawout)
363 		record(fscript, NULL, 0, 'e');
364 	if (!qflg) {
365 		if (!rawout) {
366 			if (showexit)
367 				(void)fprintf(fscript, "\nCommand exit status:"
368 				    " %d", eno);
369 			(void)fprintf(fscript,"\nScript done on %s",
370 			    ctime(&tvec));
371 		}
372 		(void)printf("\nScript done, output file is %s\n", fname);
373 		if (fflg) {
374 			(void)printf("Filemon done, output file is %s\n",
375 			    fmfname);
376 		}
377 	}
378 	(void)fclose(fscript);
379 	(void)close(master);
380 	exit(eno);
381 }
382 
383 static void
384 record(FILE *fp, char *buf, size_t cc, int direction)
385 {
386 	struct iovec iov[2];
387 	struct stamp stamp;
388 	struct timeval tv;
389 
390 	(void)gettimeofday(&tv, NULL);
391 	stamp.scr_len = cc;
392 	stamp.scr_sec = tv.tv_sec;
393 	stamp.scr_usec = tv.tv_usec;
394 	stamp.scr_direction = direction;
395 	iov[0].iov_len = sizeof(stamp);
396 	iov[0].iov_base = &stamp;
397 	iov[1].iov_len = cc;
398 	iov[1].iov_base = buf;
399 	if (writev(fileno(fp), &iov[0], 2) == -1)
400 		err(1, "writev");
401 }
402 
403 static void
404 consume(FILE *fp, off_t len, char *buf, int reg)
405 {
406 	size_t l;
407 
408 	if (reg) {
409 		if (fseeko(fp, len, SEEK_CUR) == -1)
410 			err(1, NULL);
411 	}
412 	else {
413 		while (len > 0) {
414 			l = MIN(DEF_BUF, len);
415 			if (fread(buf, sizeof(char), l, fp) != l)
416 				err(1, "cannot read buffer");
417 			len -= l;
418 		}
419 	}
420 }
421 
422 #define swapstamp(stamp) do { \
423 	if (stamp.scr_direction > 0xff) { \
424 		stamp.scr_len = bswap64(stamp.scr_len); \
425 		stamp.scr_sec = bswap64(stamp.scr_sec); \
426 		stamp.scr_usec = bswap32(stamp.scr_usec); \
427 		stamp.scr_direction = bswap32(stamp.scr_direction); \
428 	} \
429 } while (0/*CONSTCOND*/)
430 
431 static void
432 playback(FILE *fp)
433 {
434 	struct timespec tsi, tso;
435 	struct stamp stamp;
436 	struct stat pst;
437 	char buf[DEF_BUF];
438 	off_t nread, save_len;
439 	size_t l;
440 	time_t tclock;
441 	int reg;
442 
443 	if (fstat(fileno(fp), &pst) == -1)
444 		err(1, "fstat failed");
445 
446 	reg = S_ISREG(pst.st_mode);
447 
448 	for (nread = 0; !reg || nread < pst.st_size; nread += save_len) {
449 		if (fread(&stamp, sizeof(stamp), 1, fp) != 1) {
450 			if (reg)
451 				err(1, "reading playback header");
452 			else
453 				break;
454 		}
455 		swapstamp(stamp);
456 		save_len = sizeof(stamp);
457 
458 		if (reg && stamp.scr_len >
459 		    (uint64_t)(pst.st_size - save_len) - nread)
460 			errx(1, "invalid stamp");
461 
462 		save_len += stamp.scr_len;
463 		tclock = stamp.scr_sec;
464 		tso.tv_sec = stamp.scr_sec;
465 		tso.tv_nsec = stamp.scr_usec * 1000;
466 
467 		switch (stamp.scr_direction) {
468 		case 's':
469 			if (!qflg)
470 			    (void)printf("Script started on %s",
471 				ctime(&tclock));
472 			tsi = tso;
473 			(void)consume(fp, stamp.scr_len, buf, reg);
474 			break;
475 		case 'e':
476 			if (!qflg)
477 				(void)printf("\nScript done on %s",
478 				    ctime(&tclock));
479 			(void)consume(fp, stamp.scr_len, buf, reg);
480 			break;
481 		case 'i':
482 			/* throw input away */
483 			(void)consume(fp, stamp.scr_len, buf, reg);
484 			break;
485 		case 'o':
486 			tsi.tv_sec = tso.tv_sec - tsi.tv_sec;
487 			tsi.tv_nsec = tso.tv_nsec - tsi.tv_nsec;
488 			if (tsi.tv_nsec < 0) {
489 				tsi.tv_sec -= 1;
490 				tsi.tv_nsec += 1000000000;
491 			}
492 			if (usesleep)
493 				(void)nanosleep(&tsi, NULL);
494 			tsi = tso;
495 			while (stamp.scr_len > 0) {
496 				l = MIN(DEF_BUF, stamp.scr_len);
497 				if (fread(buf, sizeof(char), l, fp) != l)
498 					err(1, "cannot read buffer");
499 
500 				(void)write(STDOUT_FILENO, buf, l);
501 				stamp.scr_len -= l;
502 			}
503 			break;
504 		default:
505 			errx(1, "invalid direction");
506 		}
507 	}
508 	(void)fclose(fp);
509 	exit(0);
510 }
511