1 // Copyright 2000-2005 the Contributors, as shown in the revision logs.
2 // Licensed under the Apache Public Source License 2.0 ("the License").
3 // You may not use this file except in compliance with the License.
5 package org.ibex.mail.protocol;
7 import org.ibex.crypto.*;
8 import org.ibex.jinetd.Listener;
9 import org.ibex.jinetd.Worker;
10 import org.ibex.mail.*;
11 import org.ibex.util.*;
12 import org.ibex.mail.target.*;
18 // FIXME: this is valid LSUB "" asdfdas%*%*%*%*SFEFGWEF
19 // FIXME: be very careful about where/when we quotify stuff
20 // FIXME: 'UID FOO 100:*' must match at least one message even if all UIDs less than 100
21 // FIXME: LIST should return INBOX if applicable
25 // RFC 3501: IMAPv4 with clarifications
29 // FEATURE: make sure we're being case-insensitive enough; probably want to upcase atom()
30 // FEATURE: MIME-queries and BODYSTRUCTURE
31 // FEATURE: READ-WRITE / READ-ONLY status on SELECT
32 // FEATURE: pipelining
33 // FEATURE: support [charset]
35 // FEATURE: subscriptions
36 // FEATURE: tune for efficiency
38 // FEATURE: asynchronous client notifications (need to re-read RFC)
43 public static final float version = (float)0.2;
45 // API Class //////////////////////////////////////////////////////////////////////////////
47 public static interface Client {
48 public void expunge(int uid);
49 public void list(char separator, String mailbox, boolean lsub, boolean phantom);
50 public void fetch(int num, int flags, int size, Message m, int muid); // m may be null or incomplete
53 public static interface Server {
54 public void setClient(IMAP.Client client);
55 public String[] capability();
56 public Hashtable id(Hashtable clientId);
57 public void copy(Query q, String to);
59 public void unselect();
60 public void delete(String m);
61 public void create(String m);
62 public void append(String m, int flags, Date arrival, String body);
66 public void subscribe(String mailbox);
67 public void unsubscribe(String mailbox);
68 public int unseen(String mailbox);
69 public int recent(String mailbox);
70 public int count(String mailbox);
73 public int uidNext(String mailbox);
74 public int uidValidity(String mailbox);
75 public int[] search(Query q, boolean uid);
76 public void rename(String from, String to);
77 public void select(String mailbox, boolean examineOnly);
78 public void setFlags(Query q, int flags, boolean uid, boolean silent);
79 public void removeFlags(Query q, int flags, boolean uid, boolean silent);
80 public void addFlags(Query q, int flags, boolean uid, boolean silent);
81 public void expunge();
82 public void fetch(Query q, int spec, String[] headers, int start, int end, boolean uid);
83 public void lsub(String start, String ref);
84 public void list(String start, String ref);
85 public static class Exn extends MailException { public Exn(String s) { super(s); } }
86 public static class Bad extends Exn { public Bad(String s) { super(s); } }
87 public static class No extends Exn { public No(String s) { super(s); } }
91 // MailboxWrapper //////////////////////////////////////////////////////////////////////////////
93 /** wraps an IMAP.Server interface around a Mailbox */
94 public static class MailboxWrapper implements Server {
96 public static final char sep = '.';
99 Mailbox selected = null;
101 Mailbox selected() { if (selected == null) throw new Bad("no mailbox selected"); return selected; }
105 public MailboxWrapper(Login auth, Client c) { this.auth=auth; this.client=c;}
106 public void setClient(IMAP.Client client) { }
108 private Mailbox mailbox(String name, boolean create) { return mailbox(name, create, true); }
109 private Mailbox mailbox(String name, boolean create, boolean throwexn) {
110 if (name.equalsIgnoreCase("inbox")) return inbox;
112 for(StringTokenizer st = new StringTokenizer(name, sep + ""); st.hasMoreTokens();)
113 if ((m = m.slash(st.nextToken(), create)) == null) {
114 if (throwexn) throw new Server.No("no such mailbox " + name);
120 // FEATURE: not accurate when a wildcard and subsequent non-wildcards both match a single component
121 public void lsub(String start, String ref) { list(start, ref, true); }
122 public void list(String start, String ref) { list(start, ref, false); }
123 public void list(String start, String ref, boolean lsub) {
124 if (ref.length() == 0) { client.list(sep, start, lsub, false); return; }
125 while (start.endsWith(""+sep)) start = start.substring(0, start.length() - 1);
126 if (ref.endsWith("%")) ref = ref + sep;
127 String[] children = (start.length() == 0 ? root : mailbox(start, false)).children();
128 for(int i=0; i<children.length; i++) {
129 String s = children[i], pre = ref, kid = start + (start.length() > 0 ? sep+"" : "") + s;
130 if (mailbox(kid, false) == null) continue;
131 boolean phantom = mailbox(kid, false).phantom();
133 if (pre.length() == 0) {
134 if (s.length() == 0) client.list(sep, kid, lsub, phantom);
135 } else switch(pre.charAt(0)) {
136 case sep: if (s.length() == 0) list(kid, pre.substring(1), lsub); break;
137 case '%': client.list(sep,kid,lsub,phantom);pre=pre.substring(1); s = ""; continue;
138 case '*': client.list(sep,kid,lsub,phantom);list(kid,pre,lsub);pre=pre.substring(1); break;
139 default: if (s.length()==0) break;
140 if (s.charAt(0) != pre.charAt(0)) break;
141 s = s.substring(1); pre = pre.substring(1); continue;
148 public String[] capability() { return new String[] { "IMAP4rev1" , "UNSELECT", "ID" }; }
149 public Hashtable id(Hashtable clientId) {
150 Hashtable response = new Hashtable();
151 response.put("name", IMAP.class.getName());
152 response.put("version", version + "");
153 response.put("os", System.getProperty("os.name", null));
154 response.put("os-version", System.getProperty("os.version", null));
155 response.put("vendor", "none");
156 response.put("support-url", "http://mail.ibex.org/");
160 public void copy(Query q, String to) { copy(q, mailbox(to, false)); }
161 /* */ void copy(Query q, Mailbox to) {
162 for(Mailbox.Iterator it=selected().iterator(q);it.next();) to.add(it.cur(), it.flags() | Mailbox.Flag.RECENT); }
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(Message.newMessage(new Stream(b)),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 maxuid() {
181 Mailbox mb = selected();
182 if (mb == null) return 0;
183 for(Mailbox.Iterator it = mb.iterator(); it.next(); ) ret = it.uid();
186 public int unseen(String mailbox) { return mailbox(mailbox, false).count(Query.not(Query.seen())); }
187 public int recent(String mailbox) { return mailbox(mailbox, false).count(Query.recent()); }
188 public int count(String mailbox) { return mailbox(mailbox, false).count(Query.all()); }
189 public int count() { return selected().count(Query.all()); }
190 public int uidNext(String mailbox) { return mailbox(mailbox, false).uidNext(); }
191 public int uidValidity(String mailbox) { return mailbox(mailbox, false).uidValidity(); }
192 public void select(String mailbox, boolean examineOnly) {
193 selected = mailbox(mailbox, false);
196 public int[] search(Query q, boolean uid) {
197 Vec.Int vec = new Vec.Int();
198 for(Mailbox.Iterator it = selected().iterator(q); it.next();) {
199 vec.addElement(uid ? it.uid() : it.num());
205 public void setFlags(Query q, int f, boolean uid, boolean silent) { doFlags(q, f, uid, 0, silent); }
206 public void addFlags(Query q, int f, boolean uid, boolean silent) { doFlags(q, f, uid, 1, silent); }
207 public void removeFlags(Query q, int f, boolean uid, boolean silent) { doFlags(q, f, uid, -1, silent); }
209 private void doFlags(Query q, int flags, boolean uid, int style, boolean silent) {
210 for(Mailbox.Iterator it = selected().iterator(q);it.next();) {
211 boolean recent = it.recent();
212 try { throw new Exception("flags " + flags); } catch (Exception e) { Log.error(this, e); }
213 if (style == -1) it.removeFlags(flags);
214 else if (style == 0) it.setFlags(flags);
215 else if (style == 1) it.addFlags(flags);
217 if (!silent) client.fetch(it.num(), it.flags(), -1, null, it.uid());
220 public void rename(String from0, String to) {
221 Mailbox from = mailbox(from0, false);
222 if (from.equals(inbox)) { from.copy(Query.all(), mailbox(to, true)); }
223 else if (to.equalsIgnoreCase("inbox")) { from.copy(Query.all(), mailbox(to, true)); from.destroy(false); }
224 else from.rename(to);
226 public void fetch(Query q, int spec, String[] headers, int start, int end, boolean uid) {
227 for(Mailbox.Iterator it = selected().iterator(q); it.next(); ) {
228 Message message = ((spec & (BODYSTRUCTURE | ENVELOPE | INTERNALDATE | FIELDS | FIELDSNOT | RFC822 |
229 RFC822TEXT | RFC822SIZE | HEADERNOT | HEADER)) != 0) ? it.cur() : null;
230 int size = message == null ? 0 : message.size();
231 client.fetch(it.num(), it.flags(), size, message, it.uid());
238 // Single Session Handler //////////////////////////////////////////////////////////////////////////////
240 /** takes an IMAP.Server and exposes it to the world as an IMAP server on a TCP socket */
241 public static class Listener implements Worker, Client {
242 String selectedName = null;
243 Mailbox inbox = null, root = null;
245 Parser parser = null;
246 Connection conn = null;
248 public Listener(Login auth) { api = new IMAP.MailboxWrapper(this.auth = auth, this); }
249 Parser.Token token() { return parser.token(); }
250 void println(String s) { conn.println(s); }
251 void newline() { parser.newline(); }
252 Query query(int max) { return parser.query(max, maxn(true)); }
254 public void login(String u, String p) {
256 if ((ret = auth.login(u,p,IMAP.class)) == null) throw new Server.No("Login failed.");
257 if (ret instanceof IMAP.Server) {
258 api = (IMAP.Server)ret;
261 Account account = (Account)ret;
262 ((MailboxWrapper)api).root = root = account.getMailbox(IMAP.class);
263 Log.warn(this, "logged in, root="+root);
264 ((MailboxWrapper)api).inbox = inbox = root.slash("INBOX", false);
265 if (inbox == null) ((MailboxWrapper)api).inbox = inbox = root;
269 private int maxn(boolean uid) { return uid ? api.maxuid() : api.count(); }
271 public void handleRequest(Connection conn) {
273 parser = new Parser(conn);
274 conn.setTimeout(30 * 60 * 1000);
275 println("* OK " + conn.vhost + " " + IMAP.class.getName() + " IMAP4rev1 [RFC3501] v" + version + " server ready");
276 for(String tag = null;; newline()) try {
279 tag = null; Parser.Token tok = token(); if (tok == null) return; tag = tok.astring();
280 String command = token().atom();
281 if (command.equalsIgnoreCase("UID")) { uid = true; command = token().atom(); }
282 int commandKey = ((Integer)commands.get(command.toUpperCase())).intValue();
284 case LOGIN: login(token().astring(), token().astring()); break;
285 case CAPABILITY: println("* CAPABILITY " + Printer.join(" ", api.capability())); break;
286 case AUTHENTICATE: throw new Server.No("AUTHENTICATE not supported");
287 case LOGOUT: api.logout(); println("* BYE"); conn.close(); return;
288 case LIST: api.list(token().q(), token().astring()); break; /*astring is a hack for EUDORA*/
289 case LSUB: api.lsub(token().q(), token().q()); break;
290 case SUBSCRIBE: api.subscribe(token().astring()); break;
291 case UNSUBSCRIBE: api.unsubscribe(token().astring()); break;
292 case RENAME: api.rename(token().astring(), token().astring()); break;
293 case COPY: selected(); api.copy(Query.set(uid, token().set(maxn(uid))), token().astring()); break;
294 case DELETE: api.delete(token().atom()); break;
295 case CHECK: selected(); api.check(); break;
296 case NOOP: api.noop(); break;
297 case CLOSE: selected(); api.close(); break;
298 case EXPUNGE: selected(); api.expunge(); break;
299 case UNSELECT: selected(); api.unselect(); selected = false; break;
300 case CREATE: api.create(token().astring()); break;
301 case FETCH: selected(); fetch(Query.set(lastuid=uid, token().set(maxn(uid))),
302 lastfetch=token().lx(), 0, 0, 0, uid, 0); break;
303 case SEARCH: selected(); println("* SEARCH " + Printer.join(api.search(query(), uid))); break;
306 String mailbox = token().astring();
307 api.select(mailbox, commandKey==EXAMINE);
308 println("* FLAGS (\\Answered \\Flagged \\Deleted \\Seen \\Draft)");
309 println("* " + api.count(mailbox) + " EXISTS");
310 println("* " + api.recent(mailbox) + " RECENT");
311 println("* OK [UIDVALIDITY " + api.uidValidity(mailbox) + "] UIDs valid");
312 println("* OK [UIDNEXT " + api.uidNext(mailbox) + "]");
313 println("* OK [PERMANENTFLAGS (\\Seen \\Draft \\Answered \\Deleted)]");
317 String mailbox = token().astring(); // hack for GNUS buggy client
318 Parser.Token[] list = token().l();
319 String response = "";
320 for(int i=0; i<list.length; i++) {
321 String s = list[i].atom().toUpperCase();
322 if (i>0) response += " ";
323 if (s.equals("MESSAGES")) response += "MESSAGES " + api.count(mailbox);
324 if (s.equals("RECENT")) response += "RECENT " + api.recent(mailbox);
325 if (s.equals("UIDNEXT")) response += "UIDNEXT " + api.uidNext(mailbox);
326 if (s.equals("UIDVALIDITY")) response += "UIDVALIDITY " + api.uidValidity(mailbox);
327 if (s.equals("UNSEEN")) response += "UNSEEN " + api.unseen(mailbox);
329 println("* STATUS " + mailbox + " (" + response + ")");
333 String m = token().astring();
335 Date arrival = new Date();
336 Parser.Token t = token();
337 if (t.type == t.LIST) { flags = t.flags(); t = token(); }
338 if (t.type != t.QUOTED) { arrival = t.datetime(); t = token(); }
339 api.append(m, flags, arrival, t.q());
343 Query q = uid ? Query.uid(token().set(maxn(uid))) : Query.num(token().set(maxn(uid)));
344 String s = token().atom().toUpperCase();
345 int flags = token().flags();
346 if (s.equals("FLAGS")) api.setFlags(q, flags, uid, false);
347 else if (s.equals("+FLAGS")) api.addFlags(q, flags, uid, false);
348 else if (s.equals("-FLAGS")) api.removeFlags(q, flags, uid, false);
349 else if (s.equals("FLAGS.SILENT")) api.setFlags(q, flags, uid, true);
350 else if (s.equals("+FLAGS.SILENT")) api.addFlags(q, flags, uid, true);
351 else if (s.equals("-FLAGS.SILENT")) api.removeFlags(q, flags, uid, true);
352 else throw new Server.Bad("unknown STORE specifier " + s);
354 default: throw new Server.Bad("unrecognized command \"" + command + "\"");
356 println(tag+" OK "+command+" Completed. " +
357 (commandKey == LOGIN ? ("[CAPABILITY "+Printer.join(" ", api.capability())+"]") : ""));
358 } catch (Server.Bad b) { println(tag==null ? "* BAD Invalid tag":(tag + " Bad " + b.toString()));
359 } catch (Server.No n) { println(tag==null?"* BAD Invalid tag":(tag+" No " + n.toString())); }
362 private Parser.Token[] lastfetch = null; // hack
363 private boolean lastuid = false; // hack
364 private boolean selected = false;
365 private void selected() { if (!selected) throw new Server.Bad("no mailbox selected"); }
367 // Callbacks //////////////////////////////////////////////////////////////////////////////
369 public void expunge(int uid) { println("* " + uid + " EXPUNGE"); }
370 public void fetch(int n, int f, int size, Message m, int muid) { fetch(m, lastfetch, n, f, size, lastuid, muid); }
371 public void list(char sep, String mb, boolean sub, boolean p) {
372 println("* " + (sub?"LSUB":"LIST")+" ("+(p?"\\Noselect":"")+") \""+sep+"\" \""+mb+"\"");}
375 * Parse a fetch request <i>or</i> emit a fetch reply.
377 * To avoid duplicating tedious parsing logic, this function
378 * performs both of the following tasks:
379 * - parse the fetch request in Token[] t and return a fetch spec
380 * - emit a fetch reply for the parsed spec with respect to message m
382 private void fetch(Object o, Parser.Token[] t, int num, int flags, int size, boolean uid, int muid) {
383 Query q = o == null ? null : o instanceof Query ? (Query)o : null;
384 Message m = o == null ? null : o instanceof Message ? (Message)o : null;
385 boolean e = q == null;
388 int spec = 0; // spec; see constants for flags
389 String[] headers = null;
390 int start = -1, end = -1;
391 StringBuffer r = new StringBuffer();
392 if (e) { r.append(num); r.append(" FETCH ("); }
393 int initlen = r.length();
395 boolean good = false;
396 for(int i=0; i<t.length; i++)
397 if ((t[i].type == Parser.Token.QUOTED || t[i].type == Parser.Token.ATOM) &&
398 t[i].astring().equalsIgnoreCase("UID")) good = true;
400 Parser.Token[] t2 = new Parser.Token[t.length + 1];
401 System.arraycopy(t, 0, t2, 0, t.length);
402 t2[t2.length - 1] = parser.token("UID");
403 lastfetch = (t = t2);
406 if (t.length == 0 && (t[0].type == Parser.Token.QUOTED || t[0].type == Parser.Token.ATOM)) {
407 if (t[0].astring().equalsIgnoreCase("ALL"))
408 t = new Parser.Token[] { parser.token("FLAGS"), parser.token("INTERNALDATE"),
409 parser.token("ENVELOPE"), parser.token("RFC822.SIZE") };
410 else if (t[0].astring().equalsIgnoreCase("FULL"))
411 t = new Parser.Token[] { parser.token("FLAGS"), parser.token("INTERNALDATE"), parser.token("BODY"),
412 parser.token("ENVELOPE"), parser.token("RFC822.SIZE") };
413 else if (t[0].astring().equalsIgnoreCase("FAST"))
414 t = new Parser.Token[] { parser.token("FLAGS"), parser.token("INTERNALDATE"),
415 parser.token("RFC822.SIZE") };
417 for(int i=0; i<t.length; i++) {
418 if (r.length() > initlen) r.append(" ");
419 if (t[i] == null || t[i].s == null) continue;
420 String s = t[i].s.toUpperCase();
421 r.append(s.equalsIgnoreCase("BODY.PEEK")?"BODY":s);
422 if (s.equals("BODYSTRUCTURE")) { spec|=BODYSTRUCTURE;if(e){r.append(" ");r.append(Printer.bodystructure(m));}
423 } else if (s.equals("ENVELOPE")) { spec|=ENVELOPE; if(e){r.append(" ");r.append(Printer.envelope(m));}
424 } else if (s.equals("FLAGS")) { spec|=FLAGS; if(e){r.append(" ");r.append(Printer.flags(flags));}
425 } else if (s.equals("INTERNALDATE")) { spec|=INTERNALDATE; if(e){r.append(" ");r.append(Printer.date(m.arrival));}
426 } else if (s.equals("RFC822")) { spec|=RFC822; if(e){r.append(" ");r.append(Printer.message(m));}
427 } else if (s.equals("RFC822.TEXT")) { spec|=RFC822TEXT; if(e){r.append(" ");r.append(Printer.qq(m.body));}
428 } else if (s.equals("RFC822.HEADER")){ spec|=HEADER;if(e){r.append(" ");r.append(Printer.qq(m.headers.raw+"\r\n"));}
429 } else if (s.equals("RFC822.SIZE")) { spec|=RFC822SIZE; if(e){r.append(" ");r.append(m.size());}
430 } else if (s.equals("UID")) { spec|=UID; if(e){r.append(" ");r.append(muid); }
431 } else if (!(s.equals("BODY.PEEK") || s.equals("BODY"))) { throw new Server.No("unknown fetch argument: " + s);
433 if (s.equalsIgnoreCase("BODY.PEEK")) spec |= PEEK;
434 //else if (e) api.addFlags(Query.num(new int[] { num, num }), Mailbox.Flag.SEEN, false, false);
435 if (i >= t.length - 1 || t[i+1].type != Parser.Token.LIST) {
436 spec |= BODYSTRUCTURE;
437 if (e) { r.append(" "); r.append(Printer.bodystructure(m)); } continue;
438 //{ if (e) { r.append(" "); r.append(Printer.qq(m.body)); } continue; }
442 Parser.Token[] list = t[++i].l();
443 s = list.length == 0 ? "" : list[0].s.toUpperCase();
445 if (list.length == 0) { spec |= RFC822TEXT; if(e) payload = m.headers.raw+"\r\n"+m.body; }
446 else if (s.equals("") || s.equals("1")) { spec |= RFC822TEXT; if(e) payload = m.headers.raw+"\r\n"+m.body; }
447 else if (s.equals("TEXT")) { spec |= RFC822TEXT; if(e) payload = m.body; }
448 else if (s.equals("HEADER")) { spec |= HEADER; if(e) payload = m.headers.raw+"\r\n"; }
449 else if (s.equals("HEADER.FIELDS")) { spec |= FIELDS; payload=headers(r,t[i].l()[1].sl(),false,m,e); }
450 else if (s.equals("HEADER.FIELDS.NOT")) { spec |= FIELDSNOT; payload=headers(r,t[i].l()[1].sl(),true,m,e); }
451 else if (s.equals("MIME")) { throw new Server.Bad("MIME not supported"); }
452 else throw new Server.Bad("unknown section type " + s);
453 if (i<t.length - 1 && (t[i+1].s != null && t[i+1].s.startsWith("<"))) {
455 s = t[i].s.substring(1, t[i].s.indexOf('>'));
456 int dot = s.indexOf('.');
457 start = dot == -1 ? Integer.parseInt(s) : Integer.parseInt(s.substring(0, s.indexOf('.')));
458 end = dot == -1 ? -1 : Integer.parseInt(s.substring(s.indexOf('.') + 1));
459 if (e) { payload = payload.substring(start, Math.min(end+1,payload.length())); r.append("<"+start+">"); }
461 if (e) { r.append("] "); r.append(Printer.qq(payload)); }
466 println("* " + r.toString());
468 api.fetch(q, spec, headers, start, end, uid);
472 private String headers(StringBuffer r, String[] headers, boolean negate, Message m, boolean e) {
474 if (e) r.append(" (");
476 if(e) for(int j=0; j<headers.length; j++) {
477 r.append(headers[j] + (j<headers.length-1?" ":""));
478 if (m.headers.gets(headers[j]) != null) payload += headers[j]+": "+m.headers.gets(headers[j])+"\r\n";
481 throw new Server.No("HEADERS.NOT temporarily disaled");
483 if (e) for(int j=0; j<headers.length; j++) r.append(headers[j] + (j<headers.length-1?" ":""));
484 if(e) { OUTER: for(Enumeration x=m.headers.keys(); x.hasMoreElements();) {
485 String key = (String)x.nextElement();
486 for(int j=0; j<headers.length; j++) if (key.equalsIgnoreCase(headers[j])) continue OUTER;
487 payload += key + ": " + m.headers.gets(key)+"\r\n";
491 if (e) r.append(")");
492 return payload + "\r\n";
495 private static final Hashtable commands = new Hashtable();
496 private static final int UID = 0; static { commands.put("UID", new Integer(UID)); }
497 private static final int AUTHENTICATE = 1; static { commands.put("AUTHENTICATE", new Integer(AUTHENTICATE)); }
498 private static final int LIST = 2; static { commands.put("LIST", new Integer(LIST)); }
499 private static final int LSUB = 3; static { commands.put("LSUB", new Integer(LSUB)); }
500 private static final int SUBSCRIBE = 4; static { commands.put("SUBSCRIBE", new Integer(SUBSCRIBE)); }
501 private static final int UNSUBSCRIBE = 5; static { commands.put("UNSUBSCRIBE", new Integer(UNSUBSCRIBE)); }
502 private static final int CAPABILITY = 6; static { commands.put("CAPABILITY", new Integer(CAPABILITY)); }
503 private static final int ID = 7; static { commands.put("ID", new Integer(ID)); }
504 private static final int LOGIN = 8; static { commands.put("LOGIN", new Integer(LOGIN)); }
505 private static final int LOGOUT = 9; static { commands.put("LOGOUT", new Integer(LOGOUT)); }
506 private static final int RENAME = 10; static { commands.put("RENAME", new Integer(RENAME)); }
507 private static final int EXAMINE = 11; static { commands.put("EXAMINE", new Integer(EXAMINE)); }
508 private static final int SELECT = 12; static { commands.put("SELECT", new Integer(SELECT)); }
509 private static final int COPY = 13; static { commands.put("COPY", new Integer(COPY)); }
510 private static final int DELETE = 14; static { commands.put("DELETE", new Integer(DELETE)); }
511 private static final int CHECK = 15; static { commands.put("CHECK", new Integer(CHECK)); }
512 private static final int NOOP = 16; static { commands.put("NOOP", new Integer(NOOP)); }
513 private static final int CLOSE = 17; static { commands.put("CLOSE", new Integer(CLOSE)); }
514 private static final int EXPUNGE = 18; static { commands.put("EXPUNGE", new Integer(EXPUNGE)); }
515 private static final int UNSELECT = 19; static { commands.put("UNSELECT", new Integer(UNSELECT)); }
516 private static final int CREATE = 20; static { commands.put("CREATE", new Integer(CREATE)); }
517 private static final int STATUS = 21; static { commands.put("STATUS", new Integer(STATUS)); }
518 private static final int FETCH = 22; static { commands.put("FETCH", new Integer(FETCH)); }
519 private static final int APPEND = 23; static { commands.put("APPEND", new Integer(APPEND)); }
520 private static final int STORE = 24; static { commands.put("STORE", new Integer(STORE)); }
521 private static final int SEARCH = 25; static { commands.put("SEARCH", new Integer(SEARCH)); }
524 public static class Parser {
525 private Stream stream;
526 public Parser(Stream from) { this.stream = from; }
527 public Token token(String s) { return new Token(s); }
528 protected Query query(int max, int maxuid) {
534 Parser.Token t = token(false);
535 if (t == null) break;
536 if (t.type == t.LIST) throw new Server.No("nested queries not yet supported FIXME");
537 else if (t.type == t.SET) return Query.num(t.set(max));
538 s = t.atom().toUpperCase();
539 if (s.equals("NOT")) return Query.not(query(max, maxuid));
540 if (s.equals("OR")) return Query.or(query(max, maxuid), query(max, maxuid)); // FIXME parse rest of list
541 if (s.equals("AND")) return Query.and(query(max, maxuid), query(max, maxuid));
543 if (s.startsWith("UN")) { not = true; s = s.substring(2); }
544 if (s.equals("ANSWERED")) q = Query.answered();
545 else if (s.equals("DELETED")) q = Query.deleted();
546 else if (s.equals("ALL")) q = Query.all();
547 else if (s.equals("DRAFT")) q = Query.draft();
548 else if (s.equals("FLAGGED")) q = Query.flagged();
549 else if (s.equals("RECENT")) q = Query.recent();
550 else if (s.equals("SEEN")) q = Query.seen();
551 else if (s.equals("OLD")) { not = true; q = Query.recent(); }
552 else if (s.equals("NEW")) q = Query.and(Query.recent(), Query.not(Query.seen()));
553 else if (s.equals("KEYWORD")) q = Query.header("keyword", token().flag());
554 else if (s.equals("HEADER")) q = Query.header(token().astring(), token().astring());
555 else if (s.equals("BCC")) q = Query.header("bcc", token().astring());
556 else if (s.equals("CC")) q = Query.header("cc", token().astring());
557 else if (s.equals("FROM")) q = Query.header("from", token().astring());
558 else if (s.equals("TO")) q = Query.header("to", token().astring());
559 else if (s.equals("SUBJECT")) q = Query.header("subject", token().astring());
560 else if (s.equals("LARGER")) q = Query.size(token().n(), Integer.MAX_VALUE);
561 else if (s.equals("SMALLER")) q = Query.size(Integer.MIN_VALUE, token().n());
562 else if (s.equals("BODY")) q = Query.body(token().astring());
563 else if (s.equals("TEXT")) q = Query.full(token().astring());
564 else if (s.equals("BEFORE")) q = Query.arrival(new Date(0), token().date());
565 else if (s.equals("SINCE")) q = Query.arrival(token().date(), new Date(Long.MAX_VALUE));
566 else if (s.equals("ON")) { Date d = token().date(); q = Query.arrival(d, new Date(d.getTime() + 24 * 60 * 60)); }
567 else if (s.equals("SENTBEFORE")) q = Query.sent(new Date(0), token().date());
568 else if (s.equals("SENTSINCE")) q = Query.sent(token().date(), new Date(Long.MAX_VALUE));
569 else if (s.equals("SENTON")) { Date d = token().date(); q = Query.sent(d, new Date(d.getTime() + 24 * 60 * 60)); }
570 else if (s.equals("UID")) q = Query.uid(token().set(max));
571 q = not ? Query.not(q) : q;
572 ret = ret == null ? q : Query.and(ret, q);
577 private static void bad(String s) { throw new Server.Bad(s); }
579 public final byte type;
580 private final String s;
581 private final Parser.Token[] l;
583 private static final byte NIL = 0, LIST = 1, QUOTED = 2, NUMBER = 3, ATOM = 4, BAREWORD = 5, SET = 6;
584 public Token() { this.s = null; n = 0; l = null; type = NIL; }
585 public Token(String s) { this(s, false); }
586 public Token(String s, boolean quoted) { this.s = s; n = 0; l = null; type = quoted ? QUOTED : ATOM; }
587 public Token(Parser.Token[] list) { this.s = null; n = 0; l = list; type = LIST; }
588 public Token(int number) { this.s = null; n = number; l = null; type = NUMBER; }
590 public String flag() { if (type != ATOM) bad("expected a flag"); return s; }
591 public int n() { if (type != NUMBER) bad("expected number"); return n; }
592 public int nz() { int n = n(); if (n == 0) bad("expected nonzero number"); return n; }
593 public String q() { if (type == NIL) return null; if (type != QUOTED) bad("expected qstring"); return s; }
594 public Parser.Token[] l() { if (type == NIL) return null; if (type != LIST) bad("expected list"); return l; }
595 public Parser.Token[] lx() {
596 if (type == LIST) return l;
600 Parser.Token t = token(false);
601 if (t == null) break;
604 Parser.Token[] ret = new Parser.Token[v.size()];
608 public String nstring() { if (type==NIL) return null; if (type!=QUOTED) bad("expected nstring"); return s; }
609 public String astring() {
610 if (type != ATOM && type != QUOTED) bad("expected atom or string");
611 if (s == null) bad("astring cannot be null");
613 public String[] sl() {
614 if (type == NIL) return null;
615 if (type != LIST) bad("expected list");
616 String[] ret = new String[l.length];
617 for(int i=0; i<ret.length; i++) ret[i] = l[i].s;
621 if (type != LIST) bad("expected flag list");
623 for(int i=0; i<l.length; i++) {
624 String flag = l[i].s;
625 if (flag.equals("\\Deleted")) ret |= Mailbox.Flag.DELETED;
626 else if (flag.equals("\\Seen")) ret |= Mailbox.Flag.SEEN;
627 else if (flag.equals("\\Flagged")) ret |= Mailbox.Flag.FLAGGED;
628 else if (flag.equals("\\Draft")) ret |= Mailbox.Flag.DRAFT;
629 else if (flag.equals("\\Answered")) ret |= Mailbox.Flag.ANSWERED;
630 else if (flag.equals("\\Recent")) ret |= Mailbox.Flag.RECENT;
634 public int[] set(int largest) {
635 if (type != ATOM) bad("expected a messageid set");
636 Vec.Int ids = new Vec.Int();
637 StringTokenizer st = new StringTokenizer(s, ",");
638 while(st.hasMoreTokens()) {
639 String s = st.nextToken();
640 if (s.indexOf(':') == -1) {
642 ids.addElement(largest);
643 ids.addElement(largest);
645 ids.addElement(Integer.parseInt(s));
646 ids.addElement(Integer.parseInt(s));
649 int start = Integer.parseInt(s.substring(0, s.indexOf(':')));
650 String end_s = s.substring(s.indexOf(':')+1);
651 int end = end_s.equals("*") ? largest : Integer.parseInt(end_s);
652 for(int j=Math.min(start,end); j<=Math.max(start,end); j++) {
660 if (type != QUOTED && type != ATOM) bad("Expected quoted or unquoted date");
661 try { return new SimpleDateFormat("dd-MMM-yyyy").parse(s);
662 } catch (ParseException p) { throw new Server.Bad("invalid date format; " + p); }
664 public Date datetime() {
665 if (type != QUOTED) bad("Expected quoted datetime");
666 try { return new SimpleDateFormat("dd-MM-yyyy hh:mm:ss zzzz").parse(s.trim());
667 } catch (ParseException p) { throw new Server.Bad("invalid datetime format " + s + " : " + p); }
669 public String atom() {
670 if (type != ATOM) bad("expected atom");
671 for(int i=0; i<s.length(); i++) {
672 char c = s.charAt(i);
673 if (c == '(' || c == ')' || c == '{' || c == ' ' || c == '%' || c == '*' || c == '\"' | c == '\\')
674 bad("invalid char in atom: " + c);
680 public void newline() {
681 while (stream.peekc() == '\r' || stream.peekc() == '\n' || stream.peekc() == ' ') {
682 for(char c = stream.peekc(); c == ' ';) { stream.getc(); c = stream.peekc(); };
683 for(char c = stream.peekc(); c == '\r' || c == '\n';) { stream.getc(); c = stream.peekc(); };
687 public Token token() { return token(true); }
688 public Token token(boolean freak) {
689 Vec toks = new Vec();
690 StringBuffer sb = new StringBuffer();
691 char c = stream.getc(); while (c == ' ') c = stream.getc();
692 if (c == '\r' || c == '\n') { if (freak) bad("unexpected end of line"); return null; }
694 while(stream.peekc() != '}') sb.append(stream.getc());
696 stream.println("+ Ready when you are...");
697 int octets = Integer.parseInt(sb.toString());
698 while(stream.peekc() == ' ') stream.getc(); // whitespace
699 while(stream.peekc() == '\n' || stream.peekc() == '\r') stream.getc();
700 byte[] bytes = new byte[octets];
702 while(numread < bytes.length) {
703 int n = stream.read(bytes, numread, bytes.length - numread);
704 if (n == -1) bad("end of stream while reading IMAP qstring");
707 return new Token(new String(bytes), true);
708 } else if (c == '\"') {
711 if (c == '\\') sb.append(stream.getc());
712 else if (c == '\"') break;
715 return new Token(sb.toString(), true);
717 // NOTE: this is technically a violation of the IMAP grammar, since atoms like FOO[BAR should be legal
718 } else if (c == ']' || c == ')') { return null;
719 } else if (c == '[' || c == '(') {
721 do { t = token(); if (t != null) toks.addElement(t); } while (t != null);
722 Token[] ret = new Token[toks.size()];
724 return new Token(ret);
729 if (c == ' ' || c == '\"' || c == '(' || c == ')' || c == '[' || c == ']' ||
730 c == '{' || c == '\n' || c == '\r')
731 return new Token(sb.toString(), false);
737 public static class Printer {
738 static String quotify(String s){
739 return s==null?"NIL":"\""+s.replaceAll("\\\\","\\\\").replaceAll("\"","\\\\\"")+"\"";}
740 static String quotify(Date d) {
741 return new SimpleDateFormat("dd-MMM-yyyy HH:mm:ss +zzzz").format(d); }
742 static String address(Address a) {
743 return"("+quotify(a.description)+" NIL "+quotify(a.user)+" "+quotify(a.host)+")"; }
744 public static String addressList(Object a) {
745 if (a == null) return "NIL";
746 if (a instanceof Address) return "("+address((Address)a)+")";
747 if (a instanceof String) return "("+address(Address.parse((String)a))+")";
748 Address[] aa = (Address[])a;
749 StringBuffer ret = new StringBuffer();
751 for(int i=0; i<aa.length; i++) { ret.append(aa[i]); if (i < aa.length - 1) ret.append(" "); }
753 return ret.toString();
755 static String flags(Mailbox.Iterator it) {
757 (it.deleted() ? "\\Deleted " : "") +
758 (it.seen() ? "\\Seen " : "") +
759 (it.flagged() ? "\\Flagged " : "") +
760 (it.draft() ? "\\Draft " : "") +
761 (it.answered() ? "\\Answered " : "") +
762 (it.recent() ? "\\Recent " : "");
764 static String flags(int flags) {
766 (((flags & Mailbox.Flag.DELETED) == Mailbox.Flag.DELETED) ? "\\Deleted " : "") +
767 (((flags & Mailbox.Flag.SEEN) == Mailbox.Flag.SEEN) ? "\\Seen " : "") +
768 (((flags & Mailbox.Flag.FLAGGED) == Mailbox.Flag.FLAGGED) ? "\\Flagged " : "") +
769 (((flags & Mailbox.Flag.DRAFT) == Mailbox.Flag.DRAFT) ? "\\Draft " : "") +
770 (((flags & Mailbox.Flag.ANSWERED) == Mailbox.Flag.ANSWERED)? "\\Answered " : "") +
771 (((flags & Mailbox.Flag.RECENT) == Mailbox.Flag.RECENT) ? "\\Recent " : "");
772 if (ret.endsWith(" ")) ret = ret.substring(0, ret.length() - 1);
775 static String bodystructure(Message m) {
777 return "(\"TEXT\" \"PLAIN\" (\"CHARSET\" \"ISO-8859-1\") NIL NIL \"7BIT\" "+m.size()+" "+m.lines+")";
779 static String message(Message m) { return m.toString(); }
780 static String date(Date d) { return "\""+d.toString()+"\""; }
781 static String envelope(Message m) {
783 "(" + quotify(m.arrival.toString()) +
784 " " + quotify(m.subject) +
785 " " + addressList(m.from) +
786 " " + addressList(m.headers.gets("sender")) +
787 " " + addressList(m.replyto) +
788 " " + addressList(m.to) +
789 " " + addressList(m.cc) +
790 " " + addressList(m.bcc) +
791 " " + quotify((String)m.headers.gets("in-reply-to")) +
792 " " + quotify(m.messageid) +
796 public static String qq(String s) {
797 StringBuffer ret = new StringBuffer();
799 ret.append(s.getBytes().length);
804 return ret.toString();
807 private static String join(int[] nums) {
808 StringBuffer ret = new StringBuffer();
809 for(int i=0; i<nums.length; i++) {
811 if (i<nums.length-1) ret.append(' ');
813 return ret.toString();
815 private static String join(String delimit, String[] stuff) {
816 StringBuffer ret = new StringBuffer();
817 for(int i=0; i<stuff.length; i++) {
818 ret.append(stuff[i]);
819 if (i<stuff.length - 1) ret.append(delimit);
821 return ret.toString();
826 // Main //////////////////////////////////////////////////////////////////////////////
828 public static final int
829 PEEK=0x1, BODYSTRUCTURE=0x2, ENVELOPE=0x4, FLAGS=0x8, INTERNALDATE=0x10, FIELDS=0x800, FIELDSNOT=0x1000,
830 RFC822=0x20, RFC822TEXT=0x40, RFC822SIZE=0x80, HEADERNOT=0x100, UID=0x200, HEADER=0x400;