correct exchange of from and to
[org.ibex.mail.git] / src / org / ibex / mail / Message.java
index 22d94dd..c9fc2ae 100644 (file)
 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
-// 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
+import org.ibex.crypto.*;
+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
+// 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 {
-
-    public final String allHeaders;   // pristine headers
-    public final Hashtable headers;   // hash of headers (not including resent's and traces)
-
-    // parsed header fields
-    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;
-    public final Hashtable[] resent;
-    public final Trace[] traces;
+// FEATURE: lazy body
+// FIXME RFC822 1,000-char limit per line
 
-    // envelope fields
-    public final Address envelopeFrom;
-    public final Address[] envelopeTo;
+/** 
+ *  [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 {
 
-    public static class StoredMessage extends Message {
-        public final int uid;
-        public boolean deleted = false;
-        public boolean read = false;
-        public boolean answered = false;
-    }
+    // Envelope //////////////////////////////////////////////////////////////////////////////
 
-    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 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.get("X-org.ibex.mail.headers.envelope.To"))   : e.to;
+            Address from = e.from == null ? Address.parse(h.get("X-org.ibex.mail.headers.envelope.From")) : e.from;
+            return new Envelope(from, to, e.arrival);
         }
     }
 
-    public class Trace {
-        final String returnPath = null;
-        final Element[] elements;
-        public class Element {
-            final String fromDomain;
-            final String fromIP;
-            final String toDomain;
-            final String forWhom;
-            final Date date;
-        }
-    }
 
-    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;
-            }
-        }
-    }
+    // Parsed Headers //////////////////////////////////////////////////////////////////////////////
 
-    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);
-
-            if (headers.get(key) != null)
-                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                    
-                } 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();
+    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 int         lines;                   // lines in the body  FIXME not accurate anymore
+
+
+    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.get("To") == null       ? envelope.to    : Address.parse(headers.get("To"));
+        this.from         = headers.get("From") == null     ? envelope.from  : Address.parse(headers.get("From"));
+        this.replyto      = headers.get("Reply-To") == null ? null           : Address.parse(headers.get("Reply-To"));
+        this.subject      = headers.get("Subject");
+        this.messageid    = headers.get("Message-Id");
+        this.cc           = Address.list(headers.get("Cc"));
+        this.bcc          = Address.list(headers.get("BCc"));
+        this.date         = parseDate(headers.get("Date"));
+        this.lines        = 0; /* FIMXE */
+        resent.copyInto(this.resent = new Hashtable[resent.size()]);
+        traces.copyInto(this.traces = new Trace[traces.size()]);
     }
 
+
+    // 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('<');
@@ -136,5 +93,81 @@ public class Message {
         return ret.toString();
     }
 
-    private static final Random random = new Random();
+    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) { throw new RuntimeException("bounce not implemented"); }  // FIXME!
+    public String summary() {
+        return
+            "          Subject: " + subject + "\n" +
+            "     EnvelopeFrom: " + envelope.from + "\n" +
+            "       EnvelopeTo: " + envelope.to + "\n" +
+            "        MessageId: " + messageid;
+    }
+
+    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(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 = stream.readln();
+                if (s == null) break;
+                if (!s.startsWith("Received:")) { stream.unread(s); break; }
+                s = s.substring(9).trim();
+                el.addElement(new Element(s));
+            }
+            elements = new Element[el.size()];
+            el.copyInto(elements);
+        }
+        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 static class Malformed extends Exception { public Malformed(String s) { super(s); } }
+
 }
+
+        /*
+            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));
+        */