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);
111 if (!is_valid_message(msg)) {
112 lprintf(1, "WARNING: output clobbered the message!\n");
116 * Now figure out where the headers/text break is. IMAP considers the
117 * intervening blank line to be part of the headers, not the text.
122 ptr = fgets(buf, sizeof buf, tmp);
125 if (strlen(buf) == 0) headers_size = ftell(tmp);
127 } while ( (headers_size == 0L) && (ptr != NULL) );
128 fseek(tmp, 0L, SEEK_END);
129 total_size = ftell(tmp);
130 text_size = total_size - headers_size;
132 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
133 cprintf("RFC822.SIZE %ld", total_size);
138 else if (!strcasecmp(whichfmt, "RFC822")) {
139 bytes_remaining = total_size;
143 else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
144 bytes_remaining = headers_size;
148 else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
149 bytes_remaining = text_size;
150 fseek(tmp, headers_size, SEEK_SET);
153 cprintf("%s {%ld}\r\n", whichfmt, bytes_remaining);
154 blocksize = sizeof(buf);
155 while (bytes_remaining > 0L) {
156 if (blocksize > bytes_remaining) blocksize = bytes_remaining;
157 fread(buf, blocksize, 1, tmp);
158 client_write(buf, blocksize);
159 bytes_remaining = bytes_remaining - blocksize;
168 * Load a specific part of a message into the temp file to be output to a
169 * client. FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
170 * but we still can't handle "2.HEADER" (which might not be a problem, because
171 * we currently don't have the ability to break out nested RFC822's anyway).
173 * Note: mime_parser() was called with dont_decode set to 1, so we have the
174 * luxury of simply spewing without having to re-encode.
176 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
177 void *content, char *cbtype, size_t length, char *encoding,
180 struct imap_fetch_part *imfp;
183 imfp = (struct imap_fetch_part *)cbuserdata;
185 if (!strcasecmp(partnum, imfp->desired_section)) {
186 fwrite(content, length, 1, imfp->output_fp);
189 sprintf(mbuf2, "%s.MIME", partnum);
191 if (!strcasecmp(imfp->desired_section, mbuf2)) {
192 fprintf(imfp->output_fp, "Content-type: %s", cbtype);
193 if (strlen(name) > 0)
194 fprintf(imfp->output_fp, "; name=\"%s\"", name);
195 fprintf(imfp->output_fp, "\r\n");
196 if (strlen(encoding) > 0)
197 fprintf(imfp->output_fp,
198 "Content-Transfer-Encoding: %s\r\n", encoding);
199 if (strlen(encoding) > 0) {
200 fprintf(imfp->output_fp, "Content-Disposition: %s",
202 if (strlen(filename) > 0) {
203 fprintf(imfp->output_fp, "; filename=\"%s\"",
206 fprintf(imfp->output_fp, "\r\n");
208 fprintf(imfp->output_fp, "Content-Length: %d\r\n", length);
209 fprintf(imfp->output_fp, "\r\n");
217 * Called by imap_fetch_envelope() to output the "From" field.
218 * This is in its own function because its logic is kind of complex. We
219 * really need to make this suck less.
221 void imap_output_envelope_from(struct CtdlMessage *msg) {
222 char user[1024], node[1024], name[1024];
224 cprintf("(("); /* open double-parens */
225 imap_strout(msg->cm_fields['A']); /* personal name */
226 cprintf(" NIL "); /* source route (not used) */
228 if (msg->cm_fields['F'] != NULL) {
229 process_rfc822_addr(msg->cm_fields['F'], user, node, name);
230 imap_strout(user); /* mailbox name (user id) */
232 if (!strcasecmp(node, config.c_nodename)) {
233 imap_strout(config.c_fqdn);
236 imap_strout(node); /* host name */
240 imap_strout(msg->cm_fields['A']); /* mailbox name (user id) */
242 imap_strout(msg->cm_fields['N']); /* host name */
245 cprintf(")) "); /* close double-parens */
250 * Implements the ENVELOPE fetch item
252 * FIXME ... we only output some of the fields right now. Definitely need
253 * to do all of them. Accurately, too.
255 * Note that the imap_strout() function can cleverly output NULL fields as NIL,
256 * so we don't have to check for that condition like we do elsewhere.
258 void imap_fetch_envelope(long msgnum, struct CtdlMessage *msg) {
259 char datestringbuf[256];
261 char *fieldptr = NULL;
263 /* Parse the message date into an IMAP-format date string */
264 if (msg->cm_fields['T'] != NULL) {
265 msgdate = atol(msg->cm_fields['T']);
268 msgdate = time(NULL);
270 datestring(datestringbuf, msgdate, DATESTRING_IMAP);
272 /* Now start spewing data fields. The order is important, as it is
273 * defined by the protocol specification. Nonexistent fields must
274 * be output as NIL, existent fields must be quoted or literalled.
275 * The imap_strout() function conveniently does all this for us.
277 cprintf("ENVELOPE (");
280 imap_strout(datestringbuf);
284 imap_strout(msg->cm_fields['U']);
288 imap_output_envelope_from(msg);
292 /* FIXME ... check for a *real* Sender: field */
295 imap_output_envelope_from(msg);
300 /* FIXME ... check for a *real* Reply-to: field */
303 imap_output_envelope_from(msg);
306 cprintf("NIL "); /* to */
308 cprintf("NIL "); /* cc */
310 cprintf("NIL "); /* bcc */
313 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "In-reply-to");
314 imap_strout(fieldptr);
316 if (fieldptr != NULL) phree(fieldptr);
319 imap_strout(msg->cm_fields['I']);
326 * Strip any non header information out of a chunk of RFC822 data on disk
328 void imap_strip_headers(FILE *fp) {
332 while (fgets(buf, sizeof buf, fp) != NULL) {
334 if (strlen(buf) == 0) {
336 ftruncate(fileno(fp), ftell(fp));
340 fprintf(fp, "\r\n"); /* add the trailing newline */
346 * Implements the BODY and BODY.PEEK fetch items
348 void imap_fetch_body(long msgnum, char *item, int is_peek,
349 struct CtdlMessage *msg) {
356 long bytes_remaining = 0;
359 struct imap_fetch_part imfp;
361 /* extract section */
362 strcpy(section, item);
363 for (i=0; i<strlen(section); ++i) {
364 if (section[i]=='[') strcpy(section, §ion[i+1]);
366 for (i=0; i<strlen(section); ++i) {
367 if (section[i]==']') section[i] = 0;
369 lprintf(9, "Section is %s\n", section);
371 /* extract partial */
372 strcpy(partial, item);
373 for (i=0; i<strlen(partial); ++i) {
374 if (partial[i]=='<') {
375 strcpy(partial, &partial[i+1]);
379 for (i=0; i<strlen(partial); ++i) {
380 if (partial[i]=='>') partial[i] = 0;
382 if (is_partial == 0) strcpy(partial, "");
383 lprintf(9, "Partial is %s\n", partial);
387 lprintf(1, "Cannot open temp file: %s\n", strerror(errno));
391 /* Now figure out what the client wants, and get it */
393 if (!strcmp(section, "")) { /* the whole thing */
394 CtdlRedirectOutput(tmp, -1);
395 CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 0, 0, 1);
396 CtdlRedirectOutput(NULL, -1);
400 * Be obnoxious and send the entire header, even if the client only
401 * asks for certain fields. FIXME this shortcut later.
403 else if (!strncasecmp(section, "HEADER", 6)) {
404 CtdlRedirectOutput(tmp, -1);
405 CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 1, 0, 1);
406 CtdlRedirectOutput(NULL, -1);
407 imap_strip_headers(tmp);
411 * Anything else must be a part specifier.
412 * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
415 safestrncpy(imfp.desired_section, section,
416 sizeof(imfp.desired_section));
417 imfp.output_fp = tmp;
419 mime_parser(msg->cm_fields['M'], NULL,
426 fseek(tmp, 0L, SEEK_END);
427 bytes_remaining = ftell(tmp);
429 if (is_partial == 0) {
431 cprintf("BODY[%s] {%ld}\r\n", section, bytes_remaining);
434 sscanf(partial, "%ld.%ld", &pstart, &pbytes);
435 if ((bytes_remaining - pstart) < pbytes) {
436 pbytes = bytes_remaining - pstart;
438 fseek(tmp, pstart, SEEK_SET);
439 bytes_remaining = pbytes;
440 cprintf("BODY[%s] {%ld}<%ld>\r\n",
441 section, bytes_remaining, pstart);
444 blocksize = sizeof(buf);
445 while (bytes_remaining > 0L) {
446 if (blocksize > bytes_remaining) blocksize = bytes_remaining;
447 fread(buf, blocksize, 1, tmp);
448 client_write(buf, blocksize);
449 bytes_remaining = bytes_remaining - blocksize;
455 /* FIXME set the last read pointer or something */
461 * Spew the BODYSTRUCTURE data for a message. (Do you need a silencer if
462 * you're going to shoot a MIME? Do you need a reason to shoot Mark Crispin?
465 * FIXME finish the implementation
467 void imap_fetch_bodystructure (long msgnum, char *item,
468 struct CtdlMessage *msg) {
475 /* For non-RFC822 (ordinary Citadel) messages, this is short and
478 if (msg->cm_format_type != FMT_RFC822) {
480 /* *sigh* We have to RFC822-format the message just to be able
484 if (tmp == NULL) return;
485 CtdlRedirectOutput(tmp, -1);
486 CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 0, 0, 1);
487 CtdlRedirectOutput(NULL, -1);
490 while (fgets(buf, sizeof buf, tmp) != NULL) ++lines;
494 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
495 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
496 "\"7BIT\" %ld %ld) ", bytes, lines);
501 /* For messages already stored in RFC822 format, we have to parse. */
513 * imap_do_fetch() calls imap_do_fetch_msg() to output the deta of an
514 * individual message, once it has been successfully loaded from disk.
516 void imap_do_fetch_msg(int seq, struct CtdlMessage *msg,
517 int num_items, char **itemlist) {
520 cprintf("* %d FETCH (", seq);
522 for (i=0; i<num_items; ++i) {
524 if (!strncasecmp(itemlist[i], "BODY[", 5)) {
525 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i],
528 else if (!strncasecmp(itemlist[i], "BODY.PEEK[", 10)) {
529 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i],
532 else if (!strcasecmp(itemlist[i], "BODYSTRUCTURE")) {
533 imap_fetch_bodystructure(IMAP->msgids[seq-1],
536 else if (!strcasecmp(itemlist[i], "ENVELOPE")) {
537 imap_fetch_envelope(IMAP->msgids[seq-1], msg);
539 else if (!strcasecmp(itemlist[i], "FLAGS")) {
540 imap_fetch_flags(msg);
542 else if (!strcasecmp(itemlist[i], "INTERNALDATE")) {
543 imap_fetch_internaldate(msg);
545 else if (!strcasecmp(itemlist[i], "RFC822")) {
546 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
548 else if (!strcasecmp(itemlist[i], "RFC822.HEADER")) {
549 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
551 else if (!strcasecmp(itemlist[i], "RFC822.SIZE")) {
552 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
554 else if (!strcasecmp(itemlist[i], "RFC822.TEXT")) {
555 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
557 else if (!strcasecmp(itemlist[i], "UID")) {
561 if (i != num_items-1) cprintf(" ");
570 * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
571 * validated and boiled down the request a bit.
573 void imap_do_fetch(int num_items, char **itemlist) {
575 struct CtdlMessage *msg;
577 if (IMAP->num_msgs > 0)
578 for (i = 0; i < IMAP->num_msgs; ++i)
579 if (IMAP->flags[i] && IMAP_FETCHED) {
580 msg = CtdlFetchMessage(IMAP->msgids[i]);
582 imap_do_fetch_msg(i+1, msg, num_items, itemlist);
583 CtdlFreeMessage(msg);
586 cprintf("* %d FETCH <internal error>\r\n", i+1);
594 * Back end for imap_handle_macros()
595 * Note that this function *only* looks at the beginning of the string. It
596 * is not a generic search-and-replace function.
598 void imap_macro_replace(char *str, char *find, char *replace) {
601 if (!strncasecmp(str, find, strlen(find))) {
602 if (str[strlen(find)]==' ') {
603 strcpy(holdbuf, &str[strlen(find)+1]);
604 strcpy(str, replace);
606 strcat(str, holdbuf);
608 if (str[strlen(find)]==0) {
609 strcpy(holdbuf, &str[strlen(find)+1]);
610 strcpy(str, replace);
618 * Handle macros embedded in FETCH data items.
619 * (What the heck are macros doing in a wire protocol? Are we trying to save
620 * the computer at the other end the trouble of typing a lot of characters?)
622 void imap_handle_macros(char *str) {
626 for (i=0; i<strlen(str); ++i) {
627 if (str[i]=='(') ++nest;
628 if (str[i]=='[') ++nest;
629 if (str[i]=='<') ++nest;
630 if (str[i]=='{') ++nest;
631 if (str[i]==')') --nest;
632 if (str[i]==']') --nest;
633 if (str[i]=='>') --nest;
634 if (str[i]=='}') --nest;
637 imap_macro_replace(&str[i],
639 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE"
641 imap_macro_replace(&str[i],
645 imap_macro_replace(&str[i],
647 "FLAGS INTERNALDATE RFC822.SIZE"
649 imap_macro_replace(&str[i],
651 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY"
659 * Break out the data items requested, possibly a parenthesized list.
660 * Returns the number of data items, or -1 if the list is invalid.
661 * NOTE: this function alters the string it is fed, and uses it as a buffer
662 * to hold the data for the pointers it returns.
664 int imap_extract_data_items(char **argv, char *items) {
670 /* Convert all whitespace to ordinary space characters. */
671 for (i=0; i<strlen(items); ++i) {
672 if (isspace(items[i])) items[i]=' ';
675 /* Strip leading and trailing whitespace, then strip leading and
676 * trailing parentheses if it's a list
679 if ( (items[0]=='(') && (items[strlen(items)-1]==')') ) {
680 items[strlen(items)-1] = 0;
681 strcpy(items, &items[1]);
685 /* Parse any macro data items */
686 imap_handle_macros(items);
689 * Now break out the data items. We throw in one trailing space in
690 * order to avoid having to break out the last one manually.
694 initial_len = strlen(items);
695 for (i=0; i<initial_len; ++i) {
696 if (items[i]=='(') ++nest;
697 if (items[i]=='[') ++nest;
698 if (items[i]=='<') ++nest;
699 if (items[i]=='{') ++nest;
700 if (items[i]==')') --nest;
701 if (items[i]==']') --nest;
702 if (items[i]=='>') --nest;
703 if (items[i]=='}') --nest;
705 if (nest <= 0) if (items[i]==' ') {
707 argv[num_items++] = start;
718 * One particularly hideous aspect of IMAP is that we have to allow the client
719 * to specify arbitrary ranges and/or sets of messages to fetch. Citadel IMAP
720 * handles this by setting the IMAP_FETCHED flag for each message specified in
721 * the ranges/sets, then looping through the message array, outputting messages
722 * with the flag set. We don't bother returning an error if an out-of-range
723 * number is specified (we just return quietly) because any client braindead
724 * enough to request a bogus message number isn't going to notice the
727 * This function clears out the IMAP_FETCHED bits, then sets that bit for each
728 * message included in the specified range.
730 * Set is_uid to 1 to fetch by UID instead of sequence number.
732 void imap_pick_range(char *range, int is_uid) {
736 char setstr[1024], lostr[1024], histr[1024];
740 actual_range = range;
741 if (!strcasecmp(range, "ALL")) actual_range = "1:*";
744 * Clear out the IMAP_FETCHED flags for all messages.
746 for (i = 1; i <= IMAP->num_msgs; ++i) {
747 IMAP->flags[i-1] = IMAP->flags[i-1] & ~IMAP_FETCHED;
751 * Now set it for all specified messages.
753 num_sets = num_tokens(actual_range, ',');
754 for (s=0; s<num_sets; ++s) {
755 extract_token(setstr, actual_range, s, ',');
757 extract_token(lostr, setstr, 0, ':');
758 if (num_tokens(setstr, ':') >= 2) {
759 extract_token(histr, setstr, 1, ':');
760 if (!strcmp(histr, "*")) sprintf(histr, "%d", INT_MAX);
763 strcpy(histr, lostr);
768 /* Loop through the array, flipping bits where appropriate */
769 for (i = 1; i <= IMAP->num_msgs; ++i) {
770 if (is_uid) { /* fetch by sequence number */
771 if ( (IMAP->msgids[i-1]>=lo)
772 && (IMAP->msgids[i-1]<=hi)) {
774 IMAP->flags[i-1] | IMAP_FETCHED;
777 else { /* fetch by uid */
778 if ( (i>=lo) && (i<=hi)) {
780 IMAP->flags[i-1] | IMAP_FETCHED;
790 * This function is called by the main command loop.
792 void imap_fetch(int num_parms, char *parms[]) {
799 cprintf("%s BAD invalid parameters\r\n", parms[0]);
803 imap_pick_range(parms[2], 0);
806 for (i=3; i<num_parms; ++i) {
807 strcat(items, parms[i]);
808 if (i < (num_parms-1)) strcat(items, " ");
811 num_items = imap_extract_data_items(itemlist, items);
813 cprintf("%s BAD invalid data item list\r\n", parms[0]);
817 imap_do_fetch(num_items, itemlist);
818 cprintf("%s OK FETCH completed\r\n", parms[0]);
822 * This function is called by the main command loop.
824 void imap_uidfetch(int num_parms, char *parms[]) {
829 int have_uid_item = 0;
832 cprintf("%s BAD invalid parameters\r\n", parms[0]);
836 imap_pick_range(parms[3], 1);
839 for (i=4; i<num_parms; ++i) {
840 strcat(items, parms[i]);
841 if (i < (num_parms-1)) strcat(items, " ");
844 num_items = imap_extract_data_items(itemlist, items);
846 cprintf("%s BAD invalid data item list\r\n", parms[0]);
850 /* If the "UID" item was not included, we include it implicitly
851 * because this is a UID FETCH command
853 for (i=0; i<num_items; ++i) {
854 if (!strcasecmp(itemlist[i], "UID")) ++have_uid_item;
856 if (have_uid_item == 0) itemlist[num_items++] = "UID";
858 imap_do_fetch(num_items, itemlist);
859 cprintf("%s OK UID FETCH completed\r\n", parms[0]);