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