Module: ActionDispatch::Http::MimeNegotiation

Extended by:
ActiveSupport::Concern
Included in:
Request
Defined in:
actionpack/lib/action_dispatch/http/mime_negotiation.rb

Defined Under Namespace

Classes: InvalidType

Constant Summary collapse

RESCUABLE_MIME_FORMAT_ERRORS =
[
  ActionController::BadRequest,
  ActionDispatch::Http::Parameters::ParseError,
]

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included, prepend_features, prepended

Instance Method Details

#acceptsObject

Returns the accepted MIME type for the request.


54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 54

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

#content_mime_typeObject

The MIME type of the HTTP request, such as Mime.


23
24
25
26
27
28
29
30
31
32
33
34
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 23

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

#content_typeObject


36
37
38
39
40
41
42
43
44
45
46
47
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 36

def content_type
  if self.class.return_only_media_type_on_content_type
    ActiveSupport::Deprecation.warn(
      "Rails 7.1 will return Content-Type header without modification." \
      " If you want just the MIME type, please use `#media_type` instead."
    )

    content_mime_type&.to_s
  else
    super
  end
end

#format(view_path = []) ⇒ Object

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

75
76
77
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 75

def format(view_path = [])
  formats.first || Mime::NullType.instance
end

#format=(extension) ⇒ Object

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

127
128
129
130
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 127

def format=(extension)
  parameters[:format] = extension.to_s
  set_header "action_dispatch.request.formats", [Mime::Type.lookup_by_extension(parameters[:format])]
end

#formatsObject


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 79

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
    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

#formats=(extensions) ⇒ Object

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

146
147
148
149
150
151
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 146

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

#has_content_type?Boolean

:nodoc:

Returns:

  • (Boolean)

49
50
51
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 49

def has_content_type? # :nodoc:
  get_header "CONTENT_TYPE"
end

#negotiate_mime(order) ⇒ Object

Returns the first MIME type that matches the provided array of MIME types.


154
155
156
157
158
159
160
161
162
163
164
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 154

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

#should_apply_vary_header?Boolean

Returns:

  • (Boolean)

166
167
168
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 166

def should_apply_vary_header?
  !params_readable? && use_accept_header && valid_accept_header
end

#variantObject


112
113
114
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 112

def variant
  @variant ||= ActiveSupport::ArrayInquirer.new
end

#variant=(variant) ⇒ Object

Sets the variant for template.


102
103
104
105
106
107
108
109
110
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 102

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