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 - 2015 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. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 #ifndef HAVE_AMALGAMATION
65 /* TODO FP_UNLINK: should be in a separated process so that unlinking
66 * TODO the temporary "garbage" is "safe"(r than it is like that) */
79 static struct fp
*fp_head
;
80 static struct child
*_popen_child
;
82 static int scan_mode(char const *mode
, int *omode
);
83 static void register_file(FILE *fp
, int omode
, int ispipe
, int pid
,
84 int flags
, char const *realfile
, long offset
,
85 char const *save_cmd
);
86 static enum okay
_file_save(struct fp
*fpp
);
87 static int _file_load(int flags
, int infd
, int outfd
,
88 char const *load_cmd
);
89 static enum okay
unregister_file(FILE *fp
);
90 static int file_pid(FILE *fp
);
93 static void _sigchld(int signo
);
95 static int wait_command(int pid
);
96 static struct child
*_findchild(int pid
, bool_t create
);
97 static void _delchild(struct child
*cp
);
100 scan_mode(char const *mode
, int *omode
)
107 {"w", O_WRONLY
| O_CREAT
| O_TRUNC
},
108 {"wx", O_WRONLY
| O_CREAT
| O_EXCL
},
109 {"a", O_WRONLY
| O_APPEND
| O_CREAT
},
110 {"a+", O_RDWR
| O_APPEND
},
112 {"w+", O_RDWR
| O_CREAT
| O_EXCL
}
118 for (i
= 0; UICMP(z
, i
, <, NELEM(maps
)); ++i
)
119 if (!strcmp(maps
[i
].mode
, mode
)) {
120 *omode
= maps
[i
].omode
;
125 n_alert(_("Internal error: bad stdio open mode %s"), mode
);
127 *omode
= 0; /* (silence CC) */
135 register_file(FILE *fp
, int omode
, int ispipe
, int pid
, int flags
,
136 char const *realfile
, long offset
, char const *save_cmd
)
141 assert(!(flags
& FP_UNLINK
) || realfile
!= NULL
);
143 fpp
= smalloc(sizeof *fpp
);
150 fpp
->realfile
= (realfile
!= NULL
) ? sstrdup(realfile
) : NULL
;
151 fpp
->save_cmd
= (save_cmd
!= NULL
) ? sstrdup(save_cmd
) : NULL
;
152 fpp
->offset
= offset
;
158 _file_save(struct fp
*fpp
)
165 if (fpp
->omode
== O_RDONLY
) {
175 if ((fpp
->flags
& FP_MASK
) == FP_IMAP
) {
176 rv
= imap_append(fpp
->realfile
, fpp
->fp
);
180 if ((fpp
->flags
& FP_MASK
) == FP_MAILDIR
) {
181 if (fseek(fpp
->fp
, fpp
->offset
, SEEK_SET
) == -1) {
183 n_err(_("Fatal: cannot restore file position and save %s: %s\n"),
184 fpp
->realfile
, strerror(outfd
));
187 rv
= maildir_append(fpp
->realfile
, fpp
->fp
, fpp
->offset
);
191 /* Ensure the I/O library doesn't optimize the fseek(3) away! */
192 if(lseek(infd
= fileno(fpp
->fp
), fpp
->offset
, SEEK_SET
) == -1){
194 n_err(_("Fatal: cannot restore file position and save %s: %s\n"),
195 fpp
->realfile
, strerror(outfd
));
199 outfd
= open(fpp
->realfile
,
200 ((fpp
->omode
| O_CREAT
| (fpp
->omode
& O_APPEND
? 0 : O_TRUNC
))
204 n_err(_("Fatal: cannot create %s: %s\n"),
205 fpp
->realfile
, strerror(outfd
));
210 switch (fpp
->flags
& FP_MASK
) {
212 cmd
[0] = "gzip"; cmd
[1] = "-c"; break;
214 cmd
[0] = "bzip2"; cmd
[1] = "-c"; break;
216 cmd
[0] = "xz"; cmd
[1] = "-c"; break;
218 cmd
[0] = "cat"; cmd
[1] = NULL
; break;
220 if ((cmd
[0] = ok_vlook(SHELL
)) == NULL
)
223 cmd
[2] = fpp
->save_cmd
;
225 if (run_command(cmd
[0], 0, infd
, outfd
, cmd
[1], cmd
[2], NULL
, NULL
) >= 0)
235 _file_load(int flags
, int infd
, int outfd
, char const *load_cmd
)
242 switch (flags
& FP_MASK
) {
243 case FP_GZIP
: cmd
[0] = "gzip"; cmd
[1] = "-cd"; break;
244 case FP_BZIP2
: cmd
[0] = "bzip2"; cmd
[1] = "-cd"; break;
245 case FP_XZ
: cmd
[0] = "xz"; cmd
[1] = "-cd"; break;
246 default: cmd
[0] = "cat"; cmd
[1] = NULL
; break;
248 if ((cmd
[0] = ok_vlook(SHELL
)) == NULL
)
259 rv
= run_command(cmd
[0], 0, infd
, outfd
, cmd
[1], cmd
[2], NULL
, NULL
);
266 unregister_file(FILE *fp
)
272 for (pp
= &fp_head
; (p
= *pp
) != NULL
; pp
= &p
->link
)
274 if ((p
->flags
& FP_MASK
) != FP_RAW
) /* TODO ;} */
276 if (p
->flags
& FP_UNLINK
&& unlink(p
->realfile
))
279 if (p
->save_cmd
!= NULL
)
281 if (p
->realfile
!= NULL
)
286 DBGOR(n_panic
, n_alert
)(_("Invalid file pointer"));
301 for (p
= fp_head
; p
; p
= p
->link
)
316 NYD_X
; /* Signal handler */
320 pid
= waitpid(-1, &status
, WNOHANG
);
322 if (pid
== -1 && errno
== EINTR
)
327 if ((cp
= _findchild(pid
, FAL0
)) != NULL
) {
329 cp
->pid
= -1; /* XXX Was _delchild(cp);# */
339 wait_command(int pid
)
344 if (!wait_child(pid
, NULL
)) {
345 if (ok_blook(bsdcompat
) || ok_blook(bsdmsgs
))
346 n_err(_("Fatal error in process\n"));
353 static struct child
*
354 _findchild(int pid
, bool_t create
)
359 for (cpp
= &_popen_child
; *cpp
!= NULL
&& (*cpp
)->pid
!= pid
;
363 if (*cpp
== NULL
&& create
) {
364 *cpp
= smalloc(sizeof **cpp
);
366 (*cpp
)->done
= (*cpp
)->free
= 0;
374 _delchild(struct child
*cp
)
386 if (*(cpp
= &(*cpp
)->link
) == NULL
) {
387 DBG( n_err("! popen.c:_delchild(): implementation error\n"); )
395 command_manager_start(void)
397 struct sigaction nact
, oact
;
400 nact
.sa_handler
= &_sigchld
;
401 sigemptyset(&nact
.sa_mask
);
410 if (sigaction(SIGCHLD
, &nact
, &oact
) != 0)
411 n_panic(_("Cannot install signal handler for child process management"));
416 safe_fopen(char const *file
, char const *oflags
, int *xflags
)
420 NYD2_ENTER
; /* (only for Fopen() and once in lex.c) */
422 if (scan_mode(oflags
, &osflags
) < 0)
424 osflags
|= _O_CLOEXEC
;
428 if ((fd
= open(file
, osflags
, 0666)) == -1)
432 fp
= fdopen(fd
, oflags
);
439 Fopen(char const *file
, char const *oflags
)
445 if ((fp
= safe_fopen(file
, oflags
, &osflags
)) != NULL
)
446 register_file(fp
, osflags
, 0, 0, FP_RAW
, NULL
, 0L, NULL
);
452 Fdopen(int fd
, char const *oflags
, bool_t nocloexec
)
458 scan_mode(oflags
, &osflags
);
460 osflags
|= _O_CLOEXEC
; /* Ensured to be set by caller as documented! */
462 if ((fp
= fdopen(fd
, oflags
)) != NULL
)
463 register_file(fp
, osflags
, 0, 0, FP_RAW
, NULL
, 0L, NULL
);
474 if (unregister_file(fp
) == OKAY
)
479 return (i
== 3 ? 0 : EOF
);
483 Zopen(char const *file
, char const *oflags
) /* FIXME MESS! */
486 char const *cload
= NULL
, *csave
= NULL
;
487 int flags
, osflags
, mode
, infd
;
493 if (scan_mode(oflags
, &osflags
) < 0)
497 rof
= OF_RDWR
| OF_UNLINK
;
498 if (osflags
& O_APPEND
)
500 mode
= (osflags
== O_RDONLY
) ? R_OK
: R_OK
| W_OK
;
502 if ((osflags
& O_APPEND
) && ((p
= which_protocol(file
)) == PROTO_IMAP
||
503 p
== PROTO_MAILDIR
)) {
504 flags
|= (p
== PROTO_IMAP
) ? FP_IMAP
: FP_MAILDIR
;
505 osflags
= O_RDWR
| O_APPEND
| O_CREAT
;
510 if ((ext
= strrchr(file
, '.')) != NULL
) {
511 if (!asccasecmp(ext
, ".gz"))
513 else if (!asccasecmp(ext
, ".xz")) {
515 osflags
&= ~O_APPEND
;
517 } else if (!asccasecmp(ext
, ".bz2")) {
519 osflags
&= ~O_APPEND
;
523 #define _X1 "file-hook-load-"
525 #define _X2 "file-hook-save-"
526 size_t l
= strlen(++ext
);
527 char *vbuf
= ac_alloc(l
+ MAX(sizeof(_X1
), sizeof(_X2
)));
529 memcpy(vbuf
, _X1
, sizeof(_X1
) -1);
530 memcpy(vbuf
+ sizeof(_X1
) -1, ext
, l
);
531 vbuf
[sizeof(_X1
) -1 + l
] = '\0';
532 cload
= vok_vlook(vbuf
);
533 memcpy(vbuf
, _X2
, sizeof(_X2
) -1);
534 memcpy(vbuf
+ sizeof(_X2
) -1, ext
, l
);
535 vbuf
[sizeof(_X2
) -1 + l
] = '\0';
536 csave
= vok_vlook(vbuf
);
541 if ((csave
!= NULL
) && (cload
!= NULL
)) {
543 osflags
&= ~O_APPEND
;
545 } else if ((csave
!= NULL
) | (cload
!= NULL
)) {
546 n_alert(_("Only one of *mailbox-(load|save)-%s* is set! "
547 "Treating as plain text!"), ext
);
555 rv
= Fopen(file
, oflags
);
559 if ((infd
= open(file
, (mode
& W_OK
) ? O_RDWR
: O_RDONLY
)) == -1 &&
560 (!(osflags
& O_CREAT
) || errno
!= ENOENT
))
564 /* Note rv is not yet register_file()d, fclose() it in error path! */
565 if ((rv
= Ftmp(NULL
, "zopen", rof
, 0600)) == NULL
) {
566 n_perr(_("tmpfile"), 0);
570 if (flags
& (FP_IMAP
| FP_MAILDIR
))
572 else if (infd
>= 0) {
573 if (_file_load(flags
, infd
, fileno(rv
), cload
) < 0) {
583 if ((infd
= creat(file
, 0666)) == -1) {
594 if (!(osflags
& O_APPEND
))
596 if ((offset
= ftell(rv
)) == -1) {
602 register_file(rv
, osflags
, 0, 0, flags
, file
, offset
, csave
);
609 Ftmp(char **fn
, char const *prefix
, enum oflags oflags
, int mode
)
612 size_t maxname
, tries
;
617 assert((oflags
& OF_WRONLY
) || (oflags
& OF_RDWR
));
618 assert(!(oflags
& OF_RDONLY
));
619 assert(!(oflags
& OF_REGISTER_UNLINK
) || (oflags
& OF_REGISTER
));
626 if ((pc
= pathconf(tempdir
, _PC_NAME_MAX
)) != -1)
627 maxname
= (size_t)pc
;
632 cp
= smalloc(strlen(tempdir
) + 1 + maxname
+1);
633 cp
= sstpcpy(cp
, tempdir
);
636 osoflags
= O_CREAT
| O_EXCL
| _O_CLOEXEC
;
637 osoflags
|= (oflags
& OF_WRONLY
) ? O_WRONLY
: O_RDWR
;
638 if (oflags
& OF_APPEND
)
639 osoflags
|= O_APPEND
;
641 for (tries
= 0;; ++tries
) {
645 x
= sstpcpy(cp
, UAGENT
);
647 if (*prefix
!= '\0') {
648 x
= sstpcpy(x
, prefix
);
652 /* Calculate length of a random string addon */
653 i
= PTR2SIZE(x
- cp
);
654 if (i
>= maxname
>> 1) {
659 /* But don't be too fatalistic */
660 if (i
> 8 && tries
< FTMP_OPEN_TRIES
/ 2)
662 memcpy(x
, getrandstring(i
), i
+1);
665 if ((fd
= open(cp_base
, osoflags
, mode
)) != -1) {
669 if (tries
>= FTMP_OPEN_TRIES
) {
676 if (oflags
& OF_REGISTER
) {
677 char const *osflags
= (oflags
& OF_RDWR
? "w+" : "w");
680 scan_mode(osflags
, &osflagbits
); /* TODO osoflags&xy ?!!? */
681 if ((fp
= fdopen(fd
, osflags
)) != NULL
)
682 register_file(fp
, osflagbits
| _O_CLOEXEC
, 0, 0,
683 (FP_RAW
| (oflags
& OF_REGISTER_UNLINK
? FP_UNLINK
: 0)),
686 fp
= fdopen(fd
, (oflags
& OF_RDWR
? "w+" : "w"));
688 if (fp
== NULL
|| (oflags
& OF_UNLINK
)) {
699 if (fp
== NULL
|| !(oflags
& OF_HOLDSIGS
))
706 if ((cp
= cp_base
) != NULL
)
712 Ftmp_release(char **fn
)
741 pipe_cloexec(int fd
[2])
747 if (pipe2(fd
, O_CLOEXEC
) == -1)
752 (void)fcntl(fd
[0], F_SETFD
, FD_CLOEXEC
);
753 (void)fcntl(fd
[1], F_SETFD
, FD_CLOEXEC
);
762 Popen(char const *cmd
, char const *mode
, char const *sh
,
763 char const **env_addon
, int newfd1
)
765 int p
[2], myside
, hisside
, fd0
, fd1
, pid
;
766 char mod
[2] = {'0', '\0'};
771 /* First clean up child structures */
773 struct child
**cpp
, *cp
;
776 sigprocmask(SIG_BLOCK
, &nset
, &oset
);
778 for (cpp
= &_popen_child
; *cpp
!= NULL
;) {
779 if ((*cpp
)->pid
== -1) {
787 sigprocmask(SIG_SETMASK
, &oset
, NULL
);
790 if (!pipe_cloexec(p
))
796 hisside
= fd1
= p
[WRITE
];
798 } else if (*mode
== 'W') {
800 hisside
= fd0
= p
[READ
];
805 hisside
= fd0
= p
[READ
];
812 if (cmd
== (char*)-1) {
813 if ((pid
= fork_child()) == -1)
814 n_perr(_("fork"), 0);
816 union {char const *ccp
; int (*ptf
)(void); int es
;} u
;
817 prepare_child(&nset
, fd0
, fd1
);
824 } else if (sh
== NULL
) {
825 pid
= start_command(cmd
, &nset
, fd0
, fd1
, NULL
, NULL
, NULL
, env_addon
);
827 pid
= start_command(sh
, &nset
, fd0
, fd1
, "-c", cmd
, NULL
, env_addon
);
835 if ((rv
= fdopen(myside
, mod
)) != NULL
)
836 register_file(rv
, 0, 1, pid
, FP_RAW
, NULL
, 0L, NULL
);
845 Pclose(FILE *ptr
, bool_t dowait
)
855 unregister_file(ptr
);
859 sigaddset(&nset
, SIGINT
);
860 sigaddset(&nset
, SIGHUP
);
861 sigprocmask(SIG_BLOCK
, &nset
, &oset
);
862 rv
= wait_child(pid
, NULL
);
863 sigprocmask(SIG_SETMASK
, &oset
, NULL
);
874 close_all_files(void)
877 while (fp_head
!= NULL
)
879 Pclose(fp_head
->fp
, TRU1
);
892 cp
= _findchild(0, TRU1
);
894 if ((cp
->pid
= pid
= fork()) == -1) {
896 n_perr(_("fork"), 0);
903 run_command(char const *cmd
, sigset_t
*mask
, int infd
, int outfd
,
904 char const *a0
, char const *a1
, char const *a2
, char const **env_addon
)
909 if ((rv
= start_command(cmd
, mask
, infd
, outfd
, a0
, a1
, a2
, env_addon
)) < 0)
912 rv
= wait_command(rv
);
918 start_command(char const *cmd
, sigset_t
*mask
, int infd
, int outfd
,
919 char const *a0
, char const *a1
, char const *a2
,
920 char const **env_addon
)
925 if ((rv
= fork_child()) == -1) {
926 n_perr(_("fork"), 0);
928 } else if (rv
== 0) {
932 if (env_addon
!= NULL
) { /* TODO env_addon; should have struct child */
933 extern char **environ
;
934 size_t ei
, ei_orig
, ai
, ai_orig
;
937 /* TODO note we don't check the POSIX limit:
938 * the total space used to store the environment and the arguments to
939 * the process is limited to {ARG_MAX} bytes */
940 for (ei
= 0; environ
[ei
] != NULL
; ++ei
)
943 for (ai
= 0; env_addon
[ai
] != NULL
; ++ai
)
946 env
= ac_alloc(sizeof(*env
) * (ei
+ ai
+1));
947 memcpy(env
, environ
, sizeof(*env
) * ei
);
949 /* Replace all those keys that yet exist */
951 char const *ee
, *kvs
;
955 kvs
= strchr(ee
, '=');
957 kl
= PTR2SIZE(kvs
- ee
);
959 for (ei
= ei_orig
; ei
-- > 0;) {
960 char const *ekvs
= strchr(env
[ei
], '=');
961 if (ekvs
!= NULL
&& kl
== PTR2SIZE(ekvs
- env
[ei
]) &&
962 !memcmp(ee
, env
[ei
], kl
)) {
963 env
[ei
] = UNCONST(ee
);
964 env_addon
[ai
] = NULL
;
970 /* And append the rest */
971 for (ei
= ei_orig
, ai
= ai_orig
; ai
-- > 0;)
972 if (env_addon
[ai
] != NULL
)
973 env
[ei
++] = UNCONST(env_addon
[ai
]);
979 i
= getrawlist(cmd
, strlen(cmd
), argv
, NELEM(argv
), 0);
981 if ((argv
[i
++] = UNCONST(a0
)) != NULL
&&
982 (argv
[i
++] = UNCONST(a1
)) != NULL
&&
983 (argv
[i
++] = UNCONST(a2
)) != NULL
)
985 prepare_child(mask
, infd
, outfd
);
986 execvp(argv
[0], argv
);
995 prepare_child(sigset_t
*nset
, int infd
, int outfd
)
1001 /* All file descriptors other than 0, 1, and 2 are supposed to be cloexec */
1003 dup2(infd
, STDIN_FILENO
);
1005 dup2(outfd
, STDOUT_FILENO
);
1008 for (i
= 1; i
< NSIG
; ++i
)
1009 if (sigismember(nset
, i
))
1010 safe_signal(i
, SIG_IGN
);
1011 if (!sigismember(nset
, SIGINT
))
1012 safe_signal(SIGINT
, SIG_DFL
);
1016 sigprocmask(SIG_SETMASK
, &fset
, NULL
);
1023 sigset_t nset
, oset
;
1028 sigaddset(&nset
, SIGCHLD
);
1029 sigprocmask(SIG_BLOCK
, &nset
, &oset
);
1031 if ((cp
= _findchild(pid
, FAL0
)) != NULL
) {
1038 sigprocmask(SIG_SETMASK
, &oset
, NULL
);
1043 wait_child(int pid
, int *wait_status
)
1045 sigset_t nset
, oset
;
1052 sigaddset(&nset
, SIGCHLD
);
1053 sigprocmask(SIG_BLOCK
, &nset
, &oset
);
1055 cp
= _findchild(pid
, FAL0
);
1064 sigprocmask(SIG_SETMASK
, &oset
, NULL
);
1066 if (wait_status
!= NULL
)
1068 rv
= (WIFEXITED(ws
) && WEXITSTATUS(ws
) == 0);