NeoMutt  2024-04-25-89-g194907
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
sort.c
Go to the documentation of this file.
1
33#include "config.h"
34#include <stdbool.h>
35#include <stdlib.h>
36#include "mutt/lib.h"
37#include "address/lib.h"
38#include "config/lib.h"
39#include "email/lib.h"
40#include "core/lib.h"
41#include "alias/lib.h"
42#include "sort.h"
43#include "nntp/lib.h"
44#include "globals.h"
45#include "mutt_logging.h"
46#include "mutt_thread.h"
47#include "mview.h"
48#include "mx.h"
49#include "score.h"
50
55{
57 short sort;
58 short sort_aux;
59};
60
64static int compare_email_shim(const void *a, const void *b, void *sdata)
65{
66 const struct Email *ea = *(struct Email const *const *) a;
67 const struct Email *eb = *(struct Email const *const *) b;
68 const struct EmailCompare *cmp = sdata;
69 return mutt_compare_emails(ea, eb, cmp->type, cmp->sort, cmp->sort_aux);
70}
71
75static int compare_score(const struct Email *a, const struct Email *b, bool reverse)
76{
77 int result = mutt_numeric_cmp(b->score, a->score); /* note that this is reverse */
78 return reverse ? -result : result;
79}
80
84static int compare_size(const struct Email *a, const struct Email *b, bool reverse)
85{
86 int result = mutt_numeric_cmp(a->body->length, b->body->length);
87 return reverse ? -result : result;
88}
89
93static int compare_date_sent(const struct Email *a, const struct Email *b, bool reverse)
94{
95 int result = mutt_numeric_cmp(a->date_sent, b->date_sent);
96 return reverse ? -result : result;
97}
98
102static int compare_subject(const struct Email *a, const struct Email *b, bool reverse)
103{
104 int rc;
105
106 if (!a->env->real_subj)
107 {
108 if (!b->env->real_subj)
109 rc = compare_date_sent(a, b, false);
110 else
111 rc = -1;
112 }
113 else if (!b->env->real_subj)
114 {
115 rc = 1;
116 }
117 else
118 {
119 rc = mutt_istr_cmp(a->env->real_subj, b->env->real_subj);
120 }
121 return reverse ? -rc : rc;
122}
123
134const char *mutt_get_name(const struct Address *a)
135{
136 struct Address *ali = NULL;
137
138 if (a)
139 {
140 const bool c_reverse_alias = cs_subset_bool(NeoMutt->sub, "reverse_alias");
141 if (c_reverse_alias && (ali = alias_reverse_lookup(a)) && ali->personal)
142 return buf_string(ali->personal);
143 if (a->personal)
144 return buf_string(a->personal);
145 if (a->mailbox)
146 return mutt_addr_for_display(a);
147 }
148 /* don't return NULL to avoid segfault when printing/comparing */
149 return "";
150}
151
155static int compare_to(const struct Email *a, const struct Email *b, bool reverse)
156{
157 char fa[128] = { 0 };
158
159 mutt_str_copy(fa, mutt_get_name(TAILQ_FIRST(&a->env->to)), sizeof(fa));
160 const char *fb = mutt_get_name(TAILQ_FIRST(&b->env->to));
161 int result = mutt_istrn_cmp(fa, fb, sizeof(fa));
162 return reverse ? -result : result;
163}
164
168static int compare_from(const struct Email *a, const struct Email *b, bool reverse)
169{
170 char fa[128] = { 0 };
171
172 mutt_str_copy(fa, mutt_get_name(TAILQ_FIRST(&a->env->from)), sizeof(fa));
173 const char *fb = mutt_get_name(TAILQ_FIRST(&b->env->from));
174 int result = mutt_istrn_cmp(fa, fb, sizeof(fa));
175 return reverse ? -result : result;
176}
177
181static int compare_date_received(const struct Email *a, const struct Email *b, bool reverse)
182{
183 int result = mutt_numeric_cmp(a->received, b->received);
184 return reverse ? -result : result;
185}
186
190static int compare_order(const struct Email *a, const struct Email *b, bool reverse)
191{
192 int result = mutt_numeric_cmp(a->index, b->index);
193 return reverse ? -result : result;
194}
195
199static int compare_spam(const struct Email *a, const struct Email *b, bool reverse)
200{
201 char *aptr = NULL, *bptr = NULL;
202 int ahas, bhas;
203 int result = 0;
204 double difference;
205
206 /* Firstly, require spam attributes for both msgs */
207 /* to compare. Determine which msgs have one. */
208 ahas = a->env && !buf_is_empty(&a->env->spam);
209 bhas = b->env && !buf_is_empty(&b->env->spam);
210
211 /* If one msg has spam attr but other does not, sort the one with first. */
212 if (ahas && !bhas)
213 return reverse ? -1 : 1;
214 if (!ahas && bhas)
215 return reverse ? 1 : -1;
216
217 /* Else, if neither has a spam attr, presume equality. Fall back on aux. */
218 if (!ahas && !bhas)
219 return 0;
220
221 /* Both have spam attrs. */
222
223 /* preliminary numeric examination */
224 difference = (strtod(a->env->spam.data, &aptr) - strtod(b->env->spam.data, &bptr));
225
226 /* map double into comparison (-1, 0, or 1) */
227 result = ((difference < 0.0) ? -1 : (difference > 0.0) ? 1 : 0);
228
229 /* If either aptr or bptr is equal to data, there is no numeric */
230 /* value for that spam attribute. In this case, compare lexically. */
231 if ((aptr == a->env->spam.data) || (bptr == b->env->spam.data))
232 {
233 result = mutt_str_cmp(aptr, bptr);
234 return reverse ? -result : result;
235 }
236
237 /* Otherwise, we have numeric value for both attrs. If these values */
238 /* are equal, then we first fall back upon string comparison, then */
239 /* upon auxiliary sort. */
240 if (result == 0)
241 result = mutt_str_cmp(aptr, bptr);
242 return reverse ? -result : result;
243}
244
248static int compare_label(const struct Email *a, const struct Email *b, bool reverse)
249{
250 int ahas, bhas, result = 0;
251
252 /* As with compare_spam, not all messages will have the x-label
253 * property. Blank X-Labels are treated as null in the index
254 * display, so we'll consider them as null for sort, too. */
255 ahas = a->env && a->env->x_label && *(a->env->x_label);
256 bhas = b->env && b->env->x_label && *(b->env->x_label);
257
258 /* First we bias toward a message with a label, if the other does not. */
259 if (ahas && !bhas)
260 return reverse ? 1 : -1;
261 if (!ahas && bhas)
262 return reverse ? -1 : 1;
263
264 /* If neither has a label, use aux sort. */
265 if (!ahas && !bhas)
266 return 0;
267
268 /* If both have a label, we just do a lexical compare. */
269 result = mutt_istr_cmp(a->env->x_label, b->env->x_label);
270 return reverse ? -result : result;
271}
272
279static sort_mail_t get_sort_func(enum SortType method, enum MailboxType type)
280{
281 switch (method)
282 {
283 case SORT_DATE:
284 return compare_date_sent;
285 case SORT_FROM:
286 return compare_from;
287 case SORT_LABEL:
288 return compare_label;
289 case SORT_ORDER:
290 if (type == MUTT_NNTP)
291 return nntp_compare_order;
292 else
293 return compare_order;
294 case SORT_RECEIVED:
296 case SORT_SCORE:
297 return compare_score;
298 case SORT_SIZE:
299 return compare_size;
300 case SORT_SPAM:
301 return compare_spam;
302 case SORT_SUBJECT:
303 return compare_subject;
304 case SORT_TO:
305 return compare_to;
306 default:
307 mutt_error(_("Could not find sorting function [report this bug]"));
308 return NULL;
309 }
310 /* not reached */
311}
312
324int mutt_compare_emails(const struct Email *a, const struct Email *b,
325 enum MailboxType type, short sort, short sort_aux)
326{
327 sort_mail_t func = get_sort_func(sort & SORT_MASK, type);
328 int rc = func(a, b, (sort & SORT_REVERSE) != 0);
329 if (rc == 0)
330 {
331 func = get_sort_func(sort_aux & SORT_MASK, type);
332 rc = func(a, b, (sort_aux & SORT_REVERSE) != 0);
333 }
334 if (rc == 0)
335 {
336 /* Fallback of last resort to preserve stable order; will only
337 * return 0 if a and b have the same index, which is probably a
338 * bug in the code. */
339 func = compare_order;
340 rc = func(a, b, false);
341 }
342 return rc;
343}
344
350void mutt_sort_headers(struct MailboxView *mv, bool init)
351{
352 if (!mv)
353 return;
354
355 struct Mailbox *m = mv->mailbox;
356 if (!m || !m->emails[0])
357 return;
358
359 OptNeedResort = false;
360
361 if (m->msg_count == 0)
362 {
363 /* this function gets called by mutt_sync_mailbox(), which may have just
364 * deleted all the messages. the virtual message numbers are not updated
365 * in that routine, so we must make sure to zero the vcount member. */
366 m->vcount = 0;
368 mv->vsize = 0;
369 return; /* nothing to do! */
370 }
371
372 if (m->verbose)
373 mutt_message(_("Sorting mailbox..."));
374
375 const bool c_score = cs_subset_bool(NeoMutt->sub, "score");
376 if (OptNeedRescore && c_score)
377 {
378 for (int i = 0; i < m->msg_count; i++)
379 {
380 struct Email *e = m->emails[i];
381 if (!e)
382 break;
383 mutt_score_message(m, e, true);
384 }
385 }
386 OptNeedRescore = false;
387
388 if (OptResortInit)
389 {
390 OptResortInit = false;
391 init = true;
392 }
393
394 if (init)
396
397 const bool threaded = mutt_using_threads();
398 if (threaded)
399 {
400 mutt_sort_threads(mv->threads, init);
401 }
402 else
403 {
404 struct EmailCompare cmp = { 0 };
405 cmp.type = mx_type(m);
406 cmp.sort = cs_subset_sort(NeoMutt->sub, "sort");
407 cmp.sort_aux = cs_subset_sort(NeoMutt->sub, "sort_aux");
408 mutt_qsort_r((void *) m->emails, m->msg_count, sizeof(struct Email *),
409 compare_email_shim, &cmp);
410 }
411
412 /* adjust the virtual message numbers */
413 m->vcount = 0;
414 for (int i = 0; i < m->msg_count; i++)
415 {
416 struct Email *e_cur = m->emails[i];
417 if (!e_cur)
418 break;
419
420 if ((e_cur->vnum != -1) || (e_cur->collapsed && e_cur->visible))
421 {
422 e_cur->vnum = m->vcount;
423 m->v2r[m->vcount] = i;
424 m->vcount++;
425 }
426 e_cur->msgno = i;
427 }
428
429 /* re-collapse threads marked as collapsed */
430 if (threaded)
431 {
433 mv->vsize = mutt_set_vnum(m);
434 }
435
436 if (m->verbose)
438}
439
445{
446 if (!m)
447 return;
448
449 struct EmailCompare cmp = { 0 };
450 cmp.type = mx_type(m);
451 cmp.sort = SORT_ORDER;
452 mutt_qsort_r((void *) m->emails, m->msg_count, sizeof(struct Email *),
453 compare_email_shim, &cmp);
454}
const char * mutt_addr_for_display(const struct Address *a)
Convert an Address for display purposes.
Definition: address.c:1012
Email Address Handling.
Email Aliases.
struct Address * alias_reverse_lookup(const struct Address *addr)
Does the user have an alias for the given address.
Definition: reverse.c:105
bool buf_is_empty(const struct Buffer *buf)
Is the Buffer empty?
Definition: buffer.c:291
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
short cs_subset_sort(const struct ConfigSubset *sub, const char *name)
Get a sort config item by name.
Definition: helpers.c:266
Convenience wrapper for the config headers.
Convenience wrapper for the core headers.
MailboxType
Supported mailbox formats.
Definition: mailbox.h:41
@ MUTT_NNTP
'NNTP' (Usenet) Mailbox type
Definition: mailbox.h:49
Structs that make up an email.
bool OptNeedRescore
(pseudo) set when the 'score' command is used
Definition: globals.c:68
bool OptResortInit
(pseudo) used to force the next resort to be from scratch
Definition: globals.c:74
bool OptNeedResort
(pseudo) used to force a re-sort
Definition: globals.c:69
Global variables.
#define mutt_error(...)
Definition: logging2.h:92
#define mutt_message(...)
Definition: logging2.h:91
static int compare_email_shim(const void *a, const void *b, void *sdata)
Helper to sort emails - Implements sort_t -.
Definition: sort.c:64
int mutt_compare_emails(const struct Email *a, const struct Email *b, enum MailboxType type, short sort, short sort_aux)
Compare two emails using up to two sort methods -.
Definition: sort.c:324
static int compare_to(const struct Email *a, const struct Email *b, bool reverse)
Compare the 'to' fields of two emails - Implements sort_mail_t -.
Definition: sort.c:155
int nntp_compare_order(const struct Email *a, const struct Email *b, bool reverse)
Restore the 'unsorted' order of emails - Implements sort_mail_t -.
Definition: nntp.c:2356
static int compare_label(const struct Email *a, const struct Email *b, bool reverse)
Compare the labels of two emails - Implements sort_mail_t -.
Definition: sort.c:248
static int compare_spam(const struct Email *a, const struct Email *b, bool reverse)
Compare the spam values of two emails - Implements sort_mail_t -.
Definition: sort.c:199
static int compare_order(const struct Email *a, const struct Email *b, bool reverse)
Restore the 'unsorted' order of emails - Implements sort_mail_t -.
Definition: sort.c:190
static int compare_date_sent(const struct Email *a, const struct Email *b, bool reverse)
Compare the sent date of two emails - Implements sort_mail_t -.
Definition: sort.c:93
static int compare_subject(const struct Email *a, const struct Email *b, bool reverse)
Compare the subject of two emails - Implements sort_mail_t -.
Definition: sort.c:102
static int compare_score(const struct Email *a, const struct Email *b, bool reverse)
Compare two emails using their scores - Implements sort_mail_t -.
Definition: sort.c:75
static int compare_from(const struct Email *a, const struct Email *b, bool reverse)
Compare the 'from' fields of two emails - Implements sort_mail_t -.
Definition: sort.c:168
static int compare_size(const struct Email *a, const struct Email *b, bool reverse)
Compare the size of two emails - Implements sort_mail_t -.
Definition: sort.c:84
static int compare_date_received(const struct Email *a, const struct Email *b, bool reverse)
Compare the date received of two emails - Implements sort_mail_t -.
Definition: sort.c:181
Convenience wrapper for the library headers.
#define _(a)
Definition: message.h:28
int mutt_str_cmp(const char *a, const char *b)
Compare two strings, safely.
Definition: string.c:399
int mutt_istrn_cmp(const char *a, const char *b, size_t num)
Compare two strings ignoring case (to a maximum), safely.
Definition: string.c:439
int mutt_istr_cmp(const char *a, const char *b)
Compare two strings ignoring case, safely.
Definition: string.c:412
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:581
void mutt_clear_error(void)
Clear the message line (bottom line of screen)
Definition: mutt_logging.c:74
NeoMutt Logging.
void mutt_clear_threads(struct ThreadsContext *tctx)
Clear the threading of message in a mailbox.
Definition: mutt_thread.c:720
void mutt_thread_collapse_collapsed(struct ThreadsContext *tctx)
Re-collapse threads marked as collapsed.
Definition: mutt_thread.c:1768
void mutt_sort_threads(struct ThreadsContext *tctx, bool init)
Sort email threads.
Definition: mutt_thread.c:1031
off_t mutt_set_vnum(struct Mailbox *m)
Set the virtual index number of all the messages in a mailbox.
Definition: mutt_thread.c:1404
Create/manipulate threading in emails.
#define mutt_using_threads()
Definition: mutt_thread.h:114
View of a Mailbox.
enum MailboxType mx_type(struct Mailbox *m)
Return the type of the Mailbox.
Definition: mx.c:1796
API for mailboxes.
Usenet network mailbox type; talk to an NNTP server.
void mutt_qsort_r(void *base, size_t nmemb, size_t size, sort_t compar, void *sdata)
Sort an array, where the comparator has access to opaque data rather than requiring global variables.
Definition: qsort_r.c:67
#define TAILQ_FIRST(head)
Definition: queue.h:723
void mutt_score_message(struct Mailbox *m, struct Email *e, bool upd_mbox)
Apply scoring to an email.
Definition: score.c:164
Routines for adding user scores to emails.
#define SORT_MASK
Mask for the sort id.
Definition: sort2.h:70
SortType
Methods for sorting.
Definition: sort2.h:34
@ SORT_SUBJECT
Sort by the email's subject.
Definition: sort2.h:38
@ SORT_ORDER
Sort by the order the messages appear in the mailbox.
Definition: sort2.h:40
@ SORT_SPAM
Sort by the email's spam score.
Definition: sort2.h:49
@ SORT_LABEL
Sort by the emails label.
Definition: sort2.h:54
@ SORT_FROM
Sort by the email's From field.
Definition: sort2.h:39
@ SORT_SIZE
Sort by the size of the email.
Definition: sort2.h:36
@ SORT_RECEIVED
Sort by when the message were delivered locally.
Definition: sort2.h:42
@ SORT_TO
Sort by the email's To field.
Definition: sort2.h:43
@ SORT_DATE
Sort by the date the email was sent.
Definition: sort2.h:35
@ SORT_SCORE
Sort by the email's score.
Definition: sort2.h:44
#define SORT_REVERSE
Reverse the order of the sort.
Definition: sort2.h:71
const char * mutt_get_name(const struct Address *a)
Pick the best name to display from an address.
Definition: sort.c:134
static sort_mail_t get_sort_func(enum SortType method, enum MailboxType type)
Get the sort function for a given sort id.
Definition: sort.c:279
void mutt_sort_order(struct Mailbox *m)
Sort emails by their disk order.
Definition: sort.c:444
void mutt_sort_headers(struct MailboxView *mv, bool init)
Sort emails by their headers.
Definition: sort.c:350
Assorted sorting methods.
int(* sort_mail_t)(const struct Email *a, const struct Email *b, bool reverse)
Definition: sort.h:49
#define mutt_numeric_cmp(a, b)
Definition: sort.h:35
An email address.
Definition: address.h:36
struct Buffer * personal
Real name of address.
Definition: address.h:37
struct Buffer * mailbox
Mailbox and host address.
Definition: address.h:38
LOFF_T length
length (in bytes) of attachment
Definition: body.h:53
char * data
Pointer to data.
Definition: buffer.h:37
Context for compare_email_shim()
Definition: sort.c:55
short sort_aux
Secondary sort.
Definition: sort.c:58
short sort
Primary sort.
Definition: sort.c:57
enum MailboxType type
Current mailbox type.
Definition: sort.c:56
The envelope/body of an email.
Definition: email.h:39
bool visible
Is this message part of the view?
Definition: email.h:124
struct Envelope * env
Envelope information.
Definition: email.h:68
bool collapsed
Is this message part of a collapsed thread?
Definition: email.h:123
struct Body * body
List of MIME parts.
Definition: email.h:69
bool threaded
Used for threading.
Definition: email.h:111
time_t date_sent
Time when the message was sent (UTC)
Definition: email.h:60
int vnum
Virtual message number.
Definition: email.h:117
int score
Message score.
Definition: email.h:116
int msgno
Number displayed to the user.
Definition: email.h:114
int index
The absolute (unsorted) message number.
Definition: email.h:113
time_t received
Time when the message was placed in the mailbox.
Definition: email.h:61
struct AddressList to
Email's 'To' list.
Definition: envelope.h:60
struct Buffer spam
Spam header.
Definition: envelope.h:82
char * x_label
X-Label.
Definition: envelope.h:76
char *const real_subj
Offset of the real subject.
Definition: envelope.h:71
struct AddressList from
Email's 'From' list.
Definition: envelope.h:59
View of a Mailbox.
Definition: mview.h:40
off_t vsize
Size (in bytes) of the messages shown.
Definition: mview.h:41
struct ThreadsContext * threads
Threads context.
Definition: mview.h:44
struct Mailbox * mailbox
Current Mailbox.
Definition: mview.h:51
A mailbox.
Definition: mailbox.h:79
int vcount
The number of virtual messages.
Definition: mailbox.h:99
int * v2r
Mapping from virtual to real msgno.
Definition: mailbox.h:98
int msg_count
Total number of messages.
Definition: mailbox.h:88
struct Email ** emails
Array of Emails.
Definition: mailbox.h:96
bool verbose
Display status messages?
Definition: mailbox.h:117
Container for Accounts, Notifications.
Definition: neomutt.h:42
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46