def __init__(self, debug=0, settings_path=None):
Irc.__init__(self, debug)
self.__plugins = {}
self.__commands = {}
# Register command handler on privmsg event queue
self.event.register('PRIVMSG', self.__parse_commands)
# Register some internal commands
self.plugin_register('purplebot.plugins.core')
self.settings = Settings(settings_path)
self.settings.load()
self.block = BlockList(self.settings)
signal.signal(signal.SIGUSR1, self.__reload_plugins)
def setUp(self): self.settings = Settings()
class TestSettings(unittest.TestCase):
"""Test the settings within the framework of the bot"""
def setUp(self):
self.settings = Settings()
def test_set_function(self):
key = 'Testing'
val = 'test value'
self.settings.set(key, val)
assert val == self.settings.get(key)
def test_missing(self):
key = 'Missing value'
assert None == self.settings.get(key)
def test_saving(self):
assert self.settings.save() == True
def test_loading(self):
assert self.settings.load() == True
def test_getitem(self):
key = 'Testing'
self.settings.set('Testing', 'foo')
assert 'foo' == self.settings.get(key)
def test_setitem(self):
key = 'setitem'
val = 'some value'
self.settings[key] = val
assert self.settings[key] == val
def test_required(self):
key = 'requiredvalue'
with self.assertRaises(BotError):
self.settings.required(key)
class bot(Irc):
"""Mostly simple IRC Bot framework"""
def __init__(self, debug=0, settings_path=None):
Irc.__init__(self, debug)
self.__plugins = {}
self.__commands = {}
# Register command handler on privmsg event queue
self.event.register('PRIVMSG', self.__parse_commands)
# Register some internal commands
self.plugin_register('purplebot.plugins.core')
self.settings = Settings(settings_path)
self.settings.load()
self.block = BlockList(self.settings)
signal.signal(signal.SIGUSR1, self.__reload_plugins)
def __reload_plugins(self, signum, sigframe):
logger.info('Bot recieved signal %s', signum)
logger.info('Reloading Settings')
self.settings.load()
self.block = BlockList(self.settings)
logger.info('Reloading Plugins')
for plugin in self.__plugins:
plugin = plugin.replace('_', '.')
logger.info('Reloading %s', plugin)
self.plugin_unregister(plugin)
self.plugin_register(plugin)
@ignore_self
def __parse_commands(self, bot, line):
# '[":hostname(sender)","PRIVMSG","reciever(#channel or nick)",":*",*]'
try:
nick, host = parse_hostmask(line[0])
if self.block.check(line[0]):
return # Ignore messages from blocked users
commandstr = line[3].lstrip(':')
if commandstr in list(self.__commands.keys()):
cmd = self.__commands[commandstr]
if hasattr(cmd, 'alias'):
logger.info('Alias command %s => %s', commandstr, cmd.alias)
if cmd.alias not in list(self.__commands.keys()):
raise CommandError('Invalid Alias')
cmd = self.__commands[cmd.alias]
if hasattr(cmd, 'disabled') and cmd.disabled is True:
logger.debug('%s has been disabled', cmd.command)
return
else:
cmd(self, {'nick': nick, 'host': host}, line)
except CommandError as e:
logger.exception('CommandError', exc_info=True)
self.irc_notice(nick, e.__str__())
except Exception as e:
logger.exception('Error processing commands\n%s', line, exc_info=True)
self.irc_notice(nick, 'There was an error processing that command')
if self._debugvar >= 2:
raise
def alias_add(self, alias, command):
def alias_func():
pass
if alias in list(self.__commands.keys()):
raise BotError('Alias cannot overwrite existing object')
alias_func.alias = command
self.__commands[alias] = alias_func
def alias_remove(self, alias):
if alias not in list(self.__commands.keys()):
raise BotError('Invalid alias name')
cmd = self.__commands[alias]
if not hasattr(cmd, 'alias'):
raise BotError('Invalid alias')
self.__commands.pop(alias)
def plugin_register(self, module):
"""Register a new plugin
:param module: Module name in dot format. Ex my.plugin
:type module: str
"""
if module in list(self.__plugins.keys()):
logger.warning('Already loaded module %s', module)
return True
try:
# We want to split off the last part of the module name
# so that we can get just the module we want instead of
# the entire stack
name = module.split('.').pop()
mod = __import__(module, fromlist=[name])
logger.info('Registering %s', mod.__purple__)
except ImportError:
logger.exception('Error importing %s', module)
return False
except AttributeError:
logger.exception('Incomptable module %s', module)
return False
except Exception:
logger.exception('Unknown Error loading plugin %s', module)
if self._debugvar >= 2:
raise
return False
else:
self.__plugins[module] = mod
for name, obj in vars(mod).items():
if name == 'load':
logger.info('Running %s plugin load event', module)
obj(self)
if hasattr(obj, 'command'):
logger.info('Loading command: %s', obj.command)
self.__commands[obj.command] = obj
if hasattr(obj, 'event'):
logger.info('Loading %s event: %s', obj.event, name)
self.event.register(obj.event, obj)
def plugin_unregister(self, module):
"""Unregister a plugin
:param module: Module name in dot format. Ex my.plugin
:type module: str
"""
module = module.replace('.', '_')
if module not in list(self.__plugins.keys()):
return False
try:
mod = self.__plugins[module]
except Exception:
logger.debug('Error unloading plugin %s', module)
if self._debugvar >= 2:
raise
return False
else:
for name, obj in vars(mod).items():
if name == 'unload':
logger.debug('Running %s plugin unload event', module)
obj(self)
if hasattr(obj, 'command'):
logger.debug('Unloading command: %s', obj.command)
self.__commands.pop(obj.command)
if hasattr(obj, 'event'):
logger.debug('Unloading %s event: %s', obj.event, name)
self.event.unregister(obj.event, obj)
self.__plugins.pop(module)
def __cmd_version(self, bot, hostmask, line):
bot.irc_ctcp_reply(line, '1.1')
def kill(self):
for p in list(self.__plugins.keys()):
self.plugin_unregister(p)
self.event.unregister('PRIVMSG', self.__parse_commands)
self.running = False
def command_help(self, cmd):
if cmd in list(self.__commands.keys()):
if hasattr(self.__commands[cmd], 'example'):
return self.__commands[cmd].example
else:
return 'No help for that command'
else:
return 'Invalid Command'
def plugin_list(self):
"""Return a list of currently loaded plugins"""
return list(self.__plugins.keys())
def command_enable(self, cmd):
if cmd in list(self.__commands.keys()):
logger.info('Enable command %s', cmd)
cmd = self.__commands[cmd]
cmd.disabled = False
def command_disable(self, cmd):
if cmd in list(self.__commands.keys()):
logger.info('Disable command %s', cmd)
cmd = self.__commands[cmd]
cmd.disabled = True
def timedelay(self, time, func, args):
threading.Timer(time, func, args).start()
def __str__(self):
return '%s' % (self.settings)