src/org/ibex/mail/Mailbox.java

   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.
   4
   5 package org.ibex.mail;
   6 import org.ibex.mail.*;
   7 import org.ibex.util.*;
   8 import org.ibex.mail.*;
   9 import org.ibex.js.*;
  10 import java.io.*;
  11 import java.net.*;
  12 import java.util.*;
  13 import java.text.*;
  14
  15 /** abstract superclass for mailboxes, which store messages along with their flags */
  16 public abstract class Mailbox extends JS.Obj implements Target {
  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     public abstract Mailbox.Iterator iterator(Query q);
  25
  26     public abstract void             insert(Message message, int flags);
  27     public abstract void             post(Message message);
  28     public abstract void             move(Query q, Mailbox dest);
  29     public abstract void             copy(Query q, Mailbox dest);
  30     public abstract int              count(Query q);
  31     public abstract int              uidNext();
  32
  33     // Thunks ////////////////////////////////////////////////////////////////////////////
  34
  35     public          void             accept(Message m) { insert(m, Flag.RECENT); }
  36     public          Mailbox.Iterator iterator() { return iterator(Query.all()); }
  37
  38
  39     // Default Implementation //////////////////////////////////////////////////////////////////////////////
  40
  41     private int randomUidValidity = new Random().nextInt();
  42     public  int uidValidity()  { return randomUidValidity; }
  43
  44     /** default, inefficient implementation of Mailbox; only requires a few methods to be implemented */
  45     public static abstract class Default extends Mailbox {
  46         public Mailbox.Iterator iterator(Query q) { return new Mailbox.Iterator.QueryIterator(q, this); }
  47         public void copy(Query q, Mailbox dest) { for(Mailbox.Iterator it = iterator(q); it.next();) dest.insert(it.cur(), it.getFlags()); }
  48         public int count(Query q) { int count = 0; for(Mailbox.Iterator it = iterator(q); it.next();) count++; return count; }
  49         public MailTree slash(String name, boolean create) { return null; }
  50         public String[] children() { return new String[] { }; }
  51         public void post(Message message) { insert(message, Flag.RECENT); }
  52         public void move(Query q, Mailbox dest) {
  53             for(Mailbox.Iterator it = iterator(q);it.next();) { dest.insert(it.cur(), it.getFlags()); it.delete(); }
  54         }
  55         public static abstract class Iterator implements Mailbox.Iterator {
  56             // FIXME: NNTP spec allows us to use longs (64-bit) here
  57             // FIXME: NNTP spec requires that the minimum nntpNumber of a group must never, ever decrease (no, that's not a typo)
  58             public int     nntpNumber() { throw new MailException("not supported"); }
  59             public int     getFlags() { return 0; }
  60             public void    setFlags(int flags) { throw new MailException("not supported"); }
  61         }
  62     }
  63
  64
  65     // Iterator Definition //////////////////////////////////////////////////////////////////////////////
  66
  67     public static interface Iterator {
  68         public abstract Message cur();
  69         public abstract Headers head();
  70         public abstract boolean next();
  71         public abstract void    delete();
  72
  73         /** a unique identifier for this message */
  74         public abstract int     uid();
  75
  76         /**
  77          *  Message number according to IMAP semantics.
  78          *    - must range from 1..numMessagesInMailbox
  79          *    - no two messages in the same mailbox may have the same imapNumber
  80          *    - sorting by uid must yield the same order as sorting them by imapNumber
  81          *    - imapNumber changes when messages with lower imapNumbers are deleted
  82          */
  83         public abstract int     imapNumber();
  84
  85         /**
  86          *  Message number according to NNTP semantics.
  87          *    - no two messages in the same mailbox may have the same nntpNumber
  88          *    - article number may NEVER change or EVER be reused
  89          *    - uidValidity is irrelevant
  90          */
  91         public abstract int     nntpNumber();
  92
  93         public abstract int     getFlags();
  94         public abstract void    setFlags(int flags);
  95
  96         public static class Wrapper implements Iterator {
  97             private Iterator it;
  98             public Wrapper(Iterator it) { this.it = it; }
  99             public Message cur() { return it.cur(); }
 100             public Headers head() { return it.head(); }
 101             public boolean next() { return it.next(); }
 102             public int     uid() { return it.uid(); }
 103             public int     nntpNumber() { return it.nntpNumber(); }
 104             public int     imapNumber() { return it.imapNumber(); }
 105             public void    delete() { it.delete(); }
 106             public int     getFlags() { return it.getFlags(); }
 107             public void    setFlags(int flags) { it.setFlags(flags); }
 108         }
 109
 110         public static class AclWrapper extends Wrapper {
 111             private Acl.Entry acl;
 112             public AclWrapper(Iterator it, Acl.Entry acl) { super(it); this.acl = acl; }
 113             public Message cur() { if (acl.read && acl.list) return super.cur(); else throw new Acl.PermissionDenied(); }
 114             public Headers head() { if (acl.read && acl.list) return super.head(); else throw new Acl.PermissionDenied(); }
 115             public boolean next() { if (acl.list) return super.next(); else throw new Acl.PermissionDenied(); }
 116             public int     uid() { if (acl.list) return super.uid(); else throw new Acl.PermissionDenied(); }
 117             public int     nntpNumber() { if (acl.list) return super.nntpNumber(); else throw new Acl.PermissionDenied(); }
 118             public int     imapNumber() { if (acl.list) return super.imapNumber(); else throw new Acl.PermissionDenied(); }
 119             public void    delete() { if (acl.delete) super.delete(); else throw new Acl.PermissionDenied(); }
 120             public int     getFlags() { if (acl.list) return super.getFlags(); else throw new Acl.PermissionDenied(); }
 121             public void    setFlags(int flags) { if (acl.flags) super.setFlags(flags); else throw new Acl.PermissionDenied(); }
 122         }
 123
 124         class QueryIterator extends Mailbox.Iterator.Wrapper {
 125             Query q;
 126             public QueryIterator(Query q, Mailbox m) { super(m.iterator()); this.q = q; }
 127             public boolean next() {
 128                 if (q == null) return false;
 129                 do { if (!super.next()) return false; } while(!q.match(this)); return true; }
 130         }
 131
 132         public static class NullIterator extends Mailbox.Default.Iterator {
 133             public NullIterator() { }
 134             public Message cur() { return null; }
 135             public Headers head() { return null; }
 136             public boolean next() { return false; }
 137             public int     uid() { return 0; }
 138             public void    delete() { }
 139             public int     imapNumber() { return 0; }
 140             public int     nntpNumber() { throw new RuntimeException("this mailbox does not keep article numbers"); }
 141         }
 142     }
 143
 144     /** constants for the six IMAP flags */
 145     public static class Flag {
 146         public static final int DELETED  = 0x0001;
 147         public static final int SEEN     = 0x0002;
 148         public static final int FLAGGED  = 0x0004;
 149         public static final int DRAFT    = 0x0008;
 150         public static final int ANSWERED = 0x0010;
 151         public static final int RECENT   = 0x0020;
 152         public static final int[] all = new int[] { DELETED, SEEN, FLAGGED, DRAFT, ANSWERED, RECENT };
 153         public static final int defaultFlags = RECENT;
 154     }
 155
 156     public static class MailboxWrapper extends Mailbox {
 157         private Mailbox m;
 158         public MailboxWrapper(Mailbox m) { this.m = m; }
 159
 160         public Mailbox.Iterator iterator() { return m.iterator(); }
 161         public Mailbox.Iterator iterator(Query q) { return m.iterator(q); }
 162         public void             insert(Message message, int flags) { m.insert(message, flags); }
 163         public void             post(Message message) { m.insert(message, Flag.RECENT); }
 164         public void             move(Query q, Mailbox dest) { m.move(q, dest); }
 165         public void             copy(Query q, Mailbox dest) { m.copy(q, dest); }
 166         public int              count(Query q) { return m.count(q); }
 167         public int              uidNext() { return m.uidNext(); }
 168         public int              uidValidity()  { return m.uidValidity(); }
 169     }
 170
 171     public static class AclWrapper extends MailboxWrapper {
 172         private Mailbox m;
 173         private Acl.Entry acl;
 174         public AclWrapper(Mailbox m, Acl.Entry acl) { super(m); this.acl = acl; }
 175         public Mailbox.Iterator iterator(Query q) { if (acl.list) return new Mailbox.Iterator.AclWrapper(m.iterator(q), acl); else throw new Acl.PermissionDenied(); }
 176         public Mailbox.Iterator iterator() { if (acl.list) return new Mailbox.Iterator.AclWrapper(m.iterator(), acl); else throw new Acl.PermissionDenied(); }
 177         public void             insert(Message message, int flags) { if (acl.insert) m.insert(message, flags); else throw new Acl.PermissionDenied(); }
 178         public int              uidValidity()  { if (acl.list) return m.uidValidity(); else throw new Acl.PermissionDenied(); }
 179         public void             post(Message message) { if (acl.post) m.insert(message, Flag.RECENT); else throw new Acl.PermissionDenied(); }
 180         public void             move(Query q, Mailbox dest) { if (acl.list && acl.read && acl.delete) m.move(q, dest); else throw new Acl.PermissionDenied(); }
 181         public void             copy(Query q, Mailbox dest) { if (acl.list && acl.read) m.copy(q, dest); else throw new Acl.PermissionDenied(); }
 182         public int              count(Query q) { if (acl.list) return m.count(q); else throw new Acl.PermissionDenied(); }
 183         public int              uidNext() { if (acl.list) return m.uidNext(); else throw new Acl.PermissionDenied(); }
 184     }
 185 }