module ActionDispatch::Http::MimeNegotiation
Constants
We use normal content negotiation unless you include / in your list, in which case we assume you’re a browser and send HTML.
/,\s*\*\/\*|\*\/\*\s*,/
[
ActionController::BadRequest,
ActionDispatch::Http::Parameters::ParseError,
]
Public instance methods
Returns the accepted MIME type for the request.
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 42
def accepts
fetch_header("action_dispatch.request.accepts") do |k|
header = get_header("HTTP_ACCEPT").to_s.strip
v = if header.empty?
[content_mime_type]
else
Mime::Type.parse(header)
end
set_header k, v
rescue ::Mime::Type::InvalidMimeType => e
raise InvalidType, e.message
end
end
The MIME type of the HTTP request, such as Mime.
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 24
def content_mime_type
fetch_header("action_dispatch.request.content_type") do |k|
v = if get_header("CONTENT_TYPE") =~ /^([^,;]*)/
Mime::Type.lookup($1.strip.downcase)
else
nil
end
set_header k, v
rescue ::Mime::Type::InvalidMimeType => e
raise InvalidType, e.message
end
end
Returns the MIME type for the format used in the request.
GET /posts/5.xml | request.format => Mime[:xml]
GET /posts/5.xhtml | request.format => Mime[:html]
GET /posts/5 | request.format => Mime[:html] or Mime[:js], or request.accepts.first
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 63
def format(_view_path = nil)
formats.first || Mime::NullType.instance
end
Sets the format by string extension, which can be used to force custom formats that are not controlled by the extension.
class ApplicationController < ActionController::Base
before_action :adjust_format_for_iphone
private
def adjust_format_for_iphone
request.format = :iphone if request.env["HTTP_USER_AGENT"][/iPhone/]
end
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 115
def format=(extension)
parameters[:format] = extension.to_s
set_header "action_dispatch.request.formats", [Mime::Type.lookup_by_extension(parameters[:format])]
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 67
def formats
fetch_header("action_dispatch.request.formats") do |k|
v = if params_readable?
Array(Mime[parameters[:format]])
elsif use_accept_header && valid_accept_header
accepts.dup
elsif extension_format = format_from_path_extension
[extension_format]
elsif xhr?
[Mime[:js]]
else
[Mime[:html]]
end
v.select! do |format|
format.symbol || format.ref == "*/*"
end
set_header k, v
end
end
Sets the formats by string extensions. This differs from format=
by allowing you to set multiple, ordered formats, which is useful when you want to have a fallback.
In this example, the :iphone
format will be used if it’s available, otherwise it’ll fall back to the :html
format.
class ApplicationController < ActionController::Base
before_action :adjust_format_for_iphone_with_html_fallback
private
def adjust_format_for_iphone_with_html_fallback
request.formats = [ :iphone, :html ] if request.env["HTTP_USER_AGENT"][/iPhone/]
end
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 135
def formats=(extensions)
parameters[:format] = extensions.first.to_s
set_header "action_dispatch.request.formats", extensions.collect { |extension|
Mime::Type.lookup_by_extension(extension)
}
end
Returns the first MIME type that matches the provided array of MIME types.
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 143
def negotiate_mime(order)
formats.each do |priority|
if priority == Mime::ALL
return order.first
elsif order.include?(priority)
return priority
end
end
order.include?(Mime::ALL) ? format : nil
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 155
def should_apply_vary_header?
!params_readable? && use_accept_header && valid_accept_header
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 100
def variant
@variant ||= ActiveSupport::ArrayInquirer.new
end
Sets the variant for template.
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 90
def variant=(variant)
variant = Array(variant)
if variant.all?(Symbol)
@variant = ActiveSupport::ArrayInquirer.new(variant)
else
raise ArgumentError, "request.variant must be set to a Symbol or an Array of Symbols."
end
end