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
|
# Copyright (C) 2020 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 Literal
from dataclasses import dataclass
from nbxmpp.const import Affiliation
from nbxmpp.const import Role
from nbxmpp.modules.vcard_temp import VCard
from nbxmpp.namespaces import Namespace
from nbxmpp.protocol import InvalidJid
from nbxmpp.protocol import Iq
from nbxmpp.protocol import JID
from nbxmpp.protocol import Message
from nbxmpp.protocol import StanzaMalformed
from nbxmpp.simplexml import Node
from nbxmpp.structs import DiscoInfo
from nbxmpp.structs import MucUserData
AffiliationT = Literal["owner", "admin", "member", "outcast", "none"]
RoleT = Literal["moderator", "participant", "visitor", "none"]
@dataclass
class MucInfoResult:
info: DiscoInfo
vcard: VCard | None = None
redirected: bool = False
def make_affiliation_request(jid: JID | str, affiliation: AffiliationT) -> Iq:
iq = Iq(typ="get", to=jid, queryNS=Namespace.MUC_ADMIN)
item = iq.setQuery().setTag("item")
item.setAttr("affiliation", affiliation)
return iq
def make_set_affiliation_request(
room_jid: JID, users_dict: dict[JID, dict[str, str | None]]
) -> Iq:
iq = Iq(typ="set", to=room_jid, queryNS=Namespace.MUC_ADMIN)
item = iq.setQuery()
for jid, data in users_dict.items():
affiliation = data.get("affiliation")
reason = data.get("reason")
nick = data.get("nick")
item_tag = item.addChild("item", {"jid": jid, "affiliation": affiliation})
if reason is not None:
item_tag.setTagData("reason", reason)
if nick is not None:
item_tag.setAttr("nick", nick)
return iq
def make_destroy_request(room_jid: JID, reason: str | None, jid: str | None) -> Iq:
iq = Iq(typ="set", queryNS=Namespace.MUC_OWNER, to=room_jid)
destroy = iq.setQuery().setTag("destroy")
if reason:
destroy.setTagData("reason", reason)
if jid:
destroy.setAttr("jid", jid)
return iq
def make_set_config_request(room_jid: JID, form) -> Iq:
iq = Iq(typ="set", to=room_jid, queryNS=Namespace.MUC_OWNER)
query = iq.setQuery()
form.setAttr("type", "submit")
query.addChild(node=form)
return iq
def make_config_request(room_jid: JID) -> Iq:
iq = Iq(typ="get", queryNS=Namespace.MUC_OWNER, to=room_jid)
return iq
def make_cancel_config_request(room_jid: JID) -> Iq:
cancel = Node(tag="x", attrs={"xmlns": Namespace.DATA, "type": "cancel"})
iq = Iq(typ="set", queryNS=Namespace.MUC_OWNER, payload=cancel, to=room_jid)
return iq
def make_set_role_request(
room_jid: JID, nick: str, role: RoleT, reason: str | None
) -> Iq:
iq = Iq(typ="set", to=room_jid, queryNS=Namespace.MUC_ADMIN)
item = iq.setQuery().setTag("item")
item.setAttr("nick", nick)
item.setAttr("role", role)
if reason:
item.addChild(name="reason", payload=reason)
return iq
def make_captcha_request(room_jid: JID, form_node) -> Iq:
iq = Iq(typ="set", to=room_jid)
captcha = iq.addChild(name="captcha", namespace=Namespace.CAPTCHA)
captcha.addChild(node=form_node)
return iq
def build_direct_invite(
room: JID, to: JID, reason: str | None, password: str | None, continue_: bool | None
) -> Message:
message = Message(to=to)
attrs = {"jid": room}
if reason:
attrs["reason"] = reason
if continue_:
attrs["continue"] = "true"
if password:
attrs["password"] = password
message.addChild(name="x", attrs=attrs, namespace=Namespace.CONFERENCE)
return message
def build_mediated_invite(
room: JID, to: JID, reason: str | None, password: str | None, continue_: bool | None
) -> Message:
message = Message(to=room)
muc_user = message.addChild("x", namespace=Namespace.MUC_USER)
invite = muc_user.addChild("invite", attrs={"to": to})
if continue_:
invite.addChild(name="continue")
if reason:
invite.setTagData("reason", reason)
if password:
muc_user.setTagData("password", password)
return message
def parse_muc_user(muc_user: Node, is_presence: bool = True) -> MucUserData | None:
item = muc_user.getTag("item")
if item is None:
return None
item_dict = item.getAttrs()
role = item_dict.get("role")
if role is not None:
try:
role = Role(role)
except ValueError:
raise StanzaMalformed("invalid role %s" % role)
elif is_presence:
# role attr MUST be included in all presence broadcasts
raise StanzaMalformed("role attr missing")
affiliation = item_dict.get("affiliation")
if affiliation is not None:
try:
affiliation = Affiliation(affiliation)
except ValueError:
raise StanzaMalformed("invalid affiliation %s" % affiliation)
elif is_presence:
# affiliation attr MUST be included in all presence broadcasts
raise StanzaMalformed("affiliation attr missing")
jid = item_dict.get("jid")
if jid is not None:
try:
jid = JID.from_string(jid, force_bare=True)
except InvalidJid as error:
raise StanzaMalformed("invalid jid %s, %s" % (jid, error))
return MucUserData(
affiliation=affiliation,
jid=jid,
nick=item.getAttr("nick"),
role=role,
actor=item.getTagAttr("actor", "nick"),
reason=item.getTagData("reason"),
)
|
