2 * Implements the FETCH command in IMAP.
3 * This is a good example of the protocol's gratuitous complexity.
5 * Copyright (c) 2001-2011 by the citadel.org team
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
31 #include <sys/types.h>
33 #if TIME_WITH_SYS_TIME
34 # include <sys/time.h>
38 # include <sys/time.h>
48 #include <libcitadel.h>
51 #include "sysdep_decls.h"
52 #include "citserver.h"
58 #include "internet_addressing.h"
59 #include "serv_imap.h"
60 #include "imap_tools.h"
61 #include "imap_fetch.h"
63 #include "ctdl_module.h"
68 * Individual field functions for imap_do_fetch_msg() ...
71 void imap_fetch_uid(int seq) {
72 IAPrintf("UID %ld", IMAP->msgids[seq-1]);
75 void imap_fetch_flags(int seq)
78 int num_flags_printed = 0;
80 if (Imap->flags[seq] & IMAP_DELETED) {
81 if (num_flags_printed > 0)
86 if (Imap->flags[seq] & IMAP_SEEN) {
87 if (num_flags_printed > 0)
92 if (Imap->flags[seq] & IMAP_ANSWERED) {
93 if (num_flags_printed > 0)
98 if (Imap->flags[seq] & IMAP_RECENT) {
99 if (num_flags_printed > 0)
108 void imap_fetch_internaldate(struct CtdlMessage *msg) {
113 if (msg->cm_fields['T'] != NULL) {
114 msgdate = atol(msg->cm_fields['T']);
117 msgdate = time(NULL);
120 datestring(datebuf, sizeof datebuf, msgdate, DATESTRING_IMAP);
121 IAPrintf( "INTERNALDATE \"%s\"", datebuf);
126 * Fetch RFC822-formatted messages.
128 * 'whichfmt' should be set to one of:
129 * "RFC822" entire message
130 * "RFC822.HEADER" headers only (with trailing blank line)
131 * "RFC822.SIZE" size of translated message
132 * "RFC822.TEXT" body only (without leading blank line)
134 void imap_fetch_rfc822(long msgnum, const char *whichfmt) {
135 citimap *Imap = IMAP;
136 const char *ptr = NULL;
137 size_t headers_size, text_size, total_size;
138 size_t bytes_to_send = 0;
140 int need_to_rewrite_metadata = 0;
142 CitContext *CCC = CC;
144 /* Determine whether this particular fetch operation requires
145 * us to fetch the message body from disk. If not, we can save
146 * on some disk operations...
148 if ( (!strcasecmp(whichfmt, "RFC822"))
149 || (!strcasecmp(whichfmt, "RFC822.TEXT")) ) {
153 /* If this is an RFC822.SIZE fetch, first look in the message's
154 * metadata record to see if we've saved that information.
156 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
157 GetMetaData(&smi, msgnum);
158 if (smi.meta_rfc822_length > 0L) {
159 IAPrintf("RFC822.SIZE %ld", smi.meta_rfc822_length);
162 need_to_rewrite_metadata = 1;
166 /* Cache the most recent RFC822 FETCH because some clients like to
167 * fetch in pieces, and we don't want to have to go back to the
168 * message store for each piece. We also burn the cache if the
169 * client requests something that involves reading the message
170 * body, but we haven't fetched the body yet.
172 if ((Imap->cached_rfc822 != NULL)
173 && (Imap->cached_rfc822_msgnum == msgnum)
174 && (Imap->cached_rfc822_withbody || (!need_body)) ) {
177 else if (Imap->cached_rfc822 != NULL) {
178 /* Some other message is cached -- free it */
179 FreeStrBuf(&Imap->cached_rfc822);
180 Imap->cached_rfc822_msgnum = (-1);
183 /* At this point, we now can fetch and convert the message iff it's not
184 * the one we had cached.
186 if (Imap->cached_rfc822 == NULL) {
188 * Load the message into memory for translation & measurement
190 CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
191 CtdlOutputMsg(msgnum, MT_RFC822,
192 (need_body ? HEADERS_ALL : HEADERS_FAST),
193 0, 1, NULL, SUPPRESS_ENV_TO
195 if (!need_body) IAPuts("\r\n"); /* extra trailing newline */
196 Imap->cached_rfc822 = CCC->redirect_buffer;
197 CCC->redirect_buffer = NULL;
198 Imap->cached_rfc822_msgnum = msgnum;
199 Imap->cached_rfc822_withbody = need_body;
200 if ( (need_to_rewrite_metadata) &&
201 (StrLength(Imap->cached_rfc822) > 0) ) {
202 smi.meta_rfc822_length = StrLength(Imap->cached_rfc822);
208 * Now figure out where the headers/text break is. IMAP considers the
209 * intervening blank line to be part of the headers, not the text.
216 StrBuf *Line = NewStrBuf();
219 StrBufSipLine(Line, Imap->cached_rfc822, &ptr);
221 if ((StrLength(Line) != 0) && (ptr != StrBufNOTNULL))
224 if ((StrLength(Line) != 0) &&
225 (ptr != StrBufNOTNULL) )
227 headers_size = ptr - ChrPtr(Imap->cached_rfc822);
230 } while ( (headers_size == 0) &&
231 (ptr != StrBufNOTNULL) );
233 total_size = StrLength(Imap->cached_rfc822);
234 text_size = total_size - headers_size;
239 total_size = StrLength(Imap->cached_rfc822);
244 "RFC822: headers=" SIZE_T_FMT
246 ", total=" SIZE_T_FMT,
247 headers_size, text_size, total_size);
249 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
250 IAPrintf("RFC822.SIZE " SIZE_T_FMT, total_size);
254 else if (!strcasecmp(whichfmt, "RFC822")) {
255 ptr = ChrPtr(Imap->cached_rfc822);
256 bytes_to_send = total_size;
259 else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
260 ptr = ChrPtr(Imap->cached_rfc822);
261 bytes_to_send = headers_size;
264 else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
265 ptr = &ChrPtr(Imap->cached_rfc822)[headers_size];
266 bytes_to_send = text_size;
269 IAPrintf("%s {" SIZE_T_FMT "}\r\n", whichfmt, bytes_to_send);
270 iaputs(ptr, bytes_to_send);
276 * Load a specific part of a message into the temp file to be output to a
277 * client. FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
278 * but we still can't handle "2.HEADER" (which might not be a problem).
280 * Note: mime_parser() was called with dont_decode set to 1, so we have the
281 * luxury of simply spewing without having to re-encode.
283 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
284 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
285 char *cbid, void *cbuserdata)
288 char *desired_section;
290 desired_section = (char *)cbuserdata;
291 syslog(LOG_DEBUG, "imap_load_part() looking for %s, found %s",
296 if (!strcasecmp(partnum, desired_section)) {
297 iaputs(content, length);
300 snprintf(mimebuf2, sizeof mimebuf2, "%s.MIME", partnum);
302 if (!strcasecmp(desired_section, mimebuf2)) {
303 IAPuts("Content-type: ");
305 if (!IsEmptyStr(cbcharset)) {
306 IAPuts("; charset=\"");
310 if (!IsEmptyStr(name)) {
316 if (!IsEmptyStr(encoding)) {
317 IAPuts("Content-Transfer-Encoding: ");
321 if (!IsEmptyStr(encoding)) {
322 IAPuts("Content-Disposition: ");
325 if (!IsEmptyStr(filename)) {
326 IAPuts("; filename=\"");
332 IAPrintf("Content-Length: %ld\r\n\r\n", (long)length);
338 * Called by imap_fetch_envelope() to output the "From" field.
339 * This is in its own function because its logic is kind of complex. We
340 * really need to make this suck less.
342 void imap_output_envelope_from(struct CtdlMessage *msg) {
343 char user[SIZ], node[SIZ], name[SIZ];
347 /* For anonymous messages, it's so easy! */
348 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONONLY)) {
349 IAPuts("((\"----\" NIL \"x\" \"x.org\")) ");
352 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONOPT)) {
353 IAPuts("((\"anonymous\" NIL \"x\" \"x.org\")) ");
357 /* For everything else, we do stuff. */
358 IAPuts("(("); /* open double-parens */
359 plain_imap_strout(msg->cm_fields['A']); /* personal name */
360 IAPuts(" NIL "); /* source route (not used) */
363 if (msg->cm_fields['F'] != NULL) {
364 process_rfc822_addr(msg->cm_fields['F'], user, node, name);
365 plain_imap_strout(user); /* mailbox name (user id) */
367 if (!strcasecmp(node, config.c_nodename)) {
368 plain_imap_strout(config.c_fqdn);
371 plain_imap_strout(node); /* host name */
375 plain_imap_strout(msg->cm_fields['A']); /* mailbox name (user id) */
377 plain_imap_strout(msg->cm_fields['N']); /* host name */
380 IAPuts(")) "); /* close double-parens */
386 * Output an envelope address (or set of addresses) in the official,
387 * convoluted, braindead format. (Note that we can't use this for
388 * the "From" address because its data may come from a number of different
389 * fields. But we can use it for "To" and possibly others.
391 void imap_output_envelope_addr(char *addr) {
392 char individual_addr[256];
404 if (IsEmptyStr(addr)) {
411 /* How many addresses are listed here? */
412 num_addrs = num_tokens(addr, ',');
414 /* Output them one by one. */
415 for (i=0; i<num_addrs; ++i) {
416 extract_token(individual_addr, addr, i, ',', sizeof individual_addr);
417 striplt(individual_addr);
418 process_rfc822_addr(individual_addr, user, node, name);
420 plain_imap_strout(name);
422 plain_imap_strout(user);
424 plain_imap_strout(node);
426 if (i < (num_addrs-1))
435 * Implements the ENVELOPE fetch item
437 * Note that the imap_strout() function can cleverly output NULL fields as NIL,
438 * so we don't have to check for that condition like we do elsewhere.
440 void imap_fetch_envelope(struct CtdlMessage *msg) {
441 char datestringbuf[SIZ];
443 char *fieldptr = NULL;
448 /* Parse the message date into an IMAP-format date string */
449 if (msg->cm_fields['T'] != NULL) {
450 msgdate = atol(msg->cm_fields['T']);
453 msgdate = time(NULL);
455 datestring(datestringbuf, sizeof datestringbuf,
456 msgdate, DATESTRING_IMAP);
458 /* Now start spewing data fields. The order is important, as it is
459 * defined by the protocol specification. Nonexistent fields must
460 * be output as NIL, existent fields must be quoted or literalled.
461 * The imap_strout() function conveniently does all this for us.
463 IAPuts("ENVELOPE (");
466 plain_imap_strout(datestringbuf);
470 plain_imap_strout(msg->cm_fields['U']);
474 imap_output_envelope_from(msg);
476 /* Sender (default to same as 'From' if not present) */
477 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Sender");
478 if (fieldptr != NULL) {
479 imap_output_envelope_addr(fieldptr);
483 imap_output_envelope_from(msg);
487 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Reply-to");
488 if (fieldptr != NULL) {
489 imap_output_envelope_addr(fieldptr);
493 imap_output_envelope_from(msg);
497 imap_output_envelope_addr(msg->cm_fields['R']);
499 /* Cc (we do it this way because there might be a legacy non-Citadel Cc: field present) */
500 fieldptr = msg->cm_fields['Y'];
501 if (fieldptr != NULL) {
502 imap_output_envelope_addr(fieldptr);
505 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Cc");
506 imap_output_envelope_addr(fieldptr);
507 if (fieldptr != NULL) free(fieldptr);
511 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Bcc");
512 imap_output_envelope_addr(fieldptr);
513 if (fieldptr != NULL) free(fieldptr);
516 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "In-reply-to");
517 plain_imap_strout(fieldptr);
519 if (fieldptr != NULL) free(fieldptr);
522 len = strlen(msg->cm_fields['I']);
525 (msg->cm_fields['I'][0] == '<') &&
526 (msg->cm_fields['I'][len - 1] == '>'))
529 plain_imap_strout(msg->cm_fields['I']);
533 char *Buf = malloc(len + 3);
536 if (msg->cm_fields['I'][0] != '<')
541 memcpy(&Buf[pos], msg->cm_fields['I'], len);
543 if (msg->cm_fields['I'][len] != '>')
556 * This function is called only when CC->redirect_buffer contains a set of
557 * RFC822 headers with no body attached. Its job is to strip that set of
558 * headers down to *only* the ones we're interested in.
560 void imap_strip_headers(StrBuf *section) {
562 StrBuf *which_fields = NULL;
563 int doing_headers = 0;
567 StrBuf *boiled_headers = NULL;
570 int done_headers = 0;
571 const char *Ptr = NULL;
572 CitContext *CCC = CC;
574 if (CCC->redirect_buffer == NULL) return;
576 which_fields = NewStrBufDup(section);
578 if (!strncasecmp(ChrPtr(which_fields), "HEADER.FIELDS", 13))
581 !strncasecmp(ChrPtr(which_fields), "HEADER.FIELDS.NOT", 17))
584 for (i=0; i < StrLength(which_fields); ++i) {
585 if (ChrPtr(which_fields)[i]=='(')
586 StrBufReplaceToken(which_fields, i, 1, HKEY(""));
588 for (i=0; i < StrLength(which_fields); ++i) {
589 if (ChrPtr(which_fields)[i]==')') {
590 StrBufCutAt(which_fields, i, NULL);
594 memset(&Cmd, 0, sizeof(citimap_command));
595 Cmd.CmdBuf = which_fields;
596 num_parms = imap_parameterize(&Cmd);
598 boiled_headers = NewStrBufPlain(NULL, StrLength(CCC->redirect_buffer));
599 Line = NewStrBufPlain(NULL, SIZ);
603 StrBufSipLine(Line, CCC->redirect_buffer, &Ptr);
605 if (!isspace(ChrPtr(Line)[0])) {
607 if (doing_headers == 0) ok = 1;
609 /* we're supposed to print all headers that are not matching the filter list */
610 if (headers_not) for (i=0, ok = 1; (i < num_parms) && (ok == 1); ++i) {
611 if ( (!strncasecmp(ChrPtr(Line),
613 Cmd.Params[i].len)) &&
614 (ChrPtr(Line)[Cmd.Params[i].len]==':') ) {
618 /* we're supposed to print all headers matching the filterlist */
619 else for (i=0, ok = 0; ((i < num_parms) && (ok == 0)); ++i) {
620 if ( (!strncasecmp(ChrPtr(Line),
622 Cmd.Params[i].len)) &&
623 (ChrPtr(Line)[Cmd.Params[i].len]==':') ) {
631 StrBufAppendBuf(boiled_headers, Line, 0);
632 StrBufAppendBufPlain(boiled_headers, HKEY("\r\n"), 0);
635 if ((Ptr == StrBufNOTNULL) ||
636 (StrLength(Line) == 0) ||
637 (ChrPtr(Line)[0]=='\r') ||
638 (ChrPtr(Line)[0]=='\n') ) done_headers = 1;
639 } while (!done_headers);
641 StrBufAppendBufPlain(boiled_headers, HKEY("\r\n"), 0);
643 /* Now save it back (it'll always be smaller) */
644 FreeStrBuf(&CCC->redirect_buffer);
645 CCC->redirect_buffer = boiled_headers;
648 FreeStrBuf(&which_fields);
654 * Implements the BODY and BODY.PEEK fetch items
656 void imap_fetch_body(long msgnum, ConstStr item, int is_peek) {
657 struct CtdlMessage *msg = NULL;
661 size_t pstart, pbytes;
662 int loading_body_now = 0;
664 int burn_the_cache = 0;
665 CitContext *CCC = CC;
666 citimap *Imap = IMAP;
668 /* extract section */
669 section = NewStrBufPlain(CKEY(item));
671 if (strchr(ChrPtr(section), '[') != NULL) {
672 StrBufStripAllBut(section, '[', ']');
674 syslog(LOG_DEBUG, "Section is: [%s]",
675 (StrLength(section) == 0) ? "(empty)" : ChrPtr(section)
678 /* Burn the cache if we don't have the same section of the
679 * same message again.
681 if (Imap->cached_body != NULL) {
682 if (Imap->cached_bodymsgnum != msgnum) {
685 else if ( (!Imap->cached_body_withbody) && (need_body) ) {
688 else if (strcasecmp(Imap->cached_bodypart, ChrPtr(section))) {
691 if (burn_the_cache) {
692 /* Yup, go ahead and burn the cache. */
693 free(Imap->cached_body);
694 Imap->cached_body_len = 0;
695 Imap->cached_body = NULL;
696 Imap->cached_bodymsgnum = (-1);
697 strcpy(Imap->cached_bodypart, "");
701 /* extract partial */
702 partial = NewStrBufPlain(CKEY(item));
703 if (strchr(ChrPtr(partial), '<') != NULL) {
704 StrBufStripAllBut(partial, '<', '>');
707 if ( (is_partial == 1) && (StrLength(partial) > 0) ) {
708 syslog(LOG_DEBUG, "Partial is <%s>", ChrPtr(partial));
711 if (Imap->cached_body == NULL) {
712 CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
713 loading_body_now = 1;
714 msg = CtdlFetchMessage(msgnum, (need_body ? 1 : 0));
717 /* Now figure out what the client wants, and get it */
719 if (!loading_body_now) {
720 /* What we want is already in memory */
723 else if ( (!strcmp(ChrPtr(section), "1")) && (msg->cm_format_type != 4) ) {
724 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
727 else if (StrLength(section) == 0) {
728 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, SUPPRESS_ENV_TO);
732 * If the client asked for just headers, or just particular header
733 * fields, strip it down.
735 else if (!strncasecmp(ChrPtr(section), "HEADER", 6)) {
736 /* This used to work with HEADERS_FAST, but then Apple got stupid with their
737 * IMAP library and this broke Mail.App and iPhone Mail, so we had to change it
738 * to HEADERS_ONLY so the trendy hipsters with their iPhones can read mail.
740 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, SUPPRESS_ENV_TO);
741 imap_strip_headers(section);
745 * Strip it down if the client asked for everything _except_ headers.
747 else if (!strncasecmp(ChrPtr(section), "TEXT", 4)) {
748 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
752 * Anything else must be a part specifier.
753 * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
756 mime_parser(msg->cm_fields['M'], NULL,
757 *imap_load_part, NULL, NULL,
763 if (loading_body_now) {
764 Imap->cached_body_len = StrLength(CCC->redirect_buffer);
765 Imap->cached_body = SmashStrBuf(&CCC->redirect_buffer);
766 Imap->cached_bodymsgnum = msgnum;
767 Imap->cached_body_withbody = need_body;
768 strcpy(Imap->cached_bodypart, ChrPtr(section));
771 if (is_partial == 0) {
773 iaputs(SKEY(section));
774 IAPrintf("] {" SIZE_T_FMT "}\r\n", Imap->cached_body_len);
776 pbytes = Imap->cached_body_len;
779 sscanf(ChrPtr(partial), SIZE_T_FMT "." SIZE_T_FMT, &pstart, &pbytes);
780 if (pbytes > (Imap->cached_body_len - pstart)) {
781 pbytes = Imap->cached_body_len - pstart;
784 iaputs(SKEY(section));
785 IAPrintf("]<" SIZE_T_FMT "> {" SIZE_T_FMT "}\r\n", pstart, pbytes);
788 FreeStrBuf(&partial);
790 /* Here we go -- output it */
791 iaputs(&Imap->cached_body[pstart], pbytes);
794 CtdlFreeMessage(msg);
797 /* Mark this message as "seen" *unless* this is a "peek" operation */
799 CtdlSetSeen(&msgnum, 1, 1, ctdlsetseen_seen, NULL, NULL);
801 FreeStrBuf(§ion);
805 * Called immediately before outputting a multipart bodystructure
807 void imap_fetch_bodystructure_pre(
808 char *name, char *filename, char *partnum, char *disp,
809 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
810 char *cbid, void *cbuserdata
819 * Called immediately after outputting a multipart bodystructure
821 void imap_fetch_bodystructure_post(
822 char *name, char *filename, char *partnum, char *disp,
823 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
824 char *cbid, void *cbuserdata
832 extract_token(subtype, cbtype, 1, '/', sizeof subtype);
833 plain_imap_strout(subtype);
836 /* IAPuts(" NIL"); We thought we needed this at one point, but maybe we don't... */
844 * Output the info for a MIME part in the format required by BODYSTRUCTURE.
847 void imap_fetch_bodystructure_part(
848 char *name, char *filename, char *partnum, char *disp,
849 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
850 char *cbid, void *cbuserdata
854 int have_encoding = 0;
857 char cbmaintype[128];
860 if (cbtype != NULL) if (!IsEmptyStr(cbtype)) have_cbtype = 1;
862 extract_token(cbmaintype, cbtype, 0, '/', sizeof cbmaintype);
863 extract_token(cbsubtype, cbtype, 1, '/', sizeof cbsubtype);
866 strcpy(cbmaintype, "TEXT");
867 strcpy(cbsubtype, "PLAIN");
871 plain_imap_strout(cbmaintype); /* body type */
873 plain_imap_strout(cbsubtype); /* body subtype */
876 IAPuts("("); /* begin body parameter list */
878 /* "NAME" must appear as the first parameter. This is not required by IMAP,
879 * but the Asterisk voicemail application blindly assumes that NAME will be in
880 * the first position. If it isn't, it rejects the message.
882 if (name != NULL) if (!IsEmptyStr(name)) {
884 plain_imap_strout(name);
888 IAPuts("\"CHARSET\" ");
889 if (cbcharset == NULL) {
890 plain_imap_strout("US-ASCII");
892 else if (cbcharset[0] == 0) {
893 plain_imap_strout("US-ASCII");
896 plain_imap_strout(cbcharset);
898 IAPuts(") "); /* end body parameter list */
900 IAPuts("NIL "); /* Body ID */
901 IAPuts("NIL "); /* Body description */
903 if (encoding != NULL) if (encoding[0] != 0) have_encoding = 1;
905 plain_imap_strout(encoding);
908 plain_imap_strout("7BIT");
912 /* The next field is the size of the part in bytes. */
913 IAPrintf("%ld ", (long)length); /* bytes */
915 /* The next field is the number of lines in the part, if and only
916 * if the part is TEXT. More gratuitous complexity.
918 if (!strcasecmp(cbmaintype, "TEXT")) {
919 if (length) for (i=0; i<length; ++i) {
920 if (((char *)content)[i] == '\n') ++lines;
922 IAPrintf("%d ", lines);
925 /* More gratuitous complexity */
926 if ((!strcasecmp(cbmaintype, "MESSAGE"))
927 && (!strcasecmp(cbsubtype, "RFC822"))) {
928 /* FIXME: message/rfc822 also needs to output the envelope structure,
929 * body structure, and line count of the encapsulated message. Fortunately
930 * there are not yet any clients depending on this, so we can get away
931 * with not implementing it for now.
935 /* MD5 value of body part; we can get away with NIL'ing this */
942 else if (IsEmptyStr(disp)) {
947 plain_imap_strout(disp);
948 if (filename != NULL) if (!IsEmptyStr(filename)) {
949 IAPuts(" (\"FILENAME\" ");
950 plain_imap_strout(filename);
956 /* Body language (not defined yet) */
963 * Spew the BODYSTRUCTURE data for a message.
966 void imap_fetch_bodystructure (long msgnum, const char *item,
967 struct CtdlMessage *msg) {
968 const char *rfc822 = NULL;
969 const char *rfc822_body = NULL;
971 size_t rfc822_headers_len;
972 size_t rfc822_body_len;
973 const char *ptr = NULL;
978 /* Handle NULL message gracefully */
980 IAPuts("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
981 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
986 /* For non-RFC822 (ordinary Citadel) messages, this is short and
989 if (msg->cm_format_type != FMT_RFC822) {
991 /* *sigh* We have to RFC822-format the message just to be able
992 * to measure it. FIXME use smi cached fields if possible
995 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
996 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1, SUPPRESS_ENV_TO);
997 rfc822_len = StrLength(CC->redirect_buffer);
998 rfc822 = pch = SmashStrBuf(&CC->redirect_buffer);
1002 ptr = cmemreadline(ptr, buf, sizeof buf);
1004 if ((IsEmptyStr(buf)) && (rfc822_body == NULL)) {
1007 } while (*ptr != 0);
1009 rfc822_headers_len = rfc822_body - rfc822;
1010 rfc822_body_len = rfc822_len - rfc822_headers_len;
1013 IAPuts("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
1014 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
1016 IAPrintf(SIZE_T_FMT " %d)", rfc822_body_len, lines);
1021 /* For messages already stored in RFC822 format, we have to parse. */
1022 IAPuts("BODYSTRUCTURE ");
1023 mime_parser(msg->cm_fields['M'],
1025 *imap_fetch_bodystructure_part, /* part */
1026 *imap_fetch_bodystructure_pre, /* pre-multi */
1027 *imap_fetch_bodystructure_post, /* post-multi */
1029 1); /* don't decode -- we want it as-is */
1034 * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
1035 * individual message, once it has been selected for output.
1037 void imap_do_fetch_msg(int seq, citimap_command *Cmd) {
1039 citimap *Imap = IMAP;
1040 struct CtdlMessage *msg = NULL;
1041 int body_loaded = 0;
1043 /* Don't attempt to fetch bogus messages or UID's */
1044 if (seq < 1) return;
1045 if (Imap->msgids[seq-1] < 1L) return;
1048 IAPrintf("* %d FETCH (", seq);
1050 for (i=0; i<Cmd->num_parms; ++i) {
1052 /* Fetchable without going to the message store at all */
1053 if (!strcasecmp(Cmd->Params[i].Key, "UID")) {
1054 imap_fetch_uid(seq);
1056 else if (!strcasecmp(Cmd->Params[i].Key, "FLAGS")) {
1057 imap_fetch_flags(seq-1);
1060 /* Potentially fetchable from cache, if the client requests
1061 * stuff from the same message several times in a row.
1063 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822")) {
1064 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1066 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.HEADER")) {
1067 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1069 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.SIZE")) {
1070 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1072 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.TEXT")) {
1073 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1076 /* BODY fetches do their own fetching and caching too. */
1077 else if (!strncasecmp(Cmd->Params[i].Key, "BODY[", 5)) {
1078 imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i], 0);
1080 else if (!strncasecmp(Cmd->Params[i].Key, "BODY.PEEK[", 10)) {
1081 imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i], 1);
1084 /* Otherwise, load the message into memory.
1086 else if (!strcasecmp(Cmd->Params[i].Key, "BODYSTRUCTURE")) {
1087 if ((msg != NULL) && (!body_loaded)) {
1088 CtdlFreeMessage(msg); /* need the whole thing */
1092 msg = CtdlFetchMessage(Imap->msgids[seq-1], 1);
1095 imap_fetch_bodystructure(Imap->msgids[seq-1],
1096 Cmd->Params[i].Key, msg);
1098 else if (!strcasecmp(Cmd->Params[i].Key, "ENVELOPE")) {
1100 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0);
1103 imap_fetch_envelope(msg);
1105 else if (!strcasecmp(Cmd->Params[i].Key, "INTERNALDATE")) {
1107 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0);
1110 imap_fetch_internaldate(msg);
1113 if (i != Cmd->num_parms-1) IAPuts(" ");
1119 CtdlFreeMessage(msg);
1126 * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1127 * validated and boiled down the request a bit.
1129 void imap_do_fetch(citimap_command *Cmd) {
1130 citimap *Imap = IMAP;
1133 /* debug output the parsed vector */
1136 syslog(LOG_DEBUG, "----- %ld params", Cmd->num_parms);
1138 for (i=0; i < Cmd->num_parms; i++) {
1139 if (Cmd->Params[i].len != strlen(Cmd->Params[i].Key))
1140 syslog(LOG_DEBUG, "*********** %ld != %ld : %s",
1142 strlen(Cmd->Params[i].Key),
1143 Cmd->Params[i].Key);
1145 syslog(LOG_DEBUG, "%ld : %s",
1147 Cmd->Params[i].Key);
1152 if (Imap->num_msgs > 0) {
1153 for (i = 0; i < Imap->num_msgs; ++i) {
1155 /* Abort the fetch loop if the session breaks.
1156 * This is important for users who keep mailboxes
1157 * that are too big *and* are too impatient to
1158 * let them finish loading. :)
1160 if (CC->kill_me) return;
1162 /* Get any message marked for fetch. */
1163 if (Imap->flags[i] & IMAP_SELECTED) {
1164 imap_do_fetch_msg(i+1, Cmd);
1173 * Back end for imap_handle_macros()
1174 * Note that this function *only* looks at the beginning of the string. It
1175 * is not a generic search-and-replace function.
1177 void imap_macro_replace(StrBuf *Buf, long where,
1179 char *find, long findlen,
1180 char *replace, long replacelen)
1183 if (StrLength(Buf) - where > findlen)
1186 if (!strncasecmp(ChrPtr(Buf) + where, find, findlen)) {
1187 if (ChrPtr(Buf)[where + findlen] == ' ') {
1188 StrBufPlain(TmpBuf, replace, replacelen);
1189 StrBufAppendBufPlain(TmpBuf, HKEY(" "), 0);
1190 StrBufReplaceToken(Buf, where, findlen,
1193 if (where + findlen == StrLength(Buf)) {
1194 StrBufReplaceToken(Buf, where, findlen,
1195 replace, replacelen);
1203 * Handle macros embedded in FETCH data items.
1204 * (What the heck are macros doing in a wire protocol? Are we trying to save
1205 * the computer at the other end the trouble of typing a lot of characters?)
1207 void imap_handle_macros(citimap_command *Cmd) {
1210 StrBuf *Tmp = NewStrBuf();
1212 for (i=0; i < StrLength(Cmd->CmdBuf); ++i) {
1213 char ch = ChrPtr(Cmd->CmdBuf)[i];
1218 else if ((ch==')') ||
1224 imap_macro_replace(Cmd->CmdBuf, i,
1227 HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE")
1229 imap_macro_replace(Cmd->CmdBuf, i,
1232 HKEY("BODYSTRUCTURE")
1234 imap_macro_replace(Cmd->CmdBuf, i,
1237 HKEY("FLAGS INTERNALDATE RFC822.SIZE")
1239 imap_macro_replace(Cmd->CmdBuf, i,
1242 HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY")
1251 * Break out the data items requested, possibly a parenthesized list.
1252 * Returns the number of data items, or -1 if the list is invalid.
1253 * NOTE: this function alters the string it is fed, and uses it as a buffer
1254 * to hold the data for the pointers it returns.
1256 int imap_extract_data_items(citimap_command *Cmd)
1260 const char *pch, *end;
1262 /* Convert all whitespace to ordinary space characters. */
1263 pch = ChrPtr(Cmd->CmdBuf);
1264 end = pch + StrLength(Cmd->CmdBuf);
1269 StrBufPeek(Cmd->CmdBuf, pch, 0, ' ');
1273 /* Strip leading and trailing whitespace, then strip leading and
1274 * trailing parentheses if it's a list
1276 StrBufTrim(Cmd->CmdBuf);
1277 pch = ChrPtr(Cmd->CmdBuf);
1278 if ( (pch[0]=='(') &&
1279 (pch[StrLength(Cmd->CmdBuf)-1]==')') )
1281 StrBufCutRight(Cmd->CmdBuf, 1);
1282 StrBufCutLeft(Cmd->CmdBuf, 1);
1283 StrBufTrim(Cmd->CmdBuf);
1286 /* Parse any macro data items */
1287 imap_handle_macros(Cmd);
1290 * Now break out the data items. We throw in one trailing space in
1291 * order to avoid having to break out the last one manually.
1293 nArgs = StrLength(Cmd->CmdBuf) / 10 + 10;
1294 nArgs = CmdAdjust(Cmd, nArgs, 0);
1296 Cmd->Params[Cmd->num_parms].Key = pch = ChrPtr(Cmd->CmdBuf);
1297 end = Cmd->Params[Cmd->num_parms].Key + StrLength(Cmd->CmdBuf);
1307 else if ((*pch==')') ||
1313 if ((nest <= 0) && (*pch==' ')) {
1314 StrBufPeek(Cmd->CmdBuf, pch, 0, '\0');
1315 Cmd->Params[Cmd->num_parms].len =
1316 pch - Cmd->Params[Cmd->num_parms].Key;
1318 if (Cmd->num_parms + 1 >= Cmd->avail_parms) {
1319 nArgs = CmdAdjust(Cmd, nArgs * 2, 1);
1322 Cmd->Params[Cmd->num_parms].Key = ++pch;
1324 else if (pch + 1 == end) {
1325 Cmd->Params[Cmd->num_parms].len =
1326 pch - Cmd->Params[Cmd->num_parms].Key + 1;
1332 return Cmd->num_parms;
1338 * One particularly hideous aspect of IMAP is that we have to allow the client
1339 * to specify arbitrary ranges and/or sets of messages to fetch. Citadel IMAP
1340 * handles this by setting the IMAP_SELECTED flag for each message specified in
1341 * the ranges/sets, then looping through the message array, outputting messages
1342 * with the flag set. We don't bother returning an error if an out-of-range
1343 * number is specified (we just return quietly) because any client braindead
1344 * enough to request a bogus message number isn't going to notice the
1345 * difference anyway.
1347 * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1348 * message included in the specified range.
1350 * Set is_uid to 1 to fetch by UID instead of sequence number.
1352 void imap_pick_range(const char *supplied_range, int is_uid) {
1353 citimap *Imap = IMAP;
1357 char setstr[SIZ], lostr[SIZ], histr[SIZ];
1359 char actual_range[SIZ];
1362 * Handle the "ALL" macro
1364 if (!strcasecmp(supplied_range, "ALL")) {
1365 safestrncpy(actual_range, "1:*", sizeof actual_range);
1368 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1372 * Clear out the IMAP_SELECTED flags for all messages.
1374 for (i = 0; i < Imap->num_msgs; ++i) {
1375 Imap->flags[i] = Imap->flags[i] & ~IMAP_SELECTED;
1379 * Now set it for all specified messages.
1381 num_sets = num_tokens(actual_range, ',');
1382 for (s=0; s<num_sets; ++s) {
1383 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1385 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1386 if (num_tokens(setstr, ':') >= 2) {
1387 extract_token(histr, setstr, 1, ':', sizeof histr);
1388 if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1391 safestrncpy(histr, lostr, sizeof histr);
1396 /* Loop through the array, flipping bits where appropriate */
1397 for (i = 1; i <= Imap->num_msgs; ++i) {
1398 if (is_uid) { /* fetch by sequence number */
1399 if ( (Imap->msgids[i-1]>=lo)
1400 && (Imap->msgids[i-1]<=hi)) {
1401 Imap->flags[i-1] |= IMAP_SELECTED;
1404 else { /* fetch by uid */
1405 if ( (i>=lo) && (i<=hi)) {
1406 Imap->flags[i-1] |= IMAP_SELECTED;
1416 * This function is called by the main command loop.
1418 void imap_fetch(int num_parms, ConstStr *Params) {
1419 citimap_command Cmd;
1422 if (num_parms < 4) {
1423 IReply("BAD invalid parameters");
1427 imap_pick_range(Params[2].Key, 0);
1429 memset(&Cmd, 0, sizeof(citimap_command));
1430 Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1431 MakeStringOf(Cmd.CmdBuf, 3);
1433 num_items = imap_extract_data_items(&Cmd);
1434 if (num_items < 1) {
1435 IReply("BAD invalid data item list");
1436 FreeStrBuf(&Cmd.CmdBuf);
1441 imap_do_fetch(&Cmd);
1442 IReply("OK FETCH completed");
1443 FreeStrBuf(&Cmd.CmdBuf);
1448 * This function is called by the main command loop.
1450 void imap_uidfetch(int num_parms, ConstStr *Params) {
1451 citimap_command Cmd;
1454 int have_uid_item = 0;
1456 if (num_parms < 5) {
1457 IReply("BAD invalid parameters");
1461 imap_pick_range(Params[3].Key, 1);
1463 memset(&Cmd, 0, sizeof(citimap_command));
1464 Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1466 MakeStringOf(Cmd.CmdBuf, 4);
1468 syslog(LOG_DEBUG, "-------%s--------", ChrPtr(Cmd.CmdBuf));
1470 num_items = imap_extract_data_items(&Cmd);
1471 if (num_items < 1) {
1472 IReply("BAD invalid data item list");
1473 FreeStrBuf(&Cmd.CmdBuf);
1478 /* If the "UID" item was not included, we include it implicitly
1479 * (at the beginning) because this is a UID FETCH command
1481 for (i=0; i<num_items; ++i) {
1482 if (!strcasecmp(Cmd.Params[i].Key, "UID")) ++have_uid_item;
1484 if (have_uid_item == 0) {
1485 if (Cmd.num_parms + 1 >= Cmd.avail_parms)
1486 CmdAdjust(&Cmd, Cmd.avail_parms + 1, 1);
1487 memmove(&Cmd.Params[1],
1489 sizeof(ConstStr) * Cmd.num_parms);
1492 Cmd.Params[0] = (ConstStr){HKEY("UID")};
1495 imap_do_fetch(&Cmd);
1496 IReply("OK UID FETCH completed");
1497 FreeStrBuf(&Cmd.CmdBuf);