NeoMutt  2023-05-17-33-gce4425
Teaching an old dog new tricks
DOXYGEN
util.c
Go to the documentation of this file.
1
32#include "config.h"
33#include <arpa/inet.h>
34#include <ctype.h>
35#include <errno.h>
36#include <netdb.h>
37#include <signal.h>
38#include <stdbool.h>
39#include <stdio.h>
40#include <string.h>
41#include <sys/wait.h>
42#include <time.h>
43#include <unistd.h>
44#include "private.h"
45#include "mutt/lib.h"
46#include "config/lib.h"
47#include "email/lib.h"
48#include "core/lib.h"
49#include "conn/lib.h"
50#include "lib.h"
51#include "bcache/lib.h"
52#include "question/lib.h"
53#include "adata.h"
54#include "edata.h"
55#include "globals.h" // IWYU pragma: keep
56#include "mdata.h"
57#include "msn.h"
58#include "mutt_account.h"
59#ifdef USE_HCACHE
60#include "hcache/lib.h"
61#endif
62
71int imap_adata_find(const char *path, struct ImapAccountData **adata,
72 struct ImapMboxData **mdata)
73{
74 struct ConnAccount cac = { { 0 } };
75 struct ImapAccountData *tmp_adata = NULL;
76 char tmp[1024] = { 0 };
77
78 if (imap_parse_path(path, &cac, tmp, sizeof(tmp)) < 0)
79 return -1;
80
81 struct Account *np = NULL;
82 TAILQ_FOREACH(np, &NeoMutt->accounts, entries)
83 {
84 if (np->type != MUTT_IMAP)
85 continue;
86
87 tmp_adata = np->adata;
88 if (!tmp_adata)
89 continue;
90 if (imap_account_match(&tmp_adata->conn->account, &cac))
91 {
92 *mdata = imap_mdata_new(tmp_adata, tmp);
93 *adata = tmp_adata;
94 return 0;
95 }
96 }
97 mutt_debug(LL_DEBUG3, "no ImapAccountData found\n");
98 return -1;
99}
100
106{
107 mutt_hash_free(&mdata->uid_hash);
108 imap_msn_free(&mdata->msn);
109 mutt_bcache_close(&mdata->bcache);
110}
111
119void imap_get_parent(const char *mbox, char delim, char *buf, size_t buflen)
120{
121 /* Make a copy of the mailbox name, but only if the pointers are different */
122 if (mbox != buf)
123 mutt_str_copy(buf, mbox, buflen);
124
125 int n = mutt_str_len(buf);
126
127 /* Let's go backwards until the next delimiter
128 *
129 * If buf[n] is a '/', the first n-- will allow us
130 * to ignore it. If it isn't, then buf looks like
131 * "/aaaaa/bbbb". There is at least one "b", so we can't skip
132 * the "/" after the 'a's.
133 *
134 * If buf == '/', then n-- => n == 0, so the loop ends
135 * immediately */
136 for (n--; (n >= 0) && (buf[n] != delim); n--)
137 ; // do nothing
138
139 /* We stopped before the beginning. There is a trailing slash. */
140 if (n > 0)
141 {
142 /* Strip the trailing delimiter. */
143 buf[n] = '\0';
144 }
145 else
146 {
147 buf[0] = (n == 0) ? delim : '\0';
148 }
149}
150
160void imap_get_parent_path(const char *path, char *buf, size_t buflen)
161{
162 struct ImapAccountData *adata = NULL;
163 struct ImapMboxData *mdata = NULL;
164 char mbox[1024] = { 0 };
165
166 if (imap_adata_find(path, &adata, &mdata) < 0)
167 {
168 mutt_str_copy(buf, path, buflen);
169 return;
170 }
171
172 /* Gets the parent mbox in mbox */
173 imap_get_parent(mdata->name, adata->delim, mbox, sizeof(mbox));
174
175 /* Returns a fully qualified IMAP url */
176 imap_qualify_path(buf, buflen, &adata->conn->account, mbox);
177 imap_mdata_free((void *) &mdata);
178}
179
187void imap_clean_path(char *path, size_t plen)
188{
189 struct ImapAccountData *adata = NULL;
190 struct ImapMboxData *mdata = NULL;
191
192 if (imap_adata_find(path, &adata, &mdata) < 0)
193 return;
194
195 /* Returns a fully qualified IMAP url */
196 imap_qualify_path(path, plen, &adata->conn->account, mdata->name);
197 imap_mdata_free((void *) &mdata);
198}
199
203static const char *imap_get_field(enum ConnAccountField field, void *gf_data)
204{
205 switch (field)
206 {
207 case MUTT_CA_LOGIN:
208 return cs_subset_string(NeoMutt->sub, "imap_login");
209 case MUTT_CA_USER:
210 return cs_subset_string(NeoMutt->sub, "imap_user");
211 case MUTT_CA_PASS:
212 return cs_subset_string(NeoMutt->sub, "imap_pass");
214 return cs_subset_string(NeoMutt->sub, "imap_oauth_refresh_command");
215 case MUTT_CA_HOST:
216 default:
217 return NULL;
218 }
219}
220
221#ifdef USE_HCACHE
230static void imap_msn_index_to_uid_seqset(struct Buffer *buf, struct ImapMboxData *mdata)
231{
232 int first = 1, state = 0;
233 unsigned int cur_uid = 0, last_uid = 0;
234 unsigned int range_begin = 0, range_end = 0;
235 const size_t max_msn = imap_msn_highest(&mdata->msn);
236
237 for (unsigned int msn = 1; msn <= max_msn + 1; msn++)
238 {
239 bool match = false;
240 if (msn <= max_msn)
241 {
242 struct Email *e_cur = imap_msn_get(&mdata->msn, msn - 1);
243 cur_uid = e_cur ? imap_edata_get(e_cur)->uid : 0;
244 if (!state || (cur_uid && ((cur_uid - 1) == last_uid)))
245 match = true;
246 last_uid = cur_uid;
247 }
248
249 if (match)
250 {
251 switch (state)
252 {
253 case 1: /* single: convert to a range */
254 state = 2;
255 /* fall through */
256 case 2: /* extend range ending */
257 range_end = cur_uid;
258 break;
259 default:
260 state = 1;
261 range_begin = cur_uid;
262 break;
263 }
264 }
265 else if (state)
266 {
267 if (first)
268 first = 0;
269 else
270 buf_addch(buf, ',');
271
272 if (state == 1)
273 buf_add_printf(buf, "%u", range_begin);
274 else if (state == 2)
275 buf_add_printf(buf, "%u:%u", range_begin, range_end);
276
277 state = 1;
278 range_begin = cur_uid;
279 }
280 }
281}
282
286static void imap_hcache_namer(const char *path, struct Buffer *dest)
287{
288 buf_printf(dest, "%s.hcache", path);
289}
290
296void imap_hcache_open(struct ImapAccountData *adata, struct ImapMboxData *mdata)
297{
298 if (!adata || !mdata)
299 return;
300
301 if (mdata->hcache)
302 return;
303
304 struct HeaderCache *hc = NULL;
305 struct Buffer *mbox = buf_pool_get();
306 struct Buffer *cachepath = buf_pool_get();
307
308 imap_cachepath(adata->delim, mdata->name, mbox);
309
310 if (strstr(buf_string(mbox), "/../") || mutt_str_equal(buf_string(mbox), "..") ||
311 mutt_strn_equal(buf_string(mbox), "../", 3))
312 {
313 goto cleanup;
314 }
315 size_t len = buf_len(mbox);
316 if ((len > 3) && (mutt_str_equal(buf_string(mbox) + len - 3, "/..")))
317 goto cleanup;
318
319 struct Url url = { 0 };
320 mutt_account_tourl(&adata->conn->account, &url);
321 url.path = mbox->data;
322 url_tobuffer(&url, cachepath, U_PATH);
323
324 const char *const c_header_cache = cs_subset_path(NeoMutt->sub, "header_cache");
325 hc = mutt_hcache_open(c_header_cache, buf_string(cachepath), imap_hcache_namer);
326
327cleanup:
328 buf_pool_release(&mbox);
329 buf_pool_release(&cachepath);
330 mdata->hcache = hc;
331}
332
338{
339 if (!mdata->hcache)
340 return;
341
343 mdata->hcache = NULL;
344}
345
353struct Email *imap_hcache_get(struct ImapMboxData *mdata, unsigned int uid)
354{
355 if (!mdata->hcache)
356 return NULL;
357
358 char key[16] = { 0 };
359
360 sprintf(key, "/%u", uid);
361 struct HCacheEntry hce = mutt_hcache_fetch(mdata->hcache, key, mutt_str_len(key),
362 mdata->uidvalidity);
363 if (!hce.email && hce.uidvalidity)
364 {
365 mutt_debug(LL_DEBUG3, "hcache uidvalidity mismatch: %u\n", hce.uidvalidity);
366 }
367
368 return hce.email;
369}
370
378int imap_hcache_put(struct ImapMboxData *mdata, struct Email *e)
379{
380 if (!mdata->hcache)
381 return -1;
382
383 char key[16] = { 0 };
384
385 sprintf(key, "/%u", imap_edata_get(e)->uid);
386 return mutt_hcache_store(mdata->hcache, key, mutt_str_len(key), e, mdata->uidvalidity);
387}
388
396int imap_hcache_del(struct ImapMboxData *mdata, unsigned int uid)
397{
398 if (!mdata->hcache)
399 return -1;
400
401 char key[16] = { 0 };
402
403 sprintf(key, "/%u", uid);
404 return mutt_hcache_delete_record(mdata->hcache, key, mutt_str_len(key));
405}
406
414{
415 if (!mdata->hcache)
416 return -1;
417
418 /* The seqset is likely large. Preallocate to reduce reallocs */
419 struct Buffer buf = buf_make(8192);
420 imap_msn_index_to_uid_seqset(&buf, mdata);
421
422 int rc = mutt_hcache_store_raw(mdata->hcache, "/UIDSEQSET", 10, buf.data,
423 buf_len(&buf) + 1);
424 mutt_debug(LL_DEBUG3, "Stored /UIDSEQSET %s\n", buf.data);
425 buf_dealloc(&buf);
426 return rc;
427}
428
436{
437 if (!mdata->hcache)
438 return -1;
439
440 return mutt_hcache_delete_record(mdata->hcache, "/UIDSEQSET", 10);
441}
442
450{
451 if (!mdata->hcache)
452 return NULL;
453
454 char *seqset = mutt_hcache_fetch_str(mdata->hcache, "/UIDSEQSET", 10);
455 mutt_debug(LL_DEBUG3, "Retrieved /UIDSEQSET %s\n", NONULL(seqset));
456
457 return seqset;
458}
459#endif
460
473int imap_parse_path(const char *path, struct ConnAccount *cac, char *mailbox, size_t mailboxlen)
474{
475 static unsigned short ImapPort = 0;
476 static unsigned short ImapsPort = 0;
477
478 if (ImapPort == 0)
479 {
480 struct servent *service = getservbyname("imap", "tcp");
481 if (service)
482 ImapPort = ntohs(service->s_port);
483 else
484 ImapPort = IMAP_PORT;
485 mutt_debug(LL_DEBUG3, "Using default IMAP port %d\n", ImapPort);
486 }
487
488 if (ImapsPort == 0)
489 {
490 struct servent *service = getservbyname("imaps", "tcp");
491 if (service)
492 ImapsPort = ntohs(service->s_port);
493 else
494 ImapsPort = IMAP_SSL_PORT;
495 mutt_debug(LL_DEBUG3, "Using default IMAPS port %d\n", ImapsPort);
496 }
497
498 /* Defaults */
499 cac->port = ImapPort;
501 cac->service = "imap";
503
504 struct Url *url = url_parse(path);
505 if (!url)
506 return -1;
507
508 if ((url->scheme != U_IMAP) && (url->scheme != U_IMAPS))
509 {
510 url_free(&url);
511 return -1;
512 }
513
514 if ((mutt_account_fromurl(cac, url) < 0) || (cac->host[0] == '\0'))
515 {
516 url_free(&url);
517 return -1;
518 }
519
520 if (url->scheme == U_IMAPS)
521 cac->flags |= MUTT_ACCT_SSL;
522
523 mutt_str_copy(mailbox, url->path, mailboxlen);
524
525 url_free(&url);
526
527 if ((cac->flags & MUTT_ACCT_SSL) && !(cac->flags & MUTT_ACCT_PORT))
528 cac->port = ImapsPort;
529
530 return 0;
531}
532
544int imap_mxcmp(const char *mx1, const char *mx2)
545{
546 char *b1 = NULL;
547 char *b2 = NULL;
548 int rc;
549
550 if (!mx1 || (*mx1 == '\0'))
551 mx1 = "INBOX";
552 if (!mx2 || (*mx2 == '\0'))
553 mx2 = "INBOX";
554 if (mutt_istr_equal(mx1, "INBOX") && mutt_istr_equal(mx2, "INBOX"))
555 {
556 return 0;
557 }
558
559 b1 = mutt_mem_malloc(strlen(mx1) + 1);
560 b2 = mutt_mem_malloc(strlen(mx2) + 1);
561
562 imap_fix_path('\0', mx1, b1, strlen(mx1) + 1);
563 imap_fix_path('\0', mx2, b2, strlen(mx2) + 1);
564
565 rc = mutt_str_cmp(b1, b2);
566 FREE(&b1);
567 FREE(&b2);
568
569 return rc;
570}
571
580void imap_pretty_mailbox(char *path, size_t pathlen, const char *folder)
581{
582 struct ConnAccount cac_target = { { 0 } };
583 struct ConnAccount cac_home = { { 0 } };
584 struct Url url = { 0 };
585 const char *delim = NULL;
586 int tlen;
587 int hlen = 0;
588 bool home_match = false;
589 char target_mailbox[1024] = { 0 };
590 char home_mailbox[1024] = { 0 };
591
592 if (imap_parse_path(path, &cac_target, target_mailbox, sizeof(target_mailbox)) < 0)
593 return;
594
595 if (imap_path_probe(folder, NULL) != MUTT_IMAP)
596 goto fallback;
597
598 if (imap_parse_path(folder, &cac_home, home_mailbox, sizeof(home_mailbox)) < 0)
599 goto fallback;
600
601 tlen = mutt_str_len(target_mailbox);
602 hlen = mutt_str_len(home_mailbox);
603
604 /* check whether we can do '+' substitution */
605 if (tlen && imap_account_match(&cac_home, &cac_target) &&
606 mutt_strn_equal(home_mailbox, target_mailbox, hlen))
607 {
608 const char *const c_imap_delim_chars = cs_subset_string(NeoMutt->sub, "imap_delim_chars");
609 if (hlen == 0)
610 {
611 home_match = true;
612 }
613 else if (c_imap_delim_chars)
614 {
615 for (delim = c_imap_delim_chars; *delim != '\0'; delim++)
616 if (target_mailbox[hlen] == *delim)
617 home_match = true;
618 }
619 }
620
621 /* do the '+' substitution */
622 if (home_match)
623 {
624 *path++ = '+';
625 /* copy remaining path, skipping delimiter */
626 if (hlen != 0)
627 ++hlen;
628 memcpy(path, target_mailbox + hlen, tlen - hlen);
629 path[tlen - hlen] = '\0';
630 return;
631 }
632
633fallback:
634 mutt_account_tourl(&cac_target, &url);
635 url.path = target_mailbox;
636 url_tostring(&url, path, pathlen, U_NO_FLAGS);
637}
638
645enum QuadOption imap_continue(const char *msg, const char *resp)
646{
647 imap_error(msg, resp);
648 return mutt_yesorno(_("Continue?"), MUTT_NO);
649}
650
656void imap_error(const char *where, const char *msg)
657{
658 mutt_error("%s [%s]", where, msg);
659}
660
678char *imap_fix_path(char delim, const char *mailbox, char *path, size_t plen)
679{
680 int i = 0;
681 const char *const c_imap_delim_chars = cs_subset_string(NeoMutt->sub, "imap_delim_chars");
682 for (; mailbox && *mailbox && (i < plen - 1); i++)
683 {
684 if (*mailbox == delim || (!delim && strchr(NONULL(c_imap_delim_chars), *mailbox)))
685 {
686 delim = *mailbox;
687 /* Skip multiple occurrences of delim */
688 while (*mailbox && *(mailbox + 1) == delim)
689 mailbox++;
690 }
691 path[i] = *mailbox++;
692 }
693
694 /* Do not terminate with a delimiter */
695 if (i && path[i - 1] == delim)
696 i--;
697
698 /* Ensure null termination */
699 path[i] = '\0';
700 return path;
701}
702
709void imap_cachepath(char delim, const char *mailbox, struct Buffer *dest)
710{
711 const char *p = mailbox;
712 buf_reset(dest);
713 if (!p)
714 return;
715
716 while (*p)
717 {
718 if (p[0] == delim)
719 {
720 buf_addch(dest, '/');
721 /* simple way to avoid collisions with UIDs */
722 if ((p[1] >= '0') && (p[1] <= '9'))
723 buf_addch(dest, '_');
724 }
725 else
726 {
727 buf_addch(dest, *p);
728 }
729 p++;
730 }
731}
732
740int imap_get_literal_count(const char *buf, unsigned int *bytes)
741{
742 char *pc = NULL;
743 char *pn = NULL;
744
745 if (!buf || !(pc = strchr(buf, '{')))
746 return -1;
747
748 pc++;
749 pn = pc;
750 while (isdigit((unsigned char) *pc))
751 pc++;
752 *pc = '\0';
753 if (!mutt_str_atoui(pn, bytes))
754 return -1;
755
756 return 0;
757}
758
767char *imap_get_qualifier(char *buf)
768{
769 char *s = buf;
770
771 /* skip tag */
772 s = imap_next_word(s);
773 /* skip OK/NO/BAD response */
774 s = imap_next_word(s);
775
776 return s;
777}
778
784char *imap_next_word(char *s)
785{
786 bool quoted = false;
787
788 while (*s)
789 {
790 if (*s == '\\')
791 {
792 s++;
793 if (*s)
794 s++;
795 continue;
796 }
797 if (*s == '\"')
798 quoted = !quoted;
799 if (!quoted && isspace(*s))
800 break;
801 s++;
802 }
803
804 SKIPWS(s);
805 return s;
806}
807
815void imap_qualify_path(char *buf, size_t buflen, struct ConnAccount *cac, char *path)
816{
817 struct Url url = { 0 };
818 mutt_account_tourl(cac, &url);
819 url.path = path;
820 url_tostring(&url, buf, buflen, U_NO_FLAGS);
821}
822
832void imap_quote_string(char *dest, size_t dlen, const char *src, bool quote_backtick)
833{
834 const char *quote = "`\"\\";
835 if (!quote_backtick)
836 quote++;
837
838 char *pt = dest;
839 const char *s = src;
840
841 *pt++ = '"';
842 /* save room for quote-chars */
843 dlen -= 3;
844
845 for (; *s && dlen; s++)
846 {
847 if (strchr(quote, *s))
848 {
849 if (dlen < 2)
850 break;
851 dlen -= 2;
852 *pt++ = '\\';
853 *pt++ = *s;
854 }
855 else
856 {
857 *pt++ = *s;
858 dlen--;
859 }
860 }
861 *pt++ = '"';
862 *pt = '\0';
863}
864
870{
871 char *d = s;
872
873 if (*s == '\"')
874 s++;
875 else
876 return;
877
878 while (*s)
879 {
880 if (*s == '\"')
881 {
882 *d = '\0';
883 return;
884 }
885 if (*s == '\\')
886 {
887 s++;
888 }
889 if (*s)
890 {
891 *d = *s;
892 d++;
893 s++;
894 }
895 }
896 *d = '\0';
897}
898
906void imap_munge_mbox_name(bool unicode, char *dest, size_t dlen, const char *src)
907{
908 char *buf = mutt_str_dup(src);
909 imap_utf_encode(unicode, &buf);
910
911 imap_quote_string(dest, dlen, buf, false);
912
913 FREE(&buf);
914}
915
923void imap_unmunge_mbox_name(bool unicode, char *s)
924{
926
927 char *buf = mutt_str_dup(s);
928 if (buf)
929 {
930 imap_utf_decode(unicode, &buf);
931 strncpy(s, buf, strlen(s));
932 }
933
934 FREE(&buf);
935}
936
941{
942 time_t now = mutt_date_now();
943 struct Account *np = NULL;
944 const short c_imap_keepalive = cs_subset_number(NeoMutt->sub, "imap_keepalive");
945 TAILQ_FOREACH(np, &NeoMutt->accounts, entries)
946 {
947 if (np->type != MUTT_IMAP)
948 continue;
949
950 struct ImapAccountData *adata = np->adata;
951 if (!adata || !adata->mailbox)
952 continue;
953
954 if ((adata->state >= IMAP_AUTHENTICATED) && (now >= (adata->lastread + c_imap_keepalive)))
955 imap_check_mailbox(adata->mailbox, true);
956 }
957}
958
965{
966 struct sigaction oldalrm;
967 struct sigaction act;
968 sigset_t oldmask;
969 int rc;
970
971 const bool c_imap_passive = cs_subset_bool(NeoMutt->sub, "imap_passive");
972 cs_subset_str_native_set(NeoMutt->sub, "imap_passive", true, NULL);
973 OptKeepQuiet = true;
974
975 sigprocmask(SIG_SETMASK, NULL, &oldmask);
976
977 sigemptyset(&act.sa_mask);
978 act.sa_handler = mutt_sig_empty_handler;
979#ifdef SA_INTERRUPT
980 act.sa_flags = SA_INTERRUPT;
981#else
982 act.sa_flags = 0;
983#endif
984
985 sigaction(SIGALRM, &act, &oldalrm);
986
987 const short c_imap_keepalive = cs_subset_number(NeoMutt->sub, "imap_keepalive");
988 alarm(c_imap_keepalive);
989 while ((waitpid(pid, &rc, 0) < 0) && (errno == EINTR))
990 {
991 alarm(0); /* cancel a possibly pending alarm */
993 alarm(c_imap_keepalive);
994 }
995
996 alarm(0); /* cancel a possibly pending alarm */
997
998 sigaction(SIGALRM, &oldalrm, NULL);
999 sigprocmask(SIG_SETMASK, &oldmask, NULL);
1000
1001 OptKeepQuiet = false;
1002 cs_subset_str_native_set(NeoMutt->sub, "imap_passive", c_imap_passive, NULL);
1003
1004 return rc;
1005}
1006
1012{
1014 struct ImapMboxData *mdata = imap_mdata_get(m);
1015 if (!adata || !adata->mailbox || (adata->mailbox != m) || !mdata)
1016 return;
1017 mdata->reopen |= IMAP_REOPEN_ALLOW;
1018}
1019
1025{
1027 struct ImapMboxData *mdata = imap_mdata_get(m);
1028 if (!adata || !adata->mailbox || (adata->mailbox != m) || !mdata)
1029 return;
1030 mdata->reopen &= ~IMAP_REOPEN_ALLOW;
1031}
1032
1039bool imap_account_match(const struct ConnAccount *a1, const struct ConnAccount *a2)
1040{
1041 if (!a1 || !a2)
1042 return false;
1043 if (a1->type != a2->type)
1044 return false;
1045 if (!mutt_istr_equal(a1->host, a2->host))
1046 return false;
1047 if ((a1->port != 0) && (a2->port != 0) && (a1->port != a2->port))
1048 return false;
1049 if (a1->flags & a2->flags & MUTT_ACCT_USER)
1050 return mutt_str_equal(a1->user, a2->user);
1051
1052 const char *user = NONULL(Username);
1053
1054 const char *const c_imap_user = cs_subset_string(NeoMutt->sub, "imap_user");
1055 if ((a1->type == MUTT_ACCT_TYPE_IMAP) && c_imap_user)
1056 user = c_imap_user;
1057
1058 if (a1->flags & MUTT_ACCT_USER)
1059 return mutt_str_equal(a1->user, user);
1060 if (a2->flags & MUTT_ACCT_USER)
1061 return mutt_str_equal(a2->user, user);
1062
1063 return true;
1064}
1065
1071struct SeqsetIterator *mutt_seqset_iterator_new(const char *seqset)
1072{
1073 if (!seqset || (*seqset == '\0'))
1074 return NULL;
1075
1076 struct SeqsetIterator *iter = mutt_mem_calloc(1, sizeof(struct SeqsetIterator));
1077 iter->full_seqset = mutt_str_dup(seqset);
1078 iter->eostr = strchr(iter->full_seqset, '\0');
1079 iter->substr_cur = iter->substr_end = iter->full_seqset;
1080
1081 return iter;
1082}
1083
1092int mutt_seqset_iterator_next(struct SeqsetIterator *iter, unsigned int *next)
1093{
1094 if (!iter || !next)
1095 return -1;
1096
1097 if (iter->in_range)
1098 {
1099 if ((iter->down && (iter->range_cur == (iter->range_end - 1))) ||
1100 (!iter->down && (iter->range_cur == (iter->range_end + 1))))
1101 {
1102 iter->in_range = 0;
1103 }
1104 }
1105
1106 if (!iter->in_range)
1107 {
1108 iter->substr_cur = iter->substr_end;
1109 if (iter->substr_cur == iter->eostr)
1110 return 1;
1111
1112 iter->substr_end = strchr(iter->substr_cur, ',');
1113 if (!iter->substr_end)
1114 iter->substr_end = iter->eostr;
1115 else
1116 *(iter->substr_end++) = '\0';
1117
1118 char *range_sep = strchr(iter->substr_cur, ':');
1119 if (range_sep)
1120 *range_sep++ = '\0';
1121
1122 if (!mutt_str_atoui_full(iter->substr_cur, &iter->range_cur))
1123 return -1;
1124 if (range_sep)
1125 {
1126 if (!mutt_str_atoui_full(range_sep, &iter->range_end))
1127 return -1;
1128 }
1129 else
1130 {
1131 iter->range_end = iter->range_cur;
1132 }
1133
1134 iter->down = (iter->range_end < iter->range_cur);
1135 iter->in_range = 1;
1136 }
1137
1138 *next = iter->range_cur;
1139 if (iter->down)
1140 iter->range_cur--;
1141 else
1142 iter->range_cur++;
1143
1144 return 0;
1145}
1146
1152{
1153 if (!ptr || !*ptr)
1154 return;
1155
1156 struct SeqsetIterator *iter = *ptr;
1157 FREE(&iter->full_seqset);
1158 FREE(ptr);
1159}
const char * mutt_str_atoui(const char *str, unsigned int *dst)
Convert ASCII string to an unsigned integer.
Definition: atoi.c:203
Body Caching (local copies of email bodies)
void mutt_bcache_close(struct BodyCache **bcache)
Close an Email-Body Cache.
Definition: bcache.c:164
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:171
int buf_add_printf(struct Buffer *buf, const char *fmt,...)
Format a string appending a Buffer.
Definition: buffer.c:214
size_t buf_len(const struct Buffer *buf)
Calculate the length of a Buffer.
Definition: buffer.c:414
void buf_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition: buffer.c:352
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:86
struct Buffer buf_make(size_t size)
Make a new buffer on the stack.
Definition: buffer.c:68
size_t buf_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition: buffer.c:251
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:78
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:317
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition: helpers.c:169
const char * cs_subset_path(const struct ConfigSubset *sub, const char *name)
Get a path config item by name.
Definition: helpers.c:194
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:73
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.
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:73
char * Username
User's login name.
Definition: globals.c:42
static void imap_hcache_namer(const char *path, struct Buffer *dest)
Generate a filename for the header cache - Implements hcache_namer_t -.
Definition: util.c:286
#define mutt_error(...)
Definition: logging2.h:87
#define mutt_debug(LEVEL,...)
Definition: logging2.h:84
enum MailboxType imap_path_probe(const char *path, const struct stat *st)
Is this an IMAP Mailbox? - Implements MxOps::path_probe() -.
Definition: imap.c:2254
void mutt_hash_free(struct HashTable **ptr)
Free a hash table.
Definition: hash.c:457
Header cache multiplexor.
int mutt_hcache_store(struct HeaderCache *hc, const char *key, size_t keylen, struct Email *e, uint32_t uidvalidity)
Multiplexor for StoreOps::store.
Definition: hcache.c:616
void mutt_hcache_close(struct HeaderCache *hc)
Multiplexor for StoreOps::close.
Definition: hcache.c:489
struct HeaderCache * mutt_hcache_open(const char *path, const char *folder, hcache_namer_t namer)
Multiplexor for StoreOps::open.
Definition: hcache.c:379
int mutt_hcache_delete_record(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition: hcache.c:695
int mutt_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:674
struct HCacheEntry mutt_hcache_fetch(struct HeaderCache *hc, const char *key, size_t keylen, uint32_t uidvalidity)
Multiplexor for StoreOps::fetch.
Definition: hcache.c:513
char * mutt_hcache_fetch_str(struct HeaderCache *hc, const char *key, size_t keylen)
Fetch a string from the cache.
Definition: hcache.c:600
struct ImapAccountData * imap_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition: adata.c:90
struct ImapEmailData * imap_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:65
struct ImapMboxData * imap_mdata_new(struct ImapAccountData *adata, const char *name)
Allocate and initialise a new ImapMboxData structure.
Definition: mdata.c:73
struct ImapMboxData * imap_mdata_get(struct Mailbox *m)
Get the Mailbox data for this mailbox.
Definition: mdata.c:60
void imap_mdata_free(void **ptr)
Free the private Mailbox data - Implements Mailbox::mdata_free()
Definition: mdata.c:40
#define IMAP_PORT
Default port for IMAP.
Definition: private.h:44
@ IMAP_AUTHENTICATED
Connection is authenticated.
Definition: private.h:107
#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:395
#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:428
enum MxStatus imap_check_mailbox(struct Mailbox *m, bool force)
Use the NOOP or IDLE command to poll for new mail.
Definition: imap.c:938
@ LL_DEBUG3
Log at debug level 3.
Definition: logging2.h:42
@ MUTT_IMAP
'IMAP' Mailbox type
Definition: mailbox.h:50
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
void * mutt_mem_malloc(size_t size)
Allocate memory on the heap.
Definition: memory.c:90
#define FREE(x)
Definition: memory.h:43
void imap_msn_free(struct MSN *msn)
Free the cache.
Definition: msn.c:59
size_t imap_msn_highest(const struct MSN *msn)
Return the highest MSN in use.
Definition: msn.c:69
struct Email * imap_msn_get(const struct MSN *msn, size_t idx)
Return the Email associated with an msn.
Definition: msn.c:80
IMAP MSN helper functions.
time_t mutt_date_now(void)
Return the number of seconds since the Unix epoch.
Definition: date.c:446
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:471
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:810
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:251
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:798
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:497
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:568
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:653
int mutt_account_fromurl(struct ConnAccount *cac, const struct Url *url)
Fill ConnAccount with information from url.
Definition: mutt_account.c:43
void mutt_account_tourl(struct ConnAccount *cac, struct Url *url)
Fill URL with info from account.
Definition: mutt_account.c:79
ConnAccount object used by POP and IMAP.
@ MUTT_ACCT_TYPE_IMAP
Imap Account.
Definition: mutt_account.h:37
Notmuch-specific Mailbox data.
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:106
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:119
Pop-specific Account data.
Pop-specific Email data.
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 mutt_yesorno(const char *msg, enum QuadOption def)
Ask the user a Yes/No question.
Definition: question.c:194
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:725
GUI display the mailboxes in a side panel.
void mutt_sig_empty_handler(int sig)
Dummy signal handler.
Definition: signal.c:71
Key value store.
#define NONULL(x)
Definition: string2.h:37
#define SKIPWS(ch)
Definition: string2.h:45
A group of associated Mailboxes.
Definition: account.h:37
enum MailboxType type
Type of Mailboxes this Account contains.
Definition: account.h:38
void * adata
Private data (for Mailbox backends)
Definition: account.h:43
String manipulation buffer.
Definition: buffer.h:34
char * data
Pointer to data.
Definition: buffer.h:35
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)
Function to get some login credentials.
Definition: connaccount.h:68
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:50
The envelope/body of an email.
Definition: email.h:37
char * path
Path of Email (for local Mailboxes)
Definition: email.h:68
Wrapper for Email retrieved from the header cache.
Definition: lib.h:99
uint32_t uidvalidity
IMAP-specific UIDVALIDITY.
Definition: lib.h:100
struct Email * email
Retrieved email.
Definition: lib.h:102
Header cache structure.
Definition: lib.h:88
IMAP-specific Account data -.
Definition: adata.h:40
char delim
Path delimiter.
Definition: adata.h:75
struct Mailbox * mailbox
Current selected mailbox.
Definition: adata.h:76
struct Connection * conn
Connection to IMAP server.
Definition: adata.h:41
unsigned int uid
32-bit Message UID
Definition: edata.h:44
IMAP-specific Mailbox data -.
Definition: mdata.h:39
struct HeaderCache * hcache
Email header cache.
Definition: mdata.h:62
struct BodyCache * bcache
Email body cache.
Definition: mdata.h:60
struct HashTable * uid_hash
Hash Table: "uid" -> Email.
Definition: mdata.h:58
uint32_t uidvalidity
Definition: mdata.h:50
char * name
Mailbox name.
Definition: mdata.h:40
A mailbox.
Definition: mailbox.h:79
void * mdata
Driver specific data.
Definition: mailbox.h:132
Container for Accounts, Notifications.
Definition: neomutt.h:37
struct AccountList accounts
List of all Accounts.
Definition: neomutt.h:40
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
UID Sequence Set Iterator.
Definition: private.h:169
char * eostr
Definition: private.h:171
char * substr_end
Definition: private.h:177
unsigned int range_end
Definition: private.h:175
char * substr_cur
Definition: private.h:176
char * full_seqset
Definition: private.h:170
unsigned int range_cur
Definition: private.h:174
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:310
struct Url * url_parse(const char *src)
Fill in Url.
Definition: url.c:238
int url_tostring(struct Url *url, char *dest, size_t len, uint8_t flags)
Output the URL string for a given Url object.
Definition: url.c:422
int url_tobuffer(struct Url *url, struct Buffer *buf, uint8_t flags)
Output the URL string for a given Url object.
Definition: url.c:357
void url_free(struct Url **ptr)
Free the contents of a URL.
Definition: url.c:123
#define U_NO_FLAGS
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
Definition: url.h:50
void imap_unmunge_mbox_name(bool unicode, char *s)
Remove quoting from a mailbox name.
Definition: util.c:923
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:473
static const char * imap_get_field(enum ConnAccountField field, void *gf_data)
Get connection login credentials - Implements ConnAccount::get_field()
Definition: util.c:203
void imap_qualify_path(char *buf, size_t buflen, struct ConnAccount *cac, char *path)
Make an absolute IMAP folder target.
Definition: util.c:815
void imap_allow_reopen(struct Mailbox *m)
Allow re-opening a folder upon expunge.
Definition: util.c:1011
void imap_disallow_reopen(struct Mailbox *m)
Disallow re-opening a folder upon expunge.
Definition: util.c:1024
int imap_get_literal_count(const char *buf, unsigned int *bytes)
Write number of bytes in an IMAP literal into bytes.
Definition: util.c:740
int imap_hcache_store_uid_seqset(struct ImapMboxData *mdata)
Store a UID Sequence Set in the header cache.
Definition: util.c:413
int imap_hcache_put(struct ImapMboxData *mdata, struct Email *e)
Add an entry to the header cache.
Definition: util.c:378
void imap_mdata_cache_reset(struct ImapMboxData *mdata)
Release and clear cache data of ImapMboxData structure.
Definition: util.c:105
void imap_get_parent(const char *mbox, char delim, char *buf, size_t buflen)
Get an IMAP folder's parent.
Definition: util.c:119
struct SeqsetIterator * mutt_seqset_iterator_new(const char *seqset)
Create a new Sequence Set Iterator.
Definition: util.c:1071
void imap_quote_string(char *dest, size_t dlen, const char *src, bool quote_backtick)
Quote string according to IMAP rules.
Definition: util.c:832
int imap_wait_keepalive(pid_t pid)
Wait for a process to change state.
Definition: util.c:964
char * imap_hcache_get_uid_seqset(struct ImapMboxData *mdata)
Get a UID Sequence Set from the header cache.
Definition: util.c:449
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:645
void imap_unquote_string(char *s)
Equally stupid unquoting routine.
Definition: util.c:869
struct Email * imap_hcache_get(struct ImapMboxData *mdata, unsigned int uid)
Get a header cache entry by its UID.
Definition: util.c:353
void imap_get_parent_path(const char *path, char *buf, size_t buflen)
Get the path of the parent folder.
Definition: util.c:160
int mutt_seqset_iterator_next(struct SeqsetIterator *iter, unsigned int *next)
Get the next UID from a Sequence Set.
Definition: util.c:1092
void imap_clean_path(char *path, size_t plen)
Cleans an IMAP path using imap_fix_path.
Definition: util.c:187
void mutt_seqset_iterator_free(struct SeqsetIterator **ptr)
Free a Sequence Set Iterator.
Definition: util.c:1151
char * imap_fix_path(char delim, const char *mailbox, char *path, size_t plen)
Fix up the imap path.
Definition: util.c:678
int imap_mxcmp(const char *mx1, const char *mx2)
Compare mailbox names, giving priority to INBOX.
Definition: util.c:544
void imap_pretty_mailbox(char *path, size_t pathlen, const char *folder)
Prettify an IMAP mailbox name.
Definition: util.c:580
void imap_cachepath(char delim, const char *mailbox, struct Buffer *dest)
Generate a cache path for a mailbox.
Definition: util.c:709
void imap_keepalive(void)
Poll the current folder to keep the connection alive.
Definition: util.c:940
void imap_error(const char *where, const char *msg)
Show an error and abort.
Definition: util.c:656
void imap_hcache_close(struct ImapMboxData *mdata)
Close the header cache.
Definition: util.c:337
int imap_hcache_del(struct ImapMboxData *mdata, unsigned int uid)
Delete an item from the header cache.
Definition: util.c:396
int imap_hcache_clear_uid_seqset(struct ImapMboxData *mdata)
Delete a UID Sequence Set from the header cache.
Definition: util.c:435
int imap_adata_find(const char *path, struct ImapAccountData **adata, struct ImapMboxData **mdata)
Find the Account data for this path.
Definition: util.c:71
bool imap_account_match(const struct ConnAccount *a1, const struct ConnAccount *a2)
Compare two Accounts.
Definition: util.c:1039
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:906
void imap_hcache_open(struct ImapAccountData *adata, struct ImapMboxData *mdata)
Open a header cache.
Definition: util.c:296
static void imap_msn_index_to_uid_seqset(struct Buffer *buf, struct ImapMboxData *mdata)
Convert MSN index of UIDs to Seqset.
Definition: util.c:230
char * imap_next_word(char *s)
Find where the next IMAP word begins.
Definition: util.c:784
char * imap_get_qualifier(char *buf)
Get the qualifier from a tagged response.
Definition: util.c:767