PEP 8 conformance for package init library
[mudpy.git] / lib / mudpy / telnet.py
1 # -*- coding: utf-8 -*-
2 u"""Telnet functions and constants for the mudpy engine."""
3
4 # Copyright (c) 2004-2011 Jeremy Stanley <fungi@yuggoth.org>. Permission
5 # to use, copy, modify, and distribute this software is granted under
6 # terms provided in the LICENSE file distributed with this software.
7
8 # telnet options (from bsd's arpa/telnet.h since telnetlib's are ambiguous)
9 TELOPT_BINARY = 0  # transmit 8-bit data by the receiver (rfc 856)
10 TELOPT_ECHO = 1  # echo received data back to the sender (rfc 857)
11 TELOPT_SGA = 3  # suppress transmission of the go ahead character (rfc 858)
12 # TELOPT_TTYPE = 24 # exchange terminal type information (rfc 1091)
13 TELOPT_EOR = 25  # transmit end-of-record after transmitting data (rfc 885)
14 TELOPT_NAWS = 31  # negotiate about window size (rfc 1073)
15 TELOPT_LINEMODE = 34  # cooked line-by-line input mode (rfc 1184)
16
17 supported = (
18     TELOPT_BINARY,
19     TELOPT_ECHO,
20     TELOPT_SGA,
21     TELOPT_EOR,
22     TELOPT_NAWS,
23     TELOPT_LINEMODE
24 )
25
26 # telnet commands
27 EOR = 239  # end-of-record signal (rfc 885)
28 SE = 240  # end of subnegotiation parameters (rfc 854)
29 GA = 249  # go ahead signal (rfc 854)
30 SB = 250  # what follows is subnegotiation of the indicated option (rfc 854)
31 WILL = 251  # desire or confirmation of performing an option (rfc 854)
32 WONT = 252  # refusal or confirmation of performing an option (rfc 854)
33 DO = 253  # request or confirm performing an option (rfc 854)
34 DONT = 254  # demand or confirm no longer performing an option (rfc 854)
35 IAC = 255  # interpret as command escape character (rfc 854)
36
37 # RFC 1143 option negotiation states
38 NO = 0  # option is disabled
39 YES = 1  # option is enabled
40 WANTNO = 2  # demanded disabling option
41 WANTYES = 3  # requested enabling option
42 WANTNO_OPPOSITE = 4  # demanded disabling option but queued an enable after it
43 WANTYES_OPPOSITE = 5  # requested enabling option but queued a disable after it
44
45 # RFC 1143 option negotiation parties
46 HIM = 0
47 US = 1
48
49
50 def telnet_proto(*arguments):
51     u"""Return a concatenated series of Telnet protocol commands."""
52     # (this will need to be byte type during 2to3 migration)
53     return "".join([chr(x) for x in arguments])
54
55
56 def send_command(user, *command):
57     u"""Sends a Telnet command string to the specified user's socket."""
58     user.send(telnet_proto(IAC, *command), raw=True)
59
60
61 def is_enabled(user, telopt, party, state=YES):
62     u"""Returns True if the indicated Telnet option is enabled, False if not."""
63     if (telopt, party) in user.telopts and user.telopts[
64        (telopt, party)
65        ] is state:
66         return True
67     else:
68         return False
69
70
71 def enable(user, telopt, party):
72     u"""Negotiates enabling a Telnet option for the indicated user's socket."""
73     if party is HIM:
74         txpos = DO
75     else:
76         txpos = WILL
77     if not (telopt, party) in user.telopts or user.telopts[
78        (telopt, party)
79        ] is NO:
80         user.telopts[(telopt, party)] = WANTYES
81         send_command(user, txpos, telopt)
82     elif user.telopts[(telopt, party)] is WANTNO:
83         user.telopts[(telopt, party)] = WANTNO_OPPOSITE
84     elif user.telopts[(telopt, party)] is WANTYES_OPPOSITE:
85         user.telopts[(telopt, party)] = WANTYES
86
87
88 def disable(user, telopt, party):
89     u"""Negotiates disabling a Telnet option for the indicated user's socket."""
90     if party is HIM:
91         txneg = DONT
92     else:
93         txneg = WONT
94     if not (telopt, party) in user.telopts:
95         user.telopts[(telopt, party)] = NO
96     elif user.telopts[(telopt, party)] is YES:
97         user.telopts[(telopt, party)] = WANTNO
98         send_command(user, txneg, telopt)
99     elif user.telopts[(telopt, party)] is WANTYES:
100         user.telopts[(telopt, party)] = WANTYES_OPPOSITE
101     elif user.telopts[(telopt, party)] is WANTNO_OPPOSITE:
102         user.telopts[(telopt, party)] = WANTNO
103
104
105 def negotiate_telnet_options(user):
106     u"""Reply to and remove telnet negotiation options from partial_input."""
107     import misc
108
109     # make a local copy to play with
110     text = user.partial_input
111
112     # start at the begining of the input
113     position = 0
114
115     # as long as we haven't checked it all
116     len_text = len(text)
117     while position < len_text:
118
119         # jump to the first IAC you find
120         position = text.find(telnet_proto(IAC), position)
121
122         # if there wasn't an IAC in the input or it's at the end, we're done
123         if position < 0 or position >= len_text - 1:
124             break
125
126         # the byte following the IAC is our command
127         # (this will need to be byte type during 2to3 migration)
128         command = ord(text[position + 1])
129
130         # replace a double (literal) IAC if there's an LF later
131         if command is IAC:
132             if text.find("\n", position) > 0:
133                 position += 1
134                 text = text[:position] + text[position + 1:]
135             else:
136                 position += 2
137
138         # implement an RFC 1143 option negotiation queue here
139         elif len_text > position + 2 and WILL <= command <= DONT:
140             # this will need to be byte type during 2to3 migration
141             telopt = ord(text[position + 2])
142             if telopt in supported:
143                 if command <= WONT:
144                     party = HIM
145                     rxpos = WILL
146                     txpos = DO
147                     txneg = DONT
148                 else:
149                     party = US
150                     rxpos = DO
151                     txpos = WILL
152                     txneg = WONT
153                 if (telopt, party) not in user.telopts:
154                     user.telopts[(telopt, party)] = NO
155                 if command is rxpos:
156                     if user.telopts[(telopt, party)] is NO:
157                         user.telopts[(telopt, party)] = YES
158                         send_command(user, txpos, telopt)
159                     elif user.telopts[(telopt, party)] is WANTNO:
160                         user.telopts[(telopt, party)] = NO
161                     elif user.telopts[(telopt, party)] is WANTNO_OPPOSITE:
162                         user.telopts[(telopt, party)] = YES
163                     elif user.telopts[(telopt, party)] is WANTYES_OPPOSITE:
164                         user.telopts[(telopt, party)] = WANTNO
165                         send_command(user, txneg, telopt)
166                     else:
167                         user.telopts[(telopt, party)] = YES
168                 else:
169                     if user.telopts[(telopt, party)] is YES:
170                         user.telopts[(telopt, party)] = NO
171                         send_command(user, txneg, telopt)
172                     elif user.telopts[(telopt, party)] is WANTNO_OPPOSITE:
173                         user.telopts[(telopt, party)] = WANTYES
174                         send_command(user, txpos, telopt)
175                     else:
176                         user.telopts[(telopt, party)] = NO
177             elif command is WILL:
178                 send_command(user, DONT, telopt)
179             else:
180                 send_command(user, WONT, telopt)
181             text = text[:position] + text[position + 3:]
182
183         # subnegotiation options
184         elif len_text > position + 4 and command is SB:
185             # this will need to be byte type during 2to3 migration
186             telopt = ord(text[position + 2])
187             if telopt is TELOPT_NAWS:
188                 # this will need to be byte type during 2to3 migration
189                 user.columns = ord(text[position + 3]) * \
190                     256 + ord(text[position + 4])
191             end_subnegotiation = text.find(telnet_proto(IAC, SE), position)
192             if end_subnegotiation > 0:
193                 text = text[:position] + text[end_subnegotiation + 2:]
194             else:
195                 position += 1
196
197         # otherwise, strip out a two-byte IAC command
198         elif len_text > position + 2:
199             misc.log(u"Unknown Telnet IAC command %s ignored." % command)
200             text = text[:position] + text[position + 2:]
201
202         # and this means we got the begining of an IAC
203         else:
204             position += 1
205
206     # replace the input with our cleaned-up text
207     user.partial_input = text