Class: Mime::Type
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]
- @@unverifiable_types =
Set.new [:text, :json, :csv, :xml, :rss, :atom, :yaml]
Class Method Summary collapse
- .lookup(string) ⇒ Object
- .lookup_by_extension(extension) ⇒ Object
- .parse(accept_header) ⇒ Object
- .register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false) ⇒ Object
-
.register_alias(string, symbol, extension_synonyms = []) ⇒ Object
Registers an alias that’s not used on mime type lookup, but can be referenced directly.
- .unverifiable_types ⇒ Object
Instance Method Summary collapse
- #==(mime_type) ⇒ Object
- #===(list) ⇒ Object
- #=~(mime_type) ⇒ Object
- #browser_generated? ⇒ Boolean
- #html? ⇒ Boolean
-
#initialize(string, symbol = nil, synonyms = []) ⇒ Type
constructor
A new instance of Type.
- #to_s ⇒ Object
- #to_str ⇒ Object
- #to_sym ⇒ Object
-
#verify_request? ⇒ Boolean
Returns true if Action Pack should check requests using this Mime Type for possible request forgery.
Constructor Details
permalink #initialize(string, symbol = nil, synonyms = []) ⇒ Type
Returns a new instance of Type.
147 148 149 150 |
# File 'lib/action_controller/mime_type.rb', line 147 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
permalink #method_missing(method, *args) ⇒ Object (private)
[View source]
202 203 204 205 206 207 208 |
# File 'lib/action_controller/mime_type.rb', line 202 def method_missing(method, *args) if method.to_s =~ /(\w+)\?$/ $1.downcase.to_sym == to_sym else super end end |
Class Method Details
permalink .lookup(string) ⇒ Object
[View source]
65 66 67 |
# File 'lib/action_controller/mime_type.rb', line 65 def lookup(string) LOOKUP[string] end |
permalink .lookup_by_extension(extension) ⇒ Object
[View source]
69 70 71 |
# File 'lib/action_controller/mime_type.rb', line 69 def lookup_by_extension(extension) EXTENSION_LOOKUP[extension] end |
permalink .parse(accept_header) ⇒ Object
[View source]
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 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 |
# File 'lib/action_controller/mime_type.rb', line 88 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 |
permalink .register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false) ⇒ Object
[View source]
79 80 81 82 83 84 85 86 |
# File 'lib/action_controller/mime_type.rb', line 79 def register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false) Mime.instance_eval { 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 { |string| LOOKUP[string] = SET.last } unless skip_lookup ([symbol.to_s] + extension_synonyms).each { |ext| EXTENSION_LOOKUP[ext] = SET.last } end |
permalink .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.
75 76 77 |
# File 'lib/action_controller/mime_type.rb', line 75 def register_alias(string, symbol, extension_synonyms = []) register(string, symbol, [], extension_synonyms, true) end |
permalink .unverifiable_types ⇒ Object
[View source]
33 34 35 36 |
# File 'lib/action_controller/mime_type.rb', line 33 def self.unverifiable_types ActiveSupport::Deprecation.warn("unverifiable_types is deprecated and has no effect", caller) @@unverifiable_types end |
Instance Method Details
permalink #==(mime_type) ⇒ Object
[View source]
172 173 174 175 176 177 |
# File 'lib/action_controller/mime_type.rb', line 172 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 |
permalink #===(list) ⇒ Object
[View source]
164 165 166 167 168 169 170 |
# File 'lib/action_controller/mime_type.rb', line 164 def ===(list) if list.is_a?(Array) (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) } else super end end |
permalink #=~(mime_type) ⇒ Object
[View source]
179 180 181 182 183 184 185 |
# File 'lib/action_controller/mime_type.rb', line 179 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 |
permalink #browser_generated? ⇒ Boolean
197 198 199 |
# File 'lib/action_controller/mime_type.rb', line 197 def browser_generated? @@browser_generated_types.include?(to_sym) end |
permalink #html? ⇒ Boolean
193 194 195 |
# File 'lib/action_controller/mime_type.rb', line 193 def html? @@html_types.include?(to_sym) || @string =~ /html/ end |
permalink #to_s ⇒ Object
[View source]
152 153 154 |
# File 'lib/action_controller/mime_type.rb', line 152 def to_s @string end |
permalink #to_str ⇒ Object
[View source]
156 157 158 |
# File 'lib/action_controller/mime_type.rb', line 156 def to_str to_s end |
permalink #to_sym ⇒ Object
[View source]
160 161 162 |
# File 'lib/action_controller/mime_type.rb', line 160 def to_sym @symbol || @string.to_sym end |
permalink #verify_request? ⇒ Boolean
Returns true if Action Pack should check requests using this Mime Type for possible request forgery. See ActionController::RequestForgeryProtection.
189 190 191 |
# File 'lib/action_controller/mime_type.rb', line 189 def verify_request? browser_generated? end |