home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2006 January / Gamestar_80_2006-01_dvd.iso / Dema / Civilization4 / data1.cab / Civ4DemoComponent / Assets / Python / System / telnetlib.pyc (.txt) < prev    next >
Encoding:
Python Compiled Bytecode  |  2005-11-09  |  19.3 KB  |  720 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.4)
  3.  
  4. '''TELNET client class.
  5.  
  6. Based on RFC 854: TELNET Protocol Specification, by J. Postel and
  7. J. Reynolds
  8.  
  9. Example:
  10.  
  11. >>> from telnetlib import Telnet
  12. >>> tn = Telnet(\'www.python.org\', 79)   # connect to finger port
  13. >>> tn.write(\'guido\r
  14. \')
  15. >>> print tn.read_all()
  16. Login       Name               TTY         Idle    When    Where
  17. guido    Guido van Rossum      pts/2        <Dec  2 11:10> snag.cnri.reston..
  18.  
  19. >>>
  20.  
  21. Note that read_all() won\'t read until eof -- it just reads some data
  22. -- but it guarantees to read at least one byte unless EOF is hit.
  23.  
  24. It is possible to pass a Telnet object to select.select() in order to
  25. wait until more data is available.  Note that in this case,
  26. read_eager() may return \'\' even if there was data on the socket,
  27. because the protocol negotiation may have eaten the data.  This is why
  28. EOFError is needed in some cases to distinguish between "no data" and
  29. "connection closed" (since the socket also appears ready for reading
  30. when it is closed).
  31.  
  32. To do:
  33. - option negotiation
  34. - timeout should be intrinsic to the connection object instead of an
  35.   option on one of the read calls only
  36.  
  37. '''
  38. import sys
  39. import socket
  40. import select
  41. __all__ = [
  42.     'Telnet']
  43. DEBUGLEVEL = 0
  44. TELNET_PORT = 23
  45. IAC = chr(255)
  46. DONT = chr(254)
  47. DO = chr(253)
  48. WONT = chr(252)
  49. WILL = chr(251)
  50. theNULL = chr(0)
  51. SE = chr(240)
  52. NOP = chr(241)
  53. DM = chr(242)
  54. BRK = chr(243)
  55. IP = chr(244)
  56. AO = chr(245)
  57. AYT = chr(246)
  58. EC = chr(247)
  59. EL = chr(248)
  60. GA = chr(249)
  61. SB = chr(250)
  62. BINARY = chr(0)
  63. ECHO = chr(1)
  64. RCP = chr(2)
  65. SGA = chr(3)
  66. NAMS = chr(4)
  67. STATUS = chr(5)
  68. TM = chr(6)
  69. RCTE = chr(7)
  70. NAOL = chr(8)
  71. NAOP = chr(9)
  72. NAOCRD = chr(10)
  73. NAOHTS = chr(11)
  74. NAOHTD = chr(12)
  75. NAOFFD = chr(13)
  76. NAOVTS = chr(14)
  77. NAOVTD = chr(15)
  78. NAOLFD = chr(16)
  79. XASCII = chr(17)
  80. LOGOUT = chr(18)
  81. BM = chr(19)
  82. DET = chr(20)
  83. SUPDUP = chr(21)
  84. SUPDUPOUTPUT = chr(22)
  85. SNDLOC = chr(23)
  86. TTYPE = chr(24)
  87. EOR = chr(25)
  88. TUID = chr(26)
  89. OUTMRK = chr(27)
  90. TTYLOC = chr(28)
  91. VT3270REGIME = chr(29)
  92. X3PAD = chr(30)
  93. NAWS = chr(31)
  94. TSPEED = chr(32)
  95. LFLOW = chr(33)
  96. LINEMODE = chr(34)
  97. XDISPLOC = chr(35)
  98. OLD_ENVIRON = chr(36)
  99. AUTHENTICATION = chr(37)
  100. ENCRYPT = chr(38)
  101. NEW_ENVIRON = chr(39)
  102. TN3270E = chr(40)
  103. XAUTH = chr(41)
  104. CHARSET = chr(42)
  105. RSP = chr(43)
  106. COM_PORT_OPTION = chr(44)
  107. SUPPRESS_LOCAL_ECHO = chr(45)
  108. TLS = chr(46)
  109. KERMIT = chr(47)
  110. SEND_URL = chr(48)
  111. FORWARD_X = chr(49)
  112. PRAGMA_LOGON = chr(138)
  113. SSPI_LOGON = chr(139)
  114. PRAGMA_HEARTBEAT = chr(140)
  115. EXOPL = chr(255)
  116. NOOPT = chr(0)
  117.  
  118. class Telnet:
  119.     """Telnet interface class.
  120.  
  121.     An instance of this class represents a connection to a telnet
  122.     server.  The instance is initially not connected; the open()
  123.     method must be used to establish a connection.  Alternatively, the
  124.     host name and optional port number can be passed to the
  125.     constructor, too.
  126.  
  127.     Don't try to reopen an already connected instance.
  128.  
  129.     This class has many read_*() methods.  Note that some of them
  130.     raise EOFError when the end of the connection is read, because
  131.     they can return an empty string for other reasons.  See the
  132.     individual doc strings.
  133.  
  134.     read_until(expected, [timeout])
  135.         Read until the expected string has been seen, or a timeout is
  136.         hit (default is no timeout); may block.
  137.  
  138.     read_all()
  139.         Read all data until EOF; may block.
  140.  
  141.     read_some()
  142.         Read at least one byte or EOF; may block.
  143.  
  144.     read_very_eager()
  145.         Read all data available already queued or on the socket,
  146.         without blocking.
  147.  
  148.     read_eager()
  149.         Read either data already queued or some data available on the
  150.         socket, without blocking.
  151.  
  152.     read_lazy()
  153.         Read all data in the raw queue (processing it first), without
  154.         doing any socket I/O.
  155.  
  156.     read_very_lazy()
  157.         Reads all data in the cooked queue, without doing any socket
  158.         I/O.
  159.  
  160.     read_sb_data()
  161.         Reads available data between SB ... SE sequence. Don't block.
  162.  
  163.     set_option_negotiation_callback(callback)
  164.         Each time a telnet option is read on the input flow, this callback
  165.         (if set) is called with the following parameters :
  166.         callback(telnet socket, command, option)
  167.             option will be chr(0) when there is no option.
  168.         No other action is done afterwards by telnetlib.
  169.  
  170.     """
  171.     
  172.     def __init__(self, host = None, port = 0):
  173.         '''Constructor.
  174.  
  175.         When called without arguments, create an unconnected instance.
  176.         With a hostname argument, it connects the instance; a port
  177.         number is optional.
  178.  
  179.         '''
  180.         self.debuglevel = DEBUGLEVEL
  181.         self.host = host
  182.         self.port = port
  183.         self.sock = None
  184.         self.rawq = ''
  185.         self.irawq = 0
  186.         self.cookedq = ''
  187.         self.eof = 0
  188.         self.iacseq = ''
  189.         self.sb = 0
  190.         self.sbdataq = ''
  191.         self.option_callback = None
  192.         if host is not None:
  193.             self.open(host, port)
  194.         
  195.  
  196.     
  197.     def open(self, host, port = 0):
  198.         """Connect to a host.
  199.  
  200.         The optional second argument is the port number, which
  201.         defaults to the standard telnet port (23).
  202.  
  203.         Don't try to reopen an already connected instance.
  204.  
  205.         """
  206.         self.eof = 0
  207.         if not port:
  208.             port = TELNET_PORT
  209.         
  210.         self.host = host
  211.         self.port = port
  212.         msg = 'getaddrinfo returns an empty list'
  213.         for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
  214.             (af, socktype, proto, canonname, sa) = res
  215.             
  216.             try:
  217.                 self.sock = socket.socket(af, socktype, proto)
  218.                 self.sock.connect(sa)
  219.             except socket.error:
  220.                 msg = None
  221.                 if self.sock:
  222.                     self.sock.close()
  223.                 
  224.                 self.sock = None
  225.                 continue
  226.  
  227.         
  228.         if not self.sock:
  229.             raise socket.error, msg
  230.         
  231.  
  232.     
  233.     def __del__(self):
  234.         '''Destructor -- close the connection.'''
  235.         self.close()
  236.  
  237.     
  238.     def msg(self, msg, *args):
  239.         '''Print a debug message, when the debug level is > 0.
  240.  
  241.         If extra arguments are present, they are substituted in the
  242.         message using the standard string formatting operator.
  243.  
  244.         '''
  245.         if self.debuglevel > 0:
  246.             print 'Telnet(%s,%d):' % (self.host, self.port),
  247.             if args:
  248.                 print msg % args
  249.             else:
  250.                 print msg
  251.         
  252.  
  253.     
  254.     def set_debuglevel(self, debuglevel):
  255.         '''Set the debug level.
  256.  
  257.         The higher it is, the more debug output you get (on sys.stdout).
  258.  
  259.         '''
  260.         self.debuglevel = debuglevel
  261.  
  262.     
  263.     def close(self):
  264.         '''Close the connection.'''
  265.         if self.sock:
  266.             self.sock.close()
  267.         
  268.         self.sock = 0
  269.         self.eof = 1
  270.         self.iacseq = ''
  271.         self.sb = 0
  272.  
  273.     
  274.     def get_socket(self):
  275.         '''Return the socket object used internally.'''
  276.         return self.sock
  277.  
  278.     
  279.     def fileno(self):
  280.         '''Return the fileno() of the socket object used internally.'''
  281.         return self.sock.fileno()
  282.  
  283.     
  284.     def write(self, buffer):
  285.         '''Write a string to the socket, doubling any IAC characters.
  286.  
  287.         Can block if the connection is blocked.  May raise
  288.         socket.error if the connection is closed.
  289.  
  290.         '''
  291.         if IAC in buffer:
  292.             buffer = buffer.replace(IAC, IAC + IAC)
  293.         
  294.         self.msg('send %r', buffer)
  295.         self.sock.sendall(buffer)
  296.  
  297.     
  298.     def read_until(self, match, timeout = None):
  299.         '''Read until a given string is encountered or until timeout.
  300.  
  301.         When no match is found, return whatever is available instead,
  302.         possibly the empty string.  Raise EOFError if the connection
  303.         is closed and no cooked data is available.
  304.  
  305.         '''
  306.         n = len(match)
  307.         self.process_rawq()
  308.         i = self.cookedq.find(match)
  309.         if i >= 0:
  310.             i = i + n
  311.             buf = self.cookedq[:i]
  312.             self.cookedq = self.cookedq[i:]
  313.             return buf
  314.         
  315.         s_reply = ([
  316.             self], [], [])
  317.         s_args = s_reply
  318.         if timeout is not None:
  319.             s_args = s_args + (timeout,)
  320.         
  321.         while not (self.eof) and select.select(*s_args) == s_reply:
  322.             i = max(0, len(self.cookedq) - n)
  323.             self.fill_rawq()
  324.             self.process_rawq()
  325.             i = self.cookedq.find(match, i)
  326.             if i >= 0:
  327.                 i = i + n
  328.                 buf = self.cookedq[:i]
  329.                 self.cookedq = self.cookedq[i:]
  330.                 return buf
  331.                 continue
  332.         return self.read_very_lazy()
  333.  
  334.     
  335.     def read_all(self):
  336.         '''Read all data until EOF; block until connection closed.'''
  337.         self.process_rawq()
  338.         while not self.eof:
  339.             self.fill_rawq()
  340.             self.process_rawq()
  341.         buf = self.cookedq
  342.         self.cookedq = ''
  343.         return buf
  344.  
  345.     
  346.     def read_some(self):
  347.         """Read at least one byte of cooked data unless EOF is hit.
  348.  
  349.         Return '' if EOF is hit.  Block if no data is immediately
  350.         available.
  351.  
  352.         """
  353.         self.process_rawq()
  354.         while not (self.cookedq) and not (self.eof):
  355.             self.fill_rawq()
  356.             self.process_rawq()
  357.         buf = self.cookedq
  358.         self.cookedq = ''
  359.         return buf
  360.  
  361.     
  362.     def read_very_eager(self):
  363.         """Read everything that's possible without blocking in I/O (eager).
  364.  
  365.         Raise EOFError if connection closed and no cooked data
  366.         available.  Return '' if no cooked data available otherwise.
  367.         Don't block unless in the midst of an IAC sequence.
  368.  
  369.         """
  370.         self.process_rawq()
  371.         while not (self.eof) and self.sock_avail():
  372.             self.fill_rawq()
  373.             self.process_rawq()
  374.         return self.read_very_lazy()
  375.  
  376.     
  377.     def read_eager(self):
  378.         """Read readily available data.
  379.  
  380.         Raise EOFError if connection closed and no cooked data
  381.         available.  Return '' if no cooked data available otherwise.
  382.         Don't block unless in the midst of an IAC sequence.
  383.  
  384.         """
  385.         self.process_rawq()
  386.         while not (self.cookedq) and not (self.eof) and self.sock_avail():
  387.             self.fill_rawq()
  388.             self.process_rawq()
  389.         return self.read_very_lazy()
  390.  
  391.     
  392.     def read_lazy(self):
  393.         """Process and return data that's already in the queues (lazy).
  394.  
  395.         Raise EOFError if connection closed and no data available.
  396.         Return '' if no cooked data available otherwise.  Don't block
  397.         unless in the midst of an IAC sequence.
  398.  
  399.         """
  400.         self.process_rawq()
  401.         return self.read_very_lazy()
  402.  
  403.     
  404.     def read_very_lazy(self):
  405.         """Return any data available in the cooked queue (very lazy).
  406.  
  407.         Raise EOFError if connection closed and no data available.
  408.         Return '' if no cooked data available otherwise.  Don't block.
  409.  
  410.         """
  411.         buf = self.cookedq
  412.         self.cookedq = ''
  413.         if not buf and self.eof and not (self.rawq):
  414.             raise EOFError, 'telnet connection closed'
  415.         
  416.         return buf
  417.  
  418.     
  419.     def read_sb_data(self):
  420.         """Return any data available in the SB ... SE queue.
  421.  
  422.         Return '' if no SB ... SE available. Should only be called
  423.         after seeing a SB or SE command. When a new SB command is
  424.         found, old unread SB data will be discarded. Don't block.
  425.  
  426.         """
  427.         buf = self.sbdataq
  428.         self.sbdataq = ''
  429.         return buf
  430.  
  431.     
  432.     def set_option_negotiation_callback(self, callback):
  433.         '''Provide a callback function called after each receipt of a telnet option.'''
  434.         self.option_callback = callback
  435.  
  436.     
  437.     def process_rawq(self):
  438.         """Transfer from raw queue to cooked queue.
  439.  
  440.         Set self.eof when connection is closed.  Don't block unless in
  441.         the midst of an IAC sequence.
  442.  
  443.         """
  444.         buf = [
  445.             '',
  446.             '']
  447.         
  448.         try:
  449.             while self.rawq:
  450.                 c = self.rawq_getchar()
  451.                 if not self.iacseq:
  452.                     if c == theNULL:
  453.                         continue
  454.                     
  455.                     if c == '\x11':
  456.                         continue
  457.                     
  458.                     if c != IAC:
  459.                         buf[self.sb] = buf[self.sb] + c
  460.                         continue
  461.                     else:
  462.                         self.iacseq += c
  463.                 c != IAC
  464.                 if len(self.iacseq) == 1:
  465.                     if c in (DO, DONT, WILL, WONT):
  466.                         self.iacseq += c
  467.                         continue
  468.                     
  469.                     self.iacseq = ''
  470.                     if c == IAC:
  471.                         buf[self.sb] = buf[self.sb] + c
  472.                     elif c == SB:
  473.                         self.sb = 1
  474.                         self.sbdataq = ''
  475.                     elif c == SE:
  476.                         self.sb = 0
  477.                         self.sbdataq = self.sbdataq + buf[1]
  478.                         buf[1] = ''
  479.                     
  480.                     if self.option_callback:
  481.                         self.option_callback(self.sock, c, NOOPT)
  482.                     else:
  483.                         self.msg('IAC %d not recognized' % ord(c))
  484.                 self.option_callback
  485.                 if len(self.iacseq) == 2:
  486.                     cmd = self.iacseq[1]
  487.                     self.iacseq = ''
  488.                     opt = c
  489.                     if cmd in (DO, DONT):
  490.                         if not cmd == DO or 'DO':
  491.                             pass
  492.                         self.msg('IAC %s %d', 'DONT', ord(opt))
  493.                         if self.option_callback:
  494.                             self.option_callback(self.sock, cmd, opt)
  495.                         else:
  496.                             self.sock.sendall(IAC + WONT + opt)
  497.                     elif cmd in (WILL, WONT):
  498.                         if not cmd == WILL or 'WILL':
  499.                             pass
  500.                         self.msg('IAC %s %d', 'WONT', ord(opt))
  501.                         if self.option_callback:
  502.                             self.option_callback(self.sock, cmd, opt)
  503.                         else:
  504.                             self.sock.sendall(IAC + DONT + opt)
  505.                     
  506.                 cmd in (DO, DONT)
  507.         except EOFError:
  508.             self.iacseq = ''
  509.             self.sb = 0
  510.  
  511.         self.cookedq = self.cookedq + buf[0]
  512.         self.sbdataq = self.sbdataq + buf[1]
  513.  
  514.     
  515.     def rawq_getchar(self):
  516.         '''Get next char from raw queue.
  517.  
  518.         Block if no data is immediately available.  Raise EOFError
  519.         when connection is closed.
  520.  
  521.         '''
  522.         if not self.rawq:
  523.             self.fill_rawq()
  524.             if self.eof:
  525.                 raise EOFError
  526.             
  527.         
  528.         c = self.rawq[self.irawq]
  529.         self.irawq = self.irawq + 1
  530.         if self.irawq >= len(self.rawq):
  531.             self.rawq = ''
  532.             self.irawq = 0
  533.         
  534.         return c
  535.  
  536.     
  537.     def fill_rawq(self):
  538.         '''Fill raw queue from exactly one recv() system call.
  539.  
  540.         Block if no data is immediately available.  Set self.eof when
  541.         connection is closed.
  542.  
  543.         '''
  544.         if self.irawq >= len(self.rawq):
  545.             self.rawq = ''
  546.             self.irawq = 0
  547.         
  548.         buf = self.sock.recv(50)
  549.         self.msg('recv %r', buf)
  550.         self.eof = not buf
  551.         self.rawq = self.rawq + buf
  552.  
  553.     
  554.     def sock_avail(self):
  555.         '''Test whether data is available on the socket.'''
  556.         return select.select([
  557.             self], [], [], 0) == ([
  558.             self], [], [])
  559.  
  560.     
  561.     def interact(self):
  562.         '''Interaction function, emulates a very dumb telnet client.'''
  563.         if sys.platform == 'win32':
  564.             self.mt_interact()
  565.             return None
  566.         
  567.         while None:
  568.             (rfd, wfd, xfd) = select.select([
  569.                 self,
  570.                 sys.stdin], [], [])
  571.             if self in rfd:
  572.                 
  573.                 try:
  574.                     text = self.read_eager()
  575.                 except EOFError:
  576.                     print '*** Connection closed by remote host ***'
  577.                     break
  578.  
  579.                 if text:
  580.                     sys.stdout.write(text)
  581.                     sys.stdout.flush()
  582.                 
  583.             
  584.             if sys.stdin in rfd:
  585.                 line = sys.stdin.readline()
  586.                 if not line:
  587.                     break
  588.                 
  589.                 self.write(line)
  590.                 continue
  591.  
  592.     
  593.     def mt_interact(self):
  594.         '''Multithreaded version of interact().'''
  595.         import thread
  596.         thread.start_new_thread(self.listener, ())
  597.         while None:
  598.             line = sys.stdin.readline()
  599.             if not line:
  600.                 break
  601.             
  602.  
  603.     
  604.     def listener(self):
  605.         '''Helper for mt_interact() -- this executes in the other thread.'''
  606.         while None:
  607.             
  608.             try:
  609.                 data = self.read_eager()
  610.             except EOFError:
  611.                 print '*** Connection closed by remote host ***'
  612.                 return None
  613.  
  614.             if data:
  615.                 sys.stdout.write(data)
  616.                 continue
  617.             sys.stdout.flush()
  618.  
  619.     
  620.     def expect(self, list, timeout = None):
  621.         """Read until one from a list of a regular expressions matches.
  622.  
  623.         The first argument is a list of regular expressions, either
  624.         compiled (re.RegexObject instances) or uncompiled (strings).
  625.         The optional second argument is a timeout, in seconds; default
  626.         is no timeout.
  627.  
  628.         Return a tuple of three items: the index in the list of the
  629.         first regular expression that matches; the match object
  630.         returned; and the text read up till and including the match.
  631.  
  632.         If EOF is read and no text was read, raise EOFError.
  633.         Otherwise, when nothing matches, return (-1, None, text) where
  634.         text is the text received so far (may be the empty string if a
  635.         timeout happened).
  636.  
  637.         If a regular expression ends with a greedy match (e.g. '.*')
  638.         or if more than one expression can match the same input, the
  639.         results are undeterministic, and may depend on the I/O timing.
  640.  
  641.         """
  642.         re = None
  643.         list = list[:]
  644.         indices = range(len(list))
  645.         for i in indices:
  646.             if not hasattr(list[i], 'search'):
  647.                 if not re:
  648.                     import re
  649.                 
  650.                 list[i] = re.compile(list[i])
  651.                 continue
  652.         
  653.         while None:
  654.             for i in indices:
  655.                 m = list[i].search(self.cookedq)
  656.                 if m:
  657.                     e = m.end()
  658.                     text = self.cookedq[:e]
  659.                     self.cookedq = self.cookedq[e:]
  660.                     return (i, m, text)
  661.                     continue
  662.             
  663.             if self.eof:
  664.                 break
  665.             
  666.             if timeout is not None:
  667.                 (r, w, x) = select.select([
  668.                     self.fileno()], [], [], timeout)
  669.                 if not r:
  670.                     break
  671.                 
  672.             
  673.             self.fill_rawq()
  674.         text = self.read_very_lazy()
  675.         if not text and self.eof:
  676.             raise EOFError
  677.         
  678.         return (-1, None, text)
  679.  
  680.  
  681.  
  682. def test():
  683.     '''Test program for telnetlib.
  684.  
  685.     Usage: python telnetlib.py [-d] ... [host [port]]
  686.  
  687.     Default host is localhost; default port is 23.
  688.  
  689.     '''
  690.     debuglevel = 0
  691.     while sys.argv[1:] and sys.argv[1] == '-d':
  692.         debuglevel = debuglevel + 1
  693.         del sys.argv[1]
  694.     host = 'localhost'
  695.     if sys.argv[1:]:
  696.         host = sys.argv[1]
  697.     
  698.     port = 0
  699.     if sys.argv[2:]:
  700.         portstr = sys.argv[2]
  701.         
  702.         try:
  703.             port = int(portstr)
  704.         except ValueError:
  705.             port = socket.getservbyname(portstr, 'tcp')
  706.         except:
  707.             None<EXCEPTION MATCH>ValueError
  708.         
  709.  
  710.     None<EXCEPTION MATCH>ValueError
  711.     tn = Telnet()
  712.     tn.set_debuglevel(debuglevel)
  713.     tn.open(host, port)
  714.     tn.interact()
  715.     tn.close()
  716.  
  717. if __name__ == '__main__':
  718.     test()
  719.  
  720.