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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
|
=begin
= net/protocol.rb
written by Minero Aoki <aamine@dp.u-netsurf.ne.jp>
This library is distributed under the terms of the Ruby license.
You can freely distribute/modify this library.
=end
require 'socket'
module Net
Version = '1.1.17'
=begin
== Net::Protocol
the abstruct class for Internet protocol
=== Super Class
Object
=== Class Methods
: new( address = 'localhost', port = nil )
This method Creates a new protocol object.
: start( address = 'localhost', port = nil, *args )
: start( address = 'localhost', port = nil, *args ){|proto| .... }
This method creates a new Protocol object and start session.
If you call this method with block, Protocol object give itself
to block and finish session when block returns.
: Proxy( address, port )
This method creates a proxy class of its protocol.
Arguments are address/port of proxy host.
=== Methods
: address
the address of connecting server (FQDN).
: port
connecting port number
: start( *args )
This method start protocol. If you call this method when the protocol
is already started, this only returns false without doing anything.
'*args' are specified in subclasses.
: finish
This method ends protocol. If you call this method before protocol starts,
it only return false without doing anything.
: active?
true if session have been started
=end
class Protocol
Version = ::Net::Version
class << self
def start( address = 'localhost', port = nil, *args )
instance = new( address, port )
if iterator? then
instance.start( *args ) { yield instance }
else
instance.start *args
instance
end
end
def Proxy( p_addr, p_port )
klass = Class.new( self )
klass.module_eval %-
def initialize( addr, port )
@proxyaddr = '#{p_addr}'
@proxyport = '#{p_port}'
super @proxyaddr, @proxyport
@address = addr
@port = port
end
def connect( addr = nil, port = nil )
super @proxyaddr, @proxyport
end
private :connect
attr_reader :proxyaddr, :proxyport
-
def klass.proxy?
true
end
klass
end
def proxy?
false
end
private
def protocol_param( name, val )
module_eval %-
def self.#{name.id2name}
#{val}
end
-
end
end
#
# sub-class requirements
#
# protocol_param command_type
# protocol_param port
#
# private method do_start (optional)
# private method do_finish (optional)
#
protocol_param :port, 'nil'
protocol_param :command_type, 'nil'
protocol_param :socket_type, '::Net::Socket'
def initialize( addr = nil, port = nil )
@address = addr || 'localhost'
@port = port || type.port
@active = false
@pipe = nil
@command = nil
@socket = nil
end
attr_reader :address, :port,
:command, :socket
def start( *args )
return false if active?
begin
connect
do_start *args
@active = true
yield if iterator?
ensure
finish if iterator?
end
end
def finish
ret = active?
do_finish
disconnect
@active = false
ret
end
def active?
@active
end
def set_pipe( arg ) # un-documented
@pipe = arg
end
private
def do_start
end
def do_finish
@command.quit
end
def connect( addr = @address, port = @port )
@socket = type.socket_type.open( addr, port, @pipe )
@command = type.command_type.new( @socket )
end
def disconnect
@command = nil
if @socket and not @socket.closed? then
@socket.close
end
@socket = nil
end
end
Session = Protocol
class Command
def initialize( sock )
@socket = sock
@last_reply = nil
@critical = false
end
attr_accessor :socket
attr_reader :last_reply
# abstract quit
private
# abstract get_reply()
def check_reply( *oks )
@last_reply = get_reply
reply_must( @last_reply, *oks )
end
def reply_must( rep, *oks )
oks.each do |i|
if i === rep then
return rep
end
end
rep.error!
end
def getok( line, ok = SuccessCode )
@socket.writeline line
check_reply ok
end
def critical
return if @critical
@critical = true
r = yield
@critical = false
r
end
def critical?
@critical
end
def begin_critical
ret = @critical
@critical = true
not ret
end
def end_critical
@critical = false
end
end
class Response
def initialize( ctype, cno, msg )
@code_type = ctype
@code = cno
@message = msg
super()
end
attr_reader :code_type, :code, :message
alias msg message
def error!
raise @code_type.error_type, @code + ' ' + Net.quote(@message)
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 Code
def initialize( paren, err )
@parents = paren
@err = err
@parents.push self
end
attr_reader :parents
def error_type
@err
end
def ===( response )
response.code_type.parents.reverse_each {|i| return true if i == self }
false
end
def mkchild( err = nil )
type.new( @parents + [self], err || @err )
end
end
ReplyCode = Code.new( [], ProtoUnknownError )
SuccessCode = ReplyCode.mkchild( ProtoUnknownError )
ContinueCode = ReplyCode.mkchild( ProtoUnknownError )
ErrorCode = ReplyCode.mkchild( ProtocolError )
SyntaxErrorCode = ErrorCode.mkchild( ProtoSyntaxError )
FatalErrorCode = ErrorCode.mkchild( ProtoFatalError )
ServerErrorCode = ErrorCode.mkchild( ProtoServerError )
AuthErrorCode = ErrorCode.mkchild( ProtoAuthError )
RetriableCode = ReplyCode.mkchild( ProtoRetriableError )
UnknownCode = ReplyCode.mkchild( ProtoUnknownError )
class WriteAdapter
def initialize( sock, mid )
@sock = sock
@mid = mid
end
def write( str )
@sock.__send__ @mid, str
end
alias << write
end
class ReadAdapter
def initialize( block )
@block = block
end
def <<( str )
@block.call str
end
end
class Socket
def initialize( addr, port, pipe = nil )
@addr = addr
@port = port
@pipe = pipe
@prepipe = nil
@closed = true
@ipaddr = ''
@sending = ''
@buffer = ''
@socket = TCPsocket.new( addr, port )
@closed = false
@ipaddr = @socket.addr[3]
end
attr :pipe, true
class << self
alias open new
end
def reopen
unless closed? then
@socket.close
@buffer = ''
end
@socket = TCPsocket.new( @addr, @port )
end
attr :socket, true
def close
@socket.close
@closed = true
end
def closed?
@closed
end
def address
@addr.dup
end
alias addr address
attr_reader :port
def ip_address
@ipaddr.dup
end
alias ipaddr ip_address
attr_reader :sending
CRLF = "\r\n"
D_CRLF = ".\r\n"
TERMEXP = /\n|\r\n|\r/o
def read( len, dest = '' )
@pipe << "reading #{len} bytes...\n" if @pipe; pipeoff
rsize = 0
while rsize + @buffer.size < len do
rsize += writeinto( dest, @buffer.size )
fill_rbuf
end
writeinto( dest, len - rsize )
@pipe << "read #{len} bytes\n" if pipeon
dest
end
def read_all( dest = '' )
@pipe << "reading all...\n" if @pipe; pipeoff
rsize = 0
begin
while true do
rsize += writeinto( dest, @buffer.size )
fill_rbuf
end
rescue EOFError
;
end
@pipe << "read #{rsize} bytes\n" if pipeon
dest
end
def readuntil( target )
while true do
idx = @buffer.index( target )
break if idx
fill_rbuf
end
dest = ''
writeinto( dest, idx + target.size )
dest
end
def readline
ret = readuntil( CRLF )
ret.chop!
ret
end
def read_pendstr( dest )
@pipe << "reading text...\n" if @pipe; pipeoff
rsize = 0
while (str = readuntil( CRLF )) != D_CRLF do
rsize += str.size
str.gsub!( /\A\./o, '' )
dest << str
end
@pipe << "read #{rsize} bytes\n" if pipeon
dest
end
def read_pendlist
@pipe << "reading list...\n" if @pipe; pipeoff
arr = []
str = nil
while (str = readuntil( CRLF )) != D_CRLF do
str.chop!
arr.push str
yield str if iterator?
end
@pipe << "read #{arr.size} lines\n" if pipeon
arr
end
private
READ_BLOCK = 1024 * 8
def fill_rbuf
@buffer << @socket.sysread( READ_BLOCK )
end
def writeinto( dest, len )
bsi = @buffer.size
dest << @buffer[ 0, len ]
@buffer = @buffer[ len, bsi - len ]
@pipe << %{read "#{Net.quote dest}"\n} if @pipe
len
end
public
def write( str )
do_write_beg
do_write_do str
do_write_fin
end
def writeline( str )
do_write_beg
do_write_do str
do_write_do CRLF
do_write_fin
end
def write_bin( src, block )
do_write_beg
if block then
block.call WriteAdapter.new( self, :do_write_do )
else
src.each do |bin|
do_write_do bin
end
end
do_write_fin
end
def write_pendstr( src, block )
@pipe << "writing text from #{src.type}\n" if @pipe; pipeoff
do_write_beg
if block then
block.call WriteAdapter.new( self, :write_pendstr_inner )
else
write_pendstr_inner src
end
each_crlf_line2( :i_w_pend )
do_write_do D_CRLF
wsize = do_write_fin
@pipe << "wrote #{wsize} bytes text" if pipeon
wsize
end
private
def write_inner( src )
each_crlf_line( src, :do_write_do )
end
def write_pendstr_inner( src )
each_crlf_line src, :i_w_pend
end
def i_w_pend( line )
do_write_do '.' if line[0] == ?.
do_write_do line
end
def each_crlf_line( src, mid )
beg = 0
buf = pos = s = bin = nil
adding( src ) do
beg = 0
buf = @wbuf
while true do
pos = buf.index( TERMEXP, beg )
break unless pos
s = $&.size
break if pos + s == buf.size - 1 and buf[-1] == ?\r
__send__ mid, buf[ beg, pos - beg ] << CRLF
beg = pos + s
end
@wbuf = buf[ beg, buf.size - beg ] if beg != 0
end
end
def adding( src )
i = nil
case src
when String
0.step( src.size, 512 ) do |i|
@wbuf << src[ i, 512 ]
yield
end
when File
while true do
i = src.read( 512 )
break unless i
@wbuf << i
yield
end
else
src.each do |bin|
@wbuf << bin
yield if @wbuf.size > 512
end
end
end
def each_crlf_line2( mid )
buf = @wbuf
beg = pos = nil
buf << "\n" unless /\n|\r/o === buf[-1,1]
beg = 0
while true do
pos = buf.index( TERMEXP, beg )
break unless pos
__send__ mid, buf[ beg, pos - beg ] << CRLF
beg = pos + $&.size
end
end
def do_write_beg
@writtensize = 0
@sending = ''
@wbuf = ''
end
def do_write_do( arg )
if @pipe or @sending.size < 128 then
@sending << Net.quote( arg )
else
@sending << '...' unless @sending[-1] == ?.
end
s = @socket.write( arg )
@writtensize += s
s
end
def do_write_fin
if @pipe then
@pipe << 'write "'
@pipe << @sending
@pipe << "\"\n"
end
@socket.flush
@writtensize
end
def pipeoff
@prepipe = @pipe
@pipe = nil
@prepipe
end
def pipeon
@pipe = @prepipe
@prepipe = nil
@pipe
end
end
def Net.quote( str )
str = str.gsub( "\n", '\\n' )
str.gsub!( "\r", '\\r' )
str.gsub!( "\t", '\\t' )
str
end
end # module Net
|