4 * Utility functions for the IMAP module.
6 * Copyright (c) 2001-2009 by the citadel.org team and others, except for
7 * most of the UTF7 and UTF8 handling code which was lifted from Evolution.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 #include <libcitadel.h>
31 #include "sysdep_decls.h"
32 #include "internet_addressing.h"
33 #include "imap_tools.h"
34 #include "serv_imap.h"
35 #include "ctdl_module.h"
41 /* String handling helpers */
43 /* This code uses some pretty nasty string manipulation. To make everything
44 * manageable, we use this semi-high-level string manipulation API. Strings are
45 * always \0-terminated, despite the fact that we keep track of the size.
53 static void string_init(struct string* s, char* buf, int bufsize)
56 s->maxsize = bufsize-1;
57 s->size = strlen(buf);
60 static char* string_end(struct string* s)
62 return s->buffer + s->size;
65 /* Append a UTF8 string of a particular length (in bytes). -1 to autocalculate. */
67 static void string_append_sn(struct string* s, char* p, int len)
71 if ((s->size+len) > s->maxsize)
72 len = s->maxsize - s->size;
73 memcpy(s->buffer + s->size, p, len);
75 s->buffer[s->size] = '\0';
78 /* As above, always autocalculate. */
80 #define string_append_s(s, p) string_append_sn((s), (p), -1)
82 /* Appends a UTF8 character --- which may make the size change by more than 1!
83 * If the string overflows, the last character may become invalid. */
85 static void string_append_c(struct string* s, int c)
90 /* Don't do anything if there's no room. */
92 if (s->size == s->maxsize)
97 /* This is the most common case, so we optimise it. */
99 s->buffer[s->size++] = c;
100 s->buffer[s->size] = 0;
105 UmlChar[0] = 0xC0 | (c >> 6);
106 UmlChar[1] = 0x80 | (c & 0x3F);
109 else if (c <= 0xFFFF)
111 UmlChar[0] = 0xE0 | (c >> 12);
112 UmlChar[1] = 0x80 | ((c >> 6) & 0x3f);
113 UmlChar[2] = 0x80 | (c & 0x3f);
118 UmlChar[0] = 0xf0 | c >> 18;
119 UmlChar[1] = 0x80 | ((c >> 12) & 0x3f);
120 UmlChar[2] = 0x80 | ((c >> 6) & 0x3f);
121 UmlChar[3] = 0x80 | (c & 0x3f);
125 string_append_sn(s, UmlChar, len);
128 /* Reads a UTF8 character from a char*, advancing the pointer. */
130 int utf8_getc(char** ptr)
132 unsigned char* p = (unsigned char*) *ptr;
148 /* valid start char? (max 4 octets) */
150 m = 0x7f80; /* used to mask out the length bits */
153 if ((c & 0xc0) != 0x80)
158 v = (v<<6) | (c & 0x3f);
173 /* IMAP name safety */
175 /* IMAP has certain special requirements in its character set, which means we
176 * have to do a fair bit of work to convert Citadel's UTF8 strings to IMAP
177 * strings. The next two routines (and their data tables) do that.
180 static char *utf7_alphabet =
181 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+,";
183 static unsigned char utf7_rank[256] = {
184 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
185 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
186 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0x3E,0x3F,0xFF,0xFF,0xFF,
187 0x34,0x35,0x36,0x37,0x38,0x39,0x3A,0x3B,0x3C,0x3D,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
188 0xFF,0x00,0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0A,0x0B,0x0C,0x0D,0x0E,
189 0x0F,0x10,0x11,0x12,0x13,0x14,0x15,0x16,0x17,0x18,0x19,0xFF,0xFF,0xFF,0xFF,0xFF,
190 0xFF,0x1A,0x1B,0x1C,0x1D,0x1E,0x1F,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,
191 0x29,0x2A,0x2B,0x2C,0x2D,0x2E,0x2F,0x30,0x31,0x32,0x33,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,
196 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
197 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
198 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
199 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
202 /* Base64 helpers. */
204 static void utf7_closeb64(struct string* out, int v, int i)
210 x = (v << (6-i)) & 0x3F;
211 string_append_c(out, utf7_alphabet[x]);
213 string_append_c(out, '-');
216 /* Convert from a Citadel name to an IMAP-safe name. Returns the end
217 * of the destination.
219 static char* toimap(char* destp, char* destend, char* src)
227 string_init(&dest, destp, destend-destp);
228 /* CtdlLogPrintf(CTDL_DEBUG, "toimap %s\r\n", src); */
232 int c = utf8_getc(&src);
236 if (c >= 0x20 && c <= 0x7e)
240 utf7_closeb64(&dest, v, i);
248 string_append_sn(&dest, "&-", 2);
252 /* Citadel extension: / becomes |, because /
253 * isn't valid as part of an IMAP name. */
259 /* Citadel extension: backslashes mark folder
260 * seperators in the IMAP subfolder emulation
261 * hack. We turn them into / characters,
262 * *except* if it's the last character in the
271 string_append_c(&dest, c);
278 string_append_c(&dest, '&');
285 int x = (v >> (i-6)) & 0x3f;
286 string_append_c(&dest, utf7_alphabet[x]);
293 utf7_closeb64(&dest, v, i);
294 /* CtdlLogPrintf(CTDL_DEBUG, " -> %s\r\n", destp); */
295 return string_end(&dest);
298 /* Convert from an IMAP-safe name back into a Citadel name. Returns the end of the destination. */
300 static int cfrommap(int c);
301 static char* fromimap(char* destp, char* destend, const char* src)
304 unsigned const char *p = (unsigned const char*) src;
311 string_init(&dest, destp, destend-destp);
312 /* CtdlLogPrintf(CTDL_DEBUG, "fromimap %s\r\n", src); */
319 /* US-ASCII characters. */
324 string_append_c(&dest, cfrommap(c));
330 string_append_c(&dest, '&');
333 else if (utf7_rank[c] != 0xff)
342 string_append_sn(&dest, "&-", 2);
350 else if (utf7_rank[c] != 0xFF)
352 v = (v<<6) | utf7_rank[c];
356 int x = (v >> (i-16)) & 0xFFFF;
357 string_append_c(&dest, cfrommap(x));
363 string_append_c(&dest, cfrommap(c));
370 /* CtdlLogPrintf(CTDL_DEBUG, " -> %s\r\n", destp); */
371 return string_end(&dest);
374 /* Undoes the special character conversion. */
376 static int cfrommap(int c)
380 case '|': return '/';
381 case '/': return '\\';
386 /* Output a string to the IMAP client, either as a literal or quoted.
387 * (We do a literal if it has any double-quotes or backslashes.) */
389 void plain_imap_strout(char *buf)
395 if (buf == NULL) { /* yeah, we handle this */
401 for (i = 0; i < len; ++i) {
402 if ((buf[i] == '\"') || (buf[i] == '\\'))
407 cprintf("{%ld}\r\n%s", len, buf);
409 cprintf("\"%s\"", buf);
413 /* Output a string to the IMAP client, either as a literal or quoted.
414 * (We do a literal if it has any double-quotes or backslashes.) */
416 void imap_strout(ConstStr *args)
421 if ((args == NULL) || (args->len == 0))
422 { /* yeah, we handle this */
427 for (i = 0; i < args->len; ++i) {
428 if ((args->Key[i] == '\"') || (args->Key[i] == '\\'))
433 cprintf("{%ld}\r\n%s", args->len, args->Key);
435 cprintf("\"%s\"", args->Key);
442 /* Break a command down into tokens, unquoting any escaped characters. */
444 void MakeStringOf(StrBuf *Buf, int skip)
447 citimap_command *Cmd = &IMAP->Cmd;
449 for (i=skip; i<Cmd->num_parms; ++i) {
450 StrBufAppendBufPlain(Buf, Cmd->Params[i].Key, Cmd->Params[i].len, 0);
451 if (i < (Cmd->num_parms-1)) StrBufAppendBufPlain(Buf, HKEY(" "), 0);
456 void TokenCutRight(citimap_command *Cmd,
462 if (CutMe->len < n) {
467 CutAt = CutMe->Key + CutMe->len - n;
470 StrBufPeek(Cmd->CmdBuf, CutAt, -1, '\0');
473 void TokenCutLeft(citimap_command *Cmd,
477 if (CutMe->len < n) {
478 CutMe->Key += CutMe->len;
489 int CmdAdjust(citimap_command *Cmd,
494 if (nArgs > Cmd->avail_parms) {
495 Params = (ConstStr*) malloc(sizeof(ConstStr) * nArgs);
499 sizeof(ConstStr) * Cmd->avail_parms);
502 sizeof(ConstStr) * Cmd->avail_parms,
504 sizeof(ConstStr) * nArgs -
505 sizeof(ConstStr) * Cmd->avail_parms
511 sizeof(ConstStr) * nArgs);
513 Cmd->avail_parms = nArgs;
514 if (Cmd->Params != NULL)
516 Cmd->Params = Params;
522 sizeof(ConstStr) * Cmd->avail_parms);
526 return Cmd->avail_parms;
529 int imap_parameterize(citimap_command *Cmd)
532 const char *In, *End;
534 In = ChrPtr(Cmd->CmdBuf);
535 End = In + StrLength(Cmd->CmdBuf);
537 /* we start with 10 chars per arg, maybe we need to realloc later. */
538 nArgs = StrLength(Cmd->CmdBuf) / 10 + 10;
539 nArgs = CmdAdjust(Cmd, nArgs, 0);
542 /* Skip whitespace. */
548 /* Found the start of a token. */
550 Cmd->Params[Cmd->num_parms].Key = In;
552 /* Read in the token. */
561 /* Found a quoted section. */
563 Cmd->Params[Cmd->num_parms].Key++;
569 StrBufPeek(Cmd->CmdBuf, In, -1, '\0');
572 else if (*In == '\\')
576 Cmd->Params[Cmd->num_parms].len =
577 In - Cmd->Params[Cmd->num_parms].Key;
579 return Cmd->num_parms;
584 else if (*In == '\\')
590 Cmd->Params[Cmd->num_parms].len =
591 In - Cmd->Params[Cmd->num_parms].Key;
593 return Cmd->num_parms;
597 StrBufPeek(Cmd->CmdBuf, In, -1, '\0');
598 Cmd->Params[Cmd->num_parms].len =
599 In - Cmd->Params[Cmd->num_parms].Key;
600 if (Cmd->num_parms + 1 >= Cmd->avail_parms) {
601 nArgs = CmdAdjust(Cmd, nArgs * 2, 1);
606 return Cmd->num_parms;
609 int old_imap_parameterize(char** args, char *in)
616 /* Skip whitespace. */
623 /* Found the start of a token. */
627 /* Read in the token. */
637 /* Found a quoted section. */
669 /* Convert a struct ctdlroom to an IMAP-compatible mailbox name. */
671 void imap_mailboxname(char *buf, int bufsize, struct ctdlroom *qrbuf)
673 char* bufend = buf+bufsize;
677 /* For mailboxes, just do it straight.
678 * Do the Cyrus-compatible thing: all private folders are
679 * subfolders of INBOX. */
681 if (qrbuf->QRflags & QR_MAILBOX)
683 if (strcasecmp(qrbuf->QRname+11, MAILROOM) == 0)
684 p = toimap(p, bufend, "INBOX");
687 p = toimap(p, bufend, "INBOX");
690 p = toimap(p, bufend, qrbuf->QRname+11);
695 /* Otherwise, prefix the floor name as a "public folders" moniker. */
697 fl = CtdlGetCachedFloor(qrbuf->QRfloor);
698 p = toimap(p, bufend, fl->f_name);
701 p = toimap(p, bufend, qrbuf->QRname);
706 * Convert an inputted folder name to our best guess as to what an equivalent
707 * room name should be.
709 * If an error occurs, it returns -1. Otherwise...
711 * The lower eight bits of the return value are the floor number on which the
712 * room most likely resides. The upper eight bits may contain flags,
713 * including IR_MAILBOX if we're dealing with a personal room.
717 int imap_roomname(char *rbuf, int bufsize, const char *foldername)
720 char floorname[ROOMNAMELEN*2];
721 char roomname[ROOMNAMELEN];
726 if (foldername == NULL)
729 /* Unmunge the entire string into the output buffer. */
731 fromimap(rbuf, rbuf+bufsize, foldername);
733 /* Is this an IMAP inbox? */
735 if (strncasecmp(rbuf, "INBOX", 5) == 0)
739 /* It's the system inbox. */
741 safestrncpy(rbuf, MAILROOM, bufsize);
742 ret = (0 | IR_MAILBOX);
745 else if (rbuf[5] == FDELIM)
747 /* It's another personal mail folder. */
749 safestrncpy(rbuf, rbuf+6, bufsize);
750 ret = (0 | IR_MAILBOX);
754 /* If we get here, the folder just happens to start with INBOX
755 * --- fall through. */
758 /* Is this a multi-level room name? */
760 levels = num_tokens(rbuf, FDELIM);
764 /* Extract the main room name. */
766 len = extract_token(floorname, rbuf, 0, FDELIM, sizeof floorname);
767 if (len < 0) len = 0;
768 safestrncpy(roomname, &rbuf[len + 1], sizeof(roomname));
770 /* Try and find it on any floor. */
772 for (i = 0; i < MAXFLOORS; ++i)
774 fl = CtdlGetCachedFloor(i);
775 if (fl->f_flags & F_INUSE)
777 if (strcasecmp(floorname, fl->f_name) == 0)
781 safestrncpy(rbuf, roomname, bufsize);
789 /* Meh. It's either not a multi-level room name, or else we
792 ret = (0 | IR_MAILBOX);
795 CtdlLogPrintf(CTDL_DEBUG, "(That translates to \"%s\")\n", rbuf);
800 * Output a struct internet_address_list in the form an IMAP client wants
802 void imap_ial_out(struct internet_address_list *ialist)
804 struct internet_address_list *iptr;
806 if (ialist == NULL) {
812 for (iptr = ialist; iptr != NULL; iptr = iptr->next) {
814 plain_imap_strout(iptr->ial_name);
816 plain_imap_strout(iptr->ial_user);
818 plain_imap_strout(iptr->ial_node);
828 * Determine whether the supplied string is a valid message set.
829 * If the string contains only numbers, colons, commas, and asterisks,
830 * return 1 for a valid message set. If any other character is found,
833 int imap_is_message_set(const char *buf)
838 return (0); /* stupidity checks */
842 if (!strcasecmp(buf, "ALL"))
843 return (1); /* macro? why? */
845 for (i = 0; buf[i]; ++i) { /* now start the scan */
855 return (1); /* looks like we're good */
860 * imap_match.c, based on wildmat.c from INN
861 * hacked for Citadel/IMAP by Daniel Malament
864 /* note: not all return statements use these; don't change them */
865 #define WILDMAT_TRUE 1
866 #define WILDMAT_FALSE 0
867 #define WILDMAT_ABORT -1
868 #define WILDMAT_DELIM '/'
871 * Match text and p, return TRUE, FALSE, or ABORT.
873 static int do_imap_match(const char *supplied_text, const char *supplied_p)
876 char lcase_text[SIZ], lcase_p[SIZ];
880 /* Copy both strings and lowercase them, in order to
881 * make this entire operation case-insensitive.
884 ((supplied_text[i] != '\0') &&
885 (i < sizeof(lcase_text)));
887 lcase_text[i] = tolower(supplied_text[i]);
888 lcase_text[i] = '\0';
891 ((supplied_p[i] != '\0') &&
892 (i < sizeof(lcase_p)));
894 lcase_p[i] = tolower(supplied_p[i]);
898 for (p = lcase_p, text = lcase_text;
899 !IsEmptyStr(p) && !IsEmptyStr(text);
901 if ((*text == '\0') && (*p != '*') && (*p != '%')) {
902 return WILDMAT_ABORT;
907 return WILDMAT_FALSE;
912 while (++p, ((*p == '*') || (*p == '%'))) {
913 /* Consecutive stars or %'s act
914 * just like one star.
919 /* Trailing star matches everything. */
923 if ((matched = do_imap_match(text++, p))
928 return WILDMAT_ABORT;
930 while (++p, (!IsEmptyStr(p) && ((*p == '*') || (*p == '%'))))
932 /* Consecutive %'s act just like one, but even
933 * a single star makes the sequence act like
943 * Trailing % matches everything
944 * without a delimiter.
946 while (!IsEmptyStr(text)) {
947 if (*text == WILDMAT_DELIM) {
948 return WILDMAT_FALSE;
954 while (!IsEmptyStr(text) && (*(text - 1) != WILDMAT_DELIM)) {
955 if ((matched = do_imap_match(text++, p))
960 return WILDMAT_ABORT;
964 return (*text == '\0');
970 * Support function for mailbox pattern name matching in LIST and LSUB
971 * Returns nonzero if the supplied mailbox name matches the supplied pattern.
973 int imap_mailbox_matches_pattern(const char *pattern, char *mailboxname)
975 /* handle just-star case quickly */
976 if ((pattern[0] == '*') && (pattern[1] == '\0')) {
979 return (do_imap_match(mailboxname, pattern) == WILDMAT_TRUE);
985 * Compare an IMAP date string (date only, no time) to the date found in
988 int imap_datecmp(const char *datestr, time_t msgtime) {
993 int day, month, year;
994 int msgday, msgmonth, msgyear;
997 char *imap_datecmp_ascmonths[12] = {
998 "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
1001 if (datestr == NULL) return(0);
1003 /* Expecting a date in the form dd-Mmm-yyyy */
1004 extract_token(daystr, datestr, 0, '-', sizeof daystr);
1005 extract_token(monthstr, datestr, 1, '-', sizeof monthstr);
1006 extract_token(yearstr, datestr, 2, '-', sizeof yearstr);
1009 year = atoi(yearstr);
1011 for (i=0; i<12; ++i) {
1012 if (!strcasecmp(monthstr, imap_datecmp_ascmonths[i])) {
1017 /* Extract day/month/year from message timestamp */
1018 localtime_r(&msgtime, &msgtm);
1019 msgday = msgtm.tm_mday;
1020 msgmonth = msgtm.tm_mon;
1021 msgyear = msgtm.tm_year + 1900;
1023 /* Now start comparing */
1025 if (year < msgyear) return(+1);
1026 if (year > msgyear) return(-1);
1028 if (month < msgmonth) return(+1);
1029 if (month > msgmonth) return(-1);
1031 if (day < msgday) return(+1);
1032 if (day > msgday) return(-1);