libs/web/luasrc/i18n.lua

   1 --[[
   2 LuCI - Internationalisation
   3
   4 Description:
   5 A very minimalistic but yet effective internationalisation module
   6
   7 FileId:
   8 $Id$
   9
  10 License:
  11 Copyright 2008 Steven Barth <steven@midlink.org>
  12
  13 Licensed under the Apache License, Version 2.0 (the "License");
  14 you may not use this file except in compliance with the License.
  15 You may obtain a copy of the License at
  16
  17         http://www.apache.org/licenses/LICENSE-2.0
  18
  19 Unless required by applicable law or agreed to in writing, software
  20 distributed under the License is distributed on an "AS IS" BASIS,
  21 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  22 See the License for the specific language governing permissions and
  23 limitations under the License.
  24
  25 ]]--
  26
  27 module("luci.i18n", package.seeall)
  28 require("luci.sys")
  29
  30 table   = {}
  31 i18ndir = luci.sys.libpath() .. "/i18n/"
  32 loaded  = {}
  33 context = luci.util.threadlocal()
  34 default = "en"
  35
  36 -- Clears the translation table
  37 function clear()
  38         table = {}
  39 end
  40
  41 -- Loads a translation and copies its data into the global translation table
  42 function load(file, lang, force)
  43         lang = lang or ""
  44         if force or not loaded[lang] or not loaded[lang][file] then
  45                 local f = loadfile(i18ndir .. file .. "." .. lang .. ".lua")
  46                  or loadfile(i18ndir .. file .. "." .. lang)
  47                 if f then
  48                         table[lang] = table[lang] or {}
  49                         setfenv(f, table[lang])
  50                         f()
  51                         loaded[lang] = loaded[lang] or {}
  52                         loaded[lang][file] = true
  53                         return true
  54                 else
  55                         return false
  56                 end
  57         else
  58                 return true
  59         end
  60 end
  61
  62 -- Same as load but autocompletes the filename with .LANG from config.lang
  63 function loadc(file, force)
  64         load(file, default, force)
  65         return load(file, context.lang, force)
  66 end
  67
  68 -- Sets the context language
  69 function setlanguage(lang)
  70         context.lang = lang
  71 end
  72
  73 -- Returns the i18n-value defined by "key" or if there is no such: "default"
  74 function translate(key, default)
  75         return (table[context.lang] and table[context.lang][key])
  76                 or (table[default] and table[default][key])
  77                 or default
  78 end
  79
  80 -- Translate shourtcut with sprintf/string.format inclusion
  81 function translatef(key, default, ...)
  82         return translate(key, default):format(...)
  83 end