+// 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.target;
import org.ibex.mail.*;
import org.ibex.util.*;
import org.ibex.mail.*;
+import org.ibex.js.*;
import java.io.*;
import java.net.*;
import java.util.*;
import java.text.*;
/** abstract superclass for mailboxes, which store messages along with their flags */
-public abstract class Mailbox extends Target {
+public abstract class Mailbox extends JS.Obj implements Target {
+
+ public JS get(JS key) throws JSExn {
+ return slash(JSU.toString(key), true);
+ }
public static final String STORAGE_ROOT =
System.getProperty("ibex.mail.root", File.separatorChar + "var" + File.separatorChar + "org.ibex.mail");
// Required Methods //////////////////////////////////////////////////////////////////////////////
+ /** phantom mailboxes merely contain others; like the alt.binaries in alt.binaries.warez */
+ public abstract boolean phantom();
public abstract Mailbox.Iterator iterator(Query q);
- public abstract void add(Message message);
- public abstract void add(Message message, int flags);
+
+ public abstract void insert(Message message, int flags);
public abstract void move(Query q, Mailbox dest);
public abstract void copy(Query q, Mailbox dest);
public abstract int count(Query q);
public abstract int uidNext();
- public abstract int uidValidity();
- public abstract void rename(String newName);
- public abstract void destroy();
+ public abstract void rename(String newName); /* FIXME: IMAP semantics require creating parent dirs */
+ public abstract void destroy(boolean recursive);
public abstract Mailbox slash(String name, boolean create);
public abstract String[] children();
-
// Thunks ////////////////////////////////////////////////////////////////////////////
- public final void accept(Message m) { add(m); }
+ public void accept(Message m) { insert(m, Flag.RECENT); }
public Mailbox.Iterator iterator() { return iterator(Query.all()); }
// Default Implementation //////////////////////////////////////////////////////////////////////////////
+ private int randomUidValidity = new Random().nextInt();
+ public int uidValidity() { return randomUidValidity; }
+
/** default, inefficient implementation of Mailbox; only requires a few methods to be implemented */
public static abstract class Default extends Mailbox {
public Mailbox.Iterator iterator(Query q) { return new Mailbox.Iterator.QueryIterator(q, this); }
- public void copy(Query q, Mailbox dest) { for(Mailbox.Iterator it = iterator(q); it.next();) dest.add(it.cur()); }
+ public boolean phantom() { return false; }
+ public void copy(Query q, Mailbox dest) { for(Mailbox.Iterator it = iterator(q); it.next();) dest.insert(it.cur(), it.getFlags()); }
public int count(Query q) { int count = 0; for(Mailbox.Iterator it = iterator(q); it.next();) count++; return count; }
public void rename(String newName) { throw new MailException("not supported"); }
- public void destroy() { throw new MailException("not supported"); }
- public Mailbox slash(String name, boolean create) { throw new MailException("not supported"); }
+ public void destroy(boolean recursive) { throw new MailException("not supported"); }
+ public Mailbox slash(String name, boolean create) { return null; }
public String[] children() { return new String[] { }; }
public void move(Query q, Mailbox dest) {
- for(Mailbox.Iterator it = iterator(q);it.next();) { dest.add(it.cur()); it.delete(); }
+ for(Mailbox.Iterator it = iterator(q);it.next();) { dest.insert(it.cur(), it.getFlags()); it.delete(); }
}
public static abstract class Iterator implements Mailbox.Iterator {
- public void addFlags(int flags) {
- if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true);
- if ((flags & Flag.SEEN) == Flag.SEEN) seen(true);
- if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true);
- if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true);
- if ((flags & Flag.RECENT) == Flag.RECENT) recent(true);
- }
- public void removeFlags(int flags) {
- if ((flags & Flag.DELETED) == Flag.DELETED) deleted(false);
- if ((flags & Flag.SEEN) == Flag.SEEN) seen(false);
- if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(false);
- if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(false);
- if ((flags & Flag.RECENT) == Flag.RECENT) recent(false);
- }
- public void setFlags(int flags) {
- if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true); else deleted(false);
- if ((flags & Flag.SEEN) == Flag.SEEN) seen(true); else seen(false);
- if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true); else flagged(false);
- if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true); else draft(false);
- if ((flags & Flag.RECENT) == Flag.RECENT) recent(true); else recent(false);
- }
+ public int nntpNumber() { throw new MailException("not supported"); }
+ public int getFlags() { return 0; }
+ public boolean getFlag(int flag) { return false; }
+ public void setFlag(int flag, boolean set) { throw new RuntimeException("not implemented"); }
}
}
public static interface Iterator {
public abstract Message cur();
+ public abstract Headers head();
public abstract boolean next();
- public abstract int uid();
- public abstract int num();
public abstract void delete();
- public abstract void set(String key, String val);
- public abstract String get(String key);
- public abstract boolean seen();
- public abstract boolean deleted();
- public abstract boolean flagged();
- public abstract boolean draft();
- public abstract boolean answered();
- public abstract boolean recent();
- public abstract void seen(boolean on);
- public abstract void deleted(boolean on);
- public abstract void flagged(boolean on);
- public abstract void draft(boolean on);
- public abstract void answered(boolean on);
- public abstract void recent(boolean on);
- public abstract void addFlags(int flags);
- public abstract void removeFlags(int flags);
- public abstract void setFlags(int flags);
+
+ /** a unique identifier for this message */
+ public abstract int uid();
+
+ /**
+ * Message number according to IMAP semantics.
+ * - no two messages in the same mailbox may have the same imapNumber
+ * - sorting by uid must yield the same order as sorting them by imapNumber
+ * - imapNumber may only change if uidValidity changes
+ * - if uidValidity changes, imapNumbers may change or be reused
+ */
+ public abstract int imapNumber();
+
+ /**
+ * Message number according to NNTP semantics.
+ * - no two messages in the same mailbox may have the same nntpNumber
+ * - article number may NEVER change or EVER be reused
+ * - uidValidity is irrelevant
+ */
+ public abstract int nntpNumber();
+
+ public abstract int getFlags();
+ public abstract boolean getFlag(int flag);
+ public abstract void setFlag(int flag, boolean set);
public static class Wrapper implements Iterator {
private Iterator it;
public Wrapper(Iterator it) { this.it = it; }
public Message cur() { return it.cur(); }
+ public Headers head() { return it.head(); }
public boolean next() { return it.next(); }
public int uid() { return it.uid(); }
- public int num() { return it.num(); }
- public void set(String key, String val) { it.set(key, val); }
- public String get(String key) { return it.get(key); }
+ public int nntpNumber() { return it.nntpNumber(); }
+ public int imapNumber() { return it.imapNumber(); }
public void delete() { it.delete(); }
- public boolean seen() { return it.seen(); }
- public boolean deleted() { return it.deleted(); }
- public boolean flagged() { return it.flagged(); }
- public boolean draft() { return it.draft(); }
- public boolean answered() { return it.answered(); }
- public boolean recent() { return it.recent(); }
- public void seen(boolean on) { it.seen(on); }
- public void deleted(boolean on) { it.deleted(on); }
- public void flagged(boolean on) { it.flagged(on); }
- public void draft(boolean on) { it.draft(on); }
- public void answered(boolean on) { it.answered(on); }
- public void recent(boolean on) { it.recent(on); }
- public void addFlags(int flags) { it.addFlags(flags); }
- public void removeFlags(int flags) { it.removeFlags(flags); }
- public void setFlags(int flags) { it.setFlags(flags); }
+ public int getFlags() { return it.getFlags(); }
+ public boolean getFlag(int flag) { return it.getFlag(flag); }
+ public void setFlag(int flag, boolean set) { it.setFlag(flag, set); }
}
class QueryIterator extends Mailbox.Iterator.Wrapper {
Query q;
public QueryIterator(Query q, Mailbox m) { super(m.iterator()); this.q = q; }
- public boolean next() { do { if (!super.next()) return false; } while(!q.match(this)); return true; }
+ public boolean next() {
+ if (q == null) return false;
+ do { if (!super.next()) return false; } while(!q.match(this)); return true; }
+ }
+
+ public static class NullIterator extends Mailbox.Default.Iterator {
+ public NullIterator() { }
+ public Message cur() { return null; }
+ public Headers head() { return null; }
+ public boolean next() { return false; }
+ public int uid() { return 0; }
+ public void delete() { }
+ public int imapNumber() { return 0; }
+ public int nntpNumber() { throw new RuntimeException("this mailbox does not keep article numbers"); }
}
}
public static final int DRAFT = 0x0008;
public static final int ANSWERED = 0x0010;
public static final int RECENT = 0x0020;
+ public static final int[] all = new int[] { DELETED, SEEN, FLAGGED, DRAFT, ANSWERED, RECENT };
+ public static final int defaultFlags = RECENT;
}
-
+
+ public static class MailboxWrapper extends Mailbox {
+
+ private Mailbox m;
+ public MailboxWrapper(Mailbox m) { this.m = m; }
+
+ public boolean phantom() { return m.phantom(); }
+ public Mailbox.Iterator iterator(Query q) { return m.iterator(q); }
+ public void insert(Message message, int flags) { m.insert(message, flags); }
+ public void move(Query q, Mailbox dest) { m.move(q, dest); }
+ public void copy(Query q, Mailbox dest) { m.copy(q, dest); }
+ public int count(Query q) { return m.count(q); }
+ public int uidNext() { return m.uidNext(); }
+ public void rename(String newName) { m.rename(newName); }
+ public void destroy(boolean recursive) { m.destroy(recursive); }
+ public Mailbox slash(String name, boolean create) { return m.slash(name, create); }
+ public String[] children() { return m.children(); }
+ public Mailbox.Iterator iterator() { return m.iterator(); }
+ public int uidValidity() { return m.uidValidity(); }
+ }
+
}
projects / org.ibex.mail.git / blobdiff