Class: WEBrick::HTTPResponse

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

Constant Summary collapse

BUFSIZE = 
1024*4

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ HTTPResponse

Returns a new instance of HTTPResponse.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/webrick/httpresponse.rb', line 31

def initialize(config)
  @config = config
  @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
end

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body



24
25
26
 
# File 'lib/webrick/httpresponse.rb', line 24

def body
  @body
end

#config ⇒ Object (readonly)

Returns the value of attribute config



29
30
31
 
# File 'lib/webrick/httpresponse.rb', line 29

def config
  @config
end

#cookies ⇒ Object (readonly)

Returns the value of attribute cookies



22
23
24
 
# File 'lib/webrick/httpresponse.rb', line 22

def cookies
  @cookies
end

#filename ⇒ Object

Returns the value of attribute filename



27
28
29
 
# File 'lib/webrick/httpresponse.rb', line 27

def filename
  @filename
end

#header ⇒ Object (readonly)

Returns the value of attribute header



21
22
23
 
# File 'lib/webrick/httpresponse.rb', line 21

def header
  @header
end

#http_version ⇒ Object (readonly)

Returns the value of attribute http_version



21
22
23
 
# File 'lib/webrick/httpresponse.rb', line 21

def http_version
  @http_version
end

#keep_alive ⇒ Object

Returns the value of attribute keep_alive



28
29
30
 
# File 'lib/webrick/httpresponse.rb', line 28

def keep_alive
  @keep_alive
end

#reason_phrase ⇒ Object

Returns the value of attribute reason_phrase



23
24
25
 
# File 'lib/webrick/httpresponse.rb', line 23

def reason_phrase
  @reason_phrase
end

#request_http_version ⇒ Object

Returns the value of attribute request_http_version



26
27
28
 
# File 'lib/webrick/httpresponse.rb', line 26

def request_http_version
  @request_http_version
end

#request_method ⇒ Object

Returns the value of attribute request_method



26
27
28
 
# File 'lib/webrick/httpresponse.rb', line 26

def request_method
  @request_method
end

#request_uri ⇒ Object

Returns the value of attribute request_uri



26
27
28
 
# File 'lib/webrick/httpresponse.rb', line 26

def request_uri
  @request_uri
end

#sent_size ⇒ Object (readonly)

Returns the value of attribute sent_size



29
30
31
 
# File 'lib/webrick/httpresponse.rb', line 29

def sent_size
  @sent_size
end

#status ⇒ Object

Returns the value of attribute status



21
22
23
 
# File 'lib/webrick/httpresponse.rb', line 21

def status
  @status
end

Instance Method Details

#[](field) ⇒ Object 



58
59
60
 
# File 'lib/webrick/httpresponse.rb', line 58

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

#[]=(field, value) ⇒ Object 



62
63
64
 
# File 'lib/webrick/httpresponse.rb', line 62

def []=(field, value)
  @header[field.downcase] = value.to_s
end

#chunked=(val) ⇒ Object 



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

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

#chunked? ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/webrick/httpresponse.rb', line 88

def chunked?
  @chunked
end

#content_length ⇒ Object 



66
67
68
69
70
 
# File 'lib/webrick/httpresponse.rb', line 66

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

#content_length=(len) ⇒ Object 



72
73
74
 
# File 'lib/webrick/httpresponse.rb', line 72

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

#content_type ⇒ Object 



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

def content_type
  self['content-type']
end

#content_type=(type) ⇒ Object 



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

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

#each ⇒ Object 



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

def each
  @header.each{|k, v|  yield(k, v) }
end

#keep_alive? ⇒ Boolean

Returns:

  • (Boolean) 


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

def keep_alive?
  @keep_alive
end

#send_body(socket) ⇒ Object 



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

def send_body(socket)
  case @body
  when IO then send_body_io(socket)
  else send_body_string(socket)
  end
end

#send_header(socket) ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/webrick/httpresponse.rb', line 169

def send_header(socket)
  if @http_version.major > 0
    data = status_line()
    @header.each{|key, value|
      tmp = key.gsub(/\bwww|^te$|\b\w/){|s| s.upcase }
      data << "#{tmp}: #{value}" << CRLF
    }
    @cookies.each{|cookie|
      data << "Set-Cookie: " << cookie.to_s << CRLF
    }
    data << CRLF
    _write_data(socket, data)
  end
end

#send_response(socket) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/webrick/httpresponse.rb', line 100

def send_response(socket)
  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 



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

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

  @body = ''
  @body << <<-_end_of_html_
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<HTML>
  <HEAD><TITLE>#{HTMLUtils::escape(@reason_phrase)}</TITLE></HEAD>
  <BODY>
<H1>#{HTMLUtils::escape(@reason_phrase)}</H1>
#{HTMLUtils::escape(ex.message)}
<HR>
  _end_of_html_

  if backtrace && $DEBUG
    @body << "backtrace of `#{HTMLUtils::escape(ex.class.to_s)}' "
    @body << "#{HTMLUtils::escape(ex.message)}"
    @body << "<PRE>"
    ex.backtrace.each{|line| @body << "\t#{line}\n"}
    @body << "</PRE><HR>"
  end

  @body << <<-_end_of_html_
<ADDRESS>
 #{HTMLUtils::escape(@config[:ServerSoftware])} at
 #{host}:#{port}
</ADDRESS>
  </BODY>
</HTML>
  _end_of_html_
end

#set_redirect(status, url) ⇒ Object 



197
198
199
200
201
 
# File 'lib/webrick/httpresponse.rb', line 197

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

#setup_header ⇒ Object 



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

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

  # 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?
    unless @body.is_a?(IO)
      @header['content-length'] = @body ? @body.size : 0
    end
  end

  # Keep-Alive connection.
  if @header['connection'] == "close"
     @keep_alive = false
  elsif keep_alive?
    if chunked? || @header['content-length']
      @header['connection'] = "Keep-Alive"
    end
  else
    @header['connection'] = "close"
  end

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

#status_line ⇒ Object 



49
50
51
 
# File 'lib/webrick/httpresponse.rb', line 49

def status_line
  "HTTP/#@http_version #@status #@reason_phrase #{CRLF}"
end

#to_s ⇒ Object 



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

def to_s
  ret = ""
  send_response(ret)
  ret
end