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