xref: /freebsd/usr.bin/script/script.c (revision b0b1dbdd)
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  * 3. 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 | O_CLOEXEC)) == -1)
165 			err(1, "open(\"/dev/filemon\", O_RDWR)");
166 		if ((fm_log = open(fmfname,
167 		    O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC,
168 		    S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)) == -1)
169 			err(1, "open(%s)", fmfname);
170 		if (ioctl(fm_fd, FILEMON_SET_FD, &fm_log) < 0)
171 			err(1, "Cannot set filemon log file descriptor");
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 				showexit = 1;
200 				fprintf(fscript, "Command: ");
201 				for (k = 0 ; argv[k] ; ++k)
202 					fprintf(fscript, "%s%s", k ? " " : "",
203 						argv[k]);
204 				fprintf(fscript, "\n");
205 			}
206 		}
207 		fflush(fscript);
208 		if (fflg) {
209 			(void)printf("Filemon started, output file is %s\n",
210 			    fmfname);
211 		}
212 	}
213 	if (ttyflg) {
214 		rtt = tt;
215 		cfmakeraw(&rtt);
216 		rtt.c_lflag &= ~ECHO;
217 		(void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &rtt);
218 	}
219 
220 	child = fork();
221 	if (child < 0) {
222 		warn("fork");
223 		done(1);
224 	}
225 	if (child == 0) {
226 		if (fflg) {
227 			int pid;
228 
229 			pid = getpid();
230 			if (ioctl(fm_fd, FILEMON_SET_PID, &pid) < 0)
231 				err(1, "Cannot set filemon PID");
232 		}
233 
234 		doshell(argv);
235 	}
236 	close(slave);
237 
238 	start = tvec = time(0);
239 	readstdin = 1;
240 	for (;;) {
241 		FD_ZERO(&rfd);
242 		FD_SET(master, &rfd);
243 		if (readstdin)
244 			FD_SET(STDIN_FILENO, &rfd);
245 		if (!readstdin && ttyflg) {
246 			tv.tv_sec = 1;
247 			tv.tv_usec = 0;
248 			tvp = &tv;
249 			readstdin = 1;
250 		} else if (flushtime > 0) {
251 			tv.tv_sec = flushtime - (tvec - start);
252 			tv.tv_usec = 0;
253 			tvp = &tv;
254 		} else {
255 			tvp = NULL;
256 		}
257 		n = select(master + 1, &rfd, 0, 0, tvp);
258 		if (n < 0 && errno != EINTR)
259 			break;
260 		if (n > 0 && FD_ISSET(STDIN_FILENO, &rfd)) {
261 			cc = read(STDIN_FILENO, ibuf, BUFSIZ);
262 			if (cc < 0)
263 				break;
264 			if (cc == 0) {
265 				if (tcgetattr(master, &stt) == 0 &&
266 				    (stt.c_lflag & ICANON) != 0) {
267 					(void)write(master, &stt.c_cc[VEOF], 1);
268 				}
269 				readstdin = 0;
270 			}
271 			if (cc > 0) {
272 				if (rawout)
273 					record(fscript, ibuf, cc, 'i');
274 				(void)write(master, ibuf, cc);
275 				if (kflg && tcgetattr(master, &stt) >= 0 &&
276 				    ((stt.c_lflag & ECHO) == 0)) {
277 					(void)fwrite(ibuf, 1, cc, fscript);
278 				}
279 			}
280 		}
281 		if (n > 0 && FD_ISSET(master, &rfd)) {
282 			cc = read(master, obuf, sizeof (obuf));
283 			if (cc <= 0)
284 				break;
285 			(void)write(STDOUT_FILENO, obuf, cc);
286 			if (rawout)
287 				record(fscript, obuf, cc, 'o');
288 			else
289 				(void)fwrite(obuf, 1, cc, fscript);
290 		}
291 		tvec = time(0);
292 		if (tvec - start >= flushtime) {
293 			fflush(fscript);
294 			start = tvec;
295 		}
296 		if (Fflg)
297 			fflush(fscript);
298 	}
299 	finish();
300 	done(0);
301 }
302 
303 static void
304 usage(void)
305 {
306 	(void)fprintf(stderr,
307 	    "usage: script [-adfkpqr] [-t time] [file [command ...]]\n");
308 	exit(1);
309 }
310 
311 static void
312 finish(void)
313 {
314 	int e, status;
315 
316 	if (waitpid(child, &status, 0) == child) {
317 		if (WIFEXITED(status))
318 			e = WEXITSTATUS(status);
319 		else if (WIFSIGNALED(status))
320 			e = WTERMSIG(status);
321 		else /* can't happen */
322 			e = 1;
323 		done(e);
324 	}
325 }
326 
327 static void
328 doshell(char **av)
329 {
330 	const char *shell;
331 
332 	shell = getenv("SHELL");
333 	if (shell == NULL)
334 		shell = _PATH_BSHELL;
335 
336 	(void)close(master);
337 	(void)fclose(fscript);
338 	free(fmfname);
339 	login_tty(slave);
340 	setenv("SCRIPT", fname, 1);
341 	if (av[0]) {
342 		execvp(av[0], av);
343 		warn("%s", av[0]);
344 	} else {
345 		execl(shell, shell, "-i", (char *)NULL);
346 		warn("%s", shell);
347 	}
348 	exit(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 			if (showexit)
364 				(void)fprintf(fscript, "\nCommand exit status:"
365 				    " %d", eno);
366 			(void)fprintf(fscript,"\nScript done on %s",
367 			    ctime(&tvec));
368 		}
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 
380 static void
381 record(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 
400 static void
401 consume(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 
428 static void
429 playback(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