4 * Implements the FETCH command in IMAP.
5 * This command is way too convoluted. Marc Crispin is a fscking idiot.
18 #include <sys/types.h>
27 #include "sysdep_decls.h"
28 #include "citserver.h"
31 #include "dynloader.h"
38 #include "internet_addressing.h"
39 #include "mime_parser.h"
40 #include "serv_imap.h"
41 #include "imap_tools.h"
42 #include "imap_fetch.h"
47 struct imap_fetch_part {
48 char desired_section[256];
53 * Individual field functions for imap_do_fetch_msg() ...
58 void imap_fetch_uid(int seq) {
59 cprintf("UID %ld", IMAP->msgids[seq-1]);
62 void imap_fetch_flags(struct CtdlMessage *msg) {
63 cprintf("FLAGS ()"); /* FIXME do something here */
66 void imap_fetch_internaldate(struct CtdlMessage *msg) {
70 if (msg->cm_fields['T'] != NULL) {
71 msgdate = atol(msg->cm_fields['T']);
77 datestring(buf, msgdate, DATESTRING_IMAP);
78 cprintf("INTERNALDATE \"%s\"", buf);
83 * Fetch RFC822-formatted messages.
85 * 'whichfmt' should be set to one of:
86 * "RFC822" entire message
87 * "RFC822.HEADER" headers only (with trailing blank line)
88 * "RFC822.SIZE" size of translated message
89 * "RFC822.TEXT" body only (without leading blank line)
91 void imap_fetch_rfc822(int msgnum, char *whichfmt, struct CtdlMessage *msg) {
95 long headers_size, text_size, total_size;
96 long bytes_remaining = 0;
101 lprintf(1, "Cannot open temp file: %s\n", strerror(errno));
106 * Load the message into a temp file for translation and measurement
108 CtdlRedirectOutput(tmp, -1);
109 CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 0, 0, 1);
110 CtdlRedirectOutput(NULL, -1);
113 * Now figure out where the headers/text break is. IMAP considers the
114 * intervening blank line to be part of the headers, not the text.
119 ptr = fgets(buf, sizeof buf, tmp);
122 if (strlen(buf) == 0) headers_size = ftell(tmp);
124 } while ( (headers_size == 0L) && (ptr != NULL) );
125 fseek(tmp, 0L, SEEK_END);
126 total_size = ftell(tmp);
127 text_size = total_size - headers_size;
129 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
130 cprintf("RFC822.SIZE %ld", total_size);
135 else if (!strcasecmp(whichfmt, "RFC822")) {
136 bytes_remaining = total_size;
140 else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
141 bytes_remaining = headers_size;
145 else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
146 bytes_remaining = text_size;
147 fseek(tmp, headers_size, SEEK_SET);
150 cprintf("%s {%ld}\r\n", whichfmt, bytes_remaining);
151 blocksize = sizeof(buf);
152 while (bytes_remaining > 0L) {
153 if (blocksize > bytes_remaining) blocksize = bytes_remaining;
154 fread(buf, blocksize, 1, tmp);
155 client_write(buf, blocksize);
156 bytes_remaining = bytes_remaining - blocksize;
165 * Load a specific part of a message into the temp file to be output to a
166 * client. FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
167 * but we still can't handle "2.HEADER" (which might not be a problem, because
168 * we currently don't have the ability to break out nested RFC822's anyway).
170 * Note: mime_parser() was called with dont_decode set to 1, so we have the
171 * luxury of simply spewing without having to re-encode.
173 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
174 void *content, char *cbtype, size_t length, char *encoding,
177 struct imap_fetch_part *imfp;
180 imfp = (struct imap_fetch_part *)cbuserdata;
182 if (!strcasecmp(partnum, imfp->desired_section)) {
183 fwrite(content, length, 1, imfp->output_fp);
186 sprintf(mbuf2, "%s.MIME", partnum);
188 if (!strcasecmp(imfp->desired_section, mbuf2)) {
189 fprintf(imfp->output_fp, "Content-type: %s", cbtype);
190 if (strlen(name) > 0)
191 fprintf(imfp->output_fp, "; name=\"%s\"", name);
192 fprintf(imfp->output_fp, "\r\n");
193 if (strlen(encoding) > 0)
194 fprintf(imfp->output_fp,
195 "Content-Transfer-Encoding: %s\r\n", encoding);
196 if (strlen(encoding) > 0) {
197 fprintf(imfp->output_fp, "Content-Disposition: %s",
199 if (strlen(filename) > 0) {
200 fprintf(imfp->output_fp, "; filename=\"%s\"",
203 fprintf(imfp->output_fp, "\r\n");
205 fprintf(imfp->output_fp, "Content-Length: %d\r\n", length);
206 fprintf(imfp->output_fp, "\r\n");
214 * Implements the ENVELOPE fetch item
216 * FIXME ... we only output some of the fields right now. Definitely need
217 * to do all of them. Accurately, too.
219 * Note that the imap_strout() function can cleverly output NULL fields as NIL,
220 * so we don't have to check for that condition like we do elsewhere.
222 void imap_fetch_envelope(long msgnum, struct CtdlMessage *msg) {
226 if (msg->cm_fields['T'] != NULL) {
227 msgdate = atol(msg->cm_fields['T']);
230 msgdate = time(NULL);
233 datestring(buf, msgdate, DATESTRING_IMAP);
235 cprintf("ENVELOPE (");
238 cprintf("\"%s\" ", buf);
241 imap_strout(msg->cm_fields['U']);
244 cprintf("NIL "); /* from */
245 cprintf("NIL "); /* sender */
246 cprintf("NIL "); /* reply-to */
247 cprintf("NIL "); /* to */
248 cprintf("NIL "); /* cc */
249 cprintf("NIL "); /* bcc */
250 cprintf("NIL "); /* in-reply-to */
253 imap_strout(msg->cm_fields['I']);
260 * Strip any non header information out of a chunk of RFC822 data on disk
262 void imap_strip_headers(FILE *fp) {
266 while (fgets(buf, sizeof buf, fp) != NULL) {
268 if (strlen(buf) == 0) {
270 ftruncate(fileno(fp), ftell(fp));
274 fprintf(fp, "\r\n"); /* add the trailing newline */
280 * Implements the BODY and BODY.PEEK fetch items
282 void imap_fetch_body(long msgnum, char *item, int is_peek,
283 struct CtdlMessage *msg) {
290 long bytes_remaining = 0;
293 struct imap_fetch_part imfp;
295 /* extract section */
296 strcpy(section, item);
297 for (i=0; i<strlen(section); ++i) {
298 if (section[i]=='[') strcpy(section, §ion[i+1]);
300 for (i=0; i<strlen(section); ++i) {
301 if (section[i]==']') section[i] = 0;
303 lprintf(9, "Section is %s\n", section);
305 /* extract partial */
306 strcpy(partial, item);
307 for (i=0; i<strlen(partial); ++i) {
308 if (partial[i]=='<') {
309 strcpy(partial, &partial[i+1]);
313 for (i=0; i<strlen(partial); ++i) {
314 if (partial[i]=='>') partial[i] = 0;
316 if (is_partial == 0) strcpy(partial, "");
317 lprintf(9, "Partial is %s\n", partial);
321 lprintf(1, "Cannot open temp file: %s\n", strerror(errno));
325 /* Now figure out what the client wants, and get it */
327 if (!strcmp(section, "")) { /* the whole thing */
328 CtdlRedirectOutput(tmp, -1);
329 CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 0, 0, 1);
330 CtdlRedirectOutput(NULL, -1);
334 * Be obnoxious and send the entire header, even if the client only
335 * asks for certain fields. FIXME this shortcut later.
337 else if (!strncasecmp(section, "HEADER", 6)) {
338 CtdlRedirectOutput(tmp, -1);
339 CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 1, 0, 1);
340 CtdlRedirectOutput(NULL, -1);
341 imap_strip_headers(tmp);
345 * Anything else must be a part specifier.
346 * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
349 safestrncpy(imfp.desired_section, section,
350 sizeof(imfp.desired_section));
351 imfp.output_fp = tmp;
353 mime_parser(msg->cm_fields['M'], NULL,
360 fseek(tmp, 0L, SEEK_END);
361 bytes_remaining = ftell(tmp);
363 if (is_partial == 0) {
365 cprintf("BODY[%s] {%ld}\r\n", section, bytes_remaining);
368 sscanf(partial, "%ld.%ld", &pstart, &pbytes);
369 if ((bytes_remaining - pstart) < pbytes) {
370 pbytes = bytes_remaining - pstart;
372 fseek(tmp, pstart, SEEK_SET);
373 bytes_remaining = pbytes;
374 cprintf("BODY[%s] {%ld}<%ld>\r\n",
375 section, bytes_remaining, pstart);
378 blocksize = sizeof(buf);
379 while (bytes_remaining > 0L) {
380 if (blocksize > bytes_remaining) blocksize = bytes_remaining;
381 fread(buf, blocksize, 1, tmp);
382 client_write(buf, blocksize);
383 bytes_remaining = bytes_remaining - blocksize;
389 /* FIXME set the last read pointer or something */
395 * Spew the BODYSTRUCTURE data for a message. (Do you need a silencer if
396 * you're going to shoot a MIME? Do you need a reason to shoot Mark Crispin?
399 * FIXME finish the implementation
401 void imap_fetch_bodystructure (long msgnum, char *item,
402 struct CtdlMessage *msg) {
409 /* For non-RFC822 (ordinary Citadel) messages, this is short and
412 if (msg->cm_format_type != FMT_RFC822) {
414 /* *sigh* We have to RFC822-format the message just to be able
418 if (tmp == NULL) return;
419 CtdlRedirectOutput(tmp, -1);
420 CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 0, 0, 1);
421 CtdlRedirectOutput(NULL, -1);
424 while (fgets(buf, sizeof buf, tmp) != NULL) ++lines;
428 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
429 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
430 "\"7BIT\" %ld %ld) ", bytes, lines);
435 /* For messages already stored in RFC822 format, we have to parse. */
447 * imap_do_fetch() calls imap_do_fetch_msg() to output the deta of an
448 * individual message, once it has been successfully loaded from disk.
450 void imap_do_fetch_msg(int seq, struct CtdlMessage *msg,
451 int num_items, char **itemlist) {
454 cprintf("* %d FETCH (", seq);
456 for (i=0; i<num_items; ++i) {
458 if (!strncasecmp(itemlist[i], "BODY[", 5)) {
459 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i],
462 else if (!strncasecmp(itemlist[i], "BODY.PEEK[", 10)) {
463 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i],
466 else if (!strcasecmp(itemlist[i], "BODYSTRUCTURE")) {
467 imap_fetch_bodystructure(IMAP->msgids[seq-1],
470 else if (!strcasecmp(itemlist[i], "ENVELOPE")) {
471 imap_fetch_envelope(IMAP->msgids[seq-1], msg);
473 else if (!strcasecmp(itemlist[i], "FLAGS")) {
474 imap_fetch_flags(msg);
476 else if (!strcasecmp(itemlist[i], "INTERNALDATE")) {
477 imap_fetch_internaldate(msg);
479 else if (!strcasecmp(itemlist[i], "RFC822")) {
480 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
482 else if (!strcasecmp(itemlist[i], "RFC822.HEADER")) {
483 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
485 else if (!strcasecmp(itemlist[i], "RFC822.SIZE")) {
486 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
488 else if (!strcasecmp(itemlist[i], "RFC822.TEXT")) {
489 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
491 else if (!strcasecmp(itemlist[i], "UID")) {
495 if (i != num_items-1) cprintf(" ");
504 * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
505 * validated and boiled down the request a bit.
507 void imap_do_fetch(int num_items, char **itemlist) {
509 struct CtdlMessage *msg;
511 if (IMAP->num_msgs > 0)
512 for (i = 0; i < IMAP->num_msgs; ++i)
513 if (IMAP->flags[i] && IMAP_FETCHED) {
514 msg = CtdlFetchMessage(IMAP->msgids[i]);
516 imap_do_fetch_msg(i+1, msg, num_items, itemlist);
517 CtdlFreeMessage(msg);
520 cprintf("* %d FETCH <internal error>\r\n", i+1);
528 * Back end for imap_handle_macros()
529 * Note that this function *only* looks at the beginning of the string. It
530 * is not a generic search-and-replace function.
532 void imap_macro_replace(char *str, char *find, char *replace) {
535 if (!strncasecmp(str, find, strlen(find))) {
536 if (str[strlen(find)]==' ') {
537 strcpy(holdbuf, &str[strlen(find)+1]);
538 strcpy(str, replace);
540 strcat(str, holdbuf);
542 if (str[strlen(find)]==0) {
543 strcpy(holdbuf, &str[strlen(find)+1]);
544 strcpy(str, replace);
552 * Handle macros embedded in FETCH data items.
553 * (What the heck are macros doing in a wire protocol? Are we trying to save
554 * the computer at the other end the trouble of typing a lot of characters?)
556 void imap_handle_macros(char *str) {
560 for (i=0; i<strlen(str); ++i) {
561 if (str[i]=='(') ++nest;
562 if (str[i]=='[') ++nest;
563 if (str[i]=='<') ++nest;
564 if (str[i]=='{') ++nest;
565 if (str[i]==')') --nest;
566 if (str[i]==']') --nest;
567 if (str[i]=='>') --nest;
568 if (str[i]=='}') --nest;
571 imap_macro_replace(&str[i],
573 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE"
575 imap_macro_replace(&str[i],
579 imap_macro_replace(&str[i],
581 "FLAGS INTERNALDATE RFC822.SIZE"
583 imap_macro_replace(&str[i],
585 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY"
593 * Break out the data items requested, possibly a parenthesized list.
594 * Returns the number of data items, or -1 if the list is invalid.
595 * NOTE: this function alters the string it is fed, and uses it as a buffer
596 * to hold the data for the pointers it returns.
598 int imap_extract_data_items(char **argv, char *items) {
604 /* Convert all whitespace to ordinary space characters. */
605 for (i=0; i<strlen(items); ++i) {
606 if (isspace(items[i])) items[i]=' ';
609 /* Strip leading and trailing whitespace, then strip leading and
610 * trailing parentheses if it's a list
613 if ( (items[0]=='(') && (items[strlen(items)-1]==')') ) {
614 items[strlen(items)-1] = 0;
615 strcpy(items, &items[1]);
619 /* Parse any macro data items */
620 imap_handle_macros(items);
623 * Now break out the data items. We throw in one trailing space in
624 * order to avoid having to break out the last one manually.
628 initial_len = strlen(items);
629 for (i=0; i<initial_len; ++i) {
630 if (items[i]=='(') ++nest;
631 if (items[i]=='[') ++nest;
632 if (items[i]=='<') ++nest;
633 if (items[i]=='{') ++nest;
634 if (items[i]==')') --nest;
635 if (items[i]==']') --nest;
636 if (items[i]=='>') --nest;
637 if (items[i]=='}') --nest;
639 if (nest <= 0) if (items[i]==' ') {
641 argv[num_items++] = start;
652 * One particularly hideous aspect of IMAP is that we have to allow the client
653 * to specify arbitrary ranges and/or sets of messages to fetch. Citadel IMAP
654 * handles this by setting the IMAP_FETCHED flag for each message specified in
655 * the ranges/sets, then looping through the message array, outputting messages
656 * with the flag set. We don't bother returning an error if an out-of-range
657 * number is specified (we just return quietly) because any client braindead
658 * enough to request a bogus message number isn't going to notice the
661 * This function clears out the IMAP_FETCHED bits, then sets that bit for each
662 * message included in the specified range.
664 * Set is_uid to 1 to fetch by UID instead of sequence number.
666 void imap_pick_range(char *range, int is_uid) {
670 char setstr[1024], lostr[1024], histr[1024];
674 * Clear out the IMAP_FETCHED flags for all messages.
676 for (i = 1; i <= IMAP->num_msgs; ++i) {
677 IMAP->flags[i-1] = IMAP->flags[i-1] & ~IMAP_FETCHED;
681 * Now set it for all specified messages.
683 num_sets = num_tokens(range, ',');
684 for (s=0; s<num_sets; ++s) {
685 extract_token(setstr, range, s, ',');
687 extract_token(lostr, setstr, 0, ':');
688 if (num_tokens(setstr, ':') >= 2) {
689 extract_token(histr, setstr, 1, ':');
690 if (!strcmp(histr, "*")) sprintf(histr, "%d", INT_MAX);
693 strcpy(histr, lostr);
698 /* Loop through the array, flipping bits where appropriate */
699 for (i = 1; i <= IMAP->num_msgs; ++i) {
700 if (is_uid) { /* fetch by sequence number */
701 if ( (IMAP->msgids[i-1]>=lo)
702 && (IMAP->msgids[i-1]<=hi)) {
704 IMAP->flags[i-1] | IMAP_FETCHED;
707 else { /* fetch by uid */
708 if ( (i>=lo) && (i<=hi)) {
710 IMAP->flags[i-1] | IMAP_FETCHED;
720 * This function is called by the main command loop.
722 void imap_fetch(int num_parms, char *parms[]) {
729 cprintf("%s BAD invalid parameters\r\n", parms[0]);
733 imap_pick_range(parms[2], 0);
736 for (i=3; i<num_parms; ++i) {
737 strcat(items, parms[i]);
738 if (i < (num_parms-1)) strcat(items, " ");
741 num_items = imap_extract_data_items(itemlist, items);
743 cprintf("%s BAD invalid data item list\r\n", parms[0]);
747 imap_do_fetch(num_items, itemlist);
748 cprintf("%s OK FETCH completed\r\n", parms[0]);
752 * This function is called by the main command loop.
754 void imap_uidfetch(int num_parms, char *parms[]) {
759 int have_uid_item = 0;
762 cprintf("%s BAD invalid parameters\r\n", parms[0]);
766 imap_pick_range(parms[3], 1);
769 for (i=4; i<num_parms; ++i) {
770 strcat(items, parms[i]);
771 if (i < (num_parms-1)) strcat(items, " ");
774 num_items = imap_extract_data_items(itemlist, items);
776 cprintf("%s BAD invalid data item list\r\n", parms[0]);
780 /* If the "UID" item was not included, we include it implicitly
781 * because this is a UID FETCH command
783 for (i=0; i<num_items; ++i) {
784 if (!strcasecmp(itemlist[i], "UID")) ++have_uid_item;
786 if (have_uid_item == 0) itemlist[num_items++] = "UID";
788 imap_do_fetch(num_items, itemlist);
789 cprintf("%s OK UID FETCH completed\r\n", parms[0]);