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 Object get(Object key) {
  14         if (key instanceof String) return slash((String)key, true);
  15         return null;
  16     }
  17
  18     public static final String STORAGE_ROOT =
  19         System.getProperty("ibex.mail.root", File.separatorChar + "var" + File.separatorChar + "org.ibex.mail");
  20
  21
  22     // Required Methods //////////////////////////////////////////////////////////////////////////////
  23
  24     /** phantom mailboxes merely contain others; like the alt.binaries in alt.binaries.warez */
  25     public abstract boolean          phantom();
  26     public abstract Mailbox.Iterator iterator(Query q);
  27     public abstract void             add(Message message);
  28     public abstract void             add(Message message, int flags);
  29     public abstract void             move(Query q, Mailbox dest);
  30     public abstract void             copy(Query q, Mailbox dest);
  31     public abstract int              count(Query q);
  32     public abstract int              uidNext();
  33     public abstract void             rename(String newName);      /* FIXME: IMAP semantics require creating parent dirs */
  34     public abstract void             destroy(boolean recursive);
  35     public abstract Mailbox          slash(String name, boolean create);
  36     public abstract String[]         children();
  37
  38
  39     // Thunks ////////////////////////////////////////////////////////////////////////////
  40
  41     public final    void             accept(Message m) { add(m); }
  42     public          Mailbox.Iterator iterator() { return iterator(Query.all()); }
  43
  44
  45     // Default Implementation //////////////////////////////////////////////////////////////////////////////
  46
  47     private int randomUidValidity = new Random().nextInt();
  48     public  int uidValidity()  { return randomUidValidity; }
  49
  50     /** default, inefficient implementation of Mailbox; only requires a few methods to be implemented */
  51     public static abstract class Default extends Mailbox {
  52         public Mailbox.Iterator iterator(Query q) { return new Mailbox.Iterator.QueryIterator(q, this); }
  53         public boolean phantom() { return false; }
  54         public void copy(Query q, Mailbox dest) { for(Mailbox.Iterator it = iterator(q); it.next();) dest.add(it.cur()); }
  55         public int count(Query q) { int count = 0; for(Mailbox.Iterator it = iterator(q); it.next();) count++; return count; }
  56         public void rename(String newName) { throw new MailException("not supported"); }
  57         public void  destroy(boolean recursive) { throw new MailException("not supported"); }
  58         public Mailbox slash(String name, boolean create) { return null; }
  59         public String[] children() { return new String[] { }; }
  60         public void move(Query q, Mailbox dest) {
  61             for(Mailbox.Iterator it = iterator(q);it.next();) { dest.add(it.cur()); it.delete(); }
  62         }
  63         public static abstract class Iterator implements Mailbox.Iterator {
  64             public boolean seen() { return false; }
  65             public boolean deleted() { return false; }
  66             public boolean flagged() { return false; }
  67             public boolean draft() { return false; }
  68             public boolean answered() { return false; }
  69             public boolean recent() { return false; }
  70             public void    seen(boolean on) { }
  71             public void    deleted(boolean on) { }
  72             public void    flagged(boolean on) { }
  73             public void    draft(boolean on) { }
  74             public void    answered(boolean on) { }
  75             public void    recent(boolean on) { }
  76             public void    set(String key, String val) { throw new MailException("not supported"); }
  77             public String  get(String key) { throw new MailException("not supported"); }
  78             public int flags() {
  79                 return
  80                     (deleted() ? Flag.DELETED : 0) |
  81                     (seen() ? Flag.SEEN : 0) |
  82                     (answered() ? Flag.ANSWERED : 0) |
  83                     (draft() ? Flag.DRAFT : 0) |
  84                     (recent() ? Flag.RECENT : 0);
  85             }
  86             public void addFlags(int flags) {
  87                 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true);
  88                 if ((flags & Flag.SEEN) == Flag.SEEN) seen(true);
  89                 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true);
  90                 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true);
  91                 if ((flags & Flag.RECENT) == Flag.RECENT) recent(true);
  92             }
  93             public void removeFlags(int flags) {
  94                 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(false);
  95                 if ((flags & Flag.SEEN) == Flag.SEEN) seen(false);
  96                 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(false);
  97                 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(false);
  98                 if ((flags & Flag.RECENT) == Flag.RECENT) recent(false);
  99             }
 100             public void setFlags(int flags) {
 101                 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true); else deleted(false);
 102                 if ((flags & Flag.SEEN) == Flag.SEEN) seen(true); else seen(false);
 103                 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true); else flagged(false);
 104                 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true); else draft(false);
 105                 if ((flags & Flag.RECENT) == Flag.RECENT) recent(true); else recent(false);
 106             }
 107         }
 108     }
 109
 110
 111     // Iterator Definition //////////////////////////////////////////////////////////////////////////////
 112
 113     public static interface Iterator {
 114         public abstract Message cur();
 115         public abstract MIME.Headers head();
 116         public abstract boolean next();
 117         public abstract int     uid();
 118         public abstract int     num();
 119         public abstract void    delete();
 120
 121         public abstract void    set(String key, String val);
 122         public abstract String  get(String key);
 123
 124         public abstract boolean seen();
 125         public abstract boolean deleted();
 126         public abstract boolean flagged();
 127         public abstract boolean draft();
 128         public abstract boolean answered();
 129         public abstract boolean recent();
 130
 131         public abstract void    seen(boolean on);
 132         public abstract void    deleted(boolean on);
 133         public abstract void    flagged(boolean on);
 134         public abstract void    draft(boolean on);
 135         public abstract void    answered(boolean on);
 136         public abstract void    recent(boolean on);
 137
 138         public abstract int     flags();
 139         public abstract void    addFlags(int flags);
 140         public abstract void    removeFlags(int flags);
 141         public abstract void    setFlags(int flags);
 142
 143         public static class Wrapper implements Iterator {
 144             private Iterator it;
 145             public Wrapper(Iterator it) { this.it = it; }
 146             public Message cur() { return it.cur(); }
 147             public MIME.Headers head() { return it.head(); }
 148             public boolean next() { return it.next(); }
 149             public int     uid() { return it.uid(); }
 150             public int     flags() { return it.flags(); }
 151             public int     num() { return it.num(); }
 152             public void    set(String key, String val) { it.set(key, val); }
 153             public String  get(String key) { return it.get(key); }
 154             public void    delete() { it.delete(); }
 155             public boolean seen() { return it.seen(); }
 156             public boolean deleted() { return it.deleted(); }
 157             public boolean flagged() { return it.flagged(); }
 158             public boolean draft() { return it.draft(); }
 159             public boolean answered() { return it.answered(); }
 160             public boolean recent() { return it.recent(); }
 161             public void    seen(boolean on) { it.seen(on); }
 162             public void    deleted(boolean on) { it.deleted(on); }
 163             public void    flagged(boolean on) { it.flagged(on); }
 164             public void    draft(boolean on) { it.draft(on); }
 165             public void    answered(boolean on) { it.answered(on); }
 166             public void    recent(boolean on) { it.recent(on); }
 167             public void    addFlags(int flags) { it.addFlags(flags); }
 168             public void    removeFlags(int flags) { it.removeFlags(flags); }
 169             public void    setFlags(int flags) { it.setFlags(flags); }
 170         }
 171
 172         class QueryIterator extends Mailbox.Iterator.Wrapper {
 173             Query q;
 174             public QueryIterator(Query q, Mailbox m) { super(m.iterator()); this.q = q; }
 175             public boolean next() {
 176                 if (q == null) return false;
 177                 do { if (!super.next()) return false; } while(!q.match(this)); return true; }
 178         }
 179
 180         public static class NullIterator extends Mailbox.Default.Iterator {
 181             public NullIterator() { }
 182             public Message cur() { return null; }
 183             public MIME.Headers head() { return null; }
 184             public boolean next() { return false; }
 185             public int     uid() { return 0; }
 186             public int     flags() { return 0; }
 187             public int     num() { return 0; }
 188             public void    set(String key, String val) { }
 189             public String  get(String key) { return null; }
 190             public void    delete() { }
 191             public boolean seen() { return false; }
 192             public boolean deleted() { return false; }
 193             public boolean flagged() { return false; }
 194             public boolean draft() { return false; }
 195             public boolean answered() { return false; }
 196             public boolean recent() { return false; }
 197             public void    seen(boolean on) { }
 198             public void    deleted(boolean on) { }
 199             public void    flagged(boolean on) { }
 200             public void    draft(boolean on) { }
 201             public void    answered(boolean on) { }
 202             public void    recent(boolean on) { }
 203         }
 204     }
 205
 206     /** constants for the six IMAP flags */
 207     public static class Flag {
 208         public static final int DELETED  = 0x0001;
 209         public static final int SEEN     = 0x0002;
 210         public static final int FLAGGED  = 0x0004;
 211         public static final int DRAFT    = 0x0008;
 212         public static final int ANSWERED = 0x0010;
 213         public static final int RECENT   = 0x0020;
 214     }
 215
 216 }