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 "ctdl_module.h"
40 /* String handling helpers */
42 /* This code uses some pretty nasty string manipulation. To make everything
43 * manageable, we use this semi-high-level string manipulation API. Strings are
44 * always \0-terminated, despite the fact that we keep track of the size.
52 static void string_init(struct string* s, char* buf, int bufsize)
55 s->maxsize = bufsize-1;
56 s->size = strlen(buf);
59 static char* string_end(struct string* s)
61 return s->buffer + s->size;
64 /* Append a UTF8 string of a particular length (in bytes). -1 to autocalculate. */
66 static void string_append_sn(struct string* s, char* p, int len)
70 if ((s->size+len) > s->maxsize)
71 len = s->maxsize - s->size;
72 memcpy(s->buffer + s->size, p, len);
74 s->buffer[s->size] = '\0';
77 /* As above, always autocalculate. */
79 #define string_append_s(s, p) string_append_sn((s), (p), -1)
81 /* Appends a UTF8 character --- which may make the size change by more than 1!
82 * If the string overflows, the last character may become invalid. */
84 static void string_append_c(struct string* s, int c)
89 /* Don't do anything if there's no room. */
91 if (s->size == s->maxsize)
96 /* This is the most common case, so we optimise it. */
98 s->buffer[s->size++] = c;
99 s->buffer[s->size] = 0;
104 buf[0] = 0xC0 | (c >> 6);
105 buf[1] = 0x80 | (c & 0x3F);
108 else if (c <= 0xFFFF)
110 buf[0] = 0xE0 | (c >> 12);
111 buf[1] = 0x80 | ((c >> 6) & 0x3f);
112 buf[2] = 0x80 | (c & 0x3f);
117 buf[0] = 0xf0 | c >> 18;
118 buf[1] = 0x80 | ((c >> 12) & 0x3f);
119 buf[2] = 0x80 | ((c >> 6) & 0x3f);
120 buf[3] = 0x80 | (c & 0x3f);
124 string_append_sn(s, buf, len);
127 /* Reads a UTF8 character from a char*, advancing the pointer. */
129 int utf8_getc(char** ptr)
131 unsigned char* p = (unsigned char*) *ptr;
147 /* valid start char? (max 4 octets) */
149 m = 0x7f80; /* used to mask out the length bits */
152 if ((c & 0xc0) != 0x80)
157 v = (v<<6) | (c & 0x3f);
172 /* IMAP name safety */
174 /* IMAP has certain special requirements in its character set, which means we
175 * have to do a fair bit of work to convert Citadel's UTF8 strings to IMAP
176 * strings. The next two routines (and their data tables) do that.
179 static char *utf7_alphabet =
180 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+,";
182 static unsigned char utf7_rank[256] = {
183 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
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,0x3E,0x3F,0xFF,0xFF,0xFF,
186 0x34,0x35,0x36,0x37,0x38,0x39,0x3A,0x3B,0x3C,0x3D,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
187 0xFF,0x00,0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0A,0x0B,0x0C,0x0D,0x0E,
188 0x0F,0x10,0x11,0x12,0x13,0x14,0x15,0x16,0x17,0x18,0x19,0xFF,0xFF,0xFF,0xFF,0xFF,
189 0xFF,0x1A,0x1B,0x1C,0x1D,0x1E,0x1F,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,
190 0x29,0x2A,0x2B,0x2C,0x2D,0x2E,0x2F,0x30,0x31,0x32,0x33,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,
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,
201 /* Base64 helpers. */
203 static void utf7_closeb64(struct string* out, int v, int i)
209 x = (v << (6-i)) & 0x3F;
210 string_append_c(out, utf7_alphabet[x]);
212 string_append_c(out, '-');
215 /* Convert from a Citadel name to an IMAP-safe name. Returns the end
216 * of the destination.
218 static char* toimap(char* destp, char* destend, char* src)
226 string_init(&dest, destp, destend-destp);
227 /* CtdlLogPrintf(CTDL_DEBUG, "toimap %s\r\n", src); */
231 int c = utf8_getc(&src);
235 if (c >= 0x20 && c <= 0x7e)
239 utf7_closeb64(&dest, v, i);
247 string_append_sn(&dest, "&-", 2);
251 /* Citadel extension: / becomes |, because /
252 * isn't valid as part of an IMAP name. */
258 /* Citadel extension: backslashes mark folder
259 * seperators in the IMAP subfolder emulation
260 * hack. We turn them into / characters,
261 * *except* if it's the last character in the
270 string_append_c(&dest, c);
277 string_append_c(&dest, '&');
284 int x = (v >> (i-6)) & 0x3f;
285 string_append_c(&dest, utf7_alphabet[x]);
292 utf7_closeb64(&dest, v, i);
293 /* CtdlLogPrintf(CTDL_DEBUG, " -> %s\r\n", destp); */
294 return string_end(&dest);
297 /* Convert from an IMAP-safe name back into a Citadel name. Returns the end of the destination. */
299 static int cfrommap(int c);
300 static char* fromimap(char* destp, char* destend, char* src)
303 unsigned char *p = (unsigned char*) src;
310 string_init(&dest, destp, destend-destp);
311 /* CtdlLogPrintf(CTDL_DEBUG, "fromimap %s\r\n", src); */
318 /* US-ASCII characters. */
323 string_append_c(&dest, cfrommap(c));
329 string_append_c(&dest, '&');
332 else if (utf7_rank[c] != 0xff)
341 string_append_sn(&dest, "&-", 2);
349 else if (utf7_rank[c] != 0xFF)
351 v = (v<<6) | utf7_rank[c];
355 int x = (v >> (i-16)) & 0xFFFF;
356 string_append_c(&dest, cfrommap(x));
362 string_append_c(&dest, cfrommap(c));
369 /* CtdlLogPrintf(CTDL_DEBUG, " -> %s\r\n", destp); */
370 return string_end(&dest);
373 /* Undoes the special character conversion. */
375 static int cfrommap(int c)
379 case '|': return '/';
380 case '/': return '\\';
385 /* Output a string to the IMAP client, either as a literal or quoted.
386 * (We do a literal if it has any double-quotes or backslashes.) */
388 void imap_strout(char *buf)
394 if (buf == NULL) { /* yeah, we handle this */
400 for (i = 0; i < len; ++i) {
401 if ((buf[i] == '\"') || (buf[i] == '\\'))
406 cprintf("{%ld}\r\n%s", len, buf);
408 cprintf("\"%s\"", buf);
412 /* Break a command down into tokens, unquoting any escaped characters. */
414 int imap_parameterize(char** args, char* in)
421 /* Skip whitespace. */
428 /* Found the start of a token. */
432 /* Read in the token. */
442 /* Found a quoted section. */
474 /* Convert a struct ctdlroom to an IMAP-compatible mailbox name. */
476 void imap_mailboxname(char *buf, int bufsize, struct ctdlroom *qrbuf)
478 char* bufend = buf+bufsize;
482 /* For mailboxes, just do it straight.
483 * Do the Cyrus-compatible thing: all private folders are
484 * subfolders of INBOX. */
486 if (qrbuf->QRflags & QR_MAILBOX)
488 if (strcasecmp(qrbuf->QRname+11, MAILROOM) == 0)
489 p = toimap(p, bufend, "INBOX");
492 p = toimap(p, bufend, "INBOX");
495 p = toimap(p, bufend, qrbuf->QRname+11);
500 /* Otherwise, prefix the floor name as a "public folders" moniker. */
502 fl = CtdlGetCachedFloor(qrbuf->QRfloor);
503 p = toimap(p, bufend, fl->f_name);
506 p = toimap(p, bufend, qrbuf->QRname);
511 * Convert an inputted folder name to our best guess as to what an equivalent
512 * room name should be.
514 * If an error occurs, it returns -1. Otherwise...
516 * The lower eight bits of the return value are the floor number on which the
517 * room most likely resides. The upper eight bits may contain flags,
518 * including IR_MAILBOX if we're dealing with a personal room.
522 int imap_roomname(char *rbuf, int bufsize, char *foldername)
526 char roomname[ROOMNAMELEN];
531 if (foldername == NULL)
534 /* Unmunge the entire string into the output buffer. */
536 fromimap(rbuf, rbuf+bufsize, foldername);
538 /* Is this an IMAP inbox? */
540 if (strncasecmp(rbuf, "INBOX", 5) == 0)
544 /* It's the system inbox. */
546 safestrncpy(rbuf, MAILROOM, bufsize);
547 ret = (0 | IR_MAILBOX);
550 else if (rbuf[5] == FDELIM)
552 /* It's another personal mail folder. */
554 safestrncpy(rbuf, rbuf+6, bufsize);
555 ret = (0 | IR_MAILBOX);
559 /* If we get here, the folder just happens to start with INBOX
560 * --- fall through. */
563 /* Is this a multi-level room name? */
565 levels = num_tokens(rbuf, FDELIM);
568 /* Extract the main room name. */
570 extract_token(floorname, rbuf, 0, FDELIM, sizeof floorname);
571 strcpy(roomname, &rbuf[strlen(floorname)+1]);
573 /* Try and find it on any floor. */
575 for (i = 0; i < MAXFLOORS; ++i)
577 fl = CtdlGetCachedFloor(i);
578 if (fl->f_flags & F_INUSE)
580 if (strcasecmp(floorname, fl->f_name) == 0)
584 safestrncpy(rbuf, roomname, bufsize);
592 /* Meh. It's either not a multi-level room name, or else we
595 ret = (0 | IR_MAILBOX);
598 CtdlLogPrintf(CTDL_DEBUG, "(That translates to \"%s\")\n", rbuf);
603 * Output a struct internet_address_list in the form an IMAP client wants
605 void imap_ial_out(struct internet_address_list *ialist)
607 struct internet_address_list *iptr;
609 if (ialist == NULL) {
615 for (iptr = ialist; iptr != NULL; iptr = iptr->next) {
617 imap_strout(iptr->ial_name);
619 imap_strout(iptr->ial_user);
621 imap_strout(iptr->ial_node);
631 * Determine whether the supplied string is a valid message set.
632 * If the string contains only numbers, colons, commas, and asterisks,
633 * return 1 for a valid message set. If any other character is found,
636 int imap_is_message_set(char *buf)
641 return (0); /* stupidity checks */
645 if (!strcasecmp(buf, "ALL"))
646 return (1); /* macro? why? */
648 for (i = 0; buf[i]; ++i) { /* now start the scan */
658 return (1); /* looks like we're good */
663 * imap_match.c, based on wildmat.c from INN
664 * hacked for Citadel/IMAP by Daniel Malament
667 /* note: not all return statements use these; don't change them */
668 #define WILDMAT_TRUE 1
669 #define WILDMAT_FALSE 0
670 #define WILDMAT_ABORT -1
671 #define WILDMAT_DELIM '/'
674 * Match text and p, return TRUE, FALSE, or ABORT.
676 static int do_imap_match(const char *supplied_text, const char *supplied_p)
679 char lcase_text[SIZ], lcase_p[SIZ];
680 char *text = lcase_text;
683 /* Copy both strings and lowercase them, in order to
684 * make this entire operation case-insensitive.
686 for (i=0; i<=strlen(supplied_text); ++i)
687 lcase_text[i] = tolower(supplied_text[i]);
688 for (i=0; i<=strlen(supplied_p); ++i)
689 p[i] = tolower(supplied_p[i]);
692 for (; *p; text++, p++) {
693 if ((*text == '\0') && (*p != '*') && (*p != '%')) {
694 return WILDMAT_ABORT;
699 return WILDMAT_FALSE;
704 while (++p, ((*p == '*') || (*p == '%'))) {
705 /* Consecutive stars or %'s act
706 * just like one star.
711 /* Trailing star matches everything. */
715 if ((matched = do_imap_match(text++, p))
720 return WILDMAT_ABORT;
722 while (++p, ((*p == '*') || (*p == '%'))) {
723 /* Consecutive %'s act just like one, but even
724 * a single star makes the sequence act like
734 * Trailing % matches everything
735 * without a delimiter.
738 if (*text == WILDMAT_DELIM) {
739 return WILDMAT_FALSE;
745 while (*text && (*(text - 1) != WILDMAT_DELIM)) {
746 if ((matched = do_imap_match(text++, p))
751 return WILDMAT_ABORT;
755 return (*text == '\0');
761 * Support function for mailbox pattern name matching in LIST and LSUB
762 * Returns nonzero if the supplied mailbox name matches the supplied pattern.
764 int imap_mailbox_matches_pattern(char *pattern, char *mailboxname)
766 /* handle just-star case quickly */
767 if ((pattern[0] == '*') && (pattern[1] == '\0')) {
770 return (do_imap_match(mailboxname, pattern) == WILDMAT_TRUE);
776 * Compare an IMAP date string (date only, no time) to the date found in
779 int imap_datecmp(char *datestr, time_t msgtime) {
784 int day, month, year;
785 int msgday, msgmonth, msgyear;
788 char *imap_datecmp_ascmonths[12] = {
789 "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
792 if (datestr == NULL) return(0);
794 /* Expecting a date in the form dd-Mmm-yyyy */
795 extract_token(daystr, datestr, 0, '-', sizeof daystr);
796 extract_token(monthstr, datestr, 1, '-', sizeof monthstr);
797 extract_token(yearstr, datestr, 2, '-', sizeof yearstr);
800 year = atoi(yearstr);
802 for (i=0; i<12; ++i) {
803 if (!strcasecmp(monthstr, imap_datecmp_ascmonths[i])) {
808 /* Extract day/month/year from message timestamp */
809 localtime_r(&msgtime, &msgtm);
810 msgday = msgtm.tm_mday;
811 msgmonth = msgtm.tm_mon;
812 msgyear = msgtm.tm_year + 1900;
814 /* Now start comparing */
816 if (year < msgyear) return(+1);
817 if (year > msgyear) return(-1);
819 if (month < msgmonth) return(+1);
820 if (month > msgmonth) return(-1);
822 if (day < msgday) return(+1);
823 if (day > msgday) return(-1);