/
service.go
503 lines (406 loc) · 11.2 KB
/
service.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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
package locale
import (
"context"
"fmt"
"io"
"os"
"strings"
"sync"
"github.com/cortezaproject/corteza/server/pkg/options"
"go.uber.org/zap"
"golang.org/x/text/language"
"golang.org/x/text/language/display"
)
type (
resourceStore interface {
TransformResource(context.Context, language.Tag) (map[string]map[string]*ResourceTranslation, error)
}
Locale interface {
T(ctx context.Context, ns, key string, rr ...string) string
TFor(tag language.Tag, ns, key string, rr ...string) string
Tags() []language.Tag
}
Resource interface {
TResource(ctx context.Context, ns, key string, rr ...string) string
TResourceFor(tag language.Tag, ns, key string, rr ...string) string
Tags() []language.Tag
SupportedLang(language.Tag) bool
ResourceTranslations(code language.Tag, resource string) ResourceTranslationIndex
Default() *Language
}
service struct {
l sync.RWMutex
s resourceStore
// logger facility for the locale service
log *zap.Logger
// options
opt options.LocaleOpt
// configured sources where we can load languages from
src []string
// all configured tags
tags []language.Tag
// set of all known languages
set map[language.Tag]*Language
// default language
def *Language
}
)
var (
// Global locales service
global *service
)
// Global returns global RBAC service
func Global() *service {
return global
}
// SetGlobal re-sets global service
func SetGlobal(ll *service) {
global = ll
}
func Static(ll ...*Language) (svc *service) {
svc = &service{
log: zap.NewNop(),
set: make(map[language.Tag]*Language),
}
for _, l := range ll {
svc.set[l.Tag] = l
svc.tags = append(svc.tags, l.Tag)
}
return svc
}
func Service(log *zap.Logger, opt options.LocaleOpt) (*service, error) {
svc := &service{
opt: opt,
src: strings.Split(opt.Path, ":"),
log: log.Named("locale"),
}
for _, lang := range strings.Split(opt.Languages, ",") {
lang = strings.TrimSpace(lang)
tag := language.Make(lang)
if tag.IsRoot() {
return nil, fmt.Errorf("failed to parse language '%s' (did you use comma to separate them?)", lang)
}
svc.tags = append(svc.tags, tag)
}
return svc, svc.ReloadStatic()
}
func (svc *service) BindStore(s resourceStore) {
svc.s = s
}
// Default language
func (svc *service) Default() *Language {
return svc.def
}
// Tags of all loaded languages
func (svc *service) Tags() (tt []language.Tag) {
svc.l.RLock()
defer svc.l.RUnlock()
return svc.tags
}
func (svc *service) SupportedLang(tag language.Tag) bool {
return svc.set[tag] != nil
}
// ReloadStatic all language configurations (as configured via path options) and
// all translation files
func (svc *service) ReloadStatic() (err error) {
var (
ll, aux []*Language
logFields = make([]zap.Field, 0)
)
svc.l.Lock()
defer svc.l.Unlock()
if len(svc.tags) == 0 {
return fmt.Errorf("no supported languages (LOCALE_LANGUAGES is empty)")
}
svc.log.Info("reloading static",
zap.Strings("path", svc.src),
zap.Strings("tags", tagsToStrings(svc.tags)),
)
// In case where this is already initialized, we need to make sure to
// preserve any resource translations.
// The preservation is handled below, before we update svc.set.
if svc.set == nil {
svc.set = make(map[language.Tag]*Language)
}
// load embedded locales from the corteza-locale package
if ll, err = loadConfigs(LoadEmbedded()); err != nil {
return fmt.Errorf("could not load embedded locales: %w", err)
} else {
// cleanup src and effectively mark the
// loaded languages as embedded
for _, l := range ll {
l.src = ""
}
}
// load imported locales from the configured (LOCALE_PATH) paths
for _, p := range svc.src {
aux, err = loadConfigs(os.DirFS(p))
if err != nil {
return fmt.Errorf("could not load imported locales: %w", err)
}
if len(aux) == 0 {
svc.log.Warn(
"no languages found in path, future versions of Corteza will require at least one language to be present",
zap.String("path", p),
)
}
for _, l := range aux {
l.src = p + "/" + l.src
}
ll = append(ll, aux...)
}
for _, lang := range ll {
logFields = []zap.Field{
zap.Stringer("tag", lang.Tag),
}
if !hasTag(lang.Tag, svc.tags) {
svc.log.Debug(
"language skipped (not in LOCALE_LANGUAGES)",
zap.Stringer("tag", lang.Tag),
)
continue
}
if !lang.Extends.IsRoot() {
logFields = append(logFields, zap.Stringer("extends", lang.Extends))
}
if lang.src != "" {
logFields = append(logFields, zap.String("imported", lang.src))
} else {
logFields = append(logFields, zap.Bool("embedded", true))
}
if err = loadTranslations(lang); err != nil {
return err
}
if svc.set[lang.Tag] != nil {
svc.log.Info(
"language overloaded",
logFields...,
)
} else {
svc.log.Info(
"language loaded",
logFields...,
)
}
// Preserve current resource translations.
// Resource translations are updated when they change so these are
// already up to date.
if existing, ok := svc.set[lang.Tag]; ok {
lang.resources = existing.resources
}
svc.set[lang.Tag] = lang
}
svc.log.Debug("languages loaded",
zap.Strings("path", svc.src),
zap.Int("count", len(svc.set)),
)
// Do another pass and link all extended languages
for _, lang := range svc.set {
if lang.Extends.IsRoot() {
continue
}
if svc.set[lang.Extends] == nil {
return fmt.Errorf("could not extend langage %q from an unknown language %q", lang.Tag, lang.Extends)
}
lang.extends = svc.set[lang.Extends]
}
if svc.def == nil {
first := svc.tags[0]
if svc.set[first] == nil {
return fmt.Errorf("could not find %s in loaded languages", first)
}
svc.def = svc.set[first]
}
return nil
}
// ReloadResourceTranslations all language configurations (as configured via path options) and
// all translation files
func (svc *service) ReloadResourceTranslations(ctx context.Context) (err error) {
if svc.s == nil {
return fmt.Errorf("store for locale service not set")
}
svc.l.RLock()
defer svc.l.RUnlock()
svc.log.Info("reloading resource translations",
zap.Strings("tags", tagsToStrings(svc.tags)),
)
for _, tag := range svc.tags {
lang, ok := svc.set[tag]
if !ok {
lang = &Language{
Tag: tag,
// @todo find a better name for this, because it's not the
// language that it's loaded from the store, the resource translations are
src: "store",
}
svc.set[tag] = lang
}
if lang.resources, err = svc.LoadResourceTranslations(ctx, lang.Tag); err != nil {
return err
}
svc.log.Info(
"resource translations loaded",
zap.Stringer("tag", lang.Tag),
zap.String("src", lang.src),
zap.Int("translations", len(lang.resources)),
)
}
return nil
}
// List returns list of all languages
func (svc *service) List() []*Language {
svc.l.RLock()
defer svc.l.RUnlock()
ll := make([]*Language, 0, len(svc.set))
for _, tag := range svc.tags {
if svc.set[tag] != nil {
ll = append(ll, svc.set[tag])
}
}
return ll
}
// List localized list of all languages
func (svc *service) LocalizedList(ctx context.Context) []*Language {
svc.l.RLock()
defer svc.l.RUnlock()
var (
l *Language
ll = make([]*Language, 0, len(svc.set))
reqLang = GetAcceptLanguageFromContext(ctx)
)
for _, tag := range svc.tags {
l = svc.set[tag]
if l == nil {
continue
}
l = &Language{
Tag: l.Tag,
Name: l.Name,
}
if nl := display.Languages(reqLang); nl != nil {
l.LocalizedName = nl.Name(l.Tag)
}
if l.Name == "" {
if nl := display.Languages(l.Tag); nl != nil {
// for cases when language name is not configured
l.Name = nl.Name(l.Tag)
}
}
ll = append(ll, l)
}
return ll
}
func (svc *service) HasLanguage(lang language.Tag) bool {
return svc.set[lang] != nil
}
func (svc *service) HasApplication(lang language.Tag, app string) bool {
return svc.set[lang] != nil && svc.set[lang].external[app] != nil
}
// EncodeExternal writes into
func (svc *service) EncodeExternal(w io.Writer, app string, ll ...language.Tag) (err error) {
svc.l.RLock()
defer svc.l.RUnlock()
_, _ = fmt.Fprint(w, "{")
for i, lang := range ll {
if i > 0 {
_, _ = fmt.Fprint(w, ",")
}
_, _ = fmt.Fprintf(w, "%q:", lang)
if svc.HasApplication(lang, app) {
svc.set[lang].external[app].Seek(0, 0)
_, _ = io.Copy(w, svc.set[lang].external[app])
} else {
_, _ = fmt.Fprint(w, "null")
}
}
_, _ = fmt.Fprint(w, "}")
return err
}
// NS returns translator function for the current language (from context) and a specific namespace
//
// Language is picked from the context
func (svc *service) NS(ctx context.Context, ns string) func(key string, rr ...string) string {
var (
tag = GetAcceptLanguageFromContext(ctx)
)
return func(key string, rr ...string) string {
return svc.t(tag, ns, key, rr...)
}
}
// T returns translated key from namespaces using list of replacement pairs
//
// Language is picked from the context
func (svc *service) T(ctx context.Context, ns, key string, rr ...string) string {
return svc.t(GetAcceptLanguageFromContext(ctx), ns, key, rr...)
}
// T returns translated key from namespaces using list of replacement pairs
//
// Language is specified
func (svc *service) TFor(tag language.Tag, ns, key string, rr ...string) string {
return svc.t(tag, ns, key, rr...)
}
// TResource returns translated key for resource using list of replacement pairs
//
// Language is picked from the context
func (svc *service) TResource(ctx context.Context, ns, key string, rr ...string) string {
return svc.tResource(GetAcceptLanguageFromContext(ctx), ns, key, rr...)
}
// TResourceFor returns translated key for resource using list of replacement pairs
//
// Language is picked from the context
func (svc *service) TResourceFor(tag language.Tag, ns, key string, rr ...string) string {
return svc.tResource(tag, ns, key, rr...)
}
// ResourceTranslations returns all translations for the given language for the
// given resource.
//
// The response is indexed by translation key for nicer lookups.
func (svc *service) ResourceTranslations(tag language.Tag, resource string) ResourceTranslationIndex {
out := make(ResourceTranslationIndex)
svc.l.Lock()
defer svc.l.Unlock()
if svc != nil && svc.set != nil {
if l, has := svc.set[tag]; has {
return l.resourceTranslations(resource)
}
}
return out
}
// Finds language and uses it to translate the given key
func (svc *service) t(tag language.Tag, ns, key string, rr ...string) string {
if svc != nil && svc.set != nil {
if l, has := svc.set[tag]; has {
return l.t(ns, key, rr...)
}
}
// In case of a missing language, translation
// key is returned
return key
}
// Finds language and uses it to translate the given key for resource
func (svc *service) tResource(tag language.Tag, ns, key string, rr ...string) string {
if svc != nil && svc.set != nil {
if l, has := svc.set[tag]; has {
return l.tResource(ns, key, rr...)
}
}
// In case of a missing language, only empty string is
// returned (in contrast to static translations
// where a string with key is returned)
return ""
}
func hasTag(t language.Tag, tt []language.Tag) bool {
for _, tag := range tt {
if tag.String() == t.String() {
return true
}
}
return false
}
func tagsToStrings(tt []language.Tag) []string {
out := make([]string, len(tt))
for t := range tt {
out[t] = tt[t].String()
}
return out
}