1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-27 10:18:30 +00:00
forgejo/modules/templates
wxiaoguang 722dab5286
Make HTML template functions support context ()
# Background

Golang template is not friendly for large projects, and Golang template
team is quite slow, related:
* `https://github.com/golang/go/issues/54450`

Without upstream support, we can also have our solution to make HTML
template functions support context.

It helps a lot, the above Golang template issue `#54450` explains a lot:

1. It makes `{{Locale.Tr}}` could be used in any template, without
passing unclear `(dict "root" . )` anymore.
2. More and more functions need `context`, like `avatar`, etc, we do not
need to do `(dict "Context" $.Context)` anymore.
3. Many request-related functions could be shared by parent&children
templates, like "user setting" / "system setting"

See the test `TestScopedTemplateSetFuncMap`, one template set, two
`Execute` calls with different `CtxFunc`.

# The Solution

Instead of waiting for upstream, this PR re-uses the escaped HTML
template trees, use `AddParseTree` to add related templates/trees to a
new template instance, then the new template instance can have its own
FuncMap , the function calls in the template trees will always use the
new template's FuncMap.

`template.New` / `template.AddParseTree` / `adding-FuncMap` are all
quite fast, so the performance is not affected.

The details:

1. Make a new `html/template/Template` for `all` templates
2. Add template code to the `all` template
3. Freeze the `all` template, reset its exec func map, it shouldn't
execute any template.
4. When a router wants to render a template by its `name`
    1. Find the `name` in `all`
    2. Find all its related sub templates
3. Escape all related templates (just like what the html template
package does)
4. Add the escaped parse-trees of related templates into a new (scoped)
`text/template/Template`
    5. Add context-related func map into the new (scoped) text template
    6. Execute the new (scoped) text template
7. To improve performance, the escaped templates are cached to `template
sets`

# FAQ

## There is a `unsafe` call, is this PR unsafe?

This PR is safe. Golang has strict language definition, it's safe to do
so: https://pkg.go.dev/unsafe#Pointer (1) Conversion of a *T1 to Pointer
to *T2


## What if Golang template supports such feature in the future?

The public structs/interfaces/functions introduced by this PR is quite
simple, the code of `HTMLRender` is not changed too much. It's very easy
to switch to the official mechanism if there would be one.

## Does this PR change the template execution behavior?

No, see the tests (welcome to design more tests if it's necessary)

---------

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: Jason Song <i@wolfogre.com>
Co-authored-by: Giteabot <teabot@gitea.io>
2023-04-20 04:08:58 -04:00
..
eval Use a general Eval function for expressions in templates. () 2023-04-07 21:25:49 +08:00
scopedtmpl Make HTML template functions support context () 2023-04-20 04:08:58 -04:00
vars Implement FSFE REUSE for golang files () 2022-11-27 18:20:29 +00:00
base.go Use a general approach to access custom/static/builtin assets () 2023-04-12 18:16:45 +08:00
dynamic.go Use a general approach to access custom/static/builtin assets () 2023-04-12 18:16:45 +08:00
helper.go Improve Wiki TOC () 2023-04-17 15:05:19 -04:00
helper_test.go Implement FSFE REUSE for golang files () 2022-11-27 18:20:29 +00:00
htmlrenderer.go Make HTML template functions support context () 2023-04-20 04:08:58 -04:00
htmlrenderer_test.go Show friendly 500 error page to users and developers () 2023-04-14 13:19:11 +08:00
mailer.go Use a general approach to access custom/static/builtin assets () 2023-04-12 18:16:45 +08:00
static.go Use a general approach to access custom/static/builtin assets () 2023-04-12 18:16:45 +08:00
templates_bindata.go Implement FSFE REUSE for golang files () 2022-11-27 18:20:29 +00:00
util.go Merge template functions "dict/Dict/mergeinto" () 2023-04-07 09:39:08 -05:00
util_test.go Merge template functions "dict/Dict/mergeinto" () 2023-04-07 09:39:08 -05:00