* Reversed previous change. It wasn't needed after all.
[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         if (name != NULL) if (!IsEmptyStr(name)) {
797                 cprintf("\"NAME\" ");
798                 imap_strout(name);
799                 cprintf(" ");
800         }
801
802         cprintf("\"CHARSET\" ");
803         if (cbcharset == NULL) {
804                 imap_strout("US-ASCII");
805         }
806         else if (cbcharset[0] == 0) {
807                 imap_strout("US-ASCII");
808         }
809         else {
810                 imap_strout(cbcharset);
811         }
812         cprintf(") ");                                                  /* end body parameter list */
813
814         cprintf("NIL ");                                                /* Body ID */
815         cprintf("NIL ");                                                /* Body description */
816
817         if (encoding != NULL) if (encoding[0] != 0)  have_encoding = 1;
818         if (have_encoding) {
819                 imap_strout(encoding);
820         }
821         else {
822                 imap_strout("7BIT");
823         }
824         cprintf(" ");
825
826         /* The next field is the size of the part in bytes. */
827         cprintf("%ld ", (long)length);  /* bytes */
828
829         /* The next field is the number of lines in the part, if and only
830          * if the part is TEXT.  More gratuitous complexity.
831          */
832         if (!strcasecmp(cbmaintype, "TEXT")) {
833                 if (length) for (i=0; i<length; ++i) {
834                         if (((char *)content)[i] == '\n') ++lines;
835                 }
836                 cprintf("%d ", lines);
837         }
838
839         /* More gratuitous complexity */
840         if ((!strcasecmp(cbmaintype, "MESSAGE"))
841            && (!strcasecmp(cbsubtype, "RFC822"))) {
842                 /* FIXME
843                      A body type of type MESSAGE and subtype RFC822
844                      contains, immediately after the basic fields, the
845                      envelope structure, body structure, and size in
846                      text lines of the encapsulated message.
847                 */
848         }
849
850         /* MD5 value of body part; we can get away with NIL'ing this */
851         cprintf("NIL ");
852
853         /* Disposition */
854         if (disp == NULL) {
855                 cprintf("NIL");
856         }
857         else if (IsEmptyStr(disp)) {
858                 cprintf("NIL");
859         }
860         else {
861                 cprintf("(");
862                 imap_strout(disp);
863                 if (filename != NULL) if (!IsEmptyStr(filename)) {
864                         cprintf(" (\"FILENAME\" ");
865                         imap_strout(filename);
866                         cprintf(")");
867                 }
868                 cprintf(")");
869         }
870
871         /* Body language (not defined yet) */
872         cprintf(" NIL)");
873 }
874
875
876
877 /*
878  * Spew the BODYSTRUCTURE data for a message.
879  *
880  */
881 void imap_fetch_bodystructure (long msgnum, char *item,
882                 struct CtdlMessage *msg) {
883         char *rfc822 = NULL;
884         char *rfc822_body = NULL;
885         size_t rfc822_len;
886         size_t rfc822_headers_len;
887         size_t rfc822_body_len;
888         char *ptr = NULL;
889         char buf[SIZ];
890         int lines = 0;
891
892         /* Handle NULL message gracefully */
893         if (msg == NULL) {
894                 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
895                         "(\"CHARSET\" \"US-ASCII\") NIL NIL "
896                         "\"7BIT\" 0 0)");
897                 return;
898         }
899
900         /* For non-RFC822 (ordinary Citadel) messages, this is short and
901          * sweet...
902          */
903         if (msg->cm_format_type != FMT_RFC822) {
904
905                 /* *sigh* We have to RFC822-format the message just to be able
906                  * to measure it.  FIXME use smi cached fields if possible
907                  */
908
909                 CC->redirect_buffer = malloc(SIZ);
910                 CC->redirect_len = 0;
911                 CC->redirect_alloc = SIZ;
912                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1);
913                 rfc822 = CC->redirect_buffer;
914                 rfc822_len = CC->redirect_len;
915                 CC->redirect_buffer = NULL;
916                 CC->redirect_len = 0;
917                 CC->redirect_alloc = 0;
918
919                 ptr = rfc822;
920                 while (ptr = memreadline(ptr, buf, sizeof buf), *ptr != 0) {
921                         ++lines;
922                         if ((IsEmptyStr(buf)) && (rfc822_body == NULL)) {
923                                 rfc822_body = ptr;
924                         }
925                 }
926
927                 rfc822_headers_len = rfc822_body - rfc822;
928                 rfc822_body_len = rfc822_len - rfc822_headers_len;
929                 free(rfc822);
930
931                 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
932                         "(\"CHARSET\" \"US-ASCII\") NIL NIL "
933                         "\"7BIT\" %d %d)", rfc822_body_len, lines);
934
935                 return;
936         }
937
938         /* For messages already stored in RFC822 format, we have to parse. */
939         cprintf("BODYSTRUCTURE ");
940         mime_parser(msg->cm_fields['M'],
941                         NULL,
942                         *imap_fetch_bodystructure_part, /* part */
943                         *imap_fetch_bodystructure_pre,  /* pre-multi */
944                         *imap_fetch_bodystructure_post, /* post-multi */
945                         NULL,
946                         1);     /* don't decode -- we want it as-is */
947 }
948
949
950 /*
951  * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
952  * individual message, once it has been selected for output.
953  */
954 void imap_do_fetch_msg(int seq, int num_items, char **itemlist) {
955         int i;
956         struct CtdlMessage *msg = NULL;
957         int body_loaded = 0;
958
959         /* Don't attempt to fetch bogus messages or UID's */
960         if (seq < 1) return;
961         if (IMAP->msgids[seq-1] < 1L) return;
962
963         buffer_output();
964         cprintf("* %d FETCH (", seq);
965
966         for (i=0; i<num_items; ++i) {
967
968                 /* Fetchable without going to the message store at all */
969                 if (!strcasecmp(itemlist[i], "UID")) {
970                         imap_fetch_uid(seq);
971                 }
972                 else if (!strcasecmp(itemlist[i], "FLAGS")) {
973                         imap_fetch_flags(seq-1);
974                 }
975
976                 /* Potentially fetchable from cache, if the client requests
977                  * stuff from the same message several times in a row.
978                  */
979                 else if (!strcasecmp(itemlist[i], "RFC822")) {
980                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
981                 }
982                 else if (!strcasecmp(itemlist[i], "RFC822.HEADER")) {
983                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
984                 }
985                 else if (!strcasecmp(itemlist[i], "RFC822.SIZE")) {
986                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
987                 }
988                 else if (!strcasecmp(itemlist[i], "RFC822.TEXT")) {
989                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
990                 }
991
992                 /* BODY fetches do their own fetching and caching too. */
993                 else if (!strncasecmp(itemlist[i], "BODY[", 5)) {
994                         imap_fetch_body(IMAP->msgids[seq-1], itemlist[i], 0);
995                 }
996                 else if (!strncasecmp(itemlist[i], "BODY.PEEK[", 10)) {
997                         imap_fetch_body(IMAP->msgids[seq-1], itemlist[i], 1);
998                 }
999
1000                 /* Otherwise, load the message into memory.
1001                  */
1002                 else if (!strcasecmp(itemlist[i], "BODYSTRUCTURE")) {
1003                         if ((msg != NULL) && (!body_loaded)) {
1004                                 CtdlFreeMessage(msg);   /* need the whole thing */
1005                                 msg = NULL;
1006                         }
1007                         if (msg == NULL) {
1008                                 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 1);
1009                                 body_loaded = 1;
1010                         }
1011                         imap_fetch_bodystructure(IMAP->msgids[seq-1],
1012                                         itemlist[i], msg);
1013                 }
1014                 else if (!strcasecmp(itemlist[i], "ENVELOPE")) {
1015                         if (msg == NULL) {
1016                                 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 0);
1017                                 body_loaded = 0;
1018                         }
1019                         imap_fetch_envelope(msg);
1020                 }
1021                 else if (!strcasecmp(itemlist[i], "INTERNALDATE")) {
1022                         if (msg == NULL) {
1023                                 msg = CtdlFetchMessage(IMAP->msgids[seq-1], 0);
1024                                 body_loaded = 0;
1025                         }
1026                         imap_fetch_internaldate(msg);
1027                 }
1028
1029                 if (i != num_items-1) cprintf(" ");
1030         }
1031
1032         cprintf(")\r\n");
1033         unbuffer_output();
1034         if (msg != NULL) {
1035                 CtdlFreeMessage(msg);
1036         }
1037 }
1038
1039
1040
1041 /*
1042  * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1043  * validated and boiled down the request a bit.
1044  */
1045 void imap_do_fetch(int num_items, char **itemlist) {
1046         int i;
1047
1048         if (IMAP->num_msgs > 0) {
1049                 for (i = 0; i < IMAP->num_msgs; ++i) {
1050
1051                         /* Abort the fetch loop if the session breaks.
1052                          * This is important for users who keep mailboxes
1053                          * that are too big *and* are too impatient to
1054                          * let them finish loading.  :)
1055                          */
1056                         if (CC->kill_me) return;
1057
1058                         /* Get any message marked for fetch. */
1059                         if (IMAP->flags[i] & IMAP_SELECTED) {
1060                                 imap_do_fetch_msg(i+1, num_items, itemlist);
1061                         }
1062                 }
1063         }
1064 }
1065
1066
1067
1068 /*
1069  * Back end for imap_handle_macros()
1070  * Note that this function *only* looks at the beginning of the string.  It
1071  * is not a generic search-and-replace function.
1072  */
1073 void imap_macro_replace(char *str, char *find, char *replace) {
1074         char holdbuf[SIZ];
1075
1076         if (!strncasecmp(str, find, strlen(find))) {
1077                 if (str[strlen(find)]==' ') {
1078                         strcpy(holdbuf, &str[strlen(find)+1]);
1079                         strcpy(str, replace);
1080                         strcat(str, " ");
1081                         strcat(str, holdbuf);
1082                 }
1083                 if (str[strlen(find)]==0) {
1084                         strcpy(holdbuf, &str[strlen(find)+1]);
1085                         strcpy(str, replace);
1086                 }
1087         }
1088 }
1089
1090
1091
1092 /*
1093  * Handle macros embedded in FETCH data items.
1094  * (What the heck are macros doing in a wire protocol?  Are we trying to save
1095  * the computer at the other end the trouble of typing a lot of characters?)
1096  */
1097 void imap_handle_macros(char *str) {
1098         int i;
1099         int nest = 0;
1100
1101         for (i=0; str[i]; ++i) {
1102                 if (str[i]=='(') ++nest;
1103                 if (str[i]=='[') ++nest;
1104                 if (str[i]=='<') ++nest;
1105                 if (str[i]=='{') ++nest;
1106                 if (str[i]==')') --nest;
1107                 if (str[i]==']') --nest;
1108                 if (str[i]=='>') --nest;
1109                 if (str[i]=='}') --nest;
1110
1111                 if (nest <= 0) {
1112                         imap_macro_replace(&str[i],
1113                                 "ALL",
1114                                 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE"
1115                         );
1116                         imap_macro_replace(&str[i],
1117                                 "BODY",
1118                                 "BODYSTRUCTURE"
1119                         );
1120                         imap_macro_replace(&str[i],
1121                                 "FAST",
1122                                 "FLAGS INTERNALDATE RFC822.SIZE"
1123                         );
1124                         imap_macro_replace(&str[i],
1125                                 "FULL",
1126                                 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY"
1127                         );
1128                 }
1129         }
1130 }
1131
1132
1133 /*
1134  * Break out the data items requested, possibly a parenthesized list.
1135  * Returns the number of data items, or -1 if the list is invalid.
1136  * NOTE: this function alters the string it is fed, and uses it as a buffer
1137  * to hold the data for the pointers it returns.
1138  */
1139 int imap_extract_data_items(char **argv, char *items) {
1140         int num_items = 0;
1141         int nest = 0;
1142         int i;
1143         char *start;
1144         long initial_len;
1145
1146         /* Convert all whitespace to ordinary space characters. */
1147         for (i=0; items[i]; ++i) {
1148                 if (isspace(items[i])) items[i]=' ';
1149         }
1150
1151         /* Strip leading and trailing whitespace, then strip leading and
1152          * trailing parentheses if it's a list
1153          */
1154         striplt(items);
1155         if ( (items[0]=='(') && (items[strlen(items)-1]==')') ) {
1156                 items[strlen(items)-1] = 0;
1157                 strcpy(items, &items[1]);
1158                 striplt(items);
1159         }
1160
1161         /* Parse any macro data items */
1162         imap_handle_macros(items);
1163
1164         /*
1165          * Now break out the data items.  We throw in one trailing space in
1166          * order to avoid having to break out the last one manually.
1167          */
1168         strcat(items, " ");
1169         start = items;
1170         initial_len = strlen(items);
1171         for (i=0; i<initial_len; ++i) {
1172                 if (items[i]=='(') ++nest;
1173                 if (items[i]=='[') ++nest;
1174                 if (items[i]=='<') ++nest;
1175                 if (items[i]=='{') ++nest;
1176                 if (items[i]==')') --nest;
1177                 if (items[i]==']') --nest;
1178                 if (items[i]=='>') --nest;
1179                 if (items[i]=='}') --nest;
1180
1181                 if (nest <= 0) if (items[i]==' ') {
1182                         items[i] = 0;
1183                         argv[num_items++] = start;
1184                         start = &items[i+1];
1185                 }
1186         }
1187
1188         return(num_items);
1189
1190 }
1191
1192
1193 /*
1194  * One particularly hideous aspect of IMAP is that we have to allow the client
1195  * to specify arbitrary ranges and/or sets of messages to fetch.  Citadel IMAP
1196  * handles this by setting the IMAP_SELECTED flag for each message specified in
1197  * the ranges/sets, then looping through the message array, outputting messages
1198  * with the flag set.  We don't bother returning an error if an out-of-range
1199  * number is specified (we just return quietly) because any client braindead
1200  * enough to request a bogus message number isn't going to notice the
1201  * difference anyway.
1202  *
1203  * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1204  * message included in the specified range.
1205  *
1206  * Set is_uid to 1 to fetch by UID instead of sequence number.
1207  */
1208 void imap_pick_range(char *supplied_range, int is_uid) {
1209         int i;
1210         int num_sets;
1211         int s;
1212         char setstr[SIZ], lostr[SIZ], histr[SIZ];
1213         long lo, hi;
1214         char actual_range[SIZ];
1215
1216         /* 
1217          * Handle the "ALL" macro
1218          */
1219         if (!strcasecmp(supplied_range, "ALL")) {
1220                 safestrncpy(actual_range, "1:*", sizeof actual_range);
1221         }
1222         else {
1223                 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1224         }
1225
1226         /*
1227          * Clear out the IMAP_SELECTED flags for all messages.
1228          */
1229         for (i = 0; i < IMAP->num_msgs; ++i) {
1230                 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SELECTED;
1231         }
1232
1233         /*
1234          * Now set it for all specified messages.
1235          */
1236         num_sets = num_tokens(actual_range, ',');
1237         for (s=0; s<num_sets; ++s) {
1238                 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1239
1240                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1241                 if (num_tokens(setstr, ':') >= 2) {
1242                         extract_token(histr, setstr, 1, ':', sizeof histr);
1243                         if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1244                 } 
1245                 else {
1246                         safestrncpy(histr, lostr, sizeof histr);
1247                 }
1248                 lo = atol(lostr);
1249                 hi = atol(histr);
1250
1251                 /* Loop through the array, flipping bits where appropriate */
1252                 for (i = 1; i <= IMAP->num_msgs; ++i) {
1253                         if (is_uid) {   /* fetch by sequence number */
1254                                 if ( (IMAP->msgids[i-1]>=lo)
1255                                    && (IMAP->msgids[i-1]<=hi)) {
1256                                         IMAP->flags[i-1] |= IMAP_SELECTED;
1257                                 }
1258                         }
1259                         else {          /* fetch by uid */
1260                                 if ( (i>=lo) && (i<=hi)) {
1261                                         IMAP->flags[i-1] |= IMAP_SELECTED;
1262                                 }
1263                         }
1264                 }
1265         }
1266
1267 }
1268
1269
1270
1271 /*
1272  * This function is called by the main command loop.
1273  */
1274 void imap_fetch(int num_parms, char *parms[]) {
1275         char items[SIZ];
1276         char *itemlist[512];
1277         int num_items;
1278         int i;
1279
1280         if (num_parms < 4) {
1281                 cprintf("%s BAD invalid parameters\r\n", parms[0]);
1282                 return;
1283         }
1284
1285         imap_pick_range(parms[2], 0);
1286
1287         strcpy(items, "");
1288         for (i=3; i<num_parms; ++i) {
1289                 strcat(items, parms[i]);
1290                 if (i < (num_parms-1)) strcat(items, " ");
1291         }
1292
1293         num_items = imap_extract_data_items(itemlist, items);
1294         if (num_items < 1) {
1295                 cprintf("%s BAD invalid data item list\r\n", parms[0]);
1296                 return;
1297         }
1298
1299         imap_do_fetch(num_items, itemlist);
1300         cprintf("%s OK FETCH completed\r\n", parms[0]);
1301 }
1302
1303 /*
1304  * This function is called by the main command loop.
1305  */
1306 void imap_uidfetch(int num_parms, char *parms[]) {
1307         char items[SIZ];
1308         char *itemlist[512];
1309         int num_items;
1310         int i;
1311         int have_uid_item = 0;
1312
1313         if (num_parms < 5) {
1314                 cprintf("%s BAD invalid parameters\r\n", parms[0]);
1315                 return;
1316         }
1317
1318         imap_pick_range(parms[3], 1);
1319
1320         strcpy(items, "");
1321         for (i=4; i<num_parms; ++i) {
1322                 strcat(items, parms[i]);
1323                 if (i < (num_parms-1)) strcat(items, " ");
1324         }
1325
1326         num_items = imap_extract_data_items(itemlist, items);
1327         if (num_items < 1) {
1328                 cprintf("%s BAD invalid data item list\r\n", parms[0]);
1329                 return;
1330         }
1331
1332         /* If the "UID" item was not included, we include it implicitly
1333          * (at the beginning) because this is a UID FETCH command
1334          */
1335         for (i=0; i<num_items; ++i) {
1336                 if (!strcasecmp(itemlist[i], "UID")) ++have_uid_item;
1337         }
1338         if (have_uid_item == 0) {
1339                 memmove(&itemlist[1], &itemlist[0], (sizeof(itemlist[0]) * num_items));
1340                 ++num_items;
1341                 itemlist[0] = "UID";
1342         }
1343
1344         imap_do_fetch(num_items, itemlist);
1345         cprintf("%s OK UID FETCH completed\r\n", parms[0]);
1346 }
1347
1348