summaryrefslogtreecommitdiff
path: root/lib/net/http.rb
blob: bdbcb82fd552119cbfc2b036d8dca13d71844fa3 (plain)
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
=begin

= net/http.rb

maintained by Minero Aoki <aamine@dp.u-netsurf.ne.jp>
This file is derived from "http-access.rb".

This library is distributed under the terms of the Ruby license.
You can freely distribute/modify this library.

=end

require 'net/protocol'


module Net


class HTTPError < ProtocolError; end
class HTTPBadResponse < HTTPError; end


=begin

= class HTTP

== Class Methods

: new( address, port = 80 )
  create new HTTP object.

: port
  returns HTTP default port, 80

: command_type
  returns Command class, HTTPCommand


== Methods

: get( path, header = nil, dest = '' )
: get( path, header = nil ) {|str| .... }
  get data from "path" on connecting host.
  "header" must be a Hash like { 'Accept' => '*/*', ... }.
  Data is written to "dest" by using "<<" method.
  This method returns response header (Hash) and "dest".

  If called as iterator, give a part String of entity body.

: head( path, header = nil )
  get only header from "path" on connecting host.
  "header" is a Hash like { 'Accept' => '*/*', ... }.
  This method returns header as a Hash like

    { 'content-length' => 'Content-Length: 2554',
      'content-type'   => 'Content-Type: text/html',
      ... }

: post( path, data, header = nil, dest = '' )
: post( path, data, header = nil ) {|str| .... }
  post "data"(must be String now) to "path" (and get entity body).
  "header" must be a Hash like { 'Accept' => '*/*', ... }.
  Data is written to "dest" by using "<<" method.
  This method returns response header (Hash) and "dest".

  If called as iterator, give a part String of entity body.

  ATTENTION: entity body could be empty

: get2( path, header = nil )
  send GET request for "path".
  "header" must be a Hash like { 'Accept' => '*/*', ... }.
  This method returns response header (Hash).

: get_body( dest = '' )
: get_body {|str| .... }
  gets entity body of forwarded 'get2' or 'post2' methods.
  Data is written in "dest" by using "<<" method.
  This method returns "dest".

  If called as iterator, give a part String of entity body.

