sid/echo.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Copyright (C) 2007-2012 Thomas Perl <thp.io/about>
   4 # Copyright (C) 2014, 2020 kaliko <kaliko@azylum.org>
   5
   6 # This program is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, version 3 only.
   9
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 from .plugin import Plugin, botcmd
  19
  20
  21 class Echo(Plugin):
  22     """Drops a message to be sent when someone gets online.
  23     """
  24
  25     def __init__(self, bot):
  26         Plugin.__init__(self, bot)
  27         self.inbox = dict()
  28         self.presence = dict()
  29         # The groupchat_presence event is triggered whenever a
  30         # presence stanza is received from any chat room, including
  31         # any presences you send yourself. To limit event handling
  32         # to a single room, use the events muc::room@server::presence,
  33         # muc::room@server::got_online, or muc::room@server::got_offline.
  34         bot.add_event_handler("muc::%s::presence" %
  35                               self.bot.room, self.log_presence)
  36
  37     def log_presence(self, pres):
  38         """Handler method registering MUC participants presence"""
  39         self.log.debug('%s: %s', pres['muc']['nick'], pres['type'])
  40         nick = pres['muc']['nick']
  41         self.presence.update({nick: (pres['muc']['role'], pres['type'])})
  42         self.log.debug(self.presence)
  43         if pres['type'] == 'available':
  44             while self.inbox.get(nick, []):
  45                 self.send(self.bot.room,
  46                           self.inbox.get(nick).pop(),
  47                           mtype='groupchat')
  48                 self.inbox.pop(nick)
  49
  50     @botcmd
  51     def tell(self, message, args):
  52         """Drops a message to be sent when someone gets online.
  53
  54         * ``!tell queue``       : messages in queue
  55         * ``!tell <nick> <msg>``: append <msg> to <nick> in queue"""
  56         if not len(args):
  57             msg = 'Missing arguments:\n{}'.format(self.tell.__doc__)
  58             self.reply(message, msg)
  59             return
  60         if len(args) == 1:
  61             if args[0] == 'queue':
  62                 msg = '\n'.join(['{0}:\n\t{1}'.format(k, '\n'.join(v))
  63                                  for k, v in self.inbox.items()])
  64                 self.reply(message, msg)
  65                 return
  66             if args[0] == 'purge':
  67                 sender = message['from'].resource
  68                 if self.presence[sender][0] == 'moderator':
  69                     self.inbox = dict()
  70                 return
  71         if len(args) < 2:
  72             msg = 'Please provide a message:\n{}'.format(self.tell.__doc__)
  73             self.reply(message, msg)
  74             return
  75         self._handle_msg(message)
  76
  77     def _handle_msg(self, message):
  78         """Format and drop message in the inbox"""
  79         sender = message['from'].resource
  80         recipient = message['body'].split()[1]
  81         tell_msg = ' '.join(message['body'].split()[2:])
  82         self.log.debug('%s: %s', recipient, tell_msg)
  83         letter = '{0}, {1} wanted you to know: {2}'.format(recipient, sender, tell_msg)
  84         if (self.presence.get(recipient) and
  85                 self.presence[recipient][1] == 'available'):
  86             return
  87         if recipient in self.inbox.keys():
  88             self.inbox[recipient].append(letter)
  89         else:
  90             self.inbox[recipient] = [letter]
  91
  92
  93 # VIM MODLINE
  94 # vim: ai ts=4 sw=4 sts=4 expandtab