+ ircbot logging: atomic multiline log records
[rbot] / lib / rbot / language.rb
1 #-- vim:sw=2:et
2 #++
3 #
4 # :title: Language module for rbot
5 #
6 # This module takes care of language handling for rbot:
7 # setting the core.language value, loading the appropriate
8 # .lang file etc.
9
10 module Irc
11 class Bot
12   class Language
13
14     # This constant hash holds the mapping
15     # from long language names to the usual POSIX
16     # locale specifications
17     Lang2Locale = {
18       :english  => 'en',
19       :british_english  => 'en_GB',
20       :american_english  => 'en_US',
21       :italian  => 'it',
22       :french   => 'fr',
23       :german   => 'de',
24       :dutch    => 'nl',
25       :japanese => 'ja',
26       :russian  => 'ru',
27       :traditional_chinese => 'zh_TW',
28       :simplified_chinese => 'zh_CN'
29     }
30     # On WIN32 it appears necessary to have ".UTF-8" explicitly for gettext to use UTF-8
31     Lang2Locale.each_value {|v| v.replace(v + '.UTF-8')}
32
33     # Return the shortest language for the current
34     # GetText locale
35     def Language.from_locale
36       return 'english' unless defined?(GetText)
37       lang = locale.language
38       if locale.country
39         str = lang + "_#{locale.country}"
40         if Lang2Locale.value?(str)
41           # Get the shortest key in Lang2Locale which maps to the given lang_country
42           lang_str = Lang2Locale.select { |k, v| v == str }.transpose.first.map { |v| v.to_s }.sort { |a, b| a.length <=> b.length }.first
43           if File.exist?(File.join(Config::datadir, "languages/#{lang_str}.lang"))
44             return lang_str
45           end
46         end
47       end
48       # lang_country didn't work, let's try lan
49       if Lang2Locale.value?(lang)
50         # Get the shortest key in Lang2Locale which maps to the given lang
51         lang_str = Lang2Locale.select { |k, v| v == lang }.transpose.first.map { |v| v.to_s }.sort { |a, b| a.length <=> b.length }.first
52         if File.exist?(File.join(Config::datadir, "/languages/#{lang_str}.lang"))
53           return lang_str
54         end
55       end
56       # all else fail, return 'english'
57       return 'english'
58     end
59
60     Config.register Config::EnumValue.new('core.language', 
61       :default => Irc::Bot::Language.from_locale, :wizard => true,
62       :values => Proc.new{|bot|
63             Dir.new(Config::datadir + "/languages").collect {|f|
64               f =~ /\.lang$/ ? f.gsub(/\.lang$/, "") : nil
65             }.compact
66           },   
67       :on_change => Proc.new {|bot, v| bot.lang.set_language v},
68       :desc => "Which language file the bot should use")
69     
70     def initialize(bot, language)
71       @bot = bot
72       set_language language
73     end
74     attr_reader :language
75
76     def set_language(language)
77       lang_str = language.to_s.downcase.gsub(/\s+/,'_')
78       lang_sym = lang_str.intern
79       if defined?(GetText) and Lang2Locale.key?(lang_sym)
80         setlocale(Lang2Locale[lang_sym])
81         debug "locale set to #{locale}"
82         rbot_gettext_debug
83       else
84         warning "Unable to set locale, unknown language #{language} (#{lang_str})"
85       end
86
87       file = Config::datadir + "/languages/#{lang_str}.lang"
88       unless(FileTest.exist?(file))
89         raise "no such language: #{lang_str} (no such file #{file})"
90       end
91       @language = lang_str
92       @file = file
93       scan
94       return if @bot.plugins.nil?
95       @bot.plugins.core_modules.each { |p|
96         if p.respond_to?('set_language')
97           p.set_language(@language)
98         end
99       }
100       @bot.plugins.plugins.each { |p|
101         if p.respond_to?('set_language')
102           p.set_language(@language)
103         end
104       }
105     end
106
107     def scan
108       @strings = Hash.new
109       current_key = nil
110       IO.foreach(@file) {|l|
111         next if l =~ /^$/
112         next if l =~ /^\s*#/
113         if(l =~ /^(\S+):$/)
114           @strings[$1] = Array.new
115           current_key = $1
116         elsif(l =~ /^\s*(.*)$/)
117           @strings[current_key] << $1
118         end
119       }
120     end
121
122     def rescan
123       scan
124     end
125
126     def get(key)
127       if(@strings.has_key?(key))
128         return @strings[key][rand(@strings[key].length)]
129       else
130         raise "undefined language key"
131       end
132     end
133
134     def save
135       File.open(@file, "w") {|file|
136         @strings.each {|key,val|
137           file.puts "#{key}:"
138           val.each_value {|v|
139             file.puts "   #{v}"
140           }
141         }
142       }
143     end
144   end
145
146 end
147 end