attempt to refactor IRC reconnect

bspkrs · bspkrs · commit f1ca8eff4590 · 2015-01-06T11:02:42.000-05:00
diff --git a/AsyncSocket.py b/AsyncSocket.py
@@ -55,9 +55,6 @@ def handle_connect(self):
     def handle_close(self):
         self.logger.info("Closing Socket")
         self.close()
-        # if not self.bot.isTerminating:
-        #     self.logger.info('Throwing sys.exit(408)')
-        #     sys.exit(408)
 
     def handle_read(self):
         self.recvBuffer = self.recvBuffer + self.recv(8192)
diff --git a/BotBase.py b/BotBase.py
@@ -13,61 +13,67 @@
 from IRCHandler import CmdHandler,CmdGenerator,Sender,Color, EOL
 from ConfigHandler import AdvConfigParser
 
-# TODO: Refactor the bothandler to be per-bot and have it handle reconnect.
-# TODO: There should be a new class BotManager that maintains a list of BotHandlers that are running.
+
 class BotHandler(object):
-    botList = {}
-
-    @classmethod
-    def addBot(cls, botname, bot):
-        if not botname in cls.botList or not cls.botList[botname]:
-            cls.botList[botname] = bot
-
-    @classmethod
-    def remBot(cls, botname):
-        if botname in cls.botList and cls.botList[botname]:
-            retval = cls.botList[botname]
-            cls.botList.__delitem__(botname)
-            retval.onShuttingDown()
-            return retval
-        return None
-
-    @classmethod
-    def runAll(cls):
-        cls.startAll()
-        cls.loop()
-
-    @classmethod
-    def setAllKilled(cls):
-        for bot in cls.botList.values():
-            bot.isTerminating = True
-
-    @classmethod
-    def stopAll(cls):
-        for bot in cls.botList.values():
-            bot.onShuttingDown()
-
-    @classmethod
-    def loop(cls):
-        try:
-            asyncore.loop()
-        except KeyboardInterrupt as e:
-            print("Keyboard Interrupt: Shutting down.")
-            cls.setAllKilled()
-            cls.stopAll()
-        except:
-            print('Other Exception: Shutting down.')
-            cls.stopAll()
-            raise
 
-    @classmethod
-    def startAll(cls):
-        for bot in cls.botList.values():
-            bot.onStartUp()
-            bot.connect()
+    def __init__(self, bot, reconnect_wait=15, reset_attempt_secs=300, max_reconnects=10):
+        self.bot = bot
+        self.reconnect_wait = reconnect_wait
+        self.reset_attempt_secs = reset_attempt_secs
+        self.max_reconnects = max_reconnects
+
+    def start(self):
+        self.bot.onStartUp()
+        self.bot.connect()
+        return self
+
+    def stop(self):
+        self.bot.onShuttingDown()
+        return self
+
+    def setKilled(self):
+        self.bot.isTerminating = True
+        return self
+
+    def run(self):
+        restart = True
+        last_start = 0
+        reconnect_attempts = 0
+
+        while restart:
+            if last_start != 0 and reconnect_attempts != 0:
+                self.bot.logger.warning('Attempting IRC reconnection in %d seconds...' % self.reconnect_wait)
+                time.sleep(self.reconnect_wait)
+
+            last_start = time.time()
+
+            if not self.bot.isRunning:
+                self.bot.resetSockets()
+                self.start()
+
+            try:
+                asyncore.loop()
+            except KeyboardInterrupt as e:
+                print("Keyboard Interrupt: Shutting down.")
+                self.stop()
+                restart = False
+            except:
+                print('Other Exception: Shutting down.')
+                self.stop()
+                raise
+
+            if not self.bot.isTerminating:
+                self.bot.logger.warning('IRC connection was lost.')
+
+                if time.time() - last_start > self.reset_attempt_secs:
+                    reconnect_attempts = 0
+
+                reconnect_attempts += 1
+                restart = reconnect_attempts <= self.max_reconnects
+
 
 class BotBase(object):
-    def __init__(self, configfile = None, nspass = None, backupcfg=False):
+    def __init__(self, configfile=None, nspass=None, backupcfg=False):
         self.configfile = configfile if configfile else 'bot.cfg'
 
         if backupcfg and os.path.exists(self.configfile):
@@ -146,20 +152,17 @@ def __init__(self, configfile = None, nspass = None, backupcfg=False):
         self.isIdentified = False   #Turn to true when nick/ident commands are sent
         self.isReady      = False   #Turn to true after RPL_ENDOFMOTD. Every join/nick etc commands should be sent once this is True.
         self.isTerminating     = False   #This is set to true by the stop command to bypass restarting
-        self.isRunning = True
+        self.isRunning = False
 
