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

annotate sat/tools/common/template.py @ 3771:e597dbfbc4c6

doc (cli/pubsub): document new `--public` flags: `--public` option is documented for `subscribe`, `subscriptions` and `node subscriptions get`, with examples. A warning has been added to show explicitely the privacy implication of using `--public` with `subscribe`. rel 365

author	Goffi <goffi@goffi.org>
date	Fri, 13 May 2022 19:32:06 +0200
parents	dd1d1a582438
children	73936abc6838

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	1 #!/usr/bin/env python3
3137 559a625a236b fixed shebangs Goffi <goffi@goffi.org> parents: 3136 diff changeset	2
3266 8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	3 # SAT: an XMPP client
3479 be6d91572633 date update Goffi <goffi@goffi.org> parents: 3478 diff changeset	4 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	5
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	6 # 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	7 # 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	8 # 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	9 # (at your option) any later version.
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	10
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	11 # 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	12 # 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	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	14 # GNU Affero General Public License for more details.
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	15
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	16 # 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	17 # 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	18
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	19 """Template generation"""
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	20
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	21 import os.path
3266 8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	22 import time
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	23 import re
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	24 import json
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	25 from pathlib import Path
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	26 from collections import namedtuple
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	27 from typing import Optional, List, Tuple
3266 8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	28 from xml.sax.saxutils import quoteattr
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	29 from babel import support
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	30 from babel import Locale
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	31 from babel.core import UnknownLocaleError
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	32 import pygments
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	33 from pygments import lexers
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	34 from pygments import formatters
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	35 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	36 from sat.core.i18n import _
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	37 from sat.core import exceptions
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	38 from sat.tools import config
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	39 from sat.tools.common import date_utils
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	40 from sat.core.log import getLogger
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	41
3038 5f3068915686 common (template): suppress jinja2 depreaction warning (to be removed once 2.10.1 is released) Goffi <goffi@goffi.org> parents: 3028 diff changeset	42 log = getLogger(__name__)
5f3068915686 common (template): suppress jinja2 depreaction warning (to be removed once 2.10.1 is released) Goffi <goffi@goffi.org> parents: 3028 diff changeset	43
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	44 try:
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	45 import sat_templates
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	46 except ImportError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	47 raise exceptions.MissingModule(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	48 "sat_templates module is not available, please install it or check your path to "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	49 "use template engine"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	50 )
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	51 else:
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	52 sat_templates # to avoid pyflakes warning
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	53
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	54 try:
3061 948833e3b542 tools (common/template): removed warning catches, jinja2>=2.10.3 now handles them correctly Goffi <goffi@goffi.org> parents: 3038 diff changeset	55 import jinja2
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	56 except:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	57 raise exceptions.MissingModule(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	58 "Missing module jinja2, please install it from http://jinja.pocoo.org or with "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	59 "pip install jinja2"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	60 )
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	61
3266 8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	62 from lxml import etree
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	63 from jinja2 import Markup as safe
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	64 from jinja2 import is_undefined
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	65 from jinja2 import utils
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	66 from jinja2 import TemplateNotFound
2675 39d187f3698d template: import contextfilter as module attribute Goffi <goffi@goffi.org> parents: 2671 diff changeset	67 from jinja2 import contextfilter
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	68 from jinja2.loaders import split_template_path
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	69
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	70 HTML_EXT = ("html", "xhtml")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	71 RE_ATTR_ESCAPE = re.compile(r"[^a-z_-]")
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	72 SITE_RESERVED_NAMES = ("sat",)
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	73 TPL_RESERVED_CHARS = r"()/."
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	74 RE_TPL_RESERVED_CHARS = re.compile("[" + TPL_RESERVED_CHARS + "]")
3266 8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	75 BROWSER_DIR = "_browser"
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	76 BROWSER_META_FILE = "browser_meta.json"
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	77
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	78 TemplateData = namedtuple("TemplateData", ['site', 'theme', 'path'])
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	79
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	80
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	81 class TemplateLoader(jinja2.BaseLoader):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	82 """A template loader which handle site, theme and absolute paths"""
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	83 # TODO: list_templates should be implemented
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	84
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	85 def __init__(self, sites_paths, sites_themes, trusted=False):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	86 """
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	87 @param trusted(bool): if True, absolue template paths will be allowed
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	88 be careful when using this option and sure that you can trust the template,
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	89 as this allow the template to open any file on the system that the
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	90 launching user can access.
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	91 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	92 if not sites_paths or not "" in sites_paths:
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	93 raise exceptions.InternalError("Invalid sites_paths")
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	94 super(jinja2.BaseLoader, self).__init__()
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	95 self.sites_paths = sites_paths
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	96 self.sites_themes = sites_themes
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	97 self.trusted = trusted
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	98
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	99 @staticmethod
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	100 def parse_template(template):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	101 """Parse template path and return site, theme and path
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	102
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	103 @param template_path(unicode): path to template with parenthesis syntax
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	104 The site and/or theme can be specified in parenthesis just before the path
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	105 e.g.: (some_theme)path/to/template.html
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	106 (/some_theme)path/to/template.html (equivalent to previous one)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	107 (other_site/other_theme)path/to/template.html
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	108 (other_site/)path/to/template.html (defaut theme for other_site)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	109 /absolute/path/to/template.html (in trusted environment only)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	110 @return (TemplateData):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	111 site, theme and template_path.
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	112 if site is empty, SàT Templates are used
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	113 site and theme can be both None if absolute path is used
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	114 Relative path is the path from theme root dir e.g. blog/articles.html
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	115 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	116 if template.startswith("("):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	117 # site and/or theme are specified
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	118 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	119 theme_end = template.index(")")
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	120 except IndexError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	121 raise ValueError("incorrect site/theme in template")
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	122 theme_data = template[1:theme_end]
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	123 theme_splitted = theme_data.split('/')
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	124 if len(theme_splitted) == 1:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	125 site, theme = "", theme_splitted[0]
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	126 elif len(theme_splitted) == 2:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	127 site, theme = theme_splitted
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	128 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	129 raise ValueError("incorrect site/theme in template")
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	130 template_path = template[theme_end+1:]
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	131 if not template_path or template_path.startswith("/"):
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	132 raise ValueError("incorrect template path")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	133 elif template.startswith("/"):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	134 # this is an absolute path, so we have no site and no theme
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	135 site = None
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	136 theme = None
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	137 template_path = template
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	138 else:
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	139 # a default template
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	140 site = ""
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	141 theme = C.TEMPLATE_THEME_DEFAULT
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	142 template_path = template
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	143
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	144 if site is not None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	145 site = site.strip()
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	146 if not site:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	147 site = ""
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	148 elif site in SITE_RESERVED_NAMES:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	149 raise ValueError(_("{site} can't be used as site name, "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	150 "it's reserved.").format(site=site))
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	151
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	152 if theme is not None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	153 theme = theme.strip()
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	154 if not theme:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	155 theme = C.TEMPLATE_THEME_DEFAULT
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	156 if RE_TPL_RESERVED_CHARS.search(theme):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	157 raise ValueError(_("{theme} contain forbidden char. Following chars "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	158 "are forbidden: {reserved}").format(
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	159 theme=theme, reserved=TPL_RESERVED_CHARS))
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	160
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	161 return TemplateData(site, theme, template_path)
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	162
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	163 @staticmethod
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	164 def getSitesAndThemes(
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	165 site: str,
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	166 theme: str,
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	167 settings: Optional[dict] = None,
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	168 ) -> List[Tuple[str, str]]:
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	169 """Get sites and themes to check for template/file
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	170
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	171 Will add default theme and default site in search list when suitable. Settings'
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	172 `fallback` can be used to modify behaviour: themes in this list will then be used
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	173 instead of default (it can also be empty list or None, in which case no fallback
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	174 is used).
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	175
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	176 @param site: site requested
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	177 @param theme: theme requested
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	178 @return: site and theme couples to check
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	179 """
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	180 if settings is None:
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	181 settings = {}
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	182 sites_and_themes = [[site, theme]]
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	183 fallback = settings.get("fallback", [C.TEMPLATE_THEME_DEFAULT])
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	184 for fb_theme in fallback:
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	185 if theme != fb_theme:
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	186 sites_and_themes.append([site, fb_theme])
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	187 if site:
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	188 for fb_theme in fallback:
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	189 sites_and_themes.append(["", fb_theme])
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	190 return sites_and_themes
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	191
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	192 def _get_template_f(self, site, theme, path_elts):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	193 """Look for template and return opened file if found
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	194
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	195 @param site(unicode): names of site to check
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	196 (default site will also checked)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	197 @param theme(unicode): theme to check (default theme will also be checked)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	198 @param path_elts(iterable[str]): elements of template path
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	199 @return (tuple[(File, None), (str, None)]): a tuple with:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	200 - opened template, or None if not found
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	201 - absolute file path, or None if not found
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	202 """
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	203 if site is None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	204 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	205 "_get_template_f must not be used with absolute path")
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	206 settings = self.sites_themes[site][theme]['settings']
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	207 for site_to_check, theme_to_check in self.getSitesAndThemes(
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	208 site, theme, settings):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	209 try:
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	210 base_path = self.sites_paths[site_to_check]
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	211 except KeyError:
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	212 log.warning(_("Unregistered site requested: {site_to_check}").format(
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	213 site_to_check=site_to_check))
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	214 filepath = os.path.join(
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	215 base_path,
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	216 C.TEMPLATE_TPL_DIR,
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	217 theme_to_check,
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	218 *path_elts
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	219 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	220 f = utils.open_if_exists(filepath, 'r')
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	221 if f is not None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	222 return f, filepath
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	223 return None, None
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	224
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	225 def get_source(self, environment, template):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	226 """Retrieve source handling site and themes
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	227
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	228 If the path is absolute it is used directly if in trusted environment
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	229 else and exception is raised.
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	230 if the path is just relative, "default" theme is used.
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	231 @raise PermissionError: absolute path used in untrusted environment
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	232 """
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	233 site, theme, template_path = self.parse_template(template)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	234
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	235 if site is None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	236 # we have an abolute template
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	237 if theme is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	238 raise exceptions.InternalError("We can't have a theme with absolute "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	239 "template.")
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	240 if not self.trusted:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	241 log.error(_("Absolute template used while unsecure is disabled, hack "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	242 "attempt? Template: {template}").format(template=template))
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	243 raise exceptions.PermissionError("absolute template is not allowed")
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	244 filepath = template_path
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	245 f = utils.open_if_exists(filepath, 'r')
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	246 else:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	247 # relative path, we have to deal with site and theme
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	248 assert theme and template_path
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	249 path_elts = split_template_path(template_path)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	250 # if we have non default site, we check it first, else we only check default
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	251 f, filepath = self._get_template_f(site, theme, path_elts)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	252
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	253 if f is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	254 if (site is not None and path_elts[0] == "error"
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	255 and os.path.splitext(template_path)[1][1:] in HTML_EXT):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	256 # if an HTML error is requested but doesn't exist, we try again
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	257 # with base error.
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	258 f, filepath = self._get_template_f(
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	259 site, theme, ("error", "base.html"))
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	260 if f is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	261 raise exceptions.InternalError("error/base.html should exist")
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	262 else:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	263 raise TemplateNotFound(template)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	264
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	265 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	266 contents = f.read()
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	267 finally:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	268 f.close()
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	269
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	270 mtime = os.path.getmtime(filepath)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	271
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	272 def uptodate():
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	273 try:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	274 return os.path.getmtime(filepath) == mtime
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	275 except OSError:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	276 return False
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	277
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	278 return contents, filepath, uptodate
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	279
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	280
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	281 class Indexer(object):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	282 """Index global to a page"""
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	283
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	284 def __init__(self):
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	285 self._indexes = {}
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	286
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	287 def next(self, value):
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	288 if value not in self._indexes:
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	289 self._indexes[value] = 0
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	290 return 0
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	291 self._indexes[value] += 1
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	292 return self._indexes[value]
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	293
2385 39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	294 def current(self, value):
39d30cf722cb template: gidx methods improvment: Goffi <goffi@goffi.org> parents: 2384 diff changeset	295 return self._indexes.get(value)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	296
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	297
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	298 class ScriptsHandler(object):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	299 def __init__(self, renderer, template_data):
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	300 self.renderer = renderer
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	301 self.template_data = template_data
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	302 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	303
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	304 def include(self, library_name, attribute="defer"):
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	305 """Mark that a script need to be imported.
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	306
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	307 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	308 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	309 @param library_name(unicode): name of the library to import
2465 bb0bbcc80fc8 template: boolean attribute can now be specified when importing a script, and default to "defer" Goffi <goffi@goffi.org> parents: 2454 diff changeset	310 @param loading:
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	311 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	312 if attribute not in ("defer", "async", ""):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	313 raise exceptions.DataError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	314 _('Invalid attribute, please use one of "defer", "async" or ""')
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	315 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	316 if not library_name.endswith(".js"):
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	317 library_name = library_name + ".js"
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	318 if (library_name, attribute) not in self.scripts:
2465 bb0bbcc80fc8 template: boolean attribute can now be specified when importing a script, and default to "defer" Goffi <goffi@goffi.org> parents: 2454 diff changeset	319 self.scripts.append((library_name, attribute))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	320 return ""
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	321
2265 322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	322 def generate_scripts(self):
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	323 """Generate the <script> elements
322694543225 tools (common/template): ScriptsHandler fix/improvments: Goffi <goffi@goffi.org> parents: 2249 diff changeset	324
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	325 @return (unicode): <scripts> HTML tags
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	326 """
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	327 scripts = []
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	328 tpl = "<script src={src} {attribute}></script>"
2465 bb0bbcc80fc8 template: boolean attribute can now be specified when importing a script, and default to "defer" Goffi <goffi@goffi.org> parents: 2454 diff changeset	329 for library, attribute in self.scripts:
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	330 library_path = self.renderer.getStaticPath(self.template_data, library)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	331 if library_path is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	332 log.warning(_("Can't find {libary} javascript library").format(
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	333 library=library))
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	334 continue
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	335 path = self.renderer.getFrontURL(library_path)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	336 scripts.append(tpl.format(src=quoteattr(path), attribute=attribute))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	337 return safe("\n".join(scripts))
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	338
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	339
2676 da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	340 class Environment(jinja2.Environment):
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	341
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	342 def get_template(self, name, parent=None, globals=None):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	343 if name[0] not in ('/', '('):
2676 da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	344 # if name is not an absolute path or a full template name (this happen on
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	345 # extend or import during rendering), we convert it to a full template name.
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	346 # This is needed to handle cache correctly when a base template is overriden.
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	347 # Without that, we could not distinguish something like base/base.html if
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	348 # it's launched from some_site/some_theme or from [default]/default
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	349 name = "({site}/{theme}){template}".format(
2676 da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	350 site=self._template_data.site,
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	351 theme=self._template_data.theme,
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	352 template=name)
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	353
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	354 return super(Environment, self).get_template(name, parent, globals)
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	355
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	356
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	357 class Renderer(object):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	358
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	359 def __init__(self, host, front_url_filter=None, trusted=False, private=False):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	360 """
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	361 @param front_url_filter(callable): filter to retrieve real url of a directory/file
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	362 The callable will get a two arguments:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	363 - a dict with a "template_data" key containing TemplateData instance of
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	364 current template. Only site and theme should be necessary.
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	365 - the relative URL of the file to retrieve, relative from theme root
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	366 None to use default filter which return real path on file
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	367 Need to be specified for web rendering, to reflect URL seen by end user
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	368 @param trusted(bool): if True, allow to access absolute path
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	369 Only set to True if environment is safe (e.g. command line tool)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	370 @param private(bool): if True, also load sites from sites_path_private_dict
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	371 """
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	372 self.host = host
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	373 self.trusted = trusted
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	374 self.sites_paths = {
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	375 "": os.path.dirname(sat_templates.__file__),
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	376 }
3266 8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	377 self.sites_themes = {
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	378 }
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	379 conf = config.parseMainConf()
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	380 public_sites = config.getConfig(conf, None, "sites_path_public_dict", {})
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	381 sites_data = [public_sites]
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	382 if private:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	383 private_sites = config.getConfig(conf, None, "sites_path_private_dict", {})
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	384 sites_data.append(private_sites)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	385 for sites in sites_data:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	386 normalised = {}
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	387 for name, path in sites.items():
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	388 if RE_TPL_RESERVED_CHARS.search(name):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	389 log.warning(_("Can't add \"{name}\" site, it contains forbidden "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	390 "characters. Forbidden characters are {forbidden}.")
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	391 .format(name=name, forbidden=TPL_RESERVED_CHARS))
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	392 continue
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	393 path = os.path.expanduser(os.path.normpath(path))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	394 if not path or not path.startswith("/"):
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	395 log.warning(_("Can't add \"{name}\" site, it should map to an "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	396 "absolute path").format(name=name))
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	397 continue
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	398 normalised[name] = path
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	399 self.sites_paths.update(normalised)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	400
3266 8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	401 for site, site_path in self.sites_paths.items():
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	402 tpl_path = Path(site_path) / C.TEMPLATE_TPL_DIR
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	403 for p in tpl_path.iterdir():
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	404 if not p.is_dir():
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	405 continue
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	406 log.debug(f"theme found for {site or 'default site'}: {p.name}")
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	407 theme_data = self.sites_themes.setdefault(site, {})[p.name] = {
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	408 'path': p,
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	409 'settings': {}}
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	410 theme_settings = p / "settings.json"
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	411 if theme_settings.is_file:
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	412 try:
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	413 with theme_settings.open() as f:
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	414 settings = json.load(f)
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	415 except Exception as e:
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	416 log.warning(_(
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	417 "Can't load theme settings at {path}: {e}").format(
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	418 path=theme_settings, e=e))
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	419 else:
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	420 log.debug(
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	421 f"found settings for theme {p.name!r} at {theme_settings}")
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	422 fallback = settings.get("fallback")
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	423 if fallback is None:
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	424 settings["fallback"] = []
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	425 elif isinstance(fallback, str):
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	426 settings["fallback"] = [fallback]
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	427 elif not isinstance(fallback, list):
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	428 raise ValueError(
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	429 'incorrect type for "fallback" in settings '
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	430 f'({type(fallback)}) at {theme_settings}: {fallback}'
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	431 )
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	432 theme_data['settings'] = settings
3266 8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	433 browser_path = p / BROWSER_DIR
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	434 if browser_path.is_dir():
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	435 theme_data['browser_path'] = browser_path
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	436 browser_meta_path = browser_path / BROWSER_META_FILE
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	437 if browser_meta_path.is_file():
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	438 try:
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	439 with browser_meta_path.open() as f:
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	440 theme_data['browser_meta'] = json.load(f)
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	441 except Exception as e:
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	442 log.error(
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	443 f"Can't parse browser metadata at {browser_meta_path}: {e}"
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	444 )
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	445 continue
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	446
2676 da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	447 self.env = Environment(
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	448 loader=TemplateLoader(
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	449 sites_paths=self.sites_paths,
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	450 sites_themes=self.sites_themes,
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	451 trusted=trusted
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	452 ),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	453 autoescape=jinja2.select_autoescape(["html", "xhtml", "xml"]),
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	454 trim_blocks=True,
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	455 lstrip_blocks=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	456 extensions=["jinja2.ext.i18n"],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	457 )
2676 da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	458 self.env._template_data = None
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	459 self._locale_str = C.DEFAULT_LOCALE
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	460 self._locale = Locale.parse(self._locale_str)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	461 self.installTranslations()
2906 7dbdbd132649 template (i18n): activate ext.i18n.trimmed policy, to have clean translation strings. Set minimal jinja2 version to 2.10 Goffi <goffi@goffi.org> parents: 2903 diff changeset	462
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	463 # we want to have access to SàT constants in templates
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	464 self.env.globals["C"] = C
2906 7dbdbd132649 template (i18n): activate ext.i18n.trimmed policy, to have clean translation strings. Set minimal jinja2 version to 2.10 Goffi <goffi@goffi.org> parents: 2903 diff changeset	465
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	466 # custom filters
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	467 self.env.filters["next_gidx"] = self._next_gidx
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	468 self.env.filters["cur_gidx"] = self._cur_gidx
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	469 self.env.filters["date_fmt"] = self._date_fmt
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	470 self.env.filters["xmlui_class"] = self._xmlui_class
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	471 self.env.filters["attr_escape"] = self.attr_escape
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	472 self.env.filters["item_filter"] = self._item_filter
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	473 self.env.filters["adv_format"] = self._adv_format
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	474 self.env.filters["dict_ext"] = self._dict_ext
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	475 self.env.filters["highlight"] = self.highlight
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	476 self.env.filters["front_url"] = (self._front_url if front_url_filter is None
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	477 else front_url_filter)
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	478 # custom tests
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	479 self.env.tests["in_the_past"] = self._in_the_past
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	480 self.icons_path = os.path.join(host.media_dir, "fonts/fontello/svg")
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	481
2906 7dbdbd132649 template (i18n): activate ext.i18n.trimmed policy, to have clean translation strings. Set minimal jinja2 version to 2.10 Goffi <goffi@goffi.org> parents: 2903 diff changeset	482 # policies
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	483 self.env.policies["ext.i18n.trimmed"] = True
3306 3af0909629a2 common (template): better json dumping: Goffi <goffi@goffi.org> parents: 3274 diff changeset	484 self.env.policies["json.dumps_kwargs"] = {
3af0909629a2 common (template): better json dumping: Goffi <goffi@goffi.org> parents: 3274 diff changeset	485 "sort_keys": True,
3af0909629a2 common (template): better json dumping: Goffi <goffi@goffi.org> parents: 3274 diff changeset	486 # if object can't be serialised, we use None
3311 29f8122f00f3 tools (common/template): use `to_json` instead of `json` + added missing args to `date_fmt` Goffi <goffi@goffi.org> parents: 3306 diff changeset	487 "default": lambda o: o.to_json() if hasattr(o, "to_json") else None
3306 3af0909629a2 common (template): better json dumping: Goffi <goffi@goffi.org> parents: 3274 diff changeset	488 }
2906 7dbdbd132649 template (i18n): activate ext.i18n.trimmed policy, to have clean translation strings. Set minimal jinja2 version to 2.10 Goffi <goffi@goffi.org> parents: 2903 diff changeset	489
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	490 def getFrontURL(self, template_data, path=None):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	491 """Give front URL (i.e. URL seen by end-user) of a path
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	492
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	493 @param template_data[TemplateData]: data of current template
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	494 @param path(unicode, None): relative path of file to get,
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	495 if set, will remplate template_data.path
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	496 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	497 return self.env.filters["front_url"]({"template_data": template_data},
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	498 path or template_data.path)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	499
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	500 def installTranslations(self):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	501 # TODO: support multi translation
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	502 # for now, only translations in sat_templates are handled
2903 68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	503 self.translations = {}
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	504 for site_key, site_path in self.sites_paths.items():
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	505 site_prefix = "[{}] ".format(site_key) if site_key else ''
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	506 i18n_dir = os.path.join(site_path, "i18n")
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	507 for lang_dir in os.listdir(i18n_dir):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	508 lang_path = os.path.join(i18n_dir, lang_dir)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	509 if not os.path.isdir(lang_path):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	510 continue
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	511 po_path = os.path.join(lang_path, "LC_MESSAGES/sat.mo")
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	512 try:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	513 locale = Locale.parse(lang_dir)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	514 with open(po_path, "rb") as f:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	515 try:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	516 translations = self.translations[locale]
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	517 except KeyError:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	518 self.translations[locale] = support.Translations(f, "sat")
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	519 else:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	520 translations.merge(support.Translations(f, "sat"))
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	521 except EnvironmentError:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	522 log.error(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	523 _("Can't find template translation at {path}").format(
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	524 path=po_path))
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	525 except UnknownLocaleError as e:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	526 log.error(_("{site}Invalid locale name: {msg}").format(
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	527 site=site_prefix, msg=e))
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	528 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	529 log.info(_("{site}loaded {lang} templates translations").format(
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	530 site = site_prefix,
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	531 lang=lang_dir))
2903 68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	532
68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	533 default_locale = Locale.parse(self._locale_str)
68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	534 if default_locale not in self.translations:
68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	535 # default locale disable gettext,
68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	536 # so we can use None instead of a Translations instance
68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	537 self.translations[default_locale] = None
68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	538
68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	539 self.env.install_null_translations(True)
68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	540 # we generate a tuple of locales ordered by display name that templates can access
68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	541 # through the "locales" variable
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	542 self.locales = tuple(sorted(list(self.translations.keys()),
2903 68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	543 key=lambda l: l.language_name.lower()))
68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	544
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	545
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	546 def setLocale(self, locale_str):
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	547 """set current locale
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	548
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	549 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	550 """
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	551 if locale_str == self._locale_str:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	552 return
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	553 if locale_str == "en":
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	554 # we default to GB English when it's not specified
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	555 # one of the main reason is to avoid the nonsense U.S. short date format
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	556 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	557 try:
2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	558 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	559 except ValueError as e:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	560 log.warning(_("invalid locale value: {msg}").format(msg=e))
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	561 locale_str = self._locale_str = C.DEFAULT_LOCALE
2323 2dae79990122 template: print warning message and use DEFAULT_LOCALE on bad locale Goffi <goffi@goffi.org> parents: 2266 diff changeset	562 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	563
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	564 locale_str = str(locale)
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	565 if locale_str != C.DEFAULT_LOCALE:
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	566 try:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	567 translations = self.translations[locale]
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	568 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	569 log.warning(_("Can't find locale {locale}".format(locale=locale)))
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	570 locale_str = C.DEFAULT_LOCALE
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	571 locale = Locale.parse(self._locale_str)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	572 else:
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	573 self.env.install_gettext_translations(translations, True)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	574 log.debug(_("Switched to {lang}").format(lang=locale.english_name))
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	575
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	576 if locale_str == C.DEFAULT_LOCALE:
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	577 self.env.install_null_translations(True)
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	578
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	579 self._locale = locale
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	580 self._locale_str = locale_str
e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	581
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	582 def getThemeAndRoot(self, template):
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	583 """retrieve theme and root dir of a given template
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	584
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	585 @param template(unicode): template to parse
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	586 @return (tuple[unicode, unicode]): theme and absolute path to theme's root dir
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	587 @raise NotFound: requested site has not been found
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	588 """
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	589 # FIXME: check use in jp, and include site
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	590 site, theme, __ = self.env.loader.parse_template(template)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	591 if site is None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	592 # absolute template
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	593 return "", os.path.dirname(template)
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	594 try:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	595 site_root_dir = self.sites_paths[site]
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	596 except KeyError:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	597 raise exceptions.NotFound
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	598 return theme, os.path.join(site_root_dir, C.TEMPLATE_TPL_DIR, theme)
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	599
3266 8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	600 def getThemesData(self, site_name):
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	601 try:
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	602 return self.sites_themes[site_name]
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	603 except KeyError:
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	604 raise exceptions.NotFound(f"no theme found for {site_name}")
8ec5ddb4e759 tools (common/template): list themes and parse their browser data, available through new `getThemesData` method Goffi <goffi@goffi.org> parents: 3137 diff changeset	605
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	606 def getStaticPath(
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	607 self,
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	608 template_data: TemplateData,
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	609 filename: str,
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	610 settings: Optional[dict]=None
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	611 ) -> Optional[TemplateData]:
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	612 """Retrieve path of a static file if it exists with current theme or default
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	613
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	614 File will be looked at <site_root_dir>/<theme_dir>/<static_dir>/filename,
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	615 then <site_root_dir>/<default_theme_dir>/<static_dir>/filename anf finally
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	616 <default_site>/<default_theme_dir>/<static_dir> (i.e. sat_templates).
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	617 In case of absolute URL, base dir of template is used as base. For instance if
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	618 template is an absolute template to "/some/path/template.html", file will be
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	619 checked at "/some/path/<filename>"
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	620 @param template_data: data of current template
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	621 @param filename: name of the file to retrieve
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	622 @param settings: theme settings, can be used to modify behaviour
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	623 @return: built template data instance where .path is
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	624 the relative path to the file, from theme root dir.
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	625 None if not found.
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	626 """
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	627 if template_data.site is None:
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	628 # we have an absolue path
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	629 if (not template_data.theme is None
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	630 or not template_data.path.startswith('/')):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	631 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	632 "invalid template data, was expecting absolute URL")
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	633 static_dir = os.path.dirname(template_data.path)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	634 file_path = os.path.join(static_dir, filename)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	635 if os.path.exists(file_path):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	636 return TemplateData(site=None, theme=None, path=file_path)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	637 else:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	638 return None
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	639
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	640 sites_and_themes = TemplateLoader.getSitesAndThemes(template_data.site,
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	641 template_data.theme,
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	642 settings)
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	643 for site, theme in sites_and_themes:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	644 site_root_dir = self.sites_paths[site]
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	645 relative_path = os.path.join(C.TEMPLATE_STATIC_DIR, filename)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	646 absolute_path = os.path.join(site_root_dir, C.TEMPLATE_TPL_DIR,
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	647 theme, relative_path)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	648 if os.path.exists(absolute_path):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	649 return TemplateData(site=site, theme=theme, path=relative_path)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	650
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	651 return None
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	652
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	653 def _appendCSSPaths(
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	654 self,
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	655 template_data: TemplateData,
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	656 css_files: list,
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	657 css_files_noscript: list,
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	658 name_root: str,
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	659 settings: dict
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	660
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	661 ) -> None:
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	662 """Append found css to css_files and css_files_noscript
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	663
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	664 @param css_files: list to fill of relative path to found css file
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	665 @param css_files_noscript: list to fill of relative path to found css file
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	666 with "_noscript" suffix
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	667 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	668 name = name_root + ".css"
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	669 css_path = self.getStaticPath(template_data, name, settings)
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	670 if css_path is not None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	671 css_files.append(self.getFrontURL(css_path))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	672 noscript_name = name_root + "_noscript.css"
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	673 noscript_path = self.getStaticPath(
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	674 template_data, noscript_name, settings)
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	675 if noscript_path is not None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	676 css_files_noscript.append(self.getFrontURL(noscript_path))
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	677
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	678 def getCSSFiles(self, template_data):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	679 """Retrieve CSS files to use according template_data
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	680
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	681 For each element of the path, a .css file is looked for in /static, and returned
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	682 if it exists.
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	683 Previous element are kept by replacing '/' with '_'.
2877 f8427bf8c072 tools (common/template): always use highlight.css if present. Goffi <goffi@goffi.org> parents: 2771 diff changeset	684 styles_extra.css, styles.css, highlight.css and fonts.css are always used if they
f8427bf8c072 tools (common/template): always use highlight.css if present. Goffi <goffi@goffi.org> parents: 2771 diff changeset	685 exist.
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	686 For each found file, if a file with the same name and "_noscript" suffix exists,
3267 2eeca6fd08f7 tools (common/template): typos Goffi <goffi@goffi.org> parents: 3266 diff changeset	687 it will be returned is second part of resulting tuple.
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	688 For instance, if template_data is (some_site, some_theme, blog/articles.html),
3267 2eeca6fd08f7 tools (common/template): typos Goffi <goffi@goffi.org> parents: 3266 diff changeset	689 following files are returned, each time trying [some_site root] first,
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	690 then default site (i.e. sat_templates) root:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	691 - some_theme/static/styles.css is returned if it exists
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	692 else default/static/styles.css
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	693 - some_theme/static/blog.css is returned if it exists
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	694 else default/static/blog.css (if it exists too)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	695 - some_theme/static/blog_articles.css is returned if it exists
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	696 else default/static/blog_articles.css (if it exists too)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	697 and for each found files, if same file with _noscript suffix exists, it is put
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	698 in noscript list (for instance (some_theme/static/styles_noscript.css)).
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	699 The behaviour may be changed with theme settings: if "fallback" is set, specified
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	700 themes will be checked instead of default. The theme will be checked in given
b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	701 order, and "fallback" may be None or empty list to not check anything.
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	702 @param template_data(TemplateData): data of the current template
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	703 @return (tuple[list[unicode], list[unicode]]): a tuple with:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	704 - front URLs of CSS files to use
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	705 - front URLs of CSS files to use when scripts are not enabled
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	706 """
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	707 # TODO: some caching would be nice
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	708 css_files = []
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	709 css_files_noscript = []
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	710 path_elems = template_data.path.split('/')
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	711 path_elems[-1] = os.path.splitext(path_elems[-1])[0]
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	712 site = template_data.site
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	713 if site is None:
85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	714 # absolute path
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	715 settings = {}
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	716 else:
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	717 settings = self.sites_themes[site][template_data.theme]['settings']
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	718
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	719 css_path = self.getStaticPath(template_data, 'fonts.css', settings)
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	720 if css_path is not None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	721 css_files.append(self.getFrontURL(css_path))
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	722
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	723 for name_root in ('styles', 'styles_extra', 'highlight'):
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	724 self._appendCSSPaths(
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	725 template_data, css_files, css_files_noscript, name_root, settings)
2683 38af118a7d74 template: better css files order Goffi <goffi@goffi.org> parents: 2680 diff changeset	726
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	727 for idx in range(len(path_elems)):
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	728 name_root = "_".join(path_elems[:idx+1])
3268 85c9cfcd4f5e tools (common/template): theme settings with possibility to disable default fallback for CSS: Goffi <goffi@goffi.org> parents: 3267 diff changeset	729 self._appendCSSPaths(
3478 b65175eb7769 tools (common/template): new `fallback` settings: Goffi <goffi@goffi.org> parents: 3311 diff changeset	730 template_data, css_files, css_files_noscript, name_root, settings)
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	731
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	732 return css_files, css_files_noscript
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	733
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	734 ## custom filters ##
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	735
2675 39d187f3698d template: import contextfilter as module attribute Goffi <goffi@goffi.org> parents: 2671 diff changeset	736 @contextfilter
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	737 def _front_url(self, ctx, relative_url):
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	738 """Get front URL (URL seen by end-user) from a relative URL
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	739
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	740 This default method return absolute full path
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	741 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	742 template_data = ctx['template_data']
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	743 if template_data.site is None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	744 assert template_data.theme is None
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	745 assert template_data.path.startswith("/")
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	746 return os.path.join(os.path.dirname(template_data.path, relative_url))
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	747
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	748 site_root_dir = self.sites_paths[template_data.site]
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	749 return os.path.join(site_root_dir, C.TEMPLATE_TPL_DIR, template_data.theme,
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	750 relative_url)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	751
2675 39d187f3698d template: import contextfilter as module attribute Goffi <goffi@goffi.org> parents: 2671 diff changeset	752 @contextfilter
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	753 def _next_gidx(self, ctx, value):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	754 """Use next current global index as suffix"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	755 next_ = ctx["gidx"].next(value)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	756 return value if next_ == 0 else "{}_{}".format(value, next_)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	757
2675 39d187f3698d template: import contextfilter as module attribute Goffi <goffi@goffi.org> parents: 2671 diff changeset	758 @contextfilter
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	759 def _cur_gidx(self, ctx, value):
e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	760 """Use current current global index as suffix"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	761 current = ctx["gidx"].current(value)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	762 return value if not current else "{}_{}".format(value, current)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	763
3311 29f8122f00f3 tools (common/template): use `to_json` instead of `json` + added missing args to `date_fmt` Goffi <goffi@goffi.org> parents: 3306 diff changeset	764 def _date_fmt(self, timestamp, fmt="short", date_only=False, auto_limit=7,
29f8122f00f3 tools (common/template): use `to_json` instead of `json` + added missing args to `date_fmt` Goffi <goffi@goffi.org> parents: 3306 diff changeset	765 auto_old_fmt="short", auto_new_fmt="relative"):
2599 5b26033c49a8 tools (common): moved date_fmt function from template filters to new date_utils module, so it can be used everywhere. Goffi <goffi@goffi.org> parents: 2562 diff changeset	766 if is_undefined(fmt):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	767 fmt = "short"
2453 84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	768 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	769 return date_utils.date_fmt(
2907 8ca12f30f61f template (filters): set locale when using "date_fmt" Goffi <goffi@goffi.org> parents: 2906 diff changeset	770 timestamp, fmt, date_only, auto_limit, auto_old_fmt,
8ca12f30f61f template (filters): set locale when using "date_fmt" Goffi <goffi@goffi.org> parents: 2906 diff changeset	771 locale_str = self._locale_str
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	772 )
2453 84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	773 except Exception as e:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	774 log.warning(_("Can't parse date: {msg}").format(msg=e))
2453 84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	775 return timestamp
84e84a46b014 template (filters): don't crash on invalid date in date_fmt Goffi <goffi@goffi.org> parents: 2452 diff changeset	776
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	777 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	778 """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	779
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	780 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	781 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	782 return RE_ATTR_ESCAPE.sub("_", 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	783
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	784 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	785 """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	786
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	787 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	788 @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	789 @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	790 @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	791 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	792 """
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	793 classes = []
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	794 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	795 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	796 try:
d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	797 for value in xmlui_item.widgets[name].values:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	798 classes.append(escaped_name + "_" + self.attr_escape(value))
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	799 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	800 log.debug(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	801 _('ignoring field "{name}": it doesn\'t exists').format(name=name)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	802 )
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	803 continue
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	804 return " ".join(classes) or None
2384 d14c1a3e3244 template: new "xmlui_class" filter compute class names from name/values of requested fields. Goffi <goffi@goffi.org> parents: 2323 diff changeset	805
2675 39d187f3698d template: import contextfilter as module attribute Goffi <goffi@goffi.org> parents: 2671 diff changeset	806 @contextfilter
2422 5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	807 def _item_filter(self, ctx, item, filters):
2402 f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	808 """return item's value, filtered if suitable
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	809
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	810 @param item(object): item to filter
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	811 value must have name and value attributes,
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	812 mostly used for XMLUI items
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	813 @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	814 if filter is None, return the value unchanged
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	815 if filter is a callable, apply it
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	816 if filter is a dict, it can have following keys:
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	817 - filters: iterable of filters to apply
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	818 - filters_args: kwargs of filters in the same order as filters (use empty
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	819 dict if needed)
2402 f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	820 - template: template to format where {value} is the filtered value
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	821 """
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	822 value = item.value
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	823 filter_ = filters.get(item.name, None)
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	824 if filter_ is None:
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	825 return value
f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	826 elif isinstance(filter_, dict):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	827 filters_args = filter_.get("filters_args")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	828 for idx, f_name in enumerate(filter_.get("filters", [])):
2422 5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	829 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	830 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	831 try:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	832 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	833 except AttributeError:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	834 eval_context_filter = False
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	835
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	836 if eval_context_filter:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	837 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	838 else:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	839 value = filter_func(value, **kwargs)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	840 template = filter_.get("template")
2422 5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	841 if template:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	842 # 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	843 # 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	844 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	845 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	846 if is_safe:
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	847 value = safe(value)
5425cf18929b template: fixed the use of eval_context_filter in item_filter Goffi <goffi@goffi.org> parents: 2414 diff changeset	848 return value
2402 f905dfe69fcc template: new item_value filter Goffi <goffi@goffi.org> parents: 2401 diff changeset	849
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	850 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	851 """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	852
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	853 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	854 @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	855 @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	856 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	857 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	858 @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	859 """
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	860 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	861 return value
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	862 # jinja use string when no special char is used, so we have to convert to unicode
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	863 return str(template).format(value=value, **kwargs)
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	864
2425 d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	865 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	866 """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	867
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	868 @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	869 @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	870 None to return source_dict unmodified
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	871 @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	872 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	873 @return (dict): resulting dictionary
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	874 """
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	875 if extra_dict is None:
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	876 return source_dict
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	877 if key is not None:
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	878 extra_dict = extra_dict.get(key, {})
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	879 ret = source_dict.copy()
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	880 ret.update(extra_dict)
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	881 return ret
d294527bd46f template: added dict_ext filter to extend a dictionary Goffi <goffi@goffi.org> parents: 2422 diff changeset	882
2454 06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	883 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	884 """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	885
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	886 Under the hood, pygments is used, check its documentation for options possible
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	887 values.
2454 06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	888 @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	889 @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	890 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	891 @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	892 @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	893 """
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	894 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	895 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	896 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	897 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	898 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	899 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	900 else:
06ff33052354 core, template (filters): added pygments as a dependency + new highlight filter to use it. Goffi <goffi@goffi.org> parents: 2453 diff changeset	901 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	902 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	903 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	904
2403 dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	905 ## custom tests ##
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	906
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	907 def _in_the_past(self, timestamp):
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	908 """check if a date is in the past
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	909
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	910 @param timestamp(unicode, int): unix time
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	911 @return (bool): True if date is in the past
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	912 """
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	913 return time.time() > int(timestamp)
dec31114c402 template: improved date formatter: Goffi <goffi@goffi.org> parents: 2402 diff changeset	914
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	915 ## template methods ##
00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	916
00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	917 def _icon_defs(self, *names):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	918 """Define svg icons which will be used in the template.
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	919
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	920 Their name is used as id
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	921 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	922 svg_elt = etree.Element(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	923 "svg",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	924 nsmap={None: "http://www.w3.org/2000/svg"},
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	925 width="0",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	926 height="0",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	927 style="display: block",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	928 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	929 defs_elt = etree.SubElement(svg_elt, "defs")
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	930 for name in names:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	931 path = os.path.join(self.icons_path, name + ".svg")
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	932 icon_svg_elt = etree.parse(path).getroot()
00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	933 # we use icon name as id, so we can retrieve them easily
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	934 icon_svg_elt.set("id", name)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	935 if not icon_svg_elt.tag == "{http://www.w3.org/2000/svg}svg":
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	936 raise exceptions.DataError("invalid SVG element")
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	937 defs_elt.append(icon_svg_elt)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	938 return safe(etree.tostring(svg_elt, encoding="unicode"))
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	939
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	940 def _icon_use(self, name, cls=""):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	941 return safe('<svg class="svg-icon{cls}" xmlns="http://www.w3.org/2000/svg" '
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	942 'viewBox="0 0 100 100">\n'
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	943 ' <use href="#{name}"/>'
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	944 '</svg>\n'.format(name=name, cls=(" " + cls) if cls else ""))
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	945
3274 430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	946 def _icon_from_client(self, client):
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	947 """Get icon name to represent a disco client"""
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	948 if client is None:
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	949 return 'desktop'
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	950 elif 'pc' in client:
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	951 return 'desktop'
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	952 elif 'phone' in client:
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	953 return 'mobile'
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	954 elif 'web' in client:
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	955 return 'globe'
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	956 elif 'console' in client:
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	957 return 'terminal'
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	958 else:
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	959 return 'desktop'
430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	960
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	961 def render(self, template, site=None, theme=None, locale=C.DEFAULT_LOCALE,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	962 media_path="", css_files=None, css_inline=False, **kwargs):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	963 """Render a template
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	964
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	965 @param template(unicode): template to render (e.g. blog/articles.html)
3267 2eeca6fd08f7 tools (common/template): typos Goffi <goffi@goffi.org> parents: 3266 diff changeset	966 @param site(unicode): site name
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	967 None or empty string for defaut site (i.e. SàT templates)
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	968 @param theme(unicode): template theme
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	969 @param media_path(unicode): prefix of the SàT media path/URL to use for
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	970 template root. Must end with a u'/'
3267 2eeca6fd08f7 tools (common/template): typos Goffi <goffi@goffi.org> parents: 3266 diff changeset	971 @param css_files(list[unicode],None): CSS files to use
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	972 CSS files must be in static dir of the template
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	973 use None for automatic selection of CSS files based on template category
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	974 None is recommended. General static/style.css and theme file name will be
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	975 used.
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	976 @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	977 @param **kwargs: variable to transmit to the template
5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	978 """
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	979 if not template:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	980 raise ValueError("template can't be empty")
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	981 if site is not None or theme is not None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	982 # user wants to set site and/or theme, so we add it to the template path
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	983 if site is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	984 site = ''
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	985 if theme is None:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	986 theme = C.TEMPLATE_THEME_DEFAULT
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	987 if template[0] == "(":
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	988 raise ValueError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	989 "you can't specify site or theme in template path and in argument "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	990 "at the same time"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	991 )
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	992
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	993 template_data = TemplateData(site, theme, template)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	994 template = "({site}/{theme}){template}".format(
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	995 site=site, theme=theme, template=template)
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	996 else:
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	997 template_data = self.env.loader.parse_template(template)
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	998
2676 da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	999 # we need to save template_data in environment, to load right templates when they
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	1000 # are referenced from other templates (e.g. import)
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	1001 # FIXME: this trick will not work anymore if we use async templates (it works
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	1002 # here because we know that the rendering will be blocking until we unset
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	1003 # _template_data)
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	1004 self.env._template_data = template_data
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	1005
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	1006 template_source = self.env.get_template(template)
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	1007
f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	1008 if css_files is None:
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1009 css_files, css_files_noscript = self.getCSSFiles(template_data)
3747 dd1d1a582438 tools (common/template): fix setting of `css_files_noscript` when `css_file` is specified Goffi <goffi@goffi.org> parents: 3479 diff changeset	1010 else:
dd1d1a582438 tools (common/template): fix setting of `css_files_noscript` when `css_file` is specified Goffi <goffi@goffi.org> parents: 3479 diff changeset	1011 css_files_noscript = []
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	1012
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	1013 kwargs["icon_defs"] = self._icon_defs
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	1014 kwargs["icon"] = self._icon_use
3274 430204a3cc10 tools (common/template): new `icon_from_client` method: Goffi <goffi@goffi.org> parents: 3268 diff changeset	1015 kwargs["icon_from_client"] = self._icon_from_client
2515 00480cf83fa1 template: added icon handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1016
2159 5734b0994cf0 core (tools/common): template renderer first draft: Goffi <goffi@goffi.org> parents: diff changeset	1017 if css_inline:
2169 f472179305a1 tools(templates): workflow improvments: Goffi <goffi@goffi.org> parents: 2159 diff changeset	1018 css_contents = []
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	1019 for files, suffix in ((css_files, ""),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	1020 (css_files_noscript, "_noscript")):
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1021 site_root_dir = self.sites_paths[template_data.site]
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1022 for css_file in files:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1023 css_file_path = os.path.join(site_root_dir, css_file)
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1024 with open(css_file_path) as f:
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1025 css_contents.append(f.read())
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1026 if css_contents:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2952 diff changeset	1027 kwargs["css_content" + suffix] = "\n".join(css_contents)
2245 e09048cb7595 core (tools/common/template): helping methods/filters for templates: Goffi <goffi@goffi.org> parents: 2169 diff changeset	1028
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1029 scripts_handler = ScriptsHandler(self, template_data)
2249 e572482f6cbd core (tools/common/template): i18n support Goffi <goffi@goffi.org> parents: 2245 diff changeset	1030 self.setLocale(locale)
2676 da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	1031
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1032 # XXX: theme used in template arguments is the requested theme, which may differ
0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1033 # from actual theme if the template doesn't exist in the requested theme.
2676 da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	1034 rendered = template_source.render(
2671 0fa217fafabf tools (common/template), jp: refactoring to handle multiple sites: Goffi <goffi@goffi.org> parents: 2624 diff changeset	1035 template_data=template_data,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	1036 media_path=media_path,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	1037 css_files=css_files,
2680 ae5340b57ff8 template: fixed by variable used in css_files_noscript Goffi <goffi@goffi.org> parents: 2676 diff changeset	1038 css_files_noscript=css_files_noscript,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	1039 locale=self._locale,
2903 68a7543ebbb3 template: added "locales" variables to templates: Goffi <goffi@goffi.org> parents: 2877 diff changeset	1040 locales=self.locales,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	1041 gidx=Indexer(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	1042 script=scripts_handler,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	1043 **kwargs
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2599 diff changeset	1044 )
2676 da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	1045 self.env._template_data = None
da8f3ac86845 template: overriden get_template to always have full template name: Goffi <goffi@goffi.org> parents: 2675 diff changeset	1046 return rendered

Mercurial > libervia-backend

annotate sat/tools/common/template.py @ 3771:e597dbfbc4c6