модуль ActionController::DataStreaming
Методы для отправки произвольных данных и потоковой передачи файлов в браузер вместо рендеринга.
Приватные методы экземпляров
# File actionpack/lib/action_controller/metal/data_streaming.rb, line 109
def send_data(data, options = {}) #:doc:
send_file_headers! options
render options.slice(:status, :content_type).merge(body: data)
end Отправляет заданные бинарные данные в браузер. Этот метод похож на render plain: data, но также позволяет указать, должен ли браузер отображать ответ как вложение файла (т.е. в диалоге загрузки) или как данные в строке. Также можно установить тип содержимого, имя файла и другие параметры.
Параметры:
-
:filename— предлагает имя файла для использования браузером. -
:type— указывает HTTP-тип содержимого. По умолчанию — 'application/octet-stream'. Можно указать строку или символ для зарегистрированного типа с помощьюMime::Type.register, например :json. Если опущено, тип будет определён из расширения файла, указанного в:filename. Если для расширения не зарегистрирован тип содержимого, будет использован тип по умолчанию 'application/octet-stream'. -
:disposition— указывает, будет ли файл показан в строке или загружен. Допустимые значения — 'inline' и 'attachment' (по умолчанию). -
:status— указывает код состояния, который нужно отправить вместе с ответом. По умолчанию — 200.
Загрузка данных в общем случае:
send_data buffer
Загрузка динамически сгенерированного tar-архива:
send_data generate_tgz('dir'), filename: 'dir.tgz'
Отображение изображения Active Record в браузере:
send_data image.data, type: image.content_type, disposition: 'inline'
См. send_file для получения дополнительной информации о заголовках HTTP Content-* и кэшировании.
# File actionpack/lib/action_controller/metal/data_streaming.rb, line 69
def send_file(path, options = {}) #:doc:
raise MissingFile, "Cannot read file #{path}" unless File.file?(path) && File.readable?(path)
options[:filename] ||= File.basename(path) unless options[:url_based_filename]
send_file_headers! options
self.status = options[:status] || 200
self.content_type = options[:content_type] if options.key?(:content_type)
response.send_file path
end Отправляет файл. Использует подходящий для сервера метод (например, X-Sendfile) через middleware Rack::Sendfile. Используемый заголовок устанавливается через config.action_dispatch.x_sendfile_header. Ваш сервер также может настроить его, установив заголовок X-Sendfile-Type.
Будьте внимательны, очищая параметр пути, если он поступает с веб-страницы. send_file(params[:path]) позволяет злоумышленнику загрузить любой файл с вашего сервера.
Параметры:
-
:filename— предлагает имя файла для использования браузером. По умолчанию —File.basename(path). -
:type— указывает HTTP-тип содержимого. Можно указать строку или символ для зарегистрированного типа с помощьюMime::Type.register, например :json. Если опущено, тип будет определён из расширения файла, указанного в:filename. Если для расширения не зарегистрирован тип содержимого, будет использован тип по умолчанию 'application/octet-stream'. -
:disposition— указывает, будет ли файл показан в строке или загружен. Допустимые значения — 'inline' и 'attachment' (по умолчанию). -
:status— указывает код состояния, который нужно отправить вместе с ответом. По умолчанию — 200. -
:url_based_filename— устанавливается вtrue, если вы хотите, чтобы браузер угадал имя файла из URL, что необходимо для i18n имён файлов в некоторых браузерах (установка:filenameпереопределяет этот параметр).
По умолчанию заголовки Content-Type и Content-Disposition настроены для загрузки произвольных бинарных файлов в возможно большем количестве браузеров. Известны особенности работы IE версий 4, 5, 5.5 и 6 (особенно при загрузке по SSL).
Простая загрузка:
send_file '/path/to.zip'
Отображение JPEG в браузере:
send_file '/path/to.jpeg', type: 'image/jpeg', disposition: 'inline'
Отображение страницы 404 в браузере:
send_file '/path/to/404.html', type: 'text/html; charset=utf-8', status: 404
Узнайте подробнее об остальных заголовках Content-* HTTP, если вы хотите предоставить пользователю больше информации (например, Content-Description) в www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
Также имейте в виду, что документ может быть кэширован прокси-серверами и браузерами. Заголовки Pragma и Cache-Control указывают, как файл может быть кэширован посредниками. По умолчанию требуется проверка клиентом с сервером перед отображением кэшированного ответа. См. www.mnot.net/cache_docs/ для обзора кэширования в веб-среде и www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 для спецификации заголовка Cache-Control.
© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.