Skip to content

Commit bdab8ce

Browse files
weierophinneyweierophinney
committed
Merge pull request #31 from fredden/content-disposition
Properly encode content-disposition header
2 parents ec85449 + df3fa89 commit bdab8ce

File tree

4 files changed

+550
-0
lines changed

4 files changed

+550
-0
lines changed

‎CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ All notable changes to this project will be documented in this file, in reverse
7676

7777
- [#75](https://github.com/laminas/laminas-mail/pull/75) fixes how `Laminas\Mail\Header\ListParser::parse()` parses the string with quotes.
7878

79+
- [#31](https://github.com/laminas/laminas-mail/pull/31) Properly encode `content-disposition` header.
80+
7981
- [#88](https://github.com/laminas/laminas-mail/pull/88) fixes recognising encoding of `Subject` and `GenericHeader` headers.
8082

8183
## 2.10.0 - 2018-06-07

‎src/Header/ContentDisposition.php

+296
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,296 @@
1+
<?php
2+
3+
/**
4+
* @see https://github.com/laminas/laminas-mail for the canonical source repository
5+
* @copyright https://github.com/laminas/laminas-mail/blob/master/COPYRIGHT.md
6+
* @license https://github.com/laminas/laminas-mail/blob/master/LICENSE.md New BSD License
7+
*/
8+
9+
namespace Laminas\Mail\Header;
10+
11+
use Laminas\Mail\Headers;
12+
use Laminas\Mime\Mime;
13+
14+
class ContentDisposition implements UnstructuredInterface
15+
{
16+
/**
17+
* 78 chars (RFC 2822) - (semicolon + space (Header::FOLDING))
18+
*
19+
* @var int
20+
*/
21+
const MAX_PARAMETER_LENGTH = 76;
22+
23+
/**
24+
* @var string
25+
*/
26+
protected $disposition = 'inline';
27+
28+
/**
29+
* Header encoding
30+
*
31+
* @var string
32+
*/
33+
protected $encoding = 'ASCII';
34+
35+
/**
36+
* @var array
37+
*/
38+
protected $parameters = [];
39+
40+
/**
41+
* @inheritDoc
42+
*/
43+
public static function fromString($headerLine)
44+
{
45+
list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
46+
$value = HeaderWrap::mimeDecodeValue($value);
47+
48+
// check to ensure proper header type for this factory
49+
if (strtolower($name) !== 'content-disposition') {
50+
throw new Exception\InvalidArgumentException('Invalid header line for Content-Disposition string');
51+
}
52+
53+
$value = str_replace(Headers::FOLDING, ' ', $value);
54+
$parts = explode(';', $value, 2);
55+
56+
$header = new static();
57+
$header->setDisposition($parts[0]);
58+
59+
if (isset($parts[1])) {
60+
$values = ListParser::parse(trim($parts[1]), [';', '=']);
61+
$length = count($values);
62+
$continuedValues = [];
63+
64+
for ($i = 0; $i < $length; $i += 2) {
65+
$value = $values[$i + 1];
66+
$value = trim($value, "'\" \t\n\r\0\x0B");
67+
$name = trim($values[$i], "'\" \t\n\r\0\x0B");
68+
69+
if (strpos($name, '*')) {
70+
list($name, $count) = explode('*', $name);
71+
if (! isset($continuedValues[$name])) {
72+
$continuedValues[$name] = [];
73+
}
74+
$continuedValues[$name][$count] = $value;
75+
} else {
76+
$header->setParameter($name, $value);
77+
}
78+
}
79+
80+
foreach ($continuedValues as $name => $values) {
81+
$value = '';
82+
for ($i = 0; $i < count($values); $i++) {
83+
if (! isset($values[$i])) {
84+
throw new Exception\InvalidArgumentException(
85+
'Invalid header line for Content-Disposition string - incomplete continuation'
86+
);
87+
}
88+
$value .= $values[$i];
89+
}
90+
$header->setParameter($name, $value);
91+
}
92+
}
93+
94+
return $header;
95+
}
96+
97+
/**
98+
* @inheritDoc
99+
*/
100+
public function getFieldName()
101+
{
102+
return 'Content-Disposition';
103+
}
104+
105+
/**
106+
* @inheritDoc
107+
*/
108+
public function getFieldValue($format = HeaderInterface::FORMAT_RAW)
109+
{
110+
$result = $this->disposition;
111+
if (empty($this->parameters)) {
112+
return $result;
113+
}
114+
115+
foreach ($this->parameters as $attribute => $value) {
116+
$valueIsEncoded = false;
117+
if (HeaderInterface::FORMAT_ENCODED === $format && ! Mime::isPrintable($value)) {
118+
$value = $this->getEncodedValue($value);
119+
$valueIsEncoded = true;
120+
}
121+
122+
$line = sprintf('%s="%s"', $attribute, $value);
123+
124+
if (strlen($line) < self::MAX_PARAMETER_LENGTH) {
125+
$lines = explode(Headers::FOLDING, $result);
126+
127+
if (count($lines) === 1) {
128+
$existingLineLength = strlen('Content-Disposition: ' . $result);
129+
} else {
130+
$existingLineLength = 1 + strlen($lines[count($lines) - 1]);
131+
}
132+
133+
if ((2 + $existingLineLength + strlen($line)) <= self::MAX_PARAMETER_LENGTH) {
134+
$result .= '; ' . $line;
135+
} else {
136+
$result .= ';' . Headers::FOLDING . $line;
137+
}
138+
} else {
139+
// Use 'continuation' per RFC 2231
140+
$maxValueLength = strlen($value);
141+
do {
142+
$maxValueLength = ceil(0.6 * $maxValueLength);
143+
} while ($maxValueLength > self::MAX_PARAMETER_LENGTH);
144+
145+
if ($valueIsEncoded) {
146+
$encodedLength = strlen($value);
147+
$value = HeaderWrap::mimeDecodeValue($value);
148+
$decodedLength = strlen($value);
149+
$maxValueLength -= ($encodedLength - $decodedLength);
150+
}
151+
152+
$valueParts = str_split($value, $maxValueLength);
153+
$i = 0;
154+
foreach ($valueParts as $valuePart) {
155+
$attributePart = $attribute . '*' . $i++;
156+
if ($valueIsEncoded) {
157+
$valuePart = $this->getEncodedValue($valuePart);
158+
}
159+
$result .= sprintf(';%s%s="%s"', Headers::FOLDING, $attributePart, $valuePart);
160+
}
161+
}
162+
}
163+
164+
return $result;
165+
}
166+
167+
/**
168+
* @param string $value
169+
* @return string
170+
*/
171+
protected function getEncodedValue($value)
172+
{
173+
$configuredEncoding = $this->encoding;
174+
$this->encoding = 'UTF-8';
175+
$value = HeaderWrap::wrap($value, $this);
176+
$this->encoding = $configuredEncoding;
177+
return $value;
178+
}
179+
180+
/**
181+
* @inheritDoc
182+
*/
183+
public function setEncoding($encoding)
184+
{
185+
$this->encoding = $encoding;
186+
return $this;
187+
}
188+
189+
/**
190+
* @inheritDoc
191+
*/
192+
public function getEncoding()
193+
{
194+
return $this->encoding;
195+
}
196+
197+
/**
198+
* @inheritDoc
199+
*/
200+
public function toString()
201+
{
202+
return 'Content-Disposition: ' . $this->getFieldValue(HeaderInterface::FORMAT_ENCODED);
203+
}
204+
205+
/**
206+
* Set the content disposition
207+
* Expected values include 'inline', 'attachment'
208+
*
209+
* @param string $disposition
210+
* @return ContentDisposition
211+
*/
212+
public function setDisposition($disposition)
213+
{
214+
$this->disposition = strtolower($disposition);
215+
return $this;
216+
}
217+
218+
/**
219+
* Retrieve the content disposition
220+
*
221+
* @return string
222+
*/
223+
public function getDisposition()
224+
{
225+
return $this->disposition;
226+
}
227+
228+
/**
229+
* Add a parameter pair
230+
*
231+
* @param string $name
232+
* @param string $value
233+
* @return ContentDisposition
234+
*/
235+
public function setParameter($name, $value)
236+
{
237+
$name = strtolower($name);
238+
239+
if (! HeaderValue::isValid($name)) {
240+
throw new Exception\InvalidArgumentException(
241+
'Invalid content-disposition parameter name detected'
242+
);
243+
}
244+
// '5' here is for the quotes & equal sign in `name="value"`,
245+
// and the space & semicolon for line folding
246+
if ((strlen($name) + 5) >= self::MAX_PARAMETER_LENGTH) {
247+
throw new Exception\InvalidArgumentException(
248+
'Invalid content-disposition parameter name detected (too long)'
249+
);
250+
}
251+
252+
$this->parameters[$name] = $value;
253+
return $this;
254+
}
255+
256+
/**
257+
* Get all parameters
258+
*
259+
* @return array
260+
*/
261+
public function getParameters()
262+
{
263+
return $this->parameters;
264+
}
265+
266+
/**
267+
* Get a parameter by name
268+
*
269+
* @param string $name
270+
* @return null|string
271+
*/
272+
public function getParameter($name)
273+
{
274+
$name = strtolower($name);
275+
if (isset($this->parameters[$name])) {
276+
return $this->parameters[$name];
277+
}
278+
return null;
279+
}
280+
281+
/**
282+
* Remove a named parameter
283+
*
284+
* @param string $name
285+
* @return bool
286+
*/
287+
public function removeParameter($name)
288+
{
289+
$name = strtolower($name);
290+
if (isset($this->parameters[$name])) {
291+
unset($this->parameters[$name]);
292+
return true;
293+
}
294+
return false;
295+
}
296+
}

‎src/Header/HeaderLoader.php

+3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ class HeaderLoader extends PluginClassLoader
2121
protected $plugins = [
2222
'bcc' => 'Laminas\Mail\Header\Bcc',
2323
'cc' => 'Laminas\Mail\Header\Cc',
24+
'contentdisposition' => 'Laminas\Mail\Header\ContentDisposition',
25+
'content_disposition' => 'Laminas\Mail\Header\ContentDisposition',
26+
'content-disposition' => 'Laminas\Mail\Header\ContentDisposition',
2427
'contenttype' => 'Laminas\Mail\Header\ContentType',
2528
'content_type' => 'Laminas\Mail\Header\ContentType',
2629
'content-type' => 'Laminas\Mail\Header\ContentType',

0 commit comments

Comments
 (0)