summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/base/test/unit/test_postPluginFilters.js
blob: de75307886b6a425c39ff0c8ac6d8b07a1b0e4fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/*
 * tests post-plugin message filters as implemented in bug 198100
 */

/* import-globals-from ../../../test/resources/POP3pump.js */
load("../../../resources/POP3pump.js");

// Globals

var gDbService = Cc["@mozilla.org/msgDatabase/msgDBService;1"].getService(
  Ci.nsIMsgDBService
);

// command functions for test data
var kTrain = 0; // train a file as a trait
var kClass = 1; // classify files with traits

var gTest; // currently active test
var gMsgHdr; // current message header

var kJunkFile = "../../../data/bugmail1";
var kGoodFile = "../../../data/draft1";

var kPriorityLow = 3;
var kPriorityHigh = 5;
var gInboxListener; // database listener object

var gTests = [
  {
    // train two different messages
    command: kTrain,
    fileName: kGoodFile,
    traitId: MailServices.junk.GOOD_TRAIT,
  },
  {
    command: kTrain,
    fileName: kJunkFile,
    traitId: MailServices.junk.JUNK_TRAIT,
  },
  {
    // test a filter that acts on GOOD messages
    command: kClass,
    fileName: kGoodFile,
    test() {
      Assert.equal(kPriorityHigh, gMsgHdr.priority);
    },
  },
  {
    // test a filter that acts on JUNK messages
    command: kClass,
    fileName: kJunkFile,
    test() {
      Assert.equal(kPriorityLow, gMsgHdr.priority);
    },
  },
];

// main test
function run_test() {
  // Setup some incoming filters, setting junk priority low, and good high.

  // Can't use the fake server, must use the deferredTo local server!
  let filterList = localAccountUtils.incomingServer.getFilterList(null);

  // junkIsLow filter
  let filter = filterList.createFilter("junkIsLow");
  let searchTerm = filter.createTerm();
  searchTerm.attrib = Ci.nsMsgSearchAttrib.JunkStatus;
  let value = searchTerm.value;
  value.attrib = Ci.nsMsgSearchAttrib.JunkStatus;
  value.junkStatus = MailServices.junk.JUNK;
  searchTerm.value = value;
  searchTerm.op = Ci.nsMsgSearchOp.Is;
  searchTerm.booleanAnd = false;
  filter.appendTerm(searchTerm);
  let action = filter.createAction();
  action.type = Ci.nsMsgFilterAction.ChangePriority;
  action.priority = kPriorityLow;
  filter.appendAction(action);
  filter.filterType = Ci.nsMsgFilterType.PostPlugin;
  filter.enabled = true;
  filterList.insertFilterAt(0, filter);

  // goodIsHigh filter
  filter = filterList.createFilter("goodIsHigh");
  searchTerm = filter.createTerm();
  searchTerm.attrib = Ci.nsMsgSearchAttrib.JunkStatus;
  value = searchTerm.value;
  value.attrib = Ci.nsMsgSearchAttrib.JunkStatus;
  value.junkStatus = MailServices.junk.GOOD;
  searchTerm.value = value;
  searchTerm.op = Ci.nsMsgSearchOp.Is;
  searchTerm.booleanAnd = false;
  filter.appendTerm(searchTerm);
  action = filter.createAction();
  action.type = Ci.nsMsgFilterAction.ChangePriority;
  action.priority = kPriorityHigh;
  filter.appendAction(action);
  filter.filterType = Ci.nsMsgFilterType.PostPlugin;
  filter.enabled = true;
  filterList.insertFilterAt(1, filter);

  // setup a db listener to grab the message headers. There's probably an
  // easier way, but this works.
  gInboxListener = new DBListener();
  gDbService.registerPendingListener(
    localAccountUtils.inboxFolder,
    gInboxListener
  );

  do_test_pending();

  startCommand();
}

function endTest() {
  // Cleanup
  dump(" Exiting mail tests\n");
  if (gInboxListener) {
    gDbService.unregisterPendingListener(gInboxListener);
  }

  gPOP3Pump = null;

  do_test_finished(); // for the one in run_test()
}

var classifyListener = {
  // nsIMsgTraitClassificationListener implementation
  onMessageTraitsClassified(aMsgURI, aTraits, aPercents) {
    // print("Message URI is " + aMsgURI);
    if (!aMsgURI) {
      // Ignore end-of-batch signal.
      return;
    }

    startCommand();
  },
};

/** @implements {nsIDBChangeListener} */
function DBListener() {}

DBListener.prototype = {
  onHdrFlagsChanged(aHdrChanged, aOldFlags, aNewFlags, aInstigator) {},

  onHdrDeleted(aHdrChanged, aParentKey, Flags, aInstigator) {},

  onHdrAdded(aHdrChanged, aParentKey, aFlags, aInstigator) {
    gMsgHdr = aHdrChanged;
  },

  onParentChanged(aKeyChanged, oldParent, newParent, aInstigator) {},

  onAnnouncerGoingAway(instigator) {
    if (gInboxListener) {
      try {
        POP3Pump.inbox.msgDatabase.removeListener(gInboxListener);
      } catch (e) {
        dump("listener not found\n");
      }
    }
  },

  onReadChanged(aInstigator) {},

  onJunkScoreChanged(aInstigator) {},

  onHdrPropertyChanged(aHdrToChange, aPreChange, aStatus, aInstigator) {},
  onEvent(aDB, aEvent) {},
};

// start the next test command
function startCommand() {
  if (gTest && gTest.test) {
    dump("doing test " + gTest.test.name + "\n");
    gTest.test();
  }
  if (!gTests.length) {
    // Do we have more commands?
    // no, all done
    endTest();
    return;
  }

  gTest = gTests.shift();
  switch (gTest.command) {
    case kTrain:
      // train message
      var proArray = [];
      proArray.push(gTest.traitId);

      MailServices.junk.setMsgTraitClassification(
        getSpec(gTest.fileName), // aMsgURI
        [], // aOldTraits
        proArray, // aNewTraits
        classifyListener // aTraitListener
      );
      // null,      // [optional] in nsIMsgWindow aMsgWindow
      // null,      // [optional] in nsIJunkMailClassificationListener aJunkListener
      break;

    case kClass:
      // classify message
      gPOP3Pump.files = [gTest.fileName];
      gPOP3Pump.onDone = function () {
        do_timeout(100, startCommand);
      };
      gPOP3Pump.run();
      break;
  }
}

function getSpec(aFileName) {
  var file = do_get_file(aFileName);
  var uri = Services.io.newFileURI(file).QueryInterface(Ci.nsIURL);
  uri = uri.mutate().setQuery("type=application/x-message-display").finalize();
  return uri.spec;
}