From 2dee000b7f6cdf9371f3737032735c57ae092c67 Mon Sep 17 00:00:00 2001
From: Jeremy Stanley <fungi@yuggoth.org>
Date: Fri, 31 Aug 2018 18:13:42 +0000
Subject: [PATCH] Identify with SASL

Identify through SASL using the convenient ib3 mixins, and
get rid of a bunch of special-case code in the process.

This helps when dealing with channels set to require identified
users, as otherwise channel joins will race NickServ's processing of
the identify message and some channels will end up not serviced by
the bot (an alternative would be to delay joining channels until the
identify success is confirmed, but the implementation for that looks
like it would be at least as complex).

Note this also effectively drops non-SSL IRC support. Given
passwords are sent over this connection, I don't see it as a loss.

Change-Id: I0aa15d81f0158fcf2b74825cdb3968d62356fa1d
Co-Authored-By: Thierry Carrez <thierry@openstack.org>
---
 requirements.txt |  1 +
 statusbot/bot.py | 53 ++++++++++++++----------------------------------
 2 files changed, 16 insertions(+), 38 deletions(-)

diff --git a/requirements.txt b/requirements.txt
index 5666697..0a71d11 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,3 +5,4 @@ irc
 python-daemon
 kitchen
 python-twitter>=3.4
+ib3
diff --git a/statusbot/bot.py b/statusbot/bot.py
index 8811609..88951ca 100644
--- a/statusbot/bot.py
+++ b/statusbot/bot.py
@@ -21,7 +21,7 @@
 nick=NICKNAME
 pass=PASSWORD
 server=irc.freenode.net
-port=6667
+port=6697
 channels=foo,bar
 nicks=alice,bob
 
@@ -48,6 +48,8 @@ access_token_secret=access_token_secret
 import argparse
 import ConfigParser
 import daemon
+from ib3.auth import SASL
+from ib3.connection import SSL
 import irc.bot
 import json
 import logging.config
@@ -57,7 +59,6 @@ import time
 import simplemediawiki
 import datetime
 import re
-import ssl
 import twitter
 import urllib
 
@@ -312,21 +313,16 @@ class AlertFile(UpdateInterface):
         self.write(None)
 
 
-class StatusBot(irc.bot.SingleServerIRCBot):
+class StatusBot(SASL, SSL, irc.bot.SingleServerIRCBot):
     log = logging.getLogger("statusbot.bot")
 
     def __init__(self, channels, nicks, publishers, successlog, thankslog,
-                 nickname, password, server, port=6667):
-        if port == 6697:
-            factory = irc.connection.Factory(wrapper=ssl.wrap_socket)
-            irc.bot.SingleServerIRCBot.__init__(self,
-                                                [(server, port)],
-                                                nickname, nickname,
-                                                connect_factory=factory)
-        else:
-            irc.bot.SingleServerIRCBot.__init__(self,
-                                                [(server, port)],
-                                                nickname, nickname)
+                 nickname, password, server, port=6697):
+        super(StatusBot, self).__init__(
+            server_list=[(server, port)],
+            nickname=nickname,
+            realname=nickname,
+            ident_password=password)
         self.channel_list = channels
         self.nicks = nicks
         self.nickname = nickname
@@ -338,32 +334,13 @@ class StatusBot(irc.bot.SingleServerIRCBot):
         self.successlog = successlog
         self.thankslog = thankslog
 
-    def on_nicknameinuse(self, c, e):
-        self.log.debug("Nickname in use, releasing")
-        c.nick(c.get_nickname() + "_")
-        c.privmsg("nickserv", "identify %s " % self.password)
-        c.privmsg("nickserv", "ghost %s %s" % (self.nickname, self.password))
-        c.privmsg("nickserv", "release %s %s" % (self.nickname, self.password))
-        time.sleep(ANTI_FLOOD_SLEEP)
-        c.nick(self.nickname)
-
-    def on_welcome(self, c, e):
-        self.identify_msg_cap = False
-        self.log.debug("Requesting identify-msg capability")
-        c.cap('REQ', 'identify-msg')
-        c.cap('END')
-        self.log.debug("Identifying to nickserv")
-        c.privmsg("nickserv", "identify %s " % self.password)
-        for channel in self.channel_list:
-            self.log.info("Joining %s" % channel)
-            c.join(channel)
-            time.sleep(ANTI_FLOOD_SLEEP)
-
     def on_cap(self, c, e):
         self.log.debug("Received cap response %s" % repr(e.arguments))
-        if e.arguments[0] == 'ACK' and 'identify-msg' in e.arguments[1]:
-            self.log.debug("identify-msg cap acked")
-            self.identify_msg_cap = True
+        if e.arguments[0] == 'ACK' and 'sasl' in e.arguments[1]:
+            for channel in self.channel_list:
+                self.log.info("Joining %s" % channel)
+                c.join(channel)
+                time.sleep(ANTI_FLOOD_SLEEP)
 
     def on_pubmsg(self, c, e):
         if not self.identify_msg_cap: