* io.c (rb_open_file): encoding in mode string was ignored if perm is
[ruby-svn.git] / lib / net / telnet.rb
blob67fd656c636da4e87322b77ffe953e2dcf4355b2
1 # = net/telnet.rb - Simple Telnet Client Library
2
3 # Author:: Wakou Aoyama <wakou@ruby-lang.org>
4 # Documentation:: William Webber and Wakou Aoyama 
6 # This file holds the class Net::Telnet, which provides client-side
7 # telnet functionality.
9 # For documentation, see Net::Telnet.
12 require "socket"
13 require "delegate"
14 require "timeout"
15 require "English"
17 module Net
19   #
20   # == Net::Telnet
21   #
22   # Provides telnet client functionality.
23   #
24   # This class also has, through delegation, all the methods of a
25   # socket object (by default, a +TCPSocket+, but can be set by the
26   # +Proxy+ option to <tt>new()</tt>).  This provides methods such as
27   # <tt>close()</tt> to end the session and <tt>sysread()</tt> to read
28   # data directly from the host, instead of via the <tt>waitfor()</tt>
29   # mechanism.  Note that if you do use <tt>sysread()</tt> directly
30   # when in telnet mode, you should probably pass the output through
31   # <tt>preprocess()</tt> to extract telnet command sequences.
32   #
33   # == Overview
34   #
35   # The telnet protocol allows a client to login remotely to a user
36   # account on a server and execute commands via a shell.  The equivalent
37   # is done by creating a Net::Telnet class with the +Host+ option
38   # set to your host, calling #login() with your user and password,
39   # issuing one or more #cmd() calls, and then calling #close()
40   # to end the session.  The #waitfor(), #print(), #puts(), and
41   # #write() methods, which #cmd() is implemented on top of, are
42   # only needed if you are doing something more complicated.
43   #
44   # A Net::Telnet object can also be used to connect to non-telnet
45   # services, such as SMTP or HTTP.  In this case, you normally
46   # want to provide the +Port+ option to specify the port to
47   # connect to, and set the +Telnetmode+ option to false to prevent
48   # the client from attempting to interpret telnet command sequences.
49   # Generally, #login() will not work with other protocols, and you
50   # have to handle authentication yourself.
51   #
52   # For some protocols, it will be possible to specify the +Prompt+
53   # option once when you create the Telnet object and use #cmd() calls; 
54   # for others, you will have to specify the response sequence to
55   # look for as the Match option to every #cmd() call, or call
56   # #puts() and #waitfor() directly; for yet others, you will have 
57   # to use #sysread() instead of #waitfor() and parse server 
58   # responses yourself.
59   #
60   # It is worth noting that when you create a new Net::Telnet object,
61   # you can supply a proxy IO channel via the Proxy option.  This
62   # can be used to attach the Telnet object to other Telnet objects,
63   # to already open sockets, or to any read-write IO object.  This
64   # can be useful, for instance, for setting up a test fixture for
65   # unit testing.
66   # 
67   # == Examples
68   # 
69   # === Log in and send a command, echoing all output to stdout
70   # 
71   #   localhost = Net::Telnet::new("Host" => "localhost",
72   #                                "Timeout" => 10,
73   #                                "Prompt" => /[$%#>] \z/n)
74   #   localhost.login("username", "password") { |c| print c }
75   #   localhost.cmd("command") { |c| print c }
76   #   localhost.close
77   # 
78   # 
79   # === Check a POP server to see if you have mail
80   # 
81   #   pop = Net::Telnet::new("Host" => "your_destination_host_here",
82   #                          "Port" => 110,
83   #                          "Telnetmode" => false,
84   #                          "Prompt" => /^\+OK/n)
85   #   pop.cmd("user " + "your_username_here") { |c| print c }
86   #   pop.cmd("pass " + "your_password_here") { |c| print c }
87   #   pop.cmd("list") { |c| print c }
88   #
89   # == References
90   #
91   # There are a large number of RFCs relevant to the Telnet protocol.
92   # RFCs 854-861 define the base protocol.  For a complete listing
93   # of relevant RFCs, see
94   # http://www.omnifarious.org/~hopper/technical/telnet-rfc.html
95   #
96   class Telnet < SimpleDelegator
98     # :stopdoc:
99     IAC   = 255.chr # "\377" # "\xff" # interpret as command
100     DONT  = 254.chr # "\376" # "\xfe" # you are not to use option 
101     DO    = 253.chr # "\375" # "\xfd" # please, you use option 
102     WONT  = 252.chr # "\374" # "\xfc" # I won't use option 
103     WILL  = 251.chr # "\373" # "\xfb" # I will use option 
104     SB    = 250.chr # "\372" # "\xfa" # interpret as subnegotiation 
105     GA    = 249.chr # "\371" # "\xf9" # you may reverse the line 
106     EL    = 248.chr # "\370" # "\xf8" # erase the current line 
107     EC    = 247.chr # "\367" # "\xf7" # erase the current character 
108     AYT   = 246.chr # "\366" # "\xf6" # are you there 
109     AO    = 245.chr # "\365" # "\xf5" # abort output--but let prog finish 
110     IP    = 244.chr # "\364" # "\xf4" # interrupt process--permanently 
111     BREAK = 243.chr # "\363" # "\xf3" # break 
112     DM    = 242.chr # "\362" # "\xf2" # data mark--for connect. cleaning 
113     NOP   = 241.chr # "\361" # "\xf1" # nop 
114     SE    = 240.chr # "\360" # "\xf0" # end sub negotiation 
115     EOR   = 239.chr # "\357" # "\xef" # end of record (transparent mode) 
116     ABORT = 238.chr # "\356" # "\xee" # Abort process 
117     SUSP  = 237.chr # "\355" # "\xed" # Suspend process 
118     EOF   = 236.chr # "\354" # "\xec" # End of file 
119     SYNCH = 242.chr # "\362" # "\xf2" # for telfunc calls 
121     OPT_BINARY         =   0.chr # "\000" # "\x00" # Binary Transmission 
122     OPT_ECHO           =   1.chr # "\001" # "\x01" # Echo 
123     OPT_RCP            =   2.chr # "\002" # "\x02" # Reconnection 
124     OPT_SGA            =   3.chr # "\003" # "\x03" # Suppress Go Ahead 
125     OPT_NAMS           =   4.chr # "\004" # "\x04" # Approx Message Size Negotiation 
126     OPT_STATUS         =   5.chr # "\005" # "\x05" # Status 
127     OPT_TM             =   6.chr # "\006" # "\x06" # Timing Mark 
128     OPT_RCTE           =   7.chr # "\a"   # "\x07" # Remote Controlled Trans and Echo 
129     OPT_NAOL           =   8.chr # "\010" # "\x08" # Output Line Width 
130     OPT_NAOP           =   9.chr # "\t"   # "\x09" # Output Page Size 
131     OPT_NAOCRD         =  10.chr # "\n"   # "\x0a" # Output Carriage-Return Disposition 
132     OPT_NAOHTS         =  11.chr # "\v"   # "\x0b" # Output Horizontal Tab Stops 
133     OPT_NAOHTD         =  12.chr # "\f"   # "\x0c" # Output Horizontal Tab Disposition 
134     OPT_NAOFFD         =  13.chr # "\r"   # "\x0d" # Output Formfeed Disposition 
135     OPT_NAOVTS         =  14.chr # "\016" # "\x0e" # Output Vertical Tabstops 
136     OPT_NAOVTD         =  15.chr # "\017" # "\x0f" # Output Vertical Tab Disposition 
137     OPT_NAOLFD         =  16.chr # "\020" # "\x10" # Output Linefeed Disposition 
138     OPT_XASCII         =  17.chr # "\021" # "\x11" # Extended ASCII 
139     OPT_LOGOUT         =  18.chr # "\022" # "\x12" # Logout 
140     OPT_BM             =  19.chr # "\023" # "\x13" # Byte Macro 
141     OPT_DET            =  20.chr # "\024" # "\x14" # Data Entry Terminal 
142     OPT_SUPDUP         =  21.chr # "\025" # "\x15" # SUPDUP 
143     OPT_SUPDUPOUTPUT   =  22.chr # "\026" # "\x16" # SUPDUP Output 
144     OPT_SNDLOC         =  23.chr # "\027" # "\x17" # Send Location 
145     OPT_TTYPE          =  24.chr # "\030" # "\x18" # Terminal Type 
146     OPT_EOR            =  25.chr # "\031" # "\x19" # End of Record 
147     OPT_TUID           =  26.chr # "\032" # "\x1a" # TACACS User Identification 
148     OPT_OUTMRK         =  27.chr # "\e"   # "\x1b" # Output Marking 
149     OPT_TTYLOC         =  28.chr # "\034" # "\x1c" # Terminal Location Number 
150     OPT_3270REGIME     =  29.chr # "\035" # "\x1d" # Telnet 3270 Regime 
151     OPT_X3PAD          =  30.chr # "\036" # "\x1e" # X.3 PAD 
152     OPT_NAWS           =  31.chr # "\037" # "\x1f" # Negotiate About Window Size 
153     OPT_TSPEED         =  32.chr # " "    # "\x20" # Terminal Speed 
154     OPT_LFLOW          =  33.chr # "!"    # "\x21" # Remote Flow Control 
155     OPT_LINEMODE       =  34.chr # "\""   # "\x22" # Linemode 
156     OPT_XDISPLOC       =  35.chr # "#"    # "\x23" # X Display Location 
157     OPT_OLD_ENVIRON    =  36.chr # "$"    # "\x24" # Environment Option 
158     OPT_AUTHENTICATION =  37.chr # "%"    # "\x25" # Authentication Option 
159     OPT_ENCRYPT        =  38.chr # "&"    # "\x26" # Encryption Option 
160     OPT_NEW_ENVIRON    =  39.chr # "'"    # "\x27" # New Environment Option 
161     OPT_EXOPL          = 255.chr # "\377" # "\xff" # Extended-Options-List 
163     NULL = "\000" 
164     CR   = "\015"   
165     LF   = "\012" 
166     EOL  = CR + LF 
167     REVISION = '$Id$'
168     # :startdoc:
170     #
171     # Creates a new Net::Telnet object.
172     #
173     # Attempts to connect to the host (unless the Proxy option is
174     # provided: see below).  If a block is provided, it is yielded
175     # status messages on the attempt to connect to the server, of
176     # the form:
177     # 
178     #   Trying localhost...
179     #   Connected to localhost.
180     #
181     # +options+ is a hash of options.  The following example lists
182     # all options and their default values.
183     # 
184     #   host = Net::Telnet::new(
185     #            "Host"       => "localhost",  # default: "localhost"
186     #            "Port"       => 23,           # default: 23
187     #            "Binmode"    => false,        # default: false
188     #            "Output_log" => "output_log", # default: nil (no output)
189     #            "Dump_log"   => "dump_log",   # default: nil (no output)
190     #            "Prompt"     => /[$%#>] \z/n, # default: /[$%#>] \z/n
191     #            "Telnetmode" => true,         # default: true
192     #            "Timeout"    => 10,           # default: 10
193     #              # if ignore timeout then set "Timeout" to false.
194     #            "Waittime"   => 0,            # default: 0
195     #            "Proxy"      => proxy         # default: nil
196     #                            # proxy is Net::Telnet or IO object
197     #          )
198     #
199     # The options have the following meanings:
200     #
201     # Host:: the hostname or IP address of the host to connect to, as a String. 
202     #        Defaults to "localhost".
203     #
204     # Port:: the port to connect to.  Defaults to 23.
205     #
206     # Binmode:: if false (the default), newline substitution is performed.  
207     #           Outgoing LF is
208     #           converted to CRLF, and incoming CRLF is converted to LF.  If
209     #           true, this substitution is not performed.  This value can
210     #           also be set with the #binmode() method.  The 
211     #           outgoing conversion only applies to the #puts() and #print()
212     #           methods, not the #write() method.  The precise nature of
213     #           the newline conversion is also affected by the telnet options
214     #           SGA and BIN.
215     #
216     # Output_log:: the name of the file to write connection status messages
217     #              and all received traffic to.  In the case of a proper
218     #              Telnet session, this will include the client input as
219     #              echoed by the host; otherwise, it only includes server
220     #              responses.  Output is appended verbatim to this file.  
221     #              By default, no output log is kept.
222     #
223     # Dump_log:: as for Output_log, except that output is written in hexdump
224     #            format (16 bytes per line as hex pairs, followed by their
225     #            printable equivalent), with connection status messages
226     #            preceded by '#', sent traffic preceded by '>', and 
227     #            received traffic preceded by '<'.  By default, not dump log
228     #            is kept.
229     #
230     # Prompt:: a regular expression matching the host's command-line prompt
231     #          sequence.  This is needed by the Telnet class to determine
232     #          when the output from a command has finished and the host is
233     #          ready to receive a new command.  By default, this regular
234     #          expression is /[$%#>] \z/n.
235     #
236     # Telnetmode:: a boolean value, true by default.  In telnet mode, 
237     #              traffic received from the host is parsed for special
238     #              command sequences, and these sequences are escaped
239     #              in outgoing traffic sent using #puts() or #print()
240     #              (but not #write()).  If you are using the Net::Telnet
241     #              object to connect to a non-telnet service (such as
242     #              SMTP or POP), this should be set to "false" to prevent
243     #              undesired data corruption.  This value can also be set
244     #              by the #telnetmode() method.
245     #
246     # Timeout:: the number of seconds to wait before timing out both the
247     #           initial attempt to connect to host (in this constructor),
248     #           and all attempts to read data from the host (in #waitfor(),
249     #           #cmd(), and #login()).  Exceeding this timeout causes a
250     #           TimeoutError to be raised.  The default value is 10 seconds.
251     #           You can disable the timeout by setting this value to false.
252     #           In this case, the connect attempt will eventually timeout
253     #           on the underlying connect(2) socket call with an
254     #           Errno::ETIMEDOUT error (but generally only after a few
255     #           minutes), but other attempts to read data from the host
256     #           will hand indefinitely if no data is forthcoming.
257     #
258     # Waittime:: the amount of time to wait after seeing what looks like a 
259     #            prompt (that is, received data that matches the Prompt
260     #            option regular expression) to see if more data arrives.
261     #            If more data does arrive in this time, Net::Telnet assumes
262     #            that what it saw was not really a prompt.  This is to try to 
263     #            avoid false matches, but it can also lead to missing real
264     #            prompts (if, for instance, a background process writes to
265     #            the terminal soon after the prompt is displayed).  By
266     #            default, set to 0, meaning not to wait for more data.
267     #
268     # Proxy:: a proxy object to used instead of opening a direct connection
269     #         to the host.  Must be either another Net::Telnet object or
270     #         an IO object.  If it is another Net::Telnet object, this 
271     #         instance will use that one's socket for communication.  If an
272     #         IO object, it is used directly for communication.  Any other
273     #         kind of object will cause an error to be raised.
274     #
275     def initialize(options) # :yield: mesg 
276       @options = options
277       @options["Host"]       = "localhost"   unless @options.has_key?("Host")
278       @options["Port"]       = 23            unless @options.has_key?("Port")
279       @options["Prompt"]     = /[$%#>] \z/n  unless @options.has_key?("Prompt")
280       @options["Timeout"]    = 10            unless @options.has_key?("Timeout")
281       @options["Waittime"]   = 0             unless @options.has_key?("Waittime")
282       unless @options.has_key?("Binmode")
283         @options["Binmode"]    = false         
284       else
285         unless (true == @options["Binmode"] or false == @options["Binmode"])
286           raise ArgumentError, "Binmode option must be true or false"
287         end
288       end
290       unless @options.has_key?("Telnetmode")
291         @options["Telnetmode"] = true          
292       else
293         unless (true == @options["Telnetmode"] or false == @options["Telnetmode"])
294           raise ArgumentError, "Telnetmode option must be true or false"
295         end
296       end
298       @telnet_option = { "SGA" => false, "BINARY" => false }
300       if @options.has_key?("Output_log")
301         @log = File.open(@options["Output_log"], 'a+')
302         @log.sync = true
303         @log.binmode
304       end
306       if @options.has_key?("Dump_log")
307         @dumplog = File.open(@options["Dump_log"], 'a+')
308         @dumplog.sync = true
309         @dumplog.binmode
310         def @dumplog.log_dump(dir, x)  # :nodoc:
311           len = x.length
312           addr = 0
313           offset = 0
314           while 0 < len
315             if len < 16
316               line = x[offset, len]
317             else
318               line = x[offset, 16]
319             end
320             hexvals = line.unpack('H*')[0]
321             hexvals += ' ' * (32 - hexvals.length)
322             hexvals = format("%s %s %s %s  " * 4, *hexvals.unpack('a2' * 16))
323             line = line.gsub(/[\000-\037\177-\377]/n, '.')
324             printf "%s 0x%5.5x: %s%s\n", dir, addr, hexvals, line
325             addr += 16
326             offset += 16
327             len -= 16
328           end
329           print "\n"
330         end
331       end
333       if @options.has_key?("Proxy")
334         if @options["Proxy"].kind_of?(Net::Telnet)
335           @sock = @options["Proxy"].sock
336         elsif @options["Proxy"].kind_of?(IO)
337           @sock = @options["Proxy"]
338         else
339           raise "Error: Proxy must be an instance of Net::Telnet or IO."
340         end
341       else
342         message = "Trying " + @options["Host"] + "...\n"
343         yield(message) if block_given?
344         @log.write(message) if @options.has_key?("Output_log")
345         @dumplog.log_dump('#', message) if @options.has_key?("Dump_log")
347         begin
348           if @options["Timeout"] == false
349             @sock = TCPSocket.open(@options["Host"], @options["Port"])
350           else
351             timeout(@options["Timeout"]) do
352               @sock = TCPSocket.open(@options["Host"], @options["Port"])
353             end
354           end
355         rescue TimeoutError
356           raise TimeoutError, "timed out while opening a connection to the host"
357         rescue
358           @log.write($ERROR_INFO.to_s + "\n") if @options.has_key?("Output_log")
359           @dumplog.log_dump('#', $ERROR_INFO.to_s + "\n") if @options.has_key?("Dump_log")
360           raise
361         end
362         @sock.sync = true
363         @sock.binmode
365         message = "Connected to " + @options["Host"] + ".\n"
366         yield(message) if block_given?
367         @log.write(message) if @options.has_key?("Output_log")
368         @dumplog.log_dump('#', message) if @options.has_key?("Dump_log")
369       end
371       super(@sock)
372     end # initialize
374     # The socket the Telnet object is using.  Note that this object becomes
375     # a delegate of the Telnet object, so normally you invoke its methods
376     # directly on the Telnet object.
377     attr :sock 
379     # Set telnet command interpretation on (+mode+ == true) or off
380     # (+mode+ == false), or return the current value (+mode+ not
381     # provided).  It should be on for true telnet sessions, off if
382     # using Net::Telnet to connect to a non-telnet service such
383     # as SMTP.
384     def telnetmode(mode = nil)
385       case mode
386       when nil
387         @options["Telnetmode"]
388       when true, false
389         @options["Telnetmode"] = mode
390       else
391         raise ArgumentError, "argument must be true or false, or missing"
392       end
393     end
395     # Turn telnet command interpretation on (true) or off (false).  It
396     # should be on for true telnet sessions, off if using Net::Telnet
397     # to connect to a non-telnet service such as SMTP.
398     def telnetmode=(mode)
399       if (true == mode or false == mode)
400         @options["Telnetmode"] = mode
401       else
402         raise ArgumentError, "argument must be true or false"
403       end
404     end
406     # Turn newline conversion on (+mode+ == false) or off (+mode+ == true),
407     # or return the current value (+mode+ is not specified).
408     def binmode(mode = nil)
409       case mode
410       when nil
411         @options["Binmode"] 
412       when true, false
413         @options["Binmode"] = mode
414       else
415         raise ArgumentError, "argument must be true or false"
416       end
417     end
419     # Turn newline conversion on (false) or off (true).
420     def binmode=(mode)
421       if (true == mode or false == mode)
422         @options["Binmode"] = mode
423       else
424         raise ArgumentError, "argument must be true or false"
425       end
426     end
428     # Preprocess received data from the host.
429     #
430     # Performs newline conversion and detects telnet command sequences.
431     # Called automatically by #waitfor().  You should only use this 
432     # method yourself if you have read input directly using sysread()
433     # or similar, and even then only if in telnet mode.
434     def preprocess(string)
435       # combine CR+NULL into CR
436       string = string.gsub(/#{CR}#{NULL}/no, CR) if @options["Telnetmode"]
438       # combine EOL into "\n"
439       string = string.gsub(/#{EOL}/no, "\n") unless @options["Binmode"]
441       # remove NULL
442       string = string.gsub(/#{NULL}/no, '') unless @options["Binmode"]
444       string.gsub(/#{IAC}(
445                    [#{IAC}#{AO}#{AYT}#{DM}#{IP}#{NOP}]|
446                    [#{DO}#{DONT}#{WILL}#{WONT}]
447                      [#{OPT_BINARY}-#{OPT_NEW_ENVIRON}#{OPT_EXOPL}]|
448                    #{SB}[^#{IAC}]*#{IAC}#{SE}
449                  )/xno) do
450         if    IAC == $1  # handle escaped IAC characters
451           IAC
452         elsif AYT == $1  # respond to "IAC AYT" (are you there)
453           self.write("nobody here but us pigeons" + EOL)
454           ''
455         elsif DO[0] == $1[0]  # respond to "IAC DO x"
456           if OPT_BINARY[0] == $1[1]
457             @telnet_option["BINARY"] = true
458             self.write(IAC + WILL + OPT_BINARY)
459           else
460             self.write(IAC + WONT + $1[1..1])
461           end
462           ''
463         elsif DONT[0] == $1[0]  # respond to "IAC DON'T x" with "IAC WON'T x"
464           self.write(IAC + WONT + $1[1..1])
465           ''
466         elsif WILL[0] == $1[0]  # respond to "IAC WILL x"
467           if    OPT_BINARY[0] == $1[1]
468             self.write(IAC + DO + OPT_BINARY)
469           elsif OPT_ECHO[0] == $1[1]
470             self.write(IAC + DO + OPT_ECHO)
471           elsif OPT_SGA[0]  == $1[1]
472             @telnet_option["SGA"] = true
473             self.write(IAC + DO + OPT_SGA)
474           else
475             self.write(IAC + DONT + $1[1..1])
476           end
477           ''
478         elsif WONT[0] == $1[0]  # respond to "IAC WON'T x"
479           if    OPT_ECHO[0] == $1[1]
480             self.write(IAC + DONT + OPT_ECHO)
481           elsif OPT_SGA[0]  == $1[1]
482             @telnet_option["SGA"] = false
483             self.write(IAC + DONT + OPT_SGA)
484           else
485             self.write(IAC + DONT + $1[1..1])
486           end
487           ''
488         else
489           ''
490         end
491       end
492     end # preprocess
494     # Read data from the host until a certain sequence is matched.
495     #
496     # If a block is given, the received data will be yielded as it
497     # is read in (not necessarily all in one go), or nil if EOF 
498     # occurs before any data is received.  Whether a block is given
499     # or not, all data read will be returned in a single string, or again 
500     # nil if EOF occurs before any data is received.  Note that
501     # received data includes the matched sequence we were looking for.
502     #
503     # +options+ can be either a regular expression or a hash of options.
504     # If a regular expression, this specifies the data to wait for.
505     # If a hash, this can specify the following options:
506     #
507     # Match:: a regular expression, specifying the data to wait for.
508     # Prompt:: as for Match; used only if Match is not specified.
509     # String:: as for Match, except a string that will be converted
510     #          into a regular expression.  Used only if Match and
511     #          Prompt are not specified.
512     # Timeout:: the number of seconds to wait for data from the host
513     #           before raising a TimeoutError.  If set to false, 
514     #           no timeout will occur.  If not specified, the
515     #           Timeout option value specified when this instance
516     #           was created will be used, or, failing that, the
517     #           default value of 10 seconds.
518     # Waittime:: the number of seconds to wait after matching against
519     #            the input data to see if more data arrives.  If more
520     #            data arrives within this time, we will judge ourselves
521     #            not to have matched successfully, and will continue
522     #            trying to match.  If not specified, the Waittime option
523     #            value specified when this instance was created will be
524     #            used, or, failing that, the default value of 0 seconds,
525     #            which means not to wait for more input.
526     # FailEOF:: if true, when the remote end closes the connection then an
527     #           EOFError will be raised. Otherwise, defaults to the old
528     #           behaviour that the function will return whatever data
529     #           has been received already, or nil if nothing was received.
530     #           
531     def waitfor(options) # :yield: recvdata
532       time_out = @options["Timeout"]
533       waittime = @options["Waittime"]
534       fail_eof = @options["FailEOF"]
536       if options.kind_of?(Hash)
537         prompt   = if options.has_key?("Match")
538                      options["Match"]
539                    elsif options.has_key?("Prompt")
540                      options["Prompt"]
541                    elsif options.has_key?("String")
542                      Regexp.new( Regexp.quote(options["String"]) )
543                    end
544         time_out = options["Timeout"]  if options.has_key?("Timeout")
545         waittime = options["Waittime"] if options.has_key?("Waittime")
546         fail_eof = options["FailEOF"]  if options.has_key?("FailEOF")
547       else
548         prompt = options
549       end
551       if time_out == false
552         time_out = nil
553       end
555       line = ''
556       buf = ''
557       rest = ''
558       until(prompt === line and not IO::select([@sock], nil, nil, waittime))
559         unless IO::select([@sock], nil, nil, time_out)
560           raise TimeoutError, "timed out while waiting for more data"
561         end
562         begin
563           c = @sock.readpartial(1024 * 1024)
564           @dumplog.log_dump('<', c) if @options.has_key?("Dump_log")
565           if @options["Telnetmode"]
566             c = rest + c
567             if Integer(c.rindex(/#{IAC}#{SE}/no) || 0) <
568                Integer(c.rindex(/#{IAC}#{SB}/no) || 0)
569               buf = preprocess(c[0 ... c.rindex(/#{IAC}#{SB}/no)])
570               rest = c[c.rindex(/#{IAC}#{SB}/no) .. -1]
571             elsif pt = c.rindex(/#{IAC}[^#{IAC}#{AO}#{AYT}#{DM}#{IP}#{NOP}]?\z/no) ||
572                        c.rindex(/\r\z/no)
573               buf = preprocess(c[0 ... pt])
574               rest = c[pt .. -1]
575             else
576               buf = preprocess(c)
577               rest = ''
578             end
579          else
580            # Not Telnetmode.
581            #
582            # We cannot use preprocess() on this data, because that
583            # method makes some Telnetmode-specific assumptions.
584            buf = rest + c
585            rest = ''
586            unless @options["Binmode"]
587              if pt = buf.rindex(/\r\z/no)
588                buf = buf[0 ... pt]
589                rest = buf[pt .. -1]
590              end
591              buf.gsub!(/#{EOL}/no, "\n")
592            end
593           end
594           @log.print(buf) if @options.has_key?("Output_log")
595           line += buf
596           yield buf if block_given?
597         rescue EOFError # End of file reached
598           raise if fail_eof
599           if line == ''
600             line = nil
601             yield nil if block_given?
602           end
603           break
604         end
605       end
606       line
607     end
609     # Write +string+ to the host.
610     #
611     # Does not perform any conversions on +string+.  Will log +string+ to the
612     # dumplog, if the Dump_log option is set.
613     def write(string)
614       length = string.length
615       while 0 < length
616         IO::select(nil, [@sock])
617         @dumplog.log_dump('>', string[-length..-1]) if @options.has_key?("Dump_log")
618         length -= @sock.syswrite(string[-length..-1])
619       end
620     end
622     # Sends a string to the host.
623     #
624     # This does _not_ automatically append a newline to the string.  Embedded
625     # newlines may be converted and telnet command sequences escaped 
626     # depending upon the values of telnetmode, binmode, and telnet options
627     # set by the host.
628     def print(string)
629       string = string.gsub(/#{IAC}/no, IAC + IAC) if @options["Telnetmode"]
631       if @options["Binmode"]
632         self.write(string)
633       else
634         if @telnet_option["BINARY"] and @telnet_option["SGA"]
635           # IAC WILL SGA IAC DO BIN send EOL --> CR
636           self.write(string.gsub(/\n/n, CR))
637         elsif @telnet_option["SGA"]
638           # IAC WILL SGA send EOL --> CR+NULL
639           self.write(string.gsub(/\n/n, CR + NULL))
640         else
641           # NONE send EOL --> CR+LF
642           self.write(string.gsub(/\n/n, EOL))
643         end
644       end
645     end
647     # Sends a string to the host.
648     #
649     # Same as #print(), but appends a newline to the string.
650     def puts(string)
651       self.print(string + "\n")
652     end
654     # Send a command to the host.
655     #
656     # More exactly, sends a string to the host, and reads in all received
657     # data until is sees the prompt or other matched sequence.
658     #
659     # If a block is given, the received data will be yielded to it as
660     # it is read in.  Whether a block is given or not, the received data 
661     # will be return as a string.  Note that the received data includes
662     # the prompt and in most cases the host's echo of our command.
663     #
664     # +options+ is either a String, specified the string or command to
665     # send to the host; or it is a hash of options.  If a hash, the
666     # following options can be specified:
667     #
668     # String:: the command or other string to send to the host.
669     # Match:: a regular expression, the sequence to look for in
670     #         the received data before returning.  If not specified,
671     #         the Prompt option value specified when this instance
672     #         was created will be used, or, failing that, the default
673     #         prompt of /[$%#>] \z/n.
674     # Timeout:: the seconds to wait for data from the host before raising
675     #           a Timeout error.  If not specified, the Timeout option
676     #           value specified when this instance was created will be
677     #           used, or, failing that, the default value of 10 seconds.
678     #
679     # The command or other string will have the newline sequence appended
680     # to it.
681     def cmd(options) # :yield: recvdata
682       match    = @options["Prompt"]
683       time_out = @options["Timeout"]
685       if options.kind_of?(Hash)
686         string   = options["String"]
687         match    = options["Match"]   if options.has_key?("Match")
688         time_out = options["Timeout"] if options.has_key?("Timeout")
689       else
690         string = options
691       end
693       self.puts(string)
694       if block_given?
695         waitfor({"Prompt" => match, "Timeout" => time_out}){|c| yield c }
696       else
697         waitfor({"Prompt" => match, "Timeout" => time_out})
698       end
699     end
701     # Login to the host with a given username and password.
702     #
703     # The username and password can either be provided as two string
704     # arguments in that order, or as a hash with keys "Name" and
705     # "Password".    
706     #
707     # This method looks for the strings "login" and "Password" from the
708     # host to determine when to send the username and password.  If the
709     # login sequence does not follow this pattern (for instance, you
710     # are connecting to a service other than telnet), you will need
711     # to handle login yourself.
712     #
713     # The password can be omitted, either by only
714     # provided one String argument, which will be used as the username,
715     # or by providing a has that has no "Password" key.  In this case,
716     # the method will not look for the "Password:" prompt; if it is
717     # sent, it will have to be dealt with by later calls.
718     #
719     # The method returns all data received during the login process from
720     # the host, including the echoed username but not the password (which
721     # the host should not echo).  If a block is passed in, this received
722     # data is also yielded to the block as it is received.
723     def login(options, password = nil) # :yield: recvdata
724       login_prompt = /[Ll]ogin[: ]*\z/n
725       password_prompt = /[Pp]ass(?:word|phrase)[: ]*\z/n
726       if options.kind_of?(Hash)
727         username = options["Name"]
728         password = options["Password"]
729         login_prompt = options["LoginPrompt"] if options["LoginPrompt"]
730         password_prompt = options["PasswordPrompt"] if options["PasswordPrompt"]
731       else
732         username = options
733       end
735       if block_given?
736         line = waitfor(login_prompt){|c| yield c }
737         if password
738           line += cmd({"String" => username,
739                        "Match" => password_prompt}){|c| yield c }
740           line += cmd(password){|c| yield c }
741         else
742           line += cmd(username){|c| yield c }
743         end
744       else
745         line = waitfor(login_prompt)
746         if password
747           line += cmd({"String" => username,
748                        "Match" => password_prompt})
749           line += cmd(password)
750         else
751           line += cmd(username)
752         end
753       end
754       line
755     end
757   end  # class Telnet
758 end  # module Net