added ability to define basic text info commands in the config file

Author: bspkrs

Diff for: BotBase.py

@@ -118,7 +118,6 @@ def __init__(self, configfile=None, nspass=None, backupcfg=False):
         self.logerrorsmaxbytes = self.config.geti('BOT', 'LOGERRORSMAXBYTES', str(1024*1024), "The log will be rotated when its size reaches this many bytes.")
         self.help_url    = self.config.get('BOT', 'HELP_URL',  '')
         self.primary_channels = set(self.config.get('BOT','PRIMARY_CHANNELS', '', 'Important bot messages will be sent to Ops in these channels.').split(';') if self.config.get('BOT','PRIMARY_CHANNELS', "").strip() else [])
-        self.about_msg   = self.config.get('BOT', 'ABOUT_MSG', '', 'A message with info about the bot (owners, authors, more info, etc).')
 
         self.allowunregistered = self.config.getb('AUTH', 'ALLOWUNREGISTERED', "true", 'Can users without a registered nick emit commands?')
         self.authtimeout       = self.config.geti('AUTH', 'TIMEOUT', "60", 'User authentication refresh delay in seconds. User auth will be considered valid for this period.')
@@ -150,6 +149,7 @@ def __init__(self, configfile=None, nspass=None, backupcfg=False):
 
         self.logger.info("Users  : %s"%self.authUsers)
         self.logger.info("Groups : %s"%self.groups)
+        self.txtcmds = {}
 
         self.updateConfig()
 
@@ -196,8 +196,13 @@ def __init__(self, configfile=None, nspass=None, backupcfg=False):
         self.registerCommand('shutdown', self.killSelf, ['admin'], 0, 0, "", "Kills the bot.")
 
         self.registerCommand('help',      self.helpcmd,    ['any'],   0, 1, "[<command>|*]", "Lists available commands or help about a specific command.", allowpub=True)
-        if self.about_msg and self.about_msg != '':
-            self.registerCommand('about', self.aboutcmd, ['any'], 0, 0, '', 'About this bot.', allowpub=True)
+
+        # We collect the list of simple text commands)
+        for option in self.config.options('TEXTCOMMANDS'):
+            self.addtxtcmd(option, json.loads(self.config.get('TEXTCOMMANDS',option)))
+
+        if 'about' not in self.txtcmds.keys():
+            self.addtxtcmd('about', {})
 
     def clone(self):
         return BotBase(self.configfile, self.nspass, self.backupcfg)
@@ -406,6 +411,31 @@ def groupmeta(self, bot, sender, dest, cmd, args):
         bot.sendNotice(sender.nick, "Done")
         self.updateConfig()
 
+    def addtxtcmd(self, cmd, data):
+        if cmd.lower() not in self.txtcmds.keys() and cmd.lower() not in self.cmdHandler.commands.keys():
+            data = self.addmissingkeys(data)
+            self.txtcmds[cmd.lower()] = data
+            if data['text'] and data['text'] != '':
+                self.registerCommand(cmd.lower(), self.txtcmd, data.get('groups'), 0, 0, '', data.get('helpdesc', ''), showhelp=data.get('showhelp', True), allowpub=data.get('allowpub', True))
+        else:
+            self.logger.warning('Attempted to register duplicate command %s' % cmd)
+
+    def addmissingkeys(self, data):
+        if 'groups' not in data.keys():
+            data['groups'] = ['any']
+        if 'helpdesc' not in data.keys():
+            data['helpdesc'] = ''
+        if 'showhelp' not in data.keys():
+            data['showhelp'] = True
+        if 'allowpub' not in data.keys():
+            data['allowpub'] = True
+        if 'text' not in data.keys():
+            data['text'] = ''
+        return data
+
+    def txtcmd(self, bot, sender, dest, cmd, args):
+        bot.sendOutput(dest, self.txtcmds[cmd['command']]['text'])
+
     # Default help command
     def helpcmd(self, bot, sender, dest, cmd, args):
         if len(args) == 0 or args[0] == '*':
@@ -459,9 +489,6 @@ def helpcmd(self, bot, sender, dest, cmd, args):
             else:
                 bot.sendNotice(sender.nick, "§B*** Invalid command specified ***")
 
-    def aboutcmd(self, bot, sender, dest, cmd, args):
-        self.sendOutput(dest, self.about_msg)
-
     # DCC Request command, in by default
     def requestDCC(self, bot, sender, dest, cmd, args):
         if self.dccActive:
@@ -570,6 +597,9 @@ def updateConfig(self):
             for user, bans in self.banList.items():
                 self.config.set('BANLIST',user, ';'.join(bans))
 
+            for command, data in self.txtcmds.items():
+                self.config.set('TEXTCOMMANDS', command, json.dumps(data))
+
             self.config.write(fp)
 
     #IRC COMMANDS QUICK ACCESS