libervia-backend: sat/plugins/plugin_exp_pubsub

annotate sat/plugins/plugin_exp_pubsub_schema.py @ 3086:13be04a70e2f

plugin XEP-0045: show join error even if it's not a StanzaError, log it with warning instead of error

author	Goffi <goffi@goffi.org>
date	Fri, 20 Dec 2019 12:28:04 +0100
parents	68d423f4fb55
children	9d0df638c8b4

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	1 #!/usr/bin/env python3
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	3
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	4 # SAT plugin for Pubsub Schemas
2771 003b8b4b56a7 date update Goffi <goffi@goffi.org> parents: 2760 diff changeset	5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	6
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	10 # (at your option) any later version.
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	11
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	16
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	19
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	20 from collections import Iterable
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	21 import itertools
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	22 from zope.interface import implementer
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	23 from twisted.words.protocols.jabber import jid
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	24 from twisted.words.protocols.jabber.xmlstream import XMPPHandler
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	25 from twisted.words.xish import domish
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	26 from twisted.internet import defer
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	27 from wokkel import disco, iwokkel
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	28 from wokkel import data_form
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	29 from wokkel import generic
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	30 from sat.core.i18n import _
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	31 from sat.core import exceptions
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	32 from sat.core.constants import Const as C
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	33 from sat.tools import xml_tools
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	34 from sat.tools import utils
2612 3e4e78de9cca tools (date_utils): moved date_parse to common.date_utils, because it can be used in frontends Goffi <goffi@goffi.org> parents: 2603 diff changeset	35 from sat.tools.common import date_utils
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	36 from sat.tools.common import data_format
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	37 from sat.core.log import getLogger
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	38
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	39 log = getLogger(__name__)
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	40
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	41 NS_SCHEMA = "https://salut-a-toi/protocol/schema:0"
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	42
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	43 PLUGIN_INFO = {
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	44 C.PI_NAME: "PubSub Schema",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	45 C.PI_IMPORT_NAME: "PUBSUB_SCHEMA",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	46 C.PI_TYPE: "EXP",
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	47 C.PI_PROTOCOLS: [],
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	48 C.PI_DEPENDENCIES: ["XEP-0060", "IDENTITY"],
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	49 C.PI_MAIN: "PubsubSchema",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	50 C.PI_HANDLER: "yes",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	51 C.PI_DESCRIPTION: _("""Handle Pubsub data schemas"""),
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	52 }
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	53
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	54
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	55 class PubsubSchema(object):
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	56 def __init__(self, host):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	57 log.info(_("PubSub Schema initialization"))
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	58 self.host = host
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	59 self._p = self.host.plugins["XEP-0060"]
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	60 self._i = self.host.plugins["IDENTITY"]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	61 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	62 "psSchemaGet",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	63 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	64 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	65 out_sign="s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	66 method=self._getSchema,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	67 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	68 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	69 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	70 "psSchemaSet",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	71 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	72 in_sign="ssss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	73 out_sign="",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	74 method=self._setSchema,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	75 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	76 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	77 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	78 "psSchemaUIGet",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	79 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	80 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	81 out_sign="s",
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	82 method=lambda service, nodeIdentifier, profile_key: self._getUISchema(
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	83 service, nodeIdentifier, default_node=None, profile_key=profile_key),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	84 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	85 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	86 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	87 "psItemsFormGet",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	88 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	89 in_sign="ssssiassa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	90 out_sign="(asa{ss})",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	91 method=self._getDataFormItems,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	92 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	93 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	94 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	95 "psItemFormSend",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	96 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	97 in_sign="ssa{sas}ssa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	98 out_sign="s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	99 method=self._sendDataFormItem,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	100 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	101 )
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	102
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	103 def getHandler(self, client):
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	104 return SchemaHandler()
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	105
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	106 def _getSchemaBridgeCb(self, schema_elt):
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	107 if schema_elt is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	108 return ""
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	109 return schema_elt.toXml()
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	110
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	111 def _getSchema(self, service, nodeIdentifier, profile_key=C.PROF_KEY_NONE):
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	112 client = self.host.getClient(profile_key)
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	113 service = None if not service else jid.JID(service)
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	114 d = self.getSchema(client, service, nodeIdentifier)
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	115 d.addCallback(self._getSchemaBridgeCb)
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	116 return d
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	117
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	118 def _getSchemaCb(self, iq_elt):
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	119 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	120 schema_elt = next(iq_elt.elements(NS_SCHEMA, "schema"))
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	121 except StopIteration:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	122 raise exceptions.DataError("missing <schema> element")
2395 713cedc99752 plugin pubsub schema: allow any data_form schema: Goffi <goffi@goffi.org> parents: 2388 diff changeset	123 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	124 x_elt = next(schema_elt.elements((data_form.NS_X_DATA, "x")))
2395 713cedc99752 plugin pubsub schema: allow any data_form schema: Goffi <goffi@goffi.org> parents: 2388 diff changeset	125 except StopIteration:
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	126 # there is not schema on this node
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	127 return None
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	128 return x_elt
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	129
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	130 def getSchema(self, client, service, nodeIdentifier):
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	131 """retrieve PubSub node schema
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	132
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	133 @param service(jid.JID, None): jid of PubSub service
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	134 None to use our PEP
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	135 @param nodeIdentifier(unicode): node to get schema from
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	136 @return (domish.Element, None): schema (<x> element)
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	137 None if not schema has been set on this node
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	138 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	139 iq_elt = client.IQ("get")
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	140 if service is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	141 iq_elt["to"] = service.full()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	142 pubsub_elt = iq_elt.addElement((NS_SCHEMA, "pubsub"))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	143 schema_elt = pubsub_elt.addElement((NS_SCHEMA, "schema"))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	144 schema_elt["node"] = nodeIdentifier
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	145 d = iq_elt.send()
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	146 d.addCallback(self._getSchemaCb)
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	147 return d
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	148
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	149 @defer.inlineCallbacks
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	150 def getSchemaForm(self, client, service, nodeIdentifier, schema=None,
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	151 form_type="form", copy_form=True):
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	152 """get data form from node's schema
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	153
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	154 @param service(None, jid.JID): PubSub service
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	155 @param nodeIdentifier(unicode): node
2371 2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	156 @param schema(domish.Element, data_form.Form, None): node schema
2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	157 if domish.Element, will be converted to data form
2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	158 if data_form.Form it will be returned without modification
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	159 if None, it will be retrieved from node (imply one additional XMPP request)
2386 2e05921df16a plugin schema, core(xmlui): deep copy base form when reused to avoid accidental modification Goffi <goffi@goffi.org> parents: 2381 diff changeset	160 @param form_type(unicode): type of the form
2e05921df16a plugin schema, core(xmlui): deep copy base form when reused to avoid accidental modification Goffi <goffi@goffi.org> parents: 2381 diff changeset	161 @param copy_form(bool): if True and if schema is already a data_form.Form, will deep copy it before returning
2e05921df16a plugin schema, core(xmlui): deep copy base form when reused to avoid accidental modification Goffi <goffi@goffi.org> parents: 2381 diff changeset	162 needed when the form is reused and it will be modified (e.g. in sendDataFormItem)
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	163 @return(data_form.Form): data form
2386 2e05921df16a plugin schema, core(xmlui): deep copy base form when reused to avoid accidental modification Goffi <goffi@goffi.org> parents: 2381 diff changeset	164 the form should not be modified if copy_form is not set
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	165 """
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	166 if schema is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	167 log.debug(_("unspecified schema, we need to request it"))
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	168 schema = yield self.getSchema(client, service, nodeIdentifier)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	169 if schema is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	170 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	171 _(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	172 "no schema specified, and this node has no schema either, we can't construct the data form"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	173 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	174 )
2371 2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	175 elif isinstance(schema, data_form.Form):
2386 2e05921df16a plugin schema, core(xmlui): deep copy base form when reused to avoid accidental modification Goffi <goffi@goffi.org> parents: 2381 diff changeset	176 if copy_form:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	177 # XXX: we don't use deepcopy as it will do an infinite loop if a
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	178 # domish.Element is present in the form fields (happens for
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	179 # XEP-0315 data forms XML Element)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	180 schema = data_form.Form(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	181 formType = schema.formType,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	182 title = schema.title,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	183 instructions = schema.instructions[:],
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	184 formNamespace = schema.formNamespace,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	185 fields = schema.fieldList,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	186 )
2371 2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	187 defer.returnValue(schema)
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	188
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	189 try:
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	190 form = data_form.Form.fromElement(schema)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	191 except data_form.Error as e:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	192 raise exceptions.DataError(_("Invalid Schema: {msg}").format(msg=e))
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	193 form.formType = form_type
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	194 defer.returnValue(form)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	195
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	196 def schema2XMLUI(self, schema_elt):
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	197 form = data_form.Form.fromElement(schema_elt)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	198 xmlui = xml_tools.dataForm2XMLUI(form, "")
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	199 return xmlui
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	200
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	201 def _getUISchema(self, service, nodeIdentifier, default_node=None,
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	202 profile_key=C.PROF_KEY_NONE):
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	203 if not nodeIdentifier:
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	204 if not default_node:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	205 raise ValueError(_("nodeIndentifier needs to be set"))
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	206 nodeIdentifier = default_node
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	207 client = self.host.getClient(profile_key)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	208 service = None if not service else jid.JID(service)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	209 d = self.getUISchema(client, service, nodeIdentifier)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	210 d.addCallback(lambda xmlui: xmlui.toXml())
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	211 return d
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	212
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	213 def getUISchema(self, client, service, nodeIdentifier):
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	214 d = self.getSchema(client, service, nodeIdentifier)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	215 d.addCallback(self.schema2XMLUI)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	216 return d
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	217
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	218 def _setSchema(self, service, nodeIdentifier, schema, profile_key=C.PROF_KEY_NONE):
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	219 client = self.host.getClient(profile_key)
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	220 service = None if not service else jid.JID(service)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	221 schema = generic.parseXml(schema.encode("utf-8"))
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	222 return self.setSchema(client, service, nodeIdentifier, schema)
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	223
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	224 def setSchema(self, client, service, nodeIdentifier, schema):
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	225 """set or replace PubSub node schema
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	226
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	227 @param schema(domish.Element, None): schema to set
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	228 None if schema need to be removed
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	229 """
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	230 iq_elt = client.IQ()
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	231 if service is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	232 iq_elt["to"] = service.full()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	233 pubsub_elt = iq_elt.addElement((NS_SCHEMA, "pubsub"))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	234 schema_elt = pubsub_elt.addElement((NS_SCHEMA, "schema"))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	235 schema_elt["node"] = nodeIdentifier
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	236 if schema is not None:
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	237 schema_elt.addChild(schema)
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	238 return iq_elt.send()
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	239
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	240 def _getDataFormItems(self, form_ns="", service="", node="", schema="", max_items=10,
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	241 item_ids=None, sub_id=None, extra_dict=None,
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	242 profile_key=C.PROF_KEY_NONE):
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	243 client = self.host.getClient(profile_key)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	244 service = jid.JID(service) if service else None
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2395 diff changeset	245 if not node:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	246 raise exceptions.DataError(_("empty node is not allowed"))
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	247 if schema:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	248 schema = generic.parseXml(schema.encode("utf-8"))
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	249 else:
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	250 schema = None
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	251 max_items = None if max_items == C.NO_LIMIT else max_items
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	252 extra = self._p.parseExtra(extra_dict)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	253 d = self.getDataFormItems(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	254 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	255 service,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	256 node,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	257 schema,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	258 max_items or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	259 item_ids,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	260 sub_id or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	261 extra.rsm_request,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	262 extra.extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	263 form_ns=form_ns or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	264 )
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2784 diff changeset	265 d.addCallback(self._p.transItemsData)
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	266 return d
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	267
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	268 @defer.inlineCallbacks
2760 3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2624 diff changeset	269 def getDataFormItems(self, client, service, nodeIdentifier, schema=None,
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2624 diff changeset	270 max_items=None, item_ids=None, sub_id=None, rsm_request=None,
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	271 extra=None, default_node=None, form_ns=None, filters=None):
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	272 """Get items known as being data forms, and convert them to XMLUI
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	273
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	274 @param schema(domish.Element, data_form.Form, None): schema of the node if known
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	275 if None, it will be retrieved from node
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	276 @param default_node(unicode): node to use if nodeIdentifier is None or empty
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	277 @param form_ns (unicode, None): namespace of the form
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	278 None to accept everything, even if form has no namespace
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2395 diff changeset	279 @param filters(dict, None): same as for xml_tools.dataFormResult2XMLUI
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	280 other parameters as the same as for [getItems]
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	281 @return (list[unicode]): XMLUI of the forms
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	282 if an item is invalid (not corresponding to form_ns or not a data_form)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	283 it will be skipped
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	284 @raise ValueError: one argument is invalid
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	285 """
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	286 if not nodeIdentifier:
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	287 if not default_node:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	288 raise ValueError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	289 _("default_node must be set if nodeIdentifier is not set")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	290 )
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	291 nodeIdentifier = default_node
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	292 # we need the initial form to get options of fields when suitable
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	293 schema_form = yield self.getSchemaForm(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	294 client, service, nodeIdentifier, schema, form_type="result", copy_form=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	295 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	296 items_data = yield self._p.getItems(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	297 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	298 service,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	299 nodeIdentifier,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	300 max_items,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	301 item_ids,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	302 sub_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	303 rsm_request,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	304 extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	305 )
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	306 items, metadata = items_data
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	307 items_xmlui = []
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	308 for item_elt in items:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	309 for x_elt in item_elt.elements((data_form.NS_X_DATA, "x")):
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	310 form = data_form.Form.fromElement(x_elt)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	311 if form_ns and form.formNamespace != form_ns:
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	312 continue
2381 72c30e73a9a5 plugin schema: use new "prepend" argument to put "id" widget first. Goffi <goffi@goffi.org> parents: 2378 diff changeset	313 xmlui = xml_tools.dataFormResult2XMLUI(
72c30e73a9a5 plugin schema: use new "prepend" argument to put "id" widget first. Goffi <goffi@goffi.org> parents: 2378 diff changeset	314 form,
72c30e73a9a5 plugin schema: use new "prepend" argument to put "id" widget first. Goffi <goffi@goffi.org> parents: 2378 diff changeset	315 schema_form,
2426 6c39f30444a0 plugin schema: prepend a "publisher" field after "id" in getDataFormItems with published given by PubSub service Goffi <goffi@goffi.org> parents: 2421 diff changeset	316 # FIXME: conflicts with schema (i.e. if "id" or "publisher" already exists)
6c39f30444a0 plugin schema: prepend a "publisher" field after "id" in getDataFormItems with published given by PubSub service Goffi <goffi@goffi.org> parents: 2421 diff changeset	317 # are not checked
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	318 prepend=(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	319 ("label", "id"),
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	320 ("text", item_elt["id"], "id"),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	321 ("label", "publisher"),
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	322 ("text", item_elt.getAttribute("publisher", ""), "publisher"),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	323 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	324 filters=filters,
2958 e2cb04b381bb tools (xml_tools): added "read_only" argument in dataFormResult2XMLUI (and use it in plugin pubsub_schema) Goffi <goffi@goffi.org> parents: 2807 diff changeset	325 read_only=False,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	326 )
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	327 items_xmlui.append(xmlui)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	328 break
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	329 defer.returnValue((items_xmlui, metadata))
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	330
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	331 def _sendDataFormItem(self, service, nodeIdentifier, values, schema=None,
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	332 item_id=None, extra=None, profile_key=C.PROF_KEY_NONE):
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	333 client = self.host.getClient(profile_key)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	334 service = None if not service else jid.JID(service)
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	335 if schema:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	336 schema = generic.parseXml(schema.encode("utf-8"))
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	337 else:
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	338 schema = None
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	339 d = self.sendDataFormItem(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	340 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	341 service,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	342 nodeIdentifier,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	343 values,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	344 schema,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	345 item_id or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	346 extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	347 deserialise=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	348 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	349 d.addCallback(lambda ret: ret or "")
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	350 return d
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	351
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	352 @defer.inlineCallbacks
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	353 def sendDataFormItem(self, client, service, nodeIdentifier, values, schema=None,
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	354 item_id=None, extra=None, deserialise=False):
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	355 """Publish an item as a dataform when we know that there is a schema
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	356
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	357 @param values(dict[key(unicode), [iterable[object], object]]): values set for the
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	358 form. If not iterable, will be put in a list.
2371 2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	359 @param schema(domish.Element, data_form.Form, None): data schema
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	360 None to retrieve data schema from node (need to do a additional XMPP call)
2371 2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	361 Schema is needed to construct data form to publish
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	362 @param deserialise(bool): if True, data are list of unicode and must be
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	363 deserialized according to expected type.
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	364 This is done in this method and not directly in _sendDataFormItem because we
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	365 need to know the data type which is in the form, not availablable in
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	366 _sendDataFormItem
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	367 other parameters as the same as for [self._p.sendItem]
2420 03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2398 diff changeset	368 @return (unicode): id of the created item
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	369 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	370 form = yield self.getSchemaForm(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	371 client, service, nodeIdentifier, schema, form_type="submit"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	372 )
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	373
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	374 for name, values_list in values.items():
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	375 try:
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	376 field = form.fields[name]
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	377 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	378 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	379 _("field {name} doesn't exist, ignoring it").format(name=name)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	380 )
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	381 continue
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	382 if isinstance(values_list, str) or not isinstance(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	383 values_list, Iterable
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	384 ):
2371 2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	385 values_list = [values_list]
2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	386 if deserialise:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	387 if field.fieldType == "boolean":
2371 2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	388 values_list = [C.bool(v) for v in values_list]
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	389 elif field.fieldType == "text-multi":
2421 b7e24ce97a06 plugin schema: separate lines of text-multi in different values as requested by XEP-0004 Goffi <goffi@goffi.org> parents: 2420 diff changeset	390 # for text-multi, lines must be put on separate values
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	391 values_list = list(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	392 itertools.chain(*[v.splitlines() for v in values_list])
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	393 )
2784 76ebecdb9b1e plugin pubsub schema: handle XHTML fields Goffi <goffi@goffi.org> parents: 2774 diff changeset	394 elif xml_tools.isXHTMLField(field):
76ebecdb9b1e plugin pubsub schema: handle XHTML fields Goffi <goffi@goffi.org> parents: 2774 diff changeset	395 values_list = [generic.parseXml(v.encode("utf-8"))
76ebecdb9b1e plugin pubsub schema: handle XHTML fields Goffi <goffi@goffi.org> parents: 2774 diff changeset	396 for v in values_list]
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	397 elif "jid" in (field.fieldType or ""):
2371 2268df8c99bf plugin pubsub schema: values handling: Goffi <goffi@goffi.org> parents: 2363 diff changeset	398 values_list = [jid.JID(v) for v in values_list]
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	399 if "list" in (field.fieldType or ""):
2388 4c883d1c3e81 plugin schema: when publishing a schema, check that values of list are allowed, else use default value Goffi <goffi@goffi.org> parents: 2386 diff changeset	400 # for lists, we check that given values are allowed in form
4c883d1c3e81 plugin schema: when publishing a schema, check that values of list are allowed, else use default value Goffi <goffi@goffi.org> parents: 2386 diff changeset	401 allowed_values = [o.value for o in field.options]
4c883d1c3e81 plugin schema: when publishing a schema, check that values of list are allowed, else use default value Goffi <goffi@goffi.org> parents: 2386 diff changeset	402 values_list = [v for v in values_list if v in allowed_values]
4c883d1c3e81 plugin schema: when publishing a schema, check that values of list are allowed, else use default value Goffi <goffi@goffi.org> parents: 2386 diff changeset	403 if not values_list:
4c883d1c3e81 plugin schema: when publishing a schema, check that values of list are allowed, else use default value Goffi <goffi@goffi.org> parents: 2386 diff changeset	404 # if values don't map to allowed values, we use default ones
4c883d1c3e81 plugin schema: when publishing a schema, check that values of list are allowed, else use default value Goffi <goffi@goffi.org> parents: 2386 diff changeset	405 values_list = field.values
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	406 elif field.ext_type == 'xml':
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	407 # FIXME: XML elements are not handled correctly, we need to know if we
3071 68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	408 # have actual XML/XHTML, or text to escape
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	409 for idx, value in enumerate(values_list[:]):
3071 68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	410 if isinstance(value, domish.Element):
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	411 if (field.value and (value.name != field.value.name
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	412 or value.uri != field.value.uri)):
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	413 # the element is not the one expected in form, so we create the right element
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	414 # to wrap the current value
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	415 wrapper_elt = domish.Element((field.value.uri, field.value.name))
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	416 wrapper_elt.addChild(value)
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	417 values_list[idx] = wrapper_elt
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	418 else:
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	419 # we have to convert the value to a domish.Element
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	420 if field.value and field.value.uri == C.NS_XHTML:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	421 div_elt = domish.Element((C.NS_XHTML, 'div'))
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	422 div_elt.addContent(str(value))
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	423 values_list[idx] = div_elt
3071 68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	424 else:
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	425 # only XHTML fields are handled for now
68d423f4fb55 plugin pubsub schema: fixed XML field handling in `sendDataFormItem` Goffi <goffi@goffi.org> parents: 3040 diff changeset	426 raise NotImplementedError
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	427
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	428 field.values = values_list
41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	429
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	430 yield self._p.sendItem(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	431 client, service, nodeIdentifier, form.toElement(), item_id, extra
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	432 )
2363 41c7717b52cd plugin PubSub Schema: schema helper methods: Goffi <goffi@goffi.org> parents: 2350 diff changeset	433
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	434 ## filters ##
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	435 # filters useful for data form to XMLUI conversion #
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	436
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	437 def valueOrPublisherFilter(self, form_xmlui, widget_type, args, kwargs):
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	438 """Replace missing value by publisher's user part"""
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	439 if not args[0]:
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	440 # value is not filled: we use user part of publisher (if we have it)
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	441 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	442 publisher = jid.JID(form_xmlui.named_widgets["publisher"].value)
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	443 except (KeyError, RuntimeError):
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	444 pass
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	445 else:
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	446 args[0] = publisher.user.capitalize()
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	447 return widget_type, args, kwargs
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	448
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	449 def textbox2ListFilter(self, form_xmlui, widget_type, args, kwargs):
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	450 """Split lines of a textbox in a list
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	451
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	452 main use case is using a textbox for labels
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	453 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	454 if widget_type != "textbox":
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	455 return widget_type, args, kwargs
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	456 widget_type = "list"
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	457 options = [o for o in args.pop(0).split("\n") if o]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	458 kwargs = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	459 "options": options,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	460 "name": kwargs.get("name"),
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	461 "styles": ("noselect", "extensible", "reducible"),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	462 }
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	463 return widget_type, args, kwargs
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	464
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	465 def dateFilter(self, form_xmlui, widget_type, args, kwargs):
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	466 """Convert a string with a date to a unix timestamp"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	467 if widget_type != "string" or not args[0]:
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	468 return widget_type, args, kwargs
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	469 # we convert XMPP date to timestamp
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	470 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	471 args[0] = str(date_utils.date_parse(args[0]))
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	472 except Exception as e:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	473 log.warning(_("Can't parse date field: {msg}").format(msg=e))
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	474 return widget_type, args, kwargs
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	475
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	476 ## Helper methods ##
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	477
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	478 def prepareBridgeGet(self, service, node, max_items, sub_id, extra_dict, profile_key):
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	479 """Parse arguments received from bridge *Get methods and return higher level data
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	480
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	481 @return (tuple): (client, service, node, max_items, extra, sub_id) usable for
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	482 internal methods
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	483 """
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	484 client = self.host.getClient(profile_key)
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	485 service = jid.JID(service) if service else None
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	486 if not node:
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	487 node = None
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	488 max_items = None if max_items == C.NO_LIMIT else max_items
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	489 if not sub_id:
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	490 sub_id = None
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	491 extra = self._p.parseExtra(extra_dict)
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	492
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	493 return client, service, node, max_items, extra, sub_id
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	494
2760 3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2624 diff changeset	495 def _get(self, service="", node="", max_items=10, item_ids=None, sub_id=None,
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2624 diff changeset	496 extra=None, default_node=None, form_ns=None, filters=None,
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2624 diff changeset	497 profile_key=C.PROF_KEY_NONE):
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	498 """Bridge method to retrieve data from node with schema
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	499
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	500 this method is a helper so dependant plugins can use it directly
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	501 when adding *Get methods
2603 5d4ac5415b40 plugins schema, merge-requests, tickets: convert labels from textbox to list only when "labels_as_list" is set in extra parameters. Goffi <goffi@goffi.org> parents: 2562 diff changeset	502 extra can have the key "labels_as_list" which is a hack to convert
5d4ac5415b40 plugins schema, merge-requests, tickets: convert labels from textbox to list only when "labels_as_list" is set in extra parameters. Goffi <goffi@goffi.org> parents: 2562 diff changeset	503 labels from textbox to list in XMLUI, which usually render better
5d4ac5415b40 plugins schema, merge-requests, tickets: convert labels from textbox to list only when "labels_as_list" is set in extra parameters. Goffi <goffi@goffi.org> parents: 2562 diff changeset	504 in final UI.
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	505 """
2603 5d4ac5415b40 plugins schema, merge-requests, tickets: convert labels from textbox to list only when "labels_as_list" is set in extra parameters. Goffi <goffi@goffi.org> parents: 2562 diff changeset	506 if filters is None:
5d4ac5415b40 plugins schema, merge-requests, tickets: convert labels from textbox to list only when "labels_as_list" is set in extra parameters. Goffi <goffi@goffi.org> parents: 2562 diff changeset	507 filters = {}
5d4ac5415b40 plugins schema, merge-requests, tickets: convert labels from textbox to list only when "labels_as_list" is set in extra parameters. Goffi <goffi@goffi.org> parents: 2562 diff changeset	508 if extra is None:
5d4ac5415b40 plugins schema, merge-requests, tickets: convert labels from textbox to list only when "labels_as_list" is set in extra parameters. Goffi <goffi@goffi.org> parents: 2562 diff changeset	509 extra = {}
5d4ac5415b40 plugins schema, merge-requests, tickets: convert labels from textbox to list only when "labels_as_list" is set in extra parameters. Goffi <goffi@goffi.org> parents: 2562 diff changeset	510 # XXX: Q&D way to get list for labels when displaying them, but text when we
5d4ac5415b40 plugins schema, merge-requests, tickets: convert labels from textbox to list only when "labels_as_list" is set in extra parameters. Goffi <goffi@goffi.org> parents: 2562 diff changeset	511 # have to modify them
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	512 if C.bool(extra.get("labels_as_list", C.BOOL_FALSE)):
2603 5d4ac5415b40 plugins schema, merge-requests, tickets: convert labels from textbox to list only when "labels_as_list" is set in extra parameters. Goffi <goffi@goffi.org> parents: 2562 diff changeset	513 filters = filters.copy()
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	514 filters["labels"] = self.textbox2ListFilter
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	515 client, service, node, max_items, extra, sub_id = self.prepareBridgeGet(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	516 service, node, max_items, sub_id, extra, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	517 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	518 d = self.getDataFormItems(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	519 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	520 service,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	521 node or None,
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	522 max_items=max_items,
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	523 item_ids=item_ids,
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	524 sub_id=sub_id,
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	525 rsm_request=extra.rsm_request,
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	526 extra=extra.extra,
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	527 default_node=default_node,
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	528 form_ns=form_ns,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	529 filters=filters,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	530 )
2807 0b7ce5daee9b plugin XEP-0277: blog items data are now entirely serialised before going to bridge: Goffi <goffi@goffi.org> parents: 2784 diff changeset	531 d.addCallback(self._p.transItemsData)
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	532 return d
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	533
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	534 def prepareBridgeSet(self, service, node, schema, item_id, extra, profile_key):
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	535 """Parse arguments received from bridge *Set methods and return higher level data
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	536
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	537 @return (tuple): (client, service, node, schema, item_id, extra) usable for
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	538 internal methods
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	539 """
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	540 client = self.host.getClient(profile_key)
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	541 service = None if not service else jid.JID(service)
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	542 if schema:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	543 schema = generic.parseXml(schema.encode("utf-8"))
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	544 else:
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	545 schema = None
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	546 extra = data_format.deserialise(extra)
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	547 return client, service, node or None, schema, item_id or None, extra
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	548
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	549 @defer.inlineCallbacks
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	550 def copyMissingValues(self, client, service, node, item_id, form_ns, values):
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	551 """Retrieve values existing in original item and missing in update
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	552
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	553 Existing item will be retrieve, and values not already specified in values will
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	554 be filled
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	555 @param service: same as for [XEP_0060.getItems]
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	556 @param node: same as for [XEP_0060.getItems]
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	557 @param item_id(unicode): id of the item to retrieve
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	558 @param form_ns (unicode, None): namespace of the form
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	559 @param values(dict): values to fill
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	560 This dict will be modified in place to fill value present in existing
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	561 item and missing in the dict.
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	562 """
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	563 try:
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	564 # we get previous item
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	565 items_data = yield self._p.getItems(
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	566 client, service, node, item_ids=[item_id]
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	567 )
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	568 item_elt = items_data[0][0]
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	569 except Exception as e:
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	570 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	571 _("Can't get previous item, update ignored: {reason}").format(
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	572 reason=e
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	573 )
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	574 )
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	575 else:
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	576 # and parse it
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	577 form = data_form.findForm(item_elt, form_ns)
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	578 if form is None:
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	579 log.warning(
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	580 _("Can't parse previous item, update ignored: data form not found")
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	581 )
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	582 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	583 for name, field in form.fields.items():
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	584 if name not in values:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	585 values[name] = "\n".join(str(v) for v in field.values)
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	586
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	587 def _set(self, service, node, values, schema=None, item_id=None, extra=None,
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	588 default_node=None, form_ns=None, fill_author=True,
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	589 profile_key=C.PROF_KEY_NONE):
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	590 """Bridge method to set item in node with schema
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	591
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	592 this method is a helper so dependant plugins can use it directly
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	593 when adding *Set methods
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	594 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	595 client, service, node, schema, item_id, extra = self.prepareBridgeSet(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	596 service, node, schema, item_id, extra
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	597 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	598 d = self.set(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	599 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	600 service,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	601 node,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	602 values,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	603 schema,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	604 item_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	605 extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	606 deserialise=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	607 form_ns=form_ns,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	608 default_node=default_node,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	609 fill_author=fill_author,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	610 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	611 d.addCallback(lambda ret: ret or "")
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	612 return d
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	613
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	614 @defer.inlineCallbacks
2774 95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	615 def set(self, client, service, node, values, schema, item_id, extra, deserialise,
95321f233387 plugin pubsub schema: code formatting minor update Goffi <goffi@goffi.org> parents: 2771 diff changeset	616 form_ns, default_node=None, fill_author=True):
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	617 """Set an item in a node with a schema
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	618
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	619 This method can be used directly by *Set methods added by dependant plugin
2554 0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	620 @param values(dict[key(unicode), [iterable[object]\|object]]): values of the items
0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	621 if value is not iterable, it will be put in a list
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	622 'created' and 'updated' will be forced to current time:
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	623 - 'created' is set if item_id is None, i.e. if it's a new ticket
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	624 - 'updated' is set everytime
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	625 @param extra(dict, None): same as for [XEP-0060.sendItem] with additional keys:
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	626 - update(bool): if True, get previous item data to merge with current one
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	627 if True, item_id must be None
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	628 @param form_ns (unicode, None): namespace of the form
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	629 needed when an update is done
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	630 @param default_node(unicode, None): value to use if node is not set
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	631 other arguments are same as for [self._s.sendDataFormItem]
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	632 @return (unicode): id of the created item
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	633 """
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	634 if extra is None:
989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	635 extra = {}
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	636 if not node:
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	637 if default_node is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	638 raise ValueError(_("default_node must be set if node is not set"))
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	639 node = default_node
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	640 now = utils.xmpp_date()
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	641 if not item_id:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	642 values["created"] = now
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	643 elif extra.get("update", False):
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	644 if item_id is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	645 raise exceptions.DataError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	646 _('if extra["update"] is set, item_id must be set too')
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	647 )
2959 989b622faff6 plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes Goffi <goffi@goffi.org> parents: 2958 diff changeset	648 yield self.copyMissingValues(client, service, node, item_id, form_ns, values)
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	649
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	650 values["updated"] = now
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	651 if fill_author:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	652 if not values.get("author"):
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	653 identity = yield self._i.getIdentity(client, client.jid)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	654 values["author"] = identity["nick"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	655 if not values.get("author_jid"):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	656 values["author_jid"] = client.jid.full()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	657 item_id = yield self.sendDataFormItem(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	658 client, service, node, values, schema, item_id, extra, deserialise
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	659 )
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	660 defer.returnValue(item_id)
544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2426 diff changeset	661
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	662
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2959 diff changeset	663 @implementer(iwokkel.IDisco)
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	664 class SchemaHandler(XMPPHandler):
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	665
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	666 def getDiscoInfo(self, requestor, service, nodeIdentifier=""):
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	667 return [disco.DiscoFeature(NS_SCHEMA)]
388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	668
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	669 def getDiscoItems(self, requestor, service, nodeIdentifier=""):
2350 388226e9c3ff plugin schema: PubSub node schema, first draft Goffi <goffi@goffi.org> parents: diff changeset	670 return []

Mercurial > libervia-backend

annotate sat/plugins/plugin_exp_pubsub_schema.py @ 3086:13be04a70e2f