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
|
<?php
class Swift_Encoder_QpEncoderTest extends \SwiftMailerTestCase
{
/* -- RFC 2045, 6.7 --
(1) (General 8bit representation) Any octet, except a CR or
LF that is part of a CRLF line break of the canonical
(standard) form of the data being encoded, may be
represented by an "=" followed by a two digit
hexadecimal representation of the octet's value. The
digits of the hexadecimal alphabet, for this purpose,
are "0123456789ABCDEF". Uppercase letters must be
used; lowercase letters are not allowed. Thus, for
example, the decimal value 12 (US-ASCII form feed) can
be represented by "=0C", and the decimal value 61 (US-
ASCII EQUAL SIGN) can be represented by "=3D". This
rule must be followed except when the following rules
allow an alternative encoding.
*/
public function testPermittedCharactersAreNotEncoded()
{
/* -- RFC 2045, 6.7 --
(2) (Literal representation) Octets with decimal values of
33 through 60 inclusive, and 62 through 126, inclusive,
MAY be represented as the US-ASCII characters which
correspond to those octets (EXCLAMATION POINT through
LESS THAN, and GREATER THAN through TILDE,
respectively).
*/
foreach (array_merge(range(33, 60), range(62, 126)) as $ordinal) {
$char = chr($ordinal);
$charStream = $this->_createCharStream();
$charStream->shouldReceive('flushContents')
->once();
$charStream->shouldReceive('importString')
->once()
->with($char);
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array($ordinal));
$charStream->shouldReceive('readBytes')
->atLeast()->times(1)
->andReturn(false);
$encoder = new Swift_Encoder_QpEncoder($charStream);
$this->assertIdenticalBinary($char, $encoder->encodeString($char));
}
}
public function testWhiteSpaceAtLineEndingIsEncoded()
{
/* -- RFC 2045, 6.7 --
(3) (White Space) Octets with values of 9 and 32 MAY be
represented as US-ASCII TAB (HT) and SPACE characters,
respectively, but MUST NOT be so represented at the end
of an encoded line. Any TAB (HT) or SPACE characters
on an encoded line MUST thus be followed on that line
by a printable character. In particular, an "=" at the
end of an encoded line, indicating a soft line break
(see rule #5) may follow one or more TAB (HT) or SPACE
characters. It follows that an octet with decimal
value 9 or 32 appearing at the end of an encoded line
must be represented according to Rule #1. This rule is
necessary because some MTAs (Message Transport Agents,
programs which transport messages from one user to
another, or perform a portion of such transfers) are
known to pad lines of text with SPACEs, and others are
known to remove "white space" characters from the end
of a line. Therefore, when decoding a Quoted-Printable
body, any trailing white space on a line must be
deleted, as it will necessarily have been added by
intermediate transport agents.
*/
$HT = chr(0x09); //9
$SPACE = chr(0x20); //32
//HT
$string = 'a'.$HT.$HT."\r\n".'b';
$charStream = $this->_createCharStream();
$charStream->shouldReceive('flushContents')
->once();
$charStream->shouldReceive('importString')
->once()
->with($string);
$charStream->shouldReceive('readBytes')->once()->andReturn(array(ord('a')));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x09));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x09));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x0D));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x0A));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(ord('b')));
$charStream->shouldReceive('readBytes')->once()->andReturn(false);
$encoder = new Swift_Encoder_QpEncoder($charStream);
$this->assertEquals(
'a'.$HT.'=09'."\r\n".'b',
$encoder->encodeString($string)
);
//SPACE
$string = 'a'.$SPACE.$SPACE."\r\n".'b';
$charStream = $this->_createCharStream();
$charStream->shouldReceive('flushContents')
->once();
$charStream->shouldReceive('importString')
->once()
->with($string);
$charStream->shouldReceive('readBytes')->once()->andReturn(array(ord('a')));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x20));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x20));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x0D));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x0A));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(ord('b')));
$charStream->shouldReceive('readBytes')->once()->andReturn(false);
$encoder = new Swift_Encoder_QpEncoder($charStream);
$this->assertEquals(
'a'.$SPACE.'=20'."\r\n".'b',
$encoder->encodeString($string)
);
}
public function testCRLFIsLeftAlone()
{
/*
(4) (Line Breaks) A line break in a text body, represented
as a CRLF sequence in the text canonical form, must be
represented by a (RFC 822) line break, which is also a
CRLF sequence, in the Quoted-Printable encoding. Since
the canonical representation of media types other than
text do not generally include the representation of
line breaks as CRLF sequences, no hard line breaks
(i.e. line breaks that are intended to be meaningful
and to be displayed to the user) can occur in the
quoted-printable encoding of such types. Sequences
like "=0D", "=0A", "=0A=0D" and "=0D=0A" will routinely
appear in non-text data represented in quoted-
printable, of course.
Note that many implementations may elect to encode the
local representation of various content types directly
rather than converting to canonical form first,
encoding, and then converting back to local
representation. In particular, this may apply to plain
text material on systems that use newline conventions
other than a CRLF terminator sequence. Such an
implementation optimization is permissible, but only
when the combined canonicalization-encoding step is
equivalent to performing the three steps separately.
*/
$string = 'a'."\r\n".'b'."\r\n".'c'."\r\n";
$charStream = $this->_createCharStream();
$charStream->shouldReceive('flushContents')
->once();
$charStream->shouldReceive('importString')
->once()
->with($string);
$charStream->shouldReceive('readBytes')->once()->andReturn(array(ord('a')));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x0D));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x0A));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(ord('b')));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x0D));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x0A));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(ord('c')));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x0D));
$charStream->shouldReceive('readBytes')->once()->andReturn(array(0x0A));
$charStream->shouldReceive('readBytes')->once()->andReturn(false);
$encoder = new Swift_Encoder_QpEncoder($charStream);
$this->assertEquals($string, $encoder->encodeString($string));
}
public function testLinesLongerThan76CharactersAreSoftBroken()
{
/*
(5) (Soft Line Breaks) The Quoted-Printable encoding
REQUIRES that encoded lines be no more than 76
characters long. If longer lines are to be encoded
with the Quoted-Printable encoding, "soft" line breaks
must be used. An equal sign as the last character on a
encoded line indicates such a non-significant ("soft")
line break in the encoded text.
*/
$input = str_repeat('a', 140);
$charStream = $this->_createCharStream();
$charStream->shouldReceive('flushContents')
->once();
$charStream->shouldReceive('importString')
->once()
->with($input);
$output = '';
for ($i = 0; $i < 140; ++$i) {
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('a')));
if (75 == $i) {
$output .= "=\r\n";
}
$output .= 'a';
}
$charStream->shouldReceive('readBytes')
->once()
->andReturn(false);
$encoder = new Swift_Encoder_QpEncoder($charStream);
$this->assertEquals($output, $encoder->encodeString($input));
}
public function testMaxLineLengthCanBeSpecified()
{
$input = str_repeat('a', 100);
$charStream = $this->_createCharStream();
$charStream->shouldReceive('flushContents')
->once();
$charStream->shouldReceive('importString')
->once()
->with($input);
$output = '';
for ($i = 0; $i < 100; ++$i) {
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('a')));
if (53 == $i) {
$output .= "=\r\n";
}
$output .= 'a';
}
$charStream->shouldReceive('readBytes')
->once()
->andReturn(false);
$encoder = new Swift_Encoder_QpEncoder($charStream);
$this->assertEquals($output, $encoder->encodeString($input, 0, 54));
}
public function testBytesBelowPermittedRangeAreEncoded()
{
/*
According to Rule (1 & 2)
*/
foreach (range(0, 32) as $ordinal) {
$char = chr($ordinal);
$charStream = $this->_createCharStream();
$charStream->shouldReceive('flushContents')
->once();
$charStream->shouldReceive('importString')
->once()
->with($char);
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array($ordinal));
$charStream->shouldReceive('readBytes')
->atLeast()->times(1)
->andReturn(false);
$encoder = new Swift_Encoder_QpEncoder($charStream);
$this->assertEquals(
sprintf('=%02X', $ordinal), $encoder->encodeString($char)
);
}
}
public function testDecimalByte61IsEncoded()
{
/*
According to Rule (1 & 2)
*/
$char = '=';
$charStream = $this->_createCharStream();
$charStream->shouldReceive('flushContents')
->once();
$charStream->shouldReceive('importString')
->once()
->with($char);
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(61));
$charStream->shouldReceive('readBytes')
->atLeast()->times(1)
->andReturn(false);
$encoder = new Swift_Encoder_QpEncoder($charStream);
$this->assertEquals('=3D', $encoder->encodeString('='));
}
public function testBytesAbovePermittedRangeAreEncoded()
{
/*
According to Rule (1 & 2)
*/
foreach (range(127, 255) as $ordinal) {
$char = chr($ordinal);
$charStream = $this->_createCharStream();
$charStream->shouldReceive('flushContents')
->once();
$charStream->shouldReceive('importString')
->once()
->with($char);
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array($ordinal));
$charStream->shouldReceive('readBytes')
->atLeast()->times(1)
->andReturn(false);
$encoder = new Swift_Encoder_QpEncoder($charStream);
$this->assertEquals(
sprintf('=%02X', $ordinal), $encoder->encodeString($char)
);
}
}
public function testFirstLineLengthCanBeDifferent()
{
$input = str_repeat('a', 140);
$charStream = $this->_createCharStream();
$charStream->shouldReceive('flushContents')
->once();
$charStream->shouldReceive('importString')
->once()
->with($input);
$output = '';
for ($i = 0; $i < 140; ++$i) {
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('a')));
if (53 == $i || 53 + 75 == $i) {
$output .= "=\r\n";
}
$output .= 'a';
}
$charStream->shouldReceive('readBytes')
->once()
->andReturn(false);
$encoder = new Swift_Encoder_QpEncoder($charStream);
$this->assertEquals(
$output, $encoder->encodeString($input, 22),
'%s: First line should start at offset 22 so can only have max length 54'
);
}
public function testTextIsPreWrapped()
{
$encoder = $this->createEncoder();
$input = str_repeat('a', 70)."\r\n".
str_repeat('a', 70)."\r\n".
str_repeat('a', 70);
$this->assertEquals(
$input, $encoder->encodeString($input)
);
}
private function _createCharStream()
{
return $this->getMockery('Swift_CharacterStream')->shouldIgnoreMissing();
}
private function createEncoder()
{
$factory = new Swift_CharacterReaderFactory_SimpleCharacterReaderFactory();
$charStream = new Swift_CharacterStream_NgCharacterStream($factory, 'utf-8');
return new Swift_Encoder_QpEncoder($charStream);
}
}
|