Merge lp:~ddormer/kali/kali-update into lp:kali

[Darren Dormer]

-Changed InspircdServices in protocol.py to work with the new Spanning Tree 1.2 protocol.
-Changes have also been made in controller.py and the various services (nickserv, ares, oper) to correctly interact with InspircdServices.
-Added usual noob code. :D

[Jonathan Jacobs (jjacobs)]

Can you file a bug for this branch (like "Use new spanning tree 1.2 protocol") and link the branch to it? Then for future branches can you name the branch bugnumber-branch-name, I wouldn't worry about it for this particular branch.

[Jeremy Thurgood (jerith)]

Great stuff so far, thanks for taking this on.

Where do the sids and cids come from?

I don't see any unit tests around this stuff. Does Kali have any?
 * If so, can you update them?
 * If not, can you add some?

[Darren Dormer (ddormer)]

Thanks :>

I'll sort the branch stuff out now.
SID and CID are manually assigned for Kali, and the automatically
assigned/generated ones from (and for) the IRCd are included in the SERVER
command during initial connection.
I could try adding unit tests, but I'd prefer someone else handle that.

On Fri, Nov 4, 2011 at 4:03 PM, Jeremy Thurgood <email address hidden> wrote:

> Great stuff so far, thanks for taking this on.
>
> Where do the sids and cids come from?
>
> I don't see any unit tests around this stuff. Does Kali have any?
> * If so, can you update them?
> * If not, can you add some?
> --
> https://code.launchpad.net/~protato/kali/kali-update/+merge/81250
> You are the owner of lp:~protato/kali/kali-update.
>

[lp:~ddormer/kali/kali-update]

141. By Darren Dormer on 2011-11-24

Cleaned up newServiceUID and newCID functions a bit

[Tristan Seligmann (mithrandi)]

Having manually assigned CIDs for every pseudouser seems rather error-prone; it's too easy to accidentally use the same CID in two places, especially in the scenario where we eventually can have Kali plugins from external packages.

What about having a method on the controller to return a new CID instead? It can allocate them sequentially, the same way InspIRCd apparently does it, so that can be done when the pseudouser is being broadcast thus avoiding any possibility of collisions.

review: Needs Fixing

[lp:~ddormer/kali/kali-update]

142. By Darren Dormer on 2012-01-05

Replaced manually added CIDs with a generator

[Darren Dormer (ddormer)]

> Having manually assigned CIDs for every pseudouser seems rather error-prone;
> it's too easy to accidentally use the same CID in two places, especially in
> the scenario where we eventually can have Kali plugins from external packages.
>
> What about having a method on the controller to return a new CID instead? It
> can allocate them sequentially, the same way InspIRCd apparently does it, so
> that can be done when the pseudouser is being broadcast thus avoiding any
> possibility of collisions.

I've removed the manually assigned CIDs and replaced them with a generator, I'm not sure that it's in the correct place but I'm sure you'll tell me if it isn't :)

[Tristan Seligmann (mithrandi)]

You probably want itertools.product, not itertools.combinations; something like this:

self.ids = itertools.product(*[string.ascii_uppercase] * 6)

It's a little ugly because the signature of itertools.product is stupid, but I think that should do the trick. Otherwise, I think this looks good.

review: Needs Fixing

[lp:~ddormer/kali/kali-update]

143. By Darren Dormer on 2012-01-15

ID Generator now uses itertools.product which is more ideal

[Darren Dormer (ddormer)]

Ah I see, that returns a much better result. :)
I've replaced the itertools.combinations with itertools.product.

[Tristan Seligmann (mithrandi)]

Okay, the wraparound case isn't handled at present (you'll just get a StopIteration exception if the iterator is exhausted), but that's probably not important right now. Could you open a bug report about this so it doesn't get forgotten, though?

review: Approve

=== modified file 'config.py.sample'
--- config.py.sample	2009-01-11 21:05:56 +0000
+++ config.py.sample	2012-01-15 17:06:23 +0000
@@ -8,5 +8,6 @@
 
 password = 'blahblahpass'
 name = 'services.irc.net'
