X-Git-Url: http://git.kaliko.me/?p=sid.git;a=blobdiff_plain;f=sid%2Fsid.py;h=fadb79e172ec77de117f9b2696f13d437f5fa6ee;hp=82dcab560d3ee1810e1b21bd32d32c184f053804;hb=1c1134e00f13fee92f9a0e0996d08db32579d89a;hpb=efde726294d04e02bb52c15ad2c9ebdb696c98cf diff --git a/sid/sid.py b/sid/sid.py index 82dcab5..fadb79e 100644 --- a/sid/sid.py +++ b/sid/sid.py @@ -2,7 +2,7 @@ # Copyright (C) 2007-2012 Thomas Perl # Copyright (C) 2010, 2011 Anaël Verrier -# Copyright (C) 2014 kaliko +# Copyright (C) 2014, 2015, 2020 kaliko # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -21,11 +21,15 @@ import inspect import logging import traceback -import sleekxmpp +import slixmpp def botcmd(*args, **kwargs): - """Decorator for bot command functions""" + """Decorator for bot command functions + + :param bool hidden: is the command hidden in global help + :param str name: command name, default to decorated function name + """ def decorate(func, hidden=False, name=None): setattr(func, '_bot_command', True) @@ -41,12 +45,21 @@ def botcmd(*args, **kwargs): return lambda func: decorate(func, **kwargs) -class MUCBot(sleekxmpp.ClientXMPP): +class MUCBot(slixmpp.ClientXMPP): + """ + :param str jid: jid to log with + :param str password: jid password + :param str room: conference room to join + :param str nick: Nickname to use in the room + """ + #: Class attribute to define bot's command prefix + #: + #: Defaults to "!" prefix = '!' def __init__(self, jid, password, room, nick, log_file=None, - log_level=logging.INFO): + log_level=logging.INFO): super(MUCBot, self).__init__(jid, password) self.log = logging.getLogger(__package__) @@ -56,9 +69,10 @@ class MUCBot(sleekxmpp.ClientXMPP): self.nick = nick self.__set_logger(log_file, log_level) self.__seen = dict() - self.register_plugin('xep_0030') # Service Discovery - self.register_plugin('xep_0045') # Multi-User Chat - self.register_plugin('xep_0199') # self Ping + self.register_plugin('xep_0030') # Service Discovery + self.register_plugin('xep_0045') # Multi-User Chat + self.register_plugin('xep_0071') # xhtml-im + self.register_plugin('xep_0199') # self Ping # The session_start event will be triggered when # the bot establishes its connection with the server @@ -75,7 +89,7 @@ class MUCBot(sleekxmpp.ClientXMPP): for name, value in inspect.getmembers(self): if inspect.ismethod(value) and getattr(value, '_bot_command', False): name = getattr(value, '_bot_command_name') - self.log.debug('Registered command: %s' % name) + self.log.debug('Registered command: %s', name) self.commands[name] = value def __set_logger(self, log_file=None, log_level=logging.INFO): @@ -83,13 +97,18 @@ class MUCBot(sleekxmpp.ClientXMPP): log_fd = open(log_file, 'w') if log_file else None chandler = logging.StreamHandler(log_fd) formatter = logging.Formatter( - '%(asctime)s - %(name)s - %(levelname)s - %(message)s') + '%(asctime)s - %(name)s - %(levelname)s - %(message)s' + ) chandler.setFormatter(formatter) self.log.addHandler(chandler) self.log.setLevel(log_level) - self.log.debug('set logger, log level : %s' % log_level) + self.log.debug('set logger, log level : %s', log_level) def message(self, msg): + """Messages handler + + Parses message received to detect :py:obj:`prefix` + """ if msg['type'] not in ('groupchat', 'chat'): self.log.warning('Unhandled message') return @@ -99,25 +118,25 @@ class MUCBot(sleekxmpp.ClientXMPP): if not body.startswith(MUCBot.prefix): return if msg['from'] not in self.__seen: - self.log.warning('Will not handle message ' - 'from unseen jid: %s' % msg['from']) + self.log.warning('Will not handle message from unseen jid: %s', msg['from']) #return args = body[1:].split() cmd = args.pop(0) if cmd not in self.commands: return - self.log.debug('cmd: {0}'.format(cmd)) + self.log.debug('cmd: %s', cmd) if args: - self.log.debug('arg: {0}'.format(args)) + self.log.debug('arg: %s', args) try: self.commands[cmd](msg, args) except Exception as err: reply = ''.join(traceback.format_exc()) - self.log.exception('An error occurred processing: {0}: {1}'.format(body, reply)) + self.log.exception('An error occurred processing: %s: %s', body, reply) if self.log.level < 10 and reply: self.send_message(mto=msg['from'].bare, mbody=reply, mtype='groupchat') def _view(self, pres): + """Track known nick""" nick = pres['from'] status = (pres['type'], pres['status']) self.__seen.update({nick: status}) @@ -130,38 +149,37 @@ class MUCBot(sleekxmpp.ClientXMPP): requesting the roster and broadcasting an initial presence stanza. - Arguments: - event -- An empty dictionary. The session_start - event does not provide any additional - data. + :param dict event: An empty dictionary. The session_start + event does not provide any additional data. """ self.get_roster() self.send_presence() - self.plugin['xep_0045'].joinMUC(self.room, + self.plugin['xep_0045'].join_muc(self.room, self.nick, # If a room password is needed, use: # password=the_room_password, wait=True) - def register_bot_plugin(self, plugin_class): - self.plugins.append(plugin_class(self)) + :param `sid.plugin.Plugin` plugin_cls: A :py:obj:`sid.plugin.Plugin` class + """ + self.plugins.append(plugin_cls(self)) for name, value in inspect.getmembers(self.plugins[-1]): if inspect.ismethod(value) and getattr(value, '_bot_command', False): name = getattr(value, '_bot_command_name') - self.log.debug('Registered command: %s' % name) + self.log.debug('Registered command: %s', name) self.commands[name] = value def foreach_plugin(self, method, *args, **kwds): for plugin in self.plugins: - self.log.debug('shuting down %s' % plugin.__str__) + self.log.debug('shuting down %s', plugin.__str__) getattr(plugin, method)(*args, **kwds) def shutdown_plugins(self): # TODO: why can't use event session_end|disconnected? self.log.info('shuting down') for plugin in self.plugins: - self.log.debug('shuting down %s' % plugin) + self.log.debug('shuting down %s', plugin) getattr(plugin, 'shutdown')() @botcmd @@ -170,7 +188,8 @@ class MUCBot(sleekxmpp.ClientXMPP): Automatically assigned to the "help" command.""" help_cmd = ('Type {}help '.format(self.prefix) + - ' to get more info about that specific command.') + ' to get more info about that specific command.\n\n'+ + 'SRC: http://git.kaliko.me/sid.git') if not args: if self.__doc__: description = self.__doc__.strip() @@ -189,7 +208,8 @@ class MUCBot(sleekxmpp.ClientXMPP): text = '{}\n\n{}'.format(description, usage) else: if args[0] in self.commands.keys(): - text = self.commands[args[0]].__doc__.strip() or 'undocumented' + text = self.commands[args[0]].__doc__ or 'undocumented' + text = inspect.cleandoc(text) else: text = 'That command is not defined.' if message['type'] == 'groupchat':