]> git.ipfire.org Git - thirdparty/util-linux.git/blobdiff - term-utils/scriptlive.c
build-sys: remove duplicate includes
[thirdparty/util-linux.git] / term-utils / scriptlive.c
index 24f9c8e65e1308f4a19692d19b76fb2d67ef9580..b17dc9ef304e0f8f7dc72a752fede00dd64feb29 100644 (file)
@@ -27,7 +27,6 @@
 #include <sys/types.h>
 #include <sys/wait.h>
 #include <termios.h>
-#include <unistd.h>
 #include <paths.h>
 
 #include "c.h"
 #include "nls.h"
 #include "strutils.h"
 #include "optutils.h"
+#include "pty-session.h"
 #include "script-playutils.h"
-#include "rpmatch.h"
+#include "monotonic.h"
 
 
 #define SCRIPT_MIN_DELAY 0.0001                /* from original sripreplay.pl */
 
+struct scriptlive {
+       struct ul_pty *pty;
+       struct replay_setup *setup;
+       struct replay_step *step;
+};
+
 static void __attribute__((__noreturn__))
 usage(void)
 {
@@ -59,10 +65,12 @@ usage(void)
 
        fputs(USAGE_OPTIONS, out);
        fputs(_(" -t, --timing <file>     script timing log file\n"), out);
+       fputs(_(" -T, --log-timing <file> alias to -t\n"), out);
        fputs(_(" -I, --log-in <file>     script stdin log file\n"), out);
        fputs(_(" -B, --log-io <file>     script stdin and stdout log file\n"), out);
 
        fputs(USAGE_SEPARATOR, out);
+       fputs(_(" -c, --command <command> run command rather than interactive shell\n"), out);
        fputs(_(" -d, --divisor <num>     speed up or slow down execution with time divisor\n"), out);
        fputs(_(" -m, --maxdelay <num>    wait at most this many seconds between updates\n"), out);
        printf(USAGE_HELP_OPTIONS(25));
@@ -83,85 +91,88 @@ getnum(const char *s)
        return d;
 }
 
-static void
-delay_for(double delay)
+static void callback_child_sigstop(
+                       void *data __attribute__((__unused__)),
+                       pid_t child)
+{
+       kill(getpid(), SIGSTOP);
+       kill(child, SIGCONT);
+}
+
+static int process_next_step(struct scriptlive *ss)
 {
-#ifdef HAVE_NANOSLEEP
-       struct timespec ts, remainder;
-       ts.tv_sec = (time_t) delay;
-       ts.tv_nsec = (delay - ts.tv_sec) * 1.0e9;
+       int rc = 0, fd = ul_pty_get_childfd(ss->pty);
 
-       DBG(TIMING, ul_debug("going to sleep for %fs", delay));
+       /* read next step(s) */
+       do {
+               struct timeval *delay;
 
-       while (-1 == nanosleep(&ts, &remainder)) {
-               if (EINTR == errno)
-                       ts = remainder;
-               else
+               rc = replay_get_next_step(ss->setup, "I", &ss->step);
+               if (rc == 1) {
+                       ul_pty_write_eof_to_child(ss->pty);
+                       rc = 0;
+                       break;
+               }
+               if (rc)
                        break;
-       }
-#else
-       struct timeval tv;
-       tv.tv_sec = (long) delay;
-       tv.tv_usec = (delay - tv.tv_sec) * 1.0e6;
-       select(0, NULL, NULL, NULL, &tv);
-#endif
-}
 
-static int start_shell(const char *shell, pid_t *shell_pid, int *shell_fd)
-{
-       const char *shname;
-       int fds[2];
+               delay = replay_step_get_delay(ss->step);
+               if (timerisset(delay)) {
+                       /* wait until now+delay in mainloop */
+                       struct timeval now, target;
 
-       assert(shell_pid);
-       assert(shell_fd);
+                       gettime_monotonic(&now);
+                       timeradd(&now, delay, &target);
 
-       if (pipe(fds) < 0)
-               err(EXIT_FAILURE, _("pipe failed"));
+                       ul_pty_set_mainloop_time(ss->pty, &target);
+                       break;
+               } else {
+                       /* no delay -- immediately write */
+                       rc = replay_emit_step_data(ss->setup, ss->step, fd);
+                       fdatasync(fd);
+               }
+       } while (rc == 0);
 
-       *shell_pid  = fork();
+       return rc;
+}
 
