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
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
|
# Copyright (C) 2018-2020 Philipp Hörist <philipp AT hoerist.com>
#
# This file is part of nbxmpp.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import typing
from typing import Any
from typing import Optional
from typing import Set
from typing import NamedTuple
from typing import Union
import time
import random
from dataclasses import dataclass
from dataclasses import field
from datetime import datetime
from gi.repository import Gio
from gi.repository import GLib
from nbxmpp.simplexml import Node
from nbxmpp.namespaces import Namespace
from nbxmpp.protocol import Protocol
from nbxmpp.protocol import JID
from nbxmpp.const import AdHocAction
from nbxmpp.const import IqType
from nbxmpp.const import AdHocNoteType
from nbxmpp.const import MessageType
from nbxmpp.const import AvatarState
from nbxmpp.const import StatusCode
from nbxmpp.const import PresenceType
from nbxmpp.const import AdHocStatus
from nbxmpp.const import InviteType
from nbxmpp.const import Role
from nbxmpp.const import Affiliation
from nbxmpp.const import AnonymityMode
from nbxmpp.const import PresenceShow
class StanzaHandler(NamedTuple):
name: str
callback: Any
typ: str = ''
ns: str = ''
xmlns: Optional[str] = None
priority: int = 50
class CommonResult(NamedTuple):
jid: Optional[JID] = None
class InviteData(NamedTuple):
muc: JID
from_: JID
reason: Optional[str]
password: Optional[str]
type: InviteType
continued: bool
thread: Optional[str]
class DeclineData(NamedTuple):
muc: JID
from_: JID
reason: Optional[str]
class CaptchaData(NamedTuple):
form: Any
bob_data: BobData
class BobData(NamedTuple):
algo: str
hash_: str
max_age: str
data: str
cid: str
type: str
class BookmarkData(NamedTuple):
jid: JID
name: Optional[str] = None
nick: Optional[str] = None
autojoin: bool = False
password: Optional[str] = None
extensions: Optional[Node] = None
class VoiceRequest(NamedTuple):
jid:JID
nick: str
form: Any
class MucUserData(NamedTuple):
jid: Optional[JID]
affiliation: Optional[Affiliation]
nick: Optional[str]
role: Optional[Role]
actor: Optional[str]
reason: Optional[str]
class MucDestroyed(NamedTuple):
alternate: Optional[JID]
reason: Optional[str]
password: Optional[str]
class MucConfigResult(NamedTuple):
jid: JID
form: Optional[Any] = None
class MucSubject(NamedTuple):
text: str
author: Optional[str]
timestamp: Optional[float]
class AffiliationResult(NamedTuple):
jid: JID
users: dict[JID, dict[str, str]]
class EntityCapsData(NamedTuple):
hash: str
node: str
ver: str
class HTTPAuthData(NamedTuple):
id: Optional[str]
method: Optional[str]
url: Optional[str]
body: Optional[str]
class StanzaIDData(NamedTuple):
id: str
by: str
class PubSubEventData(NamedTuple):
node: Node
id: Optional[str] = None
item: Optional[Node] = None
data: Optional[Any] = None
deleted: bool = False
retracted: bool = False
purged: bool = False
class MoodData(NamedTuple):
mood: str
test: str
class BlockingPush(NamedTuple):
block: Set[JID]
unblock: Set[JID]
unblock_all: bool
class ActivityData(NamedTuple):
activity: str
subactivity: str
text: str
class LocationData(NamedTuple):
accuracy: Optional[str] = None
alt: Optional[str] = None
altaccuracy: Optional[str] = None
area: Optional[str] = None
bearing: Optional[str] = None
building: Optional[str] = None
country: Optional[str] = None
countrycode: Optional[str] = None
datum: Optional[str] = None
description: Optional[str] = None
error: Optional[str] = None
floor: Optional[str] = None
lat: Optional[str] = None
locality: Optional[str] = None
lon: Optional[str] = None
postalcode: Optional[str] = None
region: Optional[str] = None
room: Optional[str] = None
speed: Optional[str] = None
street: Optional[str] = None
text: Optional[str] = None
timestamp: Optional[str] = None
tzo: Optional[str] = None
uri: Optional[str] = None
class PGPPublicKey(NamedTuple):
jid: JID
key: str
date: datetime
class PGPKeyMetadata(NamedTuple):
jid: JID
fingerprint: str
date: datetime
class OMEMOMessage(NamedTuple):
sid: int
iv: bytes
keys: dict[int, tuple[bytes, bool]]
payload: bytes
class AnnotationNote(NamedTuple):
jid: JID
data: str
cdate: Optional[datetime] = None
mdate: Optional[datetime] = None
class EMEData(NamedTuple):
name: str
namespace: str
class MuclumbusResult(NamedTuple):
first: Optional[str]
last: Optional[str]
max: Optional[int]
end: bool
items: list[MuclumbusItem]
class MuclumbusItem(NamedTuple):
jid: str
name: str
nusers: str
description: str
language: str
is_open: bool
anonymity_mode: AnonymityMode
class SoftwareVersionResult(NamedTuple):
name: str
version: str
os: Optional[str]
class AdHocCommandNote(NamedTuple):
text: str
type: AdHocNoteType
class IBBData(NamedTuple):
type: str
sid: str
block_size: Optional[int]
seq: Optional[int]
data: Optional[str]
class OOBData(NamedTuple):
url: str
desc: str
class CorrectionData(NamedTuple):
id: str
class ReplyData(NamedTuple):
to: str
id: str
fallback_start: Optional[int]
fallback_end: Optional[int]
class ModerationData(NamedTuple):
stanza_id: str
moderator_jid: Optional[str]
by: Optional[JID]
reason: Optional[str]
timestamp: Optional[str]
stamp: float
is_tombstone: bool
occupant_id: Optional[str]
class DiscoItems(NamedTuple):
jid: JID
node: str
items: list[DiscoItem]
class DiscoItem(NamedTuple):
jid: JID
name: Optional[str]
node: Optional[str]
class RegisterData(NamedTuple):
instructions: Optional[str]
form: Optional[Any]
fields_form: Optional[Any]
oob_url: Optional[str]
bob_data: Optional[BobData]
class HTTPUploadData(NamedTuple):
put_uri: str
get_uri: str
headers: dict[str, str]
class RSMData(NamedTuple):
after: Optional[str]
before: Optional[str]
last: Optional[str]
first: Optional[str]
first_index: Optional[int]
count: Optional[int]
max: Optional[int]
index: Optional[int]
class MAMQueryData(NamedTuple):
jid: JID
rsm: RSMData
complete: bool
class MAMPreferencesData(NamedTuple):
default: str
always: list[JID]
never: list[JID]
class LastActivityData(NamedTuple):
seconds: int
status: str
class RosterData(NamedTuple):
items: Optional[list[RosterItem]]
version: str
class RosterPush(NamedTuple):
item: RosterItem
version: str
@dataclass
class RosterItem:
jid: JID
name: Optional[str] = None
ask: Optional[str] = None
subscription: Optional[str] = None
approved: Optional[str] = None
groups: Set[str] = field(default_factory=set)
@classmethod
def from_node(cls, node: Node) -> RosterItem:
attrs = node.getAttrs(copy=True)
jid = attrs.get('jid')
if jid is None:
raise Exception('jid attribute missing')
jid = JID.from_string(jid)
if jid.is_full:
raise Exception('full jid in roster not allowed')
groups = {group.getData() for group in node.getTags('group')}
return cls(jid=jid,
name=attrs.get('name'),
ask=attrs.get('ask'),
subscription=attrs.get('subscription') or 'none',
approved=attrs.get('approved'),
groups=groups)
def asdict(self) -> dict[str, Any]:
return {'jid': self.jid,
'name': self.name,
'ask': self.ask,
'subscription': self.subscription,
'approved': self.approved,
'groups': self.groups}
class DiscoInfo(NamedTuple):
stanza: Optional[Node]
identities: list[DiscoIdentity]
features: list[str]
dataforms: list[Any]
timestamp: Optional[float] = None
def get_caps_hash(self) -> Optional[str]:
try:
return self.node.split('#')[1]
except Exception:
return None
def has_field(self, form_type: str, var: str) -> bool:
for dataform in self.dataforms:
try:
if dataform['FORM_TYPE'].value != form_type:
continue
if var in dataform.vars:
return True
except Exception:
continue
return False
def get_field_value(self, form_type: str, var: str) -> Optional[Any]:
for dataform in self.dataforms:
try:
if dataform['FORM_TYPE'].value != form_type:
continue
if dataform[var].type_ == 'jid-multi':
return dataform[var].values or None
return dataform[var].value or None
except Exception:
continue
return None
def supports(self, feature: str) -> bool:
return feature in self.features
def serialize(self) -> str:
if self.stanza is None:
raise ValueError('Unable to serialize DiscoInfo, no stanza found')
return str(self.stanza)
@property
def node(self) -> Optional[str]:
try:
query = self.stanza.getQuery()
except Exception:
return None
if query is not None:
return query.getAttr('node')
return None
@property
def jid(self) -> Optional[JID]:
try:
return self.stanza.getFrom()
except Exception:
return None
@property
def mam_namespace(self) -> Optional[str]:
if Namespace.MAM_2 in self.features:
return Namespace.MAM_2
if Namespace.MAM_1 in self.features:
return Namespace.MAM_1
return None
@property
def has_mam_2(self) -> bool:
return Namespace.MAM_2 in self.features
@property
def has_mam_1(self) -> bool:
return Namespace.MAM_1 in self.features
@property
def has_mam(self) -> bool:
return self.has_mam_1 or self.has_mam_2
@property
def has_httpupload(self) -> bool:
return Namespace.HTTPUPLOAD_0 in self.features
@property
def has_message_moderation(self) -> bool:
return Namespace.MESSAGE_MODERATE in self.features
@property
def is_muc(self) -> bool:
for identity in self.identities:
if identity.category == 'conference':
if Namespace.MUC in self.features:
return True
return False
@property
def is_irc(self) -> bool:
for identity in self.identities:
if identity.category == 'conference' and identity.type == 'irc':
return True
return False
@property
def muc_name(self) -> Optional[str]:
if self.muc_room_name:
return self.muc_room_name
if self.muc_identity_name:
return self.muc_identity_name
if self.jid is not None:
return self.jid.localpart
return None
@property
def muc_identity_name(self) -> Optional[str]:
for identity in self.identities:
if identity.category == 'conference':
return identity.name
return None
@property
def muc_room_name(self) -> Optional[Any]:
return self.get_field_value(Namespace.MUC_INFO, 'muc#roomconfig_roomname')
@property
def muc_description(self) -> Optional[Any]:
return self.get_field_value(Namespace.MUC_INFO, 'muc#roominfo_description')
@property
def muc_log_uri(self) -> Optional[Any]:
return self.get_field_value(Namespace.MUC_INFO, 'muc#roominfo_logs')
@property
def muc_users(self) -> Optional[Any]:
return self.get_field_value(Namespace.MUC_INFO, 'muc#roominfo_occupants')
@property
def muc_contacts(self) -> Optional[Any]:
return self.get_field_value(Namespace.MUC_INFO, 'muc#roominfo_contactjid')
@property
def muc_subject(self) -> Optional[Any]:
return self.get_field_value(Namespace.MUC_INFO, 'muc#roominfo_subject')
@property
def muc_subjectmod(self) -> Optional[Any]:
# muc#roominfo_changesubject stems from a wrong example in the MUC XEP
# Ejabberd and Prosody use this value
# muc#roomconfig_changesubject is also used by Prosody
return (self.get_field_value(Namespace.MUC_INFO, 'muc#roominfo_subjectmod') or
self.get_field_value(Namespace.MUC_INFO, 'muc#roomconfig_changesubject') or
self.get_field_value(Namespace.MUC_INFO, 'muc#roominfo_changesubject'))
@property
def muc_lang(self) -> Optional[Any]:
return self.get_field_value(Namespace.MUC_INFO, 'muc#roominfo_lang')
@property
def muc_is_persistent(self) -> bool:
return 'muc_persistent' in self.features
@property
def muc_is_moderated(self) -> bool:
return 'muc_moderated' in self.features
@property
def muc_is_open(self) -> bool:
return 'muc_open' in self.features
@property
def muc_is_members_only(self) -> bool:
return 'muc_membersonly' in self.features
@property
def muc_is_hidden(self) -> bool:
return 'muc_hidden' in self.features
@property
def muc_is_nonanonymous(self) -> bool:
return 'muc_nonanonymous' in self.features
@property
def muc_is_passwordprotected(self) -> bool:
return 'muc_passwordprotected' in self.features
@property
def muc_is_public(self) -> bool:
return 'muc_public' in self.features
@property
def muc_is_semianonymous(self) -> bool:
return 'muc_semianonymous' in self.features
@property
def muc_is_temporary(self) -> bool:
return 'muc_temporary' in self.features
@property
def muc_is_unmoderated(self) -> bool:
return 'muc_unmoderated' in self.features
@property
def muc_is_unsecured(self) -> bool:
return 'muc_unsecured' in self.features
@property
def is_gateway(self) -> bool:
for identity in self.identities:
if identity.category == 'gateway':
return True
return False
@property
def gateway_name(self) -> Optional[str]:
for identity in self.identities:
if identity.category == 'gateway':
return identity.name
return None
@property
def gateway_type(self) -> Optional[str]:
for identity in self.identities:
if identity.category == 'gateway':
return identity.type
return None
def has_category(self, category: str) -> bool:
for identity in self.identities:
if identity.category == category:
return True
return False
def has_identity(self, category: str, type_: str) -> bool:
for identity in self.identities:
if (identity.category == category and
identity.type == type_):
return True
return False
@property
def httpupload_max_file_size(self) -> Optional[float]:
size = self.get_field_value(Namespace.HTTPUPLOAD_0, 'max-file-size')
try:
return float(size)
except Exception:
return None
class DiscoIdentity(NamedTuple):
category: str
type: str
name: Optional[str] = None
lang: Optional[str] = None
def get_node(self) -> Node:
identity = Node('identity',
attrs={'category': self.category,
'type': self.type})
if self.name is not None:
identity.setAttr('name', self.name)
if self.lang is not None:
identity.setAttr('xml:lang', self.lang)
return identity
def __eq__(self, other: DiscoIdentity):
return str(self) == str(other)
def __ne__(self, other: DiscoIdentity):
return not self.__eq__(other)
def __str__(self) -> str:
return '%s/%s/%s/%s' % (self.category,
self.type,
self.lang or '',
self.name or '')
def __hash__(self) -> int:
return hash(str(self))
class AdHocCommand(NamedTuple):
jid: JID
node: Node
name: Optional[str]
sessionid: Optional[str] = None
status: Optional[AdHocStatus] = None
data: Optional[Node] = None
actions: Optional[Set[AdHocAction]] = None
default: Optional[AdHocAction] = None
notes: Optional[list[AdHocCommandNote]] = None
@property
def is_completed(self) -> bool:
return self.status == AdHocStatus.COMPLETED
@property
def is_canceled(self) -> bool:
return self.status == AdHocStatus.CANCELED
class ProxyData(NamedTuple):
type: str
host: str
username: Optional[str]
password: Optional[str]
def get_uri(self) -> str:
if self.username is not None:
username = GLib.uri_escape_string(self.username, None, False)
password = GLib.uri_escape_string(self.password, None, False)
user_pass = f'{username}:{password}'
return '%s://%s@%s' % (self.type,
user_pass,
self.host)
return '%s://%s' % (self.type, self.host)
def get_resolver(self) -> Gio.SimpleProxyResolver:
return Gio.SimpleProxyResolver.new(self.get_uri(), None)
class OMEMOBundle(NamedTuple):
spk: dict[str, Union[int, bytes]]
spk_signature: bytes
ik: bytes
otpks: list[dict[str, str]]
device_id: int = -1
namespace: str = Namespace.OMEMO_TEMP
def pick_prekey(self) -> dict[str, str]:
return random.SystemRandom().choice(self.otpks)
class ChatMarker(NamedTuple):
type: str
id: str
@property
def is_received(self) -> bool:
return self.type == 'received'
@property
def is_displayed(self) -> bool:
return self.type == 'displayed'
@property
def is_acknowledged(self) -> bool:
return self.type == 'acknowledged'
class Reactions(NamedTuple):
id: str
emojis: set[str]
class CommonError:
def __init__(self, stanza):
self._stanza_name = stanza.getName()
self._error_node = stanza.getTag('error')
self.condition = stanza.getError()
self.condition_data = self._error_node.getTagData(self.condition)
self.app_condition = stanza.getAppError()
self.type = stanza.getErrorType()
self.by = None
self.jid = stanza.getFrom()
self.id = stanza.getID()
self._text = {}
by = self._error_node.getAttr('by')
if by is not None:
try:
self.by = JID.from_string(by)
except Exception:
pass
text_elements = self._error_node.getTags('text', namespace=Namespace.STANZAS)
for element in text_elements:
lang = element.getXmlLang()
text = element.getData()
self._text[lang] = text
@classmethod
def from_string(cls, node_string: Union[bytes, str]) -> CommonError:
return cls(Protocol(node=node_string))
def get_text(self, pref_lang=None):
if pref_lang is not None:
text = self._text.get(pref_lang)
if text is not None:
return text
if self._text:
text = self._text.get('en')
if text is not None:
return text
text = self._text.get(None)
if text is not None:
return text
return self._text.popitem()[1]
return ''
def set_text(self, lang, text):
self._text[lang] = text
def __str__(self):
condition = self.condition
if self.app_condition is not None:
condition = '%s (%s)' % (self.condition, self.app_condition)
text = self.get_text('en') or ''
if text:
text = ' - %s' % text
return 'Error from %s: %s%s' % (self.jid, condition, text)
def serialize(self) -> str:
return str(Protocol(name=self._stanza_name,
frm=self.jid,
xmlns=Namespace.CLIENT,
attrs={'id': self.id},
payload=self._error_node))
class HTTPUploadError(CommonError):
def __init__(self, stanza):
CommonError.__init__(self, stanza)
def get_max_file_size(self):
if not self.app_condition == 'file-too-large':
return None
node = self._error_node.getTag(self.app_condition)
try:
return float(node.getTagData('max-file-size'))
except Exception:
return None
def get_retry_date(self):
if not self.app_condition == 'retry':
return None
return self._error_node.getTagAttr('stamp')
class StanzaMalformedError(CommonError):
def __init__(self, stanza, text):
self._error_node = None
self.condition = 'stanza-malformed'
self.condition_data = None
self.app_condition = None
self.type = None
self.jid = stanza.getFrom()
self.id = stanza.getID()
self._text = {}
if text:
self._text['en'] = text
@classmethod
def from_string(cls, node_string):
raise NotImplementedError
def __str__(self):
text = self.get_text('en')
if text:
text = ': %s' % text
return 'Received malformed stanza from %s%s' % (self.jid, text)
def serialize(self):
raise NotImplementedError
class StreamError(CommonError):
def __init__(self, stanza):
self.condition = stanza.getError()
self.condition_data = self._error_node.getTagData(self.condition)
self.app_condition = stanza.getAppError()
self.type = stanza.getErrorType()
self.jid = stanza.getFrom()
self.id = stanza.getID()
self._text = {}
text_elements = self._error_node.getTags('text', namespace=Namespace.STREAMS)
for element in text_elements:
lang = element.getXmlLang()
text = element.getData()
self._text[lang] = text
@classmethod
def from_string(cls, node_string):
raise NotImplementedError
def __str__(self):
text = self.get_text('en') or ''
if text:
text = ' - %s' % text
return 'Error from %s: %s%s' % (self.jid, self.condition, text)
def serialize(self):
raise NotImplementedError
class TuneData(NamedTuple):
artist: Optional[str] = None
length: Optional[str] = None
rating: Optional[str] = None
source: Optional[str] = None
title: Optional[str] = None
track: Optional[str] = None
uri: Optional[str] = None
@property
def was_removed(self) -> bool:
return (self.artist is None and
self.title is None and
self.track is None)
class MAMData(NamedTuple):
id: str
query_id: str
archive: JID
namespace: str
timestamp: float
@property
def is_ver_1(self) -> bool:
return self.namespace == Namespace.MAM_1
@property
def is_ver_2(self) -> bool:
return self.namespace == Namespace.MAM_2
class CarbonData(NamedTuple):
type: str
@property
def is_sent(self) -> bool:
return self.type == 'sent'
@property
def is_received(self) -> bool:
return self.type == 'received'
class ReceiptData(NamedTuple):
type: str
id: Optional[str] = None
@property
def is_request(self) -> bool:
return self.type == 'request'
@property
def is_received(self) -> bool:
return self.type == 'received'
class Properties:
pass
@dataclass
class MessageProperties:
own_jid: JID
carbon: Optional[CarbonData] = None
type: MessageType = MessageType.NORMAL
id: Optional[str] = None
stanza_ids: list[StanzaIDData] = field(default_factory=list)
origin_id: Optional[str] = None
from_: Optional[JID] = None
to: Optional[JID] = None
jid: Optional[JID] = None
remote_jid: Optional[JID] = None
subject = None
body: Optional[str] = None
thread: Optional[str] = None
user_timestamp = None
timestamp: float = field(default_factory=time.time)
has_server_delay: bool = False
error = None
eme: Optional[EMEData] = None
http_auth: Optional[HTTPAuthData] = None
nickname: Optional[str] = None
from_muc: bool = False
occupant_id: Optional[str] = None
muc_jid: Optional[JID] = None
muc_nickname: Optional[str] = None
muc_status_codes: Optional[Set[StatusCode]] = None
muc_private_message: bool = False
muc_invite = None
muc_decline = None
muc_user = None
muc_ofrom = None
muc_subject: Optional[MucSubject] = None
captcha: Optional[CaptchaData] = None
voice_request: Optional[VoiceRequest] = None
self_message: bool = False
mam: Optional[MAMData] = None
pubsub: bool = False
pubsub_event: Optional[PubSubEventData] = None
openpgp = None
omemo = None
encrypted = None
pgp_legacy = None
marker: Optional[ChatMarker] = None
receipt: Optional[ReceiptData] = None
oob: Optional[OOBData] = None
correction: Optional[CorrectionData] = None
reply_data: Optional[ReplyData] = None
moderation: Optional[ModerationData] = None
attention: bool = False
forms = None
xhtml: Optional[str] = None
security_label = None
chatstate = None
reactions: Optional[Reactions] = None
def is_from_us(self, bare_match: bool = True):
if self.from_ is None:
raise ValueError('from attribute missing')
if bare_match:
return self.own_jid.bare_match(self.from_)
return self.own_jid == self.from_
@property
def has_user_delay(self) -> bool:
return self.user_timestamp is not None
@property
def is_encrypted(self) -> bool:
return self.encrypted is not None
@property
def is_omemo(self) -> bool:
return self.omemo is not None
@property
def is_openpgp(self) -> bool:
return self.openpgp is not None
@property
def is_pgp_legacy(self) -> bool:
return self.pgp_legacy is not None
@property
def is_pubsub(self) -> bool:
return self.pubsub
@property
def is_pubsub_event(self) -> bool:
return self.pubsub_event is not None
@property
def is_carbon_message(self) -> bool:
return self.carbon is not None
@property
def is_sent_carbon(self) -> bool:
return self.carbon is not None and self.carbon.is_sent
@property
def is_received_carbon(self) -> bool:
return self.carbon is not None and self.carbon.is_received
@property
def is_mam_message(self) -> bool:
return self.mam is not None
@property
def is_http_auth(self) -> bool:
return self.http_auth is not None
@property
def is_muc_subject(self) -> bool:
return (self.type == MessageType.GROUPCHAT and
self.body is None and
self.subject is not None)
@property
def is_muc_config_change(self) -> bool:
return bool(self.muc_status_codes)
@property
def is_muc_pm(self) -> bool:
return self.muc_private_message
@property
def is_muc_invite_or_decline(self) -> bool:
return (self.muc_invite is not None or
self.muc_decline is not None)
@property
def is_captcha_challenge(self) -> bool:
return self.captcha is not None
@property
def is_voice_request(self) -> bool:
return self.voice_request is not None
@property
def is_self_message(self) -> bool:
return self.self_message
@property
def is_marker(self) -> bool:
return self.marker is not None
@property
def is_receipt(self) -> bool:
return self.receipt is not None
@property
def is_oob(self) -> bool:
return self.oob is not None
@property
def is_correction(self) -> bool:
return self.correction is not None
@property
def is_moderation(self) -> bool:
return self.moderation is not None
@property
def has_attention(self) -> bool:
return self.attention
@property
def has_forms(self) -> bool:
return self.forms is not None
@property
def has_xhtml(self) -> bool:
return self.xhtml is not None
@property
def has_security_label(self) -> bool:
return self.security_label is not None
@property
def has_chatstate(self) -> bool:
return self.chatstate is not None
@dataclass
class IqProperties:
own_jid: JID
type: Optional[IqType] = None
jid: Optional[JID] = None
id: Optional[str] = None
error: Optional[Any] = None
query: Optional[Node] = None
payload: Optional[Node] = None
http_auth: Optional[HTTPAuthData] = None
ibb: Optional[IBBData] = None
blocking: Optional[BlockingPush] = None
roster: Optional[RosterPush] = None
@property
def is_http_auth(self) -> bool:
return self.http_auth is not None
@property
def is_ibb(self) -> bool:
return self.ibb is not None
@property
def is_blocking(self) -> bool:
return self.blocking is not None
@property
def is_roster(self) -> bool:
return self.roster is not None
class IqPropertiesBase(typing.Protocol):
own_jid: JID
type: IqType
jid: JID
id: str
error: Optional[Any]
query: Optional[Node]
payload: Optional[Node]
class BlockingProperties(IqPropertiesBase):
blocking: BlockingPush
@property
def is_blocking(self) -> bool: ...
@dataclass
class PresenceProperties:
own_jid: JID
type: Optional[PresenceType] = None
priority: Optional[int] = None
show: Optional[PresenceShow] = None
jid: Optional[JID] = None
resource: Optional[str] = None
id: Optional[str] = None
nickname: Optional[str] = None
self_presence: bool = False
self_bare: bool = False
from_muc: bool = False
occupant_id: Optional[str] = None
status: str = ''
timestamp: float = field(default_factory=time.time)
user_timestamp: Optional[float] = None
idle_timestamp: Optional[float] = None
signed: Optional[Any] = None
error: Optional[Any] = None
avatar_sha: Optional[str] = None
avatar_state: AvatarState = AvatarState.IGNORE
muc_jid: Optional[JID] = None
muc_status_codes: Optional[Set[StatusCode]] = None
muc_user: Optional[MucUserData] = None
muc_nickname: Optional[str] = None
muc_destroyed: Optional[MucDestroyed] = None
entity_caps: Optional[EntityCapsData] = None
@property
def is_self_presence(self) -> bool:
return self.self_presence
@property
def is_self_bare(self) -> bool:
return self.self_bare
@property
def is_muc_destroyed(self) -> bool:
return self.muc_destroyed is not None
@property
def is_muc_self_presence(self) -> bool:
return (self.from_muc and
self.muc_status_codes is not None and
StatusCode.SELF in self.muc_status_codes)
@property
def is_nickname_modified(self) -> bool:
return (self.from_muc and
self.muc_status_codes is not None and
StatusCode.NICKNAME_MODIFIED in self.muc_status_codes and
self.type == PresenceType.AVAILABLE)
@property
def is_nickname_changed(self) -> bool:
return (self.from_muc and
self.muc_status_codes is not None and
StatusCode.NICKNAME_CHANGE in self.muc_status_codes and
self.muc_user.nick is not None and
self.type == PresenceType.UNAVAILABLE)
@property
def new_jid(self) -> JID:
if not self.is_nickname_changed:
raise ValueError('This is not a nickname change')
return self.jid.new_with(resource=self.muc_user.nick)
@property
def is_kicked(self) -> bool:
status_codes = {
StatusCode.REMOVED_BANNED,
StatusCode.REMOVED_KICKED,
StatusCode.REMOVED_AFFILIATION_CHANGE,
StatusCode.REMOVED_NONMEMBER_IN_MEMBERS_ONLY,
StatusCode.REMOVED_SERVICE_SHUTDOWN,
StatusCode.REMOVED_ERROR
}
return (self.from_muc and
self.muc_status_codes is not None and
bool(status_codes.intersection(self.muc_status_codes)) and
self.type == PresenceType.UNAVAILABLE)
@property
def is_muc_shutdown(self) -> bool:
return (self.from_muc and
self.muc_status_codes is not None and
StatusCode.REMOVED_SERVICE_SHUTDOWN in self.muc_status_codes)
@property
def is_new_room(self) -> bool:
status_codes = {
StatusCode.CREATED,
StatusCode.SELF
}
return (self.from_muc and
self.muc_status_codes is not None and
status_codes.issubset(self.muc_status_codes))
@property
def affiliation(self) -> Optional[Affiliation]:
try:
return self.muc_user.affiliation
except Exception:
return None
@property
def role(self) -> Optional[Role]:
try:
return self.muc_user.role
except Exception:
return None
class XHTMLData:
def __init__(self, xhtml: Node):
self._bodys: dict[Optional[str], Node] = {}
for body in xhtml.getTags('body', namespace=Namespace.XHTML):
lang = body.getXmlLang()
self._bodys[lang] = body
def get_body(self, pref_lang: Optional[str] = None) -> str:
if pref_lang is not None:
body = self._bodys.get(pref_lang)
if body is not None:
return str(body)
body = self._bodys.get('en')
if body is not None:
return str(body)
body = self._bodys.get(None)
if body is not None:
return str(body)
return str(self._bodys.popitem()[1])
|