Skip to content

Commit

Permalink
bug fixes #250 and #251
Browse files Browse the repository at this point in the history
  • Loading branch information
nyamsprod committed Aug 30, 2017
1 parent c2ce6a3 commit 6f82c76
Show file tree
Hide file tree
Showing 8 changed files with 82 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ matrix:
- php: 7.1
env: COLLECT_COVERAGE=true VALIDATE_CODING_STYLE=true
- php: master
env: COLLECT_COVERAGE=true VALIDATE_CODING_STYLE=false
env: COLLECT_COVERAGE=false VALIDATE_CODING_STYLE=false
allow_failures:
- php: master
fast_finish: true
Expand Down
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,25 @@

All Notable changes to `Csv` will be documented in this file

## Next - TBD

### Added

- Nothing

### Deprecated

- Nothing

### Fixed

- Bug fixes headers from AbstractCsv::output according to RFC6266 [#250](https://github.com/thephpleague/csv/issues/250)
- Make sure the internal source still exists before closing it [#251](https://github.com/thephpleague/csv/issues/251)

### Removed

- Nothing

## 9.0.1 - 2017-08-21

### Added
Expand Down
2 changes: 1 addition & 1 deletion docs/9.0/connections/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ die;

use League\Csv\Reader;

$reader = Reader::createFromPath('/path/to/my/file.csv');
$reader = Reader::createFromPath('file.csv');
$reader->output("name-for-your-file.csv");
die;
~~~
Expand Down
8 changes: 4 additions & 4 deletions docs/_data/project.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ repository: 'csv'
releases:
# next:
# version: '10.0'
# requires: 'PHP >= 5.5.0'
# latest: '8.2.1 - 2017-02-03'
# requires: 'PHP >= 7.3.0'
# latest: '10.0.0 - 2020-02-29'
# supported_until: 'TBD'
# documentation_link: '/8.0/'
# documentation_link: '/10.0/'
current:
version: '9.0'
requires: 'PHP >= 7.0.10'
latest: '9.0.0 - 2017-08-18'
latest: '9.0.1 - 2017-08-21'
supported_until: 'TBD'
documentation_link: '/9.0/'
previous:
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrading/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ redirect_from: /changelog/
All Notable changes to `Csv` will be documented in this file

{% for release in site.github.releases %}
## {{ release.name }}
## {{ release.name }} - {{ release.published_at | date: "%Y-%m-%d" }}
{{ release.body | replace:'```':'~~~' | markdownify }}
{% endfor %}
43 changes: 38 additions & 5 deletions src/AbstractCsv.php
Original file line number Diff line number Diff line change
Expand Up @@ -303,12 +303,8 @@ public function chunk(int $length): Generator
public function output(string $filename = null): int
{
if (null !== $filename) {
header('Content-Type: text/csv');
header('Content-Transfer-Encoding: binary');
header('Content-Description: File Transfer');
header('Content-Disposition: attachment; filename="'.rawurlencode($filename).'"');
$this->sendHeaders($filename);
}

$input_bom = $this->getInputBOM();
$this->document->rewind();
$this->document->fseek(strlen($input_bom));
Expand All @@ -317,6 +313,43 @@ public function output(string $filename = null): int
return strlen($this->output_bom) + $this->document->fpassthru();
}

/**
* Send the CSV headers
*
* Adapted from Symfony\Component\HttpFoundation\ResponseHeaderBag::makeDisposition
*
* @param string|null $filename CSV disposition name
*
* @throws Exception if the submitted header is invalid according to RFC 6266
*
* @see https://tools.ietf.org/html/rfc6266#section-4.3
*/
protected function sendHeaders(string $filename)
{
if (strlen($filename) != strcspn($filename, '\\/')) {
throw new Exception('The filename cannot contain the "/" and "\\" characters.');
}

$flag = FILTER_FLAG_STRIP_LOW;
if (strlen($filename) !== mb_strlen($filename)) {
$flag |= FILTER_FLAG_STRIP_HIGH;
}

$filenameFallback = filter_var($filename, FILTER_SANITIZE_STRING, $flag);
$filenameFallback = str_replace('%', '', $filenameFallback);

$disposition = sprintf('attachment; filename="%s"', str_replace('"', '\\"', $filenameFallback));
if ($filename !== $filenameFallback) {
$disposition .= sprintf("; filename*=utf-8''%s", rawurlencode($filename));
}
$disposition .= '; modification-date="'.date('r').'"';

header('Content-Type: text/csv');
header('Content-Transfer-Encoding: binary');
header('Content-Description: File Transfer');
header('Content-Disposition: '.$disposition);
}

/**
* Sets the field delimiter
*
Expand Down
2 changes: 1 addition & 1 deletion src/Stream.php
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ public function __destruct()

array_walk_recursive($this->filters, $walker);

if ($this->should_close_stream) {
if ($this->should_close_stream && is_resource($this->stream)) {
fclose($this->stream);
}

Expand Down
22 changes: 17 additions & 5 deletions tests/CsvTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,27 @@ public function testCloningIsForbidden()
/**
* @runInSeparateProcess
* @covers ::output
* @covers ::sendHeaders
*/
public function testOutputSize()
{
$this->assertSame(60, $this->csv->output(__DIR__.'/data/test.csv'));
$this->assertSame(60, $this->csv->output('test.csv'));
}

/**
* @covers ::output
* @covers ::sendHeaders
*/
public function testInvalidOutputFile()
{
$this->expectException(Exception::class);
$this->csv->output('invalid/file.csv');
}

/**
* @runInSeparateProcess
* @covers ::output
* @covers ::sendHeaders
* @covers ::createFromString
* @covers League\Csv\Stream
*/
Expand All @@ -140,15 +152,15 @@ public function testOutputHeaders()

$raw_csv = Reader::BOM_UTF8."john,doe,[email protected]\njane,doe,[email protected]\n";
$csv = Reader::createFromString($raw_csv);
$csv->output('test.csv');
$csv->output('tést.csv');
$headers = \xdebug_get_headers();

// Due to the variety of ways the xdebug expresses Content-Type of text files,
// we cannot count on complete string matching.
$this->assertContains('content-type: text/csv', strtolower($headers[0]));
$this->assertSame($headers[1], 'Content-Transfer-Encoding: binary');
$this->assertSame($headers[2], 'Content-Description: File Transfer');
$this->assertSame($headers[3], 'Content-Disposition: attachment; filename="test.csv"');
$this->assertSame('Content-Transfer-Encoding: binary', $headers[1]);
$this->assertSame('Content-Description: File Transfer', $headers[2]);
$this->assertContains('Content-Disposition: attachment; filename="tst.csv"; filename*=utf-8\'\'t%C3%A9st.csv; modification-date="', $headers[3]);
}

/**
Expand Down

0 comments on commit 6f82c76

Please sign in to comment.