Use O_NOCTTY (if available) when opening /dev/ptmx, just in case any
[sgt/putty] / unix / uxpty.c
CommitLineData
28d00fe4 1/*
2 * Pseudo-tty backend for pterm.
28d00fe4 3 */
4
74aca06d 5#define _GNU_SOURCE
054d8535 6
1709795f 7#include <stdio.h>
8#include <stdlib.h>
054d8535 9#include <string.h>
10#include <unistd.h>
a0e16eb1 11#include <signal.h>
2916fa14 12#include <assert.h>
054d8535 13#include <fcntl.h>
88e6b9ca 14#include <termios.h>
be4f86de 15#include <grp.h>
755a6d84 16#include <utmp.h>
17#include <pwd.h>
18#include <time.h>
a0e16eb1 19#include <sys/types.h>
d4e1d591 20#include <sys/stat.h>
a0e16eb1 21#include <sys/wait.h>
88e6b9ca 22#include <sys/ioctl.h>
0f33f9d1 23#include <errno.h>
1709795f 24
25#include "putty.h"
d6fa1947 26#include "tree234.h"
1709795f 27
0b1df797 28#ifndef OMIT_UTMP
bea25c48 29#include <utmpx.h>
30#endif
31
1709795f 32#ifndef FALSE
33#define FALSE 0
34#endif
35#ifndef TRUE
36#define TRUE 1
37#endif
38
bea25c48 39/* updwtmpx() needs the name of the wtmp file. Try to find it. */
40#ifndef WTMPX_FILE
41#ifdef _PATH_WTMPX
42#define WTMPX_FILE _PATH_WTMPX
43#else
44#define WTMPX_FILE "/var/log/wtmpx"
755a6d84 45#endif
755a6d84 46#endif
bea25c48 47
755a6d84 48#ifndef LASTLOG_FILE
49#ifdef _PATH_LASTLOG
50#define LASTLOG_FILE _PATH_LASTLOG
51#else
52#define LASTLOG_FILE "/var/log/lastlog"
53#endif
54#endif
55
f51dc031 56/*
57 * Set up a default for vaguely sane systems. The idea is that if
58 * OMIT_UTMP is not defined, then at least one of the symbols which
59 * enable particular forms of utmp processing should be, if only so
60 * that a link error can warn you that you should have defined
61 * OMIT_UTMP if you didn't want any. Currently HAVE_PUTUTLINE is
62 * the only such symbol.
63 */
64#ifndef OMIT_UTMP
65#if !defined HAVE_PUTUTLINE
66#define HAVE_PUTUTLINE
67#endif
68#endif
69
d6fa1947 70typedef struct pty_tag *Pty;
71
72/*
73 * The pty_signal_pipe, along with the SIGCHLD handler, must be
74 * process-global rather than session-specific.
75 */
76static int pty_signal_pipe[2] = { -1, -1 }; /* obviously bogus initial val */
77
78struct pty_tag {
4a693cfc 79 Conf *conf;
d6fa1947 80 int master_fd, slave_fd;
81 void *frontend;
82 char name[FILENAME_MAX];
115393d8 83 pid_t child_pid;
d6fa1947 84 int term_width, term_height;
85 int child_dead, finished;
86 int exit_code;
2916fa14 87 bufchain output_data;
d6fa1947 88};
89
90/*
91 * We store our pty backends in a tree sorted by master fd, so that
92 * when we get an uxsel notification we know which backend instance
93 * is the owner of the pty that caused it.
94 */
95static int pty_compare_by_fd(void *av, void *bv)
96{
97 Pty a = (Pty)av;
98 Pty b = (Pty)bv;
99
100 if (a->master_fd < b->master_fd)
101 return -1;
102 else if (a->master_fd > b->master_fd)
103 return +1;
104 return 0;
105}
106
107static int pty_find_by_fd(void *av, void *bv)
108{
109 int a = *(int *)av;
110 Pty b = (Pty)bv;
111
112 if (a < b->master_fd)
113 return -1;
114 else if (a > b->master_fd)
115 return +1;
116 return 0;
117}
054d8535 118
d6fa1947 119static tree234 *ptys_by_fd = NULL;
120
121/*
122 * We also have a tree sorted by child pid, so that when we wait()
123 * in response to the signal we know which backend instance is the
124 * owner of the process that caused the signal.
125 */
126static int pty_compare_by_pid(void *av, void *bv)
127{
128 Pty a = (Pty)av;
129 Pty b = (Pty)bv;
130
131 if (a->child_pid < b->child_pid)
132 return -1;
133 else if (a->child_pid > b->child_pid)
134 return +1;
135 return 0;
136}
137
138static int pty_find_by_pid(void *av, void *bv)
139{
115393d8 140 pid_t a = *(pid_t *)av;
d6fa1947 141 Pty b = (Pty)bv;
142
143 if (a < b->child_pid)
144 return -1;
145 else if (a > b->child_pid)
146 return +1;
147 return 0;
148}
149
150static tree234 *ptys_by_pid = NULL;
151
152/*
153 * If we are using pty_pre_init(), it will need to have already
154 * allocated a pty structure, which we must then return from
155 * pty_init() rather than allocating a new one. Here we store that
156 * structure between allocation and use.
157 *
158 * Note that although most of this module is entirely capable of
159 * handling multiple ptys in a single process, pty_pre_init() is
160 * fundamentally _dependent_ on there being at most one pty per
161 * process, so the normal static-data constraints don't apply.
162 *
163 * Likewise, since utmp is only used via pty_pre_init, it too must
164 * be single-instance, so we can declare utmp-related variables
165 * here.
166 */
167static Pty single_pty = NULL;
74aca06d 168
d4e1d591 169#ifndef OMIT_UTMP
dd5517cb 170static pid_t pty_utmp_helper_pid = -1;
171static int pty_utmp_helper_pipe = -1;
d6fa1947 172static int pty_stamped_utmp;
bea25c48 173static struct utmpx utmp_entry;
d6fa1947 174#endif
175
176/*
177 * pty_argv is a grievous hack to allow a proper argv to be passed
178 * through from the Unix command line. Again, it doesn't really
179 * make sense outside a one-pty-per-process setup.
180 */
181char **pty_argv;
d6fa1947 182
183static void pty_close(Pty pty);
2916fa14 184static void pty_try_write(Pty pty);
d4e1d591 185
d6fa1947 186#ifndef OMIT_UTMP
95c47834 187static void setup_utmp(char *ttyname, char *location)
755a6d84 188{
755a6d84 189#ifdef HAVE_LASTLOG
190 struct lastlog lastlog_entry;
191 FILE *lastlog;
192#endif
193 struct passwd *pw;
bea25c48 194 struct timeval tv;
755a6d84 195
196 pw = getpwuid(getuid());
197 memset(&utmp_entry, 0, sizeof(utmp_entry));
198 utmp_entry.ut_type = USER_PROCESS;
199 utmp_entry.ut_pid = getpid();
200 strncpy(utmp_entry.ut_line, ttyname+5, lenof(utmp_entry.ut_line));
201 strncpy(utmp_entry.ut_id, ttyname+8, lenof(utmp_entry.ut_id));
202 strncpy(utmp_entry.ut_user, pw->pw_name, lenof(utmp_entry.ut_user));
203 strncpy(utmp_entry.ut_host, location, lenof(utmp_entry.ut_host));
bea25c48 204 /*
205 * Apparently there are some architectures where (struct
206 * utmpx).ut_tv is not essentially struct timeval (e.g. Linux
207 * amd64). Hence the temporary.
208 */
209 gettimeofday(&tv, NULL);
210 utmp_entry.ut_tv.tv_sec = tv.tv_sec;
211 utmp_entry.ut_tv.tv_usec = tv.tv_usec;
755a6d84 212
bea25c48 213 setutxent();
214 pututxline(&utmp_entry);
215 endutxent();
216
217 updwtmpx(WTMPX_FILE, &utmp_entry);
755a6d84 218
219#ifdef HAVE_LASTLOG
220 memset(&lastlog_entry, 0, sizeof(lastlog_entry));
221 strncpy(lastlog_entry.ll_line, ttyname+5, lenof(lastlog_entry.ll_line));
222 strncpy(lastlog_entry.ll_host, location, lenof(lastlog_entry.ll_host));
223 time(&lastlog_entry.ll_time);
224 if ((lastlog = fopen(LASTLOG_FILE, "r+")) != NULL) {
225 fseek(lastlog, sizeof(lastlog_entry) * getuid(), SEEK_SET);
226 fwrite(&lastlog_entry, 1, sizeof(lastlog_entry), lastlog);
227 fclose(lastlog);
228 }
229#endif
230
f51dc031 231 pty_stamped_utmp = 1;
232
755a6d84 233}
234
235static void cleanup_utmp(void)
236{
bea25c48 237 struct timeval tv;
755a6d84 238
95c47834 239 if (!pty_stamped_utmp)
f51dc031 240 return;
241
755a6d84 242 utmp_entry.ut_type = DEAD_PROCESS;
243 memset(utmp_entry.ut_user, 0, lenof(utmp_entry.ut_user));
bea25c48 244 gettimeofday(&tv, NULL);
245 utmp_entry.ut_tv.tv_sec = tv.tv_sec;
246 utmp_entry.ut_tv.tv_usec = tv.tv_usec;
755a6d84 247
bea25c48 248 updwtmpx(WTMPX_FILE, &utmp_entry);
755a6d84 249
250 memset(utmp_entry.ut_line, 0, lenof(utmp_entry.ut_line));
bea25c48 251 utmp_entry.ut_tv.tv_sec = 0;
252 utmp_entry.ut_tv.tv_usec = 0;
755a6d84 253
bea25c48 254 setutxent();
255 pututxline(&utmp_entry);
256 endutxent();
755a6d84 257
f51dc031 258 pty_stamped_utmp = 0; /* ensure we never double-cleanup */
755a6d84 259}
d4e1d591 260#endif
755a6d84 261
a0e16eb1 262static void sigchld_handler(int signum)
263{
ecb25722 264 if (write(pty_signal_pipe[1], "x", 1) <= 0)
265 /* not much we can do about it */;
a0e16eb1 266}
267
d4e1d591 268#ifndef OMIT_UTMP
755a6d84 269static void fatal_sig_handler(int signum)
270{
0f33f9d1 271 putty_signal(signum, SIG_DFL);
755a6d84 272 cleanup_utmp();
273 setuid(getuid());
274 raise(signum);
275}
d4e1d591 276#endif
755a6d84 277
d6fa1947 278static int pty_open_slave(Pty pty)
270d2e8d 279{
89e97516 280 if (pty->slave_fd < 0) {
d6fa1947 281 pty->slave_fd = open(pty->name, O_RDWR);
db9b7dce 282 cloexec(pty->slave_fd);
89e97516 283 }
270d2e8d 284
d6fa1947 285 return pty->slave_fd;
270d2e8d 286}
287
d6fa1947 288static void pty_open_master(Pty pty)
1709795f 289{
be4f86de 290#ifdef BSD_PTYS
95c47834 291 const char chars1[] = "pqrstuvwxyz";
292 const char chars2[] = "0123456789abcdef";
293 const char *p1, *p2;
294 char master_name[20];
295 struct group *gp;
296
297 for (p1 = chars1; *p1; p1++)
298 for (p2 = chars2; *p2; p2++) {
299 sprintf(master_name, "/dev/pty%c%c", *p1, *p2);
d6fa1947 300 pty->master_fd = open(master_name, O_RDWR);
301 if (pty->master_fd >= 0) {
95c47834 302 if (geteuid() == 0 ||
270d2e8d 303 access(master_name, R_OK | W_OK) == 0) {
304 /*
305 * We must also check at this point that we are
306 * able to open the slave side of the pty. We
307 * wouldn't want to allocate the wrong master,
308 * get all the way down to forking, and _then_
309 * find we're unable to open the slave.
310 */
d6fa1947 311 strcpy(pty->name, master_name);
312 pty->name[5] = 't'; /* /dev/ptyXX -> /dev/ttyXX */
270d2e8d 313
db9b7dce 314 cloexec(pty->master_fd);
89e97516 315
d6fa1947 316 if (pty_open_slave(pty) >= 0 &&
317 access(pty->name, R_OK | W_OK) == 0)
270d2e8d 318 goto got_one;
d6fa1947 319 if (pty->slave_fd > 0)
320 close(pty->slave_fd);
321 pty->slave_fd = -1;
270d2e8d 322 }
d6fa1947 323 close(pty->master_fd);
be4f86de 324 }
95c47834 325 }
be4f86de 326
95c47834 327 /* If we get here, we couldn't get a tty at all. */
328 fprintf(stderr, "pterm: unable to open a pseudo-terminal device\n");
329 exit(1);
be4f86de 330
95c47834 331 got_one:
95c47834 332
333 /* We need to chown/chmod the /dev/ttyXX device. */
334 gp = getgrnam("tty");
d6fa1947 335 chown(pty->name, getuid(), gp ? gp->gr_gid : -1);
336 chmod(pty->name, 0600);
be4f86de 337#else
193c8d4a 338
339 const int flags = O_RDWR
340#ifdef O_NOCTTY
341 | O_NOCTTY
342#endif
343 ;
344
345 pty->master_fd = open("/dev/ptmx", flags);
054d8535 346
d6fa1947 347 if (pty->master_fd < 0) {
054d8535 348 perror("/dev/ptmx: open");
349 exit(1);
350 }
351
d6fa1947 352 if (grantpt(pty->master_fd) < 0) {
054d8535 353 perror("grantpt");
354 exit(1);
355 }
356
d6fa1947 357 if (unlockpt(pty->master_fd) < 0) {
054d8535 358 perror("unlockpt");
359 exit(1);
360 }
361
db9b7dce 362 cloexec(pty->master_fd);
89e97516 363
d6fa1947 364 pty->name[FILENAME_MAX-1] = '\0';
365 strncpy(pty->name, ptsname(pty->master_fd), FILENAME_MAX-1);
be4f86de 366#endif
d6fa1947 367
2916fa14 368 {
369 /*
370 * Set the pty master into non-blocking mode.
371 */
f98b8260 372 int fl;
373 fl = fcntl(pty->master_fd, F_GETFL);
374 if (fl != -1 && !(fl & O_NONBLOCK))
375 fcntl(pty->master_fd, F_SETFL, fl | O_NONBLOCK);
2916fa14 376 }
377
d6fa1947 378 if (!ptys_by_fd)
379 ptys_by_fd = newtree234(pty_compare_by_fd);
380 add234(ptys_by_fd, pty);
95c47834 381}
054d8535 382
95c47834 383/*
384 * Pre-initialisation. This is here to get around the fact that GTK
385 * doesn't like being run in setuid/setgid programs (probably
386 * sensibly). So before we initialise GTK - and therefore before we
387 * even process the command line - we check to see if we're running
388 * set[ug]id. If so, we open our pty master _now_, chown it as
389 * necessary, and drop privileges. We can always close it again
390 * later. If we're potentially going to be doing utmp as well, we
391 * also fork off a utmp helper process and communicate with it by
392 * means of a pipe; the utmp helper will keep privileges in order
393 * to clean up utmp when we exit (i.e. when its end of our pipe
394 * closes).
395 */
396void pty_pre_init(void)
397{
d6fa1947 398 Pty pty;
399
d4e1d591 400#ifndef OMIT_UTMP
95c47834 401 pid_t pid;
402 int pipefd[2];
d4e1d591 403#endif
95c47834 404
d6fa1947 405 pty = single_pty = snew(struct pty_tag);
2916fa14 406 bufchain_init(&pty->output_data);
d6fa1947 407
0f33f9d1 408 /* set the child signal handler straight away; it needs to be set
409 * before we ever fork. */
410 putty_signal(SIGCHLD, sigchld_handler);
d6fa1947 411 pty->master_fd = pty->slave_fd = -1;
412#ifndef OMIT_UTMP
413 pty_stamped_utmp = FALSE;
414#endif
95c47834 415
416 if (geteuid() != getuid() || getegid() != getgid()) {
d6fa1947 417 pty_open_master(pty);
39baeaa4 418
95c47834 419#ifndef OMIT_UTMP
dd5517cb 420 /*
421 * Fork off the utmp helper.
422 */
423 if (pipe(pipefd) < 0) {
424 perror("pterm: pipe");
425 exit(1);
426 }
427 cloexec(pipefd[0]);
428 cloexec(pipefd[1]);
429 pid = fork();
430 if (pid < 0) {
431 perror("pterm: fork");
432 exit(1);
433 } else if (pid == 0) {
434 char display[128], buffer[128];
435 int dlen, ret;
436
437 close(pipefd[1]);
438 /*
439 * Now sit here until we receive a display name from the
440 * other end of the pipe, and then stamp utmp. Unstamp utmp
441 * again, and exit, when the pipe closes.
442 */
95c47834 443
dd5517cb 444 dlen = 0;
445 while (1) {
95c47834 446
dd5517cb 447 ret = read(pipefd[0], buffer, lenof(buffer));
448 if (ret <= 0) {
449 cleanup_utmp();
450 _exit(0);
451 } else if (!pty_stamped_utmp) {
452 if (dlen < lenof(display))
453 memcpy(display+dlen, buffer,
454 min(ret, lenof(display)-dlen));
455 if (buffer[ret-1] == '\0') {
456 /*
457 * Now we have a display name. NUL-terminate
458 * it, and stamp utmp.
459 */
460 display[lenof(display)-1] = '\0';
461 /*
462 * Trap as many fatal signals as we can in the
463 * hope of having the best possible chance to
464 * clean up utmp before termination. We are
465 * unfortunately unprotected against SIGKILL,
466 * but that's life.
467 */
468 putty_signal(SIGHUP, fatal_sig_handler);
469 putty_signal(SIGINT, fatal_sig_handler);
470 putty_signal(SIGQUIT, fatal_sig_handler);
471 putty_signal(SIGILL, fatal_sig_handler);
472 putty_signal(SIGABRT, fatal_sig_handler);
473 putty_signal(SIGFPE, fatal_sig_handler);
474 putty_signal(SIGPIPE, fatal_sig_handler);
475 putty_signal(SIGALRM, fatal_sig_handler);
476 putty_signal(SIGTERM, fatal_sig_handler);
477 putty_signal(SIGSEGV, fatal_sig_handler);
478 putty_signal(SIGUSR1, fatal_sig_handler);
479 putty_signal(SIGUSR2, fatal_sig_handler);
755a6d84 480#ifdef SIGBUS
dd5517cb 481 putty_signal(SIGBUS, fatal_sig_handler);
755a6d84 482#endif
483#ifdef SIGPOLL
dd5517cb 484 putty_signal(SIGPOLL, fatal_sig_handler);
755a6d84 485#endif
486#ifdef SIGPROF
dd5517cb 487 putty_signal(SIGPROF, fatal_sig_handler);
755a6d84 488#endif
489#ifdef SIGSYS
dd5517cb 490 putty_signal(SIGSYS, fatal_sig_handler);
755a6d84 491#endif
492#ifdef SIGTRAP
dd5517cb 493 putty_signal(SIGTRAP, fatal_sig_handler);
755a6d84 494#endif
495#ifdef SIGVTALRM
dd5517cb 496 putty_signal(SIGVTALRM, fatal_sig_handler);
755a6d84 497#endif
498#ifdef SIGXCPU
dd5517cb 499 putty_signal(SIGXCPU, fatal_sig_handler);
755a6d84 500#endif
501#ifdef SIGXFSZ
dd5517cb 502 putty_signal(SIGXFSZ, fatal_sig_handler);
755a6d84 503#endif
504#ifdef SIGIO
dd5517cb 505 putty_signal(SIGIO, fatal_sig_handler);
506#endif
507 setup_utmp(pty->name, display);
508 }
509 }
510 }
511 } else {
512 close(pipefd[0]);
513 pty_utmp_helper_pid = pid;
514 pty_utmp_helper_pipe = pipefd[1];
515 }
95c47834 516#endif
95c47834 517 }
95c47834 518
519 /* Drop privs. */
520 {
95c47834 521#ifndef HAVE_NO_SETRESUID
d4e1d591 522 int gid = getgid(), uid = getuid();
95c47834 523 int setresgid(gid_t, gid_t, gid_t);
524 int setresuid(uid_t, uid_t, uid_t);
525 setresgid(gid, gid, gid);
526 setresuid(uid, uid, uid);
527#else
528 setgid(getgid());
529 setuid(getuid());
530#endif
531 }
532}
533
d6fa1947 534int pty_real_select_result(Pty pty, int event, int status)
74aca06d 535{
536 char buf[4096];
537 int ret;
538 int finished = FALSE;
539
d6fa1947 540 if (event < 0) {
74aca06d 541 /*
d6fa1947 542 * We've been called because our child process did
543 * something. `status' tells us what.
74aca06d 544 */
d6fa1947 545 if ((WIFEXITED(status) || WIFSIGNALED(status))) {
74aca06d 546 /*
d6fa1947 547 * The primary child process died. We could keep
548 * the terminal open for remaining subprocesses to
549 * output to, but conventional wisdom seems to feel
550 * that that's the Wrong Thing for an xterm-alike,
551 * so we bail out now (though we don't necessarily
552 * _close_ the window, depending on the state of
553 * Close On Exit). This would be easy enough to
554 * change or make configurable if necessary.
74aca06d 555 */
d6fa1947 556 pty->exit_code = status;
557 pty->child_dead = TRUE;
558 del234(ptys_by_pid, pty);
74aca06d 559 finished = TRUE;
74aca06d 560 }
d6fa1947 561 } else {
562 if (event == 1) {
74aca06d 563
d6fa1947 564 ret = read(pty->master_fd, buf, sizeof(buf));
74aca06d 565
d6fa1947 566 /*
567 * Clean termination condition is that either ret == 0, or ret
568 * < 0 and errno == EIO. Not sure why the latter, but it seems
569 * to happen. Boo.
570 */
571 if (ret == 0 || (ret < 0 && errno == EIO)) {
74aca06d 572 /*
d6fa1947 573 * We assume a clean exit if the pty has closed but the
574 * actual child process hasn't. The only way I can
575 * imagine this happening is if it detaches itself from
576 * the pty and goes daemonic - in which case the
577 * expected usage model would precisely _not_ be for
578 * the pterm window to hang around!
74aca06d 579 */
74aca06d 580 finished = TRUE;
d6fa1947 581 if (!pty->child_dead)
582 pty->exit_code = 0;
583 } else if (ret < 0) {
584 perror("read pty master");
585 exit(1);
586 } else if (ret > 0) {
587 from_backend(pty->frontend, 0, buf, ret);
74aca06d 588 }
2916fa14 589 } else if (event == 2) {
590 /*
591 * Attempt to send data down the pty.
592 */
593 pty_try_write(pty);
594 }
74aca06d 595 }
596
d6fa1947 597 if (finished && !pty->finished) {
4a693cfc 598 int close_on_exit;
599
d6fa1947 600 uxsel_del(pty->master_fd);
601 pty_close(pty);
602 pty->master_fd = -1;
74aca06d 603
d6fa1947 604 pty->finished = TRUE;
74aca06d 605
606 /*
607 * This is a slight layering-violation sort of hack: only
608 * if we're not closing on exit (COE is set to Never, or to
609 * Only On Clean and it wasn't a clean exit) do we output a
610 * `terminated' message.
611 */
4a693cfc 612 close_on_exit = conf_get_int(pty->conf, CONF_close_on_exit);
613 if (close_on_exit == FORCE_OFF ||
614 (close_on_exit == AUTO && pty->exit_code != 0)) {
74aca06d 615 char message[512];
d6fa1947 616 if (WIFEXITED(pty->exit_code))
74aca06d 617 sprintf(message, "\r\n[pterm: process terminated with exit"
d6fa1947 618 " code %d]\r\n", WEXITSTATUS(pty->exit_code));
619 else if (WIFSIGNALED(pty->exit_code))
74aca06d 620#ifdef HAVE_NO_STRSIGNAL
621 sprintf(message, "\r\n[pterm: process terminated on signal"
d6fa1947 622 " %d]\r\n", WTERMSIG(pty->exit_code));
74aca06d 623#else
624 sprintf(message, "\r\n[pterm: process terminated on signal"
d6fa1947 625 " %d (%.400s)]\r\n", WTERMSIG(pty->exit_code),
626 strsignal(WTERMSIG(pty->exit_code)));
74aca06d 627#endif
d6fa1947 628 from_backend(pty->frontend, 0, message, strlen(message));
74aca06d 629 }
39934deb 630
d6fa1947 631 notify_remote_exit(pty->frontend);
74aca06d 632 }
d6fa1947 633
74aca06d 634 return !finished;
635}
636
d6fa1947 637int pty_select_result(int fd, int event)
74aca06d 638{
d6fa1947 639 int ret = TRUE;
640 Pty pty;
641
642 if (fd == pty_signal_pipe[0]) {
643 pid_t pid;
d6fa1947 644 int status;
645 char c[1];
646
ecb25722 647 if (read(pty_signal_pipe[0], c, 1) <= 0)
648 /* ignore error */;
649 /* ignore its value; it'll be `x' */
d6fa1947 650
651 do {
652 pid = waitpid(-1, &status, WNOHANG);
653
d6fa1947 654 pty = find234(ptys_by_pid, &pid, pty_find_by_pid);
655
656 if (pty)
657 ret = ret && pty_real_select_result(pty, -1, status);
658 } while (pid > 0);
659 } else {
660 pty = find234(ptys_by_fd, &fd, pty_find_by_fd);
661
662 if (pty)
663 ret = ret && pty_real_select_result(pty, event, 0);
664 }
665
666 return ret;
667}
668
669static void pty_uxsel_setup(Pty pty)
670{
2916fa14 671 int rwx;
672
673 rwx = 1; /* always want to read from pty */
674 if (bufchain_size(&pty->output_data))
675 rwx |= 2; /* might also want to write to it */
676 uxsel_set(pty->master_fd, rwx, pty_select_result);
d6fa1947 677
678 /*
679 * In principle this only needs calling once for all pty
680 * backend instances, but it's simplest just to call it every
681 * time; uxsel won't mind.
682 */
74aca06d 683 uxsel_set(pty_signal_pipe[0], 1, pty_select_result);
684}
685
95c47834 686/*
687 * Called to set up the pty.
688 *
689 * Returns an error message, or NULL on success.
690 *
691 * Also places the canonical host name into `realhost'. It must be
692 * freed by the caller.
693 */
4a693cfc 694static const char *pty_init(void *frontend, void **backend_handle, Conf *conf,
79bf227b 695 char *host, int port, char **realhost, int nodelay,
696 int keepalive)
95c47834 697{
698 int slavefd;
699 pid_t pid, pgrp;
c13772b1 700#ifndef NOT_X_WINDOWS /* for Mac OS X native compilation */
7af753e6 701 long windowid;
c13772b1 702#endif
d6fa1947 703 Pty pty;
95c47834 704
d6fa1947 705 if (single_pty) {
706 pty = single_pty;
707 } else {
708 pty = snew(struct pty_tag);
709 pty->master_fd = pty->slave_fd = -1;
710#ifndef OMIT_UTMP
711 pty_stamped_utmp = FALSE;
712#endif
713 }
714
715 pty->frontend = frontend;
28d00fe4 716 *backend_handle = NULL; /* we can't sensibly use this, sadly */
717
4a693cfc 718 pty->conf = conf_copy(conf);
719 pty->term_width = conf_get_int(conf, CONF_width);
720 pty->term_height = conf_get_int(conf, CONF_height);
f278d6f8 721
d6fa1947 722 if (pty->master_fd < 0)
723 pty_open_master(pty);
95c47834 724
725 /*
726 * Set the backspace character to be whichever of ^H and ^? is
727 * specified by bksp_is_delete.
728 */
729 {
730 struct termios attrs;
d6fa1947 731 tcgetattr(pty->master_fd, &attrs);
4a693cfc 732 attrs.c_cc[VERASE] = conf_get_int(conf, CONF_bksp_is_delete)
733 ? '\177' : '\010';
d6fa1947 734 tcsetattr(pty->master_fd, TCSANOW, &attrs);
95c47834 735 }
736
d4e1d591 737#ifndef OMIT_UTMP
95c47834 738 /*
739 * Stamp utmp (that is, tell the utmp helper process to do so),
740 * or not.
741 */
4a693cfc 742 if (!conf_get_int(conf, CONF_stamp_utmp)) {
95c47834 743 close(pty_utmp_helper_pipe); /* just let the child process die */
58dcb876 744 pty_utmp_helper_pipe = -1;
dd5517cb 745 } else if (pty_utmp_helper_pipe >= 0) {
d6fa1947 746 char *location = get_x_display(pty->frontend);
95c47834 747 int len = strlen(location)+1, pos = 0; /* +1 to include NUL */
748 while (pos < len) {
749 int ret = write(pty_utmp_helper_pipe, location+pos, len - pos);
750 if (ret < 0) {
751 perror("pterm: writing to utmp helper process");
752 close(pty_utmp_helper_pipe); /* arrgh, just give up */
58dcb876 753 pty_utmp_helper_pipe = -1;
95c47834 754 break;
755 }
756 pos += ret;
757 }
758 }
d4e1d591 759#endif
755a6d84 760
c13772b1 761#ifndef NOT_X_WINDOWS /* for Mac OS X native compilation */
d6fa1947 762 windowid = get_windowid(pty->frontend);
c13772b1 763#endif
7af753e6 764
755a6d84 765 /*
054d8535 766 * Fork and execute the command.
767 */
768 pid = fork();
769 if (pid < 0) {
770 perror("fork");
88e6b9ca 771 exit(1);
054d8535 772 }
773
774 if (pid == 0) {
054d8535 775 /*
776 * We are the child.
777 */
d37c2d81 778
d6fa1947 779 slavefd = pty_open_slave(pty);
d37c2d81 780 if (slavefd < 0) {
781 perror("slave pty: open");
0f33f9d1 782 _exit(1);
d37c2d81 783 }
784
d6fa1947 785 close(pty->master_fd);
054d8535 786 fcntl(slavefd, F_SETFD, 0); /* don't close on exec */
787 dup2(slavefd, 0);
788 dup2(slavefd, 1);
789 dup2(slavefd, 2);
90f2ed42 790 close(slavefd);
054d8535 791 setsid();
bbaa7993 792#ifdef TIOCSCTTY
211b4228 793 ioctl(0, TIOCSCTTY, 1);
bbaa7993 794#endif
d37c2d81 795 pgrp = getpid();
3a7c6b9e 796 tcsetpgrp(0, pgrp);
ea0716c6 797 setpgid(pgrp, pgrp);
d6fa1947 798 close(open(pty->name, O_WRONLY, 0));
ea0716c6 799 setpgid(pgrp, pgrp);
fe9548aa 800 {
4a693cfc 801 char *term_env_var = dupprintf("TERM=%s",
802 conf_get_str(conf, CONF_termtype));
fe9548aa 803 putenv(term_env_var);
30d1257c 804 /* We mustn't free term_env_var, as putenv links it into the
805 * environment in place.
806 */
fe9548aa 807 }
c13772b1 808#ifndef NOT_X_WINDOWS /* for Mac OS X native compilation */
7af753e6 809 {
30d1257c 810 char *windowid_env_var = dupprintf("WINDOWID=%ld", windowid);
7af753e6 811 putenv(windowid_env_var);
30d1257c 812 /* We mustn't free windowid_env_var, as putenv links it into the
813 * environment in place.
814 */
7af753e6 815 }
c13772b1 816#endif
73feed4f 817 {
4a693cfc 818 char *key, *val;
819
820 for (val = conf_get_str_strs(conf, CONF_environmt, NULL, &key);
821 val != NULL;
822 val = conf_get_str_strs(conf, CONF_environmt, key, &key)) {
823 char *varval = dupcat(key, "=", val, NULL);
73feed4f 824 putenv(varval);
825 /*
826 * We must not free varval, since putenv links it
827 * into the environment _in place_. Weird, but
828 * there we go. Memory usage will be rationalised
829 * as soon as we exec anyway.
830 */
831 }
832 }
833
8bf5c419 834 /*
203abf9e 835 * SIGINT, SIGQUIT and SIGPIPE may have been set to ignored by
836 * our parent, particularly by things like sh -c 'pterm &' and
837 * some window or session managers. SIGCHLD, meanwhile, was
838 * blocked during pt_main() startup. Reverse all this for our
839 * child process.
8bf5c419 840 */
0f33f9d1 841 putty_signal(SIGINT, SIG_DFL);
842 putty_signal(SIGQUIT, SIG_DFL);
203abf9e 843 putty_signal(SIGPIPE, SIG_DFL);
15b5d988 844 block_signal(SIGCHLD, 0);
34826e4a 845 if (pty_argv) {
846 /*
847 * Exec the exact argument list we were given.
848 */
6169c758 849 execvp(pty_argv[0], pty_argv);
34826e4a 850 /*
851 * If that fails, and if we had exactly one argument, pass
852 * that argument to $SHELL -c.
853 *
854 * This arranges that we can _either_ follow 'pterm -e'
855 * with a list of argv elements to be fed directly to
856 * exec, _or_ with a single argument containing a command
857 * to be parsed by a shell (but, in cases of doubt, the
858 * former is more reliable).
859 *
860 * A quick survey of other terminal emulators' -e options
861 * (as of Debian squeeze) suggests that:
862 *
863 * - xterm supports both modes, more or less like this
864 * - gnome-terminal will only accept a one-string shell command
865 * - Eterm, kterm and rxvt will only accept a list of
866 * argv elements (as did older versions of pterm).
867 *
868 * It therefore seems important to support both usage
869 * modes in order to be a drop-in replacement for either
870 * xterm or gnome-terminal, and hence for anyone's
871 * plausible uses of the Debian-style alias
872 * 'x-terminal-emulator'...
873 */
874 if (pty_argv[1] == NULL) {
875 char *shell = getenv("SHELL");
876 if (shell)
877 execl(shell, shell, "-c", pty_argv[0], (void *)NULL);
878 }
879 } else {
c8ee61b9 880 char *shell = getenv("SHELL");
881 char *shellname;
4a693cfc 882 if (conf_get_int(conf, CONF_login_shell)) {
c8ee61b9 883 char *p = strrchr(shell, '/');
3d88e64d 884 shellname = snewn(2+strlen(shell), char);
c8ee61b9 885 p = p ? p+1 : shell;
886 sprintf(shellname, "-%s", p);
887 } else
888 shellname = shell;
30264db9 889 execl(getenv("SHELL"), shellname, (void *)NULL);
c8ee61b9 890 }
891
054d8535 892 /*
893 * If we're here, exec has gone badly foom.
894 */
895 perror("exec");
0f33f9d1 896 _exit(127);
054d8535 897 } else {
d6fa1947 898 pty->child_pid = pid;
899 pty->child_dead = FALSE;
900 pty->finished = FALSE;
901 if (pty->slave_fd > 0)
902 close(pty->slave_fd);
903 if (!ptys_by_pid)
904 ptys_by_pid = newtree234(pty_compare_by_pid);
905 add234(ptys_by_pid, pty);
270d2e8d 906 }
054d8535 907
90f2ed42 908 if (pty_signal_pipe[0] < 0) {
909 if (pipe(pty_signal_pipe) < 0) {
910 perror("pipe");
911 exit(1);
912 }
913 cloexec(pty_signal_pipe[0]);
914 cloexec(pty_signal_pipe[1]);
74aca06d 915 }
d6fa1947 916 pty_uxsel_setup(pty);
917
918 *backend_handle = pty;
74aca06d 919
5617c1e6 920 *realhost = dupprintf("\0");
921
1709795f 922 return NULL;
923}
924
4a693cfc 925static void pty_reconfig(void *handle, Conf *conf)
86916870 926{
d6fa1947 927 Pty pty = (Pty)handle;
6b0eeb4e 928 /*
929 * We don't have much need to reconfigure this backend, but
930 * unfortunately we do need to pick up the setting of Close On
931 * Exit so we know whether to give a `terminated' message.
932 */
4a693cfc 933 conf_copy_into(pty->conf, conf);
86916870 934}
935
936/*
6b0eeb4e 937 * Stub routine (never called in pterm).
cb60dcb3 938 */
939static void pty_free(void *handle)
940{
d6fa1947 941 Pty pty = (Pty)handle;
942
943 /* Either of these may fail `not found'. That's fine with us. */
944 del234(ptys_by_pid, pty);
945 del234(ptys_by_fd, pty);
946
947 sfree(pty);
cb60dcb3 948}
949
2916fa14 950static void pty_try_write(Pty pty)
951{
952 void *data;
953 int len, ret;
954
955 assert(pty->master_fd >= 0);
956
957 while (bufchain_size(&pty->output_data) > 0) {
958 bufchain_prefix(&pty->output_data, &data, &len);
959 ret = write(pty->master_fd, data, len);
960
961 if (ret < 0 && (errno == EWOULDBLOCK)) {
962 /*
963 * We've sent all we can for the moment.
964 */
965 break;
966 }
967 if (ret < 0) {
968 perror("write pty master");
969 exit(1);
970 }
971 bufchain_consume(&pty->output_data, ret);
972 }
973
974 pty_uxsel_setup(pty);
975}
976
cb60dcb3 977/*
1709795f 978 * Called to send data down the pty.
979 */
28d00fe4 980static int pty_send(void *handle, char *buf, int len)
1709795f 981{
d6fa1947 982 Pty pty = (Pty)handle;
983
984 if (pty->master_fd < 0)
2916fa14 985 return 0; /* ignore all writes if fd closed */
90cfd8f4 986
2916fa14 987 bufchain_add(&pty->output_data, buf, len);
988 pty_try_write(pty);
989
990 return bufchain_size(&pty->output_data);
1709795f 991}
992
d6fa1947 993static void pty_close(Pty pty)
90cfd8f4 994{
d6fa1947 995 if (pty->master_fd >= 0) {
996 close(pty->master_fd);
997 pty->master_fd = -1;
90cfd8f4 998 }
d4e1d591 999#ifndef OMIT_UTMP
58dcb876 1000 if (pty_utmp_helper_pipe >= 0) {
1001 close(pty_utmp_helper_pipe); /* this causes utmp to be cleaned up */
1002 pty_utmp_helper_pipe = -1;
1003 }
d4e1d591 1004#endif
90cfd8f4 1005}
1006
1709795f 1007/*
1008 * Called to query the current socket sendability status.
1009 */
28d00fe4 1010static int pty_sendbuffer(void *handle)
1709795f 1011{
d6fa1947 1012 /* Pty pty = (Pty)handle; */
1709795f 1013 return 0;
1014}
1015
1016/*
1017 * Called to set the size of the window
1018 */
28d00fe4 1019static void pty_size(void *handle, int width, int height)
1709795f 1020{
d6fa1947 1021 Pty pty = (Pty)handle;
88e6b9ca 1022 struct winsize size;
1023
d6fa1947 1024 pty->term_width = width;
1025 pty->term_height = height;
f278d6f8 1026
d6fa1947 1027 size.ws_row = (unsigned short)pty->term_height;
1028 size.ws_col = (unsigned short)pty->term_width;
1029 size.ws_xpixel = (unsigned short) pty->term_width *
1030 font_dimension(pty->frontend, 0);
1031 size.ws_ypixel = (unsigned short) pty->term_height *
1032 font_dimension(pty->frontend, 1);
1033 ioctl(pty->master_fd, TIOCSWINSZ, (void *)&size);
1709795f 1034 return;
1035}
1036
1037/*
1038 * Send special codes.
1039 */
28d00fe4 1040static void pty_special(void *handle, Telnet_Special code)
1709795f 1041{
d6fa1947 1042 /* Pty pty = (Pty)handle; */
1709795f 1043 /* Do nothing! */
1044 return;
1045}
1046
125105d1 1047/*
1048 * Return a list of the special codes that make sense in this
1049 * protocol.
1050 */
1051static const struct telnet_special *pty_get_specials(void *handle)
1052{
d6fa1947 1053 /* Pty pty = (Pty)handle; */
125105d1 1054 /*
1055 * Hmm. When I get round to having this actually usable, it
1056 * might be quite nice to have the ability to deliver a few
1057 * well chosen signals to the child process - SIGINT, SIGTERM,
1058 * SIGKILL at least.
1059 */
1060 return NULL;
1061}
1062
6226c939 1063static int pty_connected(void *handle)
1709795f 1064{
d6fa1947 1065 /* Pty pty = (Pty)handle; */
6226c939 1066 return TRUE;
1709795f 1067}
1068
28d00fe4 1069static int pty_sendok(void *handle)
1709795f 1070{
d6fa1947 1071 /* Pty pty = (Pty)handle; */
1709795f 1072 return 1;
1073}
1074
28d00fe4 1075static void pty_unthrottle(void *handle, int backlog)
1709795f 1076{
d6fa1947 1077 /* Pty pty = (Pty)handle; */
1709795f 1078 /* do nothing */
1079}
1080
28d00fe4 1081static int pty_ldisc(void *handle, int option)
1709795f 1082{
d6fa1947 1083 /* Pty pty = (Pty)handle; */
1709795f 1084 return 0; /* neither editing nor echoing */
1085}
1086
b9d7bcad 1087static void pty_provide_ldisc(void *handle, void *ldisc)
1088{
d6fa1947 1089 /* Pty pty = (Pty)handle; */
b9d7bcad 1090 /* This is a stub. */
1091}
1092
a8327734 1093static void pty_provide_logctx(void *handle, void *logctx)
1094{
d6fa1947 1095 /* Pty pty = (Pty)handle; */
a8327734 1096 /* This is a stub. */
1097}
1098
28d00fe4 1099static int pty_exitcode(void *handle)
1709795f 1100{
d6fa1947 1101 Pty pty = (Pty)handle;
1102 if (!pty->finished)
90cfd8f4 1103 return -1; /* not dead yet */
1104 else
d6fa1947 1105 return pty->exit_code;
1709795f 1106}
1107
f89c3294 1108static int pty_cfg_info(void *handle)
1109{
d6fa1947 1110 /* Pty pty = (Pty)handle; */
f89c3294 1111 return 0;
1112}
1113
1709795f 1114Backend pty_backend = {
1115 pty_init,
cb60dcb3 1116 pty_free,
86916870 1117 pty_reconfig,
1709795f 1118 pty_send,
1119 pty_sendbuffer,
1120 pty_size,
1121 pty_special,
125105d1 1122 pty_get_specials,
6226c939 1123 pty_connected,
1709795f 1124 pty_exitcode,
1125 pty_sendok,
1126 pty_ldisc,
b9d7bcad 1127 pty_provide_ldisc,
a8327734 1128 pty_provide_logctx,
1709795f 1129 pty_unthrottle,
f89c3294 1130 pty_cfg_info,
9e164d82 1131 "pty",
1132 -1,
a4451dd1 1133 0
1709795f 1134};