1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Termination processing.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2016 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
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
47 QUITFLAG_KEEPSAVE
= 1<<2,
48 QUITFLAG_APPEND
= 1<<3,
49 QUITFLAG_EMPTYBOX
= 1<<4
57 static struct quitnames
const _quitnames
[] = {
58 {QUITFLAG_HOLD
, ok_b_hold
},
59 {QUITFLAG_KEEP
, ok_b_keep
},
60 {QUITFLAG_KEEPSAVE
, ok_b_keepsave
},
61 {QUITFLAG_APPEND
, ok_b_append
},
62 {QUITFLAG_EMPTYBOX
, ok_b_emptybox
} /* TODO obsolete emptybox */
65 static char _mboxname
[PATH_MAX
]; /* Name of mbox */
67 /* Touch the indicated file */
68 static void _alter(char const *name
);
70 /* Preserve all the appropriate messages back in the system mailbox, and print
71 * a nice message indicated how many were saved. On any error, just return -1.
72 * Else return 0. Incorporate the any new mail that we found */
73 static int writeback(FILE *res
, FILE *obuf
);
75 /* Terminate an editing session by attempting to write out the user's file from
76 * the temporary. Save any new stuff appended to the file */
77 static bool_t
edstop(void);
79 /* Remove "mailname", unless *keep* says otherwise; force truncation, then */
80 static void _demail(void);
83 _alter(char const *name
) /* TODO error handling */
86 struct timespec tsa
[2];
94 tsa
[0].tv_sec
= n_time_epoch() + 1;
96 tsa
[1].tv_nsec
= UTIME_OMIT
;
97 utimensat(AT_FDCWD
, name
, tsa
, 0);
99 if (!stat(name
, &sb
)) {
100 utb
.actime
= n_time_epoch() + 1;
101 utb
.modtime
= sb
.st_mtime
;
109 writeback(FILE *res
, FILE *obuf
)
115 if (fseek(obuf
, 0L, SEEK_SET
) == -1)
120 while ((c
= getc(res
)) != EOF
)
124 for (p
= 0, mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
125 if ((mp
->m_flag
& MPRESERVE
) || !(mp
->m_flag
& MTOUCH
)) {
127 if (sendmp(mp
, obuf
, NULL
, NULL
, SEND_MBOX
, NULL
) < 0) {
137 while ((c
= getc(res
)) != EOF
)
145 fseek(obuf
, 0L, SEEK_SET
);
148 if (fseek(obuf
, 0L, SEEK_SET
) == -1)
153 printf(_("Held 1 message in %s\n"), displayname
);
155 printf(_("Held %d messages in %s\n"), p
, displayname
);
165 edstop(void) /* TODO oh my god */
169 FILE *obuf
= NULL
, *ibuf
= NULL
;
181 for (mp
= message
, gotcha
= 0; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
182 if (mp
->m_flag
& MNEW
) {
184 mp
->m_flag
|= MSTATUS
;
186 if (mp
->m_flag
& (MODIFY
| MDELETED
| MSTATUS
| MFLAG
| MUNFLAG
|
187 MANSWER
| MUNANSWER
| MDRAFT
| MUNDRAFT
))
195 /* TODO This is too simple minded? We should regenerate an index file
196 * TODO to be able to truly tell whether *anything* has changed!
197 * TODO (Or better: only come here.. then! It is an *object method!* */
198 /* TODO Ignoring stat error is easy, huh? */
199 if (!stat(mailname
, &statb
) && statb
.st_size
> mailsize
) {
200 if ((obuf
= Ftmp(NULL
, "edstop", OF_RDWR
| OF_UNLINK
| OF_REGISTER
)) ==
202 n_perr(_("tmpfile"), 0);
205 if ((ibuf
= Zopen(mailname
, "r")) == NULL
) {
211 n_file_lock(fileno(ibuf
), FLT_READ
, 0,0, UIZ_MAX
); /* TODO ign. lock err*/
212 fseek(ibuf
, (long)mailsize
, SEEK_SET
);
213 while ((c
= getc(ibuf
)) != EOF
) /* xxx bytewise??? TODO ... I/O error? */
220 printf(_("%s "), n_shexp_quote_cp(displayname
, FAL0
));
223 if ((obuf
= Zopen(mailname
, "r+")) == NULL
) {
228 n_file_lock(fileno(obuf
), FLT_WRITE
, 0,0, UIZ_MAX
); /* TODO ign. lock err! */
233 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
234 if (mp
->m_flag
& MDELETED
)
237 if (sendmp(mp
, obuf
, NULL
, NULL
, SEND_MBOX
, NULL
) < 0) {
246 gotcha
= (c
== 0 && ibuf
== NULL
);
248 while ((c
= getc(ibuf
)) != EOF
)
258 if (gotcha
&& !ok_blook(keep
) && !ok_blook(emptybox
)/* TODO obsolete eb*/) {
261 if ((rms
= n_path_rm(mailname
)) == TRU1
)
262 printf((ok_blook(bsdcompat
) || ok_blook(bsdmsgs
))
263 ? _("removed\n") : _("removed.\n"));
267 printf(_("removal error (ignored)\n"));
268 n_err(_("Error removing %s (ignored):"),
269 n_shexp_quote_cp(mailname
, FAL0
)); /* TODO */
270 n_perr(NULL
, e
); /* TODO */
273 printf((ok_blook(bsdcompat
) || ok_blook(bsdmsgs
))
274 ? _("complete\n") : _("updated.\n"));
284 /* TODO The codebase aborted by jumping to the main loop here.
285 * TODO The OpenBSD mailx simply ignores this error.
286 * TODO For now we follow the latter unless we are interactive,
287 * TODO in which case we ask the user whether the error is to be
288 * TODO ignored or not. More of this around here in this file! */
289 rv
= getapproval(_("Continue, possibly loosing changes"), TRU1
);
297 _demail(void) /* TODO error handling */
300 if (ok_blook(keep
) || n_path_rm(mailname
) <= FAL0
) {
301 /* TODO demail(): try use f?truncate(2) instead?! */
302 int fd
= open(mailname
, (O_WRONLY
| O_CREAT
| n_O_NOFOLLOW
| O_TRUNC
),
313 int p
, modify
, anystat
, c
;
314 FILE *fbuf
= NULL
, *lckfp
= NULL
, *rbuf
, *abuf
;
321 temporary_localopts_folder_hook_unroll();
323 /* If we are read only, we can't do anything, so just return quickly */
324 /* TODO yet we cannot return quickly if resources have to be released!
325 * TODO somewhen it'll be mailbox->quit() anyway, for now do it by hand
326 *if (mb.mb_perm == 0)
328 p
= (mb
.mb_perm
== 0);
330 /* TODO lex.c:setfile() has just called hold_sigs(); before it called
331 * TODO us, but this causes uninterruptible hangs due to blocked sigs
332 * TODO anywhere except for MB_FILE (all others install their own
333 * TODO handlers, as it seems, properly); marked YYY */
334 switch (mb
.mb_type
) {
338 rele_sigs(); /* YYY */
340 hold_sigs(); /* YYY */
344 rele_sigs(); /* YYY */
346 hold_sigs(); /* YYY */
357 goto jleave
; /* TODO */
360 /* If editing (not reading system mail box), then do the work in edstop() */
361 if (pstate
& PS_EDIT
) {
366 /* See if there any messages to save in mbox. If no, we
367 * can save copying mbox to /tmp and back.
369 * Check also to see if any files need to be preserved.
370 * Delete all untouched messages to keep them out of mbox.
371 * If all the messages are to be preserved, just exit with
373 fbuf
= Zopen(mailname
, "r+");
377 printf(_("Thou hast new mail.\n"));
382 if ((lckfp
= n_dotlock(mailname
, fileno(fbuf
), FLT_WRITE
, 0,0, UIZ_MAX
)
384 n_perr(_("Unable to (dot) lock mailbox"), 0);
387 rv
= getapproval(_("Continue, possibly loosing changes"), TRU1
);
392 if (!fstat(fileno(fbuf
), &minfo
) && minfo
.st_size
> mailsize
) {
393 printf(_("New mail has arrived.\n"));
394 rbuf
= Ftmp(NULL
, "quit", OF_RDWR
| OF_UNLINK
| OF_REGISTER
);
395 if (rbuf
== NULL
|| fbuf
== NULL
)
398 fseek(fbuf
, (long)mailsize
, SEEK_SET
);
399 while ((c
= getc(fbuf
)) != EOF
)
402 p
= minfo
.st_size
- mailsize
;
413 anystat
= holdbits();
415 for (c
= 0, p
= 0, mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
416 if (mp
->m_flag
& MBOX
)
418 if (mp
->m_flag
& MPRESERVE
)
420 if (mp
->m_flag
& MODIFY
)
423 if (p
== msgCount
&& !modify
&& !anystat
) {
426 printf(_("Held 1 message in %s\n"), displayname
);
428 printf(_("Held %d messages in %s\n"), p
, displayname
);
434 if (writeback(rbuf
, fbuf
) >= 0)
437 rv
= getapproval(_("Continue, possibly loosing changes"), TRU1
);
443 if (makembox() == STOP
) {
444 rv
= getapproval(_("Continue, possibly loosing changes"), TRU1
);
448 /* Now we are ready to copy back preserved files to the system mailbox, if
449 * any were requested */
451 if (writeback(rbuf
, fbuf
) < 0)
452 rv
= getapproval(_("Continue, possibly loosing changes"), TRU1
);
456 /* Finally, remove his file. If new mail has arrived, copy it back */
460 fseek(abuf
, 0L, SEEK_SET
);
461 while ((c
= getc(rbuf
)) != EOF
)
474 if (lckfp
!= NULL
&& lckfp
!= (FILE*)-1)
485 int anystat
, autohold
, holdbit
, nohold
;
489 autohold
= ok_blook(hold
);
490 holdbit
= autohold
? MPRESERVE
: MBOX
;
491 nohold
= MBOX
| MSAVED
| MDELETED
| MPRESERVE
;
492 if (ok_blook(keepsave
))
494 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
495 if (mp
->m_flag
& MNEW
) {
497 mp
->m_flag
|= MSTATUS
;
499 if (mp
->m_flag
& (MSTATUS
| MFLAG
| MUNFLAG
| MANSWER
| MUNANSWER
|
502 if (!(mp
->m_flag
& MTOUCH
))
503 mp
->m_flag
|= MPRESERVE
;
504 if (!(mp
->m_flag
& nohold
))
505 mp
->m_flag
|= holdbit
;
512 makembox(void) /* TODO oh my god */
515 char *mbox
, *tempQuit
;
517 FILE *ibuf
= NULL
, *obuf
, *abuf
;
523 if (!ok_blook(append
)) {
524 if ((obuf
= Ftmp(&tempQuit
, "makembox",
525 OF_WRONLY
| OF_HOLDSIGS
| OF_REGISTER
)) == NULL
) {
526 n_perr(_("temporary mail quit file"), 0);
529 if ((ibuf
= Fopen(tempQuit
, "r")) == NULL
)
531 Ftmp_release(&tempQuit
);
537 if ((abuf
= Zopen(mbox
, "r")) != NULL
) {
538 while ((c
= getc(abuf
)) != EOF
)
543 n_perr(_("temporary mail quit file"), 0);
550 if ((c
= open(mbox
, (O_WRONLY
| O_CREAT
| n_O_NOFOLLOW
| O_TRUNC
), 0666)
553 if ((obuf
= Zopen(mbox
, "r+")) == NULL
) {
559 if ((obuf
= Zopen(mbox
, "a")) == NULL
) {
566 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
567 if (mp
->m_flag
& MBOX
) {
569 if (sendmp(mp
, obuf
, saveignore
, NULL
, SEND_MBOX
, NULL
) < 0) {
577 mp
->m_flag
|= MBOXED
;
583 /* Copy the user's old mbox contents back to the end of the stuff we just
584 * saved. If we are appending, this is unnecessary */
585 if (!ok_blook(append
)) {
603 if (Fclose(obuf
) != 0) {
608 printf(_("Saved 1 message in mbox\n"));
610 printf(_("Saved %d messages in mbox\n"), mcount
);
618 save_mbox_for_possible_quitstuff(void) /* TODO try to get rid of that */
623 if ((cp
= expand("&")) == NULL
)
625 n_strscpy(_mboxname
, cp
, sizeof _mboxname
);
632 enum quitflags qf
= 0;
636 for (i
= 0; i
< NELEM(_quitnames
); ++i
)
637 if (n_var_oklook(_quitnames
[i
].okey
) != NULL
)
638 qf
|= _quitnames
[i
].flag
;
644 restorequitflags(int qf
)
649 for (i
= 0; i
< NELEM(_quitnames
); ++i
) {
650 char *x
= n_var_oklook(_quitnames
[i
].okey
);
651 if (qf
& _quitnames
[i
].flag
) {
653 n_var_okset(_quitnames
[i
].okey
, TRU1
);
654 } else if (x
!= NULL
)
655 n_var_okclear(_quitnames
[i
].okey
);