Mercurial > libervia-backend
annotate src/plugins/plugin_xep_0297.py @ 1963:a2bc5089c2eb
backend, frontends: message refactoring (huge commit):
/!\ several features are temporarily disabled, like notifications in frontends
next step in refactoring, with the following changes:
- jp: updated jp message to follow changes in backend/bridge
- jp: added --lang, --subject, --subject_lang, and --type options to jp message + fixed unicode handling for jid
- quick_frontend (QuickApp, QuickChat):
- follow backend changes
- refactored chat, message are now handled in OrderedDict and uid are kept so they can be updated
- Message and Occupant classes handle metadata, so frontend just have to display them
- Primitivus (Chat):
- follow backend/QuickFrontend changes
- info & standard messages are handled in the same MessageWidget class
- improved/simplified handling of messages, removed update() method
- user joined/left messages are merged when next to each other
- a separator is shown when message is received while widget is out of focus, so user can quickly see the new messages
- affiliation/role are shown (in a basic way for now) in occupants panel
- removed "/me" messages handling, as it will be done by a backend plugin
- message language is displayed when available (only one language per message for now)
- fixed :history and :search commands
- core (constants): new constants for messages type, XML namespace, entity type
- core: *Message methods renamed to follow new code sytle (e.g. sendMessageToBridge => messageSendToBridge)
- core (messages handling): fixed handling of language
- core (messages handling): mes_data['from'] and ['to'] are now jid.JID
- core (core.xmpp): reorganised message methods, added getNick() method to client.roster
- plugin text commands: fixed plugin and adapted to new messages behaviour. client is now used in arguments instead of profile
- plugins: added information for cancellation reason in CancelError calls
- plugin XEP-0045: various improvments, but this plugin still need work:
- trigger is used to avoid message already handled by the plugin to be handled a second time
- changed the way to handle history, the last message from DB is checked and we request only messages since this one, in seconds (thanks Poezio folks :))
- subject reception is waited before sending the roomJoined signal, this way we are sure that everything including history is ready
- cmd_* method now follow the new convention with client instead of profile
- roomUserJoined and roomUserLeft messages are removed, the events are now handled with info message with a "ROOM_USER_JOINED" info subtype
- probably other forgotten stuffs :p
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 20 Jun 2016 18:41:53 +0200 |
parents | 2daf7b4c6756 |
children | ad88808591ef |
rev | line source |
---|---|
1934
2daf7b4c6756
use of /usr/bin/env instead of /usr/bin/python in shebang
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
1 #!/usr/bin/env python2 |
1274 | 2 # -*- coding: utf-8 -*- |
3 | |
4 # SAT plugin for Stanza Forwarding (XEP-0297) | |
1766 | 5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org) |
6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org) | |
1274 | 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 _ | |
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 = 'urn:xmpp:forward:0' | |
36 | |
37 PLUGIN_INFO = { | |
38 "name": "Stanza Forwarding", | |
39 "import_name": "XEP-0297", | |
40 "type": "XEP", | |
41 "protocols": ["XEP-0297"], | |
42 "main": "XEP_0297", | |
43 "handler": "yes", | |
44 "description": _("""Implementation of Stanza Forwarding""") | |
45 } | |
46 | |
47 | |
48 class XEP_0297(object): | |
49 | |
50 def __init__(self, host): | |
51 log.info(_("Stanza Forwarding plugin initialization")) | |
52 self.host = host | |
53 | |
54 def getHandler(self, profile): | |
55 return XEP_0297_handler(self, profile) | |
56 | |
57 @classmethod | |
58 def updateUri(cls, element, uri): | |
59 """Update recursively the element URI. | |
60 | |
61 @param element (domish.Element): element to update | |
62 @param uri (unicode): new URI | |
63 """ | |
64 # XXX: we need this because changing the URI of an existing element | |
65 # containing children doesn't update the children's blank URI. | |
66 element.uri = uri | |
67 element.defaultUri = uri | |
68 for child in element.children: | |
69 if isinstance(child, domish.Element) and not child.uri: | |
70 XEP_0297.updateUri(child, uri) | |
71 | |
72 def forward(self, stanza, to_jid, stamp, body='', profile_key=C.PROF_KEY_NONE): | |
73 """Forward a message to the given JID. | |
74 | |
75 @param stanza (domish.Element): original stanza to be forwarded. | |
76 @param to_jid (JID): recipient JID. | |
77 @param stamp (datetime): offset-aware timestamp of the original reception. | |
78 @param body (unicode): optional description. | |
79 @param profile_key (unicode): %(doc_profile_key)s | |
80 @return: a Deferred when the message has been sent | |
81 """ | |
82 msg = domish.Element((None, 'message')) | |
83 msg['to'] = to_jid.full() | |
84 msg['type'] = stanza['type'] | |
85 | |
86 body_elt = domish.Element((None, 'body')) | |
87 if body: | |
88 body_elt.addContent(body) | |
89 | |
90 forwarded_elt = domish.Element((NS_SF, 'forwarded')) | |
91 delay_elt = self.host.plugins['XEP-0203'].delay(stamp) | |
92 forwarded_elt.addChild(delay_elt) | |
93 if not stanza.uri: # None or '' | |
94 XEP_0297.updateUri(stanza, 'jabber:client') | |
95 forwarded_elt.addChild(stanza) | |
96 | |
97 msg.addChild(body_elt) | |
98 msg.addChild(forwarded_elt) | |
99 | |
100 client = self.host.getClient(profile_key) | |
101 return client.xmlstream.send(msg.toXml()) | |
102 | |
103 | |
104 class XEP_0297_handler(XMPPHandler): | |
105 implements(iwokkel.IDisco) | |
106 | |
107 def __init__(self, plugin_parent, profile): | |
108 self.plugin_parent = plugin_parent | |
109 self.host = plugin_parent.host | |
110 self.profile = profile | |
111 | |
112 def getDiscoInfo(self, requestor, target, nodeIdentifier=''): | |
113 return [disco.DiscoFeature(NS_SF)] | |
114 | |
115 def getDiscoItems(self, requestor, target, nodeIdentifier=''): | |
116 return [] |