more cleanup
[org.ibex.mail.git] / 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     public abstract Mailbox.Iterator iterator(Query q);
20     public abstract void             add(Message message);
21     public abstract void             add(Message message, int flags);
22     public abstract void             move(Query q, Mailbox dest);
23     public abstract void             copy(Query q, Mailbox dest);
24     public abstract int              count(Query q);
25     public abstract int              uidNext();
26     public abstract int              uidValidity();
27     public abstract void             rename(String newName);
28     public abstract void             destroy();
29     public abstract Mailbox          slash(String name, boolean create);
30     public abstract String[]         children();
31
32
33     // Thunks ////////////////////////////////////////////////////////////////////////////
34
35     public final    void             accept(Message m) { add(m); }
36     public          Mailbox.Iterator iterator() { return iterator(Query.all()); }
37
38
39     // Default Implementation //////////////////////////////////////////////////////////////////////////////
40
41     /** default, inefficient implementation of Mailbox; only requires a few methods to be implemented */
42     public static abstract class Default extends Mailbox {
43         public Mailbox.Iterator iterator(Query q) { return new Mailbox.Iterator.QueryIterator(q, this); }
44         public void copy(Query q, Mailbox dest) { for(Mailbox.Iterator it = iterator(q); it.next();) dest.add(it.cur()); }
45         public int count(Query q) { int count = 0; for(Mailbox.Iterator it = iterator(q); it.next();) count++; return count; }
46         public void rename(String newName) { throw new MailException("not supported"); }
47         public void  destroy() { throw new MailException("not supported"); }
48         public Mailbox slash(String name, boolean create) { throw new MailException("not supported"); }
49         public String[] children() { return new String[] { }; }
50         public void move(Query q, Mailbox dest) {
51             for(Mailbox.Iterator it = iterator(q);it.next();) { dest.add(it.cur()); it.delete(); }
52         }
53         public static abstract class Iterator implements Mailbox.Iterator {
54             public void addFlags(int flags) {
55                 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true);
56                 if ((flags & Flag.SEEN) == Flag.SEEN) seen(true);
57                 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true);
58                 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true);
59                 if ((flags & Flag.RECENT) == Flag.RECENT) recent(true);
60             }
61             public void removeFlags(int flags) {
62                 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(false);
63                 if ((flags & Flag.SEEN) == Flag.SEEN) seen(false);
64                 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(false);
65                 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(false);
66                 if ((flags & Flag.RECENT) == Flag.RECENT) recent(false);
67             }
68             public void setFlags(int flags) {
69                 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true); else deleted(false);
70                 if ((flags & Flag.SEEN) == Flag.SEEN) seen(true); else seen(false);
71                 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true); else flagged(false);
72                 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true); else draft(false);
73                 if ((flags & Flag.RECENT) == Flag.RECENT) recent(true); else recent(false);
74             }
75         }
76     }
77
78
79     // Iterator Definition //////////////////////////////////////////////////////////////////////////////
80
81     public static interface Iterator {
82         public abstract Message cur();
83         public abstract boolean next();
84         public abstract int     uid();
85         public abstract int     num();
86         public abstract void    delete();
87         public abstract void    set(String key, String val);
88         public abstract String  get(String key);
89         public abstract boolean seen();
90         public abstract boolean deleted();
91         public abstract boolean flagged();
92         public abstract boolean draft();
93         public abstract boolean answered();
94         public abstract boolean recent();
95         public abstract void    seen(boolean on);
96         public abstract void    deleted(boolean on);
97         public abstract void    flagged(boolean on);
98         public abstract void    draft(boolean on);
99         public abstract void    answered(boolean on);
100         public abstract void    recent(boolean on);
101         public abstract void    addFlags(int flags);
102         public abstract void    removeFlags(int flags);
103         public abstract void    setFlags(int flags);
104
105         public static class Wrapper implements Iterator {
106             private Iterator it;
107             public Wrapper(Iterator it) { this.it = it; }
108             public Message cur() { return it.cur(); }
109             public boolean next() { return it.next(); }
110             public int     uid() { return it.uid(); }
111             public int     num() { return it.num(); }
112             public void    set(String key, String val) { it.set(key, val); }
113             public String  get(String key) { return it.get(key); }
114             public void    delete() { it.delete(); }
115             public boolean seen() { return it.seen(); }
116             public boolean deleted() { return it.deleted(); }
117             public boolean flagged() { return it.flagged(); }
118             public boolean draft() { return it.draft(); }
119             public boolean answered() { return it.answered(); }
120             public boolean recent() { return it.recent(); }
121             public void    seen(boolean on) { it.seen(on); }
122             public void    deleted(boolean on) { it.deleted(on); }
123             public void    flagged(boolean on) { it.flagged(on); }
124             public void    draft(boolean on) { it.draft(on); }
125             public void    answered(boolean on) { it.answered(on); }
126             public void    recent(boolean on) { it.recent(on); }
127             public void    addFlags(int flags) { it.addFlags(flags); }
128             public void    removeFlags(int flags) { it.removeFlags(flags); }
129             public void    setFlags(int flags) { it.setFlags(flags); }
130         }
131
132         class QueryIterator extends Mailbox.Iterator.Wrapper {
133             Query q;
134             public QueryIterator(Query q, Mailbox m) { super(m.iterator()); this.q = q; }
135             public boolean next() { do { if (!super.next()) return false; } while(!q.match(this)); return true; }
136         }
137     }
138
139     /** constants for the six IMAP flags */
140     public static class Flag {
141         public static final int DELETED  = 0x0001;
142         public static final int SEEN     = 0x0002;
143         public static final int FLAGGED  = 0x0004;
144         public static final int DRAFT    = 0x0008;
145         public static final int ANSWERED = 0x0010;
146         public static final int RECENT   = 0x0020;
147     }
148     
149 }