GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 01:09:22 +01:00
Code Issues Projects Releases Wiki Activity

Irc: only apply encoding settings on connect

Browse Source 
Changing the encoding after a connection has been established is somewhat dangerous, because it's possible to corrupt channel/user state if characters in the old encoding are no longer valid.

Also, mark this option as experimental.
This commit is contained in:
James Lu 2017-06-02 07:30:20 -07:00
parent 2737b6bbfc
commit b9aee6ae85
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
classes.py
View File

@ -56,6 +56,9 @@ class Irc(utils.DeprecatedAttributesObject):
self.botdata = conf['bot'] self.botdata = conf['bot']
self.protoname = proto.__name__.split('.')[-1] # Remove leading pylinkirc.protocols. self.protoname = proto.__name__.split('.')[-1] # Remove leading pylinkirc.protocols.
self.proto = proto.Class(self) self.proto = proto.Class(self)
# These options depend on self.serverdata from above to be set.
self.encoding = None
self.pingfreq = self.serverdata.get('pingfreq') or 90 self.pingfreq = self.serverdata.get('pingfreq') or 90
self.pingtimeout = self.pingfreq * 2 self.pingtimeout = self.pingfreq * 2
@ -111,6 +114,7 @@ class Irc(utils.DeprecatedAttributesObject):
(Re)sets an IRC object to its default state. This should be called when (Re)sets an IRC object to its default state. This should be called when
an IRC object is first created, and on every reconnection to a network. an IRC object is first created, and on every reconnection to a network.
""" """
self.encoding = self.serverdata.get('encoding') or 'utf-8'
self.pingfreq = self.serverdata.get('pingfreq') or 90 self.pingfreq = self.serverdata.get('pingfreq') or 90
self.pingtimeout = self.pingfreq * 3 self.pingtimeout = self.pingfreq * 3
@ -437,13 +441,10 @@ class Irc(utils.DeprecatedAttributesObject):
log.error('(%s) Connection timed out.', self.name) log.error('(%s) Connection timed out.', self.name)
return return
# Get the encoding from the config file, falling back to UTF-8 if none is specified.
encoding = self.serverdata.get('encoding') or 'utf-8'
while b'\n' in buf: while b'\n' in buf:
line, buf = buf.split(b'\n', 1) line, buf = buf.split(b'\n', 1)
line = line.strip(b'\r') line = line.strip(b'\r')
line = line.decode(encoding, "replace") line = line.decode(self.encoding, "replace")
self.runline(line) self.runline(line)
def runline(self, line): def runline(self, line):
@ -510,8 +511,7 @@ class Irc(utils.DeprecatedAttributesObject):
# Safeguard against newlines in input!! Otherwise, each line gets # Safeguard against newlines in input!! Otherwise, each line gets
# treated as a separate command, which is particularly nasty. # treated as a separate command, which is particularly nasty.
data = data.replace('\n', ' ') data = data.replace('\n', ' ')
encoding = self.serverdata.get('encoding') or 'utf-8' encoded_data = data.encode(self.encoding, 'replace') + b"\n"
encoded_data = data.encode(encoding, 'replace') + b"\n"
log.debug("(%s) -> %s", self.name, data) log.debug("(%s) -> %s", self.name, data)

3
example-conf.yml
View File

@ -205,6 +205,9 @@ servers:
# using m_nationalchars or something similar. Encoding defaults to utf-8 if not set, and # using m_nationalchars or something similar. Encoding defaults to utf-8 if not set, and
# should be one of the standard encodings defined at # should be one of the standard encodings defined at
# https://docs.python.org/3/library/codecs.html#standard-encodings # https://docs.python.org/3/library/codecs.html#standard-encodings
# Changing this setting requires a disconnect and reconnect of the corresponding network
# to apply.
# This setting is EXPERIMENTAL as of PyLink 1.2.x.
#encoding: utf-8 #encoding: utf-8
ts6net: ts6net: