Mercurial > libervia-backend
view src/plugins/plugin_xep_0095.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 | 6a66c8c5a567 |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # SAT plugin for managing xep-0095 # 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 _ from sat.core.constants import Const as C from sat.core.log import getLogger log = getLogger(__name__) from sat.core import exceptions from twisted.words.protocols.jabber import xmlstream from twisted.words.protocols.jabber import error from zope.interface import implements from wokkel import disco from wokkel import iwokkel import uuid PLUGIN_INFO = { "name": "XEP 0095 Plugin", "import_name": "XEP-0095", "type": "XEP", "protocols": ["XEP-0095"], "main": "XEP_0095", "handler": "yes", "description": _("""Implementation of Stream Initiation""") } IQ_SET = '/iq[@type="set"]' NS_SI = 'http://jabber.org/protocol/si' SI_REQUEST = IQ_SET + '/si[@xmlns="' + NS_SI + '"]' SI_PROFILE_HEADER = "http://jabber.org/protocol/si/profile/" SI_ERROR_CONDITIONS = ('bad-profile', 'no-valid-streams') class XEP_0095(object): def __init__(self, host): log.info(_("Plugin XEP_0095 initialization")) self.host = host self.si_profiles = {} # key: SI profile, value: callback def getHandler(self, profile): return XEP_0095_handler(self) def registerSIProfile(self, si_profile, callback): """Add a callback for a SI Profile @param si_profile(unicode): SI profile name (e.g. file-transfer) @param callback(callable): method to call when the profile name is asked """ self.si_profiles[si_profile] = callback def unregisterSIProfile(self, si_profile): try: del self.si_profiles[si_profile] except KeyError: log.error(u"Trying to unregister SI profile [{}] which was not registered".format(si_profile)) def streamInit(self, iq_elt, profile): """This method is called on stream initiation (XEP-0095 #3.2) @param iq_elt: IQ element @param profile: %(doc_profile)s""" log.info(_("XEP-0095 Stream initiation")) iq_elt.handled = True si_elt = iq_elt.elements(NS_SI, 'si').next() si_id = si_elt['id'] si_mime_type = iq_elt.getAttribute('mime-type', 'application/octet-stream') si_profile = si_elt['profile'] si_profile_key = si_profile[len(SI_PROFILE_HEADER):] if si_profile.startswith(SI_PROFILE_HEADER) else si_profile if si_profile_key in self.si_profiles: #We know this SI profile, we call the callback self.si_profiles[si_profile_key](iq_elt, si_id, si_mime_type, si_elt, profile) else: #We don't know this profile, we send an error self.sendError(iq_elt, 'bad-profile', profile) def sendError(self, request, condition, profile): """Send IQ error as a result @param request(domish.Element): original IQ request @param condition(str): error condition @param profile: %(doc_profile)s """ client = self.host.getClient(profile) if condition in SI_ERROR_CONDITIONS: si_condition = condition condition = 'bad-request' else: si_condition = None iq_error_elt = error.StanzaError(condition).toResponse(request) if si_condition is not None: iq_error_elt.error.addElement((NS_SI, si_condition)) client.xmlstream.send(iq_error_elt) def acceptStream(self, iq_elt, feature_elt, misc_elts=None, profile=C.PROF_KEY_NONE): """Send the accept stream initiation answer @param iq_elt(domish.Element): initial SI request @param feature_elt(domish.Element): 'feature' element containing stream method to use @param misc_elts(list[domish.Element]): list of elements to add @param profile: %(doc_profile)s """ log.info(_("sending stream initiation accept answer")) if misc_elts is None: misc_elts = [] client = self.host.getClient(profile) result_elt = xmlstream.toResponse(iq_elt, 'result') si_elt = result_elt.addElement((NS_SI, 'si')) si_elt.addChild(feature_elt) for elt in misc_elts: si_elt.addChild(elt) client.xmlstream.send(result_elt) def _parseOfferResult(self, iq_elt): try: si_elt = iq_elt.elements(NS_SI, "si").next() except StopIteration: log.warning(u"No <si/> element found in result while expected") raise exceptions.DataError return (iq_elt, si_elt) def proposeStream(self, to_jid, si_profile, feature_elt, misc_elts, mime_type='application/octet-stream', profile=C.PROF_KEY_NONE): """Propose a stream initiation @param to_jid(jid.JID): recipient @param si_profile(unicode): Stream initiation profile (XEP-0095) @param feature_elt(domish.Element): feature element, according to XEP-0020 @param misc_elts(list[domish.Element]): list of elements to add @param mime_type(unicode): stream mime type @param profile: %(doc_profile)s @return (tuple): tuple with: - session id (unicode) - (D(domish_elt, domish_elt): offer deferred which returl a tuple with iq_elt and si_elt """ client = self.host.getClient(profile) offer = client.IQ() sid = str(uuid.uuid4()) log.debug(_(u"Stream Session ID: %s") % offer["id"]) offer["from"] = client.jid.full() offer["to"] = to_jid.full() si = offer.addElement('si', NS_SI) si['id'] = sid si["mime-type"] = mime_type si["profile"] = si_profile for elt in misc_elts: si.addChild(elt) si.addChild(feature_elt) offer_d = offer.send() offer_d.addCallback(self._parseOfferResult) return sid, offer_d class XEP_0095_handler(xmlstream.XMPPHandler): implements(iwokkel.IDisco) def __init__(self, plugin_parent): self.plugin_parent = plugin_parent self.host = plugin_parent.host def connectionInitialized(self): self.xmlstream.addObserver(SI_REQUEST, self.plugin_parent.streamInit, profile=self.parent.profile) def getDiscoInfo(self, requestor, target, nodeIdentifier=''): return [disco.DiscoFeature(NS_SI)] + [disco.DiscoFeature(u"http://jabber.org/protocol/si/profile/{}".format(profile_name)) for profile_name in self.plugin_parent.si_profiles] def getDiscoItems(self, requestor, target, nodeIdentifier=''): return []