Module: ActionController::DataStreaming
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::ActiveSupport::Concern
|
|
Instance Chain:
self,
Rendering
|
|
Defined in: | actionpack/lib/action_controller/metal/data_streaming.rb |
Overview
Methods for sending arbitrary data and for streaming files to the browser, instead of rendering.
Constant Summary
-
DEFAULT_SEND_FILE_DISPOSITION =
Internal use only
# File 'actionpack/lib/action_controller/metal/data_streaming.rb', line 19"attachment"
-
DEFAULT_SEND_FILE_TYPE =
Internal use only
# File 'actionpack/lib/action_controller/metal/data_streaming.rb', line 18"application/octet-stream"
Rendering
- Included
Class Method Summary
::ActiveSupport::Concern
- Extended
class_methods | Define class methods from given block. |
included | Evaluate given block in context of base class, so that you can write class macros here. |
prepended | Evaluate given block in context of base class, so that you can write class macros here. |
append_features, prepend_features |
Instance Method Summary
-
#send_data(data, options = {})
private
Sends the given binary data to the browser.
-
#send_file(path, options = {})
private
Sends the file.
- #send_file_headers!(options) private
Rendering
- Included
#render | Renders a template and assigns the result to |
#render_to_string | Similar to |
#_normalize_options | Normalize both text and status options. |
#_normalize_text, | |
#_process_options | Process controller specific options, as status, content-type and location. |
#_process_variant, #_render_in_priorities, #_set_html_content_type, #_set_rendered_content_type, #_set_vary_header, #render_to_body, | |
#process_action | Before processing, set the request formats in current controller formats. |
Instance Method Details
#send_data(data, options = {}) (private)
Sends the given binary data to the browser. This method is similar to ‘render plain: data`, but also allows you to specify whether the browser should display the response as a file attachment (i.e. in a download dialog) or as inline data. You may also set the content type, the file name, and other things.
Options:
-
:filename
- suggests a filename for the browser to use. -
:type
- specifies an HTTP content type. Defaults toapplication/octet-stream
. You can specify either a string or a symbol for a registered type with Mime::Type.register, for example:json
. If omitted, type will be inferred from the file extension specified in:filename
. If no content type is registered for the extension, the default typeapplication/octet-stream
will be used. -
:disposition
- specifies whether the file will be shown inline or downloaded. Valid values are“inline”
and“attachment”
(default). -
:status
- specifies the status code to send with the response. Defaults to 200.
Generic data download:
send_data buffer
Download a dynamically-generated tarball:
send_data generate_tgz('dir'), filename: 'dir.tgz'
Display an image Active Record in the browser:
send_data image.data, type: image.content_type, disposition: 'inline'
See #send_file for more information on HTTP Content-*
headers and caching.
# File 'actionpack/lib/action_controller/metal/data_streaming.rb', line 120
def send_data(data, = {}) # :doc: send_file_headers! render .slice(:status, :content_type).merge(body: data) end
#send_file(path, options = {}) (private)
Sends the file. This uses a server-appropriate method (such as X-Sendfile
) via the Rack::Sendfile
middleware. The header to use is set via config.action_dispatch.x_sendfile_header
. Your server can also configure this for you by setting the X-Sendfile-Type
header.
Be careful to sanitize the path parameter if it is coming from a web page. send_file(params[:path])
allows a malicious user to download any file on your server.
Options:
-
:filename
- suggests a filename for the browser to use. Defaults to ‘File.basename(path)`. -
:type
- specifies an HTTP content type. You can specify either a string or a symbol for a registered type with Mime::Type.register, for example:json
. If omitted, the type will be inferred from the file extension specified in:filename
. If no content type is registered for the extension, the default typeapplication/octet-stream
will be used. -
:disposition
- specifies whether the file will be shown inline or downloaded. Valid values are“inline”
and“attachment”
(default). -
:status
- specifies the status code to send with the response. Defaults to 200. -
:url_based_filename
- set totrue
if you want the browser to guess the filename from the URL, which is necessary for i18n filenames on certain browsers (setting:filename
overrides this option).
The default Content-Type
and Content-Disposition
headers are set to download arbitrary binary files in as many browsers as possible. IE versions 4, 5, 5.5, and 6 are all known to have a variety of quirks (especially when downloading over SSL).
Simple download:
send_file '/path/to.zip'
Show a JPEG in the browser:
send_file '/path/to.jpeg', type: 'image/jpeg', disposition: 'inline'
Show a 404 page in the browser:
send_file '/path/to/404.html', type: 'text/html; charset=utf-8', disposition: 'inline', status: 404
You can use other Content-*
HTTP headers to provide additional information to the client. See MDN for a [list of HTTP headers](developer.mozilla.org/en-US/docs/Web/HTTP/Headers).
Also be aware that the document may be cached by proxies and browsers. The Pragma
and Cache-Control
headers declare how the file may be cached by intermediaries. They default to require clients to validate with the server before releasing cached responses. See www.mnot.net/cache_docs/ for an overview of web caching and [RFC 9111](www.rfc-editor.org/rfc/rfc9111.html#name-cache-control) for the Cache-Control
header spec.
# File 'actionpack/lib/action_controller/metal/data_streaming.rb', line 76
def send_file(path, = {}) # :doc: raise MissingFile, "Cannot read file #{path}" unless File.file?(path) && File.readable?(path) [:filename] ||= File.basename(path) unless [:url_based_filename] send_file_headers! self.status = [:status] || 200 self.content_type = [:content_type] if .key?(:content_type) response.send_file path end
#send_file_headers!(options) (private)
# File 'actionpack/lib/action_controller/metal/data_streaming.rb', line 125
def send_file_headers!( ) type_provided = .has_key?(:type) content_type = .fetch(:type, DEFAULT_SEND_FILE_TYPE) self.content_type = content_type response.sending_file = true raise ArgumentError, ":type option required" if content_type.nil? if content_type.is_a?(Symbol) extension = Mime[content_type] raise ArgumentError, "Unknown MIME type #{ [:type]}" unless extension self.content_type = extension else if !type_provided && [:filename] # If type wasn't provided, try guessing from file extension. content_type = Mime::Type.lookup_by_extension(File.extname( [:filename]).downcase.delete(".")) || content_type end self.content_type = content_type end disposition = .fetch(:disposition, DEFAULT_SEND_FILE_DISPOSITION) if disposition headers["Content-Disposition"] = ActionDispatch::Http::ContentDisposition.format(disposition: disposition, filename: [:filename]) end headers["Content-Transfer-Encoding"] = "binary" end