When outputting the extension data for a
[citadel.git] / citadel / modules / imap / imap_fetch.c
1 /*
2  * $Id$
3  *
4  * Implements the FETCH command in IMAP.
5  * This is a good example of the protocol's gratuitous complexity.
6  *
7  */
8
9
10 #include "sysdep.h"
11 #include <stdlib.h>
12 #include <unistd.h>
13 #include <stdio.h>
14 #include <fcntl.h>
15 #include <signal.h>
16 #include <pwd.h>
17 #include <errno.h>
18 #include <sys/types.h>
19
20 #if TIME_WITH_SYS_TIME
21 # include <sys/time.h>
22 # include <time.h>
23 #else
24 # if HAVE_SYS_TIME_H
25 #  include <sys/time.h>
26 # else
27 #  include <time.h>
28 # endif
29 #endif
30
31 #include <sys/wait.h>
32 #include <ctype.h>
33 #include <string.h>
34 #include <limits.h>
35 #include "citadel.h"
36 #include "server.h"
37 #include "sysdep_decls.h"
38 #include "citserver.h"
39 #include "support.h"
40 #include "config.h"
41 #include "room_ops.h"
42 #include "user_ops.h"
43 #include "policy.h"
44 #include "database.h"
45 #include "msgbase.h"
46 #include "tools.h"
47 #include "internet_addressing.h"
48 #include "mime_parser.h"
49 #include "serv_imap.h"
50 #include "imap_tools.h"
51 #include "imap_fetch.h"
52 #include "genstamp.h"
53
54
55
56 /*
57  * Individual field functions for imap_do_fetch_msg() ...
58  */
59
60 void imap_fetch_uid(int seq) {
61         cprintf("UID %ld", IMAP->msgids[seq-1]);
62 }
63
64 void imap_fetch_flags(int seq) {
65         int num_flags_printed = 0;
66         cprintf("FLAGS (");
67         if (IMAP->flags[seq] & IMAP_DELETED) {
68                 if (num_flags_printed > 0) cprintf(" ");
69                 cprintf("\\Deleted");
70                 ++num_flags_printed;
71         }
72         if (IMAP->flags[seq] & IMAP_SEEN) {
73                 if (num_flags_printed > 0) cprintf(" ");
74                 cprintf("\\Seen");
75                 ++num_flags_printed;
76         }
77         if (IMAP->flags[seq] & IMAP_ANSWERED) {
78                 if (num_flags_printed > 0) cprintf(" ");
79                 cprintf("\\Answered");
80                 ++num_flags_printed;
81         }
82         if (IMAP->flags[seq] & IMAP_RECENT) {
83                 if (num_flags_printed > 0) cprintf(" ");
84                 cprintf("\\Recent");
85                 ++num_flags_printed;
86         }
87         cprintf(")");
88 }
89
90 void imap_fetch_internaldate(struct CtdlMessage *msg) {
91         char buf[SIZ];
92         time_t msgdate;
93
94         if (!msg) return;
95         if (msg->cm_fields['T'] != NULL) {
96                 msgdate = atol(msg->cm_fields['T']);
97         }
98         else {
99                 msgdate = time(NULL);
100         }
101
102         datestring(buf, sizeof buf, msgdate, DATESTRING_IMAP);
103         cprintf("INTERNALDATE \"%s\"", buf);
104 }
105
106
107 /*
108  * Fetch RFC822-formatted messages.
109  *
110  * 'whichfmt' should be set to one of:
111  *      "RFC822"        entire message
112  *      "RFC822.HEADER" headers only (with trailing blank line)
113  *      "RFC822.SIZE"   size of translated message
114  *      "RFC822.TEXT"   body only (without leading blank line)
115  */
116 void imap_fetch_rfc822(long msgnum, char *whichfmt) {
117         char buf[SIZ];
118         char *ptr = NULL;
119         size_t headers_size, text_size, total_size;
120         size_t bytes_to_send = 0;
121         struct MetaData smi;
122         int need_to_rewrite_metadata = 0;
123         int need_body = 0;
124
125         /* Determine whether this particular fetch operation requires
126          * us to fetch the message body from disk.  If not, we can save
127          * on some disk operations...
128          */
129         if ( (!strcasecmp(whichfmt, "RFC822"))
130            || (!strcasecmp(whichfmt, "RFC822.TEXT")) ) {
131                 need_body = 1;
132         }
133
134         /* If this is an RFC822.SIZE fetch, first look in the message's
135          * metadata record to see if we've saved that information.
136          */
137         if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
138                 GetMetaData(&smi, msgnum);
139                 if (smi.meta_rfc822_length > 0L) {
140                         cprintf("RFC822.SIZE %ld", smi.meta_rfc822_length);
141                         return;
142                 }
143                 need_to_rewrite_metadata = 1;
144                 need_body = 1;
145         }
146         
147         /* Cache the most recent RFC822 FETCH because some clients like to
148          * fetch in pieces, and we don't want to have to go back to the
149          * message store for each piece.  We also burn the cache if the
150          * client requests something that involves reading the message
151          * body, but we haven't fetched the body yet.
152          */
153         if ((IMAP->cached_rfc822_data != NULL)
154            && (IMAP->cached_rfc822_msgnum == msgnum)
155            && (IMAP->cached_rfc822_withbody || (!need_body)) ) {
156                 /* Good to go! */
157         }
158         else if (IMAP->cached_rfc822_data != NULL) {
159                 /* Some other message is cached -- free it */
160                 free(IMAP->cached_rfc822_data);
161                 IMAP->cached_rfc822_data = NULL;
162                 IMAP->cached_rfc822_msgnum = (-1);
163                 IMAP->cached_rfc822_len = 0;
164         }
165
166         /* At this point, we now can fetch and convert the message iff it's not
167          * the one we had cached.
168          */
169         if (IMAP->cached_rfc822_data == NULL) {
170                 /*
171                  * Load the message into memory for translation & measurement
172                  */
173                 CC->redirect_buffer = malloc(SIZ);
174                 CC->redirect_len = 0;
175                 CC->redirect_alloc = SIZ;
176                 CtdlOutputMsg(msgnum, MT_RFC822,
177                         (need_body ? HEADERS_ALL : HEADERS_ONLY),
178                         0, 1, NULL);
179                 if (!need_body) cprintf("\r\n");        /* extra trailing newline */
180                 IMAP->cached_rfc822_data = CC->redirect_buffer;
181                 IMAP->cached_rfc822_len = CC->redirect_len;
182                 IMAP->cached_rfc822_msgnum = msgnum;
183                 IMAP->cached_rfc822_withbody = need_body;
184                 CC->redirect_buffer = NULL;
185                 CC->redirect_len = 0;
186                 CC->redirect_alloc = 0;
187                 if ( (need_to_rewrite_metadata) && (IMAP->cached_rfc822_len > 0) ) {
188                         smi.meta_rfc822_length = (long)IMAP->cached_rfc822_len;
189                         PutMetaData(&smi);
190                 }
191         }
192
193         /*
194          * Now figure out where the headers/text break is.  IMAP considers the
195          * intervening blank line to be part of the headers, not the text.
196          */
197         headers_size = 0;
198         text_size = 0;
199         total_size = 0;
200
201         if (need_body) {
202                 ptr = IMAP->cached_rfc822_data;
203                 do {
204                         ptr = memreadline(ptr, buf, sizeof buf);
205                         if (*ptr != 0) {
206                                 striplt(buf);
207                                 if (IsEmptyStr(buf)) {
208                                         headers_size = ptr - IMAP->cached_rfc822_data;
209                                 }
210                         }
211                 } while ( (headers_size == 0) && (*ptr != 0) );
212
213                 total_size = IMAP->cached_rfc822_len;
214                 text_size = total_size - headers_size;
215         }
216         else {
217                 headers_size = IMAP->cached_rfc822_len;
218                 total_size = IMAP->cached_rfc822_len;
219                 text_size = 0;
220         }
221
222         lprintf(CTDL_DEBUG, "RFC822: headers=%d, text=%d, total=%d\n",
223                 headers_size, text_size, total_size);
224
225         if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
226                 cprintf("RFC822.SIZE %d", total_size);
227                 return;
228         }
229
230         else if (!strcasecmp(whichfmt, "RFC822")) {
231                 ptr = IMAP->cached_rfc822_data;
232                 bytes_to_send = total_size;
233         }
234
235         else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
236                 ptr = IMAP->cached_rfc822_data;
237                 bytes_to_send = headers_size;
238         }
239
240         else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
241                 ptr = &IMAP->cached_rfc822_data[headers_size];
242                 bytes_to_send = text_size;
243         }
244
245         cprintf("%s {%d}\r\n", whichfmt, bytes_to_send);
246         client_write(ptr, bytes_to_send);
247 }
248
249
250
251 /*
252  * Load a specific part of a message into the temp file to be output to a
253  * client.  FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
254  * but we still can't handle "2.HEADER" (which might not be a problem).
255  *
256  * Note: mime_parser() was called with dont_decode set to 1, so we have the
257  * luxury of simply spewing without having to re-encode.
258  */
259 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
260                     void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
261                     void *cbuserdata)
262 {
263         char mbuf2[SIZ];
264         char *desired_section;
265
266         desired_section = (char *)cbuserdata;
267
268         if (!strcasecmp(partnum, desired_section)) {
269                 client_write(content, length);
270         }
271
272         snprintf(mbuf2, sizeof mbuf2, "%s.MIME", partnum);
273
274         if (!strcasecmp(desired_section, mbuf2)) {
275                 cprintf("Content-type: %s", cbtype);
276                 if (!IsEmptyStr(cbcharset))
277                         cprintf("; charset=\"%s\"", cbcharset);
278                 if (!IsEmptyStr(name))
279                         cprintf("; name=\"%s\"", name);
280                 cprintf("\r\n");
281                 if (!IsEmptyStr(encoding))
282                         cprintf("Content-Transfer-Encoding: %s\r\n", encoding);
283                 if (!IsEmptyStr(encoding)) {
284                         cprintf("Content-Disposition: %s", disp);
285                         if (!IsEmptyStr(filename)) {
286                                 cprintf("; filename=\"%s\"", filename);
287                         }
288                         cprintf("\r\n");
289                 }
290                 cprintf("Content-Length: %ld\r\n", (long)length);
291                 cprintf("\r\n");
292         }
293                         
294
295 }
296
297
298 /* 
299  * Called by imap_fetch_envelope() to output the "From" field.
300  * This is in its own function because its logic is kind of complex.  We
301  * really need to make this suck less.
302  */
303 void imap_output_envelope_from(struct CtdlMessage *msg) {
304         char user[SIZ], node[SIZ], name[SIZ];
305
306         if (!msg) return;
307
308         /* For anonymous messages, it's so easy! */
309         if (!is_room_aide() && (msg->cm_anon_type == MES_ANONONLY)) {
310                 cprintf("((\"----\" NIL \"x\" \"x.org\")) ");
311                 return;
312         }
313         if (!is_room_aide() && (msg->cm_anon_type == MES_ANONOPT)) {
314                 cprintf("((\"anonymous\" NIL \"x\" \"x.org\")) ");
315                 return;
316         }
317
318         /* For everything else, we do stuff. */
319         cprintf("((");                          /* open double-parens */
320         imap_strout(msg->cm_fields['A']);       /* personal name */
321         cprintf(" NIL ");                       /* source route (not used) */
322
323
324         if (msg->cm_fields['F'] != NULL) {
325                 process_rfc822_addr(msg->cm_fields['F'], user, node, name);
326                 imap_strout(user);              /* mailbox name (user id) */
327                 cprintf(" ");
328                 if (!strcasecmp(node, config.c_nodename)) {
329                         imap_strout(config.c_fqdn);
330                 }
331                 else {
332                         imap_strout(node);              /* host name */
333                 }
334         }
335         else {
336                 imap_strout(msg->cm_fields['A']); /* mailbox name (user id) */
337                 cprintf(" ");
338                 imap_strout(msg->cm_fields['N']);       /* host name */
339         }
340         
341         cprintf(")) ");                         /* close double-parens */
342 }
343
344
345
346 /*
347  * Output an envelope address (or set of addresses) in the official,
348  * convuluted, braindead format.  (Note that we can't use this for
349  * the "From" address because its data may come from a number of different
350  * fields.  But we can use it for "To" and possibly others.
351  */
352 void imap_output_envelope_addr(char *addr) {
353         char individual_addr[256];
354         int num_addrs;
355         int i;
356         char user[256];
357         char node[256];
358         char name[256];
359
360         if (addr == NULL) {
361                 cprintf("NIL ");
362                 return;
363         }
364
365         if (IsEmptyStr(addr)) {
366                 cprintf("NIL ");
367                 return;
368         }
369
370         cprintf("(");
371
372         /* How many addresses are listed here? */
373         num_addrs = num_tokens(addr, ',');
374
375         /* Output them one by one. */
376         for (i=0; i<num_addrs; ++i) {
377                 extract_token(individual_addr, addr, i, ',', sizeof individual_addr);
378                 striplt(individual_addr);
379                 process_rfc822_addr(individual_addr, user, node, name);
380                 cprintf("(");
381                 imap_strout(name);
382                 cprintf(" NIL ");
383                 imap_strout(user);
384                 cprintf(" ");
385                 imap_strout(node);
386                 cprintf(")");
387                 if (i < (num_addrs-1)) cprintf(" ");
388         }
389
390         cprintf(") ");
391 }
392
393
394 /*
395  * Implements the ENVELOPE fetch item
396  * 
397  * Note that the imap_strout() function can cleverly output NULL fields as NIL,
398  * so we don't have to check for that condition like we do elsewhere.
399  */
400 void imap_fetch_envelope(struct CtdlMessage *msg) {
401         char datestringbuf[SIZ];
402         time_t msgdate;
403         char *fieldptr = NULL;
404
405         if (!msg) return;
406
407         /* Parse the message date into an IMAP-format date string */
408         if (msg->cm_fields['T'] != NULL) {
409                 msgdate = atol(msg->cm_fields['T']);
410         }
411         else {
412                 msgdate = time(NULL);
413         }
414         datestring(datestringbuf, sizeof datestringbuf,
415                 msgdate, DATESTRING_IMAP);
416
417         /* Now start spewing data fields.  The order is important, as it is
418          * defined by the protocol specification.  Nonexistent fields must
419          * be output as NIL, existent fields must be quoted or literalled.
420          * The imap_strout() function conveniently does all this for us.
421          */
422         cprintf("ENVELOPE (");
423
424         /* Date */
425         imap_strout(datestringbuf);
426         cprintf(" ");
427
428         /* Subject */
429         imap_strout(msg->cm_fields['U']);
430         cprintf(" ");
431
432         /* From */
433         imap_output_envelope_from(msg);
434
435         /* Sender (default to same as 'From' if not present) */
436         fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Sender");
437         if (fieldptr != NULL) {
438                 imap_output_envelope_addr(fieldptr);
439                 free(fieldptr);
440         }
441         else {
442                 imap_output_envelope_from(msg);
443         }
444
445         /* Reply-to */
446         fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Reply-to");
447         if (fieldptr != NULL) {
448                 imap_output_envelope_addr(fieldptr);
449                 free(fieldptr);
450         }
451         else {
452                 imap_output_envelope_from(msg);
453         }
454
455         /* To */
456         imap_output_envelope_addr(msg->cm_fields['R']);
457
458         /* Cc (we do it this way because there might be a legacy non-Citadel Cc: field present) */
459         fieldptr = msg->cm_fields['Y'];
460         if (fieldptr != NULL) {
461                 imap_output_envelope_addr(fieldptr);
462         }
463         else {
464                 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Cc");
465                 imap_output_envelope_addr(fieldptr);
466                 if (fieldptr != NULL) free(fieldptr);
467         }
468
469         /* Bcc */
470         fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Bcc");
471         imap_output_envelope_addr(fieldptr);
472         if (fieldptr != NULL) free(fieldptr);
473
474         /* In-reply-to */
475         fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "In-reply-to");
476         imap_strout(fieldptr);
477         cprintf(" ");
478         if (fieldptr != NULL) free(fieldptr);
479
480         /* message ID */
481         imap_strout(msg->cm_fields['I']);
482
483         cprintf(")");
484 }
485
486 /*
487  * This function is called only when CC->redirect_buffer contains a set of
488  * RFC822 headers with no body attached.  Its job is to strip that set of
489  * headers down to *only* the ones we're interested in.
490  */
491 void imap_strip_headers(char *section) {
492         char buf[SIZ];
493         char *which_fields = NULL;
494         int doing_headers = 0;
495         int headers_not = 0;
496         char *parms[SIZ];
497         int num_parms = 0;
498         int i;
499         char *boiled_headers = NULL;
500         int ok = 0;
501         int done_headers = 0;
502         char *ptr = NULL;
503
504         if (CC->redirect_buffer == NULL) return;
505
506         which_fields = strdup(section);
507
508         if (!strncasecmp(which_fields, "HEADER.FIELDS", 13))
509                 doing_headers = 1;
510         if (!strncasecmp(which_fields, "HEADER.FIELDS.NOT", 17))
511                 headers_not = 1;
512
513         for (i=0; which_fields[i]; ++i) {
514                 if (which_fields[i]=='(')
515                         strcpy(which_fields, &which_fields[i+1]);
516         }
517         for (i=0; which_fields[i]; ++i) {
518                 if (which_fields[i]==')') {
519                         which_fields[i] = 0;
520                         break;
521                 }
522         }
523         num_parms = imap_parameterize(parms, which_fields);
524
525         boiled_headers = malloc(CC->redirect_alloc);
526         strcpy(boiled_headers, "");
527
528         ptr = CC->redirect_buffer;
529         ok = 0;
530         while ( (done_headers == 0) && (ptr = memreadline(ptr, buf, sizeof buf), *ptr != 0) ) {
531                 if (!isspace(buf[0])) {
532                         ok = 0;
533                         if (doing_headers == 0) ok = 1;
534                         else {
535                                 if (headers_not) ok = 1;
536                                 else ok = 0;
537                                 for (i=0; i<num_parms; ++i) {
538                                         if ( (!strncasecmp(buf, parms[i],
539                                            strlen(parms[i]))) &&
540                                            (buf[strlen(parms[i])]==':') ) {
541                                                 if (headers_not) ok = 0;
542                                                 else ok = 1;
543                                         }
544                                 }
545                         }
546                 }
547
548                 if (ok) {
549                         strcat(boiled_headers, buf);
550                         strcat(boiled_headers, "\r\n");
551                 }
552
553                 if (IsEmptyStr(buf)) done_headers = 1;
554                 if (buf[0]=='\r') done_headers = 1;
555                 if (buf[0]=='\n') done_headers = 1;
556         }
557
558         strcat(boiled_headers, "\r\n");
559
560         /* Now save it back (it'll always be smaller) */
561         strcpy(CC->redirect_buffer, boiled_headers);
562         CC->redirect_len = strlen(boiled_headers);
563
564         free(which_fields);
565         free(boiled_headers);
566 }
567
568
569 /*
570  * Implements the BODY and BODY.PEEK fetch items
571  */
572 void imap_fetch_body(long msgnum, char *item, int is_peek) {
573         struct CtdlMessage *msg = NULL;
574         char section[SIZ];
575         char partial[SIZ];
576         int is_partial = 0;
577         size_t pstart, pbytes;
578         int loading_body_now = 0;
579         int need_body = 1;
580         int burn_the_cache = 0;
581
582         /* extract section */
583         safestrncpy(section, item, sizeof section);
584         if (strchr(section, '[') != NULL) {
585                 stripallbut(section, '[', ']');
586         }
587         lprintf(CTDL_DEBUG, "Section is: %s%s\n", 
588                 section, 
589                 IsEmptyStr(section) ? "(empty)" : "");
590
591         /*
592          * We used to have this great optimization in place that would avoid
593          * fetching the entire RFC822 message from disk if the client was only
594          * asking for the headers.  Unfortunately, fetching only the Citadel
595          * headers omits "Content-type:" and this behavior breaks the iPhone
596          * email client.  So we have to fetch the whole message from disk.  The
597          *
598          *      if (!strncasecmp(section, "HEADER", 6)) {
599          *              need_body = 0;
600          *      }
601          *
602          */
603
604         /* Burn the cache if we don't have the same section of the 
605          * same message again.
606          */
607         if (IMAP->cached_body != NULL) {
608                 if (IMAP->cached_bodymsgnum != msgnum) {
609                         burn_the_cache = 1;
610                 }
611                 else if ( (!IMAP->cached_body_withbody) && (need_body) ) {
612                         burn_the_cache = 1;
613                 }
614                 else if (strcasecmp(IMAP->cached_bodypart, section)) {
615                         burn_the_cache = 1;
616                 }
617                 if (burn_the_cache) {
618                         /* Yup, go ahead and burn the cache. */
619                         free(IMAP->cached_body);
620                         IMAP->cached_body_len = 0;
621                         IMAP->cached_body = NULL;
622                         IMAP->cached_bodymsgnum = (-1);
623                         strcpy(IMAP->cached_bodypart, "");
624                 }
625         }
626
627         /* extract partial */
628         safestrncpy(partial, item, sizeof partial);
629         if (strchr(partial, '<') != NULL) {
630                 stripallbut(partial, '<', '>');
631                 is_partial = 1;
632         }
633         if (is_partial == 0) strcpy(partial, "");
634         /* if (!IsEmptyStr(partial)) lprintf(CTDL_DEBUG, "Partial is %s\n", partial); */
635
636         if (IMAP->cached_body == NULL) {
637                 CC->redirect_buffer = malloc(SIZ);
638                 CC->redirect_len = 0;
639                 CC->redirect_alloc = SIZ;
640                 loading_body_now = 1;
641                 msg = CtdlFetchMessage(msgnum, (need_body ? 1 : 0));
642         }
643
644         /* Now figure out what the client wants, and get it */
645
646         if (!loading_body_now) {
647                 /* What we want is already in memory */
648         }
649
650         else if ( (!strcmp(section, "1")) && (msg->cm_format_type != 4) ) {
651                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1);
652         }
653
654         else if (!strcmp(section, "")) {
655                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1);
656         }
657
658         /*
659          * If the client asked for just headers, or just particular header
660          * fields, strip it down.
661          */
662         else if (!strncasecmp(section, "HEADER", 6)) {
663                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1);
664                 imap_strip_headers(section);
665         }
666
667         /*
668          * Strip it down if the client asked for everything _except_ headers.
669          */
670         else if (!strncasecmp(section, "TEXT", 4)) {
671                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1);
672         }
673
674         /*
675          * Anything else must be a part specifier.
676          * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
677          */
678         else {
679                 mime_parser(msg->cm_fields['M'], NULL,
680                                 *imap_load_part, NULL, NULL,
681                                 section,
682                                 1);
683         }
684
685         if (loading_body_now) {
686                 IMAP->cached_body = CC->redirect_buffer;
687                 IMAP->cached_body_len = CC->redirect_len;
688                 IMAP->cached_bodymsgnum = msgnum;
689                 IMAP->cached_body_withbody = need_body;
690                 strcpy(IMAP->cached_bodypart, section);
691                 CC->redirect_buffer = NULL;
692                 CC->redirect_len = 0;
693                 CC->redirect_alloc = 0;
694         }
695
696         if (is_partial == 0) {
697                 cprintf("BODY[%s] {%d}\r\n", section, IMAP->cached_body_len);
698                 pstart = 0;
699                 pbytes = IMAP->cached_body_len;
700         }
701         else {
702                 sscanf(partial, "%d.%d", &pstart, &pbytes);
703                 if (pbytes > (IMAP->cached_body_len - pstart)) {
704                         pbytes = IMAP->cached_body_len - pstart;
705                 }
706                 cprintf("BODY[%s]<%d> {%d}\r\n", section, pstart, pbytes);
707         }
708
709         /* Here we go -- output it */
710         client_write(&IMAP->cached_body[pstart], pbytes);
711
712         if (msg != NULL) {
713                 CtdlFreeMessage(msg);
714         }
715
716         /* Mark this message as "seen" *unless* this is a "peek" operation */
717         if (is_peek == 0) {
718                 CtdlSetSeen(&msgnum, 1, 1, ctdlsetseen_seen, NULL, NULL);
719         }
720 }
721
722 /*
723  * Called immediately before outputting a multipart bodystructure
724  */
725 void imap_fetch_bodystructure_pre(
726                 char *name, char *filename, char *partnum, char *disp,
727                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
728                 void *cbuserdata
729                 ) {
730
731         cprintf("(");
732 }
733
734
735
736 /*
737  * Called immediately after outputting a multipart bodystructure
738  */
739 void imap_fetch_bodystructure_post(
740                 char *name, char *filename, char *partnum, char *disp,
741                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
742                 void *cbuserdata
743                 ) {
744
745         char subtype[128];
746
747         cprintf(" ");
748
749         /* disposition */
750         extract_token(subtype, cbtype, 1, '/', sizeof subtype);
751         imap_strout(subtype);
752
753         /* body language */
754         /* cprintf(" NIL"); We thought we needed this at one point, but maybe we don't... */
755
756         cprintf(")");
757 }
758
759
760
761 /*
762  * Output the info for a MIME part in the format required by BODYSTRUCTURE.
763  *
764  */
765 void imap_fetch_bodystructure_part(
766                 char *name, char *filename, char *partnum, char *disp,
767                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
768                 void *cbuserdata
769                 ) {
770
771         int have_cbtype = 0;
772         int have_encoding = 0;
773         int lines = 0;
774         size_t i;
775         char cbmaintype[128];
776         char cbsubtype[128];
777
778         if (cbtype != NULL) if (!IsEmptyStr(cbtype)) have_cbtype = 1;
779         if (have_cbtype) {
780                 extract_token(cbmaintype, cbtype, 0, '/', sizeof cbmaintype);
781                 extract_token(cbsubtype, cbtype, 1, '/', sizeof cbsubtype);
782         }
783         else {
784                 strcpy(cbmaintype, "TEXT");
785                 strcpy(cbsubtype, "PLAIN");
786         }
787
788         cprintf("(");
789         imap_strout(cbmaintype);                                        /* body type */
790         cprintf(" ");
791         imap_strout(cbsubtype);                                         /* body subtype */
792         cprintf(" ");
793
794         cprintf("(");                                                   /* begin body parameter list */
795
796         /* "NAME" must appear as the first parameter.  This is not required by IMAP,
797          * but the Asterisk voicemail application blindly assumes that NAME will be in
798          * the first position.  If it isn't, it rejects the message.
799          */
800         if (name != NULL) if (!IsEmptyStr(name)) {
801                 cprintf("\"NAME\" ");
802                 imap_strout(name);
803                 cprintf(" ");
804         }
805
806         cprintf("\"CHARSET\" ");
807         if (cbcharset == NULL) {
808                 imap_strout("US-ASCII");
809         }
810         else if (cbcharset[0] == 0) {
811                 imap_strout("US-ASCII");
812         }
813         else {
814                 imap_strout(cbcharset);
815         }
816         cprintf(") ");                                                  /* end body parameter list */
817
818         cprintf("NIL ");                                                /* Body ID */
819         cprintf("NIL ");                                                /* Body description */
820
821         if (encoding != NULL) if (encoding[0] != 0)  have_encoding = 1;
822         if (have_encoding) {
823                 imap_strout(encoding);
824         }
825         else {
826                 imap_strout("7BIT");
827         }
828         cprintf(" ");
829
830         /* The next field is the size of the part in bytes. */
831         cprintf("%ld ", (long)length);  /* bytes */
832
833         /* The next field is the number of lines in the part, if and only
834          * if the part is TEXT.  More gratuitous complexity.
835          */
836         if (!strcasecmp(cbmaintype, "TEXT")) {
837                 if (length) for (i=0; i<length; ++i) {
838                         if (((char *)content)[i] == '\n') ++lines;
839                 }
840                 cprintf("%d ", lines);
841         }
842
843         /* More gratuitous complexity */
844         if ((!strcasecmp(cbmaintype, "MESSAGE"))
845            && (!strcasecmp(cbsubtype, "RFC822"))) {
846                 /* FIXME
847                      A body type of type MESSAGE and subtype RFC822
848                      contains, immediately after the basic fields, the
849                      envelope structure, body structure, and size in
850                      text lines of the encapsulated message.
851                 */
852         }
853
854         /* MD5 value of body part; we can get away with NIL'ing this */
855         cprintf("NIL ");
856
857         /* Disposition */
858         if (disp == NULL) {
859                 cprintf("NIL");
860         }
861         else if (IsEmptyStr(disp)) {
862                 cprintf("NIL");
863         }
864         else {
865                 cprintf("(");
866                 imap_strout(disp);
867                 if (filename != NULL) if (!IsEmptyStr(filename)) {
868                         cprintf(" (\"FILENAME\" ");
869                         imap_strout(filename);
870                         cprintf(")");
871                 }
872                 cprintf(")");
873         }
874
875         /* Body language (not defined yet) */
876         cprintf(" NIL)");
877 }
878
879
880
881 /*
882  * Spew the BODYSTRUCTURE data for a message.
883  *
884  */
885 void imap_fetch_bodystructure (long msgnum, char *item,
886                 struct CtdlMessage *msg) {
887         char *rfc822 = NULL;
888         char *rfc822_body = NULL;
889         size_t rfc822_len;
890         size_t rfc822_headers_len;
891         size_t rfc822_body_len;
892         char *ptr = NULL;
893         char buf[SIZ];
894         int lines = 0;
895
896         /* Handle NULL message gracefully */
897         if (msg == NULL) {
898                 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
899                         "(\"CHARSET\" \"US-ASCII\") NIL NIL "
900                         "\"7BIT\" 0 0)");
901                 return;
902         }
903
904         /* For non-RFC822 (ordinary Citadel) messages, this is short and
905          * sweet...
906          */
907         if (msg->cm_format_type != FMT_RFC822) {
908
909                 /* *sigh* We have to RFC822-format the message just to be able
910                  * to measure it.  FIXME use smi cached fields if possible
911                  */
912
913                 CC->redirect_buffer = malloc(SIZ);
914                 CC->redirect_len = 0;
915                 CC->redirect_alloc = SIZ;
916                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1);
917                 rfc822 = CC->redirect_buffer;
918                 rfc822_len = CC->redirect_len;
919                 CC->redirect_buffer = NULL;
920                 CC->redirect_len = 0;
921                 CC->redirect_alloc = 0;
922
923                 ptr = rfc822;
924                 while (ptr = memreadline(ptr, buf, sizeof buf), *ptr != 0) {
925                         ++lines;
926                         if ((IsEmptyStr(buf)) && (rfc822_body == NULL)) {
927                                 rfc822_body = ptr;
928                         }
929                 }
930
931                 rfc822_headers_len = rfc822_body - rfc822;
932                 rfc822_body_len = rfc822_len - rfc822_headers_len;
933                 free(rfc822);
934
935                 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
936                         "(\"CHARSET\" \"US-ASCII\") NIL NIL "
937                         "\"7BIT\" %d %d)", rfc822_body_len, lines);
938
939                 return;
940         }
941
942         /* For messages already stored in RFC822 format, we have to parse. */
943         cprintf("BODYSTRUCTURE ");
944         mime_parser(msg->cm_fields['M'],
945                         NULL,
946                         *imap_fetch_bodystructure_part, /* part */
947                         *imap_fetch_bodystructure_pre,  /* pre-multi */
948                         *imap_fetch_bodystructure_post, /* post-multi */
949                         NULL,
950                         1);     /* don't decode -- we want it as-is */
951 }
952
953
954 /*
955  * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
956  * individual message, once it has been selected for output.
957  */
958 void imap_do_fetch_msg(int seq, int num_items, char **itemlist) {
959         int i;
960         struct CtdlMessage *msg = NULL;
961         int body_loaded = 0;
962
963         /* Don't attempt to fetch bogus messages or UID's */
964         if (seq < 1) return;
965         if (IMAP->msgids[seq-1] < 1L) return;
966
967         buffer_output();
968         cprintf("* %d FETCH (", seq);
969
970         for (i=0; i<num_items; ++i) {
971
972                 /* Fetchable without going to the message store at all */
973                 if (!strcasecmp(itemlist[i], "UID")) {
974                         imap_fetch_uid(seq);
975                 }
976                 else if (!strcasecmp(itemlist[i], "FLAGS")) {
977                         imap_fetch_flags(seq-1);
978                 }
979
980                 /* Potentially fetchable from cache, if the client requests
981                  * stuff from the same message several times in a row.
982                  */
983                 else if (!strcasecmp(itemlist[i], "RFC822")) {
984                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
985                 }
986                 else if (!strcasecmp(itemlist[i], "RFC822.HEADER")) {
987                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
988                 }
989                 else if (!strcasecmp(itemlist[i], "RFC822.SIZE")) {
990                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
991                 }
992                 else if (!strcasecmp(itemlist[i], "RFC822.TEXT")) {
993                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
994                 }
995
996                 /* BODY fetches do their own fetching and caching too. */
997                 else if (!strncasecmp(itemlist[i], "BODY[", 5)) {
998                         imap_fetch_body(IMAP->msgids[seq-1], itemlist[i], 0);
999                 }
1000                 else if (!strncasecmp(itemlist[i], "BODY.PEEK[", 10)) {
1001                         imap_fetch_body(IMAP->msgids[seq-1], itemlist[i], 1);
1002                 }
1003
1004                 /* Otherwise, load the message into memory.
1005                  */
1006                 else if (!strcasecmp(itemlist[i], "BODYSTRUCTURE")) {
1007                         if ((msg != NULL) && (!body_loaded)) {
1008                                 CtdlFreeMessage(msg);   /* need the whole thing */
1009                                 msg = NULL;
1010                         }
1011                         if (msg == NULL) {
1012                                 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 1);
1013                                 body_loaded = 1;
1014                         }
1015                         imap_fetch_bodystructure(IMAP->msgids[seq-1],
1016                                         itemlist[i], msg);
1017                 }
1018                 else if (!strcasecmp(itemlist[i], "ENVELOPE")) {
1019                         if (msg == NULL) {
1020                                 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 0);
1021                                 body_loaded = 0;
1022                         }
1023                         imap_fetch_envelope(msg);
1024                 }
1025                 else if (!strcasecmp(itemlist[i], "INTERNALDATE")) {
1026                         if (msg == NULL) {
1027                                 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 0);
1028                                 body_loaded = 0;
1029                         }
1030                         imap_fetch_internaldate(msg);
1031                 }
1032
1033                 if (i != num_items-1) cprintf(" ");
1034         }
1035
1036         cprintf(")\r\n");
1037         unbuffer_output();
1038         if (msg != NULL) {
1039                 CtdlFreeMessage(msg);
1040         }
1041 }
1042
1043
1044
1045 /*
1046  * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1047  * validated and boiled down the request a bit.
1048  */
1049 void imap_do_fetch(int num_items, char **itemlist) {
1050         int i;
1051
1052         if (IMAP->num_msgs > 0) {
1053                 for (i = 0; i < IMAP->num_msgs; ++i) {
1054
1055                         /* Abort the fetch loop if the session breaks.
1056                          * This is important for users who keep mailboxes
1057                          * that are too big *and* are too impatient to
1058                          * let them finish loading.  :)
1059                          */
1060                         if (CC->kill_me) return;
1061
1062                         /* Get any message marked for fetch. */
1063                         if (IMAP->flags[i] & IMAP_SELECTED) {
1064                                 imap_do_fetch_msg(i+1, num_items, itemlist);
1065                         }
1066                 }
1067         }
1068 }
1069
1070
1071
1072 /*
1073  * Back end for imap_handle_macros()
1074  * Note that this function *only* looks at the beginning of the string.  It
1075  * is not a generic search-and-replace function.
1076  */
1077 void imap_macro_replace(char *str, char *find, char *replace) {
1078         char holdbuf[SIZ];
1079
1080         if (!strncasecmp(str, find, strlen(find))) {
1081                 if (str[strlen(find)]==' ') {
1082                         strcpy(holdbuf, &str[strlen(find)+1]);
1083                         strcpy(str, replace);
1084                         strcat(str, " ");
1085                         strcat(str, holdbuf);
1086                 }
1087                 if (str[strlen(find)]==0) {
1088                         strcpy(holdbuf, &str[strlen(find)+1]);
1089                         strcpy(str, replace);
1090                 }
1091         }
1092 }
1093
1094
1095
1096 /*
1097  * Handle macros embedded in FETCH data items.
1098  * (What the heck are macros doing in a wire protocol?  Are we trying to save
1099  * the computer at the other end the trouble of typing a lot of characters?)
1100  */
1101 void imap_handle_macros(char *str) {
1102         int i;
1103         int nest = 0;
1104
1105         for (i=0; str[i]; ++i) {
1106                 if (str[i]=='(') ++nest;
1107                 if (str[i]=='[') ++nest;
1108                 if (str[i]=='<') ++nest;
1109                 if (str[i]=='{') ++nest;
1110                 if (str[i]==')') --nest;
1111                 if (str[i]==']') --nest;
1112                 if (str[i]=='>') --nest;
1113                 if (str[i]=='}') --nest;
1114
1115                 if (nest <= 0) {
1116                         imap_macro_replace(&str[i],
1117                                 "ALL",
1118                                 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE"
1119                         );
1120                         imap_macro_replace(&str[i],
1121                                 "BODY",
1122                                 "BODYSTRUCTURE"
1123                         );
1124                         imap_macro_replace(&str[i],
1125                                 "FAST",
1126                                 "FLAGS INTERNALDATE RFC822.SIZE"
1127                         );
1128                         imap_macro_replace(&str[i],
1129                                 "FULL",
1130                                 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY"
1131                         );
1132                 }
1133         }
1134 }
1135
1136
1137 /*
1138  * Break out the data items requested, possibly a parenthesized list.
1139  * Returns the number of data items, or -1 if the list is invalid.
1140  * NOTE: this function alters the string it is fed, and uses it as a buffer
1141  * to hold the data for the pointers it returns.
1142  */
1143 int imap_extract_data_items(char **argv, char *items) {
1144         int num_items = 0;
1145         int nest = 0;
1146         int i;
1147         char *start;
1148         long initial_len;
1149
1150         /* Convert all whitespace to ordinary space characters. */
1151         for (i=0; items[i]; ++i) {
1152                 if (isspace(items[i])) items[i]=' ';
1153         }
1154
1155         /* Strip leading and trailing whitespace, then strip leading and
1156          * trailing parentheses if it's a list
1157          */
1158         striplt(items);
1159         if ( (items[0]=='(') && (items[strlen(items)-1]==')') ) {
1160                 items[strlen(items)-1] = 0;
1161                 strcpy(items, &items[1]);
1162                 striplt(items);
1163         }
1164
1165         /* Parse any macro data items */
1166         imap_handle_macros(items);
1167
1168         /*
1169          * Now break out the data items.  We throw in one trailing space in
1170          * order to avoid having to break out the last one manually.
1171          */
1172         strcat(items, " ");
1173         start = items;
1174         initial_len = strlen(items);
1175         for (i=0; i<initial_len; ++i) {
1176                 if (items[i]=='(') ++nest;
1177                 if (items[i]=='[') ++nest;
1178                 if (items[i]=='<') ++nest;
1179                 if (items[i]=='{') ++nest;
1180                 if (items[i]==')') --nest;
1181                 if (items[i]==']') --nest;
1182                 if (items[i]=='>') --nest;
1183                 if (items[i]=='}') --nest;
1184
1185                 if (nest <= 0) if (items[i]==' ') {
1186                         items[i] = 0;
1187                         argv[num_items++] = start;
1188                         start = &items[i+1];
1189                 }
1190         }
1191
1192         return(num_items);
1193
1194 }
1195
1196
1197 /*
1198  * One particularly hideous aspect of IMAP is that we have to allow the client
1199  * to specify arbitrary ranges and/or sets of messages to fetch.  Citadel IMAP
1200  * handles this by setting the IMAP_SELECTED flag for each message specified in
1201  * the ranges/sets, then looping through the message array, outputting messages
1202  * with the flag set.  We don't bother returning an error if an out-of-range
1203  * number is specified (we just return quietly) because any client braindead
1204  * enough to request a bogus message number isn't going to notice the
1205  * difference anyway.
1206  *
1207  * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1208  * message included in the specified range.
1209  *
1210  * Set is_uid to 1 to fetch by UID instead of sequence number.
1211  */
1212 void imap_pick_range(char *supplied_range, int is_uid) {
1213         int i;
1214         int num_sets;
1215         int s;
1216         char setstr[SIZ], lostr[SIZ], histr[SIZ];
1217         long lo, hi;
1218         char actual_range[SIZ];
1219
1220         /* 
1221          * Handle the "ALL" macro
1222          */
1223         if (!strcasecmp(supplied_range, "ALL")) {
1224                 safestrncpy(actual_range, "1:*", sizeof actual_range);
1225         }
1226         else {
1227                 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1228         }
1229
1230         /*
1231          * Clear out the IMAP_SELECTED flags for all messages.
1232          */
1233         for (i = 0; i < IMAP->num_msgs; ++i) {
1234                 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SELECTED;
1235         }
1236
1237         /*
1238          * Now set it for all specified messages.
1239          */
1240         num_sets = num_tokens(actual_range, ',');
1241         for (s=0; s<num_sets; ++s) {
1242                 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1243
1244                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1245                 if (num_tokens(setstr, ':') >= 2) {
1246                         extract_token(histr, setstr, 1, ':', sizeof histr);
1247                         if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1248                 } 
1249                 else {
1250                         safestrncpy(histr, lostr, sizeof histr);
1251                 }
1252                 lo = atol(lostr);
1253                 hi = atol(histr);
1254
1255                 /* Loop through the array, flipping bits where appropriate */
1256                 for (i = 1; i <= IMAP->num_msgs; ++i) {
1257                         if (is_uid) {   /* fetch by sequence number */
1258                                 if ( (IMAP->msgids[i-1]>=lo)
1259                                    && (IMAP->msgids[i-1]<=hi)) {
1260                                         IMAP->flags[i-1] |= IMAP_SELECTED;
1261                                 }
1262                         }
1263                         else {          /* fetch by uid */
1264                                 if ( (i>=lo) && (i<=hi)) {
1265                                         IMAP->flags[i-1] |= IMAP_SELECTED;
1266                                 }
1267                         }
1268                 }
1269         }
1270
1271 }
1272
1273
1274
1275 /*
1276  * This function is called by the main command loop.
1277  */
1278 void imap_fetch(int num_parms, char *parms[]) {
1279         char items[SIZ];
1280         char *itemlist[512];
1281         int num_items;
1282         int i;
1283
1284         if (num_parms < 4) {
1285                 cprintf("%s BAD invalid parameters\r\n", parms[0]);
1286                 return;
1287         }
1288
1289         imap_pick_range(parms[2], 0);
1290
1291         strcpy(items, "");
1292         for (i=3; i<num_parms; ++i) {
1293                 strcat(items, parms[i]);
1294                 if (i < (num_parms-1)) strcat(items, " ");
1295         }
1296
1297         num_items = imap_extract_data_items(itemlist, items);
1298         if (num_items < 1) {
1299                 cprintf("%s BAD invalid data item list\r\n", parms[0]);
1300                 return;
1301         }
1302
1303         imap_do_fetch(num_items, itemlist);
1304         cprintf("%s OK FETCH completed\r\n", parms[0]);
1305 }
1306
1307 /*
1308  * This function is called by the main command loop.
1309  */
1310 void imap_uidfetch(int num_parms, char *parms[]) {
1311         char items[SIZ];
1312         char *itemlist[512];
1313         int num_items;
1314         int i;
1315         int have_uid_item = 0;
1316
1317         if (num_parms < 5) {
1318                 cprintf("%s BAD invalid parameters\r\n", parms[0]);
1319                 return;
1320         }
1321
1322         imap_pick_range(parms[3], 1);
1323
1324         strcpy(items, "");
1325         for (i=4; i<num_parms; ++i) {
1326                 strcat(items, parms[i]);
1327                 if (i < (num_parms-1)) strcat(items, " ");
1328         }
1329
1330         num_items = imap_extract_data_items(itemlist, items);
1331         if (num_items < 1) {
1332                 cprintf("%s BAD invalid data item list\r\n", parms[0]);
1333                 return;
1334         }
1335
1336         /* If the "UID" item was not included, we include it implicitly
1337          * (at the beginning) because this is a UID FETCH command
1338          */
1339         for (i=0; i<num_items; ++i) {
1340                 if (!strcasecmp(itemlist[i], "UID")) ++have_uid_item;
1341         }
1342         if (have_uid_item == 0) {
1343                 memmove(&itemlist[1], &itemlist[0], (sizeof(itemlist[0]) * num_items));
1344                 ++num_items;
1345                 itemlist[0] = "UID";
1346         }
1347
1348         imap_do_fetch(num_items, itemlist);
1349         cprintf("%s OK UID FETCH completed\r\n", parms[0]);
1350 }
1351
1352