Spec-Zone.ru › Ruby on Rails 6.1

модуль ActionController::DataStreaming

Включенные модули:
ActionController::Rendering

Методы для отправки произвольных данных и потоковой передачи файлов в браузер вместо рендеринга.

Приватные методы экземпляра

send_data(data, options = {}) Показать исходный код
# 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-* и кешировании.

send_file(path, options = {}) Показать исходный код
# 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) с помощью промежуточного ПО 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, если вы хотите предоставить пользователю больше информации (такой как 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–2020 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API