=end

  class HTTP < Protocol

    protocol_param :port,         '80'
    protocol_param :command_type, '::Net::HTTPCommand'


    def get( path, u_header = nil, dest = nil, &block )
      u_header ||= {}
      if block then
        dest = ReadAdapter.new( block )
        ret = nil
      else
        dest = ret =  ''
      end
      resp = nil
      connecting( u_header ) {
        @command.get edit_path(path), u_header
        resp = @command.get_response
        @command.try_get_body( resp, dest )
      }

      return resp['http-header'], ret
    end

    def get2( path, u_header = {} )
      only_header( :get, path, u_header )
    end

    def get_body( dest = '', &block )
      if block then
        dest = ReadAdapter.new( block )
      end
      @command.try_get_body @response, dest
      ensure_termination @u_header

      dest
    end

    def head( path, u_header = {} )
      ret = only_header( :head, path, u_header )['http-header']
      ensure_termination u_header
      ret
    end

    def post( path, data, u_header = nil, dest = nil, &block )
      u_header ||= {}
      if block then
        dest = ReadAdapter.new( block )
        ret = nil
      else
        dest = ret = ''
      end
      resp = nil
      connecting( u_header, true ) {
        @command.post path, u_header, data
        resp = @command.get_response
        @command.try_get_body( resp, dest )
      }

      return resp['http-header'], ret
    end

    def post2( path, data, u_header = {} )
      only_header :post, path, u_header, data
    end

    # not tested because I could not setup apache  (__;;;
    def put( path, src = nil, u_header = {}, &block )
      u_header ||= u_header
      connecting( u_header, true ) {
        @command.put path, u_header, src, dest
      }

      header
    end


    private


    def only_header( mid, path, u_header, data = nil )
      @u_header = u_header ?  procheader(u_header) : {}
      @response = nil
      ensure_connection @u_header
      if data then
        @command.send mid, edit_path(path), @u_header, data
      else
        @command.send mid, edit_path(path), @u_header
      end
      @response = @command.get_response
      @response['http-header']
    end


    # called when connecting
    def do_finish
      unless @socket.closed? then
        begin
          @command.head '/', { 'Connection' => 'Close' }
        rescue EOFError
        end
      end
    end

    def connecting( u_header, putp = false )
      u_header = procheader( u_header )
      ensure_connection u_header
      yield
      ensure_termination u_header
    end

    def ensure_connection( u_header )
      if not @socket then
        u_header['Connection'] = 'Close'
        start
      elsif @socket.closed? then
        @socket.reopen
      end
    end

    def ensure_termination( u_header )
      unless keep_alive? u_header then
        @socket.close
      end
      @u_header = @response = nil
    end

    def keep_alive?( header )
      if str = header['Connection'] then
        if /\A\s*keep-alive/i === str then
          return true
        end
      else
        if @command.http_version == '1.1' then
          return true
        end
      end

      false
    end

    def procheader( h )
      new = {}
      h.each do |k,v|
        arr = k.split('-')
        arr.each{|i| i.capitalize! }
        new[ arr.join('-') ] = v
      end
    end

    
    def edit_path( path )
      path
    end

    class << self
      def Proxy( p_addr, p_port )
        klass = super
        klass.module_eval %-
          def edit_path( path )
            'http://' + address +
              (@port == #{self.port} ? '' : ':' + @port.to_s) + path
          end
        -
        klass
      end
    end

  end

  HTTPSession = HTTP


  class HTTPSuccessCode < SuccessCode; end
  class HTTPCreatedCode < SuccessCode; end
  class HTTPAcceptedCode < SuccessCode; end
  class HTTPNoContentCode < SuccessCode; end
  class HTTPResetContentCode < SuccessCode; end
  class HTTPPartialContentCode < SuccessCode; end

  class HTTPMultipleChoiceCode < RetryCode; end
  class HTTPMovedPermanentlyCode < RetryCode; end
  class HTTPMovedTemporarilyCode < RetryCode; end
  class HTTPNotModifiedCode < RetryCode; end
  class HTTPUseProxyCode < RetryCode; end


  class HTTPCommand < Command

    HTTPVersion = '1.1'

    def initialize( sock )
      @http_version = HTTPVersion

      @in_header = {}
      @in_header[ 'Host' ]       = sock.addr
      @in_header[ 'Connection' ] = 'Keep-Alive'
      @in_header[ 'Accept' ]     = '*/*'

      super sock
    end


    attr_reader :http_version

      
    def get( path, u_header )
      request sprintf('GET %s HTTP/%s', path, HTTPVersion), u_header
    end
      
    def head( path, u_header )
      request sprintf('HEAD %s HTTP/%s', path, HTTPVersion), u_header
    end

    def post( path, u_header, data )
      request sprintf('POST %s HTTP/%s', path, HTTPVersion), u_header
      @socket.write data
    end

    def put( path, u_header, src )
      request sprintf('PUT %s HTTP/%s', path, HTTPVersion), u_header
      @socket.write_bin src
    end


    # def delete

    # def trace

    # def options


    def get_response
      rep = get_reply
      rep = get_reply while ContinueCode === rep
      header = {}
      while true do
        line = @socket.readline
        break if line.empty?
        nm = /\A[^:]+/.match( line )[0].strip.downcase
        header[nm] = line
      end

      rep['http-header'] = header
      reply_must rep, SuccessCode

      rep
    end

    def get_body( rep, dest )
      header = rep['http-header']
      if chunked? header then
        read_chunked( dest, header )
      else
        if clen = content_length( header ) then
          @socket.read clen, dest
        else
          ###
          ### "multipart/bytelenges" check should be done here ...
          ###
          @socket.read_all dest
        end
      end
    end

    def try_get_body( rep, dest )
      rep = get_reply while ContinueCode === rep
      return nil unless rep['body-exist']

      get_body rep, dest
    end


    private


    def request( req, u_header )
      @socket.writeline req
      if u_header then
        header = @in_header.dup.update( u_header )
      else
        header = @in_header
      end
      header.each do |n,v|
        @socket.writeline n + ': ' + v
      end
      @socket.writeline ''
    end


    def get_reply
      str = @socket.readline
      unless /\AHTTP\/(\d+\.\d+)?\s+(\d\d\d)\s*(.*)\z/i === str then
        raise HTTPBadResponse, "wrong status line format: #{str}"
      end
      @http_version = $1
      status  = $2
      discrip = $3
      
      be = false
      klass = case status[0]
              when ?1 then
                case status[2]
                when ?0 then ContinueCode
                when ?1 then HTTPSuccessCode
                else         UnknownCode
                end
              when ?2 then
                case status[2]
                when ?0 then be = true;  HTTPSuccessCode
                when ?1 then be = false; HTTPSuccessCode
                when ?2 then be = true;  HTTPSuccessCode
                when ?3 then be = true;  HTTPSuccessCode
                when ?4 then be = false; HTTPNoContentCode
                when ?5 then be = false; HTTPResetContentCode
                when ?6 then be = true;  HTTPPartialContentCode
                else         UnknownCode
                end
              when ?3 then
                case status[2]
                when ?0 then be = true;  HTTPMultipleChoiceCode
                when ?1 then be = true;  HTTPMovedPermanentryCode
                when ?2 then be = true;  HTTPMovedTemporarilyCode
                when ?3 then be = true;  HTTPMovedPermanentryCode
                when ?4 then be = false; HTTPNotModifiedCode
                when ?5 then be = false; HTTPUseProxyCode
                else         UnknownCode
                end
              when ?4 then ServerBusyCode
              when ?5 then FatalErrorCode
              else         UnknownCode
              end
      code = klass.new( status, discrip )
      code['body-exist'] = be
      code
    end

    def read_chunked( ret, header )
      line = nil
      len = nil
      total = 0

      while true do
        line = @socket.readline
        unless /[0-9a-hA-H]+/ === line then
          raise HTTPBadResponse, "chunk size not given"
        end
        len = $&.hex
        break if len == 0
        @socket.read( len, ret ); total += len
        @socket.read 2   # \r\n
      end
      while true do
        line = @socket.readline
        break if line.empty?
      end

      header.delete 'transfer-encoding'
      header[ 'content-length' ] = "Content-Length: #{total}"
    end

    
    def content_length( header )
      unless str = header[ 'content-length' ] then
        return nil
      end
      unless /\Acontent-length:\s*(\d+)/i === str then
        raise HTTPBadResponse, "content-length format error"
      end
      $1.to_i
    end

    def chunked?( header )
      if str = header[ 'transfer-encoding' ] then
        if /\Atransfer-encoding:\s*chunked/i === str then
          return true
        end
      end

      false
    end

  end


end   # module Net