Mercurial > libervia-backend
changeset 2099:ad88808591ef
plugin XEP-0280: Message Carbons first draft
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sun, 18 Dec 2016 20:21:31 +0100 |
| parents | e0066920a661 |
| children | fbeeba721954 |
| files | src/core/xmpp.py src/plugins/plugin_xep_0184.py src/plugins/plugin_xep_0280.py src/plugins/plugin_xep_0297.py |
| diffstat | 4 files changed, 183 insertions(+), 18 deletions(-) [+] |
line wrap: on
line diff
--- a/src/core/xmpp.py Sun Dec 18 16:28:51 2016 +0100 +++ b/src/core/xmpp.py Sun Dec 18 20:21:31 2016 +0100 @@ -149,17 +149,15 @@ xmppim.MessageProtocol.__init__(self) self.host = host - def onMessage(self, message_elt): - # TODO: handle threads - client = self.parent - if not 'from' in message_elt.attributes: - message_elt['from'] = client.jid.host - log.debug(_(u"got message from: {from_}").format(from_=message_elt['from'])) - post_treat = defer.Deferred() # XXX: plugin can add their treatments to this deferred + @staticmethod + def parseMessage(message_elt, client=None): + """parse a message XML and return message_data - if not self.host.trigger.point("MessageReceived", client, message_elt, post_treat): - return - + @param message_elt(domish.Element): raw <message> xml + @param client(SatXMPPClient, None): client to map message id to uid + if None, mapping will not be done + @return(dict): message data + """ message = {} subject = {} extra = {} @@ -171,12 +169,13 @@ "type": message_elt.getAttribute('type', 'normal'), "extra": extra} - try: - data['stanza_id'] = message_elt['id'] - except KeyError: - pass - else: - client._mess_id_uid[(data['from'], data['stanza_id'])] = data['uid'] + if client is not None: + try: + data['stanza_id'] = message_elt['id'] + except KeyError: + pass + else: + client._mess_id_uid[(data['from'], data['stanza_id'])] = data['uid'] # message for e in message_elt.elements(C.NS_CLIENT, 'body'): @@ -197,7 +196,20 @@ data['received_timestamp'] = unicode(time.time()) if parsed_delay.sender: data['delay_sender'] = parsed_delay.sender.full() + return data + def onMessage(self, message_elt): + # TODO: handle threads + client = self.parent + if not 'from' in message_elt.attributes: + message_elt['from'] = client.jid.host + log.debug(_(u"got message from: {from_}").format(from_=message_elt['from'])) + post_treat = defer.Deferred() # XXX: plugin can add their treatments to this deferred + + if not self.host.trigger.point("MessageReceived", client, message_elt, post_treat): + return + + data = self.parseMessage(message_elt, client) post_treat.addCallback(self.skipEmptyMessage) post_treat.addCallback(self.addToHistory, client)
--- a/src/plugins/plugin_xep_0184.py Sun Dec 18 16:28:51 2016 +0100 +++ b/src/plugins/plugin_xep_0184.py Sun Dec 18 20:21:31 2016 +0100 @@ -117,7 +117,6 @@ post_xml_treatments.addCallback(treatment) return True - def onMessageDeliveryReceiptsRequest(self, msg_elt, client): """This method is called on message delivery receipts **request** (XEP-0184 #7) @param msg_elt: message element
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/plugins/plugin_xep_0280.py Sun Dec 18 20:21:31 2016 +0100 @@ -0,0 +1,154 @@ +#!/usr/bin/env python2 +# -*- coding: utf-8 -*- + +# SAT plugin for managing xep-0280 +# Copyright (C) 2009-2016 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 _, D_ +from sat.core.log import getLogger +log = getLogger(__name__) +from sat.core import exceptions +from sat.core.constants import Const as C +from sat.core.xmpp import SatMessageProtocol +from twisted.words.protocols.jabber.error import StanzaError +from twisted.internet import defer +from wokkel import disco, iwokkel +from zope.interface import implements +try: + from twisted.words.protocols.xmlstream import XMPPHandler +except ImportError: + from wokkel.subprotocols import XMPPHandler + + +PARAM_CATEGORY = "Misc" +PARAM_NAME = "carbon" +PARAM_LABEL = D_(u"Message carbons") +NS_CARBONS = 'urn:xmpp:carbons:2' + +PLUGIN_INFO = { + "name": "XEP-0280 Plugin", + "import_name": "XEP-0280", + "type": "XEP", + "protocols": ["XEP-0280"], + "dependencies": [], + "main": "XEP_0280", + "handler": "yes", + "description": _("""Implementation of Message Carbons""") +} + + +class XEP_0280(object): + # TODO: param is only checked at profile connection + # activate carbons on param change even after profile connection + # TODO: chat state notifications are not handled yet (and potentially other XEPs?) + + params = """ + <params> + <individual> + <category name="{category_name}" label="{category_label}"> + <param name="{param_name}" label="{param_label}" value="true" type="bool" security="0" /> + </category> + </individual> + </params> + """.format( + category_name = PARAM_CATEGORY, + category_label = D_(PARAM_CATEGORY), + param_name = PARAM_NAME, + param_label = PARAM_LABEL, + ) + + def __init__(self, host): + log.info(_("Plugin XEP_0280 initialization")) + self.host = host + host.memory.updateParams(self.params) + host.trigger.add("MessageReceived", self.messageReceivedTrigger, priority=1000) + + def getHandler(self, profile): + return XEP_0280_handler() + + @defer.inlineCallbacks + def profileConnected(self, profile): + """activate message carbons on connection if possible and activated in config""" + client = self.host.getClient(profile) + activate = self.host.memory.getParamA(PARAM_NAME, PARAM_CATEGORY, profile_key=profile) + if not activate: + log.info(_(u"Not activating message carbons as requested in params")) + return + try: + yield self.host.checkFeatures((NS_CARBONS,), profile=profile) + except exceptions.FeatureNotFound: + log.warning(_(u"server doesn't handle message carbons")) + else: + log.info(_(u"message carbons available, enabling it")) + iq_elt = client.IQ() + iq_elt.addElement((NS_CARBONS, 'enable')) + try: + yield iq_elt.send() + except StanzaError as e: + log.warning(u"Can't activate message carbons: {}".format(e)) + else: + log.info(_(u"message carbons activated")) + + def messageReceivedTrigger(self, client, message_elt, post_treat): + """get message and handle it if carbons namespace is present""" + carbons_elt = None + for e in message_elt.elements(): + if e.uri == NS_CARBONS: + carbons_elt = e + break + + if carbons_elt is None: + # this is not a message carbons, + # we continue normal behaviour + return True + + if message_elt['from'] != client.jid.userhost(): + log.warning(u"The message carbon received is not from our server, hack attempt?\n{xml}".format( + xml = message_elt.toXml(), + )) + return + forwarded_elt = next(carbons_elt.elements(C.NS_FORWARD, 'forwarded')) + cc_message_elt = next(forwarded_elt.elements(C.NS_CLIENT, 'message')) + if carbons_elt.name == 'received': + # on receive we replace the wrapping message with the CCed one + # and continue the normal behaviour + message_elt['from'] = cc_message_elt['from'] + del message_elt.children[:] + for c in cc_message_elt.children: + message_elt.addChild(c) + return True + elif carbons_elt.name == 'sent': + # on send we parse the message and just add it to history + # and send it to frontends (without normal sending treatments) + mess_data = SatMessageProtocol.parseMessage(cc_message_elt, client) + if not mess_data['message'] and not mess_data['subject']: + return False + self.host.messageAddToHistory(mess_data, client) + self.host.messageSendToBridge(mess_data, client) + else: + log.warning(u"invalid message carbons received:\n{xml}".format( + xml = message_elt.toXml())) + return False + + +class XEP_0280_handler(XMPPHandler): + implements(iwokkel.IDisco) + + def getDiscoInfo(self, requestor, target, nodeIdentifier=''): + return [disco.DiscoFeature(NS_CARBONS)] + + def getDiscoItems(self, requestor, target, nodeIdentifier=''): + return []