libervia-backend: src/tools/xml

comparison src/tools/xml_tools.py @ 1476:48706f4ff19c

core (xmlui): added JidsListWidget to manage editable list of jids: - can be used to manage XEP-0004's jid-multi - can be used in the future for search result to display found entities (need a read-only style) - generaly usefull to manage list of entites - implemented in params too

author	Goffi <goffi@goffi.org>
date	Thu, 20 Aug 2015 18:33:52 +0200
parents	7ac073d2e7e0
children	a77217511afd

comparison

equal deleted inserted replaced

-:7ac073d2e7e0
+:48706f4ff19c
 log = getLogger(__name__)
 from xml.dom import minidom, NotFoundErr
 from wokkel import data_form
 from twisted.words.xish import domish
+from twisted.words.protocols.jabber import jid
 from sat.core import exceptions
 """This library help manage XML used in SàT (parameters, registration, etc)"""
 """Convert the XML for parameter to a SàT XML User Interface.
 @param xml (unicode)
 @return: XMLUI
 """
+# TODO: refactor params and use Twisted directly to parse XML
 params_doc = minidom.parseString(xml.encode('utf-8'))
 top = params_doc.documentElement
 if top.nodeName != 'params':
 raise exceptions.DataError(_('INTERNAL ERROR: parameters xml not valid'))
 value = param.getAttribute('value') or None
 callback_id = param.getAttribute('callback_id') or None
 if type_ == 'list':
-options, selected = _getParamListOptions(param)
+options, selected = _paramsGetListOptions(param)
 widget_kwargs['options'] = options
 widget_kwargs['selected'] = selected
+elif type_ == 'jids_list':
+widget_kwargs['jids'] = _paramsGetListJids(param)
 if type_ in ("button", "text"):
 param_ui.addEmpty()
 value = param_label
 else:
 param_ui.addWidget(type_, **widget_kwargs)
 return param_ui.toXml()
-def _getParamListOptions(param):
+def _paramsGetListOptions(param):
 """Retrieve the options for list element.
 The <option/> tags must be direct children of <param/>.
 @param param (domish.Element): element
 @return: a tuple (options, selected_value)
 return []
 options = [elem.getAttribute("value") for elem in elems]
 selected = [elem.getAttribute("value") for elem in elems if elem.getAttribute("selected") == 'true']
 return (options, selected)
+def _paramsGetListJids(param):
-## XMLUI Elements
+"""Retrive jids from a jids_list element.
+the <jid/> tags must be direct children of <param/>
+@param param (domish.Element): element
+@return: a list of jids
+"""
+elems = param.getElementsByTagName("jid")
+jids = [elem.firstChild.data for elem in elems
+if elem.firstChild is not None
+and elem.firstChild.nodeType == elem.TEXT_NODE]
+return jids
+### XMLUI Elements ###
 class Element(object):
 """ Base XMLUI element """
 type = None
 self.elem.setAttribute('label', label)
 if selected:
 self.elem.setAttribute('selected', 'true')
+class JidElement(Element):
+"""" Used by JidsListWidget to specify jids"""
+type = 'jid'
+def __init__(self, parent, jid_):
+"""
+@param jid_(jid.JID, unicode): jid to append
+"""
+assert isinstance(parent, JidsListWidget)
+super(JidElement, self).__init__(parent.xmlui, parent)
+if isinstance(jid_, jid.JID):
+value = jid.full
+elif isinstance(jid_, basestring):
+value = unicode(jid_)
+else:
+raise NotImplementedError
+jid_txt = self.xmlui.doc.createTextNode(value)
+self.elem.appendChild(jid_txt)
 class RowElement(Element):
 """" Used by AdvancedListContainer """
 type = 'row'
 def __init__(self, parent):
 self.elem.setAttribute('name', name)
 if label:
 self.elem.setAttribute('label', label)
 if description:
 self.elem.setAttribute('description', description)
+## Containers ##
 class Container(Element):
 """ And Element which contains other ones and has a layout """
 type = None
 raise exceptions.DataError(_("Incorrect number of items in list"))
 parent_container = self.getParentContainer()
 self.xmlui.changeContainer(parent_container)
+## Widgets ##
 class Widget(Element):
 type = None
 def __init__(self, xmlui, name=None, parent=None):
 """Create an element
 class ListWidget(InputWidget):
 type = 'list'
-def __init__(self, xmlui, options, selected=None, style=None, name=None, parent=None):
+def __init__(self, xmlui, options, selected=None, styles=None, name=None, parent=None):
 """
 @param xmlui
 @param options (list[option]): each option can be given as:
 - a single string if the label and the value are the same
 - a tuple with a couple of string (value,label) if the label and the value differ
 @param selected (list[string]): list of the selected values
-@param style (string)
+@param styles (iterable[string]): flags to set the behaviour of the list
 @param name (string)
 @param parent
 """
-if style is None:
+styles = set() if styles is None else set(styles)
-style = set()
+if styles is None:
-styles = set(style)
+styles = set()
+else:
+styles = set(styles)
 if not options:
 log.warning(_('empty "options" list'))
 if not styles.issubset(['multi']):
 raise exceptions.DataError(_("invalid styles"))
 super(ListWidget, self).__init__(xmlui, name, parent)
 selected = []
 for option in options:
 assert isinstance(option, basestring) or isinstance(option, tuple)
 value = option if isinstance(option, basestring) else option[0]
 OptionElement(self, option, value in selected)
+class JidsListWidget(InputWidget):
+"""A list of text or jids where elements can be added/removed or modified"""
+type = 'jids_list'
+def __init__(self, xmlui, jids, styles=None, name=None, parent=None):
+"""
+@param xmlui
+@param jids (list[jid.JID]): base jids
+@param styles (iterable[string]): flags to set the behaviour of the list
+@param name (string)
+@param parent
+"""
+super(JidsListWidget, self).__init__(xmlui, name, parent)
+styles = set() if styles is None else set(styles)
+if not styles.issubset([]): # TODO
+raise exceptions.DataError(_("invalid styles"))
+for style in styles:
+self.elem.setAttribute(style, 'yes')
+if not jids:
+log.debug('empty jids list')
+else:
+self.addJids(jids)
+def addJids(self, jids):
+for jid_ in jids:
+JidElement(self, jid_)
 ## Dialog Elements ##

Mercurial > libervia-backend

comparison src/tools/xml_tools.py @ 1476:48706f4ff19c