smarter handling of envelope-To/From
[org.ibex.mail.git] / src / org / ibex / mail / Message.java
index 22d94dd..63ef363 100644 (file)
+// Copyright 2000-2005 the Contributors, as shown in the revision logs.
+// Licensed under the Apache Public Source License 2.0 ("the License").
+// You may not use this file except in compliance with the License.
+
 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;
-
-    // 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;
-    }
+// FEATURE: lazy body
+// FIXME RFC822 1,000-char limit per line
 
-    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);
-        }
-    }
+/** 
+ *  [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 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;
-        }
-    }
+    // Parsed Headers //////////////////////////////////////////////////////////////////////////////
 
-    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 final Address     to;
+    public final Address     from;                // if multiple From entries, this is sender
+    public final Address     envelopeFrom;
+    public final Address     envelopeTo;
+    public final Date        date;
+    public final Date        arrival;
+    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 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;
+    public static Message newMessage(Stream stream) throws Malformed { return newMessage(stream, null, null); }
+    public static Message newMessage(Stream stream, Address from, Address to) throws Malformed {
+        if (from == null && to == null) return new Message(stream);
+        StringBuffer sb = new StringBuffer();
+        boolean inheaders = true;
+        if (from != null) sb.append("Return-Path: " + from.toString(true) + "\r\n");
+        while(true) {
+            String s = stream.readln();
+            if (s == null) break;
+            if (inheaders && to != null && s.toLowerCase().startsWith("envelope-to:")) continue;
+            if (inheaders && from != null && s.toLowerCase().startsWith("return-path:")) continue;
+            if (s.length() == 0 && inheaders) {
+                inheaders = false;
+                if (to != null) sb.append("Envelope-To: " + to.toString(true) + "\r\n");
             }
-            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);
+            sb.append(s);
+            sb.append("\r\n");
         }
-        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();
+        return newMessage(new Stream(sb.toString()));
+    }
+    private Message(Stream stream) throws Malformed {
+        super(stream, null, false);
+        this.envelopeTo   = headers.gets("Envelope-To") != null ? Address.parse(headers.gets("Envelope-To")) : null;
+        this.envelopeFrom = headers.gets("Return-Path") != null ? Address.parse(headers.gets("Return-Path")) : null;
+        this.to           = headers.gets("To") != null ? Address.parse(headers.gets("To")) : this.envelopeTo;
+        this.from         = headers.gets("From") != null ? Address.parse(headers.gets("From")) : this.envelopeFrom;
+        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")) == null ? new Date() : parseDate(headers.gets("Date"));
+        this.arrival      = this.date; // FIXME wrong
     }
 
+
+    // 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 +98,27 @@ 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) {
+        Log.warn(Message.class, "bounce not implemented");
+        return null;
+    }  // FIXME!
+
+    public String summary() { return "[" + envelopeFrom + " -> " + envelopeTo + "] " + 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; }
+
+    public static class Malformed extends Exception { public Malformed(String s) { super(s); } }
 }
+