Class: WEBrick::HTTPResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/webrick/httpresponse.rb

Overview

An HTTP response. This is filled in by the service or do_* methods of a WEBrick HTTP Servlet.

Defined Under Namespace

Classes: ChunkedWrapper, InvalidHeader

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ HTTPResponse

Creates a new HTTP response object. WEBrick::Config::HTTP is the default configuration.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/webrick/httpresponse.rb', line 117

def initialize(config)
  @config = config
  @buffer_size = config[:OutputBufferSize]
  @logger = config[:Logger]
  @header = Hash.new
  @status = HTTPStatus::RC_OK
  @reason_phrase = nil
  @http_version = HTTPVersion::convert(@config[:HTTPVersion])
  @body = +""
  @keep_alive = true
  @cookies = []
  @request_method = nil
  @request_uri = nil
  @request_http_version = @http_version  # temporary
  @chunked = false
  @filename = nil
  @sent_size = 0
  @bodytempfile = nil
end

Instance Attribute Details

#body ⇒ Object

Body may be:

  • a String;

  • an IO-like object that responds to #read and #readpartial;

  • a Proc-like object that responds to #call.

In the latter case, either #chunked= should be set to true, or header['content-length'] explicitly provided. Example:

server.mount_proc '/' do |req, res|
  res.chunked = true
  # or
  # res.header['content-length'] = 10
  res.body = proc { |out| out.write(Time.now.to_s) }
end



70
71
72
 
# File 'lib/webrick/httpresponse.rb', line 70

def body
  @body
end

#config ⇒ Object (readonly)

Configuration for this response



101
102
103
 
# File 'lib/webrick/httpresponse.rb', line 101

def config
  @config
end

#cookies ⇒ Object (readonly)

Response cookies



46
47
48
 
# File 'lib/webrick/httpresponse.rb', line 46

def cookies
  @cookies
end

#filename ⇒ Object

Filename of the static file in this response. Only used by the FileHandler servlet.



91
92
93
 
# File 'lib/webrick/httpresponse.rb', line 91

def filename
  @filename
end

#header ⇒ Object (readonly)

Response header



41
42
43
 
# File 'lib/webrick/httpresponse.rb', line 41

def header
  @header
end

#http_version ⇒ Object (readonly)

HTTP Response version



31
32
33
 
# File 'lib/webrick/httpresponse.rb', line 31

def http_version
  @http_version
end

#keep_alive ⇒ Object

Is this a keep-alive response?



96
97
98
 
# File 'lib/webrick/httpresponse.rb', line 96

def keep_alive
  @keep_alive
end

#reason_phrase ⇒ Object

Response reason phrase (“OK”)



51
52
53
 
# File 'lib/webrick/httpresponse.rb', line 51

def reason_phrase
  @reason_phrase
end

#request_http_version ⇒ Object

Request HTTP version for this response



85
86
87
 
# File 'lib/webrick/httpresponse.rb', line 85

def request_http_version
  @request_http_version
end

#request_method ⇒ Object

Request method for this response



75
76
77
 
# File 'lib/webrick/httpresponse.rb', line 75

def request_method
  @request_method
end

#request_uri ⇒ Object

Request URI for this response



80
81
82
 
# File 'lib/webrick/httpresponse.rb', line 80

def request_uri
  @request_uri
end

#sent_size ⇒ Object (readonly)

Bytes sent in this response



106
107
108
 
# File 'lib/webrick/httpresponse.rb', line 106

def sent_size
  @sent_size
end

#status ⇒ Object

Response status code (200)



36
37
38
 
# File 'lib/webrick/httpresponse.rb', line 36

def status
  @status
end

#upgrade ⇒ Object

Set the response body proc as an streaming/upgrade response.



111
112
113
 
# File 'lib/webrick/httpresponse.rb', line 111

def upgrade
  @upgrade
end

Instance Method Details

#[](field) ⇒ Object

Retrieves the response header field



155
156
157
 
# File 'lib/webrick/httpresponse.rb', line 155

def [](field)
  @header[field.downcase]
end

#[]=(field, value) ⇒ Object

Sets the response header field to value



162
163
164
165
 
# File 'lib/webrick/httpresponse.rb', line 162

