2 * Utility functions for the IMAP module.
4 * Copyright (c) 2001-2017 by the citadel.org team and others, except for
5 * most of the UTF7 and UTF8 handling code which was lifted from Evolution.
7 * This program is open source software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #define SHOW_ME_VAPPEND_PRINTF
29 #include <libcitadel.h>
30 #include "../../citadel_defs.h"
31 #include "../../sysdep_decls.h"
32 #include "../../internet_addressing.h"
33 #include "serv_imap.h"
34 #include "imap_tools.h"
35 #include "../../ctdl_module.h"
37 /* String handling helpers */
39 /* This code uses some pretty nasty string manipulation. To make everything
40 * manageable, we use this semi-high-level string manipulation API. Strings are
41 * always \0-terminated, despite the fact that we keep track of the size.
49 static void string_init(struct string* s, char* buf, int bufsize)
52 s->maxsize = bufsize-1;
53 s->size = strlen(buf);
56 static char* string_end(struct string* s)
58 return s->buffer + s->size;
61 /* Append a UTF8 string of a particular length (in bytes). -1 to autocalculate. */
63 static void string_append_sn(struct string* s, char* p, int len)
67 if ((s->size+len) > s->maxsize)
68 len = s->maxsize - s->size;
69 memcpy(s->buffer + s->size, p, len);
71 s->buffer[s->size] = '\0';
74 /* As above, always autocalculate. */
76 #define string_append_s(s, p) string_append_sn((s), (p), -1)
78 /* Appends a UTF8 character --- which may make the size change by more than 1!
79 * If the string overflows, the last character may become invalid. */
81 static void string_append_c(struct string* s, int c)
86 /* Don't do anything if there's no room. */
88 if (s->size == s->maxsize)
93 /* This is the most common case, so we optimise it. */
95 s->buffer[s->size++] = c;
96 s->buffer[s->size] = 0;
101 UmlChar[0] = 0xC0 | (c >> 6);
102 UmlChar[1] = 0x80 | (c & 0x3F);
105 else if (c <= 0xFFFF)
107 UmlChar[0] = 0xE0 | (c >> 12);
108 UmlChar[1] = 0x80 | ((c >> 6) & 0x3f);
109 UmlChar[2] = 0x80 | (c & 0x3f);
114 UmlChar[0] = 0xf0 | c >> 18;
115 UmlChar[1] = 0x80 | ((c >> 12) & 0x3f);
116 UmlChar[2] = 0x80 | ((c >> 6) & 0x3f);
117 UmlChar[3] = 0x80 | (c & 0x3f);
121 string_append_sn(s, UmlChar, len);
124 /* Reads a UTF8 character from a char*, advancing the pointer. */
126 int utf8_getc(char** ptr)
128 unsigned char* p = (unsigned char*) *ptr;
144 /* valid start char? (max 4 octets) */
146 m = 0x7f80; /* used to mask out the length bits */
149 if ((c & 0xc0) != 0x80)
154 v = (v<<6) | (c & 0x3f);
169 /* IMAP name safety */
171 /* IMAP has certain special requirements in its character set, which means we
172 * have to do a fair bit of work to convert Citadel's UTF8 strings to IMAP
173 * strings. The next two routines (and their data tables) do that.
176 static char *utf7_alphabet =
177 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+,";
179 static unsigned char utf7_rank[256] = {
180 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
181 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
182 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0x3E,0x3F,0xFF,0xFF,0xFF,
183 0x34,0x35,0x36,0x37,0x38,0x39,0x3A,0x3B,0x3C,0x3D,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
184 0xFF,0x00,0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0A,0x0B,0x0C,0x0D,0x0E,
185 0x0F,0x10,0x11,0x12,0x13,0x14,0x15,0x16,0x17,0x18,0x19,0xFF,0xFF,0xFF,0xFF,0xFF,
186 0xFF,0x1A,0x1B,0x1C,0x1D,0x1E,0x1F,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,
187 0x29,0x2A,0x2B,0x2C,0x2D,0x2E,0x2F,0x30,0x31,0x32,0x33,0xFF,0xFF,0xFF,0xFF,0xFF,
188 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
189 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
190 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
191 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
192 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
193 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
194 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
195 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
198 /* Base64 helpers. */
200 static void utf7_closeb64(struct string* out, int v, int i)
206 x = (v << (6-i)) & 0x3F;
207 string_append_c(out, utf7_alphabet[x]);
209 string_append_c(out, '-');
212 /* Convert from a Citadel name to an IMAP-safe name. Returns the end
213 * of the destination.
215 static char* toimap(char* destp, char* destend, char* src)
223 string_init(&dest, destp, destend-destp);
224 /* syslog(LOG_DEBUG, "toimap %s", src); */
228 int c = utf8_getc(&src);
232 if (c >= 0x20 && c <= 0x7e)
236 utf7_closeb64(&dest, v, i);
244 string_append_sn(&dest, "&-", 2);
248 /* Citadel extension: / becomes |, because /
249 * isn't valid as part of an IMAP name. */
255 /* Citadel extension: backslashes mark folder
256 * seperators in the IMAP subfolder emulation
257 * hack. We turn them into / characters,
258 * *except* if it's the last character in the
267 string_append_c(&dest, c);
274 string_append_c(&dest, '&');
281 int x = (v >> (i-6)) & 0x3f;
282 string_append_c(&dest, utf7_alphabet[x]);
289 utf7_closeb64(&dest, v, i);
290 /* syslog(LOG_DEBUG, " -> %s", destp); */
291 return string_end(&dest);
294 /* Convert from an IMAP-safe name back into a Citadel name. Returns the end of the destination. */
296 static int cfrommap(int c);
297 static char* fromimap(char* destp, char* destend, const char* src)
300 unsigned const char *p = (unsigned const char*) src;
307 string_init(&dest, destp, destend-destp);
308 /* syslog(LOG_DEBUG, "fromimap %s", src); */
315 /* US-ASCII characters. */
320 string_append_c(&dest, cfrommap(c));
326 string_append_c(&dest, '&');
329 else if (utf7_rank[c] != 0xff)
338 string_append_sn(&dest, "&-", 2);
346 else if (utf7_rank[c] != 0xFF)
348 v = (v<<6) | utf7_rank[c];
352 int x = (v >> (i-16)) & 0xFFFF;
353 string_append_c(&dest, cfrommap(x));
359 string_append_c(&dest, cfrommap(c));
366 /* syslog(LOG_DEBUG, " -> %s", destp); */
367 return string_end(&dest);
370 /* Undoes the special character conversion. */
371 static int cfrommap(int c)
375 case '|': return '/';
376 case '/': return '\\';
382 /* Break a command down into tokens, unquoting any escaped characters. */
383 void MakeStringOf(StrBuf *Buf, int skip)
386 citimap_command *Cmd = &IMAP->Cmd;
388 for (i=skip; i<Cmd->num_parms; ++i) {
389 StrBufAppendBufPlain(Buf, Cmd->Params[i].Key, Cmd->Params[i].len, 0);
390 if (i < (Cmd->num_parms-1)) StrBufAppendBufPlain(Buf, HKEY(" "), 0);
395 void TokenCutRight(citimap_command *Cmd,
401 if (CutMe->len < n) {
406 CutAt = CutMe->Key + CutMe->len - n;
409 StrBufPeek(Cmd->CmdBuf, CutAt, -1, '\0');
412 void TokenCutLeft(citimap_command *Cmd,
416 if (CutMe->len < n) {
417 CutMe->Key += CutMe->len;
428 int CmdAdjust(citimap_command *Cmd,
433 if (nArgs > Cmd->avail_parms) {
434 Params = (ConstStr*) malloc(sizeof(ConstStr) * nArgs);
438 sizeof(ConstStr) * Cmd->avail_parms);
441 sizeof(ConstStr) * Cmd->avail_parms,
443 sizeof(ConstStr) * nArgs -
444 sizeof(ConstStr) * Cmd->avail_parms
450 sizeof(ConstStr) * nArgs);
452 Cmd->avail_parms = nArgs;
453 if (Cmd->Params != NULL)
455 Cmd->Params = Params;
461 sizeof(ConstStr) * Cmd->avail_parms);
465 return Cmd->avail_parms;
468 int imap_parameterize(citimap_command *Cmd)
471 const char *In, *End;
473 In = ChrPtr(Cmd->CmdBuf);
474 End = In + StrLength(Cmd->CmdBuf);
476 /* we start with 10 chars per arg, maybe we need to realloc later. */
477 nArgs = StrLength(Cmd->CmdBuf) / 10 + 10;
478 nArgs = CmdAdjust(Cmd, nArgs, 0);
481 /* Skip whitespace. */
487 /* Found the start of a token. */
489 Cmd->Params[Cmd->num_parms].Key = In;
491 /* Read in the token. */
500 /* Found a quoted section. */
502 Cmd->Params[Cmd->num_parms].Key++;
508 StrBufPeek(Cmd->CmdBuf, In, -1, '\0');
511 else if (*In == '\\')
515 Cmd->Params[Cmd->num_parms].len =
516 In - Cmd->Params[Cmd->num_parms].Key;
518 return Cmd->num_parms;
523 else if (*In == '\\')
529 Cmd->Params[Cmd->num_parms].len =
530 In - Cmd->Params[Cmd->num_parms].Key;
532 return Cmd->num_parms;
536 StrBufPeek(Cmd->CmdBuf, In, -1, '\0');
537 Cmd->Params[Cmd->num_parms].len =
538 In - Cmd->Params[Cmd->num_parms].Key;
539 if (Cmd->num_parms + 1 >= Cmd->avail_parms) {
540 nArgs = CmdAdjust(Cmd, nArgs * 2, 1);
545 return Cmd->num_parms;
549 /* Convert a struct ctdlroom to an IMAP-compatible mailbox name. */
550 long imap_mailboxname(char *buf, int bufsize, struct ctdlroom *qrbuf)
552 char* bufend = buf+bufsize;
557 /* For mailboxes, just do it straight.
558 * Do the Cyrus-compatible thing: all private folders are
559 * subfolders of INBOX. */
561 if (qrbuf->QRflags & QR_MAILBOX)
563 if (strcasecmp(qrbuf->QRname+11, MAILROOM) == 0)
565 pend = toimap(p, bufend, "INBOX");
570 p = toimap(p, bufend, "INBOX");
573 pend = toimap(p, bufend, qrbuf->QRname+11);
579 /* Otherwise, prefix the floor name as a "public folders" moniker. */
581 fl = CtdlGetCachedFloor(qrbuf->QRfloor);
582 p = toimap(p, bufend, fl->f_name);
585 pend = toimap(p, bufend, qrbuf->QRname);
591 * Convert an inputted folder name to our best guess as to what an equivalent
592 * room name should be.
594 * If an error occurs, it returns -1. Otherwise...
596 * The lower eight bits of the return value are the floor number on which the
597 * room most likely resides. The upper eight bits may contain flags,
598 * including IR_MAILBOX if we're dealing with a personal room.
601 int imap_roomname(char *rbuf, int bufsize, const char *foldername)
604 char floorname[ROOMNAMELEN*2];
605 char roomname[ROOMNAMELEN];
610 if (foldername == NULL)
613 /* Unmunge the entire string into the output buffer. */
615 fromimap(rbuf, rbuf+bufsize, foldername);
617 /* Is this an IMAP inbox? */
619 if (strncasecmp(rbuf, "INBOX", 5) == 0)
623 /* It's the system inbox. */
625 safestrncpy(rbuf, MAILROOM, bufsize);
626 ret = (0 | IR_MAILBOX);
629 else if (rbuf[5] == FDELIM)
631 /* It's another personal mail folder. */
633 safestrncpy(rbuf, rbuf+6, bufsize);
634 ret = (0 | IR_MAILBOX);
638 /* If we get here, the folder just happens to start with INBOX
639 * --- fall through. */
642 /* Is this a multi-level room name? */
644 levels = num_tokens(rbuf, FDELIM);
648 /* Extract the main room name. */
650 len = extract_token(floorname, rbuf, 0, FDELIM, sizeof floorname);
651 if (len < 0) len = 0;
652 safestrncpy(roomname, &rbuf[len + 1], sizeof(roomname));
654 /* Try and find it on any floor. */
656 for (i = 0; i < MAXFLOORS; ++i)
658 fl = CtdlGetCachedFloor(i);
659 if (fl->f_flags & F_INUSE)
661 if (strcasecmp(floorname, fl->f_name) == 0)
665 safestrncpy(rbuf, roomname, bufsize);
673 /* Meh. It's either not a multi-level room name, or else we
676 ret = (0 | IR_MAILBOX);
679 syslog(LOG_DEBUG, "(That translates to \"%s\")", rbuf);
685 * Determine whether the supplied string is a valid message set.
686 * If the string contains only numbers, colons, commas, and asterisks,
687 * return 1 for a valid message set. If any other character is found,
690 int imap_is_message_set(const char *buf)
695 return (0); /* stupidity checks */
699 if (!strcasecmp(buf, "ALL"))
700 return (1); /* macro? why? */
702 for (i = 0; buf[i]; ++i) { /* now start the scan */
712 return (1); /* looks like we're good */
717 * imap_match.c, based on wildmat.c from INN
718 * hacked for Citadel/IMAP by Daniel Malament
721 /* note: not all return statements use these; don't change them */
722 #define WILDMAT_TRUE 1
723 #define WILDMAT_FALSE 0
724 #define WILDMAT_ABORT -1
725 #define WILDMAT_DELIM '/'
728 * Match text and p, return TRUE, FALSE, or ABORT.
730 static int do_imap_match(const char *supplied_text, const char *supplied_p)
733 char lcase_text[SIZ], lcase_p[SIZ];
737 /* Copy both strings and lowercase them, in order to
738 * make this entire operation case-insensitive.
741 ((supplied_text[i] != '\0') &&
742 (i < sizeof(lcase_text)));
744 lcase_text[i] = tolower(supplied_text[i]);
745 lcase_text[i] = '\0';
748 ((supplied_p[i] != '\0') &&
749 (i < sizeof(lcase_p)));
751 lcase_p[i] = tolower(supplied_p[i]);
755 for (p = lcase_p, text = lcase_text;
756 !IsEmptyStr(p) && !IsEmptyStr(text);
758 if ((*text == '\0') && (*p != '*') && (*p != '%')) {
759 return WILDMAT_ABORT;
764 return WILDMAT_FALSE;
769 while (++p, ((*p == '*') || (*p == '%'))) {
770 /* Consecutive stars or %'s act
771 * just like one star.
776 /* Trailing star matches everything. */
780 if ((matched = do_imap_match(text++, p))
785 return WILDMAT_ABORT;
787 while (++p, (!IsEmptyStr(p) && ((*p == '*') || (*p == '%'))))
789 /* Consecutive %'s act just like one, but even
790 * a single star makes the sequence act like
800 * Trailing % matches everything
801 * without a delimiter.
803 while (!IsEmptyStr(text)) {
804 if (*text == WILDMAT_DELIM) {
805 return WILDMAT_FALSE;
811 while (!IsEmptyStr(text) &&
812 /* make sure text - 1 isn't before lcase_p */
813 ((text == lcase_text) || (*(text - 1) != WILDMAT_DELIM)))
815 if ((matched = do_imap_match(text++, p))
820 return WILDMAT_ABORT;
824 if ((*text == '\0') && (*p == '\0')) return WILDMAT_TRUE;
825 else return WILDMAT_FALSE;
830 * Support function for mailbox pattern name matching in LIST and LSUB
831 * Returns nonzero if the supplied mailbox name matches the supplied pattern.
833 int imap_mailbox_matches_pattern(const char *pattern, char *mailboxname)
835 /* handle just-star case quickly */
836 if ((pattern[0] == '*') && (pattern[1] == '\0')) {
839 return (do_imap_match(mailboxname, pattern) == WILDMAT_TRUE);
845 * Compare an IMAP date string (date only, no time) to the date found in
848 int imap_datecmp(const char *datestr, time_t msgtime) {
853 int day, month, year;
854 int msgday, msgmonth, msgyear;
857 char *imap_datecmp_ascmonths[12] = {
858 "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
861 if (datestr == NULL) return(0);
863 /* Expecting a date in the form dd-Mmm-yyyy */
864 extract_token(daystr, datestr, 0, '-', sizeof daystr);
865 extract_token(monthstr, datestr, 1, '-', sizeof monthstr);
866 extract_token(yearstr, datestr, 2, '-', sizeof yearstr);
869 year = atoi(yearstr);
871 for (i=0; i<12; ++i) {
872 if (!strcasecmp(monthstr, imap_datecmp_ascmonths[i])) {
877 /* Extract day/month/year from message timestamp */
878 localtime_r(&msgtime, &msgtm);
879 msgday = msgtm.tm_mday;
880 msgmonth = msgtm.tm_mon;
881 msgyear = msgtm.tm_year + 1900;
883 /* Now start comparing */
885 if (year < msgyear) return(+1);
886 if (year > msgyear) return(-1);
888 if (month < msgmonth) return(+1);
889 if (month > msgmonth) return(-1);
891 if (day < msgday) return(+1);
892 if (day > msgday) return(-1);
898 void IAPrintf(const char *Format, ...)
902 va_start(arg_ptr, Format);
903 StrBufVAppendPrintf(IMAP->Reply, Format, arg_ptr);
908 void iaputs(const char *Str, long Len)
910 StrBufAppendBufPlain(IMAP->Reply, Str, Len, 0);
914 void ireply(const char *Msg, long len)
916 citimap *Imap = IMAP;
918 StrBufAppendBufPlain(Imap->Reply,
919 CKEY(Imap->Cmd.Params[0]), 0);
920 StrBufAppendBufPlain(Imap->Reply,
922 StrBufAppendBufPlain(Imap->Reply,
925 StrBufAppendBufPlain(Imap->Reply,
931 void IReplyPrintf(const char *Format, ...)
933 citimap *Imap = IMAP;
937 StrBufAppendBufPlain(Imap->Reply,
938 CKEY(Imap->Cmd.Params[0]), 0);
940 StrBufAppendBufPlain(Imap->Reply,
943 va_start(arg_ptr, Format);
944 StrBufVAppendPrintf(IMAP->Reply, Format, arg_ptr);
947 StrBufAppendBufPlain(Imap->Reply,
953 /* Output a string to the IMAP client, either as a literal or quoted.
954 * (We do a literal if it has any double-quotes or backslashes.) */
955 void IPutStr(const char *Msg, long Len)
959 citimap *Imap = IMAP;
962 if ((Msg == NULL) || (Len == 0))
963 { /* yeah, we handle this */
964 StrBufAppendBufPlain(Imap->Reply, HKEY("NIL"), 0);
968 for (i = 0; i < Len; ++i) {
969 if ((Msg[i] == '\"') || (Msg[i] == '\\'))
974 StrBufAppendPrintf(Imap->Reply, "{%ld}\r\n", Len);
975 StrBufAppendBufPlain(Imap->Reply, Msg, Len, 0);
977 StrBufAppendBufPlain(Imap->Reply,
979 StrBufAppendBufPlain(Imap->Reply,
981 StrBufAppendBufPlain(Imap->Reply,
986 void IUnbuffer (void)
988 citimap *Imap = IMAP;
990 cputbuf(Imap->Reply);
991 FlushStrBuf(Imap->Reply);