Mercurial > libervia-backend
view src/plugins/plugin_xep_0020.py @ 1955:633b5c21aefd
backend, frontend: messages refactoring (huge commit, not finished):
/!\ database schema has been modified, do a backup before updating
message have been refactored, here are the main changes:
- languages are now handled
- all messages have an uid (internal to SàT)
- message updating is anticipated
- subject is now first class
- new naming scheme is used newMessage => messageNew, getHistory => historyGet, sendMessage => messageSend
- minimal compatibility refactoring in quick_frontend/Primitivus, better refactoring should follow
- threads handling
- delayed messages are saved into history
- info messages may also be saved in history (e.g. to keep track of people joining/leaving a room)
- duplicate messages should be avoided
- historyGet return messages in right order, no need to sort again
- plugins have been updated to follow new features, some of them need to be reworked (e.g. OTR)
- XEP-0203 (Delayed Delivery) is now fully handled in core, the plugin just handle disco and creation of a delay element
- /!\ jp and Libervia are currently broken, as some features of Primitivus
It has been put in one huge commit to avoid breaking messaging between changes.
This is the main part of message refactoring, other commits will follow to take profit of the new features/behaviour.
author | Goffi <goffi@goffi.org> |
---|---|
date | Tue, 24 May 2016 22:11:04 +0200 |
parents | 2daf7b4c6756 |
children | 1d3f73e065e1 |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # SAT plugin for managing xep-0020 # 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.log import getLogger log = getLogger(__name__) from sat.core import exceptions from twisted.words.xish import domish from zope.interface import implements try: from twisted.words.protocols.xmlstream import XMPPHandler except ImportError: from wokkel.subprotocols import XMPPHandler from wokkel import disco, iwokkel, data_form NS_FEATURE_NEG = 'http://jabber.org/protocol/feature-neg' PLUGIN_INFO = { "name": "XEP 0020 Plugin", "import_name": "XEP-0020", "type": "XEP", "protocols": ["XEP-0020"], "main": "XEP_0020", "handler": "yes", "description": _("""Implementation of Feature Negotiation""") } class XEP_0020(object): def __init__(self, host): log.info(_("Plugin XEP_0020 initialization")) def getHandler(self, profile): return XEP_0020_handler() def getFeatureElt(self, elt): """Check element's children to find feature elements @param elt(domish.Element): parent element of the feature element @return: feature elements @raise exceptions.NotFound: no feature element found """ try: feature_elt = elt.elements(NS_FEATURE_NEG, 'feature').next() except StopIteration: raise exceptions.NotFound return feature_elt def _getForm(self, elt, namespace): """Return the first child data form @param elt(domish.Element): parent of the data form @param namespace (None, unicode): form namespace or None to ignore @return (None, data_form.Form): data form or None is nothing is found """ if namespace is None: try: form_elt = elt.elements(data_form.NS_X_DATA).next() except StopIteration: return None else: return data_form.Form.fromElement(form_elt) else: return data_form.findForm(elt, namespace) def getChoosedOptions(self, feature_elt, namespace): """Return choosed feature for feature element @param feature_elt(domish.Element): feature domish element @param namespace (None, unicode): form namespace or None to ignore @return (dict): feature name as key, and choosed option as value @raise exceptions.NotFound: not data form is found """ form = self._getForm(feature_elt, namespace) if form is None: raise exceptions.NotFound result = {} for field in form.fields: values = form.fields[field].values result[field] = values[0] if values else None if len(values) > 1: log.warning(_(u"More than one value choosed for {}, keeping the first one").format(field)) return result def negotiate(self, feature_elt, name, negotiable_values, namespace): """Negotiate the feature options @param feature_elt(domish.Element): feature element @param name: the option name (i.e. field's var attribute) to negotiate @param negotiable_values(iterable): acceptable values for this negotiation first corresponding value will be returned @param namespace (None, unicode): form namespace or None to ignore @raise KeyError: name is not found in data form fields """ form = self._getForm(feature_elt, namespace) options = [option.value for option in form.fields[name].options] for value in negotiable_values: if value in options: return value return None def chooseOption(self, options, namespace): """Build a feature element with choosed options @param options(dict): dict with feature as key and choosed option as value @param namespace (None, unicode): form namespace or None to ignore """ feature_elt = domish.Element((NS_FEATURE_NEG, 'feature')) x_form = data_form.Form('submit', formNamespace=namespace) x_form.makeFields(options) feature_elt.addChild(x_form.toElement()) return feature_elt def proposeFeatures(self, options_dict, namespace): """Build a feature element with options to propose @param options_dict(dict): dict with feature as key and iterable of acceptable options as value @param namespace(None, unicode): feature namespace """ feature_elt = domish.Element((NS_FEATURE_NEG, 'feature')) x_form = data_form.Form('form', formNamespace=namespace) for field in options_dict: x_form.addField(data_form.Field('list-single', field, options=[data_form.Option(option) for option in options_dict[field]])) feature_elt.addChild(x_form.toElement()) return feature_elt class XEP_0020_handler(XMPPHandler): implements(iwokkel.IDisco) def getDiscoInfo(self, requestor, target, nodeIdentifier=''): return [disco.DiscoFeature(NS_FEATURE_NEG)] def getDiscoItems(self, requestor, target, nodeIdentifier=''): return []