Class: Mime::Type

Inherits:
Object
  • Object
show all
Defined in:
lib/action_dispatch/http/mime_type.rb

Overview

Encapsulates the notion of a mime type. Can be used at render time, for example, with:

class PostsController < ActionController::Base
  def show
    @post = Post.find(params[:id])

    respond_to do |format|
      format.html
      format.ics { render :text => post.to_ics, :mime_type => Mime::Type["text/calendar"]  }
      format.xml { render :xml => @people.to_xml }
    end
  end
end

Defined Under Namespace

Classes: AcceptItem

Constant Summary collapse

@@html_types = 
Set.new [:html, :all]
@@browser_generated_types =

These are the content types which browsers can generate without using ajax, flash, etc i.e. following a link, getting an image or posting a form. CSRF protection only needs to protect against these types.

Set.new [:html, :url_encoded_form, :multipart_form, :text]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(string, symbol = nil, synonyms = []) ⇒ Type

Returns a new instance of Type.



165
166
167
168
 
# File 'lib/action_dispatch/http/mime_type.rb', line 165

def initialize(string, symbol = nil, synonyms = [])
  @symbol, @synonyms = symbol, synonyms
  @string = string
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object (private) 



216
217
218
219
220
221
222
 
# File 'lib/action_dispatch/http/mime_type.rb', line 216

def method_missing(method, *args)
  if method.to_s =~ /(\w+)\?$/
    $1.downcase.to_sym == to_sym
  else
    super
  end
end

Instance Attribute Details

#symbol ⇒ Object (readonly)

Returns the value of attribute symbol.



54
55
56
 
# File 'lib/action_dispatch/http/mime_type.rb', line 54

def symbol
  @symbol
end

Class Method Details

.lookup(string) ⇒ Object 



83
84
85
 
# File 'lib/action_dispatch/http/mime_type.rb', line 83

def lookup(string)
  LOOKUP[string]
end

.lookup_by_extension(extension) ⇒ Object 



87
88
89
 
# File 'lib/action_dispatch/http/mime_type.rb', line 87

def lookup_by_extension(extension)
  EXTENSION_LOOKUP[extension.to_s]
end

.parse(accept_header) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/action_dispatch/http/mime_type.rb', line 106

def parse(accept_header)
  if accept_header !~ /,/
    [Mime::Type.lookup(accept_header)]
  else
    # keep track of creation order to keep the subsequent sort stable
    list = []
    accept_header.split(/,/).each_with_index do |header, index|
      params, q = header.split(/;\s*q=/)
      if params
        params.strip!
        list << AcceptItem.new(index, params, q) unless params.empty?
      end
    end
    list.sort!

    # Take care of the broken text/xml entry by renaming or deleting it
    text_xml = list.index("text/xml")
    app_xml = list.index(Mime::XML.to_s)

    if text_xml && app_xml
      # set the q value to the max of the two
      list[app_xml].q = [list[text_xml].q, list[app_xml].q].max

      # make sure app_xml is ahead of text_xml in the list
      if app_xml > text_xml
        list[app_xml], list[text_xml] = list[text_xml], list[app_xml]
        app_xml, text_xml = text_xml, app_xml
      end

      # delete text_xml from the list
      list.delete_at(text_xml)

    elsif text_xml
      list[text_xml].name = Mime::XML.to_s
    end

    # Look for more specific XML-based types and sort them ahead of app/xml

    if app_xml
      idx = app_xml
      app_xml_type = list[app_xml]

      while(idx < list.length)
        type = list[idx]
        break if type.q < app_xml_type.q
        if type.name =~ /\+xml$/
          list[app_xml], list[idx] = list[idx], list[app_xml]
          app_xml = idx
        end
        idx += 1
      end
    end

    list.map! { |i| Mime::Type.lookup(i.name) }.uniq!
    list
  end
end

.register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false) ⇒ Object 



97
98
99
100
101
102
103
104
 
# File 'lib/action_dispatch/http/mime_type.rb', line 97

def register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false)
  Mime.const_set(symbol.to_s.upcase, Type.new(string, symbol, mime_type_synonyms))

  SET << Mime.const_get(symbol.to_s.upcase)

  ([string] + mime_type_synonyms).each { |str| LOOKUP[str] = SET.last } unless skip_lookup
  ([symbol.to_s] + extension_synonyms).each { |ext| EXTENSION_LOOKUP[ext] = SET.last }
end

.register_alias(string, symbol, extension_synonyms = []) ⇒ Object

Registers an alias that’s not used on mime type lookup, but can be referenced directly. Especially useful for rendering different HTML versions depending on the user agent, like an iPhone.



93
94
95
 
# File 'lib/action_dispatch/http/mime_type.rb', line 93

def register_alias(string, symbol, extension_synonyms = [])
  register(string, symbol, [], extension_synonyms, true)
end

Instance Method Details

#==(mime_type) ⇒ Object 



190
191
192
193
194
195
 
# File 'lib/action_dispatch/http/mime_type.rb', line 190

def ==(mime_type)
  return false if mime_type.blank?
  (@synonyms + [ self ]).any? do |synonym|
    synonym.to_s == mime_type.to_s || synonym.to_sym == mime_type.to_sym
  end
end

#===(list) ⇒ Object 



182
183
184
185
186
187
188
 
# File 'lib/action_dispatch/http/mime_type.rb', line 182

def ===(list)
  if list.is_a?(Array)
    (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) }
  else
    super
  end
end

#=~(mime_type) ⇒ Object 



197
198
199
200
201
202
203
 
# File 'lib/action_dispatch/http/mime_type.rb', line 197

def =~(mime_type)
  return false if mime_type.blank?
  regexp = Regexp.new(Regexp.quote(mime_type.to_s))
  (@synonyms + [ self ]).any? do |synonym|
    synonym.to_s =~ regexp
  end
end

#html? ⇒ Boolean

Returns:

  • (Boolean) 


211
212
213
 
# File 'lib/action_dispatch/http/mime_type.rb', line 211

def html?
  @@html_types.include?(to_sym) || @string =~ /html/
end

#to_s ⇒ Object 



170
171
172
 
# File 'lib/action_dispatch/http/mime_type.rb', line 170

def to_s
  @string
end

#to_str ⇒ Object 



174
175
176
 
# File 'lib/action_dispatch/http/mime_type.rb', line 174

def to_str
  to_s
end

#to_sym ⇒ Object 



178
179
180
 
# File 'lib/action_dispatch/http/mime_type.rb', line 178

def to_sym
  @symbol || @string.to_sym
end

#verify_request? ⇒ Boolean

Returns true if Action Pack should check requests using this Mime Type for possible request forgery. See ActionController::RequestForgeryProtection.

Returns:

  • (Boolean) 


207
208
209
 
# File 'lib/action_dispatch/http/mime_type.rb', line 207

def verify_request?
  @@browser_generated_types.include?(to_sym)
end