1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2015 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
9 * Gunnar Ritter. 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. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by Gunnar Ritter
22 * and his contributors.
23 * 4. Neither the name of Gunnar Ritter nor the names of his contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY GUNNAR RITTER AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL GUNNAR RITTER OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42 #ifndef HAVE_AMALGAMATION
46 /* Open addressing is used for Message-IDs because the maximum number of
47 * messages in the table is known in advance (== msgCount) */
49 struct message
*mi_data
;
52 #define NOT_AN_ID ((struct mitem*)-1)
65 /* Return the hash value for a message id modulo mprime, or mprime if the
66 * passed string does not look like a message-id */
67 static ui32_t
_mhash(char const *cp
, ui32_t mprime
);
69 /* Look up a message id. Returns NOT_AN_ID if the passed string does not look
70 * like a message-id */
71 static struct mitem
* _mlook(char *id
, struct mitem
*mt
,
72 struct message
*mdata
, ui32_t mprime
);
74 /* Child is to be adopted by parent. A thread tree is structured as follows:
76 * ------ m_child ------ m_child
77 * | |-------------------->| |------------------------> . . .
78 * | |<--------------------| |<----------------------- . . .
79 * ------ m_parent ------ m_parent
81 * | \____ m_younger | |
90 * | |------------------------> . . .
91 * | |<----------------------- . . .
96 * The base message of a thread does not have a m_parent link. Elements
97 * connected by m_younger/m_elder links are replies to the same message, which
98 * is connected to them by m_parent links. The first reply to a message gets
100 static void _adopt(struct message
*parent
, struct message
*child
,
103 /* Connect all msgs on the lowest thread level with m_younger/m_elder links */
104 static struct message
* _interlink(struct message
*m
, ui32_t cnt
, int nmail
);
106 static void _finalize(struct message
*mp
);
108 /* Several sort comparison PTFs */
110 static int _mui32lt(void const *a
, void const *b
);
112 static int _mlonglt(void const *a
, void const *b
);
113 static int _mcharlt(void const *a
, void const *b
);
115 static void _lookup(struct message
*m
, struct mitem
*mi
,
117 static void _makethreads(struct message
*m
, ui32_t cnt
, int nmail
);
118 static int _colpt(int *msgvec
, int cl
);
119 static void _colps(struct message
*b
, int cl
);
120 static void _colpm(struct message
*m
, int cl
, int *cc
, int *uc
);
123 _mhash(char const *cp
, ui32_t mprime
)
125 ui32_t h
= 0, g
, at
= 0;
128 for (--cp
; *++cp
!= '\0';) {
129 /* Pay attention not to hash characters which are irrelevant for
130 * Message-ID semantics */
132 cp
= skip_comment(cp
+ 1) - 1;
135 if (*cp
== '"' || *cp
== '\\')
139 /* TODO torek hash */
140 h
= ((h
<< 4) & 0xffffffff) + lowerconv(*cp
);
141 if ((g
= h
& 0xf0000000) != 0) {
147 return (at
? h
% mprime
: mprime
);
150 static struct mitem
*
151 _mlook(char *id
, struct mitem
*mt
, struct message
*mdata
, ui32_t mprime
)
153 struct mitem
*mp
= NULL
;
158 if ((id
= hfield1("message-id", mdata
)) == NULL
)
160 /* Normalize, what hfield1() doesn't do (TODO should now GREF, too!!) */
162 id
[strlen(id
) -1] = '\0';
168 if (mdata
!= NULL
&& mdata
->m_idhash
)
169 h
= ~mdata
->m_idhash
;
171 h
= _mhash(id
, mprime
);
179 while (mp
->mi_id
!= NULL
) {
180 if (!msgidcmp(mp
->mi_id
, id
))
182 c
+= (n
& 1) ? -((n
+1)/2) * ((n
+1)/2) : ((n
+1)/2) * ((n
+1)/2);
189 if (mdata
!= NULL
&& mp
->mi_id
== NULL
) {
190 mp
->mi_id
= sstrdup(id
);
192 mdata
->m_idhash
= ~h
;
194 if (mp
->mi_id
== NULL
)
202 _adopt(struct message
*parent
, struct message
*child
, int dist
)
204 struct message
*mp
, *mq
;
207 for (mp
= parent
; mp
!= NULL
; mp
= mp
->m_parent
)
211 child
->m_level
= dist
; /* temporarily store distance */
212 child
->m_parent
= parent
;
214 if (parent
->m_child
!= NULL
) {
216 for (mp
= parent
->m_child
; mp
!= NULL
; mp
= mp
->m_younger
) {
217 if (mp
->m_date
>= child
->m_date
) {
218 if (mp
->m_elder
!= NULL
)
219 mp
->m_elder
->m_younger
= child
;
220 child
->m_elder
= mp
->m_elder
;
222 child
->m_younger
= mp
;
223 if (mp
== parent
->m_child
)
224 parent
->m_child
= child
;
229 mq
->m_younger
= child
;
232 parent
->m_child
= child
;
237 static struct message
*
238 _interlink(struct message
*m
, ui32_t cnt
, int nmail
)
240 struct message
*root
;
246 autocollapse
= (!nmail
&& !(pstate
& PS_HOOK_NEWMAIL
) &&
247 ok_blook(autocollapse
));
248 ms
= smalloc(sizeof *ms
* cnt
);
250 for (n
= 0, i
= 0; UICMP(32, i
, <, cnt
); ++i
) {
251 if (m
[i
].m_parent
== NULL
) {
254 ms
[n
].ms_u
.ms_long
= m
[i
].m_date
;
261 qsort(ms
, n
, sizeof *ms
, &_mlonglt
);
262 root
= m
+ ms
[0].ms_n
;
263 for (i
= 1; UICMP(32, i
, <, n
); ++i
) {
264 m
[ms
[i
-1].ms_n
].m_younger
= m
+ ms
[i
].ms_n
;
265 m
[ms
[i
].ms_n
].m_elder
= m
+ ms
[i
- 1].ms_n
;
276 _finalize(struct message
*mp
)
281 for (n
= 0; mp
; mp
= next_in_thread(mp
)) {
282 mp
->m_threadpos
= ++n
;
283 mp
->m_level
= mp
->m_parent
? mp
->m_level
+ mp
->m_parent
->m_level
: 0;
290 _mui32lt(void const *a
, void const *b
)
292 struct msort
const *xa
= a
, *xb
= b
;
296 i
= (int)(xa
->ms_u
.ms_ui
- xb
->ms_u
.ms_ui
);
298 i
= xa
->ms_n
- xb
->ms_n
;
305 _mlonglt(void const *a
, void const *b
)
307 struct msort
const *xa
= a
, *xb
= b
;
311 i
= (int)(xa
->ms_u
.ms_long
- xb
->ms_u
.ms_long
);
313 i
= xa
->ms_n
- xb
->ms_n
;
319 _mcharlt(void const *a
, void const *b
)
321 struct msort
const *xa
= a
, *xb
= b
;
325 i
= strcoll(xa
->ms_u
.ms_char
, xb
->ms_u
.ms_char
);
327 i
= xa
->ms_n
- xb
->ms_n
;
333 _lookup(struct message
*m
, struct mitem
*mi
, ui32_t mprime
)
341 if (m
->m_flag
& MHIDDEN
)
345 if ((cp
= hfield1("in-reply-to", m
)) != NULL
) {
346 if ((np
= extract(cp
, GREF
)) != NULL
)
348 if ((ip
= _mlook(np
->n_name
, mi
, NULL
, mprime
)) != NULL
&&
350 _adopt(ip
->mi_data
, m
, 1);
353 } while ((np
= np
->n_flink
) != NULL
);
356 if ((cp
= hfield1("references", m
)) != NULL
) {
357 if ((np
= extract(cp
, GREF
)) != NULL
) {
358 while (np
->n_flink
!= NULL
)
361 if ((ip
= _mlook(np
->n_name
, mi
, NULL
, mprime
)) != NULL
) {
363 continue; /* skip dist++ */
364 _adopt(ip
->mi_data
, m
, dist
);
368 } while ((np
= np
->n_blink
) != NULL
);
376 _makethreads(struct message
*m
, ui32_t cnt
, int nmail
)
386 /* It is performance crucial to space this large enough in order to minimize
388 mprime
= nextprime((cnt
< UI32_MAX
>> 3) ? cnt
<< 2 : cnt
);
389 mt
= scalloc(mprime
, sizeof *mt
);
393 for (i
= 0; i
< cnt
; ++i
) {
394 if (!(m
[i
].m_flag
& MHIDDEN
)) {
395 _mlook(NULL
, mt
, m
+ i
, mprime
);
396 if (m
[i
].m_date
== 0) {
397 if ((cp
= hfield1("date", m
+ i
)) != NULL
)
398 m
[i
].m_date
= rfctime(cp
);
401 m
[i
].m_child
= m
[i
].m_younger
= m
[i
].m_elder
= m
[i
].m_parent
= NULL
;
403 if (!nmail
&& !(pstate
& PS_HOOK_NEWMAIL
))
404 m
[i
].m_collapsed
= 0;
408 /* Most folders contain the eldest messages first. Traversing them in
409 * descending order makes it more likely that younger brothers are found
410 * first, so elder ones can be prepended to the brother list, which is
411 * faster. The worst case is still in O(n^2) and occurs when all but one
412 * messages in a folder are replies to the one message, and are sorted such
413 * that youngest messages occur first */
414 for (i
= cnt
; i
> 0; --i
) {
415 _lookup(m
+ i
- 1, mt
, mprime
);
421 threadroot
= _interlink(m
, cnt
, nmail
);
422 _finalize(threadroot
);
424 for (i
= 0; i
< mprime
; ++i
)
425 if (mt
[i
].mi_id
!= NULL
)
435 _colpt(int *msgvec
, int cl
)
440 if (mb
.mb_threaded
!= 1) {
441 puts("Not in threaded mode.");
444 for (ip
= msgvec
; *ip
!= 0; ++ip
)
445 _colps(message
+ *ip
- 1, cl
);
453 _colps(struct message
*b
, int cl
)
459 if (cl
&& (b
->m_collapsed
> 0 || (b
->m_flag
& (MNEW
| MREAD
)) == MNEW
))
462 if (b
->m_child
!= NULL
) {
464 _colpm(m
, cl
, &cc
, &uc
);
465 for (m
= m
->m_younger
; m
!= NULL
; m
= m
->m_younger
)
466 _colpm(m
, cl
, &cc
, &uc
);
470 b
->m_collapsed
= -cc
;
471 for (m
= b
->m_parent
; m
!= NULL
; m
= m
->m_parent
)
472 if (m
->m_collapsed
<= -uc
) {
473 m
->m_collapsed
+= uc
;
477 if (b
->m_collapsed
> 0) {
481 for (m
= b
; m
!= NULL
; m
= m
->m_parent
)
482 if (m
->m_collapsed
<= -uc
) {
483 m
->m_collapsed
+= uc
;
492 _colpm(struct message
*m
, int cl
, int *cc
, int *uc
)
496 if (m
->m_collapsed
> 0)
498 if ((m
->m_flag
& (MNEW
| MREAD
)) != MNEW
|| m
->m_collapsed
< 0)
500 if (m
->m_collapsed
> 0)
503 if (m
->m_collapsed
> 0) {
509 if (m
->m_child
!= NULL
) {
511 _colpm(m
, cl
, cc
, uc
);
512 for (m
= m
->m_younger
; m
!= NULL
; m
= m
->m_younger
)
513 _colpm(m
, cl
, cc
, uc
);
524 if (mb
.mb_threaded
!= 1 || vp
== NULL
|| vp
== (void*)-1) {
526 if (mb
.mb_type
== MB_IMAP
)
527 imap_getheaders(1, msgCount
);
529 _makethreads(message
, msgCount
, (vp
== (void*)-1));
530 if (mb
.mb_sorted
!= NULL
)
532 mb
.mb_sorted
= sstrdup("thread");
535 if (vp
!= NULL
&& vp
!= (void*)-1 && !(pstate
& PS_HOOK_MASK
) &&
537 rv
= print_header_group(vp
);
552 if (mb
.mb_sorted
!= NULL
)
556 for (m
= message
; PTRCMP(m
, <, message
+ msgCount
); ++m
)
559 if (vp
&& !(pstate
& PS_HOOK_MASK
) && ok_blook(header
))
560 rv
= print_header_group(vp
);
568 next_in_thread(struct message
*mp
)
573 if ((rv
= mp
->m_child
) != NULL
)
575 if ((rv
= mp
->m_younger
) != NULL
)
578 while ((rv
= mp
->m_parent
) != NULL
) {
580 if ((rv
= rv
->m_younger
) != NULL
)
589 prev_in_thread(struct message
*mp
)
594 if ((rv
= mp
->m_elder
) != NULL
) {
595 for (mp
= rv
; (rv
= mp
->m_child
) != NULL
;) {
597 while ((rv
= mp
->m_younger
) != NULL
)
610 this_in_thread(struct message
*mp
, long n
)
615 if (n
== -1) { /* find end of thread */
617 if ((rv
= mp
->m_younger
) != NULL
) {
621 rv
= next_in_thread(mp
);
622 if (rv
== NULL
|| rv
->m_threadpos
< mp
->m_threadpos
) {
632 while (mp
!= NULL
&& mp
->m_threadpos
< n
) {
633 if ((rv
= mp
->m_younger
) != NULL
&& rv
->m_threadpos
<= n
) {
637 mp
= next_in_thread(mp
);
639 rv
= (mp
!= NULL
&& mp
->m_threadpos
== n
) ? mp
: NULL
;
648 enum method
{SORT_SUBJECT
, SORT_DATE
, SORT_STATUS
, SORT_SIZE
, SORT_FROM
,
649 SORT_TO
, SORT_SPAM
, SORT_THREAD
} method
;
652 enum method me_method
;
653 int (*me_func
)(void const *, void const *);
654 } const methnames
[] = {
655 {"date", SORT_DATE
, &_mlonglt
},
656 {"from", SORT_FROM
, &_mcharlt
},
657 {"to", SORT_TO
, &_mcharlt
},
658 {"subject", SORT_SUBJECT
, &_mcharlt
},
659 {"size", SORT_SIZE
, &_mlonglt
},
661 {"spam", SORT_SPAM
, &_mui32lt
},
663 {"status", SORT_STATUS
, &_mlonglt
},
664 {"thread", SORT_THREAD
, NULL
}
668 char *_args
[2], *cp
, **args
= vp
;
670 int (*func
)(void const *, void const *);
676 if (vp
== NULL
|| vp
== (void*)-1) {
677 _args
[0] = savestr((mb
.mb_sorted
!= NULL
) ? mb
.mb_sorted
: "unsorted");
680 } else if (args
[0] == NULL
) {
681 printf("Current sorting criterion is: %s\n",
682 (mb
.mb_sorted
!= NULL
) ? mb
.mb_sorted
: "unsorted");
689 if (*args
[0] != '\0' && is_prefix(args
[0], methnames
[i
].me_name
))
691 if (UICMP(z
, ++i
, >=, NELEM(methnames
))) {
692 n_err(_("Unknown sorting method \"%s\"\n"), args
[0]);
698 if (mb
.mb_sorted
!= NULL
)
700 mb
.mb_sorted
= sstrdup(args
[0]);
702 method
= methnames
[i
].me_method
;
703 func
= methnames
[i
].me_func
;
704 msgvec
[0] = (int)PTR2SIZE(dot
- message
+ 1);
707 if (method
== SORT_THREAD
) {
708 i
= c_thread((vp
!= NULL
&& vp
!= (void*)-1) ? msgvec
: vp
);
712 showname
= ok_blook(showname
);
713 ms
= ac_alloc(sizeof *ms
* msgCount
);
720 if (mb
.mb_type
== MB_IMAP
)
721 imap_getheaders(1, msgCount
);
729 for (n
= 0, i
= 0; i
< msgCount
; ++i
) {
731 if (!(mp
->m_flag
& MHIDDEN
)) {
734 if (mp
->m_date
== 0 && (cp
= hfield1("date", mp
)) != NULL
)
735 mp
->m_date
= rfctime(cp
);
736 ms
[n
].ms_u
.ms_long
= mp
->m_date
;
739 if (mp
->m_flag
& MDELETED
)
740 ms
[n
].ms_u
.ms_long
= 1;
741 else if ((mp
->m_flag
& (MNEW
| MREAD
)) == MNEW
)
742 ms
[n
].ms_u
.ms_long
= 90;
743 else if (mp
->m_flag
& MFLAGGED
)
744 ms
[n
].ms_u
.ms_long
= 85;
745 else if ((mp
->m_flag
& (MNEW
| MBOX
)) == MBOX
)
746 ms
[n
].ms_u
.ms_long
= 70;
747 else if (mp
->m_flag
& MNEW
)
748 ms
[n
].ms_u
.ms_long
= 80;
749 else if (mp
->m_flag
& MREAD
)
750 ms
[n
].ms_u
.ms_long
= 40;
752 ms
[n
].ms_u
.ms_long
= 60;
755 ms
[n
].ms_u
.ms_long
= mp
->m_xsize
;
759 ms
[n
].ms_u
.ms_ui
= mp
->m_spamscore
;
764 if ((cp
= hfield1((method
== SORT_FROM
? "from" : "to"), mp
)) !=
766 ms
[n
].ms_u
.ms_char
= sstrdup(showname
? realname(cp
) : skin(cp
));
767 makelow(ms
[n
].ms_u
.ms_char
);
769 ms
[n
].ms_u
.ms_char
= sstrdup("");
773 if ((cp
= hfield1("subject", mp
)) != NULL
) {
776 mime_fromhdr(&in
, &out
, TD_ICONV
);
777 ms
[n
].ms_u
.ms_char
= sstrdup(subject_re_trim(out
.s
));
779 makelow(ms
[n
].ms_u
.ms_char
);
781 ms
[n
].ms_u
.ms_char
= sstrdup("");
786 mp
->m_child
= mp
->m_younger
= mp
->m_elder
= mp
->m_parent
= NULL
;
794 qsort(ms
, n
, sizeof *ms
, func
);
795 threadroot
= message
+ ms
[0].ms_n
;
796 for (i
= 1; i
< n
; ++i
) {
797 message
[ms
[i
- 1].ms_n
].m_younger
= message
+ ms
[i
].ms_n
;
798 message
[ms
[i
].ms_n
].m_elder
= message
+ ms
[i
- 1].ms_n
;
803 _finalize(threadroot
);
810 for (i
= 0; i
< n
; ++i
)
811 free(ms
[i
].ms_u
.ms_char
);
818 i
= ((vp
!= NULL
&& vp
!= (void*)-1 && !(pstate
& PS_HOOK_MASK
) &&
819 ok_blook(header
)) ? print_header_group(msgvec
) : 0);
837 c_uncollapse(void *v
)
848 uncollapse1(struct message
*mp
, int always
)
851 if (mb
.mb_threaded
== 1 && (always
|| mp
->m_collapsed
> 0))