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
|
#
# = net/protocol.rb
#
#--
# Copyright (c) 1999-2003 Yukihiro Matsumoto
# Copyright (c) 1999-2003 Minero Aoki
#
# written and maintained by Minero Aoki <aamine@loveruby.net>
#
# This program is free software. You can re-distribute and/or
# modify this program under the same terms as Ruby itself,
# Ruby Distribute License or GNU General Public License.
#
# $Id$
#++
#
# WARNING: This file is going to remove.
# Do not rely on the implementation written in this file.
#
require 'socket'
require 'timeout'
module Net # :nodoc:
class Protocol #:nodoc: internal use only
private
def Protocol.protocol_param( name, val )
module_eval(<<-End, __FILE__, __LINE__ + 1)
def #{name}
#{val}
end
End
end
end
class ProtocolError < StandardError; end
class ProtoSyntaxError < ProtocolError; end
class ProtoFatalError < ProtocolError; end
class ProtoUnknownError < ProtocolError; end
class ProtoServerError < ProtocolError; end
class ProtoAuthError < ProtocolError; end
class ProtoCommandError < ProtocolError; end
class ProtoRetriableError < ProtocolError; end
ProtocRetryError = ProtoRetriableError
class InternetMessageIO #:nodoc: internal use only
class << self
alias open new
end
def initialize( addr, port,
open_timeout = nil, read_timeout = nil,
debug_output = nil )
@address = addr
@port = port
@read_timeout = read_timeout
@debug_output = debug_output
@socket = nil
@rbuf = nil # read buffer
@wbuf = nil # write buffer
connect open_timeout
LOG 'opened'
end
attr_reader :address
attr_reader :port
def ip_address
return '' unless @socket
@socket.addr[3]
end
attr_accessor :read_timeout
attr_reader :socket
def connect( open_timeout )
LOG "opening connection to #{@address}..."
timeout(open_timeout) {
@socket = TCPsocket.new(@address, @port)
}
@rbuf = ''
end
private :connect
def close
if @socket
@socket.close
LOG 'closed'
else
LOG 'close call for already closed socket'
end
@socket = nil
@rbuf = ''
end
def reopen( open_timeout = nil )
LOG 'reopening...'
close
connect open_timeout
LOG 'reopened'
end
def closed?
not @socket
end
def inspect
"#<#{self.class} #{closed?() ? 'closed' : 'opened'}>"
end
###
### READ
###
public
def read( len, dest = '', ignore_eof = false )
LOG "reading #{len} bytes..."
# LOG_off() # experimental: [ruby-list:38800]
read_bytes = 0
begin
while read_bytes + @rbuf.size < len
read_bytes += rbuf_moveto(dest, @rbuf.size)
rbuf_fill
end
rbuf_moveto dest, len - read_bytes
rescue EOFError
raise unless ignore_eof
end
# LOG_on()
LOG "read #{read_bytes} bytes"
dest
end
def read_all( dest = '' )
LOG 'reading all...'
# LOG_off() # experimental: [ruby-list:38800]
read_bytes = 0
begin
while true
read_bytes += rbuf_moveto(dest, @rbuf.size)
rbuf_fill
end
rescue EOFError
;
end
# LOG_on()
LOG "read #{read_bytes} bytes"
dest
end
def readuntil( terminator, ignore_eof = false )
dest = ''
begin
until idx = @rbuf.index(terminator)
rbuf_fill
end
rbuf_moveto dest, idx + terminator.size
rescue EOFError
raise unless ignore_eof
rbuf_moveto dest, @rbuf.size
end
dest
end
def readline
readuntil("\n").chop
end
def each_message_chunk
LOG 'reading message...'
LOG_off()
read_bytes = 0
while (line = readuntil("\r\n")) != ".\r\n"
read_bytes += line.size
yield line.sub(/\A\./, '')
end
LOG_on()
LOG "read message (#{read_bytes} bytes)"
end
# *library private* (cannot handle 'break')
def each_list_item
while (str = readuntil("\r\n")) != ".\r\n"
yield str.chop
end
end
private
def rbuf_fill
until IO.select([@socket], nil, nil, @read_timeout)
raise TimeoutError, "socket read timeout (#{@read_timeout} sec)"
end
@rbuf << @socket.sysread(1024)
end
def rbuf_moveto( dest, len )
dest << (s = @rbuf.slice!(0, len))
@debug_output << %Q[-> #{s.dump}\n] if @debug_output
len
end
###
### WRITE
###
public
def write( str )
writing {
write0 str
}
end
def writeline( str )
writing {
write0 str + "\r\n"
}
end
def write_message( src )
LOG "writing message from #{src.class}"
LOG_off()
len = using_each_crlf_line {
write_message_0 src
}
LOG_on()
LOG "wrote #{len} bytes"
len
end
def write_message_by_block( &block )
LOG 'writing message from block'
LOG_off()
len = using_each_crlf_line {
begin
block.call(WriteAdapter.new(self, :write_message_0))
rescue LocalJumpError
# allow `break' from writer block
end
}
LOG_on()
LOG "wrote #{len} bytes"
len
end
private
def writing
@written_bytes = 0
@debug_output << '<- ' if @debug_output
yield
@socket.flush
@debug_output << "\n" if @debug_output
bytes = @written_bytes
@written_bytes = nil
bytes
end
def write0( str )
@debug_output << str.dump if @debug_output
len = @socket.write(str)
@written_bytes += len
len
end
#
# Reads string from src calling :each, and write to @socket.
# Escapes '.' on the each line head.
#
def write_message_0( src )
prev = @written_bytes
each_crlf_line(src) do |line|
if line[0] == ?.
then write0 '.' + line
else write0 line
end
end
@written_bytes - prev
end
#
# setup @wbuf for each_crlf_line.
#
def using_each_crlf_line
writing {
@wbuf = ''
yield
if not @wbuf.empty? # unterminated last line
if @wbuf[-1] == ?\r
@wbuf.chop!
end
@wbuf.concat "\r\n"
write0 @wbuf
elsif @written_bytes == 0 # empty src
write0 "\r\n"
end
write0 ".\r\n"
@wbuf = nil
}
end
#
# extract a CR-LF-terminating-line from @wbuf and yield it.
#
def each_crlf_line( src )
adding(src) do
beg = 0
buf = @wbuf
while buf.index(/\n|\r\n|\r/, beg)
m = Regexp.last_match
if (m.begin(0) == buf.length - 1) and buf[-1] == ?\r
# "...\r" : can follow "\n..."
break
end
str = buf[beg ... m.begin(0)]
str.concat "\r\n"
yield str
beg = m.end(0)
end
@wbuf = buf[beg ... buf.length]
end
end
#
# Reads strings from SRC and add to @wbuf, then yield.
#
def adding( src )
case src
when String # for speeding up.
0.step(src.size - 1, 2048) do |i|
@wbuf << src[i,2048]
yield
end
when File # for speeding up.
while s = src.read(2048)
s[0,0] = @wbuf
@wbuf = s
yield
end
else # generic reader
src.each do |s|
@wbuf << s
yield if @wbuf.size > 2048
end
yield unless @wbuf.empty?
end
end
###
### DEBUG
###
private
def LOG_off
@save_debug_out = @debug_output
@debug_output = nil
end
def LOG_on
@debug_output = @save_debug_out
end
def LOG( msg )
return unless @debug_output
@debug_output << msg
@debug_output << "\n"
end
end
#
# The writer adapter class
#
class WriteAdapter
def initialize( sock, mid )
@socket = sock
@method_id = mid
end
def inspect
"#<#{self.class} socket=#{@socket.inspect}>"
end
def write( str )
@socket.__send__(@method_id, str)
end
alias print write
def <<( str )
write str
self
end
def puts( str = '' )
write str.sub(/\n?\z/, "\n")
end
def printf( *args )
write sprintf(*args)
end
end
class ReadAdapter #:nodoc: internal use only
def initialize( block )
@block = block
end
def inspect
"#<#{self.class}>"
end
def <<( str )
call_block(str, &@block) if @block
end
private
#
# This method is needed because @block must be called by yield,
# not Proc#call. You can see difference when using `break' in
# the block.
#
def call_block( str )
yield str
end
end
module NetPrivate #:nodoc: obsolete
Socket = ::Net::InternetMessageIO
end
end # module Net
|