# -*- coding: utf-8 -*-
-
-# Copyright (C) 2007-2012 Thomas Perl <thp.io/about>
-# Copyright (C) 2014 kaliko <kaliko@azylum.org>
-
-# 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
-# the Free Software Foundation, version 3 only.
-
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# SPDX-FileCopyrightText: 2007-2012 Thomas Perl <thp.io/about>
+# SPDX-FileCopyrightText: 2014, 2020 kaliko <kaliko@azylum.org>
+# SPDX-License-Identifier: GPL-3.0-or-later
from .plugin import Plugin, botcmd
+
class Echo(Plugin):
+ """Drops a message to be sent when someone gets online.
+ """
def __init__(self, bot):
Plugin.__init__(self, bot)
- self.online = set()
self.inbox = dict()
+ self.presence = dict()
# The groupchat_presence event is triggered whenever a
# presence stanza is received from any chat room, including
# any presences you send yourself. To limit event handling
# to a single room, use the events muc::room@server::presence,
# muc::room@server::got_online, or muc::room@server::got_offline.
- bot.add_event_handler("muc::%s::got_offline" % self.bot.room, self._went_offline)
- bot.add_event_handler("muc::%s::got_online" % self.bot.room, self._went_online)
- bot.add_event_handler("muc::%s::presence" % self.bot.room, self.log_presence)
+ bot.add_event_handler("muc::%s::presence" %
+ self.bot.room, self.log_presence)
def log_presence(self, pres):
- self.log.debug('{0}: {1}'.format(pres['muc']['nick'], pres['type']))
-
- def _went_online(self, pres):
+ """Handler method registering MUC participants presence"""
+ self.log.debug('%s: %s', pres['muc']['nick'], pres['type'])
nick = pres['muc']['nick']
- self.online.add(nick)
- while self.inbox.get(nick, []):
- self.send(self.inbox.get(nick).pop())
- self.inbox.pop(nick)
-
- def _went_offline(self, pres):
- nick = pres['muc']['nick']
- if nick in self.online:
- self.online.remove(nick)
+ self.presence.update({nick: (pres['muc']['role'], pres['type'])})
+ self.log.debug(self.presence)
+ if pres['type'] == 'available':
+ while self.inbox.get(nick, []):
+ self.send(self.bot.room,
+ self.inbox.get(nick).pop(),
+ mtype='groupchat')
+ self.inbox.pop(nick)
@botcmd
def tell(self, message, args):
- """drop a message to be sent when someone gets online.
- !tell queue : messages in queue
- !tell <nick> <msg> : append <msg> to <nick> in queue"""
+ """Drops a message to be sent when someone gets online.
+
+ * ``!tell queue`` : messages in queue
+ * ``!tell <nick> <msg>``: append <msg> to <nick> in queue"""
if not len(args):
- self.send('Missing arguments:\n{}'.format(self.tell.__doc__))
- return
- if len(args) == 1 and args[0] == 'queue':
- self.send('\n'.join(['{0}:\n\t{1}'.format(k, '\n'.join(v))
- for k, v in self.inbox.items()]))
+ msg = 'Missing arguments:\n{}'.format(self.tell.__doc__)
+ self.reply(message, msg)
return
+ if len(args) == 1:
+ if args[0] == 'queue':
+ msg = '\n'.join(['{0}:\n\t{1}'.format(k, '\n'.join(v))
+ for k, v in self.inbox.items()])
+ self.reply(message, msg)
+ return
+ if args[0] == 'purge':
+ sender = message['from'].resource
+ if self.presence[sender][0] == 'moderator':
+ self.inbox = dict()
+ return
if len(args) < 2:
- self.send('Please provide a message:\n{}'.format(self.tell.__doc__))
+ msg = 'Please provide a message:\n{}'.format(self.tell.__doc__)
+ self.reply(message, msg)
return
+ self._handle_msg(message)
+
+ def _handle_msg(self, message):
+ """Format and drop message in the inbox"""
sender = message['from'].resource
recipient = message['body'].split()[1]
tell_msg = ' '.join(message['body'].split()[2:])
- self.log.debug('{0}: {1}'.format(recipient, tell_msg))
- letter = '{0}, {1} told me to tell you: {2}'.format(recipient, sender, tell_msg)
- if recipient in self.online:
+ self.log.debug('%s: %s', recipient, tell_msg)
+ letter = '{0}, {1} wanted you to know: {2}'.format(recipient, sender, tell_msg)
+ if (self.presence.get(recipient) and
+ self.presence[recipient][1] == 'available'):
return
if recipient in self.inbox.keys():
- self.inbox[recipient].append(letter)
+ self.inbox[recipient].append(letter)
else:
- self.inbox[recipient] = [letter]
+ self.inbox[recipient] = [letter]
# VIM MODLINE
home / dev / repositories / sid.git / blobdiff