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

annotate src/tools/common/template.py @ 2454:06ff33052354

core, template (filters): added pygments as a dependency + new highlight filter to use it.

author	Goffi <goffi@goffi.org>
date	Thu, 30 Nov 2017 21:00:24 +0100
parents	84e84a46b014
children	bb0bbcc80fc8

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
2414 8b37a62336c3 misc: date update (yes it's a bit late :p ) Goffi <goffi@goffi.org> parents: 2403 diff changeset	5 # Copyright (C) 2009-2017 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
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	25 from sat.core.log import getLogger
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	26 log = getLogger(__name__)
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	27 import os.path
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	28 from xml.sax.saxutils import quoteattr
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	29 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	30 import re
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	31 from babel import support
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	32 from babel import Locale
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	33 from babel.core import UnknownLocaleError
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	34 from babel import dates
2454 06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	35 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	36 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	37 from pygments import formatters
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	38 try:
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	39 import sat_templates
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	40 except ImportError:
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	41 raise exceptions.MissingModule(u'sat_templates module is not available, please install it or check your path to use template engine')
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	42 else:
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	43 sat_templates # to avoid pyflakes warning
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	44
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	45 try:
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	46 import jinja2
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	47 except:
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	48 raise exceptions.MissingModule(u'Missing module jinja2, please install it from http://jinja.pocoo.org or with pip install jinja2')
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	49
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	50 from jinja2 import Markup as safe
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	51 from jinja2 import is_undefined
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	52
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	53 HTML_EXT = ('html', 'xhtml')
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	54 DEFAULT_LOCALE = u'en_GB'
2401 221478058d8a template: improved attribute escaping, and added it to filters under the name "attr_escape" Goffi <goffi@goffi.org> parents: 2394 diff changeset	55 RE_ATTR_ESCAPE = re.compile(r'[^a-z_-]')
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	56 # TODO: handle external path (an additional search path for templates should be settable by user
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	57 # 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	58
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	59
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	60 class TemplateLoader(jinja2.FileSystemLoader):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	61
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	62 def __init__(self):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	63 searchpath = os.path.dirname(sat_templates.__file__)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	64 super(TemplateLoader, self).__init__(searchpath, followlinks=True)
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 def parse_template(self, template):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	67 """parse template path and return theme and relative URL
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	68
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	69 @param template_path(unicode): path to template with parenthesis syntax
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	70 @return (tuple[(unicode,None),unicode]): theme and template_path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	71 theme can be None if relative path is used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	72 relative path is the path from search path with theme specified
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	73 e.g. default/blog/articles.html
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	74 """
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	75 if template.startswith(u'('):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	76 try:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	77 theme_end = template.index(u')')
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	78 except IndexError:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	79 raise ValueError(u"incorrect theme in template")
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	80 theme = template[1:theme_end]
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	81 template = template[theme_end+1:]
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	82 if not template or template.startswith(u'/'):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	83 raise ValueError(u"incorrect path after template name")
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	84 template = os.path.join(theme, template)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	85 elif template.startswith(u'/'):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	86 # absolute path means no template
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	87 theme = None
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	88 raise NotImplementedError(u'absolute path is not implemented yet')
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	89 else:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	90 theme = C.TEMPLATE_THEME_DEFAULT
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	91 template = os.path.join(theme, template)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	92 return theme, template
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	93
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	94 def get_default_template(self, theme, template_path):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	95 """return default template path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	96
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	97 @param theme(unicode): theme used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	98 @param template_path(unicode): path to the not found template
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	99 @return (unicode, None): default path or None if there is not
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	100 """
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	101 ext = os.path.splitext(template_path)[1][1:]
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	102 path_elems = template_path.split(u'/')
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	103 if ext in HTML_EXT:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	104 if path_elems[1] == u'error':
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	105 # if an inexisting error page is requested, we return base page
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	106 default_path = os.path.join(theme, u'error/base.html')
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	107 return default_path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	108 if theme != C.TEMPLATE_THEME_DEFAULT:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	109 # 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	110 return os.path.join(C.TEMPLATE_THEME_DEFAULT, path_elems[1:])
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	111
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	112 def get_source(self, environment, template):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	113 """relative path to template dir, with special theme handling
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	114
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	115 if the path is just relative, "default" theme is used.
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	116 The theme can be specified in parenthesis just before the path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	117 e.g.: (some_theme)path/to/template.html
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	118 """
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	119 theme, template_path = self.parse_template(template)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	120 try:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	121 return super(TemplateLoader, self).get_source(environment, template_path)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	122 except jinja2.exceptions.TemplateNotFound as e:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	123 # 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	124 if theme is not None:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	125 default_path = self.get_default_template(theme, template_path)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	126 if default_path is not None:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	127 return super(TemplateLoader, self).get_source(environment, default_path)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	128 # if no default template is found, we re-raise the error
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	129 raise e
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	130
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	131
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	132 class Indexer(object):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	133 """Index global to a page"""
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	134
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	135 def __init__(self):
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	136 self._indexes = {}
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	137
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	138 def next(self, value):
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	139 if value not in self._indexes:
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	140 self._indexes[value] = 0
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	141 return 0
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	142 self._indexes[value] += 1
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	143 return self._indexes[value]
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 current(self, value):
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	146 return self._indexes.get(value)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	147
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	148
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	149 class ScriptsHandler(object):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	150
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	151 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	152 self.renderer = renderer
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	153 self.template_root_dir = template_root_dir
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	154 self.root_path = root_path
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	155 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	156 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	157
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	158 def include(self, library_name):
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	159 """Mark that a script need to be imported.
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	160
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	161 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	162 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	163 @param library_name(unicode): name of the library to import
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	164 """
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	165 if library_name.endswith('.js'):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	166 library_name = library_name[:-3]
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	167 if library_name not in self.scripts:
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	168 self.scripts.append(library_name)
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	169 return u''
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	170
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	171 def generate_scripts(self):
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	172 """Generate the <script> elements
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	173
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	174 @return (unicode): <scripts> HTML tags
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	175 """
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	176 scripts = []
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	177 tpl = u'<script src={src}></script>'
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	178 for library in self.scripts:
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	179 path = self.renderer.getStaticPath(library, self.template_root_dir, self.theme, self.is_default_theme, '.js')
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	180 if path is None:
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	181 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	182 continue
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	183 path = os.path.join(self.root_path, path)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	184 scripts.append(tpl.format(src=quoteattr(path)))
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	185 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	186
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	187
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	188 class Renderer(object):
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	189
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	190 def __init__(self, host):
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	191 self.host = host
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	192 self.base_dir = os.path.dirname(sat_templates.__file__) # 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	193 self.env = jinja2.Environment(
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	194 loader=TemplateLoader(),
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	195 autoescape=jinja2.select_autoescape(['html', 'xhtml', 'xml']),
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	196 trim_blocks=True,
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	197 lstrip_blocks=True,
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	198 extensions=['jinja2.ext.i18n'],
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	199 )
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	200 self._locale_str = DEFAULT_LOCALE
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	201 self._locale = Locale.parse(self._locale_str)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	202 self.installTranslations()
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	203 # we want to have access to SàT constants in templates
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	204 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	205 # custom filters
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	206 self.env.filters['next_gidx'] = self._next_gidx
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	207 self.env.filters['cur_gidx'] = self._cur_gidx
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	208 self.env.filters['date_fmt'] = self._date_fmt
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	209 self.env.filters['xmlui_class'] = self._xmlui_class
2401 221478058d8a template: improved attribute escaping, and added it to filters under the name "attr_escape" Goffi <goffi@goffi.org> parents: 2394 diff changeset	210 self.env.filters['attr_escape'] = self.attr_escape
2402 f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	211 self.env.filters['item_filter'] = self._item_filter
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	212 self.env.filters['adv_format'] = self._adv_format
2425 d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	213 self.env.filters['dict_ext'] = self._dict_ext
2454 06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	214 self.env.filters['highlight'] = self.highlight
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	215 # custom tests
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	216 self.env.tests['in_the_past'] = self._in_the_past
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	217
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	218 def installTranslations(self):
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	219 i18n_dir = os.path.join(self.base_dir, 'i18n')
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	220 self.translations = {}
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	221 for lang_dir in os.listdir(i18n_dir):
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	222 lang_path = os.path.join(i18n_dir, lang_dir)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	223 if not os.path.isdir(lang_path):
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	224 continue
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	225 po_path = os.path.join(lang_path, 'LC_MESSAGES/sat.mo')
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	226 try:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	227 with open(po_path, 'rb') as f:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	228 self.translations[Locale.parse(lang_dir)] = support.Translations(f, 'sat')
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	229 except EnvironmentError:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	230 log.error(_(u"Can't find template translation at {path}").format(path = po_path))
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	231 except UnknownLocaleError as e:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	232 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	233 else:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	234 log.info(_(u'loaded {lang} templates translations').format(lang=lang_dir))
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	235 self.env.install_null_translations(True)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	236
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	237 def setLocale(self, locale_str):
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	238 """set current locale
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	239
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	240 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	241 """
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	242 if locale_str == self._locale_str:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	243 return
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	244 if locale_str == 'en':
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	245 # we default to GB English when it's not specified
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	246 # one of the main reason is to avoid the nonsense U.S. short date format
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	247 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	248 try:
2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	249 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	250 except ValueError as e:
2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	251 log.warning(_(u"invalid locale value: {msg}").format(msg=e))
2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	252 locale_str = self._locale_str = DEFAULT_LOCALE
2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	253 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	254
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	255 locale_str = unicode(locale)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	256 if locale_str != DEFAULT_LOCALE:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	257 try:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	258 translations = self.translations[locale]
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	259 except KeyError:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	260 log.warning(_(u"Can't find locale {locale}".format(locale=locale)))
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	261 locale_str = DEFAULT_LOCALE
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	262 locale = Locale.parse(self._locale_str)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	263 else:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	264 self.env.install_gettext_translations(translations, True)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	265 log.debug(_(u'Switched to {lang}').format(lang=locale.english_name))
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	266
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	267 if locale_str == DEFAULT_LOCALE:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	268 self.env.install_null_translations(True)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	269
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	270 self._locale = locale
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	271 self._locale_str = locale_str
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	272
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	273 def getThemeAndRoot(self, template):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	274 """retrieve theme and root dir of a given tempalte
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	275
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	276 @param template(unicode): template to parse
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	277 @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	278 """
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	279 theme, dummy = self.env.loader.parse_template(template)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	280 return theme, os.path.join(self.base_dir, theme)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	281
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	282 def getStaticPath(self, name, template_root_dir, theme, is_default, ext='.css'):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	283 """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	284
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	285 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	286 if not found.
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	287 @param name(unicode): name of the file to look for
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	288 @param template_root_dir(unicode): absolute path to template root used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	289 @param theme(unicode): name of the template theme used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	290 @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	291 @return (unicode, None): relative path if found, else None
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	292 """
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	293 file_ = None
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	294 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	295 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	296 file_ = path
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	297 elif not is_default:
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	298 path = os.path.join(C.TEMPLATE_THEME_DEFAULT, C.TEMPLATE_STATIC_DIR, name + ext)
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	299 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	300 file_.append(path)
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	301 return file_
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	302
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	303 def getThemeData(self, template_path):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	304 """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	305
2452 7aa863cbc47f template: remove extension from elements while looking for a path: Goffi <goffi@goffi.org> parents: 2425 diff changeset	306 @return tuple(unicode, unicode, bool):
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	307 path_elems: elements of the path
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	308 theme: theme of the page
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	309 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	310 """
2452 7aa863cbc47f template: remove extension from elements while looking for a path: Goffi <goffi@goffi.org> parents: 2425 diff changeset	311 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	312 theme = path_elems.pop(0)
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	313 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	314 return (path_elems, theme, is_default)
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	315
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	316 def getCSSFiles(self, template_path, template_root_dir):
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	317 """retrieve CSS files to use according to theme and template path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	318
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	319 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	320 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	321 For instance, if template_path is some_theme/blog/articles.html:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	322 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	323 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	324 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	325 @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	326 @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	327 @return list[unicode]: relative path to CSS files to use
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	328 """
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	329 # TODO: some caching would be nice
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	330 css_files = []
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	331 path_elems, theme, is_default = self.getThemeData(template_path)
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	332 for css in (u'fonts', u'styles'):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	333 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	334 if css_path is not None:
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	335 css_files.append(css_path)
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 for idx, path in enumerate(path_elems):
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	338 css_path = self.getStaticPath(u'_'.join(path_elems[:idx+1]), template_root_dir, theme, is_default)
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	339 if css_path is not None:
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	340 css_files.append(css_path)
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	341
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	342 return css_files
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	343
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	344
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	345 ## custom filters ##
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	346
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	347 @jinja2.contextfilter
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	348 def _next_gidx(self, ctx, value):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	349 """Use next current global index as suffix"""
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	350 next_ = ctx['gidx'].next(value)
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	351 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	352
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	353 @jinja2.contextfilter
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	354 def _cur_gidx(self, ctx, value):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	355 """Use current current global index as suffix"""
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	356 current = ctx['gidx'].current(value)
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	357 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	358
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	359 def _date_fmt(self, timestamp, fmt='short', date_only=False, auto_limit=None, auto_old_fmt=None):
2453 84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	360 try:
84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	361 return self.date_fmt(timestamp, fmt, date_only, auto_limit, auto_old_fmt)
84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	362 except Exception as e:
84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	363 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	364 return timestamp
84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	365
84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	366 def date_fmt(self, timestamp, fmt='short', date_only=False, auto_limit=None, auto_old_fmt=None):
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	367 """format date according to locale
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	368
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	369 @param timestamp(basestring, int): unix time
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	370 @param fmt(str): one of:
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	371 - short: e.g. u'31/12/17'
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	372 - medium: e.g. u'Apr 1, 2007'
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	373 - long: e.g. u'April 1, 2007'
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	374 - full: e.g. u'Sunday, April 1, 2007'
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	375 - relative: format in relative time
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	376 e.g.: 3 hours
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	377 note that this format is not precise
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	378 - iso: ISO 8601 format
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	379 e.g.: u'2007-04-01T19:53:23Z'
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	380 - auto_limit (int, None): limit in days before using auto_old_fmt
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	381 None: use default(7 days)
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	382 - auto_old_fmt(unicode, None): format to use when date is olded than limit
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	383 None: use default(short)
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	384 or a free value which is passed to babel.dates.format_datetime
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	385 @param date_only(bool): if True, only display date (not datetime)
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	386
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	387 """
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	388 if is_undefined(fmt):
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	389 fmt = u'short'
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	390
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	391 if (auto_limit is not None or auto_old_fmt is not None) and fmt != 'auto':
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	392 raise ValueError(u'auto argument can only be used with auto fmt')
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	393 if fmt == 'auto':
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	394 days_delta = (time.time() - int(timestamp)) / 3600
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	395 if days_delta > (auto_limit or 7):
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	396 fmt = auto_old_fmt or 'short'
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	397 else:
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	398 fmt = 'relative'
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	399
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	400 if fmt == 'relative':
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	401 delta = int(timestamp) - time.time()
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	402 return dates.format_timedelta(delta, granularity="minute", add_direction=True, locale=self._locale_str)
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	403 elif fmt in ('short', 'long'):
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	404 formatter = dates.format_date if date_only else dates.format_datetime
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	405 return formatter(int(timestamp), format=fmt, locale=self._locale_str)
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	406 elif fmt == 'iso':
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	407 if date_only:
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	408 fmt = 'yyyy-MM-dd'
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	409 else:
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	410 fmt = "yyyy-MM-ddTHH:mm:ss'Z'"
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	411 return dates.format_datetime(int(timestamp), format=fmt)
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	412 else:
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	413 return dates.format_datetime(int(timestamp), format=fmt, locale=self._locale_str)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	414
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	415 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	416 """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	417
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	418 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	419 """
2401 221478058d8a template: improved attribute escaping, and added it to filters under the name "attr_escape" Goffi <goffi@goffi.org> parents: 2394 diff changeset	420 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	421
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	422 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	423 """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	424
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	425 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	426 @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	427 @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	428 @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	429 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	430 """
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	431 classes = []
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	432 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	433 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	434 try:
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	435 for value in xmlui_item.widgets[name].values:
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	436 classes.append(escaped_name + '_' + self.attr_escape(value))
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	437 except KeyError:
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	438 log.debug(_(u"ignoring field \"{name}\": it doesn't exists").format(name=name))
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	439 continue
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	440 return u' '.join(classes) or None
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	441
2422 5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	442 @jinja2.contextfilter
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	443 def _item_filter(self, ctx, item, filters):
2402 f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	444 """return item's value, filtered if suitable
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	445
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	446 @param item(object): item to filter
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	447 value must have name and value attributes,
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	448 mostly used for XMLUI items
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	449 @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	450 if filter is None, return the value unchanged
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	451 if filter is a callable, apply it
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	452 if filter is a dict, it can have following keys:
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	453 - filters: iterable of filters to apply
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	454 - 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	455 - template: template to format where {value} is the filtered value
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	456 """
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	457 value = item.value
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	458 filter_ = filters.get(item.name, None)
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	459 if filter_ is None:
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	460 return value
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	461 elif isinstance(filter_, dict):
2422 5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	462 filters_args = filter_.get(u'filters_args')
2402 f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	463 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	464 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	465 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	466 try:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	467 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	468 except AttributeError:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	469 eval_context_filter = False
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	470
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	471 if eval_context_filter:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	472 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	473 else:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	474 value = filter_func(value, **kwargs)
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	475 template = filter_.get(u'template')
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	476 if template:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	477 # 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	478 # 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	479 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	480 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	481 if is_safe:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	482 value = safe(value)
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	483 return value
2402 f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	484
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	485 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	486 """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	487
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	488 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	489 @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	490 @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	491 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	492 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	493 @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	494 """
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	495 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	496 return 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	497 # jinja use string when no special char is used, so we have to convert to unicode
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	498 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	499
2425 d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	500 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	501 """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	502
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	503 @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	504 @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	505 None to return source_dict unmodified
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	506 @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	507 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	508 @return (dict): resulting dictionary
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	509 """
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	510 if extra_dict is None:
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	511 return source_dict
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	512 if key is not None:
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	513 extra_dict = extra_dict.get(key, {})
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	514 ret = source_dict.copy()
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	515 ret.update(extra_dict)
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	516 return ret
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	517
2454 06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	518 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	519 """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	520
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	521 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	522 @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	523 @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	524 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	525 @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	526 @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	527 """
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	528 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	529 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	530 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	531 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	532 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	533 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	534 else:
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	535 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	536 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	537 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	538
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	539 ## custom tests ##
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	540
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	541 def _in_the_past(self, timestamp):
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	542 """check if a date is in the past
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	543
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	544 @param timestamp(unicode, int): unix time
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	545 @return (bool): True if date is in the past
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	546 """
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	547 return time.time() > int(timestamp)
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	548
2394 7bfcc431f66d template: added media_path to template data Goffi <goffi@goffi.org> parents: 2391 diff changeset	549 def render(self, template, theme=None, locale=DEFAULT_LOCALE, root_path=u'', media_path=u'', css_files=None, css_inline=False, **kwargs):
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	550 """render a template
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	551
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	552 @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	553 @param theme(unicode): template theme
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	554 @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	555 must end with a u'/'
2394 7bfcc431f66d template: added media_path to template data Goffi <goffi@goffi.org> parents: 2391 diff changeset	556 @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	557 must end with a u'/'
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	558 @param css_files(list[unicode],None): CSS files to used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	559 CSS files must be in static dir of the template
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	560 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	561 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	562 @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	563 @param **kwargs: variable to transmit to the template
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	564 """
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	565 if not template:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	566 raise ValueError(u"template can't be empty")
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	567 if theme is not None:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	568 # use want to set a theme, we add it to the template path
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	569 if template[0] == u'(':
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	570 raise ValueError(u"you can't specify theme in template path and in argument at the same time")
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	571 elif template[0] == u'/':
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	572 raise ValueError(u"you can't specify theme with absolute paths")
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	573 template= u'(' + theme + u')' + template
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	574 else:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	575 theme, dummy = self.env.loader.parse_template(template)
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	576
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	577 template_source = self.env.get_template(template)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	578 template_root_dir = os.path.normpath(self.base_dir) # FIXME: should be modified if we handle use extra dirs
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	579 # XXX: template_path may have a different theme as first element than theme if a default page is used
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	580 template_path = template_source.filename[len(template_root_dir)+1:]
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	581
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	582 if css_files is None:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	583 css_files = self.getCSSFiles(template_path, template_root_dir)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	584
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	585 if css_inline:
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	586 css_contents = []
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	587 for css_file in css_files:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	588 css_file_path = os.path.join(template_root_dir, css_file)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	589 with open(css_file_path) as f:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	590 css_contents.append(f.read())
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	591 if css_contents:
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	592 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	593
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	594 scripts_handler = ScriptsHandler(self, template_path, template_root_dir, root_path)
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	595 self.setLocale(locale)
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	596 # 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	597 # if the template doesn't exist in the requested theme.
2394 7bfcc431f66d template: added media_path to template data Goffi <goffi@goffi.org> parents: 2391 diff changeset	598 return template_source.render(theme=theme, root_path=root_path, media_path=media_path, css_files=css_files, locale=self._locale, gidx=Indexer(), script=scripts_handler, **kwargs)

Mercurial > libervia-backend

annotate src/tools/common/template.py @ 2454:06ff33052354