NeoMutt  2025-12-11-860-g80c9cc
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
util.c
Go to the documentation of this file.
1
28
34
35#include "config.h"
36#include <arpa/inet.h>
37#include <errno.h>
38#include <netdb.h>
39#include <signal.h>
40#include <stdbool.h>
41#include <stdio.h>
42#include <string.h>
43#include <sys/types.h>
44#include <sys/wait.h>
45#include <unistd.h>
46#include "private.h"
47#include "mutt/lib.h"
48#include "config/lib.h"
49#include "email/lib.h"
50#include "core/lib.h"
51#include "conn/lib.h"
52#include "lib.h"
53#include "bcache/lib.h"
54#include "question/lib.h"
55#include "store/lib.h"
56#include "adata.h"
57#include "edata.h"
58#include "globals.h"
59#include "mdata.h"
60#include "msn.h"
61#ifdef USE_HCACHE
62#include "hcache/lib.h"
63#endif
64
73int imap_adata_find(const char *path, struct ImapAccountData **adata,
74 struct ImapMboxData **mdata)
75{
76 struct ConnAccount cac = { { 0 } };
77 struct ImapAccountData *tmp_adata = NULL;
78 char tmp[1024] = { 0 };
79
80 if (imap_parse_path(path, &cac, tmp, sizeof(tmp)) < 0)
81 return -1;
82
83 struct Account **ap = NULL;
85 {
86 struct Account *a = *ap;
87 if (a->type != MUTT_IMAP)
88 continue;
89
90 tmp_adata = a->adata;
91 if (!tmp_adata)
92 continue;
93 if (imap_account_match(&tmp_adata->conn->account, &cac))
94 {
95 if (mdata)
96 {
97 *mdata = imap_mdata_new(tmp_adata, tmp);
98 }
99 *adata = tmp_adata;
100 return 0;
101 }
102 }
103 mutt_debug(LL_DEBUG3, "no ImapAccountData found\n");
104 return -1;
105}
106
112{
114 mdata->reopen = IMAP_OPEN_NO_FLAGS;
115 mutt_hash_free(&mdata->uid_hash);
116 imap_msn_free(&mdata->msn);
117 mutt_bcache_close(&mdata->bcache);
118}
119
127void imap_get_parent(const char *mbox, char delim, char *buf, size_t buflen)
128{
129 /* Make a copy of the mailbox name, but only if the pointers are different */
130 if (mbox != buf)
131 mutt_str_copy(buf, mbox, buflen);
132
133 int n = mutt_str_len(buf);
134
135 /* Let's go backwards until the next delimiter
136 *
137 * If buf[n] is a '/', the first n-- will allow us
138 * to ignore it. If it isn't, then buf looks like
139 * "/aaaaa/bbbb". There is at least one "b", so we can't skip
140 * the "/" after the 'a's.
141 *
142 * If buf == '/', then n-- => n == 0, so the loop ends
143 * immediately */
144 for (n--; (n >= 0) && (buf[n] != delim); n--)
145 ; // do nothing
146
147 /* We stopped before the beginning. There is a trailing slash. */
148 if (n > 0)
149 {
150 /* Strip the trailing delimiter. */
151 buf[n] = '\0';
152 }
153 else
154 {
155 buf[0] = (n == 0) ? delim : '\0';
156 }
157}
158
168void imap_get_parent_path(const char *path, char *buf, size_t buflen)
169{
170 struct ImapAccountData *adata = NULL;
171 struct ImapMboxData *mdata = NULL;
172 char mbox[1024] = { 0 };
173
174 if (imap_adata_find(path, &adata, &mdata) < 0)
175 {
176 mutt_str_copy(buf, path, buflen);
177 return;
178 }
179
180 /* Gets the parent mbox in mbox */
181 imap_get_parent(mdata->name, adata->delim, mbox, sizeof(mbox));
182
183 /* Returns a fully qualified IMAP url */
184 imap_qualify_path(buf, buflen, &adata->conn->account, mbox);
185 imap_mdata_free((void *) &mdata);
186}
187
195void imap_clean_path(char *path, size_t plen)
196{
197 struct ImapAccountData *adata = NULL;
198 struct ImapMboxData *mdata = NULL;
199
200 if (imap_adata_find(path, &adata, &mdata) < 0)
201 return;
202
203 /* Returns a fully qualified IMAP url */
204 imap_qualify_path(path, plen, &adata->conn->account, mdata->name);
205 imap_mdata_free((void *) &mdata);
206}
207
211static const char *imap_get_field(enum ConnAccountField field, void *gf_data)
212{
213 switch (field)
214 {
215 case MUTT_CA_LOGIN:
216 return cs_subset_string(NeoMutt->sub, "imap_login");
217 case MUTT_CA_USER:
218 return cs_subset_string(NeoMutt->sub, "imap_user");
219 case MUTT_CA_PASS:
220 return cs_subset_string(NeoMutt->sub, "imap_pass");
222 return cs_subset_string(NeoMutt->sub, "imap_oauth_refresh_command");
223 case MUTT_CA_HOST:
224 default:
225 return NULL;
226 }
227}
228
229#ifdef USE_HCACHE
238static void imap_msn_index_to_uid_seqset(struct Buffer *buf, struct ImapMboxData *mdata)
239{
240 int first = 1, state = 0;
241 unsigned int cur_uid = 0, last_uid = 0;
242 unsigned int range_begin = 0, range_end = 0;
243 const size_t max_msn = imap_msn_highest(&mdata->msn);
244
245 for (unsigned int msn = 1; msn <= max_msn + 1; msn++)
246 {
247 bool match = false;
248 if (msn <= max_msn)
249 {
250 struct Email *e_cur = imap_msn_get(&mdata->msn, msn - 1);
251 cur_uid = e_cur ? imap_edata_get(e_cur)->uid : 0;
252 if (!state || (cur_uid && ((cur_uid - 1) == last_uid)))
253 match = true;
254 last_uid = cur_uid;
255 }
256
257 if (match)
258 {
259 switch (state)
260 {
261 case 1: /* single: convert to a range */
262 state = 2;
264
265 case 2: /* extend range ending */
266 range_end = cur_uid;
267 break;
268 default:
269 state = 1;
270 range_begin = cur_uid;
271 break;
272 }
273 }
274 else if (state)
275 {
276 if (first)
277 first = 0;
278 else
279 buf_addch(buf, ',');
280
281 if (state == 1)
282 buf_add_printf(buf, "%u", range_begin);
283 else if (state == 2)
284 buf_add_printf(buf, "%u:%u", range_begin, range_end);
285
286 state = 1;
287 range_begin = cur_uid;
288 }
289 }
290}
291
295static void imap_hcache_namer(const struct StoreOps *store_ops,
296 const char *path, struct Buffer *dest)
297{
298 buf_printf(dest, "%s.%s.hcache", path, store_ops->name);
299}
300
307void imap_hcache_open(struct ImapAccountData *adata, struct ImapMboxData *mdata, bool create)
308{
309 if (!adata || !mdata)
310 return;
311
312 if (mdata->hcache)
313 return;
314
315 struct HeaderCache *hc = NULL;
316 struct Buffer *mbox = buf_pool_get();
317 struct Buffer *cachepath = buf_pool_get();
318
319 imap_cachepath(adata->delim, mdata->name, mbox);
320
321 if (strstr(buf_string(mbox), "/../") || mutt_str_equal(buf_string(mbox), "..") ||
322 mutt_strn_equal(buf_string(mbox), "../", 3))
323 {
324 goto cleanup;
325 }
326 size_t len = buf_len(mbox);
327 if ((len > 3) && (mutt_str_equal(buf_string(mbox) + len - 3, "/..")))
328 goto cleanup;
329
330 struct Url url = { 0 };
331 account_to_url(&adata->conn->account, &url);
332 url.path = mbox->data;
333 url_tobuffer(&url, cachepath, U_PATH);
334
335 const char *const c_header_cache = cs_subset_path(NeoMutt->sub, "header_cache");
336 hc = hcache_open(c_header_cache, buf_string(cachepath), imap_hcache_namer, create);
337
338cleanup:
339 buf_pool_release(&mbox);
340 buf_pool_release(&cachepath);
341 mdata->hcache = hc;
342}
343
349{
350 if (!mdata->hcache)
351 return;
352
353 hcache_close(&mdata->hcache);
354}
355
363struct Email *imap_hcache_get(struct ImapMboxData *mdata, unsigned int uid)
364{
365 if (!mdata->hcache)
366 return NULL;
367
368 char key[16] = { 0 };
369
370 snprintf(key, sizeof(key), "%u", uid);
371 struct HCacheEntry hce = hcache_fetch_email(mdata->hcache, key, mutt_str_len(key),
372 mdata->uidvalidity);
373 if (!hce.email && hce.uidvalidity)
374 {
375 mutt_debug(LL_DEBUG3, "hcache uidvalidity mismatch: %u\n", hce.uidvalidity);
376 }
377
378 return hce.email;
379}
380
388int imap_hcache_put(struct ImapMboxData *mdata, struct Email *e)
389{
390 if (!mdata->hcache)
391 return -1;
392
393 char key[16] = { 0 };
394
395 snprintf(key, sizeof(key), "%u", imap_edata_get(e)->uid);
396 return hcache_store_email(mdata->hcache, key, mutt_str_len(key), e, mdata->uidvalidity);
397}
398
406int imap_hcache_del(struct ImapMboxData *mdata, unsigned int uid)
407{
408 if (!mdata->hcache)
409 return -1;
410
411 char key[16] = { 0 };
412
413 snprintf(key, sizeof(key), "%u", uid);
414 return hcache_delete_email(mdata->hcache, key, mutt_str_len(key));
415}
416
424{
425 if (!mdata->hcache)
426 return -1;
427
428 struct Buffer *buf = buf_pool_get();
429 buf_alloc(buf, 8192); // The seqset is likely large. Preallocate to reduce reallocs
431
432 int rc = hcache_store_raw(mdata->hcache, "UIDSEQSET", 9, buf->data, buf_len(buf) + 1);
433 mutt_debug(LL_DEBUG3, "Stored UIDSEQSET %s\n", buf_string(buf));
434 buf_pool_release(&buf);
435 return rc;
436}
437
445{
446 if (!mdata->hcache)
447 return -1;
448
449 return hcache_delete_raw(mdata->hcache, "UIDSEQSET", 9);
450}
451
459{
460 if (!mdata->hcache)
461 return NULL;
462
463 char *seqset = hcache_fetch_raw_str(mdata->hcache, "UIDSEQSET", 9);
464 mutt_debug(LL_DEBUG3, "Retrieved UIDSEQSET %s\n", NONULL(seqset));
465
466 return seqset;
467}
468#endif
469
482int imap_parse_path(const char *path, struct ConnAccount *cac, char *mailbox, size_t mailboxlen)
483{
484 static unsigned short ImapPort = 0;
485 static unsigned short ImapsPort = 0;
486
487 if (ImapPort == 0)
488 {
489 struct servent *service = getservbyname("imap", "tcp");
490 if (service)
491 ImapPort = ntohs(service->s_port);
492 else
493 ImapPort = IMAP_PORT;
494 mutt_debug(LL_DEBUG3, "Using default IMAP port %d\n", ImapPort);
495 }
496
497 if (ImapsPort == 0)
498 {
499 struct servent *service = getservbyname("imaps", "tcp");
500 if (service)
501 ImapsPort = ntohs(service->s_port);
502 else
503 ImapsPort = IMAP_SSL_PORT;
504 mutt_debug(LL_DEBUG3, "Using default IMAPS port %d\n", ImapsPort);
505 }
506
507 /* Defaults */
508 cac->port = ImapPort;
510 cac->service = "imap";
512
513 struct Url *url = url_parse(path);
514 if (!url)
515 return -1;
516
517 if ((url->scheme != U_IMAP) && (url->scheme != U_IMAPS))
518 {
519 url_free(&url);
520 return -1;
521 }
522
523 if ((account_from_url(cac, url) < 0) || (cac->host[0] == '\0'))
524 {
525 url_free(&url);
526 return -1;
527 }
528
529 if (url->scheme == U_IMAPS)
530 cac->flags |= MUTT_ACCT_SSL;
531
532 mutt_str_copy(mailbox, url->path, mailboxlen);
533
534 url_free(&url);
535
536 if ((cac->flags & MUTT_ACCT_SSL) && !(cac->flags & MUTT_ACCT_PORT))
537 cac->port = ImapsPort;
538
539 return 0;
540}
541
553int imap_mxcmp(const char *mx1, const char *mx2)
554{
555 char *b1 = NULL;
556 char *b2 = NULL;
557 int rc;
558
559 if (!mx1 || (*mx1 == '\0'))
560 mx1 = "INBOX";
561 if (!mx2 || (*mx2 == '\0'))
562 mx2 = "INBOX";
563 if (mutt_istr_equal(mx1, "INBOX") && mutt_istr_equal(mx2, "INBOX"))
564 {
565 return 0;
566 }
567
568 b1 = MUTT_MEM_MALLOC(strlen(mx1) + 1, char);
569 b2 = MUTT_MEM_MALLOC(strlen(mx2) + 1, char);
570
571 imap_fix_path(mx1, b1, strlen(mx1) + 1);
572 imap_fix_path(mx2, b2, strlen(mx2) + 1);
573
574 rc = mutt_str_cmp(b1, b2);
575 FREE(&b1);
576 FREE(&b2);
577
578 return rc;
579}
580
589void imap_pretty_mailbox(char *path, size_t pathlen, const char *folder)
590{
591 struct ConnAccount cac_target = { { 0 } };
592 struct ConnAccount cac_home = { { 0 } };
593 struct Url url = { 0 };
594 const char *delim = NULL;
595 int tlen;
596 int hlen = 0;
597 bool home_match = false;
598 char target_mailbox[1024] = { 0 };
599 char home_mailbox[1024] = { 0 };
600
601 if (imap_parse_path(path, &cac_target, target_mailbox, sizeof(target_mailbox)) < 0)
602 return;
603
604 if (imap_path_probe(folder, NULL) != MUTT_IMAP)
605 goto fallback;
606
607 if (imap_parse_path(folder, &cac_home, home_mailbox, sizeof(home_mailbox)) < 0)
608 goto fallback;
609
610 tlen = mutt_str_len(target_mailbox);
611 hlen = mutt_str_len(home_mailbox);
612
613 /* check whether we can do '+' substitution */
614 if (tlen && imap_account_match(&cac_home, &cac_target) &&
615 mutt_strn_equal(home_mailbox, target_mailbox, hlen))
616 {
617 const char *const c_imap_delim_chars = cs_subset_string(NeoMutt->sub, "imap_delim_chars");
618 if (hlen == 0)
619 {
620 home_match = true;
621 }
622 else if (c_imap_delim_chars)
623 {
624 for (delim = c_imap_delim_chars; *delim != '\0'; delim++)
625 if (target_mailbox[hlen] == *delim)
626 home_match = true;
627 }
628 }
629
630 /* do the '+' substitution */
631 if (home_match)
632 {
633 *path++ = '+';
634 /* copy remaining path, skipping delimiter */
635 if (hlen != 0)
636 hlen++;
637 memcpy(path, target_mailbox + hlen, tlen - hlen);
638 path[tlen - hlen] = '\0';
639 return;
640 }
641
642fallback:
643 account_to_url(&cac_target, &url);
644 url.path = target_mailbox;
645 url_tostring(&url, path, pathlen, U_NO_FLAGS);
646}
647
654enum QuadOption imap_continue(const char *msg, const char *resp)
655{
656 imap_error(msg, resp);
657 return query_yesorno(_("Continue?"), MUTT_NO);
658}
659
665void imap_error(const char *where, const char *msg)
666{
667 mutt_error("%s [%s]", where, msg);
668}
669
686char *imap_fix_path(const char *mailbox, char *path, size_t plen)
687{
688 const char *const c_imap_delim_chars = cs_subset_string(NeoMutt->sub, "imap_delim_chars");
689
690 char *out = path;
691 size_t space_left = plen - 1;
692
693 if (mailbox)
694 {
695 for (const char *c = mailbox; *c && space_left; c++, space_left--)
696 {
697 if (strchr(NONULL(c_imap_delim_chars), *c))
698 {
699 return imap_fix_path_with_delim(*c, mailbox, path, plen);
700 }
701 *out++ = *c;
702 }
703 }
704
705 *out = '\0';
706 return path;
707}
708
718char *imap_fix_path_with_delim(const char delim, const char *mailbox, char *path, size_t plen)
719{
720 char *out = path;
721 size_t space_left = plen - 1;
722
723 if (mailbox)
724 {
725 for (const char *c = mailbox; *c && space_left; c++, space_left--)
726 {
727 if (*c == delim || *c == '/')
728 {
729 while (*c && *(c + 1) == *c)
730 c++;
731 *out++ = delim;
732 }
733 else
734 {
735 *out++ = *c;
736 }
737 }
738 }
739
740 if (out != path && *(out - 1) == delim)
741 {
742 out--;
743 }
744 *out = '\0';
745 return path;
746}
747
754void imap_cachepath(char delim, const char *mailbox, struct Buffer *dest)
755{
756 const char *p = mailbox;
757 buf_reset(dest);
758 if (!p)
759 return;
760
761 while (*p)
762 {
763 if (p[0] == delim)
764 {
765 buf_addch(dest, '/');
766 /* simple way to avoid collisions with UIDs */
767 if ((p[1] >= '0') && (p[1] <= '9'))
768 buf_addch(dest, '_');
769 }
770 else
771 {
772 buf_addch(dest, *p);
773 }
774 p++;
775 }
776}
777
785int imap_get_literal_count(char *buf, unsigned int *bytes)
786{
787 char *pc = NULL;
788 char *pn = NULL;
789
790 if (!buf || !(pc = strchr(buf, '{')))
791 return -1;
792
793 pc++;
794 pn = pc;
795 while (mutt_isdigit(*pc))
796 pc++;
797 *pc = '\0';
798 if (!mutt_str_atoui(pn, bytes))
799 return -1;
800
801 return 0;
802}
803
812char *imap_get_qualifier(char *buf)
813{
814 char *s = buf;
815
816 /* skip tag */
817 s = imap_next_word(s);
818 /* skip OK/NO/BAD response */
819 s = imap_next_word(s);
820
821 return s;
822}
823
829char *imap_next_word(char *s)
830{
831 bool quoted = false;
832
833 while (*s)
834 {
835 if (*s == '\\')
836 {
837 s++;
838 if (*s)
839 s++;
840 continue;
841 }
842 if (*s == '\"')
843 quoted = !quoted;
844 if (!quoted && mutt_isspace(*s))
845 break;
846 s++;
847 }
848
849 SKIPWS(s);
850 return s;
851}
852
860void imap_qualify_path(char *buf, size_t buflen, struct ConnAccount *cac, char *path)
861{
862 struct Url url = { 0 };
863 account_to_url(cac, &url);
864 url.path = path;
865 url_tostring(&url, buf, buflen, U_NO_FLAGS);
866}
867
874void imap_buf_qualify_path(struct Buffer *buf, struct ConnAccount *cac, char *path)
875{
876 struct Url url = { 0 };
877 account_to_url(cac, &url);
878 url.path = path;
879 url_tobuffer(&url, buf, U_NO_FLAGS);
880}
881
891void imap_quote_string(char *dest, size_t dlen, const char *src, bool quote_backtick)
892{
893 const char *quote = "`\"\\";
894 if (!quote_backtick)
895 quote++;
896
897 char *pt = dest;
898 const char *s = src;
899
900 if (dlen < 3)
901 {
902 *dest = '\0';
903 return;
904 }
905
906 *pt++ = '"';
907 /* save room for quote-chars */
908 dlen -= 3;
909
910 for (; *s && dlen; s++)
911 {
912 if (strchr(quote, *s))
913 {
914 if (dlen < 2)
915 break;
916 dlen -= 2;
917 *pt++ = '\\';
918 *pt++ = *s;
919 }
920 else
921 {
922 *pt++ = *s;
923 dlen--;
924 }
925 }
926 *pt++ = '"';
927 *pt = '\0';
928}
929
935{
936 char *d = s;
937
938 if (*s == '\"')
939 s++;
940 else
941 return;
942
943 while (*s)
944 {
945 if (*s == '\"')
946 {
947 *d = '\0';
948 return;
949 }
950 if (*s == '\\')
951 {
952 s++;
953 }
954 if (*s)
955 {
956 *d = *s;
957 d++;
958 s++;
959 }
960 }
961 *d = '\0';
962}
963
971void imap_munge_mbox_name(bool unicode, char *dest, size_t dlen, const char *src)
972{
973 char *buf = mutt_str_dup(src);
974 imap_utf_encode(unicode, &buf);
975
976 imap_quote_string(dest, dlen, buf, false);
977
978 FREE(&buf);
979}
980
988void imap_unmunge_mbox_name(bool unicode, char *s)
989{
991
992 char *buf = mutt_str_dup(s);
993 if (buf)
994 {
995 imap_utf_decode(unicode, &buf);
996 strncpy(s, buf, strlen(s));
997 }
998
999 FREE(&buf);
1000}
1001
1006{
1007 time_t now = mutt_date_now();
1008 const short c_imap_keep_alive = cs_subset_number(NeoMutt->sub, "imap_keep_alive");
1009
1010 struct Account **ap = NULL;
1012 {
1013 struct Account *a = *ap;
1014 if (a->type != MUTT_IMAP)
1015 continue;
1016
1017 struct ImapAccountData *adata = a->adata;
1018 if (!adata || !adata->mailbox)
1019 continue;
1020
1021 if ((adata->state >= IMAP_AUTHENTICATED) && (now >= (adata->lastread + c_imap_keep_alive)))
1022 imap_check_mailbox(adata->mailbox, true);
1023 }
1024}
1025
1032{
1033 struct sigaction oldalrm = { 0 };
1034 struct sigaction act = { 0 };
1035 sigset_t oldmask = { 0 };
1036 int rc;
1037
1038 const bool c_imap_passive = cs_subset_bool(NeoMutt->sub, "imap_passive");
1039 cs_subset_str_native_set(NeoMutt->sub, "imap_passive", true, NULL);
1040 OptKeepQuiet = true;
1041
1042 sigprocmask(SIG_SETMASK, NULL, &oldmask);
1043
1044 sigemptyset(&act.sa_mask);
1045 act.sa_handler = mutt_sig_empty_handler;
1046#ifdef SA_INTERRUPT
1047 act.sa_flags = SA_INTERRUPT;
1048#else
1049 act.sa_flags = 0;
1050#endif
1051
1052 sigaction(SIGALRM, &act, &oldalrm);
1053
1054 const short c_imap_keep_alive = cs_subset_number(NeoMutt->sub, "imap_keep_alive");
1055 alarm(c_imap_keep_alive);
1056 while ((waitpid(pid, &rc, 0) < 0) && (errno == EINTR))
1057 {
1058 alarm(0); /* cancel a possibly pending alarm */
1060 alarm(c_imap_keep_alive);
1061 }
1062
1063 alarm(0); /* cancel a possibly pending alarm */
1064
1065 sigaction(SIGALRM, &oldalrm, NULL);
1066 sigprocmask(SIG_SETMASK, &oldmask, NULL);
1067
1068 OptKeepQuiet = false;
1069 cs_subset_str_native_set(NeoMutt->sub, "imap_passive", c_imap_passive, NULL);
1070
1071 return rc;
1072}
1073
1079{
1081 struct ImapMboxData *mdata = imap_mdata_get(m);
1082 if (!adata || !adata->mailbox || (adata->mailbox != m) || !mdata)
1083 return;
1084 mdata->reopen |= IMAP_REOPEN_ALLOW;
1085}
1086
1092{
1094 struct ImapMboxData *mdata = imap_mdata_get(m);
1095 if (!adata || !adata->mailbox || (adata->mailbox != m) || !mdata)
1096 return;
1097 mdata->reopen &= ~IMAP_REOPEN_ALLOW;
1098}
1099
1106bool imap_account_match(const struct ConnAccount *a1, const struct ConnAccount *a2)
1107{
1108 if (!a1 || !a2)
1109 return false;
1110 if (a1->type != a2->type)
1111 return false;
1112 if (!mutt_istr_equal(a1->host, a2->host))
1113 return false;
1114 if ((a1->port != 0) && (a2->port != 0) && (a1->port != a2->port))
1115 return false;
1116 if (a1->flags & a2->flags & MUTT_ACCT_USER)
1117 return mutt_str_equal(a1->user, a2->user);
1118
1119 const char *user = NONULL(NeoMutt->username);
1120
1121 const char *const c_imap_user = cs_subset_string(NeoMutt->sub, "imap_user");
1122 if ((a1->type == MUTT_ACCT_TYPE_IMAP) && c_imap_user)
1123 user = c_imap_user;
1124
1125 if (a1->flags & MUTT_ACCT_USER)
1126 return mutt_str_equal(a1->user, user);
1127 if (a2->flags & MUTT_ACCT_USER)
1128 return mutt_str_equal(a2->user, user);
1129
1130 return true;
1131}
1132
1138struct SeqsetIterator *mutt_seqset_iterator_new(const char *seqset)
1139{
1140 if (!seqset || (*seqset == '\0'))
1141 return NULL;
1142
1143 struct SeqsetIterator *iter = MUTT_MEM_CALLOC(1, struct SeqsetIterator);
1144 iter->full_seqset = mutt_str_dup(seqset);
1145 iter->eostr = strchr(iter->full_seqset, '\0');
1146 iter->substr_cur = iter->substr_end = iter->full_seqset;
1147
1148 return iter;
1149}
1150
1159int mutt_seqset_iterator_next(struct SeqsetIterator *iter, unsigned int *next)
1160{
1161 if (!iter || !next)
1162 return -1;
1163
1164 if (iter->in_range)
1165 {
1166 if ((iter->down && (iter->range_cur == (iter->range_end - 1))) ||
1167 (!iter->down && (iter->range_cur == (iter->range_end + 1))))
1168 {
1169 iter->in_range = 0;
1170 }
1171 }
1172
1173 if (!iter->in_range)
1174 {
1175 iter->substr_cur = iter->substr_end;
1176 if (iter->substr_cur == iter->eostr)
1177 return 1;
1178
1179 iter->substr_end = strchr(iter->substr_cur, ',');
1180 if (!iter->substr_end)
1181 iter->substr_end = iter->eostr;
1182 else
1183 *(iter->substr_end++) = '\0';
1184
1185 char *range_sep = strchr(iter->substr_cur, ':');
1186 if (range_sep)
1187 *range_sep++ = '\0';
1188
1189 if (!mutt_str_atoui_full(iter->substr_cur, &iter->range_cur))
1190 return -1;
1191 if (range_sep)
1192 {
1193 if (!mutt_str_atoui_full(range_sep, &iter->range_end))
1194 return -1;
1195 }
1196 else
1197 {
1198 iter->range_end = iter->range_cur;
1199 }
1200
1201 iter->down = (iter->range_end < iter->range_cur);
1202 iter->in_range = 1;
1203 }
1204
1205 *next = iter->range_cur;
1206 if (iter->down)
1207 iter->range_cur--;
1208 else
1209 iter->range_cur++;
1210
1211 return 0;
1212}
1213
1219{
1220 if (!ptr || !*ptr)
1221 return;
1222
1223 struct SeqsetIterator *iter = *ptr;
1224 FREE(&iter->full_seqset);
1225 FREE(ptr);
1226}
#define ARRAY_FOREACH(elem, head)
Iterate over all elements of the array.
Definition array.h:223
const char * mutt_str_atoui(const char *str, unsigned int *dst)
Convert ASCII string to an unsigned integer.
Definition atoi.c:217
Body Caching (local copies of email bodies)
void mutt_bcache_close(struct BodyCache **ptr)
Close an Email-Body Cache.
Definition bcache.c:167
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition buffer.c:161
int buf_add_printf(struct Buffer *buf, const char *fmt,...)
Format a string appending a Buffer.
Definition buffer.c:204
size_t buf_len(const struct Buffer *buf)
Calculate the length of a Buffer.
Definition buffer.c:491
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition buffer.c:76
size_t buf_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition buffer.c:241
void buf_alloc(struct Buffer *buf, size_t new_size)
Make sure a buffer can store at least new_size bytes.
Definition buffer.c:337
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition helpers.c:291
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition helpers.c:143
const char * cs_subset_path(const struct ConfigSubset *sub, const char *name)
Get a path config item by name.
Definition helpers.c:168
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition helpers.c:47
Convenience wrapper for the config headers.
Connection Library.
ConnAccountField
Login credentials.
Definition connaccount.h:33
@ MUTT_CA_OAUTH_CMD
OAuth refresh command.
Definition connaccount.h:38
@ MUTT_CA_USER
User name.
Definition connaccount.h:36
@ MUTT_CA_LOGIN
Login name.
Definition connaccount.h:35
@ MUTT_CA_HOST
Server name.
Definition connaccount.h:34
@ MUTT_CA_PASS
Password.
Definition connaccount.h:37
#define MUTT_ACCT_SSL
Account uses SSL/TLS.
Definition connaccount.h:47
#define MUTT_ACCT_USER
User field has been set.
Definition connaccount.h:44
#define MUTT_ACCT_PORT
Port field has been set.
Definition connaccount.h:43
Convenience wrapper for the core headers.
@ MUTT_IMAP
'IMAP' Mailbox type
Definition mailbox.h:49
bool mutt_isspace(int arg)
Wrapper for isspace(3)
Definition ctype.c:96
bool mutt_isdigit(int arg)
Wrapper for isdigit(3)
Definition ctype.c:66
Structs that make up an email.
bool OptKeepQuiet
(pseudo) shut up the message and refresh functions while we are executing an external program
Definition globals.c:49
Global variables.
static const char * imap_get_field(enum ConnAccountField field, void *gf_data)
Get connection login credentials - Implements ConnAccount::get_field() -.
Definition util.c:211
static void imap_hcache_namer(const struct StoreOps *store_ops, const char *path, struct Buffer *dest)
Generate a filename for the header cache - Implements hcache_namer_t -.
Definition util.c:295
#define mutt_error(...)
Definition logging2.h:94
#define mutt_debug(LEVEL,...)
Definition logging2.h:91
void imap_mdata_free(void **ptr)
Free the private Mailbox data - Implements Mailbox::mdata_free() -.
Definition mdata.c:40
enum MailboxType imap_path_probe(const char *path, const struct stat *st)
Is this an IMAP Mailbox?
Definition imap.c:2681
void mutt_hash_free(struct HashTable **ptr)
Free a hash table.
Definition hash.c:459
struct HeaderCache * hcache_open(const char *path, const char *folder, hcache_namer_t namer, bool create)
Multiplexor for StoreOps::open.
Definition hcache.c:477
int hcache_delete_email(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition hcache.c:752
void hcache_close(struct HeaderCache **ptr)
Multiplexor for StoreOps::close.
Definition hcache.c:549
struct HCacheEntry hcache_fetch_email(struct HeaderCache *hc, const char *key, size_t keylen, uint32_t uidvalidity)
Multiplexor for StoreOps::fetch.
Definition hcache.c:569
int hcache_store_email(struct HeaderCache *hc, const char *key, size_t keylen, struct Email *e, uint32_t uidvalidity)
Multiplexor for StoreOps::store.
Definition hcache.c:683
char * hcache_fetch_raw_str(struct HeaderCache *hc, const char *key, size_t keylen)
Fetch a string from the cache.
Definition hcache.c:662
int hcache_delete_raw(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition hcache.c:765
int hcache_store_raw(struct HeaderCache *hc, const char *key, size_t keylen, void *data, size_t dlen)
Store a key / data pair.
Definition hcache.c:737
Header cache multiplexor.
struct ImapAccountData * imap_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition adata.c:162
Imap-specific Account data.
struct ImapEmailData * imap_edata_get(struct Email *e)
Get the private data for this Email.
Definition edata.c:66
Imap-specific Email data.
IMAP network mailbox.
struct ImapMboxData * imap_mdata_new(struct ImapAccountData *adata, const char *name)
Allocate and initialise a new ImapMboxData structure.
Definition mdata.c:74
struct ImapMboxData * imap_mdata_get(struct Mailbox *m)
Get the Mailbox data for this mailbox.
Definition mdata.c:61
Imap-specific Mailbox data.
Shared constants/structs that are private to IMAP.
#define IMAP_PORT
Default port for IMAP.
Definition private.h:44
@ IMAP_AUTHENTICATED
Connection is authenticated.
Definition private.h:108
#define IMAP_OPEN_NO_FLAGS
No flags are set.
Definition private.h:63
#define IMAP_REOPEN_ALLOW
Allow re-opening a folder upon expunge.
Definition private.h:64
void imap_utf_encode(bool unicode, char **s)
Encode email from local charset to UTF-8.
Definition utf7.c:397
#define IMAP_SSL_PORT
Port for IMAP over SSL/TLS.
Definition private.h:45
void imap_utf_decode(bool unicode, char **s)
Decode email from UTF-8 to local charset.
Definition utf7.c:430
enum MxStatus imap_check_mailbox(struct Mailbox *m, bool force)
Use the NOOP or IDLE command to poll for new mail.
Definition imap.c:1220
@ LL_DEBUG3
Log at debug level 3.
Definition logging2.h:47
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:68
#define MUTT_MEM_CALLOC(n, type)
Definition memory.h:52
#define MUTT_MEM_MALLOC(n, type)
Definition memory.h:53
void imap_msn_free(struct MSNArray *msn)
Free the cache.
Definition msn.c:62
struct Email * imap_msn_get(const struct MSNArray *msn, int idx)
Return the Email associated with an msn.
Definition msn.c:83
size_t imap_msn_highest(const struct MSNArray *msn)
Return the highest MSN in use.
Definition msn.c:72
IMAP MSN helper functions.
time_t mutt_date_now(void)
Return the number of seconds since the Unix epoch.
Definition date.c:457
Convenience wrapper for the library headers.
#define FALLTHROUGH
Definition lib.h:117
#define _(a)
Definition message.h:28
int mutt_str_cmp(const char *a, const char *b)
Compare two strings, safely.
Definition string.c:403
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition string.c:677
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition string.c:257
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:665
bool mutt_strn_equal(const char *a, const char *b, size_t num)
Check for equality of two strings (to a maximum), safely.
Definition string.c:429
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition string.c:503
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:586
void account_to_url(struct ConnAccount *cac, struct Url *url)
Fill URL with info from account.
int account_from_url(struct ConnAccount *cac, const struct Url *url)
Fill ConnAccount with information from url.
@ MUTT_ACCT_TYPE_IMAP
Imap Account.
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:91
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:111
QuadOption
Possible values for a quad-option.
Definition quad.h:36
@ MUTT_NO
User answered 'No', or assume 'No'.
Definition quad.h:38
Ask the user a question.
enum QuadOption query_yesorno(const char *prompt, enum QuadOption def)
Ask the user a Yes/No question.
Definition question.c:329
void mutt_sig_empty_handler(int sig)
Dummy signal handler.
Definition signal.c:130
Key value store.
#define NONULL(x)
Definition string2.h:44
#define SKIPWS(ch)
Definition string2.h:52
A group of associated Mailboxes.
Definition account.h:36
enum MailboxType type
Type of Mailboxes this Account contains.
Definition account.h:37
void * adata
Private data (for Mailbox backends)
Definition account.h:42
String manipulation buffer.
Definition buffer.h:36
char * data
Pointer to data.
Definition buffer.h:37
Login details for a remote server.
Definition connaccount.h:53
char user[128]
Username.
Definition connaccount.h:56
const char * service
Name of the service, e.g. "imap".
Definition connaccount.h:61
char host[128]
Server to login to.
Definition connaccount.h:54
const char *(* get_field)(enum ConnAccountField field, void *gf_data)
Definition connaccount.h:70
unsigned char type
Connection type, e.g. MUTT_ACCT_TYPE_IMAP.
Definition connaccount.h:59
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition connaccount.h:60
unsigned short port
Port to connect to.
Definition connaccount.h:58
struct ConnAccount account
Account details: username, password, etc.
Definition connection.h:49
The envelope/body of an email.
Definition email.h:39
char * path
Path of Email (for local Mailboxes)
Definition email.h:70
Wrapper for Email retrieved from the header cache.
Definition lib.h:100
uint32_t uidvalidity
IMAP-specific UIDVALIDITY.
Definition lib.h:101
struct Email * email
Retrieved email.
Definition lib.h:103
Header Cache.
Definition lib.h:87
IMAP-specific Account data -.
Definition adata.h:40
char delim
Path delimiter.
Definition adata.h:79
struct Mailbox * mailbox
Current selected mailbox.
Definition adata.h:80
struct Connection * conn
Connection to IMAP server.
Definition adata.h:41
unsigned int uid
32-bit Message UID
Definition edata.h:45
IMAP-specific Mailbox data -.
Definition mdata.h:40
ImapOpenFlags reopen
Flags, e.g. IMAP_REOPEN_ALLOW.
Definition mdata.h:45
struct HeaderCache * hcache
Email header cache.
Definition mdata.h:64
struct BodyCache * bcache
Email body cache.
Definition mdata.h:62
struct HashTable * uid_hash
Hash Table: "uid" -> Email.
Definition mdata.h:60
ImapOpenFlags check_status
Flags, e.g. IMAP_NEWMAIL_PENDING.
Definition mdata.h:46
uint32_t uidvalidity
UID validity.
Definition mdata.h:51
char * name
Mailbox name.
Definition mdata.h:41
A mailbox.
Definition mailbox.h:78
void * mdata
Driver specific data.
Definition mailbox.h:131
Container for Accounts, Notifications.
Definition neomutt.h:41
struct AccountArray accounts
All Accounts.
Definition neomutt.h:50
char * username
User's login name.
Definition neomutt.h:56
struct ConfigSubset * sub
Inherited config items.
Definition neomutt.h:49
UID Sequence Set Iterator.
Definition private.h:170
char * eostr
End of string.
Definition private.h:172
char * substr_end
End of substring.
Definition private.h:178
unsigned int range_end
End of range.
Definition private.h:176
int down
Counting down.
Definition private.h:174
char * substr_cur
Current position in substring.
Definition private.h:177
int in_range
Currently in a range.
Definition private.h:173
char * full_seqset
Full sequence set string.
Definition private.h:171
unsigned int range_cur
Current range value.
Definition private.h:175
Definition lib.h:66
const char * name
Store name.
Definition lib.h:67
A parsed URL proto://user:password@host:port/path?a=1&b=2
Definition url.h:69
char * src
Raw URL string.
Definition url.h:77
char * path
Path.
Definition url.h:75
enum UrlScheme scheme
Scheme, e.g. U_SMTPS.
Definition url.h:70
int cs_subset_str_native_set(const struct ConfigSubset *sub, const char *name, intptr_t value, struct Buffer *err)
Natively set the value of a string config item.
Definition subset.c:303
struct Url * url_parse(const char *src)
Fill in Url.
Definition url.c:242
void url_free(struct Url **ptr)
Free the contents of a URL.
Definition url.c:124
int url_tostring(const struct Url *url, char *dest, size_t len, uint8_t flags)
Output the URL string for a given Url object.
Definition url.c:426
int url_tobuffer(const struct Url *url, struct Buffer *buf, uint8_t flags)
Output the URL string for a given Url object.
Definition url.c:361
#define U_NO_FLAGS
No flags are set for URL parsing.
Definition url.h:49
@ U_IMAP
Url is imap://.
Definition url.h:39
@ U_IMAPS
Url is imaps://.
Definition url.h:40
#define U_PATH
Path is included in URL.
Definition url.h:50
void imap_unmunge_mbox_name(bool unicode, char *s)
Remove quoting from a mailbox name.
Definition util.c:988
int imap_parse_path(const char *path, struct ConnAccount *cac, char *mailbox, size_t mailboxlen)
Parse an IMAP mailbox name into ConnAccount, name.
Definition util.c:482
void imap_qualify_path(char *buf, size_t buflen, struct ConnAccount *cac, char *path)
Make an absolute IMAP folder target.
Definition util.c:860
void imap_allow_reopen(struct Mailbox *m)
Allow re-opening a folder upon expunge.
Definition util.c:1078
void imap_disallow_reopen(struct Mailbox *m)
Disallow re-opening a folder upon expunge.
Definition util.c:1091
void imap_hcache_open(struct ImapAccountData *adata, struct ImapMboxData *mdata, bool create)
Open a header cache.
Definition util.c:307
int imap_hcache_store_uid_seqset(struct ImapMboxData *mdata)
Store a UID Sequence Set in the header cache.
Definition util.c:423
int imap_hcache_put(struct ImapMboxData *mdata, struct Email *e)
Add an entry to the header cache.
Definition util.c:388
void imap_mdata_cache_reset(struct ImapMboxData *mdata)
Release and clear cache data of ImapMboxData structure.
Definition util.c:111
void imap_get_parent(const char *mbox, char delim, char *buf, size_t buflen)
Get an IMAP folder's parent.
Definition util.c:127
struct SeqsetIterator * mutt_seqset_iterator_new(const char *seqset)
Create a new Sequence Set Iterator.
Definition util.c:1138
void imap_quote_string(char *dest, size_t dlen, const char *src, bool quote_backtick)
Quote string according to IMAP rules.
Definition util.c:891
char * imap_hcache_get_uid_seqset(struct ImapMboxData *mdata)
Get a UID Sequence Set from the header cache.
Definition util.c:458
enum QuadOption imap_continue(const char *msg, const char *resp)
Display a message and ask the user if they want to go on.
Definition util.c:654
void imap_unquote_string(char *s)
Equally stupid unquoting routine.
Definition util.c:934
struct Email * imap_hcache_get(struct ImapMboxData *mdata, unsigned int uid)
Get a header cache entry by its UID.
Definition util.c:363
int imap_wait_keep_alive(pid_t pid)
Wait for a process to change state.
Definition util.c:1031
void imap_get_parent_path(const char *path, char *buf, size_t buflen)
Get the path of the parent folder.
Definition util.c:168
int mutt_seqset_iterator_next(struct SeqsetIterator *iter, unsigned int *next)
Get the next UID from a Sequence Set.
Definition util.c:1159
void imap_clean_path(char *path, size_t plen)
Cleans an IMAP path using imap_fix_path.
Definition util.c:195
void mutt_seqset_iterator_free(struct SeqsetIterator **ptr)
Free a Sequence Set Iterator.
Definition util.c:1218
int imap_get_literal_count(char *buf, unsigned int *bytes)
Write number of bytes in an IMAP literal into bytes.
Definition util.c:785
int imap_mxcmp(const char *mx1, const char *mx2)
Compare mailbox names, giving priority to INBOX.
Definition util.c:553
void imap_pretty_mailbox(char *path, size_t pathlen, const char *folder)
Prettify an IMAP mailbox name.
Definition util.c:589
void imap_cachepath(char delim, const char *mailbox, struct Buffer *dest)
Generate a cache path for a mailbox.
Definition util.c:754
char * imap_fix_path(const char *mailbox, char *path, size_t plen)
Fix up the imap path.
Definition util.c:686
void imap_error(const char *where, const char *msg)
Show an error and abort.
Definition util.c:665
void imap_hcache_close(struct ImapMboxData *mdata)
Close the header cache.
Definition util.c:348
char * imap_fix_path_with_delim(const char delim, const char *mailbox, char *path, size_t plen)
Fix up the imap path.
Definition util.c:718
int imap_hcache_del(struct ImapMboxData *mdata, unsigned int uid)
Delete an item from the header cache.
Definition util.c:406
int imap_hcache_clear_uid_seqset(struct ImapMboxData *mdata)
Delete a UID Sequence Set from the header cache.
Definition util.c:444
int imap_adata_find(const char *path, struct ImapAccountData **adata, struct ImapMboxData **mdata)
Find the Account data for this path.
Definition util.c:73
bool imap_account_match(const struct ConnAccount *a1, const struct ConnAccount *a2)
Compare two Accounts.
Definition util.c:1106
void imap_munge_mbox_name(bool unicode, char *dest, size_t dlen, const char *src)
Quote awkward characters in a mailbox name.
Definition util.c:971
void imap_keep_alive(void)
Poll the current folder to keep the connection alive.
Definition util.c:1005
static void imap_msn_index_to_uid_seqset(struct Buffer *buf, struct ImapMboxData *mdata)
Convert MSN index of UIDs to Seqset.
Definition util.c:238
void imap_buf_qualify_path(struct Buffer *buf, struct ConnAccount *cac, char *path)
Make an absolute IMAP folder target to a buffer.
Definition util.c:874
char * imap_next_word(char *s)
Find where the next IMAP word begins.
Definition util.c:829
char * imap_get_qualifier(char *buf)
Get the qualifier from a tagged response.
Definition util.c:812