4 * Implements the FETCH command in IMAP.
5 * This is a good example of the protocol's gratuitous complexity.
7 * Copyright (c) 2001-2009 by the citadel.org team
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
33 #include <sys/types.h>
35 #if TIME_WITH_SYS_TIME
36 # include <sys/time.h>
40 # include <sys/time.h>
50 #include <libcitadel.h>
53 #include "sysdep_decls.h"
54 #include "citserver.h"
62 #include "internet_addressing.h"
63 #include "serv_imap.h"
64 #include "imap_tools.h"
65 #include "imap_fetch.h"
67 #include "ctdl_module.h"
72 * Individual field functions for imap_do_fetch_msg() ...
75 void imap_fetch_uid(int seq) {
76 cprintf("UID %ld", IMAP->msgids[seq-1]);
79 void imap_fetch_flags(int seq) {
80 int num_flags_printed = 0;
82 if (IMAP->flags[seq] & IMAP_DELETED) {
83 if (num_flags_printed > 0) cprintf(" ");
87 if (IMAP->flags[seq] & IMAP_SEEN) {
88 if (num_flags_printed > 0) cprintf(" ");
92 if (IMAP->flags[seq] & IMAP_ANSWERED) {
93 if (num_flags_printed > 0) cprintf(" ");
94 cprintf("\\Answered");
97 if (IMAP->flags[seq] & IMAP_RECENT) {
98 if (num_flags_printed > 0) cprintf(" ");
105 void imap_fetch_internaldate(struct CtdlMessage *msg) {
110 if (msg->cm_fields['T'] != NULL) {
111 msgdate = atol(msg->cm_fields['T']);
114 msgdate = time(NULL);
117 datestring(buf, sizeof buf, msgdate, DATESTRING_IMAP);
118 cprintf("INTERNALDATE \"%s\"", buf);
123 * Fetch RFC822-formatted messages.
125 * 'whichfmt' should be set to one of:
126 * "RFC822" entire message
127 * "RFC822.HEADER" headers only (with trailing blank line)
128 * "RFC822.SIZE" size of translated message
129 * "RFC822.TEXT" body only (without leading blank line)
131 void imap_fetch_rfc822(long msgnum, char *whichfmt) {
134 size_t headers_size, text_size, total_size;
135 size_t bytes_to_send = 0;
137 int need_to_rewrite_metadata = 0;
140 /* Determine whether this particular fetch operation requires
141 * us to fetch the message body from disk. If not, we can save
142 * on some disk operations...
144 if ( (!strcasecmp(whichfmt, "RFC822"))
145 || (!strcasecmp(whichfmt, "RFC822.TEXT")) ) {
149 /* If this is an RFC822.SIZE fetch, first look in the message's
150 * metadata record to see if we've saved that information.
152 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
153 GetMetaData(&smi, msgnum);
154 if (smi.meta_rfc822_length > 0L) {
155 cprintf("RFC822.SIZE %ld", smi.meta_rfc822_length);
158 need_to_rewrite_metadata = 1;
162 /* Cache the most recent RFC822 FETCH because some clients like to
163 * fetch in pieces, and we don't want to have to go back to the
164 * message store for each piece. We also burn the cache if the
165 * client requests something that involves reading the message
166 * body, but we haven't fetched the body yet.
168 if ((IMAP->cached_rfc822_data != NULL)
169 && (IMAP->cached_rfc822_msgnum == msgnum)
170 && (IMAP->cached_rfc822_withbody || (!need_body)) ) {
173 else if (IMAP->cached_rfc822_data != NULL) {
174 /* Some other message is cached -- free it */
175 free(IMAP->cached_rfc822_data);
176 IMAP->cached_rfc822_data = NULL;
177 IMAP->cached_rfc822_msgnum = (-1);
178 IMAP->cached_rfc822_len = 0;
181 /* At this point, we now can fetch and convert the message iff it's not
182 * the one we had cached.
184 if (IMAP->cached_rfc822_data == NULL) {
186 * Load the message into memory for translation & measurement
188 CC->redirect_buffer = malloc(SIZ);
189 CC->redirect_len = 0;
190 CC->redirect_alloc = SIZ;
191 CtdlOutputMsg(msgnum, MT_RFC822,
192 (need_body ? HEADERS_ALL : HEADERS_FAST),
193 0, 1, NULL, SUPPRESS_ENV_TO
195 if (!need_body) cprintf("\r\n"); /* extra trailing newline */
196 IMAP->cached_rfc822_data = CC->redirect_buffer;
197 IMAP->cached_rfc822_len = CC->redirect_len;
198 IMAP->cached_rfc822_msgnum = msgnum;
199 IMAP->cached_rfc822_withbody = need_body;
200 CC->redirect_buffer = NULL;
201 CC->redirect_len = 0;
202 CC->redirect_alloc = 0;
203 if ( (need_to_rewrite_metadata) && (IMAP->cached_rfc822_len > 0) ) {
204 smi.meta_rfc822_length = (long)IMAP->cached_rfc822_len;
210 * Now figure out where the headers/text break is. IMAP considers the
211 * intervening blank line to be part of the headers, not the text.
218 ptr = IMAP->cached_rfc822_data;
220 ptr = memreadline(ptr, buf, sizeof buf);
223 if (IsEmptyStr(buf)) {
224 headers_size = ptr - IMAP->cached_rfc822_data;
227 } while ( (headers_size == 0) && (*ptr != 0) );
229 total_size = IMAP->cached_rfc822_len;
230 text_size = total_size - headers_size;
233 headers_size = IMAP->cached_rfc822_len;
234 total_size = IMAP->cached_rfc822_len;
238 CtdlLogPrintf(CTDL_DEBUG,
239 "RFC822: headers=" SIZE_T_FMT
241 ", total=" SIZE_T_FMT "\n",
242 headers_size, text_size, total_size);
244 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
245 cprintf("RFC822.SIZE " SIZE_T_FMT, total_size);
249 else if (!strcasecmp(whichfmt, "RFC822")) {
250 ptr = IMAP->cached_rfc822_data;
251 bytes_to_send = total_size;
254 else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
255 ptr = IMAP->cached_rfc822_data;
256 bytes_to_send = headers_size;
259 else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
260 ptr = &IMAP->cached_rfc822_data[headers_size];
261 bytes_to_send = text_size;
264 cprintf("%s {" SIZE_T_FMT "}\r\n", whichfmt, bytes_to_send);
265 client_write(ptr, bytes_to_send);
271 * Load a specific part of a message into the temp file to be output to a
272 * client. FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
273 * but we still can't handle "2.HEADER" (which might not be a problem).
275 * Note: mime_parser() was called with dont_decode set to 1, so we have the
276 * luxury of simply spewing without having to re-encode.
278 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
279 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
280 char *cbid, void *cbuserdata)
283 char *desired_section;
285 desired_section = (char *)cbuserdata;
287 if (!strcasecmp(partnum, desired_section)) {
288 client_write(content, length);
291 snprintf(mbuf2, sizeof mbuf2, "%s.MIME", partnum);
293 if (!strcasecmp(desired_section, mbuf2)) {
294 cprintf("Content-type: %s", cbtype);
295 if (!IsEmptyStr(cbcharset))
296 cprintf("; charset=\"%s\"", cbcharset);
297 if (!IsEmptyStr(name))
298 cprintf("; name=\"%s\"", name);
300 if (!IsEmptyStr(encoding))
301 cprintf("Content-Transfer-Encoding: %s\r\n", encoding);
302 if (!IsEmptyStr(encoding)) {
303 cprintf("Content-Disposition: %s", disp);
304 if (!IsEmptyStr(filename)) {
305 cprintf("; filename=\"%s\"", filename);
309 cprintf("Content-Length: %ld\r\n", (long)length);
318 * Called by imap_fetch_envelope() to output the "From" field.
319 * This is in its own function because its logic is kind of complex. We
320 * really need to make this suck less.
322 void imap_output_envelope_from(struct CtdlMessage *msg) {
323 char user[SIZ], node[SIZ], name[SIZ];
327 /* For anonymous messages, it's so easy! */
328 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONONLY)) {
329 cprintf("((\"----\" NIL \"x\" \"x.org\")) ");
332 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONOPT)) {
333 cprintf("((\"anonymous\" NIL \"x\" \"x.org\")) ");
337 /* For everything else, we do stuff. */
338 cprintf("(("); /* open double-parens */
339 imap_strout(msg->cm_fields['A']); /* personal name */
340 cprintf(" NIL "); /* source route (not used) */
343 if (msg->cm_fields['F'] != NULL) {
344 process_rfc822_addr(msg->cm_fields['F'], user, node, name);
345 imap_strout(user); /* mailbox name (user id) */
347 if (!strcasecmp(node, config.c_nodename)) {
348 imap_strout(config.c_fqdn);
351 imap_strout(node); /* host name */
355 imap_strout(msg->cm_fields['A']); /* mailbox name (user id) */
357 imap_strout(msg->cm_fields['N']); /* host name */
360 cprintf(")) "); /* close double-parens */
366 * Output an envelope address (or set of addresses) in the official,
367 * convoluted, braindead format. (Note that we can't use this for
368 * the "From" address because its data may come from a number of different
369 * fields. But we can use it for "To" and possibly others.
371 void imap_output_envelope_addr(char *addr) {
372 char individual_addr[256];
384 if (IsEmptyStr(addr)) {
391 /* How many addresses are listed here? */
392 num_addrs = num_tokens(addr, ',');
394 /* Output them one by one. */
395 for (i=0; i<num_addrs; ++i) {
396 extract_token(individual_addr, addr, i, ',', sizeof individual_addr);
397 striplt(individual_addr);
398 process_rfc822_addr(individual_addr, user, node, name);
406 if (i < (num_addrs-1)) cprintf(" ");
414 * Implements the ENVELOPE fetch item
416 * Note that the imap_strout() function can cleverly output NULL fields as NIL,
417 * so we don't have to check for that condition like we do elsewhere.
419 void imap_fetch_envelope(struct CtdlMessage *msg) {
420 char datestringbuf[SIZ];
422 char *fieldptr = NULL;
426 /* Parse the message date into an IMAP-format date string */
427 if (msg->cm_fields['T'] != NULL) {
428 msgdate = atol(msg->cm_fields['T']);
431 msgdate = time(NULL);
433 datestring(datestringbuf, sizeof datestringbuf,
434 msgdate, DATESTRING_IMAP);
436 /* Now start spewing data fields. The order is important, as it is
437 * defined by the protocol specification. Nonexistent fields must
438 * be output as NIL, existent fields must be quoted or literalled.
439 * The imap_strout() function conveniently does all this for us.
441 cprintf("ENVELOPE (");
444 imap_strout(datestringbuf);
448 imap_strout(msg->cm_fields['U']);
452 imap_output_envelope_from(msg);
454 /* Sender (default to same as 'From' if not present) */
455 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Sender");
456 if (fieldptr != NULL) {
457 imap_output_envelope_addr(fieldptr);
461 imap_output_envelope_from(msg);
465 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Reply-to");
466 if (fieldptr != NULL) {
467 imap_output_envelope_addr(fieldptr);
471 imap_output_envelope_from(msg);
475 imap_output_envelope_addr(msg->cm_fields['R']);
477 /* Cc (we do it this way because there might be a legacy non-Citadel Cc: field present) */
478 fieldptr = msg->cm_fields['Y'];
479 if (fieldptr != NULL) {
480 imap_output_envelope_addr(fieldptr);
483 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Cc");
484 imap_output_envelope_addr(fieldptr);
485 if (fieldptr != NULL) free(fieldptr);
489 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Bcc");
490 imap_output_envelope_addr(fieldptr);
491 if (fieldptr != NULL) free(fieldptr);
494 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "In-reply-to");
495 imap_strout(fieldptr);
497 if (fieldptr != NULL) free(fieldptr);
500 imap_strout(msg->cm_fields['I']);
506 * This function is called only when CC->redirect_buffer contains a set of
507 * RFC822 headers with no body attached. Its job is to strip that set of
508 * headers down to *only* the ones we're interested in.
510 void imap_strip_headers(char *section) {
512 char *which_fields = NULL;
513 int doing_headers = 0;
518 char *boiled_headers = NULL;
520 int done_headers = 0;
523 if (CC->redirect_buffer == NULL) return;
525 which_fields = strdup(section);
527 if (!strncasecmp(which_fields, "HEADER.FIELDS", 13))
529 if (!strncasecmp(which_fields, "HEADER.FIELDS.NOT", 17))
532 for (i=0; which_fields[i]; ++i) {
533 if (which_fields[i]=='(')
534 strcpy(which_fields, &which_fields[i+1]);
536 for (i=0; which_fields[i]; ++i) {
537 if (which_fields[i]==')') {
542 num_parms = imap_parameterize(parms, which_fields);
544 boiled_headers = malloc(CC->redirect_alloc);
545 strcpy(boiled_headers, "");
547 ptr = CC->redirect_buffer;
550 ptr = memreadline(ptr, buf, sizeof buf);
551 if (!isspace(buf[0])) {
553 if (doing_headers == 0) ok = 1;
555 if (headers_not) ok = 1;
557 for (i=0; i<num_parms; ++i) {
558 if ( (!strncasecmp(buf, parms[i],
559 strlen(parms[i]))) &&
560 (buf[strlen(parms[i])]==':') ) {
561 if (headers_not) ok = 0;
569 strcat(boiled_headers, buf);
570 strcat(boiled_headers, "\r\n");
573 if (IsEmptyStr(buf)) done_headers = 1;
574 if (buf[0]=='\r') done_headers = 1;
575 if (buf[0]=='\n') done_headers = 1;
576 if (*ptr == 0) done_headers = 1;
577 } while (!done_headers);
579 strcat(boiled_headers, "\r\n");
581 /* Now save it back (it'll always be smaller) */
582 strcpy(CC->redirect_buffer, boiled_headers);
583 CC->redirect_len = strlen(boiled_headers);
586 free(boiled_headers);
591 * Implements the BODY and BODY.PEEK fetch items
593 void imap_fetch_body(long msgnum, char *item, int is_peek) {
594 struct CtdlMessage *msg = NULL;
598 size_t pstart, pbytes;
599 int loading_body_now = 0;
601 int burn_the_cache = 0;
603 /* extract section */
604 safestrncpy(section, item, sizeof section);
605 if (strchr(section, '[') != NULL) {
606 stripallbut(section, '[', ']');
608 CtdlLogPrintf(CTDL_DEBUG, "Section is: %s%s\n",
610 IsEmptyStr(section) ? "(empty)" : "");
612 /* Burn the cache if we don't have the same section of the
613 * same message again.
615 if (IMAP->cached_body != NULL) {
616 if (IMAP->cached_bodymsgnum != msgnum) {
619 else if ( (!IMAP->cached_body_withbody) && (need_body) ) {
622 else if (strcasecmp(IMAP->cached_bodypart, section)) {
625 if (burn_the_cache) {
626 /* Yup, go ahead and burn the cache. */
627 free(IMAP->cached_body);
628 IMAP->cached_body_len = 0;
629 IMAP->cached_body = NULL;
630 IMAP->cached_bodymsgnum = (-1);
631 strcpy(IMAP->cached_bodypart, "");
635 /* extract partial */
636 safestrncpy(partial, item, sizeof partial);
637 if (strchr(partial, '<') != NULL) {
638 stripallbut(partial, '<', '>');
641 if (is_partial == 0) strcpy(partial, "");
642 /* if (!IsEmptyStr(partial)) CtdlLogPrintf(CTDL_DEBUG, "Partial is %s\n", partial); */
644 if (IMAP->cached_body == NULL) {
645 CC->redirect_buffer = malloc(SIZ);
646 CC->redirect_len = 0;
647 CC->redirect_alloc = SIZ;
648 loading_body_now = 1;
649 msg = CtdlFetchMessage(msgnum, (need_body ? 1 : 0));
652 /* Now figure out what the client wants, and get it */
654 if (!loading_body_now) {
655 /* What we want is already in memory */
658 else if ( (!strcmp(section, "1")) && (msg->cm_format_type != 4) ) {
659 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
662 else if (!strcmp(section, "")) {
663 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, SUPPRESS_ENV_TO);
667 * If the client asked for just headers, or just particular header
668 * fields, strip it down.
670 else if (!strncasecmp(section, "HEADER", 6)) {
671 /* This used to work with HEADERS_FAST, but then Apple got stupid with their
672 * IMAP library and this broke Mail.App and iPhone Mail, so we had to change it
673 * to HEADERS_ONLY so the trendy hipsters with their iPhones can read mail.
675 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, SUPPRESS_ENV_TO);
676 imap_strip_headers(section);
680 * Strip it down if the client asked for everything _except_ headers.
682 else if (!strncasecmp(section, "TEXT", 4)) {
683 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
687 * Anything else must be a part specifier.
688 * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
691 mime_parser(msg->cm_fields['M'], NULL,
692 *imap_load_part, NULL, NULL,
697 if (loading_body_now) {
698 IMAP->cached_body = CC->redirect_buffer;
699 IMAP->cached_body_len = CC->redirect_len;
700 IMAP->cached_bodymsgnum = msgnum;
701 IMAP->cached_body_withbody = need_body;
702 strcpy(IMAP->cached_bodypart, section);
703 CC->redirect_buffer = NULL;
704 CC->redirect_len = 0;
705 CC->redirect_alloc = 0;
708 if (is_partial == 0) {
709 cprintf("BODY[%s] {" SIZE_T_FMT "}\r\n", section, IMAP->cached_body_len);
711 pbytes = IMAP->cached_body_len;
714 sscanf(partial, SIZE_T_FMT "." SIZE_T_FMT, &pstart, &pbytes);
715 if (pbytes > (IMAP->cached_body_len - pstart)) {
716 pbytes = IMAP->cached_body_len - pstart;
718 cprintf("BODY[%s]<" SIZE_T_FMT "> {" SIZE_T_FMT "}\r\n", section, pstart, pbytes);
721 /* Here we go -- output it */
722 client_write(&IMAP->cached_body[pstart], pbytes);
725 CtdlFreeMessage(msg);
728 /* Mark this message as "seen" *unless* this is a "peek" operation */
730 CtdlSetSeen(&msgnum, 1, 1, ctdlsetseen_seen, NULL, NULL);
735 * Called immediately before outputting a multipart bodystructure
737 void imap_fetch_bodystructure_pre(
738 char *name, char *filename, char *partnum, char *disp,
739 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
740 char *cbid, void *cbuserdata
749 * Called immediately after outputting a multipart bodystructure
751 void imap_fetch_bodystructure_post(
752 char *name, char *filename, char *partnum, char *disp,
753 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
754 char *cbid, void *cbuserdata
762 extract_token(subtype, cbtype, 1, '/', sizeof subtype);
763 imap_strout(subtype);
766 /* cprintf(" NIL"); We thought we needed this at one point, but maybe we don't... */
774 * Output the info for a MIME part in the format required by BODYSTRUCTURE.
777 void imap_fetch_bodystructure_part(
778 char *name, char *filename, char *partnum, char *disp,
779 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
780 char *cbid, void *cbuserdata
784 int have_encoding = 0;
787 char cbmaintype[128];
790 if (cbtype != NULL) if (!IsEmptyStr(cbtype)) have_cbtype = 1;
792 extract_token(cbmaintype, cbtype, 0, '/', sizeof cbmaintype);
793 extract_token(cbsubtype, cbtype, 1, '/', sizeof cbsubtype);
796 strcpy(cbmaintype, "TEXT");
797 strcpy(cbsubtype, "PLAIN");
801 imap_strout(cbmaintype); /* body type */
803 imap_strout(cbsubtype); /* body subtype */
806 cprintf("("); /* begin body parameter list */
808 /* "NAME" must appear as the first parameter. This is not required by IMAP,
809 * but the Asterisk voicemail application blindly assumes that NAME will be in
810 * the first position. If it isn't, it rejects the message.
812 if (name != NULL) if (!IsEmptyStr(name)) {
813 cprintf("\"NAME\" ");
818 cprintf("\"CHARSET\" ");
819 if (cbcharset == NULL) {
820 imap_strout("US-ASCII");
822 else if (cbcharset[0] == 0) {
823 imap_strout("US-ASCII");
826 imap_strout(cbcharset);
828 cprintf(") "); /* end body parameter list */
830 cprintf("NIL "); /* Body ID */
831 cprintf("NIL "); /* Body description */
833 if (encoding != NULL) if (encoding[0] != 0) have_encoding = 1;
835 imap_strout(encoding);
842 /* The next field is the size of the part in bytes. */
843 cprintf("%ld ", (long)length); /* bytes */
845 /* The next field is the number of lines in the part, if and only
846 * if the part is TEXT. More gratuitous complexity.
848 if (!strcasecmp(cbmaintype, "TEXT")) {
849 if (length) for (i=0; i<length; ++i) {
850 if (((char *)content)[i] == '\n') ++lines;
852 cprintf("%d ", lines);
855 /* More gratuitous complexity */
856 if ((!strcasecmp(cbmaintype, "MESSAGE"))
857 && (!strcasecmp(cbsubtype, "RFC822"))) {
858 /* FIXME: message/rfc822 also needs to output the envelope structure,
859 * body structure, and line count of the encapsulated message. Fortunately
860 * there are not yet any clients depending on this, so we can get away
861 * with not implementing it for now.
865 /* MD5 value of body part; we can get away with NIL'ing this */
872 else if (IsEmptyStr(disp)) {
878 if (filename != NULL) if (!IsEmptyStr(filename)) {
879 cprintf(" (\"FILENAME\" ");
880 imap_strout(filename);
886 /* Body language (not defined yet) */
893 * Spew the BODYSTRUCTURE data for a message.
896 void imap_fetch_bodystructure (long msgnum, char *item,
897 struct CtdlMessage *msg) {
899 char *rfc822_body = NULL;
901 size_t rfc822_headers_len;
902 size_t rfc822_body_len;
907 /* Handle NULL message gracefully */
909 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
910 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
915 /* For non-RFC822 (ordinary Citadel) messages, this is short and
918 if (msg->cm_format_type != FMT_RFC822) {
920 /* *sigh* We have to RFC822-format the message just to be able
921 * to measure it. FIXME use smi cached fields if possible
924 CC->redirect_buffer = malloc(SIZ);
925 CC->redirect_len = 0;
926 CC->redirect_alloc = SIZ;
927 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1, SUPPRESS_ENV_TO);
928 rfc822 = CC->redirect_buffer;
929 rfc822_len = CC->redirect_len;
930 CC->redirect_buffer = NULL;
931 CC->redirect_len = 0;
932 CC->redirect_alloc = 0;
936 ptr = memreadline(ptr, buf, sizeof buf);
938 if ((IsEmptyStr(buf)) && (rfc822_body == NULL)) {
943 rfc822_headers_len = rfc822_body - rfc822;
944 rfc822_body_len = rfc822_len - rfc822_headers_len;
947 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
948 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
949 "\"7BIT\" " SIZE_T_FMT " %d)", rfc822_body_len, lines);
954 /* For messages already stored in RFC822 format, we have to parse. */
955 cprintf("BODYSTRUCTURE ");
956 mime_parser(msg->cm_fields['M'],
958 *imap_fetch_bodystructure_part, /* part */
959 *imap_fetch_bodystructure_pre, /* pre-multi */
960 *imap_fetch_bodystructure_post, /* post-multi */
962 1); /* don't decode -- we want it as-is */
967 * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
968 * individual message, once it has been selected for output.
970 void imap_do_fetch_msg(int seq, int num_items, char **itemlist) {
972 struct CtdlMessage *msg = NULL;
975 /* Don't attempt to fetch bogus messages or UID's */
977 if (IMAP->msgids[seq-1] < 1L) return;
980 cprintf("* %d FETCH (", seq);
982 for (i=0; i<num_items; ++i) {
984 /* Fetchable without going to the message store at all */
985 if (!strcasecmp(itemlist[i], "UID")) {
988 else if (!strcasecmp(itemlist[i], "FLAGS")) {
989 imap_fetch_flags(seq-1);
992 /* Potentially fetchable from cache, if the client requests
993 * stuff from the same message several times in a row.
995 else if (!strcasecmp(itemlist[i], "RFC822")) {
996 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
998 else if (!strcasecmp(itemlist[i], "RFC822.HEADER")) {
999 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
1001 else if (!strcasecmp(itemlist[i], "RFC822.SIZE")) {
1002 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
1004 else if (!strcasecmp(itemlist[i], "RFC822.TEXT")) {
1005 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
1008 /* BODY fetches do their own fetching and caching too. */
1009 else if (!strncasecmp(itemlist[i], "BODY[", 5)) {
1010 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i], 0);
1012 else if (!strncasecmp(itemlist[i], "BODY.PEEK[", 10)) {
1013 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i], 1);
1016 /* Otherwise, load the message into memory.
1018 else if (!strcasecmp(itemlist[i], "BODYSTRUCTURE")) {
1019 if ((msg != NULL) && (!body_loaded)) {
1020 CtdlFreeMessage(msg); /* need the whole thing */
1024 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 1);
1027 imap_fetch_bodystructure(IMAP->msgids[seq-1],
1030 else if (!strcasecmp(itemlist[i], "ENVELOPE")) {
1032 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 0);
1035 imap_fetch_envelope(msg);
1037 else if (!strcasecmp(itemlist[i], "INTERNALDATE")) {
1039 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 0);
1042 imap_fetch_internaldate(msg);
1045 if (i != num_items-1) cprintf(" ");
1051 CtdlFreeMessage(msg);
1058 * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1059 * validated and boiled down the request a bit.
1061 void imap_do_fetch(int num_items, char **itemlist) {
1064 if (IMAP->num_msgs > 0) {
1065 for (i = 0; i < IMAP->num_msgs; ++i) {
1067 /* Abort the fetch loop if the session breaks.
1068 * This is important for users who keep mailboxes
1069 * that are too big *and* are too impatient to
1070 * let them finish loading. :)
1072 if (CC->kill_me) return;
1074 /* Get any message marked for fetch. */
1075 if (IMAP->flags[i] & IMAP_SELECTED) {
1076 imap_do_fetch_msg(i+1, num_items, itemlist);
1085 * Back end for imap_handle_macros()
1086 * Note that this function *only* looks at the beginning of the string. It
1087 * is not a generic search-and-replace function.
1089 void imap_macro_replace(char *str, char *find, char *replace) {
1093 findlen = strlen(find);
1095 if (!strncasecmp(str, find, findlen)) {
1096 if (str[findlen]==' ') {
1097 strcpy(holdbuf, &str[findlen+1]);
1098 strcpy(str, replace);
1100 strcat(str, holdbuf);
1102 if (str[findlen]==0) {
1103 strcpy(holdbuf, &str[findlen+1]);
1104 strcpy(str, replace);
1112 * Handle macros embedded in FETCH data items.
1113 * (What the heck are macros doing in a wire protocol? Are we trying to save
1114 * the computer at the other end the trouble of typing a lot of characters?)
1116 void imap_handle_macros(char *str) {
1120 for (i=0; str[i]; ++i) {
1121 if (str[i]=='(') ++nest;
1122 if (str[i]=='[') ++nest;
1123 if (str[i]=='<') ++nest;
1124 if (str[i]=='{') ++nest;
1125 if (str[i]==')') --nest;
1126 if (str[i]==']') --nest;
1127 if (str[i]=='>') --nest;
1128 if (str[i]=='}') --nest;
1131 imap_macro_replace(&str[i],
1133 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE"
1135 imap_macro_replace(&str[i],
1139 imap_macro_replace(&str[i],
1141 "FLAGS INTERNALDATE RFC822.SIZE"
1143 imap_macro_replace(&str[i],
1145 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY"
1153 * Break out the data items requested, possibly a parenthesized list.
1154 * Returns the number of data items, or -1 if the list is invalid.
1155 * NOTE: this function alters the string it is fed, and uses it as a buffer
1156 * to hold the data for the pointers it returns.
1158 int imap_extract_data_items(char **argv, char *items) {
1165 /* Convert all whitespace to ordinary space characters. */
1166 for (i=0; items[i]; ++i) {
1167 if (isspace(items[i])) items[i]=' ';
1170 /* Strip leading and trailing whitespace, then strip leading and
1171 * trailing parentheses if it's a list
1174 if ( (items[0]=='(') && (items[strlen(items)-1]==')') ) {
1175 items[strlen(items)-1] = 0;
1176 strcpy(items, &items[1]);
1180 /* Parse any macro data items */
1181 imap_handle_macros(items);
1184 * Now break out the data items. We throw in one trailing space in
1185 * order to avoid having to break out the last one manually.
1189 initial_len = strlen(items);
1190 for (i=0; i<initial_len; ++i) {
1191 if (items[i]=='(') ++nest;
1192 if (items[i]=='[') ++nest;
1193 if (items[i]=='<') ++nest;
1194 if (items[i]=='{') ++nest;
1195 if (items[i]==')') --nest;
1196 if (items[i]==']') --nest;
1197 if (items[i]=='>') --nest;
1198 if (items[i]=='}') --nest;
1200 if (nest <= 0) if (items[i]==' ') {
1202 argv[num_items++] = start;
1203 start = &items[i+1];
1213 * One particularly hideous aspect of IMAP is that we have to allow the client
1214 * to specify arbitrary ranges and/or sets of messages to fetch. Citadel IMAP
1215 * handles this by setting the IMAP_SELECTED flag for each message specified in
1216 * the ranges/sets, then looping through the message array, outputting messages
1217 * with the flag set. We don't bother returning an error if an out-of-range
1218 * number is specified (we just return quietly) because any client braindead
1219 * enough to request a bogus message number isn't going to notice the
1220 * difference anyway.
1222 * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1223 * message included in the specified range.
1225 * Set is_uid to 1 to fetch by UID instead of sequence number.
1227 void imap_pick_range(char *supplied_range, int is_uid) {
1231 char setstr[SIZ], lostr[SIZ], histr[SIZ];
1233 char actual_range[SIZ];
1234 struct citimap *Imap;
1237 * Handle the "ALL" macro
1239 if (!strcasecmp(supplied_range, "ALL")) {
1240 safestrncpy(actual_range, "1:*", sizeof actual_range);
1243 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1248 * Clear out the IMAP_SELECTED flags for all messages.
1250 for (i = 0; i < Imap->num_msgs; ++i) {
1251 Imap->flags[i] = Imap->flags[i] & ~IMAP_SELECTED;
1255 * Now set it for all specified messages.
1257 num_sets = num_tokens(actual_range, ',');
1258 for (s=0; s<num_sets; ++s) {
1259 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1261 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1262 if (num_tokens(setstr, ':') >= 2) {
1263 extract_token(histr, setstr, 1, ':', sizeof histr);
1264 if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1267 safestrncpy(histr, lostr, sizeof histr);
1272 /* Loop through the array, flipping bits where appropriate */
1273 for (i = 1; i <= Imap->num_msgs; ++i) {
1274 if (is_uid) { /* fetch by sequence number */
1275 if ( (Imap->msgids[i-1]>=lo)
1276 && (Imap->msgids[i-1]<=hi)) {
1277 Imap->flags[i-1] |= IMAP_SELECTED;
1280 else { /* fetch by uid */
1281 if ( (i>=lo) && (i<=hi)) {
1282 Imap->flags[i-1] |= IMAP_SELECTED;
1293 * This function is called by the main command loop.
1295 void imap_fetch(int num_parms, char *parms[]) {
1297 char *itemlist[512];
1301 if (num_parms < 4) {
1302 cprintf("%s BAD invalid parameters\r\n", parms[0]);
1306 imap_pick_range(parms[2], 0);
1309 for (i=3; i<num_parms; ++i) {
1310 strcat(items, parms[i]);
1311 if (i < (num_parms-1)) strcat(items, " ");
1314 num_items = imap_extract_data_items(itemlist, items);
1315 if (num_items < 1) {
1316 cprintf("%s BAD invalid data item list\r\n", parms[0]);
1320 imap_do_fetch(num_items, itemlist);
1321 cprintf("%s OK FETCH completed\r\n", parms[0]);
1325 * This function is called by the main command loop.
1327 void imap_uidfetch(int num_parms, char *parms[]) {
1329 char *itemlist[512];
1332 int have_uid_item = 0;
1334 if (num_parms < 5) {
1335 cprintf("%s BAD invalid parameters\r\n", parms[0]);
1339 imap_pick_range(parms[3], 1);
1342 for (i=4; i<num_parms; ++i) {
1343 strcat(items, parms[i]);
1344 if (i < (num_parms-1)) strcat(items, " ");
1347 num_items = imap_extract_data_items(itemlist, items);
1348 if (num_items < 1) {
1349 cprintf("%s BAD invalid data item list\r\n", parms[0]);
1353 /* If the "UID" item was not included, we include it implicitly
1354 * (at the beginning) because this is a UID FETCH command
1356 for (i=0; i<num_items; ++i) {
1357 if (!strcasecmp(itemlist[i], "UID")) ++have_uid_item;
1359 if (have_uid_item == 0) {
1360 memmove(&itemlist[1], &itemlist[0], (sizeof(itemlist[0]) * num_items));
1362 itemlist[0] = "UID";
1365 imap_do_fetch(num_items, itemlist);
1366 cprintf("%s OK UID FETCH completed\r\n", parms[0]);