4 # :title: Translator plugin for rbot
6 # Author:: Yaohan Chen <yaohan.chen@gmail.com>
7 # Copyright:: (C) 2007 Yaohan Chen
10 # This plugin allows using rbot to translate text on a few translation services
14 # * Configuration for whether to show translation engine
15 # * Optionally sync default translators with karma.rb ranking
20 # base class for implementing a translation service
22 # direction:: supported translation directions, a hash where each key is a source
23 # language name, and each value is Set of target language names. The
24 # methods in the Direction module are convenient for initializing this
27 INFO = 'Some translation service'
29 class UnsupportedDirectionError < ArgumentError
32 class NoTranslationError < RuntimeError
35 attr_reader :directions, :cache
37 def initialize(directions, cache={})
38 @directions = directions
43 # whether the translator supports this direction
44 def support?(from, to)
45 from != to && @directions[from].include?(to)
48 # this implements argument checking and caching. subclasses should define the
49 # do_translate method to implement actual translation
50 def translate(text, from, to)
51 raise UnsupportedDirectionError unless support?(from, to)
52 raise ArgumentError, _("Cannot translate empty string") if text.empty?
53 request = [text, from, to]
54 unless @cache.has_key? request
55 translation = do_translate(text, from, to)
56 raise NoTranslationError if translation.empty?
57 @cache[request] = translation
64 # given the set of supported languages, return a hash suitable for the directions
65 # attribute which includes any language to any other language
66 def self.all_to_all(languages)
67 directions = all_to_none(languages)
68 languages.each {|l| directions[l] = languages.to_set}
72 # a hash suitable for the directions attribute which includes any language from/to
73 # the given set of languages (center_languages)
74 def self.all_from_to(languages, center_languages)
75 directions = all_to_none(languages)
76 center_languages.each {|l| directions[l] = languages - [l]}
77 (languages - center_languages).each {|l| directions[l] = center_languages.to_set}
81 # get a hash from a list of pairs
82 def self.pairs(list_of_pairs)
83 languages = list_of_pairs.flatten.to_set
84 directions = all_to_none(languages)
85 list_of_pairs.each do |(from, to)|
86 directions[from] << to
91 # an empty hash with empty sets as default values
92 def self.all_to_none(languages)
94 # always return empty set when the key is non-existent, but put empty set in the
95 # hash only if the key is one of the languages
96 if languages.include? k
107 class NiftyTranslator < Translator
108 INFO = '@nifty Translation <http://nifty.amikai.com/amitext/indexUTF8.jsp>'
110 def initialize(cache={})
112 super(Translator::Direction.all_from_to(%w[ja en zh_CN ko], %w[ja]), cache)
113 @form = WWW::Mechanize.new.
114 get('http://nifty.amikai.com/amitext/indexUTF8.jsp').
115 forms_with(:name => 'translateForm').last
118 def do_translate(text, from, to)
119 @radio = @form.radiobuttons_with(:name => 'langpair').first
120 @radio.value = "#{from},#{to}".upcase
122 @form.fields_with(:name => 'sourceText').last.value = text
124 @form.submit(@form.buttons_with(:name => 'translate').last).
125 forms_with(:name => 'translateForm').last.fields_with(:name => 'translatedText').last.value
130 class ExciteTranslator < Translator
131 INFO = 'Excite.jp Translation <http://www.excite.co.jp/world/>'
133 def initialize(cache={})
137 super(Translator::Direction.all_from_to(%w[ja en zh_CN zh_TW ko], %w[ja]), cache)
139 @forms = Hash.new do |h, k|
142 h[k] = open_form('english')
143 when 'zh_CN', 'zh_TW'
144 # this way we don't need to fetch the same page twice
145 h['zh_CN'] = h['zh_TW'] = open_form('chinese')
147 h[k] = open_form('korean')
153 WWW::Mechanize.new.get("http://www.excite.co.jp/world/#{name}").
154 forms_with(:name => 'world').first
157 def do_translate(text, from, to)
158 non_ja_language = from != 'ja' ? from : to
159 form = @forms[non_ja_language]
161 if non_ja_language =~ /zh_(CN|TW)/
162 form_with_fields(:name => 'wb_lp').first.value = "#{from}#{to}".sub(/_(?:CN|TW)/, '').upcase
163 form_with_fields(:name => 'big5').first.value = ($1 == 'TW' ? 'yes' : 'no')
165 # the en<->ja page is in Shift_JIS while other pages are UTF-8
166 text = Iconv.iconv('Shift_JIS', 'UTF-8', text) if non_ja_language == 'en'
167 form.fields_with(:name => 'wb_lp').first.value = "#{from}#{to}".upcase
169 form.fields_with(:name => 'before').first.value = text
170 result = form.submit.forms_with(:name => 'world').first.fields_with(:name => 'after').first.value
171 # the en<->ja page is in Shift_JIS while other pages are UTF-8
172 if non_ja_language == 'en'
173 Iconv.iconv('UTF-8', 'Shift_JIS', result)
182 class GoogleTranslator < Translator
183 INFO = 'Google Translate <http://www.google.com/translate_t>'
185 def initialize(cache={})
189 # we can probably safely assume that google translate is able to translate from
190 # any language in the source lang drop down list to any language in the target one
191 # so we create the language pairs based on that assumption
192 sl = @source_list.options.map { |o| o.value.sub('-', '_') }
193 tl = @target_list.options.map { |o| o.value.sub('-', '_') }
194 super(Translator::Direction.all_from_to(tl, sl), cache)
198 agent = WWW::Mechanize.new
199 # without faking the user agent, Google Translate will serve non-UTF-8 text
200 agent.user_agent_alias = 'Linux Konqueror'
201 @form = agent.get('http://www.google.com/translate_t').
202 forms_with(:action => '/translate_t').first
203 @source_list = @form.fields_with(:name => 'sl').last
204 @target_list = @form.fields_with(:name => 'tl').last
207 def do_translate(text, from, to)
210 @source_list.value = from.sub('_', '-')
211 @target_list.value = to.sub('_', '-')
212 @form.fields_with(:name => 'text').last.value = text
213 @form.submit.parser.search('div#result_box').inner_html
218 class BabelfishTranslator < Translator
219 INFO = 'AltaVista Babel Fish Translation <http://babelfish.altavista.com/babelfish/>'
221 def initialize(cache)
224 @form = WWW::Mechanize.new.get('http://babelfish.altavista.com/babelfish/').
225 forms_with(:name => 'frmTrText').first
226 @lang_list = @form.fields_with(:name => 'lp').first
227 language_pairs = @lang_list.options.map {|o| o.value.split('_')}.
228 reject {|p| p.empty?}
229 super(Translator::Direction.pairs(language_pairs), cache)
232 def do_translate(text, from, to)
233 if @form.fields_with(:name => 'trtext').empty?
234 @form.add_field!('trtext', text)
236 @form.fields_with(:name => 'trtext').first.value = text
238 @lang_list.value = "#{from}_#{to}"
239 @form.submit.parser.search("div[@id='result']/div[@style]").inner_html
243 class WorldlingoTranslator < Translator
244 INFO = 'WorldLingo Free Online Translator <http://www.worldlingo.com/en/products_services/worldlingo_translator.html>'
246 LANGUAGES = %w[en fr de it pt es ru nl el sv ar ja ko zh_CN zh_TW]
247 def initialize(cache)
249 super(Translator::Direction.all_to_all(LANGUAGES), cache)
252 def translate(text, from, to)
253 response = Irc::Utils.bot.httputil.get_response(URI.escape(
254 "http://www.worldlingo.com/SEfpX0LV2xIxsIIELJ,2E5nOlz5RArCY,/texttranslate?wl_srcenc=utf-8&wl_trgenc=utf-8&wl_text=#{text}&wl_srclang=#{from.upcase}&wl_trglang=#{to.upcase}"))
255 # WorldLingo seems to respond an XML when error occurs
256 case response['Content-Type']
260 raise Translator::NoTranslationError
265 class TranslatorPlugin < Plugin
266 Config.register Config::IntegerValue.new('translator.timeout',
267 :default => 30, :validate => Proc.new{|v| v > 0},
268 :desc => _("Number of seconds to wait for the translation service before timeout"))
271 'nifty' => NiftyTranslator,
272 'excite' => ExciteTranslator,
273 'google_translate' => GoogleTranslator,
274 'babelfish' => BabelfishTranslator,
275 'worldlingo' => WorldlingoTranslator,
282 TRANSLATORS.each_pair do |name, c|
284 @translators[name] = c.new(@registry.sub_registry(name))
285 map "#{name} :from :to *phrase",
286 :action => :cmd_translate, :thread => true
288 warning _("Translator %{name} cannot be used: %{reason}") %
289 {:name => name, :reason => $!}
293 Config.register Config::ArrayValue.new('translator.default_list',
294 :default => TRANSLATORS.keys,
295 :validate => Proc.new {|l| l.all? {|t| TRANSLATORS.has_key?(t)}},
296 :desc => _("List of translators to try in order when translator name not specified"),
297 :on_change => Proc.new {|bot, v| update_default})
301 def help(plugin, topic=nil)
302 if @translators.has_key?(plugin)
303 translator = @translators[plugin]
304 _('%{translator} <from> <to> <phrase> => Look up phrase using %{info}, supported from -> to languages: %{directions}') % {
305 :translator => plugin,
306 :info => translator.class::INFO,
307 :directions => translator.directions.map do |source, targets|
308 _('%{source} -> %{targets}') %
309 {:source => source, :targets => targets.to_a.join(', ')}
313 _('Command: <translator> <from> <to> <phrase>, where <translator> is one of: %{translators}. If "translator" is used in place of the translator name, the first translator in translator.default_list which supports the specified direction will be picked automatically. Use "help <translator>" to look up supported from and to languages') %
314 {:translators => @translators.keys.join(', ')}
319 @default_translators = bot.config['translator.default_list'] & @translators.keys
322 def cmd_translator(m, params)
323 from, to = params[:from], params[:to]
324 translator = @default_translators.find {|t| @translators[t].support?(from, to)}
326 cmd_translate m, params.merge({:translator => translator, :show_provider => true})
328 m.reply _('None of the default translators (translator.default_list) supports translating from %{source} to %{target}') % {:source => from, :target => to}
332 def cmd_translate(m, params)
333 # get the first word of the command
334 tname = params[:translator] || m.message[/\A(\w+)\s/, 1]
335 translator = @translators[tname]
336 from, to, phrase = params[:from], params[:to], params[:phrase].to_s
339 translation = Timeout.timeout(@bot.config['translator.timeout']) do
340 translator.translate(phrase, from, to)
342 m.reply(if params[:show_provider]
343 _('%{translation} (provided by %{translator})') %
344 {:translation => translation, :translator => tname}
349 rescue Translator::UnsupportedDirectionError
350 m.reply _("%{translator} doesn't support translating from %{source} to %{target}") %
351 {:translator => tname, :source => from, :target => to}
352 rescue Translator::NoTranslationError
353 m.reply _('%{translator} failed to provide a translation') %
354 {:translator => tname}
355 rescue Timeout::Error
356 m.reply _('The translator timed out')
359 m.reply _('No translator called %{name}') % {:name => tname}
364 plugin = TranslatorPlugin.new
365 plugin.map 'translator :from :to *phrase',
366 :action => :cmd_translator, :thread => true