libervia-backend: src/plugins/plugin_xep

annotate src/plugins/plugin_xep_0060.py @ 1466:2184d5f496b5

plugin XEP-0045: added disco announce

author	Goffi <goffi@goffi.org>
date	Tue, 18 Aug 2015 09:01:18 +0200
parents	4c4f88d7b156
children	0f0889028eea

rev	line source
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	3
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	4 # SAT plugin for Publish-Subscribe (xep-0060)
1396 069ad98b360d 2015 copyright dates update Goffi <goffi@goffi.org> parents: 1367 diff changeset	5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Jérôme Poisson (goffi@goffi.org)
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	6
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	10 # (at your option) any later version.
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	11
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	15 # GNU Affero General Public License for more details.
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	16
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	19
771 bfabeedbf32e core: i18n refactoring: Goffi <goffi@goffi.org> parents: 745 diff changeset	20 from sat.core.i18n import _
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 891 diff changeset	21 from sat.core.constants import Const as C
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	22 from sat.core.log import getLogger
301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	23 log = getLogger(__name__)
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	24
1449 389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	25 from sat.tools import sat_defer
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	26
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	27 from twisted.words.protocols.jabber import jid
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	28 from twisted.internet import defer
1449 389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	29 from wokkel import disco
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	30 # XXX: tmp.pubsub is actually use instead of wokkel version
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	31 # same thing for rsm
1449 389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	32 from wokkel import pubsub
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	33 from wokkel import rsm
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	34 from zope.interface import implements
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	35 from collections import namedtuple
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	36 import uuid
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	37
1449 389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	38 UNSPECIFIED = "unspecified error"
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	39
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	40
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	41 PLUGIN_INFO = {
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	42 "name": "Publish-Subscribe",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	43 "import_name": "XEP-0060",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	44 "type": "XEP",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	45 "protocols": ["XEP-0060"],
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	46 "dependencies": [],
1219 16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: 1217 diff changeset	47 "recommendations": ["XEP-0059"],
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	48 "main": "XEP_0060",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	49 "handler": "yes",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	50 "description": _("""Implementation of PubSub Protocol""")
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	51 }
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	52
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	53
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	54 Extra = namedtuple('Extra', ('rsm_request', 'extra'))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	55 # rsm_request is the rsm.RSMRequest build with rsm_ prefixed keys, or None
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	56 # extra is a potentially empty dict
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	57
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	58
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	59 class XEP_0060(object):
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	60 OPT_ACCESS_MODEL = 'pubsub#access_model'
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	61 OPT_PERSIST_ITEMS = 'pubsub#persist_items'
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	62 OPT_MAX_ITEMS = 'pubsub#max_items'
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	63 OPT_DELIVER_PAYLOADS = 'pubsub#deliver_payloads'
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	64 OPT_SEND_ITEM_SUBSCRIBE = 'pubsub#send_item_subscribe'
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	65 OPT_NODE_TYPE = 'pubsub#node_type'
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	66 OPT_SUBSCRIPTION_TYPE = 'pubsub#subscription_type'
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	67 OPT_SUBSCRIPTION_DEPTH = 'pubsub#subscription_depth'
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	68 OPT_ROSTER_GROUPS_ALLOWED = 'pubsub#roster_groups_allowed'
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	69 OPT_PUBLISH_MODEL = 'pubsub#publish_model'
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	70 ACCESS_OPEN = 'open'
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	71 ACCESS_PRESENCE = 'presence'
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	72 ACCESS_ROSTER = 'roster'
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	73 ACCESS_AUTHORIZE = 'authorize'
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	74 ACCESS_WHITELIST = 'whitelist'
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	75
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	76 def __init__(self, host):
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1261 diff changeset	77 log.info(_(u"PubSub plugin initialization"))
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	78 self.host = host
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	79 self._node_cb = {} # dictionnary of callbacks for node (key: node, value: list of callbacks)
1449 389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	80 self.rt_sessions = sat_defer.RTDeferredSessions()
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	81 host.bridge.addMethod("psDeleteNode", ".plugin", in_sign='sss', out_sign='', method=self._deleteNode, async=True)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	82 host.bridge.addMethod("psRetractItem", ".plugin", in_sign='sssbs', out_sign='', method=self._retractItem, async=True)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	83 host.bridge.addMethod("psRetractItems", ".plugin", in_sign='ssasbs', out_sign='', method=self._retractItems, async=True)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	84 host.bridge.addMethod("psSubscribeToMany", ".plugin", in_sign='a(ss)sa{ss}s', out_sign='s', method=self._subscribeToMany)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	85 host.bridge.addMethod("psGetSubscribeRTResult", ".plugin", in_sign='ss', out_sign='(ua(sss))', method=self._manySubscribeRTResult, async=True)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	86 host.bridge.addMethod("psGetFromMany", ".plugin", in_sign='a(ss)ia{ss}s', out_sign='s', method=self._getFromMany)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	87 host.bridge.addMethod("psGetFromManyRTResult", ".plugin", in_sign='ss', out_sign='(ua(sssasa{ss}))', method=self._getFromManyRTResult, async=True)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	88 host.bridge.addSignal("psEvent", ".plugin", signature='ssssa{ss}s') # args: category, service(jid), node, type (C.PS_ITEMS, C.PS_DELETE), data, profile
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	89
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	90 def getHandler(self, profile):
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	91 client = self.host.getClient(profile)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	92 client.pubsub_client = SatPubSubClient(self.host, self)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	93 return client.pubsub_client
1282 74d558e6c9fd plugin XEP-0060: free SatPubSubClient instance on profile disconnection souliane <souliane@mailoo.org> parents: 1268 diff changeset	94
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	95 @defer.inlineCallbacks
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	96 def profileConnected(self, profile):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	97 client = self.host.getClient(profile)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	98 pubsub_services = yield self.host.findServiceEntities("pubsub", "service", profile_key = profile)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	99 if pubsub_services:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	100 # we use one of the found services as our default pubsub service
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	101 client.pubsub_service = pubsub_services.pop()
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	102 else:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	103 client.pubsub_service = None
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	104
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	105 def parseExtra(self, extra):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	106 """Parse extra dictionnary
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	107
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	108 used bridge's extra dictionnaries
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	109 @param extra(dict): extra data used to configure request
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	110 @return(Extra): filled Extra instance
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	111 """
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	112 if extra is not None:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	113 rsm_dict = { key[4:]: value for key, value in extra.iteritems() if key.startswith('rsm_') }
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	114 if rsm_dict:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	115 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	116 rsm_dict['max_'] = rsm_dict.pop('max')
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	117 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	118 pass
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	119 rsm_request = rsm.RSMRequest(**rsm_dict)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	120 else:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	121 rsm_request = None
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	122 else:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	123 rsm_request = None
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	124 extra = {}
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	125 return Extra(rsm_request, extra)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	126
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	127 def addManagedNode(self, node, **kwargs):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	128 """Add a handler for a node
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	129
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	130 @param node(unicode): node to monitor, or None to monitor all
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	131 @param **kwargs: method(s) to call when the node is found
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	132 the methode must be named after PubSub constants in lower case
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	133 and suffixed with "_cb"
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	134 e.g.: "publish_cb" for C.PS_PUBLISH, "delete_cb" for C.PS_DELETE
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	135 """
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	136 assert kwargs
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	137 callbacks = self._node_cb.setdefault(node, {})
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	138 for event, cb in kwargs.iteritems():
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	139 event_name = event[:-3]
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	140 assert event_name in C.PS_EVENTS
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	141 callbacks.setdefault(event_name,[]).append(cb)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	142
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	143 def removeManagedNode(self, node, *args):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	144 """Add a handler for a node
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	145
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	146 @param node(unicode): node to monitor
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	147 @param *args: callback(s) to remove
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	148 """
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	149 assert args
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	150 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	151 registred_cb = self._node_cb[node]
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	152 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	153 pass
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	154 else:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	155 for callback in args:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	156 for event, cb_list in registred_cb.iteritems():
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	157 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	158 cb_list.remove(callback)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	159 except ValueError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	160 pass
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	161 else:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	162 log.debug(u"removed callback {cb} for event {event} on node {node}".format(
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	163 cb=callback, event=event, node=node))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	164 if not cb_list:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	165 del registred_cb[event]
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	166 if not registred_cb:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	167 del self._node_cb[node]
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	168 return
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	169 log.error(u"Trying to remove inexistant callback {cb} for node {node}".format(cb=callback, node=node))
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	170
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	171 # def listNodes(self, service, nodeIdentifier='', profile=C.PROF_KEY_NONE):
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	172 # """Retrieve the name of the nodes that are accessible on the target service.
1242 f584fbda4773 plugin XEP-0060: fixes listing the nodes on the pubsub service souliane <souliane@mailoo.org> parents: 1219 diff changeset	173
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	174 # @param service (JID): target service
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	175 # @param nodeIdentifier (str): the parent node name (leave empty to retrieve first-level nodes)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	176 # @param profile (str): %(doc_profile)s
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	177 # @return: deferred which fire a list of nodes
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	178 # """
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	179 # d = self.host.getDiscoItems(service, nodeIdentifier, profile_key=profile)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	180 # d.addCallback(lambda result: [item.getAttribute('node') for item in result.toElement().children if item.hasAttribute('node')])
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	181 # return d
1242 f584fbda4773 plugin XEP-0060: fixes listing the nodes on the pubsub service souliane <souliane@mailoo.org> parents: 1219 diff changeset	182
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	183 # def listSubscribedNodes(self, service, nodeIdentifier='', filter_='subscribed', profile=C.PROF_KEY_NONE):
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	184 # """Retrieve the name of the nodes to which the profile is subscribed on the target service.
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	185
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	186 # @param service (JID): target service
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	187 # @param nodeIdentifier (str): the parent node name (leave empty to retrieve all subscriptions)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	188 # @param filter_ (str): filter the result according to the given subscription type:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	189 # - None: do not filter
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	190 # - 'pending': subscription has not been approved yet by the node owner
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	191 # - 'unconfigured': subscription options have not been configured yet
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	192 # - 'subscribed': subscription is complete
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	193 # @param profile (str): %(doc_profile)s
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	194 # @return: Deferred list[str]
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	195 # """
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	196 # d = self.subscriptions(service, nodeIdentifier, profile_key=profile)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	197 # d.addCallback(lambda subs: [sub.getAttribute('node') for sub in subs if sub.getAttribute('subscription') == filter_])
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	198 # return d
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	199
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 891 diff changeset	200 def publish(self, service, nodeIdentifier, items=None, profile_key=C.PROF_KEY_NONE):
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	201 client = self.host.getClient(profile_key)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	202 return client.pubsub_client.publish(service, nodeIdentifier, items, client.pubsub_client.parent.jid)
286 3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	203
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	204 def getItems(self, service, node, max_items=None, item_ids=None, sub_id=None, rsm_request=None, extra=None, profile_key=C.PROF_KEY_NONE):
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	205 """Retrieve pubsub items from a node.
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	206
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	207 @param service (JID): pubsub service.
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	208 @param node (str): node id.
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	209 @param max_items (int): optional limit on the number of retrieved items.
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	210 @param item_ids (list[str]): identifiers of the items to be retrieved (can't be used with rsm_request).
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	211 @param sub_id (str): optional subscription identifier.
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	212 @param rsm_request (rsm.RSMRequest): RSM request data
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	213 @param profile_key (unicode): %(doc_profile_key)s
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	214 @return: a deferred couple (list[dict], dict) containing:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	215 - list of items
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	216 - metadata with the following keys:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	217 - rsm_first, rsm_last, rsm_count, rsm_index: first, last, count and index value of RSMResponse
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	218 """
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	219 if rsm_request and item_ids:
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	220 raise ValueError("items_id can't be used with rsm")
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	221 if extra is None:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	222 extra = {}
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	223 client = self.host.getClient(profile_key)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	224 ext_data = {'id': unicode(uuid.uuid4()), 'rsm': rsm_request} if rsm_request is not None else None
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	225 d = client.pubsub_client.items(service, node, max_items, item_ids, sub_id, client.pubsub_client.parent.jid, ext_data)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	226
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	227 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	228 subscribe = C.bool(extra['subscribe'])
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	229 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	230 subscribe = False
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	231
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	232 def doSubscribe(items):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	233 self.subscribe(service, node, profile_key=profile_key)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	234 return items
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	235
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	236 if subscribe:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	237 d.addCallback(doSubscribe)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	238
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	239 def addMetadata(items):
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	240 metadata = {}
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	241 if rsm_request is not None:
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	242 rsm_data = client.pubsub_client.getRSMResponse(ext_data['id'])
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	243 metadata.update({'rsm_{}'.format(key): value for key, value in rsm_data})
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	244 return (items, metadata)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	245
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	246 d.addCallback(addMetadata)
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	247 return d
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 301 diff changeset	248
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	249 # @defer.inlineCallbacks
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	250 # def getItemsFromMany(self, service, data, max_items=None, sub_id=None, rsm=None, profile_key=C.PROF_KEY_NONE):
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	251 # """Massively retrieve pubsub items from many nodes.
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	252
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	253 # @param service (JID): target service.
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	254 # @param data (dict): dictionnary binding some arbitrary keys to the node identifiers.
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	255 # @param max_items (int): optional limit on the number of retrieved items per node.
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	256 # @param sub_id (str): optional subscription identifier.
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	257 # @param rsm (dict): RSM request data
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	258 # @param profile_key (str): %(doc_profile_key)s
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	259 # @return: a deferred dict with:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	260 # - key: a value in (a subset of) data.keys()
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	261 # - couple (list[dict], dict) containing:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	262 # - list of items
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	263 # - RSM response data
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	264 # """
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	265 # client = self.host.getClient(profile_key)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	266 # found_nodes = yield self.listNodes(service, profile=client.profile)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	267 # d_dict = {}
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	268 # for publisher, node in data.items():
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	269 # if node not in found_nodes:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	270 # log.debug(u"Skip the items retrieval for [{node}]: node doesn't exist".format(node=node))
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	271 # continue # avoid pubsub "item-not-found" error
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	272 # d_dict[publisher] = self.getItems(service, node, max_items, None, sub_id, rsm, client.profile)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	273 # defer.returnValue(d_dict)
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	274
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 891 diff changeset	275 def getOptions(self, service, nodeIdentifier, subscriber, subscriptionIdentifier=None, profile_key=C.PROF_KEY_NONE):
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	276 client = self.host.getClient(profile_key)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	277 return client.pubsub_client.getOptions(service, nodeIdentifier, subscriber, subscriptionIdentifier)
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 301 diff changeset	278
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 891 diff changeset	279 def setOptions(self, service, nodeIdentifier, subscriber, options, subscriptionIdentifier=None, profile_key=C.PROF_KEY_NONE):
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	280 client = self.host.getClient(profile_key)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	281 return client.pubsub_client.setOptions(service, nodeIdentifier, subscriber, options, subscriptionIdentifier)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	282
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 891 diff changeset	283 def createNode(self, service, nodeIdentifier, options, profile_key=C.PROF_KEY_NONE):
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	284 client = self.host.getClient(profile_key)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	285 return client.pubsub_client.createNode(service, nodeIdentifier, options)
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 301 diff changeset	286
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	287 def _deleteNode(self, service_s, nodeIdentifier, profile_key):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	288 return self.deleteNode(jid.JID(service_s) if service_s else None, nodeIdentifier, profile_key)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	289
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 891 diff changeset	290 def deleteNode(self, service, nodeIdentifier, profile_key=C.PROF_KEY_NONE):
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	291 client = self.host.getClient(profile_key)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	292 return client.pubsub_client.deleteNode(service, nodeIdentifier)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	293
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	294 def _retractItem(self, service_s, nodeIdentifier, itemIdentifier, notify, profile_key):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	295 return self._retractItems(service_s, nodeIdentifier, (itemIdentifier,), notify, profile_key)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	296
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	297 def _retractItems(self, service_s, nodeIdentifier, itemIdentifiers, notify, profile_key):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	298 return self.retractItems(jid.JID(service_s) if service_s else None, nodeIdentifier, itemIdentifiers, notify, profile_key)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	299
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	300 def retractItems(self, service, nodeIdentifier, itemIdentifiers, notify=True, profile_key=C.PROF_KEY_NONE):
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	301 client = self.host.getClient(profile_key)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	302 return client.pubsub_client.retractItems(service, nodeIdentifier, itemIdentifiers, notify=True)
745 812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 704 diff changeset	303
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 891 diff changeset	304 def subscribe(self, service, nodeIdentifier, sub_jid=None, options=None, profile_key=C.PROF_KEY_NONE):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	305 # TODO: reimplement a subscribtion cache, checking that we have not subscription before trying to subscribe
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	306 client = self.host.getClient(profile_key)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	307 return client.pubsub_client.subscribe(service, nodeIdentifier, sub_jid or client.pubsub_client.parent.jid.userhostJID(), options=options)
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 301 diff changeset	308
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	309 def subscriptions(self, service, nodeIdentifier='', profile_key=C.PROF_KEY_NONE):
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	310 client = self.host.getClient(profile_key)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	311 return client.pubsub_client.subscriptions(service, nodeIdentifier)
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	312
1449 389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	313 ## methods to manage several stanzas/jids at once ##
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	314
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	315 # generic #
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	316
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	317 def getRTResults(self, session_id, on_success=None, on_error=None, profile=C.PROF_KEY_NONE):
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	318 return self.rt_sessions.getResults(session_id, on_success, on_error, profile)
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	319
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	320 def serItemsData(self, items_data, item_cb=lambda item: item.toXml()):
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	321 """Helper method to serialise result from [getItems]
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	322
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	323 the items_data must be a tuple(list[domish.Element], dict[unicode, unicode])
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	324 as returned by [getItems]. metadata values are then casted to unicode and
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	325 each item is passed to items_cb
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	326 @param items_data(tuple): tuple returned by [getItems]
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	327 @param item_cb(callable): method to transform each item
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	328 @return (tuple): a serialised form ready to go throught bridge
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	329 """
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	330 items, metadata = items_data
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	331 return [item_cb(item) for item in items], {key: unicode(value) for key, value in metadata.iteritems()}
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	332
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	333 def serItemsDataD(self, items_data, item_cb):
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	334 """Helper method to serialise result from [getItems], deferred version
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	335
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	336 the items_data must be a tuple(list[domish.Element], dict[unicode, unicode])
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	337 as returned by [getItems]. metadata values are then casted to unicode and
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	338 each item is passed to items_cb
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	339 An errback is added to item_cb, and when it is fired the value is filtered from final items
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	340 @param items_data(tuple): tuple returned by [getItems]
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	341 @param item_cb(callable): method to transform each item (must return a deferred)
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	342 @return (tuple): a deferred which fire a serialised form ready to go throught bridge
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	343 """
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	344 items, metadata = items_data
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	345 def eb(failure):
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	346 log.warning("Error while serialising/parsing item: {}".format(unicode(failure.value)))
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	347 d = defer.gatherResults([item_cb(item).addErrback(eb) for item in items])
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	348 def finishSerialisation(serialised_items):
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	349 return [item for item in serialised_items if item is not None], {key: unicode(value) for key, value in metadata.iteritems()}
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	350 d.addCallback(finishSerialisation)
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	351 return d
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	352
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	353 def serDList(self, results, failure_result=None):
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	354 """Serialise a DeferredList result
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	355
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	356 @param results: DeferredList results
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	357 @param failure_result: value to use as value for failed Deferred
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	358 (default: empty tuple)
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	359 @return (list): list with:
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	360 - failure: empty in case of success, else error message
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	361 - result
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	362 """
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	363 if failure_result is None:
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	364 failure_result = ()
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	365 return [('', result) if success else (unicode(result.result) or UNSPECIFIED, failure_result) for success, result in results]
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	366
1449 389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	367 # subscribe #
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	368
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	369 def _manySubscribeRTResult(self, session_id, profile_key=C.PROF_KEY_DEFAULT):
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	370 """Get real-time results for subcribeToManu session
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	371
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	372 @param session_id: id of the real-time deferred session
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	373 @param return (tuple): (remaining, results) where:
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	374 - remaining is the number of still expected results
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	375 - results is a list of tuple(unicode, unicode, bool, unicode) with:
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	376 - service: pubsub service
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	377 - and node: pubsub node
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	378 - failure(unicode): empty string in case of success, error message else
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	379 @param profile_key: %(doc_profile_key)s
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	380 """
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	381 profile = self.host.getClient(profile_key).profile
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	382 d = self.rt_sessions.getResults(session_id, on_success=lambda result:'', on_error=lambda failure:unicode(failure.value), profile=profile)
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	383 # we need to convert jid.JID to unicode with full() to serialise it for the bridge
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	384 d.addCallback(lambda ret: (ret[0], [(service.full(), node, '' if success else failure or UNSPECIFIED)
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	385 for (service, node), (success, failure) in ret[1].iteritems()]))
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	386 return d
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	387
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	388 def _subscribeToMany(self, node_data, subscriber=None, options=None, profile_key=C.PROF_KEY_NONE):
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	389 return self.subscribeToMany([(jid.JID(service), unicode(node)) for service, node in node_data], jid.JID(subscriber), options, profile_key)
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	390
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	391 def subscribeToMany(self, node_data, subscriber, options=None, profile_key=C.PROF_KEY_NONE):
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	392 """Subscribe to several nodes at once.
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	393
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	394 @param node_data (iterable[tuple]): iterable of tuple (service, node) where:
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	395 - service (jid.JID) is the pubsub service
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	396 - node (unicode) is the node to subscribe to
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	397 @param subscriber (jid.JID): optional subscription identifier.
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	398 @param options (dict): subscription options
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	399 @param profile_key (str): %(doc_profile_key)s
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	400 @return (str): RT Deferred session id
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	401 """
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	402 client = self.host.getClient(profile_key)
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	403 deferreds = {}
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	404 for service, node in node_data:
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	405 deferreds[(service, node)] = client.pubsub_client.subscribe(service, node, subscriber, options=options)
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	406 return self.rt_sessions.newSession(deferreds, client.profile)
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	407 # found_nodes = yield self.listNodes(service, profile=client.profile)
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	408 # subscribed_nodes = yield self.listSubscribedNodes(service, profile=client.profile)
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	409 # d_list = []
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	410 # for nodeIdentifier in (set(nodeIdentifiers) - set(subscribed_nodes)):
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	411 # if nodeIdentifier not in found_nodes:
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	412 # log.debug(u"Skip the subscription to [{node}]: node doesn't exist".format(node=nodeIdentifier))
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	413 # continue # avoid sat-pubsub "SubscriptionExists" error
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	414 # d_list.append(client.pubsub_client.subscribe(service, nodeIdentifier, sub_jid or client.pubsub_client.parent.jid.userhostJID(), options=options))
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	415 # defer.returnValue(d_list)
389357fd79ce plugin XEP-0060: use of new RTDeferredSession to subscribe many nodes at once + subscribeToMany can now subscribe on separate services Goffi <goffi@goffi.org> parents: 1446 diff changeset	416
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	417 # get #
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	418
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	419 def _getFromManyRTResult(self, session_id, profile_key=C.PROF_KEY_DEFAULT):
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	420 """Get real-time results for getFromMany session
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	421
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	422 @param session_id: id of the real-time deferred session
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	423 @param profile_key: %(doc_profile_key)s
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	424 @param return (tuple): (remaining, results) where:
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	425 - remaining is the number of still expected results
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	426 - results is a list of tuple with
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	427 - service (unicode): pubsub service
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	428 - node (unicode): pubsub node
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	429 - failure (unicode): empty string in case of success, error message else
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	430 - items (list[s]): raw XML of items
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	431 - metadata(dict): serialised metadata
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	432 """
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	433 profile = self.host.getClient(profile_key).profile
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	434 d = self.rt_sessions.getResults(session_id,
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	435 on_success=lambda result: ('', self.serItemsData(result)),
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	436 on_error=lambda failure: (unicode(failure.value) or UNSPECIFIED, ([],{})),
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	437 profile=profile)
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	438 d.addCallback(lambda ret: (ret[0],
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	439 [(service.full(), node, failure, items, metadata)
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	440 for (service, node), (success, (failure, (items, metadata))) in ret[1].iteritems()]))
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	441 return d
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	442
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	443 def _getFromMany(self, node_data, max_item=10, extra_dict=None, profile_key=C.PROF_KEY_NONE):
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	444 """
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	445 @param max_item(int): maximum number of item to get, C.NO_LIMIT for no limit
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	446 """
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	447 max_item = None if max_item == C.NO_LIMIT else max_item
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	448 extra = self.parseExtra(extra_dict)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	449 return self.getFromMany([(jid.JID(service), unicode(node)) for service, node in node_data], max_item, extra.rsm_request, extra.extra, profile_key)
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	450
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	451 def getFromMany(self, node_data, max_item=None, rsm_request=None, extra=None, profile_key=C.PROF_KEY_NONE):
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	452 """Get items from many nodes at once
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	453 @param node_data (iterable[tuple]): iterable of tuple (service, node) where:
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	454 - service (jid.JID) is the pubsub service
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	455 - node (unicode) is the node to get items from
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	456 @param max_items (int): optional limit on the number of retrieved items.
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	457 @param rsm_request (RSMRequest): RSM request data
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	458 @param profile_key (unicode): %(doc_profile_key)s
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	459 @return (str): RT Deferred session id
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	460 """
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	461 client = self.host.getClient(profile_key)
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	462 deferreds = {}
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	463 for service, node in node_data:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	464 deferreds[(service, node)] = self.getItems(service, node, max_item, rsm_request=rsm_request, extra=extra, profile_key=profile_key)
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	465 return self.rt_sessions.newSession(deferreds, client.profile)
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	466
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	467
1267 ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	468 class SatPubSubClient(rsm.PubSubClient):
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	469 implements(disco.IDisco)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	470
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	471 def __init__(self, host, parent_plugin):
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	472 self.host = host
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	473 self.parent_plugin = parent_plugin
1267 ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	474 rsm.PubSubClient.__init__(self)
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	475
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	476 def connectionInitialized(self):
1267 ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	477 rsm.PubSubClient.connectionInitialized(self)
745 812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 704 diff changeset	478
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	479 def itemsReceived(self, event):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	480 log.debug(u"Pubsub items received")
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	481 for node in (event.nodeIdentifier, None):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	482 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	483 callbacks = self.parent_plugin._node_cb[node][C.PS_ITEMS]
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	484 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	485 pass
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	486 else:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	487 for callback in callbacks:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	488 callback(event, self.parent.profile)
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	489
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	490 def deleteReceived(self, event):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	491 log.debug((u"Publish node deleted"))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	492 for node in (event.nodeIdentifier, None):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	493 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	494 callbacks = self.parent_plugin._node_cb[node][C.PS_DELETE]
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	495 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	496 pass
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	497 else:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	498 for callback in callbacks:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	499 callback(event, self.parent.profile)
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	500
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	501 def subscriptions(self, service, nodeIdentifier, sender=None):
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	502 """Return the list of subscriptions to the given service and node.
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	503
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	504 @param service: The publish subscribe service to retrieve the subscriptions from.
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	505 @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	506 @param nodeIdentifier: The identifier of the node (leave empty to retrieve all subscriptions).
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	507 @type nodeIdentifier: C{unicode}
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	508 """
1267 ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	509 request = pubsub.PubSubRequest('subscriptions')
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	510 request.recipient = service
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	511 request.nodeIdentifier = nodeIdentifier
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	512 request.sender = sender
1267 ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	513 d = request.send(self.xmlstream)
ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	514
ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	515 def cb(iq):
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	516 # FIXME: to be checked
1267 ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	517 return [sub for sub in iq.pubsub.subscriptions.elements() if
ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	518 (sub.uri == pubsub.NS_PUBSUB and sub.name == 'subscription')]
ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	519
ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	520 return d.addCallback(cb)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	521
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	522 def getDiscoInfo(self, requestor, service, nodeIdentifier=''):
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	523 disco_info = []
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	524 self.host.trigger.point("PubSub Disco Info", disco_info, self.parent.profile)
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	525 return disco_info
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	526
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	527 def getDiscoItems(self, requestor, service, nodeIdentifier=''):
1259 633fcd13a7dc plugin pubsub: fixed a bug introducted in revision 318eab3f93f8: getDiscoItems handler method which is called on disco items request, was calling getDiscoItems from host, which do a request itself, resulting in an infinite items request loop. Goffi <goffi@goffi.org> parents: 1246 diff changeset	528 return []

Mercurial > libervia-backend

annotate src/plugins/plugin_xep_0060.py @ 1466:2184d5f496b5