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