1 # -*- coding: utf-8 -*-
2 # SPDX-FileCopyrightText: 2010, 2011 Anaƫl Verrier <elghinn@free.fr>
3 # SPDX-FileCopyrightText: 2014, 2020, 2023 kaliko <kaliko@azylum.org>
6 from slixmpp.exceptions import XMPPError
8 from .sid import botcmd
13 Simple Plugin object to derive from:
15 * Exposes the bot object and its logger
16 * Provides send helpers
18 :param sid.sid.MUCBot bot: bot the plugin is load from
21 def __init__(self, bot):
23 self.log = bot.log.getChild(self.__class__.__name__)
24 #: :py:obj:`list` : List of tuples (event, handler)
27 def add_handlers(self):
28 """Add handlers declared in self.hanlders"""
29 for event, handler in self.handlers:
30 self.log.debug(f'Add {event} > {self.__class__.__name__}().{handler.__name__}')
31 self.bot.add_event_handler(event, handler)
33 def rm_handlers(self):
34 """Remove handlers declared in self.hanlders"""
35 for event, handler in self.handlers:
36 self.log.debug(f'Remove {event} > {self.__class__.__name__}().{handler.__name__}')
37 self.bot.del_event_handler(event, handler)
39 def send(self, dest, msg, mtype='chat'):
42 :param str dest: Message recipient
43 :param dict,str msg: Message to send (use dict for xhtml-im)
46 if **msg** is a :py:obj:`dict` to provide xhmlt-im massages::
50 mhtml: '<b>text</b>, # optional'
53 if isinstance(msg, str):
55 msg.setdefault('mhtml', None)
56 self.bot.send_message(mto=dest,
60 def reply(self, rcv, msg):
61 """Smart reply to message received.
63 Replies ``msg`` in private or on the muc depending on ``rcv``
65 :param rcv: The received message (slixmpp object)
66 :param dict,str msg: The message to reply, refer to :py:obj:`sid.plugin.Plugin.send` for ``msg`` format
69 if rcv['type'] == 'groupchat':
71 self.send(to, msg, mtype=rcv['type'])
73 async def ban(self, jid, reason):
74 """Coroutine to ban a jid from the room
76 :param str jid: JID to ban
77 :param str reason: Reason
81 await self.bot['xep_0045'].set_affiliation(room,
82 jid=jid, affiliation='outcast', reason=reason)
83 except XMPPError as error:
87 """Empty method to override. Called on bot shutdown"""