Chip 2000 May

home *** CD-ROM | disk | FTP | other *** search

/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _2c5f682724ac2283819ca3323ff43c3a < prev next >

Wrap

Text File | 2000-03-23 | 60KB | 1,299 lines

<HTML> <HEAD> <TITLE>Net::Telnet - interact with TELNET port or other TCP ports</TITLE> <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css"> <LINK REV="made" HREF="mailto:"> </HEAD> <BODY> <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%> <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc"> Net::Telnet - interact with TELNET port or other TCP ports </TD></TR> </TABLE> <A NAME="__index__"></A>  <UL> <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI> <LI><A HREF="#synopsis">SYNOPSIS</A></LI> <LI><A HREF="#description">DESCRIPTION</A></LI> <UL> <LI><A HREF="#what to know before using">What To Know Before Using</A></LI> <LI><A HREF="#debugging">Debugging</A></LI> <LI><A HREF="#style of named parameters">Style of Named Parameters</A></LI> <LI><A HREF="#connecting to a remote win32 machine">Connecting to a Remote Win32 Machine</A></LI> </UL> <LI><A HREF="#methods">METHODS</A></LI> <LI><A HREF="#see also">SEE ALSO</A></LI> <LI><A HREF="#examples">EXAMPLES</A></LI> <LI><A HREF="#author">AUTHOR</A></LI> <LI><A HREF="#copyright">COPYRIGHT</A></LI> </UL>  <HR> <H1><A NAME="name">NAME</A></H1> Net::Telnet - interact with TELNET port or other TCP ports <HR> <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1> <UL> <LI>Linux</LI> <LI>Solaris</LI> <LI>Windows</LI> </UL> <HR> <H1><A NAME="synopsis">SYNOPSIS</A></H1> <CODE>use Net::Telnet ();</CODE> see METHODS section below <HR> <H1><A NAME="description">DESCRIPTION</A></H1> Net::Telnet allows you to make client connections to a TCP port and do network I/O, especially to a port using the TELNET protocol. Simple I/O methods such as print, get, and getline are provided. More sophisticated interactive features are provided because connecting to a TELNET port ultimately means communicating with a program designed for human interaction. These interactive features include the ability to specify a timeout and to wait for patterns to appear in the input stream, such as the prompt from a shell. Other reasons to use this module than strictly with a TELNET port are: <UL> <LI> You're not familiar with sockets and you want a simple way to make client connections to TCP services. <LI> You want to be able to specify your own time-out while connecting, reading, or writing. <LI> You're communicating with an interactive program at the other end of some socket or pipe and you want to wait for certain patterns to appear. </UL> Here's an example that prints who's logged-on to the remote host sparky. In addition to a username and password, you must also know the user's shell prompt, which for this example is <CODE>bash$</CODE> <PRE> use Net::Telnet (); $t = new Net::Telnet (Timeout => 10, Prompt => '/bash\$ $/'); $t->open("sparky"); $t->login($username, $passwd); @lines = $t->cmd("/usr/bin/who"); print @lines;</PRE> More examples are in the EXAMPLES section below. <H2><A NAME="what to know before using">What To Know Before Using</A></H2> <UL> <LI> All output is flushed while all input is buffered. Each object contains an input buffer. <LI> The output record separator for <A HREF="../../../lib/Pod/perlfunc.html#item_print"><CODE>print()</CODE></A> and <CODE>cmd()</CODE> is set to <CODE>"\n"</CODE> by default, so that you don't have to append all your commands with a newline. See <A HREF="../../../lib/Pod/perlvar.html#item_output_record_separator"><CODE>output_record_separator()</CODE></A> to change the behavior. <LI> The methods <CODE>login()</CODE> and <CODE>cmd()</CODE> use the prompt setting in the object to determine when a login or remote command is complete. The method will fail with a time-out if you don't set the prompt correctly. <LI> To avoid unexpected backslash interpretation, always use single quotes instead of double quotes to construct a match operator argument for <CODE>prompt()</CODE> and <CODE>waitfor()</CODE> (e.g. <CODE>'/bash\$ $/'</CODE>). If you're constructing a DOS like file path, you'll need to use four backslashes to represent one (e.g. <CODE>'/c:\\\\users\\\\bill>$/i'</CODE>). Of course don't forget about regexp metacharacters like <CODE>.</CODE>, <CODE>[</CODE>, or <CODE>$</CODE>. You'll only need a single backslash to quote them. The anchor metacharacters <CODE>^</CODE> and <CODE>$</CODE> refer to positions in the input buffer. <LI> Errors such as timing-out are handled according to the errmode action. The default action is to print an error message to standard error and have the program die. Use <CODE>errmode()</CODE> to change the action. Using an errmode of <CODE>"return"</CODE> arranges for the error message to be saved and the offending method to return with an undefined value. You can obtain the error message using <CODE>errmsg()</CODE>. <LI> You'll need to be running at least Perl version 5.002 to use this module. This module does not require any libraries that don't already come with a standard Perl distribution. If you have the IO:: libraries installed then IO::Socket::INET is used as a base class, otherwise FileHandle is used. The IO:: libraries now come standard starting with perl5.004. <LI> In the input stream, each sequence of carriage return and line feed (i.e. <CODE>"\015\012"</CODE> or CR LF) is converted to <CODE>"\n"</CODE>. In the output stream, each occurrence of <CODE>"\n"</CODE> is converted to a sequence of CR LF. See <A HREF="../../../lib/Pod/perlfunc.html#item_binmode"><CODE>binmode()</CODE></A> to change the behavior. TCP protocols typically use the ASCII sequence, carriage return and line feed to designate a newline. <LI> Timing-out while making a connection is disabled for machines that don't support the <A HREF="../../../lib/Pod/perlfunc.html#item_alarm"><CODE>alarm()</CODE></A> function. Most notably these include Win32 machines. More universal support for connection time-outs will be in a later release. <LI> This is an alpha version - meaning that the interface may change in future versions. Contact me, Jay Rogers <<A HREF="mailto:jay@rgrs.com">jay@rgrs.com</A>>, if you find any bugs or have suggestions for improvement. </UL> <H2><A NAME="debugging">Debugging</A></H2> The typical bug causes a timeout error because you've made incorrect assumptions about what the remote side actually sends. The easiest way to reconcile what the remote side sends with your expectations is to use <CODE>input_log()</CODE> or <CODE>dump_log()</CODE>. <CODE>dump_log()</CODE> allows you to see the data being sent from the remote side before any translation is done, while <CODE>input_log()</CODE> shows you the results after translation. The translation includes converting end of line characters and stripping and responding to TELNET protocol commands. <H2><A NAME="style of named parameters">Style of Named Parameters</A></H2> Two different styles of named parameters are supported. This document only shows the IO:: style: <PRE> Net::Telnet->new(Timeout => 20);</PRE> however the dash-option style is also allowed: <PRE> Net::Telnet->new(-timeout => 20);</PRE> <H2><A NAME="connecting to a remote win32 machine">Connecting to a Remote Win32 Machine</A></H2> By default, Windows machines don't come with a TELNET service. However, third party TELNET servers can be acquired to provide access to a DOS shell. As is all too familiar, many of these servers are of inferior quality. One particularly nasty problem is a server that sends ANSI terminal escape sequences despite being told not to. These escape sequences make your job of parsing the data much more difficult. You can sometimes avoid this with a server that prompts you for console mode. Choose no to console mode. <HR> <H1><A NAME="methods">METHODS</A></H1> <DL> <DT><A NAME="item_new_%2D_create_a_new_Net%3A%3ATelnet_object">new - create a new Net::Telnet object</A> <DD> <PRE> $obj = Net::Telnet->new([Binmode => $mode,] [Cmd_remove_mode => $mode,] [Dump_Log => $filename,] [Errmode => $errmode,] [Fhopen => $filehandle,] [Host => $host,] [Input_log => $file,] [Input_record_separator => $char,] [Option_log => $file,] [Output_log => $file,] [Output_record_separator => $char,] [Port => $port,] [Prompt => $matchop,] [Telnetmode => $mode,] [Timeout => $secs,]);</PRE> This is the constructor for Net::Telnet objects. A new object is returned on success, the $errmode action is performed on failure - see <CODE>errmode()</CODE>. The arguments are short-cuts to methods of the same name. If the $host argument is given then the object is opened by connecting to TCP $port on $host. Also see <A HREF="../../../lib/Pod/perlfunc.html#item_open"><CODE>open()</CODE></A>. The new object returned is given the following defaults in the absence of corresponding named arguments: <DL> <DT><DD> The default Host is <CODE>"localhost"</CODE> <DT><DD> The default Port is <CODE>23</CODE> <DT><DD> The default Prompt is <CODE>'/[\$%#>] $/'</CODE> <DT><DD> The default Timeout is <CODE>10</CODE> <DT><DD> The default Errmode is <CODE>"die"</CODE> <DT><DD> The default Output_record_separator is <CODE>"\n"</CODE> <DT><DD> The default Input_record_separator is <CODE>"\n"</CODE> <DT><DD> The default Binmode is <CODE>0</CODE>, which means do newline translation <DT><DD> The default Cmd_remove_mode is <CODE>"auto"</CODE>. </DL> </DL> <DL> <DT><A NAME="item_binmode_%2D_toggle_newline_translation">binmode - toggle newline translation</A> <DD> <PRE> $mode = $obj->binmode;</PRE> <PRE> $prev = $obj->binmode($mode);</PRE> This method controls whether or not sequences of carriage returns and line feeds (CR LF or more specifically <CODE>"\015\012"</CODE>) are translated. By default they are translated (i.e. binmode is <CODE>0</CODE>). If no argument is given, the current mode is returned. If $mode is <CODE>1</CODE> then binmode is on and newline translation is not done. If $mode is <CODE>0</CODE> then binmode is off and newline translation is done. In the input stream, each sequence of CR LF is converted to <CODE>"\n"</CODE> and in the output stream, each occurrence of <CODE>"\n"</CODE> is converted to a sequence of CR LF. Note that input is always buffered. Changing binmode doesn't effect what's already been read into the buffer. Output is not buffered and changing binmode will have an immediate effect. </DL> <DL> <DT><A NAME="item_break_%2D_send_TELNET_break_character">break - send TELNET break character</A> <DD> <PRE> $ok = $obj->break;</PRE> This method sends the TELNET break character. This character is provided because it's a signal outside the USASCII character set which is currently given local meaning within many systems. It's intended to indicate that the Break Key or the Attention Key was hit. </DL> <DL> <DT><A NAME="item_buffer_%2D_scalar_reference_to_object%27s_input_bu">buffer - scalar reference to object's input buffer</A> <DD> <PRE> $ref = $obj->buffer;</PRE> This method returns a scalar reference to the input buffer for $obj. Data in the input buffer is data that has been read from the remote side but has yet to be read by the user. Modifications to the input buffer are returned by a subsequent read. </DL> <DL> <DT><A NAME="item_buffer_empty_%2D_discard_all_data_in_object%27s_in">buffer_empty - discard all data in object's input buffer</A> <DD> <PRE> $obj->buffer_empty;</PRE> This method removes all data in the input buffer for $obj. </DL> <DL> <DT><A NAME="item_close_%2D_close_object">close - close object</A> <DD> <PRE> $ok = $obj->close;</PRE> This method closes the socket, file, or pipe associated with the object. </DL> <DL> <DT><A NAME="item_cmd_%2D_issue_command_and_retrieve_output">cmd - issue command and retrieve output</A> <DD> <PRE> $ok = $obj->cmd($string); $ok = $obj->cmd(String => $string, [Output => $ref,] [Prompt => $match,] [Timeout => $secs,] [Cmd_remove_mode => $mode,]);</PRE> <PRE> @output = $obj->cmd($string); @output = $obj->cmd(String => $string, [Output => $ref,] [Prompt => $match,] [Timeout => $secs,] [Cmd_remove_mode => $mode,]);</PRE> This method sends the command $string, and reads the characters sent back by the command up until and including the matching prompt. It's assumed that the program to which you're sending is some kind of command prompting interpreter such as a shell. In a scalar context the characters read are discarded and a boolean is returned indicating the success or failure of sending the command string and reading the prompt. Note that in order to return on error, <CODE>errmode()</CODE> must not be set to <CODE>"die"</CODE>. In an array context, just the output generated by the command is returned, one line per element. In other words, all the characters in between the echoed back command string and the prompt are returned. If the command happens to return no output, an array containing one element, the null string is returned. This is so the array will indicate true in a boolean context. Many command interpreters echo back the command sent. In most situations, this method removes the first line returned from the remote side (i.e. the echoed back command). See <CODE>cmd_remove_mode()</CODE> for more control over this feature. Use <CODE>dump_log()</CODE> to debug when this method keeps timing-out and you don't think it should. Optional named arguments are provided to override the current settings of prompt, timeout, and cmd_remove_mode. The Output named argument provides an alternative method of receiving command output. If you pass a scalar reference, all the output (even if it contains multiple lines) is returned in the referenced scalar. If you pass an array or hash reference, the lines of output are returned in the referenced array or hash. </DL> <DL> <DT><A NAME="item_cmd_remove_mode_%2D_toggle_removal_of_echoed_comma">cmd_remove_mode - toggle removal of echoed commands</A> <DD> <PRE> $mode = $obj->cmd_remove_mode;</PRE> <PRE> $prev = $obj->cmd_remove_mode($mode);</PRE> This method controls how to deal with echoed back commands in the output returned by cmd(). Typically, when you send a command to the remote side, the first line of output returned is the command echoed back. Use this mode to remove the first line of output normally returned by cmd(). If no argument is given, the current mode is returned. If $mode is <CODE>0</CODE> then the command output returned from <CODE>cmd()</CODE> has no lines removed. If $mode is a positive integer, then the first $mode lines of command output are stripped. By default, $mode is set to <CODE>"auto"</CODE>. Auto means that whether or not the first line of command output is stripped, depends on whether or not the remote side offered to echo. By default, Net::Telnet always accepts an offer to echo by the remote side. You can change the default to reject such an offer using <CODE>option_accept()</CODE>. </DL> <DL> <DT><A NAME="item_dump_log_%2D_log_all_I%2FO_in_dump_format">dump_log - log all I/O in dump format</A> <DD> <PRE> $fh = $obj->dump_log;</PRE> <PRE> $fh = $obj->dump_log($fh);</PRE> <PRE> $fh = $obj->dump_log($filename);</PRE> This method starts or stops dump format logging of all the object's input and output. The dump format shows the blocks read and written in a hexadecimal and printable character format. This method is useful when debugging, however you might want to first try <CODE>input_log()</CODE> as it's more readable. If no argument is given, the current log filehandle is returned. A null string indicates logging is off. To stop logging, use a null string as an argument. If an open filehandle is given, it is used for logging and returned. Otherwise, the argument is assumed to be the name of a file, the file is opened and a filehandle to it is returned. </DL> <DL> <DT><A NAME="item_eof_%2D_end_of_file_indicator">eof - end of file indicator</A> <DD> <PRE> $eof = $obj->eof;</PRE> This method indicates if end of file has been read. Because the input is buffered this isn't the same thing as $obj has closed. In other words $obj can be closed but there still can be stuff in the buffer to be read. Under this condition you can still read but you won't be able to write. </DL> <DL> <DT><A NAME="item_errmode_%2D_define_action_to_be_performed_on_error">errmode - define action to be performed on error</A> <DD> <PRE> $mode = $obj->errmode;</PRE> <PRE> $prev = $obj->errmode($mode);</PRE> This method gets or sets the action used when errors are encountered using the object. The first calling sequence returns the current error mode. The second calling sequence sets it to $mode and returns the previous mode. Valid values for $mode are <CODE>"die"</CODE> (the default), <CODE>"return"</CODE>, a coderef, or an arrayref. When mode is <CODE>"die"</CODE> and an error is encountered using the object, then an error message is printed to standard error and the program dies. When mode is <CODE>"return"</CODE> then the method generating the error places an error message in the object and returns the undefined value in a scalar context and a null list in list context. The error message may be obtained using <CODE>errmsg()</CODE>. When mode is a coderef, then when an error is encountered coderef is called with the error message as its first argument. Using this mode you may have your own subroutine handle errors. If coderef itself returns then the method generating the error returns undefined or a null list depending on context. When mode is an arrayref, the first element of the array must be a coderef. Any elements that follow are the arguments to coderef. When an error is encountered, the coderef is called with its arguments. Using this mode you may have your own subroutine handle errors. If the coderef itself returns then the method generating the error returns undefined or a null list depending on context. </DL> <DL> <DT><A NAME="item_errmsg_%2D_most_recent_error_message">errmsg - most recent error message</A> <DD> <PRE> $msg = $obj->errmsg;</PRE> <PRE> $prev = $obj->errmsg(@msgs);</PRE> The first calling sequence returns the error message associated with the object. The null string is returned if no error has been encountered yet. The second calling sequence sets the error message for the object to the concatenation of @msgs and returns the previous error message. Normally, error messages are set internally by a method when an error is encountered. </DL> <DL> <DT><A NAME="item_error_%2D_perform_the_error_mode_action">error - perform the error mode action</A> <DD> <PRE> $obj->error(@msgs);</PRE> This method concatenates @msgs into a string and places it in the object as the error message. Also see <CODE>errmsg()</CODE>. It then performs the error mode. Also see <CODE>errmode()</CODE>. If the error mode doesn't cause the program to die then the undefined value or a null list is returned depending on context. This method is primarily used by this class or a sub-class to perform the user requested action when an error is encountered. </DL> <DL> <DT><A NAME="item_fhopen_%2D_use_already_open_filehandle_for_I%2FO">fhopen - use already open filehandle for I/O</A> <DD> <PRE> $ok = $obj->fhopen($fh);</PRE> This method associates the open filehandle $fh with $obj for further I/O. Filehandle $fh must already be opened. Suppose you want to use the features of this module to do I/O to something other than a TCP port, for example STDIN or a filehandle opened to read from a process. Instead of opening the object for I/O to a TCP port by using <A HREF="../../../lib/Pod/perlfunc.html#item_open"><CODE>open()</CODE></A> or <CODE>new()</CODE>, call this method instead. </DL> <DL> <DT><A NAME="item_get_%2D_read_block_of_data">get - read block of data</A> <DD> <PRE> $data = $obj->get([Timeout => $secs,]);</PRE> This method reads a block of data from the object and returns it along with any buffered data. If no buffered data is available to return, it will wait for data to read using the timeout specified in the object. You can override that timeout using $secs. Also see <CODE>timeout()</CODE>. If buffered data is available to return, it also checks for a block of data that can be immediately read. On eof an undefined value is returned. On time-out or other errors the error mode action is performed. An undefined value is returned for both eof and time-out when errmode is not set to <CODE>"die"</CODE>. Use <A HREF="../../../lib/Pod/perlfunc.html#item_eof"><CODE>eof()</CODE></A> and <CODE>timed_out()</CODE> to distinguish. </DL> <DL> <DT><A NAME="item_getline_%2D_read_next_line">getline - read next line</A> <DD> <PRE> $line = $obj->getline([Timeout => $secs,]);</PRE> This method reads and returns the next line of data from the object. You can use <A HREF="../../../lib/Pod/perlvar.html#item_input_record_separator"><CODE>input_record_separator()</CODE></A> to change the notion of what separates a line. The default is <CODE>"\n"</CODE>. If a line isn't immediately available, this method blocks waiting for a line or the timeout. You can override the object's timeout for this method using $secs. Also see <CODE>timeout()</CODE>. On eof an undefined value is returned. On timeout or other errors the error mode action is performed. An undefined value is returned for both eof and time-out when errmode is not set to <CODE>"die"</CODE>. Use <A HREF="../../../lib/Pod/perlfunc.html#item_eof"><CODE>eof()</CODE></A> and <CODE>timed_out()</CODE> to distinguish. </DL> <DL> <DT><A NAME="item_getlines_%2D_read_next_lines">getlines - read next lines</A> <DD> <PRE> @lines = $obj->getlines([Timeout => $secs,]);</PRE> This method reads and returns the next available lines of data from the object. You can use <A HREF="../../../lib/Pod/perlvar.html#item_input_record_separator"><CODE>input_record_separator()</CODE></A> to change the notion of what separates a line. The default is <CODE>"\n"</CODE>. If a line isn't immediately available, this method blocks waiting for one or more lines, or the timeout. You can override the object's timeout for this method using $secs. Also see <CODE>timeout()</CODE>. On eof a null array is returned. On timeout or other errors the error mode action is performed. A null array is returned for both eof and time-out when errmode is not set to <CODE>"die"</CODE>. Use <A HREF="../../../lib/Pod/perlfunc.html#item_eof"><CODE>eof()</CODE></A> and <CODE>timed_out()</CODE> to distinguish. </DL> <DL> <DT><A NAME="item_host_%2D_name_of_remote_host">host - name of remote host</A> <DD> <PRE> $host = $obj->host;</PRE> <PRE> $prev = $obj->host($host);</PRE> This method designates the remote host. With no argument this method returns the current host name set in the object. With an argument it sets the current host name to $host and returns the previous host name. You may indicate the remote host using either a hostname or an IP address. </DL> <DL> <DT><A NAME="item_input_log_%2D_log_all_input">input_log - log all input</A> <DD> <PRE> $fh = $obj->input_log;</PRE> <PRE> $fh = $obj->input_log($fh);</PRE> <PRE> $fh = $obj->input_log($filename);</PRE> This method starts or stops logging of input. This is useful when debugging. Also see <CODE>dump_log()</CODE>. Because most command interpreters echo back commands received, its likely all your output will also be in this log. Note that input logging occurs after newline translation. See <A HREF="../../../lib/Pod/perlfunc.html#item_binmode"><CODE>binmode()</CODE></A> for details on newline translation. If no argument is given, the log filehandle is returned. A null string indicates logging is off. To stop logging, use a null string as an argument. If an open filehandle is given, it is used for logging and returned. Otherwise, the argument is assumed to be the name of a file, the file is opened for logging and a filehandle to it is returned. </DL> <DL> <DT><A NAME="item_input_record_separator_%2D_input_line_delimiter">input_record_separator - input line delimiter</A> <DD> <PRE> $rs = $obj->input_record_separator;</PRE> <PRE> $prev = $obj->input_record_separator($rs);</PRE> This method designates the line delimiter for input. It's used with <CODE>getline()</CODE>, <CODE>getlines()</CODE>, and <CODE>cmd()</CODE> to determine lines in the input. With no argument this method returns the current input record separator set in the object. With an argument it sets the input record separator to $rs and returns the previous value. </DL> <DL> <DT><A NAME="item_lastline_%2D_last_line_read">lastline - last line read</A> <DD> <PRE> $line = $obj->lastline;</PRE> <PRE> $prev = $obj->lastline($line);</PRE> This method saves the last line read from the object. This may be a useful error message when the remote side abnormally closes the connection. Typically the remote side will print an error message before closing. With no argument this method returns the last line read from the object. With an argument it sets the last line read to $line and returns the previous value. Normally, only internal methods set the last line. </DL> <DL> <DT><A NAME="item_login_%2D_perform_standard_login">login - perform standard login</A> <DD> <PRE> $ok = $obj->login($username, $password);</PRE> <PRE> $ok = $obj->login(Name => $username, Password => $password, [Prompt => $match,] [Timeout => $secs,]);</PRE> This method performs a standard login by waiting for a login prompt and responding with $username, then waiting for the password prompt and responding with $password, and then waiting for the command interpreter prompt. If any of those prompts sent by the remote side don't match what's expected, this method will timeout - unless timeout is turned off. Login prompts must match either of the patterns: <PRE> /login[: ]*$/i /username[: ]*$/i</PRE> Password prompts must match the pattern: <PRE> /password[: ]*$/i</PRE> The command interpreter prompt must match the current setting of prompt. Use <CODE>dump_log()</CODE> to debug when this method keeps timing-out and you don't think it should. Optional named arguments are provided to override the current settings of prompt and timeout. </DL> <DL> <DT><A NAME="item_max_buffer_length_%2D_maximum_size_of_input_buffer">max_buffer_length - maximum size of input buffer</A> <DD> <PRE> $len = $obj->max_buffer_length;</PRE> <PRE> $prev = $obj->max_buffer_length($len);</PRE> This method designates the maximum size of the input buffer. An error is generated when a read causes the buffer to exceed this limit. The default value is 1,048,576 bytes (1MB). The input buffer can grow much larger than the block size when you continuously read using <CODE>getline()</CODE> or <CODE>waitfor()</CODE> and the data stream contains no newlines or matching waitfor patterns. With no argument this method returns the current maximum buffer length set in the object. With an argument it sets the maximum buffer length to $len and returns the previous value. </DL> <DL> <DT><A NAME="item_open_%2D_connect_to_port_on_remote_host">open - connect to port on remote host</A> <DD> <PRE> $ok = $obj->open($host);</PRE> <PRE> $ok = $obj->open([Host => $host,] [Port => $port,] [Timeout => $secs,]);</PRE> This method opens a TCP connection to $port on $host. If either argument is missing then the current value of <CODE>host()</CODE> or <CODE>port()</CODE> is used. An optional named argument is provided to override the current setting of timeout. On time-out or other connection errors, the error mode action is performed. Timeouts don't work for this method on machines that don't implement SIGALRM - most notably Win32 machines. For those machines, an error is returned when the system reaches its own time-out while trying to connect. A side effect of this method is to reset the alarm interval associated with SIGALRM. </DL> <DL> <DT><A NAME="item_option_accept_%2D_indicate_willingness_to_accept_a">option_accept - indicate willingness to accept a TELNET option</A> <DD> <PRE> $fh = $obj->option_accept([Do => $telopt,] [Dont => $telopt,] [Will => $telopt,] [Wont => $telopt,]);</PRE> This method is used to indicate whether to accept or reject an offer to enable a TELNET option made by the remote side. If you're using Do or Will to indicate a willingness to enable, then a notification callback must have already been defined by a prior call to <CODE>option_callback()</CODE>. See <CODE>option_callback()</CODE> for details on receiving enable/disable notification of a TELNET option. You can give multiple Do, Dont, Will, or Wont arguments for different TELNET options in the same call to this method. The following example describes the meaning of the named arguments. A TELNET option, such as <CODE>TELOPT_ECHO</CODE> used below, is an integer constant that you can import from Net::Telnet. See the source in file Telnet.pm for the complete list. <DL> <DT><DD> Do => <CODE>TELOPT_ECHO</CODE> <DL> <DT><DD> we'll accept an offer to enable the echo option on the local side </DL> <DT><DD> Dont => <CODE>TELOPT_ECHO</CODE> <DL> <DT><DD> we'll reject an offer to enable the echo option on the local side </DL> <DT><DD> Will => <CODE>TELOPT_ECHO</CODE> <DL> <DT><DD> we'll accept an offer to enable the echo option on the remote side </DL> <DT><DD> Wont => <CODE>TELOPT_ECHO</CODE> <DL> <DT><DD> we'll reject an offer to enable the echo option on the remote side </DL> </DL> <DT><DD> Use <CODE>option_send()</CODE> to send a request to the remote side to enable or disable a particular TELNET option. </DL> <DL> <DT><A NAME="item_option_callback_%2D_define_the_option_negotiation_">option_callback - define the option negotiation callback</A> <DD> <PRE> $coderef = $obj->option_callback;</PRE> <PRE> $prev = $obj->option_callback($coderef);</PRE> This method defines the callback subroutine that's called when a TELNET option is enabled or disabled. Once defined, the option_callback may not be undefined. However, calling this method with a different $coderef changes it. Here are the circumstances that invoke $coderef: <DL> <DT><DD> An option becomes enabled because the remote side requested an enable and <CODE>option_accept()</CODE> had been used to arrange that it be accepted. <DT><DD> The remote side arbitrarily decides to disable an option that is currently enabled. Note that Net::Telnet always accepts a request to disable from the remote side. <DT><DD> <CODE>option_send()</CODE> was used to send a request to enable or disable an option and the response from the remote side has just been received. Note, that if a request to enable is rejected then $coderef is still invoked even though the option didn't change. </DL> <DT><DD> Here are the arguments passed to &$coderef: <PRE> &$coderef($obj, $option, $is_remote, $is_enabled, $was_enabled, $buf_position);</PRE> <DL> <DT><DD> 1. $obj is the Net::Telnet object <DT><DD> 2. $option is the TELNET option. Net::Telnet exports constants for the various TELNET options which just equate to an integer. <DT><DD> 3. $is_remote is a boolean indicating for which side the option applies. <DT><DD> 4. $is_enabled is a boolean indicating the option is enabled or disabled <DT><DD> 5. $was_enabled is a boolean indicating the option was previously enabled or disabled <DT><DD> 6. $buf_position is an integer indicating the position in the object's input buffer where the option takes effect. See <CODE>buffer()</CODE> to access the object's input buffer. </DL> </DL> <DL> <DT><A NAME="item_option_log_%2D_log_all_TELNET_options_sent_or_rece">option_log - log all TELNET options sent or received</A> <DD> <PRE> $fh = $obj->option_log;</PRE> <PRE> $fh = $obj->option_log($fh);</PRE> <PRE> $fh = $obj->option_log($filename);</PRE> This method starts or stops logging of all TELNET options being sent or received. This is useful for debugging when you send options via <CODE>option_send()</CODE> or you arrange to accept option requests from the remote side via <CODE>option_accept()</CODE>. Also see <CODE>dump_log()</CODE>. If no argument is given, the log filehandle is returned. A null string indicates logging is off. To stop logging, use a null string as an argument. If an open filehandle is given, it is used for logging and returned. Otherwise, the argument is assumed to be the name of a file, the file is opened for logging and a filehandle to it is returned. </DL> <DL> <DT><A NAME="item_option_send_%2D_send_TELNET_option_negotiation_req">option_send - send TELNET option negotiation request</A> <DD> <PRE> $ok = $obj->option_send([Do => $telopt,] [Dont => $telopt,] [Will => $telopt,] [Wont => $telopt,] [Async => $boolean,]);</PRE> This method is not yet implemented. Look for it in a future version. </DL> <DL> <DT><A NAME="item_option_state_%2D_get_current_state_of_a_TELNET_opt">option_state - get current state of a TELNET option</A> <DD> <PRE> $hashref = $obj->option_state($telopt);</PRE> This method returns a hashref containing a copy of the current state of TELNET option $telopt. Here are the values returned in the hash: <DL> <DT><DD> $hashref->{remote_enabled} <DL> <DT><DD> boolean that indicates if the option is enabled on the remote side. </DL> <DT><DD> $hashref->{remote_enable_ok} <DL> <DT><DD> boolean that indicates if it's ok to accept an offer to enable this option on the remote side. </DL> <DT><DD> $hashref->{remote_state} <DL> <DT><DD> string used to hold the internal state of option negotiation for this option on the remote side. </DL> <DT><DD> $hashref->{local_enabled} <DL> <DT><DD> boolean that indicates if the option is enabled on the local side. </DL> <DT><DD> $hashref->{local_enable_ok} <DL> <DT><DD> boolean that indicates if it's ok to accept an offer to enable this option on the local side. </DL> <DT><DD> $hashref->{local_state} <DL> <DT><DD> string used to hold the internal state of option negotiation for this option on the local side. </DL> </DL> </DL> <DL> <DT><A NAME="item_output_field_separator_%2D_field_separator_for_pri">output_field_separator - field separator for print</A> <DD> <PRE> $ofs = $obj->output_field_separator;</PRE> <PRE> $prev = $obj->output_field_separator($ofs);</PRE> This method designates the output field separator for <A HREF="../../../lib/Pod/perlfunc.html#item_print"><CODE>print()</CODE></A>. Ordinarily the print method simply prints out the comma separated fields you specify. Set this to specify what's printed between fields. With no argument this method returns the current output field separator set in the object. With an argument it sets the output field separator to $ofs and returns the previous value. </DL> <DL> <DT><A NAME="item_output_log_%2D_log_all_output">output_log - log all output</A> <DD> <PRE> $fh = $obj->output_log;</PRE> <PRE> $fh = $obj->output_log($fh);</PRE> <PRE> $fh = $obj->output_log($filename);</PRE> This method starts or stops logging of output. This is useful when debugging. Also see <CODE>dump_log()</CODE>. Because most command interpreters echo back commands received, its likely all your output would also be in an input log. See <CODE>input_log()</CODE>. Note that output logging occurs before newline translation. See <A HREF="../../../lib/Pod/perlfunc.html#item_binmode"><CODE>binmode()</CODE></A> for details on newline translation. If no argument is given, the log filehandle is returned. A null string indicates logging is off. To stop logging, use a null string as an argument. If an open filehandle is given, it is used for logging and returned. Otherwise, the argument is assumed to be the name of a file, the file is opened for logging and a filehandle to it is returned. </DL> <DL> <DT><A NAME="item_output_record_separator_%2D_output_line_delimiter">output_record_separator - output line delimiter</A> <DD> <PRE> $ors = $obj->output_record_separator;</PRE> <PRE> $prev = $obj->output_record_separator($ors);</PRE> This method designates the output record separator for <A HREF="../../../lib/Pod/perlfunc.html#item_print"><CODE>print()</CODE></A>. Ordinarily the print operator simply prints out the comma separated fields you specify, with no trailing newline or record separator assumed. Set this variable to specify what's printed at the end of the print. Note: the output record separator is set to <CODE>"\n"</CODE> by default, so there's no need to append all your commands with a newline. With no argument this method returns the current output record separator set in the object. With an argument it sets the output record separator to $ors and returns the previous value. </DL> <DL> <DT><A NAME="item_port_%2D_remote_port">port - remote port</A> <DD> <PRE> $port = $obj->port;</PRE> <PRE> $prev = $obj->port($port);</PRE> This method designates the remote TCP port. With no argument this method returns the current port number. With an argument it sets the current port number to $port and returns the previous port. If $port is a service name, then first it's converted to a port number using the perl function <A HREF="../../../lib/Pod/perlfunc.html#item_getservbyname"><CODE>getservbyname()</CODE></A>. </DL> <DL> <DT><A NAME="item_print_%2D_write_to_object">print - write to object</A> <DD> <PRE> $ok = $obj->print(@list);</PRE> This method prints a string or a comma-separated list of strings to the opened object and returns non-zero if all data was successfully written. By default, the <A HREF="../../../lib/Pod/perlvar.html#item_output_record_separator"><CODE>output_record_separator()</CODE></A> is set to <CODE>"\n"</CODE> in order to have your commands automatically end with a newline. In most cases your output is being read by a command interpreter which won't accept a command until newline is read. This is similar to someone typing a command and hitting the return key. On failure, it's possible that some data was written. If you choose to try and recover from a print timing-out, use <CODE>print_length()</CODE> to determine how much was written before time-out occurred. </DL> <DL> <DT><A NAME="item_print_length_%2D_number_of_bytes_written_by_print">print_length - number of bytes written by print</A> <DD> <PRE> $num = $obj->print_length;</PRE> This returns the number of bytes successfully written by the most recent <A HREF="../../../lib/Pod/perlfunc.html#item_print"><CODE>print()</CODE></A>. </DL> <DL> <DT><A NAME="item_prompt_%2D_pattern_to_match_a_prompt">prompt - pattern to match a prompt</A> <DD> <PRE> $matchop = $obj->prompt;</PRE> <PRE> $prev = $obj->prompt($matchop);</PRE> This method sets the pattern used to find a prompt in the input stream. It must be a string representing a valid perl pattern match operator. The methods <CODE>login()</CODE> and <CODE>cmd()</CODE> try to read until matching the prompt. They will fail with a time-out error if the pattern you've chosen doesn't match what the remote side sends. With no argument this method returns the prompt set in the object. With an argument it sets the prompt to $matchop and returns the previous value. The default prompt is <CODE>'/[\$%#>] $/'</CODE> Always use single quotes, instead of double quotes, to construct $matchop (e.g. <CODE>'/bash\$ $/'</CODE>). If you're constructing a DOS like file path, you'll need to use four backslashes to represent one (e.g. <CODE>'/c:\\\\users\\\\bill>$/i'</CODE>). Of course don't forget about regexp metacharacters like <CODE>.</CODE>, <CODE>[</CODE>, or <CODE>$</CODE>. You'll only need a single backslash to quote them. The anchor metacharacters <CODE>^</CODE> and <CODE>$</CODE> refer to positions in the input buffer. </DL> <DL> <DT><A NAME="item_telnetmode_%2D_turn_off%2Fon_telnet_command_interp">telnetmode - turn off/on telnet command interpretation</A> <DD> <PRE> $mode = $obj->telnetmode;</PRE> <PRE> $prev = $obj->telnetmode($mode);</PRE> This method controls whether or not TELNET commands in the data stream are recognized and handled. The TELNET protocol uses certain character sequences sent in the data stream to control the session. If the port you're connecting to isn't using the TELNET protocol, then you should turn this mode off. The default is on. If no argument is given, the current mode is returned. If $mode is <CODE>0</CODE> then telnet mode is off. If $mode is <CODE>1</CODE> then telnet mode is on. </DL> <DL> <DT><A NAME="item_timed_out_%2D_time%2Dout_indicator">timed_out - time-out indicator</A> <DD> <PRE> $boolean = $obj->timed_out;</PRE> <PRE> $prev = $obj->timed_out($boolean);</PRE> This method indicates if a previous read or write method timed-out. With no argument this method returns true if a previous method timed-out. With an argument it sets the indicator. Normally, only internal methods set this indicator. </DL> <DL> <DT><A NAME="item_timeout_%2D_I%2FO_time%2Dout_interval">timeout - I/O time-out interval</A> <DD> <PRE> $secs = $obj->timeout;</PRE> <PRE> $prev = $obj->timeout($secs);</PRE> This method sets the timeout interval that's used when performing I/O or connecting to a port. When a method doesn't complete within the timeout interval then it's an error and the error mode action is performed. The timeout may be expressed as a relative or absolute value. If $secs is greater than or equal to the time the program was started, as determined by $^T, then it's the absolute time when timeout occurs. Also see the perl function <A HREF="../../../lib/Pod/perlfunc.html#item_time"><CODE>time()</CODE></A>. A relative timeout happens $secs from when the I/O method begins. If $secs is <CODE>0</CODE> then timeout occurs if the data cannot be immediately read or written. Use the undefined value to turn off timing-out. With no argument this method returns the timeout set in the object. With an argument it sets the timeout to $secs and returns the previous value. </DL> <DL> <DT><A NAME="item_waitfor_%2D_wait_for_pattern_in_the_input">waitfor - wait for pattern in the input</A> <DD> <PRE> $ok = $obj->waitfor($matchop); $ok = $obj->waitfor([Match => $matchop,] [String => $string,] [Timeout => $secs,]);</PRE> <PRE> ($prematch, $match) = $obj->waitfor($matchop); ($prematch, $match) = $obj->waitfor([Match => $matchop,] [String => $string,] [Timeout => $secs,]);</PRE> This method reads until a pattern match or string is found in the input stream. All the characters before and including the match are removed from the input stream. On time-out, eof, or other errors the error mode action is performed. In an array context the characters before the match and the matched characters are returned in $prematch and $match. You can specify more than one pattern or string by simply providing multiple Match and/or String named arguments. A $matchop must be a string representing a valid Perl pattern match operator. The $string is just a substring to find in the input stream. Use <CODE>dump_log()</CODE> to debug when this method keeps timing-out and you don't think it should. An optional named argument is provided to override the current setting of timeout. To avoid unexpected backslash interpretation, always use single quotes instead of double quotes to construct a match operator argument for <CODE>prompt()</CODE> and <CODE>waitfor()</CODE> (e.g. <CODE>'/bash\$ $/'</CODE>). If you're constructing a DOS like file path, you'll need to use four backslashes to represent one (e.g. <CODE>'/c:\\\\users\\\\bill>$/i'</CODE>). Of course don't forget about regexp metacharacters like <CODE>.</CODE>, <CODE>[</CODE>, or <CODE>$</CODE>. You'll only need a single backslash to quote them. The anchor metacharacters <CODE>^</CODE> and <CODE>$</CODE> refer to positions in the input buffer. </DL> <HR> <H1><A NAME="see also">SEE ALSO</A></H1> <DL> <DT><A NAME="item_RFC_854">RFC 854</A> <DD> TELNET Protocol Specification <A HREF="ftp://ftp.isi.edu/in-notes/rfc854.txt">ftp://ftp.isi.edu/in-notes/rfc854.txt</A> <DT><A NAME="item_RFC_1143">RFC 1143</A> <DD> Q Method of Implementing TELNET Option Negotiation <A HREF="ftp://ftp.isi.edu/in-notes/rfc1143.txt">ftp://ftp.isi.edu/in-notes/rfc1143.txt</A> <DT><A NAME="item_TELNET_Option_Assignments">TELNET Option Assignments</A> <DD> <A HREF="ftp://ftp.isi.edu/in-notes/iana/assignments/telnet-options">ftp://ftp.isi.edu/in-notes/iana/assignments/telnet-options</A> </DL> <HR> <H1><A NAME="examples">EXAMPLES</A></H1> This example gets the current weather forecast for Brainerd, Minnesota. <PRE> my($forecast, $t);</PRE> <PRE> use Net::Telnet (); $t = new Net::Telnet; $t->open("rainmaker.wunderground.com");</PRE> <PRE> ## Wait for first prompt and "hit return". $t->waitfor('/continue:.*$/'); $t->print("");</PRE> <PRE> ## Wait for second prompt and respond with city code. $t->waitfor('/city code.*$/'); $t->print("BRD");</PRE> <PRE> ## Read and print the first page of forecast. ($forecast) = $t->waitfor('/[ \t]+press return to continue/i'); print $forecast;</PRE> <PRE> exit;</PRE> This example checks a POP server to see if you have mail. <PRE> my($hostname, $line, $passwd, $pop, $username);</PRE> <PRE> $hostname = "your_destination_host_here"; $username = "your_username_here"; $passwd = "your_password_here";</PRE> <PRE> use Net::Telnet (); $pop = new Net::Telnet (Telnetmode => 0); $pop->open(Host => $hostname, Port => 110);</PRE> <PRE> ## Read connection message. $line = $pop->getline; die $line unless $line =~ /^\+OK/;</PRE> <PRE> ## Send user name. $pop->print("user $username"); $line = $pop->getline; die $line unless $line =~ /^\+OK/;</PRE> <PRE> ## Send password. $pop->print("pass $passwd"); $line = $pop->getline; die $line unless $line =~ /^\+OK/;</PRE> <PRE> ## Request status of messages. $pop->print("list"); $line = $pop->getline; print $line;</PRE> <PRE> exit;</PRE> Here's an example you can use to down load a file of any type. The file is read from the remote host's standard output using cat. To prevent any output processing, the remote host's standard output is put in raw mode using the Bourne shell. The Bourne shell is used because some shells, notably tcsh, prevent changing tty modes. Upon completion, FTP style statistics are printed to stderr. <PRE> my($block, $filename, $host, $hostname, $k_per_sec, $line, $num_read, $passwd, $prevblock, $prompt, $size, $size_bsd, $size_sysv, $start_time, $total_time, $username);</PRE> <PRE> $hostname = "your_destination_host_here"; $username = "your_username_here"; $passwd = "your_password_here"; $filename = "your_download_file_here";</PRE> <PRE> ## Connect and login. use Net::Telnet (); $host = new Net::Telnet (Timeout => 30, Prompt => '/[%#>] $/'); $host->open($hostname); $host->login($username, $passwd);</PRE> <PRE> ## Make sure prompt won't match anything in send data. $prompt = '_funkyPrompt_'; $host->prompt("/$prompt\$/"); $host->cmd("set prompt = '$prompt'");</PRE> <PRE> ## Get size of file. ($line) = $host->cmd("/usr/bin/ls -l $filename"); ($size_bsd, $size_sysv) = (split ' ', $line)[3,4]; if ($size_sysv =~ /^\d+$/) { $size = $size_sysv; } elsif ($size_bsd =~ /^\d+$/) { $size = $size_bsd; } else { die "$filename: no such file on $hostname"; }</PRE> <PRE> ## Start sending the file. binmode STDOUT; $host->binmode(1); $host->print("/usr/bin/sh -c 'stty raw; cat $filename'"); $host->getline; # discard echoed back line</PRE> <PRE> ## Read file a block at a time. $num_read = 0; $prevblock = ''; $start_time = time; while (($block = $host->get) and ($block !~ /$prompt$/o)) { if (length $block >= length $prompt) { print $prevblock; $num_read += length $prevblock; $prevblock = $block; } else { $prevblock .= $block; }</PRE> <PRE> } $host->close;</PRE> <PRE> ## Print last block without trailing prompt. $prevblock .= $block; $prevblock =~ s/$prompt$//; print $prevblock; $num_read += length $prevblock; die "error: expected size $size, received size $num_read\n" unless $num_read == $size;</PRE> <PRE> ## Print totals. $total_time = (time - $start_time) || 1; $k_per_sec = ($size / 1024) / $total_time; $k_per_sec = sprintf "%3.1f", $k_per_sec; warn("$num_read bytes received in $total_time seconds ", "($k_per_sec Kbytes/s)\n");</PRE> <PRE> exit;</PRE> Here's an example that shows how to talk to a program that must communicate via a terminal. In this case we're talking to the telnet program via a pseudo-terminal. We use the Comm package to start the telnet program and return a filehandle to the pseudo-terminal. This example sends some initial commands and then allows the user to type commands to the telnet session. <PRE> my($comm_pty, $host, $hostname, $passwd, $pty, $username, @lines);</PRE> <PRE> $hostname = "your_host_here"; $username = "your_name_here"; $passwd = "your_passwd_here";</PRE> <PRE> ## Start the telnet program so we can talk to it via a ## pseudo-terminal. { local $^W = 0; # Comm.pl isn't warning clean</PRE> <PRE> require "Comm.pl"; &Comm::init("close_it", "interact", "open_proc", "stty_raw", "stty_sane"); $comm_pty = &open_proc("telnet $hostname") or die "open_proc failed";</PRE> <PRE> ## Unfortunately the Comm package doesn't ## return us a fully qualified filehandle. We ## must keep the filehandle Comm returned for ## its use and we must build another filehandle ## qualified with the current package for our ## use. $pty = "main::" . $comm_pty; }</PRE> <PRE> ## Obtain a new Net::Telnet object that does I/O to the ## pseudo-terminal attached to the running telnet ## program. The "Telnetmode" is "off" because we're ## not talking directly to a telnet port as we normally ## do, we're talking to a pseudo-terminal. The ## "Output_record_separator" is now a carriage return ## because that's what you'd normally hit when you get ## done typing a line at a terminal. use Net::Telnet (); $host = new Net::Telnet (Fhopen => $pty, Timeout => 10, Prompt => '/[\$%#>] $/', Output_record_separator => "\r", Telnetmode => 0, Cmd_remove_mode => 1);</PRE> <PRE> ## Issue some commands. $host->login($username, $passwd); $host->cmd("setenv DISPLAY $ENV{DISPLAY}"); print $host->cmd("who");</PRE> <PRE> ## Allow the user to interact with telnet program until ## they exit. { no strict 'subs'; # so we can refer to STDIN local $^W = 0; # Comm.pl isn't warning clean</PRE> <PRE> &stty_raw(STDIN); &interact($comm_pty); &stty_sane(STDIN); &close_it($comm_pty); }</PRE> <PRE> print "Exited telnet\n"; exit;</PRE> <HR> <H1><A NAME="author">AUTHOR</A></H1> Jay Rogers <<A HREF="mailto:jay@rgrs.com">jay@rgrs.com</A>> <HR> <H1><A NAME="copyright">COPYRIGHT</A></H1> Copyright (c) 1997 Jay Rogers. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%> <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc"> Net::Telnet - interact with TELNET port or other TCP ports </TD></TR> </TABLE> </BODY> </HTML>