ngIRCd protocol support

classes.py

@@ -171,7 +171,7 @@ def init_vars(self):
         self.log_setup()
 
     def __repr__(self):
-        return "<%s object for network %r>" % (self.__class__.name, self.name)
+        return "<%s object for network %r>" % (self.__class__.__name__, self.name)
 
     ### General utility functions
     def call_hooks(self, hook_args):
@@ -1117,7 +1117,7 @@ def init_vars(self, *args, **kwargs):
 
     def _schedule_ping(self):
         """Schedules periodic pings in a loop."""
-        self.ping()
+        self._ping_uplink()
 
         self.pingTimer = threading.Timer(self.pingfreq, self._schedule_ping)
         self.pingTimer.daemon = True
@@ -1415,6 +1415,9 @@ def __init__(self, nick, ts, uid, server, ident='null', host='null',
         # For "serious" service clients, this should always be False.
         self.manipulatable = manipulatable
 
+        # Cloaked host for IRCds that use it
+        self.cloaked_host = None
+
     def __repr__(self):
         return 'User(%s/%s)' % (self.uid, self.nick)
 IrcUser = User

docs/technical/protocol-modules.dot

@@ -1,29 +1,48 @@
-/* Graph showing inheritance with the current PyLink protocol protocols:
+/* Graph showing inheritance with the current PyLink protocol modules:
  * Update using: dot -Tpng protocol-modules.dot > protocol-modules.png
  */
 
 digraph G {
-	ratio = 0.8; /* make the graph wider than tall */
+
+	edge [ penwidth=0.75, color="#111111CC" ];
+	subgraph cluster_core {
+		label="Core classes (pylinkirc.classes)";
+		style="filled";
+		node [style="filled",color="white"];
+		color="#90EE90";
+
+		"PyLinkNetworkCore" -> "PyLinkNetworkCoreWithUtils" -> "IRCNetwork";
+	}
+
 	subgraph cluster_helper {
-		label="Protocol module helpers";
+		label="Protocol module helpers\n(pylinkirc.protocols.ircs2s_common)";
 		style="filled";
 		node [style="filled",color="white"];
 		color="lightblue";
 
-		"ircs2s_common.py" -> "ts6_common.py";
+		"IRCNetwork" -> "IRCCommonProtocol" -> "IRCS2SProtocol" -> "TS6BaseProtocol";
+
+		subgraph cluster_helper {
+			label="pylinkirc.protocols.ts6_common";
+			style="filled";
+			color="lightcyan";
+
+			"TS6BaseProtocol";
+		}
 	}
 
 	subgraph cluster_pluggable {
-		label="Pluggable (full) protocol modules";
+		label="Complete protocol modules (pylinkirc.protocols.*)";
 		style="filled";
 		node [style="filled",color="white"];
 		color="khaki";
 
-		"ircs2s_common.py" -> "p10.py";
-		"ts6_common.py" -> "ts6.py" -> "hybrid.py";
-		"ts6.py" -> "ratbox.py";
-		"ts6_common.py" -> "inspircd.py";
-		"ts6_common.py" -> "unreal.py";
-		"clientbot.py";
+		"IRCS2SProtocol" -> "p10";
+		"IRCS2SProtocol" -> "ngircd";
+		"TS6BaseProtocol" -> "ts6" -> "hybrid";
+		"ts6" -> "ratbox";
+		"TS6BaseProtocol" -> "inspircd";
+		"TS6BaseProtocol" -> "unreal";
+		"IRCCommonProtocol" -> "clientbot";
 	}
 }

protocols/clientbot.py

@@ -8,7 +8,6 @@
 from pylinkirc.classes import *
 
 FALLBACK_REALNAME = 'PyLink Relay Mirror Client'
-COMMON_PREFIXMODES = [('h', 'halfop'), ('a', 'admin'), ('q', 'owner'), ('y', 'owner')]
 IRCV3_CAPABILITIES = {'multi-prefix', 'sasl'}
 
 class ClientbotWrapperProtocol(IRCCommonProtocol):
@@ -25,7 +24,7 @@ def __init__(self, *args, **kwargs):
         # This is just a fallback. Actual casemapping is fetched by handle_005()
         self.casemapping = 'ascii'
 
-        self.caps = {}
+        self._caps = {}
         self.ircv3_caps = set()
         self.ircv3_caps_available = {}
 
@@ -42,19 +41,12 @@ def __init__(self, *args, **kwargs):
         # are essentially all fatal errors for connections.
         self.handle_463 = self.handle_464 = self.handle_465 = self.handle_error
 
-    def _expandPUID(self, uid):
-        """
-        Returns the real nick for the given PUID.
-        """
-        if uid in self.users:
-            nick = self.users[uid].nick
-            log.debug('(%s) Mangling target PUID %s to nick %s', self.name, uid, nick)
-            return nick
-        return uid
+        self._use_builtin_005_handling = True
 
     def post_connect(self):
         """Initializes a connection to a server."""
         # (Re)initialize counter-based pseudo UID generators
+        super().post_connect()
         self.uidgen = utils.PUIDGenerator('PUID')
         self.sidgen = utils.PUIDGenerator('ClientbotInternalSID')
 
@@ -68,7 +60,7 @@ def post_connect(self):
         # Clear states from last connect
         self.who_received.clear()
         self.kick_queue.clear()
-        self.caps.clear()
+        self._caps.clear()
         self.ircv3_caps.clear()
         self.ircv3_caps_available.clear()
 
@@ -253,9 +245,9 @@ def notice(self, source, target, text):
         # Wrap around message(), which does all the text formatting for us.
         self.message(source, target, text, notice=True)
 
-    def ping(self, source=None, target=None):
+    def _ping_uplink(self):
         """
-        Sends PING to the uplink.
+        Sends a PING to the uplink.
         """
         if self.uplink:
             self.send('PING %s' % self.get_friendly_name(self.uplink))
@@ -586,40 +578,6 @@ def handle_001(self, source, command, args):
         # enumerate our uplink
         self.uplink = source
 
-    def handle_005(self, source, command, args):
-        """
-        Handles 005 / RPL_ISUPPORT.
-        """
-        self.caps.update(self.parse_isupport(args[1:-1]))
-        log.debug('(%s) handle_005: self.caps is %s', self.name, self.caps)
-
-        if 'CHANMODES' in self.caps:
-            self.cmodes['*A'], self.cmodes['*B'], self.cmodes['*C'], self.cmodes['*D'] = \
-                self.caps['CHANMODES'].split(',')
-        log.debug('(%s) handle_005: cmodes: %s', self.name, self.cmodes)
-
-        if 'USERMODES' in self.caps:
-            self.umodes['*A'], self.umodes['*B'], self.umodes['*C'], self.umodes['*D'] = \
-                self.caps['USERMODES'].split(',')
-        log.debug('(%s) handle_005: umodes: %s', self.name, self.umodes)
-
-        self.casemapping = self.caps.get('CASEMAPPING', self.casemapping)
-        log.debug('(%s) handle_005: casemapping set to %s', self.name, self.casemapping)
-
-        if 'PREFIX' in self.caps:
-            self.prefixmodes = prefixmodes = self.parse_isupport_prefixes(self.caps['PREFIX'])
-            log.debug('(%s) handle_005: prefix modes set to %s', self.name, self.prefixmodes)
-
-            # Autodetect common prefix mode names.
-            for char, modename in COMMON_PREFIXMODES:
-                # Don't overwrite existing named mode definitions.
-                if char in self.prefixmodes and modename not in self.cmodes:
-                    self.cmodes[modename] = char
-                    log.debug('(%s) handle_005: autodetecting mode %s (%s) as %s', self.name,
-                              char, self.prefixmodes[char], modename)
-
-        self.connected.set()
-
     def handle_376(self, source, command, args):
         """
         Handles end of MOTD numerics, used to start things like autoperform.
@@ -630,9 +588,11 @@ def handle_376(self, source, command, args):
             self.send(line)
 
         # Virtual endburst hook.
+        self.connected.set()  # Note, this should always be set before sending ENDBURST
         if not self.has_eob:
             self.has_eob = True
             return {'parse_as': 'ENDBURST'}
+
     handle_422 = handle_376
 
     def handle_353(self, source, command, args):
@@ -931,13 +891,6 @@ def handle_ping(self, source, command, args):
         """
         self.send('PONG :%s' % args[0], queue=False)
 
-    def handle_pong(self, source, command, args):
-        """
-        Handles incoming PONG.
-        """
-        if source == self.uplink:
-            self.lastping = time.time()
-
     def handle_privmsg(self, source, command, args):
         """Handles incoming PRIVMSG/NOTICE."""
         # <- :sender PRIVMSG #dev :afasfsa

protocols/inspircd.py

@@ -243,12 +243,6 @@ def topic_burst(self, numeric, target, text):
         self.channels[target].topic = text
         self.channels[target].topicset = True
 
-    def invite(self, numeric, target, channel):
-        """Sends an INVITE from a PyLink client.."""
-        if not self.is_internal_client(numeric):
-            raise LookupError('No such PyLink client exists.')
-        self._send_with_prefix(numeric, 'INVITE %s %s' % (target, channel))
-
     def knock(self, numeric, target, text):
         """Sends a KNOCK from a PyLink client."""
         if not self.is_internal_client(numeric):
@@ -308,14 +302,6 @@ def update_client(self, target, field, text):
                 self.call_hooks([self.sid, 'CHGNAME',
                                    {'target': target, 'newgecos': text}])
 
-    def ping(self, source=None, target=None):
-        """Sends a PING to a target server. Periodic PINGs are sent to our uplink
-        automatically by the Irc() internals; plugins shouldn't have to use this."""
-        source = source or self.sid
-        target = target or self.uplink
-        if not (target is None or source is None):
-            self._send_with_prefix(source, 'PING %s %s' % (source, target))
-
     def numeric(self, source, numeric, target, text):
         """Sends raw numerics from a server to a remote client."""
         # InspIRCd 2.0 syntax (undocumented):
@@ -384,12 +370,6 @@ def endburstf():
             self._send_with_prefix(sid, 'ENDBURST')
         return sid
 
-    def squit(self, source, target, text='No reason given'):
-        """SQUITs a PyLink server."""
-        # -> :9PY SQUIT 9PZ :blah, blah
-        self._send_with_prefix(source, 'SQUIT %s :%s' % (target, text))
-        self.handle_squit(source, 'SQUIT', [target, text])
-
     ### Core / command handlers
 
     def post_connect(self):
@@ -629,17 +609,6 @@ def handle_fmode(self, numeric, command, args):
         return {'target': channel, 'modes': changedmodes, 'ts': ts,
                 'channeldata': oldobj}
 
-    def handle_mode(self, numeric, command, args):
-        """Handles incoming user mode changes."""
-        # In InspIRCd, MODE is used for setting user modes and
-        # FMODE is used for channel modes:
-        # <- :70MAAAAAA MODE 70MAAAAAA -i+xc
-        target = args[0]
-        modestrings = args[1:]
-        changedmodes = self.parse_modes(target, modestrings)
-        self.apply_modes(target, changedmodes)
-        return {'target': target, 'modes': changedmodes}
-
     def handle_idle(self, numeric, command, args):
         """
         Handles the IDLE command, sent between servers in remote WHOIS queries.
@@ -781,19 +750,6 @@ def handle_version(self, numeric, command, args):
         Stub VERSION handler (does nothing) to override the one in ts6_common.
         """
 
-    def handle_kill(self, source, command, args):
-        """Handles incoming KILLs."""
-        killed = args[0]
-        # Depending on whether the IRCd sends explicit QUIT messages for
-        # killed clients, the user may or may not have automatically been
-        # removed from our user list.
-        # If not, we have to assume that KILL = QUIT and remove them
-        # ourselves.
-        data = self.users.get(killed)
-        if data:
-            self._remove_client(killed)
-        return {'target': killed, 'text': args[1], 'userdata': data}
-
     def handle_sakick(self, source, command, args):
         """Handles forced kicks (SAKICK)."""
         # <- :1MLAAAAAD ENCAP 0AL SAKICK #test 0ALAAAAAB :test