i18n.go

package common

import (
	"bufio"
	"cloud.google.com/go/translate"
	"context"
	"flag"
	"fmt"
	"github.com/fatih/structtag"
	"github.com/go-ini/ini"
	googlelanguage "golang.org/x/text/language"
	"google.golang.org/api/option"
	"html"
	"io"
	"os"
	"os/exec"
	"path/filepath"
	"reflect"
	"regexp"
	"strings"
	"time"
)

var (
	FlagLanguage   *string
	systemLanguage string
	i18nFile       *ini.File
)

const (
	DEFAULT_LANGUAGE = "en"

	FlagNameAppLanguage = "app.language"
)

func init() {
	FlagLanguage = flag.String(FlagNameAppLanguage, DEFAULT_LANGUAGE, "language for messages")

	Events.AddListener(EventFlagsSet{}, func(ev Event) {
		initLanguage()
	})
}

// GetSystemLanguage return BCP 47 standard language name
func GetSystemLanguage() (string, error) {
	DebugFunc()

	if IsWindowsOS() {
		cmd := exec.Command("powershell", "Get-WinSystemLocale")

		ba, err := NewWatchdogCmd(cmd, time.Second*3)
		if Error(err) {
			return "", err
		}

		output := string(ba)

		r := bufio.NewReader(strings.NewReader(output))

		b := false

		for {
			line, err := r.ReadString('\n')
			if err == io.EOF {
				break
			}

			if b {
				p := strings.Index(line, " ")

				systemLanguage = strings.TrimSpace(line[p:])
				p = strings.Index(systemLanguage, " ")
				systemLanguage = strings.TrimSpace(systemLanguage[:p])

				p = strings.Index(systemLanguage, "-")
				if p != -1 {
					systemLanguage = systemLanguage[:p]
				}

				DebugFunc(systemLanguage)

				return systemLanguage, nil
			} else {
				b = strings.HasPrefix(line, "----")
			}
		}
	} else {
		_, err := exec.LookPath("locale")
		if err != nil {
			return "en", nil
		}

		cmd := exec.Command("locale")

		ba, err := NewWatchdogCmd(cmd, time.Second)
		if Error(err) {
			return "", err
		}

		output := strings.TrimSpace(string(ba))

		r := bufio.NewReader(strings.NewReader(output))

		for {
			line, err := r.ReadString('\n')
			if err == io.EOF {
				break
			}

			if strings.HasPrefix(line, "LANGUAGE=") || strings.HasPrefix(line, "LANG=") {
				systemLanguage := strings.TrimSpace(line[strings.Index(line, "=")+1:])

				p := strings.Index(systemLanguage, "_")
				if p != -1 {
					systemLanguage = systemLanguage[:p]
				}

				DebugFunc(systemLanguage)

				return systemLanguage, nil
			}
		}
	}

	return "", fmt.Errorf("cannot get system language")
}

func initLanguage() {
	ba, _, _ := ReadResource(AppFilename(".i18n"))

	if ba != nil {
		var err error

		i18nFile, err = ini.Load(ba)
		if DebugError(err) {
			return
		}

		lang := *FlagLanguage
		if lang == "" {
			lang = DEFAULT_LANGUAGE
		}

		if lang != "" {
			Error(SetLanguage(lang))
		}
	}
}

func scanStruct(i18ns *[]string, data interface{}) error {
	return IterateStruct(data, func(fieldPath string, fieldType reflect.StructField, fieldValue reflect.Value) error {
		fieldTags, err := structtag.Parse(string(fieldType.Tag))
		if Error(err) {
			return err
		}

		tagHtml, err := fieldTags.Get("html")
		if err != nil {
			return nil
		}

		for _, i18n := range *i18ns {
			if i18n == tagHtml.Name {
				continue
			}
		}

		*i18ns = append(*i18ns, tagHtml.Name)

		return nil
	})
}

// SetLanguage sets the language file to translation
func SetLanguage(lang string) error {
	DebugFunc(lang)

	if i18nFile == nil {
		return fmt.Errorf("no language file available")
	}

	sec, _ := i18nFile.GetSection(lang)
	if sec == nil {
		return fmt.Errorf("language %s is not available", lang)
	}

	*FlagLanguage = lang

	return nil
}

// GetLanguages lists all available languages
func GetLanguages() ([]string, error) {
	list := make([]string, 0)

	if i18nFile != nil {
		for _, sec := range i18nFile.Sections() {
			if sec.Name() != ini.DefaultSection {
				list = append(list, sec.Name())
			}
		}
	} else {
		list = append(list, DEFAULT_LANGUAGE)
	}

	SortStringsCaseInsensitive(list)

	return list, nil
}

func TranslateFor(language, msg string) string {
	if i18nFile != nil && language != "" {
		sec, _ := i18nFile.GetSection(language)
		if sec != nil {
			m, err := sec.GetKey(msg)

			if err == nil && m.Value() != "" {
				return m.Value()
			}
		}
	}

	return msg
}

// Translate a message to the current set language
func Translate(msg string, args ...interface{}) string {
	if msg == "" {
		return ""
	}

	t := TranslateFor(*FlagLanguage, msg)

	return Capitalize(fmt.Sprintf(t, args...))
}

