4 * Utility functions for the IMAP module.
6 * Note: most of the UTF7 and UTF8 handling in here was lifted from Evolution.
16 #include "sysdep_decls.h"
19 #include "internet_addressing.h"
20 #include "imap_tools.h"
27 /* String handling helpers */
29 /* This code uses some pretty narsty string manipulation. To make everything
30 * manageable, we use this semi-high-level string manipulation API. Strings are
31 * always \0-terminated, despite the fact that we keep track of the size. */
39 static void string_init(struct string* s, char* buf, int bufsize)
42 s->maxsize = bufsize-1;
43 s->size = strlen(buf);
46 static char* string_end(struct string* s)
48 return s->buffer + s->size;
51 /* Append a UTF8 string of a particular length (in bytes). -1 to autocalculate. */
53 static void string_append_sn(struct string* s, char* p, int len)
57 if ((s->size+len) > s->maxsize)
58 len = s->maxsize - s->size;
59 memcpy(s->buffer + s->size, p, len);
61 s->buffer[s->size] = '\0';
64 /* As above, always autocalculate. */
66 #define string_append_s(s, p) string_append_sn((s), (p), -1)
68 /* Appends a UTF8 character --- which may make the size change by more than 1!
69 * If the string overflows, the last character may become invalid. */
71 static void string_append_c(struct string* s, int c)
76 /* Don't do anything if there's no room. */
78 if (s->size == s->maxsize)
83 /* This is the most common case, so we optimise it. */
85 s->buffer[s->size++] = c;
86 s->buffer[s->size] = 0;
91 buf[0] = 0xC0 | (c >> 6);
92 buf[1] = 0x80 | (c & 0x3F);
97 buf[0] = 0xE0 | (c >> 12);
98 buf[1] = 0x80 | ((c >> 6) & 0x3f);
99 buf[2] = 0x80 | (c & 0x3f);
104 buf[0] = 0xf0 | c >> 18;
105 buf[1] = 0x80 | ((c >> 12) & 0x3f);
106 buf[2] = 0x80 | ((c >> 6) & 0x3f);
107 buf[3] = 0x80 | (c & 0x3f);
111 string_append_sn(s, buf, len);
114 /* Reads a UTF8 character from a char*, advancing the pointer. */
116 int utf8_getc(char** ptr)
118 unsigned char* p = (unsigned char*) *ptr;
134 /* valid start char? (max 4 octets) */
136 m = 0x7f80; /* used to mask out the length bits */
139 if ((c & 0xc0) != 0x80)
144 v = (v<<6) | (c & 0x3f);
159 /* IMAP name safety */
161 /* IMAP has certain special requirements in its character set, which means we
162 * have to do a fair bit of work to convert Citadel's UTF8 strings to IMAP
163 * strings. The next two routines (and their data tables) do that.
166 static char *utf7_alphabet =
167 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+,";
169 static unsigned char utf7_rank[256] = {
170 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
171 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
172 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0x3E,0x3F,0xFF,0xFF,0xFF,
173 0x34,0x35,0x36,0x37,0x38,0x39,0x3A,0x3B,0x3C,0x3D,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
174 0xFF,0x00,0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0A,0x0B,0x0C,0x0D,0x0E,
175 0x0F,0x10,0x11,0x12,0x13,0x14,0x15,0x16,0x17,0x18,0x19,0xFF,0xFF,0xFF,0xFF,0xFF,
176 0xFF,0x1A,0x1B,0x1C,0x1D,0x1E,0x1F,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,
177 0x29,0x2A,0x2B,0x2C,0x2D,0x2E,0x2F,0x30,0x31,0x32,0x33,0xFF,0xFF,0xFF,0xFF,0xFF,
178 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
179 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
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,0xFF,0xFF,0xFF,0xFF,0xFF,
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,0xFF,0xFF,0xFF,0xFF,0xFF,
188 /* Base64 helpers. */
190 static void utf7_closeb64(struct string* out, int v, int i)
196 x = (v << (6-i)) & 0x3F;
197 string_append_c(out, utf7_alphabet[x]);
199 string_append_c(out, '-');
202 /* Convert from a Citadel name to an IMAP-safe name. Returns the end
203 * of the destination.
205 static char* toimap(char* destp, char* destend, char* src)
213 string_init(&dest, destp, destend-destp);
214 /* lprintf(CTDL_DEBUG, "toimap %s\r\n", src); */
218 int c = utf8_getc(&src);
222 if (c >= 0x20 && c <= 0x7e)
226 utf7_closeb64(&dest, v, i);
234 string_append_sn(&dest, "&-", 2);
238 /* Citadel extension: / becomes |, because /
239 * isn't valid as part of an IMAP name. */
245 /* Citadel extension: backslashes mark folder
246 * seperators in the IMAP subfolder emulation
247 * hack. We turn them into / characters,
248 * *except* if it's the last character in the
257 string_append_c(&dest, c);
264 string_append_c(&dest, '&');
271 int x = (v >> (i-6)) & 0x3f;
272 string_append_c(&dest, utf7_alphabet[x]);
279 utf7_closeb64(&dest, v, i);
280 /* lprintf(CTDL_DEBUG, " -> %s\r\n", destp); */
281 return string_end(&dest);
284 /* Convert from an IMAP-safe name back into a Citadel name. Returns the end of the destination. */
286 static int cfrommap(int c);
287 static char* fromimap(char* destp, char* destend, char* src)
290 unsigned char *p = (unsigned char*) src;
297 string_init(&dest, destp, destend-destp);
298 /* lprintf(CTDL_DEBUG, "fromimap %s\r\n", src); */
305 /* US-ASCII characters. */
310 string_append_c(&dest, cfrommap(c));
316 string_append_c(&dest, '&');
319 else if (utf7_rank[c] != 0xff)
328 string_append_sn(&dest, "&-", 2);
336 else if (utf7_rank[c] != 0xFF)
338 v = (v<<6) | utf7_rank[c];
342 int x = (v >> (i-16)) & 0xFFFF;
343 string_append_c(&dest, cfrommap(x));
349 string_append_c(&dest, cfrommap(c));
356 /* lprintf(CTDL_DEBUG, " -> %s\r\n", destp); */
357 return string_end(&dest);
360 /* Undoes the special character conversion. */
362 static int cfrommap(int c)
366 case '|': return '/';
367 case '/': return '\\';
372 /* Output a string to the IMAP client, either as a literal or quoted.
373 * (We do a literal if it has any double-quotes or backslashes.) */
375 void imap_strout(char *buf)
380 if (buf == NULL) { /* yeah, we handle this */
384 for (i = 0; i < strlen(buf); ++i) {
385 if ((buf[i] == '\"') || (buf[i] == '\\'))
390 cprintf("{%ld}\r\n%s", (long)strlen(buf), buf);
392 cprintf("\"%s\"", buf);
396 /* Break a command down into tokens, unquoting any escaped characters. */
398 int imap_parameterize(char** args, char* in)
405 /* Skip whitespace. */
412 /* Found the start of a token. */
416 /* Read in the token. */
426 /* Found a quoted section. */
458 /* Convert a struct ctdlroom to an IMAP-compatible mailbox name. */
460 void imap_mailboxname(char *buf, int bufsize, struct ctdlroom *qrbuf)
462 char* bufend = buf+bufsize;
466 /* For mailboxes, just do it straight.
467 * Do the Cyrus-compatible thing: all private folders are
468 * subfolders of INBOX. */
470 if (qrbuf->QRflags & QR_MAILBOX)
472 if (strcasecmp(qrbuf->QRname+11, MAILROOM) == 0)
473 p = toimap(p, bufend, "INBOX");
476 p = toimap(p, bufend, "INBOX");
479 p = toimap(p, bufend, qrbuf->QRname+11);
484 /* Otherwise, prefix the floor name as a "public folders" moniker. */
486 fl = cgetfloor(qrbuf->QRfloor);
487 p = toimap(p, bufend, fl->f_name);
490 p = toimap(p, bufend, qrbuf->QRname);
495 * Convert an inputted folder name to our best guess as to what an equivalent
496 * room name should be.
498 * If an error occurs, it returns -1. Otherwise...
500 * The lower eight bits of the return value are the floor number on which the
501 * room most likely resides. The upper eight bits may contain flags,
502 * including IR_MAILBOX if we're dealing with a personal room.
506 int imap_roomname(char *rbuf, int bufsize, char *foldername)
510 char roomname[ROOMNAMELEN];
515 if (foldername == NULL)
518 /* Unmunge the entire string into the output buffer. */
520 fromimap(rbuf, rbuf+bufsize, foldername);
522 /* Is this an IMAP inbox? */
524 if (strncasecmp(rbuf, "INBOX", 5) == 0)
528 /* It's the system inbox. */
530 safestrncpy(rbuf, MAILROOM, bufsize);
531 ret = (0 | IR_MAILBOX);
534 else if (rbuf[5] == FDELIM)
536 /* It's another personal mail folder. */
538 safestrncpy(rbuf, rbuf+6, bufsize);
539 ret = (0 | IR_MAILBOX);
543 /* If we get here, the folder just happens to start with INBOX
544 * --- fall through. */
547 /* Is this a multi-level room name? */
549 levels = num_tokens(rbuf, FDELIM);
552 /* Extract the main room name. */
554 extract_token(floorname, rbuf, 0, FDELIM, sizeof floorname);
555 strcpy(roomname, &rbuf[strlen(floorname)+1]);
557 /* Try and find it on any floor. */
559 for (i = 0; i < MAXFLOORS; ++i)
562 if (fl->f_flags & F_INUSE)
564 if (strcasecmp(floorname, fl->f_name) == 0)
568 safestrncpy(rbuf, roomname, bufsize);
576 /* Meh. It's either not a multi-level room name, or else we
579 ret = (0 | IR_MAILBOX);
582 lprintf(CTDL_DEBUG, "(That translates to \"%s\")\n", rbuf);
587 * Output a struct internet_address_list in the form an IMAP client wants
589 void imap_ial_out(struct internet_address_list *ialist)
591 struct internet_address_list *iptr;
593 if (ialist == NULL) {
599 for (iptr = ialist; iptr != NULL; iptr = iptr->next) {
601 imap_strout(iptr->ial_name);
603 imap_strout(iptr->ial_user);
605 imap_strout(iptr->ial_node);
615 * Determine whether the supplied string is a valid message set.
616 * If the string contains only numbers, colons, commas, and asterisks,
617 * return 1 for a valid message set. If any other character is found,
620 int imap_is_message_set(char *buf)
625 return (0); /* stupidity checks */
626 if (strlen(buf) == 0)
629 if (!strcasecmp(buf, "ALL"))
630 return (1); /* macro? why? */
632 for (i = 0; i < strlen(buf); ++i) { /* now start the scan */
642 return (1); /* looks like we're good */
647 * imap_match.c, based on wildmat.c from INN
648 * hacked for Citadel/IMAP by Daniel Malament
651 /* note: not all return statements use these; don't change them */
652 #define WILDMAT_TRUE 1
653 #define WILDMAT_FALSE 0
654 #define WILDMAT_ABORT -1
655 #define WILDMAT_DELIM '/'
658 * Match text and p, return TRUE, FALSE, or ABORT.
660 static int do_imap_match(const char *supplied_text, const char *supplied_p)
663 char lcase_text[SIZ], lcase_p[SIZ];
664 char *text = lcase_text;
667 /* Copy both strings and lowercase them, in order to
668 * make this entire operation case-insensitive.
670 for (i=0; i<=strlen(supplied_text); ++i)
671 lcase_text[i] = tolower(supplied_text[i]);
672 for (i=0; i<=strlen(supplied_p); ++i)
673 p[i] = tolower(supplied_p[i]);
676 for (; *p; text++, p++) {
677 if ((*text == '\0') && (*p != '*') && (*p != '%')) {
678 return WILDMAT_ABORT;
683 return WILDMAT_FALSE;
688 while (++p, ((*p == '*') || (*p == '%'))) {
689 /* Consecutive stars or %'s act
690 * just like one star.
695 /* Trailing star matches everything. */
699 if ((matched = do_imap_match(text++, p))
704 return WILDMAT_ABORT;
706 while (++p, ((*p == '*') || (*p == '%'))) {
707 /* Consecutive %'s act just like one, but even
708 * a single star makes the sequence act like
718 * Trailing % matches everything
719 * without a delimiter.
722 if (*text == WILDMAT_DELIM) {
723 return WILDMAT_FALSE;
729 while (*text && (*(text - 1) != WILDMAT_DELIM)) {
730 if ((matched = do_imap_match(text++, p))
735 return WILDMAT_ABORT;
739 return (*text == '\0');
745 * Support function for mailbox pattern name matching in LIST and LSUB
746 * Returns nonzero if the supplied mailbox name matches the supplied pattern.
748 int imap_mailbox_matches_pattern(char *pattern, char *mailboxname)
750 /* handle just-star case quickly */
751 if ((pattern[0] == '*') && (pattern[1] == '\0')) {
754 return (do_imap_match(mailboxname, pattern) == WILDMAT_TRUE);
760 * Compare an IMAP date string (date only, no time) to the date found in
763 int imap_datecmp(char *datestr, time_t msgtime) {
768 int day, month, year;
769 int msgday, msgmonth, msgyear;
772 if (datestr == NULL) return(0);
774 /* Expecting a date in the form dd-Mmm-yyyy */
775 extract_token(daystr, datestr, 0, '-', sizeof daystr);
776 extract_token(monthstr, datestr, 1, '-', sizeof monthstr);
777 extract_token(yearstr, datestr, 2, '-', sizeof yearstr);
780 year = atoi(yearstr);
782 for (i=0; i<12; ++i) {
783 if (!strcasecmp(monthstr, ascmonths[i])) {
788 /* Extract day/month/year from message timestamp */
789 localtime_r(&msgtime, &msgtm);
790 msgday = msgtm.tm_mday;
791 msgmonth = msgtm.tm_mon;
792 msgyear = msgtm.tm_year + 1900;
794 /* Now start comparing */
796 if (year < msgyear) return(+1);
797 if (year > msgyear) return(-1);
799 if (month < msgmonth) return(+1);
800 if (month > msgmonth) return(-1);
802 if (day < msgday) return(+1);
803 if (day > msgday) return(-1);