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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
|
import unittest.mock
import pytest
from conftest import AvatarFixtureMixin
from test_shakespeare import Base as BaseNoMUC
from slidge import LegacyMUC, MucType
from slidge.util.types import Avatar
@pytest.mark.usefixtures("avatar")
class TestContactAvatar(BaseNoMUC, AvatarFixtureMixin):
def setUp(self):
super().setUp()
self.juliet.is_friend = True
self.juliet.added_to_roster = True
def __assert_not_found(self):
juliet = self.juliet
self.recv( # language=XML
f"""
<iq type='get'
from='{juliet.user_jid}/client'
to='{juliet.jid.bare}'
id='retrieve1'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<items node='urn:xmpp:avatar:data'>
<item id='{self.avatar_sha1}' />
</items>
</pubsub>
</iq>
"""
)
self.send( # language=XML
f"""
<iq xmlns="jabber:component:accept"
type="error"
from="juliet@aim.shakespeare.lit"
to="{juliet.user_jid}/client"
id="retrieve1">
<error type="cancel">
<item-not-found xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
</error>
</iq>
"""
)
def __assert_publish(self, rewritten=False):
h = self.avatar_sha1 if rewritten else self.avatar_original_sha1
length = (
len(self.avatar_bytes) if rewritten else len(self.avatar_path.read_bytes())
)
self.send( # language=XML
f"""
<message type="headline"
from="juliet@aim.shakespeare.lit"
to="romeo@montague.lit">
<event xmlns="http://jabber.org/protocol/pubsub#event">
<items node="urn:xmpp:avatar:metadata">
<item id="{h}">
<metadata xmlns="urn:xmpp:avatar:metadata">
<info id="{h}"
type="image/png"
bytes="{length}"
height="5"
width="5" />
</metadata>
</item>
</items>
</event>
</message>
"""
)
assert self.next_sent() is None
def __assert_publish_empty(self):
self.send( # language=XML
f"""
<message type="headline"
from="juliet@aim.shakespeare.lit"
to="romeo@montague.lit">
<event xmlns="http://jabber.org/protocol/pubsub#event">
<items node="urn:xmpp:avatar:metadata">
<item>
<metadata xmlns="urn:xmpp:avatar:metadata" />
</item>
</items>
</event>
</message>
""",
use_values=False,
)
assert self.next_sent() is None
def test_avatar_path_no_id(self):
juliet = self.juliet
assert juliet.avatar is None
juliet.avatar = None
self.run_coro(juliet._set_avatar_task)
assert self.next_sent() is None
self.__assert_not_found()
juliet.avatar = Avatar(path=self.avatar_path)
self.run_coro(juliet._set_avatar_task)
self.__assert_publish()
juliet.avatar = Avatar(path=self.avatar_path)
self.run_coro(juliet._set_avatar_task)
assert self.next_sent() is None
self.run_coro(juliet.set_avatar(Avatar(path=self.avatar_path)))
assert self.next_sent() is None
self.run_coro(juliet.set_avatar(Avatar(path=self.avatar_path)))
assert self.next_sent() is None
juliet.avatar = Avatar(path=self.avatar_path)
self.run_coro(juliet._set_avatar_task)
assert self.next_sent() is None
juliet.avatar = None
self.run_coro(juliet._set_avatar_task)
self.__assert_publish_empty()
self.run_coro(juliet.set_avatar(None))
assert self.next_sent() is None
self.run_coro(juliet.set_avatar(Avatar(path=self.avatar_path)))
self.__assert_publish()
juliet.avatar = None
self.run_coro(juliet._set_avatar_task)
self.__assert_publish_empty()
def test_avatar_path_with_id(self):
juliet = self.juliet
assert juliet.avatar is None
self.xmpp.AVATAR_ID_TYPE = int
self.run_coro(juliet.set_avatar(Avatar(path=self.avatar_path, unique_id=123)))
self.__assert_publish(rewritten=False)
assert juliet.avatar.unique_id == 123
self.run_coro(juliet.set_avatar(Avatar(path=self.avatar_path, unique_id=123)))
assert self.next_sent() is None
assert juliet.avatar.unique_id == 123
self.xmpp.AVATAR_ID_TYPE = str
self.run_coro(juliet.set_avatar(Avatar(path=self.avatar_path, unique_id="123")))
assert self.next_sent() is None
assert juliet.avatar.unique_id == "123"
self.run_coro(juliet.set_avatar(None))
self.__assert_publish_empty()
assert juliet.avatar is None
def test_same_avatar_with_different_legacy_ids(self):
self.run_coro(self.juliet.set_avatar(Avatar(path=self.avatar_path, unique_id="123")))
self.__assert_publish(rewritten=False)
assert self.juliet.avatar.unique_id == "123"
assert self.juliet.get_avatar().id == self.avatar_original_sha1
self.run_coro(self.juliet.set_avatar(Avatar(path=self.avatar_path, unique_id="456")))
self.__assert_publish(
rewritten=False
) # FIXME: ideally, we should not publish here…
assert self.juliet.avatar.unique_id == "456"
assert self.juliet.get_avatar().id == self.avatar_original_sha1
def test_avatar_with_url(self):
juliet = self.juliet
assert juliet.avatar is None
juliet.avatar = Avatar(url=self.avatar_url)
self.run_coro(juliet._set_avatar_task)
self.__assert_publish(rewritten=True)
juliet.avatar = Avatar(url=self.avatar_url)
self.run_coro(juliet._set_avatar_task)
assert self.next_sent() is None
def test_avatar_with_url_and_unique_id(self):
juliet = self.juliet
assert juliet.avatar is None
self.run_coro(juliet.set_avatar(Avatar(url=self.avatar_url, unique_id="someid")))
self.__assert_publish(rewritten=True)
self.run_coro(juliet.set_avatar(Avatar(url=self.avatar_url, unique_id="someid")))
assert self.next_sent() is None
class MUC(LegacyMUC):
type = MucType.GROUP
user_nick = "romeo"
async def update_info(self):
return
class BaseMUC(BaseNoMUC):
plugin = BaseNoMUC.plugin | {"MUC": MUC}
def setUp(self):
self.patch = unittest.mock.patch(
"uuid.uuid4", return_value="uuid4"
)
self.patch.start()
super().setUp()
def tearDown(self):
super().tearDown()
self.patch.stop()
def _assert_send_room_avatar(self, empty=False, url=False):
if empty:
photo = "<photo />"
else:
photo = f"<photo>{self.avatar_sha1 if url else self.avatar_original_sha1}</photo>"
self.send( # language=XML
f"""
<presence to="romeo@montague.lit/gajim"
from="room@aim.shakespeare.lit">
<x xmlns="vcard-temp:x:update">{photo}</x>
</presence>
""",
use_values=not empty,
)
def romeo_joins(self, muc: MUC):
session = self.get_romeo_session()
self.recv( # language=XML
f"""
<presence from="{session.user_jid}/gajim"
to="room@{session.xmpp.boundjid.bare}/romeo">
<x xmlns='http://jabber.org/protocol/muc' />
</presence>
"""
)
self.send( # language=XML
"""
<presence from="room@aim.shakespeare.lit/romeo"
to="romeo@montague.lit/gajim">
<x xmlns="http://jabber.org/protocol/muc#user">
<item affiliation="member"
role="participant"
jid="romeo@montague.lit/gajim" />
<status code="100" />
<status code="110" />
</x>
<occupant-id xmlns="urn:xmpp:occupant-id:0"
id="slidge-user" />
</presence>
"""
)
subject_msg = self.next_sent()
assert subject_msg.xml.find(f"{{{subject_msg.namespace}}}subject") is not None
# assert self.next_sent()["from"] == "room@aim.shakespeare.lit"
def get_muc(self, joined=True) -> MUC:
session = self.get_romeo_session()
muc = self.run_coro(session.bookmarks.by_legacy_id("room"))
if joined:
self.romeo_joins(muc)
return self.run_coro(session.bookmarks.by_legacy_id("room"))
@pytest.mark.usefixtures("avatar")
class TestParticipantAvatar(BaseMUC, AvatarFixtureMixin):
def romeo_joins(self, muc: MUC):
super().romeo_joins(muc)
self._assert_send_room_avatar(empty=True)
def _assert_juliet_presence_no_avatar(self):
self.send( # language=XML
"""
<presence from="room@aim.shakespeare.lit/juliet"
to="romeo@montague.lit/gajim">
<x xmlns="http://jabber.org/protocol/muc#user">
<item affiliation="member"
role="participant"
jid="juliet@aim.shakespeare.lit/slidge" />
</x>
<occupant-id xmlns="urn:xmpp:occupant-id:0"
id="juliet@aim.shakespeare.lit/slidge" />
</presence>
"""
)
def _assert_juliet_presence_avatar(self, sha=None, url=False):
self.send( # language=XML
f"""
<presence from="room@aim.shakespeare.lit/juliet"
to="romeo@montague.lit/gajim">
<x xmlns="http://jabber.org/protocol/muc#user">
<item affiliation="member"
role="participant"
jid="juliet@aim.shakespeare.lit/slidge" />
</x>
<x xmlns="vcard-temp:x:update">
<photo>{self.avatar_sha1 if url else self.avatar_original_sha1}</photo>
</x>
<occupant-id xmlns="urn:xmpp:occupant-id:0"
id="juliet@aim.shakespeare.lit/slidge" />
</presence>
"""
)
def test_romeo_join_empty_room_then_juliet_joins_then_set_avatar(self):
self.get_muc(joined=True)
session = self.get_romeo_session()
session.contacts.ready.set_result(True)
muc = self.get_muc(joined=False)
self.run_coro(muc.get_participant_by_contact(self.juliet))
self._assert_juliet_presence_no_avatar()
assert self.next_sent() is None
juliet = self.juliet
juliet.avatar = Avatar(path=self.avatar_path)
# no broadcast of the contact avatar because not added to roster,
# only the participant
self.run_coro(juliet._set_avatar_task)
self._assert_juliet_presence_avatar()
assert self.next_sent() is None
self.juliet.avatar = Avatar(path=self.avatar_path)
assert self.next_sent() is None
juliet = self.juliet
juliet.avatar = None
self.run_coro(juliet._set_avatar_task)
self._assert_juliet_presence_no_avatar()
assert self.next_sent() is None
def test_romeo_join_empty_room_then_juliet_joins_then_set_avatar_with_url(self):
self.get_muc(joined=True)
session = self.get_romeo_session()
session.contacts.ready.set_result(True)
juliet = self.juliet
self.run_coro(self.get_muc(joined=False).get_participant_by_contact(juliet))
self._assert_juliet_presence_no_avatar()
assert self.next_sent() is None
juliet = self.juliet
juliet.avatar = Avatar(url=self.avatar_url)
# no broadcast of the contact avatar because not added to roster,
# only the participant
self.run_coro(juliet._set_avatar_task)
self._assert_juliet_presence_avatar(url=True)
assert self.next_sent() is None
juliet.avatar = Avatar(url=self.avatar_url)
self.run_coro(juliet._set_avatar_task)
assert self.next_sent() is None
juliet.avatar = None
self.run_coro(juliet._set_avatar_task)
self._assert_juliet_presence_no_avatar()
assert self.next_sent() is None
def test_avatar_forbidden_emoji_in_participant_nickname(self):
self.get_muc(joined=True)
session = self.get_romeo_session()
juliet = self.juliet
juliet.name = "juliet🎉"
juliet.avatar = Avatar(url=self.avatar_url)
session.contacts.ready.set_result(True)
self.run_coro(self.get_muc(False).get_participant_by_contact(juliet))
self.send( # language=XML
f"""
<presence from="room@aim.shakespeare.lit/juliet-1934e"
to="romeo@montague.lit/gajim">
<x xmlns="http://jabber.org/protocol/muc#user">
<item affiliation="member"
role="participant"
jid="juliet@aim.shakespeare.lit/slidge" />
</x>
<x xmlns="vcard-temp:x:update">
<photo>{self.avatar_sha1}</photo>
</x>
<occupant-id xmlns="urn:xmpp:occupant-id:0"
id="juliet@aim.shakespeare.lit/slidge" />
<nick xmlns="http://jabber.org/protocol/nick">juliet🎉</nick>
</presence>
"""
)
self.recv( # language=XML
"""
<iq from="romeo@montague.lit/gajim"
to="room@aim.shakespeare.lit/juliet-1934e"
type="get">
<vCard xmlns="vcard-temp" />
</iq>
"""
)
self.send( # language=XML
f"""
<iq from="room@aim.shakespeare.lit/juliet-1934e"
to="romeo@montague.lit/gajim"
type="result"
id="1">
<vCard xmlns="vcard-temp">
<PHOTO>
<BINVAL>{self.avatar_base64}</BINVAL>
<TYPE>image/png</TYPE>
</PHOTO>
</vCard>
</iq>
"""
)
assert self.next_sent() is None
juliet = self.run_coro(self.get_muc(False).get_participant_by_contact(juliet))
juliet.send_text("prout")
self.send( # language=XML
f"""
<message xmlns="jabber:component:accept"
type="groupchat"
from="room@aim.shakespeare.lit/juliet-1934e"
to="romeo@montague.lit/gajim">
<body>prout</body>
<active xmlns="http://jabber.org/protocol/chatstates" />
<markable xmlns="urn:xmpp:chat-markers:0" />
<stanza-id xmlns="urn:xmpp:sid:0"
id="uuid4"
by="room@aim.shakespeare.lit" />
<occupant-id xmlns="urn:xmpp:occupant-id:0"
id="juliet@aim.shakespeare.lit/slidge" />
<nick xmlns="http://jabber.org/protocol/nick">juliet🎉</nick>
</message>
"""
)
@pytest.mark.usefixtures("avatar")
class TestRoomAvatar(BaseMUC, AvatarFixtureMixin):
def test_room_avatar_change_after_join(self):
self.get_muc(joined=True)
self._assert_send_room_avatar(empty=True)
muc = self.get_muc(joined=False)
muc.avatar = self.avatar_path
self.run_coro(muc._set_avatar_task)
self.send( # language=XML
"""
<message type="groupchat"
from="room@aim.shakespeare.lit"
to="romeo@montague.lit/gajim">
<stanza-id xmlns="urn:xmpp:sid:0"
id="uuid4"
by="room@aim.shakespeare.lit" />
<x xmlns="http://jabber.org/protocol/muc#user">
<status code="104" />
</x>
<occupant-id xmlns="urn:xmpp:occupant-id:0"
id="room" />
</message>
""",
use_values=False,
)
self._assert_send_room_avatar()
def test_room_avatar_on_join(self):
muc = self.get_muc(joined=False)
muc.avatar = self.avatar_path
self.run_coro(muc._set_avatar_task)
self.romeo_joins(muc)
self._assert_send_room_avatar()
def test_room_avatar_with_url(self):
muc = self.get_muc(joined=False)
muc.avatar = self.avatar_url
self.run_coro(muc._set_avatar_task)
self.romeo_joins(muc)
self._assert_send_room_avatar(url=True)
def test_room_avatar_with_url_and_unique_id(self):
muc = self.get_muc(joined=False)
self.run_coro(muc.set_avatar(Avatar(url=self.avatar_url,unique_id= "id")))
self.romeo_joins(muc)
self._assert_send_room_avatar(url=True)
self.run_coro(muc.set_avatar(Avatar(url=self.avatar_url,unique_id= "id")))
assert self.next_sent() is None
|
