Mercurial > libervia-backend
annotate tools/xml_tools.py @ 105:d2630fba8dfd
params to XMLUI tools
- xml_tools: new paramsXml2xmlUI method, for conversion from params xml to User Interface XML
- xml_tools: new addButton method
- bridge: new method getParamsUI
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Wed, 23 Jun 2010 17:26:21 +0800 |
| parents | 5458ac1380cc |
| children | 138d82f64b6f |
| rev | line source |
|---|---|
|
33
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
1 #!/usr/bin/python |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
2 # -*- coding: utf-8 -*- |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 """ |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
5 SAT: a jabber client |
| 57 | 6 Copyright (C) 2009, 2010 Jérôme Poisson (goffi@goffi.org) |
|
33
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 This program is free software: you can redistribute it and/or modify |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 it under the terms of the GNU General Public License as published by |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 the Free Software Foundation, either version 3 of the License, or |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 (at your option) any later version. |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 This program is distributed in the hope that it will be useful, |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 GNU General Public License for more details. |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
17 |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
18 You should have received a copy of the GNU General Public License |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
20 """ |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
21 |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
22 from logging import debug, info, error |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
23 from xml.dom import minidom |
|
37
a61beb21d16d
Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents:
35
diff
changeset
|
24 from wokkel import data_form |
|
33
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
25 import pdb |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
26 |
| 102 | 27 """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
|
28 |
|
b9bb5d8e0cc7
In-band-registration: data form 2 xml conversion
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
29 |
| 102 | 30 def dataForm2xml(form): |
| 31 """Take a data form (xep-0004, Wokkel's implementation) and convert it to a SàT xml""" | |
| 32 | |
| 105 | 33 form_ui = XMLUI("form", "vertical") |
| 104 | 34 |
| 102 | 35 if form.instructions: |
| 105 | 36 form_ui.addText('\n'.join(form.instructions), 'instructions') |
| 103 | 37 |
| 105 | 38 form_ui.changeLayout("pairs") |
| 103 | 39 |
| 102 | 40 for field in form.fieldList: |
| 41 if field.fieldType == 'fixed': | |
| 42 __field_type = 'text' | |
| 43 elif field.fieldType == 'text-single': | |
| 44 __field_type = "string" | |
| 45 elif field.fieldType == 'text-private': | |
| 46 __field_type = "password" | |
| 47 elif field.fieldType == 'list-single': | |
| 48 __field_type = "list" | |
| 49 else: | |
| 50 error (u"FIXME FIXME FIXME: Type [%s] is not managed yet by SàT" % field.fieldType) | |
| 51 __field_type = "string" | |
|
35
c45deebb40a5
Wix: Registration form management (not finished yet)
Goffi <goffi@goffi.org>
parents:
33
diff
changeset
|
52 |
| 103 | 53 if field.label: |
| 105 | 54 form_ui.addLabel(field.label) |
| 103 | 55 else: |
| 105 | 56 form_ui.addEmpty() |
| 103 | 57 |
| 105 | 58 elem = form_ui.addElement(__field_type, field.var, None, field.value, [option.value for option in field.options]) |
| 59 return form_ui.toXml() | |
|
37
a61beb21d16d
Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents:
35
diff
changeset
|
60 |
| 102 | 61 def tupleList2dataForm(values): |
| 62 """convert a list of tuples (name,value) to a wokkel submit data form""" | |
| 63 form = data_form.Form('submit') | |
| 64 for value in values: | |
| 65 field = data_form.Field(var=value[0], value=value[1]) | |
| 66 form.addField(field) | |
|
37
a61beb21d16d
Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents:
35
diff
changeset
|
67 |
| 102 | 68 return form |
| 103 | 69 |
| 105 | 70 def paramsXml2xmlUI(xml): |
| 71 """Convert the xml for parameter to a SàT XML User Interface""" | |
| 72 params_doc = minidom.parseString(xml) | |
| 73 top = params_doc.documentElement | |
| 74 if top.nodeName != 'params': | |
| 75 error(_('INTERNAL ERROR: parameters xml not valid')) | |
| 76 assert(False) | |
| 77 param_ui = XMLUI("param", "tabs") | |
| 78 for category in top.getElementsByTagName("category"): | |
| 79 name = category.getAttribute('name') | |
| 80 if not name: | |
| 81 error(_('INTERNAL ERROR: params categories must have a name')) | |
| 82 assert(False) | |
| 83 param_ui.addCategory(name, 'pairs') | |
| 84 for param in category.getElementsByTagName("param"): | |
| 85 name = param.getAttribute('name') | |
| 86 if not name: | |
| 87 error(_('INTERNAL ERROR: params must have a name')) | |
| 88 assert(False) | |
| 89 type = param.getAttribute('type') | |
| 90 value = param.getAttribute('value') or None | |
| 91 callback = param.getAttribute('callback') or None | |
| 92 param_ui.addLabel(name) | |
| 93 param_ui.addElement(name=name, type=type, value=value, callback=callback) | |
| 94 | |
| 95 return param_ui.toXml() | |
| 96 | |
| 97 | |
| 98 | |
| 99 | |
| 103 | 100 class XMLUI: |
| 101 """This class is used to create a user interface (form/window/parameters/etc) using SàT XML""" | |
| 102 | |
| 103 def __init__(self, panel_type, layout="vertical"): | |
| 104 """Init SàT XML Panel | |
| 105 @param panel_type: one of | |
| 106 - window (new window) | |
| 107 - form (formulaire, depend of the frontend, usually a panel with cancel/submit buttons) | |
| 108 - param (parameters, presentatio depend of the frontend) | |
| 109 @param layout: disposition of elements, one of: | |
| 110 - VERTICAL: elements are disposed up to bottom | |
| 111 - HORIZONTAL: elements are disposed left to right | |
| 112 - PAIRS: elements come on two aligned columns | |
| 113 (usually one for a label, the next for the element) | |
| 114 """ | |
| 115 if not panel_type in ['window', 'form', 'param']: | |
| 116 error(_("Unknown panel type [%s]") % panel_type) | |
| 117 assert(False) | |
| 118 self.type = panel_type | |
| 119 impl = minidom.getDOMImplementation() | |
| 120 | |
| 121 self.doc = impl.createDocument(None, "sat_xmlui", None) | |
| 122 top_element = self.doc.documentElement | |
| 123 top_element.setAttribute("type", panel_type) | |
| 104 | 124 self.parentTabsLayout = None #used only we have 'tabs' layout |
| 125 self.currentCategory = None #used only we have 'tabs' layout | |
| 126 self.changeLayout(layout) | |
| 103 | 127 |
| 128 def __del__(self): | |
| 129 self.doc.unlink() | |
|
37
a61beb21d16d
Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents:
35
diff
changeset
|
130 |
| 103 | 131 def __createLayout(self, layout, parent=None): |
| 132 """Create a layout element | |
| 133 @param type: layout type (cf init doc) | |
| 134 @parent: parent element or None | |
| 135 """ | |
| 104 | 136 if not layout in ['vertical', 'horizontal', 'pairs', 'tabs']: |
| 103 | 137 error (_("Unknown layout type [%s]") % layout) |
| 138 assert (False) | |
| 139 layout_elt = self.doc.createElement('layout') | |
| 140 layout_elt.setAttribute('type',layout) | |
| 141 if parent != None: | |
| 142 parent.appendChild(layout_elt) | |
| 143 return layout_elt | |
|
37
a61beb21d16d
Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents:
35
diff
changeset
|
144 |
| 103 | 145 def __createElem(self, type, name=None, parent = None): |
| 146 """Create an element | |
| 147 @param type: one of | |
| 148 - empty: empty element (usefull to skip something in a layout, e.g. skip first element in a PAIRS layout) | |
| 149 - text: text to be displayed in an multi-line area, e.g. instructions | |
| 150 @param name: name of the element or None | |
| 151 @param parent: parent element or None | |
| 152 """ | |
| 153 elem = self.doc.createElement('elem') | |
| 154 if name: | |
| 155 elem.setAttribute('name', name) | |
| 156 elem.setAttribute('type', type) | |
| 157 if parent != None: | |
| 158 parent.appendChild(elem) | |
| 159 return elem | |
| 160 | |
| 161 def changeLayout(self, layout): | |
| 162 """Change the current layout""" | |
| 104 | 163 self.currentLayout = self.__createLayout(layout, self.currentCategory if self.currentCategory else self.doc.documentElement) |
| 164 if layout == "tabs": | |
| 165 self.parentTabsLayout = self.currentLayout | |
| 103 | 166 |
| 167 | |
| 168 def addEmpty(self, name=None): | |
| 169 """Add a multi-lines text""" | |
| 170 elem = self.__createElem('empty', name, self.currentLayout) | |
| 171 | |
| 172 def addText(self, text, name=None): | |
| 173 """Add a multi-lines text""" | |
| 174 elem = self.__createElem('text', name, self.currentLayout) | |
| 175 text = self.doc.createTextNode(text) | |
| 176 elem.appendChild(text) | |
| 177 | |
| 178 def addLabel(self, text, name=None): | |
| 179 """Add a single line text, mainly useful as label before element""" | |
| 180 elem = self.__createElem('label', name, self.currentLayout) | |
| 181 elem.setAttribute('value', text) | |
| 182 | |
| 183 def addString(self, name=None, value=None): | |
| 184 """Add a string box""" | |
| 185 elem = self.__createElem('string', name, self.currentLayout) | |
| 186 if value: | |
| 187 elem.setAttribute('value', value) | |
| 188 | |
| 189 def addPassword(self, name=None, value=None): | |
| 190 """Add a password box""" | |
| 191 elem = self.__createElem('password', name, self.currentLayout) | |
| 192 if value: | |
| 193 elem.setAttribute('value', value) | |
| 194 | |
| 195 def addList(self, options, name=None, value=None): | |
| 196 """Add a list of choices""" | |
| 197 assert (options) | |
| 198 elem = self.__createElem('list', name, self.currentLayout) | |
| 199 self.addOptions(options, elem) | |
| 200 if value: | |
| 201 elem.setAttribute('value', value) | |
| 105 | 202 |
| 203 def addButton(self, callback, name): | |
| 204 """Add a button | |
| 205 @param callback: callback which will be called if button is pressed | |
| 206 @param name: name shown on the button""" | |
| 207 elem = self.__createElem('button', name, self.currentLayout) | |
| 208 elem.setAttribute('callback', callback) | |
| 209 | |
| 103 | 210 |
| 105 | 211 def addElement(self, type, name = None, content = None, value = None, options = None, callback = None): |
| 103 | 212 """Convenience method to add element, the params correspond to the ones in addSomething methods""" |
| 213 if type == 'empty': | |
| 214 self.addEmpty(name) | |
| 215 elif type == 'text': | |
| 216 assert(content) | |
| 217 self.addText(content, name) | |
| 218 elif type == 'label': | |
| 219 assert(value) | |
| 220 elif type == 'string': | |
| 221 self.addString(name, value) | |
| 222 elif type == 'password': | |
| 223 self.addPassword(name, value) | |
| 224 elif type == 'list': | |
| 225 self.addList(options, name, value) | |
| 105 | 226 elif type == 'button': |
| 227 assert(callback and name) | |
| 228 self.addButton(callback, name) | |
| 103 | 229 |
| 230 def addOptions(self, options, parent): | |
| 231 """Add options to a multi-values element (e.g. list) | |
| 232 @param parent: multi-values element""" | |
| 233 for option in options: | |
| 234 opt = self.doc.createElement('option') | |
| 235 opt.setAttribute('value', option) | |
| 236 parent.appendChild(opt) | |
| 237 | |
| 104 | 238 def addCategory(self, name, layout): |
| 239 """Add a category to current layout (must be a tabs layout)""" | |
| 240 assert(layout != 'tabs') | |
| 241 if not self.parentTabsLayout: | |
| 242 error(_("Trying to add a category without parent tabs layout")) | |
| 243 assert(False) | |
| 244 if self.parentTabsLayout.getAttribute('type') != 'tabs': | |
| 245 error(_("parent layout of a category is not tabs")) | |
| 246 assert(False) | |
| 247 self.currentCategory = cat = self.doc.createElement('category') | |
| 248 cat.setAttribute('name', name) | |
| 249 self.changeLayout(layout) | |
| 250 self.parentTabsLayout.appendChild(cat) | |
| 251 | |
| 103 | 252 def toXml(self): |
| 253 """return the XML representation of the panel""" | |
| 254 return self.doc.toxml() |