refactoring: renamed sat package to libervia.backend
This commit is contained in:
Goffi
parent
a15648d682
commit
d2685ba11b
1 changed files with 1293 additions and 1293 deletions
|
|
@ -1,201 +0,0 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
|
||||
# SAT plugin for parrot mode (experimental)
|
||||
# Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
|
||||
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Affero General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
|
||||
# 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 Affero General Public License for more details.
|
||||
|
||||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from sat.core.i18n import _
|
||||
from sat.core.constants import Const as C
|
||||
from sat.core.log import getLogger
|
||||
|
||||
log = getLogger(__name__)
|
||||
from twisted.words.protocols.jabber import jid
|
||||
|
||||
from sat.core.exceptions import UnknownEntityError
|
||||
|
||||
# from sat.tools import trigger
|
||||
|
||||
PLUGIN_INFO = {
|
||||
C.PI_NAME: "Parrot Plugin",
|
||||
C.PI_IMPORT_NAME: "EXP-PARROT",
|
||||
C.PI_TYPE: "EXP",
|
||||
C.PI_PROTOCOLS: [],
|
||||
C.PI_DEPENDENCIES: ["XEP-0045"],
|
||||
C.PI_RECOMMENDATIONS: [C.TEXT_CMDS],
|
||||
C.PI_MAIN: "Exp_Parrot",
|
||||
C.PI_HANDLER: "no",
|
||||
C.PI_DESCRIPTION: _(
|
||||
"""Implementation of parrot mode (repeat messages between 2 entities)"""
|
||||
),
|
||||
}
|
||||
|
||||
|
||||
class Exp_Parrot(object):
|
||||
"""Parrot mode plugin: repeat messages from one entity or MUC room to another one"""
|
||||
|
||||
# XXX: This plugin can be potentially dangerous if we don't trust entities linked
|
||||
# this is specially true if we have other triggers.
|
||||
# send_message_trigger avoid other triggers execution, it's deactivated to allow
|
||||
# /unparrot command in text commands plugin.
|
||||
# FIXME: potentially unsecure, specially with e2e encryption
|
||||
|
||||
def __init__(self, host):
|
||||
log.info(_("Plugin Parrot initialization"))
|
||||
self.host = host
|
||||
host.trigger.add("message_received", self.message_received_trigger, priority=100)
|
||||
# host.trigger.add("sendMessage", self.send_message_trigger, priority=100)
|
||||
try:
|
||||
self.host.plugins[C.TEXT_CMDS].register_text_commands(self)
|
||||
except KeyError:
|
||||
log.info(_("Text commands not available"))
|
||||
|
||||
# def send_message_trigger(self, client, mess_data, treatments):
|
||||
# """ Deactivate other triggers if recipient is in parrot links """
|
||||
# try:
|
||||
# _links = client.parrot_links
|
||||
# except AttributeError:
|
||||
# return True
|
||||
#
|
||||
# if mess_data['to'].userhostJID() in _links.values():
|
||||
# log.debug("Parrot link detected, skipping other triggers")
|
||||
# raise trigger.SkipOtherTriggers
|
||||
|
||||
def message_received_trigger(self, client, message_elt, post_treat):
|
||||
""" Check if source is linked and repeat message, else do nothing """
|
||||
# TODO: many things are not repeated (subject, thread, etc)
|
||||
from_jid = message_elt["from"]
|
||||
|
||||
try:
|
||||
_links = client.parrot_links
|
||||
except AttributeError:
|
||||
return True
|
||||
|
||||
if not from_jid.userhostJID() in _links:
|
||||
return True
|
||||
|
||||
message = {}
|
||||
for e in message_elt.elements(C.NS_CLIENT, "body"):
|
||||
body = str(e)
|
||||
lang = e.getAttribute("lang") or ""
|
||||
|
||||
try:
|
||||
entity_type = self.host.memory.entity_data_get(
|
||||
client, from_jid, [C.ENTITY_TYPE])[C.ENTITY_TYPE]
|
||||
except (UnknownEntityError, KeyError):
|
||||
entity_type = "contact"
|
||||
if entity_type == C.ENTITY_TYPE_MUC:
|
||||
src_txt = from_jid.resource
|
||||
if src_txt == self.host.plugins["XEP-0045"].get_room_nick(
|
||||
client, from_jid.userhostJID()
|
||||
):
|
||||
# we won't repeat our own messages
|
||||
return True
|
||||
else:
|
||||
src_txt = from_jid.user
|
||||
message[lang] = "[{}] {}".format(src_txt, body)
|
||||
|
||||
linked = _links[from_jid.userhostJID()]
|
||||
|
||||
client.sendMessage(
|
||||
jid.JID(str(linked)), message, None, "auto", no_trigger=True
|
||||
)
|
||||
|
||||
return True
|
||||
|
||||
def add_parrot(self, client, source_jid, dest_jid):
|
||||
"""Add a parrot link from one entity to another one
|
||||
|
||||
@param source_jid: entity from who messages will be repeated
|
||||
@param dest_jid: entity where the messages will be repeated
|
||||
"""
|
||||
try:
|
||||
_links = client.parrot_links
|
||||
except AttributeError:
|
||||
_links = client.parrot_links = {}
|
||||
|
||||
_links[source_jid.userhostJID()] = dest_jid
|
||||
log.info(
|
||||
"Parrot mode: %s will be repeated to %s"
|
||||
% (source_jid.userhost(), str(dest_jid))
|
||||
)
|
||||
|
||||
def remove_parrot(self, client, source_jid):
|
||||
"""Remove parrot link
|
||||
|
||||
@param source_jid: this entity will no more be repeated
|
||||
"""
|
||||
try:
|
||||
del client.parrot_links[source_jid.userhostJID()]
|
||||
except (AttributeError, KeyError):
|
||||
pass
|
||||
|
||||
def cmd_parrot(self, client, mess_data):
|
||||
"""activate Parrot mode between 2 entities, in both directions."""
|
||||
log.debug("Catched parrot command")
|
||||
txt_cmd = self.host.plugins[C.TEXT_CMDS]
|
||||
|
||||
try:
|
||||
link_left_jid = jid.JID(mess_data["unparsed"].strip())
|
||||
if not link_left_jid.user or not link_left_jid.host:
|
||||
raise jid.InvalidFormat
|
||||
except (RuntimeError, jid.InvalidFormat, AttributeError):
|
||||
txt_cmd.feed_back(
|
||||
client, "Can't activate Parrot mode for invalid jid", mess_data
|
||||
)
|
||||
return False
|
||||
|
||||
link_right_jid = mess_data["to"]
|
||||
|
||||
self.add_parrot(client, link_left_jid, link_right_jid)
|
||||
self.add_parrot(client, link_right_jid, link_left_jid)
|
||||
|
||||
txt_cmd.feed_back(
|
||||
client,
|
||||
"Parrot mode activated for {}".format(str(link_left_jid)),
|
||||
mess_data,
|
||||
)
|
||||
|
||||
return False
|
||||
|
||||
def cmd_unparrot(self, client, mess_data):
|
||||
"""remove Parrot mode between 2 entities, in both directions."""
|
||||
log.debug("Catched unparrot command")
|
||||
txt_cmd = self.host.plugins[C.TEXT_CMDS]
|
||||
|
||||
try:
|
||||
link_left_jid = jid.JID(mess_data["unparsed"].strip())
|
||||
if not link_left_jid.user or not link_left_jid.host:
|
||||
raise jid.InvalidFormat
|
||||
except jid.InvalidFormat:
|
||||
txt_cmd.feed_back(
|
||||
client, "Can't deactivate Parrot mode for invalid jid", mess_data
|
||||
)
|
||||
return False
|
||||
|
||||
link_right_jid = mess_data["to"]
|
||||
|
||||
self.remove_parrot(client, link_left_jid)
|
||||
self.remove_parrot(client, link_right_jid)
|
||||
|
||||
txt_cmd.feed_back(
|
||||
client,
|
||||
"Parrot mode deactivated for {} and {}".format(
|
||||
str(link_left_jid), str(link_right_jid)
|
||||
),
|
||||
mess_data,
|
||||
)
|
||||
|
||||
return False
|
||||
Loading…
Reference in a new issue