Source code for

    Slixmpp: The Slick XMPP Library
    Copyright (C) 2010  Nathanael C. Fritz
    This file is part of Slixmpp.

    See the file LICENSE for copying permission.

from slixmpp.stanza.rootstanza import RootStanza
from slixmpp.xmlstream import StanzaBase, ET
from slixmpp.xmlstream.handler import Waiter, Callback
from slixmpp.xmlstream.matcher import MatchIDSender, MatcherId
from slixmpp.exceptions import IqTimeout, IqError

[docs]class Iq(RootStanza): """ XMPP <iq> stanzas, or info/query stanzas, are XMPP's method of requesting and modifying information, similar to HTTP's GET and POST methods. Each <iq> stanza must have an 'id' value which associates the stanza with the response stanza. XMPP entities must always be given a response <iq> stanza with a type of 'result' after sending a stanza of type 'get' or 'set'. Most uses cases for <iq> stanzas will involve adding a <query> element whose namespace indicates the type of information desired. However, some custom XMPP applications use <iq> stanzas as a carrier stanza for an application-specific protocol instead. Example <iq> Stanzas: <iq to="" type="get" id="314"> <query xmlns="" /> </iq> <iq to="user@localhost" type="result" id="17"> <query xmlns='jabber:iq:roster'> <item jid='' name='John Doe' subscription='both'> <group>Friends</group> </item> </query> </iq> Stanza Interface: query -- The namespace of the <query> element if one exists. Attributes: types -- May be one of: get, set, result, or error. Methods: __init__ -- Overrides StanzaBase.__init__. unhandled -- Send error if there are no handlers. set_payload -- Overrides StanzaBase.set_payload. set_query -- Add or modify a <query> element. get_query -- Return the namespace of the <query> element. del_query -- Remove the <query> element. reply -- Overrides StanzaBase.reply send -- Overrides StanzaBase.send """ namespace = 'jabber:client' name = 'iq' interfaces = set(('type', 'to', 'from', 'id', 'query')) types = set(('get', 'result', 'set', 'error')) plugin_attrib = name def __init__(self, *args, **kwargs): """ Initialize a new <iq> stanza with an 'id' value. Overrides StanzaBase.__init__. """ StanzaBase.__init__(self, *args, **kwargs) if self['id'] == '': if is not None: self['id'] = else: self['id'] = '0'
[docs] def unhandled(self): """ Send a feature-not-implemented error if the stanza is not handled. Overrides StanzaBase.unhandled. """ if self['type'] in ('get', 'set'): self.reply() self['error']['condition'] = 'feature-not-implemented' self['error']['text'] = 'No handlers registered for this request.' self.send()
[docs] def set_payload(self, value): """ Set the XML contents of the <iq> stanza. Arguments: value -- An XML object to use as the <iq> stanza's contents """ self.clear() StanzaBase.set_payload(self, value) return self
[docs] def set_query(self, value): """ Add or modify a <query> element. Query elements are differentiated by their namespace. Arguments: value -- The namespace of the <query> element. """ query = self.xml.find("{%s}query" % value) if query is None and value: plugin = self.plugin_tag_map.get('{%s}query' % value, None) if plugin: self.enable(plugin.plugin_attrib) else: self.clear() query = ET.Element("{%s}query" % value) self.xml.append(query) return self
[docs] def get_query(self): """Return the namespace of the <query> element.""" for child in self.xml: if child.tag.endswith('query'): ns = child.tag.split('}')[0] if '{' in ns: ns = ns[1:] return ns return ''
[docs] def del_query(self): """Remove the <query> element.""" for child in self.xml: if child.tag.endswith('query'): self.xml.remove(child) return self
[docs] def reply(self, clear=True): """ Send a reply <iq> stanza. Overrides StanzaBase.reply Sets the 'type' to 'result' in addition to the default StanzaBase.reply behavior. Arguments: clear -- Indicates if existing content should be removed before replying. Defaults to True. """ self['type'] = 'result' StanzaBase.reply(self, clear) return self
[docs] def send(self, callback=None, timeout=None, timeout_callback=None): """Send an <iq> stanza over the XML stream. A callback handler can be provided that will be executed when the Iq stanza's result reply is received. Overrides StanzaBase.send Arguments: callback -- Optional reference to a stream handler function. Will be executed when a reply stanza is received. timeout -- The length of time (in seconds) to wait for a response before the timeout_callback is called, instead of the regular callback timeout_callback -- Optional reference to a stream handler function. Will be executed when the timeout expires before a response has been received with the originally-sent IQ stanza. """ if matcher = MatchIDSender({ 'id': self['id'], 'self':, 'peer': self['to'] }) else: matcher = MatcherId(self['id']) if callback is not None and self['type'] in ('get', 'set'): handler_name = 'IqCallback_%s' % self['id'] if timeout_callback: self.callback = callback self.timeout_callback = timeout_callback'IqTimeout_%s' % self['id'], timeout, self._fire_timeout, repeat=False) handler = Callback(handler_name, matcher, self._handle_result, once=True) else: handler = Callback(handler_name, matcher, callback, once=True) StanzaBase.send(self) return handler_name else: return StanzaBase.send(self)
def _handle_result(self, iq): # we got the IQ, so don't fire the timeout'IqTimeout_%s' % self['id']) self.callback(iq) def _fire_timeout(self): # don't fire the handler for the IQ, if it finally does come in'IqCallback_%s' % self['id']) self.timeout_callback(self) def _set_stanza_values(self, values): """ Set multiple stanza interface values using a dictionary. Stanza plugin values may be set usind nested dictionaries. If the interface 'query' is given, then it will be set last to avoid duplication of the <query /> element. Overrides ElementBase._set_stanza_values. Arguments: values -- A dictionary mapping stanza interface with values. Plugin interfaces may accept a nested dictionary that will be used recursively. """ query = values.get('query', '') if query: del values['query'] StanzaBase._set_stanza_values(self, values) self['query'] = query else: StanzaBase._set_stanza_values(self, values) return self