URTrator now can be translated.

translator/exported.go

@@ -0,0 +1,15 @@
+// URTator - Urban Terror server browser and game launcher, written in
+// Go.
+//
+// Copyright (c) 2016, Stanslav N. a.k.a pztrn (or p0z1tr0n)
+// All rights reserved.
+//
+// Licensed under Terms and Conditions of GNU General Public License
+// version 3 or any higher.
+// ToDo: put full text of license here.
+package translator
+
+func New() *Translator {
+    t := Translator{}
+    return &t
+}

translator/translator.go

@@ -0,0 +1,127 @@
+// URTator - Urban Terror server browser and game launcher, written in
+// Go.
+//
+// Copyright (c) 2016, Stanslav N. a.k.a pztrn (or p0z1tr0n)
+// All rights reserved.
+//
+// Licensed under Terms and Conditions of GNU General Public License
+// version 3 or any higher.
+// ToDo: put full text of license here.
+
+// This is translator - package which translates everything in languages
+// other than en_US.
+// Available only on unixes for now, Windows version in ToDo.
+package translator
+
+import (
+    // stdlib
+    "encoding/json"
+    "fmt"
+    "io/ioutil"
+    "path/filepath"
+    "strings"
+)
+
+type Translator struct {
+    // Currently active language.
+    Language string
+    // Translations.
+    translations map[string]map[string]string
+    // Path to translations files.
+    translationsPath string
+}
+
+// Formats string from passed map.
+// We expect replaceable strings to be named as:
+//
+//      {{ VAR }}
+//
+// We will change whole "{{ VAR }}" to params["VAR"] value. E.g.:
+//
+//      data = "Version {{ version }}"
+//      map = map[string]string{"version": "0.1"}
+//
+// will be formatted as:
+//
+//      result = "Version 0.1"
+//
+// Also note that we will replace ALL occurences of "{{ VAR }}" within string!
+// All untranslated variables will not be touched at all.
+func (t *Translator) formatFromMap(data string, params map[string]string) string {
+    new_data := data
+    for k, v := range params {
+        new_data = strings.Replace(new_data, "{{ " + k + " }}", v, -1)
+    }
+    return new_data
+}
+
+// Translator initialization.
+func (t *Translator) Initialize() {
+    fmt.Println("Initializing translations...")
+
+    // Initialize storages.
+    t.translations = make(map[string]map[string]string)
+    t.translationsPath = ""
+
+    // Getting locale name from environment.
+    // ToDo: Windows compatability. Possible reference:
+    // https://github.com/cloudfoundry-attic/jibber_jabber/blob/master/jibber_jabber_windows.go
+    t.detectLanguage()
+
+    fmt.Println("Using translations for '" + t.Language + "'")
+
+    err := t.detectTranslationsDirectory()
+    if err == nil {
+        t.loadTranslations()
+    } else {
+        fmt.Println("Skipping translations loading due to missing translations directory.")
+    }
+}
+
+// Load translations into memory.
+func (t *Translator) loadTranslations() {
+    fmt.Println("Loading translations for language " + t.Language)
+
+    t.translations[t.Language] = make(map[string]string)
+
+    if t.translationsPath != "" {
+        files_list, _ := ioutil.ReadDir(t.translationsPath)
+        if len(files_list) > 0 {
+            for i := range files_list {
+                // Read file.
+                file_path := filepath.Join(t.translationsPath, files_list[i].Name())
+                file_data, _ := ioutil.ReadFile(file_path)
+                var trans map[string]string
+                json.Unmarshal(file_data, &trans)
+                // Assign parsed translations to language code.
+                t.translations[t.Language] = trans
+            }
+        }
+    }
+}
+
+// Actual translation function.
+// Parameters:
+//   * str - raw string from source which we will try to translate.
+//   * params - map[string]string with parameters to replace in string.
+//
+// If string wasn't found in loaded translations for current language
+// we will use English as fallback.
+// Translates passed data from loaded translations file.
+// Returns passed data without changes if translation wasn't found.
+func (t *Translator) Translate(data string, params map[string]string) string {
+    val, ok := t.translations[t.Language][data]
+    if !ok {
+        if params != nil && len(params) > 0 {
+            return t.formatFromMap(data, params)
+        } else {
+            return data
+        }
+    }
+
+    if params != nil && len(params) > 0 {
+        return t.formatFromMap(val, params)
+    }
+
+    return val
+}

