модуль ActionController::DataStreaming
Потоковая передача данных Action Controller
Методы для отправки произвольных данных и потоковой передачи файлов в браузер вместо рендеринга.
Приватные методы экземпляра
# File actionpack/lib/action_controller/metal/data_streaming.rb, line 111
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 71
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', disposition: 'inline', status: 404
Вы можете использовать другие Content-* заголовки HTTP, чтобы предоставить дополнительную информацию клиенту. См. MDN для списка заголовков HTTP.
Также учтите, что документ может кэшироваться прокси-серверами и браузерами. Заголовки Pragma и Cache-Control определяют, как файл может быть кэширован посредниками. Они по умолчанию требуют, чтобы клиенты проверяли с сервером перед освобождением кэшированных ответов. См. www.mnot.net/cache_docs/ для обзора кэширования веб-страниц и RFC 9111 для спецификации заголовка Cache-Control.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.