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