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) { 242 tv.tv_sec = 1; 243 tv.tv_usec = 0; 244 tvp = &tv; 245 readstdin = 1; 246 } else if (flushtime > 0) { 247 tv.tv_sec = flushtime - (tvec - start); 248 tv.tv_usec = 0; 249 tvp = &tv; 250 } else { 251 tvp = NULL; 252 } 253 n = select(master + 1, &rfd, 0, 0, tvp); 254 if (n < 0 && errno != EINTR) 255 break; 256 if (n > 0 && FD_ISSET(STDIN_FILENO, &rfd)) { 257 cc = read(STDIN_FILENO, ibuf, BUFSIZ); 258 if (cc < 0) 259 break; 260 if (cc == 0) { 261 if (tcgetattr(master, &stt) == 0 && 262 (stt.c_lflag & ICANON) != 0) { 263 (void)write(master, &stt.c_cc[VEOF], 1); 264 } 265 readstdin = 0; 266 } 267 if (cc > 0) { 268 if (rawout) 269 record(fscript, ibuf, cc, 'i'); 270 (void)write(master, ibuf, cc); 271 if (kflg && tcgetattr(master, &stt) >= 0 && 272 ((stt.c_lflag & ECHO) == 0)) { 273 (void)fwrite(ibuf, 1, cc, fscript); 274 } 275 } 276 } 277 if (n > 0 && FD_ISSET(master, &rfd)) { 278 cc = read(master, obuf, sizeof (obuf)); 279 if (cc <= 0) 280 break; 281 (void)write(STDOUT_FILENO, obuf, cc); 282 if (rawout) 283 record(fscript, obuf, cc, 'o'); 284 else 285 (void)fwrite(obuf, 1, cc, fscript); 286 } 287 tvec = time(0); 288 if (tvec - start >= flushtime) { 289 fflush(fscript); 290 start = tvec; 291 } 292 if (Fflg) 293 fflush(fscript); 294 } 295 finish(); 296 done(0); 297 } 298 299 static void 300 usage(void) 301 { 302 (void)fprintf(stderr, 303 "usage: script [-adfkpqr] [-t time] [file [command ...]]\n"); 304 exit(1); 305 } 306 307 static void 308 finish(void) 309 { 310 int e, status; 311 312 if (waitpid(child, &status, 0) == child) { 313 if (WIFEXITED(status)) 314 e = WEXITSTATUS(status); 315 else if (WIFSIGNALED(status)) 316 e = WTERMSIG(status); 317 else /* can't happen */ 318 e = 1; 319 done(e); 320 } 321 } 322 323 static void 324 doshell(char **av) 325 { 326 const char *shell; 327 328 shell = getenv("SHELL"); 329 if (shell == NULL) 330 shell = _PATH_BSHELL; 331 332 (void)close(master); 333 (void)fclose(fscript); 334 free(fmfname); 335 login_tty(slave); 336 setenv("SCRIPT", fname, 1); 337 if (av[0]) { 338 execvp(av[0], av); 339 warn("%s", av[0]); 340 } else { 341 execl(shell, shell, "-i", (char *)NULL); 342 warn("%s", shell); 343 } 344 fail(); 345 } 346 347 static void 348 fail(void) 349 { 350 (void)kill(0, SIGTERM); 351 done(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 (void)fprintf(fscript,"\nScript done on %s", 367 ctime(&tvec)); 368 (void)printf("\nScript done, output file is %s\n", fname); 369 if (fflg) { 370 (void)printf("Filemon done, output file is %s\n", 371 fmfname); 372 } 373 } 374 (void)fclose(fscript); 375 (void)close(master); 376 exit(eno); 377 } 378 379 static void 380 record(FILE *fp, char *buf, size_t cc, int direction) 381 { 382 struct iovec iov[2]; 383 struct stamp stamp; 384 struct timeval tv; 385 386 (void)gettimeofday(&tv, NULL); 387 stamp.scr_len = cc; 388 stamp.scr_sec = tv.tv_sec; 389 stamp.scr_usec = tv.tv_usec; 390 stamp.scr_direction = direction; 391 iov[0].iov_len = sizeof(stamp); 392 iov[0].iov_base = &stamp; 393 iov[1].iov_len = cc; 394 iov[1].iov_base = buf; 395 if (writev(fileno(fp), &iov[0], 2) == -1) 396 err(1, "writev"); 397 } 398 399 static void 400 consume(FILE *fp, off_t len, char *buf, int reg) 401 { 402 size_t l; 403 404 if (reg) { 405 if (fseeko(fp, len, SEEK_CUR) == -1) 406 err(1, NULL); 407 } 408 else { 409 while (len > 0) { 410 l = MIN(DEF_BUF, len); 411 if (fread(buf, sizeof(char), l, fp) != l) 412 err(1, "cannot read buffer"); 413 len -= l; 414 } 415 } 416 } 417 418 #define swapstamp(stamp) do { \ 419 if (stamp.scr_direction > 0xff) { \ 420 stamp.scr_len = bswap64(stamp.scr_len); \ 421 stamp.scr_sec = bswap64(stamp.scr_sec); \ 422 stamp.scr_usec = bswap32(stamp.scr_usec); \ 423 stamp.scr_direction = bswap32(stamp.scr_direction); \ 424 } \ 425 } while (0/*CONSTCOND*/) 426 427 static void 428 playback(FILE *fp) 429 { 430 struct timespec tsi, tso; 431 struct stamp stamp; 432 struct stat pst; 433 char buf[DEF_BUF]; 434 off_t nread, save_len; 435 size_t l; 436 time_t tclock; 437 int reg; 438 439 if (fstat(fileno(fp), &pst) == -1) 440 err(1, "fstat failed"); 441 442 reg = S_ISREG(pst.st_mode); 443 444 for (nread = 0; !reg || nread < pst.st_size; nread += save_len) { 445 if (fread(&stamp, sizeof(stamp), 1, fp) != 1) { 446 if (reg) 447 err(1, "reading playback header"); 448 else 449 break; 450 } 451 swapstamp(stamp); 452 save_len = sizeof(stamp); 453 454 if (reg && stamp.scr_len > 455 (uint64_t)(pst.st_size - save_len) - nread) 456 errx(1, "invalid stamp"); 457 458 save_len += stamp.scr_len; 459 tclock = stamp.scr_sec; 460 tso.tv_sec = stamp.scr_sec; 461 tso.tv_nsec = stamp.scr_usec * 1000; 462 463 switch (stamp.scr_direction) { 464 case 's': 465 if (!qflg) 466 (void)printf("Script started on %s", 467 ctime(&tclock)); 468 tsi = tso; 469 (void)consume(fp, stamp.scr_len, buf, reg); 470 break; 471 case 'e': 472 if (!qflg) 473 (void)printf("\nScript done on %s", 474 ctime(&tclock)); 475 (void)consume(fp, stamp.scr_len, buf, reg); 476 break; 477 case 'i': 478 /* throw input away */ 479 (void)consume(fp, stamp.scr_len, buf, reg); 480 break; 481 case 'o': 482 tsi.tv_sec = tso.tv_sec - tsi.tv_sec; 483 tsi.tv_nsec = tso.tv_nsec - tsi.tv_nsec; 484 if (tsi.tv_nsec < 0) { 485 tsi.tv_sec -= 1; 486 tsi.tv_nsec += 1000000000; 487 } 488 if (usesleep) 489 (void)nanosleep(&tsi, NULL); 490 tsi = tso; 491 while (stamp.scr_len > 0) { 492 l = MIN(DEF_BUF, stamp.scr_len); 493 if (fread(buf, sizeof(char), l, fp) != l) 494 err(1, "cannot read buffer"); 495 496 (void)write(STDOUT_FILENO, buf, l); 497 stamp.scr_len -= l; 498 } 499 break; 500 default: 501 errx(1, "invalid direction"); 502 } 503 } 504 (void)fclose(fp); 505 exit(0); 506 } 507