-        self.socket = AsyncSocket.AsyncSocket(self, self.host, self.port, self.floodLimit)
-        self.dccSocketv4 = DCCSocket.DCCSocket(self, False)
-        if socket.has_ipv6:
-            try:
-                self.dccSocketv6 = DCCSocket.DCCSocket(self, True)
-            except socket.error, e:
-                if e.message.find('A socket operation was attempted to an unreachable network') != -1:
-                    self.dccSocketv6 = None
-        self.cmdHandler = CmdHandler(self, self.socket)
+        self.socket = None
+        self.dccSocketv4 = None
+        self.dccSocketv6 = None
+        self.resetSockets()
+        self.cmdHandler = CmdHandler(self)
 
-        self.registerCommand('dcc',  self.requestDCC, ['any'], 0, 0, "",        "Requests a DCC connection to the bot.")
-        self.registerCommand('more', self.sendMore,   ['any'], 0, 1, "[clear]", 'Gets the next %d queued command results. Commands that can queue results will tell you so.' % self.moreCount)
+        self.registerCommand('dcc',  self.requestDCC, ['any'], 0, 0, "",            "Requests a DCC connection to the bot.")
+        #self.registerCommand('pub',  self.pubCmd,     ['any'], 1, 999, "<command>", "Executes a command and sends the results to the destination channel.")
+        self.registerCommand('more', self.sendMore,   ['any'], 0, 1, "[clear]",     'Gets the next %d queued command results. Commands that can queue results will tell you so.' % self.moreCount)
 
         self.registerCommand('useradd',  self.useradd,   ['admin'], 2, 2, "<user> <group>","Adds user to group.")
         self.registerCommand('userrm',   self.userrm,    ['admin'], 2, 2, "<user> <group>","Removes user from group.")
@@ -171,7 +174,6 @@ def __init__(self, configfile = None, nspass = None, backupcfg=False):
         self.registerCommand('groupget',  self.groupget,   ['admin'], 0, 0, "",              "Returns a list of groups and commands.")
         self.registerCommand('groupmeta', self.groupmeta,  ['admin'], 3, 999, "<group> <key> <value>", "Add a value to a group key")
 
-
         self.registerCommand('banadd', self.banadd, ['admin'], 2, 2, "<user|host> <cmd>", "Bans the user from using the specified command.")
         self.registerCommand('banrm',  self.banrm,  ['admin'], 2, 2, "<user|host> <cmd>", "Remove a ban on an user.")
         self.registerCommand('banget', self.banget, ['admin'], 1, 1, "<user|host>",       "Returns the ban list for the given user.")
@@ -184,6 +186,62 @@ def __init__(self, configfile = None, nspass = None, backupcfg=False):
         if self.about_msg and self.about_msg != '':
             self.registerCommand('about', self.aboutcmd, ['any'], 0, 0, '', 'About this bot.')
 
+    def resetSockets(self):
+        self.socket = AsyncSocket.AsyncSocket(self, self.host, self.port, self.floodLimit)
+        self.dccSocketv4 = DCCSocket.DCCSocket(self, False)
+        if socket.has_ipv6:
+            try:
+                self.dccSocketv6 = DCCSocket.DCCSocket(self, True)
+            except socket.error, e:
+                if e.message.find('A socket operation was attempted to an unreachable network') != -1:
+                    self.dccSocketv6 = None
+
+    def run(self):
+        if self.host == "":
+            self.logger.error("Please set an IRC server in the config file.")
+            return
+
+        self.onStartUp()
+        self.connect()
+        try:
+            asyncore.loop()
+        except KeyboardInterrupt as e:
+            self.logger.info("Shutting down.")
+            if not self.isTerminating:
+                self.isTerminating = True
+                self.onShuttingDown()
+        except:
+            self.onShuttingDown()
+            raise
+
+    def connect(self):
+        self.isRunning = True
+        self.socket.doConnect()
+
+    def onStartUp(self):
+        pass
+
+    def onShuttingDown(self):
+        if self.isRunning:
+            self.logger.info('Shutting down bot')
+            if self.cmdHandler.monitor_thread:
+                self.cmdHandler.monitor_thread.cancel()
+            for user in self.users.values():
+                if user.dccSocket:
+                    user.dccSocket.handle_close()
+
+            self.isRunning = False
+            self.isReady = False
+            self.isIdentified = False
+            self.dccSocketv4.handle_close()
+            if self.dccSocketv6:
+                self.dccSocketv6.handle_close()
+            self.socket.handle_close()
+
+    def killSelf(self, bot, sender, dest, cmd, args):
+        self.logger.info("Killing self.")
+        self.isTerminating = True
+
     # User handling commands
     def useradd(self, bot, sender, dest, cmd, args):
         user  = args[0].lower()
