NeoMutt  2025-12-11-1061-g88ae84
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
mailbox.c
Go to the documentation of this file.
1
25
31
32#include "config.h"
33#include <sys/stat.h>
34#include "config/lib.h"
35#include "email/lib.h"
36#include "mailbox.h"
37#include "neomutt.h"
38
40static const struct Mapping MailboxTypes[] = {
41 // clang-format off
42 { "compressed", MUTT_COMPRESSED },
43 { "imap", MUTT_IMAP },
44 { "maildir", MUTT_MAILDIR },
45 { "mbox", MUTT_MBOX },
46 { "mh", MUTT_MH },
47 { "mmdf", MUTT_MMDF },
48 { "nntp", MUTT_NNTP },
49 { "notmuch", MUTT_NOTMUCH },
50 { "pop", MUTT_POP },
51 { NULL, 0 },
52 // clang-format on
53};
54
59int mailbox_gen(void)
60{
61 static int gen = 0;
62 return gen++;
63}
64
69struct Mailbox *mailbox_new(void)
70{
71 struct Mailbox *m = MUTT_MEM_CALLOC(1, struct Mailbox);
72
73 buf_init(&m->pathbuf);
74 m->notify = notify_new();
75
76 m->email_max = 25;
77 m->emails = MUTT_MEM_CALLOC(m->email_max, struct Email *);
78 m->v2r = MUTT_MEM_CALLOC(m->email_max, int);
79 m->gen = mailbox_gen();
80 m->notify_user = true;
81 m->poll_new_mail = true;
82
83 return m;
84}
85
90void mailbox_free(struct Mailbox **ptr)
91{
92 if (!ptr || !*ptr)
93 return;
94
95 struct Mailbox *m = *ptr;
96
97 const bool do_free = (m->opened == 0) && !m->visible;
98
99 mutt_debug(LL_DEBUG3, "%sfreeing %s mailbox %s with refcount %d\n",
100 do_free ? "" : "not ", m->visible ? "visible" : "invisible",
101 buf_string(&m->pathbuf), m->opened);
102
103 if (!do_free)
104 {
105 return;
106 }
107
108 mutt_debug(LL_NOTIFY, "NT_MAILBOX_DELETE: %s %p\n",
109 mailbox_get_type_name(m->type), (void *) m);
110 struct EventMailbox ev_m = { m };
112
113 mutt_debug(LL_NOTIFY, "NT_EMAIL_DELETE_ALL\n");
114 struct EventEmail ev_e = { 0, NULL };
116
119 m->email_max = 0;
120
121 if (m->mdata_free && m->mdata)
122 m->mdata_free(&m->mdata);
123
124 buf_dealloc(&m->pathbuf);
125 cs_subset_free(&m->sub);
126 FREE(&m->name);
127 FREE(&m->realpath);
128 FREE(&m->emails);
129 FREE(&m->v2r);
130 notify_free(&m->notify);
132
133 /* The NT_MAILBOX_DELETE notification might already have caused *ptr to be NULL,
134 * so call free() on the m pointer */
135 *ptr = NULL;
136 FREE(&m);
137}
138
150{
151 if (!m)
152 return;
153
156
157 for (int i = 0; i < m->email_max; i++)
158 email_free(&m->emails[i]);
159
160 m->msg_count = 0;
161 m->msg_deleted = 0;
162 m->msg_flagged = 0;
163 m->msg_new = 0;
164 m->msg_tagged = 0;
165 m->msg_unread = 0;
166 m->size = 0;
167 m->vcount = 0;
168}
169
175struct Mailbox *mailbox_find(const char *path)
176{
177 if (!path)
178 return NULL;
179
180 struct stat st = { 0 };
181 struct stat st_tmp = { 0 };
182
183 if (stat(path, &st) != 0)
184 return NULL;
185
186 struct MailboxArray ma = neomutt_mailboxes_get(NeoMutt, MUTT_MAILBOX_ANY);
187 struct Mailbox **mp = NULL;
188 struct Mailbox *m = NULL;
189 ARRAY_FOREACH(mp, &ma)
190 {
191 if ((stat(mailbox_path(*mp), &st_tmp) == 0) &&
192 (st.st_dev == st_tmp.st_dev) && (st.st_ino == st_tmp.st_ino))
193 {
194 m = *mp;
195 break;
196 }
197 }
198
199 ARRAY_FREE(&ma); // Clean up the ARRAY, but not the Mailboxes
200 return m;
201}
202
211struct Mailbox *mailbox_find_name(const char *name)
212{
213 if (!name)
214 return NULL;
215
216 struct MailboxArray ma = neomutt_mailboxes_get(NeoMutt, MUTT_MAILBOX_ANY);
217 struct Mailbox **mp = NULL;
218 struct Mailbox *m = NULL;
219 ARRAY_FOREACH(mp, &ma)
220 {
221 if (mutt_str_equal((*mp)->name, name))
222 {
223 m = *mp;
224 break;
225 }
226 }
227
228 ARRAY_FREE(&ma); // Clean up the ARRAY, but not the Mailboxes
229 return m;
230}
231
238void mailbox_update(struct Mailbox *m)
239{
240 struct stat st = { 0 };
241
242 if (!m)
243 return;
244
245 if (stat(mailbox_path(m), &st) == 0)
246 m->size = (off_t) st.st_size;
247 else
248 m->size = 0;
249}
250
256void mailbox_changed(struct Mailbox *m, enum NotifyMailbox action)
257{
258 if (!m)
259 return;
260
261 mutt_debug(LL_NOTIFY, "NT_MAILBOX_CHANGE: %s %p\n",
262 mailbox_get_type_name(m->type), (void *) m);
263 struct EventMailbox ev_m = { m };
264 notify_send(m->notify, NT_MAILBOX, action, &ev_m);
265}
266
272void mailbox_size_add(struct Mailbox *m, const struct Email *e)
273{
274 m->size += email_get_size(e);
275}
276
282void mailbox_size_sub(struct Mailbox *m, const struct Email *e)
283{
284 m->size -= email_get_size(e);
285}
286
293bool mailbox_set_subset(struct Mailbox *m, struct ConfigSubset *sub)
294{
295 if (!m || m->sub || !sub)
296 return false;
297
298 m->sub = cs_subset_new(m->name, sub, m->notify);
300 return true;
301}
302
307{
308 struct Email *arr[10];
309 size_t idx;
310};
311
313static struct EmailGarbageCollector GC = { 0 };
314
321void mailbox_gc_add(struct Email *e)
322{
323 ASSERT(e);
324 if (GC.idx == countof(GC.arr))
325 {
327 }
328 GC.arr[GC.idx] = e;
329 GC.idx++;
330}
331
336{
337 for (size_t i = 0; i < GC.idx; i++)
338 {
339 email_free(&GC.arr[i]);
340 }
341 GC.idx = 0;
342}
343
349const char *mailbox_get_type_name(enum MailboxType type)
350{
351 const char *name = mutt_map_get_name(type, MailboxTypes);
352 if (name)
353 return name;
354 return "UNKNOWN";
355}
#define ARRAY_FOREACH(elem, head)
Iterate over all elements of the array.
Definition array.h:223
#define ARRAY_FREE(head)
Release all memory.
Definition array.h:209
void buf_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition buffer.c:383
struct Buffer * buf_init(struct Buffer *buf)
Initialise a new Buffer.
Definition buffer.c:74
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:99
Convenience wrapper for the config headers.
bool mailbox_set_subset(struct Mailbox *m, struct ConfigSubset *sub)
Set a Mailbox's Config Subset.
Definition mailbox.c:293
void mailbox_gc_run(void)
Run the garbage-collection.
Definition mailbox.c:335
void mailbox_size_add(struct Mailbox *m, const struct Email *e)
Add an email's size to the total size of a Mailbox.
Definition mailbox.c:272
void mailbox_clear_emails(struct Mailbox *m)
Free all the Emails in a Mailbox.
Definition mailbox.c:149
void mailbox_size_sub(struct Mailbox *m, const struct Email *e)
Subtract an email's size from the total size of a Mailbox.
Definition mailbox.c:282
int mailbox_gen(void)
Get the next generation number.
Definition mailbox.c:59
struct Mailbox * mailbox_new(void)
Create a new Mailbox.
Definition mailbox.c:69
void mailbox_gc_add(struct Email *e)
Add an Email to the garbage-collection set.
Definition mailbox.c:321
void mailbox_update(struct Mailbox *m)
Get the mailbox's current size.
Definition mailbox.c:238
void mailbox_free(struct Mailbox **ptr)
Free a Mailbox.
Definition mailbox.c:90
static const struct Mapping MailboxTypes[]
Lookups for Mailbox types.
Definition mailbox.c:40
struct Mailbox * mailbox_find_name(const char *name)
Find the mailbox with a given name.
Definition mailbox.c:211
static struct EmailGarbageCollector GC
Set of Emails to be deleted.
Definition mailbox.c:313
void mailbox_changed(struct Mailbox *m, enum NotifyMailbox action)
Notify observers of a change to a Mailbox.
Definition mailbox.c:256
const char * mailbox_get_type_name(enum MailboxType type)
Get the type of a Mailbox.
Definition mailbox.c:349
struct Mailbox * mailbox_find(const char *path)
Find the mailbox with a given path.
Definition mailbox.c:175
Representation of a mailbox.
NotifyMailbox
Types of Mailbox Event.
Definition mailbox.h:174
@ NT_MAILBOX_DELETE
Mailbox is about to be deleted.
Definition mailbox.h:176
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition mailbox.h:217
MailboxType
Supported mailbox formats.
Definition mailbox.h:40
@ MUTT_NOTMUCH
'Notmuch' (virtual) Mailbox type
Definition mailbox.h:50
@ MUTT_MMDF
'mmdf' Mailbox type
Definition mailbox.h:45
@ MUTT_POP
'POP3' Mailbox type
Definition mailbox.h:51
@ MUTT_MH
'MH' Mailbox type
Definition mailbox.h:46
@ MUTT_NNTP
'NNTP' (Usenet) Mailbox type
Definition mailbox.h:48
@ MUTT_IMAP
'IMAP' Mailbox type
Definition mailbox.h:49
@ MUTT_MBOX
'mbox' Mailbox type
Definition mailbox.h:44
@ MUTT_MAILBOX_ANY
Match any Mailbox type.
Definition mailbox.h:41
@ MUTT_COMPRESSED
Compressed file Mailbox type.
Definition mailbox.h:52
@ MUTT_MAILDIR
'Maildir' Mailbox type
Definition mailbox.h:47
size_t email_get_size(const struct Email *e)
Compute the size of an email.
Definition email.c:121
void email_free(struct Email **ptr)
Free an Email.
Definition email.c:46
Structs that make up an email.
@ NT_EMAIL_DELETE_ALL
All the Emails are about to be deleted.
Definition email.h:185
#define mutt_debug(LEVEL,...)
Definition logging2.h:91
void mutt_hash_free(struct HashTable **ptr)
Free a hash table.
Definition hash.c:460
@ LL_DEBUG3
Log at debug level 3.
Definition logging2.h:47
@ LL_NOTIFY
Log of notifications.
Definition logging2.h:50
const char * mutt_map_get_name(int val, const struct Mapping *map)
Lookup a string for a constant.
Definition mapping.c:42
#define countof(x)
Definition memory.h:49
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:92
#define MUTT_MEM_CALLOC(n, T)
Definition memory.h:68
struct Notify * notify_new(void)
Create a new notifications handler.
Definition notify.c:62
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition notify.c:173
void notify_free(struct Notify **ptr)
Free a notification handler.
Definition notify.c:75
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:666
struct MailboxArray neomutt_mailboxes_get(struct NeoMutt *n, enum MailboxType type)
Get an Array of matching Mailboxes.
Definition neomutt.c:607
Container for Accounts, Notifications.
@ NT_EMAIL
Email has changed, NotifyEmail, EventEmail.
Definition notify_type.h:44
@ NT_MAILBOX
Mailbox has changed, NotifyMailbox, EventMailbox.
Definition notify_type.h:50
#define ASSERT(COND)
Definition signal2.h:59
A set of inherited config items.
Definition subset.h:46
enum ConfigScope scope
Scope of Subset, e.g. SET_SCOPE_ACCOUNT.
Definition subset.h:48
Email garbage collection.
Definition mailbox.c:307
size_t idx
Current position.
Definition mailbox.c:309
struct Email * arr[10]
Array of Emails to be deleted.
Definition mailbox.c:308
The envelope/body of an email.
Definition email.h:39
An Event that happened to an Email.
Definition email.h:196
An Event that happened to a Mailbox.
Definition mailbox.h:192
A mailbox.
Definition mailbox.h:81
void(* mdata_free)(void **ptr)
Definition mailbox.h:145
int vcount
The number of virtual messages.
Definition mailbox.h:101
char * realpath
Used for duplicate detection, context comparison, and the sidebar.
Definition mailbox.h:83
int * v2r
Mapping from virtual to real msgno.
Definition mailbox.h:100
int msg_new
Number of new messages.
Definition mailbox.h:94
int msg_count
Total number of messages.
Definition mailbox.h:90
int email_max
Size of emails array.
Definition mailbox.h:99
enum MailboxType type
Mailbox type.
Definition mailbox.h:104
bool poll_new_mail
Check for new mail.
Definition mailbox.h:117
void * mdata
Driver specific data.
Definition mailbox.h:134
struct HashTable * subj_hash
Hash Table: "Subject" -> Email.
Definition mailbox.h:126
struct Email ** emails
Array of Emails.
Definition mailbox.h:98
char * name
A short name for the Mailbox.
Definition mailbox.h:84
struct Notify * notify
Notifications: NotifyMailbox, EventMailbox.
Definition mailbox.h:147
bool notify_user
Notify the user of new mail.
Definition mailbox.h:115
struct HashTable * id_hash
Hash Table: "Message-ID" -> Email.
Definition mailbox.h:125
struct Buffer pathbuf
Path of the Mailbox.
Definition mailbox.h:82
int msg_deleted
Number of deleted messages.
Definition mailbox.h:95
off_t size
Size of the Mailbox.
Definition mailbox.h:86
struct HashTable * label_hash
Hash Table: "X-Label" -> Email.
Definition mailbox.h:127
bool visible
True if a result of "mailboxes".
Definition mailbox.h:132
int msg_flagged
Number of flagged messages.
Definition mailbox.h:92
int opened
Number of times mailbox is opened.
Definition mailbox.h:130
int msg_tagged
How many messages are tagged?
Definition mailbox.h:96
int msg_unread
Number of unread messages.
Definition mailbox.h:91
int gen
Generation number, for sorting.
Definition mailbox.h:149
struct ConfigSubset * sub
Inherited config items.
Definition mailbox.h:85
Mapping between user-readable string and a constant.
Definition mapping.h:33
Container for Accounts, Notifications.
Definition neomutt.h:41
struct ConfigSubset * cs_subset_new(const char *name, struct ConfigSubset *sub_parent, struct Notify *not_parent)
Create a new Config Subset.
Definition subset.c:158
void cs_subset_free(struct ConfigSubset **ptr)
Free a Config Subset.
Definition subset.c:112
@ SET_SCOPE_MAILBOX
This Config is Mailbox-specific.
Definition subset.h:39