made Message.summary() briefer
[org.ibex.mail.git] / src / org / ibex / mail / Message.java
index 5ee6864..c26b58e 100644 (file)
 package org.ibex.mail;
 import org.ibex.crypto.*;
-import org.ibex.js.*;
 import org.ibex.util.*;
 import org.ibex.mail.protocol.*;
+import org.ibex.io.*;
 import java.util.*;
 import java.net.*;
 import java.io.*;
 
+// FIXME this is important: folded headers: can insert CRLF anywhere that whitespace appears (before the whitespace)
+
 // soft line limit (suggested): 78 chars /  hard line limit: 998 chars
-// folded headers: can insert CRLF anywhere that whitespace appears (before the whitespace)
 // date/time parsing: see spec, 3.3
 
-// FEATURE: MIME RFC2045, 2046, 2049
+// FIXME: messages must NEVER contain 8-bit binary data; this is a violation of IMAP
+
 // FEATURE: PGP-signature-parsing
 // FEATURE: mailing list header parsing
 // FEATURE: delivery status notification (and the sneaky variety)
 // FEATURE: threading as in http://www.jwz.org/doc/threading.html
+// FEATURE: lazy body
+// FIXME RFC822 1,000-char limit per line
 
-public class Message extends JSReflection {
+/** 
+ *  [immutable] This class encapsulates a message "floating in the
+ *  ether": RFC2822 data but no storage-specific flags or other
+ *  metadata.
+ */
+public class Message extends MIME.Part {
 
-    private static class CaseInsensitiveHash extends Hashtable {
-        public Object get(Object o) {
-            if (o instanceof String) return super.get(((String)o).toLowerCase());
-            return super.get(o);
-        }
-        public Object put(Object k, Object v) {
-            if (k instanceof String) return super.put(((String)k).toLowerCase(), v);
-            else return super.put(k, v);
+    // Envelope //////////////////////////////////////////////////////////////////////////////
+
+    public final Envelope    envelope;
+    public static class Envelope extends org.ibex.js.JSReflection {
+        public Envelope(Address from, Address to, Date arrival) { this.to = to; this.from = from; this.arrival = arrival; }
+        public final Date arrival;
+        public final Address to;
+        public final Address from;
+        public static Envelope augment(Envelope e, MIME.Headers h) {
+            if (e.from != null && e.to != null) return e;
+            Address to   = e.to   == null ? Address.parse(h.gets("X-org.ibex.mail.headers.envelope.To"))   : e.to;
+            Address from = e.from == null ? Address.parse(h.gets("X-org.ibex.mail.headers.envelope.From")) : e.from;
+            return new Envelope(from, to, e.arrival);
         }
     }
-    
-    public int rfc822size() { return allHeaders.length() + 2 /* CRLF */ + body.length(); }  // double check this
-
-    public final String allHeaders;   // pristine headers
-    public final Hashtable headers;   // hash of headers (not including resent's and traces)
-    public final String body;         // entire body
-    public final int lines;           // lines in the body
-
-    public final Date date;
-    public final Address to;
-    public final Address from;        // if multiple From entries, this is sender
-    public final Address replyto;     // if none provided, this is equal to sender
-    public final String subject;
-    public final String messageid;
-    public final Address[] cc;
-    public final Address[] bcc;
+
+
+    // Parsed Headers //////////////////////////////////////////////////////////////////////////////
+
+    public final Address     to;
+    public final Address     from;                // if multiple From entries, this is sender
+    public final Date        date;
+    public final Address     replyto;             // if none provided, this is equal to sender
+    public final String      subject;
+    public final String      messageid;
+    public final Address[]   cc;
+    public final Address[]   bcc;
     public final Hashtable[] resent;
-    public final Trace[] traces;
-
-    public final Address envelopeFrom;
-    public final Address[] envelopeTo;
-
-    public final Date arrival;         // when the message first arrived at this machine; IMAP "internal date message attr"
-    
-    public void dump(OutputStream os) throws IOException {
-        Writer w = new OutputStreamWriter(os);
-        w.write(allHeaders);
-        w.write("X-IbexMail-EnvelopeFrom: " + envelopeFrom + "\r\n");
-        w.write("X-IbexMail-EnvelopeTo: "); for(int i=0; i<envelopeTo.length; i++) w.write(envelopeTo[i] + " "); w.write("\r\n");
-        w.write("\r\n");
-        w.write(body);
-        w.flush();
+
+    public Message(Stream stream, Envelope envelope) throws Malformed {
+        super(stream, null, false);
+        Vec resent = new Vec(), traces = new Vec();
+        this.envelope     = Envelope.augment(envelope, headers);
+        this.to           = headers.gets("To") == null       ? envelope.to    : Address.parse(headers.gets("To"));
+        this.from         = headers.gets("From") == null     ? envelope.from  : Address.parse(headers.gets("From"));
+        this.replyto      = headers.gets("Reply-To") == null ? null           : Address.parse(headers.gets("Reply-To"));
+        this.subject      = headers.gets("Subject");
+        this.messageid    = headers.gets("Message-Id");
+        this.cc           = Address.list(headers.gets("Cc"));
+        this.bcc          = Address.list(headers.gets("BCc"));
+        this.date         = parseDate(headers.gets("Date"));
+        resent.copyInto(this.resent = new Hashtable[resent.size()]);
+        traces.copyInto(this.traces = new Trace[traces.size()]);
     }
-    /*
-    public static class Persistent {
-        public boolean deleted = false;
-        public boolean seen = false;
-        public boolean flagged = false;
-        public boolean draft = false;
-        public boolean answered = false;
-        public boolean recent = false;
-        public int uid = 0;
+
+
+    // Helpers /////////////////////////////////////////////////////////////////////////////
+
+    // http://www.jwz.org/doc/mid.html
+    private static final Random random = new Random();
+    public static String generateFreshMessageId() {
+        StringBuffer ret = new StringBuffer();
+        ret.append('<');
+        ret.append(Base36.encode(System.currentTimeMillis()));
+        ret.append('.');
+        ret.append(Base36.encode(random.nextLong()));
+        ret.append('.');
+        try { ret.append(InetAddress.getLocalHost().getHostName()); } catch (UnknownHostException e) { /* DELIBERATE */ }
+        ret.append('>');
+        return ret.toString();
     }
-    */
-        /*
-    public static class StoredMessage extends Message {
-        public int uid;
-        public final int uid;
-        public final int uidValidity;     // must be reset if mailbox is deleted and then recreated
-        public final int sequenceNumber;  // starts at 1; numbers reshuffled upon EXPUNGE
-        public Hash keywords = new Hash();  
-        public boolean deleted = false;
-        public boolean seen = false;
-        public boolean flagged = false;
-        public boolean draft = false;
-        public boolean answered = false;
-        public boolean recent = false;    // "Message is "recently" arrived in this mailbox.  This
-                                          // session is the first session to have been notified
-                                          // about this message;
-        public StoredMessage(LineReader rs) throws IOException, MailException.Malformed { super(rs); }
+
+    public static Date parseDate(String s) { return null; } // FIXME!!!
+   
+    //  use null-sender for error messages (don't send errors to the null addr)
+    public Message bounce(String reason) {
+        Log.warn(Message.class, "bounce not implemented");
+        return null;
+    }  // FIXME!
+
+    public String summary() { return "[" + envelope.from + " -> " + envelope.to + "] " + subject; }
+
+    public void dump(Stream s) {
+        s.setNewline("\r\n");
+        s.println(headers.raw);
+        s.println();
+        s.println(body);
+        s.flush();
     }
-        */
 
+    public int size()        { return headers.raw.length() + 2 /* CRLF */ + body.length(); }
+    public String toString() { return headers.raw + "\r\n" + body; }
+
+
+    // SMTP Traces //////////////////////////////////////////////////////////////////////////////
+
+    public final Trace[]     traces;
     public class Trace {
         final String returnPath;
         final Element[] elements;
-        public Trace(LineReader lr) throws Trace.Malformed, IOException {
-            String retPath = lr.readLine();
+        public Trace(Stream stream) throws Trace.Malformed {
+            String retPath = stream.readln();
             if (!retPath.startsWith("Return-Path:")) throw new Trace.Malformed("trace did not start with Return-Path header");
             returnPath = retPath.substring(12).trim();
             Vec el = new Vec();
             while(true) {
-                String s = lr.readLine();
+                String s = stream.readln();
                 if (s == null) break;
-                if (!s.startsWith("Received:")) { lr.pushback(s); break; }
+                if (!s.startsWith("Received:")) { stream.unread(s); break; }
                 s = s.substring(9).trim();
                 el.addElement(new Element(s));
             }
@@ -130,100 +153,15 @@ public class Message extends JSReflection {
         public class Malformed extends Message.Malformed { public Malformed(String s) { super(s); } }
     }
 
-    public static class Malformed extends MailException.Malformed { public Malformed(String s) { super(s); } }
-    public Message(Address envelopeFrom, Address[] envelopeTo, LineReader rs) throws IOException, MailException.Malformed {
-        this.envelopeFrom = envelopeFrom;
-        this.envelopeTo = envelopeTo;
-        this.arrival = new Date();
-        this.headers = new CaseInsensitiveHash();
-        String key = null;
-        StringBuffer all = new StringBuffer();
-        Date date = null;
-        Address to = null, from = null, replyto = null;
-        String subject = null, messageid = null;
-        Vec cc = new Vec(), bcc = new Vec(), resent = new Vec(), traces = new Vec();
-        for(String s = rs.readLine(); s != null && !s.equals(""); s = rs.readLine()) {
-            all.append(s);
-            all.append("\r\n");
-            if (s.length() == 0 || Character.isSpace(s.charAt(0))) {
-                if (key == null) throw new Malformed("Message began with a blank line; no headers");
-                headers.put(key, headers.get(key) + s);
-                continue;
-            }
-            if (s.indexOf(':') == -1) throw new Malformed("Header line does not contain colon: " + s);
-            key = s.substring(0, s.indexOf(':'));
-            for(int i=0; i<key.length(); i++)
-                if (key.charAt(i) < 33 || key.charAt(i) > 126)
-                    throw new Malformed("Header key \""+key+"\" contains invalid character \"" + key.charAt(i) + "\"");
-            String val = s.substring(s.indexOf(':') + 1).trim();
-            while(Character.isSpace(val.charAt(0))) val = val.substring(1);
-            if (key.startsWith("Resent-")) {
-                if (key.startsWith("Resent-From")) resent.addElement(new Hashtable());
-                ((Hashtable)resent.lastElement()).put(key.substring(7), val);
-            } else if (key.startsWith("Return-Path:")) {
-                rs.pushback(s); traces.addElement(new Trace(rs));
-            } else {
-                // just append it to the previous one; valid for Comments/Keywords
-                if (headers.get(key) != null) val = headers.get(key) + " " + val;
-                headers.put(key, val);
-            }            
-        }
+    public static class Malformed extends Exception { public Malformed(String s) { super(s); } }
 
-        this.date      = (Date)headers.get("Date");
-        this.to        = new Address((String)headers.get("To"));  // FIXME what if null?
-        this.from      = headers.get("From") == null     ? envelopeFrom : new Address((String)headers.get("From"));
-        this.replyto   = headers.get("Reply-To") == null ? null : new Address((String)headers.get("Reply-To"));
-        this.subject   = (String)headers.get("Subject");
-        this.messageid = (String)headers.get("Message-Id");
-        if (headers.get("Cc") != null) {
-            StringTokenizer st = new StringTokenizer((String)headers.get("Cc"));
-            this.cc = new Address[st.countTokens()];
-            for(int i=0; i<this.cc.length; i++) this.cc[i] = new Address(st.nextToken());
-        } else {
-            this.cc = new Address[0];
-        }
-        if (headers.get("Bcc") != null) {
-            StringTokenizer st = new StringTokenizer((String)headers.get("Bcc"));
-            this.bcc = new Address[st.countTokens()];
-            for(int i=0; i<this.bcc.length; i++) this.bcc[i] = new Address(st.nextToken());
-        } else {
-            this.bcc = new Address[0];
-        }
-        resent.copyInto(this.resent = new Hashtable[resent.size()]);
-        traces.copyInto(this.traces = new Trace[traces.size()]);
-        allHeaders = all.toString();
-        StringBuffer body = new StringBuffer();
-        int lines = 0;
-        for(String s = rs.readLine();; s = rs.readLine()) { if (s == null) break; lines++; body.append(s + "\r\n"); }
-        this.lines = lines;
-        this.body = body.toString();
-    }
-
-    // http://www.jwz.org/doc/mid.html
-    private static final Random random = new Random();
-    public static String generateFreshMessageId() {
-        StringBuffer ret = new StringBuffer();
-        ret.append('<');
-        ret.append(Base36.encode(System.currentTimeMillis()));
-        ret.append('.');
-        ret.append(Base36.encode(random.nextLong()));
-        ret.append('.');
-        try { ret.append(InetAddress.getLocalHost().getHostName()); } catch (UnknownHostException e) { /* DELIBERATE */ }
-        ret.append('>');
-        return ret.toString();
-    }
-
-    public String summary() {
-        return
-            "          Subject: " + subject + "\n" +
-            "     EnvelopeFrom: " + envelopeFrom + "\n" +
-            "       EnvelopeTo: " + envelopeTo + "\n" +
-            "        MessageId: " + messageid;
-    }
-
-    public Message bounce(String reason) {
-        //  use null-sender for error messages (don't send errors to the null addr)
-        // FIXME
-        throw new RuntimeException("bounce not implemented");
-    }
 }
+
+        /*
+            if (key.startsWith("Resent-")) {
+                if (resent.size() == 0 || key.startsWith("Resent-From")) resent.addElement(new Hashtable());
+                ((Hashtable)resent.lastElement()).put(key.substring(7), val);
+            } else if (key.startsWith("Return-Path")) {
+                stream.unread(s);
+                traces.addElement(new Trace(stream));
+        */