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

Defined Under Namespace

Classes: AcceptItem, AcceptList

Constant Summary collapse

TRAILING_STAR_REGEXP = 
/(text|application)\/\*/
PARAMETER_SEPARATOR_REGEXP = 
/;\s*\w+="?\w+"?/
@@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.



232
233
234
235
 
# File 'lib/action_dispatch/http/mime_type.rb', line 232

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) 



298
299
300
301
302
303
304
 
# File 'lib/action_dispatch/http/mime_type.rb', line 298

def method_missing(method, *args)
  if method.to_s.ends_with? '?'
    method[0..-2].downcase.to_sym == to_sym
  else
    super
  end
end

Instance Attribute Details

#symbol ⇒ Object (readonly)

Returns the value of attribute symbol.



61
62
63
 
# File 'lib/action_dispatch/http/mime_type.rb', line 61

def symbol
  @symbol
end

Class Method Details

.browser_generated_types ⇒ Object 



283
284
285
286
 
# File 'lib/action_dispatch/http/mime_type.rb', line 283

def self.browser_generated_types
  ActiveSupport::Deprecation.warn "Mime::Type.browser_generated_types is deprecated and will be removed in Rails 4.1"
  @@browser_generated_types
end

.lookup(string) ⇒ Object 



152
153
154
 
# File 'lib/action_dispatch/http/mime_type.rb', line 152

def lookup(string)
  LOOKUP[string]
end

.lookup_by_extension(extension) ⇒ Object 



156
157
158
 
# File 'lib/action_dispatch/http/mime_type.rb', line 156

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

.parse(accept_header) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/action_dispatch/http/mime_type.rb', line 180

def parse(accept_header)
  if !accept_header.include?(',')
    accept_header = accept_header.split(PARAMETER_SEPARATOR_REGEXP).first
    parse_trailing_star(accept_header) || [Mime::Type.lookup(accept_header)].compact
  else
    list, index = AcceptList.new, 0
    accept_header.split(',').each do |header|
      params, q = header.split(PARAMETER_SEPARATOR_REGEXP)
      if params.present?
        params.strip!

        params = parse_trailing_star(params) || [params]

        params.each do |m|
          list << AcceptItem.new(index, m.to_s, q)
          index += 1
        end
      end
    end
    list.assort!
  end
end

.parse_data_with_trailing_star(input) ⇒ Object

For an input of 'text', returns [Mime::JSON, Mime::XML, Mime::ICS, Mime::HTML, Mime::CSS, Mime::CSV, Mime::JS, Mime::YAML, Mime::TEXT].

For an input of 'application', returns [Mime::HTML, Mime::JS, Mime::XML, Mime::YAML, Mime::ATOM, Mime::JSON, Mime::RSS, Mime::URL_ENCODED_FORM].



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

def parse_data_with_trailing_star(input)
  Mime::SET.select { |m| m =~ input }
end

.parse_trailing_star(accept_header) ⇒ Object 



203
204
205
 
# File 'lib/action_dispatch/http/mime_type.rb', line 203

def parse_trailing_star(accept_header)
  parse_data_with_trailing_star($1) if accept_header =~ TRAILING_STAR_REGEXP
end

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



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/action_dispatch/http/mime_type.rb', line 166

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

  new_mime = Mime.const_get(symbol.upcase)
  SET << new_mime

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

  @register_callbacks.each do |callback|
    callback.call(new_mime)
  end
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.



162
163
164
 
# File 'lib/action_dispatch/http/mime_type.rb', line 162

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

.register_callback(&block) ⇒ Object 



148
149
150
 
# File 'lib/action_dispatch/http/mime_type.rb', line 148

def register_callback(&block)
  @register_callbacks << block
end

.unregister(symbol) ⇒ Object

This method is opposite of register method.

Usage:

Mime::Type.unregister(:mobile)



221
222
223
224
225
226
227
228
229
 
# File 'lib/action_dispatch/http/mime_type.rb', line 221

def unregister(symbol)
  symbol = symbol.upcase
  mime = Mime.const_get(symbol)
  Mime.instance_eval { remove_const(symbol) }

  SET.delete_if { |v| v.eql?(mime) }
  LOOKUP.delete_if { |_,v| v.eql?(mime) }
  EXTENSION_LOOKUP.delete_if { |_,v| v.eql?(mime) }
end

Instance Method Details

#==(mime_type) ⇒ Object 



261
262
263
264
265
266
 
# File 'lib/action_dispatch/http/mime_type.rb', line 261

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 



253
254
255
256
257
258
259
 
# File 'lib/action_dispatch/http/mime_type.rb', line 253

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

#=~(mime_type) ⇒ Object 



268
269
270
271
272
273
274
 
# File 'lib/action_dispatch/http/mime_type.rb', line 268

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) 


288
289
290
 
# File 'lib/action_dispatch/http/mime_type.rb', line 288

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

#ref ⇒ Object 



249
250
251
 
# File 'lib/action_dispatch/http/mime_type.rb', line 249

def ref
  to_sym || to_s
end

#to_s ⇒ Object 



237
238
239
 
# File 'lib/action_dispatch/http/mime_type.rb', line 237

def to_s
  @string
end

#to_str ⇒ Object 



241
242
243
 
# File 'lib/action_dispatch/http/mime_type.rb', line 241

def to_str
  to_s
end

#to_sym ⇒ Object 



245
246
247
 
# File 'lib/action_dispatch/http/mime_type.rb', line 245

def to_sym
  @symbol
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) 


278
279
280
281
 
# File 'lib/action_dispatch/http/mime_type.rb', line 278

def verify_request?
  ActiveSupport::Deprecation.warn "Mime::Type#verify_request? is deprecated and will be removed in Rails 4.1"
  @@browser_generated_types.include?(to_sym)
end