Merge lp:~marco-gallotta/ibid/channel-key into lp:~ibid-core/ibid/old-trunk-1.6

[marcog]

Provide the possibility to join a channel with a key. Only supported in IRC so far.

Provides the possibility to join a channel with a key. It only works online as I have not yet thought of a nice way to add a key to the config file.

[Stefano Rivera (stefanor)]

please update the help string

review: Needs Fixing

[Keegan Carruthers-Smith (keegan-csmith)]

You removed logging for source.irc.Ircbot.join. You also unneccessarily added the key=None argument to join, rather just leave join as before.

review: Needs Fixing

[Max Rabkin (max-rabkin)]

u'%s cannot join key-protected channels' should be u'I cannot join key-protected channels on %s'

review: Needs Fixing

[marcog (marco-gallotta)]

> u'%s cannot join key-protected channels' should be u'I cannot join key-protected channels on %s'

r960

>You removed logging for source.irc.Ircbot.join. You also unneccessarily added the key=None argument to join, rather just leave join as before.

r961

> please update the help string

r962

[lp:~marco-gallotta/ibid/channel-key]

960. By marcog on 2011-01-16

source cannot -> i cannot on source

961. By marcog on 2011-01-16

Put join()'s logging back and remove useless arg

962. By marcog on 2011-01-16

Update help string and allow option using/with in syntax

[Stefano Rivera (stefanor)]

"\s+(?:(?:using|with)?\s+" That requires two spaces without the using or with, right?

> def join_with_key(self, channel, key=None):

Why is key optional? In fact why do we need this method, can we not just add an optional argument to join?

[Stefano Rivera (stefanor)]

review: Needs Fixing

[lp:~marco-gallotta/ibid/channel-key]

963. By marcog on 2011-01-17

Remove useless group from channel join regex

[marcog (marco-gallotta)]

> "\s+(?:(?:using|with)?\s+" That requires two spaces without the using or with,
> right?
>
> > def join_with_key(self, channel, key=None):
>
> Why is key optional? In fact why do we need this method, can we not just add
> an optional argument to join?

join is an inherited method, so you can't change its arguments (afaik). I've made key non-optional here though (r964).

[lp:~marco-gallotta/ibid/channel-key]

964. By marcog on 2011-01-17

Make key required in join_with_key

[marcog (marco-gallotta)]

> "\s+(?:(?:using|with)?\s+" That requires two spaces without the using or with, right?

r965

[lp:~marco-gallotta/ibid/channel-key]

965. By marcog on 2011-01-17

Fix potential double-spaces in channel regex

[marcog (marco-gallotta)]

> why do we need this method, can we not just add an optional argument to join?

Now using single join_with_key and no join method (r966).

[lp:~marco-gallotta/ibid/channel-key]

966. By marcog on 2011-01-17

Change to single join_with_key method

[Stefano Rivera (stefanor)]

Why not use the same "join" name in the protocol, after all it's a pretty direct override of it.

[lp:~marco-gallotta/ibid/channel-key]

967. By marcog on 2011-01-18

Rather override join

[marcog (marco-gallotta)]

> Why not use the same "join" name in the protocol, after all it's a pretty
> direct override of it.

Sorry, I was being daft. I totally missed the join_with_key I added in SourceFactory many months ago which was causing issues doing this. It's done and works now (r967).

[Stefano Rivera (stefanor)]

One more: Can we use $factory.supports instead of catching TypeError?

review: Needs Fixing

[marcog (marco-gallotta)]

> One more: Can we use $factory.supports instead of catching TypeError?

r968

[lp:~marco-gallotta/ibid/channel-key]

968. By marcog on 2011-01-20

Use $factory.supports instead of catching TypeError

[Stefano Rivera (stefanor)]

review: Approve

[Stefano Rivera (stefanor)]

What about keys for autojoined channels?

[Stefano Rivera (stefanor)]

> What about keys for autojoined channels?

Marco says this will be handled in a future branch. That's ok with me.

[Max Rabkin (max-rabkin)]

review: Approve

=== modified file 'ibid/plugins/sources.py'
--- ibid/plugins/sources.py	2010-09-30 21:25:01 +0000
+++ ibid/plugins/sources.py	2011-01-20 10:54:11 +0000
@@ -20,15 +20,15 @@
 }
 
 class Actions(Processor):
-    usage = u"""(join|part|leave) [<channel> [on <source>]]
+    usage = u"""(join|part|leave) [<channel> [on <source>] [using key <key>]]
     change nick to <nick> [on <source>]"""
     features = ('actions',)
 
     permission = 'sources'
 
-    @match(r'^(join|part|leave)(?:\s+(\S*))?(?:\s+on\s+(\S+))?$')
+    @match(r'^(join|part|leave)(?:\s+(\S*))?(?:\s+on\s+(\S+))?(?:(?:\s+(?:using|with))?\s+(?:key\s+)?(\S+))?$')
     @authorise()
-    def channel(self, event, action, channel, source):
+    def channel(self, event, action, channel, source, key):
         action = action.lower()
 
         if not source:
@@ -45,11 +45,18 @@
         source = ibid.sources[source]
 
         if not hasattr(source, 'join'):
-            event.addresponse(u'%s cannot join/part channels', source.name)
+            event.addresponse(u'I cannot join/part channels on %s', source.name)
             return
 
         if action == 'join':
-            source.join(channel)
+            if key:
+                if 'channel key' in source.supports:
+                    source.join(channel, key)
+                else:
+                    event.addresponse(u'I cannot use keys on %s', source.name)
+                    return
+            else:
+                source.join(channel)
             event.addresponse(u'Joining %s', channel)
         else:
             source.leave(channel)
@@ -69,7 +76,7 @@
         source = ibid.sources[source]
 
         if not hasattr(source, 'change_nick'):
-            event.addresponse(u'%s cannot change nicks', source)
+            event.addresponse(u'I cannot change nicks on %s', source)
         else:
             source.change_nick(nick)
             event.addresponse(u'Changing nick to %s', nick)

=== modified file 'ibid/source/irc.py'
--- ibid/source/irc.py	2010-12-24 16:40:41 +0000
+++ ibid/source/irc.py	2011-01-20 10:54:11 +0000
@@ -208,9 +208,13 @@
             self.msg(raw_target, raw_message)
             self.factory.log.debug(u"Sent privmsg to %s: %s", target, message)
 
-    def join(self, channel):
-        self.factory.log.info(u"Joining %s", channel)
-        irc.IRCClient.join(self, channel.encode('utf-8'))
+    def join(self, channel, key=None):
+        if key:
+            self.factory.log.info(u"Joining %s with key %s", channel, key)
+            key = key.encode('utf-8')
+        else:
+            self.factory.log.info(u"Joining %s", channel)
+        irc.IRCClient.join(self, channel.encode('utf-8'), key)
 
     def joined(self, channel):
         event = Event(self.factory.name, u'source')
@@ -300,7 +304,7 @@
     protocol = Ircbot
 
     auth = ('hostmask', 'nickserv')
-    supports = ('action', 'notice', 'topic')
+    supports = ('action', 'notice', 'topic', 'channel key')
 
     port = IntOption('port', 'Server port number', 6667)
     ssl = BoolOption('ssl', 'Use SSL', False)
@@ -345,8 +349,8 @@
             self.proto.transport.loseConnection()
         return True
 
-    def join(self, channel):
-        return self.proto.join(channel)
+    def join(self, channel, key=None):
+        return self.proto.join(channel, key)
 
     def leave(self, channel):
         return self.proto.leave(channel)