remove legacy i18n

wxiaoguang · wxiaoguang · commit 3ea09eb8d7b5 · 2022-04-02T12:56:25.000+08:00
diff --git a/go.mod b/go.mod
@@ -78,7 +78,6 @@ require (
 	github.com/stretchr/testify v1.7.0
 	github.com/syndtr/goleveldb v1.0.0
 	github.com/tstranex/u2f v1.0.0
-	github.com/unknwon/i18n v0.0.0-20210904045753-ff3a8617e361
 	github.com/unknwon/paginater v0.0.0-20200328080006-042474bd0eae
 	github.com/unrolled/render v1.4.1
 	github.com/urfave/cli v1.22.5
diff --git a/go.sum b/go.sum
@@ -1503,8 +1503,6 @@ github.com/ulikunitz/xz v0.5.10/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0o
 github.com/unknwon/com v0.0.0-20190804042917-757f69c95f3e/go.mod h1:tOOxU81rwgoCLoOVVPHb6T/wt8HZygqH5id+GNnlCXM=
 github.com/unknwon/com v1.0.1 h1:3d1LTxD+Lnf3soQiD4Cp/0BRB+Rsa/+RTvz8GMMzIXs=
 github.com/unknwon/com v1.0.1/go.mod h1:tOOxU81rwgoCLoOVVPHb6T/wt8HZygqH5id+GNnlCXM=
-github.com/unknwon/i18n v0.0.0-20210904045753-ff3a8617e361 h1:4Ij5sX4JEzCCY/CCl8trJHey1tPsIDomYTZf145GKk0=
-github.com/unknwon/i18n v0.0.0-20210904045753-ff3a8617e361/go.mod h1:+5rDk6sDGpl3azws3O+f+GpFSyN9GVr0K8cvQLQM2ZQ=
 github.com/unknwon/paginater v0.0.0-20200328080006-042474bd0eae h1:ihaXiJkaca54IaCSnEXtE/uSZOmPxKZhDfVLrzZLFDs=
 github.com/unknwon/paginater v0.0.0-20200328080006-042474bd0eae/go.mod h1:1fdkY6xxl6ExVs2QFv7R0F5IRZHKA8RahhB9fMC9RvM=
 github.com/unrolled/render v1.4.1 h1:VdpMc2YkAOWzbmC/P2yoHhRDXgsaCQHcTJ1KK6SNCA4=
@@ -2272,7 +2270,6 @@ gopkg.in/gomail.v2 v2.0.0-20160411212932-81ebce5c23df h1:n7WqCuqOuCbNr617RXOY0AW
 gopkg.in/gomail.v2 v2.0.0-20160411212932-81ebce5c23df/go.mod h1:LRQQ+SO6ZHR7tOkpBDuZnXENFzX8qRjMDMyPD6BRkCw=
 gopkg.in/inconshreveable/log15.v2 v2.0.0-20180818164646-67afb5ed74ec/go.mod h1:aPpfJ7XW+gOuirDoZ8gHhLh3kZ1B08FtV2bbmy7Jv3s=
 gopkg.in/ini.v1 v1.44.2/go.mod h1:M3Cogqpuv0QCi3ExAY5V4uOt4qb/R3xZubo9m8lK5wg=
-gopkg.in/ini.v1 v1.46.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/ini.v1 v1.51.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/ini.v1 v1.57.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/ini.v1 v1.62.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
diff --git a/integrations/auth_ldap_test.go b/integrations/auth_ldap_test.go
@@ -16,10 +16,10 @@ import (
 	"code.gitea.io/gitea/models/organization"
 	"code.gitea.io/gitea/models/unittest"
 	user_model "code.gitea.io/gitea/models/user"
+	"code.gitea.io/gitea/modules/translation/i18n"
 	"code.gitea.io/gitea/services/auth"
 
 	"github.com/stretchr/testify/assert"
-	"github.com/unknwon/i18n"
 )
 
 type ldapUser struct {
diff --git a/integrations/branches_test.go b/integrations/branches_test.go
@@ -9,8 +9,9 @@ import (
 	"net/url"
 	"testing"
 
+	"code.gitea.io/gitea/modules/translation/i18n"
+
 	"github.com/stretchr/testify/assert"
-	"github.com/unknwon/i18n"
 )
 
 func TestViewBranches(t *testing.T) {
diff --git a/integrations/pull_merge_test.go b/integrations/pull_merge_test.go
@@ -24,10 +24,10 @@ import (
 	"code.gitea.io/gitea/modules/git"
 	api "code.gitea.io/gitea/modules/structs"
 	"code.gitea.io/gitea/modules/test"
+	"code.gitea.io/gitea/modules/translation/i18n"
 	"code.gitea.io/gitea/services/pull"
 
 	"github.com/stretchr/testify/assert"
-	"github.com/unknwon/i18n"
 )
 
 func testPullMerge(t *testing.T, session *TestSession, user, repo, pullnum string, mergeStyle repo_model.MergeStyle) *httptest.ResponseRecorder {
diff --git a/integrations/release_test.go b/integrations/release_test.go
@@ -14,10 +14,10 @@ import (
 	"code.gitea.io/gitea/models/unittest"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/test"
+	"code.gitea.io/gitea/modules/translation/i18n"
 
 	"github.com/PuerkitoBio/goquery"
 	"github.com/stretchr/testify/assert"
-	"github.com/unknwon/i18n"
 )
 
 func createNewRelease(t *testing.T, session *TestSession, repoURL, tag, title string, preRelease, draft bool) {
diff --git a/integrations/repo_branch_test.go b/integrations/repo_branch_test.go
@@ -13,9 +13,9 @@ import (
 
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/test"
+	"code.gitea.io/gitea/modules/translation/i18n"
 
 	"github.com/stretchr/testify/assert"
-	"github.com/unknwon/i18n"
 )
 
 func testCreateBranch(t testing.TB, session *TestSession, user, repo, oldRefSubURL, newBranchName string, expectedStatus int) string {
diff --git a/integrations/signin_test.go b/integrations/signin_test.go
@@ -11,9 +11,9 @@ import (
 
 	"code.gitea.io/gitea/models/unittest"
 	user_model "code.gitea.io/gitea/models/user"
+	"code.gitea.io/gitea/modules/translation/i18n"
 
 	"github.com/stretchr/testify/assert"
-	"github.com/unknwon/i18n"
 )
 
 func testLoginFailed(t *testing.T, username, password, message string) {
diff --git a/integrations/signup_test.go b/integrations/signup_test.go
@@ -13,9 +13,9 @@ import (
 	"code.gitea.io/gitea/models/unittest"
 	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/setting"
+	"code.gitea.io/gitea/modules/translation/i18n"
 
 	"github.com/stretchr/testify/assert"
-	"github.com/unknwon/i18n"
 )
 
 func TestSignup(t *testing.T) {
diff --git a/integrations/user_test.go b/integrations/user_test.go
@@ -11,9 +11,9 @@ import (
 	"code.gitea.io/gitea/models/unittest"
 	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/test"
+	"code.gitea.io/gitea/modules/translation/i18n"
 
 	"github.com/stretchr/testify/assert"
-	"github.com/unknwon/i18n"
 )
 
 func TestViewUser(t *testing.T) {
diff --git a/modules/markup/markdown/toc.go b/modules/markup/markdown/toc.go
@@ -8,7 +8,8 @@ import (
 	"fmt"
 	"net/url"
 
-	"github.com/unknwon/i18n"
+	"code.gitea.io/gitea/modules/translation/i18n"
+
 	"github.com/yuin/goldmark/ast"
 )
 
diff --git a/modules/timeutil/since.go b/modules/timeutil/since.go
@@ -12,8 +12,7 @@ import (
 	"time"
 
 	"code.gitea.io/gitea/modules/setting"
-
-	"github.com/unknwon/i18n"
+	"code.gitea.io/gitea/modules/translation/i18n"
 )
 
 // Seconds-based time units
diff --git a/modules/timeutil/since_test.go b/modules/timeutil/since_test.go
@@ -12,9 +12,9 @@ import (
 
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/translation"
+	"code.gitea.io/gitea/modules/translation/i18n"
 
 	"github.com/stretchr/testify/assert"
-	"github.com/unknwon/i18n"
 )
 
 var BaseDate time.Time
diff --git a/modules/translation/i18n/i18n.go b/modules/translation/i18n/i18n.go
@@ -0,0 +1,154 @@
+// 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"
+	"fmt"
+	"reflect"
+	"strings"
+
+	"code.gitea.io/gitea/modules/log"
+
+	"gopkg.in/ini.v1"
+)
+
+var (
+	ErrLocaleAlreadyExist = errors.New("lang already exists")
+	ErrLocaleAlreadyAdded = errors.New("lang was already added to another store")
+
+	DefaultLocales = NewLocaleStore()
+)
+
+type locale struct {
+	store    *LocaleStore
+	langName string
+	langDesc string
+	messages *ini.File
+}
+
+type LocaleStore struct {
+	// at the moment, all these fields are readonly after initialization
+	langNames   []string
+	langDescs   []string
+	localeMap   map[string]*locale
+	defaultLang string
+}
+
+func NewLocaleStore() *LocaleStore {
+	return &LocaleStore{localeMap: make(map[string]*locale)}
+}
+
+// AddLocale adds locale into the store, and the locale is attached to the store, it can not be added to another one
+func (ls *LocaleStore) AddLocale(lc *locale) error {
+	if _, ok := ls.localeMap[lc.langName]; ok {
+		return ErrLocaleAlreadyExist
+	}
+
+	if lc.store != nil {
+		return ErrLocaleAlreadyAdded
+	}
+	lc.store = ls
+	ls.langNames = append(ls.langNames, lc.langName)
+	ls.langDescs = append(ls.langDescs, lc.langDesc)
+	ls.localeMap[lc.langName] = lc
+	return nil
+}
+
+// AddLocaleByIni adds locale by ini into the store
+func (ls *LocaleStore) AddLocaleByIni(langName, langDesc string, localeFile interface{}, otherLocaleFiles ...interface{}) error {
+	iniFile, err := ini.LoadSources(ini.LoadOptions{
+		IgnoreInlineComment:         true,
+		UnescapeValueCommentSymbols: true,
+	}, localeFile, otherLocaleFiles...)
+	if err == nil {
+		iniFile.BlockMode = false
+		return ls.AddLocale(&locale{langName: langName, langDesc: langDesc, messages: iniFile})
+	}
+	return err
+}
+
+func (ls *LocaleStore) HasLang(langName string) bool {
+	_, ok := ls.localeMap[langName]
+	return ok
+}
+
+func (ls *LocaleStore) ListLangNameDesc() (names, desc []string) {
+	return ls.langNames, ls.langDescs
+}
+
+// SetDefaultLang sets default language as a fallback
+func (ls *LocaleStore) SetDefaultLang(lang string) {
+	ls.defaultLang = lang
+}
+
+// Tr translates content to target language. fall back to default language.
+func (ls *LocaleStore) Tr(lang, trKey string, trArgs ...interface{}) string {
+	l, ok := ls.localeMap[lang]
+	if !ok {
+		l, ok = ls.localeMap[ls.defaultLang]
+	}
+	if ok {
+		return l.Tr(trKey, trArgs...)
+	}
+	return trKey
+}
+
+// Tr translates content to locale language. fall back to default language.
+func (l *locale) Tr(trKey string, trArgs ...interface{}) string {
+	var section string
+
+	idx := strings.IndexByte(trKey, '.')
+	if idx > 0 {
+		section = trKey[:idx]
+		trKey = trKey[idx+1:]
+	}
+
+	trMsg := trKey
+	if trIni, err := l.messages.Section(section).GetKey(trKey); err == nil {
+		trMsg = trIni.Value()
+	} else if l.store.defaultLang != "" && l.langName != l.store.defaultLang {
+		// try to fall back to default
+		if defaultLocale, ok := l.store.localeMap[l.store.defaultLang]; ok {
+			if trIni, err = defaultLocale.messages.Section(section).GetKey(trKey); err == nil {
+				trMsg = trIni.Value()
+			}
+		}
+	}
+
+	if len(trArgs) > 0 {
+		fmtArgs := make([]interface{}, 0, len(trArgs))
+		for _, arg := range trArgs {
+			val := reflect.ValueOf(arg)
+			if val.Kind() == reflect.Slice {
+				// before, it can accept Tr(lang, key, a, [b, c], d, [e, f]) as Sprintf(msg, a, b, c, d, e, f), it's an unstable behavior
+				// now, we restrict the strange behavior and only support:
+				// 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...)
+	}
+	return trMsg
+}
+
+func ResetDefaultLocales() {
+	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...)
+}
diff --git a/modules/translation/i18n/i18n_test.go b/modules/translation/i18n/i18n_test.go
@@ -0,0 +1,56 @@
+// 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 (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_Tr(t *testing.T) {
+	testData1 := []byte(`
+.dot.name = Dot Name
+fmt = %[1]s %[2]s
+
+[section]
+sub = Sub String
+mixed = test value; <span style="color: red\; background: none;">more text</span>
+`)
+
+	testData2 := []byte(`
+fmt = %[2]s %[1]s
+
+[section]
+sub = Changed Sub String
+`)
+
+	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("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("lang2", "section.sub")
+	assert.Equal(t, "Changed Sub String", 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)
+
+	langs, descs := ls.ListLangNameDesc()
+	assert.Equal(t, []string{"lang1", "lang2"}, langs)
+	assert.Equal(t, []string{"Lang1", "Lang2"}, descs)
+}
diff --git a/modules/translation/translation.go b/modules/translation/translation.go
diff --git a/modules/web/middleware/locale.go b/modules/web/middleware/locale.go
diff --git a/routers/web/repo/issue_content_history.go b/routers/web/repo/issue_content_history.go
diff --git a/routers/web/user/setting/profile.go b/routers/web/user/setting/profile.go
diff --git a/services/cron/setting.go b/services/cron/setting.go

Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,9 @@ import (`
`9`	`9`	`"net/url"`
`10`	`10`	`"testing"`
`11`	`11`
	`12`	`+ "code.gitea.io/gitea/modules/translation/i18n"`
	`13`	`+`
`12`	`14`	`"github.com/stretchr/testify/assert"`
`13`		`- "github.com/unknwon/i18n"`
`14`	`15`	`)`
`15`	`16`
`16`	`17`	`func TestViewBranches(t *testing.T) {`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,9 @@ import (`
`13`	`13`
`14`	`14`	`"code.gitea.io/gitea/modules/setting"`
`15`	`15`	`"code.gitea.io/gitea/modules/test"`
	`16`	`+ "code.gitea.io/gitea/modules/translation/i18n"`
`16`	`17`
`17`	`18`	`"github.com/stretchr/testify/assert"`
`18`		`- "github.com/unknwon/i18n"`
`19`	`19`	`)`
`20`	`20`
`21`	`21`	`func testCreateBranch(t testing.TB, session *TestSession, user, repo, oldRefSubURL, newBranchName string, expectedStatus int) string {`
Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,9 @@ import (`
`11`	`11`
`12`	`12`	`"code.gitea.io/gitea/models/unittest"`
`13`	`13`	`user_model "code.gitea.io/gitea/models/user"`
	`14`	`+ "code.gitea.io/gitea/modules/translation/i18n"`
`14`	`15`
`15`	`16`	`"github.com/stretchr/testify/assert"`
`16`		`- "github.com/unknwon/i18n"`
`17`	`17`	`)`
`18`	`18`
`19`	`19`	`func testLoginFailed(t *testing.T, username, password, message string) {`