1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Handling of pipes, child processes, temporary files, file enwrapping
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2013 Steffen "Daode" Nurpmeso <sdaoden@users.sf.net>.
8 * Copyright (c) 1980, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 #ifndef HAVE_AMALGAMATION
69 static struct fp
*fp_head
;
78 static struct child
*_popen_child
;
80 static int scan_mode(const char *mode
, int *omode
);
81 static void register_file(FILE *fp
, int omode
, int ispipe
, int pid
,
82 int compressed
, const char *realfile
, long offset
);
83 static enum okay
compress(struct fp
*fpp
);
84 static int decompress(int compression
, int infd
, int outfd
);
85 static enum okay
unregister_file(FILE *fp
);
86 static int file_pid(FILE *fp
);
87 static int wait_command(int pid
);
88 static struct child
*findchild(int pid
);
89 static void delchild(struct child
*cp
);
92 * Provide BSD-like signal() on all systems.
95 safe_signal(int signum
, sighandler_type handler
)
97 struct sigaction nact
, oact
;
99 nact
.sa_handler
= handler
;
100 sigemptyset(&nact
.sa_mask
);
103 nact
.sa_flags
|= SA_RESTART
;
105 if (sigaction(signum
, &nact
, &oact
) != 0)
107 return oact
.sa_handler
;
111 scan_mode(const char *mode
, int *omode
)
114 if (!strcmp(mode
, "r")) {
116 } else if (!strcmp(mode
, "w")) {
117 *omode
= O_WRONLY
| O_CREAT
| O_TRUNC
;
118 } else if (!strcmp(mode
, "wx")) {
119 *omode
= O_WRONLY
| O_CREAT
| O_EXCL
;
120 } else if (!strcmp(mode
, "a")) {
121 *omode
= O_WRONLY
| O_APPEND
| O_CREAT
;
122 } else if (!strcmp(mode
, "a+")) {
123 *omode
= O_RDWR
| O_APPEND
;
124 } else if (!strcmp(mode
, "r+")) {
126 } else if (!strcmp(mode
, "w+")) {
127 *omode
= O_RDWR
| O_CREAT
| O_EXCL
;
129 fprintf(stderr
, tr(152,
130 "Internal error: bad stdio open mode %s\n"), mode
);
132 *omode
= 0; /* (silence CC) */
139 safe_fopen(const char *file
, const char *mode
, int *omode
)
143 if (scan_mode(mode
, omode
) < 0)
145 if ((fd
= open(file
, *omode
, 0666)) < 0)
147 return fdopen(fd
, mode
);
151 Fopen(const char *file
, const char *mode
)
156 if ((fp
= safe_fopen(file
, mode
, &omode
)) != NULL
) {
157 (void)fcntl(fileno(fp
), F_SETFD
, FD_CLOEXEC
);
158 register_file(fp
, omode
, 0, 0, FP_UNCOMPRESSED
, NULL
, 0L);
164 Fdopen(int fd
, const char *mode
)
169 scan_mode(mode
, &omode
);
170 if ((fp
= fdopen(fd
, mode
)) != NULL
) {
171 (void)fcntl(fileno(fp
), F_SETFD
, FD_CLOEXEC
);
172 register_file(fp
, omode
, 0, 0, FP_UNCOMPRESSED
, NULL
, 0L);
181 if (unregister_file(fp
) == OKAY
)
185 return i
== 3 ? 0 : EOF
;
189 Zopen(const char *file
, const char *mode
, int *compression
) /* TODO MESS!
190 * TODO maybe we shouldn't be simple and run commands but instead
191 * TODO links against any of available zlib.h, bzlib.h, lzma.h!
192 * TODO even libzip? Much faster, not that much more work, and we're
193 * TODO *so* fixed anyway!!
194 * TODO *or*: make it all hookable via BOXEXTENSION/DECOMPRESS etc.
195 * TODO by the user; but not like this, Coverity went grazy about it */
208 if (scan_mode(mode
, &omode
) < 0)
210 if (compression
== NULL
)
211 compression
= &_compression
;
212 bits
= R_OK
| (omode
== O_RDONLY
? 0 : W_OK
);
213 if (omode
& O_APPEND
&& ((p
= which_protocol(file
)) == PROTO_IMAP
||
214 p
== PROTO_MAILDIR
)) {
215 *compression
= p
== PROTO_IMAP
? FP_IMAP
: FP_MAILDIR
;
216 omode
= O_RDWR
| O_APPEND
| O_CREAT
;
221 if ((extension
= strrchr(file
, '.')) != NULL
) {
223 if (strcmp(extension
, ".gz") == 0)
225 if (strcmp(extension
, ".bz2") == 0)
229 if (access(file
, F_OK
) == 0) {
230 *compression
= FP_UNCOMPRESSED
;
231 return Fopen(file
, mode
);
232 } else if (access(rp
=savecat(file
, ".gz"), bits
) == 0) {
233 gzip
: *compression
= FP_GZIPPED
;
234 } else if (access(rp
=savecat(file
, ".bz2"), bits
) == 0) {
235 bz2
: *compression
= FP_BZIP2ED
;
237 *compression
= FP_UNCOMPRESSED
;
238 return Fopen(file
, mode
);
240 if (access(rp
, W_OK
) < 0)
241 *compression
|= FP_READONLY
;
243 if ((infd
= open(rp
, bits
& W_OK
? O_RDWR
: O_RDONLY
)) < 0
244 && ((omode
&O_CREAT
) == 0 || errno
!= ENOENT
))
246 open
: if ((outf
= Ftemp(&tempfn
, "Rz", "w+", 0600, 0)) == NULL
) {
247 perror(tr(167, "tmpfile"));
255 if (infd
>= 0 || (*compression
&FP_MASK
) == FP_IMAP
||
256 (*compression
&FP_MASK
) == FP_MAILDIR
) {
257 if (decompress(*compression
, infd
, fileno(outf
)) < 0) {
264 if ((infd
= creat(rp
, 0666)) < 0) {
273 if (omode
& O_APPEND
) {
276 if ((flags
= fcntl(fileno(outf
), F_GETFL
)) < 0 ||
277 fcntl(fileno(outf
), F_SETFL
, flags
|O_APPEND
)
278 < 0 || (offset
= ftell(outf
)) < 0) {
287 register_file(outf
, omode
, 0, 0, *compression
, rp
, offset
);
292 Ftemp(char **fn
, char const *prefix
, char const *mode
, int bits
,
300 cp
= smalloc(strlen(tempdir
) + 1 + sizeof("mail") + strlen(prefix
) +
302 cp
= sstpcpy(cp
, tempdir
);
304 cp
= sstpcpy(cp
, "mail");
307 cp
= sstpcpy(cp
, prefix
);
309 sstpcpy(cp
, ".XXXXXX");
312 if ((fd
= mkstemp(*fn
)) < 0)
314 if (bits
!= (S_IRUSR
|S_IWUSR
) && fchmod(fd
, bits
) < 0)
317 if (mktemp(*fn
) == NULL
)
319 if ((fd
= open(*fn
, O_CREAT
|O_EXCL
|O_RDWR
, bits
)) < 0)
324 fp
= Fdopen(fd
, mode
);
326 (void)fcntl(fd
, F_SETFD
, FD_CLOEXEC
);
327 fp
= fdopen(fd
, mode
);
346 pipe_cloexec(int fd
[2])
352 fcntl(fd
[0], F_SETFD
, FD_CLOEXEC
);
353 fcntl(fd
[1], F_SETFD
, FD_CLOEXEC
);
360 Popen(const char *cmd
, const char *mode
, const char *sh
, int newfd1
)
363 int myside
, hisside
, fd0
, fd1
;
365 char mod
[2] = { '0', '\0' };
369 if (! pipe_cloexec(p
))
375 hisside
= fd1
= p
[WRITE
];
377 } else if (*mode
== 'W') {
379 hisside
= fd0
= p
[READ
];
384 hisside
= fd0
= p
[READ
];
390 pid
= start_command(cmd
, &nset
, fd0
, fd1
, NULL
, NULL
, NULL
);
392 pid
= start_command(sh
, &nset
, fd0
, fd1
, "-c", cmd
, NULL
);
400 if ((fp
= fdopen(myside
, mod
)) != NULL
)
401 register_file(fp
, 0, 1, pid
, FP_UNCOMPRESSED
, NULL
, 0L);
406 Pclose(FILE *ptr
, bool_t dowait
)
414 unregister_file(ptr
);
418 sigaddset(&nset
, SIGINT
);
419 sigaddset(&nset
, SIGHUP
);
420 sigprocmask(SIG_BLOCK
, &nset
, &oset
);
421 pid
= wait_child(pid
);
422 sigprocmask(SIG_SETMASK
, &oset
, (sigset_t
*)NULL
);
429 close_all_files(void)
433 Pclose(fp_head
->fp
, TRU1
);
439 register_file(FILE *fp
, int omode
, int ispipe
, int pid
, int compressed
,
440 const char *realfile
, long offset
)
444 fpp
= (struct fp
*)smalloc(sizeof *fpp
);
450 fpp
->compressed
= compressed
;
451 fpp
->realfile
= realfile
? sstrdup(realfile
) : NULL
;
452 fpp
->offset
= offset
;
457 compress(struct fp
*fpp
)
460 char const *command
[2];
463 if (fpp
->omode
== O_RDONLY
)
467 if (fseek(fpp
->fp
, fpp
->offset
, SEEK_SET
) < 0)
470 if ((fpp
->compressed
&FP_MASK
) == FP_IMAP
) {
471 return imap_append(fpp
->realfile
, fpp
->fp
);
474 if ((fpp
->compressed
&FP_MASK
) == FP_MAILDIR
) {
475 return maildir_append(fpp
->realfile
, fpp
->fp
);
477 if ((outfd
= open(fpp
->realfile
,
478 (fpp
->omode
|O_CREAT
)&~O_EXCL
,
480 fprintf(stderr
, "Fatal: cannot create ");
481 perror(fpp
->realfile
);
484 if ((fpp
->omode
& O_APPEND
) == 0)
486 switch (fpp
->compressed
& FP_MASK
) {
488 command
[0] = "gzip"; command
[1] = "-c"; break;
490 command
[0] = "bzip2"; command
[1] = "-c"; break;
492 command
[0] = "cat"; command
[1] = NULL
; break;
494 if (run_command(command
[0], 0, fileno(fpp
->fp
), outfd
,
495 command
[1], NULL
, NULL
) < 0)
504 decompress(int compression
, int infd
, int outfd
)
506 char const *command
[2];
509 * Note that it is not possible to handle 'pack' or 'compress'
510 * formats because appending data does not work with them.
512 switch (compression
& FP_MASK
) {
513 case FP_GZIPPED
: command
[0] = "gzip"; command
[1] = "-cd"; break;
514 case FP_BZIP2ED
: command
[0] = "bzip2"; command
[1] = "-cd"; break;
515 case FP_IMAP
: return 0;
516 case FP_MAILDIR
: return 0;
517 default: command
[0] = "cat"; command
[1] = NULL
;
519 return run_command(command
[0], 0, infd
, outfd
, command
[1], NULL
, NULL
);
523 unregister_file(FILE *fp
)
528 for (pp
= &fp_head
; (p
= *pp
) != (struct fp
*)NULL
; pp
= &p
->link
)
530 if ((p
->compressed
&FP_MASK
) != FP_UNCOMPRESSED
)
536 panic(tr(153, "Invalid file pointer"));
546 for (p
= fp_head
; p
; p
= p
->link
)
553 * Run a command without a shell, with optional arguments and splicing
554 * of stdin and stdout. The command name can be a sequence of words.
555 * Signals must be handled by the caller.
556 * "Mask" contains the signals to ignore in the new process.
557 * SIGINT is enabled unless it's in the mask.
561 run_command(char const *cmd
, sigset_t
*mask
, int infd
, int outfd
,
562 char const *a0
, char const *a1
, char const *a2
)
566 if ((pid
= start_command(cmd
, mask
, infd
, outfd
, a0
, a1
, a2
)) < 0)
568 return wait_command(pid
);
573 start_command(const char *cmd
, sigset_t
*mask
, int infd
, int outfd
,
574 const char *a0
, const char *a1
, const char *a2
)
578 if ((pid
= fork()) < 0) {
584 int i
= getrawlist(cmd
, strlen(cmd
),
585 argv
, sizeof argv
/ sizeof *argv
, 0);
587 if ((argv
[i
++] = UNCONST(a0
)) != NULL
&&
588 (argv
[i
++] = UNCONST(a1
)) != NULL
&&
589 (argv
[i
++] = UNCONST(a2
)) != NULL
)
591 prepare_child(mask
, infd
, outfd
);
592 execvp(argv
[0], argv
);
600 prepare_child(sigset_t
*nset
, int infd
, int outfd
)
606 * All file descriptors other than 0, 1, and 2 are supposed to be
614 for (i
= 1; i
< NSIG
; i
++)
615 if (sigismember(nset
, i
))
616 safe_signal(i
, SIG_IGN
);
617 if (!sigismember(nset
, SIGINT
))
618 safe_signal(SIGINT
, SIG_DFL
);
621 sigprocmask(SIG_UNBLOCK
, &fset
, (sigset_t
*)NULL
);
625 wait_command(int pid
)
628 if (wait_child(pid
) < 0 && (value("bsdcompat") || value("bsdmsgs"))) {
629 printf(tr(154, "Fatal error in process.\n"));
635 static struct child
*
640 for (cpp
= &_popen_child
; *cpp
!= NULL
&& (*cpp
)->pid
!= pid
;
644 *cpp
= smalloc(sizeof (struct child
));
646 (*cpp
)->done
= (*cpp
)->free
= 0;
653 delchild(struct child
*cp
)
657 for (cpp
= &_popen_child
; *cpp
!= cp
; cpp
= &(*cpp
)->link
)
673 while ((pid
= waitpid(-1, &status
, WNOHANG
)) > 0) {
682 if (pid
== -1 && errno
== EINTR
)
689 * Mark a child as don't care.
695 struct child
*cp
= findchild(pid
);
697 sigaddset(&nset
, SIGCHLD
);
698 sigprocmask(SIG_BLOCK
, &nset
, &oset
);
704 sigprocmask(SIG_SETMASK
, &oset
, (sigset_t
*)NULL
);
708 * Wait for a specific child to die.
712 * This version is correct code, but causes harm on some loosing
713 * systems. So we use the second one instead.
719 struct child
*cp
= findchild(pid
);
721 sigaddset(&nset
, SIGCHLD
);
722 sigprocmask(SIG_BLOCK
, &nset
, &oset
);
726 wait_status
= cp
->status
;
728 sigprocmask(SIG_SETMASK
, &oset
, (sigset_t
*)NULL
);
730 if (WIFEXITED(wait_status
) && (WEXITSTATUS(wait_status
) == 0))
740 struct sigaction nact
, oact
;
742 nact
.sa_handler
= SIG_DFL
;
743 sigemptyset(&nact
.sa_mask
);
744 nact
.sa_flags
= SA_NOCLDSTOP
;
745 sigaction(SIGCHLD
, &nact
, &oact
);
750 term
= wait(&wait_status
);
751 if (term
== -1 && errno
== EINTR
)
753 if (term
== 0 || term
== -1)
755 cp
= findchild(term
);
756 if (cp
->free
|| term
== pid
) {
760 cp
->status
= wait_status
;
762 } while (term
!= pid
);
764 wait_status
= cp
->status
;
768 sigaction(SIGCHLD
, &oact
, NULL
);
770 * Make sure no zombies are left.
774 if (WIFEXITED(wait_status
) && (WEXITSTATUS(wait_status
) == 0))