Mercurial > libervia-backend
annotate tools/xml_tools.py @ 217:b4dfe15c0b25
primitivus: misc comments
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Mon, 27 Dec 2010 17:23:36 +0100 |
| parents | e178e8f6d13a |
| children |
| 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 |
|
160
f494cba56a9e
xml tools: pairs layout is not used anymore if there is no label in dataForm2xml
Goffi <goffi@goffi.org>
parents:
146
diff
changeset
|
38 labels = filter(lambda field:field.label,form.fieldList) |
|
f494cba56a9e
xml tools: pairs layout is not used anymore if there is no label in dataForm2xml
Goffi <goffi@goffi.org>
parents:
146
diff
changeset
|
39 if labels: |
|
f494cba56a9e
xml tools: pairs layout is not used anymore if there is no label in dataForm2xml
Goffi <goffi@goffi.org>
parents:
146
diff
changeset
|
40 #if there is no label, we don't need to use pairs |
|
f494cba56a9e
xml tools: pairs layout is not used anymore if there is no label in dataForm2xml
Goffi <goffi@goffi.org>
parents:
146
diff
changeset
|
41 form_ui.changeLayout("pairs") |
| 103 | 42 |
| 102 | 43 for field in form.fieldList: |
| 44 if field.fieldType == 'fixed': | |
| 45 __field_type = 'text' | |
| 46 elif field.fieldType == 'text-single': | |
| 47 __field_type = "string" | |
| 48 elif field.fieldType == 'text-private': | |
| 49 __field_type = "password" | |
| 50 elif field.fieldType == 'list-single': | |
| 51 __field_type = "list" | |
| 52 else: | |
| 53 error (u"FIXME FIXME FIXME: Type [%s] is not managed yet by SàT" % field.fieldType) | |
| 54 __field_type = "string" | |
|
35
c45deebb40a5
Wix: Registration form management (not finished yet)
Goffi <goffi@goffi.org>
parents:
33
diff
changeset
|
55 |
|
160
f494cba56a9e
xml tools: pairs layout is not used anymore if there is no label in dataForm2xml
Goffi <goffi@goffi.org>
parents:
146
diff
changeset
|
56 if labels: |
|
f494cba56a9e
xml tools: pairs layout is not used anymore if there is no label in dataForm2xml
Goffi <goffi@goffi.org>
parents:
146
diff
changeset
|
57 if field.label: |
|
f494cba56a9e
xml tools: pairs layout is not used anymore if there is no label in dataForm2xml
Goffi <goffi@goffi.org>
parents:
146
diff
changeset
|
58 form_ui.addLabel(field.label) |
|
f494cba56a9e
xml tools: pairs layout is not used anymore if there is no label in dataForm2xml
Goffi <goffi@goffi.org>
parents:
146
diff
changeset
|
59 else: |
|
f494cba56a9e
xml tools: pairs layout is not used anymore if there is no label in dataForm2xml
Goffi <goffi@goffi.org>
parents:
146
diff
changeset
|
60 form_ui.addEmpty() |
| 103 | 61 |
|
146
7c00c4b0a5c2
xml_tools: removed unused content parameter in addElement
Goffi <goffi@goffi.org>
parents:
107
diff
changeset
|
62 elem = form_ui.addElement(__field_type, field.var, field.value, [option.value for option in field.options]) |
| 105 | 63 return form_ui.toXml() |
|
37
a61beb21d16d
Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents:
35
diff
changeset
|
64 |
| 102 | 65 def tupleList2dataForm(values): |
| 66 """convert a list of tuples (name,value) to a wokkel submit data form""" | |
| 67 form = data_form.Form('submit') | |
| 68 for value in values: | |
| 69 field = data_form.Field(var=value[0], value=value[1]) | |
| 70 form.addField(field) | |
|
37
a61beb21d16d
Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents:
35
diff
changeset
|
71 |
| 102 | 72 return form |
| 103 | 73 |
| 105 | 74 def paramsXml2xmlUI(xml): |
| 75 """Convert the xml for parameter to a SàT XML User Interface""" | |
| 214 | 76 params_doc = minidom.parseString(xml.encode('utf-8')) |
| 105 | 77 top = params_doc.documentElement |
| 78 if top.nodeName != 'params': | |
| 79 error(_('INTERNAL ERROR: parameters xml not valid')) | |
| 80 assert(False) | |
| 81 param_ui = XMLUI("param", "tabs") | |
| 82 for category in top.getElementsByTagName("category"): | |
| 83 name = category.getAttribute('name') | |
|
183
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
84 label = category.getAttribute('label') |
| 105 | 85 if not name: |
| 86 error(_('INTERNAL ERROR: params categories must have a name')) | |
| 87 assert(False) | |
|
183
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
88 param_ui.addCategory(name, 'pairs', label=label) |
| 105 | 89 for param in category.getElementsByTagName("param"): |
| 90 name = param.getAttribute('name') | |
|
183
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
91 label = param.getAttribute('label') |
| 105 | 92 if not name: |
| 93 error(_('INTERNAL ERROR: params must have a name')) | |
| 94 assert(False) | |
| 95 type = param.getAttribute('type') | |
| 96 value = param.getAttribute('value') or None | |
| 106 | 97 callback_id = param.getAttribute('callback_id') or None |
| 98 if type == "button": | |
| 99 param_ui.addEmpty() | |
| 100 else: | |
|
183
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
101 param_ui.addLabel(label or name) |
| 106 | 102 param_ui.addElement(name=name, type=type, value=value, callback_id=callback_id) |
| 105 | 103 |
| 104 return param_ui.toXml() | |
| 105 | |
| 106 | |
| 107 | |
| 108 | |
| 103 | 109 class XMLUI: |
| 110 """This class is used to create a user interface (form/window/parameters/etc) using SàT XML""" | |
| 111 | |
| 107 | 112 def __init__(self, panel_type, layout="vertical", title=None): |
| 103 | 113 """Init SàT XML Panel |
| 114 @param panel_type: one of | |
| 115 - window (new window) | |
| 116 - form (formulaire, depend of the frontend, usually a panel with cancel/submit buttons) | |
| 117 - param (parameters, presentatio depend of the frontend) | |
| 118 @param layout: disposition of elements, one of: | |
| 107 | 119 - vertical: elements are disposed up to bottom |
| 120 - horizontal: elements are disposed left to right | |
| 121 - pairs: elements come on two aligned columns | |
| 103 | 122 (usually one for a label, the next for the element) |
| 107 | 123 - tabs: elemens are in categories with tabs (notebook) |
| 124 @param title: title or default if None | |
| 103 | 125 """ |
| 126 if not panel_type in ['window', 'form', 'param']: | |
| 127 error(_("Unknown panel type [%s]") % panel_type) | |
| 128 assert(False) | |
| 129 self.type = panel_type | |
| 130 impl = minidom.getDOMImplementation() | |
| 131 | |
| 132 self.doc = impl.createDocument(None, "sat_xmlui", None) | |
| 133 top_element = self.doc.documentElement | |
| 134 top_element.setAttribute("type", panel_type) | |
| 107 | 135 if title: |
| 136 top_element.setAttribute("title", title) | |
| 104 | 137 self.parentTabsLayout = None #used only we have 'tabs' layout |
| 138 self.currentCategory = None #used only we have 'tabs' layout | |
| 139 self.changeLayout(layout) | |
| 103 | 140 |
| 141 def __del__(self): | |
| 142 self.doc.unlink() | |
|
37
a61beb21d16d
Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents:
35
diff
changeset
|
143 |
| 103 | 144 def __createLayout(self, layout, parent=None): |
| 145 """Create a layout element | |
| 146 @param type: layout type (cf init doc) | |
| 147 @parent: parent element or None | |
| 148 """ | |
| 104 | 149 if not layout in ['vertical', 'horizontal', 'pairs', 'tabs']: |
| 103 | 150 error (_("Unknown layout type [%s]") % layout) |
| 151 assert (False) | |
| 152 layout_elt = self.doc.createElement('layout') | |
| 153 layout_elt.setAttribute('type',layout) | |
| 154 if parent != None: | |
| 155 parent.appendChild(layout_elt) | |
| 156 return layout_elt | |
|
37
a61beb21d16d
Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents:
35
diff
changeset
|
157 |
| 103 | 158 def __createElem(self, type, name=None, parent = None): |
| 159 """Create an element | |
| 160 @param type: one of | |
| 161 - empty: empty element (usefull to skip something in a layout, e.g. skip first element in a PAIRS layout) | |
| 162 - text: text to be displayed in an multi-line area, e.g. instructions | |
| 163 @param name: name of the element or None | |
| 164 @param parent: parent element or None | |
| 165 """ | |
| 166 elem = self.doc.createElement('elem') | |
| 167 if name: | |
| 168 elem.setAttribute('name', name) | |
| 169 elem.setAttribute('type', type) | |
| 170 if parent != None: | |
| 171 parent.appendChild(elem) | |
| 172 return elem | |
| 173 | |
| 174 def changeLayout(self, layout): | |
| 175 """Change the current layout""" | |
| 104 | 176 self.currentLayout = self.__createLayout(layout, self.currentCategory if self.currentCategory else self.doc.documentElement) |
| 177 if layout == "tabs": | |
| 178 self.parentTabsLayout = self.currentLayout | |
| 103 | 179 |
| 180 | |
| 181 def addEmpty(self, name=None): | |
| 182 """Add a multi-lines text""" | |
| 183 elem = self.__createElem('empty', name, self.currentLayout) | |
| 184 | |
| 185 def addText(self, text, name=None): | |
| 186 """Add a multi-lines text""" | |
| 187 elem = self.__createElem('text', name, self.currentLayout) | |
| 188 text = self.doc.createTextNode(text) | |
| 189 elem.appendChild(text) | |
| 190 | |
| 191 def addLabel(self, text, name=None): | |
| 192 """Add a single line text, mainly useful as label before element""" | |
| 193 elem = self.__createElem('label', name, self.currentLayout) | |
| 194 elem.setAttribute('value', text) | |
| 195 | |
| 196 def addString(self, name=None, value=None): | |
| 197 """Add a string box""" | |
| 198 elem = self.__createElem('string', name, self.currentLayout) | |
| 199 if value: | |
| 200 elem.setAttribute('value', value) | |
| 201 | |
| 202 def addPassword(self, name=None, value=None): | |
| 203 """Add a password box""" | |
| 204 elem = self.__createElem('password', name, self.currentLayout) | |
| 205 if value: | |
| 206 elem.setAttribute('value', value) | |
| 207 | |
| 107 | 208 def addTextBox(self, name=None, value=None): |
| 209 """Add a string box""" | |
| 210 elem = self.__createElem('textbox', name, self.currentLayout) | |
| 211 if value: | |
| 212 elem.setAttribute('value', value) | |
| 213 | |
|
183
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
214 def addBool(self, name=None, value="true"): |
|
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
215 """Add a string box""" |
|
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
216 assert value in ["true","false"] |
|
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
217 elem = self.__createElem('bool', name, self.currentLayout) |
|
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
218 elem.setAttribute('value', value) |
|
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
219 |
| 107 | 220 def addList(self, options, name=None, value=None, style=set()): |
| 103 | 221 """Add a list of choices""" |
| 107 | 222 styles = set(style) |
| 103 | 223 assert (options) |
| 107 | 224 assert (styles.issubset(['multi'])) |
| 103 | 225 elem = self.__createElem('list', name, self.currentLayout) |
| 226 self.addOptions(options, elem) | |
| 227 if value: | |
| 228 elem.setAttribute('value', value) | |
| 107 | 229 for style in styles: |
| 230 elem.setAttribute(style, 'yes') | |
| 105 | 231 |
| 107 | 232 def addButton(self, callback_id, name, value, fields_back=[]): |
| 105 | 233 """Add a button |
| 234 @param callback: callback which will be called if button is pressed | |
| 106 | 235 @param name: name |
| 107 | 236 @param value: label of the button |
| 237 @fields_back: list of names of field to give back when pushing the button""" | |
| 105 | 238 elem = self.__createElem('button', name, self.currentLayout) |
| 106 | 239 elem.setAttribute('callback_id', callback_id) |
| 107 | 240 elem.setAttribute('value', value) |
| 241 for field in fields_back: | |
| 242 fback_el = self.doc.createElement('field_back') | |
| 243 fback_el.setAttribute('name', field) | |
| 244 elem.appendChild(fback_el) | |
| 245 | |
| 105 | 246 |
| 103 | 247 |
|
146
7c00c4b0a5c2
xml_tools: removed unused content parameter in addElement
Goffi <goffi@goffi.org>
parents:
107
diff
changeset
|
248 def addElement(self, type, name = None, value = None, options = None, callback_id = None): |
| 103 | 249 """Convenience method to add element, the params correspond to the ones in addSomething methods""" |
| 250 if type == 'empty': | |
| 251 self.addEmpty(name) | |
| 252 elif type == 'text': | |
|
146
7c00c4b0a5c2
xml_tools: removed unused content parameter in addElement
Goffi <goffi@goffi.org>
parents:
107
diff
changeset
|
253 assert(value!=None) |
|
7c00c4b0a5c2
xml_tools: removed unused content parameter in addElement
Goffi <goffi@goffi.org>
parents:
107
diff
changeset
|
254 self.addText(value, name) |
| 103 | 255 elif type == 'label': |
| 256 assert(value) | |
|
146
7c00c4b0a5c2
xml_tools: removed unused content parameter in addElement
Goffi <goffi@goffi.org>
parents:
107
diff
changeset
|
257 self.addLabel(value) |
| 103 | 258 elif type == 'string': |
| 259 self.addString(name, value) | |
| 260 elif type == 'password': | |
| 261 self.addPassword(name, value) | |
| 107 | 262 elif type == 'textbox': |
| 263 self.addTextBox(name, value) | |
|
183
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
264 elif type == 'bool': |
|
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
265 if not value: |
|
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
266 value = "true" |
|
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
267 self.addBool(name, value) |
| 103 | 268 elif type == 'list': |
| 269 self.addList(options, name, value) | |
| 105 | 270 elif type == 'button': |
| 106 | 271 assert(callback_id and value) |
| 272 self.addButton(callback_id, name, value) | |
| 103 | 273 |
| 274 def addOptions(self, options, parent): | |
| 275 """Add options to a multi-values element (e.g. list) | |
| 276 @param parent: multi-values element""" | |
| 277 for option in options: | |
| 278 opt = self.doc.createElement('option') | |
| 279 opt.setAttribute('value', option) | |
| 280 parent.appendChild(opt) | |
| 281 | |
|
183
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
282 def addCategory(self, name, layout, label=None): |
| 104 | 283 """Add a category to current layout (must be a tabs layout)""" |
| 284 assert(layout != 'tabs') | |
| 285 if not self.parentTabsLayout: | |
| 286 error(_("Trying to add a category without parent tabs layout")) | |
| 287 assert(False) | |
| 288 if self.parentTabsLayout.getAttribute('type') != 'tabs': | |
| 289 error(_("parent layout of a category is not tabs")) | |
| 290 assert(False) | |
|
183
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
291 |
|
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
292 if not label: |
|
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
293 label = name |
| 104 | 294 self.currentCategory = cat = self.doc.createElement('category') |
| 295 cat.setAttribute('name', name) | |
|
183
9ee4a1d0d7fb
Added auto(dis)connect params + misc
Goffi <goffi@goffi.org>
parents:
160
diff
changeset
|
296 cat.setAttribute('label', label) |
| 104 | 297 self.changeLayout(layout) |
| 298 self.parentTabsLayout.appendChild(cat) | |
| 299 | |
| 103 | 300 def toXml(self): |
| 301 """return the XML representation of the panel""" | |
| 302 return self.doc.toxml() |