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