annotate sat/plugins/plugin_xep_0292.py @ 3966:9f85369294f3

doc (encryption, cli): pubsub signing documentation: - add a `Pubsub Signature` section to `encryption` documentation - document `-X, --sign` flag where it's used - document `pubsub/signature` subcommands fix 381
author Goffi <goffi@goffi.org>
date Sun, 30 Oct 2022 01:06:58 +0200
parents 4f02e339d184
children 524856bd7b19
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3819
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/env python3
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
2
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
3 # Libervia plugin for XEP-0292
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # Copyright (C) 2009-2022 Jérôme Poisson (goffi@goffi.org)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
5
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
6 # This program is free software: you can redistribute it and/or modify
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # it under the terms of the GNU Affero General Public License as published by
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # the Free Software Foundation, either version 3 of the License, or
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # (at your option) any later version.
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
10
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
11 # This program is distributed in the hope that it will be useful,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # GNU Affero General Public License for more details.
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
15
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
16 # You should have received a copy of the GNU Affero General Public License
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
18
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
19 from typing import List, Dict, Union, Any, Optional
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
20 from functools import partial
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
21
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
22 from twisted.words.protocols.jabber.xmlstream import XMPPHandler
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
23 from twisted.words.protocols.jabber import jid
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
24 from twisted.words.xish import domish
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
25 from zope.interface import implementer
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
26 from wokkel import disco, iwokkel
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
27
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
28 from sat.core.constants import Const as C
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
29 from sat.core.i18n import _
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
30 from sat.core.log import getLogger
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
31 from sat.core.core_types import SatXMPPEntity
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
32 from sat.core import exceptions
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
33 from sat.tools.common.async_utils import async_lru
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
34
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
35
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
36 log = getLogger(__name__)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
37
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
38 IMPORT_NAME = "XEP-0292"
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
39
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
40 PLUGIN_INFO = {
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
41 C.PI_NAME: "vCard4 Over XMPP",
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
42 C.PI_IMPORT_NAME: IMPORT_NAME,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
43 C.PI_TYPE: C.PLUG_TYPE_XEP,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
44 C.PI_MODES: C.PLUG_MODE_BOTH,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
45 C.PI_PROTOCOLS: ["XEP-0292"],
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
46 C.PI_DEPENDENCIES: ["IDENTITY", "XEP-0060", "XEP-0163"],
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
47 C.PI_MAIN: "XEP_0292",
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
48 C.PI_HANDLER: "yes",
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
49 C.PI_DESCRIPTION: _("""XEP-0292 (vCard4 Over XMPP) implementation"""),
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
50 }
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
51
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
52 NS_VCARD4 = "urn:ietf:params:xml:ns:vcard-4.0"
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
53 VCARD4_NODE = "urn:xmpp:vcard4"
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
54 text_fields = {
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
55 "fn": "name",
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
56 "nickname": "nicknames",
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
57 "note": "description"
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
58 }
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
59 text_fields_inv = {v: k for k,v in text_fields.items()}
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
60
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
61
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
62 class XEP_0292:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
63 namespace = NS_VCARD4
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
64 node = VCARD4_NODE
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
65
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
66 def __init__(self, host):
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
67 # XXX: as of XEP-0292 v0.11, there is a dedicated <IQ/> protocol in this XEP which
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
68 # should be used according to the XEP. Hovewer it feels like an outdated behaviour
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
69 # and other clients don't seem to use it. After discussing it on xsf@ MUC, it
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
70 # seems that implemeting the dedicated <IQ/> protocol is a waste of time, and thus
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
71 # it is not done here. It is expected that this dedicated protocol will be removed
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
72 # from a future version of the XEP.
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
73 log.info(_("vCard4 Over XMPP initialization"))
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
74 host.registerNamespace("vcard4", NS_VCARD4)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
75 self.host = host
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
76 self._p = host.plugins["XEP-0060"]
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
77 self._i = host.plugins['IDENTITY']
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
78 self._i.register(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
79 IMPORT_NAME,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
80 'nicknames',
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
81 partial(self.getValue, field="nicknames"),
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
82 partial(self.setValue, field="nicknames"),
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
83 priority=1000
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
84 )
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
85 self._i.register(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
86 IMPORT_NAME,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
87 'description',
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
88 partial(self.getValue, field="description"),
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
89 partial(self.setValue, field="description"),
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
90 priority=1000
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
91 )
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
92
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
93 def getHandler(self, client):
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
94 return XEP_0292_Handler()
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
95
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
96 def vcard2Dict(self, vcard_elt: domish.Element) -> Dict[str, Any]:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
97 """Convert vcard element to equivalent identity metadata"""
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
98 vcard: Dict[str, Any] = {}
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
99
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
100 for metadata_elt in vcard_elt.elements():
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
101 # Text values
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
102 for source_field, dest_field in text_fields.items():
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
103 if metadata_elt.name == source_field:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
104 if metadata_elt.text is not None:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
105 dest_type = self._i.getFieldType(dest_field)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
106 value = str(metadata_elt.text)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
107 if dest_type is str:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
108 if dest_field in vcard:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
109 vcard[dest_field] += value
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
110 else:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
111 vcard[dest_field] = value
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
112 elif dest_type is list:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
113 vcard.setdefault(dest_field, []).append(value)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
114 else:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
115 raise exceptions.InternalError(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
116 f"unexpected dest_type: {dest_type!r}"
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
117 )
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
118 break
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
119 else:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
120 log.debug(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
121 f"Following element is currently unmanaged: {metadata_elt.toXml()}"
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
122 )
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
123 return vcard
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
124
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
125 def dict2VCard(self, vcard: dict[str, Any]) -> domish.Element:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
126 """Convert vcard metadata to vCard4 element"""
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
127 vcard_elt = domish.Element((NS_VCARD4, "vcard"))
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
128 for field, elt_name in text_fields_inv.items():
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
129 value = vcard.get(field)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
130 if value:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
131 if isinstance(value, str):
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
132 value = [value]
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
133 if isinstance(value, list):
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
134 for v in value:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
135 field_elt = vcard_elt.addElement(elt_name)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
136 field_elt.addElement("text", content=v)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
137 else:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
138 log.warning(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
139 f"ignoring unexpected value: {value!r}"
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
140 )
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
141
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
142 return vcard_elt
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
143
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
144 @async_lru(5)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
145 async def getCard(self, client: SatXMPPEntity, entity: jid.JID) -> dict:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
146 try:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
147 items, metadata = await self._p.getItems(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
148 client, entity, VCARD4_NODE, item_ids=["current"]
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
149 )
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
150 except exceptions.NotFound:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
151 log.info(f"No vCard node found for {entity}")
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
152 return {}
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
153 item_elt = items[0]
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
154 try:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
155 vcard_elt = next(item_elt.elements(NS_VCARD4, "vcard"))
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
156 except StopIteration:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
157 log.info(f"vCard element is not present for {entity}")
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
158 return {}
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
159
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
160 return self.vcard2Dict(vcard_elt)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
161
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
162 async def updateVCardElt(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
163 self,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
164 client: SatXMPPEntity,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
165 vcard_elt: domish.Element,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
166 entity: Optional[jid.JID] = None
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
167 ) -> None:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
168 """Update VCard 4 of given entity, create node if doesn't already exist
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
169
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
170 @param vcard_elt: whole vCard element to update
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
171 @param entity: entity for which the vCard must be updated
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
172 None to update profile's own vCard
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
173 """
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
174 service = entity or client.jid.userhostJID()
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
175 node_options = {
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
176 self._p.OPT_ACCESS_MODEL: self._p.ACCESS_OPEN,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
177 self._p.OPT_PUBLISH_MODEL: self._p.PUBLISH_MODEL_PUBLISHERS
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
178 }
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
179 await self._p.createIfNewNode(client, service, VCARD4_NODE, node_options)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
180 await self._p.sendItem(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
181 client, service, VCARD4_NODE, vcard_elt, item_id=self._p.ID_SINGLETON
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
182 )
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
183
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
184 async def updateVCard(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
185 self,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
186 client: SatXMPPEntity,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
187 vcard: Dict[str, Any],
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
188 entity: Optional[jid.JID] = None,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
189 update: bool = True,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
190 ) -> None:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
191 """Update VCard 4 of given entity, create node if doesn't already exist
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
192
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
193 @param vcard: identity metadata
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
194 @param entity: entity for which the vCard must be updated
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
195 None to update profile's own vCard
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
196 @param update: if True, current vCard will be retrieved and updated with given
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
197 vcard (thus if False, `vcard` data will fully replace previous one).
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
198 """
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
199 service = entity or client.jid.userhostJID()
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
200 if update:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
201 current_vcard = await self.getCard(client, service)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
202 current_vcard.update(vcard)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
203 vcard = current_vcard
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
204 vcard_elt = self.dict2VCard(vcard)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
205 await self.updateVCardElt(client, vcard_elt, service)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
206
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
207 async def getValue(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
208 self,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
209 client: SatXMPPEntity,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
210 entity: jid.JID,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
211 field: str,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
212 ) -> Optional[Union[str, List[str]]]:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
213 """Return generic value
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
214
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
215 @param entity: entity from who the vCard comes
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
216 @param field: name of the field to get
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
217 This has to be a string field
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
218 @return request value
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
219 """
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
220 vcard_data = await self.getCard(client, entity)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
221 return vcard_data.get(field)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
222
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
223 async def setValue(
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
224 self,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
225 client: SatXMPPEntity,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
226 value: Union[str, List[str]],
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
227 entity: jid.JID,
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
228 field: str
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
229 ) -> None:
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
230 """Set generic value
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
231
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
232 @param entity: entity from who the vCard comes
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
233 @param field: name of the field to get
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
234 This has to be a string field
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
235 """
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
236 await self.updateVCard(client, {field: value}, entity)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
237
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
238
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
239 @implementer(iwokkel.IDisco)
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
240 class XEP_0292_Handler(XMPPHandler):
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
241
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
242 def getDiscoInfo(self, requestor, service, nodeIdentifier=""):
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
243 return [disco.DiscoFeature(NS_VCARD4)]
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
244
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
245 def getDiscoItems(self, requestor, service, nodeIdentifier=""):
4f02e339d184 plugin XEP-0292: vCard4 Over XMPP implementation:
Goffi <goffi@goffi.org>
parents:
diff changeset
246 return []