def []=(field, value)
  @chunked = value.to_s.downcase == 'chunked' if field.downcase == 'transfer-encoding'
  @header[field.downcase] = value.to_s
end

#chunked=(val) ⇒ Object

Enables chunked transfer encoding.



214
215
216
 
# File 'lib/webrick/httpresponse.rb', line 214

def chunked=(val)
  @chunked = val ? true : false
end

#chunked? ⇒ Boolean

Will this response body be returned using chunked transfer-encoding?

Returns:

  • (Boolean) 


207
208
209
 
# File 'lib/webrick/httpresponse.rb', line 207

def chunked?
  @chunked
end

#content_length ⇒ Object

The content-length header



170
171
172
173
174
 
# File 'lib/webrick/httpresponse.rb', line 170

def content_length
  if len = self['content-length']
    return Integer(len)
  end
end

#content_length=(len) ⇒ Object

Sets the content-length header to len



179
180
181
 
# File 'lib/webrick/httpresponse.rb', line 179

def content_length=(len)
  self['content-length'] = len.to_s
end

#content_type ⇒ Object

The content-type header



186
187
188
 
# File 'lib/webrick/httpresponse.rb', line 186

def content_type
  self['content-type']
end

#content_type=(type) ⇒ Object

Sets the content-type header to type



193
194
195
 
# File 'lib/webrick/httpresponse.rb', line 193

def content_type=(type)
  self['content-type'] = type
end

#each ⇒ Object

Iterates over each header in the response



200
201
202
 
# File 'lib/webrick/httpresponse.rb', line 200

def each
  @header.each{|field, value|  yield(field, value) }
end

#keep_alive? ⇒ Boolean

Will this response’s connection be kept alive?

Returns:

  • (Boolean) 


221
222
223
 
# File 'lib/webrick/httpresponse.rb', line 221

def keep_alive?
  @keep_alive
end

#make_body_tempfile ⇒ Object

:nodoc:



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/webrick/httpresponse.rb', line 325

def make_body_tempfile # :nodoc:
  return if @bodytempfile
  bodytempfile = Tempfile.create("webrick")
  if @body.nil?
    # nothing
  elsif @body.respond_to? :readpartial
    IO.copy_stream(@body, bodytempfile)
    @body.close
  elsif @body.respond_to? :call
    @body.call(bodytempfile)
  else
    bodytempfile.write @body
  end
  bodytempfile.rewind
  @body = @bodytempfile = bodytempfile
  @header['content-length'] = bodytempfile.stat.size.to_s
end

#remove_body_tempfile ⇒ Object

:nodoc:



343
344
345
346
347
348
349
 
# File 'lib/webrick/httpresponse.rb', line 343

def remove_body_tempfile # :nodoc:
  if @bodytempfile
    @bodytempfile.close
    File.unlink @bodytempfile.path
    @bodytempfile = nil
  end
end

#send_body(socket) ⇒ Object

Sends the body on socket



378
379
380
381
382
383
384
385
386
 
# File 'lib/webrick/httpresponse.rb', line 378

def send_body(socket) # :nodoc:
  if @body.respond_to? :readpartial then
    send_body_io(socket)
  elsif @body.respond_to?(:call) then
    send_body_proc(socket)
  else
    send_body_string(socket)
  end
end

#send_header(socket) ⇒ Object

Sends the headers on socket



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/webrick/httpresponse.rb', line 355

def send_header(socket) # :nodoc:
  if @http_version.major > 0
    data = status_line().dup
    @header.each{|key, value|
      tmp = key.gsub(/\bwww|^te$|\b\w/){ $&.upcase }
      data << "#{tmp}: #{check_header(value)}" << CRLF
    }
    @cookies.each{|cookie|
      data << "Set-Cookie: " << check_header(cookie.to_s) << CRLF
    }
    data << CRLF
    socket.write(data)
  end
rescue InvalidHeader => e
  @header.clear
  @cookies.clear
  set_error e
  retry
end

#send_response(socket) ⇒ Object

Sends the response on socket



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/webrick/httpresponse.rb', line 238

def send_response(socket) # :nodoc:
  begin
    setup_header()
    send_header(socket)
    send_body(socket)
  rescue Errno::EPIPE, Errno::ECONNRESET, Errno::ENOTCONN => ex
    @logger.debug(ex)
    @keep_alive = false
  rescue Exception => ex
    @logger.error(ex)
    @keep_alive = false
  end
