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 - 2017 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
56 static struct quitnames
const _quitnames
[] = {
57 {QUITFLAG_HOLD
, ok_b_hold
},
58 {QUITFLAG_KEEP
, ok_b_keep
},
59 {QUITFLAG_KEEPSAVE
, ok_b_keepsave
},
60 {QUITFLAG_APPEND
, ok_b_append
}
63 static char _mboxname
[PATH_MAX
]; /* Name of mbox */
65 /* Touch the indicated file */
66 static void _alter(char const *name
);
68 /* Preserve all the appropriate messages back in the system mailbox, and print
69 * a nice message indicated how many were saved. On any error, just return -1.
70 * Else return 0. Incorporate the any new mail that we found */
71 static int writeback(FILE *res
, FILE *obuf
);
73 /* Terminate an editing session by attempting to write out the user's file from
74 * the temporary. Save any new stuff appended to the file */
75 static bool_t
edstop(void);
78 _alter(char const *name
) /* TODO error handling */
81 struct timespec tsa
[2];
86 struct n_timespec
const *tsp
;
89 tsp
= n_time_now(TRU1
); /* TODO -> eventloop */
92 tsa
[0].tv_sec
= tsp
->ts_sec
+ 1;
93 tsa
[0].tv_nsec
= tsp
->ts_nsec
;
94 tsa
[1].tv_nsec
= UTIME_OMIT
;
95 utimensat(AT_FDCWD
, name
, tsa
, 0);
97 if (!stat(name
, &sb
)) {
98 utb
.actime
= tsp
->ts_sec
;
99 utb
.modtime
= sb
.st_mtime
;
107 writeback(FILE *res
, FILE *obuf
)
113 if (fseek(obuf
, 0L, SEEK_SET
) == -1)
118 while ((c
= getc(res
)) != EOF
)
122 for (p
= 0, mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
123 if ((mp
->m_flag
& MPRESERVE
) || !(mp
->m_flag
& MTOUCH
)) {
125 if (sendmp(mp
, obuf
, NULL
, NULL
, SEND_MBOX
, NULL
) < 0) {
135 while ((c
= getc(res
)) != EOF
)
143 fseek(obuf
, 0L, SEEK_SET
);
146 if (fseek(obuf
, 0L, SEEK_SET
) == -1)
151 fprintf(n_stdout
, _("Held 1 message in %s\n"), displayname
);
153 fprintf(n_stdout
, _("Held %d messages in %s\n"), p
, displayname
);
163 edstop(void) /* TODO oh my god */
167 FILE *obuf
= NULL
, *ibuf
= NULL
;
177 for (mp
= message
, gotcha
= 0; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
178 if (mp
->m_flag
& MNEW
) {
180 mp
->m_flag
|= MSTATUS
;
182 if (mp
->m_flag
& (MODIFY
| MDELETED
| MSTATUS
| MFLAG
| MUNFLAG
|
183 MANSWER
| MUNANSWER
| MDRAFT
| MUNDRAFT
))
191 /* TODO This is too simple minded? We should regenerate an index file
192 * TODO to be able to truly tell whether *anything* has changed!
193 * TODO (Or better: only come here.. then! It is an *object method!* */
194 /* TODO Ignoring stat error is easy, huh? */
195 if (!stat(mailname
, &statb
) && statb
.st_size
> mailsize
) {
196 if ((obuf
= Ftmp(NULL
, "edstop", OF_RDWR
| OF_UNLINK
| OF_REGISTER
)) ==
198 n_perr(_("tmpfile"), 0);
201 if ((ibuf
= n_fopen_any(mailname
, "r", NULL
)) == NULL
) {
206 n_file_lock(fileno(ibuf
), FLT_READ
, 0,0, UIZ_MAX
); /* TODO ign. lock err*/
207 fseek(ibuf
, (long)mailsize
, SEEK_SET
);
208 while ((c
= getc(ibuf
)) != EOF
) /* xxx bytewise??? TODO ... I/O error? */
216 fprintf(n_stdout
, _("%s "), n_shexp_quote_cp(displayname
, FAL0
));
219 if ((obuf
= n_fopen_any(mailname
, "r+", NULL
)) == NULL
) {
221 n_perr(n_shexp_quote_cp(mailname
, FAL0
), e
);
224 n_file_lock(fileno(obuf
), FLT_WRITE
, 0,0, UIZ_MAX
); /* TODO ign. lock err! */
229 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
230 if (mp
->m_flag
& MDELETED
)
233 if (sendmp(mp
, obuf
, NULL
, NULL
, SEND_MBOX
, NULL
) < 0) {
235 n_err(_("Failed to finalize %s\n"), n_shexp_quote_cp(mailname
, FAL0
));
242 gotcha
= (c
== 0 && ibuf
== NULL
);
244 while ((c
= getc(ibuf
)) != EOF
)
249 n_err(_("Failed to finalize %s\n"), n_shexp_quote_cp(mailname
, FAL0
));
254 /* Non-system boxes are never removed except forced via POSIX mode */
255 #ifdef HAVE_FTRUNCATE
256 ftruncate(fileno(obuf
), 0);
260 if((fd
= open(mailname
, (O_WRONLY
| O_CREAT
| n_O_NOFOLLOW
| O_TRUNC
),
265 if(ok_blook(posix
) && !ok_blook(keep
) && n_path_rm(mailname
))
266 fputs(_("removed\n"), n_stdout
);
268 fputs(_("truncated\n"), n_stdout
);
270 fputs((ok_blook(bsdcompat
) || ok_blook(bsdmsgs
))
271 ? _("complete\n") : _("updated.\n"), n_stdout
);
281 /* TODO The codebase aborted by jumping to the main loop here.
282 * TODO The OpenBSD mailx simply ignores this error.
283 * TODO For now we follow the latter unless we are interactive,
284 * TODO in which case we ask the user whether the error is to be
285 * TODO ignored or not. More of this around here in this file! */
286 rv
= getapproval(_("Continue, possibly loosing changes"), TRU1
);
294 quit(bool_t hold_sigs_on
)
296 int p
, modify
, anystat
, c
;
297 FILE *fbuf
= NULL
, *lckfp
= NULL
, *rbuf
, *abuf
;
307 temporary_folder_hook_unroll();
309 /* If we are read only, we can't do anything, so just return quickly */
310 /* TODO yet we cannot return quickly if resources have to be released!
311 * TODO somewhen it'll be mailbox->quit() anyway, for now do it by hand
312 *if (mb.mb_perm == 0)
314 p
= (mb
.mb_perm
== 0);
316 switch (mb
.mb_type
) {
320 rv
= maildir_quit(TRU1
);
324 rv
= pop3_quit(TRU1
);
330 rv
= imap_quit(TRU1
);
341 goto jleave
; /* TODO */
344 /* If editing (not reading system mail box), then do the work in edstop() */
345 if (n_pstate
& n_PS_EDIT
) {
350 /* See if there any messages to save in mbox. If no, we
351 * can save copying mbox to /tmp and back.
353 * Check also to see if any files need to be preserved.
354 * Delete all untouched messages to keep them out of mbox.
355 * If all the messages are to be preserved, just exit with
357 fbuf
= n_fopen_any(mailname
, "r+", NULL
);
359 if (n_err_no
!= n_ERR_NOENT
)
361 fprintf(n_stdout
, _("Thou hast new mail.\n"));
366 if ((lckfp
= n_dotlock(mailname
, fileno(fbuf
), FLT_WRITE
, 0,0, UIZ_MAX
)
368 n_perr(_("Unable to (dot) lock mailbox"), 0);
371 rv
= getapproval(_("Continue, possibly loosing changes"), TRU1
);
376 if (!fstat(fileno(fbuf
), &minfo
) && minfo
.st_size
> mailsize
) {
377 fprintf(n_stdout
, _("New mail has arrived.\n"));
378 rbuf
= Ftmp(NULL
, "quit", OF_RDWR
| OF_UNLINK
| OF_REGISTER
);
379 if (rbuf
== NULL
|| fbuf
== NULL
)
382 fseek(fbuf
, (long)mailsize
, SEEK_SET
);
383 while ((c
= getc(fbuf
)) != EOF
)
386 p
= minfo
.st_size
- mailsize
;
397 anystat
= holdbits();
399 for (c
= 0, p
= 0, mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
400 if (mp
->m_flag
& MBOX
)
402 if (mp
->m_flag
& MPRESERVE
)
404 if (mp
->m_flag
& MODIFY
)
407 if (p
== msgCount
&& !modify
&& !anystat
) {
410 fprintf(n_stdout
, _("Held 1 message in %s\n"), displayname
);
412 fprintf(n_stdout
, _("Held %d messages in %s\n"), p
, displayname
);
418 if (writeback(rbuf
, fbuf
) >= 0)
421 rv
= getapproval(_("Continue, possibly loosing changes"), TRU1
);
427 if (makembox() == STOP
) {
428 rv
= getapproval(_("Continue, possibly loosing changes"), TRU1
);
432 /* Now we are ready to copy back preserved files to the system mailbox, if
433 * any were requested */
435 if (writeback(rbuf
, fbuf
) < 0)
436 rv
= getapproval(_("Continue, possibly loosing changes"), TRU1
);
440 /* Finally, remove his file. If new mail has arrived, copy it back */
444 fseek(abuf
, 0L, SEEK_SET
);
445 while ((c
= getc(rbuf
)) != EOF
)
452 #ifdef HAVE_FTRUNCATE
453 ftruncate(fileno(fbuf
), 0);
457 if((fd
= open(mailname
, (O_WRONLY
| O_CREAT
| n_O_NOFOLLOW
| O_TRUNC
),
468 if (lckfp
!= NULL
&& lckfp
!= (FILE*)-1)
481 int anystat
, autohold
, holdbit
, nohold
;
485 autohold
= ok_blook(hold
);
486 holdbit
= autohold
? MPRESERVE
: MBOX
;
487 nohold
= MBOX
| MSAVED
| MDELETED
| MPRESERVE
;
488 if (ok_blook(keepsave
))
490 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
491 if (mp
->m_flag
& MNEW
) {
493 mp
->m_flag
|= MSTATUS
;
495 if (mp
->m_flag
& (MSTATUS
| MFLAG
| MUNFLAG
| MANSWER
| MUNANSWER
|
498 if (!(mp
->m_flag
& MTOUCH
))
499 mp
->m_flag
|= MPRESERVE
;
500 if (!(mp
->m_flag
& nohold
))
501 mp
->m_flag
|= holdbit
;
508 makembox(void) /* TODO oh my god */
511 char *mbox
, *tempQuit
;
513 FILE *ibuf
= NULL
, *obuf
, *abuf
;
514 enum n_fopen_state fs
;
520 if (!ok_blook(append
)) {
521 if ((obuf
= Ftmp(&tempQuit
, "makembox",
522 OF_WRONLY
| OF_HOLDSIGS
| OF_REGISTER
)) == NULL
) {
523 n_perr(_("temporary mail quit file"), 0);
526 if ((ibuf
= Fopen(tempQuit
, "r")) == NULL
)
528 Ftmp_release(&tempQuit
);
534 if ((abuf
= n_fopen_any(mbox
, "r", NULL
)) != NULL
) {
535 while ((c
= getc(abuf
)) != EOF
)
540 n_perr(_("temporary mail quit file"), 0);
547 if ((c
= open(mbox
, (O_WRONLY
| O_CREAT
| n_O_NOFOLLOW
| O_TRUNC
), 0666)
550 if ((obuf
= n_fopen_any(mbox
, "r+", &fs
)) == NULL
) {
556 if ((obuf
= n_fopen_any(mbox
, "a", &fs
)) == NULL
) {
563 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
564 if (mp
->m_flag
& MBOX
) {
567 if((fs
& n_PROTO_MASK
) == n_PROTO_IMAP
&&
568 !n_ignore_is_any(n_IGNORE_SAVE
) && imap_thisaccount(mbox
)){
569 if(imap_copy(mp
, PTR2SIZE(mp
- message
+ 1), mbox
) == STOP
)
573 if (sendmp(mp
, obuf
, n_IGNORE_SAVE
, NULL
, SEND_MBOX
, NULL
) < 0) {
584 mp
->m_flag
|= MBOXED
;
590 /* Copy the user's old mbox contents back to the end of the stuff we just
591 * saved. If we are appending, this is unnecessary */
592 if (!ok_blook(append
)) {
610 if (Fclose(obuf
) != 0) {
612 if((fs
& n_PROTO_MASK
) != n_PROTO_IMAP
)
618 fprintf(n_stdout
, _("Saved 1 message in mbox\n"));
620 fprintf(n_stdout
, _("Saved %d messages in mbox\n"), mcount
);
628 save_mbox_for_possible_quitstuff(void){ /* TODO try to get rid of that */
632 if((cp
= fexpand("&", FEXP_FULL
)) == NULL
)
634 n_strscpy(_mboxname
, cp
, sizeof _mboxname
);
641 enum quitflags qf
= 0;
645 for (i
= 0; i
< n_NELEM(_quitnames
); ++i
)
646 if (n_var_oklook(_quitnames
[i
].okey
) != NULL
)
647 qf
|= _quitnames
[i
].flag
;
653 restorequitflags(int qf
)
658 for (i
= 0; i
< n_NELEM(_quitnames
); ++i
) {
659 char *x
= n_var_oklook(_quitnames
[i
].okey
);
660 if (qf
& _quitnames
[i
].flag
) {
662 n_var_okset(_quitnames
[i
].okey
, TRU1
);
663 } else if (x
!= NULL
)
664 n_var_okclear(_quitnames
[i
].okey
);