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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
|
/* 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/. */
/*
* General testing of the byte-counting libmime facility, to make sure that what
* is streamed to us is actually labeled with the right size.
*/
/*
* Do not include glodaTestHelper because we do not want gloda loaded and it
* adds a lot of runtime overhead which makes certain debugging strategies like
* using chronicle-recorder impractical.
*/
var { MsgHdrToMimeMessage } = ChromeUtils.import(
"resource:///modules/gloda/MimeMessage.jsm"
);
var {
MessageGenerator,
SyntheticPartLeaf,
SyntheticPartMultiMixed,
SyntheticPartMultiRelated,
SyntheticMessageSet,
} = ChromeUtils.import(
"resource://testing-common/mailnews/MessageGenerator.jsm"
);
var { MessageInjection } = ChromeUtils.import(
"resource://testing-common/mailnews/MessageInjection.jsm"
);
var msgGen = new MessageGenerator();
var messageInjection;
add_setup(function () {
// Sanity check: figure out how many bytes the original text occupies in UTF-8 encoding
Assert.equal(
new TextEncoder().encode(originalText).length,
originalTextByteCount
);
messageInjection = new MessageInjection({ mode: "local" }, msgGen);
});
var htmlText = "<html><head></head><body>I am HTML! Woo! </body></html>";
var partHtml = new SyntheticPartLeaf(htmlText, {
contentType: "text/html",
});
// This text is 168 characters long, and occupies 173 bytes when encoded in
// UTF-8. (We make sure it occupies 173 bytes in run_test below). Note that
// you cannot use this text directly because it isn't pure ASCII. You must use
// one of the encoded forms below.
var originalText =
"Longtemps, je me suis couché de bonne heure. Parfois, à " +
"peine ma bougie éteinte, mes yeux se fermaient si vite que je n'avais pas le " +
"temps de me dire : « Je m'endors. »";
var originalTextByteCount = 173;
var b64Text =
"TG9uZ3RlbXBzLCBqZSBtZSBzdWlzIGNvdWNow6kgZGUgYm9ubmUgaGV1cmUuIFBhcmZvaXMs\n" +
"IMOgIHBlaW5lIG1hIGJvdWdpZSDDqXRlaW50ZSwgbWVzIHlldXggc2UgZmVybWFpZW50IHNp\n" +
"IHZpdGUgcXVlIGplIG4nYXZhaXMgcGFzIGxlIHRlbXBzIGRlIG1lIGRpcmUgOiDCqyBKZSBt\n" +
"J2VuZG9ycy4gwrsK";
var qpText =
"Longtemps,=20je=20me=20suis=20couch=C3=A9=20de=20bonne=20heure.=20Parfois,=\n" +
"=20=C3=A0=20peine=20ma=20bougie=20=C3=A9teinte,=20mes=20yeux=20se=20fermaie=\n" +
"nt=20si=20vite=20que=20je=20n'avais=20pas=20le=20temps=20de=20me=20dire=20:=\n" +
"=20=C2=AB=20Je=20m'endors.=20=C2=BB";
var uuText =
"begin 666 -\n" +
'M3&]N9W1E;7!S+"!J92!M92!S=6ES(&-O=6-HPZD@9&4@8F]N;F4@:&5U<F4N\n' +
"M(%!A<F9O:7,L(,.@('!E:6YE(&UA(&)O=6=I92##J71E:6YT92P@;65S('EE\n" +
"M=7@@<V4@9F5R;6%I96YT('-I('9I=&4@<75E(&IE(&XG879A:7,@<&%S(&QE\n" +
"G('1E;7!S(&1E(&UE(&1I<F4@.B#\"JR!*92!M)V5N9&]R<RX@PKL*\n" +
"\n" +
"end";
var yencText =
"Hello there --\n" +
"=ybegin line=128 size=174 name=jane.doe\n" +
"\x76\x99\x98\x91\x9e\x8f\x97\x9a\x9d\x56\x4a\x94\x8f\x4a\x97\x8f" +
"\x4a\x9d\x9f\x93\x9d\x4a\x8d\x99\x9f\x8d\x92\xed\xd3\x4a\x8e\x8f" +
"\x4a\x8c\x99\x98\x98\x8f\x4a\x92\x8f\x9f\x9c\x8f\x58\x4a\x7a\x8b" +
"\x9c\x90\x99\x93\x9d\x56\x4a\xed\xca\x4a\x9a\x8f\x93\x98\x8f\x4a" +
"\x97\x8b\x4a\x8c\x99\x9f\x91\x93\x8f\x4a\xed\xd3\x9e\x8f\x93\x98" +
"\x9e\x8f\x56\x4a\x97\x8f\x9d\x4a\xa3\x8f\x9f\xa2\x4a\x9d\x8f\x4a" +
"\x90\x8f\x9c\x97\x8b\x93\x8f\x98\x9e\x4a\x9d\x93\x4a\xa0\x93\x9e" +
"\x8f\x4a\x9b\x9f\x8f\x4a\x94\x8f\x4a\x98\x51\x8b\xa0\x8b\x93\x9d" +
"\x0d\x0a\x4a\x9a\x8b\x9d\x4a\x96\x8f\x4a\x9e\x8f\x97\x9a\x9d\x4a" +
"\x8e\x8f\x4a\x97\x8f\x4a\x8e\x93\x9c\x8f\x4a\x64\x4a\xec\xd5\x4a" +
"\x74\x8f\x4a\x97\x51\x8f\x98\x8e\x99\x9c\x9d\x58\x4a\xec\xe5\x34" +
"\x0d\x0a" +
"=yend size=174 crc32=7efccd8e\n";
// That completely exotic encoding is only detected if there is no content type
// on the message, which is usually the case in newsgroups. I hate you yencode!
// var partYencText = new SyntheticPartLeaf("I am text! Woo!\n\n" + yencText, {
// contentType: "",
// charset: "",
// format: "",
// });
var partUUText = new SyntheticPartLeaf(
"I am text! With uuencode... noes...\n\n" + uuText,
{
contentType: "",
charset: "",
format: "",
}
);
var tachText = {
filename: "bob.txt",
body: qpText,
charset: "utf-8",
encoding: "quoted-printable",
};
var tachInlineText = {
filename: "foo.txt",
body: qpText,
format: null,
charset: "utf-8",
encoding: "quoted-printable",
disposition: "inline",
};
// Images have a different behavior than other attachments: they are displayed
// inline most of the time, so there are two different code paths that need to
// enable streaming and byte counting to the JS mime emitter.
var tachImage = {
filename: "bob.png",
contentType: "image/png",
encoding: "base64",
charset: null,
format: null,
body: b64Text,
};
var tachPdf = {
filename: "bob.pdf",
contentType: "application/pdf",
encoding: "base64",
charset: null,
format: null,
body: b64Text,
};
var tachUU = {
filename: "john.doe",
contentType: "application/x-uuencode",
encoding: "uuencode",
charset: null,
format: null,
body: uuText,
};
var tachApplication = {
filename: "funky.funk",
contentType: "application/x-funky",
encoding: "base64",
body: b64Text,
};
var relImage = {
contentType: "image/png",
encoding: "base64",
charset: null,
format: null,
contentId: "part1.foo@bar.invalid",
body: b64Text,
};
var tachVCard = {
filename: "bob.vcf",
contentType: "text/vcard",
encoding: "7bit",
body: "begin:vcard\nfn:Bob\nend:vcard\n",
};
var partTachVCard = new SyntheticPartLeaf(tachVCard.body, tachVCard);
new SyntheticPartLeaf(relImage.body, relImage);
var messageInfos = [
{
name: "uuencode inline",
bodyPart: partUUText,
subject: "duh",
epsilon: 1,
checkTotalSize: false,
},
// Encoding type specific to newsgroups, not interested, gloda doesn't even
// treat this as an attachment (probably because gloda requires an attachment
// to have a content-type, which these yencoded parts don't have), but size IS
// counted properly nonetheless.
/* {
name: 'text/plain with yenc inline',
bodyPart: partYencText,
subject: "yEnc-Prefix: \"jane.doe\" 174 yEnc bytes - yEnc test (1)",
},*/
// Inline image, not interested either, gloda doesn't keep that as an
// attachment (probably a deliberate choice), size is NOT counted properly.
// (don't want to investigate, I doubt it's a useful information anyway.)
/* {
name: 'multipart/related',
bodyPart: new SyntheticPartMultiRelated([partHtml, partRelImage]),
},*/
// This doesn't really make sense because it returns the length of the
// encoded blob without the envelope. Disabling as part of bug 711980.
/* {
name: '.eml attachment',
bodyPart: new SyntheticPartMultiMixed([
partHtml,
msgGen.makeMessage({ body: { body: qpText,
charset: "UTF-8",
encoding: "quoted-printable" } }),
]),
epsilon: 1,
},*/
// All of the other common cases work fine.
{
name: 'all sorts of "real" attachments',
bodyPart: partHtml,
attachments: [
tachImage,
tachPdf,
tachUU,
tachApplication,
tachText,
tachInlineText,
],
epsilon: 2,
},
];
add_task(async function test_message_attachments() {
for (let messageInfo of messageInfos) {
await message_attachments(messageInfo);
}
});
var bogusMessage = msgGen.makeMessage({ body: { body: originalText } });
bogusMessage._contentType = "woooooo"; // Breaking abstraction boundaries. Bad.
var bogusMessageInfos = [
// In this case, the wooooo part is not an attachment, so its bytes won't be
// counted (size will end up being 0 bytes). We don't check the size, but
// check_bogus_parts makes sure we're able to come up with a resulting size
// for the MimeMessage.
//
// In that very case, since message M is an attachment, libmime will count M's
// bytes, and we could have MimeMessages prefer the size libmime tells them
// (when they have it), rather than recursively computing their sizes. I'm not
// sure changing jsmimeemitter.js is worth the trouble just for buggy
// messages...
{
name: ".eml attachment with inner MimeUnknown",
bodyPart: new SyntheticPartMultiMixed([
partHtml,
msgGen.makeMessage({
// <--- M
bodyPart: new SyntheticPartMultiMixed([
new SyntheticPartMultiRelated([
partHtml,
new SyntheticPartLeaf(htmlText, { contentType: "woooooo" }),
]),
]),
}),
]),
epsilon: 6,
checkSize: false,
},
];
add_task(async function test_bogus_messages(info) {
for (let bogusMessageInfo of bogusMessageInfos) {
await bogus_messages(bogusMessageInfo);
}
});
add_task(async function test_have_attachments() {
// The goal here is to explicitly check that these messages have attachments.
let number = 1;
let synMsg = msgGen.makeMessage({
name: "multipart/related",
bodyPart: new SyntheticPartMultiMixed([partHtml, partTachVCard]),
number,
});
let synSet = new SyntheticMessageSet([synMsg]);
await messageInjection.addSetsToFolders(
[messageInjection.getInboxFolder()],
[synSet]
);
let msgHdr = synSet.getMsgHdr(0);
let promiseResolve;
let promise = new Promise(resolve => {
promiseResolve = resolve;
});
MsgHdrToMimeMessage(msgHdr, null, function (aMsgHdr, aMimeMsg) {
try {
Assert.equal(aMimeMsg.allUserAttachments.length, number);
promiseResolve();
} catch (e) {
do_throw(e);
}
});
await promise;
});
async function message_attachments(info) {
let synMsg = msgGen.makeMessage(info);
let synSet = new SyntheticMessageSet([synMsg]);
await messageInjection.addSetsToFolders(
[messageInjection.getInboxFolder()],
[synSet]
);
let msgHdr = synSet.getMsgHdr(0);
let promiseResolve;
let promise = new Promise(resolve => {
promiseResolve = resolve;
});
MsgHdrToMimeMessage(msgHdr, null, function (aMsgHdr, aMimeMsg) {
try {
check_attachments(
aMimeMsg,
info.epsilon,
"checkTotalSize" in info ? info.checkTotalSize : undefined
);
promiseResolve();
} catch (e) {
do_throw(e);
}
});
await promise;
}
function check_attachments(aMimeMsg, epsilon, checkTotalSize) {
if (aMimeMsg == null) {
do_throw("We really should have gotten a result!");
}
/* It is hard to get a byte count that's perfectly accurate. When composing
* the message, the MIME structure goes like this (for an encoded attachment):
*
* XXXXXXXXXX
* XXXXXXXXXX <-- encoded block
* XXXXXXXXXX
* <-- newline
* --chopchop <-- MIME separator
*
* libmime counts bytes all the way up to the separator, which means it counts
* the bytes for the extra line. Since newlines in emails are \n, most of the
* time we get att.size = 174 instead of 173.
*
* The good news is, it's just a fixed extra cost. There no issues with the
* inner contents of the attachment, you can add as many newlines as you want
* in it, Unix or Windows, the count won't get past the bounds.
*/
Assert.ok(aMimeMsg.allUserAttachments.length > 0);
let totalSize = htmlText.length;
for (let att of aMimeMsg.allUserAttachments) {
dump("*** Attachment now is " + att.name + " " + att.size + "\n");
Assert.ok(Math.abs(att.size - originalTextByteCount) <= epsilon);
totalSize += att.size;
}
// Undefined means true.
if (checkTotalSize !== false) {
dump(
"*** Total size comparison: " + totalSize + " vs " + aMimeMsg.size + "\n"
);
Assert.ok(Math.abs(aMimeMsg.size - totalSize) <= epsilon);
}
}
function check_bogus_parts(aMimeMsg, { epsilon, checkSize }) {
if (aMimeMsg == null) {
do_throw("We really should have gotten a result!");
}
// First make sure the size is computed properly
let x = parseInt(aMimeMsg.size);
Assert.ok(!isNaN(x));
let sep = "@mozilla.org/windows-registry-key;1" in Cc ? "\r\n" : "\n";
if (checkSize) {
let partSize = 0;
// The attachment, although a MimeUnknown part, is actually plain/text that
// contains the whole attached message, including headers. Count them.
for (let k in bogusMessage.headers) {
let v = bogusMessage.headers[k];
partSize += (k + ": " + v + sep).length;
}
// That's the newline between the headers and the message body.
partSize += sep.length;
// That's the message body.
partSize += originalTextByteCount;
// That's the total length that's to be returned by the MimeMessage abstraction.
let totalSize = htmlText.length + partSize;
dump(totalSize + " vs " + aMimeMsg.size + "\n");
Assert.ok(Math.abs(aMimeMsg.size - totalSize) <= epsilon);
}
}
async function bogus_messages(info) {
let synMsg = msgGen.makeMessage(info);
let synSet = new SyntheticMessageSet([synMsg]);
await messageInjection.addSetsToFolders(
[messageInjection.getInboxFolder()],
[synSet]
);
let msgHdr = synSet.getMsgHdr(0);
let promiseResolve;
let promise = new Promise(resolve => {
promiseResolve = resolve;
});
MsgHdrToMimeMessage(msgHdr, null, function (aMsgHdr, aMimeMsg) {
try {
check_bogus_parts(aMimeMsg, info);
promiseResolve();
} catch (e) {
do_throw(e);
}
});
await promise;
}
|
