X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=src%2Forg%2Fibex%2Fmail%2Fprotocol%2FIMAP.java;h=5b981052a0cc87a938d69526dce680e5390c87c0;hb=4ff26332350edaa3c6ebfa29408c61412a6a2e40;hp=04d7194c8aa086dc5c1d838608cfb0baba38e66e;hpb=260c2d47c04ee6f82462a3a414ff02fbd71db733;p=org.ibex.mail.git diff --git a/src/org/ibex/mail/protocol/IMAP.java b/src/org/ibex/mail/protocol/IMAP.java index 04d7194..5b98105 100644 --- a/src/org/ibex/mail/protocol/IMAP.java +++ b/src/org/ibex/mail/protocol/IMAP.java @@ -1,4 +1,11 @@ +// Copyright 2000-2005 the Contributors, as shown in the revision logs. +// Licensed under the Apache Public Source License 2.0 ("the License"). +// You may not use this file except in compliance with the License. + package org.ibex.mail.protocol; +import org.ibex.io.*; +import org.ibex.crypto.*; +import org.ibex.jinetd.Listener; import org.ibex.mail.*; import org.ibex.util.*; import org.ibex.mail.target.*; @@ -6,667 +13,848 @@ import java.util.*; import java.net.*; import java.text.*; import java.io.*; - -// FEATURE: hoist all the ok()'s? + +// FIXME: this is valid LSUB "" asdfdas%*%*%*%*SFEFGWEF +// FIXME: be very careful about where/when we quotify stuff +// FIXME: 'UID FOO 100:*' must match at least one message even if all UIDs less than 100 +// FIXME: LIST should return INBOX if applicable + +// Relevant RFC's: +// RFC 2060: IMAPv4 +// RFC 3501: IMAPv4 with clarifications +// RFC 3691: UNSELECT +// RFC 2971: ID + +// FEATURE: make sure we're being case-insensitive enough; probably want to upcase atom() +// FEATURE: MIME-queries and BODYSTRUCTURE +// FEATURE: READ-WRITE / READ-ONLY status on SELECT // FEATURE: pipelining // FEATURE: support [charset] -public class IMAP extends MessageProtocol { - - public static final char imapSeparator = '.'; - - public static void main(String[] args) throws Exception { - ServerSocket ss = new ServerSocket(143); - while(true) { - System.out.println("listening"); - final Socket s = ss.accept(); - System.out.println("connected"); - new Thread() { - public void run() { - try { - Mailbox root = - FileBasedMailbox.getFileBasedMailbox(Mailbox.STORAGE_ROOT + File.separatorChar + "imap", true); - Mailbox inbox = root.slash("users", true).slash("megacz", true); - new Listener(s, "megacz.com", root, inbox).handleRequest(); - } catch (Exception e) { - e.printStackTrace(); - } - } - }.start(); - } +// FEATURE: \Noselect +// FEATURE: subscriptions +// FEATURE: tune for efficiency +// FEATURE: STARTTLS +// FEATURE: asynchronous client notifications (need to re-read RFC) + +public class IMAP { + + public IMAP() { } + public static final float version = (float)0.2; + + // FIXME this is evil + public static String getBodyString(Message m) { + StringBuffer sb = new StringBuffer(); + m.getBody().getStream().transcribe(sb); + return sb.toString(); } - public static class Exn extends MailException { - public Exn(String s) { super(s); } - public static class No extends Exn { public No(String s) { super(s); } } + // API Class ////////////////////////////////////////////////////////////////////////////// + + public static interface Client { + public void expunge(int uid); + public void list(char separator, String mailbox, boolean lsub, boolean phantom); + public void fetch(int num, int flags, int size, Message m, int muid); // m may be null or incomplete + } + + public static interface Server { + public void setClient(IMAP.Client client); + public String[] capability(); + public Hashtable id(Hashtable clientId); + public void copy(Query q, String to); + public void logout(); + public void unselect(); + public void delete(String m); + public void create(String m); + public void append(String m, int flags, Date arrival, String body); + public void check(); + public void noop(); + public void close(); + public void subscribe(String mailbox); + public void unsubscribe(String mailbox); + public int unseen(String mailbox); + public int recent(String mailbox); + public int count(String mailbox); + public int count(); + public int maxuid(); + public int uidNext(String mailbox); + public int uidValidity(String mailbox); + public int[] search(Query q, boolean uid); + public void rename(String from, String to); + public void select(String mailbox, boolean examineOnly); + public void setFlags(Query q, int flags, boolean uid, boolean silent); + public void removeFlags(Query q, int flags, boolean uid, boolean silent); + public void addFlags(Query q, int flags, boolean uid, boolean silent); + public void expunge(); + public void fetch(Query q, int spec, String[] headers, int start, int end, boolean uid); + public void lsub(String start, String ref); + public void list(String start, String ref); + public static class Exn extends MailException { public Exn(String s) { super(s); } } public static class Bad extends Exn { public Bad(String s) { super(s); } } + public static class No extends Exn { public No(String s) { super(s); } } } - private static class Listener extends Incoming { + + // MailboxWrapper ////////////////////////////////////////////////////////////////////////////// + + /** wraps an IMAP.Server interface around a Mailbox */ + public static class MailboxWrapper implements Server { + + public static final char sep = '.'; + + Mailbox inbox = null; Mailbox selected = null; - Mailbox root; - Mailbox inbox; - Socket conn; - String vhost; - PrintWriter pw; - InputStream is; - PushbackReader r; - public void init() { } - public Listener(Socket conn, String vhost, Mailbox root, Mailbox inbox) throws IOException { - this.vhost = vhost; - this.conn = conn; - this.selected = null; - this.root = root; - this.inbox = inbox; - this.pw = new PrintWriter(new OutputStreamWriter(conn.getOutputStream())); - this.is = conn.getInputStream(); - this.r = new PushbackReader(new InputStreamReader(is)); - } + Mailbox root = null; + Mailbox selected() { if (selected == null) throw new Bad("no mailbox selected"); return selected; } + final Login auth; + final Client client; - private void star(String s) { - pw.println("* " + s); - System.err.println("* " + s); - pw.flush(); - } + public MailboxWrapper(Login auth, Client c) { this.auth=auth; this.client=c;} + public void setClient(IMAP.Client client) { } - // FIXME: user-inbox-relative stuff - // FIXME should throw a No if mailbox not found and create==false - private Mailbox getMailbox(String name, boolean create) { + private Mailbox mailbox(String name, boolean create) { return mailbox(name, create, true); } + private Mailbox mailbox(String name, boolean create, boolean throwexn) { + if (name.equalsIgnoreCase("inbox")) return inbox; Mailbox m = root; - while(name.length() > 0) { - int end = name.length(); - if (name.indexOf(imapSeparator) != -1) end = name.indexOf(imapSeparator); - m = m.slash(name.substring(0, end), create); - if (end == name.length()) break; - name = name.substring(end+1); - } + for(StringTokenizer st = new StringTokenizer(name, sep + ""); st.hasMoreTokens();) + if ((m = m.slash(st.nextToken(), create)) == null) { + if (throwexn) throw new Server.No("no such mailbox " + name); + return null; + } return m; } - private boolean auth(String user, String pass) { /* FEATURE */ return user.equals("megacz") && pass.equals("pass"); } - - // FEATURE: manage subscriptions - public void lsub(Mailbox m, String s) { - star("LSUB () \".\" INBOX"); - } - - // FIXME - public void list(Mailbox m, String s) { - //star("LIST () \".\" INBOX"); - star("LIST () \".\" users.megacz.imap"); + // FEATURE: not accurate when a wildcard and subsequent non-wildcards both match a single component + public void lsub(String start, String ref) { list(start, ref, true); } + public void list(String start, String ref) { list(start, ref, false); } + public void list(String start, String ref, boolean lsub) { + + // FIXME this might be wrong + if (ref.equalsIgnoreCase("inbox")) { client.list(sep,"inbox",lsub,false); return; } + + if (ref.length() == 0) { client.list(sep, start, lsub, false); return; } + while (start.endsWith(""+sep)) start = start.substring(0, start.length() - 1); + if (ref.endsWith("%")) ref = ref + sep; + String[] children = (start.length() == 0 ? root : mailbox(start, false)).children(); + for(int i=0; i 0 ? sep+"" : "") + s; + if (mailbox(kid, false) == null) continue; + Mailbox phant = mailbox(kid, false, false); + if (phant != null) { + boolean phantom = phant.phantom(); + while(true) { + if (pre.length() == 0) { + if (s.length() == 0) client.list(sep, kid, lsub, phantom); + } else switch(pre.charAt(0)) { + case sep: if (s.length() == 0) list(kid, pre.substring(1), lsub); break; + case '%': client.list(sep,kid,lsub,phantom);pre=pre.substring(1); s = ""; continue; + case '*': client.list(sep,kid,lsub,phantom);list(kid,pre,lsub);pre=pre.substring(1); break; + default: if (s.length()==0) break; + if (s.charAt(0) != pre.charAt(0)) break; + s = s.substring(1); pre = pre.substring(1); continue; + } + break; + } + } + } } - public void copy(final Query q, Mailbox to) { for(Mailbox.Iterator it=selected.iterator(q);it.next();) to.add(it.cur()); } - public void login(String user, String pass) { if (!auth(user, pass)) throw new Exn.No("Liar, liar, pants on fire."); } - public void capability() { star("CAPABILITY IMAP4rev1"); } - public void logout() { star("BYE LOGOUT received"); } - public void delete(Mailbox m) { if (!m.equals(inbox)) m.destroy(); } - public void create(String mailbox){if(!mailbox.endsWith(".")&&!mailbox.equalsIgnoreCase("inbox"))getMailbox(mailbox,true);} - public void close(boolean examineOnly) { expunge(false, true); selected = null; } + public String[] capability() { return new String[] { "IMAP4rev1" , "UNSELECT", "ID" }; } + public Hashtable id(Hashtable clientId) { + Hashtable response = new Hashtable(); + response.put("name", IMAP.class.getName()); + response.put("version", version + ""); + response.put("os", System.getProperty("os.name", null)); + response.put("os-version", System.getProperty("os.version", null)); + response.put("vendor", "none"); + response.put("support-url", "http://mail.ibex.org/"); + return response; + } + + public void copy(Query q, String to) { copy(q, mailbox(to, false)); } + /* */ void copy(Query q, Mailbox to) { + for(Mailbox.Iterator it=selected().iterator(q);it.next();) to.add(it.cur(), it.flags() | Mailbox.Flag.RECENT); } + + public void unselect() { selected = null; } + public void delete(String m0) { delete(mailbox(m0,false)); } + public void delete(Mailbox m) { if (!m.equals(inbox)) m.destroy(false); else throw new Bad("can't delete inbox"); } + public void create(String m) { mailbox(m, true, false); } + public void append(String m,int f,Date a,String b) { try { + mailbox(m,false).add(Message.newMessage(new Fountain.StringFountain(b)),f|Mailbox.Flag.RECENT); + } catch (Message.Malformed e) { throw new No(e.getMessage()); } } public void check() { } public void noop() { } - - public void rename(Mailbox from, String to) { - if (from.equals(inbox)) from.copy(Query.all(), getMailbox(to, true)); - else if (to.equalsIgnoreCase("inbox")) { from.copy(Query.all(), getMailbox(to, true)); from.destroy(); } - else from.rename(to); + public void logout() { } + public void close() { for(Mailbox.Iterator it=selected().iterator(Query.deleted()); it.next();) it.delete(); } + public void expunge() { for(Mailbox.Iterator it = selected().iterator(Query.deleted());it.next();) expunge(it); } + public void expunge(Mailbox.Iterator it) { client.expunge(it.uid()); it.delete(); } + public void subscribe(String mailbox) { } + public void unsubscribe(String mailbox) { } + public int maxuid() { + int ret = 0; + Mailbox mb = selected(); + if (mb == null) return 0; + for(Mailbox.Iterator it = mb.iterator(); it.next(); ) ret = it.uid(); + return ret; } - - public void status(final Mailbox m, Token[] attrs) { - int count0 = 0, count1 = 0, count2 = 0; - for(Mailbox.Iterator it = m.iterator(); it.next(); ) { if (!it.seen()) count0++; if (it.recent()) count1++; count2++; } - String response = ""; - for(int i=0; i 0)*/ println("* SEARCH " + Printer.join(result)); + break; + } + case EXAMINE: + case SELECT: { + String mailbox = token().astring(); + api.select(mailbox, commandKey==EXAMINE); + println("* FLAGS (\\Answered \\Flagged \\Deleted \\Seen \\Draft)"); + println("* " + api.count(mailbox) + " EXISTS"); + println("* " + api.recent(mailbox) + " RECENT"); + println("* OK [UNSEEN " + api.unseen(mailbox) + "]"); + println("* OK [UIDVALIDITY " + api.uidValidity(mailbox) + "] UIDs valid"); + println("* OK [UIDNEXT " + api.uidNext(mailbox) + "]"); + println("* OK [PERMANENTFLAGS (\\Seen)]"); + selected = true; + break; } + case STATUS: { + String mailbox = token().astring(); // hack for GNUS buggy client + Parser.Token[] list = token().l(); + String response = ""; + for(int i=0; i0) response += " "; + if (s.equals("MESSAGES")) response += "MESSAGES " + api.count(mailbox); + if (s.equals("RECENT")) response += "RECENT " + api.recent(mailbox); + if (s.equals("UIDNEXT")) response += "UIDNEXT " + api.uidNext(mailbox); + if (s.equals("UIDVALIDITY")) response += "UIDVALIDITY " + api.uidValidity(mailbox); + if (s.equals("UNSEEN")) response += "UNSEEN " + api.unseen(mailbox); } - if (frb.start == -1) reply.append(qq(payload.toString())); - else if (frb.start == -1) reply.append("<" + frb.end + ">" + qq(payload.substring(0, frb.end + 1))); - else reply.append("<" + frb.start + "." + frb.end + ">" + qq(payload.substring(frb.start, frb.end + 1))); - } else throw new Error("this should never happen"); - star((uid ? it.uid() : it.num()) + " FETCH (" + reply.toString() + (uid ? " UID " + it.uid() : "") + ")"); - if (!peek) it.seen(true); - } + println("* STATUS " + mailbox + " (" + response + ")"); + break; + } + case APPEND: { + String m = token().astring(); + int flags = 0; + Date arrival = new Date(); + Parser.Token t = token(); + if (t.type == t.LIST) { flags = t.flags(); t = token(); } + if (t.type != t.QUOTED) { arrival = t.datetime(); t = token(); } + api.append(m, flags, arrival, t.q()); + break; } + case STORE: { + selected(); + Query q = uid ? Query.uid(token().set(maxn(uid))) : Query.imapNumber(token().set(maxn(uid))); + String s = token().atom().toUpperCase(); + int flags = token().flags(); + if (s.equals("FLAGS")) api.setFlags(q, flags, uid, false); + else if (s.equals("+FLAGS")) api.addFlags(q, flags, uid, false); + else if (s.equals("-FLAGS")) api.removeFlags(q, flags, uid, false); + else if (s.equals("FLAGS.SILENT")) api.setFlags(q, flags, uid, true); + else if (s.equals("+FLAGS.SILENT")) api.addFlags(q, flags, uid, true); + else if (s.equals("-FLAGS.SILENT")) api.removeFlags(q, flags, uid, true); + else throw new Server.Bad("unknown STORE specifier " + s); + break; } + default: throw new Server.Bad("unrecognized command \"" + command + "\""); + } + println(tag+" OK "+command+" Completed. " + + (commandKey == LOGIN ? ("[CAPABILITY "+Printer.join(" ", api.capability())+"]") : "")); + try { + newline(); + } catch (Stream.EOF e) { + Log.info(this, "connection closed"); + return; + } + } catch (Server.Bad b) { println(tag==null ? "* BAD Invalid tag":(tag + " Bad " + b.toString())); Log.warn(this,b); + } catch (Server.No n) { println(tag==null?"* BAD Invalid tag":(tag+" No " + n.toString())); Log.warn(this,n); } } + private Parser.Token[] lastfetch = null; // hack + private boolean lastuid = false; // hack + private boolean selected = false; + private void selected() { if (!selected) throw new Server.Bad("no mailbox selected"); } + + // Callbacks ////////////////////////////////////////////////////////////////////////////// + + public void expunge(int uid) { println("* " + uid + " EXPUNGE"); } + public void fetch(int n, int f, int size, Message m, int muid) { fetch(m, lastfetch, n, f, size, lastuid, muid); } + public void list(char sep, String mb, boolean sub, boolean p) { + println("* " + (sub?"LSUB":"LIST")+" ("+(p?"\\Noselect":"")+") \""+sep+"\" \""+mb+"\"");} + + /** + * Parse a fetch request or emit a fetch reply. + * + * To avoid duplicating tedious parsing logic, this function + * performs both of the following tasks: + * - parse the fetch request in Token[] t and return a fetch spec + * - emit a fetch reply for the parsed spec with respect to message m + */ + private void fetch(Object o, Parser.Token[] t, int num, int flags, int size, boolean uid, int muid) { + Query q = o == null ? null : o instanceof Query ? (Query)o : null; + Message m = o == null ? null : o instanceof Message ? (Message)o : null; + boolean e = q == null; + + // asynchronous flags update + if (size == -1) { + println("* " + num + " FETCH (FLAGS " + Printer.flags(flags) + (uid?(" UID "+muid):"") + ")"); + return; + } - // FEATURE: hoist the parsing here - public void store(Query q, String what, Token[] flags) { - for(Mailbox.Iterator it = selected.iterator(q); it.next(); ) { - Message m = it.cur(); - if (what.charAt(0) == 'F') { - it.deleted(false); it.seen(false); it.flagged(false); it.draft(false); it.answered(false); it.recent(false); } - for(int j=0; j initlen) r.append(" "); + if (t[i] == null || t[i].s == null) continue; + String s = t[i].s.toUpperCase(); + r.append(s.equalsIgnoreCase("BODY.PEEK")?"BODY":s); + if (s.equals("BODYSTRUCTURE")) { spec|=BODYSTRUCTURE;if(e){r.append(" ");r.append(Printer.bodystructure(m));} + } else if (s.equals("ENVELOPE")) { spec|=ENVELOPE; if(e){r.append(" ");r.append(Printer.envelope(m));} + } else if (s.equals("FLAGS")) { spec|=FLAGS; if(e){r.append(" ");r.append(Printer.flags(flags));} + } else if (s.equals("INTERNALDATE")) { spec|=INTERNALDATE; if(e){r.append(" ");r.append(Printer.date(m.arrival));} + } else if (s.equals("RFC822")) { spec|=RFC822; if(e){r.append(" ");r.append(Printer.message(m));} + } else if (s.equals("RFC822.TEXT")) { spec|=RFC822TEXT; if(e){r.append(" ");r.append(Printer.qq(getBodyString(m)));} + } else if (s.equals("RFC822.HEADER")){ spec|=HEADER;if(e){r.append(" ");r.append(Printer.qq(m.headers.getString()+"\r\n"));} + } else if (s.equals("RFC822.SIZE")) { spec|=RFC822SIZE; if(e){r.append(" ");r.append(m.getLength());} + } else if (s.equals("UID")) { spec|=UID; if(e){r.append(" ");r.append(muid); } + } else if (!(s.equals("BODY.PEEK") || s.equals("BODY"))) { throw new Server.No("unknown fetch argument: " + s); + } else { + if (s.equalsIgnoreCase("BODY.PEEK")) spec |= PEEK; + //else if (e) api.addFlags(Query.imapNumber(new int[] { num, num }), Mailbox.Flag.SEEN, false, false); + if (i >= t.length - 1 || t[i+1].type != Parser.Token.LIST) { + spec |= BODYSTRUCTURE; + if (e) { r.append(" "); r.append(Printer.bodystructure(m)); } continue; + //{ if (e) { r.append(" "); r.append(Printer.qq(m.body)); } continue; } + } + String payload = ""; + r.append("["); + Parser.Token[] list = t[++i].l(); + s = list.length == 0 ? "" : list[0].s.toUpperCase(); + r.append(s); + if (list.length == 0) { spec |= RFC822TEXT; if(e) payload = m.headers.getString()+"\r\n"+getBodyString(m); } + else if (s.equals("") || s.equals("1")) { spec |= RFC822TEXT; if(e) payload = m.headers.getString()+"\r\n"+getBodyString(m); } + else if (s.equals("TEXT")) { spec |= RFC822TEXT; if(e) payload = getBodyString(m); } + else if (s.equals("HEADER")) { spec |= HEADER; if(e) payload = m.headers.getString()+"\r\n"; } + else if (s.equals("HEADER.FIELDS")) { spec |= FIELDS; payload=headers(r,t[i].l()[1].sl(),false,m,e); } + else if (s.equals("HEADER.FIELDS.NOT")) { spec |= FIELDSNOT; payload=headers(r,t[i].l()[1].sl(),true,m,e); } + else if (s.equals("MIME")) { throw new Server.Bad("MIME not supported"); } + else throw new Server.Bad("unknown section type " + s); + if (i')); + int dot = s.indexOf('.'); + start = dot == -1 ? Integer.parseInt(s) : Integer.parseInt(s.substring(0, s.indexOf('.'))); + end = dot == -1 ? -1 : Integer.parseInt(s.substring(s.indexOf('.') + 1)); + if (e) { payload = payload.substring(start, Math.min(end+1,payload.length())); r.append("<"+start+">"); } + } + if (e) { r.append("] "); r.append(Printer.qq(payload)); } } - pw.flush(); - newline(); } + if (e) { + r.append(")"); + println("* " + r.toString()); + } else { + api.fetch(q, spec, headers, start, end, uid); + } } - - // Unparsing (printing) logic ////////////////////////////////////////////////////////////////////////////// - - static String quotify(String s){return s==null?"NIL":"\""+s.replaceAll("\\\\","\\\\").replaceAll("\"","\\\\\"")+"\"";} - static String quotify(Date d) { return new SimpleDateFormat("dd-MMM-yyyy HH:mm:ss +zzzz").format(d); } - static String address(Address a) {return"("+quotify(a.description)+" NIL "+quotify(a.user)+" "+quotify(a.host)+")"; } - public static String addressList(Object a) { - if (a == null) return "NIL"; - if (a instanceof Address) return "("+address((Address)a)+")"; - Address[] aa = (Address[])a; - StringBuffer ret = new StringBuffer(); - ret.append("("); - for(int i=0; i")) { - startend = s.substring(s.indexOf('<'), s.indexOf('>')); - s = s.substring(0, s.indexOf('<')); - } - if (s.equalsIgnoreCase("BODY.PEEK")) b.peek = true; - else if (s.equalsIgnoreCase("BODY")) b.peek = false; - else throw new Exn.No("unknown fetch argument: " + s); - - if (i= '0' && s2.charAt(0) <= '9') { - mimeVec.addElement(new Integer(Integer.parseInt(s2.substring(0, s2.indexOf('.'))))); - s2 = s2.substring(s2.indexOf('.') + 1); - } - if (mimeVec.size() > 0) { - b.path = new int[mimeVec.size()]; - for(int j=0; j