4 * Implements the FETCH command in IMAP.
5 * This is a good example of the protocol's gratuitous complexity.
18 #include <sys/types.h>
20 #if TIME_WITH_SYS_TIME
21 # include <sys/time.h>
25 # include <sys/time.h>
37 #include "sysdep_decls.h"
38 #include "citserver.h"
47 #include "internet_addressing.h"
48 #include "mime_parser.h"
49 #include "serv_imap.h"
50 #include "imap_tools.h"
51 #include "imap_fetch.h"
57 * Individual field functions for imap_do_fetch_msg() ...
60 void imap_fetch_uid(int seq) {
61 cprintf("UID %ld", IMAP->msgids[seq-1]);
64 void imap_fetch_flags(int seq) {
65 int num_flags_printed = 0;
67 if (IMAP->flags[seq] & IMAP_DELETED) {
68 if (num_flags_printed > 0) cprintf(" ");
72 if (IMAP->flags[seq] & IMAP_SEEN) {
73 if (num_flags_printed > 0) cprintf(" ");
77 if (IMAP->flags[seq] & IMAP_ANSWERED) {
78 if (num_flags_printed > 0) cprintf(" ");
79 cprintf("\\Answered");
82 if (IMAP->flags[seq] & IMAP_RECENT) {
83 if (num_flags_printed > 0) cprintf(" ");
90 void imap_fetch_internaldate(struct CtdlMessage *msg) {
95 if (msg->cm_fields['T'] != NULL) {
96 msgdate = atol(msg->cm_fields['T']);
102 datestring(buf, sizeof buf, msgdate, DATESTRING_IMAP);
103 cprintf("INTERNALDATE \"%s\"", buf);
108 * Fetch RFC822-formatted messages.
110 * 'whichfmt' should be set to one of:
111 * "RFC822" entire message
112 * "RFC822.HEADER" headers only (with trailing blank line)
113 * "RFC822.SIZE" size of translated message
114 * "RFC822.TEXT" body only (without leading blank line)
116 void imap_fetch_rfc822(long msgnum, char *whichfmt) {
119 size_t headers_size, text_size, total_size;
120 size_t bytes_to_send = 0;
122 int need_to_rewrite_metadata = 0;
125 /* Determine whether this particular fetch operation requires
126 * us to fetch the message body from disk. If not, we can save
127 * on some disk operations...
129 if ( (!strcasecmp(whichfmt, "RFC822"))
130 || (!strcasecmp(whichfmt, "RFC822.TEXT")) ) {
134 /* If this is an RFC822.SIZE fetch, first look in the message's
135 * metadata record to see if we've saved that information.
137 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
138 GetMetaData(&smi, msgnum);
139 if (smi.meta_rfc822_length > 0L) {
140 cprintf("RFC822.SIZE %ld", smi.meta_rfc822_length);
143 need_to_rewrite_metadata = 1;
147 /* Cache the most recent RFC822 FETCH because some clients like to
148 * fetch in pieces, and we don't want to have to go back to the
149 * message store for each piece. We also burn the cache if the
150 * client requests something that involves reading the message
151 * body, but we haven't fetched the body yet.
153 if ((IMAP->cached_rfc822_data != NULL)
154 && (IMAP->cached_rfc822_msgnum == msgnum)
155 && (IMAP->cached_rfc822_withbody || (!need_body)) ) {
158 else if (IMAP->cached_rfc822_data != NULL) {
159 /* Some other message is cached -- free it */
160 free(IMAP->cached_rfc822_data);
161 IMAP->cached_rfc822_data = NULL;
162 IMAP->cached_rfc822_msgnum = (-1);
163 IMAP->cached_rfc822_len = 0;
166 /* At this point, we now can fetch and convert the message iff it's not
167 * the one we had cached.
169 if (IMAP->cached_rfc822_data == NULL) {
171 * Load the message into memory for translation & measurement
173 CC->redirect_buffer = malloc(SIZ);
174 CC->redirect_len = 0;
175 CC->redirect_alloc = SIZ;
176 CtdlOutputMsg(msgnum, MT_RFC822,
177 (need_body ? HEADERS_ALL : HEADERS_ONLY),
179 if (!need_body) cprintf("\r\n"); /* extra trailing newline */
180 IMAP->cached_rfc822_data = CC->redirect_buffer;
181 IMAP->cached_rfc822_len = CC->redirect_len;
182 IMAP->cached_rfc822_msgnum = msgnum;
183 IMAP->cached_rfc822_withbody = need_body;
184 CC->redirect_buffer = NULL;
185 CC->redirect_len = 0;
186 CC->redirect_alloc = 0;
187 if ( (need_to_rewrite_metadata) && (IMAP->cached_rfc822_len > 0) ) {
188 smi.meta_rfc822_length = (long)IMAP->cached_rfc822_len;
194 * Now figure out where the headers/text break is. IMAP considers the
195 * intervening blank line to be part of the headers, not the text.
202 ptr = IMAP->cached_rfc822_data;
204 ptr = memreadline(ptr, buf, sizeof buf);
207 if (IsEmptyStr(buf)) {
208 headers_size = ptr - IMAP->cached_rfc822_data;
211 } while ( (headers_size == 0) && (*ptr != 0) );
213 total_size = IMAP->cached_rfc822_len;
214 text_size = total_size - headers_size;
217 headers_size = IMAP->cached_rfc822_len;
218 total_size = IMAP->cached_rfc822_len;
222 lprintf(CTDL_DEBUG, "RFC822: headers=%d, text=%d, total=%d\n",
223 headers_size, text_size, total_size);
225 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
226 cprintf("RFC822.SIZE %d", total_size);
230 else if (!strcasecmp(whichfmt, "RFC822")) {
231 ptr = IMAP->cached_rfc822_data;
232 bytes_to_send = total_size;
235 else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
236 ptr = IMAP->cached_rfc822_data;
237 bytes_to_send = headers_size;
240 else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
241 ptr = &IMAP->cached_rfc822_data[headers_size];
242 bytes_to_send = text_size;
245 cprintf("%s {%d}\r\n", whichfmt, bytes_to_send);
246 client_write(ptr, bytes_to_send);
252 * Load a specific part of a message into the temp file to be output to a
253 * client. FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
254 * but we still can't handle "2.HEADER" (which might not be a problem).
256 * Note: mime_parser() was called with dont_decode set to 1, so we have the
257 * luxury of simply spewing without having to re-encode.
259 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
260 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
264 char *desired_section;
266 desired_section = (char *)cbuserdata;
268 if (!strcasecmp(partnum, desired_section)) {
269 client_write(content, length);
272 snprintf(mbuf2, sizeof mbuf2, "%s.MIME", partnum);
274 if (!strcasecmp(desired_section, mbuf2)) {
275 cprintf("Content-type: %s", cbtype);
276 if (!IsEmptyStr(cbcharset))
277 cprintf("; charset=\"%s\"", cbcharset);
278 if (!IsEmptyStr(name))
279 cprintf("; name=\"%s\"", name);
281 if (!IsEmptyStr(encoding))
282 cprintf("Content-Transfer-Encoding: %s\r\n", encoding);
283 if (!IsEmptyStr(encoding)) {
284 cprintf("Content-Disposition: %s", disp);
285 if (!IsEmptyStr(filename)) {
286 cprintf("; filename=\"%s\"", filename);
290 cprintf("Content-Length: %ld\r\n", (long)length);
299 * Called by imap_fetch_envelope() to output the "From" field.
300 * This is in its own function because its logic is kind of complex. We
301 * really need to make this suck less.
303 void imap_output_envelope_from(struct CtdlMessage *msg) {
304 char user[SIZ], node[SIZ], name[SIZ];
308 /* For anonymous messages, it's so easy! */
309 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONONLY)) {
310 cprintf("((\"----\" NIL \"x\" \"x.org\")) ");
313 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONOPT)) {
314 cprintf("((\"anonymous\" NIL \"x\" \"x.org\")) ");
318 /* For everything else, we do stuff. */
319 cprintf("(("); /* open double-parens */
320 imap_strout(msg->cm_fields['A']); /* personal name */
321 cprintf(" NIL "); /* source route (not used) */
324 if (msg->cm_fields['F'] != NULL) {
325 process_rfc822_addr(msg->cm_fields['F'], user, node, name);
326 imap_strout(user); /* mailbox name (user id) */
328 if (!strcasecmp(node, config.c_nodename)) {
329 imap_strout(config.c_fqdn);
332 imap_strout(node); /* host name */
336 imap_strout(msg->cm_fields['A']); /* mailbox name (user id) */
338 imap_strout(msg->cm_fields['N']); /* host name */
341 cprintf(")) "); /* close double-parens */
347 * Output an envelope address (or set of addresses) in the official,
348 * convuluted, braindead format. (Note that we can't use this for
349 * the "From" address because its data may come from a number of different
350 * fields. But we can use it for "To" and possibly others.
352 void imap_output_envelope_addr(char *addr) {
353 char individual_addr[256];
365 if (IsEmptyStr(addr)) {
372 /* How many addresses are listed here? */
373 num_addrs = num_tokens(addr, ',');
375 /* Output them one by one. */
376 for (i=0; i<num_addrs; ++i) {
377 extract_token(individual_addr, addr, i, ',', sizeof individual_addr);
378 striplt(individual_addr);
379 process_rfc822_addr(individual_addr, user, node, name);
387 if (i < (num_addrs-1)) cprintf(" ");
395 * Implements the ENVELOPE fetch item
397 * Note that the imap_strout() function can cleverly output NULL fields as NIL,
398 * so we don't have to check for that condition like we do elsewhere.
400 void imap_fetch_envelope(struct CtdlMessage *msg) {
401 char datestringbuf[SIZ];
403 char *fieldptr = NULL;
407 /* Parse the message date into an IMAP-format date string */
408 if (msg->cm_fields['T'] != NULL) {
409 msgdate = atol(msg->cm_fields['T']);
412 msgdate = time(NULL);
414 datestring(datestringbuf, sizeof datestringbuf,
415 msgdate, DATESTRING_IMAP);
417 /* Now start spewing data fields. The order is important, as it is
418 * defined by the protocol specification. Nonexistent fields must
419 * be output as NIL, existent fields must be quoted or literalled.
420 * The imap_strout() function conveniently does all this for us.
422 cprintf("ENVELOPE (");
425 imap_strout(datestringbuf);
429 imap_strout(msg->cm_fields['U']);
433 imap_output_envelope_from(msg);
435 /* Sender (default to same as 'From' if not present) */
436 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Sender");
437 if (fieldptr != NULL) {
438 imap_output_envelope_addr(fieldptr);
442 imap_output_envelope_from(msg);
446 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Reply-to");
447 if (fieldptr != NULL) {
448 imap_output_envelope_addr(fieldptr);
452 imap_output_envelope_from(msg);
456 imap_output_envelope_addr(msg->cm_fields['R']);
458 /* Cc (we do it this way because there might be a legacy non-Citadel Cc: field present) */
459 fieldptr = msg->cm_fields['Y'];
460 if (fieldptr != NULL) {
461 imap_output_envelope_addr(fieldptr);
464 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Cc");
465 imap_output_envelope_addr(fieldptr);
466 if (fieldptr != NULL) free(fieldptr);
470 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Bcc");
471 imap_output_envelope_addr(fieldptr);
472 if (fieldptr != NULL) free(fieldptr);
475 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "In-reply-to");
476 imap_strout(fieldptr);
478 if (fieldptr != NULL) free(fieldptr);
481 imap_strout(msg->cm_fields['I']);
487 * This function is called only when CC->redirect_buffer contains a set of
488 * RFC822 headers with no body attached. Its job is to strip that set of
489 * headers down to *only* the ones we're interested in.
491 void imap_strip_headers(char *section) {
493 char *which_fields = NULL;
494 int doing_headers = 0;
499 char *boiled_headers = NULL;
501 int done_headers = 0;
504 if (CC->redirect_buffer == NULL) return;
506 which_fields = strdup(section);
508 if (!strncasecmp(which_fields, "HEADER.FIELDS", 13))
510 if (!strncasecmp(which_fields, "HEADER.FIELDS.NOT", 17))
513 for (i=0; which_fields[i]; ++i) {
514 if (which_fields[i]=='(')
515 strcpy(which_fields, &which_fields[i+1]);
517 for (i=0; which_fields[i]; ++i) {
518 if (which_fields[i]==')') {
523 num_parms = imap_parameterize(parms, which_fields);
525 boiled_headers = malloc(CC->redirect_alloc);
526 strcpy(boiled_headers, "");
528 ptr = CC->redirect_buffer;
530 while ( (done_headers == 0) && (ptr = memreadline(ptr, buf, sizeof buf), *ptr != 0) ) {
531 if (!isspace(buf[0])) {
533 if (doing_headers == 0) ok = 1;
535 if (headers_not) ok = 1;
537 for (i=0; i<num_parms; ++i) {
538 if ( (!strncasecmp(buf, parms[i],
539 strlen(parms[i]))) &&
540 (buf[strlen(parms[i])]==':') ) {
541 if (headers_not) ok = 0;
549 strcat(boiled_headers, buf);
550 strcat(boiled_headers, "\r\n");
553 if (IsEmptyStr(buf)) done_headers = 1;
554 if (buf[0]=='\r') done_headers = 1;
555 if (buf[0]=='\n') done_headers = 1;
558 strcat(boiled_headers, "\r\n");
560 /* Now save it back (it'll always be smaller) */
561 strcpy(CC->redirect_buffer, boiled_headers);
562 CC->redirect_len = strlen(boiled_headers);
565 free(boiled_headers);
570 * Implements the BODY and BODY.PEEK fetch items
572 void imap_fetch_body(long msgnum, char *item, int is_peek) {
573 struct CtdlMessage *msg = NULL;
577 size_t pstart, pbytes;
578 int loading_body_now = 0;
580 int burn_the_cache = 0;
582 /* extract section */
583 safestrncpy(section, item, sizeof section);
584 if (strchr(section, '[') != NULL) {
585 stripallbut(section, '[', ']');
587 lprintf(CTDL_DEBUG, "Section is: %s%s\n",
589 IsEmptyStr(section) ? "(empty)" : "");
592 * We used to have this great optimization in place that would avoid
593 * fetching the entire RFC822 message from disk if the client was only
594 * asking for the headers. Unfortunately, fetching only the Citadel
595 * headers omits "Content-type:" and this behavior breaks the iPhone
596 * email client. So we have to fetch the whole message from disk. The
598 * if (!strncasecmp(section, "HEADER", 6)) {
604 /* Burn the cache if we don't have the same section of the
605 * same message again.
607 if (IMAP->cached_body != NULL) {
608 if (IMAP->cached_bodymsgnum != msgnum) {
611 else if ( (!IMAP->cached_body_withbody) && (need_body) ) {
614 else if (strcasecmp(IMAP->cached_bodypart, section)) {
617 if (burn_the_cache) {
618 /* Yup, go ahead and burn the cache. */
619 free(IMAP->cached_body);
620 IMAP->cached_body_len = 0;
621 IMAP->cached_body = NULL;
622 IMAP->cached_bodymsgnum = (-1);
623 strcpy(IMAP->cached_bodypart, "");
627 /* extract partial */
628 safestrncpy(partial, item, sizeof partial);
629 if (strchr(partial, '<') != NULL) {
630 stripallbut(partial, '<', '>');
633 if (is_partial == 0) strcpy(partial, "");
634 /* if (!IsEmptyStr(partial)) lprintf(CTDL_DEBUG, "Partial is %s\n", partial); */
636 if (IMAP->cached_body == NULL) {
637 CC->redirect_buffer = malloc(SIZ);
638 CC->redirect_len = 0;
639 CC->redirect_alloc = SIZ;
640 loading_body_now = 1;
641 msg = CtdlFetchMessage(msgnum, (need_body ? 1 : 0));
644 /* Now figure out what the client wants, and get it */
646 if (!loading_body_now) {
647 /* What we want is already in memory */
650 else if ( (!strcmp(section, "1")) && (msg->cm_format_type != 4) ) {
651 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1);
654 else if (!strcmp(section, "")) {
655 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1);
659 * If the client asked for just headers, or just particular header
660 * fields, strip it down.
662 else if (!strncasecmp(section, "HEADER", 6)) {
663 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1);
664 imap_strip_headers(section);
668 * Strip it down if the client asked for everything _except_ headers.
670 else if (!strncasecmp(section, "TEXT", 4)) {
671 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1);
675 * Anything else must be a part specifier.
676 * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
679 mime_parser(msg->cm_fields['M'], NULL,
680 *imap_load_part, NULL, NULL,
685 if (loading_body_now) {
686 IMAP->cached_body = CC->redirect_buffer;
687 IMAP->cached_body_len = CC->redirect_len;
688 IMAP->cached_bodymsgnum = msgnum;
689 IMAP->cached_body_withbody = need_body;
690 strcpy(IMAP->cached_bodypart, section);
691 CC->redirect_buffer = NULL;
692 CC->redirect_len = 0;
693 CC->redirect_alloc = 0;
696 if (is_partial == 0) {
697 cprintf("BODY[%s] {%d}\r\n", section, IMAP->cached_body_len);
699 pbytes = IMAP->cached_body_len;
702 sscanf(partial, "%d.%d", &pstart, &pbytes);
703 if (pbytes > (IMAP->cached_body_len - pstart)) {
704 pbytes = IMAP->cached_body_len - pstart;
706 cprintf("BODY[%s]<%d> {%d}\r\n", section, pstart, pbytes);
709 /* Here we go -- output it */
710 client_write(&IMAP->cached_body[pstart], pbytes);
713 CtdlFreeMessage(msg);
716 /* Mark this message as "seen" *unless* this is a "peek" operation */
718 CtdlSetSeen(&msgnum, 1, 1, ctdlsetseen_seen, NULL, NULL);
723 * Called immediately before outputting a multipart bodystructure
725 void imap_fetch_bodystructure_pre(
726 char *name, char *filename, char *partnum, char *disp,
727 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
737 * Called immediately after outputting a multipart bodystructure
739 void imap_fetch_bodystructure_post(
740 char *name, char *filename, char *partnum, char *disp,
741 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
750 extract_token(subtype, cbtype, 1, '/', sizeof subtype);
751 imap_strout(subtype);
762 * Output the info for a MIME part in the format required by BODYSTRUCTURE.
765 void imap_fetch_bodystructure_part(
766 char *name, char *filename, char *partnum, char *disp,
767 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
772 int have_encoding = 0;
775 char cbmaintype[128];
778 if (cbtype != NULL) if (!IsEmptyStr(cbtype)) have_cbtype = 1;
780 extract_token(cbmaintype, cbtype, 0, '/', sizeof cbmaintype);
781 extract_token(cbsubtype, cbtype, 1, '/', sizeof cbsubtype);
784 strcpy(cbmaintype, "TEXT");
785 strcpy(cbsubtype, "PLAIN");
789 imap_strout(cbmaintype);
791 imap_strout(cbsubtype);
794 if (cbcharset == NULL) {
795 cprintf("(\"CHARSET\" \"US-ASCII\"");
797 else if (IsEmptyStr(cbcharset)) {
798 cprintf("(\"CHARSET\" \"US-ASCII\"");
801 cprintf("(\"CHARSET\" ");
802 imap_strout(cbcharset);
805 if (name != NULL) if (!IsEmptyStr(name)) {
806 cprintf(" \"NAME\" ");
812 cprintf("NIL "); /* Body ID */
813 cprintf("NIL "); /* Body description */
815 if (encoding != NULL) if (!IsEmptyStr(encoding)) have_encoding = 1;
817 imap_strout(encoding);
824 /* The next field is the size of the part in bytes. */
825 cprintf("%ld ", (long)length); /* bytes */
827 /* The next field is the number of lines in the part, if and only
828 * if the part is TEXT. More gratuitous complexity.
830 if (!strcasecmp(cbmaintype, "TEXT")) {
831 if (length) for (i=0; i<length; ++i) {
832 if (((char *)content)[i] == '\n') ++lines;
834 cprintf("%d ", lines);
837 /* More gratuitous complexity */
838 if ((!strcasecmp(cbmaintype, "MESSAGE"))
839 && (!strcasecmp(cbsubtype, "RFC822"))) {
841 A body type of type MESSAGE and subtype RFC822
842 contains, immediately after the basic fields, the
843 envelope structure, body structure, and size in
844 text lines of the encapsulated message.
848 /* MD5 value of body part; we can get away with NIL'ing this */
855 else if (IsEmptyStr(disp)) {
861 if (filename != NULL) if (!IsEmptyStr(filename)) {
862 cprintf(" (\"FILENAME\" ");
863 imap_strout(filename);
869 /* Body language (not defined yet) */
876 * Spew the BODYSTRUCTURE data for a message.
879 void imap_fetch_bodystructure (long msgnum, char *item,
880 struct CtdlMessage *msg) {
882 char *rfc822_body = NULL;
884 size_t rfc822_headers_len;
885 size_t rfc822_body_len;
890 /* Handle NULL message gracefully */
892 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
893 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
898 /* For non-RFC822 (ordinary Citadel) messages, this is short and
901 if (msg->cm_format_type != FMT_RFC822) {
903 /* *sigh* We have to RFC822-format the message just to be able
904 * to measure it. FIXME use smi cached fields if possible
907 CC->redirect_buffer = malloc(SIZ);
908 CC->redirect_len = 0;
909 CC->redirect_alloc = SIZ;
910 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1);
911 rfc822 = CC->redirect_buffer;
912 rfc822_len = CC->redirect_len;
913 CC->redirect_buffer = NULL;
914 CC->redirect_len = 0;
915 CC->redirect_alloc = 0;
918 while (ptr = memreadline(ptr, buf, sizeof buf), *ptr != 0) {
920 if ((IsEmptyStr(buf)) && (rfc822_body == NULL)) {
925 rfc822_headers_len = rfc822_body - rfc822;
926 rfc822_body_len = rfc822_len - rfc822_headers_len;
929 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
930 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
931 "\"7BIT\" %d %d)", rfc822_body_len, lines);
936 /* For messages already stored in RFC822 format, we have to parse. */
937 cprintf("BODYSTRUCTURE ");
938 mime_parser(msg->cm_fields['M'],
940 *imap_fetch_bodystructure_part, /* part */
941 *imap_fetch_bodystructure_pre, /* pre-multi */
942 *imap_fetch_bodystructure_post, /* post-multi */
944 1); /* don't decode -- we want it as-is */
949 * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
950 * individual message, once it has been selected for output.
952 void imap_do_fetch_msg(int seq, int num_items, char **itemlist) {
954 struct CtdlMessage *msg = NULL;
957 /* Don't attempt to fetch bogus messages or UID's */
959 if (IMAP->msgids[seq-1] < 1L) return;
962 cprintf("* %d FETCH (", seq);
964 for (i=0; i<num_items; ++i) {
966 /* Fetchable without going to the message store at all */
967 if (!strcasecmp(itemlist[i], "UID")) {
970 else if (!strcasecmp(itemlist[i], "FLAGS")) {
971 imap_fetch_flags(seq-1);
974 /* Potentially fetchable from cache, if the client requests
975 * stuff from the same message several times in a row.
977 else if (!strcasecmp(itemlist[i], "RFC822")) {
978 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
980 else if (!strcasecmp(itemlist[i], "RFC822.HEADER")) {
981 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
983 else if (!strcasecmp(itemlist[i], "RFC822.SIZE")) {
984 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
986 else if (!strcasecmp(itemlist[i], "RFC822.TEXT")) {
987 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
990 /* BODY fetches do their own fetching and caching too. */
991 else if (!strncasecmp(itemlist[i], "BODY[", 5)) {
992 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i], 0);
994 else if (!strncasecmp(itemlist[i], "BODY.PEEK[", 10)) {
995 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i], 1);
998 /* Otherwise, load the message into memory.
1000 else if (!strcasecmp(itemlist[i], "BODYSTRUCTURE")) {
1001 if ((msg != NULL) && (!body_loaded)) {
1002 CtdlFreeMessage(msg); /* need the whole thing */
1006 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 1);
1009 imap_fetch_bodystructure(IMAP->msgids[seq-1],
1012 else if (!strcasecmp(itemlist[i], "ENVELOPE")) {
1014 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 0);
1017 imap_fetch_envelope(msg);
1019 else if (!strcasecmp(itemlist[i], "INTERNALDATE")) {
1021 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 0);
1024 imap_fetch_internaldate(msg);
1027 if (i != num_items-1) cprintf(" ");
1033 CtdlFreeMessage(msg);
1040 * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1041 * validated and boiled down the request a bit.
1043 void imap_do_fetch(int num_items, char **itemlist) {
1046 if (IMAP->num_msgs > 0) {
1047 for (i = 0; i < IMAP->num_msgs; ++i) {
1049 /* Abort the fetch loop if the session breaks.
1050 * This is important for users who keep mailboxes
1051 * that are too big *and* are too impatient to
1052 * let them finish loading. :)
1054 if (CC->kill_me) return;
1056 /* Get any message marked for fetch. */
1057 if (IMAP->flags[i] & IMAP_SELECTED) {
1058 imap_do_fetch_msg(i+1, num_items, itemlist);
1067 * Back end for imap_handle_macros()
1068 * Note that this function *only* looks at the beginning of the string. It
1069 * is not a generic search-and-replace function.
1071 void imap_macro_replace(char *str, char *find, char *replace) {
1074 if (!strncasecmp(str, find, strlen(find))) {
1075 if (str[strlen(find)]==' ') {
1076 strcpy(holdbuf, &str[strlen(find)+1]);
1077 strcpy(str, replace);
1079 strcat(str, holdbuf);
1081 if (str[strlen(find)]==0) {
1082 strcpy(holdbuf, &str[strlen(find)+1]);
1083 strcpy(str, replace);
1091 * Handle macros embedded in FETCH data items.
1092 * (What the heck are macros doing in a wire protocol? Are we trying to save
1093 * the computer at the other end the trouble of typing a lot of characters?)
1095 void imap_handle_macros(char *str) {
1099 for (i=0; str[i]; ++i) {
1100 if (str[i]=='(') ++nest;
1101 if (str[i]=='[') ++nest;
1102 if (str[i]=='<') ++nest;
1103 if (str[i]=='{') ++nest;
1104 if (str[i]==')') --nest;
1105 if (str[i]==']') --nest;
1106 if (str[i]=='>') --nest;
1107 if (str[i]=='}') --nest;
1110 imap_macro_replace(&str[i],
1112 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE"
1114 imap_macro_replace(&str[i],
1118 imap_macro_replace(&str[i],
1120 "FLAGS INTERNALDATE RFC822.SIZE"
1122 imap_macro_replace(&str[i],
1124 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY"
1132 * Break out the data items requested, possibly a parenthesized list.
1133 * Returns the number of data items, or -1 if the list is invalid.
1134 * NOTE: this function alters the string it is fed, and uses it as a buffer
1135 * to hold the data for the pointers it returns.
1137 int imap_extract_data_items(char **argv, char *items) {
1144 /* Convert all whitespace to ordinary space characters. */
1145 for (i=0; items[i]; ++i) {
1146 if (isspace(items[i])) items[i]=' ';
1149 /* Strip leading and trailing whitespace, then strip leading and
1150 * trailing parentheses if it's a list
1153 if ( (items[0]=='(') && (items[strlen(items)-1]==')') ) {
1154 items[strlen(items)-1] = 0;
1155 strcpy(items, &items[1]);
1159 /* Parse any macro data items */
1160 imap_handle_macros(items);
1163 * Now break out the data items. We throw in one trailing space in
1164 * order to avoid having to break out the last one manually.
1168 initial_len = strlen(items);
1169 for (i=0; i<initial_len; ++i) {
1170 if (items[i]=='(') ++nest;
1171 if (items[i]=='[') ++nest;
1172 if (items[i]=='<') ++nest;
1173 if (items[i]=='{') ++nest;
1174 if (items[i]==')') --nest;
1175 if (items[i]==']') --nest;
1176 if (items[i]=='>') --nest;
1177 if (items[i]=='}') --nest;
1179 if (nest <= 0) if (items[i]==' ') {
1181 argv[num_items++] = start;
1182 start = &items[i+1];
1192 * One particularly hideous aspect of IMAP is that we have to allow the client
1193 * to specify arbitrary ranges and/or sets of messages to fetch. Citadel IMAP
1194 * handles this by setting the IMAP_SELECTED flag for each message specified in
1195 * the ranges/sets, then looping through the message array, outputting messages
1196 * with the flag set. We don't bother returning an error if an out-of-range
1197 * number is specified (we just return quietly) because any client braindead
1198 * enough to request a bogus message number isn't going to notice the
1199 * difference anyway.
1201 * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1202 * message included in the specified range.
1204 * Set is_uid to 1 to fetch by UID instead of sequence number.
1206 void imap_pick_range(char *supplied_range, int is_uid) {
1210 char setstr[SIZ], lostr[SIZ], histr[SIZ];
1212 char actual_range[SIZ];
1215 * Handle the "ALL" macro
1217 if (!strcasecmp(supplied_range, "ALL")) {
1218 safestrncpy(actual_range, "1:*", sizeof actual_range);
1221 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1225 * Clear out the IMAP_SELECTED flags for all messages.
1227 for (i = 0; i < IMAP->num_msgs; ++i) {
1228 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SELECTED;
1232 * Now set it for all specified messages.
1234 num_sets = num_tokens(actual_range, ',');
1235 for (s=0; s<num_sets; ++s) {
1236 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1238 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1239 if (num_tokens(setstr, ':') >= 2) {
1240 extract_token(histr, setstr, 1, ':', sizeof histr);
1241 if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1244 safestrncpy(histr, lostr, sizeof histr);
1249 /* Loop through the array, flipping bits where appropriate */
1250 for (i = 1; i <= IMAP->num_msgs; ++i) {
1251 if (is_uid) { /* fetch by sequence number */
1252 if ( (IMAP->msgids[i-1]>=lo)
1253 && (IMAP->msgids[i-1]<=hi)) {
1254 IMAP->flags[i-1] |= IMAP_SELECTED;
1257 else { /* fetch by uid */
1258 if ( (i>=lo) && (i<=hi)) {
1259 IMAP->flags[i-1] |= IMAP_SELECTED;
1270 * This function is called by the main command loop.
1272 void imap_fetch(int num_parms, char *parms[]) {
1274 char *itemlist[512];
1278 if (num_parms < 4) {
1279 cprintf("%s BAD invalid parameters\r\n", parms[0]);
1283 imap_pick_range(parms[2], 0);
1286 for (i=3; i<num_parms; ++i) {
1287 strcat(items, parms[i]);
1288 if (i < (num_parms-1)) strcat(items, " ");
1291 num_items = imap_extract_data_items(itemlist, items);
1292 if (num_items < 1) {
1293 cprintf("%s BAD invalid data item list\r\n", parms[0]);
1297 imap_do_fetch(num_items, itemlist);
1298 cprintf("%s OK FETCH completed\r\n", parms[0]);
1302 * This function is called by the main command loop.
1304 void imap_uidfetch(int num_parms, char *parms[]) {
1306 char *itemlist[512];
1309 int have_uid_item = 0;
1311 if (num_parms < 5) {
1312 cprintf("%s BAD invalid parameters\r\n", parms[0]);
1316 imap_pick_range(parms[3], 1);
1319 for (i=4; i<num_parms; ++i) {
1320 strcat(items, parms[i]);
1321 if (i < (num_parms-1)) strcat(items, " ");
1324 num_items = imap_extract_data_items(itemlist, items);
1325 if (num_items < 1) {
1326 cprintf("%s BAD invalid data item list\r\n", parms[0]);
1330 /* If the "UID" item was not included, we include it implicitly
1331 * (at the beginning) because this is a UID FETCH command
1333 for (i=0; i<num_items; ++i) {
1334 if (!strcasecmp(itemlist[i], "UID")) ++have_uid_item;
1336 if (have_uid_item == 0) {
1337 memmove(&itemlist[1], &itemlist[0], (sizeof(itemlist[0]) * num_items));
1339 itemlist[0] = "UID";
1342 imap_do_fetch(num_items, itemlist);
1343 cprintf("%s OK UID FETCH completed\r\n", parms[0]);