v1.3.5

2026-08-02 18:57:40 +02:00
parent 5e5ab8681a
commit 6fa59321c0
5759 changed files with 712133 additions and 66 deletions
@@ -0,0 +1,64 @@
+########################################################################
+# File name: __init__.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/>.
+#
+########################################################################
+"""
+:mod:`~aioxmpp.shim` --- Stanza Headers and Internet Metadata (:xep:`0131`)
+###########################################################################
+
+This module provides support for :xep:`131` stanza headers. The following
+attributes are added by this module to the existing stanza classes:
+
+.. attribute:: aioxmpp.Message.xep0131_headers
+
+   A :class:`xso.Headers` instance or :data:`None`. Represents the SHIM
+   headers of the stanza.
+
+.. attribute:: aioxmpp.Presence.xep0131_headers
+
+   A :class:`xso.Headers` instance or :data:`None`. Represents the SHIM
+   headers of the stanza.
+
+The attributes are available as soon as :mod:`aioxmpp.shim` is loaded.
+
+.. currentmodule:: aioxmpp
+
+.. autoclass:: SHIMService
+
+.. currentmodule:: aioxmpp.shim
+
+.. class:: Service
+
+   Alias of :class:`.SHIMService`.
+
+   .. deprecated:: 0.8
+
+      The alias will be removed in 1.0.
+
+.. currentmodule:: aioxmpp.shim.xso
+
+.. autoclass:: Headers
+
+"""
+from . import xso  # NOQA: F401
+
+from .service import (  # NOQA: F401
+    SHIMService,
+)
@@ -0,0 +1,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 advertisement.
+
+    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])
+        )
@@ -0,0 +1,96 @@
+########################################################################
+# File name: xso.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 multidict
+
+import aioxmpp.stanza
+import aioxmpp.xso as xso
+
+from aioxmpp.utils import namespaces
+
+namespaces.xep0131_shim = "http://jabber.org/protocol/shim"
+
+
+class Header(xso.XSO):
+    TAG = (namespaces.xep0131_shim, "header")
+
+    name = xso.Attr(
+        "name",
+    )
+
+    value = xso.Text()
+
+    def __init__(self, name, value):
+        super().__init__()
+        self.name = name
+        self.value = value
+
+
+class HeaderType(xso.AbstractElementType):
+    def get_xso_types(self):
+        return [Header]
+
+    def unpack(self, v):
+        return v.name, v.value
+
+    def pack(self, v):
+        name, value = v
+        return Header(
+            name,
+            value,
+        )
+
+
+class Headers(xso.XSO):
+    """
+    Represent stanza headers. The headers are accessible at the :attr:`headers`
+    attribute.
+
+    .. attribute:: headers
+
+       A :class:`multidict.CIMultiDict` which provides access to the headers.
+       The keys are the header names and the values are the values of the
+       header. Both must be strings.
+
+    .. seealso::
+
+       :attr:`.Message.xep0131_headers`
+          SHIM headers for :class:`~.Message` stanzas
+
+       :attr:`.Presence.xep0131_headers`
+          SHIM headers for :class:`~.Presence` stanzas
+    """
+
+    TAG = (namespaces.xep0131_shim, "header")
+
+    headers = xso.ChildValueMultiMap(
+        HeaderType(),
+        mapping_type=multidict.CIMultiDict,
+    )
+
+
+aioxmpp.stanza.Message.xep0131_headers = xso.Child([
+    Headers,
+])
+
+aioxmpp.stanza.Presence.xep0131_headers = xso.Child([
+    Headers,
+])