Mercurial > libervia-backend

comparison sat/plugins/plugin_xep_0297.py @ 2562:26edcf3a30eb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core, setup: huge cleaning: - moved directories from src and frontends/src to sat and sat_frontends, which is the recommanded naming convention - move twisted directory to root - removed all hacks from setup.py, and added missing dependencies, it is now clean - use https URL for website in setup.py - removed "Environment :: X11 Applications :: GTK", as wix is deprecated and removed - renamed sat.sh to sat and fixed its installation - added python_requires to specify Python version needed - replaced glib2reactor which use deprecated code by gtk3reactor sat can now be installed directly from virtualenv without using --system-site-packages anymore \o/
author Goffi <goffi@goffi.org>
date Mon, 02 Apr 2018 19:44:50 +0200
parents src/plugins/plugin_xep_0297.py@0046283a285d
children 56f94936df1e
comparison
equal deleted inserted replaced
2561:bd30dc3ffe5a 2562:26edcf3a30eb
1 #!/usr/bin/env python2
2 # -*- coding: utf-8 -*-
3
4 # SAT plugin for Stanza Forwarding (XEP-0297)
5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org)
6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org)
7
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU Affero General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU Affero General Public License for more details.
17
18 # You should have received a copy of the GNU Affero General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20
21 from sat.core.constants import Const as C
22 from sat.core.i18n import _, D_
23 from sat.core.log import getLogger
24 log = getLogger(__name__)
25
26 from wokkel import disco, iwokkel
27 try:
28 from twisted.words.protocols.xmlstream import XMPPHandler
29 except ImportError:
30 from wokkel.subprotocols import XMPPHandler
31 from zope.interface import implements
32
33 from twisted.words.xish import domish
34
35 NS_SF = C.NS_FORWARD
36
37 PLUGIN_INFO = {
38 C.PI_NAME: u"Stanza Forwarding",
39 C.PI_IMPORT_NAME: u"XEP-0297",
40 C.PI_TYPE: u"XEP",
41 C.PI_PROTOCOLS: [u"XEP-0297"],
42 C.PI_MAIN: "XEP_0297",
43 C.PI_HANDLER: u"yes",
44 C.PI_DESCRIPTION: D_(u"""Implementation of Stanza Forwarding""")
45 }
46
47
48 class XEP_0297(object):
49 # FIXME: check this implementation which doesn't seems to be used
50
51 def __init__(self, host):
52 log.info(_("Stanza Forwarding plugin initialization"))
53 self.host = host
54
55 def getHandler(self, client):
56 return XEP_0297_handler(self, client.profile)
57
58 @classmethod
59 def updateUri(cls, element, uri):
60 """Update recursively the element URI.
61
62 @param element (domish.Element): element to update
63 @param uri (unicode): new URI
64 """
65 # XXX: we need this because changing the URI of an existing element
66 # containing children doesn't update the children's blank URI.
67 element.uri = uri
68 element.defaultUri = uri
69 for child in element.children:
70 if isinstance(child, domish.Element) and not child.uri:
71 XEP_0297.updateUri(child, uri)
72
73 def forward(self, stanza, to_jid, stamp, body='', profile_key=C.PROF_KEY_NONE):
74 """Forward a message to the given JID.
75
76 @param stanza (domish.Element): original stanza to be forwarded.
77 @param to_jid (JID): recipient JID.
78 @param stamp (datetime): offset-aware timestamp of the original reception.
79 @param body (unicode): optional description.
80 @param profile_key (unicode): %(doc_profile_key)s
81 @return: a Deferred when the message has been sent
82 """
83 # FIXME: this method is not used and doesn't use mess_data which should be used for client.sendMessageData
84 # should it be deprecated? A method constructing the element without sending it seems more natural
85 log.warning(u"THIS METHOD IS DEPRECATED") # FIXME: we use this warning until we check the method
86 msg = domish.Element((None, 'message'))
87 msg['to'] = to_jid.full()
88 msg['type'] = stanza['type']
89
90 body_elt = domish.Element((None, 'body'))
91 if body:
92 body_elt.addContent(body)
93
94 forwarded_elt = domish.Element((NS_SF, 'forwarded'))
95 delay_elt = self.host.plugins['XEP-0203'].delay(stamp)
96 forwarded_elt.addChild(delay_elt)
97 if not stanza.uri: # None or ''
98 XEP_0297.updateUri(stanza, 'jabber:client')
99 forwarded_elt.addChild(stanza)
100
101 msg.addChild(body_elt)
102 msg.addChild(forwarded_elt)
103
104 client = self.host.getClient(profile_key)
105 return client.sendMessageData({u'xml': msg})
106
107
108 class XEP_0297_handler(XMPPHandler):
109 implements(iwokkel.IDisco)
110
111 def __init__(self, plugin_parent, profile):
112 self.plugin_parent = plugin_parent
113 self.host = plugin_parent.host
114 self.profile = profile
115
116 def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
117 return [disco.DiscoFeature(NS_SF)]
118
119 def getDiscoItems(self, requestor, target, nodeIdentifier=''):
120 return []