Refactor i18n, use Locale to provide i18n/translation related functions (go-gitea#18648)

* remove unnecessary web context data fields, and unify the i18n/translation related functions to `Locale`
* in development, show an error if a translation key is missing
* remove the unnecessary loops `for _, lang := range translation.AllLangs()` for every request, which improves the performance slightly
* use `ctx.Locale.Language()` instead of `ctx.Data["Lang"].(string)`
* add more comments about how the Locale/LangType fields are used

Author: wxiaoguang

modules/context/context.go

@@ -38,7 +38,6 @@ import (
 	"gitea.com/go-chi/session"
 	chi "github.com/go-chi/chi/v5"
 	"github.com/unknwon/com"
-	"github.com/unknwon/i18n"
 	"github.com/unrolled/render"
 	"golang.org/x/crypto/pbkdf2"
 )
@@ -738,15 +737,7 @@ func Contexter() func(next http.Handler) http.Handler {
 			ctx.Data["UnitProjectsGlobalDisabled"] = unit.TypeProjects.UnitGlobalDisabled()
 
 			ctx.Data["i18n"] = locale
-			ctx.Data["Tr"] = i18n.Tr
-			ctx.Data["Lang"] = locale.Language()
 			ctx.Data["AllLangs"] = translation.AllLangs()
-			for _, lang := range translation.AllLangs() {
-				if lang.Lang == locale.Language() {
-					ctx.Data["LangName"] = lang.Name
-					break
-				}
-			}
 
 			next.ServeHTTP(ctx.Resp, ctx.Req)
 

modules/translation/translation.go

@@ -25,17 +25,18 @@ type Locale interface {
 
 // LangType represents a lang type
 type LangType struct {
-	Lang, Name string
+	Lang, Name string // these fields are used directly in templates: {{range .AllLangs}}{{.Lang}}{{.Name}}{{end}}
 }
 
 var (
 	matcher       language.Matcher
-	allLangs      []LangType
+	allLangs      []*LangType
+	allLangMap    map[string]*LangType
 	supportedTags []language.Tag
 )
 
 // AllLangs returns all supported languages sorted by name
-func AllLangs() []LangType {
+func AllLangs() []*LangType {
 	return allLangs
 }
 
@@ -81,14 +82,17 @@ func InitLocales() {
 	}
 	i18n.SetDefaultLang("en-US")
 
-	allLangs = make([]LangType, 0, i18n.Count()-1)
+	allLangs = make([]*LangType, 0, i18n.Count())
+	allLangMap = map[string]*LangType{}
 	langs := i18n.ListLangs()
-	names := i18n.ListLangDescs()
+	descs := i18n.ListLangDescs()
 	for i, v := range langs {
-		allLangs = append(allLangs, LangType{v, names[i]})
+		l := &LangType{v, descs[i]}
+		allLangs = append(allLangs, l)
+		allLangMap[v] = l
 	}
 
-	// Sort languages case insensitive according to their name - needed for the user settings
+	// Sort languages case-insensitive according to their name - needed for the user settings
 	sort.Slice(allLangs, func(i, j int) bool {
 		return strings.ToLower(allLangs[i].Name) < strings.ToLower(allLangs[j].Name)
 	})
@@ -102,13 +106,18 @@ func Match(tags ...language.Tag) language.Tag {
 
 // locale represents the information of localization.
 type locale struct {
-	Lang string
+	Lang, LangName string // these fields are used directly in templates: .i18n.Lang
 }
 
 // NewLocale return a locale
 func NewLocale(lang string) Locale {
+	langName := "unknown"
+	if l, ok := allLangMap[lang]; ok {
+		langName = l.Name
+	}
 	return &locale{
-		Lang: lang,
+		Lang:     lang,
+		LangName: langName,
 	}
 }
 
@@ -118,7 +127,16 @@ func (l *locale) Language() string {
 
 // Tr translates content to target language.
 func (l *locale) Tr(format string, args ...interface{}) string {
-	return i18n.Tr(l.Lang, format, args...)
+	if setting.IsProd {
+		return i18n.Tr(l.Lang, format, args...)
+	}
+
+	// in development, we should show an error if a translation key is missing
+	s, ok := TryTr(l.Lang, format, args...)
+	if !ok {
+		log.Error("missing i18n translation key: %q", format)
+	}
+	return s
 }
 
 // Language specific rules for translating plural texts

routers/install/install.go

@@ -71,25 +71,16 @@ func Init(next http.Handler) http.Handler {
 			Render:  rnd,
 			Session: session.GetSession(req),
 			Data: map[string]interface{}{
+				"i18n":          locale,
 				"Title":         locale.Tr("install.install"),
 				"PageIsInstall": true,
 				"DbTypeNames":   getDbTypeNames(),
-				"i18n":          locale,
-				"Language":      locale.Language(),
-				"Lang":          locale.Language(),
 				"AllLangs":      translation.AllLangs(),
-				"CurrentURL":    setting.AppSubURL + req.URL.RequestURI(),
 				"PageStartTime": startTime,
 
 				"PasswordHashAlgorithms": user_model.AvailableHashAlgorithms,
 			},
 		}
-		for _, lang := range translation.AllLangs() {
-			if lang.Lang == locale.Language() {
-				ctx.Data["LangName"] = lang.Name
-				break
-			}
-		}
 		ctx.Req = context.WithContext(req, &ctx)
 		next.ServeHTTP(resp, ctx.Req)
 	})

routers/web/repo/blame.go

@@ -255,7 +255,7 @@ func renderBlame(ctx *context.Context, blameParts []git.BlamePart, commitNames m
 				commitCnt++
 
 				// User avatar image
-				commitSince := timeutil.TimeSinceUnix(timeutil.TimeStamp(commit.Author.When.Unix()), ctx.Data["Lang"].(string))
+				commitSince := timeutil.TimeSinceUnix(timeutil.TimeStamp(commit.Author.When.Unix()), ctx.Locale.Language())
 
 				var avatar string
 				if commit.User != nil {

routers/web/repo/issue_content_history.go

@@ -29,7 +29,7 @@ func GetContentHistoryOverview(ctx *context.Context) {
 		return
 	}
 
-	lang := ctx.Data["Lang"].(string)
+	lang := ctx.Locale.Language()
 	editedHistoryCountMap, _ := issuesModel.QueryIssueContentHistoryEditedCountMap(db.DefaultContext, issue.ID)
 	ctx.JSON(http.StatusOK, map[string]interface{}{
 		"i18n": map[string]interface{}{
@@ -55,17 +55,17 @@ func GetContentHistoryList(ctx *context.Context) {
 	// render history list to HTML for frontend dropdown items: (name, value)
 	// name is HTML of "avatar + userName + userAction + timeSince"
 	// value is historyId
-	lang := ctx.Data["Lang"].(string)
+	lang := ctx.Locale.Language()
 	var results []map[string]interface{}
 	for _, item := range items {
 		var actionText string
 		if item.IsDeleted {
-			actionTextDeleted := i18n.Tr(lang, "repo.issues.content_history.deleted")
+			actionTextDeleted := ctx.Locale.Tr("repo.issues.content_history.deleted")
 			actionText = "<i data-history-is-deleted='1'>" + actionTextDeleted + "</i>"
 		} else if item.IsFirstCreated {
-			actionText = i18n.Tr(lang, "repo.issues.content_history.created")
+			actionText = ctx.Locale.Tr("repo.issues.content_history.created")
 		} else {
-			actionText = i18n.Tr(lang, "repo.issues.content_history.edited")
+			actionText = ctx.Locale.Tr("repo.issues.content_history.edited")
 		}
 		timeSinceText := timeutil.TimeSinceUnix(item.EditedUnix, lang)
 		results = append(results, map[string]interface{}{

templates/admin/process-row.tmpl

@@ -2,7 +2,7 @@
 	<div class="df ac">
 		<div class="content f1">
 			<div class="header">{{.Process.Description}}</div>
-			<div class="description"><span title="{{DateFmtLong .Process.Start}}">{{TimeSince .Process.Start .root.Lang}}</span></div>
+			<div class="description"><span title="{{DateFmtLong .Process.Start}}">{{TimeSince .Process.Start .root.i18n.Lang}}</span></div>
 		</div>
 		<div>
 			<a class="delete-button icon" href="" data-url="{{.root.Link}}/cancel/{{.Process.PID}}" data-id="{{.Process.PID}}" data-name="{{.Process.Description}}">{{svg "octicon-trash" 16 "text-red"}}</a>

templates/base/footer_content.tmpl

@@ -9,10 +9,10 @@
 			{{end}}
 			<div class="ui language bottom floating slide up dropdown link item">
 				{{svg "octicon-globe"}}
-				<div class="text">{{.LangName}}</div>
+				<div class="text">{{.i18n.LangName}}</div>
 				<div class="menu language-menu">
 					{{range .AllLangs}}
-						<a lang="{{.Lang}}" data-url="{{AppSubUrl}}/?lang={{.Lang}}" class="item {{if eq $.Lang .Lang}}active selected{{end}}">{{.Name}}</a>
+						<a lang="{{.Lang}}" data-url="{{AppSubUrl}}/?lang={{.Lang}}" class="item {{if eq $.i18n.Lang .Lang}}active selected{{end}}">{{.Name}}</a>
 					{{end}}
 				</div>
 			</div>

templates/base/head.tmpl

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="{{.Lang}}" class="theme-{{.SignedUser.Theme}}">
+<html lang="{{.i18n.Lang}}" class="theme-{{.SignedUser.Theme}}">
 <head>
 	<meta charset="utf-8">
 	<meta name="viewport" content="width=device-width, initial-scale=1">

templates/repo/activity.tmpl

@@ -131,7 +131,7 @@
 						{{if not .IsTag}}
 							<a class="title" href="{{$.RepoLink}}/src/{{.TagName | PathEscapeSegments}}">{{.Title | RenderEmoji}}</a>
 						{{end}}
-						{{TimeSinceUnix .CreatedUnix $.Lang}}
+						{{TimeSinceUnix .CreatedUnix $.i18n.Lang}}
 					</p>
 				{{end}}
 			</div>
@@ -150,7 +150,7 @@
 					<p class="desc">
 						<span class="ui purple label">{{$.i18n.Tr "repo.activity.merged_prs_label"}}</span>
 						#{{.Index}} <a class="title" href="{{$.RepoLink}}/pulls/{{.Index}}">{{.Issue.Title | RenderEmoji}}</a>
-						{{TimeSinceUnix .MergedUnix $.Lang}}
+						{{TimeSinceUnix .MergedUnix $.i18n.Lang}}
 					</p>
 				{{end}}
 			</div>
@@ -169,7 +169,7 @@
 					<p class="desc">
 						<span class="ui green label">{{$.i18n.Tr "repo.activity.opened_prs_label"}}</span>
 						#{{.Index}} <a class="title" href="{{$.RepoLink}}/pulls/{{.Index}}">{{.Issue.Title | RenderEmoji}}</a>
-						{{TimeSinceUnix .Issue.CreatedUnix $.Lang}}
+						{{TimeSinceUnix .Issue.CreatedUnix $.i18n.Lang}}
 					</p>
 				{{end}}
 			</div>
@@ -188,7 +188,7 @@
 					<p class="desc">
 						<span class="ui red label">{{$.i18n.Tr "repo.activity.closed_issue_label"}}</span>
 						#{{.Index}} <a class="title" href="{{$.RepoLink}}/issues/{{.Index}}">{{.Title | RenderEmoji}}</a>
-						{{TimeSinceUnix .ClosedUnix $.Lang}}
+						{{TimeSinceUnix .ClosedUnix $.i18n.Lang}}
 					</p>
 				{{end}}
 			</div>
@@ -207,7 +207,7 @@
 					<p class="desc">
 						<span class="ui green label">{{$.i18n.Tr "repo.activity.new_issue_label"}}</span>
 						#{{.Index}} <a class="title" href="{{$.RepoLink}}/issues/{{.Index}}">{{.Title | RenderEmoji}}</a>
-						{{TimeSinceUnix .CreatedUnix $.Lang}}
+						{{TimeSinceUnix .CreatedUnix $.i18n.Lang}}
 					</p>
 				{{end}}
 			</div>
@@ -231,7 +231,7 @@
 						{{else}}
 						<a class="title" href="{{$.RepoLink}}/issues/{{.Index}}">{{.Title | RenderEmoji}}</a>
 						{{end}}
-						{{TimeSinceUnix .UpdatedUnix $.Lang}}
+						{{TimeSinceUnix .UpdatedUnix $.i18n.Lang}}
 					</p>
 				{{end}}
 			</div>

templates/repo/commit_page.tmpl

@@ -47,7 +47,7 @@
 						{{avatarByEmail .Commit.Author.Email .Commit.Author.Email 28 "mr-3"}}
 						<strong>{{.Commit.Author.Name}}</strong>
 					{{end}}
-					<span class="text grey ml-3" id="authored-time">{{TimeSince .Commit.Author.When $.Lang}}</span>
+					<span class="text grey ml-3" id="authored-time">{{TimeSince .Commit.Author.When $.i18n.Lang}}</span>
 					{{if or (ne .Commit.Committer.Name .Commit.Author.Name) (ne .Commit.Committer.Email .Commit.Author.Email)}}
 						<span class="text grey mx-3">{{.i18n.Tr "repo.diff.committed_by"}}</span>
 						{{if ne .Verification.CommittingUser.ID 0}}
@@ -169,7 +169,7 @@
 				{{else}}
 					<strong>{{.NoteCommit.Author.Name}}</strong>
 				{{end}}
-				<span class="text grey" id="note-authored-time">{{TimeSince .NoteCommit.Author.When $.Lang}}</span>
+				<span class="text grey" id="note-authored-time">{{TimeSince .NoteCommit.Author.When $.i18n.Lang}}</span>
 			</div>
 			<div class="ui bottom attached info segment git-notes">
 				<pre class="commit-body">{{RenderNote $.Context .Note $.RepoLink $.Repository.ComposeMetas}}</pre>