erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests:

Browse source 
- don't try to retrieve items from non accessible nodes
    - don't try to subscribe to non accessible or already subscribed nodes
This commit is contained in:
souliane 2014-09-22 20:49:13 +02:00
commit 812e0660a2
1 changed files with 180 additions and 99 deletions
Download patch file Download diff file Expand all files Collapse all files

144
src/plugins/plugin_xep_0060.py
View file

@ -21,9 +21,13 @@ from sat.core.i18n import _
from sat.core.constants import Const as C
from sat.core.log import getLogger
log = getLogger(__name__)
from wokkel.pubsub import PubSubRequest
from sat.memory.memory import Sessions
from wokkel import disco, pubsub
from wokkel.pubsub import PubSubRequest, NS_PUBSUB
from zope.interface import implements
from twisted.internet import defer
PLUGIN_INFO = {
"name": "Publish-Subscribe",
@ -54,17 +58,7 @@ class XEP_0060(object):
self.host = host
self.managedNodes = []
self.clients = {}
"""host.bridge.addMethod("getItems", ".plugin", in_sign='ssa{ss}s', out_sign='as', method=self.getItems,
async = True,
doc = { 'summary':'retrieve items',
'param_0':'service: pubsub service',
'param_1':'node: node identifier',
'param_2':'\n'.join(['options: can be:',
'- max_items: see XEP-0060 #6.5.7',
'- sub_id: subscription identifier, see XEP-0060 #7.2.2.2']),
'param_3':'%(doc_profile)s',
'return':'array of raw XML (content of the items)'
})"""
self.node_cache = Sessions(timeout=30, resettable_timeout=False)
def getHandler(self, profile):
self.clients[profile] = SatPubSubClient(self.host, self)
@ -97,6 +91,49 @@ class XEP_0060(object):
raise Exception(err_mess)
return profile, client
@defer.inlineCallbacks
def listNodes(self, service, nodeIdentifier='', profile=C.PROF_KEY_NONE):
"""Retrieve the name of the nodes that are accesible on the target service.
@param service (JID): target service
@param nodeIdentifier (str): the parent node name (leave empty to retrieve first-level nodes)
@param profile (str): %(doc_profile)s
@return: list[str]
"""
session_id = profile + "@found@" + service.userhost()
# FIXME: this can be called from self.subscribeToMany before the cache has been built by self.getItemsFromMany
if session_id in self.node_cache:
cache = self.node_cache.profileGet(session_id, profile)
else:
# FIXME: we arrive here while the cache is already being built...
result = yield self.getDiscoItems(service, nodeIdentifier, profile_key=profile)
node_names = [item.getAttribute('node') for item in result.toElement().children if item.hasAttribute('node')]
dummy, cache = self.node_cache.newSession(node_names, session_id=session_id, profile=profile)
defer.returnValue(cache)
@defer.inlineCallbacks
def listSubscribedNodes(self, service, nodeIdentifier='', filter='subscribed', profile=C.PROF_KEY_NONE):
"""Retrieve the name of the nodes to which the profile is subscribed on the target service.
@param service (JID): target service
@param nodeIdentifier (str): the parent node name (leave empty to retrieve all subscriptions)
@param filter (str): filter the result according to the given subscription type:
- None: do not filter
- 'pending': subscription has been approved yet by the node owner
- 'unconfigured': subscription options have not been configured yet
- 'subscribed': subscription is complete
@param profile (str): %(doc_profile)s
@return: list[str]
"""
session_id = profile + "@subscriptions@" + service.userhost()
if session_id in self.node_cache:
cache = self.node_cache.profileGet(session_id, profile)
else:
subs = yield self.subscriptions(service, nodeIdentifier, profile_key=profile)
node_names = [sub.getAttribute('node') for sub in subs if sub.getAttribute('subscription') == filter]
dummy, cache = self.node_cache.newSession(node_names, session_id=session_id, profile=profile)
defer.returnValue(cache)
def publish(self, service, nodeIdentifier, items=None, profile_key=C.PROF_KEY_NONE):
profile, client = self.__getClientNProfile(profile_key, 'publish item')
return client.publish(service, nodeIdentifier, items, client.parent.jid)
@ -105,6 +142,28 @@ class XEP_0060(object):
profile, client = self.__getClientNProfile(profile_key, 'get items')
return client.items(service, node, max_items, item_ids, sub_id, client.parent.jid)
@defer.inlineCallbacks
def getItemsFromMany(self, service, data, max_items=None, item_ids=None, sub_id=None, profile_key=C.PROF_KEY_NONE):
"""Massively retrieve pubsub items from many nodes.
@param service (JID): target service.
@param data (dict): dictionnary binding some arbitrary keys to the node identifiers.
@param max_items (int): optional limit on the number of retrieved items *per node*.
@param item_ids (list[str]): identifiers of the items to be retrieved (should not be used).
@param sub_id (str): optional subscription identifier.
@param profile_key (str): %(doc_profile_key)s
@return: dict binding a subset of the keys of data to Deferred instances.
"""
profile, client = self.__getClientNProfile(profile_key, 'get items')
found_nodes = yield self.listNodes(service, profile=profile)
d_dict = {}
for publisher, node in data.items():
if node not in found_nodes:
log.info("Skip the items retrieval for [{node}]: node doesn't exist".format(node=node))
continue # avoid pubsub "item-not-found" error
d_dict[publisher] = client.items(service, node, max_items, item_ids, sub_id, client.parent.jid)
defer.returnValue(d_dict)
def getOptions(self, service, nodeIdentifier, subscriber, subscriptionIdentifier=None, profile_key=C.PROF_KEY_NONE):
profile, client = self.__getClientNProfile(profile_key, 'get options')
return client.getOptions(service, nodeIdentifier, subscriber, subscriptionIdentifier)
@ -129,6 +188,36 @@ class XEP_0060(object):
profile, client = self.__getClientNProfile(profile_key, 'subscribe node')
return client.subscribe(service, nodeIdentifier, sub_jid or client.parent.jid.userhostJID(), options=options)
@defer.inlineCallbacks
def subscribeToMany(self, service, nodeIdentifiers, sub_jid=None, options=None, profile_key=C.PROF_KEY_NONE):
"""Massively subscribe to many nodes.
@param service (JID): target service.
@param nodeIdentifiers (list): the list of node identifiers to subscribe to.
@param sub_id (str): optional subscription identifier.
@param options (list): optional list of subscription options
@param profile_key (str): %(doc_profile_key)s
@return: dict binding a subset of the keys of data to Deferred instances.
"""
profile, client = self.__getClientNProfile(profile_key, 'subscribe nodes')
found_nodes = yield self.listNodes(service, profile=profile)
subscribed_nodes = yield self.listSubscribedNodes(service, profile=profile)
d_list = []
for nodeIdentifier in (set(nodeIdentifiers) - set(subscribed_nodes)):
if nodeIdentifier not in found_nodes:
log.info("Skip the subscription to [{node}]: node doesn't exist".format(node=nodeIdentifier))
continue # avoid sat-pubsub "SubscriptionExists" error
d_list.append(client.subscribe(service, nodeIdentifier, sub_jid or client.parent.jid.userhostJID(), options=options))
defer.returnValue(d_list)
def subscriptions(self, service, nodeIdentifier='', profile_key=C.PROF_KEY_NONE):
profile, client = self.__getClientNProfile(profile_key, 'retrieve subscriptions')
return client.subscriptions(service, nodeIdentifier)
def getDiscoItems(self, service, nodeIdentifier='', profile_key=C.PROF_KEY_NONE):
profile, client = self.__getClientNProfile(profile_key, 'disco items')
return client.getDiscoItems(None, service, nodeIdentifier)
class SatPubSubClient(pubsub.PubSubClient):
implements(disco.IDisco)
@ -158,7 +247,7 @@ class SatPubSubClient(pubsub.PubSubClient):
@param maxItems: Optional limit on the number of retrieved items.
@type maxItems: C{int}
@param itemIdentifiers: Identifiers of the items to be retracted.
@param itemIdentifiers: Identifiers of the items to be retrieved.
@type itemIdentifiers: C{set}
@param subscriptionIdentifier: Optional subscription identifier. In
@ -166,8 +255,6 @@ class SatPubSubClient(pubsub.PubSubClient):
the results to the specific subscription.
@type subscriptionIdentifier: C{unicode}
"""
NS_PUBSUB = 'http://jabber.org/protocol/pubsub'
request = PubSubRequest('items')
request.recipient = service
request.nodeIdentifier = nodeIdentifier
@ -220,12 +307,27 @@ class SatPubSubClient(pubsub.PubSubClient):
# def purgeReceived(self, event):
@defer.inlineCallbacks
def subscriptions(self, service, nodeIdentifier, sender=None):
"""Return the list of subscriptions to the given service and node.
@param service: The publish subscribe service to retrieve the subscriptions from.
@type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param nodeIdentifier: The identifier of the node (leave empty to retrieve all subscriptions).
@type nodeIdentifier: C{unicode}
"""
request = PubSubRequest('subscriptions')
request.recipient = service
request.nodeIdentifier = nodeIdentifier
request.sender = sender
iq = yield request.send(self.xmlstream)
defer.returnValue([sub for sub in iq.pubsub.subscriptions.elements() if
(sub.uri == NS_PUBSUB and sub.name == 'subscription')])
def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
_disco_info = []
self.host.trigger.point("PubSub Disco Info", _disco_info, self.parent.profile)
return _disco_info
def getDiscoInfo(self, requestor, service, nodeIdentifier=''):
disco_info = []
self.host.trigger.point("PubSub Disco Info", disco_info, self.parent.profile)
return disco_info
def getDiscoItems(self, requestor, target, nodeIdentifier=''):
return []
def getDiscoItems(self, requestor, service, nodeIdentifier=''):
return self.host.getDiscoItems(service, nodeIdentifier, self.parent.profile)