+sid = '9A5'
 numeric = 1
 desc = 'FooNet IRC services'

=== modified file 'kali/controller.py'
--- kali/controller.py	2009-01-25 01:21:56 +0000
+++ kali/controller.py	2012-01-15 17:06:23 +0000
@@ -1,4 +1,4 @@
-import time, types, inspect
+import time, types, inspect, itertools, string
 from textwrap import dedent
 
 from zope.interface import implements
@@ -200,19 +200,21 @@
         """
         self.ctrl = controller
         self.store = self.ctrl.store
+        self.cid = ''.join(n for n in self.ctrl.ids.next())
+        self.uid = self.ctrl.params['sid'] + self.cid 
         self.avatars = {}
 
     def event_connected(self, protocol):
         self.protocol = protocol
-        self.protocol.newServiceNick(self.nick, self.name, self.modes)
         self.signon = time.time()
+        self.protocol.newServiceUID(self.cid, self.nick, self.name, self.signon, self.modes)
 
     def event_idle(self, source, dest):
         if dest.lower() == self.nick.lower():
             self.protocol.sendMessage('IDLE', source, '%ld' % self.signon, '0', prefix=self.nick)
 
     def event_privmsg(self, source, dest, msg):
-        if dest.lower() == self.nick.lower():
+        if dest.lower() == self.uid.lower():
             self.command(source, msg)
 
     def locateCommand(self, avatar, params):
@@ -257,7 +259,7 @@
         """
         Send a notice from C{nick} via the protocol.
         """
-        self.protocol.notice(self.nick, nick, msg)
+        self.protocol.notice(self.uid, nick, msg)
 
     def kill(self, nick, msg):
         """
@@ -300,7 +302,7 @@
         self.modes.remove(mode)
 
 
-class User(record('nick user host name modes signon server'), _ModesMixin):
+class User(record('cid nick user host name modes signon server'), _ModesMixin):
     """
     Represents the state of a single IRC user.
 
@@ -358,6 +360,8 @@
         self.users = {}
         self.channels = {}
 
+        self.ids = itertools.product(*[string.ascii_uppercase] * 6)
+
     def addService(self, service):
         self.handlers.append(service)
 
@@ -385,9 +389,10 @@
         return self.channels[channelName.lower()]
 
     def createUser(self, user):
-        nick = user['nick']
-        u = self.users[nick.lower()] = User(
-            nick=nick,
+        cid = user['cid']
+        u = self.users[cid.lower()] = User(
+            cid = cid,
+            nick=user['nick'],
             user=user['username'],
             host=user['hostname'],
             name=user['realname'],
@@ -411,8 +416,8 @@
             self.event('left', channel, user)
         self.users.pop(nick.lower())
 
-    def event_opertype(self, nick, opertype):
-        user = self.users[nick.lower()]
+    def event_opertype(self, cid, opertype):
+        user = self.users[cid.lower()]
         user.opertype = opertype
 
     def event_newserver(self, server, location):

=== modified file 'kali/protocol.py'
--- kali/protocol.py	2009-01-17 23:53:49 +0000
+++ kali/protocol.py	2012-01-15 17:06:23 +0000
@@ -208,7 +208,7 @@
 class InspircdServices(IRCServices):
     serviceModes = 'd'
 
-    userParamModes = ('', '')
+    userParamModes = ('s', '')
     channelParamModes = 'fjklJL'
     channelParamListModes = 'begI'
     channelUserModes = 'ahovq'
@@ -220,7 +220,7 @@
     channelPrefixes = '#'
 
     def startHandshake(self):
-        self.sendMessage('SERVER', self.params['name'], self.params['password'], '0', ':%(desc)s' % self.params)
+        self.sendMessage('SERVER', self.params['name'], self.params['password'], '0', self.params['sid'], ':%(desc)s' % self.params)
 
     def getTargetKind(self, target):
         """
