src/org/ibex/mail/Message.java

   1 // Copyright 2000-2005 the Contributors, as shown in the revision logs.
   2 // Licensed under the Apache Public Source License 2.0 ("the License").
   3 // You may not use this file except in compliance with the License.
   4
   5 package org.ibex.mail;
   6 import org.ibex.crypto.*;
   7 import org.ibex.util.*;
   8 import org.ibex.mail.protocol.*;
   9 import org.ibex.js.*;
  10 import org.ibex.io.*;
  11 import org.ibex.io.Fountain;
  12 import java.util.*;
  13 import java.net.*;
  14 import java.io.*;
  15
  16 // FIXME: messages must NEVER contain 8-bit binary data; this is a violation of IMAP
  17 // FIXME: RFC822 1,000-char limit per line [soft line limit (suggested): 78 chars /  hard line limit: 998 chars]
  18
  19 // FEATURE: PGP-signature-parsing
  20 // FEATURE: mailing list header parsing (?)
  21 // FEATURE: threading as in http://www.jwz.org/doc/threading.html
  22
  23 /**
  24  *  [immutable] This class encapsulates a message "floating in the
  25  *  ether": RFC2822 data but no storage-specific flags or other
  26  *  metadata.
  27  */
  28 public class Message extends MIME.Part {
  29
  30     // Parsed Headers //////////////////////////////////////////////////////////////////////////////
  31
  32     public final Address     to;
  33     public final Address     from;                // if multiple From entries, this is sender
  34     public final Address     envelopeFrom;
  35     public final Address     envelopeTo;
  36     public final Date        date;
  37     public final Date        arrival;
  38     public final Address     replyto;             // if none provided, this is equal to sender
  39     public final String      subject;
  40     public final String      messageid;
  41     public final Address[]   cc;
  42     public final Address[]   bcc;
  43
  44     public static Message newMessage(Fountain in) throws Malformed { return new Message(in); }
  45
  46     public Message reply(Fountain in, Address from, boolean includeReInSubject) throws Malformed {
  47         /*
  48         Address to = null;
  49         if (to==null) to = Address.parse(headers.get("reply-to"));
  50         if (to==null) to = Address.parse(headers.get("from"));
  51         if (to==null) to = envelopeFrom;
  52         Message ret = newMessage(in, from, to);
  53         ret.headers.put("In-Reply-To", messageid);
  54         String references = headers.get("references");
  55         ret.headers.put("References", messageid + (references==null?"":(" "+references)));
  56         if (includeReInSubject && subject!=null && !subject.toLowerCase().trim().startsWith("re:"))
  57             headers.put("subject", "Re: "+subject);
  58         return ret;
  59         */
  60         // FIXME
  61         return null;
  62     }
  63
  64     // FIXME
  65     //public static Message newMessage(Headers headers, Fountain body, Address from, Address to) throws Malformed {
  66     //}
  67
  68     public static Message newMessage(Fountain in, Address from, Address to) throws Malformed {
  69         StringBuffer sb = new StringBuffer();
  70         if (from != null) sb.append("Return-Path: " + from.toString(true) + "\r\n");
  71         Stream stream = in.getStream();
  72         while(true) {
  73             String s = stream.readln();
  74             if (s == null || s.length() == 0) {
  75                 if (to != null) sb.append("Envelope-To: " + to.toString(true) + "\r\n");
  76                 sb.append("\r\n");
  77                 break;
  78             }
  79             if (to != null && s.toLowerCase().startsWith("envelope-to:")) continue;
  80             if (s.toLowerCase().startsWith("return-path:")) continue;
  81             sb.append(s);
  82             sb.append("\r\n");
  83         }
  84         for(String s = stream.readln(); s != null; s = stream.readln()) {
  85             sb.append(s);
  86             sb.append("\r\n");
  87         }
  88         return new Message(new Fountain.StringFountain(sb.toString()));
  89     }
  90
  91     private Message(Fountain in) throws Malformed {
  92         super(in);
  93         this.envelopeTo   = headers.get("Envelope-To") != null ? Address.parse(headers.get("Envelope-To")) : null;
  94         this.envelopeFrom = headers.get("Return-Path") != null ? Address.parse(headers.get("Return-Path")) : null;
  95         this.to           = headers.get("To") != null ? Address.parse(headers.get("To")) : this.envelopeTo;
  96         this.from         = headers.get("From") != null ? Address.parse(headers.get("From")) : this.envelopeFrom;
  97         this.replyto      = headers.get("Reply-To") == null ? null : Address.parse(headers.get("Reply-To"));
  98         this.subject      = headers.get("Subject");
  99         this.messageid    = headers.get("Message-Id");
 100         this.cc           = Address.list(headers.get("Cc"));
 101         this.bcc          = Address.list(headers.get("Bcc"));
 102         this.date         = parseDate(headers.get("Date")) == null ? new Date() : parseDate(headers.get("Date"));
 103
 104         if (this.messageid==null)
 105             throw new RuntimeException("every RFC2822 message must have a Message-ID: header");
 106
 107         /*
 108         // synthesize a message-id if not provided
 109         this.messageid    = headers.get("Message-Id") == null ? generateFreshMessageId(sha1(in.getStream())) : headers.get("Message-Id");
 110         if (headers.get("Message-Id") == null) {
 111             headers = headers.set("Message-Id", this.messageid);
 112             Log.warn(Message.class, "synthesizing message-id for " + summary());
 113         }
 114         */
 115
 116         this.arrival      = this.date; // FIXME wrong; grab this from traces?
 117     }
 118
 119     /*
 120     private static String sha1(Stream stream) {
 121         SHA1 sha1 = new SHA1();
 122         byte[] b = new byte[1024];
 123         while(true) {
 124             int numread = stream.read(b, 0, b.length);
 125             if (numread == -1) break;
 126             sha1.update(b, 0, numread);
 127         }
 128         byte[] results = new byte[sha1.getDigestSize()];
 129         sha1.doFinal(results, 0);
 130         return new String(Encode.toBase64(results));
 131     }
 132     */
 133
 134     // Helpers /////////////////////////////////////////////////////////////////////////////
 135
 136     // http://www.jwz.org/doc/mid.html
 137     private static final Random random = new Random();
 138     public static String generateFreshMessageId() {
 139         StringBuffer ret = new StringBuffer();
 140         ret.append('<');
 141         ret.append(Base36.encode(System.currentTimeMillis()));
 142         ret.append('.');
 143         ret.append(Base36.encode(random.nextLong()));
 144         ret.append('.');
 145         try { ret.append(InetAddress.getLocalHost().getHostName()); } catch (UnknownHostException e) { /* DELIBERATE */ }
 146         ret.append('>');
 147         return ret.toString();
 148     }
 149
 150     public static Date parseDate(String s) {
 151         // FIXME!!! this must be robust
 152         // date/time parsing: see spec, 3.3
 153         return null;
 154     }
 155
 156     // this is belived to be compliant with QSBMF (http://cr.yp.to/proto/qsbmf.txt)
 157     public Message bounce(String reason) {
 158         if (envelopeFrom==null || envelopeFrom.toString().equals("")) return null;
 159
 160         Log.warn(Message.class, "bouncing message due to: " + reason);
 161         Headers h = new Headers.Original(headers.getStream());
 162         h = h.set(new String[] {
 163             "Envelope-To", envelopeFrom.toString(),
 164             "Return-Path", "<>",
 165             "From",        "MAILER-DAEMON <>",
 166             "To",          envelopeFrom.toString(),
 167             "Subject",     "failure notice"
 168         });
 169
 170         String error =
 171             "Hi. This is the Ibex Mail Server.  I'm afraid I wasn't able to deliver\r\n"+
 172             "your message to the following addresses. This is a permanent error;\r\n"+
 173             "I've given up.  Sorry it didn't work out\r\n."+
 174             "\r\n"+
 175             "<"+envelopeTo.toString()+">:\r\n"+
 176             reason+"\r\n"+
 177             "\r\n"+
 178             "--- Below this line is a copy of the message.\r\n"+
 179             "\r\n";
 180
 181         try {
 182             return newMessage(new Fountain.Concatenate(new Fountain.StringFountain(h.getString()+"\r\n"+error), getBody()));
 183         } catch (Message.Malformed e) {
 184             Log.error(this, "caught Message.Malformed in Message.bounce(); this should never happen");
 185             Log.error(this, e);
 186             return null;
 187         }
 188     }
 189
 190     public       String toString() { throw new RuntimeException("Message.toString() called"); }
 191     public final String summary() { return "[" + envelopeFrom + " -> " + envelopeTo + "] " + subject; }
 192
 193     public static class Malformed extends MailException { public Malformed(String s) { super(s); } }
 194 }
 195