1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Maildir folder support. FIXME rewrite - why do we chdir(2)??
3 *@ FIXME indeed - my S-Postman Python (!) is faster dealing with maildir!!
5 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
6 * Copyright (c) 2012 - 2015 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
10 * Gunnar Ritter. All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by Gunnar Ritter
23 * and his contributors.
24 * 4. Neither the name of Gunnar Ritter nor the names of his contributors
25 * may be used to endorse or promote products derived from this software
26 * without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY GUNNAR RITTER AND CONTRIBUTORS ``AS IS'' AND
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL GUNNAR RITTER OR CONTRIBUTORS BE LIABLE
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 #define n_FILE maildir
43 #ifndef HAVE_AMALGAMATION
50 struct message
*md_data
;
54 static struct mditem
*_maildir_table
;
55 static ui32_t _maildir_prime
;
56 static sigjmp_buf _maildir_jmp
;
58 static void __maildircatch(int s
);
59 static void __maildircatch_hold(int s
);
61 /* Do some cleanup in the tmp/ subdir */
62 static void _cleantmp(void);
64 static int _maildir_setfile1(char const *name
, enum fedit_mode fm
,
67 /* In combination with the names from mkname(), this comparison function
68 * ensures that the order of messages in a maildir folder created by mailx
69 * remains always the same. In effect, if a mbox folder is transferred to
70 * a maildir folder by 'copy *', the message order wont' change */
71 static int mdcmp(void const *a
, void const *b
);
73 static int _maildir_subdir(char const *name
, char const *sub
,
76 static void _maildir_append(char const *name
, char const *sub
,
79 static void readin(char const *name
, struct message
*m
);
81 static void maildir_update(void);
83 static void _maildir_move(struct message
*m
);
85 static char * mkname(time_t t
, enum mflag f
, char const *pref
);
87 static enum okay
maildir_append1(char const *name
, FILE *fp
, off_t off1
,
88 long size
, enum mflag flag
);
90 static enum okay
trycreate(char const *name
);
92 static enum okay
mkmaildir(char const *name
);
94 static struct message
* mdlook(char const *name
, struct message
*data
);
96 static void mktable(void);
98 static enum okay
subdir_remove(char const *name
, char const *sub
);
101 __maildircatch(int s
)
103 NYD_X
; /* Signal handler */
104 siglongjmp(_maildir_jmp
, s
);
108 __maildircatch_hold(int s
)
110 NYD_X
; /* Signal handler */
112 /* TODO no STDIO in signal handler, no _() tr's -- pre-translate interrupt
114 n_err_sighdl(_("\nImportant operation in progress: "
115 "interrupt again to forcefully abort\n"));
116 safe_signal(SIGINT
, &__maildircatch
);
129 if ((dirp
= opendir("tmp")) == NULL
)
132 now
= n_time_epoch();
133 while ((dp
= readdir(dirp
)) != NULL
) {
134 if (dp
->d_name
[0] == '.')
136 sstpcpy(sstpcpy(dep
, "tmp/"), dp
->d_name
);
137 if (stat(dep
, &st
) < 0)
139 if (st
.st_atime
+ 36*3600 < now
)
148 _maildir_setfile1(char const *name
, enum fedit_mode fm
, int omsgCount
)
153 if (!(fm
& FEDIT_NEWMAIL
))
156 mb
.mb_perm
= ((options
& OPT_R_FLAG
) || (fm
& FEDIT_RDONLY
)) ? 0 : MB_DELE
;
157 if ((i
= _maildir_subdir(name
, "cur", fm
)) != 0)
159 if ((i
= _maildir_subdir(name
, "new", fm
)) != 0)
161 _maildir_append(name
, NULL
, NULL
);
164 for (i
= ((fm
& FEDIT_NEWMAIL
) ? omsgCount
: 0); i
< msgCount
; ++i
) {
165 readin(name
, message
+ i
);
170 if (fm
& FEDIT_NEWMAIL
) {
171 if (msgCount
> omsgCount
)
172 qsort(&message
[omsgCount
], msgCount
- omsgCount
, sizeof *message
,
175 qsort(message
, msgCount
, sizeof *message
, &mdcmp
);
183 mdcmp(void const *a
, void const *b
)
185 struct message
const *mpa
= a
, *mpb
= b
;
189 if ((i
= mpa
->m_time
- mpb
->m_time
) == 0)
190 i
= strcmp(mpa
->m_maildir_file
+ 4, mpb
->m_maildir_file
+ 4);
196 _maildir_subdir(char const *name
, char const *sub
, enum fedit_mode fm
)
203 if ((dirp
= opendir(sub
)) == NULL
) {
204 n_err(_("Cannot open directory \"%s/%s\"\n"), name
, sub
);
208 if (access(sub
, W_OK
) == -1)
210 while ((dp
= readdir(dirp
)) != NULL
) {
211 if (dp
->d_name
[0] == '.' && (dp
->d_name
[1] == '\0' ||
212 (dp
->d_name
[1] == '.' && dp
->d_name
[2] == '\0')))
214 if (dp
->d_name
[0] == '.')
216 if (!(fm
& FEDIT_NEWMAIL
) || mdlook(dp
->d_name
, NULL
) == NULL
)
217 _maildir_append(name
, sub
, dp
->d_name
);
227 _maildir_append(char const *name
, char const *sub
, char const *fn
)
232 enum mflag f
= MUSED
| MNOFROM
| MNEWEST
;
238 if (fn
!= NULL
&& sub
!= NULL
) {
239 if (!strcmp(sub
, "new"))
241 t
= strtol(fn
, &xp
, 10);
242 if ((cp
= strrchr(xp
, ',')) != NULL
&& PTRCMP(cp
, >, xp
+ 2) &&
243 cp
[-1] == '2' && cp
[-2] == ':') {
244 while (*++cp
!= '\0') {
266 /* Ensure room (and a NULLified last entry) */
268 message_append(NULL
);
271 if (fn
== NULL
|| sub
== NULL
)
274 m
= message
+ msgCount
++;
276 m
->m_maildir_file
= smalloc((sz
= strlen(sub
)) + i
+ 1 +1);
277 memcpy(m
->m_maildir_file
, sub
, sz
);
278 m
->m_maildir_file
[sz
] = '/';
279 memcpy(m
->m_maildir_file
+ sz
+ 1, fn
, i
+1);
282 m
->m_maildir_hash
= ~pjw(fn
);
289 readin(char const *name
, struct message
*m
)
292 size_t bufsize
, buflen
, cnt
;
293 long size
= 0, lines
= 0;
299 if ((fp
= Fopen(m
->m_maildir_file
, "r")) == NULL
) {
300 n_err(_("Cannot read \"%s/%s\" for message %lu\n"),
301 name
, m
->m_maildir_file
, (ul_i
)PTR2SIZE(m
- message
+ 1));
302 m
->m_flag
|= MHIDDEN
;
307 fseek(mb
.mb_otf
, 0L, SEEK_END
);
308 offset
= ftell(mb
.mb_otf
);
309 buf
= smalloc(bufsize
= LINESIZE
);
311 while (fgetline(&buf
, &bufsize
, &cnt
, &buflen
, fp
, 1) != NULL
) {
312 /* Since we simply copy over data without doing any transfer
313 * encoding reclassification/adjustment we *have* to perform
314 * RFC 4155 compliant From_ quoting here */
315 if (emptyline
&& is_head(buf
, buflen
, TRU1
)) {
316 putc('>', mb
.mb_otf
);
319 size
+= fwrite(buf
, 1, buflen
, mb
.mb_otf
);/*XXX err hdling*/
320 emptyline
= (*buf
== '\n');
325 putc('\n', mb
.mb_otf
);
332 m
->m_size
= m
->m_xsize
= size
;
333 m
->m_lines
= m
->m_xlines
= lines
;
334 m
->m_block
= mailx_blockof(offset
);
335 m
->m_offset
= mailx_offsetof(offset
);
345 int dodel
, c
, gotcha
= 0, held
= 0, modflags
= 0;
351 if (!(pstate
& PS_EDIT
)) {
353 for (m
= message
, c
= 0; PTRCMP(m
, <, message
+ msgCount
); ++m
) {
354 if (m
->m_flag
& MBOX
)
358 if (makembox() == STOP
)
361 for (m
= message
, gotcha
= 0, held
= 0; PTRCMP(m
, <, message
+ msgCount
);
363 if (pstate
& PS_EDIT
)
364 dodel
= m
->m_flag
& MDELETED
;
366 dodel
= !((m
->m_flag
& MPRESERVE
) || !(m
->m_flag
& MTOUCH
));
368 if (unlink(m
->m_maildir_file
) < 0)
369 n_err(_("Cannot delete file \"%s/%s\" for message %lu\n"),
370 mailname
, m
->m_maildir_file
, (ul_i
)PTR2SIZE(m
- message
+ 1));
374 if ((m
->m_flag
& (MREAD
| MSTATUS
)) == (MREAD
| MSTATUS
) ||
375 (m
->m_flag
& (MNEW
| MBOXED
| MSAVED
| MSTATUS
| MFLAG
|
376 MUNFLAG
| MANSWER
| MUNANSWER
| MDRAFT
| MUNDRAFT
))) {
384 if ((gotcha
|| modflags
) && (pstate
& PS_EDIT
)) {
385 printf(_("\"%s\" "), displayname
);
386 printf((ok_blook(bsdcompat
) || ok_blook(bsdmsgs
))
387 ? _("complete\n") : _("updated.\n"));
388 } else if (held
&& !(pstate
& PS_EDIT
) && mb
.mb_perm
!= 0) {
390 printf(_("Held 1 message in %s\n"), displayname
);
392 printf(_("Held %d messages in %s\n"), held
, displayname
);
396 for (m
= message
; PTRCMP(m
, <, message
+ msgCount
); ++m
)
397 free(m
->m_maildir_file
);
402 _maildir_move(struct message
*m
)
407 fn
= mkname(0, m
->m_flag
, m
->m_maildir_file
+ 4);
408 new = savecat("cur/", fn
);
409 if (!strcmp(m
->m_maildir_file
, new))
411 if (link(m
->m_maildir_file
, new) == -1) {
412 n_err(_("Cannot link \"%s/%s\" to \"%s/%s\": "
413 "message %lu not touched\n"),
414 mailname
, m
->m_maildir_file
, mailname
, new,
415 (ul_i
)PTR2SIZE(m
- message
+ 1));
418 if (unlink(m
->m_maildir_file
) == -1)
419 n_err(_("Cannot unlink \"%s/%s\"\n"), mailname
, m
->m_maildir_file
);
425 mkname(time_t t
, enum mflag f
, char const *pref
)
427 static unsigned long cnt
;
428 static pid_t mypid
; /* XXX This should possibly be global, somehow */
442 if (UICMP(32, n
, <, size
+ 8))
443 node
= srealloc(node
, size
+= 20);
446 node
[n
++] = '\\', node
[n
++] = '0',
447 node
[n
++] = '5', node
[n
++] = '7';
450 node
[n
++] = '\\', node
[n
++] = '0',
451 node
[n
++] = '7', node
[n
++] = '2';
456 } while (*cp
++ != '\0');
458 size
= 60 + strlen(node
);
460 n
= snprintf(cp
, size
, "%lu.%06lu_%06lu.%s:2,",
461 (ul_i
)t
, (ul_i
)mypid
, ++cnt
, node
);
463 size
= (n
= strlen(pref
)) + 13;
465 memcpy(cp
, pref
, n
+1);
466 for (i
= n
; i
> 3; --i
)
467 if (cp
[i
- 1] == ',' && cp
[i
- 2] == '2' && cp
[i
- 3] == ':') {
472 memcpy(cp
+ n
, ":2,", 3 +1);
494 maildir_append1(char const *name
, FILE *fp
, off_t off1
, long size
,
497 char buf
[4096], *fn
, *tfn
, *nfn
;
501 size_t nlen
, flen
, n
;
507 /* Create a unique temporary file */
508 for (nfn
= (char*)0xA /* XXX no magic */;; sleep(1)) {
509 now
= n_time_epoch();
510 flen
= strlen(fn
= mkname(now
, flag
, NULL
));
511 tfn
= salloc(n
= nlen
+ flen
+ 6);
512 snprintf(tfn
, n
, "%s/tmp/%s", name
, fn
);
514 /* Use "wx" for O_EXCL XXX stat(2) rather redundant; coverity:TOCTOU */
515 if ((!stat(tfn
, &st
) || errno
== ENOENT
) &&
516 (op
= Fopen(tfn
, "wx")) != NULL
)
519 nfn
= (char*)(PTR2SIZE(nfn
) - 1);
521 n_err(_("Can't create an unique file name in \"%s/tmp\"\n"), name
);
526 if (fseek(fp
, off1
, SEEK_SET
) == -1)
529 size_t z
= UICMP(z
, size
, >, sizeof buf
) ? sizeof buf
: (size_t)size
;
531 if (z
!= (n
= fread(buf
, 1, z
, fp
)) || n
!= fwrite(buf
, 1, n
, op
)) {
533 n_err(_("Error writing to \"%s\"\n"), tfn
);
541 nfn
= salloc(n
= nlen
+ flen
+ 6);
542 snprintf(nfn
, n
, "%s/new/%s", name
, fn
);
543 if (link(tfn
, nfn
) == -1) {
544 n_err(_("Cannot link \"%s\" to \"%s\"\n"), tfn
, nfn
);
549 if (unlink(tfn
) == -1)
550 n_err(_("Cannot unlink \"%s\"\n"), tfn
);
557 trycreate(char const *name
)
563 if (!stat(name
, &st
)) {
564 if (!S_ISDIR(st
.st_mode
)) {
565 n_err(_("\"%s\" is not a directory\n"), name
);
568 } else if (makedir(name
) != OKAY
) {
569 n_err(_("Cannot create directory \"%s\"\n"), name
);
572 ++imap_created_mailbox
;
580 mkmaildir(char const *name
) /* TODO proper cleanup on error; use path[] loop */
587 if (trycreate(name
) == OKAY
) {
588 np
= ac_alloc((sz
= strlen(name
)) + 4 +1);
589 memcpy(np
, name
, sz
);
590 memcpy(np
+ sz
, "/tmp", 4 +1);
591 if (trycreate(np
) == OKAY
) {
592 memcpy(np
+ sz
, "/new", 4 +1);
593 if (trycreate(np
) == OKAY
) {
594 memcpy(np
+ sz
, "/cur", 4 +1);
604 static struct message
*
605 mdlook(char const *name
, struct message
*data
)
611 if (data
&& data
->m_maildir_hash
)
612 h
= ~data
->m_maildir_hash
;
617 md
= _maildir_table
+ c
;
619 while (md
->md_data
!= NULL
) {
620 if (!strcmp(md
->md_data
->m_maildir_file
+ 4, name
))
622 c
+= (n
& 1) ? -((n
+1)/2) * ((n
+1)/2) : ((n
+1)/2) * ((n
+1)/2);
624 while (c
>= _maildir_prime
)
626 md
= _maildir_table
+ c
;
628 if (data
!= NULL
&& md
->md_data
== NULL
)
641 _maildir_prime
= nextprime(msgCount
);
642 _maildir_table
= scalloc(_maildir_prime
, sizeof *_maildir_table
);
643 for (mp
= message
, i
= msgCount
; i
-- != 0; ++mp
)
644 mdlook(mp
->m_maildir_file
+ 4, mp
);
649 subdir_remove(char const *name
, char const *sub
)
652 int pathsize
, pathend
, namelen
, sublen
, n
;
658 namelen
= strlen(name
);
659 sublen
= strlen(sub
);
660 path
= smalloc(pathsize
= namelen
+ sublen
+ 30 +1);
661 memcpy(path
, name
, namelen
);
663 memcpy(path
+ namelen
+ 1, sub
, sublen
);
664 path
[namelen
+ sublen
+ 1] = '/';
665 path
[pathend
= namelen
+ sublen
+ 2] = '\0';
667 if ((dirp
= opendir(path
)) == NULL
) {
671 while ((dp
= readdir(dirp
)) != NULL
) {
672 if (dp
->d_name
[0] == '.' && (dp
->d_name
[1] == '\0' ||
673 (dp
->d_name
[1] == '.' && dp
->d_name
[2] == '\0')))
675 if (dp
->d_name
[0] == '.')
677 n
= strlen(dp
->d_name
);
678 if (UICMP(32, pathend
+ n
+1, >, pathsize
))
679 path
= srealloc(path
, pathsize
= pathend
+ n
+ 30);
680 memcpy(path
+ pathend
, dp
->d_name
, n
+1);
681 if (unlink(path
) == -1) {
689 path
[pathend
] = '\0';
690 if (rmdir(path
) == -1) {
702 maildir_setfile(char const * volatile name
, enum fedit_mode fm
)
704 sighandler_type
volatile saveint
;
706 int i
= -1, omsgCount
;
709 omsgCount
= msgCount
;
710 if (cwget(&cw
) == STOP
) {
711 n_alert(_("Cannot open current directory"));
715 if (!(fm
& FEDIT_NEWMAIL
))
718 saveint
= safe_signal(SIGINT
, SIG_IGN
);
720 if (!(fm
& FEDIT_NEWMAIL
)) {
721 if (fm
& FEDIT_SYSBOX
)
734 mb
.mb_type
= MB_MAILDIR
;
737 if (chdir(name
) < 0) {
738 n_err(_("Cannot change directory to \"%s\"\n"), name
);
739 mb
.mb_type
= MB_VOID
;
743 safe_signal(SIGINT
, saveint
);
747 _maildir_table
= NULL
;
748 if (sigsetjmp(_maildir_jmp
, 1) == 0) {
749 if (fm
& FEDIT_NEWMAIL
)
751 if (saveint
!= SIG_IGN
)
752 safe_signal(SIGINT
, &__maildircatch
);
753 i
= _maildir_setfile1(name
, fm
, omsgCount
);
755 if ((fm
& FEDIT_NEWMAIL
) && _maildir_table
!= NULL
)
756 free(_maildir_table
);
758 safe_signal(SIGINT
, saveint
);
761 mb
.mb_type
= MB_VOID
;
766 if (cwret(&cw
) == STOP
)
767 n_panic(_("Cannot change back to current directory"));
771 if ((fm
& FEDIT_NEWMAIL
) && mb
.mb_sorted
&& msgCount
> omsgCount
) {
776 if (!(fm
& FEDIT_NEWMAIL
))
777 pstate
&= ~PS_SAW_COMMAND
;
779 if (options
& OPT_EXISTONLY
) {
784 if (!(fm
& FEDIT_NEWMAIL
) && (fm
& FEDIT_SYSBOX
) && msgCount
== 0) {
785 if (mb
.mb_type
== MB_MAILDIR
/* XXX ?? */ && !ok_blook(emptystart
))
786 n_err(_("No mail at \"%s\"\n"), name
);
791 if ((fm
& FEDIT_NEWMAIL
) && msgCount
> omsgCount
)
792 newmailinfo(omsgCount
);
802 sighandler_type saveint
;
806 if (cwget(&cw
) == STOP
) {
807 n_alert(_("Cannot open current directory"));
811 saveint
= safe_signal(SIGINT
, SIG_IGN
);
813 if (chdir(mailname
) == -1) {
814 n_err(_("Cannot change directory to \"%s\"\n"), mailname
);
816 safe_signal(SIGINT
, saveint
);
820 if (sigsetjmp(_maildir_jmp
, 1) == 0) {
821 if (saveint
!= SIG_IGN
)
822 safe_signal(SIGINT
, &__maildircatch_hold
);
826 safe_signal(SIGINT
, saveint
);
828 if (cwret(&cw
) == STOP
)
829 n_panic(_("Cannot change back to current directory"));
836 maildir_append(char const *name
, FILE *fp
, long offset
)
839 size_t bufsize
, buflen
, cnt
;
840 off_t off1
= -1, offs
;
843 enum {_NONE
= 0, _INHEAD
= 1<<0, _NLSEP
= 1<<1} state
;
847 if ((rv
= mkmaildir(name
)) != OKAY
)
850 buf
= smalloc(bufsize
= LINESIZE
); /* TODO line pool; signals */
853 offs
= offset
/* BSD will move due to O_APPEND! ftell(fp) */;
857 for (flag
= MNEW
, state
= _NLSEP
;;) {
858 bp
= fgetline(&buf
, &bufsize
, &cnt
, &buflen
, fp
, 1);
861 ((state
& (_INHEAD
| _NLSEP
)) == _NLSEP
&&
862 is_head(buf
, buflen
, FAL0
))) {
863 if (off1
!= (off_t
)-1) {
864 if ((rv
= maildir_append1(name
, fp
, off1
, size
, flag
)) == STOP
)
867 if (fseek(fp
, offs
+ buflen
, SEEK_SET
) == -1) {
872 off1
= offs
+ buflen
;
884 if (buf
[0] == '\n') {
887 } else if (state
& _INHEAD
) {
888 if (!ascncasecmp(buf
, "status", 6)) {
890 while (whitechar(*lp
))
893 while (*++lp
!= '\0')
902 } else if (!ascncasecmp(buf
, "x-status", 8)) {
904 while (whitechar(*lp
))
907 while (*++lp
!= '\0')
933 maildir_remove(char const *name
)
938 if (subdir_remove(name
, "tmp") == STOP
||
939 subdir_remove(name
, "new") == STOP
||
940 subdir_remove(name
, "cur") == STOP
)
942 if (rmdir(name
) == -1) {