libervia-backend: sat/tools/xml

annotate sat/tools/xml_tools.py @ 3916:40d47cc29ea4

plugin XEP-0300: type hints

author	Goffi <goffi@goffi.org>
date	Thu, 06 Oct 2022 15:19:08 +0200
parents	4cb38c8312a1
children	323017a4e4d2

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1 #!/usr/bin/env python3
3137 559a625a236b fixed shebangs Goffi <goffi@goffi.org> parents: 3136 diff changeset	2
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	3 # SAT: a jabber client
3479 be6d91572633 date update Goffi <goffi@goffi.org> parents: 3472 diff changeset	4 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	5
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	6 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	7 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	8 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	9 # (at your option) any later version.
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	10
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	11 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	14 # GNU Affero General Public License for more details.
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	15
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	16 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	18
3491 2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	19
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	20 import re
3914 4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	21 from typing import Optional, Tuple
3491 2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	22 import html.entities
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	23 from collections import OrderedDict
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	24 from xml.dom import minidom, NotFoundErr
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	25 from twisted.words.xish import domish
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	26 from twisted.words.protocols.jabber import jid
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	27 from twisted.internet import defer
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	28 from wokkel import data_form
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	29 from sat.core import exceptions
771 bfabeedbf32e core: i18n refactoring: Goffi <goffi@goffi.org> parents: 762 diff changeset	30 from sat.core.i18n import _
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	31 from sat.core.constants import Const as C
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 981 diff changeset	32 from sat.core.log import getLogger
3914 4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	33 import xml.etree.ElementTree as ET
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	34
3491 2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	35
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 981 diff changeset	36 log = getLogger(__name__)
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	37
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	38 """This library help manage XML used in SàT (parameters, registration, etc)"""
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	39
796 46aa5ada61bf core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	40 SAT_FORM_PREFIX = "SAT_FORM_"
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	41 SAT_PARAM_SEPARATOR = "_XMLUI_PARAM_" # used to have unique elements names
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	42 html_entity_re = re.compile(r"&([a-zA-Z]+?);")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	43 XML_ENTITIES = ("quot", "amp", "apos", "lt", "gt")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	44
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	45 # method to clean XHTML, receive raw unsecure XML or HTML, must return cleaned raw XHTML
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	46 # this method must be set during runtime
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	47 cleanXHTML = None
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	48
1903 29564cec913f plugin XEP-0060: service, node and uri are added to metadata when doing a getItems Goffi <goffi@goffi.org> parents: 1819 diff changeset	49 # TODO: move XMLUI stuff in a separate module
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	50 # TODO: rewrite this with lxml or ElementTree or domish.Element: it's complicated and difficult to maintain with current minidom implementation
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	51
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	52 # Helper functions
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	53
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	54
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	55 def _dataFormField2XMLUIData(field, read_only=False):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	56 """Get data needed to create an XMLUI's Widget from Wokkel's data_form's Field.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	57
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	58 The attribute field can be modified (if it's fixed and it has no value).
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	59 @param field (data_form.Field): a field with attributes "value", "fieldType",
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	60 "label" and "var"
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	61 @param read_only (bool): if True and it makes sense, create a read only input widget
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	62 @return: a tuple (widget_type, widget_args, widget_kwargs)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	63 """
3716 d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	64 widget_args = field.values or [None]
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	65 widget_kwargs = {}
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	66 if field.fieldType is None and field.ext_type is not None:
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	67 # we have an extended field
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	68 if field.ext_type == "xml":
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	69 element = field.value
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	70 if element.uri == C.NS_XHTML:
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	71 widget_type = "xhtmlbox"
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	72 widget_args[0] = element.toXml()
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	73 widget_kwargs["read_only"] = read_only
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	74 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	75 log.warning("unknown XML element, falling back to textbox")
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	76 widget_type = "textbox"
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	77 widget_args[0] = element.toXml()
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	78 widget_kwargs["read_only"] = read_only
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	79 else:
3716 d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	80
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	81 raise exceptions.DataError("unknown extended type {ext_type}".format(
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	82 ext_type = field.ext_type))
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	83
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	84 elif field.fieldType == "fixed" or field.fieldType is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	85 widget_type = "text"
863 97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	86 if field.value is None:
97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	87 if field.label is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	88 log.warning(_("Fixed field has neither value nor label, ignoring it"))
863 97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	89 field.value = ""
97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	90 else:
97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	91 field.value = field.label
97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	92 field.label = None
3732 0fac164ff2d8 tools (xml_tools): fix `widget_args` modification in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3716 diff changeset	93 widget_args = [field.value]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	94 elif field.fieldType == "text-single":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	95 widget_type = "string"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	96 widget_kwargs["read_only"] = read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	97 elif field.fieldType == "jid-single":
1473 675e0e9f1653 core , privmitivus (xmlui): add jidInput handling, with a simple String for now Goffi <goffi@goffi.org> parents: 1472 diff changeset	98 widget_type = "jid_input"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	99 widget_kwargs["read_only"] = read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	100 elif field.fieldType == "text-multi":
1078 bb4517e69957 tools (xmlui): data form 'text-multi' element must be converted to xmlui 'textbox' (not 'text') souliane <souliane@mailoo.org> parents: 1070 diff changeset	101 widget_type = "textbox"
3732 0fac164ff2d8 tools (xml_tools): fix `widget_args` modification in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3716 diff changeset	102 widget_args = ["\n".join(field.values)]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	103 widget_kwargs["read_only"] = read_only
2668 c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	104 elif field.fieldType == "hidden":
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	105 widget_type = "hidden"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	106 elif field.fieldType == "text-private":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	107 widget_type = "password"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	108 widget_kwargs["read_only"] = read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	109 elif field.fieldType == "boolean":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	110 widget_type = "bool"
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	111 if widget_args[0] is None:
3732 0fac164ff2d8 tools (xml_tools): fix `widget_args` modification in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3716 diff changeset	112 widget_args = ["false"]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	113 widget_kwargs["read_only"] = read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	114 elif field.fieldType == "integer":
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	115 widget_type = "integer"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	116 widget_kwargs["read_only"] = read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	117 elif field.fieldType == "list-single":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	118 widget_type = "list"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	119 widget_kwargs["options"] = [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	120 (option.value, option.label or option.value) for option in field.options
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	121 ]
1067 f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	122 widget_kwargs["selected"] = widget_args
f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	123 widget_args = []
3716 d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	124 elif field.fieldType == "list-multi":
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	125 widget_type = "list"
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	126 widget_kwargs["options"] = [
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	127 (option.value, option.label or option.value) for option in field.options
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	128 ]
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	129 widget_kwargs["selected"] = widget_args
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	130 widget_kwargs["styles"] = ["multi"]
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	131 widget_args = []
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	132 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	133 log.error(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	134 "FIXME FIXME FIXME: Type [%s] is not managed yet by SàT" % field.fieldType
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	135 )
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	136 widget_type = "string"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	137 widget_kwargs["read_only"] = read_only
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	138
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	139 if field.var:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	140 widget_kwargs["name"] = field.var
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	141
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	142 return widget_type, widget_args, widget_kwargs
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	143
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	144 def dataForm2Widgets(form_ui, form, read_only=False, prepend=None, filters=None):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	145 """Complete an existing XMLUI with widget converted from XEP-0004 data forms.
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	146
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	147 @param form_ui (XMLUI): XMLUI instance
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	148 @param form (data_form.Form): Wokkel's implementation of data form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	149 @param read_only (bool): if True and it makes sense, create a read only input widget
2380 59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	150 @param prepend(iterable, None): widgets to prepend to main LabelContainer
59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	151 if not None, must be an iterable of *args for addWidget. Those widgets will
59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	152 be added first to the container.
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	153 @param filters(dict, None): if not None, a dictionary of callable:
3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	154 key is the name of the widget to filter
2429 941fdf81958c core (XMLUI): form's XMLUI is use as first arguments for filters in dataForm2Widgets Goffi <goffi@goffi.org> parents: 2428 diff changeset	155 the value is a callable, it will get form's XMLUI, widget's type, args and kwargs
941fdf81958c core (XMLUI): form's XMLUI is use as first arguments for filters in dataForm2Widgets Goffi <goffi@goffi.org> parents: 2428 diff changeset	156 and must return widget's type, args and kwargs (which can be modified)
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	157 This is especially useful to modify well known fields
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	158 @return: the completed XMLUI instance
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	159 """
2405 f4b6176eb65f core (xmlui): fixed data_form => XMLUI conversion when filters is None Goffi <goffi@goffi.org> parents: 2398 diff changeset	160 if filters is None:
f4b6176eb65f core (xmlui): fixed data_form => XMLUI conversion when filters is None Goffi <goffi@goffi.org> parents: 2398 diff changeset	161 filters = {}
102 94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	162 if form.instructions:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	163 form_ui.addText("\n".join(form.instructions), "instructions")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	164
2361 5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	165 form_ui.changeContainer("label")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	166
2380 59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	167 if prepend is not None:
59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	168 for widget_args in prepend:
59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	169 form_ui.addWidget(*widget_args)
59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	170
102 94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	171 for field in form.fieldList:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	172 widget_type, widget_args, widget_kwargs = _dataFormField2XMLUIData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	173 field, read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	174 )
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	175 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	176 widget_filter = filters[widget_kwargs["name"]]
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	177 except KeyError:
3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	178 pass
3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	179 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	180 widget_type, widget_args, widget_kwargs = widget_filter(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	181 form_ui, widget_type, widget_args, widget_kwargs
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	182 )
2668 c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	183 if widget_type != "hidden":
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	184 label = field.label or field.var
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	185 if label:
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	186 form_ui.addLabel(label)
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	187 else:
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	188 form_ui.addEmpty()
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	189
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	190 form_ui.addWidget(widget_type, widget_args, *widget_kwargs)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	191
761 2f8d72226bc0 core (xml_tools): dataForm2XML renamed to dataForm2XMLUI and now return XMLUI instead of raw XML + submit_id is managed, and session_id is returned if present Goffi <goffi@goffi.org> parents: 760 diff changeset	192 return form_ui
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 35 diff changeset	193
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	194
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	195 def dataForm2XMLUI(form, submit_id, session_id=None, read_only=False):
1487 0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	196 """Take a data form (Wokkel's XEP-0004 implementation) and convert it to a SàT XMLUI.
1069 8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	197
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	198 @param form (data_form.Form): a Form instance
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	199 @param submit_id (unicode): callback id to call when submitting form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	200 @param session_id (unicode): session id to return with the data
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	201 @param read_only (bool): if True and it makes sense, create a read only input widget
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	202 @return: XMLUI instance
1069 8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	203 """
8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	204 form_ui = XMLUI("form", "vertical", submit_id=submit_id, session_id=session_id)
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	205 return dataForm2Widgets(form_ui, form, read_only=read_only)
1069 8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	206
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	207
3472 e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	208 def dataForm2dataDict(form: data_form.Form) -> dict:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	209 """Convert data form to a simple dict, easily serialisable
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	210
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	211 see dataDict2dataForm for a description of the format
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	212 """
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	213 fields = []
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	214 data_dict = {
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	215 "fields": fields
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	216 }
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	217 if form.formNamespace:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	218 data_dict["namespace"] = form.formNamespace
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	219 for form_field in form.fieldList:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	220 field = {"type": form_field.fieldType}
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	221 fields.append(field)
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	222 for src_name, dest_name in (
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	223 ('var', 'name'),
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	224 ('label', 'label'),
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	225 ('value', 'value'),
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	226 ):
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	227 value = getattr(form_field, src_name, None)
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	228 if value:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	229 field[dest_name] = value
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	230 if form_field.options:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	231 options = field["options"] = []
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	232 for form_opt in form_field.options:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	233 opt = {"value": form_opt.value}
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	234 if form_opt.label:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	235 opt["label"] = form_opt.label
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	236 options.append(opt)
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	237
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	238 if form_field.fieldType is None and form_field.ext_type == "xml":
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	239 if isinstance(form_field.value, domish.Element):
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	240 if ((form_field.value.uri == C.NS_XHTML
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	241 and form_field.value.name == "div")):
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	242 field["type"] = "xhtml"
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	243 if form_field.value.children:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	244 log.warning(
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	245 "children are not managed for XHTML fields: "
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	246 f"{form_field.value.toXml()}"
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	247 )
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	248 return data_dict
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	249
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	250
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	251 def dataDict2dataForm(data_dict):
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	252 """Convert serialisable dict of data to a data form
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	253
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	254 The format of the dict is as follow:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	255 - an optional "namespace" key with form namespace
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	256 - a mandatory "fields" key with list of fields as follow:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	257 - "type" is mostly the same as data_form.Field.fieldType
3531 a8259a1f89b2 component file sharing (management): add values of `quota` and `used` size on result form Goffi <goffi@goffi.org> parents: 3491 diff changeset	258 - "name" is used to set the "var" attribute of data_form.Field
a8259a1f89b2 component file sharing (management): add values of `quota` and `used` size on result form Goffi <goffi@goffi.org> parents: 3491 diff changeset	259 - "label", and "value" follow same attribude in data_form.Field
3472 e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	260 - "xhtml" is used for "xml" fields with child in the C.NS_XHTML namespace
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	261 - "options" are list of dict with optional "label" and mandatory "value"
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	262 following suitable attributes from data_form.Option
3903 384b7e6c2dbf tools (xml_tools): handle `required` field in `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3732 diff changeset	263 - "required" is the same as data_form.Field.required
3472 e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	264 """
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	265 # TODO: describe format
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	266 fields = []
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	267 for field_data in data_dict["fields"]:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	268 field_type = field_data.get('type', 'text-single')
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	269 kwargs = {
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	270 "fieldType": field_type,
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	271 "var": field_data["name"],
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	272 "label": field_data.get('label'),
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	273 "value": field_data.get("value"),
3903 384b7e6c2dbf tools (xml_tools): handle `required` field in `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3732 diff changeset	274 "required": field_data.get("required")
3472 e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	275 }
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	276 if field_type == "xhtml":
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	277 kwargs.update({
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	278 "fieldType": None,
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	279 "ext_type": "xml",
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	280 })
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	281 if kwargs["value"] is None:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	282 kwargs["value"] = domish.Element((C.NS_XHTML, "div"))
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	283 elif "options" in field_data:
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	284 kwargs["options"] = [
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	285 data_form.Option(o["value"], o.get("label"))
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	286 for o in field_data["options"]
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	287 ]
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	288 field = data_form.Field(**kwargs)
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	289 fields.append(field)
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	290 return data_form.Form(
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	291 "form",
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	292 formNamespace=data_dict.get("namespace"),
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	293 fields=fields
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	294 )
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	295
e12e9e1535d3 tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`: Goffi <goffi@goffi.org> parents: 3466 diff changeset	296
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	297 def dataFormEltResult2XMLUIData(form_xml):
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	298 """Parse a data form result (not parsed by Wokkel's XEP-0004 implementation).
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	299
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	300 The raw data form is used because Wokkel doesn't manage result items parsing yet.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	301 @param form_xml (domish.Element): element of the data form
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	302 @return: a couple (headers, result_list):
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	303 - headers (dict{unicode: unicode}): form headers (field labels and types)
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	304 - xmlui_data (list[tuple]): list of (widget_type, widget_args, widget_kwargs)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	305 """
1500 c7c872a40e56 tools (xml_tools): keeps data form result headers sorted souliane <souliane@mailoo.org> parents: 1499 diff changeset	306 headers = OrderedDict()
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	307 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	308 reported_elt = next(form_xml.elements("jabber:x:data", "reported"))
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	309 except StopIteration:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	310 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	311 "Couldn't find expected <reported> tag in %s" % form_xml.toXml()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	312 )
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	313
660 69a8bfd266a5 core, plugins: fixed bad use of children instead of elements() for domish.Element instances. Goffi <goffi@goffi.org> parents: 655 diff changeset	314 for elt in reported_elt.elements():
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	315 if elt.name != "field":
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	316 raise exceptions.DataError("Unexpected tag")
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	317 name = elt["var"]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	318 label = elt.attributes.get("label", "")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	319 type_ = elt.attributes.get("type")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	320 headers[name] = (label, type_)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	321
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	322 if not headers:
684 969562c4761b core (tools): small fix in using imported methods souliane <souliane@mailoo.org> parents: 660 diff changeset	323 raise exceptions.DataError("No reported fields (see XEP-0004 §3.4)")
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	324
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	325 xmlui_data = []
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	326 item_elts = form_xml.elements("jabber:x:data", "item")
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	327
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	328 for item_elt in item_elts:
660 69a8bfd266a5 core, plugins: fixed bad use of children instead of elements() for domish.Element instances. Goffi <goffi@goffi.org> parents: 655 diff changeset	329 for elt in item_elt.elements():
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	330 if elt.name != "field":
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	331 log.warning("Unexpected tag (%s)" % elt.name)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	332 continue
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	333 field = data_form.Field.fromElement(elt)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	334
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	335 xmlui_data.append(_dataFormField2XMLUIData(field))
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	336
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	337 return headers, xmlui_data
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	338
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	339
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	340 def XMLUIData2AdvancedList(xmlui, headers, xmlui_data):
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	341 """Take a raw data form result (not parsed by Wokkel's XEP-0004 implementation) and convert it to an advanced list.
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	342
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	343 The raw data form is used because Wokkel doesn't manage result items parsing yet.
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	344 @param xmlui (XMLUI): the XMLUI where the AdvancedList will be added
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	345 @param headers (dict{unicode: unicode}): form headers (field labels and types)
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	346 @param xmlui_data (list[tuple]): list of (widget_type, widget_args, widget_kwargs)
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	347 @return: the completed XMLUI instance
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	348 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	349 adv_list = AdvancedListContainer(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	350 xmlui, headers=headers, columns=len(headers), parent=xmlui.current_container
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	351 )
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	352 xmlui.changeContainer(adv_list)
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	353
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	354 for widget_type, widget_args, widget_kwargs in xmlui_data:
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	355 xmlui.addWidget(widget_type, widget_args, *widget_kwargs)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	356
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	357 return xmlui
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	358
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	359
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	360 def dataFormResult2AdvancedList(xmlui, form_xml):
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	361 """Take a raw data form result (not parsed by Wokkel's XEP-0004 implementation) and convert it to an advanced list.
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	362
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	363 The raw data form is used because Wokkel doesn't manage result items parsing yet.
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	364 @param xmlui (XMLUI): the XMLUI where the AdvancedList will be added
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	365 @param form_xml (domish.Element): element of the data form
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	366 @return: the completed XMLUI instance
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	367 """
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	368 headers, xmlui_data = dataFormEltResult2XMLUIData(form_xml)
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	369 XMLUIData2AdvancedList(xmlui, headers, xmlui_data)
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	370
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	371
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	372 def dataFormEltResult2XMLUI(form_elt, session_id=None):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	373 """Take a raw data form (not parsed by XEP-0004) and convert it to a SàT XMLUI.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	374
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	375 The raw data form is used because Wokkel doesn't manage result items parsing yet.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	376 @param form_elt (domish.Element): element of the data form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	377 @param session_id (unicode): session id to return with the data
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	378 @return: XMLUI instance
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	379 """
1069 8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	380 xml_ui = XMLUI("window", "vertical", session_id=session_id)
8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	381 try:
8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	382 dataFormResult2AdvancedList(xml_ui, form_elt)
8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	383 except exceptions.DataError:
8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	384 parsed_form = data_form.Form.fromElement(form_elt)
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	385 dataForm2Widgets(xml_ui, parsed_form, read_only=True)
1069 8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	386 return xml_ui
590 56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	387
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	388
2958 e2cb04b381bb tools (xml_tools): added "read_only" argument in dataFormResult2XMLUI (and use it in plugin pubsub_schema) Goffi <goffi@goffi.org> parents: 2938 diff changeset	389 def dataFormResult2XMLUI(result_form, base_form, session_id=None, prepend=None,
e2cb04b381bb tools (xml_tools): added "read_only" argument in dataFormResult2XMLUI (and use it in plugin pubsub_schema) Goffi <goffi@goffi.org> parents: 2938 diff changeset	390 filters=None, read_only=True):
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	391 """Convert data form result to SàT XMLUI.
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	392
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	393 @param result_form (data_form.Form): result form to convert
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	394 @param base_form (data_form.Form): initial form (i.e. of form type "form")
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	395 this one is necessary to reconstruct options when needed (e.g. list elements)
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	396 @param session_id (unicode): session id to return with the data
2380 59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	397 @param prepend: same as for [dataForm2Widgets]
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	398 @param filters: same as for [dataForm2Widgets]
2958 e2cb04b381bb tools (xml_tools): added "read_only" argument in dataFormResult2XMLUI (and use it in plugin pubsub_schema) Goffi <goffi@goffi.org> parents: 2938 diff changeset	399 @param read_only: same as for [dataForm2Widgets]
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	400 @return: XMLUI instance
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	401 """
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	402 # we deepcopy the form because _dataFormField2XMLUIData can modify the value
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	403 # FIXME: check if it's really important, the only modified value seems to be
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	404 # the replacement of None by "" on fixed fields
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	405 # form = deepcopy(result_form)
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	406 form = result_form
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	407 for name, field in form.fields.items():
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	408 try:
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	409 base_field = base_form.fields[name]
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	410 except KeyError:
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	411 continue
2386 2e05921df16a plugin schema, core(xmlui): deep copy base form when reused to avoid accidental modification Goffi <goffi@goffi.org> parents: 2380 diff changeset	412 field.options = base_field.options[:]
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	413 xml_ui = XMLUI("window", "vertical", session_id=session_id)
2958 e2cb04b381bb tools (xml_tools): added "read_only" argument in dataFormResult2XMLUI (and use it in plugin pubsub_schema) Goffi <goffi@goffi.org> parents: 2938 diff changeset	414 dataForm2Widgets(xml_ui, form, read_only=read_only, prepend=prepend, filters=filters)
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	415 return xml_ui
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	416
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	417
981 58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	418 def _cleanValue(value):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	419 """Workaround method to avoid DBus types with D-Bus bridge.
981 58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	420
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	421 @param value: value to clean
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	422 @return: value in a non DBus type (only clean string yet)
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	423 """
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	424 # XXX: must be removed when DBus types will no cause problems anymore
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	425 # FIXME: should be cleaned inside D-Bus bridge itself
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	426 if isinstance(value, str):
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	427 return str(value)
981 58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	428 return value
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	429
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	430
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	431 def XMLUIResult2DataFormResult(xmlui_data):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	432 """ Extract form data from a XMLUI return.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	433
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	434 @param xmlui_data (dict): data returned by frontends for XMLUI form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	435 @return: dict of data usable by Wokkel's data form
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	436 """
2938 48985ef7682f tools (xml_tools): split new lines for multi-lines text in XMLUIResult2DataFormResult to be correctly handled in data form Goffi <goffi@goffi.org> parents: 2814 diff changeset	437 ret = {}
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	438 for key, value in xmlui_data.items():
2938 48985ef7682f tools (xml_tools): split new lines for multi-lines text in XMLUIResult2DataFormResult to be correctly handled in data form Goffi <goffi@goffi.org> parents: 2814 diff changeset	439 if not key.startswith(SAT_FORM_PREFIX):
48985ef7682f tools (xml_tools): split new lines for multi-lines text in XMLUIResult2DataFormResult to be correctly handled in data form Goffi <goffi@goffi.org> parents: 2814 diff changeset	440 continue
3716 d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	441 if isinstance(value, str):
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	442 if "\n" in value:
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	443 # data form expects multi-lines text to be in separated values
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	444 value = value.split('\n')
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	445 elif "\t" in value:
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	446 # FIXME: workaround to handle multiple values. Proper serialisation must
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	447 # be done in XMLUI
d33da3fe34a5 tools (xml_tools): implement `list-multi` in `_dataFormField2XMLUIData`: Goffi <goffi@goffi.org> parents: 3531 diff changeset	448 value = value.split("\t")
2938 48985ef7682f tools (xml_tools): split new lines for multi-lines text in XMLUIResult2DataFormResult to be correctly handled in data form Goffi <goffi@goffi.org> parents: 2814 diff changeset	449 ret[key[len(SAT_FORM_PREFIX) :]] = _cleanValue(value)
48985ef7682f tools (xml_tools): split new lines for multi-lines text in XMLUIResult2DataFormResult to be correctly handled in data form Goffi <goffi@goffi.org> parents: 2814 diff changeset	450 return ret
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	451
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	452
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	453 def formEscape(name):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	454 """Return escaped name for forms.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	455
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	456 @param name (unicode): form name
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	457 @return: unicode
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	458 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	459 return "%s%s" % (SAT_FORM_PREFIX, name)
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	460
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	461
2741 1797671827b9 tools (xml_tools): isXMLUICancelled helper function to check if an XMLUI has been cancelled from raw XML. Goffi <goffi@goffi.org> parents: 2737 diff changeset	462 def isXMLUICancelled(raw_xmlui):
1797671827b9 tools (xml_tools): isXMLUICancelled helper function to check if an XMLUI has been cancelled from raw XML. Goffi <goffi@goffi.org> parents: 2737 diff changeset	463 """Tell if an XMLUI has been cancelled by checking raw XML"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	464 return C.bool(raw_xmlui.get('cancelled', C.BOOL_FALSE))
2741 1797671827b9 tools (xml_tools): isXMLUICancelled helper function to check if an XMLUI has been cancelled from raw XML. Goffi <goffi@goffi.org> parents: 2737 diff changeset	465
1797671827b9 tools (xml_tools): isXMLUICancelled helper function to check if an XMLUI has been cancelled from raw XML. Goffi <goffi@goffi.org> parents: 2737 diff changeset	466
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	467 def XMLUIResultToElt(xmlui_data):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	468 """Construct result domish.Element from XMLUI result.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	469
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	470 @param xmlui_data (dict): data returned by frontends for XMLUI form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	471 @return: domish.Element
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	472 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	473 form = data_form.Form("submit")
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	474 form.makeFields(XMLUIResult2DataFormResult(xmlui_data))
aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	475 return form.toElement()
aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	476
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	477
102 94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	478 def tupleList2dataForm(values):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	479 """Convert a list of tuples (name, value) to a wokkel submit data form.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	480
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	481 @param values (list): list of tuples
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	482 @return: data_form.Form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	483 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	484 form = data_form.Form("submit")
102 94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	485 for value in values:
94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	486 field = data_form.Field(var=value[0], value=value[1])
94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	487 form.addField(field)
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 35 diff changeset	488
102 94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	489 return form
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	490
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	491
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	492 def paramsXML2XMLUI(xml):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	493 """Convert the XML for parameter to a SàT XML User Interface.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	494
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	495 @param xml (unicode)
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	496 @return: XMLUI
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	497 """
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	498 # TODO: refactor params and use Twisted directly to parse XML
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	499 params_doc = minidom.parseString(xml.encode("utf-8"))
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	500 top = params_doc.documentElement
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	501 if top.nodeName != "params":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	502 raise exceptions.DataError(_("INTERNAL ERROR: parameters xml not valid"))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	503
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	504 param_ui = XMLUI("param", "tabs")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	505 tabs_cont = param_ui.current_container
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	506
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	507 for category in top.getElementsByTagName("category"):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	508 category_name = category.getAttribute("name")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	509 label = category.getAttribute("label")
796 46aa5ada61bf core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	510 if not category_name:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	511 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	512 _("INTERNAL ERROR: params categories must have a name")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	513 )
2361 5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	514 tabs_cont.addTab(category_name, label=label, container=LabelContainer)
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	515 for param in category.getElementsByTagName("param"):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	516 widget_kwargs = {}
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	517
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	518 param_name = param.getAttribute("name")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	519 param_label = param.getAttribute("label")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	520 type_ = param.getAttribute("type")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	521 if not param_name and type_ != "text":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	522 raise exceptions.DataError(_("INTERNAL ERROR: params must have a name"))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	523
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	524 value = param.getAttribute("value") or None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	525 callback_id = param.getAttribute("callback_id") or None
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	526
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	527 if type_ == "list":
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	528 options, selected = _paramsGetListOptions(param)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	529 widget_kwargs["options"] = options
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	530 widget_kwargs["selected"] = selected
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	531 widget_kwargs["styles"] = ["extensible"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	532 elif type_ == "jids_list":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	533 widget_kwargs["jids"] = _paramsGetListJids(param)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	534
865 3ee2ec7ec010 core (xmlui), frontends: handling of "text" type in params xml + bug fixes Goffi <goffi@goffi.org> parents: 863 diff changeset	535 if type_ in ("button", "text"):
106 138d82f64b6f plugin CS: friends parsing Goffi <goffi@goffi.org> parents: 105 diff changeset	536 param_ui.addEmpty()
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	537 value = param_label
106 138d82f64b6f plugin CS: friends parsing Goffi <goffi@goffi.org> parents: 105 diff changeset	538 else:
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	539 param_ui.addLabel(param_label or param_name)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	540
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	541 if value:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	542 widget_kwargs["value"] = value
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	543
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	544 if callback_id:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	545 widget_kwargs["callback_id"] = callback_id
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	546 others = [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	547 "%s%s%s"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	548 % (category_name, SAT_PARAM_SEPARATOR, other.getAttribute("name"))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	549 for other in category.getElementsByTagName("param")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	550 if other.getAttribute("type") != "button"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	551 ]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	552 widget_kwargs["fields_back"] = others
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	553
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	554 widget_kwargs["name"] = "%s%s%s" % (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	555 category_name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	556 SAT_PARAM_SEPARATOR,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	557 param_name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	558 )
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	559
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	560 param_ui.addWidget(type_, **widget_kwargs)
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	561
d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	562 return param_ui.toXml()
d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	563
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	564
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	565 def _paramsGetListOptions(param):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	566 """Retrieve the options for list element.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	567
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	568 The <option/> tags must be direct children of <param/>.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	569 @param param (domish.Element): element
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	570 @return: a tuple (options, selected_value)
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	571 """
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	572 if len(param.getElementsByTagName("options")) > 0:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	573 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	574 _("The 'options' tag is not allowed in parameter of type 'list'!")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	575 )
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	576 elems = param.getElementsByTagName("option")
655 56f8a9c99194 core, primitivus: better support for parameter of type list souliane <souliane@mailoo.org> parents: 645 diff changeset	577 if len(elems) == 0:
56f8a9c99194 core, primitivus: better support for parameter of type list souliane <souliane@mailoo.org> parents: 645 diff changeset	578 return []
3233 8770397f8f82 tools (xl_tools): fixed handling of list options labels Goffi <goffi@goffi.org> parents: 3137 diff changeset	579 options = []
8770397f8f82 tools (xl_tools): fixed handling of list options labels Goffi <goffi@goffi.org> parents: 3137 diff changeset	580 for elem in elems:
8770397f8f82 tools (xl_tools): fixed handling of list options labels Goffi <goffi@goffi.org> parents: 3137 diff changeset	581 value = elem.getAttribute("value")
8770397f8f82 tools (xl_tools): fixed handling of list options labels Goffi <goffi@goffi.org> parents: 3137 diff changeset	582 if not value:
8770397f8f82 tools (xl_tools): fixed handling of list options labels Goffi <goffi@goffi.org> parents: 3137 diff changeset	583 raise exceptions.InternalError("list option must have a value")
8770397f8f82 tools (xl_tools): fixed handling of list options labels Goffi <goffi@goffi.org> parents: 3137 diff changeset	584 label = elem.getAttribute("label")
8770397f8f82 tools (xl_tools): fixed handling of list options labels Goffi <goffi@goffi.org> parents: 3137 diff changeset	585 if label:
8770397f8f82 tools (xl_tools): fixed handling of list options labels Goffi <goffi@goffi.org> parents: 3137 diff changeset	586 options.append((value, label))
8770397f8f82 tools (xl_tools): fixed handling of list options labels Goffi <goffi@goffi.org> parents: 3137 diff changeset	587 else:
8770397f8f82 tools (xl_tools): fixed handling of list options labels Goffi <goffi@goffi.org> parents: 3137 diff changeset	588 options.append(value)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	589 selected = [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	590 elem.getAttribute("value")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	591 for elem in elems
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	592 if elem.getAttribute("selected") == "true"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	593 ]
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	594 return (options, selected)
655 56f8a9c99194 core, primitivus: better support for parameter of type list souliane <souliane@mailoo.org> parents: 645 diff changeset	595
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	596
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	597 def _paramsGetListJids(param):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	598 """Retrive jids from a jids_list element.
655 56f8a9c99194 core, primitivus: better support for parameter of type list souliane <souliane@mailoo.org> parents: 645 diff changeset	599
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	600 the <jid/> tags must be direct children of <param/>
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	601 @param param (domish.Element): element
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	602 @return: a list of jids
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	603 """
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	604 elems = param.getElementsByTagName("jid")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	605 jids = [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	606 elem.firstChild.data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	607 for elem in elems
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	608 if elem.firstChild is not None and elem.firstChild.nodeType == elem.TEXT_NODE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	609 ]
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	610 return jids
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	611
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	612
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	613 ### XMLUI Elements ###
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	614
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	615
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	616 class Element(object):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	617 """ Base XMLUI element """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	618
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	619 type = None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	620
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	621 def __init__(self, xmlui, parent=None):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	622 """Create a container element
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	623
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	624 @param xmlui: XMLUI instance
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	625 @parent: parent element
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	626 """
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	627 assert self.type is not None
2365 318f0434d830 core (xmlui): container now keep a list of children Goffi <goffi@goffi.org> parents: 2364 diff changeset	628 self.children = []
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	629 if not hasattr(self, "elem"):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	630 self.elem = parent.xmlui.doc.createElement(self.type)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	631 self.xmlui = xmlui
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	632 if parent is not None:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	633 parent.append(self)
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	634 self.parent = parent
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	635
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	636 def append(self, child):
1487 0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	637 """Append a child to this element.
1490 55cff13b1f10 core (xmlui): reverted change from 039d96e131be: we should be able to recreate the same container with changeContainer Goffi <goffi@goffi.org> parents: 1487 diff changeset	638
1487 0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	639 @param child (Element): child element
0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	640 @return: the added child Element
0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	641 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	642 self.elem.appendChild(child.elem)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	643 child.parent = self
2365 318f0434d830 core (xmlui): container now keep a list of children Goffi <goffi@goffi.org> parents: 2364 diff changeset	644 self.children.append(child)
1487 0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	645 return child
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	646
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	647
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	648 class TopElement(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	649 """ Main XML Element """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	650
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	651 type = "top"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	652
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	653 def __init__(self, xmlui):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	654 self.elem = xmlui.doc.documentElement
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	655 super(TopElement, self).__init__(xmlui)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	656
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	657
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	658 class TabElement(Element):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	659 """ Used by TabsContainer to give name and label to tabs."""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	660
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	661 type = "tab"
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	662
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	663 def __init__(self, parent, name, label, selected=False):
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	664 """
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	665
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	666 @param parent (TabsContainer): parent container
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	667 @param name (unicode): tab name
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	668 @param label (unicode): tab label
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	669 @param selected (bool): set to True to select this tab
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	670 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	671 if not isinstance(parent, TabsContainer):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	672 raise exceptions.DataError(_("TabElement must be a child of TabsContainer"))
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	673 super(TabElement, self).__init__(parent.xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	674 self.elem.setAttribute("name", name)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	675 self.elem.setAttribute("label", label)
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	676 if selected:
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	677 self.setSelected(selected)
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	678
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	679 def setSelected(self, selected=False):
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	680 """Set the tab selected.
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	681
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	682 @param selected (bool): set to True to select this tab
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	683 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	684 self.elem.setAttribute("selected", "true" if selected else "false")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	685
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	686
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	687 class FieldBackElement(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	688 """ Used by ButtonWidget to indicate which field have to be sent back """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	689
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	690 type = "field_back"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	691
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	692 def __init__(self, parent, name):
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	693 assert isinstance(parent, ButtonWidget)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	694 super(FieldBackElement, self).__init__(parent.xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	695 self.elem.setAttribute("name", name)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	696
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	697
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	698 class InternalFieldElement(Element):
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	699 """ Used by internal callbacks to indicate which fields are manipulated """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	700
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	701 type = "internal_field"
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	702
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	703 def __init__(self, parent, name):
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	704 super(InternalFieldElement, self).__init__(parent.xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	705 self.elem.setAttribute("name", name)
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	706
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	707
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	708 class InternalDataElement(Element):
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	709 """ Used by internal callbacks to retrieve extra data """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	710
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	711 type = "internal_data"
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	712
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	713 def __init__(self, parent, children):
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	714 super(InternalDataElement, self).__init__(parent.xmlui, parent)
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	715 assert isinstance(children, list)
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	716 for child in children:
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	717 self.elem.childNodes.append(child)
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	718
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	719
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	720 class OptionElement(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	721 """" Used by ListWidget to specify options """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	722
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	723 type = "option"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	724
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	725 def __init__(self, parent, option, selected=False):
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	726 """
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	727
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	728 @param parent
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	729 @param option (string, tuple)
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	730 @param selected (boolean)
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	731 """
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	732 assert isinstance(parent, ListWidget)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	733 super(OptionElement, self).__init__(parent.xmlui, parent)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	734 if isinstance(option, str):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	735 value, label = option, option
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	736 elif isinstance(option, tuple):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	737 value, label = option
1067 f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	738 else:
f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	739 raise NotImplementedError
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	740 self.elem.setAttribute("value", value)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	741 self.elem.setAttribute("label", label)
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	742 if selected:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	743 self.elem.setAttribute("selected", "true")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	744
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	745
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	746 class JidElement(Element):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	747 """" Used by JidsListWidget to specify jids"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	748
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	749 type = "jid"
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	750
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	751 def __init__(self, parent, jid_):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	752 """
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	753 @param jid_(jid.JID, unicode): jid to append
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	754 """
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	755 assert isinstance(parent, JidsListWidget)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	756 super(JidElement, self).__init__(parent.xmlui, parent)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	757 if isinstance(jid_, jid.JID):
1499 adc72c39f032 tools (xml_tools): fixes JidElement.__init__ souliane <souliane@mailoo.org> parents: 1490 diff changeset	758 value = jid_.full()
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	759 elif isinstance(jid_, str):
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	760 value = str(jid_)
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	761 else:
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	762 raise NotImplementedError
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	763 jid_txt = self.xmlui.doc.createTextNode(value)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	764 self.elem.appendChild(jid_txt)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	765
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	766
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	767 class RowElement(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	768 """" Used by AdvancedListContainer """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	769
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	770 type = "row"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	771
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	772 def __init__(self, parent):
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	773 assert isinstance(parent, AdvancedListContainer)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	774 super(RowElement, self).__init__(parent.xmlui, parent)
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	775 if parent.next_row_idx is not None:
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	776 if parent.auto_index:
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	777 raise exceptions.DataError(_("Can't set row index if auto_index is True"))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	778 self.elem.setAttribute("index", parent.next_row_idx)
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	779 parent.next_row_idx = None
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	780
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	781
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	782 class HeaderElement(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	783 """" Used by AdvancedListContainer """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	784
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	785 type = "header"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	786
876 65bf1bc70f6b tools, plugin XEP-0077: small fixes souliane <souliane@mailoo.org> parents: 865 diff changeset	787 def __init__(self, parent, name=None, label=None, description=None):
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	788 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	789 @param parent: AdvancedListContainer instance
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	790 @param name: name of the container
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	791 @param label: label to be displayed in columns
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	792 @param description: long descriptive text
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	793 """
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	794 assert isinstance(parent, AdvancedListContainer)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	795 super(HeaderElement, self).__init__(parent.xmlui, parent)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	796 if name:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	797 self.elem.setAttribute("name", name)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	798 if label:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	799 self.elem.setAttribute("label", label)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	800 if description:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	801 self.elem.setAttribute("description", description)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	802
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	803
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	804 ## Containers ##
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	805
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	806
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	807 class Container(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	808 """ And Element which contains other ones and has a layout """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	809
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	810 type = None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	811
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	812 def __init__(self, xmlui, parent=None):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	813 """Create a container element
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	814
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	815 @param xmlui: XMLUI instance
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	816 @parent: parent element or None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	817 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	818 self.elem = xmlui.doc.createElement("container")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	819 super(Container, self).__init__(xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	820 self.elem.setAttribute("type", self.type)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	821
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	822 def getParentContainer(self):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	823 """ Return first parent container
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	824
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	825 @return: parent container or None
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	826 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	827 current = self.parent
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	828 while not isinstance(current, (Container)) and current is not None:
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	829 current = current.parent
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	830 return current
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	831
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	832
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	833 class VerticalContainer(Container):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	834 type = "vertical"
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	835
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	836
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	837 class HorizontalContainer(Container):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	838 type = "horizontal"
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	839
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	840
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	841 class PairsContainer(Container):
2737 5c2ed8a5ae22 frontends (XMLUI): TabsContainer can now be the main container (Primitivus keep the old behaviour and always use VerticalContainer as main container) Goffi <goffi@goffi.org> parents: 2668 diff changeset	842 """Container with series of 2 elements"""
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	843 type = "pairs"
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	844
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	845
2361 5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	846 class LabelContainer(Container):
2737 5c2ed8a5ae22 frontends (XMLUI): TabsContainer can now be the main container (Primitivus keep the old behaviour and always use VerticalContainer as main container) Goffi <goffi@goffi.org> parents: 2668 diff changeset	847 """Like PairsContainer, but first element can only be a label"""
2361 5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	848 type = "label"
5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	849
5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	850
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	851 class TabsContainer(Container):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	852 type = "tabs"
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	853
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	854 def addTab(self, name, label=None, selected=None, container=VerticalContainer):
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	855 """Add a tab.
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	856
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	857 @param name (unicode): tab name
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	858 @param label (unicode): tab label
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	859 @param selected (bool): set to True to select this tab
1490 55cff13b1f10 core (xmlui): reverted change from 039d96e131be: we should be able to recreate the same container with changeContainer Goffi <goffi@goffi.org> parents: 1487 diff changeset	860 @param container (class): container class, inheriting from Container
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	861 @return: the container for the new tab
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	862 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	863 if not label:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	864 label = name
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	865 tab_elt = TabElement(self, name, label, selected)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	866 new_container = container(self.xmlui, tab_elt)
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	867 return self.xmlui.changeContainer(new_container)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	868
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	869 def end(self):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	870 """ Called when we have finished tabs
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	871
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	872 change current container to first container parent
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	873 """
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	874 parent_container = self.getParentContainer()
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	875 self.xmlui.changeContainer(parent_container)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	876
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	877
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	878 class AdvancedListContainer(Container):
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	879 """A list which can contain other widgets, headers, etc"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	880
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	881 type = "advanced_list"
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	882
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	883 def __init__(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	884 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	885 xmlui,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	886 callback_id=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	887 name=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	888 headers=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	889 items=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	890 columns=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	891 selectable="no",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	892 auto_index=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	893 parent=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	894 ):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	895 """Create an advanced list
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	896
1199 96fb74a4714d misc: fixed some typos Matteo Cypriani <mcy@lm7.fr> parents: 1142 diff changeset	897 @param headers: optional headers information
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	898 @param callback_id: id of the method to call when selection is done
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	899 @param items: list of widgets to add (just the first row)
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	900 @param columns: number of columns in this table, or None to autodetect
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	901 @param selectable: one of:
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	902 'no': nothing is done
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	903 'single': one row can be selected
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	904 @param auto_index: if True, indexes will be generated by frontends,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	905 starting from 0
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	906 @return: created element
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	907 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	908 assert selectable in ("no", "single")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	909 if not items and columns is None:
876 65bf1bc70f6b tools, plugin XEP-0077: small fixes souliane <souliane@mailoo.org> parents: 865 diff changeset	910 raise exceptions.DataError(_("either items or columns need do be filled"))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	911 if headers is None:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	912 headers = []
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	913 if items is None:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	914 items = []
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	915 super(AdvancedListContainer, self).__init__(xmlui, parent)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	916 if columns is None:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	917 columns = len(items[0])
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	918 self._columns = columns
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	919 self._item_idx = 0
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	920 self.current_row = None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	921 if headers:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	922 if len(headers) != self._columns:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	923 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	924 _("Headers lenght doesn't correspond to columns")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	925 )
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	926 self.addHeaders(headers)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	927 if items:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	928 self.addItems(items)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	929 self.elem.setAttribute("columns", str(self._columns))
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	930 if callback_id is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	931 self.elem.setAttribute("callback", callback_id)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	932 self.elem.setAttribute("selectable", selectable)
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	933 self.auto_index = auto_index
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	934 if auto_index:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	935 self.elem.setAttribute("auto_index", "true")
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	936 self.next_row_idx = None
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	937
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	938 def addHeaders(self, headers):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	939 for header in headers:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	940 self.addHeader(header)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	941
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	942 def addHeader(self, header):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	943 pass # TODO
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	944
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	945 def addItems(self, items):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	946 for item in items:
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	947 self.append(item)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	948
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	949 def setRowIndex(self, idx):
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	950 """ Set index for next row
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	951
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	952 index are returned when a row is selected, in data's "index" key
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	953 @param idx: string index to associate to the next row
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	954 """
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	955 self.next_row_idx = idx
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	956
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	957 def append(self, child):
f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	958 if isinstance(child, RowElement):
f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	959 return super(AdvancedListContainer, self).append(child)
f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	960 if self._item_idx % self._columns == 0:
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	961 self.current_row = RowElement(self)
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	962 self.current_row.append(child)
f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	963 self._item_idx += 1
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	964
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	965 def end(self):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	966 """ Called when we have finished list
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	967
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	968 change current container to first container parent
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	969 """
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	970 if self._item_idx % self._columns != 0:
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	971 raise exceptions.DataError(_("Incorrect number of items in list"))
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	972 parent_container = self.getParentContainer()
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	973 self.xmlui.changeContainer(parent_container)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	974
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	975
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	976 ## Widgets ##
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	977
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	978
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	979 class Widget(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	980 type = None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	981
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	982 def __init__(self, xmlui, name=None, parent=None):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	983 """Create an element
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	984
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	985 @param xmlui: XMLUI instance
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	986 @param name: name of the element or None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	987 @param parent: parent element or None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	988 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	989 self.elem = xmlui.doc.createElement("widget")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	990 super(Widget, self).__init__(xmlui, parent)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	991 if name:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	992 self.elem.setAttribute("name", name)
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	993 if name in xmlui.named_widgets:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	994 raise exceptions.ConflictError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	995 _('A widget with the name "{name}" already exists.').format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	996 name=name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	997 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	998 )
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	999 xmlui.named_widgets[name] = self
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1000 self.elem.setAttribute("type", self.type)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1001
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1002 def setInternalCallback(self, callback, fields, data_elts=None):
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1003 """Set an internal UI callback when the widget value is changed.
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1004
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1005 The internal callbacks are NO callback ids, they are strings from
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1006 a predefined set of actions that are running in the scope of XMLUI.
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1007 @param callback (string): a value from:
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1008 - 'copy': process the widgets given in 'fields' two by two, by
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1009 copying the values of one widget to the other. Target widgets
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1010 of type List do not accept the empty value.
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1011 - 'move': same than copy but moves the values if the source widget
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1012 is not a List.
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1013 - 'groups_of_contact': process the widgets two by two, assume A is
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1014 is a list of JID and B a list of groups, select in B the groups
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1015 to which the JID selected in A belongs.
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1016 - more operation to be added when necessary...
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1017 @param fields (list): a list of widget names (string)
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1018 @param data_elts (list[Element]): extra data elements
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1019 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1020 self.elem.setAttribute("internal_callback", callback)
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1021 if fields:
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1022 for field in fields:
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1023 InternalFieldElement(self, field)
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1024 if data_elts:
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1025 InternalDataElement(self, data_elts)
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	1026
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1027
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1028 class EmptyWidget(Widget):
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1029 """Place holder widget"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1030
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1031 type = "empty"
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1032
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1033
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1034 class TextWidget(Widget):
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1035 """Used for blob of text"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1036
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1037 type = "text"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1038
865 3ee2ec7ec010 core (xmlui), frontends: handling of "text" type in params xml + bug fixes Goffi <goffi@goffi.org> parents: 863 diff changeset	1039 def __init__(self, xmlui, value, name=None, parent=None):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1040 super(TextWidget, self).__init__(xmlui, name, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1041 value_elt = self.xmlui.doc.createElement("value")
865 3ee2ec7ec010 core (xmlui), frontends: handling of "text" type in params xml + bug fixes Goffi <goffi@goffi.org> parents: 863 diff changeset	1042 text = self.xmlui.doc.createTextNode(value)
1086 2cb30f46e560 core/frontends (XMLUI): value can now be inserted as a <value/> element, if not present value attribute is tested, else empty string is used. Goffi <goffi@goffi.org> parents: 1084 diff changeset	1043 value_elt.appendChild(text)
2cb30f46e560 core/frontends (XMLUI): value can now be inserted as a <value/> element, if not present value attribute is tested, else empty string is used. Goffi <goffi@goffi.org> parents: 1084 diff changeset	1044 self.elem.appendChild(value_elt)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1045
2428 c2d88fe05303 core (XMLUI): added a "value" property in TextWidget Goffi <goffi@goffi.org> parents: 2414 diff changeset	1046 @property
c2d88fe05303 core (XMLUI): added a "value" property in TextWidget Goffi <goffi@goffi.org> parents: 2414 diff changeset	1047 def value(self):
c2d88fe05303 core (XMLUI): added a "value" property in TextWidget Goffi <goffi@goffi.org> parents: 2414 diff changeset	1048 return self.elem.firstChild.firstChild.wholeText
c2d88fe05303 core (XMLUI): added a "value" property in TextWidget Goffi <goffi@goffi.org> parents: 2414 diff changeset	1049
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1050
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1051 class LabelWidget(Widget):
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1052 """One line blob of text
c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1053
c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1054 used most of time to display the desciption or name of the next widget
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1055 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1056 type = "label"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1057
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1058 def __init__(self, xmlui, label, name=None, parent=None):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1059 super(LabelWidget, self).__init__(xmlui, name, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1060 self.elem.setAttribute("value", label)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1061
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1062
2668 c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1063 class HiddenWidget(Widget):
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1064 """Not displayed widget, frontends will just copy the value(s)"""
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1065 type = "hidden"
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1066
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1067 def __init__(self, xmlui, value, name, parent=None):
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1068 super(HiddenWidget, self).__init__(xmlui, name, parent)
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1069 value_elt = self.xmlui.doc.createElement("value")
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1070 text = self.xmlui.doc.createTextNode(value)
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1071 value_elt.appendChild(text)
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1072 self.elem.appendChild(value_elt)
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1073
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1074 @property
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1075 def value(self):
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1076 return self.elem.firstChild.firstChild.wholeText
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1077
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	1078
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1079 class JidWidget(Widget):
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1080 """Used to display a Jabber ID, some specific methods can be added"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1081
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1082 type = "jid"
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1083
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1084 def __init__(self, xmlui, jid, name=None, parent=None):
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1085 super(JidWidget, self).__init__(xmlui, name, parent)
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1086 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1087 self.elem.setAttribute("value", jid.full())
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1088 except AttributeError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1089 self.elem.setAttribute("value", str(jid))
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1090
3448 987198910e56 tools (xml_tools): add missing `value` property to JidWidget Goffi <goffi@goffi.org> parents: 3396 diff changeset	1091 @property
987198910e56 tools (xml_tools): add missing `value` property to JidWidget Goffi <goffi@goffi.org> parents: 3396 diff changeset	1092 def value(self):
987198910e56 tools (xml_tools): add missing `value` property to JidWidget Goffi <goffi@goffi.org> parents: 3396 diff changeset	1093 return self.elem.getAttribute("value")
987198910e56 tools (xml_tools): add missing `value` property to JidWidget Goffi <goffi@goffi.org> parents: 3396 diff changeset	1094
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1095
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1096 class DividerWidget(Widget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1097 type = "divider"
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1098
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1099 def __init__(self, xmlui, style="line", name=None, parent=None):
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1100 """ Create a divider
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1101
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1102 @param xmlui: XMLUI instance
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1103 @param style: one of:
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1104 - line: a simple line
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1105 - dot: a line of dots
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1106 - dash: a line of dashes
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1107 - plain: a full thick line
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1108 - blank: a blank line/space
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1109 @param name: name of the widget
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1110 @param parent: parent container
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1111
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1112 """
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1113 super(DividerWidget, self).__init__(xmlui, name, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1114 self.elem.setAttribute("style", style)
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1115
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1116
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1117 ### Inputs ###
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1118
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1119
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1120 class InputWidget(Widget):
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1121 """Widget which can accept user inputs
c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1122
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1123 used mainly in forms
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1124 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1125
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1126 def __init__(self, xmlui, name=None, parent=None, read_only=False):
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1127 super(InputWidget, self).__init__(xmlui, name, parent)
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1128 if read_only:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1129 self.elem.setAttribute("read_only", "true")
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1130
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1131
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1132 class StringWidget(InputWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1133 type = "string"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1134
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1135 def __init__(self, xmlui, value=None, name=None, parent=None, read_only=False):
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1136 super(StringWidget, self).__init__(xmlui, name, parent, read_only=read_only)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1137 if value:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1138 value_elt = self.xmlui.doc.createElement("value")
1086 2cb30f46e560 core/frontends (XMLUI): value can now be inserted as a <value/> element, if not present value attribute is tested, else empty string is used. Goffi <goffi@goffi.org> parents: 1084 diff changeset	1139 text = self.xmlui.doc.createTextNode(value)
2cb30f46e560 core/frontends (XMLUI): value can now be inserted as a <value/> element, if not present value attribute is tested, else empty string is used. Goffi <goffi@goffi.org> parents: 1084 diff changeset	1140 value_elt.appendChild(text)
2cb30f46e560 core/frontends (XMLUI): value can now be inserted as a <value/> element, if not present value attribute is tested, else empty string is used. Goffi <goffi@goffi.org> parents: 1084 diff changeset	1141 self.elem.appendChild(value_elt)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1142
2446 bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1143 @property
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1144 def value(self):
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1145 return self.elem.firstChild.firstChild.wholeText
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1146
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1147
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1148 class PasswordWidget(StringWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1149 type = "password"
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1150
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1151
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1152 class TextBoxWidget(StringWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1153 type = "textbox"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1154
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1155
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1156 class XHTMLBoxWidget(StringWidget):
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1157 """Specialized textbox to manipulate XHTML"""
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1158 type = "xhtmlbox"
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1159
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1160 def __init__(self, xmlui, value, name=None, parent=None, read_only=False, clean=True):
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1161 """
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1162 @param clean(bool): if True, the XHTML is considered insecure and will be cleaned
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1163 Only set to False if you are absolutely sure that the XHTML is safe (in other
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1164 word, set to False only if you made the XHTML yourself)
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1165 """
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1166 if clean:
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1167 if cleanXHTML is None:
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1168 raise exceptions.NotFound(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1169 "No cleaning method set, can't clean the XHTML")
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1170 value = cleanXHTML(value)
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1171
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1172 super(XHTMLBoxWidget, self).__init__(
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1173 xmlui, value=value, name=name, parent=parent, read_only=read_only)
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1174
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1175
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1176 class JidInputWidget(StringWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1177 type = "jid_input"
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1178
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1179
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1180 # TODO handle min and max values
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1181 class IntWidget(StringWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1182 type = "int"
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1183
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1184 def __init__(self, xmlui, value=0, name=None, parent=None, read_only=False):
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1185 try:
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1186 int(value)
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1187 except ValueError:
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1188 raise exceptions.DataError(_("Value must be an integer"))
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1189 super(IntWidget, self).__init__(xmlui, value, name, parent, read_only=read_only)
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1190
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1191
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1192 class BoolWidget(InputWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1193 type = "bool"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1194
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1195 def __init__(self, xmlui, value="false", name=None, parent=None, read_only=False):
910 9754c0ebadba core (XMLUI): BoolWidget now accept real boolean for value Goffi <goffi@goffi.org> parents: 905 diff changeset	1196 if isinstance(value, bool):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1197 value = "true" if value else "false"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1198 elif value == "0":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1199 value = "false"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1200 elif value == "1":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1201 value = "true"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1202 if value not in ("true", "false"):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1203 raise exceptions.DataError(_("Value must be 0, 1, false or true"))
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1204 super(BoolWidget, self).__init__(xmlui, name, parent, read_only=read_only)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1205 self.elem.setAttribute("value", value)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1206
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1207
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1208 class ButtonWidget(Widget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1209 type = "button"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1210
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1211 def __init__(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1212 self, xmlui, callback_id, value=None, fields_back=None, name=None, parent=None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1213 ):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1214 """Add a button
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1215
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1216 @param callback_id: callback which will be called if button is pressed
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1217 @param value: label of the button
1487 0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	1218 @param fields_back: list of names of field to give back when pushing the button
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1219 @param name: name
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1220 @param parent: parent container
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1221 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1222 if fields_back is None:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1223 fields_back = []
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1224 super(ButtonWidget, self).__init__(xmlui, name, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1225 self.elem.setAttribute("callback", callback_id)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1226 if value:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1227 self.elem.setAttribute("value", value)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1228 for field in fields_back:
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1229 FieldBackElement(self, field)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1230
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1231
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1232 class ListWidget(InputWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1233 type = "list"
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1234 STYLES = ("multi", "noselect", "extensible", "reducible", "inline")
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1235
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1236 def __init__(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1237 self, xmlui, options, selected=None, styles=None, name=None, parent=None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1238 ):
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1239 """
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1240
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1241 @param xmlui
1141 7fcafc3206b1 plugin OTR: authentication management + fixed a bug in setState (due to a wrong docstring in potr.context.getCurrentTrust) Goffi <goffi@goffi.org> parents: 1105 diff changeset	1242 @param options (list[option]): each option can be given as:
7fcafc3206b1 plugin OTR: authentication management + fixed a bug in setState (due to a wrong docstring in potr.context.getCurrentTrust) Goffi <goffi@goffi.org> parents: 1105 diff changeset	1243 - a single string if the label and the value are the same
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1244 - a tuple with a couple of string (value,label) if the label and the
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1245 value differ
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1246 @param selected (list[string]): list of the selected values
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1247 @param styles (iterable[string]): flags to set the behaviour of the list
2071 c2fdee1bd908 core (stdui): fixed cancellation of ContactList forms Goffi <goffi@goffi.org> parents: 2044 diff changeset	1248 can be:
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1249 - multi: multiple selection is allowed
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1250 - noselect: no selection is allowed
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1251 useful when only the list itself is needed
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1252 - extensible: can be extended by user (i.e. new options can be added)
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1253 - reducible: can be reduced by user (i.e. options can be removed)
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1254 - inline: hint that this list should be displayed on a single line
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1255 (e.g. list of labels)
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1256 @param name (string)
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1257 @param parent
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1258 """
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1259 styles = set() if styles is None else set(styles)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1260 if styles is None:
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1261 styles = set()
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1262 else:
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1263 styles = set(styles)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1264 if "noselect" in styles and ("multi" in styles or selected):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1265 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1266 _(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1267 '"multi" flag and "selected" option are not compatible with '
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1268 '"noselect" flag'
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1269 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1270 )
820 462f2052af26 core(XMLUI): empty options in ListWidget now just show a warning message, no more assert Goffi <goffi@goffi.org> parents: 811 diff changeset	1271 if not options:
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	1272 # we can have no options if we get a submitted data form
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	1273 # but we can't use submitted values directly,
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	1274 # because we would not have the labels
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 981 diff changeset	1275 log.warning(_('empty "options" list'))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1276 super(ListWidget, self).__init__(xmlui, name, parent)
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1277 self.addOptions(options, selected)
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1278 self.setStyles(styles)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1279
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1280 def addOptions(self, options, selected=None):
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1281 """Add options to a multi-values element (e.g. list) """
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1282 if selected:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1283 if isinstance(selected, str):
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1284 selected = [selected]
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1285 else:
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1286 selected = []
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1287 for option in options:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1288 assert isinstance(option, str) or isinstance(option, tuple)
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1289 value = option if isinstance(option, str) else option[0]
1067 f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	1290 OptionElement(self, option, value in selected)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1291
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1292 def setStyles(self, styles):
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1293 if not styles.issubset(self.STYLES):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1294 raise exceptions.DataError(_("invalid styles"))
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1295 for style in styles:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1296 self.elem.setAttribute(style, "yes")
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1297 # TODO: check flags incompatibily (noselect and multi) like in __init__
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1298
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1299 def setStyle(self, style):
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1300 self.setStyles([style])
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1301
2446 bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1302 @property
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1303 def value(self):
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1304 """Return the value of first selected option"""
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1305 for child in self.elem.childNodes:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1306 if child.tagName == "option" and child.getAttribute("selected") == "true":
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1307 return child.getAttribute("value")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1308 return ""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1309
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1310
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1311 class JidsListWidget(InputWidget):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1312 """A list of text or jids where elements can be added/removed or modified"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1313
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1314 type = "jids_list"
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1315
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1316 def __init__(self, xmlui, jids, styles=None, name=None, parent=None):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1317 """
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1318
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1319 @param xmlui
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1320 @param jids (list[jid.JID]): base jids
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1321 @param styles (iterable[string]): flags to set the behaviour of the list
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1322 @param name (string)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1323 @param parent
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1324 """
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1325 super(JidsListWidget, self).__init__(xmlui, name, parent)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1326 styles = set() if styles is None else set(styles)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1327 if not styles.issubset([]): # TODO
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1328 raise exceptions.DataError(_("invalid styles"))
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1329 for style in styles:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1330 self.elem.setAttribute(style, "yes")
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1331 if not jids:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1332 log.debug("empty jids list")
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1333 else:
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1334 self.addJids(jids)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1335
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1336 def addJids(self, jids):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1337 for jid_ in jids:
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1338 JidElement(self, jid_)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1339
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1340
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1341 ## Dialog Elements ##
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1342
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1343
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1344 class DialogElement(Element):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1345 """Main dialog element """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1346
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1347 type = "dialog"
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1348
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1349 def __init__(self, parent, type_, level=None):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1350 if not isinstance(parent, TopElement):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1351 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1352 _("DialogElement must be a direct child of TopElement")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1353 )
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1354 super(DialogElement, self).__init__(parent.xmlui, parent)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1355 self.elem.setAttribute(C.XMLUI_DATA_TYPE, type_)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1356 self.elem.setAttribute(C.XMLUI_DATA_LVL, level or C.XMLUI_DATA_LVL_DEFAULT)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1357
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1358
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1359 class MessageElement(Element):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1360 """Element with the instruction message"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1361
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1362 type = C.XMLUI_DATA_MESS
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1363
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1364 def __init__(self, parent, message):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1365 if not isinstance(parent, DialogElement):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1366 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1367 _("MessageElement must be a direct child of DialogElement")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1368 )
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1369 super(MessageElement, self).__init__(parent.xmlui, parent)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1370 message_txt = self.xmlui.doc.createTextNode(message)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1371 self.elem.appendChild(message_txt)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1372
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1373
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1374 class ButtonsElement(Element):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1375 """Buttons element which indicate which set to use"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1376
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1377 type = "buttons"
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1378
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1379 def __init__(self, parent, set_):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1380 if not isinstance(parent, DialogElement):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1381 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1382 _("ButtonsElement must be a direct child of DialogElement")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1383 )
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1384 super(ButtonsElement, self).__init__(parent.xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1385 self.elem.setAttribute("set", set_)
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1386
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1387
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1388 class FileElement(Element):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1389 """File element used for FileDialog"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1390
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1391 type = "file"
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1392
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1393 def __init__(self, parent, type_):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1394 if not isinstance(parent, DialogElement):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1395 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1396 _("FileElement must be a direct child of DialogElement")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1397 )
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1398 super(FileElement, self).__init__(parent.xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1399 self.elem.setAttribute("type", type_)
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1400
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1401
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1402 ## XMLUI main class
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1403
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1404
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1405 class XMLUI(object):
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1406 """This class is used to create a user interface (form/window/parameters/etc) using SàT XML"""
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1407
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1408 def __init__(self, panel_type="window", container="vertical", dialog_opt=None,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1409 title=None, submit_id=None, session_id=None):
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1410 """Init SàT XML Panel
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1411
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1412 @param panel_type: one of
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1413 - C.XMLUI_WINDOW (new window)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1414 - C.XMLUI_POPUP
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1415 - C.XMLUI_FORM (form, depend of the frontend, usually a panel with
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1416 cancel/submit buttons)
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1417 - C.XMLUI_PARAM (parameters, presentation depend of the frontend)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1418 - C.XMLUI_DIALOG (one common dialog, presentation depend of frontend)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1419 @param container: disposition of elements, one of:
107 5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1420 - vertical: elements are disposed up to bottom
5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1421 - horizontal: elements are disposed left to right
5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1422 - pairs: elements come on two aligned columns
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1423 (usually one for a label, the next for the element)
2361 5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	1424 - label: associations of one LabelWidget or EmptyWidget with an other widget
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1425 similar to pairs but specialized in LabelWidget,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1426 and not necessarily arranged in 2 columns
107 5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1427 - tabs: elemens are in categories with tabs (notebook)
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1428 @param dialog_opt: only used if panel_type == C.XMLUI_DIALOG.
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1429 Dictionnary (string/string) where key can be:
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1430 - C.XMLUI_DATA_TYPE: type of dialog, value can be:
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1431 - C.XMLUI_DIALOG_MESSAGE (default): an information/error message.
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1432 Action of user is necessary to close the dialog.
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1433 Usually the frontend display a classic popup.
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1434 - C.XMLUI_DIALOG_NOTE: like a C.XMLUI_DIALOG_MESSAGE, but action of user
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1435 is not necessary to close, at frontend choice (it can be closed after
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1436 a timeout). Usually the frontend display as a timed out notification
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1437 - C.XMLUI_DIALOG_CONFIRM: dialog with 2 choices (usualy "Ok"/"Cancel").
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1438 returned data can contain:
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1439 - "answer": "true" if answer is "ok", "yes" or equivalent,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1440 "false" else
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1441 - C.XLMUI_DIALOG_FILE: a file selection dialog
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1442 returned data can contain:
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1443 - "cancelled": "true" if dialog has been cancelled, not present
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1444 or "false" else
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1445 - "path": path of the choosed file/dir
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1446 - C.XMLUI_DATA_MESS: message shown in dialog
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1447 - C.XMLUI_DATA_LVL: one of:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1448 - C.XMLUI_DATA_LVL_INFO (default): normal message
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1449 - C.XMLUI_DATA_LVL_WARNING: attention of user is important
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1450 - C.XMLUI_DATA_LVL_ERROR: something went wrong
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1451 - C.XMLUI_DATA_BTNS_SET: one of:
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1452 - C.XMLUI_DATA_BTNS_SET_OKCANCEL (default): classical "OK" and "Cancel"
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1453 set
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1454 - C.XMLUI_DATA_BTNS_SET_YESNO: a translated "yes" for OK, and "no" for
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1455 Cancel
1521 d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1456 - C.XMLUI_DATA_FILETYPE: only used for file dialogs, one of:
d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1457 - C.XMLUI_DATA_FILETYPE_FILE: a file path is requested
d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1458 - C.XMLUI_DATA_FILETYPE_DIR: a dir path is requested
d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1459 - C.XMLUI_DATA_FILETYPE_DEFAULT: same as C.XMLUI_DATA_FILETYPE_FILE
d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1460
107 5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1461 @param title: title or default if None
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1462 @param submit_id: callback id to call for panel_type we can submit (form, param,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1463 dialog)
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1464 @param session_id: use to keep a session attached to the dialog, must be
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1465 returned by frontends
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	1466 @attribute named_widgets(dict): map from name to widget
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1467 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1468 if panel_type not in [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1469 C.XMLUI_WINDOW,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1470 C.XMLUI_FORM,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1471 C.XMLUI_PARAM,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1472 C.XMLUI_POPUP,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1473 C.XMLUI_DIALOG,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1474 ]:
760 73a0077f80cc backend, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	1475 raise exceptions.DataError(_("Unknown panel type [%s]") % panel_type)
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1476 if panel_type == C.XMLUI_FORM and submit_id is None:
760 73a0077f80cc backend, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	1477 raise exceptions.DataError(_("form XMLUI need a submit_id"))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1478 if not isinstance(container, str):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1479 raise exceptions.DataError(_("container argument must be a string"))
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1480 if dialog_opt is not None and panel_type != C.XMLUI_DIALOG:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1481 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1482 _("dialog_opt can only be used with dialog panels")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1483 )
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1484 self.type = panel_type
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1485 impl = minidom.getDOMImplementation()
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1486
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1487 self.doc = impl.createDocument(None, "sat_xmlui", None)
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1488 top_element = self.doc.documentElement
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1489 top_element.setAttribute("type", panel_type)
107 5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1490 if title:
5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1491 top_element.setAttribute("title", title)
1530 94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1492 self.submit_id = submit_id
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1493 self.session_id = session_id
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1494 if panel_type == C.XMLUI_DIALOG:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1495 if dialog_opt is None:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1496 dialog_opt = {}
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1497 self._createDialog(dialog_opt)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1498 return
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	1499 self.main_container = self._createContainer(container, TopElement(self))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1500 self.current_container = self.main_container
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	1501 self.named_widgets = {}
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1502
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1503 @staticmethod
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1504 def creatorWrapper(widget_cls, is_input):
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1505 # TODO: once moved to Python 3, use functools.partialmethod and
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1506 # remove the creatorWrapper
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1507 def createWidget(self, args, *kwargs):
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1508 if self.type == C.XMLUI_DIALOG:
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1509 raise exceptions.InternalError(_(
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1510 "createWidget can't be used with dialogs"))
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1511 if "parent" not in kwargs:
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1512 kwargs["parent"] = self.current_container
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1513 if "name" not in kwargs and is_input:
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1514 # name can be given as first argument or in keyword
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1515 # arguments for InputWidgets
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1516 args = list(args)
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1517 kwargs["name"] = args.pop(0)
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1518 return widget_cls(self, args, *kwargs)
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1519 return createWidget
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1520
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1521 @classmethod
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1522 def _introspect(cls):
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1523 """ Introspect module to find Widgets and Containers, and create addXXX methods"""
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1524 # FIXME: we can't log anything because this file is used
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1525 # in bin/sat script then evaluated
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1526 # bin/sat should be refactored
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1527 # log.debug(u'introspecting XMLUI widgets and containers')
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1528 cls._containers = {}
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1529 cls._widgets = {}
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1530 for obj in list(globals().values()):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1531 try:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1532 if issubclass(obj, Widget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1533 if obj.__name__ == "Widget":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1534 continue
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1535 cls._widgets[obj.type] = obj
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1536 creator_name = "add" + obj.__name__
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1537 if creator_name.endswith('Widget'):
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1538 creator_name = creator_name[:-6]
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1539 is_input = issubclass(obj, InputWidget)
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1540 # FIXME: cf. above comment
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1541 # log.debug(u"Adding {creator_name} creator (is_input={is_input}))"
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1542 # .format(creator_name=creator_name, is_input=is_input))
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1543
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1544 assert not hasattr(cls, creator_name)
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1545 # XXX: we need to use creatorWrapper because we are in a loop
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1546 # and Python 2 doesn't support default values in kwargs
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1547 # when using args, *kwargs
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1548 setattr(cls, creator_name, cls.creatorWrapper(obj, is_input))
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1549
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1550 elif issubclass(obj, Container):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1551 if obj.__name__ == "Container":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1552 continue
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1553 cls._containers[obj.type] = obj
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1554 except TypeError:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1555 pass
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1556
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1557 def __del__(self):
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1558 self.doc.unlink()
952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1559
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1560 @property
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1561 def submit_id(self):
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1562 top_element = self.doc.documentElement
1530 94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1563 if not top_element.hasAttribute("submit"):
94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1564 # getAttribute never return None (it return empty string it attribute doesn't exists)
94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1565 # so we have to manage None here
94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1566 return None
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1567 value = top_element.getAttribute("submit")
1530 94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1568 return value
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1569
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1570 @submit_id.setter
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1571 def submit_id(self, value):
760 73a0077f80cc backend, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	1572 top_element = self.doc.documentElement
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1573 if value is None:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1574 try:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1575 top_element.removeAttribute("submit")
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1576 except NotFoundErr:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1577 pass
1531 51dec65ec62c core (xmlui): fixed submit_id returning None when its value is '' Goffi <goffi@goffi.org> parents: 1530 diff changeset	1578 else: # submit_id can be the empty string to bypass form restriction
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1579 top_element.setAttribute("submit", value)
760 73a0077f80cc backend, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	1580
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1581 @property
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1582 def session_id(self):
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1583 top_element = self.doc.documentElement
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1584 value = top_element.getAttribute("session_id")
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1585 return value or None
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1586
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1587 @session_id.setter
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1588 def session_id(self, value):
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1589 top_element = self.doc.documentElement
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1590 if value is None:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1591 try:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1592 top_element.removeAttribute("session_id")
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1593 except NotFoundErr:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1594 pass
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1595 elif value:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1596 top_element.setAttribute("session_id", value)
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1597 else:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1598 raise exceptions.DataError("session_id can't be empty")
760 73a0077f80cc backend, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	1599
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1600 def _createDialog(self, dialog_opt):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1601 dialog_type = dialog_opt.setdefault(C.XMLUI_DATA_TYPE, C.XMLUI_DIALOG_MESSAGE)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1602 if (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1603 dialog_type in [C.XMLUI_DIALOG_CONFIRM, C.XMLUI_DIALOG_FILE]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1604 and self.submit_id is None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1605 ):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1606 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1607 _("Submit ID must be filled for this kind of dialog")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1608 )
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1609 top_element = TopElement(self)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1610 level = dialog_opt.get(C.XMLUI_DATA_LVL)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1611 dialog_elt = DialogElement(top_element, dialog_type, level)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1612
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1613 try:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1614 MessageElement(dialog_elt, dialog_opt[C.XMLUI_DATA_MESS])
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1615 except KeyError:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1616 pass
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1617
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1618 try:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1619 ButtonsElement(dialog_elt, dialog_opt[C.XMLUI_DATA_BTNS_SET])
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1620 except KeyError:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1621 pass
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1622
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1623 try:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1624 FileElement(dialog_elt, dialog_opt[C.XMLUI_DATA_FILETYPE])
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1625 except KeyError:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1626 pass
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1627
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1628 def _createContainer(self, container, parent=None, **kwargs):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1629 """Create a container element
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1630
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1631 @param type: container type (cf init doc)
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1632 @parent: parent element or None
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1633 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1634 if container not in self._containers:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1635 raise exceptions.DataError(_("Unknown container type [%s]") % container)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1636 cls = self._containers[container]
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1637 new_container = cls(self, parent=parent, **kwargs)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1638 return new_container
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	1639
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1640 def changeContainer(self, container, **kwargs):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1641 """Change the current container
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1642
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1643 @param container: either container type (container it then created),
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1644 or an Container instance"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1645 if isinstance(container, str):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1646 self.current_container = self._createContainer(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1647 container,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1648 self.current_container.getParentContainer() or self.main_container,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1649 **kwargs
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1650 )
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1651 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1652 self.current_container = (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1653 self.main_container if container is None else container
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1654 )
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	1655 assert isinstance(self.current_container, Container)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1656 return self.current_container
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1657
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1658 def addWidget(self, type_, args, *kwargs):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1659 """Convenience method to add an element"""
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1660 if "parent" not in kwargs:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1661 kwargs["parent"] = self.current_container
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1662 try:
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1663 cls = self._widgets[type_]
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1664 except KeyError:
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1665 raise exceptions.DataError(_("Invalid type [{type_}]").format(type_=type_))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1666 return cls(self, args, *kwargs)
104 5458ac1380cc XMLUI: added tabs layout Goffi <goffi@goffi.org> parents: 103 diff changeset	1667
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1668 def toXml(self):
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1669 """return the XML representation of the panel"""
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1670 return self.doc.toxml()
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1671
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1672
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1673 # we call this to have automatic discovery of containers and widgets
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1674 XMLUI._introspect()
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1675
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1676
1142 2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1677 # Some sugar for XMLUI dialogs
2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1678
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1679
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1680 def note(message, title="", level=C.XMLUI_DATA_LVL_INFO):
2044 4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1681 """sugar to easily create a Note Dialog
1142 2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1682
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1683 @param message(unicode): body of the note
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1684 @param title(unicode): title of the note
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1685 @param level(unicode): one of C.XMLUI_DATA_LVL_*
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1686 @return(XMLUI): instance of XMLUI
1142 2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1687 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1688 note_xmlui = XMLUI(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1689 C.XMLUI_DIALOG,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1690 dialog_opt={
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1691 C.XMLUI_DATA_TYPE: C.XMLUI_DIALOG_NOTE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1692 C.XMLUI_DATA_MESS: message,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1693 C.XMLUI_DATA_LVL: level,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1694 },
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1695 title=title,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1696 )
1142 2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1697 return note_xmlui
2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1698
1692 0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1699
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1700 def quickNote(host, client, message, title="", level=C.XMLUI_DATA_LVL_INFO):
2044 4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1701 """more sugar to do the whole note process"""
4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1702 note_ui = note(message, title, level)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1703 host.actionNew({"xmlui": note_ui.toXml()}, profile=client.profile)
2044 4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1704
4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1705
1692 0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1706 def deferredUI(host, xmlui, chained=False):
2044 4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1707 """create a deferred linked to XMLUI
1692 0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1708
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1709 @param xmlui(XMLUI): instance of the XMLUI
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1710 Must be an XMLUI that you can submit, with submit_id set to ''
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1711 @param chained(bool): True if the Deferred result must be returned to the frontend
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1712 useful when backend is in a series of dialogs with an ui
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1713 @return (D(data)): a deferred which fire the data
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1714 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1715 assert xmlui.submit_id == ""
1692 0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1716 xmlui_d = defer.Deferred()
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1717
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1718 def onSubmit(data, profile):
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1719 xmlui_d.callback(data)
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1720 return xmlui_d if chained else {}
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1721
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1722 xmlui.submit_id = host.registerCallback(onSubmit, with_data=True, one_shot=True)
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1723 return xmlui_d
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1724
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1725
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1726 def deferXMLUI(host, xmlui, action_extra=None, security_limit=C.NO_SECURITY_LIMIT,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1727 chained=False, profile=C.PROF_KEY_NONE):
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1728 """Create a deferred linked to XMLUI
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1729
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1730 @param xmlui(XMLUI): instance of the XMLUI
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1731 Must be an XMLUI that you can submit, with submit_id set to ''
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1732 @param profile: %(doc_profile)s
1601 e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1733 @param action_extra(None, dict): extra action to merge with xmlui
e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1734 mainly used to add meta informations (see actionNew doc)
1599 e2ed8009e66e backend, bridge, frontends: actionNew has now a security_limit argument + added some docstring to explain data argument Goffi <goffi@goffi.org> parents: 1531 diff changeset	1735 @param security_limit: %(doc_security_limit)s
1692 0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1736 @param chained(bool): True if the Deferred result must be returned to the frontend
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1737 useful when backend is in a series of dialogs with an ui
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1738 @return (data): a deferred which fire the data
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1739 """
1736 3739f7779f17 core (xmlui): fixed bad call of deferredUI in deferXMLUI Goffi <goffi@goffi.org> parents: 1735 diff changeset	1740 xmlui_d = deferredUI(host, xmlui, chained)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1741 action_data = {"xmlui": xmlui.toXml()}
1601 e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1742 if action_extra is not None:
e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1743 action_data.update(action_extra)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1744 host.actionNew(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1745 action_data,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1746 security_limit=security_limit,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1747 keep_id=xmlui.submit_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1748 profile=profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1749 )
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1750 return xmlui_d
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1751
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1752
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1753 def deferDialog(host, message, title="Please confirm", type_=C.XMLUI_DIALOG_CONFIRM,
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1754 options=None, action_extra=None, security_limit=C.NO_SECURITY_LIMIT, chained=False,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1755 profile=C.PROF_KEY_NONE):
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1756 """Create a submitable dialog and manage it with a deferred
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1757
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1758 @param message(unicode): message to display
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1759 @param title(unicode): title of the dialog
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1760 @param type(unicode): dialog type (C.XMLUI_DIALOG_*)
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1761 @param options(None, dict): if not None, will be used to update (extend) dialog_opt
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1762 arguments of XMLUI
1601 e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1763 @param action_extra(None, dict): extra action to merge with xmlui
e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1764 mainly used to add meta informations (see actionNew doc)
e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1765 @param security_limit: %(doc_security_limit)s
1737 ad5da569ecf4 core (xmlui): fixed deferConfirm Goffi <goffi@goffi.org> parents: 1736 diff changeset	1766 @param chained(bool): True if the Deferred result must be returned to the frontend
ad5da569ecf4 core (xmlui): fixed deferConfirm Goffi <goffi@goffi.org> parents: 1736 diff changeset	1767 useful when backend is in a series of dialogs with an ui
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1768 @param profile: %(doc_profile)s
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1769 @return (dict): Deferred dict
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1770 """
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1771 assert profile is not None
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1772 dialog_opt = {"type": type_, "message": message}
1521 d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1773 if options is not None:
d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1774 dialog_opt.update(options)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1775 dialog = XMLUI(C.XMLUI_DIALOG, title=title, dialog_opt=dialog_opt, submit_id="")
1737 ad5da569ecf4 core (xmlui): fixed deferConfirm Goffi <goffi@goffi.org> parents: 1736 diff changeset	1776 return deferXMLUI(host, dialog, action_extra, security_limit, chained, profile)
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1777
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1778
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1779 def deferConfirm(args, *kwargs):
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1780 """call deferDialog and return a boolean instead of the whole data dict"""
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1781 d = deferDialog(args, *kwargs)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1782 d.addCallback(lambda data: C.bool(data["answer"]))
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1783 return d
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1784
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1785
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1786 # Misc other funtions
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1787
3395 d6a482a78bda tools (xml_tools): added `with_parent` and `with_children` argument to `elementCopy` Goffi <goffi@goffi.org> parents: 3393 diff changeset	1788 def elementCopy(
d6a482a78bda tools (xml_tools): added `with_parent` and `with_children` argument to `elementCopy` Goffi <goffi@goffi.org> parents: 3393 diff changeset	1789 element: domish.Element,
d6a482a78bda tools (xml_tools): added `with_parent` and `with_children` argument to `elementCopy` Goffi <goffi@goffi.org> parents: 3393 diff changeset	1790 with_parent: bool = True,
d6a482a78bda tools (xml_tools): added `with_parent` and `with_children` argument to `elementCopy` Goffi <goffi@goffi.org> parents: 3393 diff changeset	1791 with_children: bool = True
d6a482a78bda tools (xml_tools): added `with_parent` and `with_children` argument to `elementCopy` Goffi <goffi@goffi.org> parents: 3393 diff changeset	1792 ) -> domish.Element:
2814 777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1793 """Make a copy of a domish.Element
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1794
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1795 The copy will have its own children list, so other elements
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1796 can be added as direct children without modifying orignal one.
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1797 Children are not deeply copied, so if an element is added to a child or grandchild,
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1798 it will also affect original element.
3395 d6a482a78bda tools (xml_tools): added `with_parent` and `with_children` argument to `elementCopy` Goffi <goffi@goffi.org> parents: 3393 diff changeset	1799 @param element: Element to clone
2814 777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1800 """
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1801 new_elt = domish.Element(
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1802 (element.uri, element.name),
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1803 defaultUri = element.defaultUri,
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1804 attribs = element.attributes,
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1805 localPrefixes = element.localPrefixes)
3395 d6a482a78bda tools (xml_tools): added `with_parent` and `with_children` argument to `elementCopy` Goffi <goffi@goffi.org> parents: 3393 diff changeset	1806 if with_parent:
d6a482a78bda tools (xml_tools): added `with_parent` and `with_children` argument to `elementCopy` Goffi <goffi@goffi.org> parents: 3393 diff changeset	1807 new_elt.parent = element.parent
d6a482a78bda tools (xml_tools): added `with_parent` and `with_children` argument to `elementCopy` Goffi <goffi@goffi.org> parents: 3393 diff changeset	1808 if with_children:
d6a482a78bda tools (xml_tools): added `with_parent` and `with_children` argument to `elementCopy` Goffi <goffi@goffi.org> parents: 3393 diff changeset	1809 new_elt.children = element.children[:]
2814 777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1810 return new_elt
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1811
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1812
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1813 def isXHTMLField(field):
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1814 """Check if a data_form.Field is an XHTML one"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1815 return (field.fieldType is None and field.ext_type == "xml" and
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1816 field.value.uri == C.NS_XHTML)
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1817
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1818
3393 2b6f69f6df8c tools(xml_tools): fixed `<div>` unwrapping + added `parse` instance: Goffi <goffi@goffi.org> parents: 3233 diff changeset	1819 class ElementParser:
2b6f69f6df8c tools(xml_tools): fixed `<div>` unwrapping + added `parse` instance: Goffi <goffi@goffi.org> parents: 3233 diff changeset	1820 """Callable class to parse XML string into Element"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1821
1818 7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1822 # XXX: Found at http://stackoverflow.com/questions/2093400/how-to-create-twisted-words-xish-domish-element-entirely-from-raw-xml/2095942#2095942
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1823
1818 7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1824 def _escapeHTML(self, matchobj):
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1825 entity = matchobj.group(1)
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1826 if entity in XML_ENTITIES:
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1827 # we don't escape XML entities
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1828 return matchobj.group(0)
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1829 else:
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1830 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1831 return chr(html.entities.name2codepoint[entity])
1818 7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1832 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1833 log.warning("removing unknown entity {}".format(entity))
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1834 return ""
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1835
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1836 def __call__(self, raw_xml, force_spaces=False, namespace=None):
905 cad8e52bb2e6 tools: xml_tools.ElementParser do not replace '\n' and '\t' with ' ' by default souliane <souliane@mailoo.org> parents: 876 diff changeset	1837 """
1456 a13be5c22334 xml_tools: minor attribute renaming Goffi <goffi@goffi.org> parents: 1444 diff changeset	1838 @param raw_xml(unicode): the raw XML
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1839 @param force_spaces (bool): if True, replace occurrences of '\n' and '\t'
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1840 with ' '.
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1841 @param namespace(unicode, None): if set, use this namespace for the wrapping
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1842 element
905 cad8e52bb2e6 tools: xml_tools.ElementParser do not replace '\n' and '\t' with ' ' by default souliane <souliane@mailoo.org> parents: 876 diff changeset	1843 """
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1844 # we need to wrap element in case
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1845 # there is not a unique one on the top
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1846 if namespace is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1847 raw_xml = "<div xmlns='{}'>{}</div>".format(namespace, raw_xml)
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1848 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1849 raw_xml = "<div>{}</div>".format(raw_xml)
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1850
1818 7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1851 # avoid ParserError on HTML escaped chars
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1852 raw_xml = html_entity_re.sub(self._escapeHTML, raw_xml)
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1853
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1854 self.result = None
590 56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1855
56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1856 def onStart(elem):
56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1857 self.result = elem
56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1858
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1859 def onEnd():
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1860 pass
590 56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1861
56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1862 def onElement(elem):
56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1863 self.result.addChild(elem)
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1864
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1865 parser = domish.elementStream()
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1866 parser.DocumentStartEvent = onStart
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1867 parser.ElementEvent = onElement
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1868 parser.DocumentEndEvent = onEnd
536 a31abb97310d core, plugins: fixed bad namespace in stanza creation Goffi <goffi@goffi.org> parents: 480 diff changeset	1869 tmp = domish.Element((None, "s"))
905 cad8e52bb2e6 tools: xml_tools.ElementParser do not replace '\n' and '\t' with ' ' by default souliane <souliane@mailoo.org> parents: 876 diff changeset	1870 if force_spaces:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1871 raw_xml = raw_xml.replace("\n", " ").replace("\t", " ")
1456 a13be5c22334 xml_tools: minor attribute renaming Goffi <goffi@goffi.org> parents: 1444 diff changeset	1872 tmp.addRawXml(raw_xml)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1873 parser.parse(tmp.toXml().encode("utf-8"))
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1874 top_elt = self.result.firstChildElement()
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1875 # we now can check if there was a unique element on the top
3393 2b6f69f6df8c tools(xml_tools): fixed `<div>` unwrapping + added `parse` instance: Goffi <goffi@goffi.org> parents: 3233 diff changeset	1876 # and remove our wrapping <div/> is this is the case
2b6f69f6df8c tools(xml_tools): fixed `<div>` unwrapping + added `parse` instance: Goffi <goffi@goffi.org> parents: 3233 diff changeset	1877 top_elt_children = list(top_elt.elements())
2b6f69f6df8c tools(xml_tools): fixed `<div>` unwrapping + added `parse` instance: Goffi <goffi@goffi.org> parents: 3233 diff changeset	1878 if len(top_elt_children) == 1:
2b6f69f6df8c tools(xml_tools): fixed `<div>` unwrapping + added `parse` instance: Goffi <goffi@goffi.org> parents: 3233 diff changeset	1879 top_elt = top_elt_children[0]
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1880 return top_elt
1732 cf11cfc87ef9 xml_tools, plugin XEP-0071, XEP-0277: add method expandNewLinesToXHTML: souliane <souliane@mailoo.org> parents: 1692 diff changeset	1881
cf11cfc87ef9 xml_tools, plugin XEP-0071, XEP-0277: add method expandNewLinesToXHTML: souliane <souliane@mailoo.org> parents: 1692 diff changeset	1882
3393 2b6f69f6df8c tools(xml_tools): fixed `<div>` unwrapping + added `parse` instance: Goffi <goffi@goffi.org> parents: 3233 diff changeset	1883 parse = ElementParser()
2b6f69f6df8c tools(xml_tools): fixed `<div>` unwrapping + added `parse` instance: Goffi <goffi@goffi.org> parents: 3233 diff changeset	1884
2b6f69f6df8c tools(xml_tools): fixed `<div>` unwrapping + added `parse` instance: Goffi <goffi@goffi.org> parents: 3233 diff changeset	1885
1740 681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1886 # FIXME: this method is duplicated from frontends.tools.xmlui.getText
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1887 def getText(node):
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1888 """Get child text nodes of a domish.Element.
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1889
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1890 @param node (domish.Element)
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1891 @return: joined unicode text of all nodes
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1892 """
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1893 data = []
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1894 for child in node.childNodes:
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1895 if child.nodeType == child.TEXT_NODE:
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1896 data.append(child.wholeText)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1897 return "".join(data)
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1898
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1899
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1900 def findAll(elt, namespaces=None, names=None):
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1901 """Find child element at any depth matching criteria
c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1902
c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1903 @param elt(domish.Element): top parent of the elements to find
2108 70f23bc7859b core (xml_tools): fixed findAll Goffi <goffi@goffi.org> parents: 2071 diff changeset	1904 @param names(iterable[unicode], basestring, None): names to match
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1905 None to accept every names
2108 70f23bc7859b core (xml_tools): fixed findAll Goffi <goffi@goffi.org> parents: 2071 diff changeset	1906 @param namespace(iterable[unicode], basestring, None): URIs to match
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1907 None to accept every namespaces
2108 70f23bc7859b core (xml_tools): fixed findAll Goffi <goffi@goffi.org> parents: 2071 diff changeset	1908 @return ((G)domish.Element): found elements
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1909 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1910 if isinstance(namespaces, str):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1911 namespaces = tuple((namespaces,))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2958 diff changeset	1912 if isinstance(names, str):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1913 names = tuple((names,))
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1914
c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1915 for child in elt.elements():
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1916 if (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1917 domish.IElement.providedBy(child)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1918 and (not names or child.name in names)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1919 and (not namespaces or child.uri in namespaces)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1920 ):
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1921 yield child
2108 70f23bc7859b core (xml_tools): fixed findAll Goffi <goffi@goffi.org> parents: 2071 diff changeset	1922 for found in findAll(child, namespaces, names):
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1923 yield found
3396 a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1924
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1925
3491 2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1926 def findAncestor(elt, name: str, namespace: Optional[str] = None) -> domish.Element:
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1927 """Retrieve ancestor of an element"""
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1928 current = elt.parent
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1929 while True:
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1930 if current is None:
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1931 raise exceptions.NotFound(
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1932 f"Can't find any ancestor {name!r} (xmlns: {namespace!r})"
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1933 )
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1934 if current.name == name and (namespace is None or current.uri == namespace):
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1935 return current
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1936 current = current.parent
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1937
2bd75fc2555d tools (xml_tools): new findAncestor method: Goffi <goffi@goffi.org> parents: 3479 diff changeset	1938
3466 80f8635dc66e tools (xml_tools): fix pFmtElt: Goffi <goffi@goffi.org> parents: 3448 diff changeset	1939 def pFmtElt(elt, indent=0, defaultUri=""):
3396 a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1940 """Pretty format a domish.Element"""
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1941 strings = []
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1942 for child in elt.children:
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1943 if domish.IElement.providedBy(child):
3466 80f8635dc66e tools (xml_tools): fix pFmtElt: Goffi <goffi@goffi.org> parents: 3448 diff changeset	1944 strings.append(pFmtElt(child, indent+2, defaultUri=elt.defaultUri))
3396 a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1945 else:
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1946 strings.append(f"{(indent+2)*' '}{child!s}")
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1947 if elt.children:
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1948 nochild_elt = domish.Element(
3466 80f8635dc66e tools (xml_tools): fix pFmtElt: Goffi <goffi@goffi.org> parents: 3448 diff changeset	1949 (elt.uri, elt.name), elt.defaultUri, elt.attributes, elt.localPrefixes
3396 a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1950 )
3466 80f8635dc66e tools (xml_tools): fix pFmtElt: Goffi <goffi@goffi.org> parents: 3448 diff changeset	1951 strings.insert(0, f"{indent*' '}{nochild_elt.toXml(defaultUri=defaultUri)[:-2]}>")
3396 a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1952 strings.append(f"{indent*' '}</{nochild_elt.name}>")
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1953 else:
3466 80f8635dc66e tools (xml_tools): fix pFmtElt: Goffi <goffi@goffi.org> parents: 3448 diff changeset	1954 strings.append(f"{indent*' '}{elt.toXml(defaultUri=defaultUri)}")
3396 a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1955 return '\n'.join(strings)
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1956
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1957
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1958 def ppElt(elt):
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1959 """Pretty print a domish.Element"""
a4774f5b6b17 tools (xml_tools): `domish.Element` pretty formatting functions: Goffi <goffi@goffi.org> parents: 3395 diff changeset	1960 print(pFmtElt(elt))
3914 4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1961
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1962
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1963 # ElementTree
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1964
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1965 def et_get_namespace_and_name(et_elt: ET.Element) -> Tuple[Optional[str], str]:
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1966 """Retrieve element namespace and name from ElementTree element
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1967
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1968 @param et_elt: ElementTree element
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1969 @return: namespace and name of the element
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1970 if not namespace if specified, None is returned
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1971 """
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1972 name = et_elt.tag
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1973 if not name:
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1974 raise ValueError("no name set in ET element")
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1975 elif name[0] != "{":
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1976 return None, name
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1977 end_idx = name.find("}")
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1978 if end_idx == -1:
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1979 raise ValueError("Invalid ET name")
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1980 return name[1:end_idx], name[end_idx+1:]
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1981
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1982
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1983 def et_elt_2_domish_elt(et_elt: ET.Element) -> domish.Element:
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1984 """Convert ElementTree element to Twisted's domish.Element
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1985
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1986 Note: this is a naive implementation, adapted to XMPP, and some content are ignored
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1987 (attributes namespaces, tail)
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1988 """
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1989 namespace, name = et_get_namespace_and_name(et_elt)
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1990 elt = domish.Element((namespace, name), attribs=et_elt.attrib)
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1991 if et_elt.text:
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1992 elt.addContent(et_elt.text)
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1993 for child in et_elt:
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1994 elt.addChild(et_elt_2_domish_elt(child))
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1995 return elt
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1996
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1997
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1998 def domish_elt_2_et_elt(elt: domish.Element) -> ET.Element:
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	1999 """Convert Twisted's domish.Element to ElementTree equivalent
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2000
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2001 Note: this is a naive implementation, adapter to XMPP, and some text content may be
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2002 missing (content put after a tag, i.e. what would go to the "tail" attribute of ET
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2003 Element)
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2004 """
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2005 tag = f"{{{elt.uri}}}{elt.name}" if elt.uri else elt.name
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2006 et_elt = ET.Element(tag, attrib=elt.attributes)
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2007 content = str(elt)
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2008 if content:
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2009 et_elt.text = str(elt)
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2010 for child in elt.elements():
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2011 et_elt.append(domish_elt_2_et_elt(child))
4cb38c8312a1 plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing: Goffi <goffi@goffi.org> parents: 3903 diff changeset	2012 return et_elt

Mercurial > libervia-backend

annotate sat/tools/xml_tools.py @ 3916:40d47cc29ea4