]> code.citadel.org Git - citadel.git/blobdiff - citadel/imap_fetch.c
* More IMAP tweaks
[citadel.git] / citadel / imap_fetch.c
index a85eba79ffd28f3254379413d0a51bb46dcb4505..5bfc50520eaa31101c884c8d98a108456466a49c 100644 (file)
@@ -36,6 +36,7 @@
 #include "msgbase.h"
 #include "tools.h"
 #include "internet_addressing.h"
+#include "mime_parser.h"
 #include "serv_imap.h"
 #include "imap_tools.h"
 #include "imap_fetch.h"
 
 
 
+struct imap_fetch_part {
+       char desired_section[256];
+       FILE *output_fp;
+};
+
 /*
  * Individual field functions for imap_do_fetch_msg() ...
  */
@@ -53,6 +59,10 @@ void imap_fetch_uid(int seq) {
        cprintf("UID %ld", IMAP->msgids[seq-1]);
 }
 
+void imap_fetch_flags(struct CtdlMessage *msg) {
+       cprintf("FLAGS ()");    /* FIXME do something here */
+}
+
 void imap_fetch_internaldate(struct CtdlMessage *msg) {
        char buf[256];
        time_t msgdate;
@@ -69,6 +79,436 @@ void imap_fetch_internaldate(struct CtdlMessage *msg) {
 }
 
 
+/*
+ * Fetch RFC822-formatted messages.
+ *
+ * 'whichfmt' should be set to one of:
+ *     "RFC822"        entire message
+ *     "RFC822.HEADER" headers only (with trailing blank line)
+ *     "RFC822.SIZE"   size of translated message
+ *     "RFC822.TEXT"   body only (without leading blank line)
+ */
+void imap_fetch_rfc822(int msgnum, char *whichfmt, struct CtdlMessage *msg) {
+       FILE *tmp;
+       char buf[1024];
+       char *ptr;
+       long headers_size, text_size, total_size;
+       long bytes_remaining = 0;
+       long blocksize;
+
+       tmp = tmpfile();
+       if (tmp == NULL) {
+               lprintf(1, "Cannot open temp file: %s\n", strerror(errno));
+               return;
+       }
+
+       /*
+        * Load the message into a temp file for translation and measurement
+        */ 
+       CtdlRedirectOutput(tmp, -1);
+       CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 0, 0, 1);
+       CtdlRedirectOutput(NULL, -1);
+       if (!is_valid_message(msg)) {
+               lprintf(1, "WARNING: output clobbered the message!\n");
+       }
+
+       /*
+        * Now figure out where the headers/text break is.  IMAP considers the
+        * intervening blank line to be part of the headers, not the text.
+        */
+       rewind(tmp);
+       headers_size = 0L;
+       do {
+               ptr = fgets(buf, sizeof buf, tmp);
+               if (ptr != NULL) {
+                       striplt(buf);
+                       if (strlen(buf) == 0) headers_size = ftell(tmp);
+               }
+       } while ( (headers_size == 0L) && (ptr != NULL) );
+       fseek(tmp, 0L, SEEK_END);
+       total_size = ftell(tmp);
+       text_size = total_size - headers_size;
+
+       if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
+               cprintf("RFC822.SIZE %ld", total_size);
+               fclose(tmp);
+               return;
+       }
+
+       else if (!strcasecmp(whichfmt, "RFC822")) {
+               bytes_remaining = total_size;
+               rewind(tmp);
+       }
+
+       else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
+               bytes_remaining = headers_size;
+               rewind(tmp);
+       }
+
+       else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
+               bytes_remaining = text_size;
+               fseek(tmp, headers_size, SEEK_SET);
+       }
+
+       cprintf("%s {%ld}\r\n", whichfmt, bytes_remaining);
+       blocksize = sizeof(buf);
+       while (bytes_remaining > 0L) {
+               if (blocksize > bytes_remaining) blocksize = bytes_remaining;
+               fread(buf, blocksize, 1, tmp);
+               client_write(buf, blocksize);
+               bytes_remaining = bytes_remaining - blocksize;
+       }
+
+       fclose(tmp);
+}
+
+
+
+/*
+ * Load a specific part of a message into the temp file to be output to a
+ * client.  FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
+ * but we still can't handle "2.HEADER" (which might not be a problem, because
+ * we currently don't have the ability to break out nested RFC822's anyway).
+ *
+ * Note: mime_parser() was called with dont_decode set to 1, so we have the
+ * luxury of simply spewing without having to re-encode.
+ */
+void imap_load_part(char *name, char *filename, char *partnum, char *disp,
+                   void *content, char *cbtype, size_t length, char *encoding,
+                   void *cbuserdata)
+{
+       struct imap_fetch_part *imfp;
+       char mbuf2[1024];
+
+       imfp = (struct imap_fetch_part *)cbuserdata;
+
+       if (!strcasecmp(partnum, imfp->desired_section)) {
+               fwrite(content, length, 1, imfp->output_fp);
+       }
+
+       sprintf(mbuf2, "%s.MIME", partnum);
+
+       if (!strcasecmp(imfp->desired_section, mbuf2)) {
+               fprintf(imfp->output_fp, "Content-type: %s", cbtype);
+               if (strlen(name) > 0)
+                       fprintf(imfp->output_fp, "; name=\"%s\"", name);
+               fprintf(imfp->output_fp, "\r\n");
+               if (strlen(encoding) > 0)
+                       fprintf(imfp->output_fp,
+                               "Content-Transfer-Encoding: %s\r\n", encoding);
+               if (strlen(encoding) > 0) {
+                       fprintf(imfp->output_fp, "Content-Disposition: %s",
+                                       disp);
+                       if (strlen(filename) > 0) {
+                               fprintf(imfp->output_fp, "; filename=\"%s\"",
+                                       filename);
+                       }
+                       fprintf(imfp->output_fp, "\r\n");
+               }
+               fprintf(imfp->output_fp, "Content-Length: %d\r\n", length);
+               fprintf(imfp->output_fp, "\r\n");
+       }
+                       
+
+}
+
+
+/* 
+ * Called by imap_fetch_envelope() to output the "From" field.
+ * This is in its own function because its logic is kind of complex.  We
+ * really need to make this suck less.
+ */
+void imap_output_envelope_from(struct CtdlMessage *msg) {
+       char user[1024], node[1024], name[1024];
+
+       cprintf("((");                          /* open double-parens */
+       imap_strout(msg->cm_fields['A']);       /* personal name */
+       cprintf(" NIL ");                       /* source route (not used) */
+
+       if (msg->cm_fields['F'] != NULL) {
+               process_rfc822_addr(msg->cm_fields['F'], user, node, name);
+               imap_strout(user);              /* mailbox name (user id) */
+               cprintf(" ");
+               if (!strcasecmp(node, config.c_nodename)) {
+                       imap_strout(config.c_fqdn);
+               }
+               else {
+                       imap_strout(node);              /* host name */
+               }
+       }
+       else {
+               imap_strout(msg->cm_fields['A']); /* mailbox name (user id) */
+               cprintf(" ");
+               imap_strout(msg->cm_fields['N']);       /* host name */
+       }
+       
+       cprintf(")) ");                         /* close double-parens */
+}
+
+
+/*
+ * Implements the ENVELOPE fetch item
+ * 
+ * FIXME ... we only output some of the fields right now.  Definitely need
+ *           to do all of them.  Accurately, too.
+ *
+ * Note that the imap_strout() function can cleverly output NULL fields as NIL,
+ * so we don't have to check for that condition like we do elsewhere.
+ */
+void imap_fetch_envelope(long msgnum, struct CtdlMessage *msg) {
+       char datestringbuf[256];
+       time_t msgdate;
+       char *fieldptr = NULL;
+
+       /* Parse the message date into an IMAP-format date string */
+       if (msg->cm_fields['T'] != NULL) {
+               msgdate = atol(msg->cm_fields['T']);
+       }
+       else {
+               msgdate = time(NULL);
+       }
+       datestring(datestringbuf, msgdate, DATESTRING_IMAP);
+
+       /* Now start spewing data fields.  The order is important, as it is
+        * defined by the protocol specification.  Nonexistent fields must
+        * be output as NIL, existent fields must be quoted or literalled.
+        * The imap_strout() function conveniently does all this for us.
+        */
+       cprintf("ENVELOPE (");
+
+       /* Date */
+       imap_strout(datestringbuf);
+       cprintf(" ");
+
+       /* Subject */
+       imap_strout(msg->cm_fields['U']);
+       cprintf(" ");
+
+       /* From */
+       imap_output_envelope_from(msg);
+
+       /* Sender */
+       if (0) {
+               /* FIXME ... check for a *real* Sender: field */
+       }
+       else {
+               imap_output_envelope_from(msg);
+       }
+
+       /* Reply-to */
+       if (0) {
+               /* FIXME ... check for a *real* Reply-to: field */
+       }
+       else {
+               imap_output_envelope_from(msg);
+       }
+
+       cprintf("NIL ");        /* to */
+
+       cprintf("NIL ");        /* cc */
+
+       cprintf("NIL ");        /* bcc */
+
+       /* In-reply-to */
+       fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "In-reply-to");
+       imap_strout(fieldptr);
+       cprintf(" ");
+       if (fieldptr != NULL) phree(fieldptr);
+
+       /* message ID */
+       imap_strout(msg->cm_fields['I']);
+
+       cprintf(") ");
+}
+
+
+/*
+ * Strip any non header information out of a chunk of RFC822 data on disk
+ */
+void imap_strip_headers(FILE *fp) {
+       char buf[1024];
+
+       rewind(fp);
+       while (fgets(buf, sizeof buf, fp) != NULL) {
+               striplt(buf);
+               if (strlen(buf) == 0) {
+                       fflush(fp);
+                       ftruncate(fileno(fp), ftell(fp));
+               }
+       }
+       fflush(fp);
+       fprintf(fp, "\r\n");    /* add the trailing newline */
+       rewind(fp);
+}
+
+
+/*
+ * Implements the BODY and BODY.PEEK fetch items
+ */
+void imap_fetch_body(long msgnum, char *item, int is_peek,
+               struct CtdlMessage *msg) {
+       char section[1024];
+       char partial[1024];
+       int is_partial = 0;
+       char buf[1024];
+       int i;
+       FILE *tmp;
+       long bytes_remaining = 0;
+       long blocksize;
+       long pstart, pbytes;
+       struct imap_fetch_part imfp;
+
+       /* extract section */
+       strcpy(section, item);
+       for (i=0; i<strlen(section); ++i) {
+               if (section[i]=='[') strcpy(section, &section[i+1]);
+       }
+       for (i=0; i<strlen(section); ++i) {
+               if (section[i]==']') section[i] = 0;
+       }
+       lprintf(9, "Section is %s\n", section);
+
+       /* extract partial */
+       strcpy(partial, item);
+       for (i=0; i<strlen(partial); ++i) {
+               if (partial[i]=='<') {
+                       strcpy(partial, &partial[i+1]);
+                       is_partial = 1;
+               }
+       }
+       for (i=0; i<strlen(partial); ++i) {
+               if (partial[i]=='>') partial[i] = 0;
+       }
+       if (is_partial == 0) strcpy(partial, "");
+       lprintf(9, "Partial is %s\n", partial);
+
+       tmp = tmpfile();
+       if (tmp == NULL) {
+               lprintf(1, "Cannot open temp file: %s\n", strerror(errno));
+               return;
+       }
+
+       /* Now figure out what the client wants, and get it */
+
+       if (!strcmp(section, "")) {             /* the whole thing */
+               CtdlRedirectOutput(tmp, -1);
+               CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 0, 0, 1);
+               CtdlRedirectOutput(NULL, -1);
+       }
+
+       /*
+        * Be obnoxious and send the entire header, even if the client only
+        * asks for certain fields.  FIXME this shortcut later.
+        */
+       else if (!strncasecmp(section, "HEADER", 6)) {
+               CtdlRedirectOutput(tmp, -1);
+               CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 1, 0, 1);
+               CtdlRedirectOutput(NULL, -1);
+               imap_strip_headers(tmp);
+       }
+
+       /*
+        * Anything else must be a part specifier.
+        * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
+        */
+       else {
+               safestrncpy(imfp.desired_section, section,
+                               sizeof(imfp.desired_section));
+               imfp.output_fp = tmp;
+
+               mime_parser(msg->cm_fields['M'], NULL,
+                               *imap_load_part,
+                               (void *)&imfp,
+                               1);
+       }
+
+
+       fseek(tmp, 0L, SEEK_END);
+       bytes_remaining = ftell(tmp);
+
+       if (is_partial == 0) {
+               rewind(tmp);
+               cprintf("BODY[%s] {%ld}\r\n", section, bytes_remaining);
+       }
+       else {
+               sscanf(partial, "%ld.%ld", &pstart, &pbytes);
+               if ((bytes_remaining - pstart) < pbytes) {
+                       pbytes = bytes_remaining - pstart;
+               }
+               fseek(tmp, pstart, SEEK_SET);
+               bytes_remaining = pbytes;
+               cprintf("BODY[%s] {%ld}<%ld>\r\n",
+                       section, bytes_remaining, pstart);
+       }
+
+       blocksize = sizeof(buf);
+       while (bytes_remaining > 0L) {
+               if (blocksize > bytes_remaining) blocksize = bytes_remaining;
+               fread(buf, blocksize, 1, tmp);
+               client_write(buf, blocksize);
+               bytes_remaining = bytes_remaining - blocksize;
+       }
+
+       fclose(tmp);
+
+       if (is_peek) {
+               /* FIXME set the last read pointer or something */
+       }
+}
+
+
+/*
+ * Spew the BODYSTRUCTURE data for a message.  (Do you need a silencer if
+ * you're going to shoot a MIME?  Do you need a reason to shoot Mark Crispin?
+ * No, and no.)
+ *
+ * FIXME finish the implementation
+ */
+void imap_fetch_bodystructure (long msgnum, char *item,
+               struct CtdlMessage *msg) {
+       FILE *tmp;
+       char buf[1024];
+       long lines = 0L;
+       long bytes = 0L;
+
+
+       /* For non-RFC822 (ordinary Citadel) messages, this is short and
+        * sweet...
+        */
+       if (msg->cm_format_type != FMT_RFC822) {
+
+               /* *sigh* We have to RFC822-format the message just to be able
+                * to measure it.
+                */
+               tmp = tmpfile();
+               if (tmp == NULL) return;
+               CtdlRedirectOutput(tmp, -1);
+               CtdlOutputPreLoadedMsg(msg, msgnum, MT_RFC822, 0, 0, 1);
+               CtdlRedirectOutput(NULL, -1);
+
+               rewind(tmp);
+               while (fgets(buf, sizeof buf, tmp) != NULL) ++lines;
+               bytes = ftell(tmp);
+               fclose(tmp);
+
+               cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
+                       "(\"CHARSET\" \"US-ASCII\") NIL NIL "
+                       "\"7BIT\" %ld %ld) ", bytes, lines);
+
+               return;
+       }
+
+       /* For messages already stored in RFC822 format, we have to parse. */
+       /* FIXME do this! */
+
+
+}
+
+
+
+
+
+
 /*
  * imap_do_fetch() calls imap_do_fetch_msg() to output the deta of an
  * individual message, once it has been successfully loaded from disk.
@@ -82,34 +522,37 @@ void imap_do_fetch_msg(int seq, struct CtdlMessage *msg,
        for (i=0; i<num_items; ++i) {
 
                if (!strncasecmp(itemlist[i], "BODY[", 5)) {
-                       /* FIXME do something here */
+                       imap_fetch_body(IMAP->msgids[seq-1], itemlist[i],
+                                       0, msg);
                }
                else if (!strncasecmp(itemlist[i], "BODY.PEEK[", 10)) {
-                       /* FIXME do something here */
+                       imap_fetch_body(IMAP->msgids[seq-1], itemlist[i],
+                                       1, msg);
                }
                else if (!strcasecmp(itemlist[i], "BODYSTRUCTURE")) {
-                       /* FIXME do something here */
+                       imap_fetch_bodystructure(IMAP->msgids[seq-1],
+                                       itemlist[i], msg);
                }
                else if (!strcasecmp(itemlist[i], "ENVELOPE")) {
-                       /* FIXME do something here */
+                       imap_fetch_envelope(IMAP->msgids[seq-1], msg);
                }
                else if (!strcasecmp(itemlist[i], "FLAGS")) {
-                       /* FIXME do something here */
+                       imap_fetch_flags(msg);
                }
                else if (!strcasecmp(itemlist[i], "INTERNALDATE")) {
                        imap_fetch_internaldate(msg);
                }
                else if (!strcasecmp(itemlist[i], "RFC822")) {
-                       /* FIXME do something here */
+                       imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
                }
                else if (!strcasecmp(itemlist[i], "RFC822.HEADER")) {
-                       /* FIXME do something here */
+                       imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
                }
                else if (!strcasecmp(itemlist[i], "RFC822.SIZE")) {
-                       /* FIXME do something here */
+                       imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
                }
                else if (!strcasecmp(itemlist[i], "RFC822.TEXT")) {
-                       /* FIXME do something here */
+                       imap_fetch_rfc822(IMAP->msgids[seq-1], itemlist[i], msg);
                }
                else if (!strcasecmp(itemlist[i], "UID")) {
                        imap_fetch_uid(seq);
@@ -127,22 +570,20 @@ void imap_do_fetch_msg(int seq, struct CtdlMessage *msg,
  * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
  * validated and boiled down the request a bit.
  */
-void imap_do_fetch(int lo, int hi, int num_items, char **itemlist) {
+void imap_do_fetch(int num_items, char **itemlist) {
        int i;
        struct CtdlMessage *msg;
 
-       for (i=0; i<num_items; ++i) {
-               lprintf(9, "* item[%d] = <%s>\r\n", i, itemlist[i]);
-       }
-
-       for (i = lo; i <= hi; ++i) {
-               msg = CtdlFetchMessage(IMAP->msgids[i-1]);
+       if (IMAP->num_msgs > 0)
+        for (i = 0; i < IMAP->num_msgs; ++i)
+         if (IMAP->flags[i] && IMAP_FETCHED) {
+               msg = CtdlFetchMessage(IMAP->msgids[i]);
                if (msg != NULL) {
-                       imap_do_fetch_msg(i, msg, num_items, itemlist);
+                       imap_do_fetch_msg(i+1, msg, num_items, itemlist);
                        CtdlFreeMessage(msg);
                }
                else {
-                       cprintf("* %d FETCH <internal error>\r\n", i);
+                       cprintf("* %d FETCH <internal error>\r\n", i+1);
                }
        }
 }
@@ -273,14 +714,79 @@ int imap_extract_data_items(char **argv, char *items) {
 }
 
 
+/*
+ * One particularly hideous aspect of IMAP is that we have to allow the client
+ * to specify arbitrary ranges and/or sets of messages to fetch.  Citadel IMAP
+ * handles this by setting the IMAP_FETCHED flag for each message specified in
+ * the ranges/sets, then looping through the message array, outputting messages
+ * with the flag set.  We don't bother returning an error if an out-of-range
+ * number is specified (we just return quietly) because any client braindead
+ * enough to request a bogus message number isn't going to notice the
+ * difference anyway.
+ *
+ * This function clears out the IMAP_FETCHED bits, then sets that bit for each
+ * message included in the specified range.
+ *
+ * Set is_uid to 1 to fetch by UID instead of sequence number.
+ */
+void imap_pick_range(char *range, int is_uid) {
+       int i;
+       int num_sets;
+       int s;
+       char setstr[1024], lostr[1024], histr[1024];
+       int lo, hi;
+
+       /*
+        * Clear out the IMAP_FETCHED flags for all messages.
+        */
+       for (i = 1; i <= IMAP->num_msgs; ++i) {
+               IMAP->flags[i-1] = IMAP->flags[i-1] & ~IMAP_FETCHED;
+       }
+
+       /*
+        * Now set it for all specified messages.
+        */
+       num_sets = num_tokens(range, ',');
+       for (s=0; s<num_sets; ++s) {
+               extract_token(setstr, range, s, ',');
+
+               extract_token(lostr, setstr, 0, ':');
+               if (num_tokens(setstr, ':') >= 2) {
+                       extract_token(histr, setstr, 1, ':');
+                       if (!strcmp(histr, "*")) sprintf(histr, "%d", INT_MAX);
+               } 
+               else {
+                       strcpy(histr, lostr);
+               }
+               lo = atoi(lostr);
+               hi = atoi(histr);
+
+               /* Loop through the array, flipping bits where appropriate */
+               for (i = 1; i <= IMAP->num_msgs; ++i) {
+                       if (is_uid) {   /* fetch by sequence number */
+                               if ( (IMAP->msgids[i-1]>=lo)
+                                  && (IMAP->msgids[i-1]<=hi)) {
+                                       IMAP->flags[i-1] =
+                                               IMAP->flags[i-1] | IMAP_FETCHED;
+                               }
+                       }
+                       else {          /* fetch by uid */
+                               if ( (i>=lo) && (i<=hi)) {
+                                       IMAP->flags[i-1] =
+                                               IMAP->flags[i-1] | IMAP_FETCHED;
+                               }
+                       }
+               }
+       }
+}
+
+
 
 /*
  * This function is called by the main command loop.
  */
 void imap_fetch(int num_parms, char *parms[]) {
-       int lo = 0;
-       int hi = 0;
-       char lostr[1024], histr[1024], items[1024];
+       char items[1024];
        char *itemlist[256];
        int num_items;
        int i;
@@ -290,16 +796,7 @@ void imap_fetch(int num_parms, char *parms[]) {
                return;
        }
 
-       extract_token(lostr, parms[2], 0, ':');
-       lo = atoi(lostr);
-       extract_token(histr, parms[2], 1, ':');
-       hi = atoi(histr);
-
-       if ( (lo < 1) || (hi < 1) || (lo > hi) || (hi > IMAP->num_msgs) ) {
-               cprintf("%s BAD invalid sequence numbers %d:%d\r\n",
-                       parms[0], lo, hi);
-               return;
-       }
+       imap_pick_range(parms[2], 0);
 
        strcpy(items, "");
        for (i=3; i<num_parms; ++i) {
@@ -313,9 +810,49 @@ void imap_fetch(int num_parms, char *parms[]) {
                return;
        }
 
-       imap_do_fetch(lo, hi, num_items, itemlist);
+       imap_do_fetch(num_items, itemlist);
        cprintf("%s OK FETCH completed\r\n", parms[0]);
 }
 
+/*
+ * This function is called by the main command loop.
+ */
+void imap_uidfetch(int num_parms, char *parms[]) {
+       char items[1024];
+       char *itemlist[256];
+       int num_items;
+       int i;
+       int have_uid_item = 0;
+
+       if (num_parms < 5) {
+               cprintf("%s BAD invalid parameters\r\n", parms[0]);
+               return;
+       }
+
+       imap_pick_range(parms[3], 1);
+
+       strcpy(items, "");
+       for (i=4; i<num_parms; ++i) {
+               strcat(items, parms[i]);
+               if (i < (num_parms-1)) strcat(items, " ");
+       }
+
+       num_items = imap_extract_data_items(itemlist, items);
+       if (num_items < 1) {
+               cprintf("%s BAD invalid data item list\r\n", parms[0]);
+               return;
+       }
+
+       /* If the "UID" item was not included, we include it implicitly
+        * because this is a UID FETCH command
+        */
+       for (i=0; i<num_items; ++i) {
+               if (!strcasecmp(itemlist[i], "UID")) ++have_uid_item;
+       }
+       if (have_uid_item == 0) itemlist[num_items++] = "UID";
+
+       imap_do_fetch(num_items, itemlist);
+       cprintf("%s OK UID FETCH completed\r\n", parms[0]);
+}