src/org/ibex/mail/protocol/IMAP.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.io.*;
   7 import org.ibex.crypto.*;
   8 import org.ibex.jinetd.Listener;
   9 import org.ibex.mail.*;
  10 import org.ibex.util.*;
  11 import org.ibex.mail.target.*;
  12 import java.util.*;
  13 import java.net.*;
  14 import java.text.*;
  15 import java.io.*;
  16
  17 // FIXME: this is valid    LSUB "" asdfdas%*%*%*%*SFEFGWEF
  18 // FIXME: be very careful about where/when we quotify stuff
  19 // FIXME: 'UID FOO 100:*' must match at least one message even if all UIDs less than 100
  20 // FIXME: LIST should return INBOX if applicable
  21
  22 // Relevant RFC's:
  23 //   RFC 2060: IMAPv4
  24 //   RFC 3501: IMAPv4 with clarifications
  25 //   RFC 3691: UNSELECT
  26 //   RFC 2971: ID
  27
  28 // FEATURE: make sure we're being case-insensitive enough; probably want to upcase atom()
  29 // FEATURE: MIME-queries and BODYSTRUCTURE
  30 // FEATURE: READ-WRITE / READ-ONLY status on SELECT
  31 // FEATURE: pipelining
  32 // FEATURE: support [charset]
  33 // FEATURE: \Noselect
  34 // FEATURE: subscriptions
  35 // FEATURE: tune for efficiency
  36 // FEATURE: STARTTLS
  37 // FEATURE: asynchronous client notifications (need to re-read RFC)
  38
  39 public class IMAP {
  40
  41     public IMAP() { }
  42     public static final float version = (float)0.2;
  43
  44     // FIXME this is evil
  45     public static String getBodyString(Message m) {
  46         StringBuffer sb = new StringBuffer();
  47         m.getStream().transcribe(sb);
  48         return sb.toString();
  49     }
  50
  51     // API Class //////////////////////////////////////////////////////////////////////////////
  52
  53     public static interface Client {
  54         public void expunge(int uid);
  55         public void list(char separator, String mailbox, boolean lsub, boolean phantom);
  56         public void fetch(int num, int flags, int size, Message m, int muid);  // m may be null or incomplete
  57     }
  58
  59     public static interface Server {
  60         public void      setClient(IMAP.Client client);
  61         public String[]  capability();
  62         public Hashtable id(Hashtable clientId);
  63         public void      copy(Query q, String to);
  64         public void      logout();
  65         public void      unselect();
  66         public void      delete(String m);
  67         public void      create(String m);
  68         public void      append(String m, int flags, Date arrival, String body);
  69         public void      check();
  70         public void      noop();
  71         public void      close();
  72         public void      subscribe(String mailbox);
  73         public void      unsubscribe(String mailbox);
  74         public int       unseen(String mailbox);
  75         public int       recent(String mailbox);
  76         public int       count(String mailbox);
  77         public int       count();
  78         public int       maxuid();
  79         public int       uidNext(String mailbox);
  80         public int       uidValidity(String mailbox);
  81         public int[]     search(Query q, boolean uid);
  82         public void      rename(String from, String to);
  83         public void      select(String mailbox, boolean examineOnly);
  84         public void      setFlags(Query q, int flags, boolean uid, boolean silent);
  85         public void      removeFlags(Query q, int flags, boolean uid, boolean silent);
  86         public void      addFlags(Query q, int flags, boolean uid, boolean silent);
  87         public void      expunge();
  88         public void      fetch(Query q, int spec, String[] headers, int start, int end, boolean uid);
  89         public void      lsub(String start, String ref);
  90         public void      list(String start, String ref);
  91         public static class Exn extends MailException { public Exn(String s) { super(s); } }
  92         public static class Bad extends Exn { public Bad(String s) { super(s); } }
  93         public static class No extends Exn { public No(String s) { super(s); } }
  94     }
  95
  96
  97     // MailboxWrapper //////////////////////////////////////////////////////////////////////////////
  98
  99     /** wraps an IMAP.Server interface around a Mailbox */
 100     public static class MailboxWrapper implements Server {
 101
 102         public static final char sep = '.';
 103
 104         Mailbox inbox = null;
 105         Mailbox selected = null;
 106         Mailbox root = null;
 107         Mailbox selected() { if (selected == null) throw new Bad("no mailbox selected"); return selected; }
 108         final Login auth;
 109         final Client client;
 110
 111         public MailboxWrapper(Login auth, Client c) { this.auth=auth; this.client=c;}
 112         public void setClient(IMAP.Client client) { }
 113
 114         private Mailbox mailbox(String name, boolean create) { return mailbox(name, create, true); }
 115         private Mailbox mailbox(String name, boolean create, boolean throwexn) {
 116             if (name.equalsIgnoreCase("inbox")) return inbox;
 117             Mailbox m = root;
 118             for(StringTokenizer st = new StringTokenizer(name, sep + ""); st.hasMoreTokens();)
 119                 if ((m = m.slash(st.nextToken(), create)) == null) {
 120                     if (throwexn) throw new Server.No("no such mailbox " + name);
 121                     return null;
 122                 }
 123             return m;
 124         }
 125
 126         // FEATURE: not accurate when a wildcard and subsequent non-wildcards both match a single component
 127         public void lsub(String start, String ref) { list(start, ref, true); }
 128         public void list(String start, String ref) { list(start, ref, false); }
 129         public void list(String start, String ref, boolean lsub) {
 130             if (ref.length() == 0) { client.list(sep, start, lsub, false); return; }
 131             while (start.endsWith(""+sep)) start = start.substring(0, start.length() - 1);
 132             if (ref.endsWith("%")) ref = ref + sep;
 133             String[] children = (start.length() == 0 ? root : mailbox(start, false)).children();
 134             for(int i=0; i<children.length; i++) {
 135                 String s = children[i], pre = ref, kid = start + (start.length() > 0 ? sep+"" : "") + s;
 136                 if (mailbox(kid, false) == null) continue;
 137                 boolean phantom = mailbox(kid, false).phantom();
 138                 while(true) {
 139                     if (pre.length() == 0) {
 140                         if (s.length() == 0)       client.list(sep, kid, lsub, phantom);
 141                     } else switch(pre.charAt(0)) {
 142                         case sep:        if (s.length() == 0) list(kid, pre.substring(1), lsub);                    break;
 143                         case '%':        client.list(sep,kid,lsub,phantom);pre=pre.substring(1); s = "";            continue;
 144                         case '*':        client.list(sep,kid,lsub,phantom);list(kid,pre,lsub);pre=pre.substring(1); break;
 145                         default:         if (s.length()==0)                                                         break;
 146                                          if (s.charAt(0) != pre.charAt(0))                                          break;
 147                                          s = s.substring(1); pre = pre.substring(1);                                continue;
 148                     }
 149                     break;
 150                 }
 151             }
 152         }
 153
 154         public String[] capability() { return new String[] { "IMAP4rev1" , "UNSELECT", "ID" }; }
 155         public Hashtable id(Hashtable clientId) {
 156             Hashtable response = new Hashtable();
 157             response.put("name", IMAP.class.getName());
 158             response.put("version", version + "");
 159             response.put("os", System.getProperty("os.name", null));
 160             response.put("os-version", System.getProperty("os.version", null));
 161             response.put("vendor", "none");
 162             response.put("support-url", "http://mail.ibex.org/");
 163             return response;
 164         }
 165
 166         public void copy(Query q, String to) { copy(q, mailbox(to, false)); }
 167         /*  */ void copy(Query q, Mailbox to) {
 168             for(Mailbox.Iterator it=selected().iterator(q);it.next();) to.add(it.cur(), it.flags() | Mailbox.Flag.RECENT); }
 169
 170         public void unselect() { selected = null; }
 171         public void delete(String m0) { delete(mailbox(m0,false)); }
 172         public void delete(Mailbox m) { if (!m.equals(inbox)) m.destroy(false); else throw new Bad("can't delete inbox"); }
 173         public void create(String m) { mailbox(m, true, false); }
 174         public void append(String m,int f,Date a,String b) { try {
 175             mailbox(m,false).add(Message.newMessage(new Fountain.StringFountain(b)),f|Mailbox.Flag.RECENT);
 176         } catch (Message.Malformed e) { throw new No(e.getMessage()); } }
 177         public void check() { }
 178         public void noop() { }
 179         public void logout() { }
 180         public void close() { for(Mailbox.Iterator it=selected().iterator(Query.deleted()); it.next();) it.delete(); }
 181         public void expunge() { for(Mailbox.Iterator it = selected().iterator(Query.deleted());it.next();) expunge(it); }
 182         public void expunge(Mailbox.Iterator it) { client.expunge(it.uid()); it.delete(); }
 183         public void subscribe(String mailbox) { }
 184         public void unsubscribe(String mailbox) { }
 185         public int maxuid() {
 186             int ret = 0;
 187             Mailbox mb = selected();
 188             if (mb == null) return 0;
 189             for(Mailbox.Iterator it = mb.iterator(); it.next(); ) ret = it.uid();
 190             return ret;
 191         }
 192         public int unseen(String mailbox)      { return mailbox(mailbox, false).count(Query.not(Query.seen())); }
 193         public int recent(String mailbox)      { return mailbox(mailbox, false).count(Query.recent()); }
 194         public int count(String mailbox)       { return mailbox(mailbox, false).count(Query.all()); }
 195         public int count()                     { return selected().count(Query.all()); }
 196         public int uidNext(String mailbox)     { return mailbox(mailbox, false).uidNext(); }
 197         public int uidValidity(String mailbox) { return mailbox(mailbox, false).uidValidity(); }
 198         public void select(String mailbox, boolean examineOnly) {
 199             selected = mailbox(mailbox, false);
 200         }
 201
 202         public int[] search(Query q, boolean uid) {
 203             Vec.Int vec = new Vec.Int();
 204             for(Mailbox.Iterator it = selected().iterator(q); it.next();) {
 205                 vec.addElement(uid ? it.uid() : it.num());
 206                 it.recent(false);
 207             }
 208             return vec.dump();
 209         }
 210
 211         public void setFlags(Query q, int f, boolean uid, boolean silent)    { doFlags(q, f, uid, 0, silent); }
 212         public void addFlags(Query q, int f, boolean uid, boolean silent)    { doFlags(q, f, uid, 1, silent); }
 213         public void removeFlags(Query q, int f, boolean uid, boolean silent) { doFlags(q, f, uid, -1, silent); }
 214
 215         private void doFlags(Query q, int flags, boolean uid, int style, boolean silent) {
 216             for(Mailbox.Iterator it = selected().iterator(q);it.next();) {
 217                 boolean recent = it.recent();
 218                 try { throw new Exception("flags " + flags); } catch (Exception e) { Log.error(this, e); }
 219                 if (style == -1)     it.removeFlags(flags);
 220                 else if (style == 0) it.setFlags(flags);
 221                 else if (style == 1) it.addFlags(flags);
 222                 it.recent(recent);
 223                 if (!silent) client.fetch(it.num(), it.flags(), -1, null, it.uid());
 224             }
 225         }
 226         public void rename(String from0, String to) {
 227             Mailbox from = mailbox(from0, false);
 228             if (from.equals(inbox))                { from.copy(Query.all(), mailbox(to, true)); }
 229             else if (to.equalsIgnoreCase("inbox")) { from.copy(Query.all(), mailbox(to, true)); from.destroy(false); }
 230             else from.rename(to);
 231         }
 232         public void fetch(Query q, int spec, String[] headers, int start, int end, boolean uid) {
 233             for(Mailbox.Iterator it = selected().iterator(q); it.next(); ) {
 234                 Message message = ((spec & (BODYSTRUCTURE | ENVELOPE | INTERNALDATE | FIELDS | FIELDSNOT | RFC822 |
 235                                             RFC822TEXT | RFC822SIZE | HEADERNOT | HEADER)) != 0) ? it.cur() : null;
 236                 int size = message == null ? 0 : message.getLength();
 237                 client.fetch(it.num(), it.flags(), size, message, it.uid());
 238                 it.recent(false);
 239             }
 240         }
 241     }
 242
 243
 244     // Single Session Handler //////////////////////////////////////////////////////////////////////////////
 245
 246     /** takes an IMAP.Server and exposes it to the world as an IMAP server on a TCP socket */
 247     public static class Listener implements Client {
 248         String selectedName = null;
 249         Mailbox inbox = null, root = null;
 250         Server api;
 251         Parser parser = null;
 252         Connection conn = null;
 253         Login auth;
 254         public Listener(Login auth) { api = new IMAP.MailboxWrapper(this.auth = auth, this); }
 255         Parser.Token token() { return parser.token(); }
 256         void println(String s) { conn.println(s); }
 257         void newline() { parser.newline(); }
 258         Query query(int max) { return parser.query(max, maxn(true)); }
 259
 260         public void login(String u, String p) {
 261             Object ret;
 262             if ((ret = auth.login(u,p,IMAP.class)) == null) throw new Server.No("Login failed.");
 263             if (ret instanceof IMAP.Server) {
 264                 api = (IMAP.Server)ret;
 265                 api.setClient(this);
 266             } else {
 267                 Account account = (Account)ret;
 268                 ((MailboxWrapper)api).root = root = account.getMailbox(IMAP.class);
 269                 Log.warn(this, "logged in, root="+root);
 270                 ((MailboxWrapper)api).inbox = inbox = root.slash("INBOX", false);
 271                 if (inbox == null) ((MailboxWrapper)api).inbox = inbox = root;
 272             }
 273         }
 274
 275         private int maxn(boolean uid) { return uid ? api.maxuid() : api.count(); }
 276
 277         public void handleRequest(Connection conn) {
 278             this.conn = conn;
 279             parser = new Parser(conn);
 280             conn.setTimeout(30 * 60 * 1000);
 281             println("* OK " + conn.vhost + " " + IMAP.class.getName() + " IMAP4rev1 [RFC3501] v" + version + " server ready");
 282             for(String tag = null;; newline()) try {
 283                 conn.flush();
 284                 boolean uid = false;
 285                 tag = null; Parser.Token tok = token(); if (tok == null) return; tag = tok.astring();
 286                 String command = token().atom();
 287                 if (command.equalsIgnoreCase("UID")) { uid = true; command = token().atom(); }
 288                 int commandKey = ((Integer)commands.get(command.toUpperCase())).intValue();
 289                 switch(commandKey) {
 290                     case LOGIN:        login(token().astring(), token().astring()); break;
 291                     case CAPABILITY:   println("* CAPABILITY " + Printer.join(" ", api.capability())); break;
 292                     case AUTHENTICATE: throw new Server.No("AUTHENTICATE not supported");
 293                     case LOGOUT:       api.logout(); println("* BYE"); conn.close(); return;
 294                     case LIST:         api.list(token().q(), token().astring()); break; /*astring is a hack for EUDORA*/
 295                     case LSUB:         api.lsub(token().q(), token().q()); break;
 296                     case SUBSCRIBE:    api.subscribe(token().astring()); break;
 297                     case UNSUBSCRIBE:  api.unsubscribe(token().astring()); break;
 298                     case RENAME:       api.rename(token().astring(), token().astring()); break;
 299                     case COPY:         selected(); api.copy(Query.set(uid, token().set(maxn(uid))), token().astring()); break;
 300                     case DELETE:       api.delete(token().atom()); break;
 301                     case CHECK:        selected(); api.check(); break;
 302                     case NOOP:         api.noop(); break;
 303                     case CLOSE:        selected(); api.close(); break;
 304                     case EXPUNGE:      selected(); api.expunge(); break;
 305                     case UNSELECT:     selected(); api.unselect(); selected = false; break;
 306                     case CREATE:       api.create(token().astring()); break;
 307                     case FETCH:        selected(); fetch(Query.set(lastuid=uid, token().set(maxn(uid))),
 308                                                          lastfetch=token().lx(), 0, 0, 0, uid, 0); break;
 309                     case SEARCH: {
 310                         selected();
 311                         int[] result = api.search(query(maxn(uid)), uid);
 312                         /*if (result.length > 0)*/ println("* SEARCH " + Printer.join(result));
 313                         break;
 314                     }
 315                     case EXAMINE:
 316                     case SELECT: {
 317                         String mailbox = token().astring();
 318                         api.select(mailbox, commandKey==EXAMINE);
 319                         println("* FLAGS (\\Answered \\Flagged \\Deleted \\Seen \\Draft)");
 320                         println("* " + api.count(mailbox)  + " EXISTS");
 321                         println("* " + api.recent(mailbox) + " RECENT");
 322                         println("* OK [UNSEEN " + api.unseen(mailbox) + "]");
 323                         println("* OK [UIDVALIDITY " + api.uidValidity(mailbox) + "] UIDs valid");
 324                         println("* OK [UIDNEXT " + api.uidNext(mailbox) + "]");
 325                         println("* OK [PERMANENTFLAGS (\\Seen)]");
 326                         selected = true;
 327                         break; }
 328                     case STATUS: {
 329                         String mailbox = token().astring();  // hack for GNUS buggy client
 330                         Parser.Token[] list = token().l();
 331                         String response = "";
 332                         for(int i=0; i<list.length; i++) {
 333                             String s = list[i].atom().toUpperCase();
 334                             if (i>0) response += " ";
 335                             if (s.equals("MESSAGES"))    response += "MESSAGES "    + api.count(mailbox);
 336                             if (s.equals("RECENT"))      response += "RECENT "      + api.recent(mailbox);
 337                             if (s.equals("UIDNEXT"))     response += "UIDNEXT "     + api.uidNext(mailbox);
 338                             if (s.equals("UIDVALIDITY")) response += "UIDVALIDITY " + api.uidValidity(mailbox);
 339                             if (s.equals("UNSEEN"))      response += "UNSEEN "      + api.unseen(mailbox);
 340                         }
 341                         println("* STATUS " + mailbox + " (" + response + ")");
 342                         break;
 343                     }
 344                     case APPEND: {
 345                         String m = token().astring();
 346                         int flags = 0;
 347                         Date arrival = new Date();
 348                         Parser.Token t = token();
 349                         if (t.type == t.LIST)   { flags = t.flags();      t = token(); }
 350                         if (t.type != t.QUOTED) { arrival = t.datetime(); t = token(); }
 351                         api.append(m, flags, arrival, t.q());
 352                         break; }
 353                     case STORE: {
 354                         selected();
 355                         Query q = uid ? Query.uid(token().set(maxn(uid))) : Query.num(token().set(maxn(uid)));
 356                         String s = token().atom().toUpperCase();
 357                         int flags = token().flags();
 358                         if (s.equals("FLAGS"))              api.setFlags(q,    flags, uid, false);
 359                         else if (s.equals("+FLAGS"))        api.addFlags(q,    flags, uid, false);
 360                         else if (s.equals("-FLAGS"))        api.removeFlags(q, flags, uid, false);
 361                         else if (s.equals("FLAGS.SILENT"))  api.setFlags(q,    flags, uid, true);
 362                         else if (s.equals("+FLAGS.SILENT")) api.addFlags(q,    flags, uid, true);
 363                         else if (s.equals("-FLAGS.SILENT")) api.removeFlags(q, flags, uid, true);
 364                         else throw new Server.Bad("unknown STORE specifier " + s);
 365                         break; }
 366                     default: throw new Server.Bad("unrecognized command \"" + command + "\"");
 367                 }
 368                 println(tag+" OK "+command+" Completed. " +
 369                         (commandKey == LOGIN ? ("[CAPABILITY "+Printer.join(" ", api.capability())+"]") : ""));
 370                 Log.error("[imap]", conn.dumpLog());
 371             } catch (Server.Bad b) { println(tag==null ? "* BAD Invalid tag":(tag + " Bad " + b.toString()));
 372             } catch (Server.No n)  { println(tag==null?"* BAD Invalid tag":(tag+" No "  + n.toString())); }
 373         }
 374
 375         private Parser.Token[] lastfetch = null; // hack
 376         private boolean lastuid = false;  // hack
 377         private boolean selected = false;
 378         private void selected() { if (!selected) throw new Server.Bad("no mailbox selected"); }
 379
 380         // Callbacks //////////////////////////////////////////////////////////////////////////////
 381
 382         public void expunge(int uid) { println("* " + uid + " EXPUNGE"); }
 383         public void fetch(int n, int f, int size, Message m, int muid) { fetch(m, lastfetch, n, f, size, lastuid, muid); }
 384         public void list(char sep, String mb, boolean sub, boolean p) {
 385             println("* " + (sub?"LSUB":"LIST")+" ("+(p?"\\Noselect":"")+") \""+sep+"\" \""+mb+"\"");}
 386
 387         /**
 388          *   Parse a fetch request <i>or</i> emit a fetch reply.
 389          *
 390          *   To avoid duplicating tedious parsing logic, this function
 391          *   performs both of the following tasks:
 392          *      - parse the fetch request in Token[] t and return a fetch spec
 393          *      - emit a fetch reply for the parsed spec with respect to message m
 394          */
 395         private void fetch(Object o, Parser.Token[] t, int num, int flags, int size, boolean uid, int muid) {
 396             Query q   = o == null ? null : o instanceof Query ? (Query)o : null;
 397             Message m = o == null ? null : o instanceof Message ? (Message)o : null;
 398             boolean e = q == null;
 399
 400             // asynchronous flags update
 401             if (size == -1) {
 402                 println("* " + num + " FETCH (FLAGS " + Printer.flags(flags) + (uid?(" UID "+muid):"") + ")");
 403                 return;
 404             }
 405
 406             lastfetch = t;
 407             int spec = 0;                              // spec; see constants for flags
 408             String[] headers = null;
 409             int start = -1, end = -1;
 410             StringBuffer r = new StringBuffer();
 411             if (e) { r.append(num); r.append(" FETCH ("); }
 412             int initlen = r.length();
 413             if (uid) {
 414                 boolean good = false;
 415                 for(int i=0; i<t.length; i++)
 416                     if ((t[i].type == Parser.Token.QUOTED || t[i].type == Parser.Token.ATOM) &&
 417                         t[i].astring().equalsIgnoreCase("UID")) good = true;
 418                 if (!good) {
 419                     Parser.Token[] t2 = new Parser.Token[t.length + 1];
 420                     System.arraycopy(t, 0, t2, 0, t.length);
 421                     t2[t2.length - 1] = parser.token("UID");
 422                     lastfetch = (t = t2);
 423                 }
 424             }
 425             if (t.length == 0 && (t[0].type == Parser.Token.QUOTED || t[0].type == Parser.Token.ATOM)) {
 426                 if (t[0].astring().equalsIgnoreCase("ALL"))
 427                     t = new Parser.Token[] { parser.token("FLAGS"), parser.token("INTERNALDATE"),
 428                                       parser.token("ENVELOPE"), parser.token("RFC822.SIZE") };
 429                 else if (t[0].astring().equalsIgnoreCase("FULL"))
 430                     t = new Parser.Token[] { parser.token("FLAGS"), parser.token("INTERNALDATE"), parser.token("BODY"),
 431                                       parser.token("ENVELOPE"), parser.token("RFC822.SIZE") };
 432                 else if (t[0].astring().equalsIgnoreCase("FAST"))
 433                     t = new Parser.Token[] { parser.token("FLAGS"), parser.token("INTERNALDATE"),
 434                                       parser.token("RFC822.SIZE") };
 435             }
 436             for(int i=0; i<t.length; i++) {
 437                 if (r.length() > initlen) r.append(" ");
 438                 if (t[i] == null || t[i].s == null) continue;
 439                 String s = t[i].s.toUpperCase();
 440                 r.append(s.equalsIgnoreCase("BODY.PEEK")?"BODY":s);
 441                 if (s.equals("BODYSTRUCTURE")) {       spec|=BODYSTRUCTURE;if(e){r.append(" ");r.append(Printer.bodystructure(m));}
 442                 } else if (s.equals("ENVELOPE")) {     spec|=ENVELOPE;     if(e){r.append(" ");r.append(Printer.envelope(m));}
 443                 } else if (s.equals("FLAGS")) {        spec|=FLAGS;        if(e){r.append(" ");r.append(Printer.flags(flags));}
 444                 } else if (s.equals("INTERNALDATE")) { spec|=INTERNALDATE; if(e){r.append(" ");r.append(Printer.date(m.arrival));}
 445                 } else if (s.equals("RFC822")) {       spec|=RFC822;       if(e){r.append(" ");r.append(Printer.message(m));}
 446                 } else if (s.equals("RFC822.TEXT")) {  spec|=RFC822TEXT;   if(e){r.append(" ");r.append(Printer.qq(getBodyString(m)));}
 447                 } else if (s.equals("RFC822.HEADER")){ spec|=HEADER;if(e){r.append(" ");r.append(Printer.qq(m.headers.getString()+"\r\n"));}
 448                 } else if (s.equals("RFC822.SIZE")) {  spec|=RFC822SIZE;   if(e){r.append(" ");r.append(m.getLength());}
 449                 } else if (s.equals("UID")) {          spec|=UID;          if(e){r.append(" ");r.append(muid); }
 450                 } else if (!(s.equals("BODY.PEEK") || s.equals("BODY"))) { throw new Server.No("unknown fetch argument: " + s);
 451                 } else {
 452                     if (s.equalsIgnoreCase("BODY.PEEK"))   spec |= PEEK;
 453                     //else if (e) api.addFlags(Query.num(new int[] { num, num }), Mailbox.Flag.SEEN, false, false);
 454                     if (i >= t.length - 1 || t[i+1].type != Parser.Token.LIST) {
 455                         spec |= BODYSTRUCTURE;
 456                         if (e) { r.append(" "); r.append(Printer.bodystructure(m)); } continue;
 457                         //{ if (e) { r.append(" "); r.append(Printer.qq(m.body)); } continue; }
 458                     }
 459                     String payload = "";
 460                     r.append("[");
 461                     Parser.Token[] list = t[++i].l();
 462                     s = list.length == 0 ? "" : list[0].s.toUpperCase();
 463                     r.append(s);
 464                     if (list.length == 0)                   { spec |= RFC822TEXT;   if(e) payload = m.headers.getString()+"\r\n"+getBodyString(m); }
 465                     else if (s.equals("") || s.equals("1")) { spec |= RFC822TEXT;   if(e) payload = m.headers.getString()+"\r\n"+getBodyString(m); }
 466                     else if (s.equals("TEXT"))              { spec |= RFC822TEXT;   if(e) payload = getBodyString(m); }
 467                     else if (s.equals("HEADER"))            { spec |= HEADER;       if(e) payload = m.headers.getString()+"\r\n"; }
 468                     else if (s.equals("HEADER.FIELDS"))     { spec |= FIELDS;     payload=headers(r,t[i].l()[1].sl(),false,m,e); }
 469                     else if (s.equals("HEADER.FIELDS.NOT")) { spec |= FIELDSNOT;  payload=headers(r,t[i].l()[1].sl(),true,m,e); }
 470                     else if (s.equals("MIME")) {              throw new Server.Bad("MIME not supported"); }
 471                     else                                      throw new Server.Bad("unknown section type " + s);
 472                     if (i<t.length - 1 && (t[i+1].s != null && t[i+1].s.startsWith("<"))) {
 473                         i++;
 474                         s = t[i].s.substring(1, t[i].s.indexOf('>'));
 475                         int dot = s.indexOf('.');
 476                         start = dot == -1 ? Integer.parseInt(s) : Integer.parseInt(s.substring(0, s.indexOf('.')));
 477                         end = dot == -1 ? -1 : Integer.parseInt(s.substring(s.indexOf('.') + 1));
 478                         if (e) { payload = payload.substring(start, Math.min(end+1,payload.length())); r.append("<"+start+">"); }
 479                     }
 480                     if (e) { r.append("] "); r.append(Printer.qq(payload)); }
 481                 }
 482             }
 483             if (e) {
 484                 r.append(")");
 485                 println("* " + r.toString());
 486             } else {
 487                 api.fetch(q, spec, headers, start, end, uid);
 488             }
 489         }
 490
 491         private String headers(StringBuffer r, String[] headers, boolean negate, Message m, boolean e) {
 492             String payload = "";
 493             if (e) r.append(" (");
 494             if (!negate) {
 495                 if(e) for(int j=0; j<headers.length; j++) {
 496                     r.append(headers[j] + (j<headers.length-1?" ":""));
 497                     if (m.headers.get(headers[j]) != null) payload += headers[j]+": "+m.headers.get(headers[j])+"\r\n";
 498                 }
 499             } else {
 500                 throw new Server.No("HEADERS.NOT temporarily disaled");
 501                 /*
 502                 if (e) for(int j=0; j<headers.length; j++) r.append(headers[j] + (j<headers.length-1?" ":""));
 503                 if(e) { OUTER: for(Enumeration x=m.headers.keys(); x.hasMoreElements();) {
 504                     String key = (String)x.nextElement();
 505                     for(int j=0; j<headers.length; j++) if (key.equalsIgnoreCase(headers[j])) continue OUTER;
 506                     payload += key + ": " + m.headers.get(key)+"\r\n";
 507                 } }
 508                 */
 509             }
 510             if (e) r.append(")");
 511             return payload + "\r\n";
 512         }
 513
 514         private static final Hashtable commands = new Hashtable();
 515         private static final int UID = 0;          static { commands.put("UID", new Integer(UID)); }
 516         private static final int AUTHENTICATE = 1; static { commands.put("AUTHENTICATE", new Integer(AUTHENTICATE)); }
 517         private static final int LIST = 2;         static { commands.put("LIST", new Integer(LIST)); }
 518         private static final int LSUB = 3;         static { commands.put("LSUB", new Integer(LSUB)); }
 519         private static final int SUBSCRIBE = 4;    static { commands.put("SUBSCRIBE", new Integer(SUBSCRIBE)); }
 520         private static final int UNSUBSCRIBE = 5;  static { commands.put("UNSUBSCRIBE", new Integer(UNSUBSCRIBE)); }
 521         private static final int CAPABILITY = 6;   static { commands.put("CAPABILITY", new Integer(CAPABILITY)); }
 522         private static final int ID = 7;           static { commands.put("ID", new Integer(ID)); }
 523         private static final int LOGIN = 8;        static { commands.put("LOGIN", new Integer(LOGIN)); }
 524         private static final int LOGOUT = 9;       static { commands.put("LOGOUT", new Integer(LOGOUT)); }
 525         private static final int RENAME = 10;      static { commands.put("RENAME", new Integer(RENAME)); }
 526         private static final int EXAMINE = 11;     static { commands.put("EXAMINE", new Integer(EXAMINE)); }
 527         private static final int SELECT = 12;      static { commands.put("SELECT", new Integer(SELECT)); }
 528         private static final int COPY = 13;        static { commands.put("COPY", new Integer(COPY)); }
 529         private static final int DELETE = 14;      static { commands.put("DELETE", new Integer(DELETE)); }
 530         private static final int CHECK = 15;       static { commands.put("CHECK", new Integer(CHECK)); }
 531         private static final int NOOP = 16;        static { commands.put("NOOP", new Integer(NOOP)); }
 532         private static final int CLOSE = 17;       static { commands.put("CLOSE", new Integer(CLOSE)); }
 533         private static final int EXPUNGE = 18;     static { commands.put("EXPUNGE", new Integer(EXPUNGE)); }
 534         private static final int UNSELECT = 19;    static { commands.put("UNSELECT", new Integer(UNSELECT)); }
 535         private static final int CREATE = 20;      static { commands.put("CREATE", new Integer(CREATE)); }
 536         private static final int STATUS = 21;      static { commands.put("STATUS", new Integer(STATUS)); }
 537         private static final int FETCH = 22;       static { commands.put("FETCH", new Integer(FETCH)); }
 538         private static final int APPEND = 23;      static { commands.put("APPEND", new Integer(APPEND)); }
 539         private static final int STORE = 24;       static { commands.put("STORE", new Integer(STORE)); }
 540         private static final int SEARCH = 25;      static { commands.put("SEARCH", new Integer(SEARCH)); }
 541     }
 542
 543     public static class Parser {
 544         private Stream stream;
 545         public Parser(Stream from) { this.stream = from; }
 546         public Token token(String s) { return new Token(s); }
 547         protected Query query(int max, int maxuid) {
 548             String s = null;
 549             boolean not = false;
 550             Query q = null;
 551             Query ret = null;
 552             while(true) {
 553                 Parser.Token t = token(false);
 554                 if (t == null) break;
 555                 if (t.type == t.LIST) throw new Server.No("nested queries not yet supported FIXME");
 556                 else if (t.type == t.SET) return Query.num(t.set(max));
 557                 s = t.atom().toUpperCase();
 558                 if (s.equals("NOT"))   return Query.not(query(max, maxuid));
 559                 if (s.equals("OR"))    return Query.or(query(max, maxuid), query(max, maxuid));    // FIXME parse rest of list
 560                 if (s.equals("AND"))   return Query.and(query(max, maxuid), query(max, maxuid));
 561
 562                 if (s.startsWith("UN"))        { not = true; s = s.substring(2); }
 563                 if (s.equals("ANSWERED"))        q = Query.answered();
 564                 else if (s.equals("DELETED"))    q = Query.deleted();
 565                 else if (s.equals("ALL"))        q = Query.all();
 566                 else if (s.equals("DRAFT"))      q = Query.draft();
 567                 else if (s.equals("FLAGGED"))    q = Query.flagged();
 568                 else if (s.equals("RECENT"))     q = Query.recent();
 569                 else if (s.equals("SEEN"))       q = Query.seen();
 570                 else if (s.equals("OLD"))      { not = true; q = Query.recent(); }
 571                 else if (s.equals("NEW"))        q = Query.and(Query.recent(), Query.not(Query.seen()));
 572                 else if (s.equals("KEYWORD"))    q = Query.header("keyword", token().flag());
 573                 else if (s.equals("HEADER"))     q = Query.header(token().astring(), token().astring());
 574                 else if (s.equals("BCC"))        q = Query.header("bcc", token().astring());
 575                 else if (s.equals("CC"))         q = Query.header("cc", token().astring());
 576                 else if (s.equals("FROM"))       q = Query.header("from", token().astring());
 577                 else if (s.equals("TO"))         q = Query.header("to", token().astring());
 578                 else if (s.equals("SUBJECT"))    q = Query.header("subject", token().astring());
 579                 else if (s.equals("LARGER"))     q = Query.size(token().n(), Integer.MAX_VALUE);
 580                 else if (s.equals("SMALLER"))    q = Query.size(Integer.MIN_VALUE, token().n());
 581                 else if (s.equals("BODY"))       q = Query.body(token().astring());
 582                 else if (s.equals("TEXT"))       q = Query.full(token().astring());
 583                 else if (s.equals("BEFORE"))     q = Query.arrival(new Date(0), token().date());
 584                 else if (s.equals("SINCE"))      q = Query.arrival(token().date(), new Date(Long.MAX_VALUE));
 585                 else if (s.equals("ON"))       { Date d = token().date(); q = Query.arrival(d, new Date(d.getTime() + 24 * 60 * 60)); }
 586                 else if (s.equals("SENTBEFORE")) q = Query.sent(new Date(0), token().date());
 587                 else if (s.equals("SENTSINCE"))  q = Query.sent(token().date(), new Date(Long.MAX_VALUE));
 588                 else if (s.equals("SENTON"))   { Date d = token().date(); q = Query.sent(d, new Date(d.getTime() + 24 * 60 * 60)); }
 589                 else if (s.equals("UID"))        q = Query.uid(token().set(max));
 590                 q = not ? Query.not(q) : q;
 591                 ret = ret == null ? q : Query.and(ret, q);
 592             }
 593             return ret;
 594         }
 595
 596         private static void bad(String s) { throw new Server.Bad(s); }
 597         class Token {
 598             public final byte type;
 599             private final String s;
 600             private final Parser.Token[] l;
 601             private final int n;
 602             private static final byte NIL = 0, LIST = 1, QUOTED = 2, NUMBER = 3, ATOM = 4, BAREWORD = 5, SET = 6;
 603             public Token()                         { this.s = null; n = 0;      l = null; type = NIL; }
 604             public Token(String s)                 { this(s, false); }
 605             public Token(String s, boolean quoted) { this.s = s;    n = 0;      l = null; type = quoted ? QUOTED : ATOM;  }
 606             public Token(Parser.Token[] list)      { this.s = null; n = 0;      l = list; type = LIST; }
 607             public Token(int number)               { this.s = null; n = number; l = null; type = NUMBER; }
 608
 609             public String   flag()    { if (type != ATOM) bad("expected a flag"); return s; }
 610             public int      n()       { if (type != NUMBER) bad("expected number"); return n; }
 611             public int      nz()      { int n = n(); if (n == 0) bad("expected nonzero number"); return n; }
 612             public String   q()       { if (type == NIL) return null; if (type != QUOTED) bad("expected qstring"); return s; }
 613             public Parser.Token[]  l()       { if (type == NIL) return null; if (type != LIST) bad("expected list"); return l; }
 614             public Parser.Token[]  lx()      {
 615                 if (type == LIST) return l;
 616                 Vec v = new Vec();
 617                 v.addElement(this);
 618                 while(true) {
 619                     Parser.Token t = token(false);
 620                     if (t == null) break;
 621                     v.addElement(t);
 622                 }
 623                 Parser.Token[] ret = new Parser.Token[v.size()];
 624                 v.copyInto(ret);
 625                 return ret;
 626             }
 627             public String   nstring() { if (type==NIL) return null; if (type!=QUOTED) bad("expected nstring"); return s; }
 628             public String   astring() {
 629                 if (type != ATOM && type != QUOTED) bad("expected atom or string");
 630                 if (s == null) bad("astring cannot be null");
 631                 return s; }
 632             public String[] sl() {
 633                 if (type == NIL) return null;
 634                 if (type != LIST) bad("expected list");
 635                 String[] ret = new String[l.length];
 636                 for(int i=0; i<ret.length; i++) ret[i] = l[i].s;
 637                 return ret;
 638             }
 639             public int flags() {
 640                 if (type != LIST) bad("expected flag list");
 641                 int ret = 0;
 642                 for(int i=0; i<l.length; i++) {
 643                     String flag = l[i].s;
 644                     if (flag.equals("\\Deleted"))       ret |= Mailbox.Flag.DELETED;
 645                     else if (flag.equals("\\Seen"))     ret |= Mailbox.Flag.SEEN;
 646                     else if (flag.equals("\\Flagged"))  ret |= Mailbox.Flag.FLAGGED;
 647                     else if (flag.equals("\\Draft"))    ret |= Mailbox.Flag.DRAFT;
 648                     else if (flag.equals("\\Answered")) ret |= Mailbox.Flag.ANSWERED;
 649                     else if (flag.equals("\\Recent"))   ret |= Mailbox.Flag.RECENT;
 650                 }
 651                 return ret;
 652             }
 653             public int[] set(int largest) {
 654                 if (type != ATOM) bad("expected a messageid set");
 655                 Vec.Int ids = new Vec.Int();
 656                 StringTokenizer st = new StringTokenizer(s, ",");
 657                 while(st.hasMoreTokens()) {
 658                     String s = st.nextToken();
 659                     if (s.indexOf(':') == -1) {
 660                         if (s.equals("*")) {
 661                             ids.addElement(largest);
 662                             ids.addElement(largest);
 663                         } else {
 664                             ids.addElement(Integer.parseInt(s));
 665                             ids.addElement(Integer.parseInt(s));
 666                         }
 667                         continue; }
 668                     int start = Integer.parseInt(s.substring(0, s.indexOf(':')));
 669                     String end_s = s.substring(s.indexOf(':')+1);
 670                     int end = end_s.equals("*") ? largest : Integer.parseInt(end_s);
 671                     for(int j=Math.min(start,end); j<=Math.max(start,end); j++) {
 672                         ids.addElement(j);
 673                         ids.addElement(j);
 674                     }
 675                 }
 676                 return ids.dump();
 677             }
 678             public Date date() {
 679                 if (type != QUOTED && type != ATOM) bad("Expected quoted or unquoted date");
 680                 try { return new SimpleDateFormat("dd-MMM-yyyy").parse(s);
 681                 } catch (ParseException p) { throw new Server.Bad("invalid date format; " + p); }
 682             }
 683             public Date datetime() {
 684                 if (type != QUOTED) bad("Expected quoted datetime");
 685                 try { return new SimpleDateFormat("dd-MM-yyyy hh:mm:ss zzzz").parse(s.trim());
 686                 } catch (ParseException p) { throw new Server.Bad("invalid datetime format " + s + " : " + p); }
 687             }
 688             public String atom() {
 689                 if (type != ATOM) bad("expected atom");
 690                 for(int i=0; i<s.length(); i++) {
 691                     char c = s.charAt(i);
 692                     if (c == '(' || c == ')' || c == '{' || c == ' ' || c == '%' || c == '*' || c == '\"' | c == '\\')
 693                         bad("invalid char in atom: " + c);
 694                 }
 695                 return s;
 696             }
 697         }
 698
 699         public void newline() {
 700             while (stream.peekc() == '\r' || stream.peekc() == '\n' || stream.peekc() == ' ') {
 701                 for(char c = stream.peekc(); c == ' ';) { stream.getc(); c = stream.peekc(); };
 702                 for(char c = stream.peekc(); c == '\r' || c == '\n';) { stream.getc(); c = stream.peekc(); };
 703             }
 704         }
 705
 706         public Token token() { return token(true); }
 707         public Token token(boolean freak) {
 708             Vec toks = new Vec();
 709             StringBuffer sb = new StringBuffer();
 710             char c = stream.getc(); while (c == ' ') c = stream.getc();
 711             if (c == '\r' || c == '\n') { if (freak) bad("unexpected end of line"); return null; }
 712             else if (c == '{') {
 713                 while(stream.peekc() != '}') sb.append(stream.getc());
 714                 stream.getc();
 715                 stream.println("+ Ready when you are...");
 716                 int octets = Integer.parseInt(sb.toString());
 717                 while(stream.peekc() == ' ') stream.getc();   // whitespace
 718                 while(stream.peekc() == '\n' || stream.peekc() == '\r') stream.getc();
 719                 byte[] bytes = new byte[octets];
 720                 int numread = 0;
 721                 while(numread < bytes.length) {
 722                     int n = stream.read(bytes, numread, bytes.length - numread);
 723                     if (n == -1) bad("end of stream while reading IMAP qstring");
 724                     numread += n;
 725                 }
 726                 return new Token(new String(bytes), true);
 727             } else if (c == '\"') {
 728                 while(true) {
 729                     c = stream.getc();
 730                     if (c == '\\') sb.append(stream.getc());
 731                     else if (c == '\"') break;
 732                     else sb.append(c);
 733                 }
 734                 return new Token(sb.toString(), true);
 735
 736                 // NOTE: this is technically a violation of the IMAP grammar, since atoms like FOO[BAR should be legal
 737             } else if (c == ']' || c == ')') { return null;
 738             } else if (c == '[' || c == '(') {
 739                 Token t;
 740                 do { t = token(); if (t != null) toks.addElement(t); } while (t != null);
 741                 Token[] ret = new Token[toks.size()];
 742                 toks.copyInto(ret);
 743                 return new Token(ret);
 744
 745             } else while(true) {
 746                 sb.append(c);
 747                 c = stream.peekc();
 748                 if (c == ' ' || c == '\"' || c == '(' || c == ')' || c == '[' || c == ']' ||
 749                     c == '{' || c == '\n' || c == '\r')
 750                     return new Token(sb.toString(), false);
 751                 stream.getc();
 752             }
 753         }
 754     }
 755
 756     public static class Printer {
 757             static String quotify(String s){
 758                 return s==null?"NIL":"\""+s.replaceAll("\\\\","\\\\").replaceAll("\"","\\\\\"")+"\"";}
 759             static String quotify(Date d) {
 760                 return new SimpleDateFormat("dd-MMM-yyyy HH:mm:ss +zzzz").format(d); }
 761             static String address(Address a) {
 762                 return"("+quotify(a.description)+" NIL "+quotify(a.user)+" "+quotify(a.host)+")"; }
 763             public static String addressList(Object a) {
 764                 if (a == null) return "NIL";
 765                 if (a instanceof Address) return "("+address((Address)a)+")";
 766                 if (a instanceof String) return "("+address(Address.parse((String)a))+")";
 767                 Address[] aa = (Address[])a;
 768                 StringBuffer ret = new StringBuffer();
 769                 ret.append("(");
 770                 for(int i=0; i<aa.length; i++) { ret.append(aa[i]); if (i < aa.length - 1) ret.append(" "); }
 771                 ret.append(")");
 772                 return ret.toString();
 773             }
 774             static String flags(Mailbox.Iterator it) {
 775                 return
 776                     (it.deleted()  ? "\\Deleted "  : "") +
 777                     (it.seen()     ? "\\Seen "     : "") +
 778                     (it.flagged()  ? "\\Flagged "  : "") +
 779                     (it.draft()    ? "\\Draft "    : "") +
 780                     (it.answered() ? "\\Answered " : "") +
 781                     (it.recent()   ? "\\Recent "   : "");
 782         }
 783         static String flags(int flags) {
 784             String ret = "(" +
 785                 (((flags & Mailbox.Flag.DELETED) == Mailbox.Flag.DELETED) ? "\\Deleted "  : "") +
 786                 (((flags & Mailbox.Flag.SEEN) == Mailbox.Flag.SEEN)    ? "\\Seen "     : "") +
 787                 (((flags & Mailbox.Flag.FLAGGED) == Mailbox.Flag.FLAGGED) ? "\\Flagged "  : "") +
 788                 (((flags & Mailbox.Flag.DRAFT) == Mailbox.Flag.DRAFT)   ? "\\Draft "    : "") +
 789                 (((flags & Mailbox.Flag.ANSWERED) == Mailbox.Flag.ANSWERED)? "\\Answered " : "") +
 790                 (((flags & Mailbox.Flag.RECENT) == Mailbox.Flag.RECENT)  ? "\\Recent "   : "");
 791             if (ret.endsWith(" ")) ret = ret.substring(0, ret.length() - 1);
 792             return ret + ")";
 793         }
 794         static String bodystructure(Message m) {
 795             // FIXME
 796             return "(\"TEXT\" \"PLAIN\" (\"CHARSET\" \"ISO-8859-1\") NIL NIL \"7BIT\" "+m.getLength()+" "+m.getNumLines()+")";
 797         }
 798         static String message(Message m) { return m.toString(); }
 799         static String date(Date d) { return "\""+d.toString()+"\""; }
 800         static String envelope(Message m) {
 801             return
 802                 "(" + quotify(m.arrival.toString()) +
 803                 " " + quotify(m.subject) +
 804                 " " + addressList(m.from) +
 805                 " " + addressList(m.headers.get("sender")) +
 806                 " " + addressList(m.replyto) +
 807                 " " + addressList(m.to) +
 808                 " " + addressList(m.cc) +
 809                 " " + addressList(m.bcc) +
 810                 " " + quotify((String)m.headers.get("in-reply-to")) +
 811                 " " + quotify(m.messageid) +
 812                 ")";
 813         }
 814
 815         public static String qq(String s) {
 816             StringBuffer ret = new StringBuffer();
 817             ret.append('{');
 818             ret.append(s.getBytes().length);
 819             ret.append('}');
 820             ret.append('\r');
 821             ret.append('\n');
 822             ret.append(s);
 823             return ret.toString();
 824         }
 825
 826         private static String join(int[] nums) {
 827             StringBuffer ret = new StringBuffer();
 828             for(int i=0; i<nums.length; i++) {
 829                 ret.append(nums[i]);
 830                 if (i<nums.length-1) ret.append(' ');
 831             }
 832             return ret.toString();
 833         }
 834         private static String join(String delimit, String[] stuff) {
 835             StringBuffer ret = new StringBuffer();
 836             for(int i=0; i<stuff.length; i++) {
 837                 ret.append(stuff[i]);
 838                 if (i<stuff.length - 1) ret.append(delimit);
 839             }
 840             return ret.toString();
 841         }
 842         }
 843
 844
 845     // Main //////////////////////////////////////////////////////////////////////////////
 846
 847     public static final int
 848         PEEK=0x1, BODYSTRUCTURE=0x2, ENVELOPE=0x4, FLAGS=0x8, INTERNALDATE=0x10, FIELDS=0x800, FIELDSNOT=0x1000,
 849         RFC822=0x20, RFC822TEXT=0x40, RFC822SIZE=0x80, HEADERNOT=0x100, UID=0x200, HEADER=0x400;
 850
 851 }