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