X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;ds=sidebyside;f=sid%2Fplugin.py;h=6ff12eed45f01194df1597082f105d8519c3a242;hb=dbc1b2e6149234b8571425b6684a2858fa52c545;hp=671df850cdd73ea3edf7420fcfcd0cfa21b4442b;hpb=8050b8698ff1f6294abceb8b022a4aecdbe8375e;p=sid.git diff --git a/sid/plugin.py b/sid/plugin.py index 671df85..6ff12ee 100644 --- a/sid/plugin.py +++ b/sid/plugin.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # Copyright (C) 2010, 2011 Anaël Verrier -# Copyright (C) 2014 kaliko +# Copyright (C) 2014, 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 @@ -17,10 +17,38 @@ from .sid import botcmd -class Plugin(object): +class Plugin: + """Simple Plugin object to derive from: + Exposes the bot object and its logger + Provides some send helpers + """ def __init__(self, bot): self.bot = bot + self.log = bot.log.getChild(self.__class__.__name__) + + def send(self, dest, msg, mtype='chat'): + """Send msg to dest + msg = { + mbody: 'text', + mhtml: 'text, # optional' + } + """ + if isinstance(msg, str): + msg = {'mbody': msg} + msg.setdefault('mhtml', None) + self.bot.send_message(mto=dest, + mtype=mtype, + **msg) + + def reply(self, rcv, msg): + """Smart reply to message received. + Replies in private or on the muc depending on + """ + to = rcv['from'] + if rcv['type'] == 'groupchat': + to = rcv['mucroom'] + self.send(to, msg, mtype=rcv['type']) def shutdown(self): pass