src/org/ibex/mail/protocol/SMTP.java

   1 // Copyright 2000-2005 the Contributors, as shown in the revision logs.
   2 // Licensed under the Apache Public Source License 2.0 ("the License").
   3 // You may not use this file except in compliance with the License.
   4
   5 package org.ibex.mail.protocol;
   6 import org.ibex.mail.*;
   7 import org.ibex.mail.target.*;
   8 import org.ibex.util.*;
   9 import org.ibex.net.*;
  10 import org.ibex.io.*;
  11 import java.net.*;
  12 import java.io.*;
  13 import java.util.*;
  14 import java.text.*;
  15 import javax.naming.*;
  16 import javax.naming.directory.*;
  17
  18 // FIXME: better delivery cycle attempt algorithm; current one sucks
  19 // FIXME: logging: current logging sucks
  20 // FIXME: loop prevention
  21
  22 // graylisting?
  23
  24 // FEATURE: infer messageid, date, if not present (?)
  25 // FEATURE: exponential backoff on retry time?
  26 // FEATURE: RFC2822, section 4.5.1: special "postmaster" address
  27 // FEATURE: RFC2822, section 4.5.4.1: retry strategies
  28 // FEATURE: RFC2822, section 5, multiple MX records, preferences, ordering
  29 // FEATURE: RFC2822, end of 4.1.2: backslashes in headers
  30 public class SMTP {
  31
  32     public static final SimpleDateFormat dateFormat = new SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss Z");
  33     public static final int numOutgoingThreads = 5;
  34     private static final Mailbox spool =
  35         FileBasedMailbox.getFileBasedMailbox(Mailbox.STORAGE_ROOT,false).slash("spool",true).slash("smtp",true);
  36
  37     static {
  38         for(int i=0; i<numOutgoingThreads; i++)
  39             new Outgoing().start();
  40     }
  41
  42     public static void accept(Message m) throws IOException {
  43         if (!m.envelopeTo.isLocal()) Outgoing.accept(m);
  44         else                         Target.root.accept(m);
  45     }
  46
  47     public static class SMTPException extends MailException {
  48         int code;
  49         String message;
  50         public SMTPException(String s) {
  51             try {
  52                 code = Integer.parseInt(s.substring(0, s.indexOf(' ')));
  53                 message = s.substring(s.indexOf(' ')+1);
  54             } catch (NumberFormatException nfe) {
  55                 code = -1;
  56                 message = s;
  57             }
  58         }
  59         public String toString() { return "SMTP " + code + ": " + message; }
  60         public String getMessage() { return toString(); }
  61     }
  62
  63     // Server //////////////////////////////////////////////////////////////////////////////
  64
  65     public static class Server {
  66         public void handleRequest(Connection conn) {
  67             conn.setTimeout(5 * 60 * 1000);
  68             conn.setNewline("\r\n");
  69             conn.println("220 " + conn.vhost + " SMTP " + this.getClass().getName());
  70             Address from = null;
  71             Vector to = new Vector();
  72             boolean ehlo = false;
  73             String remotehost = null;
  74             for(String command = conn.readln(); ; command = conn.readln()) try {
  75                 if (command == null) return;
  76                 Log.warn(conn.getRemoteAddress()+"", command);
  77                 String c = command.toUpperCase();
  78                 if (c.startsWith("HELO"))        {
  79                     remotehost = c.substring(5).trim();
  80                     conn.println("250 HELO " + conn.vhost);
  81                     from = null; to = new Vector();
  82                 } else if (c.startsWith("EHLO")) {
  83                     remotehost = c.substring(5).trim();
  84                     conn.println("250 "+conn.vhost+" greets " + remotehost);
  85                     ehlo = true;
  86                     from = null; to = new Vector();
  87                 } else if (c.startsWith("RSET")) { conn.println("250 reset ok");           from = null; to = new Vector();
  88                 } else if (c.startsWith("HELP")) { conn.println("214 you are beyond help.  see a trained professional.");
  89                 } else if (c.startsWith("VRFY")) { conn.println("502 VRFY not supported");
  90                 } else if (c.startsWith("EXPN")) { conn.println("502 EXPN not supported");
  91                 } else if (c.startsWith("NOOP")) { conn.println("250 OK");
  92                 } else if (c.startsWith("QUIT")) { conn.println("221 " + conn.vhost + " closing connection"); return;
  93                 } else if (c.startsWith("MAIL FROM:")) {
  94                     command = command.substring(10).trim();
  95                     from = command.equals("<>") ? null : new Address(command);
  96                     conn.println("250 " + from + " is syntactically correct");
  97                 } else if (c.startsWith("RCPT TO:")) {
  98                     // some clients are broken and put RCPT first; we will tolerate this
  99                     command = command.substring(8).trim();
 100                     if(command.indexOf(' ') != -1) command = command.substring(0, command.indexOf(' '));
 101                     Address addr = new Address(command);
 102                     if (addr.isLocal()) {
 103                         // FEATURE: should check the address further and give 550 if undeliverable
 104                         conn.println("250 " + addr + " is on this machine; I will deliver it");
 105                         to.addElement(addr);
 106                     } else if (conn.getRemoteAddress().isLoopbackAddress()) {
 107                         conn.println("250 you are connected locally, so I will let you send");
 108                         to.addElement(addr);
 109                     } else {
 110                         conn.println("551 sorry, " + addr + " is not on this machine");
 111                     }
 112                 } else if (c.startsWith("DATA")) {
 113                     //if (from == null) { conn.println("503 MAIL FROM command must precede DATA"); continue; }
 114                     if (to == null || to.size()==0) { conn.println("503 RCPT TO command must precede DATA"); continue; }
 115                     conn.println("354 Enter message, ending with \".\" on a line by itself");
 116                     conn.flush();
 117                     try {
 118                         StringBuffer buf = new StringBuffer();
 119                         buf.append("Received: from " + conn.getRemoteHostname() + " (" + remotehost + ")\r\n");
 120                         buf.append("          by "+conn.vhost+" ("+SMTP.class.getName()+") with "+(ehlo?"ESMTP":"SMTP") + "\r\n");
 121                         buf.append("          for ");
 122                         // FIXME: this is leaking BCC addrs
 123                         // for(int i=0; i<to.size(); i++) buf.append(to.elementAt(i) + " ");
 124                         buf.append("; " + dateFormat.format(new Date()) + "\r\n");
 125                         while(true) {
 126                             String s = conn.readln();
 127                             if (s == null) throw new RuntimeException("connection closed");
 128                             if (s.equals(".")) break;
 129                             if (s.startsWith(".")) s = s.substring(1);
 130                             buf.append(s + "\r\n");
 131                         }
 132                         String body = buf.toString();
 133                         Message m = null;
 134                         for(int i=0; i<to.size(); i++) {
 135                             m = Message.newMessage(new Fountain.StringFountain(body), from, (Address)to.elementAt(i));
 136                             accept(m);
 137                         }
 138                         if (m != null) Log.info(SMTP.class, "accepted message: " + m.summary());
 139                         conn.println("250 message accepted");
 140                         conn.flush();
 141                         from = null; to = new Vector();
 142                     } catch (MailException.Malformed mfe) {   conn.println("501 " + mfe.toString());
 143                     } catch (MailException.MailboxFull mbf) { conn.println("452 " + mbf);
 144                     } catch (Later.LaterException le) {       conn.println("453 try again later");
 145                     } catch (IOException ioe) {
 146                         //conn.println("554 " + ioe.toString());
 147                         Log.error(this, ioe);
 148                         conn.close();
 149                         return;
 150                     }
 151                 } else                    { conn.println("500 unrecognized command"); }
 152             } catch (Message.Malformed e) { conn.println("501 " + e.toString()); }
 153         }
 154     }
 155
 156
 157     // Outgoing Mail Thread //////////////////////////////////////////////////////////////////////////////
 158
 159     public static class Outgoing extends Thread {
 160
 161         private static final HashSet deadHosts = new HashSet();
 162         public static void accept(Message m) throws IOException {
 163             if (m == null) { Log.warn(Outgoing.class, "attempted to accept(null)"); return; }
 164             String traces = m.headers.get("Received");
 165             if (traces!=null) {
 166                 int lines = 0;
 167                 for(int i=0; i<traces.length(); i++)
 168                     if (traces.charAt(i)=='\n' || traces.charAt(i)=='\r')
 169                         lines++;
 170                 if (lines > 100) { // required by rfc
 171                     Log.warn(SMTP.Outgoing.class, "Message with " + lines + " trace hops; dropping\n" + m.summary());
 172                     return;
 173                 }
 174             }
 175             synchronized(Outgoing.class) {
 176                 spool.add(m);
 177                 Outgoing.class.notifyAll();
 178             }
 179         }
 180
 181         public static boolean attempt(Message m) throws IOException {
 182             if (m.envelopeTo == null) {
 183                 Log.warn(SMTP.Outgoing.class, "aieeee, null envelopeTo: " + m.summary());
 184                 return false;
 185             }
 186             InetAddress[] mx = getMailExchangerIPs(m.envelopeTo.host);
 187             if (mx.length == 0) {
 188                 accept(m.bounce("could not resolve " + m.envelopeTo.host));
 189                 return true;
 190             }
 191             if (new Date().getTime() - m.arrival.getTime() > 1000 * 60 * 60 * 24 * 5) {
 192                 accept(m.bounce("could not send for 5 days"));
 193                 return true;
 194             }
 195             for(int i=0; i<mx.length; i++) {
 196                 //if (deadHosts.contains(mx[i])) continue;
 197                 if (attempt(m, mx[i])) { return true; }
 198             }
 199             return false;
 200         }
 201
 202         private static void check(String s, Connection conn) {
 203             if (s==null) return;
 204             while (s.length() > 3 && s.charAt(3) == '-') s = conn.readln();
 205             if (s.startsWith("4")||s.startsWith("5")) throw new SMTPException(s);
 206         }
 207         private static boolean attempt(final Message m, final InetAddress mx) {
 208             boolean accepted = false;
 209             Connection conn = null;
 210             try {
 211                 Log.note("connecting to " + mx + "...");
 212                 conn = new Connection(new Socket(mx, 25), InetAddress.getLocalHost().getHostName());
 213                 conn.setNewline("\r\n");
 214                 conn.setTimeout(60 * 1000);
 215                 Log.note("    connected");
 216                 check(conn.readln(), conn);  // banner
 217                 try {
 218                     conn.println("EHLO " + conn.vhost);
 219                     check(conn.readln(), conn);
 220                 } catch (SMTPException smtpe) {
 221                     conn.println("HELO " + conn.vhost);
 222                     check(conn.readln(), conn);
 223                 }
 224                 if (m.envelopeFrom==null) {
 225                     Log.warn("", "MAIL FROM:<>");
 226                     conn.println("MAIL FROM:<>");  check(conn.readln(), conn);
 227                 } else {
 228                     Log.warn("", "MAIL FROM:<" + m.envelopeFrom.toString()+">");
 229                     conn.println("MAIL FROM:<" + m.envelopeFrom.toString()+">");  check(conn.readln(), conn);
 230                 }
 231                 conn.println("RCPT TO:<"   + m.envelopeTo.toString()+">");      check(conn.readln(), conn);
 232                 conn.println("DATA");                          check(conn.readln(), conn);
 233                 Headers head = m.headers;
 234                 head.remove("return-path");
 235                 head.remove("bcc");
 236                 Stream stream = head.getStream();
 237                 for(String s = stream.readln(); s!=null; s=stream.readln()) {
 238                     if (s.startsWith(".")) conn.print(".");
 239                     conn.println(s);
 240                 }
 241                 conn.println("");
 242                 stream = m.getBody().getStream();
 243                 for(String s = stream.readln(); s!=null; s=stream.readln()) {
 244                     if (s.startsWith(".")) conn.print(".");
 245                     conn.println(s);
 246                 }
 247                 conn.println(".");
 248                 String resp = conn.readln();
 249                 if (resp == null)
 250                     throw new SMTPException("server " + mx + " closed connection without accepting message");
 251                 check(resp, conn);
 252                 Log.warn(SMTP.Outgoing.class, "success: " + mx + " accepted " + m.summary() + "\n["+resp+"]");
 253                 accepted = true;
 254                 conn.close();
 255             } catch (SMTPException e) {
 256                 if (accepted) return true;
 257                 Log.warn(SMTP.Outgoing.class, "    unable to send; error=" + e);
 258                 Log.warn(SMTP.Outgoing.class, "      message: " + m.summary());
 259                 Log.warn(SMTP.Outgoing.class, e);
 260                 if (e.code >= 500 && e.code <= 599) {
 261                     try {
 262                         accept(m.bounce("unable to deliver: " + e));
 263                     } catch (Exception ex) {
 264                         Log.error(SMTP.Outgoing.class, "very serious: exception while trying to deliver bounce");
 265                         Log.error(SMTP.Outgoing.class, ex);
 266                     }
 267                     return true;
 268                 }
 269                 return false;
 270             } catch (Exception e) {
 271                 if (accepted) return true;
 272                 Log.warn(SMTP.Outgoing.class, "    unable to send; error=" + e);
 273                 Log.warn(SMTP.Outgoing.class, "      message: " + m.summary());
 274                 Log.warn(SMTP.Outgoing.class, e);
 275                 if (conn != null) Log.warn(SMTP.Outgoing.class, conn.dumpLog());
 276                 return false;
 277             } finally {
 278                 if (conn != null) conn.close();
 279             }
 280             return accepted;
 281         }
 282
 283         private static HashSet<Outgoing> threads = new HashSet<Outgoing>();
 284         private static int serials = 1;
 285         private int serial = serials++;
 286         private Mailbox.Iterator it;
 287
 288         public Outgoing() {
 289             synchronized(Outgoing.class) {
 290                 threads.add(this);
 291             }
 292         }
 293
 294         public void wake() {
 295             int count = spool.count(Query.all());
 296             Log.info(SMTP.Outgoing.class, "outgoing thread #"+serial+" woke up; " + count + " messages to send");
 297             try {
 298                 while(true) {
 299                     boolean good = false;
 300                     synchronized(Outgoing.class) {
 301                         it = spool.iterator();
 302                         OUTER: for(; it.next(); ) {
 303                             for(Outgoing o : threads)
 304                                 if (o!=this && o.it != null && o.it.uid()==it.uid())
 305                                     continue OUTER;
 306                             good = true;
 307                             break;
 308                         }
 309                     }
 310                     if (!good) break;
 311                     if (attempt(it.cur())) it.delete();
 312                 }
 313             } catch (Exception e) {
 314                 //if (e instanceof InterruptedException) throw e;
 315                 Log.error(SMTP.Outgoing.class, e);
 316             }
 317             Log.info(SMTP.Outgoing.class, "outgoing thread #"+serial+" going back to sleep");
 318             it = null;
 319         }
 320
 321         public void run() {
 322             try {
 323                 while(true) {
 324                     Log.setThreadAnnotation("[outgoing #"+serial+"] ");
 325                     wake();
 326                     synchronized(Outgoing.class) {
 327                         Outgoing.class.wait(5 * 60 * 1000);
 328                     }
 329                 }
 330             } catch (InterruptedException e) { Log.warn(this, e); }
 331         }
 332     }
 333
 334     public static InetAddress[] getMailExchangerIPs(String hostName) {
 335         InetAddress[] ret;
 336         try {
 337             Hashtable env = new Hashtable();
 338             env.put("java.naming.factory.initial", "com.sun.jndi.dns.DnsContextFactory");
 339             DirContext ictx = new InitialDirContext(env);
 340             Attributes attrs = ictx.getAttributes(hostName, new String[] { "MX" });
 341             Attribute attr = attrs.get("MX");
 342             if (attr == null) {
 343                 ret = new InetAddress[1];
 344                 try {
 345                     ret[0] = InetAddress.getByName(hostName);
 346                     return ret;
 347                 } catch (UnknownHostException uhe) {
 348                     Log.warn(SMTP.class, "no MX hosts or A record for " + hostName);
 349                     return new InetAddress[0];
 350                 }
 351             } else {
 352                 ret = new InetAddress[attr.size()];
 353                 NamingEnumeration ne = attr.getAll();
 354                 for(int i=0; ne.hasMore();) {
 355                     String mx = (String)ne.next();
 356                     // FIXME we should be sorting here
 357                     mx = mx.substring(mx.indexOf(" ") + 1);
 358                     if (mx.charAt(mx.length() - 1) == '.') mx = mx.substring(0, mx.length() - 1);
 359                     InetAddress ia = InetAddress.getByName(mx);
 360                     if (ia.equals(IP.getIP(127,0,0,1))) continue;
 361                     ret[i++] = ia;
 362                 }
 363             }
 364         } catch (Exception e) {
 365             Log.warn(SMTP.class, "couldn't find MX host for " + hostName + " due to");
 366             Log.warn(SMTP.class, e);
 367             return new InetAddress[0];
 368         }
 369         return ret;
 370     }
 371 }