summaryrefslogtreecommitdiff
path: root/sleekxmpp/plugins/xep_0030.py
blob: 59c60e662173c1486b5123a6dcda95089d11019e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
"""
    SleekXMPP: The Sleek XMPP Library
    Copyright (C) 2010 Nathanael C. Fritz, Lance J.T. Stout
    This file is part of SleekXMPP.

    See the file LICENSE for copying permission.
"""

import logging
from . import base
from .. xmlstream.handler.callback import Callback
from .. xmlstream.matcher.xpath import MatchXPath
from .. xmlstream.stanzabase import registerStanzaPlugin, ElementBase, ET, JID
from .. stanza.iq import Iq


log = logging.getLogger(__name__)


class DiscoInfo(ElementBase):
    namespace = 'http://jabber.org/protocol/disco#info'
    name = 'query'
    plugin_attrib = 'disco_info'
    interfaces = set(('node', 'features', 'identities'))

    def getFeatures(self):
        features = []
        featuresXML = self.xml.findall('{%s}feature' % self.namespace)
        for feature in featuresXML:
            features.append(feature.attrib['var'])
        return features

    def setFeatures(self, features):
        self.delFeatures()
        for name in features:
            self.addFeature(name)

    def delFeatures(self):
        featuresXML = self.xml.findall('{%s}feature' % self.namespace)
        for feature in featuresXML:
            self.xml.remove(feature)

    def addFeature(self, feature):
        featureXML = ET.Element('{%s}feature' % self.namespace,
                    {'var': feature})
        self.xml.append(featureXML)

    def delFeature(self, feature):
        featuresXML = self.xml.findall('{%s}feature' % self.namespace)
        for featureXML in featuresXML:
            if featureXML.attrib['var'] == feature:
                self.xml.remove(featureXML)

    def getIdentities(self):
        ids = []
        idsXML = self.xml.findall('{%s}identity' % self.namespace)
        for idXML in idsXML:
            idData = (idXML.attrib['category'],
                  idXML.attrib['type'],
                  idXML.attrib.get('name', ''))
            ids.append(idData)
        return ids

    def setIdentities(self, ids):
        self.delIdentities()
        for idData in ids:
            self.addIdentity(*idData)

    def delIdentities(self):
        idsXML = self.xml.findall('{%s}identity' % self.namespace)
        for idXML in idsXML:
            self.xml.remove(idXML)

    def addIdentity(self, category, itype, name=''):
        idXML = ET.Element('{%s}identity' % self.namespace)
        idXML.attrib['category'] = category
        idXML.attrib['type'] = itype
        if name:
            idXML.attrib['name'] = name
        self.xml.append(idXML)

    def delIdentity(self, category, id_type, name=''):
        idsXML = self.xml.findall('{%s}identity' % self.namespace)
        for idXML in idsXML:
            idData = (idXML.attrib['category'],
                  idXML.attrib['type'])
            delId = (category, id_type)
            if idData == delId:
                self.xml.remove(idXML)


class DiscoItems(ElementBase):
    namespace = 'http://jabber.org/protocol/disco#items'
    name = 'query'
    plugin_attrib = 'disco_items'
    interfaces = set(('node', 'items'))

    def getItems(self):
        items = []
        itemsXML = self.xml.findall('{%s}item' % self.namespace)
        for item in itemsXML:
            itemData = (item.attrib['jid'],
                    item.attrib.get('node'),
                    item.attrib.get('name'))
            items.append(itemData)
        return items

    def setItems(self, items):
        self.delItems()
        for item in items:
            self.addItem(*item)

    def delItems(self):
        itemsXML = self.xml.findall('{%s}item' % self.namespace)
        for item in itemsXML:
            self.xml.remove(item)

    def addItem(self, jid, node='', name=''):
        itemXML = ET.Element('{%s}item' % self.namespace, {'jid': jid})
        if name:
            itemXML.attrib['name'] = name
        if node:
            itemXML.attrib['node'] = node
        self.xml.append(itemXML)

    def delItem(self, jid, node=''):
        itemsXML = self.xml.findall('{%s}item' % self.namespace)
        for itemXML in itemsXML:
            itemData = (itemXML.attrib['jid'],
                    itemXML.attrib.get('node', ''))
            itemDel = (jid, node)
            if itemData == itemDel:
                self.xml.remove(itemXML)


class DiscoNode(object):
    """
    Collection object for grouping info and item information
    into nodes.
    """
    def __init__(self, name):
        self.name = name
        self.info = DiscoInfo()
        self.items = DiscoItems()

        self.info['node'] = name
        self.items['node'] = name

        # This is a bit like poor man's inheritance, but
        # to simplify adding information to the node we
        # map node functions to either the info or items
        # stanza objects.
        #
        # We don't want to make DiscoNode inherit from
        # DiscoInfo and DiscoItems because DiscoNode is
        # not an actual stanza, and doing so would create
        # confusion and potential bugs.

        self._map(self.items, 'items', ['get', 'set', 'del'])
        self._map(self.items, 'item', ['add', 'del'])
        self._map(self.info, 'identities', ['get', 'set', 'del'])
        self._map(self.info, 'identity', ['add', 'del'])
        self._map(self.info, 'features', ['get', 'set', 'del'])
        self._map(self.info, 'feature', ['add', 'del'])

    def isEmpty(self):
        """
        Test if the node contains any information. Useful for
        determining if a node can be deleted.
        """
        ids = self.getIdentities()
        features = self.getFeatures()
        items = self.getItems()

        if not ids and not features and not items:
            return True
        return False

    def _map(self, obj, interface, access):
        """
        Map functions of the form obj.accessInterface
        to self.accessInterface for each given access type.
        """
        interface = interface.title()
        for access_type in access:
            method = access_type + interface
            if hasattr(obj, method):
                setattr(self, method, getattr(obj, method))


