massive refactoring of Headers class
[org.ibex.mail.git] / src / org / ibex / mail / Message.java
index 96f0873..9d91a18 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;
 import org.ibex.crypto.*;
-import org.ibex.js.*;
 import org.ibex.util.*;
 import org.ibex.mail.protocol.*;
+import org.ibex.js.*;
+import org.ibex.io.*;
+import org.ibex.io.Fountain;
 import java.util.*;
 import java.net.*;
 import java.io.*;
 
-// 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
+// FIXME: body constraints (how to enforce?)
+//   - messages must NEVER contain 8-bit binary data; this is a violation of IMAP
+//   - RFC822 1,000-char limit per line [soft line limit (suggested): 78 chars /  hard line limit: 998 chars]
 
 // FEATURE: PGP-signature-parsing
-// FEATURE: mailing list header parsing
-// FEATURE: delivery status notification (and the sneaky variety)
+// FEATURE: mailing list header parsing (?)
 // FEATURE: threading as in http://www.jwz.org/doc/threading.html
 
-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
-
-    // 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 void dump(OutputStream os) {
-        Log.error(this, "not implemented");
-    }
-
-    public static class StoredMessage extends Message {
-        public StoredMessage(/*ReadStream rs*/SMTP.LineReader rs, boolean dotTerminatedLikeSMTP) throws IOException {
-            super(rs, dotTerminatedLikeSMTP); uid = -1; }
-        public final int uid;
-        public boolean deleted = false;
-        public boolean read = false;
-        public boolean answered = false;
-        public String dumpStoredForm() { throw new Error("StoredMessage.dumpStoredForm() not implemented"); };
-        public static StoredMessage undump(InputStream os) {
-            Log.error(StoredMessage.class, "not implemented");
-            return null;
-        }
+/** 
+ *  [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 {
+
+    // Parsed Headers //////////////////////////////////////////////////////////////////////////////
+
+    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 static Message newMessage(Fountain in) throws Malformed { return new Message(in); }
+
+    /*
+    public Message reply(Fountain in, Address from, boolean includeReInSubject) throws Malformed {
+       Address to = null;
+       if (to==null) to = Address.parse(headers.get("reply-to"));
+       if (to==null) to = Address.parse(headers.get("from"));
+       if (to==null) to = envelopeFrom;
+        if (to==null) throw new Malformed("cannot reply to a message without a return address");
+       Message ret = newMessage(in, from, to);
+       ret.headers.put("In-Reply-To", messageid);
+       String references = headers.get("references");
+       ret.headers.put("References", messageid + (references==null?"":(" "+references)));
+       if (includeReInSubject && subject!=null && !subject.toLowerCase().trim().startsWith("re:"))
+           headers.put("subject", "Re: "+subject);
+       return ret;
     }
-
-    public static class Address extends JSReflection {
-        public String coerceToString() { return toString(); }
-        public String toString() {
-            if (description == null || description.equals("")) return user +"@"+ host;
-            return description + " " + "<" + user +"@"+ host + ">";
-        }
-        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('>'));
+    */
+
+    // FIXME
+    //public static Message newMessage(Headers headers, Fountain body, Address from, Address to) throws Malformed {
+    //}
+
+    public static Message newMessage(Fountain in, Address from, Address to) throws Malformed {
+        StringBuffer sb = new StringBuffer();
+        if (from != null) sb.append("Return-Path: " + from.toString(true) + "\r\n");
+        Stream stream = in.getStream();
+        while(true) {
+            String s = stream.readln();
+            if (s == null || s.length() == 0) {
+                if (to != null) sb.append("Envelope-To: " + to.toString(true) + "\r\n");
+                sb.append("\r\n");
+                break;
             }
-            if (s.indexOf('@') == -1) { /* FIXME */ }
-            description = descrip;
-            user = s.substring(0, s.indexOf('@'));
-            host = s.substring(s.indexOf('@')+1);
+            if (to != null && s.toLowerCase().startsWith("envelope-to:")) continue;
+            if (s.toLowerCase().startsWith("return-path:")) continue;
+            sb.append(s);
+            sb.append("\r\n");
         }
-    }
-
-    public class Trace {
-        String returnPath = null;
-        Element[] elements;
-        public class Element {
-            // FIXME final
-            String fromDomain;
-            String fromIP;
-            String toDomain;
-            String forWhom;
-            Date date;
+        for(String s = stream.readln(); s != null; s = stream.readln()) {
+            sb.append(s);
+            sb.append("\r\n");
         }
+        return new Message(new Fountain.StringFountain(sb.toString()));
     }
 
-    // FIXME: support dotTerminatedLikeSMTP
-    public Message(/*ReadStream rs*/SMTP.LineReader rs, boolean dotTerminatedLikeSMTP) throws IOException {
-        String key = null;
-        StringBuffer all = new StringBuffer();
-        String lastKey = null;
-        replyto = null;
-        subject = null;
-        messageid = null;
-        cc = null;
-        bcc = null;
-        resent = null;
-        traces = null;
-        envelopeFrom = null;
-        envelopeTo = null;
-
-        headers = new Hashtable();
-        date = null; // FIXME
-        to = null;
-        from = null;
-        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 */
-                break;
-            }
-
-            lastKey = 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);
+    private Message(Fountain in) throws Malformed {
+        super(in);
+
+        this.envelopeTo   = headers.get("Envelope-To") != null ? Address.parse(headers.get("Envelope-To")) : null;
+        this.envelopeFrom = headers.get("Return-Path") != null ? Address.parse(headers.get("Return-Path")) : null;
+        this.to           = headers.get("To") != null ? Address.parse(headers.get("To")) : this.envelopeTo;
+        this.from         = headers.get("From") != null ? Address.parse(headers.get("From")) : this.envelopeFrom;
+        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")) == null ? new Date() : parseDate(headers.get("Date"));
+
+        // reenable this once whitelisting is moved out of javascript
+        //if (this.messageid==null)
+        //throw new RuntimeException("every RFC2822 message must have a Message-ID: header");
+
+        /*
+        // synthesize a message-id if not provided
+        this.messageid    = headers.get("Message-Id") == null ? generateFreshMessageId(sha1(in.getStream())) : headers.get("Message-Id");
+        if (headers.get("Message-Id") == null) {
+            headers = headers.set("Message-Id", this.messageid);
+            Log.warn(Message.class, "synthesizing message-id for " + summary());
         }
+        */
 
-        allHeaders = all.toString();
+        this.arrival      = this.date; // FIXME wrong; grab this from traces?
+    }
 
-        StringBuffer body = new StringBuffer();
-        for(String s = rs.readLine();; s = rs.readLine()) {
-            if (s == null || (dotTerminatedLikeSMTP && s.equals("."))) break;
-            body.append(s);
+    /*
+    private static String sha1(Stream stream) {
+        SHA1 sha1 = new SHA1();
+        byte[] b = new byte[1024];
+        while(true) {
+            int numread = stream.read(b, 0, b.length);
+            if (numread == -1) break;
+            sha1.update(b, 0, numread);
         }
-
-        this.body = body.toString();
+        byte[] results = new byte[sha1.getDigestSize()];
+        sha1.doFinal(results, 0);
+        return new String(Encode.toBase64(results));
     }
+    */
+
+
+    // Helpers /////////////////////////////////////////////////////////////////////////////
 
     // http://www.jwz.org/doc/mid.html
+    private static final Random random = new Random();
     public static String generateFreshMessageId() {
+        return generateFreshMessageId(Base36.encode(System.currentTimeMillis())+'.'+
+                                      Base36.encode(random.nextLong()));
+    }
+    public static String generateFreshMessageId(String seed) {
         StringBuffer ret = new StringBuffer();
         ret.append('<');
-        ret.append(Base36.encode(System.currentTimeMillis()));
-        ret.append('.');
-        ret.append(Base36.encode(random.nextLong()));
-        ret.append('.');
+        ret.append(seed);
+        ret.append('@');
         try { ret.append(InetAddress.getLocalHost().getHostName()); } catch (UnknownHostException e) { /* DELIBERATE */ }
         ret.append('>');
         return ret.toString();
     }
 
-    private static final Random random = new Random();
+    public static Date parseDate(String s) {
+        // FIXME!!! this must be robust
+        // date/time parsing: see spec, 3.3
+        return null;
+    }
+
+    // this is belived to be compliant with QSBMF (http://cr.yp.to/proto/qsbmf.txt)
+    public Message bounce(String reason) {
+        if (envelopeFrom==null || envelopeFrom.toString().equals("")) return null;
+
+        Log.warn(Message.class, "bouncing message due to: " + reason);
+        Headers h = new Headers(headers, new String[] {
+            "Envelope-To", envelopeFrom.toString(),
+            "Return-Path", "<>",
+            "From",        "MAILER-DAEMON <>",
+            "To",          envelopeFrom.toString(),
+            "Subject",     "failure notice"
+        });
+
+        String error =
+            "\r\n"+
+            "Hi. This is the Ibex Mail Server.  I'm afraid I wasn't able to deliver\r\n"+
+            "your message to the following addresses. This is a permanent error;\r\n"+
+            "I've given up.  Sorry it didn't work out\r\n."+
+            "\r\n"+
+            "<"+envelopeTo.toString()+">:\r\n"+
+            reason+"\r\n"+
+            "\r\n"+
+            "--- Below this line is a copy of the message.\r\n"+
+            "\r\n";
+
+        try {
+            return newMessage(Fountain.Util.concat(h, Fountain.Util.create(error), getBody()));
+        } catch (Message.Malformed e) {
+            Log.error(this, "caught Message.Malformed in Message.bounce(); this should never happen");
+            Log.error(this, e);
+            return null;
+        }
+    }
+
+    public       String toString() { throw new RuntimeException("Message.toString() called"); }
+    public final String summary() { return "[" + envelopeFrom + " -> " + envelopeTo + "] " + subject; }
+
+    public static class Malformed extends MailException { public Malformed(String s) { super(s); } }
 }
+