From 57a669d35dc70d21be0b799e893535fc26d95c6d Mon Sep 17 00:00:00 2001
From: Jeremy Stanley <fungi@yuggoth.org>
Date: Fri, 5 Oct 2018 17:07:41 +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).

Change-Id: I1a01eed8102b59818df247a93fbe4bf50148e76a
Co-Authored-By: Thierry Carrez <thierry@openstack.org>
Depends-On: https://review.openstack.org/608313
---
 doc/source/installation.rst |  4 +--
 gerritbot/bot.py            | 51 ++++++++++---------------------------
 requirements.txt            |  1 +
 3 files changed, 15 insertions(+), 41 deletions(-)

diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 1c4c5d7..2cbc2da 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -16,9 +16,7 @@ when starting the bot. It should look like::
   nick=NICKNAME
   pass=PASSWORD
   server=irc.freenode.net
-  port=6667
-  force_ssl=True or False (Defaults to False)
-  server_password=SERVERPASS
+  port=6697
   channel_config=/path/to/yaml/config (See below)
 
   [gerrit]
diff --git a/gerritbot/bot.py b/gerritbot/bot.py
index 8a60c71..d6cc226 100755
--- a/gerritbot/bot.py
+++ b/gerritbot/bot.py
@@ -21,9 +21,7 @@
 nick=NICKNAME
 pass=PASSWORD
 server=irc.freenode.net
-port=6667
-force_ssl=false
-server_password=SERVERPASS
+port=6697
 channel_config=/path/to/yaml/config
 pid=/path/to/pid_file
 use_mqtt=True
@@ -57,12 +55,13 @@ openstack-dev:
 
 import ConfigParser
 import daemon
+from ib3.auth import SASL
+from ib3.connection import SSL
 import irc.bot
 import json
 import logging.config
 import os
 import re
-import ssl
 import sys
 import threading
 import time
@@ -98,17 +97,14 @@ class Channel(object):
         self.last_used = time.time()
 
 
-class GerritBot(irc.bot.SingleServerIRCBot):
-    def __init__(self, channels, nickname, password, server, port=6667,
-                 force_ssl=False, server_password=None):
-        if force_ssl or port == 6697:
-            factory = irc.connection.Factory(wrapper=ssl.wrap_socket)
-            super(GerritBot, self).__init__([(server, port, server_password)],
-                                            nickname, nickname,
-                                            connect_factory=factory)
-        else:
-            super(GerritBot, self).__init__([(server, port, server_password)],
-                                            nickname, nickname)
+class GerritBot(SASL, SSL, irc.bot.SingleServerIRCBot):
+    def __init__(self, channels, nickname, password, server, port=6697):
+        super(GerritBot, self).__init__(
+            server_list=[(server, port)],
+            nickname=nickname,
+            realname=nickname,
+            ident_password=password,
+            channels=channels)
         self.all_channels = {}
         for name in channels:
             self.all_channels[name] = Channel(name)
@@ -117,24 +113,6 @@ class GerritBot(irc.bot.SingleServerIRCBot):
         self.password = password
         self.log = logging.getLogger('gerritbot')
 
-    def on_nicknameinuse(self, connection, event):
-        self.log.info('Nick previously in use, recovering.')
-        connection.nick(connection.get_nickname() + "_")
-        connection.privmsg("nickserv", "identify %s " % self.password)
-        connection.privmsg("nickserv", "ghost %s %s" % (self.nickname,
-                                                        self.password))
-        connection.privmsg("nickserv", "release %s %s" % (self.nickname,
-                                                          self.password))
-        time.sleep(1)
-        connection.nick(self.nickname)
-        self.log.info('Nick previously in use, recovered.')
-
-    def on_welcome(self, connection, event):
-        self.log.info('Identifying with IRC server.')
-        connection.privmsg("nickserv", "identify %s " % self.password)
-        self.log.info('Identified with IRC server.')
-        self.joined_channels = {}
-
     def send(self, channel_name, msg):
         self.log.info('Sending "%s" to %s' % (msg, channel_name))
         if channel_name not in self.joined_channels:
@@ -468,9 +446,7 @@ def _main(config):
                     config.get('ircbot', 'nick'),
                     config.get('ircbot', 'pass'),
                     config.get('ircbot', 'server'),
-                    config.getint('ircbot', 'port'),
-                    config.getboolean('ircbot', 'force_ssl'),
-                    config.get('ircbot', 'server_password'))
+                    config.getint('ircbot', 'port'))
     if config.has_option('ircbot', 'use_mqtt'):
         use_mqtt = config.getboolean('ircbot', 'use_mqtt')
     else:
@@ -499,8 +475,7 @@ def main():
         print("Usage: %s CONFIGFILE" % sys.argv[0])
         sys.exit(1)
 
-    config = ConfigParser.ConfigParser({'force_ssl': 'false',
-                                        'server_password': None})
+    config = ConfigParser.ConfigParser()
     config.read(sys.argv[1])
 
     pid_path = ""
diff --git a/requirements.txt b/requirements.txt
index 9c5c1d9..bde41b8 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,3 +5,4 @@ irc
 pyyaml
 python-daemon
 paho-mqtt>=1.2
+ib3