Mercurial > libervia-backend
view sat/plugins/plugin_exp_pubsub_admin.py @ 4002:5245b675f7ad
plugin XEP-0313: don't wait for MAM to be retrieved in connection workflow:
MAM retrieval can be long, and can be done after connection, message just need to be
sorted when being inserted (i.e. frontends must do insort).
To avoid blocking connection for too long and result in bad UX and timeout risk, one2one
MAM message are not retrieved in background.
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 10 Mar 2023 17:22:45 +0100 |
parents | be6d91572633 |
children | 524856bd7b19 |
line wrap: on
line source
#!/usr/bin/env python3 # SAT plugin to send pubsub requests with administrator privilege # Copyright (C) 2009-2021 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 import exceptions from sat.core.constants import Const as C from sat.core.log import getLogger from sat.tools.common import data_format from twisted.words.protocols.jabber import jid from wokkel import pubsub from wokkel import generic log = getLogger(__name__) PLUGIN_INFO = { C.PI_NAME: "Pubsub Administrator", C.PI_IMPORT_NAME: "PUBSUB_ADMIN", C.PI_TYPE: C.PLUG_TYPE_EXP, C.PI_PROTOCOLS: [], C.PI_DEPENDENCIES: [], C.PI_RECOMMENDATIONS: [], C.PI_MAIN: "PubsubAdmin", C.PI_HANDLER: "no", C.PI_DESCRIPTION: _("""\Implementation of Pubsub Administrator This allows a pubsub administrator to overwrite completly items, including publisher. Specially useful when importing a node."""), } NS_PUBSUB_ADMIN = "https://salut-a-toi.org/spec/pubsub_admin:0" class PubsubAdmin(object): def __init__(self, host): self.host = host host.bridge.addMethod( "psAdminItemsSend", ".plugin", in_sign="ssasss", out_sign="as", method=self._publish, async_=True, ) def _publish(self, service, nodeIdentifier, items, extra=None, profile_key=C.PROF_KEY_NONE): client = self.host.getClient(profile_key) service = None if not service else jid.JID(service) extra = data_format.deserialise(extra) items = [generic.parseXml(i.encode('utf-8')) for i in items] return self.publish( client, service, nodeIdentifier, items, extra ) def _sendCb(self, iq_result): publish_elt = iq_result.admin.pubsub.publish ids = [] for item_elt in publish_elt.elements(pubsub.NS_PUBSUB, 'item'): ids.append(item_elt['id']) return ids def publish(self, client, service, nodeIdentifier, items, extra=None): for item in items: if item.name != 'item' or item.uri != pubsub.NS_PUBSUB: raise exceptions.DataError( 'Invalid element, a pubsub item is expected: {xml}'.format( xml=item.toXml())) iq_elt = client.IQ() iq_elt['to'] = service.full() if service else client.jid.userhost() admin_elt = iq_elt.addElement((NS_PUBSUB_ADMIN, 'admin')) pubsub_elt = admin_elt.addElement((pubsub.NS_PUBSUB, 'pubsub')) publish_elt = pubsub_elt.addElement('publish') publish_elt['node'] = nodeIdentifier for item in items: publish_elt.addChild(item) d = iq_elt.send() d.addCallback(self._sendCb) return d