-       if (*shell_pid == -1)
-               err(EXIT_FAILURE, _("fork failed"));
-       if (*shell_pid != 0) {
-               /* parent */
-               *shell_fd = fds[1];
-               close(fds[0]);
-               return -errno;
-       }
+static int mainloop_cb(void *data)
+{
+       struct scriptlive *ss = (struct scriptlive *) data;
+       int rc = 0;
 
-       /* child */
-       shname = strrchr(shell, '/');
-       if (shname)
-               shname++;
-       else
-               shname = shell;
+       /* emit previous waiting step */
+       if (ss->step && !replay_step_is_empty(ss->step)) {
+               int fd = ul_pty_get_childfd(ss->pty);;
 
-       dup2(fds[0], STDIN_FILENO);
-       close(fds[0]);
-       close(fds[1]);
+               rc = replay_emit_step_data(ss->setup, ss->step, fd);
+               fdatasync(fd);
+               if (rc)
+                       return rc;
+       }
 
-       execl(shell, shname, "-i", NULL);
-       errexec(shell);
+       return process_next_step(ss);
 }
 
 int
 main(int argc, char *argv[])
 {
-       struct replay_setup *setup = NULL;
-       struct replay_step *step = NULL;
-       const char *log_in = NULL,
-                  *log_io = NULL,
-                  *log_tm = NULL,
-                  *shell;
-       double divi = 1, maxdelay = 0;
-       int diviopt = FALSE, maxdelayopt = FALSE, idx;
-       int ch, rc;
-       int shell_fd;
-       pid_t shell_pid;
-       struct termios attrs;
+       static const struct timeval mindelay = { .tv_sec = 0, .tv_usec = 100 };
+       struct timeval maxdelay;
+
+       const char *log_in = NULL, *log_io = NULL, *log_tm = NULL,
+                  *shell = NULL, *command = NULL;
+       double divi = 1;
+       int diviopt = FALSE, idx;
+       int ch, caught_signal = 0;
+       struct ul_pty_callbacks *cb;
+       struct scriptlive ss = { .pty = NULL };
+       pid_t child;
 
        static const struct option longopts[] = {
+               { "command",    required_argument,      0, 'c' },
                { "timing",     required_argument,      0, 't' },
+               { "log-timing", required_argument,      0, 'T' },
                { "log-in",     required_argument,      0, 'I'},
                { "log-io",     required_argument,      0, 'B'},
                { "divisor",    required_argument,      0, 'd' },
@@ -187,13 +198,18 @@ main(int argc, char *argv[])
        close_stdout_atexit();
 
        replay_init_debug();
+       timerclear(&maxdelay);
 
-       while ((ch = getopt_long(argc, argv, "B:I:t:d:m:Vh", longopts, NULL)) != -1) {
+       while ((ch = getopt_long(argc, argv, "c:B:I:T:t:d:m:Vh", longopts, NULL)) != -1) {
 
                err_exclusive_options(ch, longopts, excl, excl_st);
 
                switch(ch) {
+               case 'c':
+                       command = optarg;
+                       break;
                case 't':
+               case 'T':
                        log_tm = optarg;
                        break;
                case 'I':
@@ -207,8 +223,7 @@ main(int argc, char *argv[])
                        divi = getnum(optarg);
                        break;
                case 'm':
-                       maxdelayopt = TRUE;
-                       maxdelay = getnum(optarg);
+                       strtotimeval_or_err(optarg, &maxdelay, _("failed to parse maximal delay argument"));
                        break;
                case 'V':
                        print_version(EXIT_SUCCESS);
@@ -222,9 +237,6 @@ main(int argc, char *argv[])
        argv += optind;
        idx = 0;
 
-       if (!isatty(STDIN_FILENO))
-               errx(EXIT_FAILURE, _("stdin is not terminal"));
-
        if (!log_tm && idx < argc)
                log_tm = argv[idx++];
        if (!log_in && !log_io && idx < argc)
@@ -232,68 +244,122 @@ main(int argc, char *argv[])
 
        if (!diviopt)
                divi = idx < argc ? getnum(argv[idx]) : 1;
-       if (maxdelay < 0)
-               maxdelay = 0;
 
        if (!log_tm)
                errx(EXIT_FAILURE, _("timing file not specified"));
        if (!(log_in || log_io))
                errx(EXIT_FAILURE, _("stdin typescript file not specified"));
 
-       setup = replay_new_setup();
+       ss.setup = replay_new_setup();
 
-       if (replay_set_timing_file(setup, log_tm) != 0)
+       if (replay_set_timing_file(ss.setup, log_tm) != 0)
                err(EXIT_FAILURE, _("cannot open %s"), log_tm);
 
-       if (log_in && replay_associate_log(setup, "I", log_in) != 0)
+       if (log_in && replay_associate_log(ss.setup, "I", log_in) != 0)
                err(EXIT_FAILURE, _("cannot open %s"), log_in);
 
-       if (log_io && replay_associate_log(setup, "IO", log_io) != 0)
+       if (log_io && replay_associate_log(ss.setup, "IO", log_io) != 0)
                err(EXIT_FAILURE, _("cannot open %s"), log_io);
 
-       replay_set_default_type(setup, 'I');
-       replay_set_crmode(setup, REPLAY_CRMODE_AUTO);
+       replay_set_default_type(ss.setup, 'I');
+       replay_set_crmode(ss.setup, REPLAY_CRMODE_NEVER);
+
+       if (divi != 1)
+               replay_set_delay_div(ss.setup, divi);
+       if (timerisset(&maxdelay))
+               replay_set_delay_max(ss.setup, &maxdelay);
+       replay_set_delay_min(ss.setup, &mindelay);
 
        shell = getenv("SHELL");
        if (shell == NULL)
                shell = _PATH_BSHELL;
 
-       fprintf(stdout, _(">>> scriptlive: Starting your typescript execution by %s. <<<\n"), shell);
+       fprintf(stdout, _(">>> scriptlive: Starting your typescript execution by %s.\n"),
+                       command ? command : shell);
 
-       tcgetattr(STDIN_FILENO, &attrs);
-       start_shell(shell, &shell_pid, &shell_fd);
+       ul_pty_init_debug(0);
 
-       do {
-               double delay;
+       ss.pty = ul_new_pty(isatty(STDIN_FILENO));
+       if (!ss.pty)
+               err(EXIT_FAILURE, _("failed to allocate PTY handler"));
 
-               rc = replay_get_next_step(setup, "I", &step);
-               if (rc)
-                       break;
+       ul_pty_set_callback_data(ss.pty, (void *) &ss);
+       cb = ul_pty_get_callbacks(ss.pty);
+       cb->child_sigstop = callback_child_sigstop;
+       cb->mainloop = mainloop_cb;
 
-               delay = replay_step_get_delay(step);
-               delay /= divi;
+       if (!isatty(STDIN_FILENO))
+               /* We keep ECHO flag for compatibility with script(1) */
+               ul_pty_slave_echo(ss.pty, 1);
 
-               if (maxdelayopt && delay > maxdelay)
-                       delay = maxdelay;
-               if (delay > SCRIPT_MIN_DELAY)
-                       delay_for(delay);
+       if (ul_pty_setup(ss.pty))
+               err(EXIT_FAILURE, _("failed to create pseudo-terminal"));
 
-               rc = replay_emit_step_data(setup, step, shell_fd);
-       } while (rc == 0);
+       fflush(stdout);                 /* ??? */
 
-       kill(shell_pid, SIGTERM);
-       waitpid(shell_pid, 0, 0);
-       tcsetattr(STDIN_FILENO, TCSADRAIN, &attrs);
+       switch ((int) (child = fork())) {
+       case -1: /* error */
+               ul_pty_cleanup(ss.pty);
+               err(EXIT_FAILURE, _("cannot create child process"));
+               break;
 
-       if (step && rc < 0)
-               err(EXIT_FAILURE, _("%s: log file error"), replay_step_get_filename(step));
-       else if (rc < 0)
-               err(EXIT_FAILURE, _("%s: line %d: timing file error"),
-                               replay_get_timing_file(setup),
-                               replay_get_timing_line(setup));
+       case 0: /* child */
+       {
+               const char *shname;
 
+               ul_pty_init_slave(ss.pty);
 
-       fprintf(stdout, _(">>> scriptlive: Done. <<<\n"));
+               signal(SIGTERM, SIG_DFL); /* because /etc/csh.login */
 
-       exit(EXIT_SUCCESS);
+               shname = strrchr(shell, '/');
+               shname = shname ? shname + 1 : shell;
+
+               if (access(shell, X_OK) == 0) {
+                       if (command)
+                               execl(shell, shname, "-c", command, NULL);
+                       else
+                               execl(shell, shname, "-i", NULL);
+               } else {
+                       if (command)
+                               execlp(shname, "-c", command, NULL);
+                       else
+                               execlp(shname, "-i", NULL);
+               }
+               err(EXIT_FAILURE, "failed to execute %s", shell);
+               break;
+       }
+       default:
+               break;
+       }
+
+       /* parent */
+       ul_pty_set_child(ss.pty, child);
+
+       /* read the first step and set initial delay for pty main loop; the
+        * next steps will be processed by mainloop_cb() */
+       process_next_step(&ss);
+
+       /* this is the main loop */
+       ul_pty_proxy_master(ss.pty);
+
+       /* all done; cleanup and kill */
+       caught_signal = ul_pty_get_delivered_signal(ss.pty);
+
+       if (!caught_signal && ul_pty_get_child(ss.pty) != (pid_t)-1)
+               ul_pty_wait_for_child(ss.pty);  /* final wait */
+
+       if (caught_signal && ul_pty_get_child(ss.pty) != (pid_t)-1) {
+               fprintf(stderr, _("\nSession terminated, killing shell..."));
+               kill(child, SIGTERM);
+               sleep(2);
+               kill(child, SIGKILL);
+               fprintf(stderr, " ...killed.\n");
+       }
+
+       ul_pty_cleanup(ss.pty);
+       ul_free_pty(ss.pty);
+       replay_free_setup(ss.setup);
+
+       fprintf(stdout, _("\n>>> scriptlive: done.\n"));
+       return EXIT_SUCCESS;
 }