[HttpFoundation] Add a StreamedFileResponse. #4323

niklasf · 2012-05-18T10:33:02Z

In the Drupal 8 branch where we are trying to leverage Symfonys HTTP Kernel we
currently have something like this:

function file_download(...) {
  // [...]
  return new StreamedResponse(function() use ($uri)) {
    if (... && fopen($uri, 'rb')) {
      while (!feof($fd)) {
        print fread($fd, 1024);
      }
      fclose($fd);
    }
  }, 200, $headers);
}

This is bad because:

There might be better methods of streaming out a file, like X-Sendfile if
available.
Code like this is duplicated in different places.

Obvious solution to the latter point: Factor that out to something like a
StreamedFileResponse. Basically, then, the question is why such a class
shouldn't be in Symfony itself.

Heres a sketch of what such a class would have to do. For discussion and as
context for the following questions, without testcoverage or a changelog entry
(yet).

Generally: Have something like that in Symfony?
Detail: How to do error handling? Can I throw exceptions from the HttpKernel
component?
How to best enable the different transfer methods? The switch-case stuff
doesn't look good. How to leverage the dependency injection container or
keep it compatible with that?

In the Drupal 8 branch where we are trying to leverage Symfonys HTTP Kernel we currently have something like this: ``` function file_download(...) { // [...] return new StreamedResponse(function() use ($uri)) { if (... && fopen($uri, 'rb')) { while (!feof($fd)) { print fread($fd, 1024); } fclose($fd); } }, 200, $headers); } ``` This is bad because: - There might be better methods of streaming out a file, like X-Sendfile if available. - Code like this is duplicated in different places. Obvious solution to the latter point: Factor that out to something like a StreamedFileResponse. Basically, then, the question is why such a class shouldn't be in Symfony itself. Heres a sketch of what such a class would have to do. For discussion and as context for the following questions, without testcoverage or a changelog entry (yet). - Generally: Have something like that in Symfony? - Detail: How to do error handling? Can I throw exceptions from the HttpKernel component? - How to best enable the different transfer methods? The switch-case stuff doesn't look good. How to leverage the dependency injection container or keep it compatible with that?

travisbot · 2012-05-18T10:36:10Z

This pull request passes (merged 5be540d into 1e15f21).

stof · 2012-05-18T10:58:23Z

If you want to serve files through Symfony, you can look at https://github.com/igorw/IgorwFileServeBundle

vicb · 2012-05-18T11:23:09Z

also check #3602

niklasf · 2012-05-18T13:45:22Z

Thank you!

@Crell: Looks like there have been some efforts to bring in a simple BinaryFileResponse with one transfer method, because even that isn't trivial but would be very useful. Probably that should be revived. Such a class in Symfony would be awesome.
IgorwFileServeBundle looks great, too. With a dependency injection container for all the different transfer methods and stuff.

niklasf closed this May 18, 2012

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[HttpFoundation] Add a StreamedFileResponse. #4323

[HttpFoundation] Add a StreamedFileResponse. #4323

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[HttpFoundation] Add a StreamedFileResponse. #4323

[HttpFoundation] Add a StreamedFileResponse. #4323

Uh oh!

Conversation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!