4 * Implements the FETCH command in IMAP.
5 * This is a good example of the protocol's gratuitous complexity.
7 * Copyright (c) 2001-2009 by the citadel.org team
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33 #include <sys/types.h>
35 #if TIME_WITH_SYS_TIME
36 # include <sys/time.h>
40 # include <sys/time.h>
50 #include <libcitadel.h>
53 #include "sysdep_decls.h"
54 #include "citserver.h"
61 #include "internet_addressing.h"
62 #include "imap_tools.h"
63 #include "serv_imap.h"
64 #include "imap_fetch.h"
66 #include "ctdl_module.h"
71 * Individual field functions for imap_do_fetch_msg() ...
74 void imap_fetch_uid(int seq) {
75 cprintf("UID %ld", IMAP->msgids[seq-1]);
78 void imap_fetch_flags(int seq) {
79 int num_flags_printed = 0;
81 if (IMAP->flags[seq] & IMAP_DELETED) {
82 if (num_flags_printed > 0) cprintf(" ");
86 if (IMAP->flags[seq] & IMAP_SEEN) {
87 if (num_flags_printed > 0) cprintf(" ");
91 if (IMAP->flags[seq] & IMAP_ANSWERED) {
92 if (num_flags_printed > 0) cprintf(" ");
93 cprintf("\\Answered");
96 if (IMAP->flags[seq] & IMAP_RECENT) {
97 if (num_flags_printed > 0) cprintf(" ");
105 void imap_fetch_internaldate(struct CtdlMessage *msg) {
110 if (msg->cm_fields['T'] != NULL) {
111 msgdate = atol(msg->cm_fields['T']);
114 msgdate = time(NULL);
117 datestring(buf, sizeof buf, msgdate, DATESTRING_IMAP);
118 cprintf("INTERNALDATE \"%s\"", buf);
123 * Fetch RFC822-formatted messages.
125 * 'whichfmt' should be set to one of:
126 * "RFC822" entire message
127 * "RFC822.HEADER" headers only (with trailing blank line)
128 * "RFC822.SIZE" size of translated message
129 * "RFC822.TEXT" body only (without leading blank line)
131 void imap_fetch_rfc822(long msgnum, const char *whichfmt) {
133 const char *ptr = NULL;
134 size_t headers_size, text_size, total_size;
135 size_t bytes_to_send = 0;
137 int need_to_rewrite_metadata = 0;
140 /* Determine whether this particular fetch operation requires
141 * us to fetch the message body from disk. If not, we can save
142 * on some disk operations...
144 if ( (!strcasecmp(whichfmt, "RFC822"))
145 || (!strcasecmp(whichfmt, "RFC822.TEXT")) ) {
149 /* If this is an RFC822.SIZE fetch, first look in the message's
150 * metadata record to see if we've saved that information.
152 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
153 GetMetaData(&smi, msgnum);
154 if (smi.meta_rfc822_length > 0L) {
155 cprintf("RFC822.SIZE %ld", smi.meta_rfc822_length);
158 need_to_rewrite_metadata = 1;
162 /* Cache the most recent RFC822 FETCH because some clients like to
163 * fetch in pieces, and we don't want to have to go back to the
164 * message store for each piece. We also burn the cache if the
165 * client requests something that involves reading the message
166 * body, but we haven't fetched the body yet.
168 if ((IMAP->cached_rfc822_data != NULL)
169 && (IMAP->cached_rfc822_msgnum == msgnum)
170 && (IMAP->cached_rfc822_withbody || (!need_body)) ) {
173 else if (IMAP->cached_rfc822_data != NULL) {
174 /* Some other message is cached -- free it */
175 free(IMAP->cached_rfc822_data);
176 IMAP->cached_rfc822_data = NULL;
177 IMAP->cached_rfc822_msgnum = (-1);
178 IMAP->cached_rfc822_len = 0;
181 /* At this point, we now can fetch and convert the message iff it's not
182 * the one we had cached.
184 if (IMAP->cached_rfc822_data == NULL) {
186 * Load the message into memory for translation & measurement
188 CC->redirect_buffer = malloc(SIZ);
189 CC->redirect_len = 0;
190 CC->redirect_alloc = SIZ;
191 CtdlOutputMsg(msgnum, MT_RFC822,
192 (need_body ? HEADERS_ALL : HEADERS_FAST),
193 0, 1, NULL, SUPPRESS_ENV_TO
195 if (!need_body) cprintf("\r\n"); /* extra trailing newline */
196 IMAP->cached_rfc822_data = CC->redirect_buffer;
197 IMAP->cached_rfc822_len = CC->redirect_len;
198 IMAP->cached_rfc822_msgnum = msgnum;
199 IMAP->cached_rfc822_withbody = need_body;
200 CC->redirect_buffer = NULL;
201 CC->redirect_len = 0;
202 CC->redirect_alloc = 0;
203 if ( (need_to_rewrite_metadata) && (IMAP->cached_rfc822_len > 0) ) {
204 smi.meta_rfc822_length = (long)IMAP->cached_rfc822_len;
210 * Now figure out where the headers/text break is. IMAP considers the
211 * intervening blank line to be part of the headers, not the text.
218 ptr = IMAP->cached_rfc822_data;
220 ptr = memreadline(ptr, buf, sizeof buf);
223 if (IsEmptyStr(buf)) {
224 headers_size = ptr - IMAP->cached_rfc822_data;
227 } while ( (headers_size == 0) && (*ptr != 0) );
229 total_size = IMAP->cached_rfc822_len;
230 text_size = total_size - headers_size;
233 headers_size = IMAP->cached_rfc822_len;
234 total_size = IMAP->cached_rfc822_len;
238 CtdlLogPrintf(CTDL_DEBUG,
239 "RFC822: headers=" SIZE_T_FMT
241 ", total=" SIZE_T_FMT "\n",
242 headers_size, text_size, total_size);
244 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
245 cprintf("RFC822.SIZE " SIZE_T_FMT, total_size);
249 else if (!strcasecmp(whichfmt, "RFC822")) {
250 ptr = IMAP->cached_rfc822_data;
251 bytes_to_send = total_size;
254 else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
255 ptr = IMAP->cached_rfc822_data;
256 bytes_to_send = headers_size;
259 else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
260 ptr = &IMAP->cached_rfc822_data[headers_size];
261 bytes_to_send = text_size;
264 cprintf("%s {" SIZE_T_FMT "}\r\n", whichfmt, bytes_to_send);
265 client_write(ptr, bytes_to_send);
271 * Load a specific part of a message into the temp file to be output to a
272 * client. FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
273 * but we still can't handle "2.HEADER" (which might not be a problem).
275 * Note: mime_parser() was called with dont_decode set to 1, so we have the
276 * luxury of simply spewing without having to re-encode.
278 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
279 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
280 char *cbid, void *cbuserdata)
283 char *desired_section;
285 desired_section = (char *)cbuserdata;
287 if (!strcasecmp(partnum, desired_section)) {
288 client_write(content, length);
291 snprintf(mbuf2, sizeof mbuf2, "%s.MIME", partnum);
293 if (!strcasecmp(desired_section, mbuf2)) {
294 cprintf("Content-type: %s", cbtype);
295 if (!IsEmptyStr(cbcharset))
296 cprintf("; charset=\"%s\"", cbcharset);
297 if (!IsEmptyStr(name))
298 cprintf("; name=\"%s\"", name);
300 if (!IsEmptyStr(encoding))
301 cprintf("Content-Transfer-Encoding: %s\r\n", encoding);
302 if (!IsEmptyStr(encoding)) {
303 cprintf("Content-Disposition: %s", disp);
304 if (!IsEmptyStr(filename)) {
305 cprintf("; filename=\"%s\"", filename);
309 cprintf("Content-Length: %ld\r\n", (long)length);
318 * Called by imap_fetch_envelope() to output the "From" field.
319 * This is in its own function because its logic is kind of complex. We
320 * really need to make this suck less.
322 void imap_output_envelope_from(struct CtdlMessage *msg) {
323 char user[SIZ], node[SIZ], name[SIZ];
327 /* For anonymous messages, it's so easy! */
328 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONONLY)) {
329 cprintf("((\"----\" NIL \"x\" \"x.org\")) ");
332 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONOPT)) {
333 cprintf("((\"anonymous\" NIL \"x\" \"x.org\")) ");
337 /* For everything else, we do stuff. */
338 cprintf("(("); /* open double-parens */
339 plain_imap_strout(msg->cm_fields['A']); /* personal name */
340 cprintf(" NIL "); /* source route (not used) */
343 if (msg->cm_fields['F'] != NULL) {
344 process_rfc822_addr(msg->cm_fields['F'], user, node, name);
345 plain_imap_strout(user); /* mailbox name (user id) */
347 if (!strcasecmp(node, config.c_nodename)) {
348 plain_imap_strout(config.c_fqdn);
351 plain_imap_strout(node); /* host name */
355 plain_imap_strout(msg->cm_fields['A']); /* mailbox name (user id) */
357 plain_imap_strout(msg->cm_fields['N']); /* host name */
360 cprintf(")) "); /* close double-parens */
366 * Output an envelope address (or set of addresses) in the official,
367 * convoluted, braindead format. (Note that we can't use this for
368 * the "From" address because its data may come from a number of different
369 * fields. But we can use it for "To" and possibly others.
371 void imap_output_envelope_addr(char *addr) {
372 char individual_addr[256];
384 if (IsEmptyStr(addr)) {
391 /* How many addresses are listed here? */
392 num_addrs = num_tokens(addr, ',');
394 /* Output them one by one. */
395 for (i=0; i<num_addrs; ++i) {
396 extract_token(individual_addr, addr, i, ',', sizeof individual_addr);
397 striplt(individual_addr);
398 process_rfc822_addr(individual_addr, user, node, name);
400 plain_imap_strout(name);
402 plain_imap_strout(user);
404 plain_imap_strout(node);
406 if (i < (num_addrs-1)) cprintf(" ");
414 * Implements the ENVELOPE fetch item
416 * Note that the imap_strout() function can cleverly output NULL fields as NIL,
417 * so we don't have to check for that condition like we do elsewhere.
419 void imap_fetch_envelope(struct CtdlMessage *msg) {
420 char datestringbuf[SIZ];
422 char *fieldptr = NULL;
426 /* Parse the message date into an IMAP-format date string */
427 if (msg->cm_fields['T'] != NULL) {
428 msgdate = atol(msg->cm_fields['T']);
431 msgdate = time(NULL);
433 datestring(datestringbuf, sizeof datestringbuf,
434 msgdate, DATESTRING_IMAP);
436 /* Now start spewing data fields. The order is important, as it is
437 * defined by the protocol specification. Nonexistent fields must
438 * be output as NIL, existent fields must be quoted or literalled.
439 * The imap_strout() function conveniently does all this for us.
441 cprintf("ENVELOPE (");
444 plain_imap_strout(datestringbuf);
448 plain_imap_strout(msg->cm_fields['U']);
452 imap_output_envelope_from(msg);
454 /* Sender (default to same as 'From' if not present) */
455 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Sender");
456 if (fieldptr != NULL) {
457 imap_output_envelope_addr(fieldptr);
461 imap_output_envelope_from(msg);
465 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Reply-to");
466 if (fieldptr != NULL) {
467 imap_output_envelope_addr(fieldptr);
471 imap_output_envelope_from(msg);
475 imap_output_envelope_addr(msg->cm_fields['R']);
477 /* Cc (we do it this way because there might be a legacy non-Citadel Cc: field present) */
478 fieldptr = msg->cm_fields['Y'];
479 if (fieldptr != NULL) {
480 imap_output_envelope_addr(fieldptr);
483 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Cc");
484 imap_output_envelope_addr(fieldptr);
485 if (fieldptr != NULL) free(fieldptr);
489 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Bcc");
490 imap_output_envelope_addr(fieldptr);
491 if (fieldptr != NULL) free(fieldptr);
494 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "In-reply-to");
495 plain_imap_strout(fieldptr);
497 if (fieldptr != NULL) free(fieldptr);
500 plain_imap_strout(msg->cm_fields['I']);
506 * This function is called only when CC->redirect_buffer contains a set of
507 * RFC822 headers with no body attached. Its job is to strip that set of
508 * headers down to *only* the ones we're interested in.
510 void imap_strip_headers(char *section) {
512 char *which_fields = NULL;
513 int doing_headers = 0;
518 char *boiled_headers = NULL;
520 int done_headers = 0;
521 const char *ptr = NULL;
523 if (CC->redirect_buffer == NULL) return;
525 which_fields = strdup(section);
527 if (!strncasecmp(which_fields, "HEADER.FIELDS", 13))
529 if (!strncasecmp(which_fields, "HEADER.FIELDS.NOT", 17))
532 for (i=0; which_fields[i]; ++i) {
533 if (which_fields[i]=='(')
534 strcpy(which_fields, &which_fields[i+1]);
536 for (i=0; which_fields[i]; ++i) {
537 if (which_fields[i]==')') {
542 num_parms = old_imap_parameterize(parms, which_fields);
544 boiled_headers = malloc(CC->redirect_alloc);
545 strcpy(boiled_headers, "");
547 ptr = CC->redirect_buffer;
550 ptr = memreadline(ptr, buf, sizeof buf);
551 if (!isspace(buf[0])) {
553 if (doing_headers == 0) ok = 1;
555 if (headers_not) ok = 1;
557 for (i=0; i<num_parms; ++i) {
558 if ( (!strncasecmp(buf, parms[i],
559 strlen(parms[i]))) &&
560 (buf[strlen(parms[i])]==':') ) {
561 if (headers_not) ok = 0;
569 strcat(boiled_headers, buf);
570 strcat(boiled_headers, "\r\n");
573 if (IsEmptyStr(buf)) done_headers = 1;
574 if (buf[0]=='\r') done_headers = 1;
575 if (buf[0]=='\n') done_headers = 1;
576 if (*ptr == 0) done_headers = 1;
577 } while (!done_headers);
579 strcat(boiled_headers, "\r\n");
581 /* Now save it back (it'll always be smaller) */
582 strcpy(CC->redirect_buffer, boiled_headers);
583 CC->redirect_len = strlen(boiled_headers);
586 free(boiled_headers);
591 * Implements the BODY and BODY.PEEK fetch items
593 void imap_fetch_body(long msgnum, const char *item, int is_peek) {
594 struct CtdlMessage *msg = NULL;
598 size_t pstart, pbytes;
599 int loading_body_now = 0;
601 int burn_the_cache = 0;
603 /* extract section */
604 safestrncpy(section, item, sizeof section);
605 if (strchr(section, '[') != NULL) {
606 stripallbut(section, '[', ']');
608 CtdlLogPrintf(CTDL_DEBUG, "Section is: %s%s\n",
610 IsEmptyStr(section) ? "(empty)" : ""
613 /* Burn the cache if we don't have the same section of the
614 * same message again.
616 if (IMAP->cached_body != NULL) {
617 if (IMAP->cached_bodymsgnum != msgnum) {
620 else if ( (!IMAP->cached_body_withbody) && (need_body) ) {
623 else if (strcasecmp(IMAP->cached_bodypart, section)) {
626 if (burn_the_cache) {
627 /* Yup, go ahead and burn the cache. */
628 free(IMAP->cached_body);
629 IMAP->cached_body_len = 0;
630 IMAP->cached_body = NULL;
631 IMAP->cached_bodymsgnum = (-1);
632 strcpy(IMAP->cached_bodypart, "");
636 /* extract partial */
637 safestrncpy(partial, item, sizeof partial);
638 if (strchr(partial, '<') != NULL) {
639 stripallbut(partial, '<', '>');
642 if (is_partial == 0) strcpy(partial, "");
643 /* if (!IsEmptyStr(partial)) CtdlLogPrintf(CTDL_DEBUG, "Partial is %s\n", partial); */
645 if (IMAP->cached_body == NULL) {
646 CC->redirect_buffer = malloc(SIZ);
647 CC->redirect_len = 0;
648 CC->redirect_alloc = SIZ;
649 loading_body_now = 1;
650 msg = CtdlFetchMessage(msgnum, (need_body ? 1 : 0));
653 /* Now figure out what the client wants, and get it */
655 if (!loading_body_now) {
656 /* What we want is already in memory */
659 else if ( (!strcmp(section, "1")) && (msg->cm_format_type != 4) ) {
660 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
663 else if (!strcmp(section, "")) {
664 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, SUPPRESS_ENV_TO);
668 * If the client asked for just headers, or just particular header
669 * fields, strip it down.
671 else if (!strncasecmp(section, "HEADER", 6)) {
672 /* This used to work with HEADERS_FAST, but then Apple got stupid with their
673 * IMAP library and this broke Mail.App and iPhone Mail, so we had to change it
674 * to HEADERS_ONLY so the trendy hipsters with their iPhones can read mail.
676 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, SUPPRESS_ENV_TO);
677 imap_strip_headers(section);
681 * Strip it down if the client asked for everything _except_ headers.
683 else if (!strncasecmp(section, "TEXT", 4)) {
684 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
688 * Anything else must be a part specifier.
689 * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
692 mime_parser(msg->cm_fields['M'], NULL,
693 *imap_load_part, NULL, NULL,
698 if (loading_body_now) {
699 IMAP->cached_body = CC->redirect_buffer;
700 IMAP->cached_body_len = CC->redirect_len;
701 IMAP->cached_bodymsgnum = msgnum;
702 IMAP->cached_body_withbody = need_body;
703 strcpy(IMAP->cached_bodypart, section);
704 CC->redirect_buffer = NULL;
705 CC->redirect_len = 0;
706 CC->redirect_alloc = 0;
709 if (is_partial == 0) {
710 cprintf("BODY[%s] {" SIZE_T_FMT "}\r\n", section, IMAP->cached_body_len);
712 pbytes = IMAP->cached_body_len;
715 sscanf(partial, SIZE_T_FMT "." SIZE_T_FMT, &pstart, &pbytes);
716 if (pbytes > (IMAP->cached_body_len - pstart)) {
717 pbytes = IMAP->cached_body_len - pstart;
719 cprintf("BODY[%s]<" SIZE_T_FMT "> {" SIZE_T_FMT "}\r\n", section, pstart, pbytes);
722 /* Here we go -- output it */
723 client_write(&IMAP->cached_body[pstart], pbytes);
726 CtdlFreeMessage(msg);
729 /* Mark this message as "seen" *unless* this is a "peek" operation */
731 CtdlSetSeen(&msgnum, 1, 1, ctdlsetseen_seen, NULL, NULL);
736 * Called immediately before outputting a multipart bodystructure
738 void imap_fetch_bodystructure_pre(
739 char *name, char *filename, char *partnum, char *disp,
740 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
741 char *cbid, void *cbuserdata
750 * Called immediately after outputting a multipart bodystructure
752 void imap_fetch_bodystructure_post(
753 char *name, char *filename, char *partnum, char *disp,
754 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
755 char *cbid, void *cbuserdata
763 extract_token(subtype, cbtype, 1, '/', sizeof subtype);
764 plain_imap_strout(subtype);
767 /* cprintf(" NIL"); We thought we needed this at one point, but maybe we don't... */
775 * Output the info for a MIME part in the format required by BODYSTRUCTURE.
778 void imap_fetch_bodystructure_part(
779 char *name, char *filename, char *partnum, char *disp,
780 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
781 char *cbid, void *cbuserdata
785 int have_encoding = 0;
788 char cbmaintype[128];
791 if (cbtype != NULL) if (!IsEmptyStr(cbtype)) have_cbtype = 1;
793 extract_token(cbmaintype, cbtype, 0, '/', sizeof cbmaintype);
794 extract_token(cbsubtype, cbtype, 1, '/', sizeof cbsubtype);
797 strcpy(cbmaintype, "TEXT");
798 strcpy(cbsubtype, "PLAIN");
802 plain_imap_strout(cbmaintype); /* body type */
804 plain_imap_strout(cbsubtype); /* body subtype */
807 cprintf("("); /* begin body parameter list */
809 /* "NAME" must appear as the first parameter. This is not required by IMAP,
810 * but the Asterisk voicemail application blindly assumes that NAME will be in
811 * the first position. If it isn't, it rejects the message.
813 if (name != NULL) if (!IsEmptyStr(name)) {
814 cprintf("\"NAME\" ");
815 plain_imap_strout(name);
819 cprintf("\"CHARSET\" ");
820 if (cbcharset == NULL) {
821 plain_imap_strout("US-ASCII");
823 else if (cbcharset[0] == 0) {
824 plain_imap_strout("US-ASCII");
827 plain_imap_strout(cbcharset);
829 cprintf(") "); /* end body parameter list */
831 cprintf("NIL "); /* Body ID */
832 cprintf("NIL "); /* Body description */
834 if (encoding != NULL) if (encoding[0] != 0) have_encoding = 1;
836 plain_imap_strout(encoding);
839 plain_imap_strout("7BIT");
843 /* The next field is the size of the part in bytes. */
844 cprintf("%ld ", (long)length); /* bytes */
846 /* The next field is the number of lines in the part, if and only
847 * if the part is TEXT. More gratuitous complexity.
849 if (!strcasecmp(cbmaintype, "TEXT")) {
850 if (length) for (i=0; i<length; ++i) {
851 if (((char *)content)[i] == '\n') ++lines;
853 cprintf("%d ", lines);
856 /* More gratuitous complexity */
857 if ((!strcasecmp(cbmaintype, "MESSAGE"))
858 && (!strcasecmp(cbsubtype, "RFC822"))) {
859 /* FIXME: message/rfc822 also needs to output the envelope structure,
860 * body structure, and line count of the encapsulated message. Fortunately
861 * there are not yet any clients depending on this, so we can get away
862 * with not implementing it for now.
866 /* MD5 value of body part; we can get away with NIL'ing this */
873 else if (IsEmptyStr(disp)) {
878 plain_imap_strout(disp);
879 if (filename != NULL) if (!IsEmptyStr(filename)) {
880 cprintf(" (\"FILENAME\" ");
881 plain_imap_strout(filename);
887 /* Body language (not defined yet) */
894 * Spew the BODYSTRUCTURE data for a message.
897 void imap_fetch_bodystructure (long msgnum, const char *item,
898 struct CtdlMessage *msg) {
899 const char *rfc822 = NULL;
900 const char *rfc822_body = NULL;
902 size_t rfc822_headers_len;
903 size_t rfc822_body_len;
904 const char *ptr = NULL;
909 /* Handle NULL message gracefully */
911 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
912 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
917 /* For non-RFC822 (ordinary Citadel) messages, this is short and
920 if (msg->cm_format_type != FMT_RFC822) {
922 /* *sigh* We have to RFC822-format the message just to be able
923 * to measure it. FIXME use smi cached fields if possible
926 CC->redirect_buffer = malloc(SIZ);
927 CC->redirect_len = 0;
928 CC->redirect_alloc = SIZ;
929 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1, SUPPRESS_ENV_TO);
930 rfc822 = pch = CC->redirect_buffer;
931 rfc822_len = CC->redirect_len;
932 CC->redirect_buffer = NULL;
933 CC->redirect_len = 0;
934 CC->redirect_alloc = 0;
938 ptr = memreadline(ptr, buf, sizeof buf);
940 if ((IsEmptyStr(buf)) && (rfc822_body == NULL)) {
945 rfc822_headers_len = rfc822_body - rfc822;
946 rfc822_body_len = rfc822_len - rfc822_headers_len;
949 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
950 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
951 "\"7BIT\" " SIZE_T_FMT " %d)", rfc822_body_len, lines);
956 /* For messages already stored in RFC822 format, we have to parse. */
957 cprintf("BODYSTRUCTURE ");
958 mime_parser(msg->cm_fields['M'],
960 *imap_fetch_bodystructure_part, /* part */
961 *imap_fetch_bodystructure_pre, /* pre-multi */
962 *imap_fetch_bodystructure_post, /* post-multi */
964 1); /* don't decode -- we want it as-is */
969 * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
970 * individual message, once it has been selected for output.
972 void imap_do_fetch_msg(int seq, citimap_command *Cmd) {
974 citimap *Imap = IMAP;
975 struct CtdlMessage *msg = NULL;
978 /* Don't attempt to fetch bogus messages or UID's */
980 if (Imap->msgids[seq-1] < 1L) return;
983 cprintf("* %d FETCH (", seq);
985 for (i=0; i<Cmd->num_parms; ++i) {
987 /* Fetchable without going to the message store at all */
988 if (!strcasecmp(Cmd->Params[i].Key, "UID")) {
991 else if (!strcasecmp(Cmd->Params[i].Key, "FLAGS")) {
992 imap_fetch_flags(seq-1);
995 /* Potentially fetchable from cache, if the client requests
996 * stuff from the same message several times in a row.
998 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822")) {
999 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1001 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.HEADER")) {
1002 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1004 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.SIZE")) {
1005 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1007 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.TEXT")) {
1008 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1011 /* BODY fetches do their own fetching and caching too. */
1012 else if (!strncasecmp(Cmd->Params[i].Key, "BODY[", 5)) {
1013 imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i].Key, 0);
1015 else if (!strncasecmp(Cmd->Params[i].Key, "BODY.PEEK[", 10)) {
1016 imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i].Key, 1);
1019 /* Otherwise, load the message into memory.
1021 else if (!strcasecmp(Cmd->Params[i].Key, "BODYSTRUCTURE")) {
1022 if ((msg != NULL) && (!body_loaded)) {
1023 CtdlFreeMessage(msg); /* need the whole thing */
1027 msg = CtdlFetchMessage(Imap->msgids[seq-1], 1);
1030 imap_fetch_bodystructure(Imap->msgids[seq-1],
1031 Cmd->Params[i].Key, msg);
1033 else if (!strcasecmp(Cmd->Params[i].Key, "ENVELOPE")) {
1035 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0);
1038 imap_fetch_envelope(msg);
1040 else if (!strcasecmp(Cmd->Params[i].Key, "INTERNALDATE")) {
1042 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0);
1045 imap_fetch_internaldate(msg);
1048 if (i != Cmd->num_parms-1) cprintf(" ");
1054 CtdlFreeMessage(msg);
1061 * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1062 * validated and boiled down the request a bit.
1064 void imap_do_fetch(citimap_command *Cmd) {
1067 /* debug output the parsed vector */
1070 CtdlLogPrintf(CTDL_DEBUG, "----- %ld params \n",
1073 for (i=0; i < Cmd->num_parms; i++) {
1074 if (Cmd->Params[i].len != strlen(Cmd->Params[i].Key))
1075 CtdlLogPrintf(CTDL_DEBUG, "*********** %ld != %ld : %s\n",
1077 strlen(Cmd->Params[i].Key),
1078 Cmd->Params[i].Key);
1080 CtdlLogPrintf(CTDL_DEBUG, "%ld : %s\n",
1082 Cmd->Params[i].Key);
1087 if (IMAP->num_msgs > 0) {
1088 for (i = 0; i < IMAP->num_msgs; ++i) {
1090 /* Abort the fetch loop if the session breaks.
1091 * This is important for users who keep mailboxes
1092 * that are too big *and* are too impatient to
1093 * let them finish loading. :)
1095 if (CC->kill_me) return;
1097 /* Get any message marked for fetch. */
1098 if (IMAP->flags[i] & IMAP_SELECTED) {
1099 imap_do_fetch_msg(i+1, Cmd);
1108 * Back end for imap_handle_macros()
1109 * Note that this function *only* looks at the beginning of the string. It
1110 * is not a generic search-and-replace function.
1112 void imap_macro_replace(StrBuf *Buf, long where,
1114 char *find, long findlen,
1115 char *replace, long replacelen)
1118 if (StrLength(Buf) - where > findlen)
1121 if (!strncasecmp(ChrPtr(Buf) + where, find, findlen)) {
1122 if (ChrPtr(Buf)[where + findlen] == ' ') {
1123 StrBufPlain(TmpBuf, replace, replacelen);
1124 StrBufAppendBufPlain(TmpBuf, HKEY(" "), 0);
1125 StrBufReplaceToken(Buf, where, findlen,
1128 if (where + findlen == StrLength(Buf)) {
1129 StrBufReplaceToken(Buf, where, findlen,
1130 replace, replacelen);
1138 * Handle macros embedded in FETCH data items.
1139 * (What the heck are macros doing in a wire protocol? Are we trying to save
1140 * the computer at the other end the trouble of typing a lot of characters?)
1142 void imap_handle_macros(citimap_command *Cmd) {
1145 StrBuf *Tmp = NewStrBuf();
1147 for (i=0; i < StrLength(Cmd->CmdBuf); ++i) {
1148 char ch = ChrPtr(Cmd->CmdBuf)[i];
1153 else if ((ch==')') ||
1159 imap_macro_replace(Cmd->CmdBuf, i,
1162 HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE")
1164 imap_macro_replace(Cmd->CmdBuf, i,
1167 HKEY("BODYSTRUCTURE")
1169 imap_macro_replace(Cmd->CmdBuf, i,
1172 HKEY("FLAGS INTERNALDATE RFC822.SIZE")
1174 imap_macro_replace(Cmd->CmdBuf, i,
1177 HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY")
1186 * Break out the data items requested, possibly a parenthesized list.
1187 * Returns the number of data items, or -1 if the list is invalid.
1188 * NOTE: this function alters the string it is fed, and uses it as a buffer
1189 * to hold the data for the pointers it returns.
1191 int imap_extract_data_items(citimap_command *Cmd)
1195 const char *pch, *end;
1198 /* Convert all whitespace to ordinary space characters. */
1199 pch = ChrPtr(Cmd->CmdBuf);
1200 end = pch + StrLength(Cmd->CmdBuf);
1205 StrBufPeek(Cmd->CmdBuf, pch, 0, ' ');
1209 /* Strip leading and trailing whitespace, then strip leading and
1210 * trailing parentheses if it's a list
1212 StrBufTrim(Cmd->CmdBuf);
1213 pch = ChrPtr(Cmd->CmdBuf);
1214 if ( (pch[0]=='(') &&
1215 (pch[StrLength(Cmd->CmdBuf)-1]==')') )
1217 StrBufCutRight(Cmd->CmdBuf, 1);
1218 StrBufCutLeft(Cmd->CmdBuf, 1);
1219 StrBufTrim(Cmd->CmdBuf);
1222 /* Parse any macro data items */
1223 imap_handle_macros(Cmd);
1226 * Now break out the data items. We throw in one trailing space in
1227 * order to avoid having to break out the last one manually.
1229 nArgs = StrLength(Cmd->CmdBuf) / 10 + 10;
1230 nArgs = CmdAdjust(Cmd, nArgs, 0);
1231 initial_len = StrLength(Cmd->CmdBuf);
1233 Cmd->Params[Cmd->num_parms].Key = pch = ChrPtr(Cmd->CmdBuf);
1234 end = Cmd->Params[Cmd->num_parms].Key + StrLength(Cmd->CmdBuf);
1244 else if ((*pch==')') ||
1250 if ((nest <= 0) && (*pch==' ')) {
1251 StrBufPeek(Cmd->CmdBuf, pch, 0, '\0');
1252 Cmd->Params[Cmd->num_parms].len =
1253 pch - Cmd->Params[Cmd->num_parms].Key;
1255 if (Cmd->num_parms + 1 >= Cmd->avail_parms) {
1256 nArgs = CmdAdjust(Cmd, nArgs * 2, 1);
1259 Cmd->Params[Cmd->num_parms].Key = ++pch;
1261 else if (pch + 1 == end) {
1262 Cmd->Params[Cmd->num_parms].len =
1263 pch - Cmd->Params[Cmd->num_parms].Key + 1;
1269 return Cmd->num_parms;
1275 * One particularly hideous aspect of IMAP is that we have to allow the client
1276 * to specify arbitrary ranges and/or sets of messages to fetch. Citadel IMAP
1277 * handles this by setting the IMAP_SELECTED flag for each message specified in
1278 * the ranges/sets, then looping through the message array, outputting messages
1279 * with the flag set. We don't bother returning an error if an out-of-range
1280 * number is specified (we just return quietly) because any client braindead
1281 * enough to request a bogus message number isn't going to notice the
1282 * difference anyway.
1284 * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1285 * message included in the specified range.
1287 * Set is_uid to 1 to fetch by UID instead of sequence number.
1289 void imap_pick_range(const char *supplied_range, int is_uid) {
1293 char setstr[SIZ], lostr[SIZ], histr[SIZ];
1295 char actual_range[SIZ];
1299 * Handle the "ALL" macro
1301 if (!strcasecmp(supplied_range, "ALL")) {
1302 safestrncpy(actual_range, "1:*", sizeof actual_range);
1305 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1310 * Clear out the IMAP_SELECTED flags for all messages.
1312 for (i = 0; i < Imap->num_msgs; ++i) {
1313 Imap->flags[i] = Imap->flags[i] & ~IMAP_SELECTED;
1317 * Now set it for all specified messages.
1319 num_sets = num_tokens(actual_range, ',');
1320 for (s=0; s<num_sets; ++s) {
1321 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1323 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1324 if (num_tokens(setstr, ':') >= 2) {
1325 extract_token(histr, setstr, 1, ':', sizeof histr);
1326 if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1329 safestrncpy(histr, lostr, sizeof histr);
1334 /* Loop through the array, flipping bits where appropriate */
1335 for (i = 1; i <= Imap->num_msgs; ++i) {
1336 if (is_uid) { /* fetch by sequence number */
1337 if ( (Imap->msgids[i-1]>=lo)
1338 && (Imap->msgids[i-1]<=hi)) {
1339 Imap->flags[i-1] |= IMAP_SELECTED;
1342 else { /* fetch by uid */
1343 if ( (i>=lo) && (i<=hi)) {
1344 Imap->flags[i-1] |= IMAP_SELECTED;
1354 * This function is called by the main command loop.
1356 void imap_fetch(int num_parms, ConstStr *Params) {
1357 citimap_command Cmd;
1360 if (num_parms < 4) {
1361 cprintf("%s BAD invalid parameters\r\n", Params[0].Key);
1365 imap_pick_range(Params[2].Key, 0);
1367 memset(&Cmd, 0, sizeof(citimap_command));
1368 Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1369 MakeStringOf(Cmd.CmdBuf, 3);
1371 num_items = imap_extract_data_items(&Cmd);
1372 if (num_items < 1) {
1373 cprintf("%s BAD invalid data item list\r\n", Params[0].Key);
1374 FreeStrBuf(&Cmd.CmdBuf);
1379 imap_do_fetch(&Cmd);
1380 cprintf("%s OK FETCH completed\r\n", Params[0].Key);
1381 FreeStrBuf(&Cmd.CmdBuf);
1386 * This function is called by the main command loop.
1388 void imap_uidfetch(int num_parms, ConstStr *Params) {
1389 citimap_command Cmd;
1392 int have_uid_item = 0;
1394 if (num_parms < 5) {
1395 cprintf("%s BAD invalid parameters\r\n", Params[0].Key);
1399 imap_pick_range(Params[3].Key, 1);
1401 memset(&Cmd, 0, sizeof(citimap_command));
1402 Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1404 MakeStringOf(Cmd.CmdBuf, 4);
1406 CtdlLogPrintf(CTDL_DEBUG, "-------%s--------\n", ChrPtr(Cmd.CmdBuf));
1408 num_items = imap_extract_data_items(&Cmd);
1409 if (num_items < 1) {
1410 cprintf("%s BAD invalid data item list\r\n", Params[0].Key);
1411 FreeStrBuf(&Cmd.CmdBuf);
1416 /* If the "UID" item was not included, we include it implicitly
1417 * (at the beginning) because this is a UID FETCH command
1419 for (i=0; i<num_items; ++i) {
1420 if (!strcasecmp(Cmd.Params[i].Key, "UID")) ++have_uid_item;
1422 if (have_uid_item == 0) {
1423 if (Cmd.num_parms + 1 >= Cmd.avail_parms)
1424 CmdAdjust(&Cmd, Cmd.avail_parms + 1, 1);
1425 memmove(&Cmd.Params[1],
1427 sizeof(ConstStr) * Cmd.num_parms);
1430 Cmd.Params[0] = (ConstStr){HKEY("UID")};
1433 imap_do_fetch(&Cmd);
1434 cprintf("%s OK UID FETCH completed\r\n", Params[0].Key);
1435 FreeStrBuf(&Cmd.CmdBuf);