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.
6 import org.ibex.crypto.*;
7 import org.ibex.util.*;
8 import org.ibex.mail.protocol.*;
11 import org.ibex.io.Fountain;
16 // FIXME: body constraints (how to enforce?)
17 // - messages must NEVER contain 8-bit binary data; this is a violation of IMAP
18 // - RFC822 1,000-char limit per line [soft line limit (suggested): 78 chars / hard line limit: 998 chars]
20 // FEATURE: PGP-signature-parsing
21 // FEATURE: mailing list header parsing (?)
22 // FEATURE: threading as in http://www.jwz.org/doc/threading.html
25 * [immutable] This class encapsulates a message "floating in the
26 * ether": RFC2822 data but no storage-specific flags or other
29 public class Message extends MIME.Part {
31 // Parsed Headers //////////////////////////////////////////////////////////////////////////////
33 public final Address to;
34 public final Address from; // if multiple From entries, this is sender
35 public final Address envelopeFrom;
36 public final Address envelopeTo;
37 public final Date date;
38 public final Date arrival;
39 public final Address replyto; // if none provided, this is equal to sender
40 public final String subject;
41 public final String messageid;
42 public final Address[] cc;
43 public final Address[] bcc;
45 public static Message newMessage(Fountain in) throws Malformed { return new Message(in); }
48 public Message reply(Fountain in, Address from, boolean includeReInSubject) throws Malformed {
50 if (to==null) to = Address.parse(headers.get("reply-to"));
51 if (to==null) to = Address.parse(headers.get("from"));
52 if (to==null) to = envelopeFrom;
53 if (to==null) throw new Malformed("cannot reply to a message without a return address");
54 Message ret = newMessage(in, from, to);
55 ret.headers.put("In-Reply-To", messageid);
56 String references = headers.get("references");
57 ret.headers.put("References", messageid + (references==null?"":(" "+references)));
58 if (includeReInSubject && subject!=null && !subject.toLowerCase().trim().startsWith("re:"))
59 headers.put("subject", "Re: "+subject);
65 //public static Message newMessage(Headers headers, Fountain body, Address from, Address to) throws Malformed {
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();
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");
79 if (to != null && s.toLowerCase().startsWith("envelope-to:")) continue;
80 if (s.toLowerCase().startsWith("return-path:")) continue;
84 for(String s = stream.readln(); s != null; s = stream.readln()) {
88 return new Message(new Fountain.StringFountain(sb.toString()));
91 private Message(Fountain in) throws Malformed {
94 this.envelopeTo = headers.get("Envelope-To") != null ? Address.parse(headers.get("Envelope-To")) : null;
95 this.envelopeFrom = headers.get("Return-Path") != null ? Address.parse(headers.get("Return-Path")) : null;
96 this.to = headers.get("To") != null ? Address.parse(headers.get("To")) : this.envelopeTo;
97 this.from = headers.get("From") != null ? Address.parse(headers.get("From")) : this.envelopeFrom;
98 this.replyto = headers.get("Reply-To") == null ? null : Address.parse(headers.get("Reply-To"));
99 this.subject = headers.get("Subject");
100 this.messageid = headers.get("Message-Id");
101 this.cc = Address.list(headers.get("Cc"));
102 this.bcc = Address.list(headers.get("Bcc"));
103 this.date = parseDate(headers.get("Date")) == null ? new Date() : parseDate(headers.get("Date"));
105 // reenable this once whitelisting is moved out of javascript
106 //if (this.messageid==null)
107 //throw new RuntimeException("every RFC2822 message must have a Message-ID: header");
110 // synthesize a message-id if not provided
111 this.messageid = headers.get("Message-Id") == null ? generateFreshMessageId(sha1(in.getStream())) : headers.get("Message-Id");
112 if (headers.get("Message-Id") == null) {
113 headers = headers.set("Message-Id", this.messageid);
114 Log.warn(Message.class, "synthesizing message-id for " + summary());
118 this.arrival = this.date; // FIXME wrong; grab this from traces?
122 private static String sha1(Stream stream) {
123 SHA1 sha1 = new SHA1();
124 byte[] b = new byte[1024];
126 int numread = stream.read(b, 0, b.length);
127 if (numread == -1) break;
128 sha1.update(b, 0, numread);
130 byte[] results = new byte[sha1.getDigestSize()];
131 sha1.doFinal(results, 0);
132 return new String(Encode.toBase64(results));
137 // Helpers /////////////////////////////////////////////////////////////////////////////
139 // http://www.jwz.org/doc/mid.html
140 private static final Random random = new Random();
141 public static String generateFreshMessageId() {
142 return generateFreshMessageId(Base36.encode(System.currentTimeMillis())+'.'+
143 Base36.encode(random.nextLong()));
145 public static String generateFreshMessageId(String seed) {
146 StringBuffer ret = new StringBuffer();
150 try { ret.append(InetAddress.getLocalHost().getHostName()); } catch (UnknownHostException e) { /* DELIBERATE */ }
152 return ret.toString();
155 public static Date parseDate(String s) {
156 // FIXME!!! this must be robust
157 // date/time parsing: see spec, 3.3
161 // this is belived to be compliant with QSBMF (http://cr.yp.to/proto/qsbmf.txt)
162 public Message bounce(String reason) {
163 if (envelopeFrom==null || envelopeFrom.toString().equals("")) return null;
165 Log.warn(Message.class, "bouncing message due to: " + reason);
166 Headers h = new Headers(headers, new String[] {
167 "Envelope-To", envelopeFrom.toString(),
169 "From", "MAILER-DAEMON <>",
170 "To", envelopeFrom.toString(),
171 "Subject", "failure notice"
176 "Hi. This is the Ibex Mail Server. I'm afraid I wasn't able to deliver\r\n"+
177 "your message to the following addresses. This is a permanent error;\r\n"+
178 "I've given up. Sorry it didn't work out\r\n."+
180 "<"+envelopeTo.toString()+">:\r\n"+
183 "--- Below this line is a copy of the message.\r\n"+
187 return newMessage(Fountain.Util.concat(h, Fountain.Util.create(error), getBody()));
188 } catch (Message.Malformed e) {
189 Log.error(this, "caught Message.Malformed in Message.bounce(); this should never happen");
195 public String toString() { throw new RuntimeException("Message.toString() called"); }
196 public final String summary() { return "[" + envelopeFrom + " -> " + envelopeTo + "] " + subject; }
198 public static class Malformed extends MailException { public Malformed(String s) { super(s); } }