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
|
# This file is part of nbxmpp.
#
# SPDX-License-Identifier: GPL-3.0-or-later
# XEP-0425: Message Moderation
from __future__ import annotations
from typing import TYPE_CHECKING
import datetime as dt
from nbxmpp import JID
from nbxmpp.modules.base import BaseModule
from nbxmpp.modules.date_and_time import parse_datetime
from nbxmpp.modules.util import process_response
from nbxmpp.namespaces import Namespace
from nbxmpp.protocol import Iq
from nbxmpp.protocol import Message
from nbxmpp.protocol import NodeProcessed
from nbxmpp.simplexml import Node
from nbxmpp.structs import MessageProperties
from nbxmpp.structs import ModerationData
from nbxmpp.structs import StanzaHandler
from nbxmpp.task import iq_request_task
if TYPE_CHECKING:
from nbxmpp.client import Client
class Moderation(BaseModule):
def __init__(self, client: Client) -> None:
BaseModule.__init__(self, client)
self._client = client
self.handlers = [
StanzaHandler(
name="message",
callback=self._process_moderation_0_message,
typ="groupchat",
ns=Namespace.FASTEN,
priority=20,
),
StanzaHandler(
name="message",
callback=self._process_moderation_0_tombstone_message,
typ="groupchat",
ns=Namespace.MESSAGE_MODERATE,
priority=20,
),
StanzaHandler(
name="message",
callback=self._process_moderation_1_message,
typ="groupchat",
ns=Namespace.MESSAGE_RETRACT_1,
priority=20,
),
]
@iq_request_task
def send_moderation_request(
self,
namespace: str,
muc_jid: JID,
stanza_id: str,
reason: str | None = None,
):
_task = yield
if namespace == Namespace.MESSAGE_MODERATE:
response = yield _make_moderation_request_0(muc_jid, stanza_id, reason)
else:
response = yield _make_moderation_request_1(muc_jid, stanza_id, reason)
yield process_response(response)
def _process_moderation_1_message(
self, _client: Client, stanza: Message, properties: MessageProperties
) -> None:
retract, is_tombstone = _get_retract_element(stanza, properties)
if retract is None:
return
stamp = _parse_moderation_timestamp(retract, is_tombstone, properties)
moderated = retract.getTag("moderated", namespace=Namespace.MESSAGE_MODERATE_1)
if moderated is None:
return
try:
by = _parse_by_attr(moderated)
except ValueError as error:
self._log.warning("Unable to determine by attribute: %s", error)
by = None
occupant_id = moderated.getTagAttr(
"occupant-id", "id", namespace=Namespace.OCCUPANT_ID
)
if is_tombstone:
stanza_id = properties.mam.id
else:
stanza_id = retract.getAttr("id")
if stanza_id is None:
self._log.warning("Unable to determine stanza-id")
self._log.warning(stanza)
raise NodeProcessed
properties.moderation = ModerationData(
stanza_id=stanza_id,
by=by,
reason=retract.getTagData("reason"),
stamp=stamp,
is_tombstone=is_tombstone,
occupant_id=occupant_id,
)
def _process_moderation_0_tombstone_message(
self, _client: Client, stanza: Message, properties: MessageProperties
) -> None:
if not properties.is_mam_message:
return
moderated = stanza.getTag("moderated", namespace=Namespace.MESSAGE_MODERATE)
if moderated is None:
return
properties.moderation = self._parse_moderated_0(
moderated, properties, properties.mam.id
)
def _process_moderation_0_message(
self, _client: Client, stanza: Message, properties: MessageProperties
) -> None:
if not properties.jid.is_bare:
return
apply_to = stanza.getTag("apply-to", namespace=Namespace.FASTEN)
if apply_to is None:
return
moderated = apply_to.getTag("moderated", namespace=Namespace.MESSAGE_MODERATE)
if moderated is None:
return
stanza_id = apply_to.getAttr("id")
if stanza_id is None:
self._log.warning("apply-to element without stanza-id")
self._log.warning(stanza)
raise NodeProcessed
properties.moderation = self._parse_moderated_0(
moderated, properties, stanza_id
)
def _parse_moderated_0(
self, moderated: Node, properties: MessageProperties, stanza_id: str
) -> ModerationData | None:
retract, is_tombstone = _get_retract_element(moderated, properties)
if retract is None:
self._log.warning("Failed to find <retract/ed> element")
return None
try:
by = _parse_by_attr(moderated)
except ValueError as error:
self._log.warning(error)
by = None
stamp = _parse_moderation_timestamp(retract, is_tombstone, properties)
occupant_id = moderated.getTagAttr(
"occupant-id", "id", namespace=Namespace.OCCUPANT_ID
)
return ModerationData(
stanza_id=stanza_id,
by=by,
occupant_id=occupant_id,
reason=moderated.getTagData("reason"),
stamp=stamp,
is_tombstone=is_tombstone,
)
def _get_retract_element(
element: Node, properties: MessageProperties
) -> tuple[Node | None, bool]:
"""
returns a tuple
Node and a boolean value which signals if it is a tombstone
"""
retract = element.getTag("retract", namespace=Namespace.MESSAGE_RETRACT)
if retract is not None:
return retract, False
retract = element.getTag("retract", namespace=Namespace.MESSAGE_RETRACT_1)
if retract is not None:
return retract, False
if not properties.is_mam_message:
return None, False
retracted = element.getTag("retracted", namespace=Namespace.MESSAGE_RETRACT)
if retracted is not None:
return retracted, True
retracted = element.getTag("retracted", namespace=Namespace.MESSAGE_RETRACT_1)
if retracted is not None:
return retracted, True
return None, False
def _parse_by_attr(moderated: Node) -> JID | None:
by_attr = moderated.getAttr("by")
if by_attr is None:
return None
try:
return JID.from_string(by_attr)
except Exception as error:
raise ValueError("Invalid JID: %s, %s" % (by_attr, error))
def _parse_moderation_timestamp(
retract: Node, is_tombstone: bool, properties: MessageProperties
) -> dt.datetime:
if is_tombstone:
stamp_attr = retract.getAttr("stamp")
stamp = parse_datetime(stamp_attr, check_utc=True, convert="utc")
if stamp is not None:
assert isinstance(stamp, dt.datetime)
return stamp
if properties.is_mam_message:
stamp = properties.mam.timestamp
else:
stamp = properties.timestamp
return dt.datetime.fromtimestamp(stamp, dt.timezone.utc)
def _make_moderation_request_0(muc_jid: JID, stanza_id: str, reason: str | None) -> Iq:
iq = Iq("set", Namespace.FASTEN, to=muc_jid)
query = iq.setQuery(name="apply-to")
query.setAttr("id", stanza_id)
moderate = query.addChild(name="moderate", namespace=Namespace.MESSAGE_MODERATE)
moderate.addChild(name="retract", namespace=Namespace.MESSAGE_RETRACT)
if reason is not None:
moderate.addChild(name="reason", payload=[reason])
return iq
def _make_moderation_request_1(muc_jid: JID, stanza_id: str, reason: str | None) -> Iq:
iq = Iq("set", Namespace.MESSAGE_MODERATE_1, to=muc_jid)
query = iq.setQuery(name="moderate")
query.setAttr("id", stanza_id)
query.addChild(name="retract", namespace=Namespace.MESSAGE_RETRACT_1)
if reason is not None:
query.addChild(name="reason", payload=[reason])
return iq
|
