src/org/ibex/mail/target/Mailbox.java

   1 package org.ibex.mail.target;
   2 import org.ibex.mail.*;
   3 import org.ibex.util.*;
   4 import org.ibex.mail.*;
   5 import java.io.*;
   6 import java.net.*;
   7 import java.util.*;
   8 import java.text.*;
   9
  10 /** abstract superclass for mailboxes, which store messages along with their flags */
  11 public abstract class Mailbox extends Target {
  12
  13     public static final String STORAGE_ROOT =
  14         System.getProperty("ibex.mail.root", File.separatorChar + "var" + File.separatorChar + "org.ibex.mail");
  15
  16
  17     // Required Methods //////////////////////////////////////////////////////////////////////////////
  18
  19     /** phantom mailboxes merely contain others; like the alt.binaries in alt.binaries.warez */
  20     public abstract boolean          phantom();
  21     public abstract Mailbox.Iterator iterator(Query q);
  22     public abstract void             add(Message message);
  23     public abstract void             add(Message message, int flags);
  24     public abstract void             move(Query q, Mailbox dest);
  25     public abstract void             copy(Query q, Mailbox dest);
  26     public abstract int              count(Query q);
  27     public abstract int              uidNext();
  28     public abstract int              uidValidity();
  29     public abstract void             rename(String newName);      /* FIXME: IMAP semantics require creating parent dirs */
  30     public abstract void             destroy(boolean recursive);
  31     public abstract Mailbox          slash(String name, boolean create);
  32     public abstract String[]         children();
  33
  34
  35     // Thunks ////////////////////////////////////////////////////////////////////////////
  36
  37     public final    void             accept(Message m) { add(m); }
  38     public          Mailbox.Iterator iterator() { return iterator(Query.all()); }
  39
  40
  41     // Default Implementation //////////////////////////////////////////////////////////////////////////////
  42
  43     /** default, inefficient implementation of Mailbox; only requires a few methods to be implemented */
  44     public static abstract class Default extends Mailbox {
  45         public Mailbox.Iterator iterator(Query q) { return new Mailbox.Iterator.QueryIterator(q, this); }
  46         public boolean phantom() { return false; }
  47         public void copy(Query q, Mailbox dest) { for(Mailbox.Iterator it = iterator(q); it.next();) dest.add(it.cur()); }
  48         public int count(Query q) { int count = 0; for(Mailbox.Iterator it = iterator(q); it.next();) count++; return count; }
  49         public void rename(String newName) { throw new MailException("not supported"); }
  50         public void  destroy(boolean recursive) { throw new MailException("not supported"); }
  51         public Mailbox slash(String name, boolean create) { throw new MailException("not supported"); }
  52         public String[] children() { return new String[] { }; }
  53         public void move(Query q, Mailbox dest) {
  54             for(Mailbox.Iterator it = iterator(q);it.next();) { dest.add(it.cur()); it.delete(); }
  55         }
  56         public static abstract class Iterator implements Mailbox.Iterator {
  57             public int flags() {
  58                 return
  59                     (deleted() ? Flag.DELETED : 0) |
  60                     (seen() ? Flag.SEEN : 0) |
  61                     (answered() ? Flag.ANSWERED : 0) |
  62                     (draft() ? Flag.DRAFT : 0) |
  63                     (recent() ? Flag.RECENT : 0);
  64             }
  65             public void addFlags(int flags) {
  66                 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true);
  67                 if ((flags & Flag.SEEN) == Flag.SEEN) seen(true);
  68                 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true);
  69                 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true);
  70                 if ((flags & Flag.RECENT) == Flag.RECENT) recent(true);
  71             }
  72             public void removeFlags(int flags) {
  73                 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(false);
  74                 if ((flags & Flag.SEEN) == Flag.SEEN) seen(false);
  75                 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(false);
  76                 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(false);
  77                 if ((flags & Flag.RECENT) == Flag.RECENT) recent(false);
  78             }
  79             public void setFlags(int flags) {
  80                 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true); else deleted(false);
  81                 if ((flags & Flag.SEEN) == Flag.SEEN) seen(true); else seen(false);
  82                 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true); else flagged(false);
  83                 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true); else draft(false);
  84                 if ((flags & Flag.RECENT) == Flag.RECENT) recent(true); else recent(false);
  85             }
  86         }
  87     }
  88
  89
  90     // Iterator Definition //////////////////////////////////////////////////////////////////////////////
  91
  92     public static interface Iterator {
  93         public abstract int flags();
  94         public abstract Message cur();
  95         public abstract boolean next();
  96         public abstract int     uid();
  97         public abstract int     num();
  98         public abstract void    delete();
  99         public abstract void    set(String key, String val);
 100         public abstract String  get(String key);
 101         public abstract boolean seen();
 102         public abstract boolean deleted();
 103         public abstract boolean flagged();
 104         public abstract boolean draft();
 105         public abstract boolean answered();
 106         public abstract boolean recent();
 107         public abstract void    seen(boolean on);
 108         public abstract void    deleted(boolean on);
 109         public abstract void    flagged(boolean on);
 110         public abstract void    draft(boolean on);
 111         public abstract void    answered(boolean on);
 112         public abstract void    recent(boolean on);
 113         public abstract void    addFlags(int flags);
 114         public abstract void    removeFlags(int flags);
 115         public abstract void    setFlags(int flags);
 116
 117         public static class Wrapper implements Iterator {
 118             private Iterator it;
 119             public Wrapper(Iterator it) { this.it = it; }
 120             public Message cur() { return it.cur(); }
 121             public boolean next() { return it.next(); }
 122             public int     uid() { return it.uid(); }
 123             public int     flags() { return it.flags(); }
 124             public int     num() { return it.num(); }
 125             public void    set(String key, String val) { it.set(key, val); }
 126             public String  get(String key) { return it.get(key); }
 127             public void    delete() { it.delete(); }
 128             public boolean seen() { return it.seen(); }
 129             public boolean deleted() { return it.deleted(); }
 130             public boolean flagged() { return it.flagged(); }
 131             public boolean draft() { return it.draft(); }
 132             public boolean answered() { return it.answered(); }
 133             public boolean recent() { return it.recent(); }
 134             public void    seen(boolean on) { it.seen(on); }
 135             public void    deleted(boolean on) { it.deleted(on); }
 136             public void    flagged(boolean on) { it.flagged(on); }
 137             public void    draft(boolean on) { it.draft(on); }
 138             public void    answered(boolean on) { it.answered(on); }
 139             public void    recent(boolean on) { it.recent(on); }
 140             public void    addFlags(int flags) { it.addFlags(flags); }
 141             public void    removeFlags(int flags) { it.removeFlags(flags); }
 142             public void    setFlags(int flags) { it.setFlags(flags); }
 143         }
 144
 145         class QueryIterator extends Mailbox.Iterator.Wrapper {
 146             Query q;
 147             public QueryIterator(Query q, Mailbox m) { super(m.iterator()); this.q = q; }
 148             public boolean next() { do { if (!super.next()) return false; } while(!q.match(this)); return true; }
 149         }
 150     }
 151
 152     /** constants for the six IMAP flags */
 153     public static class Flag {
 154         public static final int DELETED  = 0x0001;
 155         public static final int SEEN     = 0x0002;
 156         public static final int FLAGGED  = 0x0004;
 157         public static final int DRAFT    = 0x0008;
 158         public static final int ANSWERED = 0x0010;
 159         public static final int RECENT   = 0x0020;
 160     }
 161
 162 }