]> code.citadel.org Git - citadel.git/blob - citadel/imap_fetch.c
* imap_fetch.c: added a skeleton "ENVELOPE" fetch. Currently sends NIL's.
[citadel.git] / citadel / imap_fetch.c
1 /*
2  * $Id$
3  *
4  * Implements the FETCH command in IMAP.
5  * This command is way too convoluted.  Marc Crispin is a fscking idiot.
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 #include <sys/time.h>
20 #include <sys/wait.h>
21 #include <ctype.h>
22 #include <string.h>
23 #include <limits.h>
24 #include "citadel.h"
25 #include "server.h"
26 #include <time.h>
27 #include "sysdep_decls.h"
28 #include "citserver.h"
29 #include "support.h"
30 #include "config.h"
31 #include "dynloader.h"
32 #include "room_ops.h"
33 #include "user_ops.h"
34 #include "policy.h"
35 #include "database.h"
36 #include "msgbase.h"
37 #include "tools.h"
38 #include "internet_addressing.h"
39 #include "mime_parser.h"
40 #include "serv_imap.h"
41 #include "imap_tools.h"
42 #include "imap_fetch.h"
43 #include "genstamp.h"
44
45
46
47 struct imap_fetch_part {
48         char desired_section[256];
49         FILE *output_fp;
50 };
51
52 /*
53  * Individual field functions for imap_do_fetch_msg() ...
54  */
55
56
57
58 void imap_fetch_uid(int seq) {
59         cprintf("UID %ld", IMAP->msgids[seq-1]);
60 }
61
62 void imap_fetch_flags(struct CtdlMessage *msg) {
63         cprintf("FLAGS ()");    /* FIXME do something here */
64 }
65
66 void imap_fetch_internaldate(struct CtdlMessage *msg) {
67         char buf[256];
68         time_t msgdate;
69
70         if (msg->cm_fields['T'] != NULL) {
71                 msgdate = atol(msg->cm_fields['T']);
72         }
73         else {
74                 msgdate = time(NULL);
75         }
76
77         datestring(buf, msgdate, DATESTRING_IMAP);
78         cprintf("INTERNALDATE \"%s\"", buf);
79 }
80
81
82 /*
83  * Fetch RFC822-formatted messages.
84  *
85  * 'whichfmt' should be set to one of:
86  *      "RFC822"        entire message
87  *      "RFC822.HEADER" headers only (with trailing blank line)
88  *      "RFC822.SIZE"   size of translated message
89  *      "RFC822.TEXT"   body only (without leading blank line)
90  */
91 void imap_fetch_rfc822(int msgnum, char *whichfmt) {
92         FILE *tmp;
93         char buf[1024];
94         char *ptr;
95         long headers_size, text_size, total_size;
96         long bytes_remaining = 0;
97         long blocksize;
98
99         tmp = tmpfile();
100         if (tmp == NULL) {
101                 lprintf(1, "Cannot open temp file: %s\n", strerror(errno));
102                 return;
103         }
104
105         /*
106          * Load the message into a temp file for translation and measurement
107          */ 
108         CtdlRedirectOutput(tmp, -1);
109         CtdlOutputMsg(msgnum, MT_RFC822, 0, 0, 1);
110         CtdlRedirectOutput(NULL, -1);
111
112         /*
113          * Now figure out where the headers/text break is.  IMAP considers the
114          * intervening blank line to be part of the headers, not the text.
115          */
116         rewind(tmp);
117         headers_size = 0L;
118         do {
119                 ptr = fgets(buf, sizeof buf, tmp);
120                 if (ptr != NULL) {
121                         striplt(buf);
122                         if (strlen(buf) == 0) headers_size = ftell(tmp);
123                 }
124         } while ( (headers_size == 0L) && (ptr != NULL) );
125         fseek(tmp, 0L, SEEK_END);
126         total_size = ftell(tmp);
127         text_size = total_size - headers_size;
128
129         if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
130                 cprintf("RFC822.SIZE %ld", total_size);
131                 fclose(tmp);
132                 return;
133         }
134
135         else if (!strcasecmp(whichfmt, "RFC822")) {
136                 bytes_remaining = total_size;
137                 rewind(tmp);
138         }
139
140         else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
141                 bytes_remaining = headers_size;
142                 rewind(tmp);
143         }
144
145         else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
146                 bytes_remaining = text_size;
147                 fseek(tmp, headers_size, SEEK_SET);
148         }
149
150         cprintf("%s {%ld}\r\n", whichfmt, bytes_remaining);
151         blocksize = sizeof(buf);
152         while (bytes_remaining > 0L) {
153                 if (blocksize > bytes_remaining) blocksize = bytes_remaining;
154                 fread(buf, blocksize, 1, tmp);
155                 client_write(buf, blocksize);
156                 bytes_remaining = bytes_remaining - blocksize;
157         }
158
159         fclose(tmp);
160 }
161
162
163
164 /*
165  * Load a specific part of a message into the temp file to be output to a
166  * client.  FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
167  * but we still can't handle "2.HEADER" (which might not be a problem, because
168  * we currently don't have the ability to break out nested RFC822's anyway).
169  *
170  * Note: mime_parser() was called with dont_decode set to 1, so we have the
171  * luxury of simply spewing without having to re-encode.
172  */
173 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
174                     void *content, char *cbtype, size_t length, char *encoding,
175                     void *cbuserdata)
176 {
177         struct imap_fetch_part *imfp;
178         char mbuf2[1024];
179
180         imfp = (struct imap_fetch_part *)cbuserdata;
181
182         if (!strcasecmp(partnum, imfp->desired_section)) {
183                 fwrite(content, length, 1, imfp->output_fp);
184         }
185
186         sprintf(mbuf2, "%s.MIME", partnum);
187
188         if (!strcasecmp(imfp->desired_section, mbuf2)) {
189                 fprintf(imfp->output_fp, "Content-type: %s", cbtype);
190                 if (strlen(name) > 0)
191                         fprintf(imfp->output_fp, "; name=\"%s\"", name);
192                 fprintf(imfp->output_fp, "\r\n");
193                 if (strlen(encoding) > 0)
194                         fprintf(imfp->output_fp,
195                                 "Content-Transfer-Encoding: %s\r\n", encoding);
196                 if (strlen(encoding) > 0) {
197                         fprintf(imfp->output_fp, "Content-Disposition: %s",
198                                         disp);
199                         if (strlen(filename) > 0) {
200                                 fprintf(imfp->output_fp, "; filename=\"%s\"",
201                                         filename);
202                         }
203                         fprintf(imfp->output_fp, "\r\n");
204                 }
205                 fprintf(imfp->output_fp, "Content-Length: %d\r\n", length);
206                 fprintf(imfp->output_fp, "\r\n");
207         }
208                         
209
210 }
211
212
213 /*
214  * Implements the ENVELOPE fetch item
215  * 
216  * FIXME ... we have to actually do something useful here.
217  */
218 void imap_fetch_envelope(long msgnum, struct CtdlMessage *msg) {
219         cprintf("ENVELOPE (");
220         cprintf("NIL ");        /* date */
221         cprintf("NIL ");        /* subject */
222         cprintf("NIL ");        /* from */
223         cprintf("NIL ");        /* sender */
224         cprintf("NIL ");        /* reply-to */
225         cprintf("NIL ");        /* to */
226         cprintf("NIL ");        /* cc */
227         cprintf("NIL ");        /* bcc */
228         cprintf("NIL ");        /* in-reply-to */
229         cprintf("NIL");         /* message-id */
230         cprintf(")\r\n");
231 }
232
233
234
235 /*
236  * Implements the BODY and BODY.PEEK fetch items
237  */
238 void imap_fetch_body(long msgnum, char *item, int is_peek,
239                 struct CtdlMessage *msg) {
240         char section[1024];
241         char partial[1024];
242         int is_partial = 0;
243         char buf[1024];
244         int i;
245         FILE *tmp;
246         long bytes_remaining = 0;
247         long blocksize;
248         long pstart, pbytes;
249         struct imap_fetch_part imfp;
250
251         /* extract section */
252         strcpy(section, item);
253         for (i=0; i<strlen(section); ++i) {
254                 if (section[i]=='[') strcpy(section, &section[i+1]);
255         }
256         for (i=0; i<strlen(section); ++i) {
257                 if (section[i]==']') section[i] = 0;
258         }
259         lprintf(9, "Section is %s\n", section);
260
261         /* extract partial */
262         strcpy(partial, item);
263         for (i=0; i<strlen(partial); ++i) {
264                 if (partial[i]=='<') {
265                         strcpy(partial, &partial[i+1]);
266                         is_partial = 1;
267                 }
268         }
269         for (i=0; i<strlen(partial); ++i) {
270                 if (partial[i]=='>') partial[i] = 0;
271         }
272         lprintf(9, "Partial is %s\n", partial);
273
274         tmp = tmpfile();
275         if (tmp == NULL) {
276                 lprintf(1, "Cannot open temp file: %s\n", strerror(errno));
277                 return;
278         }
279
280         /* Now figure out what the client wants, and get it */
281
282         if (!strcmp(section, "")) {             /* the whole thing */
283                 CtdlRedirectOutput(tmp, -1);
284                 CtdlOutputMsg(msgnum, MT_RFC822, 0, 0, 1);
285                 CtdlRedirectOutput(NULL, -1);
286         }
287
288         /*
289          * Be obnoxious and send the entire header, even if the client only
290          * asks for certain fields.  FIXME this shortcut later.
291          */
292         else if (!strncasecmp(section, "HEADER", 6)) {
293                 CtdlRedirectOutput(tmp, -1);
294                 CtdlOutputMsg(msgnum, MT_RFC822, 1, 0, 1);
295                 CtdlRedirectOutput(NULL, -1);
296                 fprintf(tmp, "\r\n");   /* add the trailing newline */
297         }
298
299         /*
300          * Anything else must be a part specifier.
301          * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
302          */
303         else {
304                 safestrncpy(imfp.desired_section, section,
305                                 sizeof(imfp.desired_section));
306                 imfp.output_fp = tmp;
307
308                 mime_parser(msg->cm_fields['M'], NULL,
309                                 *imap_load_part,
310                                 (void *)&imfp,
311                                 1);
312         }
313
314
315         fseek(tmp, 0L, SEEK_END);
316         bytes_remaining = ftell(tmp);
317
318         if (is_partial == 0) {
319                 rewind(tmp);
320                 cprintf("BODY[%s] {%ld}\r\n", section, bytes_remaining);
321         }
322         else {
323                 sscanf(partial, "%ld.%ld", &pstart, &pbytes);
324                 if ((bytes_remaining - pstart) < pbytes) {
325                         pbytes = bytes_remaining - pstart;
326                 }
327                 fseek(tmp, pstart, SEEK_SET);
328                 bytes_remaining = pbytes;
329                 cprintf("BODY[%s] {%ld}<%ld>\r\n",
330                         section, bytes_remaining, pstart);
331         }
332
333         blocksize = sizeof(buf);
334         while (bytes_remaining > 0L) {
335                 if (blocksize > bytes_remaining) blocksize = bytes_remaining;
336                 fread(buf, blocksize, 1, tmp);
337                 client_write(buf, blocksize);
338                 bytes_remaining = bytes_remaining - blocksize;
339         }
340
341         fclose(tmp);
342
343         if (is_peek) {
344                 /* FIXME set the last read pointer or something */
345         }
346 }
347
348
349
350 /*
351  * imap_do_fetch() calls imap_do_fetch_msg() to output the deta of an
352  * individual message, once it has been successfully loaded from disk.
353  */
354 void imap_do_fetch_msg(int seq, struct CtdlMessage *msg,
355                         int num_items, char **itemlist) {
356         int i;
357
358         cprintf("* %d FETCH (", seq);
359
360         for (i=0; i<num_items; ++i) {
361
362                 if (!strncasecmp(itemlist[i], "BODY[", 5)) {
363                         imap_fetch_body(IMAP->msgids[seq-1], itemlist[i],
364                                         0, msg);
365                 }
366                 else if (!strncasecmp(itemlist[i], "BODY.PEEK[", 10)) {
367                         imap_fetch_body(IMAP->msgids[seq-1], itemlist[i],
368                                         1, msg);
369                 }
370                 else if (!strcasecmp(itemlist[i], "BODYSTRUCTURE")) {
371                         /* FIXME do something here */
372                 }
373                 else if (!strcasecmp(itemlist[i], "ENVELOPE")) {
374                         imap_fetch_envelope(IMAP->msgids[seq-1], msg);
375                 }
376                 else if (!strcasecmp(itemlist[i], "FLAGS")) {
377                         imap_fetch_flags(msg);
378                 }
379                 else if (!strcasecmp(itemlist[i], "INTERNALDATE")) {
380                         imap_fetch_internaldate(msg);
381                 }
382                 else if (!strcasecmp(itemlist[i], "RFC822")) {
383                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
384                 }
385                 else if (!strcasecmp(itemlist[i], "RFC822.HEADER")) {
386                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
387                 }
388                 else if (!strcasecmp(itemlist[i], "RFC822.SIZE")) {
389                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
390                 }
391                 else if (!strcasecmp(itemlist[i], "RFC822.TEXT")) {
392                         imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i]);
393                 }
394                 else if (!strcasecmp(itemlist[i], "UID")) {
395                         imap_fetch_uid(seq);
396                 }
397
398                 if (i != num_items-1) cprintf(" ");
399         }
400
401         cprintf(")\r\n");
402 }
403
404
405
406 /*
407  * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
408  * validated and boiled down the request a bit.
409  */
410 void imap_do_fetch(int num_items, char **itemlist) {
411         int i;
412         struct CtdlMessage *msg;
413
414         if (IMAP->num_msgs > 0)
415          for (i = 0; i < IMAP->num_msgs; ++i)
416           if (IMAP->flags[i] && IMAP_FETCHED) {
417                 msg = CtdlFetchMessage(IMAP->msgids[i]);
418                 if (msg != NULL) {
419                         imap_do_fetch_msg(i+1, msg, num_items, itemlist);
420                         CtdlFreeMessage(msg);
421                 }
422                 else {
423                         cprintf("* %d FETCH <internal error>\r\n", i+1);
424                 }
425         }
426 }
427
428
429
430 /*
431  * Back end for imap_handle_macros()
432  * Note that this function *only* looks at the beginning of the string.  It
433  * is not a generic search-and-replace function.
434  */
435 void imap_macro_replace(char *str, char *find, char *replace) {
436         char holdbuf[1024];
437
438         if (!strncasecmp(str, find, strlen(find))) {
439                 if (str[strlen(find)]==' ') {
440                         strcpy(holdbuf, &str[strlen(find)+1]);
441                         strcpy(str, replace);
442                         strcat(str, " ");
443                         strcat(str, holdbuf);
444                 }
445                 if (str[strlen(find)]==0) {
446                         strcpy(holdbuf, &str[strlen(find)+1]);
447                         strcpy(str, replace);
448                 }
449         }
450 }
451
452
453
454 /*
455  * Handle macros embedded in FETCH data items.
456  * (What the heck are macros doing in a wire protocol?  Are we trying to save
457  * the computer at the other end the trouble of typing a lot of characters?)
458  */
459 void imap_handle_macros(char *str) {
460         int i;
461         int nest = 0;
462
463         for (i=0; i<strlen(str); ++i) {
464                 if (str[i]=='(') ++nest;
465                 if (str[i]=='[') ++nest;
466                 if (str[i]=='<') ++nest;
467                 if (str[i]=='{') ++nest;
468                 if (str[i]==')') --nest;
469                 if (str[i]==']') --nest;
470                 if (str[i]=='>') --nest;
471                 if (str[i]=='}') --nest;
472
473                 if (nest <= 0) {
474                         imap_macro_replace(&str[i],
475                                 "ALL",
476                                 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE"
477                         );
478                         imap_macro_replace(&str[i],
479                                 "BODY",
480                                 "BODYSTRUCTURE"
481                         );
482                         imap_macro_replace(&str[i],
483                                 "FAST",
484                                 "FLAGS INTERNALDATE RFC822.SIZE"
485                         );
486                         imap_macro_replace(&str[i],
487                                 "FULL",
488                                 "FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY"
489                         );
490                 }
491         }
492 }
493
494
495 /*
496  * Break out the data items requested, possibly a parenthesized list.
497  * Returns the number of data items, or -1 if the list is invalid.
498  * NOTE: this function alters the string it is fed, and uses it as a buffer
499  * to hold the data for the pointers it returns.
500  */
501 int imap_extract_data_items(char **argv, char *items) {
502         int num_items = 0;
503         int nest = 0;
504         int i, initial_len;
505         char *start;
506
507         /* Convert all whitespace to ordinary space characters. */
508         for (i=0; i<strlen(items); ++i) {
509                 if (isspace(items[i])) items[i]=' ';
510         }
511
512         /* Strip leading and trailing whitespace, then strip leading and
513          * trailing parentheses if it's a list
514          */
515         striplt(items);
516         if ( (items[0]=='(') && (items[strlen(items)-1]==')') ) {
517                 items[strlen(items)-1] = 0;
518                 strcpy(items, &items[1]);
519                 striplt(items);
520         }
521
522         /* Parse any macro data items */
523         imap_handle_macros(items);
524
525         /*
526          * Now break out the data items.  We throw in one trailing space in
527          * order to avoid having to break out the last one manually.
528          */
529         strcat(items, " ");
530         start = items;
531         initial_len = strlen(items);
532         for (i=0; i<initial_len; ++i) {
533                 if (items[i]=='(') ++nest;
534                 if (items[i]=='[') ++nest;
535                 if (items[i]=='<') ++nest;
536                 if (items[i]=='{') ++nest;
537                 if (items[i]==')') --nest;
538                 if (items[i]==']') --nest;
539                 if (items[i]=='>') --nest;
540                 if (items[i]=='}') --nest;
541
542                 if (nest <= 0) if (items[i]==' ') {
543                         items[i] = 0;
544                         argv[num_items++] = start;
545                         start = &items[i+1];
546                 }
547         }
548
549         return(num_items);
550
551 }
552
553
554 /*
555  * One particularly hideous aspect of IMAP is that we have to allow the client
556  * to specify arbitrary ranges and/or sets of messages to fetch.  Citadel IMAP
557  * handles this by setting the IMAP_FETCHED flag for each message specified in
558  * the ranges/sets, then looping through the message array, outputting messages
559  * with the flag set.  We don't bother returning an error if an out-of-range
560  * number is specified (we just return quietly) because any client braindead
561  * enough to request a bogus message number isn't going to notice the
562  * difference anyway.
563  *
564  * This function clears out the IMAP_FETCHED bits, then sets that bit for each
565  * message included in the specified range.
566  *
567  * Set is_uid to 1 to fetch by UID instead of sequence number.
568  */
569 void imap_pick_range(char *range, int is_uid) {
570         int i;
571         int num_sets;
572         int s;
573         char setstr[1024], lostr[1024], histr[1024];
574         int lo, hi;
575
576         /*
577          * Clear out the IMAP_FETCHED flags for all messages.
578          */
579         for (i = 1; i <= IMAP->num_msgs; ++i) {
580                 IMAP->flags[i-1] = IMAP->flags[i-1] & ~IMAP_FETCHED;
581         }
582
583         /*
584          * Now set it for all specified messages.
585          */
586         num_sets = num_tokens(range, ',');
587         for (s=0; s<num_sets; ++s) {
588                 extract_token(setstr, range, s, ',');
589
590                 extract_token(lostr, setstr, 0, ':');
591                 if (num_tokens(setstr, ':') >= 2) {
592                         extract_token(histr, setstr, 1, ':');
593                         if (!strcmp(histr, "*")) sprintf(histr, "%d", INT_MAX);
594                 } 
595                 else {
596                         strcpy(histr, lostr);
597                 }
598                 lo = atoi(lostr);
599                 hi = atoi(histr);
600
601                 /* Loop through the array, flipping bits where appropriate */
602                 for (i = 1; i <= IMAP->num_msgs; ++i) {
603                         if (is_uid) {   /* fetch by sequence number */
604                                 if ( (IMAP->msgids[i-1]>=lo)
605                                    && (IMAP->msgids[i-1]<=hi)) {
606                                         IMAP->flags[i-1] =
607                                                 IMAP->flags[i-1] | IMAP_FETCHED;
608                                 }
609                         }
610                         else {          /* fetch by uid */
611                                 if ( (i>=lo) && (i<=hi)) {
612                                         IMAP->flags[i-1] =
613                                                 IMAP->flags[i-1] | IMAP_FETCHED;
614                                 }
615                         }
616                 }
617         }
618 }
619
620
621
622 /*
623  * This function is called by the main command loop.
624  */
625 void imap_fetch(int num_parms, char *parms[]) {
626         char items[1024];
627         char *itemlist[256];
628         int num_items;
629         int i;
630
631         if (num_parms < 4) {
632                 cprintf("%s BAD invalid parameters\r\n", parms[0]);
633                 return;
634         }
635
636         imap_pick_range(parms[2], 0);
637
638         strcpy(items, "");
639         for (i=3; i<num_parms; ++i) {
640                 strcat(items, parms[i]);
641                 if (i < (num_parms-1)) strcat(items, " ");
642         }
643
644         num_items = imap_extract_data_items(itemlist, items);
645         if (num_items < 1) {
646                 cprintf("%s BAD invalid data item list\r\n", parms[0]);
647                 return;
648         }
649
650         imap_do_fetch(num_items, itemlist);
651         cprintf("%s OK FETCH completed\r\n", parms[0]);
652 }
653
654 /*
655  * This function is called by the main command loop.
656  */
657 void imap_uidfetch(int num_parms, char *parms[]) {
658         char items[1024];
659         char *itemlist[256];
660         int num_items;
661         int i;
662         int have_uid_item = 0;
663
664         if (num_parms < 5) {
665                 cprintf("%s BAD invalid parameters\r\n", parms[0]);
666                 return;
667         }
668
669         imap_pick_range(parms[3], 1);
670
671         strcpy(items, "");
672         for (i=4; i<num_parms; ++i) {
673                 strcat(items, parms[i]);
674                 if (i < (num_parms-1)) strcat(items, " ");
675         }
676
677         num_items = imap_extract_data_items(itemlist, items);
678         if (num_items < 1) {
679                 cprintf("%s BAD invalid data item list\r\n", parms[0]);
680                 return;
681         }
682
683         /* If the "UID" item was not included, we include it implicitly
684          * because this is a UID FETCH command
685          */
686         for (i=0; i<num_items; ++i) {
687                 if (!strcasecmp(itemlist[i], "UID")) ++have_uid_item;
688         }
689         if (have_uid_item == 0) itemlist[num_items++] = "UID";
690
691         imap_do_fetch(num_items, itemlist);
692         cprintf("%s OK UID FETCH completed\r\n", parms[0]);
693 }
694
695