almost there
[org.ibex.mail.git] / src / org / ibex / mail / Message.java
index 22d94dd..2aa9331 100644 (file)
@@ -1,24 +1,36 @@
 package org.ibex.mail;
-// FIXME MIME: RFC2045, 2046, 2049
-// NOTE: always use Win32 line endings
-// hard line limit: 998 chars
-// soft line limit (suggested): 78 chars
-// header fields: ascii 33-126 (but no colon)
-// field body: anything ASCII except CRLF
+import org.ibex.crypto.*;
+import org.ibex.js.*;
+import org.ibex.util.*;
+import org.ibex.mail.protocol.*;
+import java.util.*;
+import java.net.*;
+import java.io.*;
+
+// soft line limit (suggested): 78 chars /  hard line limit: 998 chars
 // folded headers: can insert CRLF anywhere that whitespace appears (before the whitespace)
-// body needs CRLF; one or the other alone is not acceptable
-// date/time parsing: see 3.3
+// date/time parsing: see spec, 3.3
+
+// 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
-public class Message {
+// FEATURE: lazy body
 
-    public final String allHeaders;   // pristine headers
-    public final Hashtable headers;   // hash of headers (not including resent's and traces)
+/** 
+ *  [immutable] This class encapsulates a message "floating in the
+ *  ether": RFC2822 data but no storage-specific flags or other
+ *  metadata.
+ */
+public class Message extends JSReflection {
+
+    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
 
-    // parsed header fields
     public final Date date;
     public final Address to;
     public final Address from;        // if multiple From entries, this is sender
@@ -30,100 +42,143 @@ public class Message {
     public final Hashtable[] resent;
     public final Trace[] traces;
 
-    // envelope fields
     public final Address envelopeFrom;
-    public final Address[] envelopeTo;
-
-    public static class StoredMessage extends Message {
-        public final int uid;
-        public boolean deleted = false;
-        public boolean read = false;
-        public boolean answered = false;
-    }
+    public final Address envelopeTo;
 
-    public static class Address {
-        public final String user;
-        public final String host;
-        public final String description;
-        public Address(String user, String host, String description) {
-            this.user = user; this.host = host; this.description = description;
-        }
-        public Address(String s) {
-            s = s.trim();
-            String descrip = null;
-            if (s.indexOf('<') != -1) {
-                if (s.indexOf('>') == -1) { /* FIXME */ }
-                descrip = s.substring(0, s.indexOf('<')) + s.substring(s.indexOf('>') + 1);
-                s = s.substring(s.indexOf('<') + 1, s.indexOf('>'));
-            }
-            if (s.indexOf('@') == -1) { /* FIXME */ }
-            description = descrip;
-            user = s.substring(0, s.indexOf('@'));
-            host = s.substring(s.indexOf('@')+1);
-        }
+    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("X-org.ibex.mail-envelopeFrom: " + envelopeFrom + "\r\n");
+        w.write("X-org.ibex.mail-envelopeTo: " + envelopeTo + "\r\n");
+        w.write(allHeaders);
+        w.write("\r\n");
+        w.write(body);
+        w.flush();
     }
 
     public class Trace {
-        final String returnPath = null;
+        final String returnPath;
         final Element[] elements;
-        public class Element {
-            final String fromDomain;
-            final String fromIP;
-            final String toDomain;
-            final String forWhom;
-            final Date date;
+        public Trace(LineReader lr) throws Trace.Malformed, IOException {
+            String retPath = lr.readLine();
+            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();
+                if (s == null) break;
+                if (!s.startsWith("Received:")) { lr.pushback(s); break; }
+                s = s.substring(9).trim();
+                el.addElement(new Element(s));
+            }
+            elements = new Element[el.size()];
+            el.copyInto(elements);
         }
-    }
-
-    public static class Base36 {
-        public static String encode(long l) {
-            StringBuffer ret = new StringBuffer();
-            while (l > 0) {
-                if ((l % 36) < 10) ret.append((char)(((int)'0') + (int)(l % 36)));
-                else ret.append((char)(((int)'A') + (int)((l % 36) - 10)));
-                l /= 36;
+        public class Element {
+             String fromDomain;
+             String fromIP;
+             String toDomain;
+             String forWhom;
+             Date date;
+            public Element(String fromDomain, String fromIP, String toDomain, String forWhom, Date date) {
+                this.fromDomain=fromDomain; this.fromIP=fromIP; this.toDomain=toDomain; this.forWhom=forWhom; this.date=date; }
+            public Element(String s) throws Trace.Malformed {
+                StringTokenizer st = new StringTokenizer(s);
+                if (!st.nextToken().equals("FROM")) throw new Trace.Malformed("trace did note have a FROM element: " + s);
+                fromDomain = st.nextToken();
+                if (!st.nextToken().equals("BY")) throw new Trace.Malformed("trace did note have a BY element: " + s);
+                toDomain = st.nextToken();
+                // FIXME not done yet
             }
         }
+        public class Malformed extends Message.Malformed { public Malformed(String s) { super(s); } }
     }
 
-    public Message(ReadStream rs) {
-        String key = null;
-        StringBuffer all = new StringBuffer();
-        for(String s = rs.readLine(); s != null && !s.equals(""); s = rs.readLine()) {
-            all.append(s);
-            all.append("\r\n");
-            if (Character.isSpace(s.charAt(0))) {
-                if (lastKey == null) { /* FIXME */ }
-                headers.put(lastKey, headers.get(lastKey) + s);
-                continue;
-            }
-            if (s.indexOf(':') == -1) { /* FIXME */ }
-
-            key = s.substring(0, s.indexOf(':'));
-            String val = s.substring(0, s.indexOf(':') + 1);
-            while(Character.isSpace(val.charAt(0))) val = val.substring(1);
+    public static class Malformed extends MailException.Malformed { public Malformed(String s) { super(s); } }
 
-            if (headers.get(key) != null)
+    public Message(Address envelopeFrom, Address envelopeTo, String s, Date arrival)
+        { this(envelopeFrom, envelopeTo, new LineReader(new StringReader(s)), arrival); }
+    public Message(Address envelopeFrom, Address envelopeTo, LineReader rs) { this(envelopeFrom, envelopeTo, rs, null); }
+    public Message(Address envelopeFrom, Address envelopeTo, LineReader rs, Date arrival) {
+        try {
+            this.arrival = arrival == null ? new Date() : arrival;
+            this.headers = new CaseInsensitiveHash();
+            Vec envelopeToHeader = new Vec();
+            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");
+                    ((CaseInsensitiveHash)headers).add(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(val.length() > 0 && Character.isSpace(val.charAt(0))) val = val.substring(1);
                 if (key.startsWith("Resent-")) {
-                    // FIXME: multi-resent headers
-                } else if (key.startsWith("Return-Path:")) {
-                    // FIXME: parse traces, see RFC2821, section 4.4                    
-                } else if (key.startsWith("Recieved:")) {
-                    // FIXME: parse traces, see RFC2821, section 4.4                    
+                    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 if (key.equals("X-org.ibex.mail.headers.envelopeFrom")) {
+                    if (envelopeFrom == null) envelopeFrom = new Address(val);
+                } else if (key.equals("X-org.ibex.mail.headers.envelopeTo")) {
+                    if (envelopeTo == null) envelopeTo = new Address(val);
                 } else {
                     // just append it to the previous one; valid for Comments/Keywords
-                    val = headers.get(key) + " " + val;
-                } 
-            
-            headers.put(key, val);
-        }
-        pristeneHeaders = all.toString();
-        StringBuffer body = new StringBuffer();
-        for(String s = rs.readLine(); s != null && !s.equals(""); s = rs.readLine()) body.append(s);
-        this.body = body.toString();
+                    if (headers.get(key) != null) val = headers.get(key) + " " + val;
+                    ((CaseInsensitiveHash)headers).add(key, val);
+                }            
+            }
+
+            // FIXME what if all are null?
+            this.to           = headers.get("To") == null   ? envelopeTo    : new Address((String)headers.get("To"));
+            this.from         = headers.get("From") == null ? envelopeFrom  : new Address((String)headers.get("From"));
+            this.envelopeFrom = envelopeFrom == null        ? this.from     : envelopeFrom;
+            this.envelopeTo   = envelopeTo == null          ? this.to       : envelopeTo;
+
+            this.date      = new Date(); // FIXME (Date)headers.get("Date");
+            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();
+        } catch (IOException e) { throw new MailException.IOException(e); }
     }
 
     // http://www.jwz.org/doc/mid.html
+    private static final Random random = new Random();
     public static String generateFreshMessageId() {
         StringBuffer ret = new StringBuffer();
         ret.append('<');
@@ -136,5 +191,24 @@ public class Message {
         return ret.toString();
     }
 
-    private static final Random random = new Random();
+    public String rfc822() { return allHeaders + "\r\n" + body; }
+    public int rfc822size() { return allHeaders.length() + 2 /* CRLF */ + body.length(); }  // FIXME: double check this
+
+    public String summary() {
+        return
+            "          Subject: " + subject + "\n" +
+            "     EnvelopeFrom: " + envelopeFrom + "\n" +
+            "       EnvelopeTo: " + envelopeTo + "\n" +
+            "        MessageId: " + messageid;
+    }
+
+    //  use null-sender for error messages (don't send errors to the null addr)
+    public Message bounce(String reason) { throw new RuntimeException("bounce not implemented"); }  // FIXME!
+
+    private static class CaseInsensitiveHash extends Hashtable {
+        public Object get(Object o) { return (o instanceof String) ? super.get(((String)o).toLowerCase()) : super.get(o); }
+        public Object put(Object k, Object v) { throw new Error("you cannot write to a CaseInsensitiveHash"); }
+        void add(Object k, Object v) { if (k instanceof String) super.put(((String)k).toLowerCase(), v); else super.put(k, v); }
+    }
+
 }