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) {
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 CtdlOutputMsg(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 have to actually do something useful here.
218 void imap_fetch_envelope(long msgnum, struct CtdlMessage *msg) {
219 cprintf("ENVELOPE (");
220 cprintf("NIL "); /* date */
221 cprintf("NIL "); /* subject */
222 cprintf("NIL "); /* from */
223 cprintf("NIL "); /* sender */
224 cprintf("NIL "); /* reply-to */
225 cprintf("NIL "); /* to */
226 cprintf("NIL "); /* cc */
227 cprintf("NIL "); /* bcc */
228 cprintf("NIL "); /* in-reply-to */
229 cprintf("NIL"); /* message-id */
235 * Strip any non header information out of a chunk of RFC822 data on disk
237 void imap_strip_headers(FILE *fp) {
241 while (fgets(buf, sizeof buf, fp) != NULL) {
243 if (strlen(buf) == 0) {
244 ftruncate(fileno(fp), ftell(fp));
248 fprintf(fp, "\r\n"); /* add the trailing newline */
254 * Implements the BODY and BODY.PEEK fetch items
256 void imap_fetch_body(long msgnum, char *item, int is_peek,
257 struct CtdlMessage *msg) {
264 long bytes_remaining = 0;
267 struct imap_fetch_part imfp;
269 /* extract section */
270 strcpy(section, item);
271 for (i=0; i<strlen(section); ++i) {
272 if (section[i]=='[') strcpy(section, §ion[i+1]);
274 for (i=0; i<strlen(section); ++i) {
275 if (section[i]==']') section[i] = 0;
277 lprintf(9, "Section is %s\n", section);
279 /* extract partial */
280 strcpy(partial, item);
281 for (i=0; i<strlen(partial); ++i) {
282 if (partial[i]=='<') {
283 strcpy(partial, &partial[i+1]);
287 for (i=0; i<strlen(partial); ++i) {
288 if (partial[i]=='>') partial[i] = 0;
290 lprintf(9, "Partial is %s\n", partial);
294 lprintf(1, "Cannot open temp file: %s\n", strerror(errno));
298 /* Now figure out what the client wants, and get it */
300 if (!strcmp(section, "")) { /* the whole thing */
301 CtdlRedirectOutput(tmp, -1);
302 CtdlOutputMsg(msgnum, MT_RFC822, 0, 0, 1);
303 CtdlRedirectOutput(NULL, -1);
307 * Be obnoxious and send the entire header, even if the client only
308 * asks for certain fields. FIXME this shortcut later.
310 else if (!strncasecmp(section, "HEADER", 6)) {
311 CtdlRedirectOutput(tmp, -1);
312 CtdlOutputMsg(msgnum, MT_RFC822, 1, 0, 1);
313 CtdlRedirectOutput(NULL, -1);
314 imap_strip_headers(tmp);
318 * Anything else must be a part specifier.
319 * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
322 safestrncpy(imfp.desired_section, section,
323 sizeof(imfp.desired_section));
324 imfp.output_fp = tmp;
326 mime_parser(msg->cm_fields['M'], NULL,
333 fseek(tmp, 0L, SEEK_END);
334 bytes_remaining = ftell(tmp);
336 if (is_partial == 0) {
338 cprintf("BODY[%s] {%ld}\r\n", section, bytes_remaining);
341 sscanf(partial, "%ld.%ld", &pstart, &pbytes);
342 if ((bytes_remaining - pstart) < pbytes) {
343 pbytes = bytes_remaining - pstart;
345 fseek(tmp, pstart, SEEK_SET);
346 bytes_remaining = pbytes;
347 cprintf("BODY[%s] {%ld}<%ld>\r\n",
348 section, bytes_remaining, pstart);
351 blocksize = sizeof(buf);
352 while (bytes_remaining > 0L) {
353 if (blocksize > bytes_remaining) blocksize = bytes_remaining;
354 fread(buf, blocksize, 1, tmp);
355 client_write(buf, blocksize);
356 bytes_remaining = bytes_remaining - blocksize;
362 /* FIXME set the last read pointer or something */
369 * imap_do_fetch() calls imap_do_fetch_msg() to output the deta of an
370 * individual message, once it has been successfully loaded from disk.
372 void imap_do_fetch_msg(int seq, struct CtdlMessage *msg,
373 int num_items, char **itemlist) {
376 cprintf("* %d FETCH (", seq);
378 for (i=0; i<num_items; ++i) {
380 if (!strncasecmp(itemlist[i], "BODY[", 5)) {
381 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i],
384 else if (!strncasecmp(itemlist[i], "BODY.PEEK[", 10)) {
385 imap_fetch_body(IMAP->msgids[seq-1], itemlist[i],
388 else if (!strcasecmp(itemlist[i], "BODYSTRUCTURE")) {
389 /* FIXME do something here */
391 else if (!strcasecmp(itemlist[i], "ENVELOPE")) {
392 imap_fetch_envelope(IMAP->msgids[seq-1], msg);
394 else if (!strcasecmp(itemlist[i], "FLAGS")) {
395 imap_fetch_flags(msg);
397 else if (!strcasecmp(itemlist[i], "INTERNALDATE")) {
398 imap_fetch_internaldate(msg);
400 else if (!strcasecmp(itemlist[i], "RFC822")) {
401 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
403 else if (!strcasecmp(itemlist[i], "RFC822.HEADER")) {
404 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
406 else if (!strcasecmp(itemlist[i], "RFC822.SIZE")) {
407 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
409 else if (!strcasecmp(itemlist[i], "RFC822.TEXT")) {
410 imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
412 else if (!strcasecmp(itemlist[i], "UID")) {
416 if (i != num_items-1) cprintf(" ");
425 * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
426 * validated and boiled down the request a bit.
428 void imap_do_fetch(int num_items, char **itemlist) {
430 struct CtdlMessage *msg;
432 if (IMAP->num_msgs > 0)
433 for (i = 0; i < IMAP->num_msgs; ++i)
434 if (IMAP->flags[i] && IMAP_FETCHED) {
435 msg = CtdlFetchMessage(IMAP->msgids[i]);
437 imap_do_fetch_msg(i+1, msg, num_items, itemlist);
438 CtdlFreeMessage(msg);
441 cprintf("* %d FETCH <internal error>\r\n", i+1);
449 * Back end for imap_handle_macros()
450 * Note that this function *only* looks at the beginning of the string. It
451 * is not a generic search-and-replace function.
453 void imap_macro_replace(char *str, char *find, char *replace) {
456 if (!strncasecmp(str, find, strlen(find))) {
457 if (str[strlen(find)]==' ') {
458 strcpy(holdbuf, &str[strlen(find)+1]);
459 strcpy(str, replace);
461 strcat(str, holdbuf);
463 if (str[strlen(find)]==0) {
464 strcpy(holdbuf, &str[strlen(find)+1]);
465 strcpy(str, replace);
473 * Handle macros embedded in FETCH data items.
474 * (What the heck are macros doing in a wire protocol? Are we trying to save
475 * the computer at the other end the trouble of typing a lot of characters?)
477 void imap_handle_macros(char *str) {
481 for (i=0; i<strlen(str); ++i) {
482 if (str[i]=='(') ++nest;
483 if (str[i]=='[') ++nest;
484 if (str[i]=='<') ++nest;
485 if (str[i]=='{') ++nest;
486 if (str[i]==')') --nest;
487 if (str[i]==']') --nest;
488 if (str[i]=='>') --nest;
489 if (str[i]=='}') --nest;
492 imap_macro_replace(&str[i],
494 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE"
496 imap_macro_replace(&str[i],
500 imap_macro_replace(&str[i],
502 "FLAGS INTERNALDATE RFC822.SIZE"
504 imap_macro_replace(&str[i],
506 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY"
514 * Break out the data items requested, possibly a parenthesized list.
515 * Returns the number of data items, or -1 if the list is invalid.
516 * NOTE: this function alters the string it is fed, and uses it as a buffer
517 * to hold the data for the pointers it returns.
519 int imap_extract_data_items(char **argv, char *items) {
525 /* Convert all whitespace to ordinary space characters. */
526 for (i=0; i<strlen(items); ++i) {
527 if (isspace(items[i])) items[i]=' ';
530 /* Strip leading and trailing whitespace, then strip leading and
531 * trailing parentheses if it's a list
534 if ( (items[0]=='(') && (items[strlen(items)-1]==')') ) {
535 items[strlen(items)-1] = 0;
536 strcpy(items, &items[1]);
540 /* Parse any macro data items */
541 imap_handle_macros(items);
544 * Now break out the data items. We throw in one trailing space in
545 * order to avoid having to break out the last one manually.
549 initial_len = strlen(items);
550 for (i=0; i<initial_len; ++i) {
551 if (items[i]=='(') ++nest;
552 if (items[i]=='[') ++nest;
553 if (items[i]=='<') ++nest;
554 if (items[i]=='{') ++nest;
555 if (items[i]==')') --nest;
556 if (items[i]==']') --nest;
557 if (items[i]=='>') --nest;
558 if (items[i]=='}') --nest;
560 if (nest <= 0) if (items[i]==' ') {
562 argv[num_items++] = start;
573 * One particularly hideous aspect of IMAP is that we have to allow the client
574 * to specify arbitrary ranges and/or sets of messages to fetch. Citadel IMAP
575 * handles this by setting the IMAP_FETCHED flag for each message specified in
576 * the ranges/sets, then looping through the message array, outputting messages
577 * with the flag set. We don't bother returning an error if an out-of-range
578 * number is specified (we just return quietly) because any client braindead
579 * enough to request a bogus message number isn't going to notice the
582 * This function clears out the IMAP_FETCHED bits, then sets that bit for each
583 * message included in the specified range.
585 * Set is_uid to 1 to fetch by UID instead of sequence number.
587 void imap_pick_range(char *range, int is_uid) {
591 char setstr[1024], lostr[1024], histr[1024];
595 * Clear out the IMAP_FETCHED flags for all messages.
597 for (i = 1; i <= IMAP->num_msgs; ++i) {
598 IMAP->flags[i-1] = IMAP->flags[i-1] & ~IMAP_FETCHED;
602 * Now set it for all specified messages.
604 num_sets = num_tokens(range, ',');
605 for (s=0; s<num_sets; ++s) {
606 extract_token(setstr, range, s, ',');
608 extract_token(lostr, setstr, 0, ':');
609 if (num_tokens(setstr, ':') >= 2) {
610 extract_token(histr, setstr, 1, ':');
611 if (!strcmp(histr, "*")) sprintf(histr, "%d", INT_MAX);
614 strcpy(histr, lostr);
619 /* Loop through the array, flipping bits where appropriate */
620 for (i = 1; i <= IMAP->num_msgs; ++i) {
621 if (is_uid) { /* fetch by sequence number */
622 if ( (IMAP->msgids[i-1]>=lo)
623 && (IMAP->msgids[i-1]<=hi)) {
625 IMAP->flags[i-1] | IMAP_FETCHED;
628 else { /* fetch by uid */
629 if ( (i>=lo) && (i<=hi)) {
631 IMAP->flags[i-1] | IMAP_FETCHED;
641 * This function is called by the main command loop.
643 void imap_fetch(int num_parms, char *parms[]) {
650 cprintf("%s BAD invalid parameters\r\n", parms[0]);
654 imap_pick_range(parms[2], 0);
657 for (i=3; i<num_parms; ++i) {
658 strcat(items, parms[i]);
659 if (i < (num_parms-1)) strcat(items, " ");
662 num_items = imap_extract_data_items(itemlist, items);
664 cprintf("%s BAD invalid data item list\r\n", parms[0]);
668 imap_do_fetch(num_items, itemlist);
669 cprintf("%s OK FETCH completed\r\n", parms[0]);
673 * This function is called by the main command loop.
675 void imap_uidfetch(int num_parms, char *parms[]) {
680 int have_uid_item = 0;
683 cprintf("%s BAD invalid parameters\r\n", parms[0]);
687 imap_pick_range(parms[3], 1);
690 for (i=4; i<num_parms; ++i) {
691 strcat(items, parms[i]);
692 if (i < (num_parms-1)) strcat(items, " ");
695 num_items = imap_extract_data_items(itemlist, items);
697 cprintf("%s BAD invalid data item list\r\n", parms[0]);
701 /* If the "UID" item was not included, we include it implicitly
702 * because this is a UID FETCH command
704 for (i=0; i<num_items; ++i) {
705 if (!strcasecmp(itemlist[i], "UID")) ++have_uid_item;
707 if (have_uid_item == 0) itemlist[num_items++] = "UID";
709 imap_do_fetch(num_items, itemlist);
710 cprintf("%s OK UID FETCH completed\r\n", parms[0]);