3 module ActionController
# :nodoc:
4 # Represents an HTTP response generated by a controller action. One can use
5 # an ActionController::Response object to retrieve the current state
6 # of the response, or customize the response. An Response object can
7 # either represent a "real" HTTP response (i.e. one that is meant to be sent
8 # back to the web browser) or a test response (i.e. one that is generated
9 # from integration tests). See CgiResponse and TestResponse, respectively.
11 # Response is mostly a Ruby on Rails framework implement detail, and
12 # should never be used directly in controllers. Controllers should use the
13 # methods defined in ActionController::Base instead. For example, if you want
14 # to set the HTTP response's content MIME type, then use
15 # ActionControllerBase#headers instead of Response#headers.
17 # Nevertheless, integration tests may want to inspect controller responses in
18 # more detail, and that's when Response can be useful for application
19 # developers. Integration test methods such as
20 # ActionController::Integration::Session#get and
21 # ActionController::Integration::Session#post return objects of type
22 # TestResponse (which are of course also of type Response).
24 # For example, the following demo integration "test" prints the body of the
25 # controller response to the console:
27 # class DemoControllerTest < ActionController::IntegrationTest
28 # def test_print_root_path_to_console
33 class Response
< Rack
::Response
34 DEFAULT_HEADERS
= { "Cache-Control" => "no-cache" }
35 attr_accessor
:request
37 attr_accessor
:session, :assigns, :template, :layout
38 attr_accessor
:redirected_to, :redirected_to_method_params
40 delegate
:default_charset, :to => 'ActionController::Base'
44 @header = Rack
::Utils::HeaderHash.new(DEFAULT_HEADERS
)
46 @writer = lambda
{ |x
| @body << x
}
50 @session, @assigns = [], []
53 def location
; headers
['Location'] end
54 def location
=(url
) headers
['Location'] = url
end
57 # Sets the HTTP response's content MIME type. For example, in the controller
58 # you could write this:
60 # response.content_type = "text/plain"
62 # If a character set has been defined for this response (see charset=) then
63 # the character set information will also be included in the content type
65 def content_type
=(mime_type
)
66 self.headers
["Content-Type"] =
67 if mime_type
=~
/charset/ || (c
= charset
).nil?
70 "#{mime_type}; charset=#{c}"
74 # Returns the response's content MIME type, or nil if content type has been set.
76 content_type
= String(headers
["Content-Type"] || headers
["type"]).split(";")[0]
77 content_type
.blank
? ? nil : content_type
80 # Set the charset of the Content-Type header. Set to nil to remove it.
81 # If no content type is set, it defaults to HTML.
83 headers
["Content-Type"] =
85 "#{content_type || Mime::HTML}; charset=#{charset}"
87 content_type
|| Mime
::HTML.to_s
92 charset
= String(headers
["Content-Type"] || headers
["type"]).split(";")[1]
93 charset
.blank
? ? nil : charset
.strip
.split("=")[1]
97 if last
= headers
['Last-Modified']
103 headers
.include?('Last-Modified')
106 def last_modified
=(utc_time
)
107 headers
['Last-Modified'] = utc_time
.httpdate
115 headers
.include?('ETag')
120 headers
.delete('ETag')
122 headers
['ETag'] = %("#{Digest::MD5.hexdigest(ActiveSupport::Cache.expand_cache_key(etag))}")
126 def redirect(url
, status
)
128 self.location
= url
.gsub(/[\r\n]/, '')
129 self.body
= "<html><body>You are being <a href=\"#{CGI.escapeHTML(url)}\">redirected</a>.</body></html>"
133 headers
["Content-Transfer-Encoding"] == "binary"
136 def assign_default_content_type_and_charset!
137 self.content_type
||= Mime
::HTML
138 self.charset
||= default_charset
unless sending_file
?
142 assign_default_content_type_and_charset!
143 handle_conditional_get!
145 convert_content_type!
151 if @body.respond_to
?(:call)
152 @writer = lambda
{ |x
| callback
.call(x
) }
153 @body.call(self, self)
154 elsif @body.is_a
?(String
)
155 @body.each_line(&callback
)
157 @body.each(&callback
)
161 @block.call(self) if @block
165 @writer.call str
.to_s
169 def set_cookie(key
, value
)
170 if value
.has_key
?(:http_only)
171 ActiveSupport
::Deprecation.warn(
172 "The :http_only option in ActionController::Response#set_cookie " +
173 "has been renamed. Please use :httponly instead.", caller
)
174 value
[:httponly] ||= value
.delete(:http_only)
181 def handle_conditional_get!
182 if etag
? || last_modified
?
183 set_conditional_cache_control!
184 elsif nonempty_ok_response
?
187 if request
&& request
.etag_matches
?(etag
)
188 self.status
= '304 Not Modified'
192 set_conditional_cache_control!
196 def nonempty_ok_response
?
197 ok
= !status
|| status
.to_s
[0..2] == '200'
198 ok
&& body
.is_a
?(String
) && !body
.empty
?
201 def set_conditional_cache_control!
202 if headers
['Cache-Control'] == DEFAULT_HEADERS
['Cache-Control']
203 headers
['Cache-Control'] = 'private, max-age=0, must-revalidate'
207 def convert_content_type!
208 headers
['Content-Type'] ||= "text/html"
209 headers
['Content-Type'] +
= "; charset=" + headers
.delete('charset') if headers
['charset']
212 # Don't set the Content-Length for block-based bodies as that would mean
213 # reading it all into memory. Not nice for, say, a 2GB streaming file.
214 def set_content_length!
215 if status
&& status
.to_s
[0..2] == '204'
216 headers
.delete('Content-Length')
217 elsif length
= headers
['Content-Length']
218 headers
['Content-Length'] = length
.to_s
219 elsif !body
.respond_to
?(:call) && (!status
|| status
.to_s
[0..2] !
= '304')
220 headers
["Content-Length"] = (body
.respond_to
?(:bytesize) ? body
.bytesize
: body
.size
).to_s
224 def convert_language!
225 headers
["Content-Language"] = headers
.delete("language") if headers
["language"]
229 headers
['Set-Cookie'] = Array(headers
['Set-Cookie']).compact