func GoogleTranslate(googleApiKey string, text string, foreignLanguage string) (string, error) {
	DebugFunc("%s -> %s ...", text, foreignLanguage)

	ctx := context.Background()

	// Creates a client.
	client, err := translate.NewClient(ctx, option.WithAPIKey(googleApiKey))
	if Error(err) {
		return "", err
	}

	source, err := googlelanguage.Parse("en")
	if Error(err) {
		return "", err
	}

	// Sets the target language.
	target, err := googlelanguage.Parse(foreignLanguage)
	if Error(err) {
		return "", err
	}

	// Translates the text
	translations, err := client.Translate(ctx, []string{text}, target, &translate.Options{
		Source: source,
		Format: "",
		Model:  "",
	})
	if Error(err) {
		return "", err
	}

	term := html.UnescapeString(translations[0].Text)

	if strings.Index(foreignLanguage, "-") == -1 {
		term = strings.ReplaceAll(term, "-", " ")
	}
	term = strings.ReplaceAll(term, " / ", "/")

	DebugFunc("%s -> %s: %s", text, foreignLanguage, term)

	return term, nil
}

func CreateI18nFile(path string, objs ...interface{}) error {
	googleApiKey, ok := os.LookupEnv("GOOGLE_API_KEY")
	if !ok {
		return fmt.Errorf("Failed to get Google API key from env: GOOGLE_API_KEY")
	}

	filename := filepath.Join(path, AppFilename(".i18n"))

	i18ns := make([]string, 0)

	//get i18n from source

	rxs := []*regexp.Regexp{regexp.MustCompile("Translate\\(\"(.*?)\""), regexp.MustCompile("TranslateFor\\(.*\"(.*?)\"")}
	regexSubstitution := regexp.MustCompile("\\%[^v]")

	paths := []string{"*.go", "../common/*.go"}

	for _, path := range paths {
		err := WalkFiles(path, true, false, func(path string, f os.FileInfo) error {
			if f.IsDir() {
				return nil
			}

			Debug("extract i18n from source file: %s", path)

			ba, err := os.ReadFile(path)
			if Error(err) {
				return err
			}

			for _, regexTranslate := range rxs {
				findings := regexTranslate.FindAll(ba, -1)
				if findings == nil {
					return nil
				}

				for _, f := range findings {
					finding := string(f)

					finding = finding[strings.Index(finding, "\"")+1 : len(finding)-1]

					if regexSubstitution.Match([]byte(finding)) {
						return fmt.Errorf("invalid substitution: %s", finding)
					}

					i18ns = append(i18ns, finding)
				}
			}

			return nil
		})
		if Error(err) {
			return err
		}
	}

	for _, obj := range objs {
		err := scanStruct(&i18ns, obj)
		if Error(err) {
			return err
		}
	}

	SortStringsCaseInsensitive(i18ns)

	// remove duplicates

	r, err := regexp.Compile("\\%[^v%]")
	if Error(err) {
		return err
	}

	for i := 1; i < len(i18ns); i++ {
		if r.Match([]byte(i18ns[i])) {
			return fmt.Errorf("invalid substitution parameter found: %s", i18ns[i])
		}

		if i18ns[i] == i18ns[i-1] {
			if i+1 == len(i18ns) {
				i18ns = i18ns[0 : len(i18ns)-1]
			} else {
				i18ns = append(i18ns[:i], i18ns[i+1:]...)
				i--
			}
		}
	}

	SortStringsCaseInsensitive(i18ns)

	if i18nFile == nil {
		i18nFile = ini.Empty()
	}

	// remove non existing i18ns from list

	for _, sec := range i18nFile.Sections() {
		if sec.Name() != ini.DefaultSection {
			keys := sec.KeyStrings()

			for _, key := range keys {
				found := false

				for _, i18n := range i18ns {
					found = i18n == key
					if found {
						break
					}
				}

				if !found {
					sec.DeleteKey(key)
				}
			}
		}
	}

	// update all languages with found i18ns

	secNames := []string{DEFAULT_LANGUAGE, "nl", "it", "el", "es", "ar", "zh", "fr", "th", "de"}
	for _, sec := range i18nFile.Sections() {
		if sec.Name() != ini.DefaultSection {
			if IndexOf(secNames, sec) == -1 {
				secNames = append(secNames, sec.Name())
			}
		}
	}

	for _, i18n := range i18ns {
		for _, secName := range secNames {
			foreignLanguage := secName
			p := strings.Index(foreignLanguage, "-")
			if p != -1 {
				foreignLanguage = foreignLanguage[:p]
			}

			sec, _ := i18nFile.GetSection(secName)
			if sec == nil {
				sec, _ = i18nFile.NewSection(secName)
			}

			key, _ := sec.GetKey(i18n)
			value := ""

			if key != nil {
				value = key.String()
			}

			if value == "" {
				if secName == DEFAULT_LANGUAGE {
					value = i18n
				} else {
					var err error

					value, err = GoogleTranslate(googleApiKey, strings.ReplaceAll(i18n, "%v", "XXX"), foreignLanguage)
					if Error(err) {
						value = ""
					} else {
						value = strings.ReplaceAll(value, "XXX", "%v")
					}
				}
			}

			if key == nil {
				_, err := i18nFile.Section(sec.Name()).NewKey(i18n, value)
				if Error(err) {
					return err
				}
			} else {
				i18nFile.Section(sec.Name()).Key(i18n).SetValue(value)
			}
		}
	}

	sortedFile := ini.Empty()

	for _, sec := range i18nFile.Sections() {
		if sec.Name() != ini.DefaultSection {
			keys := sec.KeyStrings()

			SortStringsCaseInsensitive(keys)

			newSec, err := sortedFile.NewSection(sec.Name())
			if Error(err) {
				return err
			}

			for _, key := range keys {
				k, err := sec.GetKey(key)
				if Error(err) {
					return err
				}

				_, err = newSec.NewKey(key, k.String())
				if Error(err) {
					return err
				}
			}
		}
	}

	i18nFile = sortedFile

	Debug("update i18n file: %s", filename)

	err = i18nFile.SaveTo(filename)
	if Error(err) {
		return err
	}

	return nil
}