1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Folder (mailbox) initialization, newmail announcement and related.
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
44 /* Update mailname (if name != NULL) and displayname, return whether displayname
45 * was large enough to swallow mailname */
46 static bool_t
_update_mailname(char const *name
);
47 #ifdef HAVE_C90AMEND1 /* TODO unite __narrow_suffix() into one fun! */
48 SINLINE
size_t __narrow_suffix(char const *cp
, size_t cpl
, size_t maxl
);
53 __narrow_suffix(char const *cp
, size_t cpl
, size_t maxl
)
59 for (err
= ok
= i
= 0; cpl
> maxl
|| err
;) {
60 int ml
= mblen(cp
, cpl
);
61 if (ml
< 0) { /* XXX _narrow_suffix(): mblen() error; action? */
79 #endif /* HAVE_C90AMEND1 */
82 _update_mailname(char const *name
)
89 /* Don't realpath(3) if it's only an update request */
92 enum protocol p
= which_protocol(name
);
94 if (p
== PROTO_FILE
|| p
== PROTO_MAILDIR
) {
95 if (realpath(name
, mailname
) == NULL
&& errno
!= ENOENT
) {
96 n_err(_("Can't canonicalize %s\n"), n_shell_quote_cp(name
, FAL0
));
103 n_strscpy(mailname
, name
, sizeof(mailname
));
109 /* Don't display an absolute path but "+FOLDER" if under *folder* */
113 if(*(folderp
= folder_query()) != '\0'){
115 if(!strncmp(folderp
, mailp
, i
)){
116 if(folderp
[i
-1] != '/' && mailp
[i
] == '/') /* XXX DIRSEP magic */
124 /* We want to see the name of the folder .. on the screen */
126 if (i
< sizeof(displayname
) -1)
127 memcpy(dispp
, mailp
, i
+1);
130 /* Avoid disrupting multibyte sequences (if possible) */
131 #ifndef HAVE_C90AMEND1
132 j
= sizeof(displayname
) / 3 - 1;
133 i
-= sizeof(displayname
) - (1/* + */ + 3) - j
;
135 j
= field_detect_clip(sizeof(displayname
) / 3, mailp
, i
);
136 i
= j
+ __narrow_suffix(mailp
+ j
, i
- j
,
137 sizeof(displayname
) - (1/* + */ + 3 + 1) - j
);
139 snprintf(dispp
, sizeof(displayname
), "%.*s...%s",
140 (int)j
, mailp
, mailp
+ i
);
147 setfile(char const *name
, enum fedit_mode fm
) /* TODO oh my god */
149 /* Note we don't 'userid(myname) != getuid()', preliminary steps are usually
150 * necessary to make a mailbox accessible by a different user, and if that
151 * has happened, let's just let the usual file perms decide */
157 int rv
, omsgCount
= 0;
158 FILE *ibuf
= NULL
, *lckfp
= NULL
;
159 bool_t isdevnull
= FAL0
;
162 pstate
&= ~PS_SETFILE_OPENED
;
165 enum fexp_mode fexpm
;
167 if((who
= shortcut_expand(name
)) != NULL
){
168 fexpm
= FEXP_NSHORTCUT
| FEXP_NSHELL
;
174 fm
|= FEDIT_SYSBOX
; /* TODO fexpand() needs to tell is-valid-user! */
175 if(*(who
= &name
[1]) == ':')
182 if ((name
= fexpand(name
, fexpm
)) == NULL
)
186 switch (which_protocol(name
)) {
188 if (temporary_protocol_ext
!= NULL
)
189 name
= savecat(name
, temporary_protocol_ext
);
190 isdevnull
= ((options
& OPT_BATCH_FLAG
) && !strcmp(name
, "/dev/null"));
192 do { /* TODO we need objects, goes away then */
193 # ifdef HAVE_REALPATH_NULL
196 if ((cp
= realpath(name
, NULL
)) != NULL
) {
203 if (realpath(name
, cbuf
) != NULL
)
204 name
= savestr(cbuf
);
212 rv
= maildir_setfile(name
, fm
);
217 rv
= pop3_setfile(name
, fm
);
221 n_err(_("Cannot handle protocol: %s\n"), name
);
225 if ((ibuf
= Zopen(name
, "r")) == NULL
) {
226 if ((fm
& FEDIT_SYSBOX
) && errno
== ENOENT
) {
227 if (strcmp(who
, myname
) && getpwnam(who
) == NULL
) {
228 n_err(_("%s is not a user of this system\n"),
229 n_shell_quote_cp(who
, FAL0
));
232 if (!(options
& OPT_QUICKRUN_MASK
) && ok_blook(bsdcompat
))
233 n_err(_("No mail for %s\n"), who
);
234 if (fm
& FEDIT_NEWMAIL
)
236 if (ok_blook(emptystart
)) {
237 if (!(options
& OPT_QUICKRUN_MASK
) && !ok_blook(bsdcompat
))
239 /* We must avoid returning -1 and causing program exit */
240 mb
.mb_type
= MB_VOID
;
245 } else if (fm
& FEDIT_NEWMAIL
)
251 if (fstat(fileno(ibuf
), &stb
) == -1) {
252 if (fm
& FEDIT_NEWMAIL
)
254 n_perr(_("fstat"), 0);
258 if (S_ISREG(stb
.st_mode
) || isdevnull
) {
261 if (fm
& FEDIT_NEWMAIL
)
263 errno
= S_ISDIR(stb
.st_mode
) ? EISDIR
: EINVAL
;
268 /* Looks like all will be well. We must now relinquish our hold on the
269 * current set of stuff. Must hold signals while we are reading the new
270 * file, else we will ruin the message[] data structure */
272 hold_sigs(); /* TODO note on this one in quit.c:quit() */
273 if (shudclob
&& !(fm
& FEDIT_NEWMAIL
) && !quit()) {
279 if (!(fm
& FEDIT_NEWMAIL
) && mb
.mb_sock
.s_fd
>= 0)
280 sclose(&mb
.mb_sock
); /* TODO sorry? VMAILFS->close(), thank you */
283 /* TODO There is no intermediate VOID box we've switched to: name may
284 * TODO point to the same box that we just have written, so any updates
285 * TODO we won't see! Reopen again in this case. RACY! Goes with VOID! */
286 /* TODO In addition: in case of compressed/hook boxes we lock a temporary! */
287 /* TODO We may uselessly open twice but quit() doesn't say whether we were
288 * TODO modified so we can't tell: Mailbox::is_modified() :-(( */
289 if (/*shudclob && !(fm & FEDIT_NEWMAIL) &&*/ !strcmp(name
, mailname
)) {
293 if ((ibuf
= Zopen(name
, "r")) == NULL
||
294 fstat(fileno(ibuf
), &stb
) == -1 ||
295 (!S_ISREG(stb
.st_mode
) && !isdevnull
)) {
302 /* Copy the messages into /tmp and set pointers */
303 if (!(fm
& FEDIT_NEWMAIL
)) {
304 mb
.mb_type
= MB_FILE
;
305 mb
.mb_perm
= (((options
& OPT_R_FLAG
) || (fm
& FEDIT_RDONLY
) ||
306 access(name
, W_OK
) < 0) ? 0 : MB_DELE
| MB_EDIT
);
318 if (fm
& FEDIT_SYSBOX
)
325 fseek(mb
.mb_otf
, 0L, SEEK_END
);
326 /* TODO Doing this without holding a lock is.. And not err checking.. */
327 fseek(ibuf
, mailsize
, SEEK_SET
);
329 omsgCount
= msgCount
;
334 else if (!(pstate
& PS_EDIT
))
335 lckfp
= n_dotlock(name
, fileno(ibuf
), FLT_READ
, offset
,0,
336 (fm
& FEDIT_NEWMAIL
? 0 : UIZ_MAX
));
337 else if (n_file_lock(fileno(ibuf
), FLT_READ
, offset
,0,
338 (fm
& FEDIT_NEWMAIL
? 0 : UIZ_MAX
)))
342 if (!(fm
& FEDIT_NEWMAIL
)) {
343 char const *emsg
= (pstate
& PS_EDIT
)
344 ? N_("Unable to lock mailbox, aborting operation")
345 : N_("Unable to (dot) lock mailbox, aborting operation");
349 if (!(fm
& FEDIT_NEWMAIL
))
354 mailsize
= fsize(ibuf
);
356 /* TODO This is too simple minded? We should regenerate an index file
357 * TODO to be able to truly tell whether *anything* has changed! */
358 if ((fm
& FEDIT_NEWMAIL
) && UICMP(z
, mailsize
, <=, offset
)) {
362 setptr(ibuf
, offset
);
364 if ((fm
& FEDIT_NEWMAIL
) && mb
.mb_sorted
) {
371 if (lckfp
!= NULL
&& lckfp
!= (FILE*)-1) {
377 if (!(fm
& FEDIT_NEWMAIL
)) {
378 pstate
&= ~PS_SAW_COMMAND
;
379 pstate
|= PS_SETFILE_OPENED
;
382 if ((options
& OPT_EXISTONLY
) && !(options
& OPT_HEADERLIST
)) {
383 rv
= (msgCount
== 0);
387 if ((!(pstate
& PS_EDIT
) || (fm
& FEDIT_NEWMAIL
)) && msgCount
== 0) {
388 if (!(fm
& FEDIT_NEWMAIL
)) {
389 if (!ok_blook(emptystart
))
390 n_err(_("No mail for %s\n"), who
);
395 if (fm
& FEDIT_NEWMAIL
)
396 newmailinfo(omsgCount
);
402 if (lckfp
!= NULL
&& lckfp
!= (FILE*)-1)
408 mb
.mb_type
= MB_VOID
;
415 newmailinfo(int omsgCount
)
420 for (i
= 0; i
< omsgCount
; ++i
)
421 message
[i
].m_flag
&= ~MNEWEST
;
423 if (msgCount
> omsgCount
) {
424 for (i
= omsgCount
; i
< msgCount
; ++i
)
425 message
[i
].m_flag
|= MNEWEST
;
426 printf(_("New mail has arrived.\n"));
427 if ((i
= msgCount
- omsgCount
) == 1)
428 printf(_("Loaded 1 new message.\n"));
430 printf(_("Loaded %d new messages.\n"), i
);
432 printf(_("Loaded %d messages.\n"), msgCount
);
434 check_folder_hook(TRU1
);
438 if (ok_blook(header
))
439 print_headers(omsgCount
+ 1, msgCount
, FAL0
);
448 if (n_msgvec
!= NULL
)
450 n_msgvec
= scalloc(sz
+ 1, sizeof *n_msgvec
);
455 print_header_summary(char const *Larg
)
457 size_t bot
, top
, i
, j
;
461 /* Avoid any messages XXX add a make_mua_silent() and use it? */
462 if ((options
& (OPT_VERB
| OPT_EXISTONLY
)) == OPT_EXISTONLY
) {
463 freopen("/dev/null", "w", stdout
);
464 freopen("/dev/null", "w", stderr
);
466 assert(n_msgvec
!= NULL
);
467 i
= (getmsglist(/*TODO make arg const */UNCONST(Larg
), n_msgvec
, 0) <= 0);
468 if (options
& OPT_EXISTONLY
) {
469 exit_status
= (int)i
;
474 for (bot
= msgCount
, top
= 0, i
= 0; (j
= n_msgvec
[i
]) != 0; ++i
) {
481 bot
= 1, top
= msgCount
;
482 print_headers(bot
, top
, (Larg
!= NULL
)); /* TODO should take iterator!! */
488 announce(int printheaders
)
493 mdot
= newfileinfo();
496 dot
= message
+ mdot
- 1;
497 if (printheaders
&& msgCount
> 0 && ok_blook(header
)) {
498 print_header_group(vec
); /* XXX errors? */
507 int u
, n
, mdot
, d
, s
, hidden
, moved
;
510 if (mb
.mb_type
== MB_VOID
) {
516 s
= d
= hidden
= moved
=0;
517 for (mp
= message
, n
= 0, u
= 0; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
518 if (mp
->m_flag
& MNEW
)
520 if ((mp
->m_flag
& MREAD
) == 0)
522 if ((mp
->m_flag
& (MDELETED
| MSAVED
)) == (MDELETED
| MSAVED
))
524 if ((mp
->m_flag
& (MDELETED
| MSAVED
)) == MDELETED
)
526 if ((mp
->m_flag
& (MDELETED
| MSAVED
)) == MSAVED
)
528 if (mp
->m_flag
& MHIDDEN
)
532 /* If displayname gets truncated the user effectively has no option to see
533 * the full pathname of the mailbox, so print it at least for '? fi' */
534 printf(_("%s: "), n_shell_quote_cp(
535 (_update_mailname(NULL
) ? displayname
: mailname
), FAL0
));
537 printf(_("1 message"));
539 printf(_("%d messages"), msgCount
);
541 printf(_(" %d new"), n
);
543 printf(_(" %d unread"), u
);
545 printf(_(" %d deleted"), d
);
547 printf(_(" %d saved"), s
);
549 printf(_(" %d moved"), moved
);
551 printf(_(" %d hidden"), hidden
);
552 else if (mb
.mb_perm
== 0)
553 printf(_(" [Read only]"));
566 enum mflag avoid
= MHIDDEN
| MDELETED
;
570 if (ok_blook(autothread
)) {
571 OBSOLETE(_("please use *autosort=thread* instead of *autothread*"));
573 } else if ((cp
= ok_vlook(autosort
)) != NULL
) {
574 if (mb
.mb_sorted
!= NULL
)
576 mb
.mb_sorted
= sstrdup(cp
);
580 if (mb
.mb_type
== MB_VOID
) {
586 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
587 if ((mp
->m_flag
& (MNEWEST
| avoid
)) == MNEWEST
)
590 if (!nmail
|| PTRCMP(mp
, >=, message
+ msgCount
)) {
591 if (mb
.mb_threaded
) {
592 for (mp
= threadroot
; mp
!= NULL
; mp
= next_in_thread(mp
))
593 if ((mp
->m_flag
& (MNEW
| avoid
)) == MNEW
)
596 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
597 if ((mp
->m_flag
& (MNEW
| avoid
)) == MNEW
)
602 if ((mb
.mb_threaded
? (mp
== NULL
) : PTRCMP(mp
, >=, message
+ msgCount
))) {
603 if (mb
.mb_threaded
) {
604 for (mp
= threadroot
; mp
!= NULL
; mp
= next_in_thread(mp
))
605 if (mp
->m_flag
& MFLAGGED
)
608 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
609 if (mp
->m_flag
& MFLAGGED
)
614 if ((mb
.mb_threaded
? (mp
== NULL
) : PTRCMP(mp
, >=, message
+ msgCount
))) {
615 if (mb
.mb_threaded
) {
616 for (mp
= threadroot
; mp
!= NULL
; mp
= next_in_thread(mp
))
617 if (!(mp
->m_flag
& (MREAD
| avoid
)))
620 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
621 if (!(mp
->m_flag
& (MREAD
| avoid
)))
627 (mb
.mb_threaded
? (mp
!= NULL
) : PTRCMP(mp
, <, message
+ msgCount
)))
628 mdot
= (int)PTR2SIZE(mp
- message
+ 1);
629 else if (ok_blook(showlast
)) {
630 if (mb
.mb_threaded
) {
631 for (mp
= this_in_thread(threadroot
, -1); mp
;
632 mp
= prev_in_thread(mp
))
633 if (!(mp
->m_flag
& avoid
))
635 mdot
= (mp
!= NULL
) ? (int)PTR2SIZE(mp
- message
+ 1) : msgCount
;
637 for (mp
= message
+ msgCount
- 1; mp
>= message
; --mp
)
638 if (!(mp
->m_flag
& avoid
))
640 mdot
= (mp
>= message
) ? (int)PTR2SIZE(mp
- message
+ 1) : msgCount
;
643 (mb
.mb_threaded
? (mp
!= NULL
) : PTRCMP(mp
, <, message
+ msgCount
)))
644 mdot
= (int)PTR2SIZE(mp
- message
+ 1);
645 else if (mb
.mb_threaded
) {
646 for (mp
= threadroot
; mp
; mp
= next_in_thread(mp
))
647 if (!(mp
->m_flag
& avoid
))
649 mdot
= (mp
!= NULL
) ? (int)PTR2SIZE(mp
- message
+ 1) : 1;
651 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
652 if (!(mp
->m_flag
& avoid
))
654 mdot
= PTRCMP(mp
, <, message
+ msgCount
)
655 ? (int)PTR2SIZE(mp
- message
+ 1) : 1;
663 initbox(char const *name
)
668 if (mb
.mb_type
!= MB_VOID
)
669 n_strscpy(prevfile
, mailname
, PATH_MAX
);
671 /* TODO name always NE mailname (but goes away for objects anyway)
672 * TODO Well, not true no more except that in parens */
673 _update_mailname((name
!= mailname
) ? name
: NULL
);
675 if ((mb
.mb_otf
= Ftmp(&tempMesg
, "tmpmbox", OF_WRONLY
| OF_HOLDSIGS
)) ==
677 n_perr(_("temporary mail message file"), 0);
680 if ((mb
.mb_itf
= safe_fopen(tempMesg
, "r", NULL
)) == NULL
) {
681 n_perr(_("temporary mail message file"), 0);
684 Ftmp_release(&tempMesg
);
688 if (mb
.mb_sorted
!= NULL
) {
692 dot
= prevdot
= threadroot
= NULL
;
693 pstate
&= ~PS_DID_PRINT_DOT
;
699 struct n_string s
, *sp
= &s
;
705 /* *folder* is linked with *_folder_resolved*: we only use the latter */
707 if((rv
= ok_vlook(_folder_resolved
)) != NULL
)
711 * If directory does not start with a <slash> ('/'), the contents
712 * of HOME shall be prefixed to it.
714 * If folder is unset or set to null, [.] filenames beginning with
715 * '+' shall refer to files in the current directory.
716 * We may have the result already */
720 if((cp
= ok_vlook(folder
)) == NULL
)
723 /* Expand the *folder*; skip %: prefix for simplicity of use */
724 if(cp
[0] == '%' && cp
[1] == ':')
726 if((err
= (cp
= fexpand(cp
, FEXP_NSHELL
)) == NULL
) || *cp
== '\0')
729 switch(which_protocol(cp
)){
731 n_err(_("*folder* can't be set to a flat, readonly POP3 account\n"));
735 /* Further expansion desired */
739 /* Prefix HOME as necessary */
741 char const *home
= ok_vlook(HOME
);
742 size_t l1
= strlen(home
), l2
= strlen(cp
);
744 sp
= n_string_creat_auto(sp
);
745 sp
= n_string_reserve(sp
, l1
+ 1 + l2
+1);
746 sp
= n_string_push_buf(sp
, home
, l1
);
747 sp
= n_string_push_c(sp
, '/');
748 sp
= n_string_push_buf(sp
, cp
, l2
);
749 cp
= n_string_cp(sp
);
754 /* TODO Since our visual mailname is resolved via realpath(3) if available
755 * TODO to avoid that we loose track of our currently open folder in case
756 * TODO we chdir away, but still checks the leading path portion against
757 * TODO fold_query() to be able to abbreviate to the +FOLDER syntax if
758 * TODO possible, we need to realpath(3) the folder, too */
761 # ifndef HAVE_REALPATH_NULL
763 sp
= n_string_drop_ownership(sp
);
764 sp
= n_string_reserve(sp
, PATH_MAX
+1);
769 if((sp
->s_dat
= realpath(cp
, sp
->s_dat
)) != NULL
){
770 # ifdef HAVE_REALPATH_NULL
771 sp
->s_dat
= savestr(cp
= sp
->s_dat
);
775 }else if(errno
== ENOENT
)
778 n_err(_("Can't canonicalize *folder*: %s\n"),
779 n_shell_quote_cp(cp
, FAL0
));
784 #endif /* HAVE_REALPATH */
788 bool_t reset
= !(pstate
& PS_ROOT
);
791 ok_vset(_folder_resolved
, rv
);
798 n_err(_("*folder* is not resolvable, using CWD\n"));
799 assert(rv
!= NULL
&& *rv
== '\0');