Mercurial > libervia-backend
view sat/plugins/plugin_xep_0059.py @ 2844:fa1cc09df195
plugin XEP-0045: added getRoomOccupants/mucOccupantsGet method to retrieve occupants of a joined room.
author | Goffi <goffi@goffi.org> |
---|---|
date | Sat, 09 Mar 2019 16:24:17 +0100 |
parents | 003b8b4b56a7 |
children | ab2696e34d29 |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # SAT plugin for Result Set Management (XEP-0059) # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org) # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.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 wokkel import disco from wokkel import iwokkel from wokkel import rsm from twisted.words.protocols.jabber import xmlstream from zope.interface import implements PLUGIN_INFO = { C.PI_NAME: u"Result Set Management", C.PI_IMPORT_NAME: u"XEP-0059", C.PI_TYPE: u"XEP", C.PI_PROTOCOLS: [u"XEP-0059"], C.PI_MAIN: u"XEP_0059", C.PI_HANDLER: u"yes", C.PI_DESCRIPTION: _(u"""Implementation of Result Set Management"""), } RSM_PREFIX = u"rsm_" class XEP_0059(object): # XXX: RSM management is done directly in Wokkel. def __init__(self, host): log.info(_(u"Result Set Management plugin initialization")) def getHandler(self, client): return XEP_0059_handler() def parseExtra(self, extra): """Parse extra dictionnary to retrieve RSM arguments @param extra(dict): data for parse @return (rsm.RSMRequest, None): request with parsed arguments or None if no RSM arguments have been found """ if int(extra.get(RSM_PREFIX + u'max', 0)) < 0: raise ValueError(_(u"rsm_max can't be negative")) rsm_args = {} for arg in (u"max", u"after", u"before", u"index"): try: argname = "max_" if arg == u"max" else arg rsm_args[argname] = extra.pop(RSM_PREFIX + arg) except KeyError: continue if rsm_args: return rsm.RSMRequest(**rsm_args) else: return None def serialise(self, rsm_response, data=None): """Serialise data for RSM Key set in data can be: - rsm_first: first item id in the page - rsm_last: last item id in the page - rsm_index: position of the first item in the full set (may be approximate) - rsm_count: total number of items in the full set (may be approximage) If a value doesn't exists, it's not set. All values are set as strings. @param rsm_response(rsm.RSMResponse): response to serialise @param data(dict, None): dict to update with rsm_* data. If None, a new dict is created @return (dict): data dict """ if data is None: data = {} if rsm_response.first is not None: data[u"rsm_first"] = rsm_response.first if rsm_response.last is not None: data[u"rsm_last"] = rsm_response.last if rsm_response.index is not None: data[u"rsm_index"] = unicode(rsm_response.index) if rsm_response.index is not None: data[u"rsm_index"] = unicode(rsm_response.index) return data class XEP_0059_handler(xmlstream.XMPPHandler): implements(iwokkel.IDisco) def getDiscoInfo(self, requestor, target, nodeIdentifier=""): return [disco.DiscoFeature(rsm.NS_RSM)] def getDiscoItems(self, requestor, target, nodeIdentifier=""): return []