2 * Implements the FETCH command in IMAP.
3 * This is a good example of the protocol's gratuitous complexity.
5 * Copyright (c) 2001-2017 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")) || (!strcasecmp(whichfmt, "RFC822.TEXT")) ) {
148 /* If this is an RFC822.SIZE fetch, first look in the message's
149 * metadata record to see if we've saved that information.
151 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
152 GetMetaData(&smi, msgnum);
153 if (smi.meta_rfc822_length > 0L) {
154 IAPrintf("RFC822.SIZE %ld", smi.meta_rfc822_length);
157 need_to_rewrite_metadata = 1;
161 /* Cache the most recent RFC822 FETCH because some clients like to
162 * fetch in pieces, and we don't want to have to go back to the
163 * message store for each piece. We also burn the cache if the
164 * client requests something that involves reading the message
165 * body, but we haven't fetched the body yet.
167 if ((Imap->cached_rfc822 != NULL)
168 && (Imap->cached_rfc822_msgnum == msgnum)
169 && (Imap->cached_rfc822_withbody || (!need_body)) ) {
172 else if (Imap->cached_rfc822 != NULL) {
173 /* Some other message is cached -- free it */
174 FreeStrBuf(&Imap->cached_rfc822);
175 Imap->cached_rfc822_msgnum = (-1);
178 /* At this point, we now can fetch and convert the message iff it's not
179 * the one we had cached.
181 if (Imap->cached_rfc822 == NULL) {
183 * Load the message into memory for translation & measurement
185 CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
186 CtdlOutputMsg(msgnum, MT_RFC822,
187 (need_body ? HEADERS_ALL : HEADERS_FAST),
188 0, 1, NULL, SUPPRESS_ENV_TO, NULL, NULL, NULL
191 client_write(HKEY("\r\n")); // extra trailing newline -- to the redirect_buffer, *not* to the client
193 Imap->cached_rfc822 = CCC->redirect_buffer;
194 CCC->redirect_buffer = NULL;
195 Imap->cached_rfc822_msgnum = msgnum;
196 Imap->cached_rfc822_withbody = need_body;
197 if ( (need_to_rewrite_metadata) &&
198 (StrLength(Imap->cached_rfc822) > 0) ) {
199 smi.meta_rfc822_length = StrLength(Imap->cached_rfc822);
205 * Now figure out where the headers/text break is. IMAP considers the
206 * intervening blank line to be part of the headers, not the text.
211 StrBuf *Line = NewStrBuf();
214 StrBufSipLine(Line, Imap->cached_rfc822, &ptr);
216 if ((StrLength(Line) != 0) && (ptr != StrBufNOTNULL))
219 if ((StrLength(Line) != 0) &&
220 (ptr != StrBufNOTNULL) )
222 headers_size = ptr - ChrPtr(Imap->cached_rfc822);
225 } while ( (headers_size == 0) &&
226 (ptr != StrBufNOTNULL) );
228 total_size = StrLength(Imap->cached_rfc822);
229 text_size = total_size - headers_size;
233 headers_size = total_size = StrLength(Imap->cached_rfc822);
237 syslog(LOG_DEBUG, "imap: RFC822 headers=" SIZE_T_FMT ", text=" SIZE_T_FMT ", total=" SIZE_T_FMT, headers_size, text_size, total_size);
239 if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
240 IAPrintf("RFC822.SIZE " SIZE_T_FMT, total_size);
244 else if (!strcasecmp(whichfmt, "RFC822")) {
245 ptr = ChrPtr(Imap->cached_rfc822);
246 bytes_to_send = total_size;
249 else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
250 ptr = ChrPtr(Imap->cached_rfc822);
251 bytes_to_send = headers_size;
254 else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
255 ptr = &ChrPtr(Imap->cached_rfc822)[headers_size];
256 bytes_to_send = text_size;
259 IAPrintf("%s {" SIZE_T_FMT "}\r\n", whichfmt, bytes_to_send);
260 iaputs(ptr, bytes_to_send);
265 * Load a specific part of a message into the temp file to be output to a
266 * client. FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
267 * but we still can't handle "2.HEADER" (which might not be a problem).
269 * Note: mime_parser() was called with dont_decode set to 1, so we have the
270 * luxury of simply spewing without having to re-encode.
272 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
273 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
274 char *cbid, void *cbuserdata)
277 StrBuf *desired_section;
279 desired_section = (StrBuf *)cbuserdata;
280 syslog(LOG_DEBUG, "imap: imap_load_part() looking for %s, found %s", ChrPtr(desired_section), partnum);
282 if (!strcasecmp(partnum, ChrPtr(desired_section))) {
283 client_write(content, length);
286 snprintf(mimebuf2, sizeof mimebuf2, "%s.MIME", partnum);
288 if (!strcasecmp(ChrPtr(desired_section), mimebuf2)) {
289 client_write(HKEY("Content-type: "));
290 client_write(cbtype, strlen(cbtype));
291 if (!IsEmptyStr(cbcharset)) {
292 client_write(HKEY("; charset=\""));
293 client_write(cbcharset, strlen(cbcharset));
294 client_write(HKEY("\""));
296 if (!IsEmptyStr(name)) {
297 client_write(HKEY("; name=\""));
298 client_write(name, strlen(name));
299 client_write(HKEY("\""));
301 client_write(HKEY("\r\n"));
302 if (!IsEmptyStr(encoding)) {
303 client_write(HKEY("Content-Transfer-Encoding: "));
304 client_write(encoding, strlen(encoding));
305 client_write(HKEY("\r\n"));
307 if (!IsEmptyStr(encoding)) {
308 client_write(HKEY("Content-Disposition: "));
309 client_write(disp, strlen(disp));
311 if (!IsEmptyStr(filename)) {
312 client_write(HKEY("; filename=\""));
313 client_write(filename, strlen(filename));
314 client_write(HKEY("\""));
316 client_write(HKEY("\r\n"));
318 cprintf("Content-Length: %ld\r\n\r\n", (long)length);
324 * Called by imap_fetch_envelope() to output the "From" field.
325 * This is in its own function because its logic is kind of complex. We
326 * really need to make this suck less.
328 void imap_output_envelope_from(struct CtdlMessage *msg) {
329 char user[SIZ], node[SIZ], name[SIZ];
333 /* For anonymous messages, it's so easy! */
334 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONONLY)) {
335 IAPuts("((\"----\" NIL \"x\" \"x.org\")) ");
338 if (!is_room_aide() && (msg->cm_anon_type == MES_ANONOPT)) {
339 IAPuts("((\"anonymous\" NIL \"x\" \"x.org\")) ");
343 /* For everything else, we do stuff. */
344 IAPuts("(("); // open double-parens
345 IPutMsgField(eAuthor); // display name
346 IAPuts(" NIL "); // source route (not used)
348 if (!CM_IsEmpty(msg, erFc822Addr)) {
349 process_rfc822_addr(msg->cm_fields[erFc822Addr], user, node, name);
350 IPutStr(user, strlen(user)); /* mailbox name (user id) */
352 if (!strcasecmp(node, CtdlGetConfigStr("c_nodename"))) {
353 IPutStr(CtdlGetConfigStr("c_fqdn"), strlen(CtdlGetConfigStr("c_fqdn")));
356 IPutStr(node, strlen(node)); /* host name */
360 IPutMsgField(eAuthor); /* mailbox name (user id) */
362 IPutMsgField(eNodeName); /* host name */
365 IAPuts(")) "); /* close double-parens */
370 * Output an envelope address (or set of addresses) in the official,
371 * convoluted, braindead format. (Note that we can't use this for
372 * the "From" address because its data may come from a number of different
373 * fields. But we can use it for "To" and possibly others.
375 void imap_output_envelope_addr(char *addr) {
376 char individual_addr[256];
388 if (IsEmptyStr(addr)) {
395 /* How many addresses are listed here? */
396 num_addrs = num_tokens(addr, ',');
398 /* Output them one by one. */
399 for (i=0; i<num_addrs; ++i) {
400 extract_token(individual_addr, addr, i, ',', sizeof individual_addr);
401 striplt(individual_addr);
402 process_rfc822_addr(individual_addr, user, node, name);
404 IPutStr(name, strlen(name));
406 IPutStr(user, strlen(user));
408 IPutStr(node, strlen(node));
410 if (i < (num_addrs-1))
419 * Implements the ENVELOPE fetch item
421 * Note that the imap_strout() function can cleverly output NULL fields as NIL,
422 * so we don't have to check for that condition like we do elsewhere.
424 void imap_fetch_envelope(struct CtdlMessage *msg) {
425 char datestringbuf[SIZ];
427 char *fieldptr = NULL;
432 /* Parse the message date into an IMAP-format date string */
433 if (!CM_IsEmpty(msg, eTimestamp)) {
434 msgdate = atol(msg->cm_fields[eTimestamp]);
437 msgdate = time(NULL);
439 len = datestring(datestringbuf, sizeof datestringbuf, msgdate, DATESTRING_IMAP);
441 /* Now start spewing data fields. The order is important, as it is
442 * defined by the protocol specification. Nonexistent fields must
443 * be output as NIL, existent fields must be quoted or literalled.
444 * The imap_strout() function conveniently does all this for us.
446 IAPuts("ENVELOPE (");
449 IPutStr(datestringbuf, len);
453 IPutMsgField(eMsgSubject);
457 imap_output_envelope_from(msg);
459 /* Sender (default to same as 'From' if not present) */
460 fieldptr = rfc822_fetch_field(msg->cm_fields[eMesageText], "Sender");
461 if (fieldptr != NULL) {
462 imap_output_envelope_addr(fieldptr);
466 imap_output_envelope_from(msg);
470 fieldptr = rfc822_fetch_field(msg->cm_fields[eMesageText], "Reply-to");
471 if (fieldptr != NULL) {
472 imap_output_envelope_addr(fieldptr);
476 imap_output_envelope_from(msg);
480 imap_output_envelope_addr(msg->cm_fields[eRecipient]);
482 /* Cc (we do it this way because there might be a legacy non-Citadel Cc: field present) */
483 fieldptr = msg->cm_fields[eCarbonCopY];
484 if (fieldptr != NULL) {
485 imap_output_envelope_addr(fieldptr);
488 fieldptr = rfc822_fetch_field(msg->cm_fields[eMesageText], "Cc");
489 imap_output_envelope_addr(fieldptr);
490 if (fieldptr != NULL) free(fieldptr);
494 fieldptr = rfc822_fetch_field(msg->cm_fields[eMesageText], "Bcc");
495 imap_output_envelope_addr(fieldptr);
496 if (fieldptr != NULL) free(fieldptr);
499 fieldptr = rfc822_fetch_field(msg->cm_fields[eMesageText], "In-reply-to");
500 IPutStr(fieldptr, (fieldptr)?strlen(fieldptr):0);
502 if (fieldptr != NULL) free(fieldptr);
505 len = msg->cm_lengths[emessageId];
508 (msg->cm_fields[emessageId][0] == '<') &&
509 (msg->cm_fields[emessageId][len - 1] == '>'))
511 IPutMsgField(emessageId);
515 char *Buf = malloc(len + 3);
518 if (msg->cm_fields[emessageId][0] != '<')
523 memcpy(&Buf[pos], msg->cm_fields[emessageId], len);
525 if (msg->cm_fields[emessageId][len] != '>')
539 * This function is called only when CC->redirect_buffer contains a set of
540 * RFC822 headers with no body attached. Its job is to strip that set of
541 * headers down to *only* the ones we're interested in.
543 void imap_strip_headers(StrBuf *section) {
545 StrBuf *which_fields = NULL;
546 int doing_headers = 0;
550 StrBuf *boiled_headers = NULL;
553 int done_headers = 0;
554 const char *Ptr = NULL;
555 CitContext *CCC = CC;
557 if (CCC->redirect_buffer == NULL) return;
559 which_fields = NewStrBufDup(section);
561 if (!strncasecmp(ChrPtr(which_fields), "HEADER.FIELDS", 13))
564 !strncasecmp(ChrPtr(which_fields), "HEADER.FIELDS.NOT", 17))
567 for (i=0; i < StrLength(which_fields); ++i) {
568 if (ChrPtr(which_fields)[i]=='(')
569 StrBufReplaceToken(which_fields, i, 1, HKEY(""));
571 for (i=0; i < StrLength(which_fields); ++i) {
572 if (ChrPtr(which_fields)[i]==')') {
573 StrBufCutAt(which_fields, i, NULL);
577 memset(&Cmd, 0, sizeof(citimap_command));
578 Cmd.CmdBuf = which_fields;
579 num_parms = imap_parameterize(&Cmd);
581 boiled_headers = NewStrBufPlain(NULL, StrLength(CCC->redirect_buffer));
582 Line = NewStrBufPlain(NULL, SIZ);
586 StrBufSipLine(Line, CCC->redirect_buffer, &Ptr);
588 if (!isspace(ChrPtr(Line)[0])) {
590 if (doing_headers == 0) ok = 1;
592 /* we're supposed to print all headers that are not matching the filter list */
593 if (headers_not) for (i=0, ok = 1; (i < num_parms) && (ok == 1); ++i) {
594 if ( (!strncasecmp(ChrPtr(Line),
596 Cmd.Params[i].len)) &&
597 (ChrPtr(Line)[Cmd.Params[i].len]==':') ) {
601 /* we're supposed to print all headers matching the filterlist */
602 else for (i=0, ok = 0; ((i < num_parms) && (ok == 0)); ++i) {
603 if ( (!strncasecmp(ChrPtr(Line),
605 Cmd.Params[i].len)) &&
606 (ChrPtr(Line)[Cmd.Params[i].len]==':') ) {
614 StrBufAppendBuf(boiled_headers, Line, 0);
615 StrBufAppendBufPlain(boiled_headers, HKEY("\r\n"), 0);
618 if ((Ptr == StrBufNOTNULL) ||
619 (StrLength(Line) == 0) ||
620 (ChrPtr(Line)[0]=='\r') ||
621 (ChrPtr(Line)[0]=='\n') ) done_headers = 1;
622 } while (!done_headers);
624 StrBufAppendBufPlain(boiled_headers, HKEY("\r\n"), 0);
626 /* Now save it back (it'll always be smaller) */
627 FreeStrBuf(&CCC->redirect_buffer);
628 CCC->redirect_buffer = boiled_headers;
631 FreeStrBuf(&which_fields);
637 * Implements the BODY and BODY.PEEK fetch items
639 void imap_fetch_body(long msgnum, ConstStr item, int is_peek) {
640 struct CtdlMessage *msg = NULL;
644 size_t pstart, pbytes;
645 int loading_body_now = 0;
647 int burn_the_cache = 0;
648 CitContext *CCC = CC;
649 citimap *Imap = CCCIMAP;
651 /* extract section */
652 section = NewStrBufPlain(CKEY(item));
654 if (strchr(ChrPtr(section), '[') != NULL) {
655 StrBufStripAllBut(section, '[', ']');
657 syslog(LOG_DEBUG, "imap: selected section is [%s]", (StrLength(section) == 0) ? "(empty)" : ChrPtr(section));
659 /* Burn the cache if we don't have the same section of the
660 * same message again.
662 if (Imap->cached_body != NULL) {
663 if (Imap->cached_bodymsgnum != msgnum) {
666 else if ( (!Imap->cached_body_withbody) && (need_body) ) {
669 else if (strcasecmp(Imap->cached_bodypart, ChrPtr(section))) {
672 if (burn_the_cache) {
673 /* Yup, go ahead and burn the cache. */
674 free(Imap->cached_body);
675 Imap->cached_body_len = 0;
676 Imap->cached_body = NULL;
677 Imap->cached_bodymsgnum = (-1);
678 strcpy(Imap->cached_bodypart, "");
682 /* extract partial */
683 partial = NewStrBufPlain(CKEY(item));
684 if (strchr(ChrPtr(partial), '<') != NULL) {
685 StrBufStripAllBut(partial, '<', '>');
688 if ( (is_partial == 1) && (StrLength(partial) > 0) ) {
689 syslog(LOG_DEBUG, "imap: selected partial is <%s>", ChrPtr(partial));
692 if (Imap->cached_body == NULL) {
693 CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
694 loading_body_now = 1;
695 msg = CtdlFetchMessage(msgnum, (need_body ? 1 : 0), 1);
698 /* Now figure out what the client wants, and get it */
700 if (!loading_body_now) {
701 /* What we want is already in memory */
704 else if ( (!strcmp(ChrPtr(section), "1")) && (msg->cm_format_type != 4) ) {
705 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
708 else if (StrLength(section) == 0) {
709 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, SUPPRESS_ENV_TO);
713 * If the client asked for just headers, or just particular header
714 * fields, strip it down.
716 else if (!strncasecmp(ChrPtr(section), "HEADER", 6)) {
717 /* This used to work with HEADERS_FAST, but then Apple got stupid with their
718 * IMAP library and this broke Mail.App and iPhone Mail, so we had to change it
719 * to HEADERS_ONLY so the trendy hipsters with their iPhones can read mail.
721 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, SUPPRESS_ENV_TO);
722 imap_strip_headers(section);
726 * Strip it down if the client asked for everything _except_ headers.
728 else if (!strncasecmp(ChrPtr(section), "TEXT", 4)) {
729 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
733 * Anything else must be a part specifier.
734 * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
737 mime_parser(CM_RANGE(msg, eMesageText),
738 *imap_load_part, NULL, NULL,
744 if (loading_body_now) {
745 Imap->cached_body_len = StrLength(CCC->redirect_buffer);
746 Imap->cached_body = SmashStrBuf(&CCC->redirect_buffer);
747 Imap->cached_bodymsgnum = msgnum;
748 Imap->cached_body_withbody = need_body;
749 strcpy(Imap->cached_bodypart, ChrPtr(section));
752 if (is_partial == 0) {
754 iaputs(SKEY(section));
755 IAPrintf("] {" SIZE_T_FMT "}\r\n", Imap->cached_body_len);
757 pbytes = Imap->cached_body_len;
760 sscanf(ChrPtr(partial), SIZE_T_FMT "." SIZE_T_FMT, &pstart, &pbytes);
761 if (pbytes > (Imap->cached_body_len - pstart)) {
762 pbytes = Imap->cached_body_len - pstart;
765 iaputs(SKEY(section));
766 IAPrintf("]<" SIZE_T_FMT "> {" SIZE_T_FMT "}\r\n", pstart, pbytes);
769 FreeStrBuf(&partial);
771 /* Here we go -- output it */
772 iaputs(&Imap->cached_body[pstart], pbytes);
778 /* Mark this message as "seen" *unless* this is a "peek" operation */
780 CtdlSetSeen(&msgnum, 1, 1, ctdlsetseen_seen, NULL, NULL);
782 FreeStrBuf(§ion);
786 * Called immediately before outputting a multipart bodystructure
788 void imap_fetch_bodystructure_pre(
789 char *name, char *filename, char *partnum, char *disp,
790 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
791 char *cbid, void *cbuserdata
800 * Called immediately after outputting a multipart bodystructure
802 void imap_fetch_bodystructure_post(
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
813 len = extract_token(subtype, cbtype, 1, '/', sizeof subtype);
814 IPutStr(subtype, len);
817 /* IAPuts(" NIL"); We thought we needed this at one point, but maybe we don't... */
825 * Output the info for a MIME part in the format required by BODYSTRUCTURE.
828 void imap_fetch_bodystructure_part(
829 char *name, char *filename, char *partnum, char *disp,
830 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
831 char *cbid, void *cbuserdata
835 int have_encoding = 0;
838 char cbmaintype[128];
843 if (cbtype != NULL) if (!IsEmptyStr(cbtype)) have_cbtype = 1;
845 cbmaintype_len = extract_token(cbmaintype, cbtype, 0, '/', sizeof cbmaintype);
846 cbsubtype_len = extract_token(cbsubtype, cbtype, 1, '/', sizeof cbsubtype);
849 strcpy(cbmaintype, "TEXT");
851 strcpy(cbsubtype, "PLAIN");
856 IPutStr(cbmaintype, cbmaintype_len); /* body type */
858 IPutStr(cbsubtype, cbsubtype_len); /* body subtype */
861 IAPuts("("); /* begin body parameter list */
863 /* "NAME" must appear as the first parameter. This is not required by IMAP,
864 * but the Asterisk voicemail application blindly assumes that NAME will be in
865 * the first position. If it isn't, it rejects the message.
867 if ((name != NULL) && (!IsEmptyStr(name))) {
869 IPutStr(name, strlen(name));
873 IAPuts("\"CHARSET\" ");
874 if ((cbcharset == NULL) || (cbcharset[0] == 0)){
875 IPutStr(HKEY("US-ASCII"));
878 IPutStr(cbcharset, strlen(cbcharset));
880 IAPuts(") "); /* end body parameter list */
882 IAPuts("NIL "); /* Body ID */
883 IAPuts("NIL "); /* Body description */
885 if ((encoding != NULL) && (encoding[0] != 0)) have_encoding = 1;
887 IPutStr(encoding, strlen(encoding));
890 IPutStr(HKEY("7BIT"));
894 /* The next field is the size of the part in bytes. */
895 IAPrintf("%ld ", (long)length); /* bytes */
897 /* The next field is the number of lines in the part, if and only
898 * if the part is TEXT. More gratuitous complexity.
900 if (!strcasecmp(cbmaintype, "TEXT")) {
901 if (length) for (i=0; i<length; ++i) {
902 if (((char *)content)[i] == '\n') ++lines;
904 IAPrintf("%d ", lines);
907 /* More gratuitous complexity */
908 if ((!strcasecmp(cbmaintype, "MESSAGE"))
909 && (!strcasecmp(cbsubtype, "RFC822"))) {
910 /* FIXME: message/rfc822 also needs to output the envelope structure,
911 * body structure, and line count of the encapsulated message. Fortunately
912 * there are not yet any clients depending on this, so we can get away
913 * with not implementing it for now.
917 /* MD5 value of body part; we can get away with NIL'ing this */
921 if ((disp == NULL) || IsEmptyStr(disp)) {
926 IPutStr(disp, strlen(disp));
927 if ((filename != NULL) && (!IsEmptyStr(filename))) {
928 IAPuts(" (\"FILENAME\" ");
929 IPutStr(filename, strlen(filename));
935 /* Body language (not defined yet) */
942 * Spew the BODYSTRUCTURE data for a message.
945 void imap_fetch_bodystructure (long msgnum, const char *item,
946 struct CtdlMessage *msg) {
947 const char *rfc822 = NULL;
948 const char *rfc822_body = NULL;
950 size_t rfc822_headers_len;
951 size_t rfc822_body_len;
952 const char *ptr = NULL;
957 /* Handle NULL message gracefully */
959 IAPuts("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
960 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
965 /* For non-RFC822 (ordinary Citadel) messages, this is short and
968 if (msg->cm_format_type != FMT_RFC822) {
970 /* *sigh* We have to RFC822-format the message just to be able
971 * to measure it. FIXME use smi cached fields if possible
974 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
975 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1, SUPPRESS_ENV_TO);
976 rfc822_len = StrLength(CC->redirect_buffer);
977 rfc822 = pch = SmashStrBuf(&CC->redirect_buffer);
981 ptr = cmemreadline(ptr, buf, sizeof buf);
983 if ((IsEmptyStr(buf)) && (rfc822_body == NULL)) {
988 rfc822_headers_len = rfc822_body - rfc822;
989 rfc822_body_len = rfc822_len - rfc822_headers_len;
992 IAPuts("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
993 "(\"CHARSET\" \"US-ASCII\") NIL NIL "
995 IAPrintf(SIZE_T_FMT " %d)", rfc822_body_len, lines);
1000 /* For messages already stored in RFC822 format, we have to parse. */
1001 IAPuts("BODYSTRUCTURE ");
1002 mime_parser(CM_RANGE(msg, eMesageText),
1003 *imap_fetch_bodystructure_part, /* part */
1004 *imap_fetch_bodystructure_pre, /* pre-multi */
1005 *imap_fetch_bodystructure_post, /* post-multi */
1007 1); /* don't decode -- we want it as-is */
1012 * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
1013 * individual message, once it has been selected for output.
1015 void imap_do_fetch_msg(int seq, citimap_command *Cmd) {
1017 citimap *Imap = IMAP;
1018 struct CtdlMessage *msg = NULL;
1019 int body_loaded = 0;
1021 /* Don't attempt to fetch bogus messages or UID's */
1022 if (seq < 1) return;
1023 if (Imap->msgids[seq-1] < 1L) return;
1026 IAPrintf("* %d FETCH (", seq);
1028 for (i=0; i<Cmd->num_parms; ++i) {
1030 /* Fetchable without going to the message store at all */
1031 if (!strcasecmp(Cmd->Params[i].Key, "UID")) {
1032 imap_fetch_uid(seq);
1034 else if (!strcasecmp(Cmd->Params[i].Key, "FLAGS")) {
1035 imap_fetch_flags(seq-1);
1038 /* Potentially fetchable from cache, if the client requests
1039 * stuff from the same message several times in a row.
1041 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822")) {
1042 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1044 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.HEADER")) {
1045 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1047 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.SIZE")) {
1048 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1050 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.TEXT")) {
1051 imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1054 /* BODY fetches do their own fetching and caching too. */
1055 else if (!strncasecmp(Cmd->Params[i].Key, "BODY[", 5)) {
1056 imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i], 0);
1058 else if (!strncasecmp(Cmd->Params[i].Key, "BODY.PEEK[", 10)) {
1059 imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i], 1);
1062 /* Otherwise, load the message into memory.
1064 else if (!strcasecmp(Cmd->Params[i].Key, "BODYSTRUCTURE")) {
1065 if ((msg != NULL) && (!body_loaded)) {
1066 CM_Free(msg); /* need the whole thing */
1070 msg = CtdlFetchMessage(Imap->msgids[seq-1], 1, 1);
1073 imap_fetch_bodystructure(Imap->msgids[seq-1],
1074 Cmd->Params[i].Key, msg);
1076 else if (!strcasecmp(Cmd->Params[i].Key, "ENVELOPE")) {
1078 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0, 1);
1081 imap_fetch_envelope(msg);
1083 else if (!strcasecmp(Cmd->Params[i].Key, "INTERNALDATE")) {
1085 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0, 1);
1088 imap_fetch_internaldate(msg);
1091 if (i != Cmd->num_parms-1) IAPuts(" ");
1104 * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1105 * validated and boiled down the request a bit.
1107 void imap_do_fetch(citimap_command *Cmd) {
1108 citimap *Imap = IMAP;
1111 /* debug output the parsed vector */
1114 syslog(LOG_DEBUG, "imap: ----- %ld params", Cmd->num_parms);
1116 for (i=0; i < Cmd->num_parms; i++) {
1117 if (Cmd->Params[i].len != strlen(Cmd->Params[i].Key))
1118 syslog(LOG_DEBUG, "imap: *********** %ld != %ld : %s",
1120 strlen(Cmd->Params[i].Key),
1121 Cmd->Params[i].Key);
1123 syslog(LOG_DEBUG, "imap: %ld : %s",
1125 Cmd->Params[i].Key);
1130 if (Imap->num_msgs > 0) {
1131 for (i = 0; i < Imap->num_msgs; ++i) {
1133 /* Abort the fetch loop if the session breaks.
1134 * This is important for users who keep mailboxes
1135 * that are too big *and* are too impatient to
1136 * let them finish loading. :)
1138 if (CC->kill_me) return;
1140 /* Get any message marked for fetch. */
1141 if (Imap->flags[i] & IMAP_SELECTED) {
1142 imap_do_fetch_msg(i+1, Cmd);
1151 * Back end for imap_handle_macros()
1152 * Note that this function *only* looks at the beginning of the string. It
1153 * is not a generic search-and-replace function.
1155 void imap_macro_replace(StrBuf *Buf, long where,
1157 char *find, long findlen,
1158 char *replace, long replacelen)
1161 if (StrLength(Buf) - where > findlen)
1164 if (!strncasecmp(ChrPtr(Buf) + where, find, findlen)) {
1165 if (ChrPtr(Buf)[where + findlen] == ' ') {
1166 StrBufPlain(TmpBuf, replace, replacelen);
1167 StrBufAppendBufPlain(TmpBuf, HKEY(" "), 0);
1168 StrBufReplaceToken(Buf, where, findlen,
1171 if (where + findlen == StrLength(Buf)) {
1172 StrBufReplaceToken(Buf, where, findlen,
1173 replace, replacelen);
1181 * Handle macros embedded in FETCH data items.
1182 * (What the heck are macros doing in a wire protocol? Are we trying to save
1183 * the computer at the other end the trouble of typing a lot of characters?)
1185 void imap_handle_macros(citimap_command *Cmd) {
1188 StrBuf *Tmp = NewStrBuf();
1190 for (i=0; i < StrLength(Cmd->CmdBuf); ++i) {
1191 char ch = ChrPtr(Cmd->CmdBuf)[i];
1196 else if ((ch==')') ||
1202 imap_macro_replace(Cmd->CmdBuf, i,
1205 HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE")
1207 imap_macro_replace(Cmd->CmdBuf, i,
1210 HKEY("BODYSTRUCTURE")
1212 imap_macro_replace(Cmd->CmdBuf, i,
1215 HKEY("FLAGS INTERNALDATE RFC822.SIZE")
1217 imap_macro_replace(Cmd->CmdBuf, i,
1220 HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY")
1229 * Break out the data items requested, possibly a parenthesized list.
1230 * Returns the number of data items, or -1 if the list is invalid.
1231 * NOTE: this function alters the string it is fed, and uses it as a buffer
1232 * to hold the data for the pointers it returns.
1234 int imap_extract_data_items(citimap_command *Cmd)
1238 const char *pch, *end;
1240 /* Convert all whitespace to ordinary space characters. */
1241 pch = ChrPtr(Cmd->CmdBuf);
1242 end = pch + StrLength(Cmd->CmdBuf);
1247 StrBufPeek(Cmd->CmdBuf, pch, 0, ' ');
1251 /* Strip leading and trailing whitespace, then strip leading and
1252 * trailing parentheses if it's a list
1254 StrBufTrim(Cmd->CmdBuf);
1255 pch = ChrPtr(Cmd->CmdBuf);
1256 if ( (pch[0]=='(') &&
1257 (pch[StrLength(Cmd->CmdBuf)-1]==')') )
1259 StrBufCutRight(Cmd->CmdBuf, 1);
1260 StrBufCutLeft(Cmd->CmdBuf, 1);
1261 StrBufTrim(Cmd->CmdBuf);
1264 /* Parse any macro data items */
1265 imap_handle_macros(Cmd);
1268 * Now break out the data items. We throw in one trailing space in
1269 * order to avoid having to break out the last one manually.
1271 nArgs = StrLength(Cmd->CmdBuf) / 10 + 10;
1272 nArgs = CmdAdjust(Cmd, nArgs, 0);
1274 Cmd->Params[Cmd->num_parms].Key = pch = ChrPtr(Cmd->CmdBuf);
1275 end = Cmd->Params[Cmd->num_parms].Key + StrLength(Cmd->CmdBuf);
1285 else if ((*pch==')') ||
1291 if ((nest <= 0) && (*pch==' ')) {
1292 StrBufPeek(Cmd->CmdBuf, pch, 0, '\0');
1293 Cmd->Params[Cmd->num_parms].len =
1294 pch - Cmd->Params[Cmd->num_parms].Key;
1296 if (Cmd->num_parms + 1 >= Cmd->avail_parms) {
1297 nArgs = CmdAdjust(Cmd, nArgs * 2, 1);
1300 Cmd->Params[Cmd->num_parms].Key = ++pch;
1302 else if (pch + 1 == end) {
1303 Cmd->Params[Cmd->num_parms].len =
1304 pch - Cmd->Params[Cmd->num_parms].Key + 1;
1310 return Cmd->num_parms;
1316 * One particularly hideous aspect of IMAP is that we have to allow the client
1317 * to specify arbitrary ranges and/or sets of messages to fetch. Citadel IMAP
1318 * handles this by setting the IMAP_SELECTED flag for each message specified in
1319 * the ranges/sets, then looping through the message array, outputting messages
1320 * with the flag set. We don't bother returning an error if an out-of-range
1321 * number is specified (we just return quietly) because any client braindead
1322 * enough to request a bogus message number isn't going to notice the
1323 * difference anyway.
1325 * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1326 * message included in the specified range.
1328 * Set is_uid to 1 to fetch by UID instead of sequence number.
1330 void imap_pick_range(const char *supplied_range, int is_uid) {
1331 citimap *Imap = IMAP;
1335 char setstr[SIZ], lostr[SIZ], histr[SIZ];
1337 char actual_range[SIZ];
1340 * Handle the "ALL" macro
1342 if (!strcasecmp(supplied_range, "ALL")) {
1343 safestrncpy(actual_range, "1:*", sizeof actual_range);
1346 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1350 * Clear out the IMAP_SELECTED flags for all messages.
1352 for (i = 0; i < Imap->num_msgs; ++i) {
1353 Imap->flags[i] = Imap->flags[i] & ~IMAP_SELECTED;
1357 * Now set it for all specified messages.
1359 num_sets = num_tokens(actual_range, ',');
1360 for (s=0; s<num_sets; ++s) {
1361 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1363 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1364 if (num_tokens(setstr, ':') >= 2) {
1365 extract_token(histr, setstr, 1, ':', sizeof histr);
1366 if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1369 safestrncpy(histr, lostr, sizeof histr);
1374 /* Loop through the array, flipping bits where appropriate */
1375 for (i = 1; i <= Imap->num_msgs; ++i) {
1376 if (is_uid) { /* fetch by sequence number */
1377 if ( (Imap->msgids[i-1]>=lo)
1378 && (Imap->msgids[i-1]<=hi)) {
1379 Imap->flags[i-1] |= IMAP_SELECTED;
1382 else { /* fetch by uid */
1383 if ( (i>=lo) && (i<=hi)) {
1384 Imap->flags[i-1] |= IMAP_SELECTED;
1394 * This function is called by the main command loop.
1396 void imap_fetch(int num_parms, ConstStr *Params) {
1397 citimap_command Cmd;
1400 if (num_parms < 4) {
1401 IReply("BAD invalid parameters");
1405 imap_pick_range(Params[2].Key, 0);
1407 memset(&Cmd, 0, sizeof(citimap_command));
1408 Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1409 MakeStringOf(Cmd.CmdBuf, 3);
1411 num_items = imap_extract_data_items(&Cmd);
1412 if (num_items < 1) {
1413 IReply("BAD invalid data item list");
1414 FreeStrBuf(&Cmd.CmdBuf);
1419 imap_do_fetch(&Cmd);
1420 IReply("OK FETCH completed");
1421 FreeStrBuf(&Cmd.CmdBuf);
1426 * This function is called by the main command loop.
1428 void imap_uidfetch(int num_parms, ConstStr *Params) {
1429 citimap_command Cmd;
1432 int have_uid_item = 0;
1434 if (num_parms < 5) {
1435 IReply("BAD invalid parameters");
1439 imap_pick_range(Params[3].Key, 1);
1441 memset(&Cmd, 0, sizeof(citimap_command));
1442 Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1444 MakeStringOf(Cmd.CmdBuf, 4);
1446 syslog(LOG_DEBUG, "imap: -------%s--------", ChrPtr(Cmd.CmdBuf));
1448 num_items = imap_extract_data_items(&Cmd);
1449 if (num_items < 1) {
1450 IReply("BAD invalid data item list");
1451 FreeStrBuf(&Cmd.CmdBuf);
1456 /* If the "UID" item was not included, we include it implicitly
1457 * (at the beginning) because this is a UID FETCH command
1459 for (i=0; i<num_items; ++i) {
1460 if (!strcasecmp(Cmd.Params[i].Key, "UID")) ++have_uid_item;
1462 if (have_uid_item == 0) {
1463 if (Cmd.num_parms + 1 >= Cmd.avail_parms)
1464 CmdAdjust(&Cmd, Cmd.avail_parms + 1, 1);
1465 memmove(&Cmd.Params[1],
1467 sizeof(ConstStr) * Cmd.num_parms);
1470 Cmd.Params[0] = (ConstStr){HKEY("UID")};
1473 imap_do_fetch(&Cmd);
1474 IReply("OK UID FETCH completed");
1475 FreeStrBuf(&Cmd.CmdBuf);