/usr/lib/ruby/vendor_ruby/action_dispatch/http/response.rb is in ruby-actionpack 2:4.2.10-0ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | require 'active_support/core_ext/module/attribute_accessors'
require 'active_support/core_ext/string/filters'
require 'active_support/deprecation'
require 'action_dispatch/http/filter_redirect'
require 'monitor'
module ActionDispatch # :nodoc:
# Represents an HTTP response generated by a controller action. Use it to
# retrieve the current state of the response, or customize the response. It can
# either represent a real HTTP response (i.e. one that is meant to be sent
# back to the web browser) or a TestResponse (i.e. one that is generated
# from integration tests).
#
# \Response is mostly a Ruby on \Rails framework implementation detail, and
# should never be used directly in controllers. Controllers should use the
# methods defined in ActionController::Base instead. For example, if you want
# to set the HTTP response's content MIME type, then use
# ActionControllerBase#headers instead of Response#headers.
#
# Nevertheless, integration tests may want to inspect controller responses in
# more detail, and that's when \Response can be useful for application
# developers. Integration test methods such as
# ActionDispatch::Integration::Session#get and
# ActionDispatch::Integration::Session#post return objects of type
# TestResponse (which are of course also of type \Response).
#
# For example, the following demo integration test prints the body of the
# controller response to the console:
#
# class DemoControllerTest < ActionDispatch::IntegrationTest
# def test_print_root_path_to_console
# get('/')
# puts response.body
# end
# end
class Response
# The request that the response is responding to.
attr_accessor :request
# The HTTP status code.
attr_reader :status
attr_writer :sending_file
# Get and set headers for this response.
attr_accessor :header
alias_method :headers=, :header=
alias_method :headers, :header
delegate :[], :[]=, :to => :@header
delegate :each, :to => :@stream
# Sets the HTTP response's content MIME type. For example, in the controller
# you could write this:
#
# response.content_type = "text/plain"
#
# If a character set has been defined for this response (see charset=) then
# the character set information will also be included in the content type
# information.
attr_reader :content_type
# The charset of the response. HTML wants to know the encoding of the
# content you're giving them, so we need to send that along.
attr_accessor :charset
CONTENT_TYPE = "Content-Type".freeze
SET_COOKIE = "Set-Cookie".freeze
LOCATION = "Location".freeze
NO_CONTENT_CODES = [204, 304]
cattr_accessor(:default_charset) { "utf-8" }
cattr_accessor(:default_headers)
include Rack::Response::Helpers
include ActionDispatch::Http::FilterRedirect
include ActionDispatch::Http::Cache::Response
include MonitorMixin
class Buffer # :nodoc:
def initialize(response, buf)
@response = response
@buf = buf
@closed = false
end
def write(string)
raise IOError, "closed stream" if closed?
@response.commit!
@buf.push string
end
def each(&block)
@response.sending!
x = @buf.each(&block)
@response.sent!
x
end
def abort
end
def close
@response.commit!
@closed = true
end
def closed?
@closed
end
end
# The underlying body, as a streamable object.
attr_reader :stream
def initialize(status = 200, header = {}, body = [], options = {})
super()
default_headers = options.fetch(:default_headers, self.class.default_headers)
header = merge_default_headers(header, default_headers)
self.body, self.header, self.status = body, header, status
@sending_file = false
@blank = false
@cv = new_cond
@committed = false
@sending = false
@sent = false
@content_type = nil
@charset = nil
if content_type = self[CONTENT_TYPE]
type, charset = content_type.split(/;\s*charset=/)
@content_type = Mime::Type.lookup(type)
@charset = charset || self.class.default_charset
end
prepare_cache_control!
yield self if block_given?
end
def await_commit
synchronize do
@cv.wait_until { @committed }
end
end
def await_sent
synchronize { @cv.wait_until { @sent } }
end
def commit!
synchronize do
before_committed
@committed = true
@cv.broadcast
end
end
def sending!
synchronize do
before_sending
@sending = true
@cv.broadcast
end
end
def sent!
synchronize do
@sent = true
@cv.broadcast
end
end
def sending?; synchronize { @sending }; end
def committed?; synchronize { @committed }; end
def sent?; synchronize { @sent }; end
# Sets the HTTP status code.
def status=(status)
@status = Rack::Utils.status_code(status)
end
# Sets the HTTP content type.
def content_type=(content_type)
@content_type = content_type.to_s
end
# The response code of the request.
def response_code
@status
end
# Returns a string to ensure compatibility with <tt>Net::HTTPResponse</tt>.
def code
@status.to_s
end
# Returns the corresponding message for the current HTTP status code:
#
# response.status = 200
# response.message # => "OK"
#
# response.status = 404
# response.message # => "Not Found"
#
def message
Rack::Utils::HTTP_STATUS_CODES[@status]
end
alias_method :status_message, :message
# Returns the content of the response as a string. This contains the contents
# of any calls to <tt>render</tt>.
def body
strings = []
each { |part| strings << part.to_s }
strings.join
end
EMPTY = " "
# Allows you to manually set or override the response body.
def body=(body)
@blank = true if body == EMPTY
if body.respond_to?(:to_path)
@stream = body
else
synchronize do
@stream = build_buffer self, munge_body_object(body)
end
end
end
def body_parts
parts = []
@stream.each { |x| parts << x }
parts
end
def set_cookie(key, value)
::Rack::Utils.set_cookie_header!(header, key, value)
end
def delete_cookie(key, value={})
::Rack::Utils.delete_cookie_header!(header, key, value)
end
# The location header we'll be responding with.
def location
headers[LOCATION]
end
alias_method :redirect_url, :location
# Sets the location header we'll be responding with.
def location=(url)
headers[LOCATION] = url
end
def close
stream.close if stream.respond_to?(:close)
end
def abort
if stream.respond_to?(:abort)
stream.abort
elsif stream.respond_to?(:close)
# `stream.close` should really be reserved for a close from the
# other direction, but we must fall back to it for
# compatibility.
stream.close
end
end
# Turns the Response into a Rack-compatible array of the status, headers,
# and body. Allows explict splatting:
#
# status, headers, body = *response
def to_a
rack_response @status, @header.to_hash
end
alias prepare! to_a
# Be super clear that a response object is not an Array. Defining this
# would make implicit splatting work, but it also makes adding responses
# as arrays work, and "flattening" responses, cascading to the rack body!
# Not sensible behavior.
def to_ary
ActiveSupport::Deprecation.warn(<<-MSG.squish)
`ActionDispatch::Response#to_ary` no longer performs implicit conversion
to an array. Please use `response.to_a` instead, or a splat like `status,
headers, body = *response`.
MSG
to_a
end
# Returns the response cookies, converted to a Hash of (name => value) pairs
#
# assert_equal 'AuthorOfNewPage', r.cookies['author']
def cookies
cookies = {}
if header = self[SET_COOKIE]
header = header.split("\n") if header.respond_to?(:to_str)
header.each do |cookie|
if pair = cookie.split(';').first
key, value = pair.split("=").map { |v| Rack::Utils.unescape(v) }
cookies[key] = value
end
end
end
cookies
end
private
def before_committed
end
def before_sending
end
def merge_default_headers(original, default)
default.respond_to?(:merge) ? default.merge(original) : original
end
def build_buffer(response, body)
Buffer.new response, body
end
def munge_body_object(body)
body.respond_to?(:each) ? body : [body]
end
def assign_default_content_type_and_charset!(headers)
return if headers[CONTENT_TYPE].present?
@content_type ||= Mime::HTML
@charset ||= self.class.default_charset unless @charset == false
type = @content_type.to_s.dup
type << "; charset=#{@charset}" if append_charset?
headers[CONTENT_TYPE] = type
end
def append_charset?
!@sending_file && @charset != false
end
class RackBody
def initialize(response)
@response = response
end
def each(*args, &block)
@response.each(*args, &block)
end
def close
# Rack "close" maps to Response#abort, and *not* Response#close
# (which is used when the controller's finished writing)
@response.abort
end
def body
@response.body
end
def respond_to?(method, include_private = false)
if method.to_s == 'to_path'
@response.stream.respond_to?(method)
else
super
end
end
def to_path
@response.stream.to_path
end
def to_ary
nil
end
end
def rack_response(status, header)
assign_default_content_type_and_charset!(header)
handle_conditional_get!
header[SET_COOKIE] = header[SET_COOKIE].join("\n") if header[SET_COOKIE].respond_to?(:join)
if NO_CONTENT_CODES.include?(@status)
header.delete CONTENT_TYPE
[status, header, []]
else
[status, header, RackBody.new(self)]
end
end
end
end
|