showterm 0.1.1 → 0.2

data/bin/showterm

@@ -15,9 +15,7 @@ end
 
 sf, tf = Showterm.record! *ARGV
 begin
-  Showterm.upload! sf, tf, ENV['COLUMNS'] || 80
-  File.unlink sf
-  File.unlink tf
+  Showterm.upload! sf, tf
 rescue => e
   puts [e] + e.backtrace
   puts "DON'T PANIC"

data/ext/Makefile

@@ -0,0 +1,34 @@
+CC = gcc
+CFLAGS = -O2
+VERSION = 1.0.8
+
+TARGET = ttyrec ttyplay ttytime
+
+DIST =	ttyrec.c ttyplay.c ttyrec.h io.c io.h ttytime.c\
+	README Makefile ttyrec.1 ttyplay.1 ttytime.1
+
+all: $(TARGET)
+
+ttyrec: ttyrec.o io.o
+	$(CC) $(CFLAGS) -o ttyrec ttyrec.o io.o
+
+ttyplay: ttyplay.o io.o
+	$(CC) $(CFLAGS) -o ttyplay ttyplay.o io.o
+
+ttytime: ttytime.o io.o
+	$(CC) $(CFLAGS) -o ttytime ttytime.o io.o
+
+clean:
+	rm -f *.o $(TARGET) ttyrecord *~
+
+dist:
+	rm -rf ttyrec-$(VERSION)
+	rm -f ttyrec-$(VERSION).tar.gz
+
+	mkdir ttyrec-$(VERSION)
+	cp $(DIST) ttyrec-$(VERSION)
+	tar zcf ttyrec-$(VERSION).tar.gz  ttyrec-$(VERSION)
+	rm -rf ttyrec-$(VERSION)
+
+install:
+	:

data/ext/README

@@ -0,0 +1,27 @@
+ttyrec is a tty recorder. ttyplay is a tty player.
+
+Installation:
+
+  % make
+
+or if your system is SVR4 system (Solaris etc.),
+
+  % make CFLAGS=-DSVR4
+
+or if your system supports getpt(3),
+
+  % make CFLAGS=-DHAVE_getpt
+
+HAVE_getpt is required if your linux system uses devfs.
+
+
+Usage:
+
+  % ttyrec
+  (In the excuted shell, do whatever you want and exit)
+
+  % ttyplay ttyrecord
+
+Have fun!
+
+-- Satoru Takabayashi <satoru@namazu.org>

data/ext/io.c

