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
|
<?php
class Swift_Mime_Headers_ParameterizedHeaderTest extends \SwiftMailerTestCase
{
private $_charset = 'utf-8';
private $_lang = 'en-us';
public function testTypeIsParameterizedHeader()
{
$header = $this->_getHeader('Content-Type',
$this->_getHeaderEncoder('Q', true), $this->_getParameterEncoder(true)
);
$this->assertEquals(Swift_Mime_Header::TYPE_PARAMETERIZED, $header->getFieldType());
}
public function testValueIsReturnedVerbatim()
{
$header = $this->_getHeader('Content-Type',
$this->_getHeaderEncoder('Q', true), $this->_getParameterEncoder(true)
);
$header->setValue('text/plain');
$this->assertEquals('text/plain', $header->getValue());
}
public function testParametersAreAppended()
{
/* -- RFC 2045, 5.1
parameter := attribute "=" value
attribute := token
; Matching of attributes
; is ALWAYS case-insensitive.
value := token / quoted-string
token := 1*<any (US-ASCII) CHAR except SPACE, CTLs,
or tspecials>
tspecials := "(" / ")" / "<" / ">" / "@" /
"," / ";" / ":" / "\" / <">
"/" / "[" / "]" / "?" / "="
; Must be in quoted-string,
; to use within parameter values
*/
$header = $this->_getHeader('Content-Type',
$this->_getHeaderEncoder('Q', true), $this->_getParameterEncoder(true)
);
$header->setValue('text/plain');
$header->setParameters(array('charset' => 'utf-8'));
$this->assertEquals('text/plain; charset=utf-8', $header->getFieldBody());
}
public function testSpaceInParamResultsInQuotedString()
{
$header = $this->_getHeader('Content-Disposition',
$this->_getHeaderEncoder('Q', true), $this->_getParameterEncoder(true)
);
$header->setValue('attachment');
$header->setParameters(array('filename' => 'my file.txt'));
$this->assertEquals('attachment; filename="my file.txt"',
$header->getFieldBody()
);
}
public function testLongParamsAreBrokenIntoMultipleAttributeStrings()
{
/* -- RFC 2231, 3.
The asterisk character ("*") followed
by a decimal count is employed to indicate that multiple parameters
are being used to encapsulate a single parameter value. The count
starts at 0 and increments by 1 for each subsequent section of the
parameter value. Decimal values are used and neither leading zeroes
nor gaps in the sequence are allowed.
The original parameter value is recovered by concatenating the
various sections of the parameter, in order. For example, the
content-type field
Content-Type: message/external-body; access-type=URL;
URL*0="ftp://";
URL*1="cs.utk.edu/pub/moore/bulk-mailer/bulk-mailer.tar"
is semantically identical to
Content-Type: message/external-body; access-type=URL;
URL="ftp://cs.utk.edu/pub/moore/bulk-mailer/bulk-mailer.tar"
Note that quotes around parameter values are part of the value
syntax; they are NOT part of the value itself. Furthermore, it is
explicitly permitted to have a mixture of quoted and unquoted
continuation fields.
*/
$value = str_repeat('a', 180);
$encoder = $this->_getParameterEncoder();
$encoder->shouldReceive('encodeString')
->once()
->with($value, \Mockery::any(), 63, \Mockery::any())
->andReturn(str_repeat('a', 63)."\r\n".
str_repeat('a', 63)."\r\n".str_repeat('a', 54));
$header = $this->_getHeader('Content-Disposition',
$this->_getHeaderEncoder('Q', true), $encoder
);
$header->setValue('attachment');
$header->setParameters(array('filename' => $value));
$header->setMaxLineLength(78);
$this->assertEquals(
'attachment; '.
'filename*0*=utf-8\'\''.str_repeat('a', 63).";\r\n ".
'filename*1*='.str_repeat('a', 63).";\r\n ".
'filename*2*='.str_repeat('a', 54),
$header->getFieldBody()
);
}
public function testEncodedParamDataIncludesCharsetAndLanguage()
{
/* -- RFC 2231, 4.
Asterisks ("*") are reused to provide the indicator that language and
character set information is present and encoding is being used. A
single quote ("'") is used to delimit the character set and language
information at the beginning of the parameter value. Percent signs
("%") are used as the encoding flag, which agrees with RFC 2047.
Specifically, an asterisk at the end of a parameter name acts as an
indicator that character set and language information may appear at
the beginning of the parameter value. A single quote is used to
separate the character set, language, and actual value information in
the parameter value string, and an percent sign is used to flag
octets encoded in hexadecimal. For example:
Content-Type: application/x-stuff;
title*=us-ascii'en-us'This%20is%20%2A%2A%2Afun%2A%2A%2A
Note that it is perfectly permissible to leave either the character
set or language field blank. Note also that the single quote
delimiters MUST be present even when one of the field values is
omitted.
*/
$value = str_repeat('a', 20).pack('C', 0x8F).str_repeat('a', 10);
$encoder = $this->_getParameterEncoder();
$encoder->shouldReceive('encodeString')
->once()
->with($value, 12, 62, \Mockery::any())
->andReturn(str_repeat('a', 20).'%8F'.str_repeat('a', 10));
$header = $this->_getHeader('Content-Disposition',
$this->_getHeaderEncoder('Q', true), $encoder
);
$header->setValue('attachment');
$header->setParameters(array('filename' => $value));
$header->setMaxLineLength(78);
$header->setLanguage($this->_lang);
$this->assertEquals(
'attachment; filename*='.$this->_charset."'".$this->_lang."'".
str_repeat('a', 20).'%8F'.str_repeat('a', 10),
$header->getFieldBody()
);
}
public function testMultipleEncodedParamLinesAreFormattedCorrectly()
{
/* -- RFC 2231, 4.1.
Character set and language information may be combined with the
parameter continuation mechanism. For example:
Content-Type: application/x-stuff
title*0*=us-ascii'en'This%20is%20even%20more%20
title*1*=%2A%2A%2Afun%2A%2A%2A%20
title*2="isn't it!"
Note that:
(1) Language and character set information only appear at
the beginning of a given parameter value.
(2) Continuations do not provide a facility for using more
than one character set or language in the same
parameter value.
(3) A value presented using multiple continuations may
contain a mixture of encoded and unencoded segments.
(4) The first segment of a continuation MUST be encoded if
language and character set information are given.
(5) If the first segment of a continued parameter value is
encoded the language and character set field delimiters
MUST be present even when the fields are left blank.
*/
$value = str_repeat('a', 20).pack('C', 0x8F).str_repeat('a', 60);
$encoder = $this->_getParameterEncoder();
$encoder->shouldReceive('encodeString')
->once()
->with($value, 12, 62, \Mockery::any())
->andReturn(str_repeat('a', 20).'%8F'.str_repeat('a', 28)."\r\n".
str_repeat('a', 32));
$header = $this->_getHeader('Content-Disposition',
$this->_getHeaderEncoder('Q', true), $encoder
);
$header->setValue('attachment');
$header->setParameters(array('filename' => $value));
$header->setMaxLineLength(78);
$header->setLanguage($this->_lang);
$this->assertEquals(
'attachment; filename*0*='.$this->_charset."'".$this->_lang."'".
str_repeat('a', 20).'%8F'.str_repeat('a', 28).";\r\n ".
'filename*1*='.str_repeat('a', 32),
$header->getFieldBody()
);
}
public function testToString()
{
$header = $this->_getHeader('Content-Type',
$this->_getHeaderEncoder('Q', true), $this->_getParameterEncoder(true)
);
$header->setValue('text/html');
$header->setParameters(array('charset' => 'utf-8'));
$this->assertEquals('Content-Type: text/html; charset=utf-8'."\r\n",
$header->toString()
);
}
public function testValueCanBeEncodedIfNonAscii()
{
$value = 'fo'.pack('C', 0x8F).'bar';
$encoder = $this->_getHeaderEncoder('Q');
$encoder->shouldReceive('encodeString')
->once()
->with($value, \Mockery::any(), \Mockery::any(), \Mockery::any())
->andReturn('fo=8Fbar');
$header = $this->_getHeader('X-Foo', $encoder, $this->_getParameterEncoder(true));
$header->setValue($value);
$header->setParameters(array('lookslike' => 'foobar'));
$this->assertEquals('X-Foo: =?utf-8?Q?fo=8Fbar?=; lookslike=foobar'."\r\n",
$header->toString()
);
}
public function testValueAndParamCanBeEncodedIfNonAscii()
{
$value = 'fo'.pack('C', 0x8F).'bar';
$encoder = $this->_getHeaderEncoder('Q');
$encoder->shouldReceive('encodeString')
->once()
->with($value, \Mockery::any(), \Mockery::any(), \Mockery::any())
->andReturn('fo=8Fbar');
$paramEncoder = $this->_getParameterEncoder();
$paramEncoder->shouldReceive('encodeString')
->once()
->with($value, \Mockery::any(), \Mockery::any(), \Mockery::any())
->andReturn('fo%8Fbar');
$header = $this->_getHeader('X-Foo', $encoder, $paramEncoder);
$header->setValue($value);
$header->setParameters(array('says' => $value));
$this->assertEquals("X-Foo: =?utf-8?Q?fo=8Fbar?=; says*=utf-8''fo%8Fbar\r\n",
$header->toString()
);
}
public function testParamsAreEncodedWithEncodedWordsIfNoParamEncoderSet()
{
$value = 'fo'.pack('C', 0x8F).'bar';
$encoder = $this->_getHeaderEncoder('Q');
$encoder->shouldReceive('encodeString')
->once()
->with($value, \Mockery::any(), \Mockery::any(), \Mockery::any())
->andReturn('fo=8Fbar');
$header = $this->_getHeader('X-Foo', $encoder, null);
$header->setValue('bar');
$header->setParameters(array('says' => $value));
$this->assertEquals("X-Foo: bar; says=\"=?utf-8?Q?fo=8Fbar?=\"\r\n",
$header->toString()
);
}
public function testLanguageInformationAppearsInEncodedWords()
{
/* -- RFC 2231, 5.
5. Language specification in Encoded Words
RFC 2047 provides support for non-US-ASCII character sets in RFC 822
message header comments, phrases, and any unstructured text field.
This is done by defining an encoded word construct which can appear
in any of these places. Given that these are fields intended for
display, it is sometimes necessary to associate language information
with encoded words as well as just the character set. This
specification extends the definition of an encoded word to allow the
inclusion of such information. This is simply done by suffixing the
character set specification with an asterisk followed by the language
tag. For example:
From: =?US-ASCII*EN?Q?Keith_Moore?= <moore@cs.utk.edu>
*/
$value = 'fo'.pack('C', 0x8F).'bar';
$encoder = $this->_getHeaderEncoder('Q');
$encoder->shouldReceive('encodeString')
->once()
->with($value, \Mockery::any(), \Mockery::any(), \Mockery::any())
->andReturn('fo=8Fbar');
$paramEncoder = $this->_getParameterEncoder();
$paramEncoder->shouldReceive('encodeString')
->once()
->with($value, \Mockery::any(), \Mockery::any(), \Mockery::any())
->andReturn('fo%8Fbar');
$header = $this->_getHeader('X-Foo', $encoder, $paramEncoder);
$header->setLanguage('en');
$header->setValue($value);
$header->setParameters(array('says' => $value));
$this->assertEquals("X-Foo: =?utf-8*en?Q?fo=8Fbar?=; says*=utf-8'en'fo%8Fbar\r\n",
$header->toString()
);
}
public function testSetBodyModel()
{
$header = $this->_getHeader('Content-Type',
$this->_getHeaderEncoder('Q', true), $this->_getParameterEncoder(true)
);
$header->setFieldBodyModel('text/html');
$this->assertEquals('text/html', $header->getValue());
}
public function testGetBodyModel()
{
$header = $this->_getHeader('Content-Type',
$this->_getHeaderEncoder('Q', true), $this->_getParameterEncoder(true)
);
$header->setValue('text/plain');
$this->assertEquals('text/plain', $header->getFieldBodyModel());
}
public function testSetParameter()
{
$header = $this->_getHeader('Content-Type',
$this->_getHeaderEncoder('Q', true), $this->_getParameterEncoder(true)
);
$header->setParameters(array('charset' => 'utf-8', 'delsp' => 'yes'));
$header->setParameter('delsp', 'no');
$this->assertEquals(array('charset' => 'utf-8', 'delsp' => 'no'),
$header->getParameters()
);
}
public function testGetParameter()
{
$header = $this->_getHeader('Content-Type',
$this->_getHeaderEncoder('Q', true), $this->_getParameterEncoder(true)
);
$header->setParameters(array('charset' => 'utf-8', 'delsp' => 'yes'));
$this->assertEquals('utf-8', $header->getParameter('charset'));
}
private function _getHeader($name, $encoder, $paramEncoder)
{
$header = new Swift_Mime_Headers_ParameterizedHeader($name, $encoder,
$paramEncoder, new Swift_Mime_Grammar()
);
$header->setCharset($this->_charset);
return $header;
}
private function _getHeaderEncoder($type, $stub = false)
{
$encoder = $this->getMockery('Swift_Mime_HeaderEncoder')->shouldIgnoreMissing();
$encoder->shouldReceive('getName')
->zeroOrMoreTimes()
->andReturn($type);
return $encoder;
}
private function _getParameterEncoder($stub = false)
{
return $this->getMockery('Swift_Encoder')->shouldIgnoreMissing();
}
}
|