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
|
# Copyright (C) 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/>.
import logging
from typing import List
from typing import Optional
from typing import Set
from dataclasses import dataclass
from dataclasses import field
from nbxmpp.simplexml import Node
from nbxmpp.namespaces import Namespace
from nbxmpp.errors import MalformedStanzaError
from nbxmpp.task import iq_request_task
from nbxmpp.modules.base import BaseModule
from nbxmpp.modules.util import raise_if_error
from nbxmpp.modules.util import finalize
log = logging.getLogger('nbxmpp.m.vcard4')
ALLOWED_SEX_VALUES = ['M', 'F', 'O', 'N', 'U']
ALLOWED_KIND_VALUES = ['individual', 'group', 'org', 'location']
# Cardinality
# 1 Exactly one instance per vCard MUST be present.
# *1 Exactly one instance per vCard MAY be present.
# 1* One or more instances per vCard MUST be present.
# * One or more instances per vCard MAY be present.
PROPERTY_DEFINITION = {
'source': (['altid', 'pid', 'pref', 'mediatype'], '*'),
'kind': ([], '*1'),
'fn': (['language', 'altid', 'pid', 'pref', 'type'], '1*'),
'n': (['language', 'altid', 'sort-as'], '*1'),
'nickname': (['language', 'altid', 'pid', 'pref', 'type'], '*'),
'photo': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'bday': (['altid', 'calscale'], '*1'),
'anniversary': (['altid', 'calscale'], '*1'),
'gender': ([], '*1'),
'adr': (['language', 'altid', 'pid', 'pref', 'type', 'geo', 'tz', 'label'], '*'),
'tel': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'email': (['altid', 'pid', 'pref', 'type'], '*'),
'impp': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'lang': (['altid', 'pid', 'pref', 'type'], '*'),
'tz': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'geo': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'title': (['language', 'altid', 'pid', 'pref', 'type'], '*'),
'role': (['language', 'altid', 'pid', 'pref', 'type'], '*'),
'logo': (['language', 'altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'org': (['language', 'altid', 'pid', 'pref', 'type', 'sort-as'], '*'),
'member': (['altid', 'pid', 'pref', 'mediatype'], '*'),
'related': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'categories': (['altid', 'pid', 'pref', 'type'], '*'),
'note': (['language', 'altid', 'pid', 'pref', 'type'], '*'),
'prodid': ([], '*1'),
'rev': ([], '*1'),
'sound': (['language', 'altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'uid': ([], '*1'),
'clientpidmap': ([], '*'),
'url': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'key': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'fburl': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'caladruri': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
'caluri': (['altid', 'pid', 'pref', 'type', 'mediatype'], '*'),
}
PROPERTY_VALUE_TYPES = {
'bday': ['date', 'time', 'date-time', 'text'],
'anniversary': ['date', 'time', 'date-time', 'text'],
'key': ['text', 'uri'],
'tel': ['uri', 'text'],
'tz': ['text', 'uri', 'utc-offset'],
'related': ['text', 'uri'],
}
def get_data_from_children(node, child_name):
values = []
child_nodes = node.getTags(child_name)
for child_node in child_nodes:
child_value = child_node.getData()
if child_value:
values.append(child_value)
return values
def add_children(node, child_name, values):
for value in values:
node.addChild(child_name, payload=value)
def get_multiple_type_value(node, types):
for type_ in types:
value = node.getTagData(type_)
if value:
return type_, value
raise ValueError('no value found')
def make_parameters(parameters):
parameters_node = Node('parameters')
for parameter in parameters.values():
parameters_node.addChild(node=parameter.to_node())
return parameters_node
def get_parameters(node):
name = node.getName()
definition = PROPERTY_DEFINITION[name]
allowed_parameters = definition[0]
parameters_node = node.getTag('parameters')
if parameters_node is None:
return Parameters()
parameters = {}
for parameter in allowed_parameters:
parameter_node = parameters_node.getTag(parameter)
if parameter_node is None:
continue
parameter_class = PARAMETER_CLASSES.get(parameter_node.getName())
if parameter_class is None:
continue
parameter = parameter_class.from_node(parameter_node)
parameters[parameter.name] = parameter
return Parameters(parameters)
@dataclass
class Parameter:
name: str
type: str
value: str
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid parameter name: {name}')
value = node.getTagData(cls.type)
if not value:
raise ValueError('no parameter value found')
return cls(value)
def to_node(self):
node = Node(self.name)
node.addChild(self.type, payload=self.value)
return node
def copy(self):
return self.__class__(value=self.value)
@dataclass
class MultiParameter:
name: str
type: str
values: Set[str]
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid parameter name: {name}')
value_nodes = node.getTags(cls.type)
if not value_nodes:
raise ValueError('no parameter value found')
values = set()
for value_node in value_nodes:
value = value_node.getData()
if value:
values.add(value)
if not values:
raise ValueError('no parameter value found')
return cls(values)
def to_node(self):
node = Node(self.name)
for value in self.values:
node.addChild(self.type, payload=value)
return node
def copy(self):
return self.__class__(values=set(self.values))
@dataclass
class LanguageParameter(Parameter):
name: str = field(default='language', init=False)
type: str = field(default='language-tag', init=False)
@dataclass
class PrefParameter(Parameter):
name: str = field(default='pref', init=False)
type: str = field(default='integer', init=False)
@dataclass
class AltidParameter(Parameter):
name: str = field(default='altid', init=False)
type: str = field(default='text', init=False)
@dataclass
class PidParameter(MultiParameter):
name: str = field(default='pid', init=False)
type: str = field(default='text', init=False)
@dataclass
class TypeParameter(MultiParameter):
name: str = field(default='type', init=False)
type: str = field(default='text', init=False)
@dataclass
class MediatypeParameter(Parameter):
name: str = field(default='mediatype', init=False)
type: str = field(default='text', init=False)
@dataclass
class CalscaleParameter(Parameter):
name: str = field(default='calscale', init=False)
type: str = field(default='text', init=False)
@dataclass
class SortasParameter(MultiParameter):
name: str = field(default='sort-as', init=False)
type: str = field(default='text', init=False)
@dataclass
class GeoParameter(Parameter):
name: str = field(default='geo', init=False)
type: str = field(default='uri', init=False)
@dataclass
class TzParameter:
name: str = field(default='tz', init=False)
value_type: str
value: str
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
value_type, value = get_multiple_type_value(node, ['text', 'uri'])
return cls(value_type, value)
def to_node(self):
node = Node(self.name)
node.addChild(self.value_type, payload=self.value)
return node
def copy(self):
return self.__class__(value_type=self.value_type,
value=self.value)
class Parameters:
def __init__(self, parameters=None):
if parameters is None:
parameters = {}
self._parameters = parameters
def values(self):
return self._parameters.values()
def get_types(self):
parameter = self._parameters.get('type')
if parameter is None:
return set()
return parameter.values
def remove_types(self, types):
parameter = self._parameters.get('type')
if parameter is None:
raise ValueError('no type parameter')
for type_ in types:
parameter.values.discard(type_)
if not parameter.values:
self._parameters.pop('type')
def add_types(self, types):
parameter = self._parameters.get('type')
if parameter is None:
parameter = TypeParameter(set(types))
self._parameters['type'] = parameter
return
parameter.values.update(types)
def copy(self):
parameters = {}
for name, parameter in self._parameters.items():
parameters[name] = parameter.copy()
return self.__class__(parameters=parameters)
PARAMETER_CLASSES = {
'language': LanguageParameter,
'pref': PrefParameter,
'altid': AltidParameter,
'pid': PidParameter,
'type': TypeParameter,
'mediatype': MediatypeParameter,
'calscale': CalscaleParameter,
'sort-as': SortasParameter,
'geo': GeoParameter,
'tz': TzParameter
}
@dataclass
class UriProperty:
name: str
value: str
parameters: Parameters = field(default_factory=Parameters)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
value = node.getTagData('uri')
if not value:
raise ValueError('no value found')
parameters = get_parameters(node)
return cls(value, parameters)
def to_node(self):
node = Node(self.name)
if self.parameters:
node.addChild(node=make_parameters(self.parameters))
node.addChild('uri', payload=self.value)
return node
@property
def is_empty(self):
return not self.value
def copy(self):
return self.__class__(value=self.value,
parameters=self.parameters.copy())
@dataclass
class TextProperty:
name: str
value: str
parameters: Parameters = field(default_factory=Parameters)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
text = node.getTagData('text')
if not text:
raise ValueError('no value found')
parameters = get_parameters(node)
return cls(text, parameters)
def to_node(self):
node = Node(self.name)
if self.parameters:
node.addChild(node=make_parameters(self.parameters))
node.addChild('text', payload=self.value)
return node
@property
def is_empty(self):
return not self.value
def copy(self):
return self.__class__(value=self.value,
parameters=self.parameters.copy())
@dataclass
class TextListProperty:
name: str
values: List[str]
parameters: Parameters = field(default_factory=Parameters)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
text_nodes = node.getTags('text')
if not text_nodes:
raise ValueError('no value found')
values = get_data_from_children(node, 'text')
if not values:
raise ValueError('no values found')
parameters = get_parameters(node)
return cls(values, parameters)
def to_node(self):
node = Node(self.name)
if self.parameters:
node.addChild(node=make_parameters(self.parameters))
add_children(node, 'text', self.values)
return node
@property
def is_empty(self):
return not self.values
def copy(self):
return self.__class__(values=list(self.values),
parameters=self.parameters.copy())
@dataclass
class MultipleValueProperty:
name: str
value_type: str
value: str
parameters: Parameters = field(default_factory=Parameters)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
types = PROPERTY_VALUE_TYPES[cls.name]
value_type, value = get_multiple_type_value(node, types)
parameters = get_parameters(node)
return cls(value_type, value, parameters)
def to_node(self):
node = Node(self.name)
if self.parameters:
node.addChild(node=make_parameters(self.parameters))
node.addChild(self.value_type, payload=self.value)
return node
@property
def is_empty(self):
return not self.value
def copy(self):
return self.__class__(value_type=self.value_type,
value=self.value,
parameters=self.parameters.copy())
@dataclass
class SourceProperty(UriProperty):
name: str = field(default='source', init=False)
@dataclass
class KindProperty(TextProperty):
name: str = field(default='kind', init=False)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
text = node.getTagData('text')
if not text:
raise ValueError('no value found')
if text not in ALLOWED_KIND_VALUES:
text = 'individual'
parameters = get_parameters(node)
return cls(text, parameters)
@dataclass
class FnProperty(TextProperty):
name: str = field(default='fn', init=False)
@dataclass
class NProperty:
name: str = field(default='n', init=False)
surname: List[str] = field(default_factory=list)
given: List[str] = field(default_factory=list)
additional: List[str] = field(default_factory=list)
prefix: List[str] = field(default_factory=list)
suffix: List[str] = field(default_factory=list)
parameters: Parameters = field(default_factory=Parameters)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
surname = get_data_from_children(node, 'surname')
given = get_data_from_children(node, 'given')
additional = get_data_from_children(node, 'additional')
prefix = get_data_from_children(node, 'prefix')
suffix = get_data_from_children(node, 'suffix')
parameters = get_parameters(node)
return cls(surname, given, additional, prefix, suffix, parameters)
def to_node(self):
node = Node(self.name)
if self.parameters:
node.addChild(node=make_parameters(self.parameters))
add_children(node, 'surname', self.surname)
add_children(node, 'given', self.given)
add_children(node, 'additional', self.additional)
add_children(node, 'prefix', self.prefix)
add_children(node, 'suffix', self.suffix)
return node
@property
def is_empty(self):
if (self.surname or
self.given or
self.additional or
self.suffix or
self.prefix):
return False
return True
def copy(self):
return self.__class__(surname=list(self.surname),
given=list(self.given),
additional=list(self.additional),
prefix=list(self.prefix),
suffix=list(self.suffix),
parameters=self.parameters.copy())
@dataclass
class NicknameProperty(TextListProperty):
name: str = field(default='nickname', init=False)
@dataclass
class PhotoProperty(UriProperty):
name: str = field(default='photo', init=False)
@dataclass
class BDayProperty(MultipleValueProperty):
name: str = field(default='bday', init=False)
@dataclass
class AnniversaryProperty(MultipleValueProperty):
name: str = field(default='anniversary', init=False)
@dataclass
class GenderProperty:
name: str = field(default='gender', init=False)
sex: Optional[str] = None
identity: Optional[str] = None
parameters: Parameters = field(default_factory=Parameters)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
sex = node.getTagData('sex')
if sex not in ALLOWED_SEX_VALUES:
sex = None
identity = node.getTagData('identity')
if not identity:
identity = None
parameters = get_parameters(node)
return cls(sex, identity, parameters)
def to_node(self):
node = Node(self.name)
if self.parameters:
node.addChild(node=make_parameters(self.parameters))
if self.sex:
node.addChild('sex', payload=self.sex)
if self.identity:
node.addChild('identity', payload=self.identity)
return node
@property
def is_empty(self):
if self.sex or self.identity:
return False
return True
def copy(self):
return self.__class__(sex=self.sex,
identity=self.identity,
parameters=self.parameters.copy())
@dataclass
class AdrProperty:
name: str = field(default='adr', init=False)
pobox: List[str] = field(default_factory=list)
ext: List[str] = field(default_factory=list)
street: List[str] = field(default_factory=list)
locality: List[str] = field(default_factory=list)
region: List[str] = field(default_factory=list)
code: List[str] = field(default_factory=list)
country: List[str] = field(default_factory=list)
parameters: Parameters = field(default_factory=Parameters)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
pobox = get_data_from_children(node, 'pobox')
ext = get_data_from_children(node, 'ext')
street = get_data_from_children(node, 'street')
locality = get_data_from_children(node, 'locality')
region = get_data_from_children(node, 'region')
code = get_data_from_children(node, 'code')
country = get_data_from_children(node, 'country')
parameters = get_parameters(node)
return cls(pobox, ext, street, locality,
region, code, country, parameters)
def to_node(self):
node = Node(self.name)
if self.parameters:
node.addChild(node=make_parameters(self.parameters))
add_children(node, 'pobox', self.pobox)
add_children(node, 'ext', self.ext)
add_children(node, 'street', self.street)
add_children(node, 'locality', self.locality)
add_children(node, 'region', self.region)
add_children(node, 'code', self.code)
add_children(node, 'country', self.country)
return node
@property
def is_empty(self):
# pylint: disable=too-many-boolean-expressions
if (self.pobox or
self.ext or
self.street or
self.locality or
self.region or
self.code or
self.country):
return False
return True
def copy(self):
return self.__class__(pobox=list(self.pobox),
ext=list(self.ext),
street=list(self.street),
locality=list(self.locality),
region=list(self.region),
code=list(self.code),
country=list(self.country),
parameters=self.parameters.copy())
@dataclass
class TelProperty(MultipleValueProperty):
name: str = field(default='tel', init=False)
@dataclass
class EmailProperty(TextProperty):
name: str = field(default='email', init=False)
@dataclass
class ImppProperty(UriProperty):
name: str = field(default='impp', init=False)
@dataclass
class LangProperty:
name: str = field(default='lang', init=False)
value: str
parameters: Parameters = field(default_factory=Parameters)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
value = node.getTagData('language-tag')
if not value:
raise ValueError('no value found')
parameters = get_parameters(node)
return cls(value, parameters)
def to_node(self):
node = Node(self.name)
if self.parameters:
node.addChild(node=make_parameters(self.parameters))
node.addChild('language-tag', payload=self.value)
return node
@property
def is_empty(self):
return not self.value
def copy(self):
return self.__class__(value=self.value,
parameters=self.parameters.copy())
@dataclass
class TzProperty(MultipleValueProperty):
name: str = field(default='tz', init=False)
@dataclass
class GeoProperty(UriProperty):
name: str = field(default='geo', init=False)
@dataclass
class TitleProperty(TextProperty):
name: str = field(default='title', init=False)
@dataclass
class RoleProperty(TextProperty):
name: str = field(default='role', init=False)
@dataclass
class LogoProperty(UriProperty):
name: str = field(default='logo', init=False)
@dataclass
class OrgProperty(TextListProperty):
name: str = field(default='org', init=False)
@dataclass
class MemberProperty(UriProperty):
name: str = field(default='member', init=False)
@dataclass
class RelatedProperty(MultipleValueProperty):
name: str = field(default='related', init=False)
@dataclass
class CategoriesProperty(TextListProperty):
name: str = field(default='categories', init=False)
@dataclass
class NoteProperty(TextProperty):
name: str = field(default='note', init=False)
@dataclass
class ProdidProperty(TextProperty):
name: str = field(default='prodid', init=False)
@dataclass
class RevProperty(TextProperty):
name: str = field(default='rev', init=False)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
timestamp = node.getTagData('timestamp')
if not timestamp:
raise ValueError('no value found')
parameters = get_parameters(node)
return cls(timestamp, parameters)
def to_node(self):
node = Node(self.name)
if self.parameters:
node.addChild(node=make_parameters(self.parameters))
node.addChild('timestamp', payload=self.value)
return node
@dataclass
class SoundProperty(UriProperty):
name: str = field(default='sound', init=False)
@dataclass
class UidProperty(UriProperty):
name: str = field(default='uid', init=False)
@dataclass
class ClientpidmapProperty:
name: str = field(default='clientpidmap', init=False)
sourceid: int
uri: str
parameters: Parameters = field(default_factory=Parameters)
@classmethod
def from_node(cls, node):
name = node.getName()
if name != cls.name:
raise ValueError(f'invalid property name: {name}')
sourceid = node.getTagData('sourceid')
if not sourceid:
raise ValueError('no value found')
uri = node.getTagData('uri')
if not uri:
raise ValueError('no value found')
parameters = get_parameters(node)
return cls(sourceid, uri, parameters)
def to_node(self):
node = Node(self.name)
if self.parameters:
node.addChild(node=make_parameters(self.parameters))
node.addChild('sourceid', payload=self.sourceid)
node.addChild('uri', payload=self.uri)
return node
@property
def is_empty(self):
return not self.uri
def copy(self):
return self.__class__(sourceid=self.sourceid,
uri=self.uri,
parameters=self.parameters.copy())
@dataclass
class UrlProperty(UriProperty):
name: str = field(default='url', init=False)
@dataclass
class KeyProperty(MultipleValueProperty):
name: str = field(default='key', init=False)
@dataclass
class FBurlProperty(UriProperty):
name: str = field(default='fburl', init=False)
@dataclass
class CaladruriProperty(UriProperty):
name: str = field(default='caladruri', init=False)
@dataclass
class CaluriProperty(UriProperty):
name: str = field(default='calurl', init=False)
PROPERTY_CLASSES = {
'source': SourceProperty,
'kind': KindProperty,
'fn': FnProperty,
'n': NProperty,
'nickname': NicknameProperty,
'photo': PhotoProperty,
'bday': BDayProperty,
'anniversary': AnniversaryProperty,
'gender': GenderProperty,
'adr': AdrProperty,
'tel': TelProperty,
'email': EmailProperty,
'impp': ImppProperty,
'lang': LangProperty,
'tz': TzProperty,
'geo': GeoProperty,
'title': TitleProperty,
'role': RoleProperty,
'logo': LogoProperty,
'org': OrgProperty,
'member': MemberProperty,
'related': RelatedProperty,
'categories': CategoriesProperty,
'note': NoteProperty,
'prodid': ProdidProperty,
'rev': RevProperty,
'sound': SoundProperty,
'uid': UidProperty,
'clientpidmap': ClientpidmapProperty,
'url': UrlProperty,
'key': KeyProperty,
'fburl': FBurlProperty,
'caladruri': CaladruriProperty,
'caluri': CaluriProperty,
}
def get_property_from_name(name, node):
property_class = PROPERTY_CLASSES.get(name)
if property_class is None:
return None
try:
return property_class.from_node(node)
except Exception as error:
log.warning('invalid vcard property: %s %s', error, node)
return None
class VCard:
def __init__(self, properties=None):
if properties is None:
properties = []
self._properties = properties
@classmethod
def from_node(cls, node):
properties = []
for child in node.getChildren():
child_name = child.getName()
if child_name == 'group':
group_name = child.getAttr('name')
if not group_name:
continue
group_properties = []
for group_child in child.getChildren():
group_child_name = group_child.getName()
property_ = get_property_from_name(group_child_name,
group_child)
if property_ is None:
continue
group_properties.append(property_)
properties.append((group_name, group_properties))
else:
property_ = get_property_from_name(child_name, child)
if property_ is None:
continue
properties.append((None, property_))
return cls(properties)
def to_node(self):
vcard = Node(f'{Namespace.VCARD4} vcard')
for group, props in self._properties:
if group is None:
vcard.addChild(node=props.to_node())
else:
group = Node(group)
for prop in props:
group.addChild(node=prop.to_node())
vcard.addChild(node=group)
return vcard
def get_properties(self):
properties = []
for group, props in self._properties:
if group is None:
properties.append(props)
else:
properties.extend(props)
return properties
def add_property(self, name, *args, **kwargs):
prop = PROPERTY_CLASSES.get(name)(*args, **kwargs)
self._properties.append((None, prop))
return prop
def remove_property(self, prop):
for _group, props in list(self._properties):
if isinstance(props, list):
if prop in props:
props.remove(prop)
return
elif prop is props:
self._properties.remove((None, props))
return
raise ValueError('prop not found in vcard')
def copy(self):
properties = []
for group_name, props in self._properties:
if group_name is None:
properties.append((None, props.copy()))
else:
group_properties = [prop.copy() for prop in props]
properties.append((group_name, group_properties))
return self.__class__(properties=properties)
class VCard4(BaseModule):
_depends = {
'publish': 'PubSub',
'request_items': 'PubSub',
}
def __init__(self, client):
BaseModule.__init__(self, client)
self._client = client
self.handlers = []
@iq_request_task
def request_vcard(self, jid=None):
task = yield
items = yield self.request_items(Namespace.VCARD4_PUBSUB,
jid=jid,
max_items=1)
raise_if_error(items)
if not items:
yield task.set_result(None)
yield _get_vcard(items[0])
@iq_request_task
def set_vcard(self, vcard, public=False):
task = yield
access_model = 'open' if public else 'presence'
options = {
'pubsub#persist_items': 'true',
'pubsub#access_model': access_model,
}
result = yield self.publish(Namespace.VCARD4_PUBSUB,
vcard.to_node(),
id_='current',
options=options,
force_node_options=True)
yield finalize(task, result)
def _get_vcard(item):
vcard = item.getTag('vcard', namespace=Namespace.VCARD4)
if vcard is None:
raise MalformedStanzaError('vcard node missing', item)
try:
vcard = VCard.from_node(vcard)
except Exception as error:
raise MalformedStanzaError('invalid vcard: %s' % error, item)
return vcard
|