@@ -0,0 +1,161 @@
+/*
+ * Copyright (c) 2000 Satoru Takabayashi <satoru@namazu.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *	This product includes software developed by the University of
+ *	California, Berkeley and its contributors.
+ * 4. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#include <assert.h>
+#include <errno.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "ttyrec.h"
+
+#define SWAP_ENDIAN(val) ((unsigned int) ( \
+    (((unsigned int) (val) & (unsigned int) 0x000000ffU) << 24) | \
+    (((unsigned int) (val) & (unsigned int) 0x0000ff00U) <<  8) | \
+    (((unsigned int) (val) & (unsigned int) 0x00ff0000U) >>  8) | \
+    (((unsigned int) (val) & (unsigned int) 0xff000000U) >> 24)))
+
+static int 
+is_little_endian ()
+{
+    static int retval = -1;
+
+    if (retval == -1) {
+	int n = 1;
+	char *p = (char *)&n;
+	char x[] = {1, 0, 0, 0};
+
+	assert(sizeof(int) == 4);
+
+	if (memcmp(p, x, 4) == 0) {
+	    retval = 1;
+	} else {
+	    retval = 0;
+	}
+    }
+
+    return retval;
+}
+
+static int
+convert_to_little_endian (int x)
+{
+    if (is_little_endian()) {
+	return x;
+    } else {
+	return SWAP_ENDIAN(x);
+    }
+}
+
+int
+read_header (FILE *fp, Header *h)
+{
+    int buf[3];
+
+    if (fread(buf, sizeof(int), 3, fp) == 0) {
+	return 0;
+    }
+
+    h->tv.tv_sec  = convert_to_little_endian(buf[0]);
+    h->tv.tv_usec = convert_to_little_endian(buf[1]);
+    h->len        = convert_to_little_endian(buf[2]);
+
+    return 1;
+}
+
+int
+write_header (FILE *fp, Header *h)
+{
+    int buf[3];
+
+    buf[0] = convert_to_little_endian(h->tv.tv_sec);
+    buf[1] = convert_to_little_endian(h->tv.tv_usec);
+    buf[2] = convert_to_little_endian(h->len);
+
+    if (fwrite(buf, sizeof(int), 3, fp) == 0) {
+	return 0;
+    }
+
+    return 1;
+}
+
+static char *progname = "";
+void
+set_progname (const char *name)
+{
+    progname = strdup(name);
+}
+
+FILE *
+efopen (const char *path, const char *mode)
+{
+    FILE *fp = fopen(path, mode);
+    if (fp == NULL) {
+	fprintf(stderr, "%s: %s: %s\n", progname, path, strerror(errno));
+	exit(EXIT_FAILURE);
+    }
+    return fp;
+}
+
+int
+edup (int oldfd)
+{
+    int fd = dup(oldfd);
+    if (fd == -1) {
+	fprintf(stderr, "%s: dup failed: %s\n", progname, strerror(errno));
+	exit(EXIT_FAILURE);
+    }
+    return fd;
+}
+
+int
+edup2 (int oldfd, int newfd)
+{
+    int fd = dup2(oldfd, newfd);
+    if (fd == -1) {
+	fprintf(stderr, "%s: dup2 failed: %s\n", progname, strerror(errno));
+	exit(EXIT_FAILURE);
+    }
+    return fd;
+}
+
+FILE *
+efdopen (int fd, const char *mode)
+{
+    FILE *fp = fdopen(fd, mode);
+    if (fp == NULL) {
+	fprintf(stderr, "%s: fdopen failed: %s\n", progname, strerror(errno));
+	exit(EXIT_FAILURE);
+    }
+}

data/ext/io.h

@@ -0,0 +1,13 @@
+#ifndef __TTYREC_IO_H__
+#define __TTYREC_IO_H__
+
+#include "ttyrec.h"
+
+int     read_header     (FILE *fp, Header *h);
+int     write_header    (FILE *fp, Header *h);
+FILE*   efopen          (const char *path, const char *mode);
+int     edup            (int oldfd);
+int     edup2           (int oldfd, int newfd);
+FILE*   efdopen         (int fd, const char *mode);
+
+#endif

data/ext/ttyplay.1

@@ -0,0 +1,62 @@
+.\"
+.\" This manual page is written by NAKANO Takeo <nakano@webmasters.gr.jp>
+.\"
+.TH TTYPLAY 1
+.SH NAME
+ttyplay \- player of the tty session recorded by ttyrec
+.SH SYNOPSIS
+.br
+.B ttyplay
+.I [\-s SPEED] [\-n] [\-p] file
+.br
+.SH DESCRIPTION
+.B Ttyplay
+plays the tty session in
+.IR file ,
+which was recorded previously by
+.BR ttyrec (1).
+.PP
+When
+.B \-p
+option is given,
+.B ttyplay
+output the
+.I file
+as it grows.
+It means that you can see the "live" shell session 
+running by another user.
+.PP
+If you hit any key during playback, it will go right to the next
+character typed.  This is handy when examining sessions where a user
+spends a lot of time at a prompt.
+.PP
+Additionally, there are some special keys defined:
+.TP
+.BI + " or " f
+ double the speed of playback.
+.TP
+.BI \- " or " s
+ halve the speed of playback.
+.TP
+.BI 1
+set playback to speed 1.0 again.
+
+.SH OPTIONS
+.TP
+.BI \-s " SPEED"
+multiple the playing speed by
+.I SPEED
+(default is 1).
+.TP
+.B \-n
+no wait mode.
+Ignore the timing information in
+.IR file .
+.TP
+.B \-p
+peek another person's tty session.
+.SH "SEE ALSO"
+.BR script (1),
+.BR ttyrec (1),
+.BR ttytime (1)
+

data/ext/ttyplay.c

@@ -0,0 +1,312 @@
+/*
+ * Copyright (c) 2000 Satoru Takabayashi <satoru@namazu.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *	This product includes software developed by the University of
+ *	California, Berkeley and its contributors.
+ * 4. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <assert.h>
+#include <unistd.h>
+#include <termios.h>
+#include <sys/time.h>
+#include <string.h>
+
+#include "ttyrec.h"
+#include "io.h"
+
+typedef double	(*WaitFunc)	(struct timeval prev, 
+				 struct timeval cur, 
+				 double speed);
+typedef int	(*ReadFunc)	(FILE *fp, Header *h, char **buf);
+typedef void	(*WriteFunc)	(char *buf, int len);
+typedef void	(*ProcessFunc)	(FILE *fp, double speed, 
+				 ReadFunc read_func, WaitFunc wait_func);
+
+struct timeval
+timeval_diff (struct timeval tv1, struct timeval tv2)
+{
+    struct timeval diff;
+
+    diff.tv_sec = tv2.tv_sec - tv1.tv_sec;
+    diff.tv_usec = tv2.tv_usec - tv1.tv_usec;
+    if (diff.tv_usec < 0) {
+	diff.tv_sec--;
+	diff.tv_usec += 1000000;
+    }
+
+    return diff;
+}
+
+struct timeval
+timeval_div (struct timeval tv1, double n)
+{
+    double x = ((double)tv1.tv_sec  + (double)tv1.tv_usec / 1000000.0) / n;
+    struct timeval div;
+    
+    div.tv_sec  = (int)x;
+    div.tv_usec = (x - (int)x) * 1000000;
+
+    return div;
+}
+
+double
+ttywait (struct timeval prev, struct timeval cur, double speed)
+{
+    static struct timeval drift = {0, 0};
+    struct timeval start;
+    struct timeval diff = timeval_diff(prev, cur);
+    fd_set readfs;
+
+    gettimeofday(&start, NULL);
+
+    assert(speed != 0);
+    diff = timeval_diff(drift, timeval_div(diff, speed));
+    if (diff.tv_sec < 0) {
+	diff.tv_sec = diff.tv_usec = 0;
+    }
+
+    FD_SET(STDIN_FILENO, &readfs);
+    /* 
+     * We use select() for sleeping with subsecond precision.
+     * select() is also used to wait user's input from a keyboard.
+     *
+     * Save "diff" since select(2) may overwrite it to {0, 0}. 
+     */
+    struct timeval orig_diff = diff;
+    select(1, &readfs, NULL, NULL, &diff);
+    diff = orig_diff;  /* Restore the original diff value. */
+    if (FD_ISSET(0, &readfs)) { /* a user hits a character? */
+        char c;
+        read(STDIN_FILENO, &c, 1); /* drain the character */
+        switch (c) {
+        case '+':
+        case 'f':
+            speed *= 2;
+            break;
+        case '-':
+        case 's':
+            speed /= 2;
+            break;
+        case '1':
+            speed = 1.0;
+            break;
+        }
+	drift.tv_sec = drift.tv_usec = 0;
+    } else {
+	struct timeval stop;
+	gettimeofday(&stop, NULL);
+	/* Hack to accumulate the drift */
+	if (diff.tv_sec == 0 && diff.tv_usec == 0) {
+            diff = timeval_diff(drift, diff);  // diff = 0 - drift.
+        }
+	drift = timeval_diff(diff, timeval_diff(start, stop));
+    }
+    return speed;
+}
+
+double
+ttynowait (struct timeval prev, struct timeval cur, double speed)
+{
+    /* do nothing */
+    return 0; /* Speed isn't important. */
+}
+
+int
+ttyread (FILE *fp, Header *h, char **buf)
+{
+    if (read_header(fp, h) == 0) {
+	return 0;
+    }
+
+    *buf = malloc(h->len);
+    if (*buf == NULL) {
+	perror("malloc");
+    }
+	
+    if (fread(*buf, 1, h->len, fp) == 0) {
+	perror("fread");
+    }
+    return 1;
+}
+
+int
+ttypread (FILE *fp, Header *h, char **buf)
+{
+    /*
+     * Read persistently just like tail -f.
+     */
+    while (ttyread(fp, h, buf) == 0) {
+	struct timeval w = {0, 250000};
+	select(0, NULL, NULL, NULL, &w);
+	clearerr(fp);
+    }
+    return 1;
+}
+
+void
+ttywrite (char *buf, int len)
+{
+    fwrite(buf, 1, len, stdout);
+}
+
+void
+ttynowrite (char *buf, int len)
+{
+    /* do nothing */
+}
+
+void
+ttyplay (FILE *fp, double speed, ReadFunc read_func, 
+	 WriteFunc write_func, WaitFunc wait_func)
+{
+    int first_time = 1;
+    struct timeval prev;
+
+    setbuf(stdout, NULL);
+    setbuf(fp, NULL);
+
+    while (1) {
+	char *buf;
+	Header h;
+
+	if (read_func(fp, &h, &buf) == 0) {
+	    break;
+	}
+
+	if (!first_time) {
+	    speed = wait_func(prev, h.tv, speed);
+	}
+	first_time = 0;
+
+	write_func(buf, h.len);
+	prev = h.tv;
+	free(buf);
+    }
+}
+
+void
+ttyskipall (FILE *fp)
+{
+    /*
+     * Skip all records.
+     */
+    ttyplay(fp, 0, ttyread, ttynowrite, ttynowait);
+}
+
+void ttyplayback (FILE *fp, double speed, 
+		  ReadFunc read_func, WaitFunc wait_func)
+{
+    ttyplay(fp, speed, ttyread, ttywrite, wait_func);
+}
+
+void ttypeek (FILE *fp, double speed, 
+	      ReadFunc read_func, WaitFunc wait_func)
+{
+    ttyskipall(fp);
+    ttyplay(fp, speed, ttypread, ttywrite, ttynowait);
+}
+
+
+void
+usage (void)
+{
+    printf("Usage: ttyplay [OPTION] [FILE]\n");
+    printf("  -s SPEED Set speed to SPEED [1.0]\n");
+    printf("  -n       No wait mode\n");
+    printf("  -p       Peek another person's ttyrecord\n");
+    exit(EXIT_FAILURE);
+}
+
+/*
+ * We do some tricks so that select(2) properly works on
+ * STDIN_FILENO in ttywait().
+ */
+FILE *
+input_from_stdin (void)
+{
+    FILE *fp;
+    int fd = edup(STDIN_FILENO);
+    edup2(STDOUT_FILENO, STDIN_FILENO);
+    return efdopen(fd, "r");
+}
+
+int 
+main (int argc, char **argv)
+{
+    double speed = 1.0;
+    ReadFunc read_func  = ttyread;
+    WaitFunc wait_func  = ttywait;
+    ProcessFunc process = ttyplayback;
+    FILE *input = NULL;
+    struct termios old, new;
+
+    set_progname(argv[0]);
+    while (1) {
+        int ch = getopt(argc, argv, "s:np");
+        if (ch == EOF) {
+            break;
+	}
+	switch (ch) {
+	case 's':
+	    if (optarg == NULL) {
+		perror("-s option requires an argument");
+		exit(EXIT_FAILURE);
+	    }
+	    sscanf(optarg, "%lf", &speed);
+	    break;
+	case 'n':
+	    wait_func = ttynowait;
+	    break;
+	case 'p':
+	    process = ttypeek;
+	    break;
+	default:
+	    usage();
+	}
+    }
+
+    if (optind < argc) {
+	input = efopen(argv[optind], "r");
+    } else {
+        input = input_from_stdin();
+    }
+    assert(input != NULL);
+
+    tcgetattr(0, &old); /* Get current terminal state */
+    new = old;          /* Make a copy */
+    new.c_lflag &= ~(ICANON | ECHO | ECHONL); /* unbuffered, no echo */
+    tcsetattr(0, TCSANOW, &new); /* Make it current */
+
+    process(input, speed, read_func, wait_func);
+    tcsetattr(0, TCSANOW, &old);  /* Return terminal state */
+
+    return 0;
+}

