File: discovery.py

package info (click to toggle)
python-nbxmpp 6.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,340 kB
  • sloc: python: 19,639; makefile: 4
file content (144 lines) | stat: -rw-r--r-- 4,252 bytes parent folder | download | duplicates (2)
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
# Copyright (C) 2019 Philipp Hörist <philipp AT hoerist.com>
#
# This file is part of nbxmpp.
#
# SPDX-License-Identifier: GPL-3.0-or-later

from __future__ import annotations

from typing import TYPE_CHECKING

import logging
import time

from nbxmpp.errors import MalformedStanzaError
from nbxmpp.errors import StanzaError
from nbxmpp.modules.base import BaseModule
from nbxmpp.modules.dataforms import extend_form
from nbxmpp.namespaces import Namespace
from nbxmpp.protocol import ERR_ITEM_NOT_FOUND
from nbxmpp.protocol import ErrorNode
from nbxmpp.protocol import Iq
from nbxmpp.protocol import JID
from nbxmpp.protocol import NodeProcessed
from nbxmpp.structs import DiscoIdentity
from nbxmpp.structs import DiscoInfo
from nbxmpp.structs import DiscoItem
from nbxmpp.structs import DiscoItems
from nbxmpp.structs import IqProperties
from nbxmpp.structs import StanzaHandler
from nbxmpp.task import iq_request_task

if TYPE_CHECKING:
    from nbxmpp.client import Client

log = logging.getLogger("nbxmpp.m.discovery")


class Discovery(BaseModule):
    def __init__(self, client: Client) -> None:
        BaseModule.__init__(self, client)

        self._client = client
        self.handlers = [
            StanzaHandler(
                name="iq",
                callback=self._process_disco_info,
                typ="get",
                ns=Namespace.DISCO_INFO,
                priority=90,
            ),
        ]

    @staticmethod
    def _process_disco_info(
        client: Client, stanza: Iq, _properties: IqProperties
    ) -> None:
        iq = stanza.buildReply("error")
        iq.addChild(node=ErrorNode(ERR_ITEM_NOT_FOUND))
        client.send_stanza(iq)
        raise NodeProcessed

    @iq_request_task
    def disco_info(self, jid: JID | str, node: str | None = None):
        _task = yield

        response = yield get_disco_request(Namespace.DISCO_INFO, jid, node)
        if response.isError():
            raise StanzaError(response)
        yield parse_disco_info(response)

    @iq_request_task
    def disco_items(self, jid: JID | str, node: str | None = None):
        _task = yield

        response = yield get_disco_request(Namespace.DISCO_ITEMS, jid, node)
        if response.isError():
            raise StanzaError(response)
        yield parse_disco_items(response)


def parse_disco_info(stanza: Iq, timestamp: float | None = None) -> DiscoInfo:
    identities: list[DiscoIdentity] = []
    features: list[str] = []
    dataforms = []

    if timestamp is None:
        timestamp = time.time()

    query = stanza.getQuery()
    for node in query.getTags("identity"):
        attrs = node.getAttrs()
        try:
            identities.append(
                DiscoIdentity(
                    category=attrs["category"],
                    type=attrs["type"],
                    name=attrs.get("name"),
                    lang=attrs.get("xml:lang"),
                )
            )
        except Exception:
            raise MalformedStanzaError("invalid attributes", stanza)

    for node in query.getTags("feature"):
        try:
            features.append(node.getAttr("var"))
        except Exception:
            raise MalformedStanzaError("invalid attributes", stanza)

    for node in query.getTags("x", namespace=Namespace.DATA):
        dataforms.append(extend_form(node))

    return DiscoInfo(
        stanza=stanza,
        identities=identities,
        features=features,
        dataforms=dataforms,
        timestamp=timestamp,
    )


def parse_disco_items(stanza: Iq) -> DiscoItems:
    items: list[DiscoItem] = []

    query = stanza.getQuery()
    for node in query.getTags("item"):
        attrs = node.getAttrs()
        try:
            items.append(
                DiscoItem(
                    jid=attrs["jid"], name=attrs.get("name"), node=attrs.get("node")
                )
            )
        except Exception:
            raise MalformedStanzaError("invalid attributes", stanza)

    return DiscoItems(jid=stanza.getFrom(), node=query.getAttr("node"), items=items)


def get_disco_request(namespace: str, jid: str, node: str | None = None) -> Iq:
    iq = Iq("get", to=jid, queryNS=namespace)
    if node:
        iq.getQuery().setAttr("node", node)
    return iq