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"
33 #include "internet_addressing.h"
34 #include "imap_tools.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 buf[0] = 0xC0 | (c >> 6);
106 buf[1] = 0x80 | (c & 0x3F);
109 else if (c <= 0xFFFF)
111 buf[0] = 0xE0 | (c >> 12);
112 buf[1] = 0x80 | ((c >> 6) & 0x3f);
113 buf[2] = 0x80 | (c & 0x3f);
118 buf[0] = 0xf0 | c >> 18;
119 buf[1] = 0x80 | ((c >> 12) & 0x3f);
120 buf[2] = 0x80 | ((c >> 6) & 0x3f);
121 buf[3] = 0x80 | (c & 0x3f);
125 string_append_sn(s, buf, 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, char* src)
304 unsigned char *p = (unsigned 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 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 /* Break a command down into tokens, unquoting any escaped characters. */
415 int imap_parameterize(char** args, char* in)
422 /* Skip whitespace. */
429 /* Found the start of a token. */
433 /* Read in the token. */
443 /* Found a quoted section. */
475 /* Convert a struct ctdlroom to an IMAP-compatible mailbox name. */
477 void imap_mailboxname(char *buf, int bufsize, struct ctdlroom *qrbuf)
479 char* bufend = buf+bufsize;
483 /* For mailboxes, just do it straight.
484 * Do the Cyrus-compatible thing: all private folders are
485 * subfolders of INBOX. */
487 if (qrbuf->QRflags & QR_MAILBOX)
489 if (strcasecmp(qrbuf->QRname+11, MAILROOM) == 0)
490 p = toimap(p, bufend, "INBOX");
493 p = toimap(p, bufend, "INBOX");
496 p = toimap(p, bufend, qrbuf->QRname+11);
501 /* Otherwise, prefix the floor name as a "public folders" moniker. */
503 fl = cgetfloor(qrbuf->QRfloor);
504 p = toimap(p, bufend, fl->f_name);
507 p = toimap(p, bufend, qrbuf->QRname);
512 * Convert an inputted folder name to our best guess as to what an equivalent
513 * room name should be.
515 * If an error occurs, it returns -1. Otherwise...
517 * The lower eight bits of the return value are the floor number on which the
518 * room most likely resides. The upper eight bits may contain flags,
519 * including IR_MAILBOX if we're dealing with a personal room.
523 int imap_roomname(char *rbuf, int bufsize, char *foldername)
527 char roomname[ROOMNAMELEN];
532 if (foldername == NULL)
535 /* Unmunge the entire string into the output buffer. */
537 fromimap(rbuf, rbuf+bufsize, foldername);
539 /* Is this an IMAP inbox? */
541 if (strncasecmp(rbuf, "INBOX", 5) == 0)
545 /* It's the system inbox. */
547 safestrncpy(rbuf, MAILROOM, bufsize);
548 ret = (0 | IR_MAILBOX);
551 else if (rbuf[5] == FDELIM)
553 /* It's another personal mail folder. */
555 safestrncpy(rbuf, rbuf+6, bufsize);
556 ret = (0 | IR_MAILBOX);
560 /* If we get here, the folder just happens to start with INBOX
561 * --- fall through. */
564 /* Is this a multi-level room name? */
566 levels = num_tokens(rbuf, FDELIM);
569 /* Extract the main room name. */
571 extract_token(floorname, rbuf, 0, FDELIM, sizeof floorname);
572 strcpy(roomname, &rbuf[strlen(floorname)+1]);
574 /* Try and find it on any floor. */
576 for (i = 0; i < MAXFLOORS; ++i)
579 if (fl->f_flags & F_INUSE)
581 if (strcasecmp(floorname, fl->f_name) == 0)
585 safestrncpy(rbuf, roomname, bufsize);
593 /* Meh. It's either not a multi-level room name, or else we
596 ret = (0 | IR_MAILBOX);
599 CtdlLogPrintf(CTDL_DEBUG, "(That translates to \"%s\")\n", rbuf);
604 * Output a struct internet_address_list in the form an IMAP client wants
606 void imap_ial_out(struct internet_address_list *ialist)
608 struct internet_address_list *iptr;
610 if (ialist == NULL) {
616 for (iptr = ialist; iptr != NULL; iptr = iptr->next) {
618 imap_strout(iptr->ial_name);
620 imap_strout(iptr->ial_user);
622 imap_strout(iptr->ial_node);
632 * Determine whether the supplied string is a valid message set.
633 * If the string contains only numbers, colons, commas, and asterisks,
634 * return 1 for a valid message set. If any other character is found,
637 int imap_is_message_set(char *buf)
642 return (0); /* stupidity checks */
646 if (!strcasecmp(buf, "ALL"))
647 return (1); /* macro? why? */
649 for (i = 0; buf[i]; ++i) { /* now start the scan */
659 return (1); /* looks like we're good */
664 * imap_match.c, based on wildmat.c from INN
665 * hacked for Citadel/IMAP by Daniel Malament
668 /* note: not all return statements use these; don't change them */
669 #define WILDMAT_TRUE 1
670 #define WILDMAT_FALSE 0
671 #define WILDMAT_ABORT -1
672 #define WILDMAT_DELIM '/'
675 * Match text and p, return TRUE, FALSE, or ABORT.
677 static int do_imap_match(const char *supplied_text, const char *supplied_p)
680 char lcase_text[SIZ], lcase_p[SIZ];
681 char *text = lcase_text;
684 /* Copy both strings and lowercase them, in order to
685 * make this entire operation case-insensitive.
687 for (i=0; i<=strlen(supplied_text); ++i)
688 lcase_text[i] = tolower(supplied_text[i]);
689 for (i=0; i<=strlen(supplied_p); ++i)
690 p[i] = tolower(supplied_p[i]);
693 for (; *p; text++, p++) {
694 if ((*text == '\0') && (*p != '*') && (*p != '%')) {
695 return WILDMAT_ABORT;
700 return WILDMAT_FALSE;
705 while (++p, ((*p == '*') || (*p == '%'))) {
706 /* Consecutive stars or %'s act
707 * just like one star.
712 /* Trailing star matches everything. */
716 if ((matched = do_imap_match(text++, p))
721 return WILDMAT_ABORT;
723 while (++p, ((*p == '*') || (*p == '%'))) {
724 /* Consecutive %'s act just like one, but even
725 * a single star makes the sequence act like
735 * Trailing % matches everything
736 * without a delimiter.
739 if (*text == WILDMAT_DELIM) {
740 return WILDMAT_FALSE;
746 while (*text && (*(text - 1) != WILDMAT_DELIM)) {
747 if ((matched = do_imap_match(text++, p))
752 return WILDMAT_ABORT;
756 return (*text == '\0');
762 * Support function for mailbox pattern name matching in LIST and LSUB
763 * Returns nonzero if the supplied mailbox name matches the supplied pattern.
765 int imap_mailbox_matches_pattern(char *pattern, char *mailboxname)
767 /* handle just-star case quickly */
768 if ((pattern[0] == '*') && (pattern[1] == '\0')) {
771 return (do_imap_match(mailboxname, pattern) == WILDMAT_TRUE);
777 * Compare an IMAP date string (date only, no time) to the date found in
780 int imap_datecmp(char *datestr, time_t msgtime) {
785 int day, month, year;
786 int msgday, msgmonth, msgyear;
789 char *imap_datecmp_ascmonths[12] = {
790 "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
793 if (datestr == NULL) return(0);
795 /* Expecting a date in the form dd-Mmm-yyyy */
796 extract_token(daystr, datestr, 0, '-', sizeof daystr);
797 extract_token(monthstr, datestr, 1, '-', sizeof monthstr);
798 extract_token(yearstr, datestr, 2, '-', sizeof yearstr);
801 year = atoi(yearstr);
803 for (i=0; i<12; ++i) {
804 if (!strcasecmp(monthstr, imap_datecmp_ascmonths[i])) {
809 /* Extract day/month/year from message timestamp */
810 localtime_r(&msgtime, &msgtm);
811 msgday = msgtm.tm_mday;
812 msgmonth = msgtm.tm_mon;
813 msgyear = msgtm.tm_year + 1900;
815 /* Now start comparing */
817 if (year < msgyear) return(+1);
818 if (year > msgyear) return(-1);
820 if (month < msgmonth) return(+1);
821 if (month > msgmonth) return(-1);
823 if (day < msgday) return(+1);
824 if (day > msgday) return(-1);