data/ext/ttyrec.1

@@ -0,0 +1,76 @@
+.\"
+.\" This manual page is written by NAKANO Takeo <nakano@webmasters.gr.jp>
+.\"
+.TH TTYREC 1
+.SH NAME
+ttyrec \- a tty recorder
+.SH SYNOPSIS
+.br
+.B ttyrec
+.I "[\-a][\-u] [file]"
+.br
+.SH DESCRIPTION
+.B Ttyrec
+is a tty recorder.
+It is a derivative of
+.BR script (1)
+command for recording timing information with microsecond accuracy as well.
+It can record emacs -nw, vi, lynx, or any programs running on tty.
+.PP
+.B Ttyrec
+invokes a shell and records the session until the shell exits.
+Recorded data can be played back with
+.BR ttyplay (1).
+If the argument
+.I file
+is given, the session will be recorded in that file.
+Otherwise,
+.I ttyrecord
+is used as default.
+.SH OPTIONS
+.TP
+.B \-a
+Append the output to
+.I file
+or
+.IR ttyrecord ,
+rather than overwriting it.
+.TP
+.B \-u
+With this option,
+.B ttyrec
+automatically calls
+.BR uudecode (1)
+and saves its output when uuencoded data appear on the session.
+It allow you to transfer files from remote host.
+You can call
+.B ttyrec
+with this option, login to the remote host
+and invoke
+.BR uuencode (1)
+on it for the file you want to transfer.
+.TP
+.BI \-e " command"
+Invoke 
+.I command
+when ttyrec starts.
+
+
+.SH ENVIRONMENT
+.TP
+.I SHELL
+If the variable
+.I SHELL
+exists, the shell forked by
+.B ttyrec
+will be that shell.
+If it's not set,
+the Bourne shell is assumed.
+(Most shells set this variable automatically).
+.SH "SEE ALSO"
+.BR script (1),
+.BR ttyplay (1),
+.BR ttytime (1),
+.BR uuencode (1),
+.BR uudecode (1)
+