end

#set_error(ex, backtrace = false) ⇒ Object

Creates an error page for exception ex with an optional backtrace



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/webrick/httpresponse.rb', line 405

def set_error(ex, backtrace=false)
  case ex
  when HTTPStatus::Status
    @keep_alive = false if HTTPStatus::error?(ex.code)
    self.status = ex.code
  else
    @keep_alive = false
    self.status = HTTPStatus::RC_INTERNAL_SERVER_ERROR
  end
  @header['content-type'] = "text/html; charset=ISO-8859-1"

  if respond_to?(:create_error_page)
    create_error_page()
    return
  end

  if @request_uri
    host, port = @request_uri.host, @request_uri.port
  else
    host, port = @config[:ServerName], @config[:Port]
  end

  error_body(backtrace, ex, host, port)
end

#set_redirect(status, url) ⇒ Object

Redirects to url with a WEBrick::HTTPStatus::Redirect status.

Example:

res.set_redirect WEBrick::HTTPStatus::TemporaryRedirect



395
396
397
398
399
400
 
# File 'lib/webrick/httpresponse.rb', line 395

def set_redirect(status, url)
  url = URI(url).to_s
  @body = "<HTML><A HREF=\"#{url}\">#{url}</A>.</HTML>\n"
  @header['location'] = url
  raise status
end

#setup_header ⇒ Object

Sets up the headers for sending



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
 
# File 'lib/webrick/httpresponse.rb', line 255

def setup_header() # :nodoc:
  @reason_phrase    ||= HTTPStatus::reason_phrase(@status)
  @header['server'] ||= @config[:ServerSoftware]
  @header['date']   ||= Time.now.httpdate

  if @upgrade
    @header['connection'] = 'upgrade'
    @header['upgrade'] = @upgrade
    @keep_alive = false

    return
  end

  # HTTP/0.9 features
  if @request_http_version < "1.0"
    @http_version = HTTPVersion.new("0.9")
    @keep_alive = false
  end

  # HTTP/1.0 features
  if @request_http_version < "1.1"
    if chunked?
      @chunked = false
      ver = @request_http_version.to_s
      msg = "chunked is set for an HTTP/#{ver} request. (ignored)"
      @logger.warn(msg)
    end
  end

  # Determine the message length (RFC2616 -- 4.4 Message Length)
  if @status == 304 || @status == 204 || HTTPStatus::info?(@status)
    @header.delete('content-length')
    @body = ""
  elsif chunked?
    @header["transfer-encoding"] = "chunked"
    @header.delete('content-length')
  elsif %r{^multipart/byteranges} =~ @header['content-type']
    @header.delete('content-length')
  elsif @header['content-length'].nil?
    if @body.respond_to?(:bytesize)
      @header['content-length'] = @body.bytesize.to_s
    else
      @header['connection'] = 'close'
    end
  end

  # Keep-Alive connection.
  if @header['connection'] == "close"
     @keep_alive = false
  elsif keep_alive?
    if chunked? || @header['content-length'] || @status == 304 || @status == 204 || HTTPStatus.info?(@status)
      @header['connection'] = "Keep-Alive"
    else
      msg = "Could not determine content-length of response body. Set content-length of the response or set Response#chunked = true"
      @logger.warn(msg)
      @header['connection'] = "close"
      @keep_alive = false
    end
  else
    @header['connection'] = "close"
  end

  # Location is a single absoluteURI.
  if location = @header['location']
    if @request_uri
      @header['location'] = @request_uri.merge(location).to_s
    end
  end
end

#status_line ⇒ Object

The response’s HTTP status line



140
141
142
 
# File 'lib/webrick/httpresponse.rb', line 140

def status_line
  "HTTP/#@http_version #@status #@reason_phrase".rstrip << CRLF
end

#upgrade!(protocol) ⇒ Object

Sets the response to be a streaming/upgrade response. This will disable keep-alive and chunked transfer encoding.



229
230
231
232
233
 
# File 'lib/webrick/httpresponse.rb', line 229

def upgrade!(protocol)
  @upgrade = protocol
  @keep_alive = false
  @chunked = false
end