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
|
# Copyright (C) 2021 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
from nbxmpp.errors import MalformedStanzaError
from nbxmpp.errors import StanzaError
from nbxmpp.modules.base import BaseModule
from nbxmpp.modules.util import process_response
from nbxmpp.namespaces import Namespace
from nbxmpp.protocol import Iq
from nbxmpp.protocol import JID
from nbxmpp.protocol import NodeProcessed
from nbxmpp.simplexml import Node
from nbxmpp.structs import IqProperties
from nbxmpp.structs import RosterData
from nbxmpp.structs import RosterItem
from nbxmpp.structs import RosterPush
from nbxmpp.structs import StanzaHandler
from nbxmpp.task import iq_request_task
if TYPE_CHECKING:
from nbxmpp.client import Client
class Roster(BaseModule):
def __init__(self, client: Client) -> None:
BaseModule.__init__(self, client)
self._client = client
self.handlers = [
StanzaHandler(
name="iq",
callback=self._process_roster_push,
typ="set",
priority=15,
ns=Namespace.ROSTER,
),
]
@iq_request_task
def request_roster(self, version: str | None = None):
_task = yield
ver_support = self._client.features.has_roster_version()
if not ver_support:
version = None
if ver_support and version is None:
version = ""
self._log.info("Roster versioning supported: %s", ver_support)
response = yield _make_request(version, ver_support)
if response.isError():
raise StanzaError(response)
query = response.getTag("query", namespace=Namespace.ROSTER)
if query is None:
if not ver_support:
raise MalformedStanzaError("query node missing", response)
yield RosterData(None, version)
pushed_items, version = self._parse_push(response, ver_support)
yield RosterData(pushed_items, version)
def _process_roster_push(
self, _client: Client, stanza: Iq, properties: IqProperties
) -> None:
from_ = stanza.getFrom()
if from_ is not None:
if not self._client.get_bound_jid().bare == from_:
self._log.warning("Malicious Roster Push from %s", from_)
raise NodeProcessed
ver_support = self._client.features.has_roster_version()
pushed_items, version = self._parse_push(stanza, ver_support)
if len(pushed_items) != 1:
self._log.warning("Roster push contains more than one item")
self._log.warning(stanza)
raise NodeProcessed
item = pushed_items[0]
properties.roster = RosterPush(item, version)
self._log.info("Roster Push, version: %s", properties.roster.version)
self._log.info(item)
self._ack_roster_push(stanza)
def _ack_roster_push(self, stanza: Iq) -> None:
iq = Iq(
"result",
to=stanza.getFrom(),
frm=stanza.getTo(),
attrs={"id": stanza.getID()},
)
self._client.send_stanza(iq)
@iq_request_task
def delete_item(self, jid: JID | str):
_task = yield
response = yield _make_delete(jid)
yield process_response(response)
@iq_request_task
def set_item(self, jid: JID, name: str | None, groups: set[str] | None = None):
_task = yield
response = yield _make_set(jid, name, groups)
yield process_response(response)
def _parse_push(
self, stanza: Iq, ver_support: bool
) -> tuple[list[RosterItem], str | None]:
query = stanza.getTag("query", namespace=Namespace.ROSTER)
version = None
if ver_support:
version = query.getAttr("ver")
if version is None:
# raise MalformedStanzaError('ver attribute missing', stanza)
# Prosody sometimes does not send ver attribute with some
# community modules
self._log.warning("no version attribute found")
pushed_items: list[RosterItem] = []
for item in query.getTags("item"):
try:
roster_item = RosterItem.from_node(item)
except Exception:
self._log.warning("Invalid roster item")
self._log.warning(stanza)
continue
pushed_items.append(roster_item)
return pushed_items, version
def _make_delete(jid: JID | str) -> Iq:
return Iq(
"set",
Namespace.ROSTER,
payload=[Node("item", {"jid": jid, "subscription": "remove"})],
)
def _make_set(jid: JID, name: str | None, groups: set[str] | None = None) -> Iq:
if groups is None:
groups = set()
infos: dict[str, JID | str] = {"jid": jid}
if name:
infos["name"] = name
iq = Iq("set", Namespace.ROSTER)
query = iq.setQuery()
item = query.addChild("item", attrs=infos)
for group in groups:
item.addChild("group").setData(group)
return iq
def _make_request(version: str | None, roster_ver_support: bool) -> Iq:
iq = Iq("get", Namespace.ROSTER)
if version is None:
version = ""
if roster_ver_support:
iq.setTagAttr("query", "ver", version)
return iq
|
