sid/sid.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Copyright (C) 2007-2012 Thomas Perl <thp.io/about>
   4 # Copyright (C) 2010, 2011 Anaël Verrier <elghinn@free.fr>
   5 # Copyright (C) 2014, 2015, 2020 kaliko <kaliko@azylum.org>
   6
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, version 3 only.
  10
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18
  19
  20 import inspect
  21 import logging
  22 import traceback
  23
  24 import slixmpp
  25
  26 from sid import __url__
  27
  28
  29 def botcmd(*args, **kwargs):
  30     """Decorator for bot command functions
  31
  32     :param bool hidden: is the command hidden in global help
  33     :param str name: command name, default to decorated function name
  34     """
  35
  36     def decorate(func, hidden=False, name=None):
  37         setattr(func, '_bot_command', True)
  38         setattr(func, '_bot_command_hidden', hidden)
  39         setattr(func, '_bot_command_name', name or func.__name__)
  40         if func.__doc__ is None:
  41             func.__doc__ = ''
  42         return func
  43
  44     if len(args):
  45         return decorate(args[0], **kwargs)
  46     else:
  47         return lambda func: decorate(func, **kwargs)
  48
  49
  50 class MUCBot(slixmpp.ClientXMPP):
  51     """
  52     :param str jid: jid to log with
  53     :param str password: jid password
  54     :param str room: conference room to join
  55     :param str nick: Nickname to use in the room
  56     """
  57
  58     #: Class attribute to define bot's command prefix
  59     #:
  60     #: Defaults to "!"
  61     prefix = '!'
  62
  63     def __init__(self, jid, password, room, nick, log_file=None,
  64                  log_level=logging.INFO):
  65         super(MUCBot, self).__init__(jid, password)
  66
  67         # Clean sphinx autodoc for self documentation
  68         # (cf. MUCBot.help)
  69         self.__doc__ = None
  70         self.log = logging.getLogger(__package__)
  71         self.plugins = list()
  72         self.commands = dict()
  73         self.room = room
  74         self.nick = nick
  75         self.__set_logger(log_file, log_level)
  76         self.__seen = dict()
  77         self.register_plugin('xep_0030')  # Service Discovery
  78         self.register_plugin('xep_0045')  # Multi-User Chat
  79         self.register_plugin('xep_0071')  # xhtml-im
  80         self.register_plugin('xep_0199')  # self Ping
  81
  82         # The session_start event will be triggered when
  83         # the bot establishes its connection with the server
  84         # and the XML streams are ready for use. We want to
  85         # listen for this event so that we we can initialize
  86         # our roster.
  87         self.add_event_handler('session_start', self.start)
  88
  89         # Handles MUC message and dispatch
  90         self.add_event_handler('message', self.message)
  91         self.add_event_handler('got_online', self._view)
  92
  93         # Discover bot internal command (ie. help)
  94         for name, value in inspect.getmembers(self):
  95             if inspect.ismethod(value) and \
  96                getattr(value, '_bot_command', False):
  97                 name = getattr(value, '_bot_command_name')
  98                 self.log.debug('Registered command: %s', name)
  99                 self.commands[name] = value
 100
 101     def __set_logger(self, log_file=None, log_level=logging.INFO):
 102         """Create console/file handler"""
 103         log_fd = open(log_file, 'w') if log_file else None
 104         chandler = logging.StreamHandler(log_fd)
 105         formatter = logging.Formatter(
 106             '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
 107             )
 108         chandler.setFormatter(formatter)
 109         self.log.addHandler(chandler)
 110         self.log.setLevel(log_level)
 111         self.log.debug('set logger, log level : %s', log_level)
 112
 113     def message(self, msg):
 114         """Messages handler
 115
 116         Parses message received to detect :py:obj:`prefix`
 117         """
 118         if msg['type'] not in ('groupchat', 'chat'):
 119             self.log.warning('Unhandled message')
 120             return
 121         if msg['mucnick'] == self.nick:
 122             return
 123         body = msg['body'].strip()
 124         if not body.startswith(MUCBot.prefix):
 125             return
 126         if msg['from'] not in self.__seen:
 127             self.log.warning('Will not handle message from unseen jid: %s', msg['from'])
 128             #return
 129         args = body[1:].split()
 130         cmd = args.pop(0)
 131         if cmd not in self.commands:
 132             return
 133         self.log.debug('cmd: %s', cmd)
 134         if args:
 135             self.log.debug('arg: %s', args)
 136         try:
 137             self.commands[cmd](msg, args)
 138         except Exception as err:
 139             reply = ''.join(traceback.format_exc())
 140             self.log.exception('An error occurred processing: %s: %s', body, reply)
 141             if self.log.level < 10 and reply:
 142                 self.send_message(mto=msg['from'].bare, mbody=reply,
 143                                   mtype='groupchat')
 144
 145     def _view(self, pres):
 146         """Track known nick"""
 147         nick = pres['from']
 148         status = (pres['type'], pres['status'])
 149         self.__seen.update({nick: status})
 150
 151     def start(self, event):
 152         """
 153         Process the session_start event.
 154
 155         Typical actions for the session_start event are
 156         requesting the roster and broadcasting an initial
 157         presence stanza.
 158
 159         :param dict event: An empty dictionary. The session_start
 160                      event does not provide any additional data.
 161         """
 162         self.get_roster()
 163         self.send_presence()
 164         self.plugin['xep_0045'].join_muc(self.room,
 165                                          self.nick,
 166                                          # If a room password is needed, use:
 167                                          # password=the_room_password,
 168                                          wait=True)
 169
 170     def register_bot_plugin(self, plugin_cls):
 171         """Registers plugin, takes a class, the method instanciates the plugin
 172
 173         :param `sid.plugin.Plugin` plugin_cls: A :py:obj:`sid.plugin.Plugin` class
 174         """
 175         self.plugins.append(plugin_cls(self))
 176         for name, value in inspect.getmembers(self.plugins[-1]):
 177             if inspect.ismethod(value) and \
 178                getattr(value, '_bot_command', False):
 179                 name = getattr(value, '_bot_command_name')
 180                 self.log.debug('Registered command: %s', name)
 181                 self.commands[name] = value
 182
 183     def foreach_plugin(self, method, *args, **kwds):
 184         for plugin in self.plugins:
 185             self.log.debug('calling %s for %s', method, plugin)
 186             getattr(plugin, method)(*args, **kwds)
 187
 188     def shutdown_plugins(self):
 189         # TODO: also use event session_end|disconnected?
 190         self.log.info('shuting down')
 191         for plugin in self.plugins:
 192             self.log.debug('shuting down %s', plugin)
 193             getattr(plugin, 'shutdown')()
 194
 195     @botcmd
 196     def help(self, message, args):
 197         """Returns a help string listing available options.
 198
 199         Automatically assigned to the "help" command."""
 200         help_cmd = ('Type {}help <command name>'.format(self.prefix) +
 201                     ' to get more info about that specific command.\n\n' +
 202                     f'SRC: {__url__}')
 203         if not args:
 204             if self.__doc__:
 205                 description = self.__doc__.strip()
 206             else:
 207                 description = 'Available commands:'
 208
 209             cmd_list = list()
 210             for name, cmd in self.commands.items():
 211                 if name == 'help' or cmd._bot_command_hidden:
 212                     continue
 213                 doc = (cmd.__doc__.strip() or 'undocumented').split('\n', 1)[0]
 214                 cmd_list.append('{0}: {1}'.format(name, doc))
 215
 216             usage = '\n'.join(cmd_list)
 217             usage = usage + '\n\n' + help_cmd
 218             text = '{}\n\n{}'.format(description, usage)
 219         else:
 220             if args[0] in self.commands.keys():
 221                 text = self.commands[args[0]].__doc__ or 'undocumented'
 222                 text = inspect.cleandoc(text)
 223             else:
 224                 text = 'That command is not defined.'
 225         if message['type'] == 'groupchat':
 226             to = message['from'].bare
 227         else:
 228             to = message['from']
 229         self.send_message(mto=to, mbody=text, mtype=message['type'])