@@ -348,7 +406,7 @@ def helpcmd(self, bot, sender, dest, cmd, args):
             maxcmdlen    = len(max(self.cmdHandler.commands.keys(), key=len))
             maxargslen   = len(max([i['descargs'] for i in self.cmdHandler.commands.values()], key=len))
 
-            formatstr = "§B%%%ds %%%ds§N : %%s"%(maxcmdlen * -1, maxargslen * -1)
+            formatstr = "§B%%%ds %%%ds§N : %%s" %(maxcmdlen * -1, maxargslen * -1)
             showall = len(args) > 0 and args[0] == '*'
             allowedcmds = []
 
@@ -507,49 +565,6 @@ def updateConfig(self):
 
             self.config.write(fp)
 
-    def run(self):
-        if self.host == "":
-            self.logger.error("Please set an IRC server in the config file.")
-            return
-
-        self.onStartUp()
-        self.connect()
-        try:
-            asyncore.loop()
-        except KeyboardInterrupt as e:
-            self.logger.info("Shutting down.")
-            if not self.isTerminating:
-                self.isTerminating = True
-                self.onShuttingDown()
-        except:
-            self.onShuttingDown()
-            raise
-
-    def connect(self):
-        self.socket.doConnect()
-
-    def onStartUp(self):
-        pass
-
-    def onShuttingDown(self):
-        if self.isRunning:
-            self.logger.info('Shutting down bot')
-            if self.cmdHandler.monitor_thread:
-                self.cmdHandler.monitor_thread.cancel()
-            for user in self.users.values():
-                if user.dccSocket:
-                    user.dccSocket.handle_close()
-
-            self.isRunning = False
-            self.dccSocketv4.handle_close()
-            if self.dccSocketv6:
-                self.dccSocketv6.handle_close()
-            self.socket.handle_close()
-
-    def killSelf(self, bot, sender, dest, cmd, args):
-        self.logger.info("Killing self.")
-        self.isTerminating = True
-
     #IRC COMMANDS QUICK ACCESS
     def sendRaw(self, msg):
         for line in [line.strip('\r\n') for line in msg.split(EOL) if line.strip('\r\n') != '']:
diff --git a/IRCHandler.py b/IRCHandler.py
@@ -197,9 +197,8 @@ def getDurationStr(timeint):
     return time.strftime(formatstr, time.gmtime(timeint))
 
 class CmdHandler(object):
-    def __init__(self, bot, socket):
+    def __init__(self, bot):
         self.bot     = bot
-        self.socket  = socket
         self.sender  = ""
         self.cmd     = ""
         self.params  = []
@@ -508,22 +507,22 @@ def onCOMMAND(self, sender, dest, command):
 
         if len(args) < cmd['minarg'] or len(args) > cmd['maxarg']:
             if cmd['descargs']:
-                self.bot.sendNotice(sender.nick, "Wrong syntax : %s"%cmd['descargs'])
+                self.bot.sendNotice(sender.nick, "Wrong syntax : %s" % cmd['descargs'])
                 return
             else:
-                self.bot.sendNotice(sender.nick, "Wrong number of arguments : min = %s, max = %s"%(cmd['minarg'], cmd['maxarg']))
+                self.bot.sendNotice(sender.nick, "Wrong number of arguments : min = %s, max = %s" % (cmd['minarg'], cmd['maxarg']))
                 return                
 
         #We already know this sender
         if sender.nick in self.bot.users and sender == self.bot.users[sender.nick]:
-            self.logger.info("Found user %s in current users"%sender.nick)
+            self.logger.info("Found user %s in current users" % sender.nick)
             
             if -1 < self.bot.authtimeout < time.time() - self.bot.users[sender.nick].lastAuth:
                 self.bot.users[sender.nick].unauthenticate()
             
             # If current auth is not 3, we retry to authenticate the account but resending the request and resetting the flags
             if self.bot.users[sender.nick].auth != 3:
-                self.logger.info("Reauthenticating user %s"%sender.nick)
+                self.logger.info("Reauthenticating user %s" % sender.nick)
                 self.bot.users[sender.nick].unauthenticate()
                 self.bot.sendRaw(self.bot.nickAuth.format(nickserv=self.bot.nickserv, nick=sender.nick) + EOL)
                 self.bot.sendRaw(CmdGenerator.getWHOIS(sender.nick))
@@ -532,7 +531,7 @@ def onCOMMAND(self, sender, dest, command):
             cmdThread.start()
 
         else:
-            self.logger.info("Adding and authenticating user %s"%sender.nick)
+            self.logger.info("Adding and authenticating user %s" % sender.nick)
             self.bot.users[sender.nick] = sender
             self.bot.sendRaw(self.bot.nickAuth.format(nickserv=self.bot.nickserv, nick=sender.nick) + EOL)
             self.bot.sendRaw(CmdGenerator.getWHOIS(sender.nick))
diff --git a/MCPBot.py b/MCPBot.py
