removed Message.Envelope class
[org.ibex.mail.git] / src / org / ibex / mail / Query.java
1 package org.ibex.mail;
2 import java.util.*;
3 import org.ibex.mail.target.*;
4 import org.ibex.util.*;
5
6 /**
7  *  [immutable] This class encapsulates a query against a mailbox.
8  *
9  *  The default implementation of Mailbox.query() simply retrieves
10  *  each message and calls Query.match() on it to filter out any
11  *  messages which do not match.
12  *
13  *  Production-quality Mailbox implementations will want to inspect
14  *  the Query object passed to Mailbox.query() to perform more
15  *  efficient queries.
16  */
17 public class Query {
18
19     public static Query not(Query q)                { return new Query(NOT, new Query[] { q },0,0,0,null,null,null,null,null); }
20     public static Query and(Query q1, Query q2)     { return new Query(AND,new Query[]{q1,q2},0,0,0,null,null,null,null,null); }
21     public static Query and(Query[] q)              { return new Query(AND, q,0,0,0,null, null, null, null, null ); }
22     public static Query or(Query q1, Query q2)      { return new Query(OR,new Query[] {q1,q2},0,0,0,null,null, null, null, null); }
23     public static Query or(Query[] q)               { return new Query(OR, q, 0, 0, 0, null, null, null, null, null); }
24     public static Query uid(int min, int max)       { return new Query(UID, null, min, max, 0, null, null, null, null, null); }
25     public static Query messagenum(int min,int max) { return new Query(NUM,null,min,max,0,null,null,null,null, null); }
26     public static Query sent(Date e, Date l)        { return new Query(SENT,null,0,0,0,null,null,e,l,null); }
27     public static Query arrival(Date e, Date l)     { return new Query(ARRIVAL,null,0,0,0,null,null, e,l,null);}
28     public static Query header(String k, String v)  { return new Query(HEADER, null, 0, 0, 0, k, v, null, null, null);}
29     public static Query size(int min, int max)      { return new Query(SIZE, null, min, max, 0, null, null, null, null, null);}
30     public static Query body(String text)           { return new Query(BODY, null, 0, 0, 0, null, text, null, null, null);}
31     public static Query full(String text)           { return new Query(FULL, null, 0, 0, 0, null, text, null, null, null);}
32     public static Query uid(int[] set)              { return new Query(UID,  null, 0 ,0 ,0, null, null, null, null, set);}
33     public static Query num(int[] set)              { return new Query(NUM,  null, 0 ,0 ,0, null, null, null, null, set);}
34     public static Query all()                       { return new Query(ALL, null, 0, 0, 0, null, null, null, null, null); }
35     public static Query deleted()                   { return new Query(DELETED, null, 0, 0, 0, null, null, null, null, null); }
36     public static Query seen()                      { return new Query(SEEN, null, 0, 0, 0, null, null, null, null, null); }
37     public static Query flagged()                   { return new Query(FLAGGED, null, 0, 0, 0, null, null, null, null, null); }
38     public static Query draft()                     { return new Query(DRAFT, null, 0, 0, 0, null, null, null, null, null); }
39     public static Query answered()                  { return new Query(ANSWERED, null, 0, 0, 0, null, null, null, null, null); }
40     public static Query recent()                    { return new Query(RECENT, null, 0, 0, 0, null, null, null, null, null); }
41     public static Query set(boolean uid, int[] set) { return uid ? uid(set) : num(set); }
42
43     private Query(int type, Query[] q,int min,int max, int flags, String key, String text, Date earliest, Date latest, int[] set) {
44         this.type = type; this.q = q; this.min = min; this.max = max; this.flags = flags; this.key = key; this.text = text;
45         this.earliest = earliest; this.latest = latest; this.set = set; }
46
47     public static final int ALL        = 0;
48     public static final int NOT        = 1;
49     public static final int AND        = 2;
50     public static final int OR         = 3;
51     public static final int UID        = 4;
52     public static final int SENT       = 5;
53     public static final int ARRIVAL    = 6;
54     public static final int HEADER     = 7;
55     public static final int SIZE       = 8;
56     public static final int BODY       = 9;
57     public static final int FULL       = 10;
58     public static final int NUM        = 11;
59     public static final int DELETED    = 12;
60     public static final int SEEN       = 13;
61     public static final int FLAGGED    = 14;
62     public static final int DRAFT      = 15;
63     public static final int ANSWERED   = 16;
64     public static final int RECENT     = 17;
65
66     public final int type;
67     public final Query[] q;
68     public final int min;
69     public final int max;
70     public final int flags;
71     public final String key;
72     public final String text;
73     public final Date earliest;
74     public final Date latest;
75     public final int[] set;
76
77     public boolean match(Mailbox.Iterator it) {
78         switch(type) {
79             case ALL:        return true;
80             case NOT:        return !q[0].match(it);
81             case OR:         for(int i=0; i<q.length; i++) if (q[i].match(it)) return true; return false;
82             case AND:        for(int i=0; i<q.length; i++) if (!q[i].match(it)) return false; return true;
83             case UID:        if (set != null) {
84                                  for(int i=0; i<set.length; i+=2)
85                                      if (set[i] <= it.uid() && set[i+1] >= it.uid()) return true;
86                                  return false; }
87                              else return it.uid() >= min && it.uid() <= max;
88             case NUM:        if (set != null) {
89                                  for(int i=0; i<set.length; i+=2) if (set[i] <= it.num() && set[i+1] >= it.num()) return true;
90                                  return false; }
91                              else return it.num() >= min && it.num() <= max;
92             case SENT:       return (latest==null||it.cur().date.before(latest)) && 
93                                     (earliest==null||it.cur().date.after(earliest));
94             case ARRIVAL:    return (latest == null || it.cur().arrival.before(latest)) &&
95                                     (earliest == null || it.cur().arrival.after(earliest));
96             case SIZE:       return it.cur().size() >= min && it.cur().size() <= max;
97             case HEADER:     return it.cur().headers.get(key) != null &&
98                                  ((String)it.cur().headers.get(key)).toLowerCase().indexOf(text.toLowerCase()) != -1;
99             case BODY:       return it.cur().body.toLowerCase().indexOf(text.toLowerCase()) != -1;
100             case FULL:       return it.cur().body.toLowerCase().indexOf(text.toLowerCase()) != -1 ||
101                                  it.cur().headers.raw.indexOf(text) != -1;
102             case DELETED:    return it.deleted();
103             case SEEN:       return it.seen();
104             case FLAGGED:    return it.flagged();
105             case DRAFT:      return it.draft();
106             case ANSWERED:   return it.answered();
107             case RECENT:     return it.recent();
108             default:         throw new Error("this should not happen");
109         }
110     }
111 }