1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
########################################################################
# File name: service.py
# This file is part of: aioxmpp
#
# LICENSE
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program. If not, see
# <http://www.gnu.org/licenses/>.
#
########################################################################
import asyncio
import aioxmpp.service
from aioxmpp.utils import namespaces
class SHIMService(aioxmpp.service.Service):
"""
This service implements :xep:`131` feature advertisment.
It registers the ``http://jabber.org/protocol/shim`` node with the
:class:`.DiscoServer`. It publishes the supported headers on that node as
specified in the XEP.
To announce supported headers, use the :meth:`register_header` and
:meth:`unregister_header` methods.
.. automethod:: register_header
.. automethod:: unregister_header
.. versionchanged:: 0.8
This class was formerly known as :class:`aioxmpp.shim.Service`. It
is still available under that name, but the alias will be removed in
1.0.
"""
ORDER_AFTER = [aioxmpp.DiscoServer]
def __init__(self, client, **kwargs):
super().__init__(client, **kwargs)
self._disco = self.dependencies[aioxmpp.DiscoServer]
self._disco.register_feature(namespaces.xep0131_shim)
self._node = aioxmpp.disco.StaticNode()
self._disco.mount_node(
namespaces.xep0131_shim,
self._node
)
async def _shutdown(self):
self._disco.unregister_feature(namespaces.xep0131_shim)
self._disco.unmount_node(namespaces.xep0131_shim)
await super()._shutdown()
def register_header(self, name):
"""
Register support for the SHIM header with the given `name`.
If the header has already been registered as supported,
:class:`ValueError` is raised.
"""
self._node.register_feature(
"#".join([namespaces.xep0131_shim, name])
)
def unregister_header(self, name):
"""
Unregister support for the SHIM header with the given `name`.
If the header is currently not registered as supported,
:class:`KeyError` is raised.
"""
self._node.unregister_feature(
"#".join([namespaces.xep0131_shim, name])
)
|
