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