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 - 2018 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
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);
186 else while (c
>= mprime
)
191 if (mdata
!= NULL
&& mp
->mi_id
== NULL
) {
192 mp
->mi_id
= sstrdup(id
);
194 mdata
->m_idhash
= ~h
;
196 if (mp
->mi_id
== NULL
)
204 _adopt(struct message
*parent
, struct message
*child
, int dist
)
206 struct message
*mp
, *mq
;
209 for (mp
= parent
; mp
!= NULL
; mp
= mp
->m_parent
)
213 child
->m_level
= dist
; /* temporarily store distance */
214 child
->m_parent
= parent
;
216 if (parent
->m_child
!= NULL
) {
218 for (mp
= parent
->m_child
; mp
!= NULL
; mp
= mp
->m_younger
) {
219 if (mp
->m_date
>= child
->m_date
) {
220 if (mp
->m_elder
!= NULL
)
221 mp
->m_elder
->m_younger
= child
;
222 child
->m_elder
= mp
->m_elder
;
224 child
->m_younger
= mp
;
225 if (mp
== parent
->m_child
)
226 parent
->m_child
= child
;
231 mq
->m_younger
= child
;
234 parent
->m_child
= child
;
239 static struct message
*
240 _interlink(struct message
*m
, ui32_t cnt
, int nmail
)
242 struct message
*root
;
248 autocollapse
= (!nmail
&& !(n_pstate
& n_PS_HOOK_NEWMAIL
) &&
249 ok_blook(autocollapse
));
250 ms
= smalloc(sizeof *ms
* cnt
);
252 for (n
= 0, i
= 0; UICMP(32, i
, <, cnt
); ++i
) {
253 if (m
[i
].m_parent
== NULL
) {
256 ms
[n
].ms_u
.ms_long
= m
[i
].m_date
;
263 qsort(ms
, n
, sizeof *ms
, &_mlonglt
);
264 root
= m
+ ms
[0].ms_n
;
265 for (i
= 1; UICMP(32, i
, <, n
); ++i
) {
266 m
[ms
[i
-1].ms_n
].m_younger
= m
+ ms
[i
].ms_n
;
267 m
[ms
[i
].ms_n
].m_elder
= m
+ ms
[i
- 1].ms_n
;
278 _finalize(struct message
*mp
)
283 for (n
= 0; mp
; mp
= next_in_thread(mp
)) {
284 mp
->m_threadpos
= ++n
;
285 mp
->m_level
= mp
->m_parent
? mp
->m_level
+ mp
->m_parent
->m_level
: 0;
292 _mui32lt(void const *a
, void const *b
)
294 struct msort
const *xa
= a
, *xb
= b
;
298 i
= (int)(xa
->ms_u
.ms_ui
- xb
->ms_u
.ms_ui
);
300 i
= xa
->ms_n
- xb
->ms_n
;
307 _mlonglt(void const *a
, void const *b
)
309 struct msort
const *xa
= a
, *xb
= b
;
313 i
= (int)(xa
->ms_u
.ms_long
- xb
->ms_u
.ms_long
);
315 i
= xa
->ms_n
- xb
->ms_n
;
321 _mcharlt(void const *a
, void const *b
)
323 struct msort
const *xa
= a
, *xb
= b
;
327 i
= strcoll(xa
->ms_u
.ms_char
, xb
->ms_u
.ms_char
);
329 i
= xa
->ms_n
- xb
->ms_n
;
335 _lookup(struct message
*m
, struct mitem
*mi
, ui32_t mprime
)
343 if (m
->m_flag
& MHIDDEN
)
347 if ((cp
= hfield1("in-reply-to", m
)) != NULL
) {
348 if ((np
= extract(cp
, GREF
)) != NULL
)
350 if ((ip
= _mlook(np
->n_name
, mi
, NULL
, mprime
)) != NULL
&&
352 _adopt(ip
->mi_data
, m
, 1);
355 } while ((np
= np
->n_flink
) != NULL
);
358 if ((cp
= hfield1("references", m
)) != NULL
) {
359 if ((np
= extract(cp
, GREF
)) != NULL
) {
360 while (np
->n_flink
!= NULL
)
363 if ((ip
= _mlook(np
->n_name
, mi
, NULL
, mprime
)) != NULL
) {
365 continue; /* skip dist++ */
366 _adopt(ip
->mi_data
, m
, dist
);
370 } while ((np
= np
->n_blink
) != NULL
);
378 _makethreads(struct message
*m
, ui32_t cnt
, int nmail
)
388 /* It is performance crucial to space this large enough in order to minimize
390 mprime
= n_prime_next((cnt
< UI32_MAX
>> 3) ? cnt
<< 2 : cnt
);
391 mt
= scalloc(mprime
, sizeof *mt
);
395 for (i
= 0; i
< cnt
; ++i
) {
396 if (!(m
[i
].m_flag
& MHIDDEN
)) {
397 _mlook(NULL
, mt
, m
+ i
, mprime
);
398 if (m
[i
].m_date
== 0) {
399 if ((cp
= hfield1("date", m
+ i
)) != NULL
)
400 m
[i
].m_date
= rfctime(cp
);
403 m
[i
].m_child
= m
[i
].m_younger
= m
[i
].m_elder
= m
[i
].m_parent
= NULL
;
405 if (!nmail
&& !(n_pstate
& n_PS_HOOK_NEWMAIL
))
406 m
[i
].m_collapsed
= 0;
410 /* Most folders contain the eldest messages first. Traversing them in
411 * descending order makes it more likely that younger brothers are found
412 * first, so elder ones can be prepended to the brother list, which is
413 * faster. The worst case is still in O(n^2) and occurs when all but one
414 * messages in a folder are replies to the one message, and are sorted such
415 * that youngest messages occur first */
416 for (i
= cnt
; i
> 0; --i
) {
417 _lookup(m
+ i
- 1, mt
, mprime
);
423 threadroot
= _interlink(m
, cnt
, nmail
);
424 _finalize(threadroot
);
426 for (i
= 0; i
< mprime
; ++i
)
427 if (mt
[i
].mi_id
!= NULL
)
437 _colpt(int *msgvec
, int cl
)
442 if (mb
.mb_threaded
!= 1) {
443 fputs("Not in threaded mode.\n", n_stdout
);
446 for (ip
= msgvec
; *ip
!= 0; ++ip
)
447 _colps(message
+ *ip
- 1, cl
);
455 _colps(struct message
*b
, int cl
)
461 if (cl
&& (b
->m_collapsed
> 0 || (b
->m_flag
& (MNEW
| MREAD
)) == MNEW
))
464 if (b
->m_child
!= NULL
) {
466 _colpm(m
, cl
, &cc
, &uc
);
467 for (m
= m
->m_younger
; m
!= NULL
; m
= m
->m_younger
)
468 _colpm(m
, cl
, &cc
, &uc
);
472 b
->m_collapsed
= -cc
;
473 for (m
= b
->m_parent
; m
!= NULL
; m
= m
->m_parent
)
474 if (m
->m_collapsed
<= -uc
) {
475 m
->m_collapsed
+= uc
;
479 if (b
->m_collapsed
> 0) {
483 for (m
= b
; m
!= NULL
; m
= m
->m_parent
)
484 if (m
->m_collapsed
<= -uc
) {
485 m
->m_collapsed
+= uc
;
494 _colpm(struct message
*m
, int cl
, int *cc
, int *uc
)
498 if (m
->m_collapsed
> 0)
500 if ((m
->m_flag
& (MNEW
| MREAD
)) != MNEW
|| m
->m_collapsed
< 0)
502 if (m
->m_collapsed
> 0)
505 if (m
->m_collapsed
> 0) {
511 if (m
->m_child
!= NULL
) {
513 _colpm(m
, cl
, cc
, uc
);
514 for (m
= m
->m_younger
; m
!= NULL
; m
= m
->m_younger
)
515 _colpm(m
, cl
, cc
, uc
);
526 if (mb
.mb_threaded
!= 1 || vp
== NULL
|| vp
== (void*)-1) {
528 if (mb
.mb_type
== MB_IMAP
)
529 imap_getheaders(1, msgCount
);
531 _makethreads(message
, msgCount
, (vp
== (void*)-1));
532 if (mb
.mb_sorted
!= NULL
)
534 mb
.mb_sorted
= sstrdup("thread");
537 if (vp
!= NULL
&& vp
!= (void*)-1 && !(n_pstate
& n_PS_HOOK_MASK
) &&
539 rv
= print_header_group(vp
);
554 if (mb
.mb_sorted
!= NULL
)
558 for (m
= message
; PTRCMP(m
, <, message
+ msgCount
); ++m
)
561 if (vp
&& !(n_pstate
& n_PS_HOOK_MASK
) && ok_blook(header
))
562 rv
= print_header_group(vp
);
570 next_in_thread(struct message
*mp
)
575 if ((rv
= mp
->m_child
) != NULL
)
577 if ((rv
= mp
->m_younger
) != NULL
)
580 while ((rv
= mp
->m_parent
) != NULL
) {
582 if ((rv
= rv
->m_younger
) != NULL
)
591 prev_in_thread(struct message
*mp
)
596 if ((rv
= mp
->m_elder
) != NULL
) {
597 for (mp
= rv
; (rv
= mp
->m_child
) != NULL
;) {
599 while ((rv
= mp
->m_younger
) != NULL
)
612 this_in_thread(struct message
*mp
, long n
)
617 if (n
== -1) { /* find end of thread */
619 if ((rv
= mp
->m_younger
) != NULL
) {
623 rv
= next_in_thread(mp
);
624 if (rv
== NULL
|| rv
->m_threadpos
< mp
->m_threadpos
) {
634 while (mp
!= NULL
&& mp
->m_threadpos
< n
) {
635 if ((rv
= mp
->m_younger
) != NULL
&& rv
->m_threadpos
<= n
) {
639 mp
= next_in_thread(mp
);
641 rv
= (mp
!= NULL
&& mp
->m_threadpos
== n
) ? mp
: NULL
;
650 enum method
{SORT_SUBJECT
, SORT_DATE
, SORT_STATUS
, SORT_SIZE
, SORT_FROM
,
651 SORT_TO
, SORT_SPAM
, SORT_THREAD
} method
;
654 enum method me_method
;
655 int (*me_func
)(void const *, void const *);
656 } const methnames
[] = {
657 {"date", SORT_DATE
, &_mlonglt
},
658 {"from", SORT_FROM
, &_mcharlt
},
659 {"to", SORT_TO
, &_mcharlt
},
660 {"subject", SORT_SUBJECT
, &_mcharlt
},
661 {"size", SORT_SIZE
, &_mlonglt
},
663 {"spam", SORT_SPAM
, &_mui32lt
},
665 {"status", SORT_STATUS
, &_mlonglt
},
666 {"thread", SORT_THREAD
, NULL
}
670 char *_args
[2], *cp
, **args
= vp
;
672 int (*func
)(void const *, void const *);
678 if (vp
== NULL
|| vp
== (void*)-1) {
679 _args
[0] = savestr((mb
.mb_sorted
!= NULL
) ? mb
.mb_sorted
: "unsorted");
682 } else if (args
[0] == NULL
) {
683 fprintf(n_stdout
, "Current sorting criterion is: %s\n",
684 (mb
.mb_sorted
!= NULL
) ? mb
.mb_sorted
: "unsorted");
691 if (*args
[0] != '\0' && is_prefix(args
[0], methnames
[i
].me_name
))
693 if (UICMP(z
, ++i
, >=, n_NELEM(methnames
))) {
694 n_err(_("Unknown sorting method: %s\n"), args
[0]);
700 if (mb
.mb_sorted
!= NULL
)
702 mb
.mb_sorted
= sstrdup(args
[0]);
704 method
= methnames
[i
].me_method
;
705 func
= methnames
[i
].me_func
;
706 msgvec
[0] = (int)PTR2SIZE(dot
- message
+ 1);
709 if (method
== SORT_THREAD
) {
710 i
= c_thread((vp
!= NULL
&& vp
!= (void*)-1) ? msgvec
: vp
);
714 showname
= ok_blook(showname
);
715 ms
= ac_alloc(sizeof *ms
* msgCount
);
722 if (mb
.mb_type
== MB_IMAP
)
723 imap_getheaders(1, msgCount
);
731 for (n
= 0, i
= 0; i
< msgCount
; ++i
) {
733 if (!(mp
->m_flag
& MHIDDEN
)) {
736 if (mp
->m_date
== 0 && (cp
= hfield1("date", mp
)) != NULL
)
737 mp
->m_date
= rfctime(cp
);
738 ms
[n
].ms_u
.ms_long
= mp
->m_date
;
741 if (mp
->m_flag
& MDELETED
)
742 ms
[n
].ms_u
.ms_long
= 1;
743 else if ((mp
->m_flag
& (MNEW
| MREAD
)) == MNEW
)
744 ms
[n
].ms_u
.ms_long
= 90;
745 else if (mp
->m_flag
& MFLAGGED
)
746 ms
[n
].ms_u
.ms_long
= 85;
747 else if ((mp
->m_flag
& (MNEW
| MBOX
)) == MBOX
)
748 ms
[n
].ms_u
.ms_long
= 70;
749 else if (mp
->m_flag
& MNEW
)
750 ms
[n
].ms_u
.ms_long
= 80;
751 else if (mp
->m_flag
& MREAD
)
752 ms
[n
].ms_u
.ms_long
= 40;
754 ms
[n
].ms_u
.ms_long
= 60;
757 ms
[n
].ms_u
.ms_long
= mp
->m_xsize
;
761 ms
[n
].ms_u
.ms_ui
= mp
->m_spamscore
;
766 if ((cp
= hfield1((method
== SORT_FROM
? "from" : "to"), mp
)) !=
768 ms
[n
].ms_u
.ms_char
= sstrdup(showname
? realname(cp
) : skin(cp
));
769 makelow(ms
[n
].ms_u
.ms_char
);
771 ms
[n
].ms_u
.ms_char
= sstrdup(n_empty
);
775 if ((cp
= hfield1("subject", mp
)) != NULL
) {
778 mime_fromhdr(&in
, &out
, TD_ICONV
);
779 ms
[n
].ms_u
.ms_char
= sstrdup(subject_re_trim(out
.s
));
781 makelow(ms
[n
].ms_u
.ms_char
);
783 ms
[n
].ms_u
.ms_char
= sstrdup(n_empty
);
788 mp
->m_child
= mp
->m_younger
= mp
->m_elder
= mp
->m_parent
= NULL
;
796 qsort(ms
, n
, sizeof *ms
, func
);
797 threadroot
= message
+ ms
[0].ms_n
;
798 for (i
= 1; i
< n
; ++i
) {
799 message
[ms
[i
- 1].ms_n
].m_younger
= message
+ ms
[i
].ms_n
;
800 message
[ms
[i
].ms_n
].m_elder
= message
+ ms
[i
- 1].ms_n
;
805 _finalize(threadroot
);
812 for (i
= 0; i
< n
; ++i
)
813 free(ms
[i
].ms_u
.ms_char
);
820 i
= ((vp
!= NULL
&& vp
!= (void*)-1 && !(n_pstate
& n_PS_HOOK_MASK
) &&
821 ok_blook(header
)) ? print_header_group(msgvec
) : 0);
839 c_uncollapse(void *v
)
850 uncollapse1(struct message
*mp
, int always
)
853 if (mb
.mb_threaded
== 1 && (always
|| mp
->m_collapsed
> 0))