libervia-backend: sat/plugins/plugin_xep

annotate sat/plugins/plugin_xep_0060.py @ 4043:9641ce286e07

core (main): if `keep_id` is set in `action_new`, use it as `action_id`

author	Goffi <goffi@goffi.org>
date	Mon, 15 May 2023 16:20:58 +0200
parents	524856bd7b19
children

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1 #!/usr/bin/env python3
3137 559a625a236b fixed shebangs Goffi <goffi@goffi.org> parents: 3136 diff changeset	2
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	3 # SàT plugin for Publish-Subscribe (xep-0060)
3479 be6d91572633 date update Goffi <goffi@goffi.org> parents: 3468 diff changeset	4 # Copyright (C) 2009-2021 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	5
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	6 # 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	7 # 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	8 # 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	9 # (at your option) any later version.
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	10
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	11 # 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	12 # 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	13 # 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	14 # 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	15
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	16 # 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	17 # 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	18
3062 93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	19
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	20 from collections import namedtuple
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	21 from functools import reduce
3934 e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	22 from typing import Any, Callable, Dict, Iterable, List, Optional, Set, Tuple, Union
3815 853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	23 import urllib.error
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	24 import urllib.parse
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	25 import urllib.request
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	26
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	27 from twisted.internet import defer, reactor
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	28 from twisted.words.protocols.jabber import error, jid
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	29 from twisted.words.xish import domish
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	30 from wokkel import disco
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	31 from wokkel import data_form
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
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	34 from wokkel import mam
3815 853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	35 from zope.interface import implementer
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	36
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	37 from sat.core import exceptions
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	38 from sat.core.constants import Const as C
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	39 from sat.core.core_types import SatXMPPEntity
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	40 from sat.core.i18n import _
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	41 from sat.core.log import getLogger
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	42 from sat.core.xmpp import SatXMPPClient
3588 2c7a52a62be3 plugin XEP-0060: events callbacks can now be sync or async Goffi <goffi@goffi.org> parents: 3587 diff changeset	43 from sat.tools import utils
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	44 from sat.tools import sat_defer
3394 23af257ae780 plugin XEP-0060: use `xml_tools.parse` instead of `wokkel.generic.parseXml`: Goffi <goffi@goffi.org> parents: 3312 diff changeset	45 from sat.tools import xml_tools
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	46 from sat.tools.common import data_format
3062 93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	47
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	48
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	49 log = getLogger(__name__)
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	50
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	51 PLUGIN_INFO = {
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	52 C.PI_NAME: "Publish-Subscribe",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	53 C.PI_IMPORT_NAME: "XEP-0060",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	54 C.PI_TYPE: "XEP",
3726 33d75cd3c371 plugin XEP-0060, XEP-0163, XEP-0277, text syntaxes: make those plugins usable with components Goffi <goffi@goffi.org> parents: 3723 diff changeset	55 C.PI_MODES: C.PLUG_MODE_BOTH,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	56 C.PI_PROTOCOLS: ["XEP-0060"],
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	57 C.PI_DEPENDENCIES: [],
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	58 C.PI_RECOMMENDATIONS: ["XEP-0059", "XEP-0313"],
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	59 C.PI_MAIN: "XEP_0060",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	60 C.PI_HANDLER: "yes",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	61 C.PI_DESCRIPTION: _("""Implementation of PubSub Protocol"""),
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	62 }
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	63
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	64 UNSPECIFIED = "unspecified error"
8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	65
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	66
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	67 Extra = namedtuple("Extra", ("rsm_request", "extra"))
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	68 # 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	69 # extra is a potentially empty dict
2769 9282b289b964 plugin XEP-0060: set a 30s timeout on items get Goffi <goffi@goffi.org> parents: 2760 diff changeset	70 TIMEOUT = 30
3756 aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	71 # minimum features that a pubsub service must have to be selectable as default
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	72 DEFAULT_PUBSUB_MIN_FEAT = {
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	73 'http://jabber.org/protocol/pubsub#persistent-items',
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	74 'http://jabber.org/protocol/pubsub#publish',
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	75 'http://jabber.org/protocol/pubsub#retract-items',
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	76 }
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	77
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	78 class XEP_0060(object):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	79 OPT_ACCESS_MODEL = "pubsub#access_model"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	80 OPT_PERSIST_ITEMS = "pubsub#persist_items"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	81 OPT_MAX_ITEMS = "pubsub#max_items"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	82 OPT_DELIVER_PAYLOADS = "pubsub#deliver_payloads"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	83 OPT_SEND_ITEM_SUBSCRIBE = "pubsub#send_item_subscribe"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	84 OPT_NODE_TYPE = "pubsub#node_type"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	85 OPT_SUBSCRIPTION_TYPE = "pubsub#subscription_type"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	86 OPT_SUBSCRIPTION_DEPTH = "pubsub#subscription_depth"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	87 OPT_ROSTER_GROUPS_ALLOWED = "pubsub#roster_groups_allowed"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	88 OPT_PUBLISH_MODEL = "pubsub#publish_model"
3468 36cac8e6f57d plugin XEP-0060: added constants for overwrite policy configuration option Goffi <goffi@goffi.org> parents: 3467 diff changeset	89 OPT_OVERWRITE_POLICY = "pubsub#overwrite_policy"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	90 ACCESS_OPEN = "open"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	91 ACCESS_PRESENCE = "presence"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	92 ACCESS_ROSTER = "roster"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	93 ACCESS_PUBLISHER_ROSTER = "publisher-roster"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	94 ACCESS_AUTHORIZE = "authorize"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	95 ACCESS_WHITELIST = "whitelist"
3451 f37e6e78db12 plugin XEP-0060: add constants for common values of publish model Goffi <goffi@goffi.org> parents: 3394 diff changeset	96 PUBLISH_MODEL_PUBLISHERS = "publishers"
f37e6e78db12 plugin XEP-0060: add constants for common values of publish model Goffi <goffi@goffi.org> parents: 3394 diff changeset	97 PUBLISH_MODEL_SUBSCRIBERS = "subscribers"
f37e6e78db12 plugin XEP-0060: add constants for common values of publish model Goffi <goffi@goffi.org> parents: 3394 diff changeset	98 PUBLISH_MODEL_OPEN = "open"
3468 36cac8e6f57d plugin XEP-0060: added constants for overwrite policy configuration option Goffi <goffi@goffi.org> parents: 3467 diff changeset	99 OWPOL_ORIGINAL = "original_publisher"
36cac8e6f57d plugin XEP-0060: added constants for overwrite policy configuration option Goffi <goffi@goffi.org> parents: 3467 diff changeset	100 OWPOL_ANY_PUB = "any_publisher"
2647 1bf7e89fded0 plugin XEP-0060: added singleton ID ("current") Goffi <goffi@goffi.org> parents: 2643 diff changeset	101 ID_SINGLETON = "current"
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	102 EXTRA_PUBLISH_OPTIONS = "publish_options"
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	103 EXTRA_ON_PRECOND_NOT_MET = "on_precondition_not_met"
3597 5d108ce026d7 plugin pubsub cache: Pubsub Caching implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	104 # extra disco needed for RSM, cf. XEP-0060 § 6.5.4
5d108ce026d7 plugin pubsub cache: Pubsub Caching implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	105 DISCO_RSM = "http://jabber.org/protocol/pubsub#rsm"
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	106
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	107 def __init__(self, host):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	108 log.info(_("PubSub plugin initialization"))
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	109 self.host = host
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	110 self._rsm = host.plugins.get("XEP-0059")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	111 self._mam = host.plugins.get("XEP-0313")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	112 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	113 self.rt_sessions = sat_defer.RTDeferredSessions()
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	114 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	115 "ps_node_create",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	116 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	117 in_sign="ssa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	118 out_sign="s",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	119 method=self._create_node,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	120 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	121 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	122 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	123 "ps_node_configuration_get",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	124 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	125 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	126 out_sign="a{ss}",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	127 method=self._get_node_configuration,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	128 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	129 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	130 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	131 "ps_node_configuration_set",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	132 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	133 in_sign="ssa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	134 out_sign="",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	135 method=self._set_node_configuration,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	136 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	137 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	138 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	139 "ps_node_affiliations_get",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	140 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	141 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	142 out_sign="a{ss}",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	143 method=self._get_node_affiliations,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	144 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	145 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	146 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	147 "ps_node_affiliations_set",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	148 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	149 in_sign="ssa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	150 out_sign="",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	151 method=self._set_node_affiliations,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	152 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	153 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	154 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	155 "ps_node_subscriptions_get",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	156 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	157 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	158 out_sign="a{ss}",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	159 method=self._get_node_subscriptions,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	160 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	161 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	162 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	163 "ps_node_subscriptions_set",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	164 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	165 in_sign="ssa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	166 out_sign="",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	167 method=self._set_node_subscriptions,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	168 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	169 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	170 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	171 "ps_node_purge",
2801 ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	172 ".plugin",
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	173 in_sign="sss",
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	174 out_sign="",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	175 method=self._purge_node,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	176 async_=True,
2801 ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	177 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	178 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	179 "ps_node_delete",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	180 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	181 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	182 out_sign="",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	183 method=self._delete_node,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	184 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	185 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	186 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	187 "ps_node_watch_add",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	188 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	189 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	190 out_sign="",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	191 method=self._addWatch,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	192 async_=False,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	193 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	194 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	195 "ps_node_watch_remove",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	196 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	197 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	198 out_sign="",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	199 method=self._remove_watch,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	200 async_=False,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	201 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	202 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	203 "ps_affiliations_get",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	204 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	205 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	206 out_sign="a{ss}",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	207 method=self._get_affiliations,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	208 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	209 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	210 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	211 "ps_items_get",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	212 ".plugin",
3586 5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict Goffi <goffi@goffi.org> parents: 3584 diff changeset	213 in_sign="ssiassss",
3312 77177b13ff54 plugin XEP-0060: serialise psItemsGet result with data_format Goffi <goffi@goffi.org> parents: 3308 diff changeset	214 out_sign="s",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	215 method=self._get_items,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	216 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	217 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	218 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	219 "ps_item_send",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	220 ".plugin",
3100 cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3069 diff changeset	221 in_sign="ssssss",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	222 out_sign="s",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	223 method=self._send_item,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	224 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	225 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	226 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	227 "ps_items_send",
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	228 ".plugin",
3100 cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3069 diff changeset	229 in_sign="ssasss",
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	230 out_sign="as",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	231 method=self._send_items,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	232 async_=True,
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	233 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	234 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	235 "ps_item_retract",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	236 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	237 in_sign="sssbs",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	238 out_sign="",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	239 method=self._retract_item,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	240 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	241 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	242 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	243 "ps_items_retract",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	244 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	245 in_sign="ssasbs",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	246 out_sign="",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	247 method=self._retract_items,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	248 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	249 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	250 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	251 "ps_item_rename",
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	252 ".plugin",
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	253 in_sign="sssss",
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	254 out_sign="",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	255 method=self._rename_item,
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	256 async_=True,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	257 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	258 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	259 "ps_subscribe",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	260 ".plugin",
3757 5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	261 in_sign="ssss",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	262 out_sign="s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	263 method=self._subscribe,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	264 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	265 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	266 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	267 "ps_unsubscribe",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	268 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	269 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	270 out_sign="",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	271 method=self._unsubscribe,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	272 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	273 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	274 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	275 "ps_subscriptions_get",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	276 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	277 in_sign="sss",
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	278 out_sign="s",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	279 method=self._subscriptions,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	280 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	281 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	282 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	283 "ps_subscribe_to_many",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	284 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	285 in_sign="a(ss)sa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	286 out_sign="s",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	287 method=self._subscribe_to_many,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	288 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	289 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	290 "ps_get_subscribe_rt_result",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	291 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	292 in_sign="ss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	293 out_sign="(ua(sss))",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	294 method=self._many_subscribe_rt_result,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	295 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	296 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	297 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	298 "ps_get_from_many",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	299 ".plugin",
3586 5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict Goffi <goffi@goffi.org> parents: 3584 diff changeset	300 in_sign="a(ss)iss",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	301 out_sign="s",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	302 method=self._get_from_many,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	303 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	304 host.bridge.add_method(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	305 "ps_get_from_many_rt_result",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	306 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	307 in_sign="ss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	308 out_sign="(ua(sssasa{ss}))",
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	309 method=self._get_from_many_rt_result,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	310 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	311 )
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	312
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	313 # high level observer method
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	314 host.bridge.add_signal(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	315 "ps_event", ".plugin", signature="ssssss"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	316 ) # 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	317
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	318 # low level observer method, used if service/node is in watching list (see psNodeWatch* methods)
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	319 host.bridge.add_signal(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	320 "ps_event_raw", ".plugin", signature="sssass"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	321 ) # args: service(jid), node, type (C.PS_ITEMS, C.PS_DELETE), list of item_xml, profile
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	322
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	323 def get_handler(self, client):
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	324 client.pubsub_client = SatPubSubClient(self.host, self)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	325 return client.pubsub_client
1282 74d558e6c9fd plugin XEP-0060: free SatPubSubClient instance on profile disconnection souliane <souliane@mailoo.org> parents: 1268 diff changeset	326
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	327 async def profile_connected(self, client):
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	328 client.pubsub_watching = set()
2459 a9c092bf4ee9 plugin XEP-0060: added an config option to set pubsub service Goffi <goffi@goffi.org> parents: 2444 diff changeset	329 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	330 client.pubsub_service = jid.JID(
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	331 self.host.memory.config_get("", "pubsub_service")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	332 )
2459 a9c092bf4ee9 plugin XEP-0060: added an config option to set pubsub service Goffi <goffi@goffi.org> parents: 2444 diff changeset	333 except RuntimeError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	334 log.info(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	335 _(
3756 aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	336 "Can't retrieve pubsub_service from conf, we'll use first one that "
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	337 "we find"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	338 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	339 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	340 pubsub_services = await self.host.find_service_entities(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	341 client, "pubsub", "service"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	342 )
3756 aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	343 for service_jid in pubsub_services:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	344 infos = await self.host.memory.disco.get_infos(client, service_jid)
3756 aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	345 if not DEFAULT_PUBSUB_MIN_FEAT.issubset(infos.features):
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	346 continue
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	347 names = {(n or "").lower() for n in infos.identities.values()}
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	348 if "libervia pubsub service" in names:
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	349 # this is the name of Libervia's side project pubsub service, we know
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	350 # that it is a suitable default pubsub service
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	351 client.pubsub_service = service_jid
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	352 break
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	353 categories = {(i[0] or "").lower() for i in infos.identities.keys()}
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	354 if "gateway" in categories or "gateway" in names:
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	355 # we don't want to use a gateway as default pubsub service
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	356 continue
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	357 if "jabber:iq:register" in infos.features:
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	358 # may be present on gateways, and we don't want a service
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	359 # where registration is needed
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	360 continue
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	361 client.pubsub_service = service_jid
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	362 break
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	363 else:
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	364 client.pubsub_service = None
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	365 pubsub_service_str = (
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	366 client.pubsub_service.full() if client.pubsub_service else "PEP"
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	367 )
aa923e6b369f plugin XEP-0060: better filtering when looking for default pubsub service Goffi <goffi@goffi.org> parents: 3737 diff changeset	368 log.info(f"default pubsub service: {pubsub_service_str}")
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	369
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	370 def features_get(self, profile):
1483 0f0889028eea plugin XEP-0060: implemented getFeatures, data has a "service" key if service is found for this profile Goffi <goffi@goffi.org> parents: 1459 diff changeset	371 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	372 client = self.host.get_client(profile)
1483 0f0889028eea plugin XEP-0060: implemented getFeatures, data has a "service" key if service is found for this profile Goffi <goffi@goffi.org> parents: 1459 diff changeset	373 except exceptions.ProfileNotSetError:
0f0889028eea plugin XEP-0060: implemented getFeatures, data has a "service" key if service is found for this profile Goffi <goffi@goffi.org> parents: 1459 diff changeset	374 return {}
0f0889028eea plugin XEP-0060: implemented getFeatures, data has a "service" key if service is found for this profile Goffi <goffi@goffi.org> parents: 1459 diff changeset	375 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	376 return {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	377 "service": client.pubsub_service.full()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	378 if client.pubsub_service is not None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	379 else ""
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	380 }
1483 0f0889028eea plugin XEP-0060: implemented getFeatures, data has a "service" key if service is found for this profile Goffi <goffi@goffi.org> parents: 1459 diff changeset	381 except AttributeError:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	382 if self.host.is_connected(profile):
1483 0f0889028eea plugin XEP-0060: implemented getFeatures, data has a "service" key if service is found for this profile Goffi <goffi@goffi.org> parents: 1459 diff changeset	383 log.debug("Profile is not connected, service is not checked yet")
0f0889028eea plugin XEP-0060: implemented getFeatures, data has a "service" key if service is found for this profile Goffi <goffi@goffi.org> parents: 1459 diff changeset	384 else:
0f0889028eea plugin XEP-0060: implemented getFeatures, data has a "service" key if service is found for this profile Goffi <goffi@goffi.org> parents: 1459 diff changeset	385 log.error("Service should be available !")
0f0889028eea plugin XEP-0060: implemented getFeatures, data has a "service" key if service is found for this profile Goffi <goffi@goffi.org> parents: 1459 diff changeset	386 return {}
0f0889028eea plugin XEP-0060: implemented getFeatures, data has a "service" key if service is found for this profile Goffi <goffi@goffi.org> parents: 1459 diff changeset	387
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	388 def parse_extra(self, extra):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	389 """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	390
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	391 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	392 @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	393 @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	394 """
2484 785b6a1cef0a plugin forums: first draft: Goffi <goffi@goffi.org> parents: 2483 diff changeset	395 if extra is None:
785b6a1cef0a plugin forums: first draft: Goffi <goffi@goffi.org> parents: 2483 diff changeset	396 rsm_request = None
785b6a1cef0a plugin forums: first draft: Goffi <goffi@goffi.org> parents: 2483 diff changeset	397 extra = {}
785b6a1cef0a plugin forums: first draft: Goffi <goffi@goffi.org> parents: 2483 diff changeset	398 else:
2760 3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	399 # order-by
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	400 if C.KEY_ORDER_BY in extra:
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	401 # FIXME: we temporarily manage only one level of ordering
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	402 # we need to switch to a fully serialised extra data
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	403 # to be able to encode a whole ordered list
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	404 extra[C.KEY_ORDER_BY] = [extra.pop(C.KEY_ORDER_BY)]
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	405
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	406 # rsm
2702 6555e9835ff8 plugin XEP-0060: use new parseExtra methods from MAM and RSM Goffi <goffi@goffi.org> parents: 2647 diff changeset	407 if self._rsm is None:
6555e9835ff8 plugin XEP-0060: use new parseExtra methods from MAM and RSM Goffi <goffi@goffi.org> parents: 2647 diff changeset	408 rsm_request = None
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	409 else:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	410 rsm_request = self._rsm.parse_extra(extra)
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	411
8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	412 # mam
2702 6555e9835ff8 plugin XEP-0060: use new parseExtra methods from MAM and RSM Goffi <goffi@goffi.org> parents: 2647 diff changeset	413 if self._mam is None:
6555e9835ff8 plugin XEP-0060: use new parseExtra methods from MAM and RSM Goffi <goffi@goffi.org> parents: 2647 diff changeset	414 mam_request = None
6555e9835ff8 plugin XEP-0060: use new parseExtra methods from MAM and RSM Goffi <goffi@goffi.org> parents: 2647 diff changeset	415 else:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	416 mam_request = self._mam.parse_extra(extra, with_rsm=False)
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	417
2702 6555e9835ff8 plugin XEP-0060: use new parseExtra methods from MAM and RSM Goffi <goffi@goffi.org> parents: 2647 diff changeset	418 if mam_request is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	419 assert "mam" not in extra
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	420 extra["mam"] = mam_request
2760 3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	421
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	422 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	423
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	424 def add_managed_node(
3849 bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	425 self,
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	426 node: str,
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	427 priority: int = 0,
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	428 **kwargs: Callable
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	429 ):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	430 """Add a handler for a node
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	431
3849 bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	432 @param node: node to monitor
1760 30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	433 all node prefixed with this one will be triggered
3849 bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	434 @param priority: priority of the callback. Callbacks with higher priority will be
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	435 called first.
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	436 @param **kwargs: method(s) to call when the node is found
2305 972e33507609 plugin XEP-0060: addManagedNode callbacks now use client syntax instead of profile Goffi <goffi@goffi.org> parents: 2272 diff changeset	437 the method must be named after PubSub constants in lower case
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	438 and suffixed with "_cb"
2305 972e33507609 plugin XEP-0060: addManagedNode callbacks now use client syntax instead of profile Goffi <goffi@goffi.org> parents: 2272 diff changeset	439 e.g.: "items_cb" for C.PS_ITEMS, "delete_cb" for C.PS_DELETE
3597 5d108ce026d7 plugin pubsub cache: Pubsub Caching implementation Goffi <goffi@goffi.org> parents: 3591 diff changeset	440 note: only C.PS_ITEMS and C.PS_DELETE are implemented so far
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	441 """
1760 30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	442 assert node is not None
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	443 assert kwargs
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	444 callbacks = self._node_cb.setdefault(node, {})
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	445 for event, cb in kwargs.items():
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	446 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	447 assert event_name in C.PS_EVENTS
3849 bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	448 cb_list = callbacks.setdefault(event_name, [])
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	449 cb_list.append((cb, priority))
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	450 cb_list.sort(key=lambda c: c[1], reverse=True)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	451
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	452 def remove_managed_node(self, node, *args):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	453 """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	454
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	455 @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	456 @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	457 """
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	458 assert args
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	459 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	460 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	461 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	462 pass
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	463 else:
3849 bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	464 removed = False
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	465 for callback in args:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	466 for event, cb_list in registred_cb.items():
3849 bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	467 to_remove = []
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	468 for cb in cb_list:
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	469 if cb[0] == callback:
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	470 to_remove.append(cb)
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	471 for cb in to_remove:
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	472 cb_list.remove(cb)
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	473 if not cb_list:
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	474 del registred_cb[event]
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	475 if not registred_cb:
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	476 del self._node_cb[node]
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	477 removed = True
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	478 break
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	479
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	480 if not removed:
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	481 log.error(
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	482 f"Trying to remove inexistant callback {callback} for node {node}"
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	483 )
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	484
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	485 # 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	486 # """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	487
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	488 # @param service (JID): target service
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	489 # @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	490 # @param profile (str): %(doc_profile)s
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	491 # @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	492 # """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	493 # client = self.host.get_client(profile)
2148 a543eda2c923 core (memory/disco): getInfos now handle node + use client instead of profile in many methods Goffi <goffi@goffi.org> parents: 2145 diff changeset	494 # d = self.host.getDiscoItems(client, service, nodeIdentifier)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	495 # 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	496 # return d
1242 f584fbda4773 plugin XEP-0060: fixes listing the nodes on the pubsub service souliane <souliane@mailoo.org> parents: 1219 diff changeset	497
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	498 # 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	499 # """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	500
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	501 # @param service (JID): target service
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	502 # @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	503 # @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	504 # - None: do not filter
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	505 # - '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	506 # - '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	507 # - 'subscribed': subscription is complete
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	508 # @param profile (str): %(doc_profile)s
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	509 # @return: Deferred list[str]
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	510 # """
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	511 # 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	512 # 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	513 # return d
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	514
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	515 def _send_item(self, service, nodeIdentifier, payload, item_id=None, extra_ser="",
2776 838f53730ce4 plugin pubsub admin: pubsub administrator first draft: Goffi <goffi@goffi.org> parents: 2771 diff changeset	516 profile_key=C.PROF_KEY_NONE):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	517 client = self.host.get_client(profile_key)
2272 b5befe7722d3 plugin XEP-0060: added sendItem and psItemSend bridge method as a way to send directly raw XML for an item + use client instead of profile_key in publish + renamed psItemGet to psItemsGet Goffi <goffi@goffi.org> parents: 2226 diff changeset	518 service = None if not service else jid.JID(service)
3394 23af257ae780 plugin XEP-0060: use `xml_tools.parse` instead of `wokkel.generic.parseXml`: Goffi <goffi@goffi.org> parents: 3312 diff changeset	519 payload = xml_tools.parse(payload)
3100 cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3069 diff changeset	520 extra = data_format.deserialise(extra_ser)
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	521 d = defer.ensureDeferred(self.send_item(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	522 client, service, nodeIdentifier, payload, item_id or None, extra
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	523 ))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	524 d.addCallback(lambda ret: ret or "")
2272 b5befe7722d3 plugin XEP-0060: added sendItem and psItemSend bridge method as a way to send directly raw XML for an item + use client instead of profile_key in publish + renamed psItemGet to psItemsGet Goffi <goffi@goffi.org> parents: 2226 diff changeset	525 return d
b5befe7722d3 plugin XEP-0060: added sendItem and psItemSend bridge method as a way to send directly raw XML for an item + use client instead of profile_key in publish + renamed psItemGet to psItemsGet Goffi <goffi@goffi.org> parents: 2226 diff changeset	526
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	527 def _send_items(self, service, nodeIdentifier, items, extra_ser=None,
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	528 profile_key=C.PROF_KEY_NONE):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	529 client = self.host.get_client(profile_key)
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	530 service = None if not service else jid.JID(service)
3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	531 try:
3394 23af257ae780 plugin XEP-0060: use `xml_tools.parse` instead of `wokkel.generic.parseXml`: Goffi <goffi@goffi.org> parents: 3312 diff changeset	532 items = [xml_tools.parse(item) for item in items]
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	533 except Exception as e:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	534 raise exceptions.DataError(_("Can't parse items: {msg}").format(
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	535 msg=e))
3100 cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3069 diff changeset	536 extra = data_format.deserialise(extra_ser)
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	537 return defer.ensureDeferred(self.send_items(
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	538 client, service, nodeIdentifier, items, extra=extra
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	539 ))
2272 b5befe7722d3 plugin XEP-0060: added sendItem and psItemSend bridge method as a way to send directly raw XML for an item + use client instead of profile_key in publish + renamed psItemGet to psItemsGet Goffi <goffi@goffi.org> parents: 2226 diff changeset	540
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	541 async def send_item(
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	542 self,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	543 client: SatXMPPClient,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	544 service: Union[jid.JID, None],
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	545 nodeIdentifier: str,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	546 payload: domish.Element,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	547 item_id: Optional[str] = None,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	548 extra: Optional[Dict[str, Any]] = None
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	549 ) -> Optional[str]:
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	550 """High level method to send one item
2272 b5befe7722d3 plugin XEP-0060: added sendItem and psItemSend bridge method as a way to send directly raw XML for an item + use client instead of profile_key in publish + renamed psItemGet to psItemsGet Goffi <goffi@goffi.org> parents: 2226 diff changeset	551
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	552 @param service: service to send the item to None to use PEP
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	553 @param NodeIdentifier: PubSub node to use
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	554 @param payload: payload of the item to send
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	555 @param item_id: id to use or None to create one
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	556 @param extra: extra options
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	557 @return: id of the created item
2272 b5befe7722d3 plugin XEP-0060: added sendItem and psItemSend bridge method as a way to send directly raw XML for an item + use client instead of profile_key in publish + renamed psItemGet to psItemsGet Goffi <goffi@goffi.org> parents: 2226 diff changeset	558 """
3272 4c98f4972db5 plugin XEP-0060: fixed payload parsing in sendItem Goffi <goffi@goffi.org> parents: 3213 diff changeset	559 assert isinstance(payload, domish.Element)
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	560 item_elt = domish.Element((pubsub.NS_PUBSUB, 'item'))
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	561 if item_id is not None:
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	562 item_elt['id'] = item_id
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	563 item_elt.addChild(payload)
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	564 published_ids = await self.send_items(
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	565 client,
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	566 service,
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	567 nodeIdentifier,
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	568 [item_elt],
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	569 extra=extra
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	570 )
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	571 try:
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	572 return published_ids[0]
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	573 except IndexError:
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	574 return item_id
2272 b5befe7722d3 plugin XEP-0060: added sendItem and psItemSend bridge method as a way to send directly raw XML for an item + use client instead of profile_key in publish + renamed psItemGet to psItemsGet Goffi <goffi@goffi.org> parents: 2226 diff changeset	575
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	576 async def send_items(
3815 853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	577 self,
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	578 client: SatXMPPEntity,
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	579 service: Optional[jid.JID],
3815 853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	580 nodeIdentifier: str,
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	581 items: List[domish.Element],
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	582 sender: Optional[jid.JID] = None,
3815 853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	583 extra: Optional[Dict[str, Any]] = None
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	584 ) -> List[str]:
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	585 """High level method to send several items at once
3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	586
3815 853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	587 @param service: service to send the item to
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	588 None to use PEP
3815 853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	589 @param NodeIdentifier: PubSub node to use
853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	590 @param items: whole item elements to send,
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	591 "id" will be used if set
3815 853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	592 @param extra: extra options. Key can be:
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	593 - self.EXTRA_PUBLISH_OPTIONS(dict): publish options, cf. XEP-0060 § 7.1.5
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	594 the dict maps option name to value(s)
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	595 - self.EXTRA_ON_PRECOND_NOT_MET(str): policy to have when publishing is
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	596 failing du to failing precondition. Value can be:
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	597 * raise (default): raise the exception
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	598 * publish_without_options: re-publish without the publish-options.
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	599 A warning will be logged showing that the publish-options could not
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	600 be used
3815 853cbaf56e9e plugin XEP-0060: type hints Goffi <goffi@goffi.org> parents: 3791 diff changeset	601 @return: ids of the created items
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	602 """
3100 cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3069 diff changeset	603 if extra is None:
cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3069 diff changeset	604 extra = {}
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	605 if service is None:
c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	606 service = client.jid.userhostJID()
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	607 parsed_items = []
3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	608 for item in items:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	609 if item.name != 'item':
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	610 raise exceptions.DataError(_("Invalid item: {xml}").format(item.toXml()))
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	611 item_id = item.getAttribute("id")
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	612 parsed_items.append(pubsub.Item(id=item_id, payload=item.firstChildElement()))
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	613 publish_options = extra.get(self.EXTRA_PUBLISH_OPTIONS)
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	614 try:
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	615 iq_result = await self.publish(
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	616 client, service, nodeIdentifier, parsed_items, options=publish_options,
c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	617 sender=sender
c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	618 )
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	619 except error.StanzaError as e:
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	620 if ((e.condition == 'conflict' and e.appCondition
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	621 and e.appCondition.name == 'precondition-not-met'
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	622 and publish_options is not None)):
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	623 # this usually happens when publish-options can't be set
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	624 policy = extra.get(self.EXTRA_ON_PRECOND_NOT_MET, 'raise')
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	625 if policy == 'raise':
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	626 raise e
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	627 elif policy == 'publish_without_options':
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	628 log.warning(_(
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	629 "Can't use publish-options ({options}) on node {node}, "
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	630 "re-publishing without them: {reason}").format(
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	631 options=', '.join(f'{k} = {v}'
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	632 for k,v in publish_options.items()),
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	633 node=nodeIdentifier,
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	634 reason=e,
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	635 )
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	636 )
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	637 iq_result = await self.publish(
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	638 client, service, nodeIdentifier, parsed_items)
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	639 else:
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	640 raise exceptions.InternalError(
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	641 f"Invalid policy in extra's {self.EXTRA_ON_PRECOND_NOT_MET!r}: "
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	642 f"{policy}"
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	643 )
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	644 else:
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	645 raise e
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	646 try:
3854 8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	647 return [
8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	648 item['id']
8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	649 for item in iq_result.pubsub.publish.elements(pubsub.NS_PUBSUB, 'item')
8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	650 ]
3213 c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	651 except AttributeError:
c2f958dde5d2 plugin XEP-0060: async sendItems + precondition-not-met policy: Goffi <goffi@goffi.org> parents: 3137 diff changeset	652 return []
2800 3b68293a60d4 plugin XEP-0060: added sendItems/psItemsSend method to publish several items at once Goffi <goffi@goffi.org> parents: 2776 diff changeset	653
3589 ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	654 async def publish(
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	655 self,
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	656 client: SatXMPPEntity,
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	657 service: jid.JID,
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	658 nodeIdentifier: str,
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	659 items: Optional[List[domish.Element]] = None,
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	660 options: Optional[dict] = None,
3934 e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	661 sender: Optional[jid.JID] = None,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	662 extra: Optional[Dict[str, Any]] = None
3854 8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	663 ) -> domish.Element:
8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	664 """Publish pubsub items
8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	665
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	666 @param sender: sender of the request,
c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	667 client.jid will be used if nto set
3934 e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	668 @param extra: extra data
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	669 not used directly by ``publish``, but may be used in triggers
3854 8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	670 @return: IQ result stanza
3934 e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	671 @trigger XEP-0060_publish: called just before publication.
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	672 if it returns False, extra must have a "iq_result_elt" key set with
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	673 domish.Element to return.
3854 8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	674 """
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	675 if sender is None:
c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	676 sender = client.jid
3934 e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	677 if extra is None:
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	678 extra = {}
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	679 if not await self.host.trigger.async_point(
3934 e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	680 "XEP-0060_publish", client, service, nodeIdentifier, items, options, sender,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	681 extra
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	682 ):
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	683 return extra["iq_result_elt"]
3854 8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	684 iq_result_elt = await client.pubsub_client.publish(
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	685 service, nodeIdentifier, items, sender,
3100 cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3069 diff changeset	686 options=options
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	687 )
3854 8a2c46122a11 plugin XEP-0060: fix bad naming of return variable Goffi <goffi@goffi.org> parents: 3849 diff changeset	688 return iq_result_elt
3589 ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	689
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	690 def _unwrap_mam_message(self, message_elt):
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	691 try:
3062 93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	692 item_elt = reduce(
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	693 lambda elt, ns_name: next(elt.elements(*ns_name)),
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	694 (message_elt,
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	695 (mam.NS_MAM, "result"),
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	696 (C.NS_FORWARD, "forwarded"),
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	697 (C.NS_CLIENT, "message"),
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	698 ("http://jabber.org/protocol/pubsub#event", "event"),
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	699 ("http://jabber.org/protocol/pubsub#event", "items"),
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	700 ("http://jabber.org/protocol/pubsub#event", "item"),
93e8793a735a plugin XEP-0060: fixed bad MAM unwrapping after Python 3 port Goffi <goffi@goffi.org> parents: 3028 diff changeset	701 ))
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	702 except StopIteration:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	703 raise exceptions.DataError("Can't find Item in MAM message element")
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	704 return item_elt
8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	705
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	706 def serialise_items(self, items_data):
3312 77177b13ff54 plugin XEP-0060: serialise psItemsGet result with data_format Goffi <goffi@goffi.org> parents: 3308 diff changeset	707 items, metadata = items_data
77177b13ff54 plugin XEP-0060: serialise psItemsGet result with data_format Goffi <goffi@goffi.org> parents: 3308 diff changeset	708 metadata['items'] = items
77177b13ff54 plugin XEP-0060: serialise psItemsGet result with data_format Goffi <goffi@goffi.org> parents: 3308 diff changeset	709 return data_format.serialise(metadata)
77177b13ff54 plugin XEP-0060: serialise psItemsGet result with data_format Goffi <goffi@goffi.org> parents: 3308 diff changeset	710
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	711 def _get_items(self, service="", node="", max_items=10, item_ids=None, sub_id=None,
3586 5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict Goffi <goffi@goffi.org> parents: 3584 diff changeset	712 extra="", profile_key=C.PROF_KEY_NONE):
2185 dd53d7a3219a plugin XEP-0060: added psGet bridge method Goffi <goffi@goffi.org> parents: 2148 diff changeset	713 """Get items from pubsub node
dd53d7a3219a plugin XEP-0060: added psGet bridge method Goffi <goffi@goffi.org> parents: 2148 diff changeset	714
dd53d7a3219a plugin XEP-0060: added psGet bridge method Goffi <goffi@goffi.org> parents: 2148 diff changeset	715 @param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
dd53d7a3219a plugin XEP-0060: added psGet bridge method Goffi <goffi@goffi.org> parents: 2148 diff changeset	716 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	717 client = self.host.get_client(profile_key)
2185 dd53d7a3219a plugin XEP-0060: added psGet bridge method Goffi <goffi@goffi.org> parents: 2148 diff changeset	718 service = jid.JID(service) if service else None
dd53d7a3219a plugin XEP-0060: added psGet bridge method Goffi <goffi@goffi.org> parents: 2148 diff changeset	719 max_items = None if max_items == C.NO_LIMIT else max_items
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	720 extra = self.parse_extra(data_format.deserialise(extra))
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	721 d = defer.ensureDeferred(self.get_items(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	722 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	723 service,
3723 1cdb9d9fad6b plugin XEP-0060: `None` must not be used for `getItems`'s `node` Goffi <goffi@goffi.org> parents: 3597 diff changeset	724 node,
3591 d830c11eeef3 plugin XEP-0277: ignore `max_items` if `rsm_request` is set Goffi <goffi@goffi.org> parents: 3590 diff changeset	725 max_items,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	726 item_ids,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	727 sub_id or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	728 extra.rsm_request,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	729 extra.extra,
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	730 ))
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	731 d.addCallback(self.trans_items_data)
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	732 d.addCallback(self.serialise_items)
2185 dd53d7a3219a plugin XEP-0060: added psGet bridge method Goffi <goffi@goffi.org> parents: 2148 diff changeset	733 return d
dd53d7a3219a plugin XEP-0060: added psGet bridge method Goffi <goffi@goffi.org> parents: 2148 diff changeset	734
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	735 async def get_items(
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	736 self,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	737 client: SatXMPPEntity,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	738 service: Optional[jid.JID],
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	739 node: str,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	740 max_items: Optional[int] = None,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	741 item_ids: Optional[List[str]] = None,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	742 sub_id: Optional[str] = None,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	743 rsm_request: Optional[rsm.RSMRequest] = None,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	744 extra: Optional[dict] = None
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	745 ) -> Tuple[List[dict], dict]:
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	746 """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	747
1865 fc6eeacf31bc plugin XEP-0277: service can be None in mbGet, resulting in a request on default pubsub service of profile (i.e. profile's PEP) Goffi <goffi@goffi.org> parents: 1854 diff changeset	748 @param service (JID, None): pubsub service.
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	749 @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	750 @param max_items (int): optional limit on the number of retrieved items.
2758 f4070693814a plugin XEP-0060: fixed MAM return value on getItems(): Goffi <goffi@goffi.org> parents: 2718 diff changeset	751 @param item_ids (list[str]): identifiers of the items to be retrieved (can't be
3860 e417c478b488 plugin XEP-0060, tools (utils): doc/type hints Goffi <goffi@goffi.org> parents: 3859 diff changeset	752 used with rsm_request). If requested items don't exist, they won't be
e417c478b488 plugin XEP-0060, tools (utils): doc/type hints Goffi <goffi@goffi.org> parents: 3859 diff changeset	753 returned, meaning that we can have an empty list as result (NotFound
e417c478b488 plugin XEP-0060, tools (utils): doc/type hints Goffi <goffi@goffi.org> parents: 3859 diff changeset	754 exception is NOT raised).
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	755 @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	756 @param rsm_request (rsm.RSMRequest): RSM request data
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	757 @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	758 - list of items
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	759 - metadata with the following keys:
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2702 diff changeset	760 - rsm_first, rsm_last, rsm_count, rsm_index: first, last, count and index
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2702 diff changeset	761 value of RSMResponse
1903 29564cec913f plugin XEP-0060: service, node and uri are added to metadata when doing a getItems Goffi <goffi@goffi.org> parents: 1865 diff changeset	762 - service, node: service and node used
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1267 diff changeset	763 """
2319 e715a29c4f9b plugin XEP-0060: remove max_items when item_ids is set on getItems Goffi <goffi@goffi.org> parents: 2314 diff changeset	764 if item_ids and max_items is not None:
e715a29c4f9b plugin XEP-0060: remove max_items when item_ids is set on getItems Goffi <goffi@goffi.org> parents: 2314 diff changeset	765 max_items = None
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	766 if rsm_request and item_ids:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	767 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	768 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	769 extra = {}
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	770 cont, ret = await self.host.trigger.async_return_point(
3589 ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	771 "XEP-0060_getItems", client, service, node, max_items, item_ids, sub_id,
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	772 rsm_request, extra
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	773 )
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	774 if not cont:
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	775 return ret
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	776 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	777 mam_query = extra["mam"]
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	778 except KeyError:
3934 e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	779 d = defer.ensureDeferred(client.pubsub_client.items(
2760 3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	780 service = service,
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	781 nodeIdentifier = node,
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	782 maxItems = max_items,
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	783 subscriptionIdentifier = sub_id,
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	784 sender = None,
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	785 itemIdentifiers = item_ids,
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	786 orderBy = extra.get(C.KEY_ORDER_BY),
3934 e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	787 rsm_request = rsm_request,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	788 extra = extra
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	789 ))
2758 f4070693814a plugin XEP-0060: fixed MAM return value on getItems(): Goffi <goffi@goffi.org> parents: 2718 diff changeset	790 # we have no MAM data here, so we add None
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	791 d.addErrback(sat_defer.stanza_2_not_found)
2769 9282b289b964 plugin XEP-0060: set a 30s timeout on items get Goffi <goffi@goffi.org> parents: 2760 diff changeset	792 d.addTimeout(TIMEOUT, reactor)
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	793 items, rsm_response = await d
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	794 mam_response = None
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	795 else:
8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	796 # if mam is requested, we have to do a totally different query
8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	797 if self._mam is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	798 raise exceptions.NotFound("MAM (XEP-0313) plugin is not available")
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	799 if max_items is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	800 raise exceptions.DataError("max_items parameter can't be used with MAM")
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	801 if item_ids:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	802 raise exceptions.DataError("items_ids parameter can't be used with MAM")
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	803 if mam_query.node is None:
8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	804 mam_query.node = node
8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	805 elif mam_query.node != node:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	806 raise exceptions.DataError(
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	807 "MAM query node is incoherent with get_items's node"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	808 )
1777 8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	809 if mam_query.rsm is None:
8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	810 mam_query.rsm = rsm_request
8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	811 else:
8b18e5f55a90 plugin XEP-0060: MAM integration: Goffi <goffi@goffi.org> parents: 1773 diff changeset	812 if mam_query.rsm != rsm_request:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	813 raise exceptions.DataError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	814 "Conflict between RSM request and MAM's RSM request"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	815 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	816 items, rsm_response, mam_response = await self._mam.get_archives(
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	817 client, mam_query, service, self._unwrap_mam_message
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	818 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	819
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	820 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	821 subscribe = C.bool(extra["subscribe"])
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	822 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	823 subscribe = False
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	824
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	825 if subscribe:
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	826 try:
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	827 await self.subscribe(client, service, node)
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	828 except error.StanzaError as e:
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	829 log.warning(
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	830 f"Could not subscribe to node {node} on service {service}: {e}"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	831 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	832
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	833 # TODO: handle mam_response
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	834 service_jid = service if service else client.jid.userhostJID()
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	835 metadata = {
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	836 "service": service_jid,
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	837 "node": node,
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	838 "uri": self.get_node_uri(service_jid, node),
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	839 }
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	840 if mam_response is not None:
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	841 # mam_response is a dict with "complete" and "stable" keys
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	842 # we can put them directly in metadata
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	843 metadata.update(mam_response)
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	844 if rsm_request is not None and rsm_response is not None:
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	845 metadata['rsm'] = rsm_response.toDict()
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	846 if mam_response is None:
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	847 index = rsm_response.index
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	848 count = rsm_response.count
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	849 if index is None or count is None:
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	850 # we don't have enough information to know if the data is complete
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	851 # or not
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	852 metadata["complete"] = None
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	853 else:
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	854 # normally we have a strict equality here but XEP-0059 states
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	855 # that index MAY be approximative, so just in case…
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	856 metadata["complete"] = index + len(items) >= count
3948 cd4d95b3fed3 plugin OXPS, XEP-0060: indicate which items were e2ee: Goffi <goffi@goffi.org> parents: 3934 diff changeset	857 # encrypted metadata can be added by plugins in XEP-0060_items trigger
cd4d95b3fed3 plugin OXPS, XEP-0060: indicate which items were e2ee: Goffi <goffi@goffi.org> parents: 3934 diff changeset	858 if "encrypted" in extra:
cd4d95b3fed3 plugin OXPS, XEP-0060: indicate which items were e2ee: Goffi <goffi@goffi.org> parents: 3934 diff changeset	859 metadata["encrypted"] = extra["encrypted"]
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3272 diff changeset	860
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	861 return (items, metadata)
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 301 diff changeset	862
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	863 # @defer.inlineCallbacks
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	864 # 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	865 # """Massively retrieve pubsub items from many nodes.
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	866 # @param service (JID): target service.
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	867 # @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	868 # @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	869 # @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	870 # @param rsm (dict): RSM request data
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	871 # @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	872 # @return: a deferred dict with:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	873 # - 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	874 # - couple (list[dict], dict) containing:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	875 # - list of items
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	876 # - RSM response data
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	877 # """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	878 # client = self.host.get_client(profile_key)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	879 # 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	880 # d_dict = {}
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	881 # for publisher, node in data.items():
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	882 # if node not in found_nodes:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	883 # 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	884 # continue # avoid pubsub "item-not-found" error
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	885 # d_dict[publisher] = self.get_items(service, node, max_items, None, sub_id, rsm, client.profile)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1420 diff changeset	886 # 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	887
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	888 def getOptions(self, service, nodeIdentifier, subscriber, subscriptionIdentifier=None,
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	889 profile_key=C.PROF_KEY_NONE):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	890 client = self.host.get_client(profile_key)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	891 return client.pubsub_client.getOptions(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	892 service, nodeIdentifier, subscriber, subscriptionIdentifier
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	893 )
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 301 diff changeset	894
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	895 def setOptions(self, service, nodeIdentifier, subscriber, options,
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	896 subscriptionIdentifier=None, profile_key=C.PROF_KEY_NONE):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	897 client = self.host.get_client(profile_key)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	898 return client.pubsub_client.setOptions(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	899 service, nodeIdentifier, subscriber, options, subscriptionIdentifier
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	900 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	901
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	902 def _create_node(self, service_s, nodeIdentifier, options, profile_key):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	903 client = self.host.get_client(profile_key)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	904 return self.createNode(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	905 client, jid.JID(service_s) if service_s else None, nodeIdentifier, options
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	906 )
2218 6a2fa651d7fa plugin XEP-0060: node create/delete improvments: Goffi <goffi@goffi.org> parents: 2206 diff changeset	907
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	908 def createNode(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	909 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	910 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	911 service: jid.JID,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	912 nodeIdentifier: Optional[str] = None,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	913 options: Optional[Dict[str, str]] = None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	914 ) -> str:
2218 6a2fa651d7fa plugin XEP-0060: node create/delete improvments: Goffi <goffi@goffi.org> parents: 2206 diff changeset	915 """Create a new node
6a2fa651d7fa plugin XEP-0060: node create/delete improvments: Goffi <goffi@goffi.org> parents: 2206 diff changeset	916
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	917 @param service: PubSub service,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	918 @param NodeIdentifier: node name use None to create instant node (identifier will
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	919 be returned by this method)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	920 @param option: node configuration options
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: 3911 diff changeset	921 @return: identifier of the created node (may be different from requested name)
2218 6a2fa651d7fa plugin XEP-0060: node create/delete improvments: Goffi <goffi@goffi.org> parents: 2206 diff changeset	922 """
2393 8ed4ac10cb5e plugin tickets import: create comments nodes with open access/publishing Goffi <goffi@goffi.org> parents: 2389 diff changeset	923 # TODO: if pubsub service doesn't hande publish-options, configure it in a second time
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	924 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	925
2389 5675af905725 plugin XEP-0060: added createIfNewNode method which doesn't fail in case of conflict. Goffi <goffi@goffi.org> parents: 2360 diff changeset	926 @defer.inlineCallbacks
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	927 def create_if_new_node(self, client, service, nodeIdentifier, options=None):
2389 5675af905725 plugin XEP-0060: added createIfNewNode method which doesn't fail in case of conflict. Goffi <goffi@goffi.org> parents: 2360 diff changeset	928 """Helper method similar to createNode, but will not fail in case of conflict"""
5675af905725 plugin XEP-0060: added createIfNewNode method which doesn't fail in case of conflict. Goffi <goffi@goffi.org> parents: 2360 diff changeset	929 try:
5675af905725 plugin XEP-0060: added createIfNewNode method which doesn't fail in case of conflict. Goffi <goffi@goffi.org> parents: 2360 diff changeset	930 yield self.createNode(client, service, nodeIdentifier, options)
5675af905725 plugin XEP-0060: added createIfNewNode method which doesn't fail in case of conflict. Goffi <goffi@goffi.org> parents: 2360 diff changeset	931 except error.StanzaError as e:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	932 if e.condition == "conflict":
2389 5675af905725 plugin XEP-0060: added createIfNewNode method which doesn't fail in case of conflict. Goffi <goffi@goffi.org> parents: 2360 diff changeset	933 pass
5675af905725 plugin XEP-0060: added createIfNewNode method which doesn't fail in case of conflict. Goffi <goffi@goffi.org> parents: 2360 diff changeset	934 else:
5675af905725 plugin XEP-0060: added createIfNewNode method which doesn't fail in case of conflict. Goffi <goffi@goffi.org> parents: 2360 diff changeset	935 raise e
5675af905725 plugin XEP-0060: added createIfNewNode method which doesn't fail in case of conflict. Goffi <goffi@goffi.org> parents: 2360 diff changeset	936
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	937 def _get_node_configuration(self, service_s, nodeIdentifier, profile_key):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	938 client = self.host.get_client(profile_key)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	939 d = self.getConfiguration(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	940 client, jid.JID(service_s) if service_s else None, nodeIdentifier
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	941 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	942
2196 d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	943 def serialize(form):
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	944 # FIXME: better more generic dataform serialisation should be available in SàT
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	945 return {f.var: str(f.value) for f in list(form.fields.values())}
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	946
2196 d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	947 d.addCallback(serialize)
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	948 return d
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	949
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	950 def getConfiguration(self, client, service, nodeIdentifier):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	951 request = pubsub.PubSubRequest("configureGet")
2196 d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	952 request.recipient = service
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	953 request.nodeIdentifier = nodeIdentifier
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	954
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	955 def cb(iq):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	956 form = data_form.findForm(iq.pubsub.configure, pubsub.NS_PUBSUB_NODE_CONFIG)
2196 d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	957 form.typeCheck()
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	958 return form
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	959
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	960 d = request.send(client.xmlstream)
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	961 d.addCallback(cb)
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	962 return d
d3e48c9a255e plugin XEP-0060: added getConfiguration ad psNodeConfigurationGet bridge method Goffi <goffi@goffi.org> parents: 2195 diff changeset	963
3993 722c25818778 plugin XEP-0470: create a default configuration if node config can't be accessed Goffi <goffi@goffi.org> parents: 3948 diff changeset	964 def make_configuration_form(self, options: dict) -> data_form.Form:
722c25818778 plugin XEP-0470: create a default configuration if node config can't be accessed Goffi <goffi@goffi.org> parents: 3948 diff changeset	965 """Build a configuration form"""
722c25818778 plugin XEP-0470: create a default configuration if node config can't be accessed Goffi <goffi@goffi.org> parents: 3948 diff changeset	966 form = data_form.Form(
722c25818778 plugin XEP-0470: create a default configuration if node config can't be accessed Goffi <goffi@goffi.org> parents: 3948 diff changeset	967 formType="submit", formNamespace=pubsub.NS_PUBSUB_NODE_CONFIG
722c25818778 plugin XEP-0470: create a default configuration if node config can't be accessed Goffi <goffi@goffi.org> parents: 3948 diff changeset	968 )
722c25818778 plugin XEP-0470: create a default configuration if node config can't be accessed Goffi <goffi@goffi.org> parents: 3948 diff changeset	969 form.makeFields(options)
722c25818778 plugin XEP-0470: create a default configuration if node config can't be accessed Goffi <goffi@goffi.org> parents: 3948 diff changeset	970 return form
722c25818778 plugin XEP-0470: create a default configuration if node config can't be accessed Goffi <goffi@goffi.org> parents: 3948 diff changeset	971
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	972 def _set_node_configuration(self, service_s, nodeIdentifier, options, profile_key):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	973 client = self.host.get_client(profile_key)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	974 d = self.setConfiguration(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	975 client, jid.JID(service_s) if service_s else None, nodeIdentifier, options
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	976 )
2198 44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	977 return d
44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	978
44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	979 def setConfiguration(self, client, service, nodeIdentifier, options):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	980 request = pubsub.PubSubRequest("configureSet")
2198 44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	981 request.recipient = service
44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	982 request.nodeIdentifier = nodeIdentifier
44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	983
3993 722c25818778 plugin XEP-0470: create a default configuration if node config can't be accessed Goffi <goffi@goffi.org> parents: 3948 diff changeset	984 form = self.make_configuration_form(options)
2198 44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	985 request.options = form
44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	986
44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	987 d = request.send(client.xmlstream)
44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	988 return d
44f12990e275 plugin XEP-0060: added setConfiguration/psNodeConfigurationSet + fix in tmp.wokkel.pubsub Goffi <goffi@goffi.org> parents: 2196 diff changeset	989
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	990 def _get_affiliations(self, service_s, nodeIdentifier, profile_key):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	991 client = self.host.get_client(profile_key)
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	992 d = self.get_affiliations(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	993 client, jid.JID(service_s) if service_s else None, nodeIdentifier or None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	994 )
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	995 return d
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	996
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	997 def get_affiliations(self, client, service, nodeIdentifier=None):
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	998 """Retrieve affiliations of an entity
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	999
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1000 @param nodeIdentifier(unicode, None): node to get affiliation from
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1001 None to get all nodes affiliations for this service
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1002 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1003 request = pubsub.PubSubRequest("affiliations")
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1004 request.recipient = service
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1005 request.nodeIdentifier = nodeIdentifier
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1006
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1007 def cb(iq_elt):
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1008 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1009 affiliations_elt = next(
3859 3ef988734869 core: fix calls to `domish.Element.elements`: Goffi <goffi@goffi.org> parents: 3854 diff changeset	1010 iq_elt.pubsub.elements(pubsub.NS_PUBSUB, "affiliations")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1011 )
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1012 except StopIteration:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1013 raise ValueError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1014 _("Invalid result: missing <affiliations> element: {}").format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1015 iq_elt.toXml
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1016 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1017 )
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1018 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1019 return {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1020 e["node"]: e["affiliation"]
3859 3ef988734869 core: fix calls to `domish.Element.elements`: Goffi <goffi@goffi.org> parents: 3854 diff changeset	1021 for e in affiliations_elt.elements(pubsub.NS_PUBSUB, "affiliation")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1022 }
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1023 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1024 raise ValueError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1025 _("Invalid result: bad <affiliation> element: {}").format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1026 iq_elt.toXml
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1027 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1028 )
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1029
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1030 d = request.send(client.xmlstream)
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1031 d.addCallback(cb)
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1032 return d
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1033
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1034 def _get_node_affiliations(self, service_s, nodeIdentifier, profile_key):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1035 client = self.host.get_client(profile_key)
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1036 d = self.get_node_affiliations(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1037 client, jid.JID(service_s) if service_s else None, nodeIdentifier
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1038 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1039 d.addCallback(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1040 lambda affiliations: {j.full(): a for j, a in affiliations.items()}
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1041 )
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1042 return d
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1043
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1044 def get_node_affiliations(self, client, service, nodeIdentifier):
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1045 """Retrieve affiliations of a node owned by profile"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1046 request = pubsub.PubSubRequest("affiliationsGet")
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1047 request.recipient = service
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1048 request.nodeIdentifier = nodeIdentifier
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1049
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1050 def cb(iq_elt):
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1051 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1052 affiliations_elt = next(
3859 3ef988734869 core: fix calls to `domish.Element.elements`: Goffi <goffi@goffi.org> parents: 3854 diff changeset	1053 iq_elt.pubsub.elements(pubsub.NS_PUBSUB_OWNER, "affiliations")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1054 )
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1055 except StopIteration:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1056 raise ValueError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1057 _("Invalid result: missing <affiliations> element: {}").format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1058 iq_elt.toXml
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1059 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1060 )
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1061 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1062 return {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1063 jid.JID(e["jid"]): e["affiliation"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1064 for e in affiliations_elt.elements(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1065 (pubsub.NS_PUBSUB_OWNER, "affiliation")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1066 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1067 }
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1068 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1069 raise ValueError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1070 _("Invalid result: bad <affiliation> element: {}").format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1071 iq_elt.toXml
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1072 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1073 )
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1074
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1075 d = request.send(client.xmlstream)
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1076 d.addCallback(cb)
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1077 return d
427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1078
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1079 def _set_node_affiliations(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1080 self, service_s, nodeIdentifier, affiliations, profile_key=C.PROF_KEY_NONE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1081 ):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1082 client = self.host.get_client(profile_key)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1083 affiliations = {
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1084 jid.JID(jid_): affiliation for jid_, affiliation in affiliations.items()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1085 }
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1086 d = self.set_node_affiliations(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1087 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1088 jid.JID(service_s) if service_s else None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1089 nodeIdentifier,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1090 affiliations,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1091 )
2206 59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1092 return d
59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1093
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1094 def set_node_affiliations(self, client, service, nodeIdentifier, affiliations):
2206 59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1095 """Update affiliations of a node owned by profile
59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1096
59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1097 @param affiliations(dict[jid.JID, unicode]): affiliations to set
59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1098 check https://xmpp.org/extensions/xep-0060.html#affiliations for a list of possible affiliations
59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1099 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1100 request = pubsub.PubSubRequest("affiliationsSet")
2206 59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1101 request.recipient = service
59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1102 request.nodeIdentifier = nodeIdentifier
59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1103 request.affiliations = affiliations
59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1104 d = request.send(client.xmlstream)
59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1105 return d
59d3de85a0cb plugin XEP-0060: added setNodeAffiliations and its bridge method (psNodeAffiliationsSet) Goffi <goffi@goffi.org> parents: 2203 diff changeset	1106
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1107 def _purge_node(self, service_s, nodeIdentifier, profile_key):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1108 client = self.host.get_client(profile_key)
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1109 return self.purge_node(
2801 ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1110 client, jid.JID(service_s) if service_s else None, nodeIdentifier
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1111 )
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1112
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1113 def purge_node(self, client, service, nodeIdentifier):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1114 return client.pubsub_client.purge_node(service, nodeIdentifier)
2801 ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1115
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1116 def _delete_node(self, service_s, nodeIdentifier, profile_key):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1117 client = self.host.get_client(profile_key)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1118 return self.deleteNode(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1119 client, jid.JID(service_s) if service_s else None, nodeIdentifier
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1120 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	1121
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1122 def deleteNode(
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1123 self,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1124 client: SatXMPPClient,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1125 service: jid.JID,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1126 nodeIdentifier: str
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1127 ) -> defer.Deferred:
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1396 diff changeset	1128 return client.pubsub_client.deleteNode(service, nodeIdentifier)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1129
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1130 def _addWatch(self, service_s, node, profile_key):
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1131 """watch modifications on a node
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1132
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1133 This method should only be called from bridge
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1134 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1135 client = self.host.get_client(profile_key)
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1136 service = jid.JID(service_s) if service_s else client.jid.userhostJID()
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1137 client.pubsub_watching.add((service, node))
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1138
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1139 def _remove_watch(self, service_s, node, profile_key):
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1140 """remove a node watch
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1141
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1142 This method should only be called from bridge
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1143 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1144 client = self.host.get_client(profile_key)
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1145 service = jid.JID(service_s) if service_s else client.jid.userhostJID()
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1146 client.pubsub_watching.remove((service, node))
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1147
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1148 def _retract_item(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1149 self, service_s, nodeIdentifier, itemIdentifier, notify, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1150 ):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1151 return self._retract_items(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1152 service_s, nodeIdentifier, (itemIdentifier,), notify, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1153 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	1154
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1155 def _retract_items(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1156 self, service_s, nodeIdentifier, itemIdentifiers, notify, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1157 ):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1158 client = self.host.get_client(profile_key)
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1159 return self.retract_items(
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1160 client,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1161 jid.JID(service_s) if service_s else None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1162 nodeIdentifier,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1163 itemIdentifiers,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1164 notify,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1165 )
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	1166
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1167 def retract_items(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1168 self,
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1169 client: SatXMPPClient,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1170 service: jid.JID,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1171 nodeIdentifier: str,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1172 itemIdentifiers: Iterable[str],
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1173 notify: bool = True,
8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3899 diff changeset	1174 ) -> defer.Deferred:
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1175 return client.pubsub_client.retractItems(
3590 1269c2d788be plugin XEP-0060: fix notification handling in `retractItems` Goffi <goffi@goffi.org> parents: 3589 diff changeset	1176 service, nodeIdentifier, itemIdentifiers, notify=notify
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1177 )
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1178
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1179 def _rename_item(
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1180 self,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1181 service,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1182 node,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1183 item_id,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1184 new_id,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1185 profile_key=C.PROF_KEY_NONE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1186 ):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1187 client = self.host.get_client(profile_key)
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1188 service = jid.JID(service) if service else None
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1189 return defer.ensureDeferred(self.rename_item(
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1190 client, service, node, item_id, new_id
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1191 ))
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1192
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1193 async def rename_item(
3519 02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1194 self,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1195 client: SatXMPPEntity,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1196 service: Optional[jid.JID],
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1197 node: str,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1198 item_id: str,
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1199 new_id: str
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1200 ) -> None:
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1201 """Rename an item by recreating it then deleting it
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1202
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1203 we have to recreate then delete because there is currently no rename operation
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1204 with PubSub
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1205 """
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1206 if not item_id or not new_id:
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1207 raise ValueError("item_id and new_id must not be empty")
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1208 # retract must be done last, so if something goes wrong, the exception will stop
02eec2a5b5f9 plugin XEP-0060, XEP-0277: new rename methods (`psItemRename`, `mbRename`): Goffi <goffi@goffi.org> parents: 3492 diff changeset	1209 # the workflow and no accidental delete should happen
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1210 item_elt = (await self.get_items(client, service, node, item_ids=[item_id]))[0][0]
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1211 await self.send_item(client, service, node, item_elt.firstChildElement(), new_id)
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1212 await self.retract_items(client, service, node, [item_id])
745 812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 704 diff changeset	1213
2442 b8ffb7f8056b plugin XEP-0060: added "options" argument to psSubscribe, and return subscription id if present Goffi <goffi@goffi.org> parents: 2432 diff changeset	1214 def _subscribe(self, service, nodeIdentifier, options, profile_key=C.PROF_KEY_NONE):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1215 client = self.host.get_client(profile_key)
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1216 service = None if not service else jid.JID(service)
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	1217 d = defer.ensureDeferred(
3757 5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1218 self.subscribe(
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1219 client,
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1220 service,
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1221 nodeIdentifier,
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1222 options=data_format.deserialise(options)
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1223 )
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	1224 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1225 d.addCallback(lambda subscription: subscription.subscriptionIdentifier or "")
2442 b8ffb7f8056b plugin XEP-0060: added "options" argument to psSubscribe, and return subscription id if present Goffi <goffi@goffi.org> parents: 2432 diff changeset	1226 return d
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1227
3589 ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1228 async def subscribe(
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1229 self,
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1230 client: SatXMPPEntity,
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	1231 service: Optional[jid.JID],
3589 ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1232 nodeIdentifier: str,
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1233 sub_jid: Optional[jid.JID] = None,
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1234 options: Optional[dict] = None
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1235 ) -> pubsub.Subscription:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1452 diff changeset	1236 # TODO: reimplement a subscribtion cache, checking that we have not subscription before trying to subscribe
3867 c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	1237 if service is None:
c3e6c54660da plugin XEP-0060: sender can now be specified in `sendItems` and `publish`: Goffi <goffi@goffi.org> parents: 3860 diff changeset	1238 service = client.jid.userhostJID()
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1239 cont, trigger_sub = await self.host.trigger.async_return_point(
3757 5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1240 "XEP-0060_subscribe", client, service, nodeIdentifier, sub_jid, options,
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1241 )
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1242 if not cont:
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1243 return trigger_sub
3899 1e64f1ed3ebd plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: Goffi <goffi@goffi.org> parents: 3867 diff changeset	1244 try:
1e64f1ed3ebd plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: Goffi <goffi@goffi.org> parents: 3867 diff changeset	1245 subscription = await client.pubsub_client.subscribe(
1e64f1ed3ebd plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: Goffi <goffi@goffi.org> parents: 3867 diff changeset	1246 service, nodeIdentifier, sub_jid or client.jid.userhostJID(),
1e64f1ed3ebd plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: Goffi <goffi@goffi.org> parents: 3867 diff changeset	1247 options=options, sender=client.jid.userhostJID()
1e64f1ed3ebd plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: Goffi <goffi@goffi.org> parents: 3867 diff changeset	1248 )
1e64f1ed3ebd plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: Goffi <goffi@goffi.org> parents: 3867 diff changeset	1249 except error.StanzaError as e:
1e64f1ed3ebd plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: Goffi <goffi@goffi.org> parents: 3867 diff changeset	1250 if e.condition == 'item-not-found':
1e64f1ed3ebd plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: Goffi <goffi@goffi.org> parents: 3867 diff changeset	1251 raise exceptions.NotFound(e.text or e.condition)
1e64f1ed3ebd plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: Goffi <goffi@goffi.org> parents: 3867 diff changeset	1252 else:
1e64f1ed3ebd plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: Goffi <goffi@goffi.org> parents: 3867 diff changeset	1253 raise e
3589 ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1254 return subscription
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1255
6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1256 def _unsubscribe(self, service, nodeIdentifier, profile_key=C.PROF_KEY_NONE):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1257 client = self.host.get_client(profile_key)
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1258 service = None if not service else jid.JID(service)
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	1259 return defer.ensureDeferred(self.unsubscribe(client, service, nodeIdentifier))
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1260
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	1261 async def unsubscribe(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1262 self,
3589 ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1263 client: SatXMPPEntity,
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1264 service: jid.JID,
ed037c98df37 plugin XEP-0060: add trigger points Goffi <goffi@goffi.org> parents: 3588 diff changeset	1265 nodeIdentifier: str,
3757 5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1266 sub_jid: Optional[jid.JID] = None,
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1267 subscriptionIdentifier: Optional[str] = None,
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1268 sender: Optional[jid.JID] = None,
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1269 ) -> None:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1270 if not await self.host.trigger.async_point(
3757 5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1271 "XEP-0060_unsubscribe", client, service, nodeIdentifier, sub_jid,
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1272 subscriptionIdentifier, sender
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1273 ):
5bda9d2e8b35 plugin XEP-0060: use serialised options in `psSubscribe` + triggers update Goffi <goffi@goffi.org> parents: 3756 diff changeset	1274 return
3791 c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1275 try:
c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1276 await client.pubsub_client.unsubscribe(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1277 service,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1278 nodeIdentifier,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1279 sub_jid or client.jid.userhostJID(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1280 subscriptionIdentifier,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1281 sender,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1282 )
3791 c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1283 except error.StanzaError as e:
c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1284 try:
c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1285 next(e.getElement().elements(pubsub.NS_PUBSUB_ERRORS, "not-subscribed"))
c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1286 except StopIteration:
c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1287 raise e
c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1288 else:
c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1289 log.info(
c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1290 f"{sender.full() if sender else client.jid.full()} was not "
c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1291 f"subscribed to node {nodeIdentifier!s} at {service.full()}"
c61233f51b86 plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: Goffi <goffi@goffi.org> parents: 3758 diff changeset	1292 )
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1293
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1294 @utils.ensure_deferred
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1295 async def _subscriptions(
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1296 self,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1297 service="",
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1298 nodeIdentifier="",
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1299 profile_key=C.PROF_KEY_NONE
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1300 ) -> str:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1301 client = self.host.get_client(profile_key)
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1302 service = None if not service else jid.JID(service)
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1303 subs = await self.subscriptions(client, service, nodeIdentifier or None)
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1304 return data_format.serialise(subs)
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1305
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1306 async def subscriptions(
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1307 self,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1308 client: SatXMPPEntity,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1309 service: Optional[jid.JID] = None,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1310 node: Optional[str] = None
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1311 ) -> List[Dict[str, Union[str, bool]]]:
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1312 """Retrieve subscriptions from a service
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1313
6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1314 @param service(jid.JID): PubSub service
6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1315 @param nodeIdentifier(unicode, None): node to check
6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1316 None to get all subscriptions
6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1317 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1318 cont, ret = await self.host.trigger.async_return_point(
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1319 "XEP-0060_subscriptions", client, service, node
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1320 )
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1321 if not cont:
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1322 return ret
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1323 subs = await client.pubsub_client.subscriptions(service, node)
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1324 ret = []
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1325 for sub in subs:
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1326 sub_dict = {
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1327 "service": service.host if service else client.jid.host,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1328 "node": sub.nodeIdentifier,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1329 "subscriber": sub.subscriber.full(),
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1330 "state": sub.state,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1331 }
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1332 if sub.subscriptionIdentifier is not None:
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1333 sub_dict["id"] = sub.subscriptionIdentifier
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1334 ret.append(sub_dict)
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1335 return ret
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	1336
1829 6079752ffeae plugin XEP-0060, XEP-0277: added getNodeURI method Goffi <goffi@goffi.org> parents: 1778 diff changeset	1337 ## misc tools ##
6079752ffeae plugin XEP-0060, XEP-0277: added getNodeURI method Goffi <goffi@goffi.org> parents: 1778 diff changeset	1338
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1339 def get_node_uri(self, service, node, item=None):
1829 6079752ffeae plugin XEP-0060, XEP-0277: added getNodeURI method Goffi <goffi@goffi.org> parents: 1778 diff changeset	1340 """Return XMPP URI of a PubSub node
6079752ffeae plugin XEP-0060, XEP-0277: added getNodeURI method Goffi <goffi@goffi.org> parents: 1778 diff changeset	1341
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1342 @param service(jid.JID): PubSub service
1829 6079752ffeae plugin XEP-0060, XEP-0277: added getNodeURI method Goffi <goffi@goffi.org> parents: 1778 diff changeset	1343 @param node(unicode): node
6079752ffeae plugin XEP-0060, XEP-0277: added getNodeURI method Goffi <goffi@goffi.org> parents: 1778 diff changeset	1344 @return (unicode): URI of the node
6079752ffeae plugin XEP-0060, XEP-0277: added getNodeURI method Goffi <goffi@goffi.org> parents: 1778 diff changeset	1345 """
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3272 diff changeset	1346 # FIXME: deprecated, use sat.tools.common.uri instead
1904 614f3abb2c69 plugin XEP-0060: fixed traceback if service was None Goffi <goffi@goffi.org> parents: 1903 diff changeset	1347 assert service is not None
1854 3c0bb714a80b plugin XEP-0060: fixed bad xmpp: URI generation in getNodeURI Goffi <goffi@goffi.org> parents: 1829 diff changeset	1348 # XXX: urllib.urlencode use "&" to separate value, while XMPP URL (cf. RFC 5122)
3c0bb714a80b plugin XEP-0060: fixed bad xmpp: URI generation in getNodeURI Goffi <goffi@goffi.org> parents: 1829 diff changeset	1349 # use ";" as a separator. So if more than one value is used in query_data,
3c0bb714a80b plugin XEP-0060: fixed bad xmpp: URI generation in getNodeURI Goffi <goffi@goffi.org> parents: 1829 diff changeset	1350 # urlencode MUST NOT BE USED.
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1351 query_data = [("node", node.encode("utf-8"))]
1829 6079752ffeae plugin XEP-0060, XEP-0277: added getNodeURI method Goffi <goffi@goffi.org> parents: 1778 diff changeset	1352 if item is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1353 query_data.append(("item", item.encode("utf-8")))
1854 3c0bb714a80b plugin XEP-0060: fixed bad xmpp: URI generation in getNodeURI Goffi <goffi@goffi.org> parents: 1829 diff changeset	1354 return "xmpp:{service}?;{query}".format(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1355 service=service.userhost(), query=urllib.parse.urlencode(query_data)
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1356 )
1829 6079752ffeae plugin XEP-0060, XEP-0277: added getNodeURI method Goffi <goffi@goffi.org> parents: 1778 diff changeset	1357
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	1358 ## 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	1359
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1360 # generic #
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1361
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1362 def get_rt_results(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1363 self, session_id, on_success=None, on_error=None, profile=C.PROF_KEY_NONE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1364 ):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1365 return self.rt_sessions.get_results(session_id, on_success, on_error, profile)
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1366
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1367 def trans_items_data(self, items_data, item_cb=lambda item: item.toXml()):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1368 """Helper method to transform result from [get_items]
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1369
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1370 the items_data must be a tuple(list[domish.Element], dict[unicode, unicode])
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1371 as returned by [get_items].
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1372 @param items_data(tuple): tuple returned by [get_items]
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1373 @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	1374 @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	1375 """
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1376 items, metadata = items_data
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3272 diff changeset	1377 items = [item_cb(item) for item in items]
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2801 diff changeset	1378
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3272 diff changeset	1379 return (items, metadata)
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1380
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1381 def trans_items_data_d(self, items_data, item_cb):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1382 """Helper method to transform result from [get_items], deferred version
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1383
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1384 the items_data must be a tuple(list[domish.Element], dict[unicode, unicode])
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1385 as returned by [get_items]. metadata values are then casted to unicode and
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3272 diff changeset	1386 each item is passed to items_cb.
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2801 diff changeset	1387 An errback is added to item_cb, and when it is fired the value is filtered from
0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2801 diff changeset	1388 final items
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1389 @param items_data(tuple): tuple returned by [get_items]
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1390 @param item_cb(callable): method to transform each item (must return a deferred)
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3272 diff changeset	1391 @return (tuple): a deferred which fire a dict which can be serialised to go
384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3272 diff changeset	1392 throught bridge
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1393 """
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1394 items, metadata = items_data
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1395
3069 73db9db8b9e1 plugin XEP-0277: fixed comments URLs parsing Goffi <goffi@goffi.org> parents: 3062 diff changeset	1396 def eb(failure_):
3308 384283adcce1 plugins XEP-0059, XEP-0060, XEP-0277, XEP-0313: better serialisation: Goffi <goffi@goffi.org> parents: 3272 diff changeset	1397 log.warning(f"Error while parsing item: {failure_.value}")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1398
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1399 d = defer.gatherResults([item_cb(item).addErrback(eb) for item in items])
3492 fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1400 d.addCallback(lambda parsed_items: (
fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1401 [i for i in parsed_items if i is not None],
fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1402 metadata
fa796612adad plugin XEP-0277: better resilience to broken items: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1403 ))
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1404 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	1405
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1406 def ser_d_list(self, results, failure_result=None):
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1407 """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	1408
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1409 @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	1410 @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	1411 (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	1412 @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	1413 - 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	1414 - result
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1415 """
9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1416 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	1417 failure_result = ()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1418 return [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1419 ("", result)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1420 if success
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1421 else (str(result.result) or UNSPECIFIED, failure_result)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1422 for success, result in results
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1423 ]
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1449 diff changeset	1424
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	1425 # 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	1426
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1427 @utils.ensure_deferred
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1428 async def _get_node_subscriptions(
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1429 self,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1430 service: str,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1431 node: str,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1432 profile_key: str
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1433 ) -> Dict[str, str]:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1434 client = self.host.get_client(profile_key)
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1435 subs = await self.get_node_subscriptions(
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1436 client, jid.JID(service) if service else None, node
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1437 )
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1438 return {j.full(): a for j, a in subs.items()}
2338 b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1439
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1440 async def get_node_subscriptions(
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1441 self,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1442 client: SatXMPPEntity,
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1443 service: Optional[jid.JID],
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1444 nodeIdentifier: str
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1445 ) -> Dict[jid.JID, str]:
2338 b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1446 """Retrieve subscriptions to a node
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1447
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1448 @param nodeIdentifier(unicode): node to get subscriptions from
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1449 """
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1450 if not nodeIdentifier:
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1451 raise exceptions.DataError("node identifier can't be empty")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1452 request = pubsub.PubSubRequest("subscriptionsGet")
2338 b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1453 request.recipient = service
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1454 request.nodeIdentifier = nodeIdentifier
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1455
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1456 iq_elt = await request.send(client.xmlstream)
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1457 try:
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1458 subscriptions_elt = next(
4006 9456852d3286 plugin XEP-0060: fix namespace on node subscriptions request Goffi <goffi@goffi.org> parents: 3993 diff changeset	1459 iq_elt.pubsub.elements(pubsub.NS_PUBSUB_OWNER, "subscriptions")
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1460 )
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1461 except StopIteration:
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1462 raise ValueError(
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1463 _("Invalid result: missing <subscriptions> element: {}").format(
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1464 iq_elt.toXml
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1465 )
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1466 )
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1467 except AttributeError as e:
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1468 raise ValueError(_("Invalid result: {}").format(e))
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1469 try:
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1470 return {
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1471 jid.JID(s["jid"]): s["subscription"]
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1472 for s in subscriptions_elt.elements(
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1473 (pubsub.NS_PUBSUB, "subscription")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1474 )
3758 b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1475 }
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1476 except KeyError:
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1477 raise ValueError(
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1478 _("Invalid result: bad <subscription> element: {}").format(
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1479 iq_elt.toXml
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1480 )
b7cef1b24f83 plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: Goffi <goffi@goffi.org> parents: 3757 diff changeset	1481 )
2338 b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1482
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1483 def _set_node_subscriptions(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1484 self, service_s, nodeIdentifier, subscriptions, profile_key=C.PROF_KEY_NONE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1485 ):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1486 client = self.host.get_client(profile_key)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1487 subscriptions = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1488 jid.JID(jid_): subscription
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1489 for jid_, subscription in subscriptions.items()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1490 }
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1491 d = self.set_node_subscriptions(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1492 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1493 jid.JID(service_s) if service_s else None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1494 nodeIdentifier,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1495 subscriptions,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1496 )
2338 b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1497 return d
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1498
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1499 def set_node_subscriptions(self, client, service, nodeIdentifier, subscriptions):
2338 b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1500 """Set or update subscriptions of a node owned by profile
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1501
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1502 @param subscriptions(dict[jid.JID, unicode]): subscriptions to set
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1503 check https://xmpp.org/extensions/xep-0060.html#substates for a list of possible subscriptions
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1504 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1505 request = pubsub.PubSubRequest("subscriptionsSet")
2338 b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1506 request.recipient = service
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1507 request.nodeIdentifier = nodeIdentifier
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1508 request.subscriptions = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1509 pubsub.Subscription(nodeIdentifier, jid_, state)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1510 for jid_, state in subscriptions.items()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1511 }
2338 b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1512 d = request.send(client.xmlstream)
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1513 return d
b1bbd2994ceb plugin XEP-0060: implemented subscriptions management method for node owner: Goffi <goffi@goffi.org> parents: 2319 diff changeset	1514
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1515 def _many_subscribe_rt_result(self, session_id, profile_key=C.PROF_KEY_DEFAULT):
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	1516 """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	1517
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	1518 @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	1519 @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	1520 - 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	1521 - 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	1522 - 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	1523 - 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	1524 - 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	1525 @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	1526 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1527 profile = self.host.get_client(profile_key).profile
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1528 d = self.rt_sessions.get_results(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1529 session_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1530 on_success=lambda result: "",
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1531 on_error=lambda failure: str(failure.value),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1532 profile=profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1533 )
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	1534 # we need to convert jid.JID to unicode with full() to serialise it for the bridge
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1535 d.addCallback(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1536 lambda ret: (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1537 ret[0],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1538 [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1539 (service.full(), node, "" if success else failure or UNSPECIFIED)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1540 for (service, node), (success, failure) in ret[1].items()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1541 ],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1542 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1543 )
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	1544 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	1545
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1546 def _subscribe_to_many(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1547 self, node_data, subscriber=None, options=None, profile_key=C.PROF_KEY_NONE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1548 ):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1549 return self.subscribe_to_many(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1550 [(jid.JID(service), str(node)) for service, node in node_data],
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1551 jid.JID(subscriber),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1552 options,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1553 profile_key,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1554 )
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	1555
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1556 def subscribe_to_many(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1557 self, node_data, subscriber, options=None, profile_key=C.PROF_KEY_NONE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1558 ):
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	1559 """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	1560
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	1561 @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	1562 - 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	1563 - 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	1564 @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	1565 @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	1566 @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	1567 @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	1568 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1569 client = self.host.get_client(profile_key)
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	1570 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	1571 for service, node in node_data:
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	1572 deferreds[(service, node)] = defer.ensureDeferred(
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	1573 client.pubsub_client.subscribe(
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	1574 service, node, subscriber, options=options
edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	1575 )
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1576 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1577 return self.rt_sessions.new_session(deferreds, client.profile)
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	1578 # 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	1579 # 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	1580 # 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	1581 # 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	1582 # 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	1583 # 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	1584 # 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	1585 # 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	1586 # 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	1587
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1588 # get #
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1589
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1590 def _get_from_many_rt_result(self, session_id, profile_key=C.PROF_KEY_DEFAULT):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1591 """Get real-time results for get_from_many session
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1592
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1593 @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	1594 @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	1595 @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	1596 - 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	1597 - 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	1598 - service (unicode): pubsub service
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1599 - node (unicode): pubsub node
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1600 - 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	1601 - 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	1602 - metadata(dict): serialised metadata
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1603 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1604 profile = self.host.get_client(profile_key).profile
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1605 d = self.rt_sessions.get_results(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1606 session_id,
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1607 on_success=lambda result: ("", self.trans_items_data(result)),
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1608 on_error=lambda failure: (str(failure.value) or UNSPECIFIED, ([], {})),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1609 profile=profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1610 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1611 d.addCallback(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1612 lambda ret: (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1613 ret[0],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1614 [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1615 (service.full(), node, failure, items, metadata)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1616 for (service, node), (success, (failure, (items, metadata))) in ret[
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1617 1
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1618 ].items()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1619 ],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1620 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1621 )
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1622 return d
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1623
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1624 def _get_from_many(
3586 5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict Goffi <goffi@goffi.org> parents: 3584 diff changeset	1625 self, node_data, max_item=10, extra="", profile_key=C.PROF_KEY_NONE
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1626 ):
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1627 """
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1628 @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	1629 """
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1630 max_item = None if max_item == C.NO_LIMIT else max_item
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1631 extra = self.parse_extra(data_format.deserialise(extra))
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1632 return self.get_from_many(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1633 [(jid.JID(service), str(node)) for service, node in node_data],
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1634 max_item,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1635 extra.rsm_request,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1636 extra.extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1637 profile_key,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1638 )
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1639
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1640 def get_from_many(self, node_data, max_item=None, rsm_request=None, extra=None,
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2801 diff changeset	1641 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	1642 """Get items from many nodes at once
2203 427391c706eb plugin XEP-0060: added affiliation handling: Goffi <goffi@goffi.org> parents: 2201 diff changeset	1643
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1644 @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	1645 - 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	1646 - 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	1647 @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	1648 @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	1649 @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	1650 @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	1651 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1652 client = self.host.get_client(profile_key)
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1653 deferreds = {}
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1654 for service, node in node_data:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1655 deferreds[(service, node)] = defer.ensureDeferred(self.get_items(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1656 client, service, node, max_item, rsm_request=rsm_request, extra=extra
3584 edc79cefe968 plugin XEP-0060: `getItem(s)`, `publish` and `(un)subscribe` are now coroutines Goffi <goffi@goffi.org> parents: 3519 diff changeset	1657 ))
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1658 return self.rt_sessions.new_session(deferreds, client.profile)
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	1659
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1660
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1661 @implementer(disco.IDisco)
1267 ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	1662 class SatPubSubClient(rsm.PubSubClient):
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	1663
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	1664 def __init__(self, host, parent_plugin):
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1665 self.host = host
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	1666 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	1667 rsm.PubSubClient.__init__(self)
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	1668
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	1669 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	1670 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	1671
3934 e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1672 async def items(
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1673 self,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1674 service: Optional[jid.JID],
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1675 nodeIdentifier: str,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1676 maxItems: Optional[int] = None,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1677 subscriptionIdentifier: Optional[str] = None,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1678 sender: Optional[jid.JID] = None,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1679 itemIdentifiers: Optional[Set[str]] = None,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1680 orderBy: Optional[List[str]] = None,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1681 rsm_request: Optional[rsm.RSMRequest] = None,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1682 extra: Optional[Dict[str, Any]] = None,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1683 ):
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1684 if extra is None:
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1685 extra = {}
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1686 items, rsm_response = await super().items(
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1687 service, nodeIdentifier, maxItems, subscriptionIdentifier, sender,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1688 itemIdentifiers, orderBy, rsm_request
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1689 )
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1690 # items must be returned, thus this async point can't stop the workflow (but it
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1691 # can modify returned items)
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1692 await self.host.trigger.async_point(
3934 e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1693 "XEP-0060_items", self.parent, service, nodeIdentifier, items, rsm_response,
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1694 extra
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1695 )
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1696 return items, rsm_response
e345d93fb6e5 plugin OXPS: OpenPGP for XMPP Pubsub implementation: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1697
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1698 def _get_node_callbacks(self, node, event):
1760 30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1699 """Generate callbacks from given node and event
30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1700
30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1701 @param node(unicode): node used for the item
30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1702 any registered node which prefix the node will match
30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1703 @param event(unicode): one of C.PS_ITEMS, C.PS_RETRACT, C.PS_DELETE
30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1704 @return (iterator[callable]): callbacks for this node/event
30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1705 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1706 for registered_node, callbacks_dict in self.parent_plugin._node_cb.items():
1760 30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1707 if not node.startswith(registered_node):
30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1708 continue
30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1709 try:
3849 bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1710 for callback_data in callbacks_dict[event]:
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1711 yield callback_data[0]
1760 30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1712 except KeyError:
30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1713 continue
30efe084471c plugin XEP-0060: None is no more used in addManagedNode, but all nodes prefixed with a registered one are now triggered Goffi <goffi@goffi.org> parents: 1678 diff changeset	1714
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1715 async def _call_node_callbacks(self, client, event: pubsub.ItemsEvent) -> None:
3849 bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1716 """Call sequencially event callbacks of a node
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1717
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1718 Callbacks are called sequencially and not in parallel to be sure to respect
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1719 priority (notably for plugin needing to get old items before they are modified or
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1720 deleted from cache).
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1721 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1722 for callback in self._get_node_callbacks(event.nodeIdentifier, C.PS_ITEMS):
3849 bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1723 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1724 await utils.as_deferred(callback, client, event)
3849 bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1725 except Exception as e:
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1726 log.error(
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1727 f"Error while running items event callback {callback}: {e}"
bc24ce903835 plugin XEP-0060: handle priority in `addManagedNode`: Goffi <goffi@goffi.org> parents: 3815 diff changeset	1728 )
2760 3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2758 diff changeset	1729
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	1730 def itemsReceived(self, event):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1731 log.debug("Pubsub items received")
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1732 client = self.parent
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1733 defer.ensureDeferred(self._call_node_callbacks(client, event))
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1734 if (event.sender, event.nodeIdentifier) in client.pubsub_watching:
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1735 raw_items = [i.toXml() for i in event.items]
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1736 self.host.bridge.ps_event_raw(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1737 event.sender.full(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1738 event.nodeIdentifier,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1739 C.PS_ITEMS,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1740 raw_items,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1741 client.profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1742 )
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	1743
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	1744 def deleteReceived(self, event):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2911 diff changeset	1745 log.debug(("Publish node deleted"))
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1746 for callback in self._get_node_callbacks(event.nodeIdentifier, C.PS_DELETE):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1747 d = utils.as_deferred(callback, self.parent, event)
3588 2c7a52a62be3 plugin XEP-0060: events callbacks can now be sync or async Goffi <goffi@goffi.org> parents: 3587 diff changeset	1748 d.addErrback(lambda f: log.error(
2c7a52a62be3 plugin XEP-0060: events callbacks can now be sync or async Goffi <goffi@goffi.org> parents: 3587 diff changeset	1749 f"Error while running delete event callback {callback}: {f}"
2c7a52a62be3 plugin XEP-0060: events callbacks can now be sync or async Goffi <goffi@goffi.org> parents: 3587 diff changeset	1750 ))
2444 30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1751 client = self.parent
30278ea1ca7c plugin XEP-0060: added node watching methods to bridge: Goffi <goffi@goffi.org> parents: 2442 diff changeset	1752 if (event.sender, event.nodeIdentifier) in client.pubsub_watching:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1753 self.host.bridge.ps_event_raw(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1754 event.sender.full(), event.nodeIdentifier, C.PS_DELETE, [], client.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1755 )
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	1756
3587 2715da5b2aa7 plugin XEP-0060: handle purge notifications Goffi <goffi@goffi.org> parents: 3586 diff changeset	1757 def purgeReceived(self, event):
2715da5b2aa7 plugin XEP-0060: handle purge notifications Goffi <goffi@goffi.org> parents: 3586 diff changeset	1758 log.debug(("Publish node purged"))
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1759 for callback in self._get_node_callbacks(event.nodeIdentifier, C.PS_PURGE):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1760 d = utils.as_deferred(callback, self.parent, event)
3587 2715da5b2aa7 plugin XEP-0060: handle purge notifications Goffi <goffi@goffi.org> parents: 3586 diff changeset	1761 d.addErrback(lambda f: log.error(
2715da5b2aa7 plugin XEP-0060: handle purge notifications Goffi <goffi@goffi.org> parents: 3586 diff changeset	1762 f"Error while running purge event callback {callback}: {f}"
2715da5b2aa7 plugin XEP-0060: handle purge notifications Goffi <goffi@goffi.org> parents: 3586 diff changeset	1763 ))
2715da5b2aa7 plugin XEP-0060: handle purge notifications Goffi <goffi@goffi.org> parents: 3586 diff changeset	1764 client = self.parent
2715da5b2aa7 plugin XEP-0060: handle purge notifications Goffi <goffi@goffi.org> parents: 3586 diff changeset	1765 if (event.sender, event.nodeIdentifier) in client.pubsub_watching:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1766 self.host.bridge.ps_event_raw(
3587 2715da5b2aa7 plugin XEP-0060: handle purge notifications Goffi <goffi@goffi.org> parents: 3586 diff changeset	1767 event.sender.full(), event.nodeIdentifier, C.PS_PURGE, [], client.profile
2715da5b2aa7 plugin XEP-0060: handle purge notifications Goffi <goffi@goffi.org> parents: 3586 diff changeset	1768 )
2715da5b2aa7 plugin XEP-0060: handle purge notifications Goffi <goffi@goffi.org> parents: 3586 diff changeset	1769
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	1770 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	1771 """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	1772
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	1773 @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	1774 @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	1775 @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	1776 @type nodeIdentifier: C{unicode}
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1777 @return (list[pubsub.Subscription]): list of subscriptions
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	1778 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1779 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	1780 request.recipient = service
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	1781 request.nodeIdentifier = nodeIdentifier
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	1782 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	1783 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	1784
ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	1785 def cb(iq):
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1786 subs = []
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1787 for subscription_elt in iq.pubsub.subscriptions.elements(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1788 pubsub.NS_PUBSUB, "subscription"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1789 ):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1790 subscription = pubsub.Subscription(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1791 subscription_elt["node"],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1792 jid.JID(subscription_elt["jid"]),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1793 subscription_elt["subscription"],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1794 subscriptionIdentifier=subscription_elt.getAttribute("subid"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1795 )
2352 6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1796 subs.append(subscription)
6c26f435a02d plugin XEP-0060: added/fixed subscribe/unsubscribe and subscriptions methods/bridge methods: Goffi <goffi@goffi.org> parents: 2338 diff changeset	1797 return subs
1267 ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	1798
ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1261 diff changeset	1799 return d.addCallback(cb)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1800
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4006 diff changeset	1801 def purge_node(self, service, nodeIdentifier):
2801 ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1802 """Purge a node (i.e. delete all items from it)
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1803
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1804 @param service(jid.JID, None): service to send the item to
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1805 None to use PEP
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1806 @param NodeIdentifier(unicode): PubSub node to use
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1807 """
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1808 # TODO: propose this upstream and remove it once merged
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1809 request = pubsub.PubSubRequest('purge')
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1810 request.recipient = service
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1811 request.nodeIdentifier = nodeIdentifier
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1812 return request.send(self.xmlstream)
ae127e14b040 plugin XEP-0060: added purgeNode/psNodePurge method to remove all items from a node Goffi <goffi@goffi.org> parents: 2800 diff changeset	1813
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1814 def getDiscoInfo(self, requestor, service, nodeIdentifier=""):
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	1815 disco_info = []
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	1816 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	1817 return disco_info
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 993 diff changeset	1818
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1819 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	1820 return []

Mercurial > libervia-backend

annotate sat/plugins/plugin_xep_0060.py @ 4043:9641ce286e07