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 - 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
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_shexp_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
)){
122 /* We want to see the name of the folder .. on the screen */
124 if (i
< sizeof(displayname
) -1)
125 memcpy(dispp
, mailp
, i
+1);
128 /* Avoid disrupting multibyte sequences (if possible) */
129 #ifndef HAVE_C90AMEND1
130 j
= sizeof(displayname
) / 3 - 1;
131 i
-= sizeof(displayname
) - (1/* + */ + 3) - j
;
133 j
= field_detect_clip(sizeof(displayname
) / 3, mailp
, i
);
134 i
= j
+ __narrow_suffix(mailp
+ j
, i
- j
,
135 sizeof(displayname
) - (1/* + */ + 3 + 1) - j
);
137 snprintf(dispp
, sizeof(displayname
), "%.*s...%s",
138 (int)j
, mailp
, mailp
+ i
);
142 bool_t reset
= !(pstate
& PS_ROOT
);
145 ok_vset(_mailbox_resolved
, mailname
);
146 ok_vset(_mailbox_display
, displayname
);
155 setfile(char const *name
, enum fedit_mode fm
) /* TODO oh my god */
162 int rv
, omsgCount
= 0;
163 FILE *ibuf
= NULL
, *lckfp
= NULL
;
164 bool_t isdevnull
= FAL0
;
167 pstate
&= ~PS_SETFILE_OPENED
;
170 enum fexp_mode fexpm
;
172 if((who
= shortcut_expand(name
)) != NULL
){
173 fexpm
= FEXP_NSHORTCUT
| FEXP_NSHELL
;
179 fm
|= FEDIT_SYSBOX
; /* TODO fexpand() needs to tell is-valid-user! */
180 if(*(who
= &name
[1]) == ':')
186 who
= ok_vlook(LOGNAME
);
188 if ((name
= fexpand(name
, fexpm
)) == NULL
)
192 /* For at least substdate() users */
193 time_current_update(&time_current
, FAL0
);
195 switch (which_protocol(name
)) {
197 if (temporary_protocol_ext
!= NULL
)
198 name
= savecat(name
, temporary_protocol_ext
);
199 isdevnull
= ((options
& OPT_BATCH_FLAG
) && !strcmp(name
, "/dev/null"));
201 do { /* TODO we need objects, goes away then */
202 # ifdef HAVE_REALPATH_NULL
205 if ((cp
= realpath(name
, NULL
)) != NULL
) {
212 if (realpath(name
, cbuf
) != NULL
)
213 name
= savestr(cbuf
);
221 rv
= maildir_setfile(name
, fm
);
226 rv
= pop3_setfile(name
, fm
);
230 n_err(_("Cannot handle protocol: %s\n"), name
);
234 if ((ibuf
= Zopen(name
, "r")) == NULL
) {
237 if ((fm
& FEDIT_SYSBOX
) && e
== ENOENT
) {
238 if (strcmp(who
, ok_vlook(LOGNAME
)) && getpwnam(who
) == NULL
) {
239 n_err(_("%s is not a user of this system\n"),
240 n_shexp_quote_cp(who
, FAL0
));
243 if (!(options
& OPT_QUICKRUN_MASK
) && ok_blook(bsdcompat
))
244 n_err(_("No mail for %s\n"), who
);
246 if (fm
& FEDIT_NEWMAIL
)
249 mb
.mb_type
= MB_VOID
;
250 if (ok_blook(emptystart
)) {
251 if (!(options
& OPT_QUICKRUN_MASK
) && !ok_blook(bsdcompat
))
253 /* We must avoid returning -1 and causing program exit */
261 if (fstat(fileno(ibuf
), &stb
) == -1) {
262 if (fm
& FEDIT_NEWMAIL
)
264 n_perr(_("fstat"), 0);
268 if (S_ISREG(stb
.st_mode
) || isdevnull
) {
271 if (fm
& FEDIT_NEWMAIL
)
273 errno
= S_ISDIR(stb
.st_mode
) ? EISDIR
: EINVAL
;
278 if (shudclob
&& !(fm
& FEDIT_NEWMAIL
) && !quit(FAL0
))
284 if (!(fm
& FEDIT_NEWMAIL
) && mb
.mb_sock
.s_fd
>= 0)
285 sclose(&mb
.mb_sock
); /* TODO sorry? VMAILFS->close(), thank you */
288 /* TODO There is no intermediate VOID box we've switched to: name may
289 * TODO point to the same box that we just have written, so any updates
290 * TODO we won't see! Reopen again in this case. RACY! Goes with VOID! */
291 /* TODO In addition: in case of compressed/hook boxes we lock a temporary! */
292 /* TODO We may uselessly open twice but quit() doesn't say whether we were
293 * TODO modified so we can't tell: Mailbox::is_modified() :-(( */
294 if (/*shudclob && !(fm & FEDIT_NEWMAIL) &&*/ !strcmp(name
, mailname
)) {
298 if ((ibuf
= Zopen(name
, "r")) == NULL
||
299 fstat(fileno(ibuf
), &stb
) == -1 ||
300 (!S_ISREG(stb
.st_mode
) && !isdevnull
)) {
307 /* Copy the messages into /tmp and set pointers */
308 if (!(fm
& FEDIT_NEWMAIL
)) {
310 mb
.mb_type
= MB_VOID
;
313 mb
.mb_type
= MB_FILE
;
314 mb
.mb_perm
= (((options
& OPT_R_FLAG
) || (fm
& FEDIT_RDONLY
) ||
315 access(name
, W_OK
) < 0) ? 0 : MB_DELE
| MB_EDIT
);
328 if (fm
& FEDIT_SYSBOX
)
335 fseek(mb
.mb_otf
, 0L, SEEK_END
);
336 /* TODO Doing this without holding a lock is.. And not err checking.. */
337 fseek(ibuf
, mailsize
, SEEK_SET
);
339 omsgCount
= msgCount
;
344 else if (!(pstate
& PS_EDIT
))
345 lckfp
= n_dotlock(name
, fileno(ibuf
), FLT_READ
, offset
,0,
346 (fm
& FEDIT_NEWMAIL
? 0 : UIZ_MAX
));
347 else if (n_file_lock(fileno(ibuf
), FLT_READ
, offset
,0,
348 (fm
& FEDIT_NEWMAIL
? 0 : UIZ_MAX
)))
352 if (!(fm
& FEDIT_NEWMAIL
)) {
353 char const *emsg
= (pstate
& PS_EDIT
)
354 ? N_("Unable to lock mailbox, aborting operation")
355 : N_("Unable to (dot) lock mailbox, aborting operation");
359 if (!(fm
& FEDIT_NEWMAIL
))
364 mailsize
= fsize(ibuf
);
366 /* TODO This is too simple minded? We should regenerate an index file
367 * TODO to be able to truly tell whether *anything* has changed! */
368 if ((fm
& FEDIT_NEWMAIL
) && UICMP(z
, mailsize
, <=, offset
)) {
372 setptr(ibuf
, offset
);
374 if ((fm
& FEDIT_NEWMAIL
) && mb
.mb_sorted
) {
381 if (lckfp
!= NULL
&& lckfp
!= (FILE*)-1) {
386 if (!(fm
& FEDIT_NEWMAIL
)) {
387 pstate
&= ~PS_SAW_COMMAND
;
388 pstate
|= PS_SETFILE_OPENED
;
393 if ((options
& OPT_EXISTONLY
) && !(options
& OPT_HEADERLIST
)) {
394 rv
= (msgCount
== 0);
398 if ((!(pstate
& PS_EDIT
) || (fm
& FEDIT_NEWMAIL
)) && msgCount
== 0) {
399 if (!(fm
& FEDIT_NEWMAIL
)) {
400 if (!ok_blook(emptystart
))
401 n_err(_("No mail for %s\n"), who
);
406 if (fm
& FEDIT_NEWMAIL
)
407 newmailinfo(omsgCount
);
413 if (lckfp
!= NULL
&& lckfp
!= (FILE*)-1)
419 mb
.mb_type
= MB_VOID
;
426 newmailinfo(int omsgCount
)
431 for (i
= 0; i
< omsgCount
; ++i
)
432 message
[i
].m_flag
&= ~MNEWEST
;
434 if (msgCount
> omsgCount
) {
435 for (i
= omsgCount
; i
< msgCount
; ++i
)
436 message
[i
].m_flag
|= MNEWEST
;
437 printf(_("New mail has arrived.\n"));
438 if ((i
= msgCount
- omsgCount
) == 1)
439 printf(_("Loaded 1 new message.\n"));
441 printf(_("Loaded %d new messages.\n"), i
);
443 printf(_("Loaded %d messages.\n"), msgCount
);
445 check_folder_hook(TRU1
);
449 if (ok_blook(header
))
450 print_headers(omsgCount
+ 1, msgCount
, FAL0
);
459 if (n_msgvec
!= NULL
)
461 n_msgvec
= scalloc(sz
+ 1, sizeof *n_msgvec
);
466 print_header_summary(char const *Larg
)
468 size_t bot
, top
, i
, j
;
472 /* Avoid any messages XXX add a make_mua_silent() and use it? */
473 if ((options
& (OPT_VERB
| OPT_EXISTONLY
)) == OPT_EXISTONLY
) {
474 freopen("/dev/null", "w", stdout
);
475 freopen("/dev/null", "w", stderr
);
477 assert(n_msgvec
!= NULL
);
478 i
= (getmsglist(/*TODO make const */n_UNCONST(Larg
), n_msgvec
, 0) <= 0);
479 if (options
& OPT_EXISTONLY
) {
480 exit_status
= (int)i
;
485 for (bot
= msgCount
, top
= 0, i
= 0; (j
= n_msgvec
[i
]) != 0; ++i
) {
492 bot
= 1, top
= msgCount
;
493 print_headers(bot
, top
, (Larg
!= NULL
)); /* TODO should take iterator!! */
499 announce(int printheaders
)
504 mdot
= newfileinfo();
507 dot
= message
+ mdot
- 1;
508 if (printheaders
&& msgCount
> 0 && ok_blook(header
)) {
509 print_header_group(vec
); /* XXX errors? */
518 int u
, n
, mdot
, d
, s
, hidden
, moved
;
521 if (mb
.mb_type
== MB_VOID
) {
527 s
= d
= hidden
= moved
=0;
528 for (mp
= message
, n
= 0, u
= 0; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
529 if (mp
->m_flag
& MNEW
)
531 if ((mp
->m_flag
& MREAD
) == 0)
533 if ((mp
->m_flag
& (MDELETED
| MSAVED
)) == (MDELETED
| MSAVED
))
535 if ((mp
->m_flag
& (MDELETED
| MSAVED
)) == MDELETED
)
537 if ((mp
->m_flag
& (MDELETED
| MSAVED
)) == MSAVED
)
539 if (mp
->m_flag
& MHIDDEN
)
543 /* If displayname gets truncated the user effectively has no option to see
544 * the full pathname of the mailbox, so print it at least for '? fi' */
545 printf(_("%s: "), n_shexp_quote_cp(
546 (_update_mailname(NULL
) ? displayname
: mailname
), FAL0
));
548 printf(_("1 message"));
550 printf(_("%d messages"), msgCount
);
552 printf(_(" %d new"), n
);
554 printf(_(" %d unread"), u
);
556 printf(_(" %d deleted"), d
);
558 printf(_(" %d saved"), s
);
560 printf(_(" %d moved"), moved
);
562 printf(_(" %d hidden"), hidden
);
563 else if (mb
.mb_perm
== 0)
564 printf(_(" [Read only]"));
577 enum mflag avoid
= MHIDDEN
| MDELETED
;
581 if (ok_blook(autothread
)) {
582 OBSOLETE(_("please use *autosort=thread* instead of *autothread*"));
584 } else if ((cp
= ok_vlook(autosort
)) != NULL
) {
585 if (mb
.mb_sorted
!= NULL
)
587 mb
.mb_sorted
= sstrdup(cp
);
591 if (mb
.mb_type
== MB_VOID
) {
597 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
598 if ((mp
->m_flag
& (MNEWEST
| avoid
)) == MNEWEST
)
601 if (!nmail
|| PTRCMP(mp
, >=, message
+ msgCount
)) {
602 if (mb
.mb_threaded
) {
603 for (mp
= threadroot
; mp
!= NULL
; mp
= next_in_thread(mp
))
604 if ((mp
->m_flag
& (MNEW
| avoid
)) == MNEW
)
607 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
608 if ((mp
->m_flag
& (MNEW
| avoid
)) == MNEW
)
613 if ((mb
.mb_threaded
? (mp
== NULL
) : PTRCMP(mp
, >=, message
+ msgCount
))) {
614 if (mb
.mb_threaded
) {
615 for (mp
= threadroot
; mp
!= NULL
; mp
= next_in_thread(mp
))
616 if (mp
->m_flag
& MFLAGGED
)
619 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
620 if (mp
->m_flag
& MFLAGGED
)
625 if ((mb
.mb_threaded
? (mp
== NULL
) : PTRCMP(mp
, >=, message
+ msgCount
))) {
626 if (mb
.mb_threaded
) {
627 for (mp
= threadroot
; mp
!= NULL
; mp
= next_in_thread(mp
))
628 if (!(mp
->m_flag
& (MREAD
| avoid
)))
631 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
632 if (!(mp
->m_flag
& (MREAD
| avoid
)))
638 (mb
.mb_threaded
? (mp
!= NULL
) : PTRCMP(mp
, <, message
+ msgCount
)))
639 mdot
= (int)PTR2SIZE(mp
- message
+ 1);
640 else if (ok_blook(showlast
)) {
641 if (mb
.mb_threaded
) {
642 for (mp
= this_in_thread(threadroot
, -1); mp
;
643 mp
= prev_in_thread(mp
))
644 if (!(mp
->m_flag
& avoid
))
646 mdot
= (mp
!= NULL
) ? (int)PTR2SIZE(mp
- message
+ 1) : msgCount
;
648 for (mp
= message
+ msgCount
- 1; mp
>= message
; --mp
)
649 if (!(mp
->m_flag
& avoid
))
651 mdot
= (mp
>= message
) ? (int)PTR2SIZE(mp
- message
+ 1) : msgCount
;
654 (mb
.mb_threaded
? (mp
!= NULL
) : PTRCMP(mp
, <, message
+ msgCount
)))
655 mdot
= (int)PTR2SIZE(mp
- message
+ 1);
656 else if (mb
.mb_threaded
) {
657 for (mp
= threadroot
; mp
; mp
= next_in_thread(mp
))
658 if (!(mp
->m_flag
& avoid
))
660 mdot
= (mp
!= NULL
) ? (int)PTR2SIZE(mp
- message
+ 1) : 1;
662 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
663 if (!(mp
->m_flag
& avoid
))
665 mdot
= PTRCMP(mp
, <, message
+ msgCount
)
666 ? (int)PTR2SIZE(mp
- message
+ 1) : 1;
674 initbox(char const *name
)
679 if (mb
.mb_type
!= MB_VOID
)
680 n_strscpy(prevfile
, mailname
, PATH_MAX
);
682 /* TODO name always NE mailname (but goes away for objects anyway)
683 * TODO Well, not true no more except that in parens */
684 _update_mailname((name
!= mailname
) ? name
: NULL
);
686 if ((mb
.mb_otf
= Ftmp(&tempMesg
, "tmpmbox", OF_WRONLY
| OF_HOLDSIGS
)) ==
688 n_perr(_("temporary mail message file"), 0);
691 if ((mb
.mb_itf
= safe_fopen(tempMesg
, "r", NULL
)) == NULL
) {
692 n_perr(_("temporary mail message file"), 0);
695 Ftmp_release(&tempMesg
);
699 if (mb
.mb_sorted
!= NULL
) {
703 dot
= prevdot
= threadroot
= NULL
;
704 pstate
&= ~PS_DID_PRINT_DOT
;
710 struct n_string s
, *sp
= &s
;
716 sp
= n_string_creat_auto(sp
);
718 /* *folder* is linked with *_folder_resolved*: we only use the latter */
720 if((rv
= ok_vlook(_folder_resolved
)) != NULL
)
724 * If directory does not start with a <slash> ('/'), the contents
725 * of HOME shall be prefixed to it.
727 * If folder is unset or set to null, [.] filenames beginning with
728 * '+' shall refer to files in the current directory.
729 * We may have the result already */
733 if((cp
= ok_vlook(folder
)) == NULL
)
736 /* Expand the *folder*; skip %: prefix for simplicity of use */
737 if(cp
[0] == '%' && cp
[1] == ':')
739 if((err
= (cp
= fexpand(cp
, FEXP_NSPECIAL
| FEXP_NFOLDER
| FEXP_NSHELL
)
740 ) == NULL
) || *cp
== '\0')
743 switch(which_protocol(cp
)){
745 n_err(_("*folder* can't be set to a flat, readonly POP3 account\n"));
749 /* Further expansion desired */
753 /* Prefix HOME as necessary */
754 if(*cp
!= '/'){ /* XXX path_is_absolute() */
758 home
= ok_vlook(HOME
);
762 sp
= n_string_reserve(sp
, l1
+ 1 + l2
+1);
763 sp
= n_string_push_buf(sp
, home
, l1
);
764 sp
= n_string_push_c(sp
, '/');
765 sp
= n_string_push_buf(sp
, cp
, l2
);
766 cp
= n_string_cp(sp
);
767 sp
= n_string_drop_ownership(sp
);
772 /* TODO Since our visual mailname is resolved via realpath(3) if available
773 * TODO to avoid that we loose track of our currently open folder in case
774 * TODO we chdir away, but still checks the leading path portion against
775 * TODO folder_query() to be able to abbreviate to the +FOLDER syntax if
776 * TODO possible, we need to realpath(3) the folder, too */
778 assert(sp
->s_len
== 0 && sp
->s_dat
== NULL
);
779 # ifndef HAVE_REALPATH_NULL
780 sp
= n_string_reserve(sp
, PATH_MAX
+1);
783 if((sp
->s_dat
= realpath(cp
, sp
->s_dat
)) != NULL
){
784 # ifdef HAVE_REALPATH_NULL
785 n_string_cp(sp
= n_string_assign_cp(sp
, cp
= sp
->s_dat
));
789 }else if(errno
== ENOENT
)
792 n_err(_("Can't canonicalize *folder*: %s\n"),
793 n_shexp_quote_cp(cp
, FAL0
));
797 sp
= n_string_drop_ownership(sp
);
798 #endif /* HAVE_REALPATH */
800 /* Always append a solidus to our result path upon success */
804 if(rv
[(i
= strlen(rv
)) - 1] != '/'){
805 sp
= n_string_reserve(sp
, i
+ 1 +1);
806 sp
= n_string_push_buf(sp
, rv
, i
);
807 sp
= n_string_push_c(sp
, '/');
808 rv
= n_string_cp(sp
);
809 sp
= n_string_drop_ownership(sp
);
815 bool_t reset
= !(pstate
& PS_ROOT
);
818 ok_vset(_folder_resolved
, rv
);
825 n_err(_("*folder* is not resolvable, using CWD\n"));
826 assert(rv
!= NULL
&& *rv
== '\0');