d979b5f2b9
New plugin configuration options:
use_cache - Enable caching disco info results. Defaults to True
wrap_results - Always return disco results in an Iq stanza. Defaults
to False
Node handler changes:
Handlers now take four arguments: jid, node, ifrom, data
Most older style handlers will still work, depending on if they
raise a TypeError for incorrect number of arguments. Handlers that
used *args may not work.
New get_info options:
cached - Passing cached=True to get_info() will attempt to load
results from the cache. If nothing is found, a query
will be sent as normal. If set to False, the cache
will be skipped, even if it contains results.
New method:
supports() - Given a JID/node pair and a feature, return True
if the feature is supported, False if not, and
None if there was a timeout. By default, the search
will use the cache.
101 lines
3.3 KiB
Python
101 lines
3.3 KiB
Python
"""
|
|
SleekXMPP: The Sleek XMPP Library
|
|
Copyright (C) 2010 Nathanael C. Fritz, Lance J.T. Stout
|
|
This file is part of SleekXMPP.
|
|
|
|
See the file LICENSE for copying permission.
|
|
"""
|
|
|
|
import logging
|
|
|
|
import sleekxmpp
|
|
from sleekxmpp import Iq
|
|
from sleekxmpp.xmlstream import register_stanza_plugin
|
|
from sleekxmpp.plugins.base import base_plugin
|
|
from sleekxmpp.plugins.xep_0004 import Form
|
|
from sleekxmpp.plugins.xep_0030 import DiscoInfo
|
|
from sleekxmpp.plugins.xep_0128 import StaticExtendedDisco
|
|
|
|
|
|
class xep_0128(base_plugin):
|
|
|
|
"""
|
|
XEP-0128: Service Discovery Extensions
|
|
|
|
Allow the use of data forms to add additional identity
|
|
information to disco#info results.
|
|
|
|
Also see <http://www.xmpp.org/extensions/xep-0128.html>.
|
|
|
|
Attributes:
|
|
disco -- A reference to the XEP-0030 plugin.
|
|
static -- Object containing the default set of static
|
|
node handlers.
|
|
xmpp -- The main SleekXMPP object.
|
|
|
|
Methods:
|
|
set_extended_info -- Set extensions to a disco#info result.
|
|
add_extended_info -- Add an extension to a disco#info result.
|
|
del_extended_info -- Remove all extensions from a disco#info result.
|
|
"""
|
|
|
|
def plugin_init(self):
|
|
"""Start the XEP-0128 plugin."""
|
|
self.xep = '0128'
|
|
self.description = 'Service Discovery Extensions'
|
|
|
|
self._disco_ops = ['set_extended_info',
|
|
'add_extended_info',
|
|
'del_extended_info']
|
|
|
|
register_stanza_plugin(DiscoInfo, Form, iterable=True)
|
|
|
|
def post_init(self):
|
|
"""Handle cross-plugin dependencies."""
|
|
base_plugin.post_init(self)
|
|
self.disco = self.xmpp['xep_0030']
|
|
self.static = StaticExtendedDisco(self.disco.static)
|
|
|
|
self.disco.set_extended_info = self.set_extended_info
|
|
self.disco.add_extended_info = self.add_extended_info
|
|
self.disco.del_extended_info = self.del_extended_info
|
|
|
|
for op in self._disco_ops:
|
|
self.disco._add_disco_op(op, getattr(self.static, op))
|
|
|
|
def set_extended_info(self, jid=None, node=None, **kwargs):
|
|
"""
|
|
Set additional, extended identity information to a node.
|
|
|
|
Replaces any existing extended information.
|
|
|
|
Arguments:
|
|
jid -- The JID to modify.
|
|
node -- The node to modify.
|
|
data -- Either a form, or a list of forms to use
|
|
as extended information, replacing any
|
|
existing extensions.
|
|
"""
|
|
self.disco._run_node_handler('set_extended_info', jid, node, None, kwargs)
|
|
|
|
def add_extended_info(self, jid=None, node=None, **kwargs):
|
|
"""
|
|
Add additional, extended identity information to a node.
|
|
|
|
Arguments:
|
|
jid -- The JID to modify.
|
|
node -- The node to modify.
|
|
data -- Either a form, or a list of forms to add
|
|
as extended information.
|
|
"""
|
|
self.disco._run_node_handler('add_extended_info', jid, node, None, kwargs)
|
|
|
|
def del_extended_info(self, jid=None, node=None, **kwargs):
|
|
"""
|
|
Remove all extended identity information to a node.
|
|
|
|
Arguments:
|
|
jid -- The JID to modify.
|
|
node -- The node to modify.
|
|
"""
|
|
self.disco._run_node_handler('del_extended_info', jid, node, None, kwargs)
|