File: shim.py

package info (click to toggle)
python-tx-xmpp 0.10.1.post1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,468 kB
  • sloc: python: 12,915; makefile: 3
file content (42 lines) | stat: -rw-r--r-- 1,192 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
# -*- test-case-name: tx_xmpp.test.test_shim -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.

"""
XMPP Stanza Headers and Internet Metadata.

This protocol is specified in
U{XEP-0131<http://xmpp.org/extensions/xep-0131.html>}.
"""

from __future__ import division, absolute_import

from twisted.words.xish import domish

NS_SHIM = "http://jabber.org/protocol/shim"


class Headers(domish.Element):
    def __init__(self, headers):
        domish.Element.__init__(self, (NS_SHIM, "headers"))
        for name, value in headers:
            self.addElement("header", content=value)["name"] = name


def extractHeaders(stanza):
    """
    Extract SHIM headers from stanza.

    @param stanza: The stanza to extract headers from.
    @type stanza: L{Element<twisted.words.xish.domish.Element>}
    @return: Headers as a mapping from header name to a list of values.
    @rtype: L{dict}
    """
    headers = {}

    for element in domish.generateElementsQNamed(stanza.children, "headers", NS_SHIM):
        for header in domish.generateElementsQNamed(element.children, "header", NS_SHIM):
            headers.setdefault(header["name"], []).append(str(header))

    return headers