/
i18n.go
362 lines (290 loc) · 7.39 KB
/
i18n.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
/*
Package i18n is a simple language manager, use INI format file.
Source code and other details for the project are available at GitHub:
https://github.com/gookit/i18n
lang files:
conf/
lang/
en.ini
zh-CN.ini
init:
import "github/gookit/i18n"
languages := map[string]string{
"en": "English",
"zh-CN": "简体中文",
"zh-TW": "繁体中文",
}
i18n.Init("conf/lang", "en", languages)
usage:
// translate from special language
val := i18n.Tr("en", "key")
// translate from default language
val := i18n.DefTr("key")
*/
package i18n
import (
"bytes"
"errors"
"fmt"
"github.com/gookit/ini"
"io/ioutil"
"os"
"strings"
)
// language file load mode
const (
// language name is file name. "en" -> "lang/en.ini"
FileMode uint8 = 0
// language name is dir name, will load all file in the dir. "en" -> "lang/en/*.ini"
DirMode uint8 = 1
)
// I18n language manager
type I18n struct {
// languages data
data map[string]*ini.Ini
// language files directory
langDir string
// language list {en:English, zh-CN:简体中文}
languages map[string]string
// loaded lang files
// loadedFiles []string
// mode for the load language files. mode: 0 single file, 1 multi dir
LoadMode uint8
// default language name. eg. "en"
DefaultLang string
// spare(fallback) language name. eg. "en"
FallbackLang string
}
/************************************************************
* default instance
************************************************************/
// default instance
var defI18n = NewEmpty()
// Instance get default i18n instance
func Instance() *I18n {
return defI18n
}
// Tr translate language key to value string
func Tr(lang string, key string, args ...interface{}) string {
return defI18n.Tr(lang, key, args...)
}
// DefTr translate language key from default language
func DefTr(key string, args ...interface{}) string {
return defI18n.DefTr(key, args...)
}
// Init the default language instance
func Init(langDir string, defLang string, languages map[string]string) *I18n {
defI18n.langDir = langDir
defI18n.languages = languages
defI18n.DefaultLang = defLang
return defI18n.Init()
}
/************************************************************
* create instance
************************************************************/
// New a i18n instance
func New(langDir string, defLang string, languages map[string]string) *I18n {
return &I18n{
data: make(map[string]*ini.Ini, 0),
langDir: langDir,
languages: languages,
DefaultLang: defLang,
}
}
// NewEmpty a empty i18n instance
func NewEmpty() *I18n {
return &I18n{
data: make(map[string]*ini.Ini, 0),
languages: make(map[string]string, 0),
}
}
// NewWithInit a i18n instance and call init
func NewWithInit(langDir string, defLang string, languages map[string]string) *I18n {
m := New(langDir, defLang, languages)
return m.Init()
}
/************************************************************
* translate
************************************************************/
// DefTr translate from default lang
func (l *I18n) DefTr(key string, args ...interface{}) string {
return l.Tr(l.DefaultLang, key, args...)
}
// Tr translate from a lang by key
// site.name => [site]
// name = my blog
func (l *I18n) Tr(lang, key string, args ...interface{}) string {
if !l.HasLang(lang) {
// find from fallback lang
val := l.transFromFallback(key)
if val == "" {
return key
}
// if has args
if len(args) > 0 {
val = fmt.Sprintf(val, args...)
}
return val
}
val, ok := l.data[lang].Get(key)
if !ok {
// find from fallback lang
val = l.transFromFallback(key)
if val == "" {
return key
}
}
// if has args
if len(args) > 0 {
val = fmt.Sprintf(val, args...)
}
return val
}
// HasKey in the language data
func (l *I18n) HasKey(lang, key string) (ok bool) {
if !l.HasLang(lang) {
return
}
_, ok = l.data[lang].Get(key)
return
}
// translate from fallback language
func (l *I18n) transFromFallback(key string) (val string) {
fb := l.FallbackLang
if !l.HasLang(fb) {
return
}
return l.data[fb].MustString(key)
}
/************************************************************
* data manage
************************************************************/
// Init load add language files
func (l *I18n) Init() *I18n {
if l.LoadMode == FileMode {
l.loadSingleFiles()
} else if l.LoadMode == DirMode {
l.loadDirFiles()
} else {
panic("invalid load mode setting. only allow 0, 1")
}
return l
}
// load language files when LoadMode is 0
func (l *I18n) loadSingleFiles() {
pathSep := string(os.PathSeparator)
for lang := range l.languages {
lData, err := ini.LoadFiles(l.langDir + pathSep + lang + ".ini")
if err != nil {
panic("fail to load language: " + lang + ", error " + err.Error())
}
l.data[lang] = lData
}
}
// load language files when LoadMode is 1
func (l *I18n) loadDirFiles() {
pathSep := string(os.PathSeparator)
for lang := range l.languages {
dirPath := l.langDir + pathSep + lang
files, err := ioutil.ReadDir(dirPath)
if err != nil {
panic("read dir fail: " + dirPath + ", error " + err.Error())
}
sl := l.data[lang]
for _, fi := range files {
// skip dir and filter the specified format
if fi.IsDir() || !strings.HasSuffix(fi.Name(), ".ini") {
continue
}
var err error
if sl != nil {
err = sl.LoadFiles(dirPath + pathSep + fi.Name())
} else {
sl, err = ini.LoadFiles(dirPath + pathSep + fi.Name())
l.data[lang] = sl
}
if err != nil {
panic("fail to load language file: " + lang + ", error " + err.Error())
}
}
}
}
// Add new language
func (l *I18n) Add(lang string, name string) {
l.NewLang(lang, name)
}
// NewLang create/add a new language
// usage:
// i18n.NewLang("zh-CN", "简体中文")
func (l *I18n) NewLang(lang string, name string) {
// lang exist
if _, ok := l.languages[lang]; ok {
return
}
l.data[lang] = ini.New()
l.languages[lang] = name
}
// LoadFile append data to a exist language
// usage:
// i18n.LoadFile("zh-CN", "path/to/zh-CN.ini")
func (l *I18n) LoadFile(lang string, file string) (err error) {
// append data
if ld, ok := l.data[lang]; ok {
err = ld.LoadFiles(file)
if err != nil {
return
}
} else {
err = errors.New("language" + lang + " not exist, please create it before load data")
}
return
}
// LoadString load language data form a string
// usage:
// i18n.Set("zh-CN", "name = blog")
func (l *I18n) LoadString(lang string, data string) (err error) {
// append data
if ld, ok := l.data[lang]; ok {
err = ld.LoadStrings(data)
if err != nil {
return
}
} else {
err = errors.New("language" + lang + " not exist, please create it before load data")
}
return
}
// Lang get language data instance
func (l *I18n) Lang(lang string) *ini.Ini {
if _, ok := l.languages[lang]; ok {
return l.data[lang]
}
return nil
}
// Export a language data as INI string
func (l *I18n) Export(lang string) string {
if _, ok := l.languages[lang]; !ok {
return ""
}
var buf bytes.Buffer
l.data[lang].WriteTo(&buf)
return buf.String()
}
// HasLang in the manager
func (l *I18n) HasLang(lang string) bool {
_, ok := l.languages[lang]
return ok
}
// DelLang from the i18n manager
func (l *I18n) DelLang(lang string) bool {
_, ok := l.languages[lang]
if ok {
delete(l.data, lang)
delete(l.languages, lang)
}
return ok
}
// Languages get all languages
func (l *I18n) Languages() map[string]string {
return l.languages
}