Mercurial > libervia-backend

comparison sat/plugins/plugin_exp_pubsub_admin.py @ 2776:838f53730ce4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
plugin pubsub admin: pubsub administrator first draft: This experimental protocol allows to publish items where publishers can be specified.
author Goffi <goffi@goffi.org>
date Tue, 15 Jan 2019 08:51:54 +0100
parents
children ab2696e34d29
comparison
equal deleted inserted replaced
2775:2dfd5b1d39df 2776:838f53730ce4
1 #!/usr/bin/env python2
2 # -*- coding: utf-8 -*-
3
4 # SAT plugin to send pubsub requests with administrator privilege
5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
6
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
16
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20 from sat.core.i18n import _
21 from sat.core import exceptions
22 from sat.core.constants import Const as C
23 from sat.core.log import getLogger
24 from sat.tools.common import data_format
25 from twisted.words.protocols.jabber import jid
26 from wokkel import pubsub
27 from wokkel import generic
28
29 log = getLogger(__name__)
30
31 PLUGIN_INFO = {
32 C.PI_NAME: u"Pubsub Administrator",
33 C.PI_IMPORT_NAME: u"PUBSUB_ADMIN",
34 C.PI_TYPE: C.PLUG_TYPE_EXP,
35 C.PI_PROTOCOLS: [],
36 C.PI_DEPENDENCIES: [],
37 C.PI_RECOMMENDATIONS: [],
38 C.PI_MAIN: u"PubsubAdmin",
39 C.PI_HANDLER: u"no",
40 C.PI_DESCRIPTION: _(u"""\Implementation of Pubsub Administrator
41 This allows a pubsub administrator to overwrite completly items, including publisher.
42 Specially useful when importing a node."""),
43 }
44
45 NS_PUBSUB_ADMIN = u"https://salut-a-toi.org/spec/pubsub_admin:0"
46
47
48 class PubsubAdmin(object):
49
50 def __init__(self, host):
51 self.host = host
52 host.bridge.addMethod(
53 "psAdminItemsSend",
54 ".plugin",
55 in_sign="ssasss",
56 out_sign="as",
57 method=self._publish,
58 async=True,
59 )
60
61 def _publish(self, service, nodeIdentifier, items, extra=None,
62 profile_key=C.PROF_KEY_NONE):
63 client = self.host.getClient(profile_key)
64 service = None if not service else jid.JID(service)
65 extra = data_format.deserialise(extra)
66 items = [generic.parseXml(i.encode('utf-8')) for i in items]
67 return self.publish(
68 client, service, nodeIdentifier, items, extra
69 )
70
71 def _sendCb(self, iq_result):
72 publish_elt = iq_result.admin.pubsub.publish
73 ids = []
74 for item_elt in publish_elt.elements(pubsub.NS_PUBSUB, u'item'):
75 ids.append(item_elt[u'id'])
76 return ids
77
78 def publish(self, client, service, nodeIdentifier, items, extra=None):
79 for item in items:
80 if item.name != u'item' or item.uri != pubsub.NS_PUBSUB:
81 raise exceptions.DataError(
82 u'Invalid element, a pubsub item is expected: {xml}'.format(
83 xml=item.toXml()))
84 iq_elt = client.IQ()
85 iq_elt['to'] = service.full() if service else client.jid.userhost()
86 admin_elt = iq_elt.addElement((NS_PUBSUB_ADMIN, u'admin'))
87 pubsub_elt = admin_elt.addElement((pubsub.NS_PUBSUB, u'pubsub'))
88 publish_elt = pubsub_elt.addElement('publish')
89 publish_elt[u'node'] = nodeIdentifier
90 for item in items:
91 publish_elt.addChild(item)
92 d = iq_elt.send()
93 d.addCallback(self._sendCb)
94 return d