Mercurial > libervia-pubsub
view sat_pubsub/pubsub_admin.py @ 476:1092bab8b3f3
doc: update names following global renaming
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 03 Jan 2022 16:45:55 +0100 |
parents | 412d26a9b2c2 |
children | b544109ab4c4 |
line wrap: on
line source
#!/usr/bin/env python3 #-*- coding: utf-8 -*- # Copyright (c) 2019 Jérôme Poisson # # 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/>. """ Pubsub Admin experimental protocol implementation """ from zope.interface import implementer from twisted.python import log from twisted.internet import defer from twisted.words.protocols.jabber import jid, error as jabber_error, xmlstream from sat_pubsub import error from wokkel.subprotocols import XMPPHandler from wokkel import disco, iwokkel, pubsub NS_PUBSUB_ADMIN = "https://salut-a-toi.org/spec/pubsub_admin:0" ADMIN_REQUEST = '/iq[@type="set"]/admin[@xmlns="{}"]'.format(NS_PUBSUB_ADMIN) @implementer(iwokkel.IDisco) class PubsubAdminHandler(XMPPHandler): def __init__(self, backend): super(PubsubAdminHandler, self).__init__() self.backend = backend def connectionInitialized(self): self.xmlstream.addObserver(ADMIN_REQUEST, self.onAdminRequest) def sendError(self, iq_elt, condition='bad-request'): stanza_error = jabber_error.StanzaError(condition) iq_error = stanza_error.toResponse(iq_elt) self.parent.xmlstream.send(iq_error) @defer.inlineCallbacks def onAdminRequest(self, iq_elt): """Pubsub Admin request received""" iq_elt.handled = True try: pep = bool(iq_elt.delegated) except AttributeError: pep = False # is the sender really an admin? admins = self.backend.config['admins_jids_list'] from_jid = jid.JID(iq_elt['from']) if from_jid.userhostJID() not in admins: log.msg("WARNING: admin request done by non admin entity {from_jid}" .format(from_jid=from_jid.full())) self.sendError(iq_elt, 'forbidden') return # alright, we can proceed recipient = jid.JID(iq_elt['to']) admin_elt = iq_elt.admin try: pubsub_elt = next(admin_elt.elements(pubsub.NS_PUBSUB, 'pubsub')) publish_elt = next(pubsub_elt.elements(pubsub.NS_PUBSUB, 'publish')) except StopIteration: self.sendError(iq_elt) return try: node = publish_elt['node'] except KeyError: self.sendError(iq_elt) return # we prepare the result IQ request, we will fill it with item ids iq_result_elt = xmlstream.toResponse(iq_elt, 'result') result_admin_elt = iq_result_elt.addElement((NS_PUBSUB_ADMIN, 'admin')) result_pubsub_elt = result_admin_elt.addElement((pubsub.NS_PUBSUB, 'pubsub')) result_publish_elt = result_pubsub_elt.addElement('publish') result_publish_elt['node'] = node # now we can send the items for item in publish_elt.elements(pubsub.NS_PUBSUB, 'item'): try: requestor = jid.JID(item.attributes.pop('publisher')) except Exception as e: log.msg("WARNING: invalid jid in publisher ({requestor}): {msg}" .format(requestor=requestor, msg=e)) self.sendError(iq_elt) return except KeyError: requestor = from_jid # we don't use a DeferredList because we want to be sure that # each request is done in order try: payload = yield self.backend.publish( nodeIdentifier=node, items=[item], requestor=requestor, pep=pep, recipient=recipient) except (error.Forbidden, error.ItemForbidden): self.sendError(iq_elt, "forbidden") return except Exception as e: self.sendError(iq_elt, "internal-server-error") log.msg("INTERNAL ERROR: {msg}".format(msg=e)) return result_item_elt = result_publish_elt.addElement('item') # either the id was given and it is available in item # either it's a new item, and we can retrieve it from return payload try: result_item_elt['id'] = item['id'] except KeyError: result_item_elt = payload.publish.item['id'] self.xmlstream.send(iq_result_elt) def getDiscoInfo(self, requestor, service, nodeIdentifier=''): return [disco.DiscoFeature(NS_PUBSUB_ADMIN)] def getDiscoItems(self, requestor, service, nodeIdentifier=''): return []