File: stanzaid.py

package info (click to toggle)
python-aioxmpp 0.13.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 6,244 kB
  • sloc: python: 97,761; xml: 215; makefile: 155; sh: 63
file content (88 lines) | stat: -rw-r--r-- 2,420 bytes parent folder | download
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
########################################################################
# File name: delay.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 aioxmpp.xso as xso
from aioxmpp.utils import namespaces

from ..stanza import Message

namespaces.xep0359_stanza_ids = "urn:xmpp:sid:0"


class StanzaID(xso.XSO):
    """
    Represent a :xep:`359` Stanza ID.

    :param id_: The stanza ID to set
    :param by: The entity which has set the stanza ID
    :type by: :class:`aioxmpp.JID`

    .. attribute:: id_

        The assigned stanza ID.

    .. attribute:: by

        The entity who has assigned the stanza ID.

    .. warning::

        Stanza IDs may be spoofed. Please take the security considerations of
        :xep:`359` and the protocols using it into account.
    """
    TAG = (namespaces.xep0359_stanza_ids, "stanza-id")

    id_ = xso.Attr("id", default=None)
    by = xso.Attr("by", type_=xso.JID(), default=None)

    def __init__(self, *, id_=None, by=None, **kwargs):
        super().__init__(**kwargs)
        self.id_ = id_
        self.by = by


class OriginID(xso.XSO):
    """
    Represent a :xep:`359` Origin ID.

    :param id_: The origin ID to set

    .. attribute:: id_

        The assigned origin ID.

    .. warning::

        Origin IDs may be spoofed. Please take the security considerations of
        :xep:`359` and the protocols using it into account.
    """

    TAG = (namespaces.xep0359_stanza_ids, "origin-id")

    id_ = xso.Attr("id", default=None)

    def __init__(self, id_=None):
        super().__init__()
        self.id_ = id_


Message.xep0359_stanza_ids = xso.ChildList([StanzaID])
Message.xep0359_origin_id = xso.Child([OriginID])