translator/translator_unix.go

@@ -0,0 +1,90 @@
+// URTator - Urban Terror server browser and game launcher, written in
+// Go.
+//
+// Copyright (c) 2016-2017, Stanislav N. aka pztrn.
+// All rights reserved.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+// +build !windows
+
+package translator
+
+import (
+    // stdlib
+    "errors"
+    "fmt"
+    "os"
+    "path/filepath"
+    "strings"
+)
+
+// Detect language on Unices.
+func (t *Translator) detectLanguage() {
+    // Use LC_ALL first.
+    t.Language = os.Getenv("LC_ALL")
+    // If LC_ALL is empty - use LANG.
+    if t.Language == "" {
+        t.Language = os.Getenv("LANG")
+    }
+
+    // If still nothing - force "en_US" as default locale. Otherwise
+    // split language string by "." and take first part.
+    // Note: en_US is a default thing, so you will not found anything
+    // in "translations" directory!
+    if t.Language == "" {
+        fmt.Println("No locale data for current user found, using default (en_US)...")
+        t.Language = "en_US"
+    } else {
+        t.Language = strings.Split(t.Language, ".")[0]
+    }
+}
+
+func (t *Translator) detectTranslationsDirectory() error {
+    // Try to use directory near binary.
+    dir, _ := filepath.Abs(filepath.Dir(os.Args[0]))
+    // ..which can be overriden by URTRATOR_BINDIR environment variable.
+    // Useful for developers.
+    envdir := os.Getenv("URTRATOR_BINDIR")
+    if envdir != "" {
+        dir = envdir
+    }
+
+    translations_dir := filepath.Join(dir, "translations")
+    _, err := os.Stat(translations_dir)
+    if err != nil {
+        fmt.Println("Translations wasn't found near binary!")
+        // As we're using JSON translation storage, it should be
+        // put in /usr/share/urtrator/translations by package
+        // maintainers in distros.
+        fmt.Println("Trying /usr/share/urtrator/translations...")
+        _, err := os.Stat("/usr/share/urtrator/translations")
+        if err != nil {
+            t.Language = "en_US"
+            fmt.Println("Translations unavailable, forcing en_US language code")
+        } else {
+            t.translationsPath = "/usr/share/urtrator/translations"
+        }
+    } else {
+        t.translationsPath = translations_dir
+    }
+
+    if t.translationsPath != "" {
+        t.translationsPath = filepath.Join(t.translationsPath, t.Language)
+    } else {
+        return errors.New("No translations directory was detected!")
+    }
+
+    return nil
+}

translator/translator_windows.go

@@ -0,0 +1,43 @@
+// URTator - Urban Terror server browser and game launcher, written in
+// Go.
+//
+// Copyright (c) 2016-2017, Stanislav N. aka pztrn.
+// All rights reserved.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+// +build windows
+
+package translator
+
+import (
+    // stdlib
+    "errors"
+    "fmt"
+    "os"
+)
+
+// Detect language on Unices.
+func (t *Translator) detectLanguage() {
+    fmt.Println("ToDo! Forcing en_US for now!")
+    t.Language = "en_US"
+}
+
+func (t *Translator) detectTranslationsDirectory() error {
+    // Translations MUST reside in directory neear binary!
+    // ToDo: more checks.
+    t.translationsPath, _ := filepath.Abs(filepath.Dir(os.Args[0]))
+
+    return nil
+}