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 (strlen(buf) == 0) {
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 (strlen(cbcharset) > 0)
277 cprintf("; charset=\"%s\"", cbcharset);
278 if (strlen(name) > 0)
279 cprintf("; name=\"%s\"", name);
281 if (strlen(encoding) > 0)
282 cprintf("Content-Transfer-Encoding: %s\r\n", encoding);
283 if (strlen(encoding) > 0) {
284 cprintf("Content-Disposition: %s", disp);
285 if (strlen(filename) > 0) {
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 (strlen(addr) == 0) {
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; i<strlen(which_fields); ++i) {
514 if (which_fields[i]=='(')
515 strcpy(which_fields, &which_fields[i+1]);
517 for (i=0; i<strlen(which_fields); ++i) {
518 if (which_fields[i]==')')
521 num_parms = imap_parameterize(parms, which_fields);
523 boiled_headers = malloc(CC->redirect_alloc);
524 strcpy(boiled_headers, "");
526 ptr = CC->redirect_buffer;
528 while ( (done_headers == 0) && (ptr = memreadline(ptr, buf, sizeof buf), *ptr != 0) ) {
529 if (!isspace(buf[0])) {
531 if (doing_headers == 0) ok = 1;
533 if (headers_not) ok = 1;
535 for (i=0; i<num_parms; ++i) {
536 if ( (!strncasecmp(buf, parms[i],
537 strlen(parms[i]))) &&
538 (buf[strlen(parms[i])]==':') ) {
539 if (headers_not) ok = 0;
547 strcat(boiled_headers, buf);
548 strcat(boiled_headers, "\r\n");
551 if (strlen(buf) == 0) done_headers = 1;
552 if (buf[0]=='\r') done_headers = 1;
553 if (buf[0]=='\n') done_headers = 1;
556 strcat(boiled_headers, "\r\n");
558 /* Now save it back (it'll always be smaller) */
559 strcpy(CC->redirect_buffer, boiled_headers);
560 CC->redirect_len = strlen(boiled_headers);
563 free(boiled_headers);
568 * Implements the BODY and BODY.PEEK fetch items
570 void imap_fetch_body(long msgnum, char *item, int is_peek) {
571 struct CtdlMessage *msg = NULL;
575 size_t pstart, pbytes;
576 int loading_body_now = 0;
578 int burn_the_cache = 0;
580 /* extract section */
581 safestrncpy(section, item, sizeof section);
582 if (strchr(section, '[') != NULL) {
583 stripallbut(section, '[', ']');
585 lprintf(CTDL_DEBUG, "Section is: %s%s\n", section, ((strlen(section)==0) ? "(empty)" : "") );
586 if (!strncasecmp(section, "HEADER", 6)) {
590 /* Burn the cache if we don't have the same section of the
591 * same message again.
593 if (IMAP->cached_body != NULL) {
594 if (IMAP->cached_bodymsgnum != msgnum) {
597 else if ( (!IMAP->cached_body_withbody) && (need_body) ) {
600 else if (strcasecmp(IMAP->cached_bodypart, section)) {
603 if (burn_the_cache) {
604 /* Yup, go ahead and burn the cache. */
605 free(IMAP->cached_body);
606 IMAP->cached_body_len = 0;
607 IMAP->cached_body = NULL;
608 IMAP->cached_bodymsgnum = (-1);
609 strcpy(IMAP->cached_bodypart, "");
613 /* extract partial */
614 safestrncpy(partial, item, sizeof partial);
615 if (strchr(partial, '<') != NULL) {
616 stripallbut(partial, '<', '>');
619 if (is_partial == 0) strcpy(partial, "");
620 /* if (strlen(partial) > 0) lprintf(CTDL_DEBUG, "Partial is %s\n", partial); */
622 if (IMAP->cached_body == NULL) {
623 CC->redirect_buffer = malloc(SIZ);
624 CC->redirect_len = 0;
625 CC->redirect_alloc = SIZ;
626 loading_body_now = 1;
627 msg = CtdlFetchMessage(msgnum, (need_body ? 1 : 0));
630 /* Now figure out what the client wants, and get it */
632 if (!loading_body_now) {
633 /* What we want is already in memory */
636 else if ( (!strcmp(section, "1")) && (msg->cm_format_type != 4) ) {
637 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1);
640 else if (!strcmp(section, "")) {
641 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1);
645 * If the client asked for just headers, or just particular header
646 * fields, strip it down.
648 else if (!strncasecmp(section, "HEADER", 6)) {
649 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1);
650 imap_strip_headers(section);
654 * Strip it down if the client asked for everything _except_ headers.
656 else if (!strncasecmp(section, "TEXT", 4)) {
657 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1);
661 * Anything else must be a part specifier.
662 * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
665 mime_parser(msg->cm_fields['M'], NULL,
666 *imap_load_part, NULL, NULL,
671 if (loading_body_now) {
672 IMAP->cached_body = CC->redirect_buffer;
673 IMAP->cached_body_len = CC->redirect_len;
674 IMAP->cached_bodymsgnum = msgnum;
675 IMAP->cached_body_withbody = need_body;
676 strcpy(IMAP->cached_bodypart, section);
677 CC->redirect_buffer = NULL;
678 CC->redirect_len = 0;
679 CC->redirect_alloc = 0;
682 if (is_partial == 0) {
683 cprintf("BODY[%s] {%d}\r\n", section, IMAP->cached_body_len);
685 pbytes = IMAP->cached_body_len;
688 sscanf(partial, "%d.%d", &pstart, &pbytes);
689 if (pbytes > (IMAP->cached_body_len - pstart)) {
690 pbytes = IMAP->cached_body_len - pstart;
692 cprintf("BODY[%s]<%d> {%d}\r\n", section, pstart, pbytes);
695 /* Here we go -- output it */
696 client_write(&IMAP->cached_body[pstart], pbytes);
699 CtdlFreeMessage(msg);
702 /* Mark this message as "seen" *unless* this is a "peek" operation */
704 CtdlSetSeen(&msgnum, 1, 1, ctdlsetseen_seen, NULL, NULL);
709 * Called immediately before outputting a multipart bodystructure
711 void imap_fetch_bodystructure_pre(
712 char *name, char *filename, char *partnum, char *disp,
713 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
723 * Called immediately after outputting a multipart bodystructure
725 void imap_fetch_bodystructure_post(
726 char *name, char *filename, char *partnum, char *disp,
727 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
736 extract_token(subtype, cbtype, 1, '/', sizeof subtype);
737 imap_strout(subtype);
748 * Output the info for a MIME part in the format required by BODYSTRUCTURE.
751 void imap_fetch_bodystructure_part(
752 char *name, char *filename, char *partnum, char *disp,
753 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
758 int have_encoding = 0;
761 char cbmaintype[128];
764 if (cbtype != NULL) if (strlen(cbtype)>0) have_cbtype = 1;
766 extract_token(cbmaintype, cbtype, 0, '/', sizeof cbmaintype);
767 extract_token(cbsubtype, cbtype, 1, '/', sizeof cbsubtype);
770 strcpy(cbmaintype, "TEXT");
771 strcpy(cbsubtype, "PLAIN");
775 imap_strout(cbmaintype);
777 imap_strout(cbsubtype);
780 if (cbcharset == NULL) {
781 cprintf("(\"CHARSET\" \"US-ASCII\"");
783 else if (strlen(cbcharset) == 0) {
784 cprintf("(\"CHARSET\" \"US-ASCII\"");
787 cprintf("(\"CHARSET\" ");
788 imap_strout(cbcharset);
791 if (name != NULL) if (strlen(name)>0) {
792 cprintf(" \"NAME\" ");
798 cprintf("NIL "); /* Body ID */
799 cprintf("NIL "); /* Body description */
801 if (encoding != NULL) if (strlen(encoding) > 0) have_encoding = 1;
803 imap_strout(encoding);
810 /* The next field is the size of the part in bytes. */
811 cprintf("%ld ", (long)length); /* bytes */
813 /* The next field is the number of lines in the part, if and only
814 * if the part is TEXT. More gratuitous complexity.
816 if (!strcasecmp(cbmaintype, "TEXT")) {
817 if (length) for (i=0; i<length; ++i) {
818 if (((char *)content)[i] == '\n') ++lines;
820 cprintf("%d ", lines);
823 /* More gratuitous complexity */
824 if ((!strcasecmp(cbmaintype, "MESSAGE"))
825 && (!strcasecmp(cbsubtype, "RFC822"))) {
827 A body type of type MESSAGE and subtype RFC822
828 contains, immediately after the basic fields, the
829 envelope structure, body structure, and size in
830 text lines of the encapsulated message.
834 /* MD5 value of body part; we can get away with NIL'ing this */
841 else if (strlen(disp) == 0) {
847 if (filename != NULL) if (strlen(filename)>0) {
848 cprintf(" (\"FILENAME\" ");
849 imap_strout(filename);
855 /* Body language (not defined yet) */
862 * Spew the BODYSTRUCTURE data for a message.
865 void imap_fetch_bodystructure (long msgnum, char *item,
866 struct CtdlMessage *msg) {
868 char *rfc822_body = NULL;
870 size_t rfc822_headers_len;
871 size_t rfc822_body_len;
876 /* Handle NULL message gracefully */
878 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
879 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
884 /* For non-RFC822 (ordinary Citadel) messages, this is short and
887 if (msg->cm_format_type != FMT_RFC822) {
889 /* *sigh* We have to RFC822-format the message just to be able
890 * to measure it. FIXME use smi cached fields if possible
893 CC->redirect_buffer = malloc(SIZ);
894 CC->redirect_len = 0;
895 CC->redirect_alloc = SIZ;
896 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1);
897 rfc822 = CC->redirect_buffer;
898 rfc822_len = CC->redirect_len;
899 CC->redirect_buffer = NULL;
900 CC->redirect_len = 0;
901 CC->redirect_alloc = 0;
904 while (ptr = memreadline(ptr, buf, sizeof buf), *ptr != 0) {
906 if ((strlen(buf) == 0) && (rfc822_body == NULL)) {
911 rfc822_headers_len = rfc822_body - rfc822;
912 rfc822_body_len = rfc822_len - rfc822_headers_len;
915 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
916 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
917 "\"7BIT\" %d %d)", rfc822_body_len, lines);
922 /* For messages already stored in RFC822 format, we have to parse. */
923 cprintf("BODYSTRUCTURE ");
924 mime_parser(msg->cm_fields['M'],
926 *imap_fetch_bodystructure_part, /* part */
927 *imap_fetch_bodystructure_pre, /* pre-multi */
928 *imap_fetch_bodystructure_post, /* post-multi */
930 1); /* don't decode -- we want it as-is */
935 * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
936 * individual message, once it has been selected for output.
938 void imap_do_fetch_msg(int seq, int num_items, char **itemlist) {
940 struct CtdlMessage *msg = NULL;
943 /* Don't attempt to fetch bogus messages or UID's */
945 if (IMAP->msgids[seq-1] < 1L) return;
948 cprintf("* %d FETCH (", seq);
950 for (i=0; i<num_items; ++i) {
952 /* Fetchable without going to the message store at all */
953 if (!strcasecmp(itemlist[i], "UID")) {
956 else if (!strcasecmp(itemlist[i], "FLAGS")) {
957 imap_fetch_flags(seq-1);
960 /* Potentially fetchable from cache, if the client requests
961 * stuff from the same message several times in a row.
963 else if (!strcasecmp(itemlist[i], "RFC822")) {
964 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
966 else if (!strcasecmp(itemlist[i], "RFC822.HEADER")) {
967 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
969 else if (!strcasecmp(itemlist[i], "RFC822.SIZE")) {
970 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
972 else if (!strcasecmp(itemlist[i], "RFC822.TEXT")) {
973 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
976 /* BODY fetches do their own fetching and caching too. */
977 else if (!strncasecmp(itemlist[i], "BODY[", 5)) {
978 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i], 0);
980 else if (!strncasecmp(itemlist[i], "BODY.PEEK[", 10)) {
981 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i], 1);
984 /* Otherwise, load the message into memory.
986 else if (!strcasecmp(itemlist[i], "BODYSTRUCTURE")) {
987 if ((msg != NULL) && (!body_loaded)) {
988 CtdlFreeMessage(msg); /* need the whole thing */
992 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 1);
995 imap_fetch_bodystructure(IMAP->msgids[seq-1],
998 else if (!strcasecmp(itemlist[i], "ENVELOPE")) {
1000 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 0);
1003 imap_fetch_envelope(msg);
1005 else if (!strcasecmp(itemlist[i], "INTERNALDATE")) {
1007 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 0);
1010 imap_fetch_internaldate(msg);
1013 if (i != num_items-1) cprintf(" ");
1019 CtdlFreeMessage(msg);
1026 * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1027 * validated and boiled down the request a bit.
1029 void imap_do_fetch(int num_items, char **itemlist) {
1032 if (IMAP->num_msgs > 0) {
1033 for (i = 0; i < IMAP->num_msgs; ++i) {
1035 /* Abort the fetch loop if the session breaks.
1036 * This is important for users who keep mailboxes
1037 * that are too big *and* are too impatient to
1038 * let them finish loading. :)
1040 if (CC->kill_me) return;
1042 /* Get any message marked for fetch. */
1043 if (IMAP->flags[i] & IMAP_SELECTED) {
1044 imap_do_fetch_msg(i+1, num_items, itemlist);
1053 * Back end for imap_handle_macros()
1054 * Note that this function *only* looks at the beginning of the string. It
1055 * is not a generic search-and-replace function.
1057 void imap_macro_replace(char *str, char *find, char *replace) {
1060 if (!strncasecmp(str, find, strlen(find))) {
1061 if (str[strlen(find)]==' ') {
1062 strcpy(holdbuf, &str[strlen(find)+1]);
1063 strcpy(str, replace);
1065 strcat(str, holdbuf);
1067 if (str[strlen(find)]==0) {
1068 strcpy(holdbuf, &str[strlen(find)+1]);
1069 strcpy(str, replace);
1077 * Handle macros embedded in FETCH data items.
1078 * (What the heck are macros doing in a wire protocol? Are we trying to save
1079 * the computer at the other end the trouble of typing a lot of characters?)
1081 void imap_handle_macros(char *str) {
1085 for (i=0; i<strlen(str); ++i) {
1086 if (str[i]=='(') ++nest;
1087 if (str[i]=='[') ++nest;
1088 if (str[i]=='<') ++nest;
1089 if (str[i]=='{') ++nest;
1090 if (str[i]==')') --nest;
1091 if (str[i]==']') --nest;
1092 if (str[i]=='>') --nest;
1093 if (str[i]=='}') --nest;
1096 imap_macro_replace(&str[i],
1098 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE"
1100 imap_macro_replace(&str[i],
1104 imap_macro_replace(&str[i],
1106 "FLAGS INTERNALDATE RFC822.SIZE"
1108 imap_macro_replace(&str[i],
1110 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY"
1118 * Break out the data items requested, possibly a parenthesized list.
1119 * Returns the number of data items, or -1 if the list is invalid.
1120 * NOTE: this function alters the string it is fed, and uses it as a buffer
1121 * to hold the data for the pointers it returns.
1123 int imap_extract_data_items(char **argv, char *items) {
1129 /* Convert all whitespace to ordinary space characters. */
1130 for (i=0; i<strlen(items); ++i) {
1131 if (isspace(items[i])) items[i]=' ';
1134 /* Strip leading and trailing whitespace, then strip leading and
1135 * trailing parentheses if it's a list
1138 if ( (items[0]=='(') && (items[strlen(items)-1]==')') ) {
1139 items[strlen(items)-1] = 0;
1140 strcpy(items, &items[1]);
1144 /* Parse any macro data items */
1145 imap_handle_macros(items);
1148 * Now break out the data items. We throw in one trailing space in
1149 * order to avoid having to break out the last one manually.
1153 initial_len = strlen(items);
1154 for (i=0; i<initial_len; ++i) {
1155 if (items[i]=='(') ++nest;
1156 if (items[i]=='[') ++nest;
1157 if (items[i]=='<') ++nest;
1158 if (items[i]=='{') ++nest;
1159 if (items[i]==')') --nest;
1160 if (items[i]==']') --nest;
1161 if (items[i]=='>') --nest;
1162 if (items[i]=='}') --nest;
1164 if (nest <= 0) if (items[i]==' ') {
1166 argv[num_items++] = start;
1167 start = &items[i+1];
1177 * One particularly hideous aspect of IMAP is that we have to allow the client
1178 * to specify arbitrary ranges and/or sets of messages to fetch. Citadel IMAP
1179 * handles this by setting the IMAP_SELECTED flag for each message specified in
1180 * the ranges/sets, then looping through the message array, outputting messages
1181 * with the flag set. We don't bother returning an error if an out-of-range
1182 * number is specified (we just return quietly) because any client braindead
1183 * enough to request a bogus message number isn't going to notice the
1184 * difference anyway.
1186 * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1187 * message included in the specified range.
1189 * Set is_uid to 1 to fetch by UID instead of sequence number.
1191 void imap_pick_range(char *supplied_range, int is_uid) {
1195 char setstr[SIZ], lostr[SIZ], histr[SIZ];
1197 char actual_range[SIZ];
1200 * Handle the "ALL" macro
1202 if (!strcasecmp(supplied_range, "ALL")) {
1203 safestrncpy(actual_range, "1:*", sizeof actual_range);
1206 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1210 * Clear out the IMAP_SELECTED flags for all messages.
1212 for (i = 0; i < IMAP->num_msgs; ++i) {
1213 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SELECTED;
1217 * Now set it for all specified messages.
1219 num_sets = num_tokens(actual_range, ',');
1220 for (s=0; s<num_sets; ++s) {
1221 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1223 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1224 if (num_tokens(setstr, ':') >= 2) {
1225 extract_token(histr, setstr, 1, ':', sizeof histr);
1226 if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1229 safestrncpy(histr, lostr, sizeof histr);
1234 /* Loop through the array, flipping bits where appropriate */
1235 for (i = 1; i <= IMAP->num_msgs; ++i) {
1236 if (is_uid) { /* fetch by sequence number */
1237 if ( (IMAP->msgids[i-1]>=lo)
1238 && (IMAP->msgids[i-1]<=hi)) {
1239 IMAP->flags[i-1] |= IMAP_SELECTED;
1242 else { /* fetch by uid */
1243 if ( (i>=lo) && (i<=hi)) {
1244 IMAP->flags[i-1] |= IMAP_SELECTED;
1255 * This function is called by the main command loop.
1257 void imap_fetch(int num_parms, char *parms[]) {
1259 char *itemlist[512];
1263 if (num_parms < 4) {
1264 cprintf("%s BAD invalid parameters\r\n", parms[0]);
1268 imap_pick_range(parms[2], 0);
1271 for (i=3; i<num_parms; ++i) {
1272 strcat(items, parms[i]);
1273 if (i < (num_parms-1)) strcat(items, " ");
1276 num_items = imap_extract_data_items(itemlist, items);
1277 if (num_items < 1) {
1278 cprintf("%s BAD invalid data item list\r\n", parms[0]);
1282 imap_do_fetch(num_items, itemlist);
1283 cprintf("%s OK FETCH completed\r\n", parms[0]);
1287 * This function is called by the main command loop.
1289 void imap_uidfetch(int num_parms, char *parms[]) {
1291 char *itemlist[512];
1294 int have_uid_item = 0;
1296 if (num_parms < 5) {
1297 cprintf("%s BAD invalid parameters\r\n", parms[0]);
1301 imap_pick_range(parms[3], 1);
1304 for (i=4; i<num_parms; ++i) {
1305 strcat(items, parms[i]);
1306 if (i < (num_parms-1)) strcat(items, " ");
1309 num_items = imap_extract_data_items(itemlist, items);
1310 if (num_items < 1) {
1311 cprintf("%s BAD invalid data item list\r\n", parms[0]);
1315 /* If the "UID" item was not included, we include it implicitly
1316 * (at the beginning) because this is a UID FETCH command
1318 for (i=0; i<num_items; ++i) {
1319 if (!strcasecmp(itemlist[i], "UID")) ++have_uid_item;
1321 if (have_uid_item == 0) {
1322 memmove(&itemlist[1], &itemlist[0], (sizeof(itemlist[0]) * num_items));
1324 itemlist[0] = "UID";
1327 imap_do_fetch(num_items, itemlist);
1328 cprintf("%s OK UID FETCH completed\r\n", parms[0]);