class xep_0030(base.base_plugin):
    """
    XEP-0030 Service Discovery
    """

    def plugin_init(self):
        self.xep = '0030'
        self.description = 'Service Discovery'

        self.xmpp.registerHandler(
            Callback('Disco Items',
                 MatchXPath('{%s}iq/{%s}query' % (self.xmpp.default_ns,
                                  DiscoItems.namespace)),
                 self.handle_item_query))

        self.xmpp.registerHandler(
            Callback('Disco Info',
                 MatchXPath('{%s}iq/{%s}query' % (self.xmpp.default_ns,
                                  DiscoInfo.namespace)),
                 self.handle_info_query))

        registerStanzaPlugin(Iq, DiscoInfo)
        registerStanzaPlugin(Iq, DiscoItems)

        self.xmpp.add_event_handler('disco_items_request', self.handle_disco_items)
        self.xmpp.add_event_handler('disco_info_request', self.handle_disco_info)
        
        self.nodes = {}

        self.add_node('')
        self.add_feature('http://jabber.org/protocol/disco#info', node='')

    def add_node(self, node):
        if node not in self.nodes:
            self.nodes[node] = DiscoNode(node)

    def del_node(self, node):
        if node in self.nodes:
            del self.nodes[node]

    def rename_node(self, node, new_name):
        if new_name not in self.nodes and node in self.nodes:
            self.nodes[new_name] = self.nodes[node]
            self.nodes[new_name].name = new_name
            self.nodes[new_name].info['node'] = new_name
            self.nodes[new_name].items['node'] = new_name
            self.del_node(node)

    def handle_item_query(self, iq):
        if iq['type'] == 'get':
            log.debug("Items requested by %s" % iq['from'])
            self.xmpp.event('disco_items_request', iq)
        elif iq['type'] == 'result':
            log.debug("Items result from %s" % iq['from'])
            self.xmpp.event('disco_items', iq)

    def handle_info_query(self, iq):
        if iq['type'] == 'get':
            log.debug("Info requested by %s" % iq['from'])
            self.xmpp.event('disco_info_request', iq)
        elif iq['type'] == 'result':
            log.debug("Info result from %s" % iq['from'])
            self.xmpp.event('disco_info', iq)

    def handle_disco_info(self, iq, forwarded=False):
        """
        A default handler for disco#info requests. If another
        handler is registered, this one will defer and not run.
        """
        if not forwarded and \
           self.xmpp.event_handled('disco_info_request') > 1:
            return

        node_name = iq['disco_info']['node']
        log.debug("Using default handler for disco#info on node '%s'." % node_name)

        if node_name in self.nodes:
            node = self.nodes[node_name]
            iq.reply()
            iq['disco_info']['node'] = node_name

            identities = node.info['identities']
            if identities:
                iq['disco_info']['identities'] = identities
            else:
                if self.xmpp.is_component:
                    iq['disco_info'].addIdentity(
                            category='component',
                            itype='generic')
                else:
                    iq['disco_info'].addIdentity(
                            category='client',
                            itype='bot')
                log.info("No identity found for node '%'," + \
                         "using default, generic identity")

            iq['disco_info']['features'] = node.info['features']
            iq.send()
        else:
            log.debug("Node %s requested, but does not exist." % node_name)
            iq.reply().error().setPayload(iq['disco_info'].xml)
            iq['error']['code'] = '404'
            iq['error']['type'] = 'cancel'
            iq['error']['condition'] = 'item-not-found'
            iq.send()

    def handle_disco_items(self, iq, forwarded=False):
        """
        A default handler for disco#items requests. If another
        handler is registered, this one will defer and not run.

        If this handler is called by your own custom handler with
        forwarded set to True, then it will run as normal.
        """
        if not forwarded and \
           self.xmpp.event_handled('disco_items_request') > 1:
            return

        node_name = iq['disco_items']['node']
        log.debug("Using default handler for disco#items on node: '%s'." % node_name)

        if node_name in self.nodes:
            node = self.nodes[node_name]
            iq.reply().setPayload(node.items.xml).send()
        else:
            log.debug("Node %s requested, but does not exist." % node_name)
            iq.reply().error().setPayload(iq['disco_items'].xml)
            iq['error']['code'] = '404'
            iq['error']['type'] = 'cancel'
            iq['error']['condition'] = 'item-not-found'
            iq.send()

    # Older interface methods for backwards compatibility

    def getInfo(self, jid, node='', dfrom=None):
        iq = self.xmpp.Iq()
        iq['type'] = 'get'
        iq['to'] = jid
        iq['from'] = dfrom
        iq['disco_info']['node'] = node
        return iq.send()

    def getItems(self, jid, node='', dfrom=None):
        iq = self.xmpp.Iq()
        iq['type'] = 'get'
        iq['to'] = jid
        iq['from'] = dfrom
        iq['disco_items']['node'] = node
        return iq.send()

    def add_feature(self, feature, node=''):
        self.add_node(node)
        self.nodes[node].addFeature(feature)

    def add_identity(self, category='', itype='', name='', node=''):
        self.add_node(node)
        self.nodes[node].addIdentity(category=category,
                         id_type=itype,
                         name=name)

    def add_item(self, jid=None, name='', node='', subnode=''):
        self.add_node(node)
        self.add_node(subnode)
        if jid is None:
            jid = self.xmpp.fulljid
        self.nodes[node].addItem(jid=jid, name=name, node=subnode)