/
resource.go
375 lines (321 loc) · 10 KB
/
resource.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
package template
import (
"context"
"errors"
"fmt"
htmltemplate "html/template"
"os"
"path"
"regexp"
texttemplate "text/template"
"github.com/authgear/authgear-server/pkg/util/intl"
"github.com/authgear/authgear-server/pkg/util/intlresource"
"github.com/authgear/authgear-server/pkg/util/resource"
)
type Resource interface {
templateResource()
}
// HTML defines a HTML template
type HTML struct {
// Name is the name of template
Name string
// ComponentDependencies is the HTML component templates this template depends on.
ComponentDependencies []*HTML
// IsFindAllowedInFs returns an boolean indicating if the Fs can be used to find this resources
// For example, if you don't want a html inside the app fs to be used, it should return false.
IsFindAllowedInFs FindResourcesFsFilter
}
var _ resource.Descriptor = &HTML{}
func (t *HTML) templateResource() {}
func (t *HTML) MatchResource(path string) (*resource.Match, bool) {
return matchTemplatePath(path, t.Name)
}
func (t *HTML) FindResources(fs resource.Fs) ([]resource.Location, error) {
if t.IsFindAllowedInFs != nil {
allowed := t.IsFindAllowedInFs(fs)
if !allowed {
return []resource.Location{}, nil
}
}
return readTemplates(fs, t.Name)
}
func (t *HTML) ViewResources(resources []resource.ResourceFile, view resource.View) (interface{}, error) {
return viewHTMLTemplates(t.Name, resources, view)
}
func (t *HTML) UpdateResource(_ context.Context, _ []resource.ResourceFile, resrc *resource.ResourceFile, data []byte) (*resource.ResourceFile, error) {
return &resource.ResourceFile{
Location: resrc.Location,
Data: data,
}, nil
}
// PlainText defines a plain text template
type PlainText struct {
// Name is the name of template
Name string
// ComponentDependencies is the plain text component templates this template depends on.
ComponentDependencies []*PlainText
}
var _ resource.Descriptor = &PlainText{}
func (t *PlainText) templateResource() {}
func (t *PlainText) MatchResource(path string) (*resource.Match, bool) {
return matchTemplatePath(path, t.Name)
}
func (t *PlainText) FindResources(fs resource.Fs) ([]resource.Location, error) {
return readTemplates(fs, t.Name)
}
func (t *PlainText) ViewResources(resources []resource.ResourceFile, view resource.View) (interface{}, error) {
return viewTextTemplates(t.Name, resources, view)
}
func (t *PlainText) UpdateResource(_ context.Context, _ []resource.ResourceFile, resrc *resource.ResourceFile, data []byte) (*resource.ResourceFile, error) {
return &resource.ResourceFile{
Location: resrc.Location,
Data: data,
}, nil
}
func registerHTML(name string, dependencies []*HTML, isFindAllowedInFs FindResourcesFsFilter) *HTML {
desc := &HTML{Name: name, ComponentDependencies: dependencies, IsFindAllowedInFs: isFindAllowedInFs}
resource.RegisterResource(desc)
return desc
}
func RegisterHTML(name string, dependencies ...*HTML) *HTML {
return registerHTML(name, dependencies, ExcludeAppFs)
}
func RegisterAppOverridableHTML(name string, dependencies ...*HTML) *HTML {
return registerHTML(name, dependencies, AnyFs)
}
func RegisterPlainText(name string, dependencies ...*PlainText) *PlainText {
desc := &PlainText{Name: name, ComponentDependencies: dependencies}
resource.RegisterResource(desc)
return desc
}
func matchTemplatePath(path string, templateName string) (*resource.Match, bool) {
r := fmt.Sprintf("^templates/([a-zA-Z0-9-]+)/%s$", regexp.QuoteMeta(templateName))
matches := regexp.MustCompile(r).FindStringSubmatch(path)
if len(matches) != 2 {
return nil, false
}
languageTag := matches[1]
isLanguageTagValid := false
for _, localeKey := range intl.AvailableLanguages {
if languageTag == localeKey {
isLanguageTagValid = true
break
}
}
if !isLanguageTagValid {
return nil, false
}
return &resource.Match{LanguageTag: languageTag}, true
}
func readTemplates(fs resource.Fs, templateName string) ([]resource.Location, error) {
templatesDir, err := fs.Open("templates")
if os.IsNotExist(err) {
return nil, nil
} else if err != nil {
return nil, err
}
defer templatesDir.Close()
langTagDirs, err := templatesDir.Readdirnames(0)
if err != nil {
return nil, err
}
var locations []resource.Location
for _, langTag := range langTagDirs {
p := path.Join("templates", langTag, templateName)
location := resource.Location{
Fs: fs,
Path: p,
}
_, err := resource.ReadLocation(location)
if os.IsNotExist(err) {
continue
} else if err != nil {
return nil, err
}
locations = append(locations, location)
}
return locations, nil
}
type languageTemplate struct {
languageTag string
data []byte
}
func (t languageTemplate) GetLanguageTag() string {
return t.languageTag
}
var templateLanguageTagRegex = regexp.MustCompile("^templates/([a-zA-Z0-9-_]+)/")
func viewTemplates(resources []resource.ResourceFile, rawView resource.View) (interface{}, error) {
switch view := rawView.(type) {
case resource.AppFileView:
return viewTemplatesAppFile(resources, view)
case resource.EffectiveFileView:
return viewTemplatesEffectiveFile(resources, view)
case resource.EffectiveResourceView:
return viewTemplatesEffectiveResource(resources, view)
default:
return nil, fmt.Errorf("unsupported view: %T", rawView)
}
}
func viewTemplatesAppFile(resources []resource.ResourceFile, view resource.AppFileView) (interface{}, error) {
// When template is viewed as AppFile,
// the exact file is returned.
path := view.AppFilePath()
var found bool
var bytes []byte
for _, resrc := range resources {
if resrc.Location.Fs.GetFsLevel() == resource.FsLevelApp && resrc.Location.Path == path {
found = true
bytes = resrc.Data
}
}
if !found {
return nil, resource.ErrResourceNotFound
}
return bytes, nil
}
func viewTemplatesEffectiveFile(resources []resource.ResourceFile, view resource.EffectiveFileView) (interface{}, error) {
// When template is viewed as EffectiveFile, the most specific template is returned.
path := view.EffectiveFilePath()
// Compute requestedLangTag
matches := templateLanguageTagRegex.FindStringSubmatch(path)
if len(matches) < 2 {
return nil, resource.ErrResourceNotFound
}
requestedLangTag := matches[1]
var found bool
var bytes []byte
for _, resrc := range resources {
langTag := templateLanguageTagRegex.FindStringSubmatch(resrc.Location.Path)[1]
if langTag == requestedLangTag {
found = true
bytes = resrc.Data
}
}
if !found {
return nil, resource.ErrResourceNotFound
}
return bytes, nil
}
func viewTemplatesEffectiveResource(resources []resource.ResourceFile, view resource.EffectiveResourceView) (interface{}, error) {
preferredLanguageTags := view.PreferredLanguageTags()
defaultLanguageTag := view.DefaultLanguageTag()
languageTemplates := make(map[string]languageTemplate)
add := func(langTag string, resrc resource.ResourceFile) error {
t := languageTemplate{
languageTag: langTag,
data: resrc.Data,
}
languageTemplates[langTag] = t
return nil
}
extractLanguageTag := func(resrc resource.ResourceFile) string {
langTag := templateLanguageTagRegex.FindStringSubmatch(resrc.Location.Path)[1]
return langTag
}
err := intlresource.Prepare(resources, view, extractLanguageTag, add)
if err != nil {
return nil, err
}
var items []intlresource.LanguageItem
for _, i := range languageTemplates {
items = append(items, i)
}
matched, err := intlresource.Match(preferredLanguageTags, defaultLanguageTag, items)
if errors.Is(err, intlresource.ErrNoLanguageMatch) {
if len(items) > 0 {
// Use first item in case of no match, to ensure resolution always succeed
matched = items[0]
} else {
// If no configured translation for a template, fail the resolution process
return nil, ErrNotFound
}
} else if err != nil {
return nil, err
}
tagger := matched.(languageTemplate)
return tagger.data, nil
}
func viewHTMLTemplates(name string, resources []resource.ResourceFile, view resource.View) (interface{}, error) {
switch view.(type) {
case resource.AppFileView:
bytes, err := viewTemplates(resources, view)
if err != nil {
return nil, err
}
return bytes, nil
case resource.EffectiveFileView:
bytes, err := viewTemplates(resources, view)
if err != nil {
return nil, err
}
return bytes, nil
case resource.EffectiveResourceView:
bytes, err := viewTemplates(resources, view)
if err != nil {
return nil, err
}
tpl := htmltemplate.New(name)
funcMap := MakeTemplateFuncMap(tpl)
tpl.Funcs(funcMap)
_, err = tpl.Parse(string(bytes.([]byte)))
if err != nil {
return nil, fmt.Errorf("invalid HTML template: %w", err)
}
return tpl, nil
case resource.ValidateResourceView:
for _, resrc := range resources {
tpl := htmltemplate.New(name)
funcMap := MakeTemplateFuncMap(tpl)
tpl.Funcs(funcMap)
_, err := tpl.Parse(string(resrc.Data))
if err != nil {
return nil, fmt.Errorf("invalid HTML template: %w", err)
}
}
return nil, nil
default:
return nil, fmt.Errorf("unsupported view: %T", view)
}
}
func viewTextTemplates(name string, resources []resource.ResourceFile, view resource.View) (interface{}, error) {
switch view.(type) {
case resource.AppFileView:
bytes, err := viewTemplates(resources, view)
if err != nil {
return nil, err
}
return bytes, nil
case resource.EffectiveFileView:
bytes, err := viewTemplates(resources, view)
if err != nil {
return nil, err
}
return bytes, nil
case resource.EffectiveResourceView:
bytes, err := viewTemplates(resources, view)
if err != nil {
return nil, err
}
tpl := texttemplate.New(name)
funcMap := MakeTemplateFuncMap(tpl)
tpl.Funcs(funcMap)
_, err = tpl.Parse(string(bytes.([]byte)))
if err != nil {
return nil, fmt.Errorf("invalid text template: %w", err)
}
return tpl, nil
case resource.ValidateResourceView:
for _, resrc := range resources {
tpl := texttemplate.New(name)
funcMap := MakeTemplateFuncMap(tpl)
tpl.Funcs(funcMap)
_, err := tpl.Parse(string(resrc.Data))
if err != nil {
return nil, fmt.Errorf("invalid text template: %w", err)
}
}
return nil, nil
default:
return nil, fmt.Errorf("unsupported view: %T", view)
}
}