resolve
[org.ibex.mail.git] / src / org / ibex / mail / Message.java
index 85ab516..46435f3 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.*;
 
-// 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
+// FIXME: messages must NEVER contain 8-bit binary data; this is a violation of IMAP
+// FIXME: RFC822 1,000-char limit per line [soft line limit (suggested): 78 chars /  hard line limit: 998 chars]
 
-// FEATURE: MIME RFC2045, 2046, 2049
 // 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 {
+/** 
+ *  [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 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 Headers //////////////////////////////////////////////////////////////////////////////
 
-    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;
+    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 final Address envelopeFrom;
-    public final Address[] envelopeTo;
-
-    public final Date arrival;         // when the message first arrived at this machine
-    
-    public void dump(OutputStream os) throws IOException {
-        Writer w = new OutputStreamWriter(os);
-        w.write(allHeaders);
-        w.write("\r\n");
-        w.write(body);
-        w.flush();
-    }
+    public static Message newMessage(Fountain in) throws Malformed { return new Message(in); }
 
+    public Message reply(Fountain in, Address from, boolean includeReInSubject) throws Malformed {
         /*
-    public static class StoredMessage extends Message {
-        public int uid;
-        public boolean deleted = false;
-        public boolean read = false;
-        public boolean answered = false;
-        public StoredMessage(LineReader rs) throws IOException, MailException.Malformed { super(rs); }
-    }
+       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;
+       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;
         */
+        // FIXME
+        return null;
+    }
 
-    public class Trace {
-        final String returnPath;
-        final Element[] elements;
-        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));
+    // 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;
             }
-            elements = new Element[el.size()];
-            el.copyInto(elements);
+            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 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
-            }
+        for(String s = stream.readln(); s != null; s = stream.readln()) {
+            sb.append(s);
+            sb.append("\r\n");
         }
-        public class Malformed extends Message.Malformed { public Malformed(String s) { super(s); } }
+        return new Message(new Fountain.StringFountain(sb.toString()));
     }
 
-    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 Hashtable();
-        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<s.length(); i++)
-                if (s.charAt(i) < 33 || s.charAt(i) > 126)
-                    throw new Malformed("Header key contains invalid character \"" + s.charAt(i) + "\"");
-            String val = s.substring(0, s.indexOf(':'));
-            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);
-            }            
-        }
-
-        this.date      = (Date)headers.get("Date");
-        this.to        = new Address((String)headers.get("To"));
-        this.from      = new Address((String)headers.get("From"));
-        this.replyto   = 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();
-        for(String s = rs.readLine();; s = rs.readLine()) { if (s == null) break; else body.append(s + "\r\n"); }
-        this.body = body.toString();
+    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"));
+        this.arrival      = this.date; // FIXME wrong; grab this from traces?
     }
 
+
+    // Helpers /////////////////////////////////////////////////////////////////////////////
+
     // http://www.jwz.org/doc/mid.html
     private static final Random random = new Random();
     public static String generateFreshMessageId() {
@@ -176,17 +120,71 @@ public class Message extends JSReflection {
         return ret.toString();
     }
 
+    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)
+v v v v v v v
+    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.Original(headers.getStream());
+        h = h.set(new String[] {
+            "Envelope-To", envelopeFrom.toString(),
+            "Return-Path", "<>",
+            "From",        "MAILER-DAEMON <>",
+            "To",          envelopeFrom.toString(),
+            "Subject",     "failure notice"
+        });
+
+        String error =
+            "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(new Fountain.Concatenate(new Fountain.StringFountain(h.getString()+"\r\n"+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;
+        }
+    }
+*************
+v v v v v v v
+    public Message bounce(String reason) {
+        Log.warn(Message.class, "bounce not implemented");
+        return null;
+    }  // FIXME!
+    
+*************
+    public Message bounce(String reason) {
+        Log.warn(Message.class, "bounce not implemented");
+    }  // FIXME!
+    
+^ ^ ^ ^ ^ ^ ^
     public String summary() {
         return
             "          Subject: " + subject + "\n" +
-            "     EnvelopeFrom: " + envelopeFrom + "\n" +
-            "       EnvelopeTo: " + envelopeTo + "\n" +
+            "     EnvelopeFrom: " + envelope.from + "\n" +
+            "       EnvelopeTo: " + envelope.to + "\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");
-    }
+    public String toString() { throw new RuntimeException("Message.toString() called"); }
+    public String summary() { return "[" + envelopeFrom + " -> " + envelopeTo + "] " + subject; }
+
+    public static class Malformed extends MailException { public Malformed(String s) { super(s); } }
 }
+