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