Mercurial > libervia-backend
view sat/tools/common/template_xmlui.py @ 2671:0fa217fafabf
tools (common/template), jp: refactoring to handle multiple sites:
- site can now be specified in template header before theme, for instance: (some_site/some_theme)path/to/template.ext
- absolute template paths are now implemented, but Renderer must be instanciated with trusted to True for security reason (it's the case for jp)
- a new "front_url_filter" callable can be given to Renderer, which will convert template path to URL seen by end-user (default to real path).
- the "front_url_filter" can be used in templates with… "front_url" filter
- template_data is a new named tuple available in templates, which give site, theme and template relative URL
- search order is site/theme, site/default_theme, and default/default_theme where default link to sat_pubsub templates
- when loading CSS files, files with _noscript suffixes are now loaded, and used when javascript is not available
- "styles_extra.css" is also loaded before "styles.css", useful when a theme want to reuse default style, and just override some rules
- new site can be specified in sat.conf [DEFAULT] section, using sites_path_public_dict or sites_path_private_dict (where sites_path_private_dict won't be used in public frontends, like Libervia)
- "private" argument of Renderer tells the renderer to load private sites or not
- templates are now loaded from "templates" subdirectory, to differenciate them from other data like i18n
- jp template output has been updated to handle those changes, and to manage absolute templates
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 10 Sep 2018 08:58:18 +0200 |
parents | bdb8276fd2da |
children | 003b8b4b56a7 |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # SAT: a jabber client # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. """ template XMLUI parsing XMLUI classes from this modules can then be iterated to create the template """ from sat.core.log import getLogger log = getLogger(__name__) from sat_frontends.tools import xmlui from functools import partial ## Widgets ## class Widget(object): category = u"widget" type = None enabled = True read_only = True def __init__(self, xmlui_parent): self.xmlui_parent = xmlui_parent @property def name(self): return self._xmlui_name class ValueWidget(Widget): def __init__(self, xmlui_parent, value): super(ValueWidget, self).__init__(xmlui_parent) self.value = value @property def values(self): return [self.value] @property def labels(self): # helper property, there is not label for ValueWidget # but using labels make rendering more easy (one single method to call) # values are actually returned return [self.value] class InputWidget(ValueWidget): def __init__(self, xmlui_parent, value, read_only=False): super(InputWidget, self).__init__(xmlui_parent, value) self.read_only = read_only class OptionsWidget(Widget): def __init__(self, xmlui_parent, options, selected, style): super(OptionsWidget, self).__init__(xmlui_parent) self.options = options self.selected = selected self.style = style @property def values(self): for value, label in self.items: yield value @property def labels(self): """return only labels from self.items""" for value, label in self.items: yield label @property def items(self): """return suitable items, according to style""" no_select = self.no_select for value, label in self.options: if no_select or value in self.selected: yield value, label @property def inline(self): return u"inline" in self.style @property def no_select(self): return u"noselect" in self.style class EmptyWidget(xmlui.EmptyWidget, Widget): def __init__(self, _xmlui_parent): Widget.__init__(self) class TextWidget(xmlui.TextWidget, ValueWidget): type = u"text" class LabelWidget(xmlui.LabelWidget, ValueWidget): type = u"label" @property def for_name(self): try: return self._xmlui_for_name except AttributeError: return None class StringWidget(xmlui.StringWidget, InputWidget): type = u"string" class JidInputWidget(xmlui.JidInputWidget, StringWidget): type = u"jid" class TextBoxWidget(xmlui.TextWidget, InputWidget): type = u"textbox" class ListWidget(xmlui.ListWidget, OptionsWidget): type = u"list" ## Containers ## class Container(object): category = u"container" type = None def __init__(self, xmlui_parent): self.xmlui_parent = xmlui_parent self.children = [] def __iter__(self): return iter(self.children) def _xmluiAppend(self, widget): self.children.append(widget) def _xmluiRemove(self, widget): self.children.remove(widget) class VerticalContainer(xmlui.VerticalContainer, Container): type = u"vertical" class PairsContainer(xmlui.PairsContainer, Container): type = u"pairs" class LabelContainer(xmlui.PairsContainer, Container): type = u"label" ## Factory ## class WidgetFactory(object): def __getattr__(self, attr): if attr.startswith("create"): cls = globals()[attr[6:]] return cls ## Core ## class XMLUIPanel(xmlui.XMLUIPanel): widget_factory = WidgetFactory() def show(self, *args, **kwargs): raise NotImplementedError class XMLUIDialog(xmlui.XMLUIDialog): dialog_factory = WidgetFactory() def __init__(*args, **kwargs): raise NotImplementedError create = partial(xmlui.create, class_map={ xmlui.CLASS_PANEL: XMLUIPanel, xmlui.CLASS_DIALOG: XMLUIDialog})