# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 40 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 end end
Returns the accepted MIME type for the request.
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 20 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 end end
The MIME type of the HTTP request, such as Mime.
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 31 def content_type content_mime_type && content_mime_type.to_s end
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 59 def format(view_path = []) formats.first || Mime::NullType.instance 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
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 117 def format=(extension) parameters[:format] = extension.to_s set_header "action_dispatch.request.formats", [Mime::Type.lookup_by_extension(parameters[:format])] 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
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 63 def formats fetch_header("action_dispatch.request.formats") do |k| params_readable = begin parameters[:format] rescue *RESCUABLE_MIME_FORMAT_ERRORS false end v = if params_readable Array(Mime[parameters[:format]]) elsif use_accept_header && valid_accept_header accepts elsif extension_format = format_from_path_extension [extension_format] elsif xhr? [Mime[:js]] else [Mime[:html]] end v = v.select do |format| format.symbol || format.ref == "*/*" end set_header k, v end end
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 136 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
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 fallback 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
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 144 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
Returns the first MIME type that matches the provided array of MIME types.
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 102 def variant @variant ||= ActiveSupport::ArrayInquirer.new end
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 92 def variant=(variant) variant = Array(variant) if variant.all? { |v| v.is_a?(Symbol) } @variant = ActiveSupport::ArrayInquirer.new(variant) else raise ArgumentError, "request.variant must be set to a Symbol or an Array of Symbols." end end
Sets the variant for template.
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 169 def format_from_path_extension # :doc: path = get_header("action_dispatch.original_path") || get_header("PATH_INFO") if match = path && path.match(/\.(\w+)\z/) Mime[match.captures.first] end end
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 165 def use_accept_header # :doc: !self.class.ignore_accept_header end
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 160 def valid_accept_header # :doc: (xhr? && (accept.present? || content_mime_type)) || (accept.present? && accept !~ BROWSER_LIKE_ACCEPTS) end
© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.