Mercurial > libervia-backend

annotate sat/memory/disco.py @ 3838:9a53b513ae55

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (components/AP): Mention: fix 369
author Goffi <goffi@goffi.org>
date Sun, 10 Jul 2022 16:15:44 +0200
parents 073f386a191a
children 524856bd7b19
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
1 #!/usr/bin/env python3
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
3
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
4 # SAT: a jabber client
3479
be6d91572633 date update
Goffi <goffi@goffi.org>
parents: 3254
diff changeset
5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
6
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
10 # (at your option) any later version.
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
11
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
15 # GNU Affero General Public License for more details.
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
16
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
19
3718
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
20 from typing import Optional
771
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 667
diff changeset
21 from sat.core.i18n import _
951
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test
Goffi <goffi@goffi.org>
parents: 944
diff changeset
22 from sat.core import exceptions
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 973
diff changeset
23 from sat.core.log import getLogger
3718
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
24 from sat.core.core_types import SatXMPPEntity
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
25
941
c6d8fc63b1db core, plugins: host.getClient now raise an exception instead of returning None when no profile is found, plugins have been adapted consequently and a bit cleaned
Goffi <goffi@goffi.org>
parents: 916
diff changeset
26 from twisted.words.protocols.jabber import jid
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
27 from twisted.words.protocols.jabber.error import StanzaError
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
28 from twisted.internet import defer
1189
7d640c303140 core (disco): added a timeout to get items
Goffi <goffi@goffi.org>
parents: 993
diff changeset
29 from twisted.internet import reactor
1493
1285c714a6cc core (disco): use of failure.Failure when raising FeatureNotFound to avoid a jump in debugger in debug mode
Goffi <goffi@goffi.org>
parents: 1491
diff changeset
30 from twisted.python import failure
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
31 from sat.core.constants import Const as C
1684
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
32 from sat.tools import xml_tools
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
33 from sat.memory import persistent
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
34 from wokkel import disco
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
35 from base64 import b64encode
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
36 from hashlib import sha1
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
37
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
38
3718
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
39 log = getLogger(__name__)
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
40
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
41
1189
7d640c303140 core (disco): added a timeout to get items
Goffi <goffi@goffi.org>
parents: 993
diff changeset
42 TIMEOUT = 15
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
43 CAP_HASH_ERROR = "ERROR"
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
44
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
45
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
46 class HashGenerationError(Exception):
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
47 pass
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
48
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
49
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
50 class ByteIdentity(object):
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
51 """This class manage identity as bytes (needed for i;octet sort), it is used for the hash generation"""
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
52
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
53 def __init__(self, identity, lang=None):
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
54 assert isinstance(identity, disco.DiscoIdentity)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
55 self.category = identity.category.encode("utf-8")
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
56 self.idType = identity.type.encode("utf-8")
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
57 self.name = identity.name.encode("utf-8") if identity.name else b""
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
58 self.lang = lang.encode("utf-8") if lang is not None else b""
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
59
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
60 def __bytes__(self):
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
61 return b"%s/%s/%s/%s" % (self.category, self.idType, self.lang, self.name)
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
62
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
63
1684
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
64 class HashManager(object):
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
65 """map object which manage hashes
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
66
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
67 persistent storage is update when a new hash is added
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
68 """
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
69
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
70 def __init__(self, persistent):
1752
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
71 self.hashes = {
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
72 CAP_HASH_ERROR: disco.DiscoInfo() # used when we can't get disco infos
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
73 }
1684
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
74 self.persistent = persistent
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
75
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
76 def __getitem__(self, key):
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
77 return self.hashes[key]
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
78
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
79 def __setitem__(self, hash_, disco_info):
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
80 if hash_ in self.hashes:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
81 log.debug("ignoring hash set: it is already known")
1684
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
82 return
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
83 self.hashes[hash_] = disco_info
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
84 self.persistent[hash_] = disco_info.toElement().toXml()
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
85
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
86 def __contains__(self, hash_):
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
87 return self.hashes.__contains__(hash_)
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
88
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
89 def load(self):
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
90 def fillHashes(hashes):
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
91 for hash_, xml in hashes.items():
1684
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
92 element = xml_tools.ElementParser()(xml)
2587
e70023e84974 core (disco): fixed disco capabilities (empty disco was used)
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
93 disco_info = disco.DiscoInfo.fromElement(element)
3250
e4d3ba75b1b2 core (memory/disco): fixed types of disco extensions:
Goffi <goffi@goffi.org>
parents: 3194
diff changeset
94 for ext_form in disco_info.extensions.values():
e4d3ba75b1b2 core (memory/disco): fixed types of disco extensions:
Goffi <goffi@goffi.org>
parents: 3194
diff changeset
95 # wokkel doesn't call typeCheck on reception, so we do it here
e4d3ba75b1b2 core (memory/disco): fixed types of disco extensions:
Goffi <goffi@goffi.org>
parents: 3194
diff changeset
96 ext_form.typeCheck()
2587
e70023e84974 core (disco): fixed disco capabilities (empty disco was used)
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
97 if not disco_info.features and not disco_info.identities:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
98 log.warning(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
99 _(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
100 "no feature/identity found in disco element (hash: {cap_hash}), ignoring: {xml}"
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
101 ).format(cap_hash=hash_, xml=xml)
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
102 )
2587
e70023e84974 core (disco): fixed disco capabilities (empty disco was used)
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
103 else:
e70023e84974 core (disco): fixed disco capabilities (empty disco was used)
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
104 self.hashes[hash_] = disco_info
e70023e84974 core (disco): fixed disco capabilities (empty disco was used)
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
105
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
106 log.info("Disco hashes loaded")
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
107
1684
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
108 d = self.persistent.load()
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
109 d.addCallback(fillHashes)
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
110 return d
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
111
1752
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
112
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
113 class Discovery(object):
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
114 """ Manage capabilities of entities """
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
115
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
116 def __init__(self, host):
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
117 self.host = host
1684
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
118 # TODO: remove legacy hashes
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
119
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
120 def load(self):
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
121 """Load persistent hashes"""
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
122 self.hashes = HashManager(persistent.PersistentDict("disco"))
373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load
Goffi <goffi@goffi.org>
parents: 1675
diff changeset
123 return self.hashes.load()
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
124
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
125 @defer.inlineCallbacks
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
126 def hasFeature(self, client, feature, jid_=None, node=""):
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
127 """Tell if an entity has the required feature
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
128
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
129 @param feature: feature namespace
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
130 @param jid_: jid of the target, or None for profile's server
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
131 @param node(unicode): optional node to use for disco request
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
132 @return: a Deferred which fire a boolean (True if feature is available)
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
133 """
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
134 disco_infos = yield self.getInfos(client, jid_, node)
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
135 defer.returnValue(feature in disco_infos.features)
951
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test
Goffi <goffi@goffi.org>
parents: 944
diff changeset
136
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test
Goffi <goffi@goffi.org>
parents: 944
diff changeset
137 @defer.inlineCallbacks
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
138 def checkFeature(self, client, feature, jid_=None, node=""):
951
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test
Goffi <goffi@goffi.org>
parents: 944
diff changeset
139 """Like hasFeature, but raise an exception is feature is not Found
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test
Goffi <goffi@goffi.org>
parents: 944
diff changeset
140
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test
Goffi <goffi@goffi.org>
parents: 944
diff changeset
141 @param feature: feature namespace
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test
Goffi <goffi@goffi.org>
parents: 944
diff changeset
142 @param jid_: jid of the target, or None for profile's server
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
143 @param node(unicode): optional node to use for disco request
951
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test
Goffi <goffi@goffi.org>
parents: 944
diff changeset
144
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test
Goffi <goffi@goffi.org>
parents: 944
diff changeset
145 @raise: exceptions.FeatureNotFound
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test
Goffi <goffi@goffi.org>
parents: 944
diff changeset
146 """
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
147 disco_infos = yield self.getInfos(client, jid_, node)
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
148 if not feature in disco_infos.features:
3156
0318802dfe28 core (memory/disco): fixed checkFeature return Failure:
Goffi <goffi@goffi.org>
parents: 3152
diff changeset
149 raise failure.Failure(exceptions.FeatureNotFound())
1491
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
150
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
151 @defer.inlineCallbacks
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
152 def checkFeatures(self, client, features, jid_=None, identity=None, node=""):
1491
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
153 """Like checkFeature, but check several features at once, and check also identity
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
154
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
155 @param features(iterable[unicode]): features to check
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
156 @param jid_(jid.JID): jid of the target, or None for profile's server
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
157 @param node(unicode): optional node to use for disco request
1491
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
158 @param identity(None, tuple(unicode, unicode): if not None, the entity must have an identity with this (category, type) tuple
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
159
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
160 @raise: exceptions.FeatureNotFound
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
161 """
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
162 disco_infos = yield self.getInfos(client, jid_, node)
1491
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
163 if not set(features).issubset(disco_infos.features):
1493
1285c714a6cc core (disco): use of failure.Failure when raising FeatureNotFound to avoid a jump in debugger in debug mode
Goffi <goffi@goffi.org>
parents: 1491
diff changeset
164 raise failure.Failure(exceptions.FeatureNotFound())
1491
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
165
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
166 if identity is not None and identity not in disco_infos.identities:
1493
1285c714a6cc core (disco): use of failure.Failure when raising FeatureNotFound to avoid a jump in debugger in debug mode
Goffi <goffi@goffi.org>
parents: 1491
diff changeset
167 raise failure.Failure(exceptions.FeatureNotFound())
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
168
3718
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
169 async def hasIdentity(
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
170 self,
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
171 client: SatXMPPEntity,
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
172 category: str,
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
173 type_: str,
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
174 jid_: Optional[jid.JID] = None,
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
175 node: str = ""
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
176 ) -> bool:
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
177 """Tell if an entity has the requested identity
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
178
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
179 @param category: identity category
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
180 @param type_: identity type
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
181 @param jid_: jid of the target, or None for profile's server
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
182 @param node(unicode): optional node to use for disco request
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
183 @return: True if the entity has the given identity
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
184 """
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
185 disco_infos = await self.getInfos(client, jid_, node)
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
186 return (category, type_) in disco_infos.identities
16e36f0dd1cb memory (disco), core (main): new `hasIdentity` method
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
187
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
188 def getInfos(self, client, jid_=None, node="", use_cache=True):
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
189 """get disco infos from jid_, filling capability hash if needed
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
190
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
191 @param jid_: jid of the target, or None for profile's server
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
192 @param node(unicode): optional node to use for disco request
2342
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
193 @param use_cache(bool): if True, use cached data if available
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
194 @return: a Deferred which fire disco.DiscoInfo
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
195 """
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
196 if jid_ is None:
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
197 jid_ = jid.JID(client.jid.host)
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
198 try:
2342
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
199 if not use_cache:
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
200 # we ignore cache, so we pretend we haven't found it
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
201 raise KeyError
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
202 cap_hash = self.host.memory.getEntityData(
3254
6cf4bd6972c2 core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents: 3250
diff changeset
203 client, jid_, [C.ENTITY_CAP_HASH]
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
204 )[C.ENTITY_CAP_HASH]
1290
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit):
Goffi <goffi@goffi.org>
parents: 1216
diff changeset
205 except (KeyError, exceptions.UnknownEntityError):
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
206 # capability hash is not available, we'll compute one
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
207 def infosCb(disco_infos):
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
208 cap_hash = self.generateHash(disco_infos)
3250
e4d3ba75b1b2 core (memory/disco): fixed types of disco extensions:
Goffi <goffi@goffi.org>
parents: 3194
diff changeset
209 for ext_form in disco_infos.extensions.values():
e4d3ba75b1b2 core (memory/disco): fixed types of disco extensions:
Goffi <goffi@goffi.org>
parents: 3194
diff changeset
210 # wokkel doesn't call typeCheck on reception, so we do it here
e4d3ba75b1b2 core (memory/disco): fixed types of disco extensions:
Goffi <goffi@goffi.org>
parents: 3194
diff changeset
211 # to avoid ending up with incorrect types. We have to do it after
e4d3ba75b1b2 core (memory/disco): fixed types of disco extensions:
Goffi <goffi@goffi.org>
parents: 3194
diff changeset
212 # the hash has been generated (str value is needed to compute the
e4d3ba75b1b2 core (memory/disco): fixed types of disco extensions:
Goffi <goffi@goffi.org>
parents: 3194
diff changeset
213 # hash)
e4d3ba75b1b2 core (memory/disco): fixed types of disco extensions:
Goffi <goffi@goffi.org>
parents: 3194
diff changeset
214 ext_form.typeCheck()
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
215 self.hashes[cap_hash] = disco_infos
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
216 self.host.memory.updateEntityData(
3254
6cf4bd6972c2 core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents: 3250
diff changeset
217 client, jid_, C.ENTITY_CAP_HASH, cap_hash
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
218 )
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
219 return disco_infos
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
220
1752
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
221 def infosEb(fail):
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
222 if fail.check(defer.CancelledError):
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
223 reason = "request time-out"
3152
7ce31f347ca3 core (memory/disco): fixed failure creation in infosEb
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
224 fail = failure.Failure(exceptions.TimeOutError(str(fail.value)))
1752
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
225 else:
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
226 try:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
227 reason = str(fail.value)
1752
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
228 except AttributeError:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
229 reason = str(fail)
2768
cb34af35af6f core (disco): client.disco.requestInfo failure are re-raised:
Goffi <goffi@goffi.org>
parents: 2765
diff changeset
230
cb34af35af6f core (disco): client.disco.requestInfo failure are re-raised:
Goffi <goffi@goffi.org>
parents: 2765
diff changeset
231 log.warning(
3194
12486cd4fa8b core (memory/disco): minor log message change
Goffi <goffi@goffi.org>
parents: 3156
diff changeset
232 "can't request disco infos from {jid}: {reason}".format(
2768
cb34af35af6f core (disco): client.disco.requestInfo failure are re-raised:
Goffi <goffi@goffi.org>
parents: 2765
diff changeset
233 jid=jid_.full(), reason=reason
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
234 )
2768
cb34af35af6f core (disco): client.disco.requestInfo failure are re-raised:
Goffi <goffi@goffi.org>
parents: 2765
diff changeset
235 )
cb34af35af6f core (disco): client.disco.requestInfo failure are re-raised:
Goffi <goffi@goffi.org>
parents: 2765
diff changeset
236
cb34af35af6f core (disco): client.disco.requestInfo failure are re-raised:
Goffi <goffi@goffi.org>
parents: 2765
diff changeset
237 # XXX we set empty disco in cache, to avoid getting an error or waiting
cb34af35af6f core (disco): client.disco.requestInfo failure are re-raised:
Goffi <goffi@goffi.org>
parents: 2765
diff changeset
238 # for a timeout again the next time
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
239 self.host.memory.updateEntityData(
3254
6cf4bd6972c2 core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents: 3250
diff changeset
240 client, jid_, C.ENTITY_CAP_HASH, CAP_HASH_ERROR
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
241 )
2768
cb34af35af6f core (disco): client.disco.requestInfo failure are re-raised:
Goffi <goffi@goffi.org>
parents: 2765
diff changeset
242 raise fail
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
243
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
244 d = client.disco.requestInfo(jid_, nodeIdentifier=node)
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
245 d.addCallback(infosCb)
1752
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
246 d.addErrback(infosEb)
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
247 return d
1290
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit):
Goffi <goffi@goffi.org>
parents: 1216
diff changeset
248 else:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit):
Goffi <goffi@goffi.org>
parents: 1216
diff changeset
249 disco_infos = self.hashes[cap_hash]
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit):
Goffi <goffi@goffi.org>
parents: 1216
diff changeset
250 return defer.succeed(disco_infos)
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
251
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
252 @defer.inlineCallbacks
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
253 def getItems(self, client, jid_=None, node="", use_cache=True):
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
254 """get disco items from jid_, cache them for our own server
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
255
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
256 @param jid_(jid.JID): jid of the target, or None for profile's server
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
257 @param node(unicode): optional node to use for disco request
2342
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
258 @param use_cache(bool): if True, use cached data if available
963
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
259 @return: a Deferred which fire disco.DiscoItems
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
260 """
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
261 if jid_ is None:
3750
193b56ef58e0 core (disco): use new `client.server_jid` property in `getItems`
Goffi <goffi@goffi.org>
parents: 3718
diff changeset
262 jid_ = client.server_jid
2407
cf9b276f4a08 core (disco): do not cache disco items when node is set
Goffi <goffi@goffi.org>
parents: 2342
diff changeset
263
3750
193b56ef58e0 core (disco): use new `client.server_jid` property in `getItems`
Goffi <goffi@goffi.org>
parents: 3718
diff changeset
264 if jid_ == client.server_jid and not node:
2407
cf9b276f4a08 core (disco): do not cache disco items when node is set
Goffi <goffi@goffi.org>
parents: 2342
diff changeset
265 # we cache items only for our own server and if node is not set
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
266 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
267 items = self.host.memory.getEntityData(
3254
6cf4bd6972c2 core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents: 3250
diff changeset
268 client, jid_, ["DISCO_ITEMS"]
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
269 )["DISCO_ITEMS"]
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
270 log.debug("[%s] disco items are in cache" % jid_.full())
2342
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
271 if not use_cache:
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
272 # we ignore cache, so we pretend we haven't found it
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
273 raise KeyError
1290
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit):
Goffi <goffi@goffi.org>
parents: 1216
diff changeset
274 except (KeyError, exceptions.UnknownEntityError):
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
275 log.debug("Caching [%s] disco items" % jid_.full())
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
276 items = yield client.disco.requestItems(jid_, nodeIdentifier=node)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
277 self.host.memory.updateEntityData(
3254
6cf4bd6972c2 core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents: 3250
diff changeset
278 client, jid_, "DISCO_ITEMS", items
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
279 )
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
280 else:
1752
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
281 try:
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
282 items = yield client.disco.requestItems(jid_, nodeIdentifier=node)
1752
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
283 except StanzaError as e:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
284 log.warning(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
285 "Error while requesting items for {jid}: {reason}".format(
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
286 jid=jid_.full(), reason=e.condition
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
287 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
288 )
1752
cbcc223c323a core (disco): display a warning when a disco info/items request failed, and return empty DiscoInfo/DiscoITems
Goffi <goffi@goffi.org>
parents: 1684
diff changeset
289 items = disco.DiscoItems()
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
290
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
291 defer.returnValue(items)
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
292
1493
1285c714a6cc core (disco): use of failure.Failure when raising FeatureNotFound to avoid a jump in debugger in debug mode
Goffi <goffi@goffi.org>
parents: 1491
diff changeset
293 def _infosEb(self, failure_, entity_jid):
1285c714a6cc core (disco): use of failure.Failure when raising FeatureNotFound to avoid a jump in debugger in debug mode
Goffi <goffi@goffi.org>
parents: 1491
diff changeset
294 failure_.trap(StanzaError)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
295 log.warning(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
296 _("Error while requesting [%(jid)s]: %(error)s")
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
297 % {"jid": entity_jid.full(), "error": failure_.getErrorMessage()}
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
298 )
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
299
2431
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
300 def findServiceEntity(self, client, category, type_, jid_=None):
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
301 """Helper method to find first available entity from findServiceEntities
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
302
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
303 args are the same as for [findServiceEntities]
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
304 @return (jid.JID, None): found entity
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
305 """
3751
073f386a191a core (memory/disco): fix hard encoded value in `findServiceEntity`
Goffi <goffi@goffi.org>
parents: 3750
diff changeset
306 d = self.host.findServiceEntities(client, category, type_)
2431
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
307 d.addCallback(lambda entities: entities.pop() if entities else None)
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
308 return d
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
309
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
310 def findServiceEntities(self, client, category, type_, jid_=None):
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
311 """Return all available items of an entity which correspond to (category, type_)
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
312
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
313 @param category: identity's category
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
314 @param type_: identitiy's type
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
315 @param jid_: the jid of the target server (None for profile's server)
1460
c7fd121a6180 core: getProfileName no raise ProfileUnknownError + minor doc fixes
Goffi <goffi@goffi.org>
parents: 1416
diff changeset
316 @return: a set of found entities
1675
fd143578fe89 plugin XEP-0065: fixed bad error handling
Goffi <goffi@goffi.org>
parents: 1552
diff changeset
317 @raise defer.CancelledError: the request timed out
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
318 """
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
319 found_entities = set()
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
320
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
321 def infosCb(infos, entity_jid):
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
322 if (category, type_) in infos.identities:
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
323 found_entities.add(entity_jid)
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
324
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
325 def gotItems(items):
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
326 defers_list = []
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
327 for item in items:
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
328 info_d = self.getInfos(client, item.entity)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
329 info_d.addCallbacks(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
330 infosCb, self._infosEb, [item.entity], None, [item.entity]
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
331 )
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
332 defers_list.append(info_d)
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
333 return defer.DeferredList(defers_list)
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
334
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
335 d = self.getItems(client, jid_)
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
336 d.addCallback(gotItems)
2765
378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext)
Goffi <goffi@goffi.org>
parents: 2712
diff changeset
337 d.addCallback(lambda __: found_entities)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
338 reactor.callLater(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
339 TIMEOUT, d.cancel
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
340 ) # FIXME: one bad service make a general timeout
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
341 return d
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
342
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
343 def findFeaturesSet(self, client, features, identity=None, jid_=None):
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
344 """Return entities (including jid_ and its items) offering features
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
345
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
346 @param features: iterable of features which must be present
3014
b6abf8af87db plugin ad-hoc D-Bus: fixed warning when no media player is found
Goffi <goffi@goffi.org>
parents: 3012
diff changeset
347 @param identity(None, tuple(unicode, unicode)): if not None, accept only this
b6abf8af87db plugin ad-hoc D-Bus: fixed warning when no media player is found
Goffi <goffi@goffi.org>
parents: 3012
diff changeset
348 (category/type) identity
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
349 @param jid_: the jid of the target server (None for profile's server)
1552
e0bde0d0b321 core (disco): use of “profile” instead of “profile_key” in several disco methods
Goffi <goffi@goffi.org>
parents: 1493
diff changeset
350 @param profile: %(doc_profile)s
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
351 @return: a set of found entities
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
352 """
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
353 if jid_ is None:
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
354 jid_ = jid.JID(client.jid.host)
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
355 features = set(features)
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
356 found_entities = set()
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
357
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
358 def infosCb(infos, entity):
2533
8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment:
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
359 if entity is None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
360 log.warning(_("received an item without jid"))
2533
8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment:
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
361 return
1491
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
362 if identity is not None and identity not in infos.identities:
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures
Goffi <goffi@goffi.org>
parents: 1484
diff changeset
363 return
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
364 if features.issubset(infos.features):
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
365 found_entities.add(entity)
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
366
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
367 def gotItems(items):
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
368 defer_list = []
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
369 for entity in [jid_] + [item.entity for item in items]:
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
370 infos_d = self.getInfos(client, entity)
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
371 infos_d.addCallbacks(infosCb, self._infosEb, [entity], None, [entity])
1484
05b821a0ff5a core (disco): fixed bad indentation resulting in bad result in findFeaturesSet
Goffi <goffi@goffi.org>
parents: 1460
diff changeset
372 defer_list.append(infos_d)
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
373 return defer.DeferredList(defer_list)
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
374
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
375 d = self.getItems(client, jid_)
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
376 d.addCallback(gotItems)
2765
378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext)
Goffi <goffi@goffi.org>
parents: 2712
diff changeset
377 d.addCallback(lambda __: found_entities)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
378 reactor.callLater(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
379 TIMEOUT, d.cancel
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
380 ) # FIXME: one bad service make a general timeout
973
4a8903021fda core (disco): findFeaturesSet and findServiceEntities don't use inlineCallbacks anymore, that allow a better error management (no more anonying debugger raise when discoInfo fails in debug mode)
Goffi <goffi@goffi.org>
parents: 963
diff changeset
381 return d
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
382
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
383 def generateHash(self, services):
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
384 """ Generate a unique hash for given service
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
385
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
386 hash algorithm is the one described in XEP-0115
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
387 @param services: iterable of disco.DiscoIdentity/disco.DiscoFeature, as returned by discoHandler.info
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
388
282
6a0c6d8e119d added plugin xep-0115: entity capabilities
Goffi <goffi@goffi.org>
parents:
diff changeset
389 """
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
390 s = []
2830
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
391 # identities
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
392 byte_identities = [
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
393 ByteIdentity(service)
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
394 for service in services
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
395 if isinstance(service, disco.DiscoIdentity)
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
396 ] # FIXME: lang must be managed here
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
397 byte_identities.sort(key=lambda i: i.lang)
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
398 byte_identities.sort(key=lambda i: i.idType)
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
399 byte_identities.sort(key=lambda i: i.category)
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
400 for identity in byte_identities:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
401 s.append(bytes(identity))
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
402 s.append(b"<")
2830
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
403 # features
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
404 byte_features = [
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
405 service.encode("utf-8")
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
406 for service in services
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
407 if isinstance(service, disco.DiscoFeature)
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
408 ]
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
409 byte_features.sort() # XXX: the default sort has the same behaviour as the requested RFC 4790 i;octet sort
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
410 for feature in byte_features:
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
411 s.append(feature)
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
412 s.append(b"<")
2830
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
413
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
414 # extensions
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
415 ext = list(services.extensions.values())
2830
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
416 ext.sort(key=lambda f: f.formNamespace.encode('utf-8'))
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
417 for extension in ext:
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
418 s.append(extension.formNamespace.encode('utf-8'))
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
419 s.append(b"<")
2830
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
420 fields = extension.fieldList
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
421 fields.sort(key=lambda f: f.var.encode('utf-8'))
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
422 for field in fields:
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
423 s.append(field.var.encode('utf-8'))
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
424 s.append(b"<")
2830
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
425 values = [v.encode('utf-8') for v in field.values]
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
426 values.sort()
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
427 for value in values:
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
428 s.append(value)
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
429 s.append(b"<")
2830
770ec685ff1f core (disco): added missing disco extensions when generating the cap hash.
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
430
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
431 cap_hash = b64encode(sha1(b"".join(s)).digest()).decode('utf-8')
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
432 log.debug(_("Capability hash generated: [{cap_hash}]").format(cap_hash=cap_hash))
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 941
diff changeset
433 return cap_hash
963
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
434
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
435 @defer.inlineCallbacks
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
436 def _discoInfos(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
437 self, entity_jid_s, node="", use_cache=True, profile_key=C.PROF_KEY_NONE
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
438 ):
3250
e4d3ba75b1b2 core (memory/disco): fixed types of disco extensions:
Goffi <goffi@goffi.org>
parents: 3194
diff changeset
439 """Discovery method for the bridge
963
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
440 @param entity_jid_s: entity we want to discover
2342
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
441 @param use_cache(bool): if True, use cached data if available
2150
91347fe95384 core(memory.disco), bridge: discoInfos and discoItems now handle node
Goffi <goffi@goffi.org>
parents: 2148
diff changeset
442 @param node(unicode): optional node to use
963
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
443
1552
e0bde0d0b321 core (disco): use of “profile” instead of “profile_key” in several disco methods
Goffi <goffi@goffi.org>
parents: 1493
diff changeset
444 @return: list of tuples
e0bde0d0b321 core (disco): use of “profile” instead of “profile_key” in several disco methods
Goffi <goffi@goffi.org>
parents: 1493
diff changeset
445 """
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
446 client = self.host.getClient(profile_key)
963
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
447 entity = jid.JID(entity_jid_s)
2342
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
448 disco_infos = yield self.getInfos(client, entity, node, use_cache)
1414
159d16336f87 core, bridge, jp: management of service discovery extensions (XEP-0128)
Goffi <goffi@goffi.org>
parents: 1409
diff changeset
449 extensions = {}
2712
c3f59c1dcb0a core (memory/disco): normalise booleans in extensions
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
450 # FIXME: should extensions be serialised using tools.common.data_format?
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
451 for form_type, form in list(disco_infos.extensions.items()):
1414
159d16336f87 core, bridge, jp: management of service discovery extensions (XEP-0128)
Goffi <goffi@goffi.org>
parents: 1409
diff changeset
452 fields = []
159d16336f87 core, bridge, jp: management of service discovery extensions (XEP-0128)
Goffi <goffi@goffi.org>
parents: 1409
diff changeset
453 for field in form.fieldList:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
454 data = {"type": field.fieldType}
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
455 for attr in ("var", "label", "desc"):
1414
159d16336f87 core, bridge, jp: management of service discovery extensions (XEP-0128)
Goffi <goffi@goffi.org>
parents: 1409
diff changeset
456 value = getattr(field, attr)
159d16336f87 core, bridge, jp: management of service discovery extensions (XEP-0128)
Goffi <goffi@goffi.org>
parents: 1409
diff changeset
457 if value is not None:
159d16336f87 core, bridge, jp: management of service discovery extensions (XEP-0128)
Goffi <goffi@goffi.org>
parents: 1409
diff changeset
458 data[attr] = value
159d16336f87 core, bridge, jp: management of service discovery extensions (XEP-0128)
Goffi <goffi@goffi.org>
parents: 1409
diff changeset
459
1416
a419da93afef core (disco): fixed bad indentation in _discoInfos (used by bridge)
Goffi <goffi@goffi.org>
parents: 1414
diff changeset
460 values = [field.value] if field.value is not None else field.values
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
461 if field.fieldType == "boolean":
3012
2224fbbd45dd memory (disco): fixed boolean to string conversion
Goffi <goffi@goffi.org>
parents: 2830
diff changeset
462 values = [C.boolConst(v) for v in values]
1416
a419da93afef core (disco): fixed bad indentation in _discoInfos (used by bridge)
Goffi <goffi@goffi.org>
parents: 1414
diff changeset
463 fields.append((data, values))
1414
159d16336f87 core, bridge, jp: management of service discovery extensions (XEP-0128)
Goffi <goffi@goffi.org>
parents: 1409
diff changeset
464
159d16336f87 core, bridge, jp: management of service discovery extensions (XEP-0128)
Goffi <goffi@goffi.org>
parents: 1409
diff changeset
465 extensions[form_type or ""] = fields
159d16336f87 core, bridge, jp: management of service discovery extensions (XEP-0128)
Goffi <goffi@goffi.org>
parents: 1409
diff changeset
466
2712
c3f59c1dcb0a core (memory/disco): normalise booleans in extensions
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
467 defer.returnValue((
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
468 [str(f) for f in disco_infos.features],
2712
c3f59c1dcb0a core (memory/disco): normalise booleans in extensions
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
469 [(cat, type_, name or "")
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
470 for (cat, type_), name in list(disco_infos.identities.items())],
2712
c3f59c1dcb0a core (memory/disco): normalise booleans in extensions
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
471 extensions))
963
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
472
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
473 def items2tuples(self, disco_items):
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
474 """convert disco items to tuple of strings
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
475
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
476 @param disco_items(iterable[disco.DiscoItem]): items
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
477 @return G(tuple[unicode,unicode,unicode]): serialised items
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
478 """
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
479 for item in disco_items:
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
480 if not item.entity:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
481 log.warning(_("invalid item (no jid)"))
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
482 continue
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
483 yield (item.entity.full(), item.nodeIdentifier or "", item.name or "")
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
484
963
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
485 @defer.inlineCallbacks
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
486 def _discoItems(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 3014
diff changeset
487 self, entity_jid_s, node="", use_cache=True, profile_key=C.PROF_KEY_NONE
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2587
diff changeset
488 ):
963
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
489 """ Discovery method for the bridge
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
490
963
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
491 @param entity_jid_s: entity we want to discover
2150
91347fe95384 core(memory.disco), bridge: discoInfos and discoItems now handle node
Goffi <goffi@goffi.org>
parents: 2148
diff changeset
492 @param node(unicode): optional node to use
2342
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
493 @param use_cache(bool): if True, use cached data if available
1552
e0bde0d0b321 core (disco): use of “profile” instead of “profile_key” in several disco methods
Goffi <goffi@goffi.org>
parents: 1493
diff changeset
494 @return: list of tuples"""
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
495 client = self.host.getClient(profile_key)
963
723f28cd15c7 core (disco): added discoInfos and discoItems bridge methods
Goffi <goffi@goffi.org>
parents: 961
diff changeset
496 entity = jid.JID(entity_jid_s)
2342
f047d5410040 core (memory/disco): added use_cache parameter to discoInfos/discoItems (set to False to ignore cache)
Goffi <goffi@goffi.org>
parents: 2150
diff changeset
497 disco_items = yield self.getItems(client, entity, node, use_cache)
2148
a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods
Goffi <goffi@goffi.org>
parents: 2096
diff changeset
498 ret = list(self.items2tuples(disco_items))
2096
efe31f0881fb core (memory/disco): recover getItems on bridge's discoItems method if an item is empty
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
499 defer.returnValue(ret)