mirror of
https://github.com/correl/SleekXMPP.git
synced 2024-11-24 03:00:15 +00:00
Merge branch 'develop' into roster
This commit is contained in:
commit
23e499998f
14 changed files with 790 additions and 62 deletions
|
@ -138,7 +138,7 @@ class ClientXMPP(BaseXMPP):
|
||||||
log.debug("Session start has taken more than 15 seconds")
|
log.debug("Session start has taken more than 15 seconds")
|
||||||
self.disconnect(reconnect=self.auto_reconnect)
|
self.disconnect(reconnect=self.auto_reconnect)
|
||||||
|
|
||||||
def connect(self, address=tuple()):
|
def connect(self, address=tuple(), reattempt=True):
|
||||||
"""
|
"""
|
||||||
Connect to the XMPP server.
|
Connect to the XMPP server.
|
||||||
|
|
||||||
|
@ -148,6 +148,8 @@ class ClientXMPP(BaseXMPP):
|
||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
address -- A tuple containing the server's host and port.
|
address -- A tuple containing the server's host and port.
|
||||||
|
reattempt -- If True, reattempt the connection if an
|
||||||
|
error occurs.
|
||||||
"""
|
"""
|
||||||
self.session_started_event.clear()
|
self.session_started_event.clear()
|
||||||
if not address or len(address) < 2:
|
if not address or len(address) < 2:
|
||||||
|
@ -189,7 +191,8 @@ class ClientXMPP(BaseXMPP):
|
||||||
# If all else fails, use the server from the JID.
|
# If all else fails, use the server from the JID.
|
||||||
address = (self.boundjid.host, 5222)
|
address = (self.boundjid.host, 5222)
|
||||||
|
|
||||||
return XMLStream.connect(self, address[0], address[1], use_tls=True)
|
return XMLStream.connect(self, address[0], address[1],
|
||||||
|
use_tls=True, reattempt=reattempt)
|
||||||
|
|
||||||
def register_feature(self, mask, pointer, breaker=False):
|
def register_feature(self, mask, pointer, breaker=False):
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -120,6 +120,12 @@ class xep_0030(base_plugin):
|
||||||
'jid': {},
|
'jid': {},
|
||||||
'node': {}}
|
'node': {}}
|
||||||
|
|
||||||
|
def post_init(self):
|
||||||
|
"""Handle cross-plugin dependencies."""
|
||||||
|
base_plugin.post_init(self)
|
||||||
|
if self.xmpp['xep_0059']:
|
||||||
|
register_stanza_plugin(DiscoItems, self.xmpp['xep_0059'].stanza.Set)
|
||||||
|
|
||||||
def set_node_handler(self, htype, jid=None, node=None, handler=None):
|
def set_node_handler(self, htype, jid=None, node=None, handler=None):
|
||||||
"""
|
"""
|
||||||
Add a node handler for the given hierarchy level and
|
Add a node handler for the given hierarchy level and
|
||||||
|
@ -292,6 +298,9 @@ class xep_0030(base_plugin):
|
||||||
callback -- Optional callback to execute when a reply is
|
callback -- Optional callback to execute when a reply is
|
||||||
received instead of blocking and waiting for
|
received instead of blocking and waiting for
|
||||||
the reply.
|
the reply.
|
||||||
|
iterator -- If True, return a result set iterator using
|
||||||
|
the XEP-0059 plugin, if the plugin is loaded.
|
||||||
|
Otherwise the parameter is ignored.
|
||||||
"""
|
"""
|
||||||
if local or jid is None:
|
if local or jid is None:
|
||||||
return self._run_node_handler('get_items', jid, node, kwargs)
|
return self._run_node_handler('get_items', jid, node, kwargs)
|
||||||
|
@ -302,6 +311,9 @@ class xep_0030(base_plugin):
|
||||||
iq['to'] = jid
|
iq['to'] = jid
|
||||||
iq['type'] = 'get'
|
iq['type'] = 'get'
|
||||||
iq['disco_items']['node'] = node if node else ''
|
iq['disco_items']['node'] = node if node else ''
|
||||||
|
if kwargs.get('iterator', False) and self.xmpp['xep_0059']:
|
||||||
|
return self.xmpp['xep_0059'].iterate(iq, 'disco_items')
|
||||||
|
else:
|
||||||
return iq.send(timeout=kwargs.get('timeout', None),
|
return iq.send(timeout=kwargs.get('timeout', None),
|
||||||
block=kwargs.get('block', None),
|
block=kwargs.get('block', None),
|
||||||
callback=kwargs.get('callback', None))
|
callback=kwargs.get('callback', None))
|
||||||
|
|
10
sleekxmpp/plugins/xep_0059/__init__.py
Normal file
10
sleekxmpp/plugins/xep_0059/__init__.py
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
"""
|
||||||
|
SleekXMPP: The Sleek XMPP Library
|
||||||
|
Copyright (C) 2010 Nathanael C. Fritz, Erik Reuterborg Larsson
|
||||||
|
This file is part of SleekXMPP.
|
||||||
|
|
||||||
|
See the file LICENSE for copying permission.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from sleekxmpp.plugins.xep_0059.stanza import Set
|
||||||
|
from sleekxmpp.plugins.xep_0059.rsm import ResultIterator, xep_0059
|
119
sleekxmpp/plugins/xep_0059/rsm.py
Normal file
119
sleekxmpp/plugins/xep_0059/rsm.py
Normal file
|
@ -0,0 +1,119 @@
|
||||||
|
"""
|
||||||
|
SleekXMPP: The Sleek XMPP Library
|
||||||
|
Copyright (C) 2010 Nathanael C. Fritz, Erik Reuterborg Larsson
|
||||||
|
This file is part of SleekXMPP.
|
||||||
|
|
||||||
|
See the file LICENSE for copying permission.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import sleekxmpp
|
||||||
|
from sleekxmpp import Iq
|
||||||
|
from sleekxmpp.plugins.base import base_plugin
|
||||||
|
from sleekxmpp.xmlstream import register_stanza_plugin
|
||||||
|
from sleekxmpp.plugins.xep_0059 import Set
|
||||||
|
|
||||||
|
|
||||||
|
log = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class ResultIterator():
|
||||||
|
|
||||||
|
"""
|
||||||
|
An iterator for Result Set Managment
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, query, interface, amount=10, start=None, reverse=False):
|
||||||
|
"""
|
||||||
|
Arguments:
|
||||||
|
query -- The template query
|
||||||
|
interface -- The substanza of the query, for example disco_items
|
||||||
|
amount -- The max amounts of items to request per iteration
|
||||||
|
start -- From which item id to start
|
||||||
|
reverse -- If True, page backwards through the results
|
||||||
|
|
||||||
|
Example:
|
||||||
|
q = Iq()
|
||||||
|
q['to'] = 'pubsub.example.com'
|
||||||
|
q['disco_items']['node'] = 'blog'
|
||||||
|
for i in ResultIterator(q, 'disco_items', '10'):
|
||||||
|
print i['disco_items']['items']
|
||||||
|
|
||||||
|
"""
|
||||||
|
self.query = query
|
||||||
|
self.amount = amount
|
||||||
|
self.start = start
|
||||||
|
self.interface = interface
|
||||||
|
self.reverse = reverse
|
||||||
|
|
||||||
|
def __iter__(self):
|
||||||
|
return self
|
||||||
|
|
||||||
|
def __next__(self):
|
||||||
|
return self.next()
|
||||||
|
|
||||||
|
def next(self):
|
||||||
|
"""
|
||||||
|
Return the next page of results from a query.
|
||||||
|
|
||||||
|
Note: If using backwards paging, then the next page of
|
||||||
|
results will be the items before the current page
|
||||||
|
of items.
|
||||||
|
"""
|
||||||
|
self.query[self.interface]['rsm']['before'] = self.reverse
|
||||||
|
self.query['id'] = self.query.stream.new_id()
|
||||||
|
self.query[self.interface]['rsm']['max'] = str(self.amount)
|
||||||
|
|
||||||
|
if self.start and self.reverse:
|
||||||
|
self.query[self.interface]['rsm']['before'] = self.start
|
||||||
|
elif self.start:
|
||||||
|
self.query[self.interface]['rsm']['after'] = self.start
|
||||||
|
|
||||||
|
r = self.query.send(block=True)
|
||||||
|
|
||||||
|
if not r or not r[self.interface]['rsm']['first'] and \
|
||||||
|
not r[self.interface]['rsm']['last']:
|
||||||
|
raise StopIteration
|
||||||
|
|
||||||
|
if self.reverse:
|
||||||
|
self.start = r[self.interface]['rsm']['first']
|
||||||
|
else:
|
||||||
|
self.start = r[self.interface]['rsm']['last']
|
||||||
|
|
||||||
|
return r
|
||||||
|
|
||||||
|
|
||||||
|
class xep_0059(base_plugin):
|
||||||
|
|
||||||
|
"""
|
||||||
|
XEP-0050: Result Set Management
|
||||||
|
"""
|
||||||
|
|
||||||
|
def plugin_init(self):
|
||||||
|
"""
|
||||||
|
Start the XEP-0059 plugin.
|
||||||
|
"""
|
||||||
|
self.xep = '0059'
|
||||||
|
self.description = 'Result Set Management'
|
||||||
|
self.stanza = sleekxmpp.plugins.xep_0059.stanza
|
||||||
|
|
||||||
|
def post_init(self):
|
||||||
|
"""Handle inter-plugin dependencies."""
|
||||||
|
base_plugin.post_init(self)
|
||||||
|
self.xmpp['xep_0030'].add_feature(Set.namespace)
|
||||||
|
|
||||||
|
def iterate(self, stanza, interface):
|
||||||
|
"""
|
||||||
|
Create a new result set iterator for a given stanza query.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
stanza -- A stanza object to serve as a template for
|
||||||
|
queries made each iteration. For example, a
|
||||||
|
basic disco#items query.
|
||||||
|
interface -- The name of the substanza to which the
|
||||||
|
result set management stanza should be
|
||||||
|
appended. For example, for disco#items queries
|
||||||
|
the interface 'disco_items' should be used.
|
||||||
|
"""
|
||||||
|
return ResultIterator(stanza, interface)
|
108
sleekxmpp/plugins/xep_0059/stanza.py
Normal file
108
sleekxmpp/plugins/xep_0059/stanza.py
Normal file
|
@ -0,0 +1,108 @@
|
||||||
|
"""
|
||||||
|
SleekXMPP: The Sleek XMPP Library
|
||||||
|
Copyright (C) 2010 Nathanael C. Fritz, Erik Reuterborg Larsson
|
||||||
|
This file is part of SleekXMPP.
|
||||||
|
|
||||||
|
See the file LICENSE for copying permission.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from sleekxmpp.xmlstream import ElementBase, ET
|
||||||
|
from sleekxmpp.plugins.xep_0030.stanza.items import DiscoItems
|
||||||
|
|
||||||
|
|
||||||
|
class Set(ElementBase):
|
||||||
|
|
||||||
|
"""
|
||||||
|
XEP-0059 (Result Set Managment) can be used to manage the
|
||||||
|
results of queries. For example, limiting the number of items
|
||||||
|
per response or starting at certain positions.
|
||||||
|
|
||||||
|
Example set stanzas:
|
||||||
|
<iq type="get">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<max>2</max>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
<iq type="result">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<item jid="conference.example.com" />
|
||||||
|
<item jid="pubsub.example.com" />
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<first>conference.example.com</first>
|
||||||
|
<last>pubsub.example.com</last>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Stanza Interface:
|
||||||
|
first_index -- The index attribute of <first>
|
||||||
|
after -- The id defining from which item to start
|
||||||
|
before -- The id defining from which item to
|
||||||
|
start when browsing backwards
|
||||||
|
max -- Max amount per response
|
||||||
|
first -- Id for the first item in the response
|
||||||
|
last -- Id for the last item in the response
|
||||||
|
index -- Used to set an index to start from
|
||||||
|
count -- The number of remote items available
|
||||||
|
|
||||||
|
Methods:
|
||||||
|
set_first_index -- Sets the index attribute for <first> and
|
||||||
|
creates the element if it doesn't exist
|
||||||
|
get_first_index -- Returns the value of the index
|
||||||
|
attribute for <first>
|
||||||
|
del_first_index -- Removes the index attribute for <first>
|
||||||
|
but keeps the element
|
||||||
|
set_before -- Sets the value of <before>, if the value is True
|
||||||
|
then the element will be created without a value
|
||||||
|
get_before -- Returns the value of <before>, if it is
|
||||||
|
empty it will return True
|
||||||
|
|
||||||
|
"""
|
||||||
|
namespace = 'http://jabber.org/protocol/rsm'
|
||||||
|
name = 'set'
|
||||||
|
plugin_attrib = 'rsm'
|
||||||
|
sub_interfaces = set(('first', 'after', 'before', 'count',
|
||||||
|
'index', 'last', 'max'))
|
||||||
|
interfaces = set(('first_index', 'first', 'after', 'before',
|
||||||
|
'count', 'index', 'last', 'max'))
|
||||||
|
|
||||||
|
def set_first_index(self, val):
|
||||||
|
fi = self.find("{%s}first" % (self.namespace))
|
||||||
|
if fi is not None:
|
||||||
|
if val:
|
||||||
|
fi.attrib['index'] = val
|
||||||
|
else:
|
||||||
|
del fi.attrib['index']
|
||||||
|
elif val:
|
||||||
|
fi = ET.Element("{%s}first" % (self.namespace))
|
||||||
|
fi.attrib['index'] = val
|
||||||
|
self.xml.append(fi)
|
||||||
|
|
||||||
|
def get_first_index(self):
|
||||||
|
fi = self.find("{%s}first" % (self.namespace))
|
||||||
|
if fi is not None:
|
||||||
|
return fi.attrib.get('index', '')
|
||||||
|
|
||||||
|
def del_first_index(self):
|
||||||
|
fi = self.xml.find("{%s}first" % (self.namespace))
|
||||||
|
if fi is not None:
|
||||||
|
del fi.attrib['index']
|
||||||
|
|
||||||
|
def set_before(self, val):
|
||||||
|
b = self.xml.find("{%s}before" % (self.namespace))
|
||||||
|
if b is None and val == True:
|
||||||
|
self._set_sub_text('{%s}before' % self.namespace, '', True)
|
||||||
|
else:
|
||||||
|
self._set_sub_text('{%s}before' % self.namespace, val)
|
||||||
|
|
||||||
|
def get_before(self):
|
||||||
|
b = self.xml.find("{%s}before" % (self.namespace))
|
||||||
|
if b is not None and not b.text:
|
||||||
|
return True
|
||||||
|
elif b is not None:
|
||||||
|
return b.text
|
||||||
|
else:
|
||||||
|
return None
|
|
@ -1,56 +0,0 @@
|
||||||
"""
|
|
||||||
SleekXMPP: The Sleek XMPP Library
|
|
||||||
Copyright (C) 2010 Nathanael C. Fritz
|
|
||||||
This file is part of SleekXMPP.
|
|
||||||
|
|
||||||
See the file LICENSE for copying permission.
|
|
||||||
"""
|
|
||||||
from xml.etree import cElementTree as ET
|
|
||||||
from . import base
|
|
||||||
from .. xmlstream.handler.xmlwaiter import XMLWaiter
|
|
||||||
|
|
||||||
class xep_0092(base.base_plugin):
|
|
||||||
"""
|
|
||||||
XEP-0092 Software Version
|
|
||||||
"""
|
|
||||||
def plugin_init(self):
|
|
||||||
self.description = "Software Version"
|
|
||||||
self.xep = "0092"
|
|
||||||
self.name = self.config.get('name', 'SleekXMPP')
|
|
||||||
self.version = self.config.get('version', '0.1-dev')
|
|
||||||
self.xmpp.add_handler("<iq type='get' xmlns='%s'><query xmlns='jabber:iq:version' /></iq>" % self.xmpp.default_ns, self.report_version, name='Sofware Version')
|
|
||||||
|
|
||||||
def post_init(self):
|
|
||||||
base.base_plugin.post_init(self)
|
|
||||||
self.xmpp.plugin['xep_0030'].add_feature('jabber:iq:version')
|
|
||||||
|
|
||||||
def report_version(self, xml):
|
|
||||||
iq = self.xmpp.makeIqResult(xml.get('id', 'unknown'))
|
|
||||||
iq.attrib['to'] = xml.get('from', self.xmpp.server)
|
|
||||||
query = ET.Element('{jabber:iq:version}query')
|
|
||||||
name = ET.Element('name')
|
|
||||||
name.text = self.name
|
|
||||||
version = ET.Element('version')
|
|
||||||
version.text = self.version
|
|
||||||
query.append(name)
|
|
||||||
query.append(version)
|
|
||||||
iq.append(query)
|
|
||||||
self.xmpp.send(iq)
|
|
||||||
|
|
||||||
def getVersion(self, jid):
|
|
||||||
iq = self.xmpp.makeIqGet()
|
|
||||||
query = ET.Element('{jabber:iq:version}query')
|
|
||||||
iq.append(query)
|
|
||||||
iq.attrib['to'] = jid
|
|
||||||
iq.attrib['from'] = self.xmpp.boundjid.full
|
|
||||||
id = iq.get('id')
|
|
||||||
result = iq.send()
|
|
||||||
if result and result is not None and result.get('type', 'error') != 'error':
|
|
||||||
qry = result.find('{jabber:iq:version}query')
|
|
||||||
version = {}
|
|
||||||
for child in qry.getchildren():
|
|
||||||
version[child.tag.split('}')[-1]] = child.text
|
|
||||||
return version
|
|
||||||
else:
|
|
||||||
return False
|
|
||||||
|
|
11
sleekxmpp/plugins/xep_0092/__init__.py
Normal file
11
sleekxmpp/plugins/xep_0092/__init__.py
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
"""
|
||||||
|
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.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from sleekxmpp.plugins.xep_0092 import stanza
|
||||||
|
from sleekxmpp.plugins.xep_0092.stanza import Version
|
||||||
|
from sleekxmpp.plugins.xep_0092.version import xep_0092
|
42
sleekxmpp/plugins/xep_0092/stanza.py
Normal file
42
sleekxmpp/plugins/xep_0092/stanza.py
Normal file
|
@ -0,0 +1,42 @@
|
||||||
|
"""
|
||||||
|
SleekXMPP: The Sleek XMPP Library
|
||||||
|
Copyright (C) 2010 Nathanael C. Fritz
|
||||||
|
This file is part of SleekXMPP.
|
||||||
|
|
||||||
|
See the file LICENSE for copying permission.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from sleekxmpp.xmlstream import ElementBase, ET
|
||||||
|
|
||||||
|
|
||||||
|
class Version(ElementBase):
|
||||||
|
|
||||||
|
"""
|
||||||
|
XMPP allows for an agent to advertise the name and version of the
|
||||||
|
underlying software libraries, as well as the operating system
|
||||||
|
that the agent is running on.
|
||||||
|
|
||||||
|
Example version stanzas:
|
||||||
|
<iq type="get">
|
||||||
|
<query xmlns="jabber:iq:version" />
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
<iq type="result">
|
||||||
|
<query xmlns="jabber:iq:version">
|
||||||
|
<name>SleekXMPP</name>
|
||||||
|
<version>1.0</version>
|
||||||
|
<os>Linux</os>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Stanza Interface:
|
||||||
|
name -- The human readable name of the software.
|
||||||
|
version -- The specific version of the software.
|
||||||
|
os -- The name of the operating system running the program.
|
||||||
|
"""
|
||||||
|
|
||||||
|
name = 'query'
|
||||||
|
namespace = 'jabber:iq:version'
|
||||||
|
plugin_attrib = 'software_version'
|
||||||
|
interfaces = set(('name', 'version', 'os'))
|
||||||
|
sub_interfaces = interfaces
|
88
sleekxmpp/plugins/xep_0092/version.py
Normal file
88
sleekxmpp/plugins/xep_0092/version.py
Normal file
|
@ -0,0 +1,88 @@
|
||||||
|
"""
|
||||||
|
SleekXMPP: The Sleek XMPP Library
|
||||||
|
Copyright (C) 2010 Nathanael C. Fritz
|
||||||
|
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.xmlstream.handler import Callback
|
||||||
|
from sleekxmpp.xmlstream.matcher import StanzaPath
|
||||||
|
from sleekxmpp.plugins.base import base_plugin
|
||||||
|
from sleekxmpp.plugins.xep_0092 import Version
|
||||||
|
|
||||||
|
|
||||||
|
log = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class xep_0092(base_plugin):
|
||||||
|
|
||||||
|
"""
|
||||||
|
XEP-0092: Software Version
|
||||||
|
"""
|
||||||
|
|
||||||
|
def plugin_init(self):
|
||||||
|
"""
|
||||||
|
Start the XEP-0092 plugin.
|
||||||
|
"""
|
||||||
|
self.xep = "0092"
|
||||||
|
self.description = "Software Version"
|
||||||
|
self.stanza = sleekxmpp.plugins.xep_0092.stanza
|
||||||
|
|
||||||
|
self.name = self.config.get('name', 'SleekXMPP')
|
||||||
|
self.version = self.config.get('version', '0.1-dev')
|
||||||
|
self.os = self.config.get('os', '')
|
||||||
|
|
||||||
|
self.getVersion = self.get_version
|
||||||
|
|
||||||
|
self.xmpp.register_handler(
|
||||||
|
Callback('Software Version',
|
||||||
|
StanzaPath('iq/software_version'),
|
||||||
|
self._handle_version))
|
||||||
|
|
||||||
|
register_stanza_plugin(Iq, Version)
|
||||||
|
|
||||||
|
def post_init(self):
|
||||||
|
"""
|
||||||
|
Handle cross-plugin dependencies.
|
||||||
|
"""
|
||||||
|
base_plugin.post_init(self)
|
||||||
|
self.xmpp.plugin['xep_0030'].add_feature('jabber:iq:version')
|
||||||
|
|
||||||
|
def _handle_version(self, iq):
|
||||||
|
"""
|
||||||
|
Respond to a software version query.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
iq -- The Iq stanza containing the software version query.
|
||||||
|
"""
|
||||||
|
iq.reply()
|
||||||
|
iq['software_version']['name'] = self.name
|
||||||
|
iq['software_version']['version'] = self.version
|
||||||
|
iq['software_version']['os'] = self.os
|
||||||
|
iq.send()
|
||||||
|
|
||||||
|
def get_version(self, jid, ifrom=None):
|
||||||
|
"""
|
||||||
|
Retrieve the software version of a remote agent.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
jid -- The JID of the entity to query.
|
||||||
|
"""
|
||||||
|
iq = self.xmpp.Iq()
|
||||||
|
iq['to'] = jid
|
||||||
|
if ifrom:
|
||||||
|
iq['from'] = ifrom
|
||||||
|
iq['type'] = 'get'
|
||||||
|
iq['query'] = Version.namespace
|
||||||
|
|
||||||
|
result = iq.send()
|
||||||
|
|
||||||
|
if result and result['type'] != 'error':
|
||||||
|
return result['software_version']._get_stanza_values()
|
||||||
|
return False
|
|
@ -124,3 +124,9 @@ class JID(object):
|
||||||
|
|
||||||
def __repr__(self):
|
def __repr__(self):
|
||||||
return str(self)
|
return str(self)
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
"""
|
||||||
|
Two JIDs are considered equal if they have the same full JID value.
|
||||||
|
"""
|
||||||
|
return str(other) == str(self)
|
||||||
|
|
106
tests/test_stanza_xep_0059.py
Normal file
106
tests/test_stanza_xep_0059.py
Normal file
|
@ -0,0 +1,106 @@
|
||||||
|
from sleekxmpp.test import *
|
||||||
|
from sleekxmpp.plugins.xep_0059 import Set
|
||||||
|
|
||||||
|
|
||||||
|
class TestSetStanzas(SleekTest):
|
||||||
|
|
||||||
|
def testSetFirstIndex(self):
|
||||||
|
s = Set()
|
||||||
|
s['first'] = 'id'
|
||||||
|
s.set_first_index('10')
|
||||||
|
self.check(s, """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<first index="10">id</first>
|
||||||
|
</set>
|
||||||
|
""")
|
||||||
|
|
||||||
|
def testGetFirstIndex(self):
|
||||||
|
xml_string = """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<first index="10">id</first>
|
||||||
|
</set>
|
||||||
|
"""
|
||||||
|
s = Set(ET.fromstring(xml_string))
|
||||||
|
expected = '10'
|
||||||
|
self.failUnless(s['first_index'] == expected)
|
||||||
|
|
||||||
|
def testDelFirstIndex(self):
|
||||||
|
xml_string = """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<first index="10">id</first>
|
||||||
|
</set>
|
||||||
|
"""
|
||||||
|
s = Set(ET.fromstring(xml_string))
|
||||||
|
del s['first_index']
|
||||||
|
self.check(s, """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<first>id</first>
|
||||||
|
</set>
|
||||||
|
""")
|
||||||
|
|
||||||
|
def testSetBefore(self):
|
||||||
|
s = Set()
|
||||||
|
s['before'] = True
|
||||||
|
self.check(s, """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<before />
|
||||||
|
</set>
|
||||||
|
""")
|
||||||
|
|
||||||
|
def testGetBefore(self):
|
||||||
|
xml_string = """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<before />
|
||||||
|
</set>
|
||||||
|
"""
|
||||||
|
s = Set(ET.fromstring(xml_string))
|
||||||
|
expected = True
|
||||||
|
self.failUnless(s['before'] == expected)
|
||||||
|
|
||||||
|
def testGetBefore(self):
|
||||||
|
xml_string = """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<before />
|
||||||
|
</set>
|
||||||
|
"""
|
||||||
|
s = Set(ET.fromstring(xml_string))
|
||||||
|
del s['before']
|
||||||
|
self.check(s, """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
</set>
|
||||||
|
""")
|
||||||
|
|
||||||
|
def testSetBeforeVal(self):
|
||||||
|
s = Set()
|
||||||
|
s['before'] = 'id'
|
||||||
|
self.check(s, """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<before>id</before>
|
||||||
|
</set>
|
||||||
|
""")
|
||||||
|
|
||||||
|
def testGetBeforeVal(self):
|
||||||
|
xml_string = """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<before>id</before>
|
||||||
|
</set>
|
||||||
|
"""
|
||||||
|
s = Set(ET.fromstring(xml_string))
|
||||||
|
expected = 'id'
|
||||||
|
self.failUnless(s['before'] == expected)
|
||||||
|
|
||||||
|
def testGetBeforeVal(self):
|
||||||
|
xml_string = """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<before>id</before>
|
||||||
|
</set>
|
||||||
|
"""
|
||||||
|
s = Set(ET.fromstring(xml_string))
|
||||||
|
del s['before']
|
||||||
|
self.check(s, """
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
</set>
|
||||||
|
""")
|
||||||
|
|
||||||
|
|
||||||
|
suite = unittest.TestLoader().loadTestsFromTestCase(TestSetStanzas)
|
|
@ -1,3 +1,4 @@
|
||||||
|
import sys
|
||||||
import time
|
import time
|
||||||
import threading
|
import threading
|
||||||
|
|
||||||
|
@ -11,6 +12,7 @@ class TestStreamDisco(SleekTest):
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def tearDown(self):
|
def tearDown(self):
|
||||||
|
sys.excepthook = sys.__excepthook__
|
||||||
self.stream_close()
|
self.stream_close()
|
||||||
|
|
||||||
def testInfoEmptyDefaultNode(self):
|
def testInfoEmptyDefaultNode(self):
|
||||||
|
@ -524,5 +526,51 @@ class TestStreamDisco(SleekTest):
|
||||||
self.assertEqual(results, items,
|
self.assertEqual(results, items,
|
||||||
"Unexpected items: %s" % results)
|
"Unexpected items: %s" % results)
|
||||||
|
|
||||||
|
def testGetItemsIterator(self):
|
||||||
|
"""Test interaction between XEP-0030 and XEP-0059 plugins."""
|
||||||
|
|
||||||
|
raised_exceptions = []
|
||||||
|
|
||||||
|
def catch_exception(*args, **kwargs):
|
||||||
|
raised_exceptions.append(True)
|
||||||
|
|
||||||
|
sys.excepthook = catch_exception
|
||||||
|
|
||||||
|
self.stream_start(mode='client',
|
||||||
|
plugins=['xep_0030', 'xep_0059'])
|
||||||
|
|
||||||
|
results = self.xmpp['xep_0030'].get_items(jid='foo@localhost',
|
||||||
|
node='bar',
|
||||||
|
iterator=True)
|
||||||
|
results.amount = 10
|
||||||
|
|
||||||
|
t = threading.Thread(name="get_items_iterator",
|
||||||
|
target=results.next)
|
||||||
|
t.start()
|
||||||
|
|
||||||
|
self.send("""
|
||||||
|
<iq id="2" type="get" to="foo@localhost">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items"
|
||||||
|
node="bar">
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<max>10</max>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.recv("""
|
||||||
|
<iq id="2" type="result" to="tester@localhost">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
|
||||||
|
t.join()
|
||||||
|
|
||||||
|
self.assertEqual(raised_exceptions, [True],
|
||||||
|
"StopIteration was not raised: %s" % raised_exceptions)
|
||||||
|
|
||||||
|
|
||||||
suite = unittest.TestLoader().loadTestsFromTestCase(TestStreamDisco)
|
suite = unittest.TestLoader().loadTestsFromTestCase(TestStreamDisco)
|
||||||
|
|
162
tests/test_stream_xep_0059.py
Normal file
162
tests/test_stream_xep_0059.py
Normal file
|
@ -0,0 +1,162 @@
|
||||||
|
import threading
|
||||||
|
|
||||||
|
from sleekxmpp.test import *
|
||||||
|
from sleekxmpp.xmlstream import register_stanza_plugin
|
||||||
|
from sleekxmpp.plugins.xep_0030 import DiscoItems
|
||||||
|
from sleekxmpp.plugins.xep_0059 import ResultIterator, Set
|
||||||
|
|
||||||
|
|
||||||
|
class TestStreamSet(SleekTest):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
register_stanza_plugin(DiscoItems, Set)
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.stream_close()
|
||||||
|
|
||||||
|
def iter(self, rev=False):
|
||||||
|
q = self.xmpp.Iq()
|
||||||
|
q['type'] = 'get'
|
||||||
|
it = ResultIterator(q, 'disco_items', '1', reverse=rev)
|
||||||
|
for i in it:
|
||||||
|
for j in i['disco_items']['items']:
|
||||||
|
self.items.append(j[0])
|
||||||
|
|
||||||
|
def testResultIterator(self):
|
||||||
|
self.items = []
|
||||||
|
self.stream_start(mode='client')
|
||||||
|
t = threading.Thread(target=self.iter)
|
||||||
|
t.start()
|
||||||
|
self.send("""
|
||||||
|
<iq type="get" id="2">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<max>1</max>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.recv("""
|
||||||
|
<iq type="result" id="2">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<item jid="item1" />
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<last>item1</last>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.send("""
|
||||||
|
<iq type="get" id="3">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<max>1</max>
|
||||||
|
<after>item1</after>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.recv("""
|
||||||
|
<iq type="result" id="3">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<item jid="item2" />
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<last>item2</last>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.send("""
|
||||||
|
<iq type="get" id="4">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<max>1</max>
|
||||||
|
<after>item2</after>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.recv("""
|
||||||
|
<iq type="result" id="4">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<item jid="item2" />
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
t.join()
|
||||||
|
self.failUnless(self.items == ['item1', 'item2'])
|
||||||
|
|
||||||
|
def testResultIteratorReverse(self):
|
||||||
|
self.items = []
|
||||||
|
self.stream_start(mode='client')
|
||||||
|
|
||||||
|
t = threading.Thread(target=self.iter, args=(True,))
|
||||||
|
t.start()
|
||||||
|
|
||||||
|
self.send("""
|
||||||
|
<iq type="get" id="2">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<max>1</max>
|
||||||
|
<before />
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.recv("""
|
||||||
|
<iq type="result" id="2">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<item jid="item2" />
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<first>item2</first>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.send("""
|
||||||
|
<iq type="get" id="3">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<max>1</max>
|
||||||
|
<before>item2</before>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.recv("""
|
||||||
|
<iq type="result" id="3">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<item jid="item1" />
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<first>item1</first>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.send("""
|
||||||
|
<iq type="get" id="4">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
<max>1</max>
|
||||||
|
<before>item1</before>
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
self.recv("""
|
||||||
|
<iq type="result" id="4">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<item jid="item1" />
|
||||||
|
<set xmlns="http://jabber.org/protocol/rsm">
|
||||||
|
</set>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
|
||||||
|
t.join()
|
||||||
|
self.failUnless(self.items == ['item2', 'item1'])
|
||||||
|
|
||||||
|
|
||||||
|
suite = unittest.TestLoader().loadTestsFromTestCase(TestStreamSet)
|
69
tests/test_stream_xep_0092.py
Normal file
69
tests/test_stream_xep_0092.py
Normal file
|
@ -0,0 +1,69 @@
|
||||||
|
import threading
|
||||||
|
|
||||||
|
from sleekxmpp.test import *
|
||||||
|
|
||||||
|
|
||||||
|
class TestStreamSet(SleekTest):
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.stream_close()
|
||||||
|
|
||||||
|
def testHandleSoftwareVersionRequest(self):
|
||||||
|
self.stream_start(mode='client', plugins=['xep_0030', 'xep_0092'])
|
||||||
|
|
||||||
|
self.xmpp['xep_0092'].name = 'SleekXMPP'
|
||||||
|
self.xmpp['xep_0092'].version = 'dev'
|
||||||
|
self.xmpp['xep_0092'].os = 'Linux'
|
||||||
|
|
||||||
|
self.recv("""
|
||||||
|
<iq type="get" id="1">
|
||||||
|
<query xmlns="jabber:iq:version" />
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
|
||||||
|
self.send("""
|
||||||
|
<iq type="result" id="1">
|
||||||
|
<query xmlns="jabber:iq:version">
|
||||||
|
<name>SleekXMPP</name>
|
||||||
|
<version>dev</version>
|
||||||
|
<os>Linux</os>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
|
||||||
|
def testMakeSoftwareVersionRequest(self):
|
||||||
|
results = []
|
||||||
|
|
||||||
|
def query():
|
||||||
|
r = self.xmpp['xep_0092'].get_version('foo@bar')
|
||||||
|
results.append(r)
|
||||||
|
|
||||||
|
self.stream_start(mode='client', plugins=['xep_0030', 'xep_0092'])
|
||||||
|
|
||||||
|
t = threading.Thread(target=query)
|
||||||
|
t.start()
|
||||||
|
|
||||||
|
self.send("""
|
||||||
|
<iq type="get" id="1" to="foo@bar">
|
||||||
|
<query xmlns="jabber:iq:version" />
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
|
||||||
|
self.recv("""
|
||||||
|
<iq type="result" id="1" from="foo@bar" to="tester@localhost">
|
||||||
|
<query xmlns="jabber:iq:version">
|
||||||
|
<name>Foo</name>
|
||||||
|
<version>1.0</version>
|
||||||
|
<os>Linux</os>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
""")
|
||||||
|
|
||||||
|
t.join()
|
||||||
|
|
||||||
|
expected = [{'name': 'Foo', 'version': '1.0', 'os':'Linux'}]
|
||||||
|
self.assertEqual(results, expected,
|
||||||
|
"Did not receive expected results: %s" % results)
|
||||||
|
|
||||||
|
|
||||||
|
suite = unittest.TestLoader().loadTestsFromTestCase(TestStreamSet)
|
Loading…
Reference in a new issue