Module: ActionDispatch::Http::MimeNegotiation

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

Constant Summary

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included

Instance Attribute Details

- (Object) variant

Returns the value of attribute variant



13
14
15
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 13

def variant
  @variant
end

Instance Method Details

- (Object) accepts

Returns the accepted MIME type for the request.



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

def accepts
  @env["action_dispatch.request.accepts"] ||= begin
    header = @env['HTTP_ACCEPT'].to_s.strip

    if header.empty?
      [content_mime_type]
    else
      Mime::Type.parse(header)
    end
  end
end

- (Object) content_mime_type

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

For backward compatibility, the post format is extracted from the X-Post-Data-Format HTTP header if present.



19
20
21
22
23
24
25
26
27
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 19

def content_mime_type
  @env["action_dispatch.request.content_type"] ||= begin
    if @env['CONTENT_TYPE'] =~ /^([^,\;]*)/
      Mime::Type.lookup($1.strip.downcase)
    else
      nil
    end
  end
end

- (Object) content_type



29
30
31
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 29

def content_type
  content_mime_type && content_mime_type.to_s
end

- (Object) format(view_path = [])

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


52
53
54
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 52

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

- (Object) format=(extension)

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


94
95
96
97
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 94

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

- (Object) formats



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

def formats
  @env["action_dispatch.request.formats"] ||=
    if parameters[:format]
      Array(Mime[parameters[:format]])
    elsif use_accept_header && valid_accept_header
      accepts
    elsif xhr?
      [Mime::JS]
    else
      [Mime::HTML]
    end
end

- (Object) formats=(extensions)

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


113
114
115
116
117
118
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 113

def formats=(extensions)
  parameters[:format] = extensions.first.to_s
  @env["action_dispatch.request.formats"] = extensions.collect do |extension|
    Mime::Type.lookup_by_extension(extension)
  end
end

- (Object) negotiate_mime(order)

Receives an array of mimes and return the first user sent mime that matches the order array.



123
124
125
126
127
128
129
130
131
132
133
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 123

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