Module: ActionDispatch::Http::MimeNegotiation

Defined in:
actionpack/lib/action_dispatch/http/mime_negotiation.rb

Constant Summary

BROWSER_LIKE_ACCEPTS = 
/,\s*\*\/\*|\*\/\*\s*,/

Instance Method Summary (collapse)

Instance Method Details

- (Object) accepts

Returns the accepted MIME type for the request.



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

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.



8
9
10
11
12
13
14
15
16
 
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 8

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 



18
19
20
 
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 18

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


41
42
43
 
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 41

def format(view_path = [])
  formats.first
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_filter :adjust_format_for_iphone

  private
    def adjust_format_for_iphone
      request.format = :iphone if request.env["HTTP_USER_AGENT"][/iPhone/]
    end
end


71
72
73
74
 
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 71

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

- (Object) formats 



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 47

def formats
  accept = @env['HTTP_ACCEPT']

  @env["action_dispatch.request.formats"] ||=
    if parameters[:format]
      Array(Mime[parameters[:format]])
    elsif xhr? || (accept && accept !~ BROWSER_LIKE_ACCEPTS)
      accepts
    else
      [Mime::HTML]
    end
end

- (Object) negotiate_mime(order)

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



79
80
81
82
83
84
85
86
87
88
89
 
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 79

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) ? formats.first : nil
end