@@ -232,7 +232,7 @@
             raise EmptyTarget(target)
         return dict.fromkeys(self.channelPrefixes, 'channel').get(target[0], 'user')
 
-    def irc_SERVER(self, source, name, password, hopcount, description):
+    def irc_SERVER(self, source, name, password, hopcount, sid, description):
         hopcount = int(hopcount)
         if hopcount == 0:
             # authentication phase
@@ -240,10 +240,10 @@
                 raise IRCBadMessage(source)
 
             # XXX: actually check auth
-            self.sendMessage('BURST', '%ld' % time.time())
-            self.sendMessage('VERSION', ':Ares X')
+            self.sendMessage('BURST', '%ld' % time.time(), prefix=self.params['sid'])
+            self.sendMessage('VERSION', ':Ares X', prefix=self.params['sid'])
             self.services.event('connected', self)
-            self.sendMessage('ENDBURST')
+            self.sendMessage('ENDBURST', prefix=self.params['sid'])
         else:
             self.services.event('newserver', name, description)
 
@@ -263,11 +263,11 @@
             user['servicestamp'] = 0
             self.services.createUser(user)
 
-    def irc_OPERTYPE(self, nick, opertype):
-        self.services.event('opertype', nick.decode('ascii'), opertype)
+    def irc_OPERTYPE(self, cid, opertype):
+        self.services.event('opertype', cid.decode('ascii'), opertype)
         # InspIRCd doesn't send MODE +o, so we fake it here to keep
         # our modes in sync with the network.
-        self.services.event('modeadded', None, nick.decode('ascii'), 'user', ('o', None))
+        self.services.event('modeadded', None, cid.decode('ascii'), 'user', ('o', None))
 
     def irc_BURST(self, prefix, stamp):
         pass
@@ -356,6 +356,12 @@
         for channel in channels.split(','):
             self.services.event('joined', channel, source)
 
+    def irc_PING(self, sid, source, target):
+        self.sendMessage('PONG', self.params['sid'], source, prefix=self.params['sid'])
+
+    def irc_PRIVMSG(self, source, target, msg):
+        self.services.event('privmsg', source, target, msg)
+
     def irc_PART(self, source, channel, message=''):
         self.services.event('parted', channel, source, message)
 
@@ -364,6 +370,31 @@
             server = self.params['name']
         self.sendMessage('NICK', '%ld' % time.time(), nick.encode('ascii'), host, host, user, '+' + modes, '0.0.0.0', ':%s' % name)
 
+    def irc_UID(self, source, *params):
+        if len(params) == 1:
+            pass
+        else:
+            paramNames = 'cid timestamp nick hostname fakehost username ip signontime modes modeparams realname'.split()
+
+            user = dict(zip(paramNames, params))
+            user['cid'] = user['cid'].decode('ascii')
+            user['nick'] = user['nick'].decode('ascii')
+            user['modes'] = user['modes'].lstrip('+')
+            user['modeparams'] = user['modeparams'].lstrip('+')
+            user['timestamp'] = int(user['timestamp'])
+            user['server'] = source
+            user['servicestamp'] = 0
+            self.services.createUser(user)
+
+    def newCID(self, cid, nick, realname, hostname, fakehost, ident, signon, modes, server=None):
+        if server is None:
+            server = self.params['name']
+        self.sendMessage('UID', '%s%s' % (self.params['sid'], cid.encode('ascii')), '%ld' % time.time(), nick, hostname, \
+                fakehost, ident, '0.0.0.0', '%ld' % signon, '+' + modes, ':%s' % realname, prefix=self.params['sid'])
+
+    def newServiceUID(self, cid, nick, realname, signon, modes):
+        return self.newCID(cid, nick, realname, 'services.', 'services.', nick.lower(), signon, ''.join(set(modes + self.serviceModes)), ':%s' % realname)
+
 
 class ServicesFactory(ReconnectingClientFactory):
     """