libervia-backend: sat/tools/common/template.py annotate

annotate sat/tools/common/template.py @ 2631:a381186e2398

doc (CHANGELOG): added D-Bus namespace change

author	Goffi <goffi@goffi.org>
date	Mon, 02 Jul 2018 08:53:29 +0200
parents	56f94936df1e
children	0fa217fafabf

rev	line source
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/env python2
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	3
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	4 # SAT: a jabber client
2483 0046283a285d dates update Goffi <goffi@goffi.org> parents: 2466 diff changeset	5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org)
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	6
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	10 # (at your option) any later version.
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	11
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	16
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	19
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	20 """ template generation """
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	21
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	22 from sat.core.constants import Const as C
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	23 from sat.core.i18n import _
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	24 from sat.core import exceptions
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	25 from sat.tools.common import date_utils
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	26 from sat.core.log import getLogger
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	27
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	28 log = getLogger(__name__)
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	29 import os.path
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	30 from xml.sax.saxutils import quoteattr
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	31 import time
2401 221478058d8a template: improved attribute escaping, and added it to filters under the name "attr_escape" Goffi <goffi@goffi.org> parents: 2394 diff changeset	32 import re
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	33 from babel import support
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	34 from babel import Locale
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	35 from babel.core import UnknownLocaleError
2454 06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	36 import pygments
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	37 from pygments import lexers
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	38 from pygments import formatters
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	39
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	40 try:
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	41 import sat_templates
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	42 except ImportError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	43 raise exceptions.MissingModule(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	44 u"sat_templates module is not available, please install it or check your path to use template engine"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	45 )
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	46 else:
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	47 sat_templates # to avoid pyflakes warning
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	48
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	49 try:
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	50 import jinja2
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	51 except:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	52 raise exceptions.MissingModule(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	53 u"Missing module jinja2, please install it from http://jinja.pocoo.org or with pip install jinja2"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	54 )
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	55
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	56 from jinja2 import Markup as safe
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	57 from jinja2 import is_undefined
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	58 from lxml import etree
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	59
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	60 HTML_EXT = ("html", "xhtml")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	61 RE_ATTR_ESCAPE = re.compile(r"[^a-z_-]")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	62 # TODO: handle external path (an additional search path for templates should be settable by user
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	63 # TODO: handle absolute URL (should be used for trusted use cases) only (e.g. jp) for security reason
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	64
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	65
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	66 class TemplateLoader(jinja2.FileSystemLoader):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	67 def __init__(self):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	68 searchpath = os.path.dirname(sat_templates.__file__)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	69 super(TemplateLoader, self).__init__(searchpath, followlinks=True)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	70
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	71 def parse_template(self, template):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	72 """parse template path and return theme and relative URL
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	73
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	74 @param template_path(unicode): path to template with parenthesis syntax
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	75 @return (tuple[(unicode,None),unicode]): theme and template_path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	76 theme can be None if relative path is used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	77 relative path is the path from search path with theme specified
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	78 e.g. default/blog/articles.html
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	79 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	80 if template.startswith(u"("):
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	81 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	82 theme_end = template.index(u")")
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	83 except IndexError:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	84 raise ValueError(u"incorrect theme in template")
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	85 theme = template[1:theme_end]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	86 template = template[theme_end + 1 :]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	87 if not template or template.startswith(u"/"):
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	88 raise ValueError(u"incorrect path after template name")
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	89 template = os.path.join(theme, template)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	90 elif template.startswith(u"/"):
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	91 # absolute path means no template
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	92 theme = None
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	93 raise NotImplementedError(u"absolute path is not implemented yet")
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	94 else:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	95 theme = C.TEMPLATE_THEME_DEFAULT
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	96 template = os.path.join(theme, template)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	97 return theme, template
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	98
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	99 def get_default_template(self, theme, template_path):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	100 """return default template path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	101
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	102 @param theme(unicode): theme used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	103 @param template_path(unicode): path to the not found template
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	104 @return (unicode, None): default path or None if there is not
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	105 """
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	106 ext = os.path.splitext(template_path)[1][1:]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	107 path_elems = template_path.split(u"/")
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	108 if ext in HTML_EXT:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	109 if path_elems[1] == u"error":
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	110 # if an inexisting error page is requested, we return base page
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	111 default_path = os.path.join(theme, u"error/base.html")
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	112 return default_path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	113 if theme != C.TEMPLATE_THEME_DEFAULT:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	114 # if template doesn't exists for this theme, we try with default
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	115 return os.path.join(C.TEMPLATE_THEME_DEFAULT, path_elems[1:])
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	116
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	117 def get_source(self, environment, template):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	118 """relative path to template dir, with special theme handling
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	119
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	120 if the path is just relative, "default" theme is used.
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	121 The theme can be specified in parenthesis just before the path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	122 e.g.: (some_theme)path/to/template.html
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	123 """
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	124 theme, template_path = self.parse_template(template)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	125 try:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	126 return super(TemplateLoader, self).get_source(environment, template_path)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	127 except jinja2.exceptions.TemplateNotFound as e:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	128 # in some special cases, a defaut template is returned if nothing is found
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	129 if theme is not None:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	130 default_path = self.get_default_template(theme, template_path)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	131 if default_path is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	132 return super(TemplateLoader, self).get_source(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	133 environment, default_path
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	134 )
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	135 # if no default template is found, we re-raise the error
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	136 raise e
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	137
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	138
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	139 class Indexer(object):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	140 """Index global to a page"""
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	141
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	142 def __init__(self):
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	143 self._indexes = {}
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	144
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	145 def next(self, value):
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	146 if value not in self._indexes:
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	147 self._indexes[value] = 0
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	148 return 0
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	149 self._indexes[value] += 1
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	150 return self._indexes[value]
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	151
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	152 def current(self, value):
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	153 return self._indexes.get(value)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	154
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	155
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	156 class ScriptsHandler(object):
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	157 def __init__(self, renderer, template_path, template_root_dir, root_path):
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	158 self.renderer = renderer
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	159 self.template_root_dir = template_root_dir
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	160 self.root_path = root_path
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	161 self.scripts = [] # we don't use a set because order may be important
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	162 dummy, self.theme, self.is_default_theme = renderer.getThemeData(template_path)
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	163
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	164 def include(self, library_name, attribute="defer"):
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	165 """Mark that a script need to be imported.
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	166
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	167 Must be used before base.html is extended, as <script> are generated there.
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	168 If called several time with the same library, it will be imported once.
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	169 @param library_name(unicode): name of the library to import
2465 bb0bbcc80fc8 template: boolean attribute can now be specified when importing a script, and default to "defer" Goffi <goffi@goffi.org> parents: 2454 diff changeset	170 @param loading:
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	171 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	172 if attribute not in ("defer", "async", ""):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	173 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	174 _(u'Invalid attribute, please use one of "defer", "async" or ""')
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	175 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	176 if library_name.endswith(".js"):
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	177 library_name = library_name[:-3]
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	178 if library_name not in self.scripts:
2465 bb0bbcc80fc8 template: boolean attribute can now be specified when importing a script, and default to "defer" Goffi <goffi@goffi.org> parents: 2454 diff changeset	179 self.scripts.append((library_name, attribute))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	180 return u""
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	181
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	182 def generate_scripts(self):
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	183 """Generate the <script> elements
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	184
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	185 @return (unicode): <scripts> HTML tags
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	186 """
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	187 scripts = []
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	188 tpl = u"<script src={src} {attribute}></script>"
2465 bb0bbcc80fc8 template: boolean attribute can now be specified when importing a script, and default to "defer" Goffi <goffi@goffi.org> parents: 2454 diff changeset	189 for library, attribute in self.scripts:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	190 path = self.renderer.getStaticPath(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	191 library, self.template_root_dir, self.theme, self.is_default_theme, ".js"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	192 )
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	193 if path is None:
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	194 log.warning(_(u"Can't find {}.js javascript library").format(library))
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	195 continue
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	196 path = os.path.join(self.root_path, path)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	197 scripts.append(tpl.format(src=quoteattr(path), attribute=attribute))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	198 return safe(u"\n".join(scripts))
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	199
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	200
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	201 class Renderer(object):
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	202 def __init__(self, host):
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	203 self.host = host
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	204 self.base_dir = os.path.dirname(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	205 sat_templates.__file__
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	206 ) # FIXME: should be modified if we handle use extra dirs
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	207 self.env = jinja2.Environment(
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	208 loader=TemplateLoader(),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	209 autoescape=jinja2.select_autoescape(["html", "xhtml", "xml"]),
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	210 trim_blocks=True,
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	211 lstrip_blocks=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	212 extensions=["jinja2.ext.i18n"],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	213 )
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	214 self._locale_str = C.DEFAULT_LOCALE
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	215 self._locale = Locale.parse(self._locale_str)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	216 self.installTranslations()
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	217 # we want to have access to SàT constants in templates
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	218 self.env.globals[u"C"] = C
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	219 # custom filters
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	220 self.env.filters["next_gidx"] = self._next_gidx
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	221 self.env.filters["cur_gidx"] = self._cur_gidx
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	222 self.env.filters["date_fmt"] = self._date_fmt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	223 self.env.filters["xmlui_class"] = self._xmlui_class
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	224 self.env.filters["attr_escape"] = self.attr_escape
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	225 self.env.filters["item_filter"] = self._item_filter
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	226 self.env.filters["adv_format"] = self._adv_format
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	227 self.env.filters["dict_ext"] = self._dict_ext
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	228 self.env.filters["highlight"] = self.highlight
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	229 # custom tests
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	230 self.env.tests["in_the_past"] = self._in_the_past
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	231 self.icons_path = os.path.join(host.media_dir, u"fonts/fontello/svg")
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	232
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	233 def installTranslations(self):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	234 i18n_dir = os.path.join(self.base_dir, "i18n")
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	235 self.translations = {}
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	236 for lang_dir in os.listdir(i18n_dir):
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	237 lang_path = os.path.join(i18n_dir, lang_dir)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	238 if not os.path.isdir(lang_path):
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	239 continue
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	240 po_path = os.path.join(lang_path, "LC_MESSAGES/sat.mo")
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	241 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	242 with open(po_path, "rb") as f:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	243 self.translations[Locale.parse(lang_dir)] = support.Translations(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	244 f, "sat"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	245 )
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	246 except EnvironmentError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	247 log.error(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	248 _(u"Can't find template translation at {path}").format(path=po_path)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	249 )
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	250 except UnknownLocaleError as e:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	251 log.error(_(u"Invalid locale name: {msg}").format(msg=e))
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	252 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	253 log.info(_(u"loaded {lang} templates translations").format(lang=lang_dir))
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	254 self.env.install_null_translations(True)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	255
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	256 def setLocale(self, locale_str):
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	257 """set current locale
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	258
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	259 change current translation locale and self self._locale and self._locale_str
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	260 """
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	261 if locale_str == self._locale_str:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	262 return
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	263 if locale_str == "en":
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	264 # we default to GB English when it's not specified
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	265 # one of the main reason is to avoid the nonsense U.S. short date format
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	266 locale_str = "en_GB"
2323 2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	267 try:
2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	268 locale = Locale.parse(locale_str)
2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	269 except ValueError as e:
2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	270 log.warning(_(u"invalid locale value: {msg}").format(msg=e))
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	271 locale_str = self._locale_str = C.DEFAULT_LOCALE
2323 2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	272 locale = Locale.parse(locale_str)
2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	273
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	274 locale_str = unicode(locale)
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	275 if locale_str != C.DEFAULT_LOCALE:
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	276 try:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	277 translations = self.translations[locale]
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	278 except KeyError:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	279 log.warning(_(u"Can't find locale {locale}".format(locale=locale)))
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	280 locale_str = C.DEFAULT_LOCALE
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	281 locale = Locale.parse(self._locale_str)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	282 else:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	283 self.env.install_gettext_translations(translations, True)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	284 log.debug(_(u"Switched to {lang}").format(lang=locale.english_name))
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	285
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	286 if locale_str == C.DEFAULT_LOCALE:
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	287 self.env.install_null_translations(True)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	288
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	289 self._locale = locale
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	290 self._locale_str = locale_str
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	291
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	292 def getThemeAndRoot(self, template):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	293 """retrieve theme and root dir of a given tempalte
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	294
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	295 @param template(unicode): template to parse
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	296 @return (tuple[unicode, unicode]): theme and absolute path to theme's root dir
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	297 """
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	298 theme, dummy = self.env.loader.parse_template(template)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	299 return theme, os.path.join(self.base_dir, theme)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	300
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	301 def getStaticPath(self, name, template_root_dir, theme, is_default, ext=".css"):
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	302 """retrieve path of a static file if it exists with current theme or default
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	303
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	304 File will be looked at [theme]/static/[name][ext], and then default
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	305 if not found.
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	306 @param name(unicode): name of the file to look for
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	307 @param template_root_dir(unicode): absolute path to template root used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	308 @param theme(unicode): name of the template theme used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	309 @param is_default(bool): True if theme is the default theme
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	310 @return (unicode, None): relative path if found, else None
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	311 """
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	312 file_ = None
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	313 path = os.path.join(theme, C.TEMPLATE_STATIC_DIR, name + ext)
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	314 if os.path.exists(os.path.join(template_root_dir, path)):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	315 file_ = path
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	316 elif not is_default:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	317 path = os.path.join(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	318 C.TEMPLATE_THEME_DEFAULT, C.TEMPLATE_STATIC_DIR, name + ext
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	319 )
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	320 if os.path.exists(os.path.join(template_root_dir, path)):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	321 file_.append(path)
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	322 return file_
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	323
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	324 def getThemeData(self, template_path):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	325 """return template data got from template_path
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	326
2452 7aa863cbc47f template: remove extension from elements while looking for a path: Goffi <goffi@goffi.org> parents: 2425 diff changeset	327 @return tuple(unicode, unicode, bool):
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	328 path_elems: elements of the path
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	329 theme: theme of the page
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	330 is_default: True if the theme is the default theme
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	331 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	332 path_elems = [os.path.splitext(p)[0] for p in template_path.split(u"/")]
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	333 theme = path_elems.pop(0)
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	334 is_default = theme == C.TEMPLATE_THEME_DEFAULT
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	335 return (path_elems, theme, is_default)
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	336
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	337 def getCSSFiles(self, template_path, template_root_dir):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	338 """retrieve CSS files to use according to theme and template path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	339
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	340 for each element of the path, a .css file is looked for in /static, and returned if it exists.
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	341 previous element are kept by replacing '/' with '_', and styles.css is always returned.
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	342 For instance, if template_path is some_theme/blog/articles.html:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	343 some_theme/static/styles.css is returned if it exists else default/static/styles.css
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	344 some_theme/static/blog.css is returned if it exists else default/static/blog.css (if it exists too)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	345 some_theme/static/blog_articles.css is returned if it exists else default/static/blog_articles.css (if it exists too)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	346 @param template_path(unicode): relative path to template file (e.g. some_theme/blog/articles.html)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	347 @param template_root_dir(unicode): absolute path of the theme root dir used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	348 @return list[unicode]: relative path to CSS files to use
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	349 """
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	350 # TODO: some caching would be nice
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	351 css_files = []
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	352 path_elems, theme, is_default = self.getThemeData(template_path)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	353 for css in (u"fonts", u"styles"):
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	354 css_path = self.getStaticPath(css, template_root_dir, theme, is_default)
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	355 if css_path is not None:
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	356 css_files.append(css_path)
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	357
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	358 for idx, path in enumerate(path_elems):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	359 css_path = self.getStaticPath(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	360 u"_".join(path_elems[: idx + 1]), template_root_dir, theme, is_default
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	361 )
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	362 if css_path is not None:
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	363 css_files.append(css_path)
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	364
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	365 return css_files
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	366
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	367 ## custom filters ##
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	368
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	369 @jinja2.contextfilter
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	370 def _next_gidx(self, ctx, value):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	371 """Use next current global index as suffix"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	372 next_ = ctx["gidx"].next(value)
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	373 return value if next_ == 0 else u"{}_{}".format(value, next_)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	374
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	375 @jinja2.contextfilter
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	376 def _cur_gidx(self, ctx, value):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	377 """Use current current global index as suffix"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	378 current = ctx["gidx"].current(value)
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	379 return value if not current else u"{}_{}".format(value, current)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	380
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	381 def _date_fmt(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	382 self, timestamp, fmt="short", date_only=False, auto_limit=None, auto_old_fmt=None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	383 ):
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	384 if is_undefined(fmt):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	385 fmt = u"short"
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	386
2453 84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	387 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	388 return date_utils.date_fmt(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	389 timestamp, fmt, date_only, auto_limit, auto_old_fmt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	390 )
2453 84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	391 except Exception as e:
84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	392 log.warning(_(u"Can't parse date: {msg}").format(msg=e))
84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	393 return timestamp
84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	394
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	395 def attr_escape(self, text):
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	396 """escape a text to a value usable as an attribute
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	397
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	398 remove spaces, and put in lower case
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	399 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	400 return RE_ATTR_ESCAPE.sub(u"_", text.strip().lower())[:50]
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	401
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	402 def _xmlui_class(self, xmlui_item, fields):
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	403 """return classes computed from XMLUI fields name
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	404
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	405 will return a string with a series of escaped {name}_{value} separated by spaces.
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	406 @param xmlui_item(xmlui.XMLUIPanel): XMLUI containing the widgets to use
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	407 @param fields(iterable(unicode)): names of the widgets to use
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	408 @return (unicode, None): computer string to use as class attribute value
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	409 None if no field was specified
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	410 """
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	411 classes = []
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	412 for name in fields:
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	413 escaped_name = self.attr_escape(name)
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	414 try:
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	415 for value in xmlui_item.widgets[name].values:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	416 classes.append(escaped_name + "_" + self.attr_escape(value))
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	417 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	418 log.debug(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	419 _(u'ignoring field "{name}": it doesn\'t exists').format(name=name)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	420 )
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	421 continue
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	422 return u" ".join(classes) or None
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	423
2422 5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	424 @jinja2.contextfilter
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	425 def _item_filter(self, ctx, item, filters):
2402 f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	426 """return item's value, filtered if suitable
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	427
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	428 @param item(object): item to filter
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	429 value must have name and value attributes,
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	430 mostly used for XMLUI items
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	431 @param filters(dict[unicode, (callable, dict, None)]): map of name => filter
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	432 if filter is None, return the value unchanged
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	433 if filter is a callable, apply it
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	434 if filter is a dict, it can have following keys:
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	435 - filters: iterable of filters to apply
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	436 - filters_args: kwargs of filters in the same order as filters (use empty dict if needed)
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	437 - template: template to format where {value} is the filtered value
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	438 """
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	439 value = item.value
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	440 filter_ = filters.get(item.name, None)
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	441 if filter_ is None:
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	442 return value
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	443 elif isinstance(filter_, dict):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	444 filters_args = filter_.get(u"filters_args")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	445 for idx, f_name in enumerate(filter_.get(u"filters", [])):
2422 5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	446 kwargs = filters_args[idx] if filters_args is not None else {}
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	447 filter_func = self.env.filters[f_name]
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	448 try:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	449 eval_context_filter = filter_func.evalcontextfilter
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	450 except AttributeError:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	451 eval_context_filter = False
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	452
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	453 if eval_context_filter:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	454 value = filter_func(ctx.eval_ctx, value, **kwargs)
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	455 else:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	456 value = filter_func(value, **kwargs)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	457 template = filter_.get(u"template")
2422 5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	458 if template:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	459 # format will return a string, so we need to check first
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	460 # if the value is safe or not, and re-mark it after formatting
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	461 is_safe = isinstance(value, safe)
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	462 value = template.format(value=value)
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	463 if is_safe:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	464 value = safe(value)
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	465 return value
2402 f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	466
2391 07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	467 def _adv_format(self, value, template, **kwargs):
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	468 """Advancer formatter
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	469
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	470 like format() method, but take care or special values like None
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	471 @param value(unicode): value to format
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	472 @param template(None, unicode): template to use with format() method.
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	473 It will be formatted using value=value and **kwargs
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	474 None to return value unchanged
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	475 @return (unicode): formatted value
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	476 """
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	477 if template is None:
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	478 return value
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	479 # jinja use string when no special char is used, so we have to convert to unicode
2391 07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	480 return unicode(template).format(value=value, **kwargs)
07e1543d6992 template: new "adv_format" filter which use Python's format and return whole value if template is None Goffi <goffi@goffi.org> parents: 2385 diff changeset	481
2425 d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	482 def _dict_ext(self, source_dict, extra_dict, key=None):
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	483 """extend source_dict with extra dict and return the result
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	484
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	485 @param source_dict(dict): dictionary to extend
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	486 @param extra_dict(dict, None): dictionary to use to extend first one
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	487 None to return source_dict unmodified
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	488 @param key(unicode, None): if specified extra_dict[key] will be used
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	489 if it doesn't exists, a copy of unmodified source_dict is returned
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	490 @return (dict): resulting dictionary
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	491 """
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	492 if extra_dict is None:
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	493 return source_dict
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	494 if key is not None:
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	495 extra_dict = extra_dict.get(key, {})
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	496 ret = source_dict.copy()
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	497 ret.update(extra_dict)
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	498 return ret
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	499
2454 06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	500 def highlight(self, code, lexer_name=None, lexer_opts=None, html_fmt_opts=None):
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	501 """Do syntax highlighting on code
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	502
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	503 under the hood, pygments is used, check its documentation for options possible values
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	504 @param code(unicode): code or markup to highlight
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	505 @param lexer_name(unicode, None): name of the lexer to use
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	506 None to autodetect it
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	507 @param html_fmt_opts(dict, None): kword arguments to use for HtmlFormatter
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	508 @return (unicode): HTML markup with highlight classes
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	509 """
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	510 if lexer_opts is None:
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	511 lexer_opts = {}
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	512 if html_fmt_opts is None:
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	513 html_fmt_opts = {}
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	514 if lexer_name is None:
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	515 lexer = lexers.guess_lexer(code, **lexer_opts)
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	516 else:
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	517 lexer = lexers.get_lexer_by_name(lexer_name, **lexer_opts)
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	518 formatter = formatters.HtmlFormatter(**html_fmt_opts)
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	519 return safe(pygments.highlight(code, lexer, formatter))
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	520
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	521 ## custom tests ##
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	522
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	523 def _in_the_past(self, timestamp):
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	524 """check if a date is in the past
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	525
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	526 @param timestamp(unicode, int): unix time
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	527 @return (bool): True if date is in the past
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	528 """
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	529 return time.time() > int(timestamp)
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	530
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	531 ## template methods ##
00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	532
00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	533 def _icon_defs(self, *names):
00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	534 """Define svg icons which will be used in the template, and use their name as id"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	535 svg_elt = etree.Element(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	536 "svg",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	537 nsmap={None: "http://www.w3.org/2000/svg"},
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	538 width="0",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	539 height="0",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	540 style="display: block",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	541 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	542 defs_elt = etree.SubElement(svg_elt, "defs")
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	543 for name in names:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	544 path = os.path.join(self.icons_path, name + u".svg")
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	545 icon_svg_elt = etree.parse(path).getroot()
00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	546 # we use icon name as id, so we can retrieve them easily
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	547 icon_svg_elt.set("id", name)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	548 if not icon_svg_elt.tag == "{http://www.w3.org/2000/svg}svg":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	549 raise exceptions.DataError(u"invalid SVG element")
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	550 defs_elt.append(icon_svg_elt)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	551 return safe(etree.tostring(svg_elt, encoding="unicode"))
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	552
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	553 def _icon_use(self, name, cls=""):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	554 return safe(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	555 u"""<svg class="svg-icon{cls}" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	556 <use href="#{name}"/>
00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	557 </svg>
00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	558 """.format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	559 name=name, cls=(" " + cls) if cls else ""
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	560 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	561 )
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	562
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	563 def render(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	564 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	565 template,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	566 theme=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	567 locale=C.DEFAULT_LOCALE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	568 root_path=u"",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	569 media_path=u"",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	570 css_files=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	571 css_inline=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	572 **kwargs
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	573 ):
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	574 """render a template
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	575 .
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	576 @param template(unicode): template to render (e.g. blog/articles.html)
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	577 @param theme(unicode): template theme
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	578 @param root_path(unicode): prefix of the path/URL to use for template root
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	579 must end with a u'/'
2394 7bfcc431f66d template: added media_path to template data Goffi <goffi@goffi.org> parents: 2391 diff changeset	580 @param media_path(unicode): prefix of the SàT media path/URL to use for template root
7bfcc431f66d template: added media_path to template data Goffi <goffi@goffi.org> parents: 2391 diff changeset	581 must end with a u'/'
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	582 @param css_files(list[unicode],None): CSS files to used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	583 CSS files must be in static dir of the template
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	584 use None for automatic selection of CSS files based on template category
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	585 None is recommended. General static/style.css and theme file name will be used.
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	586 @param css_inline(bool): if True, CSS will be embedded in the HTML page
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	587 @param **kwargs: variable to transmit to the template
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	588 """
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	589 if not template:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	590 raise ValueError(u"template can't be empty")
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	591 if theme is not None:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	592 # use want to set a theme, we add it to the template path
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	593 if template[0] == u"(":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	594 raise ValueError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	595 u"you can't specify theme in template path and in argument at the same time"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	596 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	597 elif template[0] == u"/":
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	598 raise ValueError(u"you can't specify theme with absolute paths")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	599 template = u"(" + theme + u")" + template
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	600 else:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	601 theme, dummy = self.env.loader.parse_template(template)
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	602
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	603 template_source = self.env.get_template(template)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	604 template_root_dir = os.path.normpath(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	605 self.base_dir
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	606 ) # FIXME: should be modified if we handle use extra dirs
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	607 # XXX: template_path may have a different theme as first element than theme if a default page is used
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	608 template_path = template_source.filename[len(template_root_dir) + 1 :]
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	609
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	610 if css_files is None:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	611 css_files = self.getCSSFiles(template_path, template_root_dir)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	612
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	613 kwargs["icon_defs"] = self._icon_defs
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	614 kwargs["icon"] = self._icon_use
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	615
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	616 if css_inline:
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	617 css_contents = []
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	618 for css_file in css_files:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	619 css_file_path = os.path.join(template_root_dir, css_file)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	620 with open(css_file_path) as f:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	621 css_contents.append(f.read())
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	622 if css_contents:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	623 kwargs["css_content"] = "\n".join(css_contents)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	624
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	625 scripts_handler = ScriptsHandler(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	626 self, template_path, template_root_dir, root_path
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	627 )
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	628 self.setLocale(locale)
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	629 # XXX: theme used in template arguments is the requested theme, which may differ from actual theme
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	630 # if the template doesn't exist in the requested theme.
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	631 return template_source.render(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	632 theme=theme,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	633 root_path=root_path,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	634 media_path=media_path,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	635 css_files=css_files,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	636 locale=self._locale,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	637 gidx=Indexer(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	638 script=scripts_handler,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	639 **kwargs
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	640 )

Mercurial > libervia-backend

annotate sat/tools/common/template.py @ 2631:a381186e2398