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
|
# 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 TYPE_CHECKING
import datetime as dt
from nbxmpp.errors import MalformedStanzaError
from nbxmpp.errors import StanzaError
from nbxmpp.modules.base import BaseModule
from nbxmpp.modules.dataforms import create_field
from nbxmpp.modules.dataforms import SimpleDataForm
from nbxmpp.modules.rsm import parse_rsm
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 Node
from nbxmpp.structs import MAMPreferencesData
from nbxmpp.structs import MAMQueryData
from nbxmpp.task import iq_request_task
if TYPE_CHECKING:
from nbxmpp.client import Client
class MAM(BaseModule):
def __init__(self, client: Client) -> None:
BaseModule.__init__(self, client)
self._client = client
self.handlers = []
@iq_request_task
def make_query(
self,
jid: JID,
queryid: str | None = None,
start: dt.datetime | None = None,
end: dt.datetime | None = None,
with_: str | None = None,
after: str | None = None,
max_: int = 70,
):
_task = yield
response = yield _make_request(jid, queryid, start, end, with_, after, max_)
if response.isError():
raise StanzaError(response)
jid = response.getFrom()
fin = response.getTag("fin", namespace=Namespace.MAM_2)
if fin is None:
raise MalformedStanzaError("fin node missing", response)
rsm = parse_rsm(fin)
if rsm is None:
raise MalformedStanzaError("rsm set missing", response)
complete = fin.getAttr("complete") == "true"
if max_ != 0 and not complete:
# max_ == 0 is a request for count of the items in a result set
# in this case first and last will be absent
# See: https://xmpp.org/extensions/xep-0059.html#count
if rsm.first is None or rsm.last is None:
raise MalformedStanzaError("first or last element missing", response)
yield MAMQueryData(jid=jid, complete=complete, rsm=rsm)
@iq_request_task
def request_preferences(self):
_task = yield
response = yield _make_pref_request()
if response.isError():
raise StanzaError(response)
prefs = response.getTag("prefs", namespace=Namespace.MAM_2)
if prefs is None:
raise MalformedStanzaError("prefs node missing", response)
default = prefs.getAttr("default")
if default is None:
raise MalformedStanzaError("default attr missing", response)
always_node = prefs.getTag("always")
if always_node is None:
raise MalformedStanzaError("always node missing", response)
always = _get_preference_jids(always_node)
never_node = prefs.getTag("never")
if never_node is None:
raise MalformedStanzaError("never node missing", response)
never = _get_preference_jids(never_node)
yield MAMPreferencesData(default=default, always=always, never=never)
@iq_request_task
def set_preferences(self, default: str | None, always: list[str], never: list[str]):
_task = yield
if default not in ("always", "never", "roster"):
raise ValueError("Wrong default preferences type")
response = yield _make_set_pref_request(default, always, never)
yield process_response(response)
def _make_query_form(
start: dt.datetime | None, end: dt.datetime | None, with_: str | None
) -> SimpleDataForm:
fields = [create_field(typ="hidden", var="FORM_TYPE", value=Namespace.MAM_2)]
if start:
fields.append(
create_field(
typ="text-single",
var="start",
value=start.strftime("%Y-%m-%dT%H:%M:%SZ"),
)
)
if end:
fields.append(
create_field(
typ="text-single", var="end", value=end.strftime("%Y-%m-%dT%H:%M:%SZ")
)
)
if with_:
fields.append(create_field(typ="jid-single", var="with", value=with_))
return SimpleDataForm(type_="submit", fields=fields)
def _make_rsm_query(max_: int | None, after: str | None) -> Node:
rsm_set = Node("set", attrs={"xmlns": Namespace.RSM})
if max_ is not None:
rsm_set.setTagData("max", max_)
if after is not None:
rsm_set.setTagData("after", after)
return rsm_set
def _make_request(
jid: JID,
queryid: str | None,
start: dt.datetime | None,
end: dt.datetime | None,
with_: str | None,
after: str | None,
max_: int | None,
) -> Iq:
iq = Iq(typ="set", to=jid, queryNS=Namespace.MAM_2)
if queryid is not None:
iq.getQuery().setAttr("queryid", queryid)
payload = [_make_query_form(start, end, with_), _make_rsm_query(max_, after)]
iq.setQueryPayload(payload)
return iq
def _make_pref_request() -> Iq:
iq = Iq("get", queryNS=Namespace.MAM_2)
iq.setQuery("prefs")
return iq
def _get_preference_jids(node: Iq) -> list[JID]:
jids: list[JID] = []
for item in node.getTags("jid"):
jid = item.getData()
if not jid:
continue
try:
jid = JID.from_string(jid)
except Exception:
continue
jids.append(jid)
return jids
def _make_set_pref_request(default: str, always: list[str], never: list[str]) -> Iq:
iq = Iq(typ="set")
prefs = iq.addChild(
name="prefs", namespace=Namespace.MAM_2, attrs={"default": default}
)
always_node = prefs.addChild(name="always")
never_node = prefs.addChild(name="never")
for jid in always:
always_node.addChild(name="jid").setData(jid)
for jid in never:
never_node.addChild(name="jid").setData(jid)
return iq
|
