Mercurial > libervia-backend

annotate src/plugins/plugin_exp_parrot.py @ 896:0199a17f4d92

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: added gobject dependency for primitivus in README4PACKAGERS
author Goffi <goffi@goffi.org>
date Tue, 04 Mar 2014 00:29:10 +0100
parents 1fe00f0c9a91
children d609581bf74a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/python
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
3
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
4 # SAT plugin for parrot mode (experimental)
811
1fe00f0c9a91 dates update
Goffi <goffi@goffi.org>
parents: 771
diff changeset
5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org)
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
6
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
10 # (at your option) any later version.
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
11
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
15 # GNU Affero General Public License for more details.
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
16
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 603
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
19
771
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 697
diff changeset
20 from sat.core.i18n import _
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
21 from logging import debug, info, warning, error
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
22 from twisted.words.protocols.jabber import jid
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
23
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
24 from sat.core.exceptions import UnknownEntityError
603
1d6f48ae31d1 plugin parrot: sendMessage now avoid triggers
Goffi <goffi@goffi.org>
parents: 602
diff changeset
25 #from sat.tools.misc import SkipOtherTriggers
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
26
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
27 PLUGIN_INFO = {
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
28 "name": "Parrot Plugin",
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
29 "import_name": "EXP-PARROT",
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
30 "type": "EXP",
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
31 "protocols": [],
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
32 "dependencies": ["XEP-0045"],
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
33 "main": "Exp_Parrot",
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
34 "handler": "no",
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
35 "description": _("""Implementation of parrot mode (repeat messages between 2 entities)""")
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
36 }
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
37
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
38
588
beaf6bec2fcd Remove every old-style class.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
39 class Exp_Parrot(object):
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
40 """Parrot mode plugin: repeat messages from one entity or MUC room to another one"""
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
41 #XXX: This plugin can be potentially dangerous if we don't trust entities linked
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
42 # this is specially true if we have other triggers.
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
43 # sendMessageTrigger avoid other triggers execution, it's deactivated to allow
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
44 # /unparrot command in text commands plugin.
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
45
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
46 def __init__(self, host):
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
47 info(_("Plugin Parrot initialization"))
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
48 self.host = host
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
49 host.trigger.add("MessageReceived", self.MessageReceivedTrigger, priority=100)
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
50 #host.trigger.add("sendMessage", self.sendMessageTrigger, priority=100)
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
51
697
0c84fb112d70 core: sendMessage triggers now use a treatments deferred;
Goffi <goffi@goffi.org>
parents: 663
diff changeset
52 #def sendMessageTrigger(self, mess_data, treatments, profile):
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
53 # """ Deactivate other triggers if recipient is in parrot links """
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
54 # client = self.host.getClient(profile)
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
55 # try:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
56 # _links = client.parrot_links
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
57 # except AttributeError:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
58 # return True
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
59 #
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
60 # if mess_data['to'].userhostJID() in _links.values():
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
61 # debug("Parrot link detected, skipping other triggers")
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
62 # raise SkipOtherTriggers
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
63
663
8004c7d4aba7 core: Deferred in onMessage.
Goffi <goffi@goffi.org>
parents: 609
diff changeset
64 def MessageReceivedTrigger(self, message, post_treat, profile):
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
65 """ Check if source is linked and repeat message, else do nothing """
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
66 client = self.host.getClient(profile)
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
67 from_jid = jid.JID(message["from"])
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
68
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
69 try:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
70 _links = client.parrot_links
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
71 except AttributeError:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
72 return True
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
73
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
74 if not from_jid.userhostJID() in _links:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
75 return True
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
76
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
77 for e in message.elements():
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
78 if e.name == "body":
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
79 mess_body = e.children[0] if e.children else ""
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
80
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
81 try:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
82 entity_type = self.host.memory.getEntityData(from_jid, ['type'], profile)["type"]
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
83 except (UnknownEntityError, KeyError):
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
84 entity_type = "contact"
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
85 if entity_type == 'chatroom':
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
86 src_txt = from_jid.resource
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
87 if src_txt == self.host.plugins["XEP-0045"].getRoomNick(from_jid.userhost(), profile):
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
88 #we won't repeat our own messages
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
89 return True
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
90 else:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
91 src_txt = from_jid.user
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
92 msg = "[%s] %s" % (src_txt, mess_body)
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
93
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
94 linked = _links[from_jid.userhostJID()]
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
95
603
1d6f48ae31d1 plugin parrot: sendMessage now avoid triggers
Goffi <goffi@goffi.org>
parents: 602
diff changeset
96 self.host.sendMessage(jid.JID(unicode(linked)), msg, None, "auto", no_trigger=True, profile_key=profile)
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
97 else:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
98 warning("No body element found in message, following normal behaviour")
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
99
526
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
100 return True
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
101
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
102 def addParrot(self, source_jid, dest_jid, profile):
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
103 """Add a parrot link from one entity to another one
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
104 @param source_jid: entity from who messages will be repeated
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
105 @param dest_jid: entity where the messages will be repeated
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
106 @param profile: %(doc_profile_key)s"""
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
107 client = self.host.getClient(profile)
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
108 try:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
109 _links = client.parrot_links
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
110 except AttributeError:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
111 _links = client.parrot_links = {}
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
112
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
113 _links[source_jid.userhostJID()] = dest_jid
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
114 info("Parrot mode: %s will be repeated to %s" % (source_jid.userhost(), unicode(dest_jid)))
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
115
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
116 def removeParrot(self, source_jid, profile):
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
117 """Remove parrot link
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
118 @param source_jid: this entity will no more be repeated
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
119 @param profile: %(doc_profile_key)s"""
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
120 client = self.host.getClient(profile)
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
121 try:
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
122 del client.parrot_links[source_jid.userhostJID()]
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
123 except (AttributeError, KeyError):
d67f0ce83530 new plugin: Parrot is an experimental plugin which repeat messages between 2 entities
Goffi <goffi@goffi.org>
parents:
diff changeset
124 pass