jshiffer/slixmpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

XEP-0060: wrap all iq-sending functions with coroutine_wrapper

Browse Source
This commit is contained in:
mathieui 2015-02-23 19:11:34 +01:00
parent 506ca69917
commit e85fa4203e
No known key found for this signature in database
GPG Key ID: C59F84CEEFD616E3
1 changed files with 86 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

130
slixmpp/plugins/xep_0060/pubsub.py
View File

@ -13,6 +13,7 @@ from slixmpp.xmlstream.handler import Callback
from slixmpp.xmlstream.matcher import StanzaPath from slixmpp.xmlstream.matcher import StanzaPath
from slixmpp.plugins.base import BasePlugin from slixmpp.plugins.base import BasePlugin
from slixmpp.plugins.xep_0060 import stanza from slixmpp.plugins.xep_0060 import stanza
from slixmpp import coroutine_wrapper
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
@ -151,8 +152,9 @@ class XEP_0060(BasePlugin):
""" """
self.node_event_map[node] = event_name self.node_event_map[node] = event_name
@coroutine_wrapper
def create_node(self, jid, node, config=None, ntype=None, ifrom=None, def create_node(self, jid, node, config=None, ntype=None, ifrom=None,
timeout_callback=None, callback=None, timeout=None): timeout_callback=None, callback=None, timeout=None, coroutine=False):
""" """
Create and configure a new pubsub node. Create and configure a new pubsub node.
@ -198,11 +200,13 @@ class XEP_0060(BasePlugin):
config.add_field(var='pubsub#node_type', value=ntype) config.add_field(var='pubsub#node_type', value=ntype)
iq['pubsub']['configure'].append(config) iq['pubsub']['configure'].append(config)
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def subscribe(self, jid, node, bare=True, subscribee=None, options=None, def subscribe(self, jid, node, bare=True, subscribee=None, options=None,
ifrom=None, timeout_callback=None, callback=None, ifrom=None, timeout_callback=None, callback=None,
timeout=None): timeout=None, coroutine=False):
""" """
Subscribe to updates from a pubsub node. Subscribe to updates from a pubsub node.
@ -244,11 +248,13 @@ class XEP_0060(BasePlugin):
iq['pubsub']['subscribe']['jid'] = subscribee iq['pubsub']['subscribe']['jid'] = subscribee
if options is not None: if options is not None:
iq['pubsub']['options'].append(options) iq['pubsub']['options'].append(options)
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def unsubscribe(self, jid, node, subid=None, bare=True, subscribee=None, def unsubscribe(self, jid, node, subid=None, bare=True, subscribee=None,
ifrom=None, timeout_callback=None, callback=None, ifrom=None, timeout_callback=None, callback=None,
timeout=None): timeout=None, coroutine=False):
""" """
Unubscribe from updates from a pubsub node. Unubscribe from updates from a pubsub node.
@ -291,42 +297,52 @@ class XEP_0060(BasePlugin):
iq['pubsub']['unsubscribe']['jid'] = subscribee iq['pubsub']['unsubscribe']['jid'] = subscribee
iq['pubsub']['unsubscribe']['subid'] = subid iq['pubsub']['unsubscribe']['subid'] = subid
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def get_subscriptions(self, jid, node=None, ifrom=None, def get_subscriptions(self, jid, node=None, ifrom=None,
timeout_callback=None, callback=None, timeout_callback=None, callback=None,
timeout=None): timeout=None, coroutine=False):
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get')
iq['pubsub']['subscriptions']['node'] = node iq['pubsub']['subscriptions']['node'] = node
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
def get_affiliations(self, jid, node=None, ifrom=None, @coroutine_wrapper
timeout_callback=None, callback=None, timeout=None): def get_affiliations(self, jid, node=None, ifrom=None, timeout=None,
timeout_callback=None, callback=None, coroutine=False):
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get')
iq['pubsub']['affiliations']['node'] = node iq['pubsub']['affiliations']['node'] = node
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def get_subscription_options(self, jid, node=None, user_jid=None, def get_subscription_options(self, jid, node=None, user_jid=None,
ifrom=None, timeout_callback=None, ifrom=None, timeout_callback=None,
callback=None, timeout=None): callback=None, timeout=None, coroutine=False):
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get')
if user_jid is None: if user_jid is None:
iq['pubsub']['default']['node'] = node iq['pubsub']['default']['node'] = node
else: else:
iq['pubsub']['options']['node'] = node iq['pubsub']['options']['node'] = node
iq['pubsub']['options']['jid'] = user_jid iq['pubsub']['options']['jid'] = user_jid
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def set_subscription_options(self, jid, node, user_jid, options, def set_subscription_options(self, jid, node, user_jid, options,
ifrom=None, timeout_callback=None, ifrom=None, timeout_callback=None,
callback=None, timeout=None): callback=None, timeout=None, coroutine=False):
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get')
iq['pubsub']['options']['node'] = node iq['pubsub']['options']['node'] = node
iq['pubsub']['options']['jid'] = user_jid iq['pubsub']['options']['jid'] = user_jid
iq['pubsub']['options'].append(options) iq['pubsub']['options'].append(options)
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
def get_node_config(self, jid, node=None, ifrom=None, @coroutine_wrapper
def get_node_config(self, jid, node=None, ifrom=None, coroutine=False,
timeout_callback=None, callback=None, timeout=None): timeout_callback=None, callback=None, timeout=None):
""" """
Retrieve the configuration for a node, or the pubsub service's Retrieve the configuration for a node, or the pubsub service's
@ -349,11 +365,13 @@ class XEP_0060(BasePlugin):
iq['pubsub_owner']['default'] iq['pubsub_owner']['default']
else: else:
iq['pubsub_owner']['configure']['node'] = node iq['pubsub_owner']['configure']['node'] = node
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def get_node_subscriptions(self, jid, node, ifrom=None, def get_node_subscriptions(self, jid, node, ifrom=None,
timeout_callback=None, callback=None, timeout_callback=None, callback=None,
timeout=None): timeout=None, coroutine=False):
""" """
Retrieve the subscriptions associated with a given node. Retrieve the subscriptions associated with a given node.
@ -369,10 +387,12 @@ class XEP_0060(BasePlugin):
""" """
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get')
iq['pubsub_owner']['subscriptions']['node'] = node iq['pubsub_owner']['subscriptions']['node'] = node
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def get_node_affiliations(self, jid, node, ifrom=None, timeout_callback=None, def get_node_affiliations(self, jid, node, ifrom=None, timeout_callback=None,
callback=None, timeout=None): callback=None, timeout=None, coroutine=False):
""" """
Retrieve the affiliations associated with a given node. Retrieve the affiliations associated with a given node.
@ -388,10 +408,12 @@ class XEP_0060(BasePlugin):
""" """
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='get')
iq['pubsub_owner']['affiliations']['node'] = node iq['pubsub_owner']['affiliations']['node'] = node
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def delete_node(self, jid, node, ifrom=None, timeout_callback=None, callback=None, def delete_node(self, jid, node, ifrom=None, timeout_callback=None, callback=None,
timeout=None): timeout=None, coroutine=False):
""" """
Delete a a pubsub node. Delete a a pubsub node.
@ -407,18 +429,21 @@ class XEP_0060(BasePlugin):
""" """
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='set') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='set')
iq['pubsub_owner']['delete']['node'] = node iq['pubsub_owner']['delete']['node'] = node
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
def set_node_config(self, jid, node, config, ifrom=None, def set_node_config(self, jid, node, config, ifrom=None, coroutine=False,
timeout_callback=None, callback=None, timeout=None): timeout_callback=None, callback=None, timeout=None):
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='set') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='set')
iq['pubsub_owner']['configure']['node'] = node iq['pubsub_owner']['configure']['node'] = node
iq['pubsub_owner']['configure'].append(config) iq['pubsub_owner']['configure'].append(config)
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def publish(self, jid, node, id=None, payload=None, options=None, def publish(self, jid, node, id=None, payload=None, options=None,
ifrom=None, timeout_callback=None, callback=None, ifrom=None, timeout_callback=None, callback=None,
timeout=None): timeout=None, coroutine=False):
""" """
Add a new item to a node, or edit an existing item. Add a new item to a node, or edit an existing item.
@ -453,9 +478,11 @@ class XEP_0060(BasePlugin):
if payload is not None: if payload is not None:
iq['pubsub']['publish']['item']['payload'] = payload iq['pubsub']['publish']['item']['payload'] = payload
iq['pubsub']['publish_options'] = options iq['pubsub']['publish_options'] = options
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
def retract(self, jid, node, id, notify=None, ifrom=None, @coroutine_wrapper
def retract(self, jid, node, id, notify=None, ifrom=None, coroutine=False,
timeout_callback=None, callback=None, timeout=None): timeout_callback=None, callback=None, timeout=None):
""" """
Delete a single item from a node. Delete a single item from a node.
@ -465,25 +492,30 @@ class XEP_0060(BasePlugin):
iq['pubsub']['retract']['node'] = node iq['pubsub']['retract']['node'] = node
iq['pubsub']['retract']['notify'] = notify iq['pubsub']['retract']['notify'] = notify
iq['pubsub']['retract']['item']['id'] = id iq['pubsub']['retract']['item']['id'] = id
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def purge(self, jid, node, ifrom=None, timeout_callback=None, callback=None, def purge(self, jid, node, ifrom=None, timeout_callback=None, callback=None,
timeout=None): timeout=None, coroutine=False):
""" """
Remove all items from a node. Remove all items from a node.
""" """
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='set') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='set')
iq['pubsub_owner']['purge']['node'] = node iq['pubsub_owner']['purge']['node'] = node
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def get_nodes(self, *args, **kwargs): def get_nodes(self, *args, **kwargs):
""" """
Discover the nodes provided by a Pubsub service, using disco. Discover the nodes provided by a Pubsub service, using disco.
""" """
return self.xmpp['xep_0030'].get_items(*args, **kwargs) return self.xmpp['xep_0030'].get_items(*args, **kwargs)
def get_item(self, jid, node, item_id, ifrom=None, @coroutine_wrapper
timeout_callback=None, callback=None, timeout=None): def get_item(self, jid, node, item_id, ifrom=None, timeout=None,
timeout_callback=None, callback=None, coroutine=False):
""" """
Retrieve the content of an individual item. Retrieve the content of an individual item.
""" """
@ -492,11 +524,13 @@ class XEP_0060(BasePlugin):
item['id'] = item_id item['id'] = item_id
iq['pubsub']['items']['node'] = node iq['pubsub']['items']['node'] = node
iq['pubsub']['items'].append(item) iq['pubsub']['items'].append(item)
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def get_items(self, jid, node, item_ids=None, max_items=None, def get_items(self, jid, node, item_ids=None, max_items=None,
iterator=False, ifrom=None, timeout_callback=None, iterator=False, ifrom=None, timeout_callback=None,
callback=None, timeout=None): callback=None, timeout=None, coroutine=False):
""" """
Request the contents of a node's items. Request the contents of a node's items.
@ -519,21 +553,26 @@ class XEP_0060(BasePlugin):
if iterator: if iterator:
return self.xmpp['xep_0059'].iterate(iq, 'pubsub') return self.xmpp['xep_0059'].iterate(iq, 'pubsub')
else: else:
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout,
coroutine=coroutine,
timeout_callback=timeout_callback)
@coroutine_wrapper
def get_item_ids(self, jid, node, ifrom=None, timeout_callback=None, callback=None, def get_item_ids(self, jid, node, ifrom=None, timeout_callback=None, callback=None,
timeout=None, iterator=False): timeout=None, iterator=False, coroutine=False):
""" """
Retrieve the ItemIDs hosted by a given node, using disco. Retrieve the ItemIDs hosted by a given node, using disco.
""" """
self.xmpp['xep_0030'].get_items(jid, node, ifrom=ifrom, self.xmpp['xep_0030'].get_items(jid, node, ifrom=ifrom,
callback=callback, timeout=timeout, callback=callback, timeout=timeout,
iterator=iterator, iterator=iterator,
timeout_callback=timeout_callback) timeout_callback=timeout_callback,
coroutine=coroutine)
@coroutine_wrapper
def modify_affiliations(self, jid, node, affiliations=None, ifrom=None, def modify_affiliations(self, jid, node, affiliations=None, ifrom=None,
timeout_callback=None, callback=None, timeout_callback=None, callback=None,
timeout=None): timeout=None, coroutine=False):
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='set') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='set')
iq['pubsub_owner']['affiliations']['node'] = node iq['pubsub_owner']['affiliations']['node'] = node
@ -546,11 +585,13 @@ class XEP_0060(BasePlugin):
aff['affiliation'] = affiliation aff['affiliation'] = affiliation
iq['pubsub_owner']['affiliations'].append(aff) iq['pubsub_owner']['affiliations'].append(aff)
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)
def modify_subscriptions(self, jid, node, subscriptions=None, @coroutine_wrapper
ifrom=None, timeout_callback=None, def modify_subscriptions(self, jid, node, subscriptions=None, ifrom=None,
callback=None, timeout=None): timeout_callback=None, callback=None,
timeout=None, coroutine=False):
iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='set') iq = self.xmpp.Iq(sto=jid, sfrom=ifrom, stype='set')
iq['pubsub_owner']['subscriptions']['node'] = node iq['pubsub_owner']['subscriptions']['node'] = node
@ -563,4 +604,5 @@ class XEP_0060(BasePlugin):
sub['subscription'] = subscription sub['subscription'] = subscription
iq['pubsub_owner']['subscriptions'].append(sub) iq['pubsub_owner']['subscriptions'].append(sub)
return iq.send(callback=callback, timeout=timeout, timeout_callback=timeout_callback) return iq.send(callback=callback, timeout=timeout, coroutine=coroutine,
timeout_callback=timeout_callback)