mirror of
https://github.com/go-gitea/gitea
synced 2025-07-22 18:28:37 +00:00
Share HTML template renderers and create a watcher framework (#20218)
The recovery, API, Web and package frameworks all create their own HTML Renderers. This increases the memory requirements of Gitea unnecessarily with duplicate templates being kept in memory. Further the reloading framework in dev mode for these involves locking and recompiling all of the templates on each load. This will potentially hide concurrency issues and it is inefficient. This PR stores the templates renderer in the context and stores this context in the NormalRoutes, it then creates a fsnotify.Watcher framework to watch files. The watching framework is then extended to the mailer templates which were previously not being reloaded in dev. Then the locales are simplified to a similar structure. Fix #20210 Fix #20211 Fix #20217 Signed-off-by: Andrew Thornton <art27@cantab.net>
This commit is contained in:
zeripath
GitHub
12
modules/translation/i18n/errors.go
Normal file
12
modules/translation/i18n/errors.go
Normal file
@@ -0,0 +1,12 @@
|
||||
// Copyright 2022 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package i18n
|
||||
|
||||
import "errors"
|
||||
|
||||
var (
|
||||
ErrLocaleAlreadyExist = errors.New("lang already exists")
|
||||
ErrUncertainArguments = errors.New("arguments to i18n should not contain uncertain slices")
|
||||
)
|
||||
42
modules/translation/i18n/format.go
Normal file
42
modules/translation/i18n/format.go
Normal file
@@ -0,0 +1,42 @@
|
||||
// Copyright 2022 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package i18n
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"reflect"
|
||||
)
|
||||
|
||||
// Format formats provided arguments for a given translated message
|
||||
func Format(format string, args ...interface{}) (msg string, err error) {
|
||||
if len(args) == 0 {
|
||||
return format, nil
|
||||
}
|
||||
|
||||
fmtArgs := make([]interface{}, 0, len(args))
|
||||
for _, arg := range args {
|
||||
val := reflect.ValueOf(arg)
|
||||
if val.Kind() == reflect.Slice {
|
||||
// Previously, we would accept Tr(lang, key, a, [b, c], d, [e, f]) as Sprintf(msg, a, b, c, d, e, f)
|
||||
// but this is an unstable behavior.
|
||||
//
|
||||
// So we restrict the accepted arguments to either:
|
||||
//
|
||||
// 1. Tr(lang, key, [slice-items]) as Sprintf(msg, items...)
|
||||
// 2. Tr(lang, key, args...) as Sprintf(msg, args...)
|
||||
if len(args) == 1 {
|
||||
for i := 0; i < val.Len(); i++ {
|
||||
fmtArgs = append(fmtArgs, val.Index(i).Interface())
|
||||
}
|
||||
} else {
|
||||
err = ErrUncertainArguments
|
||||
break
|
||||
}
|
||||
} else {
|
||||
fmtArgs = append(fmtArgs, arg)
|
||||
}
|
||||
}
|
||||
return fmt.Sprintf(format, fmtArgs...), err
|
||||
}
|
||||
@@ -5,297 +5,48 @@
|
||||
package i18n
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"reflect"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"code.gitea.io/gitea/modules/log"
|
||||
"code.gitea.io/gitea/modules/setting"
|
||||
|
||||
"gopkg.in/ini.v1"
|
||||
"io"
|
||||
)
|
||||
|
||||
var (
|
||||
ErrLocaleAlreadyExist = errors.New("lang already exists")
|
||||
var DefaultLocales = NewLocaleStore()
|
||||
|
||||
DefaultLocales = NewLocaleStore(true)
|
||||
)
|
||||
|
||||
type locale struct {
|
||||
// This mutex will be set if we have live-reload enabled (e.g. dev mode)
|
||||
reloadMu *sync.RWMutex
|
||||
|
||||
store *LocaleStore
|
||||
langName string
|
||||
|
||||
idxToMsgMap map[int]string // the map idx is generated by store's trKeyToIdxMap
|
||||
|
||||
sourceFileName string
|
||||
sourceFileInfo os.FileInfo
|
||||
lastReloadCheckTime time.Time
|
||||
type Locale interface {
|
||||
// Tr translates a given key and arguments for a language
|
||||
Tr(trKey string, trArgs ...interface{}) string
|
||||
// Has reports if a locale has a translation for a given key
|
||||
Has(trKey string) bool
|
||||
}
|
||||
|
||||
type LocaleStore struct {
|
||||
// This mutex will be set if we have live-reload enabled (e.g. dev mode)
|
||||
reloadMu *sync.RWMutex
|
||||
// LocaleStore provides the functions common to all locale stores
|
||||
type LocaleStore interface {
|
||||
io.Closer
|
||||
|
||||
langNames []string
|
||||
langDescs []string
|
||||
localeMap map[string]*locale
|
||||
|
||||
// this needs to be locked when live-reloading
|
||||
trKeyToIdxMap map[string]int
|
||||
|
||||
defaultLang string
|
||||
}
|
||||
|
||||
func NewLocaleStore(isProd bool) *LocaleStore {
|
||||
store := &LocaleStore{localeMap: make(map[string]*locale), trKeyToIdxMap: make(map[string]int)}
|
||||
if !isProd {
|
||||
store.reloadMu = &sync.RWMutex{}
|
||||
}
|
||||
return store
|
||||
}
|
||||
|
||||
// AddLocaleByIni adds locale by ini into the store
|
||||
// if source is a string, then the file is loaded. In dev mode, this file will be checked for live-reloading
|
||||
// if source is a []byte, then the content is used
|
||||
// Note: this is not concurrent safe
|
||||
func (store *LocaleStore) AddLocaleByIni(langName, langDesc string, source interface{}) error {
|
||||
if _, ok := store.localeMap[langName]; ok {
|
||||
return ErrLocaleAlreadyExist
|
||||
}
|
||||
|
||||
l := &locale{store: store, langName: langName}
|
||||
if store.reloadMu != nil {
|
||||
l.reloadMu = &sync.RWMutex{}
|
||||
l.reloadMu.Lock() // Arguably this is not necessary as AddLocaleByIni isn't concurrent safe - but for consistency we do this
|
||||
defer l.reloadMu.Unlock()
|
||||
}
|
||||
|
||||
if fileName, ok := source.(string); ok {
|
||||
l.sourceFileName = fileName
|
||||
l.sourceFileInfo, _ = os.Stat(fileName) // live-reload only works for regular files. the error can be ignored
|
||||
}
|
||||
|
||||
var err error
|
||||
l.idxToMsgMap, err = store.readIniToIdxToMsgMap(source)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
store.langNames = append(store.langNames, langName)
|
||||
store.langDescs = append(store.langDescs, langDesc)
|
||||
|
||||
store.localeMap[l.langName] = l
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// readIniToIdxToMsgMap will read a provided ini and creates an idxToMsgMap
|
||||
func (store *LocaleStore) readIniToIdxToMsgMap(source interface{}) (map[int]string, error) {
|
||||
iniFile, err := ini.LoadSources(ini.LoadOptions{
|
||||
IgnoreInlineComment: true,
|
||||
UnescapeValueCommentSymbols: true,
|
||||
}, source)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to load ini: %w", err)
|
||||
}
|
||||
iniFile.BlockMode = false
|
||||
|
||||
idxToMsgMap := make(map[int]string)
|
||||
|
||||
if store.reloadMu != nil {
|
||||
store.reloadMu.Lock()
|
||||
defer store.reloadMu.Unlock()
|
||||
}
|
||||
|
||||
for _, section := range iniFile.Sections() {
|
||||
for _, key := range section.Keys() {
|
||||
|
||||
var trKey string
|
||||
if section.Name() == "" || section.Name() == "DEFAULT" {
|
||||
trKey = key.Name()
|
||||
} else {
|
||||
trKey = section.Name() + "." + key.Name()
|
||||
}
|
||||
|
||||
// Instead of storing the key strings in multiple different maps we compute a idx which will act as numeric code for key
|
||||
// This reduces the size of the locale idxToMsgMaps
|
||||
idx, ok := store.trKeyToIdxMap[trKey]
|
||||
if !ok {
|
||||
idx = len(store.trKeyToIdxMap)
|
||||
store.trKeyToIdxMap[trKey] = idx
|
||||
}
|
||||
idxToMsgMap[idx] = key.Value()
|
||||
}
|
||||
}
|
||||
iniFile = nil
|
||||
return idxToMsgMap, nil
|
||||
}
|
||||
|
||||
func (store *LocaleStore) idxForTrKey(trKey string) (int, bool) {
|
||||
if store.reloadMu != nil {
|
||||
store.reloadMu.RLock()
|
||||
defer store.reloadMu.RUnlock()
|
||||
}
|
||||
idx, ok := store.trKeyToIdxMap[trKey]
|
||||
return idx, ok
|
||||
}
|
||||
|
||||
// HasLang reports if a language is available in the store
|
||||
func (store *LocaleStore) HasLang(langName string) bool {
|
||||
_, ok := store.localeMap[langName]
|
||||
return ok
|
||||
}
|
||||
|
||||
// ListLangNameDesc reports if a language available in the store
|
||||
func (store *LocaleStore) ListLangNameDesc() (names, desc []string) {
|
||||
return store.langNames, store.langDescs
|
||||
}
|
||||
|
||||
// SetDefaultLang sets default language as a fallback
|
||||
func (store *LocaleStore) SetDefaultLang(lang string) {
|
||||
store.defaultLang = lang
|
||||
}
|
||||
|
||||
// Tr translates content to target language. fall back to default language.
|
||||
func (store *LocaleStore) Tr(lang, trKey string, trArgs ...interface{}) string {
|
||||
l, ok := store.localeMap[lang]
|
||||
if !ok {
|
||||
l, ok = store.localeMap[store.defaultLang]
|
||||
}
|
||||
|
||||
if ok {
|
||||
return l.Tr(trKey, trArgs...)
|
||||
}
|
||||
return trKey
|
||||
}
|
||||
|
||||
// reloadIfNeeded will check if the locale needs to be reloaded
|
||||
// this function will assume that the l.reloadMu has been RLocked if it already exists
|
||||
func (l *locale) reloadIfNeeded() {
|
||||
if l.reloadMu == nil {
|
||||
return
|
||||
}
|
||||
|
||||
now := time.Now()
|
||||
if now.Sub(l.lastReloadCheckTime) < time.Second || l.sourceFileInfo == nil || l.sourceFileName == "" {
|
||||
return
|
||||
}
|
||||
|
||||
l.reloadMu.RUnlock()
|
||||
l.reloadMu.Lock() // (NOTE: a pre-emption can occur between these two locks so we need to recheck)
|
||||
defer l.reloadMu.RLock()
|
||||
defer l.reloadMu.Unlock()
|
||||
|
||||
if now.Sub(l.lastReloadCheckTime) < time.Second || l.sourceFileInfo == nil || l.sourceFileName == "" {
|
||||
return
|
||||
}
|
||||
|
||||
l.lastReloadCheckTime = now
|
||||
sourceFileInfo, err := os.Stat(l.sourceFileName)
|
||||
if err != nil || sourceFileInfo.ModTime().Equal(l.sourceFileInfo.ModTime()) {
|
||||
return
|
||||
}
|
||||
|
||||
idxToMsgMap, err := l.store.readIniToIdxToMsgMap(l.sourceFileName)
|
||||
if err == nil {
|
||||
l.idxToMsgMap = idxToMsgMap
|
||||
} else {
|
||||
log.Error("Unable to live-reload the locale file %q, err: %v", l.sourceFileName, err)
|
||||
}
|
||||
|
||||
// We will set the sourceFileInfo to this file to prevent repeated attempts to re-load this broken file
|
||||
l.sourceFileInfo = sourceFileInfo
|
||||
}
|
||||
|
||||
// Tr translates content to locale language. fall back to default language.
|
||||
func (l *locale) Tr(trKey string, trArgs ...interface{}) string {
|
||||
if l.reloadMu != nil {
|
||||
l.reloadMu.RLock()
|
||||
defer l.reloadMu.RUnlock()
|
||||
l.reloadIfNeeded()
|
||||
}
|
||||
|
||||
msg, _ := l.tryTr(trKey, trArgs...)
|
||||
return msg
|
||||
}
|
||||
|
||||
func (l *locale) tryTr(trKey string, trArgs ...interface{}) (msg string, found bool) {
|
||||
trMsg := trKey
|
||||
|
||||
// convert the provided trKey to a common idx from the store
|
||||
idx, ok := l.store.idxForTrKey(trKey)
|
||||
|
||||
if ok {
|
||||
if msg, found = l.idxToMsgMap[idx]; found {
|
||||
trMsg = msg // use the translation that we have found
|
||||
} else if l.langName != l.store.defaultLang {
|
||||
// No translation available in our current language... fallback to the default language
|
||||
|
||||
// Attempt to get the default language from the locale store
|
||||
if def, ok := l.store.localeMap[l.store.defaultLang]; ok {
|
||||
|
||||
if def.reloadMu != nil {
|
||||
def.reloadMu.RLock()
|
||||
def.reloadIfNeeded()
|
||||
}
|
||||
if msg, found = def.idxToMsgMap[idx]; found {
|
||||
trMsg = msg // use the translation that we have found
|
||||
}
|
||||
if def.reloadMu != nil {
|
||||
def.reloadMu.RUnlock()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if !found && !setting.IsProd {
|
||||
log.Error("missing i18n translation key: %q", trKey)
|
||||
}
|
||||
|
||||
if len(trArgs) == 0 {
|
||||
return trMsg, found
|
||||
}
|
||||
|
||||
fmtArgs := make([]interface{}, 0, len(trArgs))
|
||||
for _, arg := range trArgs {
|
||||
val := reflect.ValueOf(arg)
|
||||
if val.Kind() == reflect.Slice {
|
||||
// Previously, we would accept Tr(lang, key, a, [b, c], d, [e, f]) as Sprintf(msg, a, b, c, d, e, f)
|
||||
// but this is an unstable behavior.
|
||||
//
|
||||
// So we restrict the accepted arguments to either:
|
||||
//
|
||||
// 1. Tr(lang, key, [slice-items]) as Sprintf(msg, items...)
|
||||
// 2. Tr(lang, key, args...) as Sprintf(msg, args...)
|
||||
if len(trArgs) == 1 {
|
||||
for i := 0; i < val.Len(); i++ {
|
||||
fmtArgs = append(fmtArgs, val.Index(i).Interface())
|
||||
}
|
||||
} else {
|
||||
log.Error("the args for i18n shouldn't contain uncertain slices, key=%q, args=%v", trKey, trArgs)
|
||||
break
|
||||
}
|
||||
} else {
|
||||
fmtArgs = append(fmtArgs, arg)
|
||||
}
|
||||
}
|
||||
|
||||
return fmt.Sprintf(trMsg, fmtArgs...), found
|
||||
// Tr translates a given key and arguments for a language
|
||||
Tr(lang, trKey string, trArgs ...interface{}) string
|
||||
// Has reports if a locale has a translation for a given key
|
||||
Has(lang, trKey string) bool
|
||||
// SetDefaultLang sets the default language to fall back to
|
||||
SetDefaultLang(lang string)
|
||||
// ListLangNameDesc provides paired slices of language names to descriptors
|
||||
ListLangNameDesc() (names, desc []string)
|
||||
// Locale return the locale for the provided language or the default language if not found
|
||||
Locale(langName string) (Locale, bool)
|
||||
// HasLang returns whether a given language is present in the store
|
||||
HasLang(langName string) bool
|
||||
// AddLocaleByIni adds a new language to the store
|
||||
AddLocaleByIni(langName, langDesc string, source interface{}) error
|
||||
}
|
||||
|
||||
// ResetDefaultLocales resets the current default locales
|
||||
// NOTE: this is not synchronized
|
||||
func ResetDefaultLocales(isProd bool) {
|
||||
DefaultLocales = NewLocaleStore(isProd)
|
||||
func ResetDefaultLocales() {
|
||||
if DefaultLocales != nil {
|
||||
_ = DefaultLocales.Close()
|
||||
}
|
||||
DefaultLocales = NewLocaleStore()
|
||||
}
|
||||
|
||||
// Tr use default locales to translate content to target language.
|
||||
func Tr(lang, trKey string, trArgs ...interface{}) string {
|
||||
return DefaultLocales.Tr(lang, trKey, trArgs...)
|
||||
// GetLocales returns the locale from the default locales
|
||||
func GetLocale(lang string) (Locale, bool) {
|
||||
return DefaultLocales.Locale(lang)
|
||||
}
|
||||
|
||||
@@ -27,36 +27,34 @@ fmt = %[2]s %[1]s
|
||||
sub = Changed Sub String
|
||||
`)
|
||||
|
||||
for _, isProd := range []bool{true, false} {
|
||||
ls := NewLocaleStore(isProd)
|
||||
assert.NoError(t, ls.AddLocaleByIni("lang1", "Lang1", testData1))
|
||||
assert.NoError(t, ls.AddLocaleByIni("lang2", "Lang2", testData2))
|
||||
ls.SetDefaultLang("lang1")
|
||||
ls := NewLocaleStore()
|
||||
assert.NoError(t, ls.AddLocaleByIni("lang1", "Lang1", testData1))
|
||||
assert.NoError(t, ls.AddLocaleByIni("lang2", "Lang2", testData2))
|
||||
ls.SetDefaultLang("lang1")
|
||||
|
||||
result := ls.Tr("lang1", "fmt", "a", "b")
|
||||
assert.Equal(t, "a b", result)
|
||||
result := ls.Tr("lang1", "fmt", "a", "b")
|
||||
assert.Equal(t, "a b", result)
|
||||
|
||||
result = ls.Tr("lang2", "fmt", "a", "b")
|
||||
assert.Equal(t, "b a", result)
|
||||
result = ls.Tr("lang2", "fmt", "a", "b")
|
||||
assert.Equal(t, "b a", result)
|
||||
|
||||
result = ls.Tr("lang1", "section.sub")
|
||||
assert.Equal(t, "Sub String", result)
|
||||
result = ls.Tr("lang1", "section.sub")
|
||||
assert.Equal(t, "Sub String", result)
|
||||
|
||||
result = ls.Tr("lang2", "section.sub")
|
||||
assert.Equal(t, "Changed Sub String", result)
|
||||
result = ls.Tr("lang2", "section.sub")
|
||||
assert.Equal(t, "Changed Sub String", result)
|
||||
|
||||
result = ls.Tr("", ".dot.name")
|
||||
assert.Equal(t, "Dot Name", result)
|
||||
result = ls.Tr("", ".dot.name")
|
||||
assert.Equal(t, "Dot Name", result)
|
||||
|
||||
result = ls.Tr("lang2", "section.mixed")
|
||||
assert.Equal(t, `test value; <span style="color: red; background: none;">more text</span>`, result)
|
||||
result = ls.Tr("lang2", "section.mixed")
|
||||
assert.Equal(t, `test value; <span style="color: red; background: none;">more text</span>`, result)
|
||||
|
||||
langs, descs := ls.ListLangNameDesc()
|
||||
assert.Equal(t, []string{"lang1", "lang2"}, langs)
|
||||
assert.Equal(t, []string{"Lang1", "Lang2"}, descs)
|
||||
langs, descs := ls.ListLangNameDesc()
|
||||
assert.Equal(t, []string{"lang1", "lang2"}, langs)
|
||||
assert.Equal(t, []string{"Lang1", "Lang2"}, descs)
|
||||
|
||||
result, found := ls.localeMap["lang1"].tryTr("no-such")
|
||||
assert.Equal(t, "no-such", result)
|
||||
assert.False(t, found)
|
||||
}
|
||||
found := ls.Has("lang1", "no-such")
|
||||
assert.False(t, found)
|
||||
assert.NoError(t, ls.Close())
|
||||
}
|
||||
|
||||
161
modules/translation/i18n/localestore.go
Normal file
161
modules/translation/i18n/localestore.go
Normal file
@@ -0,0 +1,161 @@
|
||||
// Copyright 2022 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package i18n
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"code.gitea.io/gitea/modules/log"
|
||||
|
||||
"gopkg.in/ini.v1"
|
||||
)
|
||||
|
||||
// This file implements the static LocaleStore that will not watch for changes
|
||||
|
||||
type locale struct {
|
||||
store *localeStore
|
||||
langName string
|
||||
idxToMsgMap map[int]string // the map idx is generated by store's trKeyToIdxMap
|
||||
}
|
||||
|
||||
type localeStore struct {
|
||||
// After initializing has finished, these fields are read-only.
|
||||
langNames []string
|
||||
langDescs []string
|
||||
|
||||
localeMap map[string]*locale
|
||||
trKeyToIdxMap map[string]int
|
||||
|
||||
defaultLang string
|
||||
}
|
||||
|
||||
// NewLocaleStore creates a static locale store
|
||||
func NewLocaleStore() LocaleStore {
|
||||
return &localeStore{localeMap: make(map[string]*locale), trKeyToIdxMap: make(map[string]int)}
|
||||
}
|
||||
|
||||
// AddLocaleByIni adds locale by ini into the store
|
||||
// if source is a string, then the file is loaded
|
||||
// if source is a []byte, then the content is used
|
||||
func (store *localeStore) AddLocaleByIni(langName, langDesc string, source interface{}) error {
|
||||
if _, ok := store.localeMap[langName]; ok {
|
||||
return ErrLocaleAlreadyExist
|
||||
}
|
||||
|
||||
store.langNames = append(store.langNames, langName)
|
||||
store.langDescs = append(store.langDescs, langDesc)
|
||||
|
||||
l := &locale{store: store, langName: langName, idxToMsgMap: make(map[int]string)}
|
||||
store.localeMap[l.langName] = l
|
||||
|
||||
iniFile, err := ini.LoadSources(ini.LoadOptions{
|
||||
IgnoreInlineComment: true,
|
||||
UnescapeValueCommentSymbols: true,
|
||||
}, source)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to load ini: %w", err)
|
||||
}
|
||||
iniFile.BlockMode = false
|
||||
|
||||
for _, section := range iniFile.Sections() {
|
||||
for _, key := range section.Keys() {
|
||||
var trKey string
|
||||
if section.Name() == "" || section.Name() == "DEFAULT" {
|
||||
trKey = key.Name()
|
||||
} else {
|
||||
trKey = section.Name() + "." + key.Name()
|
||||
}
|
||||
idx, ok := store.trKeyToIdxMap[trKey]
|
||||
if !ok {
|
||||
idx = len(store.trKeyToIdxMap)
|
||||
store.trKeyToIdxMap[trKey] = idx
|
||||
}
|
||||
l.idxToMsgMap[idx] = key.Value()
|
||||
}
|
||||
}
|
||||
iniFile = nil
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (store *localeStore) HasLang(langName string) bool {
|
||||
_, ok := store.localeMap[langName]
|
||||
return ok
|
||||
}
|
||||
|
||||
func (store *localeStore) ListLangNameDesc() (names, desc []string) {
|
||||
return store.langNames, store.langDescs
|
||||
}
|
||||
|
||||
// SetDefaultLang sets default language as a fallback
|
||||
func (store *localeStore) SetDefaultLang(lang string) {
|
||||
store.defaultLang = lang
|
||||
}
|
||||
|
||||
// Tr translates content to target language. fall back to default language.
|
||||
func (store *localeStore) Tr(lang, trKey string, trArgs ...interface{}) string {
|
||||
l, _ := store.Locale(lang)
|
||||
|
||||
return l.Tr(trKey, trArgs...)
|
||||
}
|
||||
|
||||
// Has returns whether the given language has a translation for the provided key
|
||||
func (store *localeStore) Has(lang, trKey string) bool {
|
||||
l, _ := store.Locale(lang)
|
||||
|
||||
return l.Has(trKey)
|
||||
}
|
||||
|
||||
// Locale returns the locale for the lang or the default language
|
||||
func (store *localeStore) Locale(lang string) (Locale, bool) {
|
||||
l, found := store.localeMap[lang]
|
||||
if !found {
|
||||
var ok bool
|
||||
l, ok = store.localeMap[store.defaultLang]
|
||||
if !ok {
|
||||
// no default - return an empty locale
|
||||
l = &locale{store: store, idxToMsgMap: make(map[int]string)}
|
||||
}
|
||||
}
|
||||
return l, found
|
||||
}
|
||||
|
||||
// Close implements io.Closer
|
||||
func (store *localeStore) Close() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Tr translates content to locale language. fall back to default language.
|
||||
func (l *locale) Tr(trKey string, trArgs ...interface{}) string {
|
||||
format := trKey
|
||||
|
||||
idx, ok := l.store.trKeyToIdxMap[trKey]
|
||||
if ok {
|
||||
if msg, ok := l.idxToMsgMap[idx]; ok {
|
||||
format = msg // use the found translation
|
||||
} else if def, ok := l.store.localeMap[l.store.defaultLang]; ok {
|
||||
// try to use default locale's translation
|
||||
if msg, ok := def.idxToMsgMap[idx]; ok {
|
||||
format = msg
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
msg, err := Format(format, trArgs...)
|
||||
if err != nil {
|
||||
log.Error("Error whilst formatting %q in %s: %v", trKey, l.langName, err)
|
||||
}
|
||||
return msg
|
||||
}
|
||||
|
||||
// Has returns whether a key is present in this locale or not
|
||||
func (l *locale) Has(trKey string) bool {
|
||||
idx, ok := l.store.trKeyToIdxMap[trKey]
|
||||
if !ok {
|
||||
return false
|
||||
}
|
||||
_, ok = l.idxToMsgMap[idx]
|
||||
return ok
|
||||
}
|
||||
@@ -5,15 +5,16 @@
|
||||
package translation
|
||||
|
||||
import (
|
||||
"path"
|
||||
"context"
|
||||
"sort"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"code.gitea.io/gitea/modules/log"
|
||||
"code.gitea.io/gitea/modules/options"
|
||||
"code.gitea.io/gitea/modules/setting"
|
||||
"code.gitea.io/gitea/modules/translation/i18n"
|
||||
"code.gitea.io/gitea/modules/util"
|
||||
"code.gitea.io/gitea/modules/watcher"
|
||||
|
||||
"golang.org/x/text/language"
|
||||
)
|
||||
@@ -31,6 +32,7 @@ type LangType struct {
|
||||
}
|
||||
|
||||
var (
|
||||
lock *sync.RWMutex
|
||||
matcher language.Matcher
|
||||
allLangs []*LangType
|
||||
allLangMap map[string]*LangType
|
||||
@@ -43,57 +45,52 @@ func AllLangs() []*LangType {
|
||||
}
|
||||
|
||||
// InitLocales loads the locales
|
||||
func InitLocales() {
|
||||
i18n.ResetDefaultLocales(setting.IsProd)
|
||||
localeNames, err := options.Dir("locale")
|
||||
if err != nil {
|
||||
log.Fatal("Failed to list locale files: %v", err)
|
||||
func InitLocales(ctx context.Context) {
|
||||
if lock != nil {
|
||||
lock.Lock()
|
||||
defer lock.Unlock()
|
||||
} else if !setting.IsProd && lock == nil {
|
||||
lock = &sync.RWMutex{}
|
||||
}
|
||||
|
||||
localFiles := make(map[string]interface{}, len(localeNames))
|
||||
for _, name := range localeNames {
|
||||
if options.IsDynamic() {
|
||||
// Try to check if CustomPath has the file, otherwise fallback to StaticRootPath
|
||||
value := path.Join(setting.CustomPath, "options/locale", name)
|
||||
refreshLocales := func() {
|
||||
i18n.ResetDefaultLocales()
|
||||
localeNames, err := options.Dir("locale")
|
||||
if err != nil {
|
||||
log.Fatal("Failed to list locale files: %v", err)
|
||||
}
|
||||
|
||||
isFile, err := util.IsFile(value)
|
||||
if err != nil {
|
||||
log.Fatal("Failed to load %s locale file. %v", name, err)
|
||||
}
|
||||
|
||||
if isFile {
|
||||
localFiles[name] = value
|
||||
} else {
|
||||
localFiles[name] = path.Join(setting.StaticRootPath, "options/locale", name)
|
||||
}
|
||||
} else {
|
||||
localFiles := make(map[string]interface{}, len(localeNames))
|
||||
for _, name := range localeNames {
|
||||
localFiles[name], err = options.Locale(name)
|
||||
if err != nil {
|
||||
log.Fatal("Failed to load %s locale file. %v", name, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
supportedTags = make([]language.Tag, len(setting.Langs))
|
||||
for i, lang := range setting.Langs {
|
||||
supportedTags[i] = language.Raw.Make(lang)
|
||||
}
|
||||
supportedTags = make([]language.Tag, len(setting.Langs))
|
||||
for i, lang := range setting.Langs {
|
||||
supportedTags[i] = language.Raw.Make(lang)
|
||||
}
|
||||
|
||||
matcher = language.NewMatcher(supportedTags)
|
||||
for i := range setting.Names {
|
||||
key := "locale_" + setting.Langs[i] + ".ini"
|
||||
matcher = language.NewMatcher(supportedTags)
|
||||
for i := range setting.Names {
|
||||
key := "locale_" + setting.Langs[i] + ".ini"
|
||||
|
||||
if err = i18n.DefaultLocales.AddLocaleByIni(setting.Langs[i], setting.Names[i], localFiles[key]); err != nil {
|
||||
log.Error("Failed to set messages to %s: %v", setting.Langs[i], err)
|
||||
if err = i18n.DefaultLocales.AddLocaleByIni(setting.Langs[i], setting.Names[i], localFiles[key]); err != nil {
|
||||
log.Error("Failed to set messages to %s: %v", setting.Langs[i], err)
|
||||
}
|
||||
}
|
||||
if len(setting.Langs) != 0 {
|
||||
defaultLangName := setting.Langs[0]
|
||||
if defaultLangName != "en-US" {
|
||||
log.Info("Use the first locale (%s) in LANGS setting option as default", defaultLangName)
|
||||
}
|
||||
i18n.DefaultLocales.SetDefaultLang(defaultLangName)
|
||||
}
|
||||
}
|
||||
if len(setting.Langs) != 0 {
|
||||
defaultLangName := setting.Langs[0]
|
||||
if defaultLangName != "en-US" {
|
||||
log.Info("Use the first locale (%s) in LANGS setting option as default", defaultLangName)
|
||||
}
|
||||
i18n.DefaultLocales.SetDefaultLang(defaultLangName)
|
||||
}
|
||||
|
||||
refreshLocales()
|
||||
|
||||
langs, descs := i18n.DefaultLocales.ListLangNameDesc()
|
||||
allLangs = make([]*LangType, 0, len(langs))
|
||||
@@ -108,6 +105,17 @@ func InitLocales() {
|
||||
sort.Slice(allLangs, func(i, j int) bool {
|
||||
return strings.ToLower(allLangs[i].Name) < strings.ToLower(allLangs[j].Name)
|
||||
})
|
||||
|
||||
if !setting.IsProd {
|
||||
watcher.CreateWatcher(ctx, "Locales", &watcher.CreateWatcherOpts{
|
||||
PathsCallback: options.WalkLocales,
|
||||
BetweenCallback: func() {
|
||||
lock.Lock()
|
||||
defer lock.Unlock()
|
||||
refreshLocales()
|
||||
},
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Match matches accept languages
|
||||
@@ -118,16 +126,24 @@ func Match(tags ...language.Tag) language.Tag {
|
||||
|
||||
// locale represents the information of localization.
|
||||
type locale struct {
|
||||
i18n.Locale
|
||||
Lang, LangName string // these fields are used directly in templates: .i18n.Lang
|
||||
}
|
||||
|
||||
// NewLocale return a locale
|
||||
func NewLocale(lang string) Locale {
|
||||
if lock != nil {
|
||||
lock.RLock()
|
||||
defer lock.RUnlock()
|
||||
}
|
||||
|
||||
langName := "unknown"
|
||||
if l, ok := allLangMap[lang]; ok {
|
||||
langName = l.Name
|
||||
}
|
||||
i18nLocale, _ := i18n.GetLocale(lang)
|
||||
return &locale{
|
||||
Locale: i18nLocale,
|
||||
Lang: lang,
|
||||
LangName: langName,
|
||||
}
|
||||
@@ -137,11 +153,6 @@ func (l *locale) Language() string {
|
||||
return l.Lang
|
||||
}
|
||||
|
||||
// Tr translates content to target language.
|
||||
func (l *locale) Tr(format string, args ...interface{}) string {
|
||||
return i18n.Tr(l.Lang, format, args...)
|
||||
}
|
||||
|
||||
// Language specific rules for translating plural texts
|
||||
var trNLangRules = map[string]func(int64) int{
|
||||
// the default rule is "en-US" if a language isn't listed here
|
||||
|
||||
Reference in New Issue
Block a user