Set the 'must_close_session' flag at the end of close_session(), so
[u/mdw/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 {
79 Config cfg;
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
115393d8 170static pid_t pty_utmp_helper_pid;
171static int pty_utmp_helper_pipe;
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
d6fa1947 338 pty->master_fd = open("/dev/ptmx", O_RDWR);
054d8535 339
d6fa1947 340 if (pty->master_fd < 0) {
054d8535 341 perror("/dev/ptmx: open");
342 exit(1);
343 }
344
d6fa1947 345 if (grantpt(pty->master_fd) < 0) {
054d8535 346 perror("grantpt");
347 exit(1);
348 }
349
d6fa1947 350 if (unlockpt(pty->master_fd) < 0) {
054d8535 351 perror("unlockpt");
352 exit(1);
353 }
354
db9b7dce 355 cloexec(pty->master_fd);
89e97516 356
d6fa1947 357 pty->name[FILENAME_MAX-1] = '\0';
358 strncpy(pty->name, ptsname(pty->master_fd), FILENAME_MAX-1);
be4f86de 359#endif
d6fa1947 360
2916fa14 361 {
362 /*
363 * Set the pty master into non-blocking mode.
364 */
f98b8260 365 int fl;
366 fl = fcntl(pty->master_fd, F_GETFL);
367 if (fl != -1 && !(fl & O_NONBLOCK))
368 fcntl(pty->master_fd, F_SETFL, fl | O_NONBLOCK);
2916fa14 369 }
370
d6fa1947 371 if (!ptys_by_fd)
372 ptys_by_fd = newtree234(pty_compare_by_fd);
373 add234(ptys_by_fd, pty);
95c47834 374}
054d8535 375
95c47834 376/*
377 * Pre-initialisation. This is here to get around the fact that GTK
378 * doesn't like being run in setuid/setgid programs (probably
379 * sensibly). So before we initialise GTK - and therefore before we
380 * even process the command line - we check to see if we're running
381 * set[ug]id. If so, we open our pty master _now_, chown it as
382 * necessary, and drop privileges. We can always close it again
383 * later. If we're potentially going to be doing utmp as well, we
384 * also fork off a utmp helper process and communicate with it by
385 * means of a pipe; the utmp helper will keep privileges in order
386 * to clean up utmp when we exit (i.e. when its end of our pipe
387 * closes).
388 */
389void pty_pre_init(void)
390{
d6fa1947 391 Pty pty;
392
d4e1d591 393#ifndef OMIT_UTMP
95c47834 394 pid_t pid;
395 int pipefd[2];
d4e1d591 396#endif
95c47834 397
d6fa1947 398 pty = single_pty = snew(struct pty_tag);
2916fa14 399 bufchain_init(&pty->output_data);
d6fa1947 400
0f33f9d1 401 /* set the child signal handler straight away; it needs to be set
402 * before we ever fork. */
403 putty_signal(SIGCHLD, sigchld_handler);
d6fa1947 404 pty->master_fd = pty->slave_fd = -1;
405#ifndef OMIT_UTMP
406 pty_stamped_utmp = FALSE;
407#endif
95c47834 408
409 if (geteuid() != getuid() || getegid() != getgid()) {
d6fa1947 410 pty_open_master(pty);
39baeaa4 411 }
412
95c47834 413#ifndef OMIT_UTMP
39baeaa4 414 /*
95c47834 415 * Fork off the utmp helper.
755a6d84 416 */
95c47834 417 if (pipe(pipefd) < 0) {
418 perror("pterm: pipe");
419 exit(1);
420 }
90f2ed42 421 cloexec(pipefd[0]);
422 cloexec(pipefd[1]);
95c47834 423 pid = fork();
424 if (pid < 0) {
425 perror("pterm: fork");
426 exit(1);
427 } else if (pid == 0) {
428 char display[128], buffer[128];
429 int dlen, ret;
430
431 close(pipefd[1]);
432 /*
433 * Now sit here until we receive a display name from the
434 * other end of the pipe, and then stamp utmp. Unstamp utmp
435 * again, and exit, when the pipe closes.
436 */
437
438 dlen = 0;
439 while (1) {
440
441 ret = read(pipefd[0], buffer, lenof(buffer));
442 if (ret <= 0) {
443 cleanup_utmp();
0f33f9d1 444 _exit(0);
95c47834 445 } else if (!pty_stamped_utmp) {
446 if (dlen < lenof(display))
447 memcpy(display+dlen, buffer,
448 min(ret, lenof(display)-dlen));
449 if (buffer[ret-1] == '\0') {
450 /*
451 * Now we have a display name. NUL-terminate
452 * it, and stamp utmp.
453 */
454 display[lenof(display)-1] = '\0';
455 /*
456 * Trap as many fatal signals as we can in the
457 * hope of having the best possible chance to
458 * clean up utmp before termination. We are
459 * unfortunately unprotected against SIGKILL,
460 * but that's life.
461 */
0f33f9d1 462 putty_signal(SIGHUP, fatal_sig_handler);
463 putty_signal(SIGINT, fatal_sig_handler);
464 putty_signal(SIGQUIT, fatal_sig_handler);
465 putty_signal(SIGILL, fatal_sig_handler);
466 putty_signal(SIGABRT, fatal_sig_handler);
467 putty_signal(SIGFPE, fatal_sig_handler);
468 putty_signal(SIGPIPE, fatal_sig_handler);
469 putty_signal(SIGALRM, fatal_sig_handler);
470 putty_signal(SIGTERM, fatal_sig_handler);
471 putty_signal(SIGSEGV, fatal_sig_handler);
472 putty_signal(SIGUSR1, fatal_sig_handler);
473 putty_signal(SIGUSR2, fatal_sig_handler);
755a6d84 474#ifdef SIGBUS
0f33f9d1 475 putty_signal(SIGBUS, fatal_sig_handler);
755a6d84 476#endif
477#ifdef SIGPOLL
0f33f9d1 478 putty_signal(SIGPOLL, fatal_sig_handler);
755a6d84 479#endif
480#ifdef SIGPROF
0f33f9d1 481 putty_signal(SIGPROF, fatal_sig_handler);
755a6d84 482#endif
483#ifdef SIGSYS
0f33f9d1 484 putty_signal(SIGSYS, fatal_sig_handler);
755a6d84 485#endif
486#ifdef SIGTRAP
0f33f9d1 487 putty_signal(SIGTRAP, fatal_sig_handler);
755a6d84 488#endif
489#ifdef SIGVTALRM
0f33f9d1 490 putty_signal(SIGVTALRM, fatal_sig_handler);
755a6d84 491#endif
492#ifdef SIGXCPU
0f33f9d1 493 putty_signal(SIGXCPU, fatal_sig_handler);
755a6d84 494#endif
495#ifdef SIGXFSZ
0f33f9d1 496 putty_signal(SIGXFSZ, fatal_sig_handler);
755a6d84 497#endif
498#ifdef SIGIO
0f33f9d1 499 putty_signal(SIGIO, fatal_sig_handler);
95c47834 500#endif
d6fa1947 501 setup_utmp(pty->name, display);
95c47834 502 }
503 }
504 }
505 } else {
506 close(pipefd[0]);
507 pty_utmp_helper_pid = pid;
508 pty_utmp_helper_pipe = pipefd[1];
509 }
755a6d84 510#endif
95c47834 511
512 /* Drop privs. */
513 {
95c47834 514#ifndef HAVE_NO_SETRESUID
d4e1d591 515 int gid = getgid(), uid = getuid();
95c47834 516 int setresgid(gid_t, gid_t, gid_t);
517 int setresuid(uid_t, uid_t, uid_t);
518 setresgid(gid, gid, gid);
519 setresuid(uid, uid, uid);
520#else
521 setgid(getgid());
522 setuid(getuid());
523#endif
524 }
525}
526
d6fa1947 527int pty_real_select_result(Pty pty, int event, int status)
74aca06d 528{
529 char buf[4096];
530 int ret;
531 int finished = FALSE;
532
d6fa1947 533 if (event < 0) {
74aca06d 534 /*
d6fa1947 535 * We've been called because our child process did
536 * something. `status' tells us what.
74aca06d 537 */
d6fa1947 538 if ((WIFEXITED(status) || WIFSIGNALED(status))) {
74aca06d 539 /*
d6fa1947 540 * The primary child process died. We could keep
541 * the terminal open for remaining subprocesses to
542 * output to, but conventional wisdom seems to feel
543 * that that's the Wrong Thing for an xterm-alike,
544 * so we bail out now (though we don't necessarily
545 * _close_ the window, depending on the state of
546 * Close On Exit). This would be easy enough to
547 * change or make configurable if necessary.
74aca06d 548 */
d6fa1947 549 pty->exit_code = status;
550 pty->child_dead = TRUE;
551 del234(ptys_by_pid, pty);
74aca06d 552 finished = TRUE;
74aca06d 553 }
d6fa1947 554 } else {
555 if (event == 1) {
74aca06d 556
d6fa1947 557 ret = read(pty->master_fd, buf, sizeof(buf));
74aca06d 558
d6fa1947 559 /*
560 * Clean termination condition is that either ret == 0, or ret
561 * < 0 and errno == EIO. Not sure why the latter, but it seems
562 * to happen. Boo.
563 */
564 if (ret == 0 || (ret < 0 && errno == EIO)) {
74aca06d 565 /*
d6fa1947 566 * We assume a clean exit if the pty has closed but the
567 * actual child process hasn't. The only way I can
568 * imagine this happening is if it detaches itself from
569 * the pty and goes daemonic - in which case the
570 * expected usage model would precisely _not_ be for
571 * the pterm window to hang around!
74aca06d 572 */
74aca06d 573 finished = TRUE;
d6fa1947 574 if (!pty->child_dead)
575 pty->exit_code = 0;
576 } else if (ret < 0) {
577 perror("read pty master");
578 exit(1);
579 } else if (ret > 0) {
580 from_backend(pty->frontend, 0, buf, ret);
74aca06d 581 }
2916fa14 582 } else if (event == 2) {
583 /*
584 * Attempt to send data down the pty.
585 */
586 pty_try_write(pty);
587 }
74aca06d 588 }
589
d6fa1947 590 if (finished && !pty->finished) {
591 uxsel_del(pty->master_fd);
592 pty_close(pty);
593 pty->master_fd = -1;
74aca06d 594
d6fa1947 595 pty->finished = TRUE;
74aca06d 596
597 /*
598 * This is a slight layering-violation sort of hack: only
599 * if we're not closing on exit (COE is set to Never, or to
600 * Only On Clean and it wasn't a clean exit) do we output a
601 * `terminated' message.
602 */
d6fa1947 603 if (pty->cfg.close_on_exit == FORCE_OFF ||
604 (pty->cfg.close_on_exit == AUTO && pty->exit_code != 0)) {
74aca06d 605 char message[512];
d6fa1947 606 if (WIFEXITED(pty->exit_code))
74aca06d 607 sprintf(message, "\r\n[pterm: process terminated with exit"
d6fa1947 608 " code %d]\r\n", WEXITSTATUS(pty->exit_code));
609 else if (WIFSIGNALED(pty->exit_code))
74aca06d 610#ifdef HAVE_NO_STRSIGNAL
611 sprintf(message, "\r\n[pterm: process terminated on signal"
d6fa1947 612 " %d]\r\n", WTERMSIG(pty->exit_code));
74aca06d 613#else
614 sprintf(message, "\r\n[pterm: process terminated on signal"
d6fa1947 615 " %d (%.400s)]\r\n", WTERMSIG(pty->exit_code),
616 strsignal(WTERMSIG(pty->exit_code)));
74aca06d 617#endif
d6fa1947 618 from_backend(pty->frontend, 0, message, strlen(message));
74aca06d 619 }
39934deb 620
d6fa1947 621 notify_remote_exit(pty->frontend);
74aca06d 622 }
d6fa1947 623
74aca06d 624 return !finished;
625}
626
d6fa1947 627int pty_select_result(int fd, int event)
74aca06d 628{
d6fa1947 629 int ret = TRUE;
630 Pty pty;
631
632 if (fd == pty_signal_pipe[0]) {
633 pid_t pid;
d6fa1947 634 int status;
635 char c[1];
636
ecb25722 637 if (read(pty_signal_pipe[0], c, 1) <= 0)
638 /* ignore error */;
639 /* ignore its value; it'll be `x' */
d6fa1947 640
641 do {
642 pid = waitpid(-1, &status, WNOHANG);
643
d6fa1947 644 pty = find234(ptys_by_pid, &pid, pty_find_by_pid);
645
646 if (pty)
647 ret = ret && pty_real_select_result(pty, -1, status);
648 } while (pid > 0);
649 } else {
650 pty = find234(ptys_by_fd, &fd, pty_find_by_fd);
651
652 if (pty)
653 ret = ret && pty_real_select_result(pty, event, 0);
654 }
655
656 return ret;
657}
658
659static void pty_uxsel_setup(Pty pty)
660{
2916fa14 661 int rwx;
662
663 rwx = 1; /* always want to read from pty */
664 if (bufchain_size(&pty->output_data))
665 rwx |= 2; /* might also want to write to it */
666 uxsel_set(pty->master_fd, rwx, pty_select_result);
d6fa1947 667
668 /*
669 * In principle this only needs calling once for all pty
670 * backend instances, but it's simplest just to call it every
671 * time; uxsel won't mind.
672 */
74aca06d 673 uxsel_set(pty_signal_pipe[0], 1, pty_select_result);
674}
675
95c47834 676/*
677 * Called to set up the pty.
678 *
679 * Returns an error message, or NULL on success.
680 *
681 * Also places the canonical host name into `realhost'. It must be
682 * freed by the caller.
683 */
cbe2d68f 684static const char *pty_init(void *frontend, void **backend_handle, Config *cfg,
79bf227b 685 char *host, int port, char **realhost, int nodelay,
686 int keepalive)
95c47834 687{
688 int slavefd;
689 pid_t pid, pgrp;
c13772b1 690#ifndef NOT_X_WINDOWS /* for Mac OS X native compilation */
7af753e6 691 long windowid;
c13772b1 692#endif
d6fa1947 693 Pty pty;
95c47834 694
d6fa1947 695 if (single_pty) {
696 pty = single_pty;
697 } else {
698 pty = snew(struct pty_tag);
699 pty->master_fd = pty->slave_fd = -1;
700#ifndef OMIT_UTMP
701 pty_stamped_utmp = FALSE;
702#endif
703 }
704
705 pty->frontend = frontend;
28d00fe4 706 *backend_handle = NULL; /* we can't sensibly use this, sadly */
707
d6fa1947 708 pty->cfg = *cfg; /* structure copy */
709 pty->term_width = cfg->width;
710 pty->term_height = cfg->height;
f278d6f8 711
d6fa1947 712 if (pty->master_fd < 0)
713 pty_open_master(pty);
95c47834 714
715 /*
716 * Set the backspace character to be whichever of ^H and ^? is
717 * specified by bksp_is_delete.
718 */
719 {
720 struct termios attrs;
d6fa1947 721 tcgetattr(pty->master_fd, &attrs);
86916870 722 attrs.c_cc[VERASE] = cfg->bksp_is_delete ? '\177' : '\010';
d6fa1947 723 tcsetattr(pty->master_fd, TCSANOW, &attrs);
95c47834 724 }
725
d4e1d591 726#ifndef OMIT_UTMP
95c47834 727 /*
728 * Stamp utmp (that is, tell the utmp helper process to do so),
729 * or not.
730 */
58dcb876 731 if (!cfg->stamp_utmp) {
95c47834 732 close(pty_utmp_helper_pipe); /* just let the child process die */
58dcb876 733 pty_utmp_helper_pipe = -1;
734 } else {
d6fa1947 735 char *location = get_x_display(pty->frontend);
95c47834 736 int len = strlen(location)+1, pos = 0; /* +1 to include NUL */
737 while (pos < len) {
738 int ret = write(pty_utmp_helper_pipe, location+pos, len - pos);
739 if (ret < 0) {
740 perror("pterm: writing to utmp helper process");
741 close(pty_utmp_helper_pipe); /* arrgh, just give up */
58dcb876 742 pty_utmp_helper_pipe = -1;
95c47834 743 break;
744 }
745 pos += ret;
746 }
747 }
d4e1d591 748#endif
755a6d84 749
c13772b1 750#ifndef NOT_X_WINDOWS /* for Mac OS X native compilation */
d6fa1947 751 windowid = get_windowid(pty->frontend);
c13772b1 752#endif
7af753e6 753
755a6d84 754 /*
054d8535 755 * Fork and execute the command.
756 */
757 pid = fork();
758 if (pid < 0) {
759 perror("fork");
88e6b9ca 760 exit(1);
054d8535 761 }
762
763 if (pid == 0) {
054d8535 764 /*
765 * We are the child.
766 */
d37c2d81 767
d6fa1947 768 slavefd = pty_open_slave(pty);
d37c2d81 769 if (slavefd < 0) {
770 perror("slave pty: open");
0f33f9d1 771 _exit(1);
d37c2d81 772 }
773
d6fa1947 774 close(pty->master_fd);
054d8535 775 fcntl(slavefd, F_SETFD, 0); /* don't close on exec */
776 dup2(slavefd, 0);
777 dup2(slavefd, 1);
778 dup2(slavefd, 2);
90f2ed42 779 close(slavefd);
054d8535 780 setsid();
bbaa7993 781#ifdef TIOCSCTTY
211b4228 782 ioctl(0, TIOCSCTTY, 1);
bbaa7993 783#endif
d37c2d81 784 pgrp = getpid();
3a7c6b9e 785 tcsetpgrp(0, pgrp);
ea0716c6 786 setpgid(pgrp, pgrp);
d6fa1947 787 close(open(pty->name, O_WRONLY, 0));
ea0716c6 788 setpgid(pgrp, pgrp);
fe9548aa 789 {
30d1257c 790 char *term_env_var = dupprintf("TERM=%s", cfg->termtype);
fe9548aa 791 putenv(term_env_var);
30d1257c 792 /* We mustn't free term_env_var, as putenv links it into the
793 * environment in place.
794 */
fe9548aa 795 }
c13772b1 796#ifndef NOT_X_WINDOWS /* for Mac OS X native compilation */
7af753e6 797 {
30d1257c 798 char *windowid_env_var = dupprintf("WINDOWID=%ld", windowid);
7af753e6 799 putenv(windowid_env_var);
30d1257c 800 /* We mustn't free windowid_env_var, as putenv links it into the
801 * environment in place.
802 */
7af753e6 803 }
c13772b1 804#endif
73feed4f 805 {
806 char *e = cfg->environmt;
807 char *var, *varend, *val, *varval;
808 while (*e) {
809 var = e;
810 while (*e && *e != '\t') e++;
811 varend = e;
812 if (*e == '\t') e++;
813 val = e;
814 while (*e) e++;
815 e++;
816
817 varval = dupprintf("%.*s=%s", varend-var, var, val);
818 putenv(varval);
819 /*
820 * We must not free varval, since putenv links it
821 * into the environment _in place_. Weird, but
822 * there we go. Memory usage will be rationalised
823 * as soon as we exec anyway.
824 */
825 }
826 }
827
8bf5c419 828 /*
829 * SIGINT and SIGQUIT may have been set to ignored by our
830 * parent, particularly by things like sh -c 'pterm &' and
15b5d988 831 * some window managers. SIGCHLD, meanwhile, was blocked
832 * during pt_main() startup. Reverse all this for our child
833 * process.
8bf5c419 834 */
0f33f9d1 835 putty_signal(SIGINT, SIG_DFL);
836 putty_signal(SIGQUIT, SIG_DFL);
15b5d988 837 block_signal(SIGCHLD, 0);
6169c758 838 if (pty_argv)
839 execvp(pty_argv[0], pty_argv);
c8ee61b9 840 else {
841 char *shell = getenv("SHELL");
842 char *shellname;
86916870 843 if (cfg->login_shell) {
c8ee61b9 844 char *p = strrchr(shell, '/');
3d88e64d 845 shellname = snewn(2+strlen(shell), char);
c8ee61b9 846 p = p ? p+1 : shell;
847 sprintf(shellname, "-%s", p);
848 } else
849 shellname = shell;
30264db9 850 execl(getenv("SHELL"), shellname, (void *)NULL);
c8ee61b9 851 }
852
054d8535 853 /*
854 * If we're here, exec has gone badly foom.
855 */
856 perror("exec");
0f33f9d1 857 _exit(127);
054d8535 858 } else {
d6fa1947 859 pty->child_pid = pid;
860 pty->child_dead = FALSE;
861 pty->finished = FALSE;
862 if (pty->slave_fd > 0)
863 close(pty->slave_fd);
864 if (!ptys_by_pid)
865 ptys_by_pid = newtree234(pty_compare_by_pid);
866 add234(ptys_by_pid, pty);
270d2e8d 867 }
054d8535 868
90f2ed42 869 if (pty_signal_pipe[0] < 0) {
870 if (pipe(pty_signal_pipe) < 0) {
871 perror("pipe");
872 exit(1);
873 }
874 cloexec(pty_signal_pipe[0]);
875 cloexec(pty_signal_pipe[1]);
74aca06d 876 }
d6fa1947 877 pty_uxsel_setup(pty);
878
879 *backend_handle = pty;
74aca06d 880
5617c1e6 881 *realhost = dupprintf("\0");
882
1709795f 883 return NULL;
884}
885
86916870 886static void pty_reconfig(void *handle, Config *cfg)
887{
d6fa1947 888 Pty pty = (Pty)handle;
6b0eeb4e 889 /*
890 * We don't have much need to reconfigure this backend, but
891 * unfortunately we do need to pick up the setting of Close On
892 * Exit so we know whether to give a `terminated' message.
893 */
d6fa1947 894 pty->cfg = *cfg; /* structure copy */
86916870 895}
896
897/*
6b0eeb4e 898 * Stub routine (never called in pterm).
cb60dcb3 899 */
900static void pty_free(void *handle)
901{
d6fa1947 902 Pty pty = (Pty)handle;
903
904 /* Either of these may fail `not found'. That's fine with us. */
905 del234(ptys_by_pid, pty);
906 del234(ptys_by_fd, pty);
907
908 sfree(pty);
cb60dcb3 909}
910
2916fa14 911static void pty_try_write(Pty pty)
912{
913 void *data;
914 int len, ret;
915
916 assert(pty->master_fd >= 0);
917
918 while (bufchain_size(&pty->output_data) > 0) {
919 bufchain_prefix(&pty->output_data, &data, &len);
920 ret = write(pty->master_fd, data, len);
921
922 if (ret < 0 && (errno == EWOULDBLOCK)) {
923 /*
924 * We've sent all we can for the moment.
925 */
926 break;
927 }
928 if (ret < 0) {
929 perror("write pty master");
930 exit(1);
931 }
932 bufchain_consume(&pty->output_data, ret);
933 }
934
935 pty_uxsel_setup(pty);
936}
937
cb60dcb3 938/*
1709795f 939 * Called to send data down the pty.
940 */
28d00fe4 941static int pty_send(void *handle, char *buf, int len)
1709795f 942{
d6fa1947 943 Pty pty = (Pty)handle;
944
945 if (pty->master_fd < 0)
2916fa14 946 return 0; /* ignore all writes if fd closed */
90cfd8f4 947
2916fa14 948 bufchain_add(&pty->output_data, buf, len);
949 pty_try_write(pty);
950
951 return bufchain_size(&pty->output_data);
1709795f 952}
953
d6fa1947 954static void pty_close(Pty pty)
90cfd8f4 955{
d6fa1947 956 if (pty->master_fd >= 0) {
957 close(pty->master_fd);
958 pty->master_fd = -1;
90cfd8f4 959 }
d4e1d591 960#ifndef OMIT_UTMP
58dcb876 961 if (pty_utmp_helper_pipe >= 0) {
962 close(pty_utmp_helper_pipe); /* this causes utmp to be cleaned up */
963 pty_utmp_helper_pipe = -1;
964 }
d4e1d591 965#endif
90cfd8f4 966}
967
1709795f 968/*
969 * Called to query the current socket sendability status.
970 */
28d00fe4 971static int pty_sendbuffer(void *handle)
1709795f 972{
d6fa1947 973 /* Pty pty = (Pty)handle; */
1709795f 974 return 0;
975}
976
977/*
978 * Called to set the size of the window
979 */
28d00fe4 980static void pty_size(void *handle, int width, int height)
1709795f 981{
d6fa1947 982 Pty pty = (Pty)handle;
88e6b9ca 983 struct winsize size;
984
d6fa1947 985 pty->term_width = width;
986 pty->term_height = height;
f278d6f8 987
d6fa1947 988 size.ws_row = (unsigned short)pty->term_height;
989 size.ws_col = (unsigned short)pty->term_width;
990 size.ws_xpixel = (unsigned short) pty->term_width *
991 font_dimension(pty->frontend, 0);
992 size.ws_ypixel = (unsigned short) pty->term_height *
993 font_dimension(pty->frontend, 1);
994 ioctl(pty->master_fd, TIOCSWINSZ, (void *)&size);
1709795f 995 return;
996}
997
998/*
999 * Send special codes.
1000 */
28d00fe4 1001static void pty_special(void *handle, Telnet_Special code)
1709795f 1002{
d6fa1947 1003 /* Pty pty = (Pty)handle; */
1709795f 1004 /* Do nothing! */
1005 return;
1006}
1007
125105d1 1008/*
1009 * Return a list of the special codes that make sense in this
1010 * protocol.
1011 */
1012static const struct telnet_special *pty_get_specials(void *handle)
1013{
d6fa1947 1014 /* Pty pty = (Pty)handle; */
125105d1 1015 /*
1016 * Hmm. When I get round to having this actually usable, it
1017 * might be quite nice to have the ability to deliver a few
1018 * well chosen signals to the child process - SIGINT, SIGTERM,
1019 * SIGKILL at least.
1020 */
1021 return NULL;
1022}
1023
6226c939 1024static int pty_connected(void *handle)
1709795f 1025{
d6fa1947 1026 /* Pty pty = (Pty)handle; */
6226c939 1027 return TRUE;
1709795f 1028}
1029
28d00fe4 1030static int pty_sendok(void *handle)
1709795f 1031{
d6fa1947 1032 /* Pty pty = (Pty)handle; */
1709795f 1033 return 1;
1034}
1035
28d00fe4 1036static void pty_unthrottle(void *handle, int backlog)
1709795f 1037{
d6fa1947 1038 /* Pty pty = (Pty)handle; */
1709795f 1039 /* do nothing */
1040}
1041
28d00fe4 1042static int pty_ldisc(void *handle, int option)
1709795f 1043{
d6fa1947 1044 /* Pty pty = (Pty)handle; */
1709795f 1045 return 0; /* neither editing nor echoing */
1046}
1047
b9d7bcad 1048static void pty_provide_ldisc(void *handle, void *ldisc)
1049{
d6fa1947 1050 /* Pty pty = (Pty)handle; */
b9d7bcad 1051 /* This is a stub. */
1052}
1053
a8327734 1054static void pty_provide_logctx(void *handle, void *logctx)
1055{
d6fa1947 1056 /* Pty pty = (Pty)handle; */
a8327734 1057 /* This is a stub. */
1058}
1059
28d00fe4 1060static int pty_exitcode(void *handle)
1709795f 1061{
d6fa1947 1062 Pty pty = (Pty)handle;
1063 if (!pty->finished)
90cfd8f4 1064 return -1; /* not dead yet */
1065 else
d6fa1947 1066 return pty->exit_code;
1709795f 1067}
1068
f89c3294 1069static int pty_cfg_info(void *handle)
1070{
d6fa1947 1071 /* Pty pty = (Pty)handle; */
f89c3294 1072 return 0;
1073}
1074
1709795f 1075Backend pty_backend = {
1076 pty_init,
cb60dcb3 1077 pty_free,
86916870 1078 pty_reconfig,
1709795f 1079 pty_send,
1080 pty_sendbuffer,
1081 pty_size,
1082 pty_special,
125105d1 1083 pty_get_specials,
6226c939 1084 pty_connected,
1709795f 1085 pty_exitcode,
1086 pty_sendok,
1087 pty_ldisc,
b9d7bcad 1088 pty_provide_ldisc,
a8327734 1089 pty_provide_logctx,
1709795f 1090 pty_unthrottle,
f89c3294 1091 pty_cfg_info,
9e164d82 1092 "pty",
1093 -1,
a4451dd1 1094 0
1709795f 1095};