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
|
<?php
class Swift_Mime_HeaderEncoder_QpHeaderEncoderTest extends \SwiftMailerTestCase
{
//Most tests are already covered in QpEncoderTest since this subclass only
// adds a getName() method
public function testNameIsQ()
{
$encoder = $this->_createEncoder(
$this->_createCharacterStream(true)
);
$this->assertEquals('Q', $encoder->getName());
}
public function testSpaceAndTabNeverAppear()
{
/* -- RFC 2047, 4.
Only a subset of the printable ASCII characters may be used in
'encoded-text'. Space and tab characters are not allowed, so that
the beginning and end of an 'encoded-word' are obvious.
*/
$charStream = $this->_createCharacterStream();
$charStream->shouldReceive('readBytes')
->atLeast()->times(6)
->andReturn(array(ord('a')), array(0x20), array(0x09), array(0x20), array(ord('b')), false);
$encoder = $this->_createEncoder($charStream);
$this->assertNotRegExp('~[ \t]~', $encoder->encodeString("a \t b"),
'%s: encoded-words in headers cannot contain LWSP as per RFC 2047.'
);
}
public function testSpaceIsRepresentedByUnderscore()
{
/* -- RFC 2047, 4.2.
(2) The 8-bit hexadecimal value 20 (e.g., ISO-8859-1 SPACE) may be
represented as "_" (underscore, ASCII 95.). (This character may
not pass through some internetwork mail gateways, but its use
will greatly enhance readability of "Q" encoded data with mail
readers that do not support this encoding.) Note that the "_"
always represents hexadecimal 20, even if the SPACE character
occupies a different code position in the character set in use.
*/
$charStream = $this->_createCharacterStream();
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('a')));
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(0x20));
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('b')));
$charStream->shouldReceive('readBytes')
->zeroOrMoreTimes()
->andReturn(false);
$encoder = $this->_createEncoder($charStream);
$this->assertEquals('a_b', $encoder->encodeString('a b'),
'%s: Spaces can be represented by more readable underscores as per RFC 2047.'
);
}
public function testEqualsAndQuestionAndUnderscoreAreEncoded()
{
/* -- RFC 2047, 4.2.
(3) 8-bit values which correspond to printable ASCII characters other
than "=", "?", and "_" (underscore), MAY be represented as those
characters. (But see section 5 for restrictions.) In
particular, SPACE and TAB MUST NOT be represented as themselves
within encoded words.
*/
$charStream = $this->_createCharacterStream();
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('=')));
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('?')));
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('_')));
$charStream->shouldReceive('readBytes')
->zeroOrMoreTimes()
->andReturn(false);
$encoder = $this->_createEncoder($charStream);
$this->assertEquals('=3D=3F=5F', $encoder->encodeString('=?_'),
'%s: Chars =, ? and _ (underscore) may not appear as per RFC 2047.'
);
}
public function testParensAndQuotesAreEncoded()
{
/* -- RFC 2047, 5 (2).
A "Q"-encoded 'encoded-word' which appears in a 'comment' MUST NOT
contain the characters "(", ")" or "
*/
$charStream = $this->_createCharacterStream();
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('(')));
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('"')));
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord(')')));
$charStream->shouldReceive('readBytes')
->zeroOrMoreTimes()
->andReturn(false);
$encoder = $this->_createEncoder($charStream);
$this->assertEquals('=28=22=29', $encoder->encodeString('(")'),
'%s: Chars (, " (DQUOTE) and ) may not appear as per RFC 2047.'
);
}
public function testOnlyCharactersAllowedInPhrasesAreUsed()
{
/* -- RFC 2047, 5.
(3) As a replacement for a 'word' entity within a 'phrase', for example,
one that precedes an address in a From, To, or Cc header. The ABNF
definition for 'phrase' from RFC 822 thus becomes:
phrase = 1*( encoded-word / word )
In this case the set of characters that may be used in a "Q"-encoded
'encoded-word' is restricted to: <upper and lower case ASCII
letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
(underscore, ASCII 95.)>. An 'encoded-word' that appears within a
'phrase' MUST be separated from any adjacent 'word', 'text' or
'special' by 'linear-white-space'.
*/
$allowedBytes = array_merge(
range(ord('a'), ord('z')), range(ord('A'), ord('Z')),
range(ord('0'), ord('9')),
array(ord('!'), ord('*'), ord('+'), ord('-'), ord('/'))
);
foreach (range(0x00, 0xFF) as $byte) {
$char = pack('C', $byte);
$charStream = $this->_createCharacterStream();
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array($byte));
$charStream->shouldReceive('readBytes')
->zeroOrMoreTimes()
->andReturn(false);
$encoder = $this->_createEncoder($charStream);
$encodedChar = $encoder->encodeString($char);
if (in_array($byte, $allowedBytes)) {
$this->assertEquals($char, $encodedChar,
'%s: Character '.$char.' should not be encoded.'
);
} elseif (0x20 == $byte) {
//Special case
$this->assertEquals('_', $encodedChar,
'%s: Space character should be replaced.'
);
} else {
$this->assertEquals(sprintf('=%02X', $byte), $encodedChar,
'%s: Byte '.$byte.' should be encoded.'
);
}
}
}
public function testEqualsNeverAppearsAtEndOfLine()
{
/* -- RFC 2047, 5 (3).
The 'encoded-text' in an 'encoded-word' must be self-contained;
'encoded-text' MUST NOT be continued from one 'encoded-word' to
another. This implies that the 'encoded-text' portion of a "B"
'encoded-word' will be a multiple of 4 characters long; for a "Q"
'encoded-word', any "=" character that appears in the 'encoded-text'
portion will be followed by two hexadecimal characters.
*/
$input = str_repeat('a', 140);
$charStream = $this->_createCharacterStream();
$output = '';
$seq = 0;
for (; $seq < 140; ++$seq) {
$charStream->shouldReceive('readBytes')
->once()
->andReturn(array(ord('a')));
if (75 == $seq) {
$output .= "\r\n"; // =\r\n
}
$output .= 'a';
}
$charStream->shouldReceive('readBytes')
->zeroOrMoreTimes()
->andReturn(false);
$encoder = $this->_createEncoder($charStream);
$this->assertEquals($output, $encoder->encodeString($input));
}
// -- Creation Methods
private function _createEncoder($charStream)
{
return new Swift_Mime_HeaderEncoder_QpHeaderEncoder($charStream);
}
private function _createCharacterStream($stub = false)
{
return $this->getMockery('Swift_CharacterStream')->shouldIgnoreMissing();
}
}
|
