2 * Implements the FETCH command in IMAP.
3 * This is a good example of the protocol's gratuitous complexity.
5 * Copyright (c) 2001-2015 by the citadel.org team
7 * This program is open source software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
27 #include <sys/types.h>
29 #if TIME_WITH_SYS_TIME
30 # include <sys/time.h>
34 # include <sys/time.h>
44 #include <libcitadel.h>
47 #include "sysdep_decls.h"
48 #include "citserver.h"
54 #include "internet_addressing.h"
55 #include "serv_imap.h"
56 #include "imap_tools.h"
57 #include "imap_fetch.h"
59 #include "ctdl_module.h"
64 * Individual field functions for imap_do_fetch_msg() ...
67 void imap_fetch_uid(int seq) {
68 IAPrintf("UID %ld", IMAP->msgids[seq-1]);
71 void imap_fetch_flags(int seq)
74 int num_flags_printed = 0;
76 if (Imap->flags[seq] & IMAP_DELETED) {
77 if (num_flags_printed > 0)
82 if (Imap->flags[seq] & IMAP_SEEN) {
83 if (num_flags_printed > 0)
88 if (Imap->flags[seq] & IMAP_ANSWERED) {
89 if (num_flags_printed > 0)
94 if (Imap->flags[seq] & IMAP_RECENT) {
95 if (num_flags_printed > 0)
104 void imap_fetch_internaldate(struct CtdlMessage *msg) {
109 if (!CM_IsEmpty(msg, eTimestamp)) {
110 msgdate = atol(msg->cm_fields[eTimestamp]);
113 msgdate = time(NULL);
116 datestring(datebuf, sizeof datebuf, msgdate, DATESTRING_IMAP);
117 IAPrintf( "INTERNALDATE \"%s\"", datebuf);
122 * Fetch RFC822-formatted messages.
124 * 'whichfmt' should be set to one of:
125 * "RFC822" entire message
126 * "RFC822.HEADER" headers only (with trailing blank line)
127 * "RFC822.SIZE" size of translated message
128 * "RFC822.TEXT" body only (without leading blank line)
130 void imap_fetch_rfc822(long msgnum, const char *whichfmt) {
131 CitContext *CCC = CC;
132 citimap *Imap = CCCIMAP;
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 IAPrintf("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 != NULL)
169 && (Imap->cached_rfc822_msgnum == msgnum)
170 && (Imap->cached_rfc822_withbody || (!need_body)) ) {
173 else if (Imap->cached_rfc822 != NULL) {
174 /* Some other message is cached -- free it */
175 FreeStrBuf(&Imap->cached_rfc822);
176 Imap->cached_rfc822_msgnum = (-1);
179 /* At this point, we now can fetch and convert the message iff it's not
180 * the one we had cached.
182 if (Imap->cached_rfc822 == NULL) {
184 * Load the message into memory for translation & measurement
186 CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
187 CtdlOutputMsg(msgnum, MT_RFC822,
188 (need_body ? HEADERS_ALL : HEADERS_FAST),
189 0, 1, NULL, SUPPRESS_ENV_TO, NULL, NULL, NULL
191 if (!need_body) IAPuts("\r\n"); /* extra trailing newline */
192 Imap->cached_rfc822 = CCC->redirect_buffer;
193 CCC->redirect_buffer = NULL;
194 Imap->cached_rfc822_msgnum = msgnum;
195 Imap->cached_rfc822_withbody = need_body;
196 if ( (need_to_rewrite_metadata) &&
197 (StrLength(Imap->cached_rfc822) > 0) ) {
198 smi.meta_rfc822_length = StrLength(Imap->cached_rfc822);
204 * Now figure out where the headers/text break is. IMAP considers the
205 * intervening blank line to be part of the headers, not the text.
210 StrBuf *Line = NewStrBuf();
213 StrBufSipLine(Line, Imap->cached_rfc822, &ptr);
215 if ((StrLength(Line) != 0) && (ptr != StrBufNOTNULL))
218 if ((StrLength(Line) != 0) &&
219 (ptr != StrBufNOTNULL) )
221 headers_size = ptr - ChrPtr(Imap->cached_rfc822);
224 } while ( (headers_size == 0) &&
225 (ptr != StrBufNOTNULL) );
227 total_size = StrLength(Imap->cached_rfc822);
228 text_size = total_size - headers_size;
233 total_size = StrLength(Imap->cached_rfc822);
237 IMAP_syslog(LOG_DEBUG,
238 "RFC822: headers=" SIZE_T_FMT
240 ", total=" SIZE_T_FMT,
241 headers_size, text_size, total_size);
243 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
244 IAPrintf("RFC822.SIZE " SIZE_T_FMT, total_size);
248 else if (!strcasecmp(whichfmt, "RFC822")) {
249 ptr = ChrPtr(Imap->cached_rfc822);
250 bytes_to_send = total_size;
253 else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
254 ptr = ChrPtr(Imap->cached_rfc822);
255 bytes_to_send = headers_size;
258 else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
259 ptr = &ChrPtr(Imap->cached_rfc822)[headers_size];
260 bytes_to_send = text_size;
263 IAPrintf("%s {" SIZE_T_FMT "}\r\n", whichfmt, bytes_to_send);
264 iaputs(ptr, bytes_to_send);
270 * Load a specific part of a message into the temp file to be output to a
271 * client. FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
272 * but we still can't handle "2.HEADER" (which might not be a problem).
274 * Note: mime_parser() was called with dont_decode set to 1, so we have the
275 * luxury of simply spewing without having to re-encode.
277 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
278 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
279 char *cbid, void *cbuserdata)
281 struct CitContext *CCC = CC;
283 StrBuf *desired_section;
285 desired_section = (StrBuf *)cbuserdata;
286 IMAP_syslog(LOG_DEBUG, "imap_load_part() looking for %s, found %s",
287 ChrPtr(desired_section),
291 if (!strcasecmp(partnum, ChrPtr(desired_section))) {
292 client_write(content, length);
295 snprintf(mimebuf2, sizeof mimebuf2, "%s.MIME", partnum);
297 if (!strcasecmp(ChrPtr(desired_section), mimebuf2)) {
298 client_write(HKEY("Content-type: "));
299 client_write(cbtype, strlen(cbtype));
300 if (!IsEmptyStr(cbcharset)) {
301 client_write(HKEY("; charset=\""));
302 client_write(cbcharset, strlen(cbcharset));
303 client_write(HKEY("\""));
305 if (!IsEmptyStr(name)) {
306 client_write(HKEY("; name=\""));
307 client_write(name, strlen(name));
308 client_write(HKEY("\""));
310 client_write(HKEY("\r\n"));
311 if (!IsEmptyStr(encoding)) {
312 client_write(HKEY("Content-Transfer-Encoding: "));
313 client_write(encoding, strlen(encoding));
314 client_write(HKEY("\r\n"));
316 if (!IsEmptyStr(encoding)) {
317 client_write(HKEY("Content-Disposition: "));
318 client_write(disp, strlen(disp));
320 if (!IsEmptyStr(filename)) {
321 client_write(HKEY("; filename=\""));
322 client_write(filename, strlen(filename));
323 client_write(HKEY("\""));
325 client_write(HKEY("\r\n"));
327 cprintf("Content-Length: %ld\r\n\r\n", (long)length);
333 * Called by imap_fetch_envelope() to output the "From" field.
334 * This is in its own function because its logic is kind of complex. We
335 * really need to make this suck less.
337 void imap_output_envelope_from(struct CtdlMessage *msg) {
338 char user[SIZ], node[SIZ], name[SIZ];
342 /* For anonymous messages, it's so easy! */
343 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONONLY)) {
344 IAPuts("((\"----\" NIL \"x\" \"x.org\")) ");
347 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONOPT)) {
348 IAPuts("((\"anonymous\" NIL \"x\" \"x.org\")) ");
352 /* For everything else, we do stuff. */
353 IAPuts("(("); /* open double-parens */
354 IPutMsgField(eAuthor); /* personal name */
355 IAPuts(" NIL "); /* source route (not used) */
358 if (!CM_IsEmpty(msg, erFc822Addr)) {
359 process_rfc822_addr(msg->cm_fields[erFc822Addr], user, node, name);
360 IPutStr(user, strlen(user)); /* mailbox name (user id) */
362 if (!strcasecmp(node, CtdlGetConfigStr("c_nodename"))) {
363 IPutStr(CtdlGetConfigStr("c_fqdn"), strlen(CtdlGetConfigStr("c_fqdn")));
366 IPutStr(node, strlen(node)); /* host name */
370 IPutMsgField(eAuthor); /* mailbox name (user id) */
372 IPutMsgField(eNodeName); /* host name */
375 IAPuts(")) "); /* close double-parens */
381 * Output an envelope address (or set of addresses) in the official,
382 * convoluted, braindead format. (Note that we can't use this for
383 * the "From" address because its data may come from a number of different
384 * fields. But we can use it for "To" and possibly others.
386 void imap_output_envelope_addr(char *addr) {
387 char individual_addr[256];
399 if (IsEmptyStr(addr)) {
406 /* How many addresses are listed here? */
407 num_addrs = num_tokens(addr, ',');
409 /* Output them one by one. */
410 for (i=0; i<num_addrs; ++i) {
411 extract_token(individual_addr, addr, i, ',', sizeof individual_addr);
412 striplt(individual_addr);
413 process_rfc822_addr(individual_addr, user, node, name);
415 IPutStr(name, strlen(name));
417 IPutStr(user, strlen(user));
419 IPutStr(node, strlen(node));
421 if (i < (num_addrs-1))
430 * Implements the ENVELOPE fetch item
432 * Note that the imap_strout() function can cleverly output NULL fields as NIL,
433 * so we don't have to check for that condition like we do elsewhere.
435 void imap_fetch_envelope(struct CtdlMessage *msg) {
436 char datestringbuf[SIZ];
438 char *fieldptr = NULL;
443 /* Parse the message date into an IMAP-format date string */
444 if (!CM_IsEmpty(msg, eTimestamp)) {
445 msgdate = atol(msg->cm_fields[eTimestamp]);
448 msgdate = time(NULL);
450 len = datestring(datestringbuf, sizeof datestringbuf,
451 msgdate, DATESTRING_IMAP);
453 /* Now start spewing data fields. The order is important, as it is
454 * defined by the protocol specification. Nonexistent fields must
455 * be output as NIL, existent fields must be quoted or literalled.
456 * The imap_strout() function conveniently does all this for us.
458 IAPuts("ENVELOPE (");
461 IPutStr(datestringbuf, len);
465 IPutMsgField(eMsgSubject);
469 imap_output_envelope_from(msg);
471 /* Sender (default to same as 'From' if not present) */
472 fieldptr = rfc822_fetch_field(msg->cm_fields[eMesageText], "Sender");
473 if (fieldptr != NULL) {
474 imap_output_envelope_addr(fieldptr);
478 imap_output_envelope_from(msg);
482 fieldptr = rfc822_fetch_field(msg->cm_fields[eMesageText], "Reply-to");
483 if (fieldptr != NULL) {
484 imap_output_envelope_addr(fieldptr);
488 imap_output_envelope_from(msg);
492 imap_output_envelope_addr(msg->cm_fields[eRecipient]);
494 /* Cc (we do it this way because there might be a legacy non-Citadel Cc: field present) */
495 fieldptr = msg->cm_fields[eCarbonCopY];
496 if (fieldptr != NULL) {
497 imap_output_envelope_addr(fieldptr);
500 fieldptr = rfc822_fetch_field(msg->cm_fields[eMesageText], "Cc");
501 imap_output_envelope_addr(fieldptr);
502 if (fieldptr != NULL) free(fieldptr);
506 fieldptr = rfc822_fetch_field(msg->cm_fields[eMesageText], "Bcc");
507 imap_output_envelope_addr(fieldptr);
508 if (fieldptr != NULL) free(fieldptr);
511 fieldptr = rfc822_fetch_field(msg->cm_fields[eMesageText], "In-reply-to");
512 IPutStr(fieldptr, (fieldptr)?strlen(fieldptr):0);
514 if (fieldptr != NULL) free(fieldptr);
517 len = msg->cm_lengths[emessageId];
520 (msg->cm_fields[emessageId][0] == '<') &&
521 (msg->cm_fields[emessageId][len - 1] == '>'))
524 IPutMsgField(emessageId);
528 char *Buf = malloc(len + 3);
531 if (msg->cm_fields[emessageId][0] != '<')
536 memcpy(&Buf[pos], msg->cm_fields[emessageId], len);
538 if (msg->cm_fields[emessageId][len] != '>')
551 * This function is called only when CC->redirect_buffer contains a set of
552 * RFC822 headers with no body attached. Its job is to strip that set of
553 * headers down to *only* the ones we're interested in.
555 void imap_strip_headers(StrBuf *section) {
557 StrBuf *which_fields = NULL;
558 int doing_headers = 0;
562 StrBuf *boiled_headers = NULL;
565 int done_headers = 0;
566 const char *Ptr = NULL;
567 CitContext *CCC = CC;
569 if (CCC->redirect_buffer == NULL) return;
571 which_fields = NewStrBufDup(section);
573 if (!strncasecmp(ChrPtr(which_fields), "HEADER.FIELDS", 13))
576 !strncasecmp(ChrPtr(which_fields), "HEADER.FIELDS.NOT", 17))
579 for (i=0; i < StrLength(which_fields); ++i) {
580 if (ChrPtr(which_fields)[i]=='(')
581 StrBufReplaceToken(which_fields, i, 1, HKEY(""));
583 for (i=0; i < StrLength(which_fields); ++i) {
584 if (ChrPtr(which_fields)[i]==')') {
585 StrBufCutAt(which_fields, i, NULL);
589 memset(&Cmd, 0, sizeof(citimap_command));
590 Cmd.CmdBuf = which_fields;
591 num_parms = imap_parameterize(&Cmd);
593 boiled_headers = NewStrBufPlain(NULL, StrLength(CCC->redirect_buffer));
594 Line = NewStrBufPlain(NULL, SIZ);
598 StrBufSipLine(Line, CCC->redirect_buffer, &Ptr);
600 if (!isspace(ChrPtr(Line)[0])) {
602 if (doing_headers == 0) ok = 1;
604 /* we're supposed to print all headers that are not matching the filter list */
605 if (headers_not) for (i=0, ok = 1; (i < num_parms) && (ok == 1); ++i) {
606 if ( (!strncasecmp(ChrPtr(Line),
608 Cmd.Params[i].len)) &&
609 (ChrPtr(Line)[Cmd.Params[i].len]==':') ) {
613 /* we're supposed to print all headers matching the filterlist */
614 else for (i=0, ok = 0; ((i < num_parms) && (ok == 0)); ++i) {
615 if ( (!strncasecmp(ChrPtr(Line),
617 Cmd.Params[i].len)) &&
618 (ChrPtr(Line)[Cmd.Params[i].len]==':') ) {
626 StrBufAppendBuf(boiled_headers, Line, 0);
627 StrBufAppendBufPlain(boiled_headers, HKEY("\r\n"), 0);
630 if ((Ptr == StrBufNOTNULL) ||
631 (StrLength(Line) == 0) ||
632 (ChrPtr(Line)[0]=='\r') ||
633 (ChrPtr(Line)[0]=='\n') ) done_headers = 1;
634 } while (!done_headers);
636 StrBufAppendBufPlain(boiled_headers, HKEY("\r\n"), 0);
638 /* Now save it back (it'll always be smaller) */
639 FreeStrBuf(&CCC->redirect_buffer);
640 CCC->redirect_buffer = boiled_headers;
643 FreeStrBuf(&which_fields);
649 * Implements the BODY and BODY.PEEK fetch items
651 void imap_fetch_body(long msgnum, ConstStr item, int is_peek) {
652 struct CtdlMessage *msg = NULL;
656 size_t pstart, pbytes;
657 int loading_body_now = 0;
659 int burn_the_cache = 0;
660 CitContext *CCC = CC;
661 citimap *Imap = CCCIMAP;
663 /* extract section */
664 section = NewStrBufPlain(CKEY(item));
666 if (strchr(ChrPtr(section), '[') != NULL) {
667 StrBufStripAllBut(section, '[', ']');
669 IMAP_syslog(LOG_DEBUG, "Section is: [%s]",
670 (StrLength(section) == 0) ? "(empty)" : ChrPtr(section)
673 /* Burn the cache if we don't have the same section of the
674 * same message again.
676 if (Imap->cached_body != NULL) {
677 if (Imap->cached_bodymsgnum != msgnum) {
680 else if ( (!Imap->cached_body_withbody) && (need_body) ) {
683 else if (strcasecmp(Imap->cached_bodypart, ChrPtr(section))) {
686 if (burn_the_cache) {
687 /* Yup, go ahead and burn the cache. */
688 free(Imap->cached_body);
689 Imap->cached_body_len = 0;
690 Imap->cached_body = NULL;
691 Imap->cached_bodymsgnum = (-1);
692 strcpy(Imap->cached_bodypart, "");
696 /* extract partial */
697 partial = NewStrBufPlain(CKEY(item));
698 if (strchr(ChrPtr(partial), '<') != NULL) {
699 StrBufStripAllBut(partial, '<', '>');
702 if ( (is_partial == 1) && (StrLength(partial) > 0) ) {
703 IMAP_syslog(LOG_DEBUG, "Partial is <%s>", ChrPtr(partial));
706 if (Imap->cached_body == NULL) {
707 CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
708 loading_body_now = 1;
709 msg = CtdlFetchMessage(msgnum, (need_body ? 1 : 0));
712 /* Now figure out what the client wants, and get it */
714 if (!loading_body_now) {
715 /* What we want is already in memory */
718 else if ( (!strcmp(ChrPtr(section), "1")) && (msg->cm_format_type != 4) ) {
719 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
722 else if (StrLength(section) == 0) {
723 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, SUPPRESS_ENV_TO);
727 * If the client asked for just headers, or just particular header
728 * fields, strip it down.
730 else if (!strncasecmp(ChrPtr(section), "HEADER", 6)) {
731 /* This used to work with HEADERS_FAST, but then Apple got stupid with their
732 * IMAP library and this broke Mail.App and iPhone Mail, so we had to change it
733 * to HEADERS_ONLY so the trendy hipsters with their iPhones can read mail.
735 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, SUPPRESS_ENV_TO);
736 imap_strip_headers(section);
740 * Strip it down if the client asked for everything _except_ headers.
742 else if (!strncasecmp(ChrPtr(section), "TEXT", 4)) {
743 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
747 * Anything else must be a part specifier.
748 * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
751 mime_parser(CM_RANGE(msg, eMesageText),
752 *imap_load_part, NULL, NULL,
758 if (loading_body_now) {
759 Imap->cached_body_len = StrLength(CCC->redirect_buffer);
760 Imap->cached_body = SmashStrBuf(&CCC->redirect_buffer);
761 Imap->cached_bodymsgnum = msgnum;
762 Imap->cached_body_withbody = need_body;
763 strcpy(Imap->cached_bodypart, ChrPtr(section));
766 if (is_partial == 0) {
768 iaputs(SKEY(section));
769 IAPrintf("] {" SIZE_T_FMT "}\r\n", Imap->cached_body_len);
771 pbytes = Imap->cached_body_len;
774 sscanf(ChrPtr(partial), SIZE_T_FMT "." SIZE_T_FMT, &pstart, &pbytes);
775 if (pbytes > (Imap->cached_body_len - pstart)) {
776 pbytes = Imap->cached_body_len - pstart;
779 iaputs(SKEY(section));
780 IAPrintf("]<" SIZE_T_FMT "> {" SIZE_T_FMT "}\r\n", pstart, pbytes);
783 FreeStrBuf(&partial);
785 /* Here we go -- output it */
786 iaputs(&Imap->cached_body[pstart], pbytes);
792 /* Mark this message as "seen" *unless* this is a "peek" operation */
794 CtdlSetSeen(&msgnum, 1, 1, ctdlsetseen_seen, NULL, NULL);
796 FreeStrBuf(§ion);
800 * Called immediately before outputting a multipart bodystructure
802 void imap_fetch_bodystructure_pre(
803 char *name, char *filename, char *partnum, char *disp,
804 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
805 char *cbid, void *cbuserdata
814 * Called immediately after outputting a multipart bodystructure
816 void imap_fetch_bodystructure_post(
817 char *name, char *filename, char *partnum, char *disp,
818 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
819 char *cbid, void *cbuserdata
827 len = extract_token(subtype, cbtype, 1, '/', sizeof subtype);
828 IPutStr(subtype, len);
831 /* IAPuts(" NIL"); We thought we needed this at one point, but maybe we don't... */
839 * Output the info for a MIME part in the format required by BODYSTRUCTURE.
842 void imap_fetch_bodystructure_part(
843 char *name, char *filename, char *partnum, char *disp,
844 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
845 char *cbid, void *cbuserdata
849 int have_encoding = 0;
852 char cbmaintype[128];
857 if (cbtype != NULL) if (!IsEmptyStr(cbtype)) have_cbtype = 1;
859 cbmaintype_len = extract_token(cbmaintype, cbtype, 0, '/', sizeof cbmaintype);
860 cbsubtype_len = extract_token(cbsubtype, cbtype, 1, '/', sizeof cbsubtype);
863 strcpy(cbmaintype, "TEXT");
865 strcpy(cbsubtype, "PLAIN");
870 IPutStr(cbmaintype, cbmaintype_len); /* body type */
872 IPutStr(cbsubtype, cbsubtype_len); /* body subtype */
875 IAPuts("("); /* begin body parameter list */
877 /* "NAME" must appear as the first parameter. This is not required by IMAP,
878 * but the Asterisk voicemail application blindly assumes that NAME will be in
879 * the first position. If it isn't, it rejects the message.
881 if ((name != NULL) && (!IsEmptyStr(name))) {
883 IPutStr(name, strlen(name));
887 IAPuts("\"CHARSET\" ");
888 if ((cbcharset == NULL) || (cbcharset[0] == 0)){
889 IPutStr(HKEY("US-ASCII"));
892 IPutStr(cbcharset, strlen(cbcharset));
894 IAPuts(") "); /* end body parameter list */
896 IAPuts("NIL "); /* Body ID */
897 IAPuts("NIL "); /* Body description */
899 if ((encoding != NULL) && (encoding[0] != 0)) have_encoding = 1;
901 IPutStr(encoding, strlen(encoding));
904 IPutStr(HKEY("7BIT"));
908 /* The next field is the size of the part in bytes. */
909 IAPrintf("%ld ", (long)length); /* bytes */
911 /* The next field is the number of lines in the part, if and only
912 * if the part is TEXT. More gratuitous complexity.
914 if (!strcasecmp(cbmaintype, "TEXT")) {
915 if (length) for (i=0; i<length; ++i) {
916 if (((char *)content)[i] == '\n') ++lines;
918 IAPrintf("%d ", lines);
921 /* More gratuitous complexity */
922 if ((!strcasecmp(cbmaintype, "MESSAGE"))
923 && (!strcasecmp(cbsubtype, "RFC822"))) {
924 /* FIXME: message/rfc822 also needs to output the envelope structure,
925 * body structure, and line count of the encapsulated message. Fortunately
926 * there are not yet any clients depending on this, so we can get away
927 * with not implementing it for now.
931 /* MD5 value of body part; we can get away with NIL'ing this */
935 if ((disp == NULL) || IsEmptyStr(disp)) {
940 IPutStr(disp, strlen(disp));
941 if ((filename != NULL) && (!IsEmptyStr(filename))) {
942 IAPuts(" (\"FILENAME\" ");
943 IPutStr(filename, strlen(filename));
949 /* Body language (not defined yet) */
956 * Spew the BODYSTRUCTURE data for a message.
959 void imap_fetch_bodystructure (long msgnum, const char *item,
960 struct CtdlMessage *msg) {
961 const char *rfc822 = NULL;
962 const char *rfc822_body = NULL;
964 size_t rfc822_headers_len;
965 size_t rfc822_body_len;
966 const char *ptr = NULL;
971 /* Handle NULL message gracefully */
973 IAPuts("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
974 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
979 /* For non-RFC822 (ordinary Citadel) messages, this is short and
982 if (msg->cm_format_type != FMT_RFC822) {
984 /* *sigh* We have to RFC822-format the message just to be able
985 * to measure it. FIXME use smi cached fields if possible
988 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
989 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1, SUPPRESS_ENV_TO);
990 rfc822_len = StrLength(CC->redirect_buffer);
991 rfc822 = pch = SmashStrBuf(&CC->redirect_buffer);
995 ptr = cmemreadline(ptr, buf, sizeof buf);
997 if ((IsEmptyStr(buf)) && (rfc822_body == NULL)) {
1000 } while (*ptr != 0);
1002 rfc822_headers_len = rfc822_body - rfc822;
1003 rfc822_body_len = rfc822_len - rfc822_headers_len;
1006 IAPuts("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
1007 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
1009 IAPrintf(SIZE_T_FMT " %d)", rfc822_body_len, lines);
1014 /* For messages already stored in RFC822 format, we have to parse. */
1015 IAPuts("BODYSTRUCTURE ");
1016 mime_parser(CM_RANGE(msg, eMesageText),
1017 *imap_fetch_bodystructure_part, /* part */
1018 *imap_fetch_bodystructure_pre, /* pre-multi */
1019 *imap_fetch_bodystructure_post, /* post-multi */
1021 1); /* don't decode -- we want it as-is */
1026 * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
1027 * individual message, once it has been selected for output.
1029 void imap_do_fetch_msg(int seq, citimap_command *Cmd) {
1031 citimap *Imap = IMAP;
1032 struct CtdlMessage *msg = NULL;
1033 int body_loaded = 0;
1035 /* Don't attempt to fetch bogus messages or UID's */
1036 if (seq < 1) return;
1037 if (Imap->msgids[seq-1] < 1L) return;
1040 IAPrintf("* %d FETCH (", seq);
1042 for (i=0; i<Cmd->num_parms; ++i) {
1044 /* Fetchable without going to the message store at all */
1045 if (!strcasecmp(Cmd->Params[i].Key, "UID")) {
1046 imap_fetch_uid(seq);
1048 else if (!strcasecmp(Cmd->Params[i].Key, "FLAGS")) {
1049 imap_fetch_flags(seq-1);
1052 /* Potentially fetchable from cache, if the client requests
1053 * stuff from the same message several times in a row.
1055 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822")) {
1056 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1058 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.HEADER")) {
1059 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1061 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.SIZE")) {
1062 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1064 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.TEXT")) {
1065 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1068 /* BODY fetches do their own fetching and caching too. */
1069 else if (!strncasecmp(Cmd->Params[i].Key, "BODY[", 5)) {
1070 imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i], 0);
1072 else if (!strncasecmp(Cmd->Params[i].Key, "BODY.PEEK[", 10)) {
1073 imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i], 1);
1076 /* Otherwise, load the message into memory.
1078 else if (!strcasecmp(Cmd->Params[i].Key, "BODYSTRUCTURE")) {
1079 if ((msg != NULL) && (!body_loaded)) {
1080 CM_Free(msg); /* need the whole thing */
1084 msg = CtdlFetchMessage(Imap->msgids[seq-1], 1);
1087 imap_fetch_bodystructure(Imap->msgids[seq-1],
1088 Cmd->Params[i].Key, msg);
1090 else if (!strcasecmp(Cmd->Params[i].Key, "ENVELOPE")) {
1092 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0);
1095 imap_fetch_envelope(msg);
1097 else if (!strcasecmp(Cmd->Params[i].Key, "INTERNALDATE")) {
1099 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0);
1102 imap_fetch_internaldate(msg);
1105 if (i != Cmd->num_parms-1) IAPuts(" ");
1118 * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1119 * validated and boiled down the request a bit.
1121 void imap_do_fetch(citimap_command *Cmd) {
1122 citimap *Imap = IMAP;
1125 /* debug output the parsed vector */
1128 IMAP_syslog(LOG_DEBUG, "----- %ld params", Cmd->num_parms);
1130 for (i=0; i < Cmd->num_parms; i++) {
1131 if (Cmd->Params[i].len != strlen(Cmd->Params[i].Key))
1132 IMAP_syslog(LOG_DEBUG, "*********** %ld != %ld : %s",
1134 strlen(Cmd->Params[i].Key),
1135 Cmd->Params[i].Key);
1137 IMAP_syslog(LOG_DEBUG, "%ld : %s",
1139 Cmd->Params[i].Key);
1144 if (Imap->num_msgs > 0) {
1145 for (i = 0; i < Imap->num_msgs; ++i) {
1147 /* Abort the fetch loop if the session breaks.
1148 * This is important for users who keep mailboxes
1149 * that are too big *and* are too impatient to
1150 * let them finish loading. :)
1152 if (CC->kill_me) return;
1154 /* Get any message marked for fetch. */
1155 if (Imap->flags[i] & IMAP_SELECTED) {
1156 imap_do_fetch_msg(i+1, Cmd);
1165 * Back end for imap_handle_macros()
1166 * Note that this function *only* looks at the beginning of the string. It
1167 * is not a generic search-and-replace function.
1169 void imap_macro_replace(StrBuf *Buf, long where,
1171 char *find, long findlen,
1172 char *replace, long replacelen)
1175 if (StrLength(Buf) - where > findlen)
1178 if (!strncasecmp(ChrPtr(Buf) + where, find, findlen)) {
1179 if (ChrPtr(Buf)[where + findlen] == ' ') {
1180 StrBufPlain(TmpBuf, replace, replacelen);
1181 StrBufAppendBufPlain(TmpBuf, HKEY(" "), 0);
1182 StrBufReplaceToken(Buf, where, findlen,
1185 if (where + findlen == StrLength(Buf)) {
1186 StrBufReplaceToken(Buf, where, findlen,
1187 replace, replacelen);
1195 * Handle macros embedded in FETCH data items.
1196 * (What the heck are macros doing in a wire protocol? Are we trying to save
1197 * the computer at the other end the trouble of typing a lot of characters?)
1199 void imap_handle_macros(citimap_command *Cmd) {
1202 StrBuf *Tmp = NewStrBuf();
1204 for (i=0; i < StrLength(Cmd->CmdBuf); ++i) {
1205 char ch = ChrPtr(Cmd->CmdBuf)[i];
1210 else if ((ch==')') ||
1216 imap_macro_replace(Cmd->CmdBuf, i,
1219 HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE")
1221 imap_macro_replace(Cmd->CmdBuf, i,
1224 HKEY("BODYSTRUCTURE")
1226 imap_macro_replace(Cmd->CmdBuf, i,
1229 HKEY("FLAGS INTERNALDATE RFC822.SIZE")
1231 imap_macro_replace(Cmd->CmdBuf, i,
1234 HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY")
1243 * Break out the data items requested, possibly a parenthesized list.
1244 * Returns the number of data items, or -1 if the list is invalid.
1245 * NOTE: this function alters the string it is fed, and uses it as a buffer
1246 * to hold the data for the pointers it returns.
1248 int imap_extract_data_items(citimap_command *Cmd)
1252 const char *pch, *end;
1254 /* Convert all whitespace to ordinary space characters. */
1255 pch = ChrPtr(Cmd->CmdBuf);
1256 end = pch + StrLength(Cmd->CmdBuf);
1261 StrBufPeek(Cmd->CmdBuf, pch, 0, ' ');
1265 /* Strip leading and trailing whitespace, then strip leading and
1266 * trailing parentheses if it's a list
1268 StrBufTrim(Cmd->CmdBuf);
1269 pch = ChrPtr(Cmd->CmdBuf);
1270 if ( (pch[0]=='(') &&
1271 (pch[StrLength(Cmd->CmdBuf)-1]==')') )
1273 StrBufCutRight(Cmd->CmdBuf, 1);
1274 StrBufCutLeft(Cmd->CmdBuf, 1);
1275 StrBufTrim(Cmd->CmdBuf);
1278 /* Parse any macro data items */
1279 imap_handle_macros(Cmd);
1282 * Now break out the data items. We throw in one trailing space in
1283 * order to avoid having to break out the last one manually.
1285 nArgs = StrLength(Cmd->CmdBuf) / 10 + 10;
1286 nArgs = CmdAdjust(Cmd, nArgs, 0);
1288 Cmd->Params[Cmd->num_parms].Key = pch = ChrPtr(Cmd->CmdBuf);
1289 end = Cmd->Params[Cmd->num_parms].Key + StrLength(Cmd->CmdBuf);
1299 else if ((*pch==')') ||
1305 if ((nest <= 0) && (*pch==' ')) {
1306 StrBufPeek(Cmd->CmdBuf, pch, 0, '\0');
1307 Cmd->Params[Cmd->num_parms].len =
1308 pch - Cmd->Params[Cmd->num_parms].Key;
1310 if (Cmd->num_parms + 1 >= Cmd->avail_parms) {
1311 nArgs = CmdAdjust(Cmd, nArgs * 2, 1);
1314 Cmd->Params[Cmd->num_parms].Key = ++pch;
1316 else if (pch + 1 == end) {
1317 Cmd->Params[Cmd->num_parms].len =
1318 pch - Cmd->Params[Cmd->num_parms].Key + 1;
1324 return Cmd->num_parms;
1330 * One particularly hideous aspect of IMAP is that we have to allow the client
1331 * to specify arbitrary ranges and/or sets of messages to fetch. Citadel IMAP
1332 * handles this by setting the IMAP_SELECTED flag for each message specified in
1333 * the ranges/sets, then looping through the message array, outputting messages
1334 * with the flag set. We don't bother returning an error if an out-of-range
1335 * number is specified (we just return quietly) because any client braindead
1336 * enough to request a bogus message number isn't going to notice the
1337 * difference anyway.
1339 * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1340 * message included in the specified range.
1342 * Set is_uid to 1 to fetch by UID instead of sequence number.
1344 void imap_pick_range(const char *supplied_range, int is_uid) {
1345 citimap *Imap = IMAP;
1349 char setstr[SIZ], lostr[SIZ], histr[SIZ];
1351 char actual_range[SIZ];
1354 * Handle the "ALL" macro
1356 if (!strcasecmp(supplied_range, "ALL")) {
1357 safestrncpy(actual_range, "1:*", sizeof actual_range);
1360 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1364 * Clear out the IMAP_SELECTED flags for all messages.
1366 for (i = 0; i < Imap->num_msgs; ++i) {
1367 Imap->flags[i] = Imap->flags[i] & ~IMAP_SELECTED;
1371 * Now set it for all specified messages.
1373 num_sets = num_tokens(actual_range, ',');
1374 for (s=0; s<num_sets; ++s) {
1375 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1377 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1378 if (num_tokens(setstr, ':') >= 2) {
1379 extract_token(histr, setstr, 1, ':', sizeof histr);
1380 if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1383 safestrncpy(histr, lostr, sizeof histr);
1388 /* Loop through the array, flipping bits where appropriate */
1389 for (i = 1; i <= Imap->num_msgs; ++i) {
1390 if (is_uid) { /* fetch by sequence number */
1391 if ( (Imap->msgids[i-1]>=lo)
1392 && (Imap->msgids[i-1]<=hi)) {
1393 Imap->flags[i-1] |= IMAP_SELECTED;
1396 else { /* fetch by uid */
1397 if ( (i>=lo) && (i<=hi)) {
1398 Imap->flags[i-1] |= IMAP_SELECTED;
1408 * This function is called by the main command loop.
1410 void imap_fetch(int num_parms, ConstStr *Params) {
1411 citimap_command Cmd;
1414 if (num_parms < 4) {
1415 IReply("BAD invalid parameters");
1419 imap_pick_range(Params[2].Key, 0);
1421 memset(&Cmd, 0, sizeof(citimap_command));
1422 Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1423 MakeStringOf(Cmd.CmdBuf, 3);
1425 num_items = imap_extract_data_items(&Cmd);
1426 if (num_items < 1) {
1427 IReply("BAD invalid data item list");
1428 FreeStrBuf(&Cmd.CmdBuf);
1433 imap_do_fetch(&Cmd);
1434 IReply("OK FETCH completed");
1435 FreeStrBuf(&Cmd.CmdBuf);
1440 * This function is called by the main command loop.
1442 void imap_uidfetch(int num_parms, ConstStr *Params) {
1443 citimap_command Cmd;
1446 int have_uid_item = 0;
1448 if (num_parms < 5) {
1449 IReply("BAD invalid parameters");
1453 imap_pick_range(Params[3].Key, 1);
1455 memset(&Cmd, 0, sizeof(citimap_command));
1456 Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1458 MakeStringOf(Cmd.CmdBuf, 4);
1460 IMAP_syslog(LOG_DEBUG, "-------%s--------", ChrPtr(Cmd.CmdBuf));
1462 num_items = imap_extract_data_items(&Cmd);
1463 if (num_items < 1) {
1464 IReply("BAD invalid data item list");
1465 FreeStrBuf(&Cmd.CmdBuf);
1470 /* If the "UID" item was not included, we include it implicitly
1471 * (at the beginning) because this is a UID FETCH command
1473 for (i=0; i<num_items; ++i) {
1474 if (!strcasecmp(Cmd.Params[i].Key, "UID")) ++have_uid_item;
1476 if (have_uid_item == 0) {
1477 if (Cmd.num_parms + 1 >= Cmd.avail_parms)
1478 CmdAdjust(&Cmd, Cmd.avail_parms + 1, 1);
1479 memmove(&Cmd.Params[1],
1481 sizeof(ConstStr) * Cmd.num_parms);
1484 Cmd.Params[0] = (ConstStr){HKEY("UID")};
1487 imap_do_fetch(&Cmd);
1488 IReply("OK UID FETCH completed");
1489 FreeStrBuf(&Cmd.CmdBuf);