]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/translator.rb
remove fish.rb and map translate in translator.rb
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / translator.rb
index 47ff329f08c5c944261c1805f852c466a58d8867..5f2dece7a942a8dcf014fd7e2568efaeeee6b55f 100644 (file)
@@ -8,6 +8,11 @@
 # License:: GPLv2
 #
 # This plugin allows using rbot to translate text on a few translation services
+#
+# TODO
+#
+# * Configuration for whether to show translation engine
+# * Optionally sync default translators with karma.rb ranking
 
 require 'set'
 require 'timeout'
@@ -34,7 +39,7 @@ class Translator
     @cache = cache
   end
 
+
   # whether the translator supports this direction
   def support?(from, to)
     from != to && @directions[from].include?(to)
@@ -107,15 +112,17 @@ class NiftyTranslator < Translator
    super(Translator::Direction.all_from_to(%w[ja en zh_CN ko], %w[ja]), cache)
     @form = WWW::Mechanize.new.
             get('http://nifty.amikai.com/amitext/indexUTF8.jsp').
-            forms.name('translateForm').first
+            forms_with(:name => 'translateForm').last
   end
 
   def do_translate(text, from, to)
-    @form.radiobuttons.name('langpair').value = "#{from},#{to}".upcase
-    @form.fields.name('sourceText').value = text
+    @radio = @form.radiobuttons_with(:name => 'langpair').first
+    @radio.value = "#{from},#{to}".upcase
+    @radio.check
+    @form.fields_with(:name => 'sourceText').last.value = text
 
-    @form.submit(@form.buttons.name('translate')).
-          forms.name('translateForm').fields.name('translatedText').value
+    @form.submit(@form.buttons_with(:name => 'translate').last).
+          forms_with(:name => 'translateForm').last.fields_with(:name => 'translatedText').last.value
   end
 end
 
@@ -144,7 +151,7 @@ class ExciteTranslator < Translator
 
   def open_form(name)
     WWW::Mechanize.new.get("http://www.excite.co.jp/world/#{name}").
-                   forms.name('world').first
+                   forms_with(:name => 'world').first
   end
 
   def do_translate(text, from, to)
@@ -152,15 +159,15 @@ class ExciteTranslator < Translator
     form = @forms[non_ja_language]
 
     if non_ja_language =~ /zh_(CN|TW)/
-      form.fields.name('wb_lp').value = "#{from}#{to}".sub(/_(?:CN|TW)/, '').upcase
-      form.fields.name('big5').value = ($1 == 'TW' ? 'yes' : 'no')
+      form_with_fields(:name => 'wb_lp').first.value = "#{from}#{to}".sub(/_(?:CN|TW)/, '').upcase
+      form_with_fields(:name => 'big5').first.value = ($1 == 'TW' ? 'yes' : 'no')
     else
       # the en<->ja page is in Shift_JIS while other pages are UTF-8
       text = Iconv.iconv('Shift_JIS', 'UTF-8', text) if non_ja_language == 'en'
-      form.fields.name('wb_lp').value = "#{from}#{to}".upcase
+      form.fields_with(:name => 'wb_lp').first.value = "#{from}#{to}".upcase
     end
-    form.fields.name('before').value = text
-    result = form.submit.forms.name('world').fields.name('after').value
+    form.fields_with(:name => 'before').first.value = text
+    result = form.submit.forms_with(:name => 'world').first.fields_with(:name => 'after').first.value
     # the en<->ja page is in Shift_JIS while other pages are UTF-8
     if non_ja_language == 'en'
       Iconv.iconv('UTF-8', 'Shift_JIS', result)
@@ -178,11 +185,13 @@ class GoogleTranslator < Translator
   def initialize(cache={})
     require 'mechanize'
     load_form!
-    language_pairs = @lang_list.options.map do |o|
-      # these options have values like "en|zh-CN"; map to things like ['en', 'zh_CN'].
-      o.value.split('|').map {|l| l.sub('-', '_')}
-    end
-    super(Translator::Direction.pairs(language_pairs), cache)
+
+    # we can probably safely assume that google translate is able to translate from
+    # any language in the source lang drop down list to any language in the target one
+    # so we create the language pairs based on that assumption
+    sl = @source_list.options.map { |o| o.value.sub('-', '_') }
+    tl = @target_list.options.map { |o| o.value.sub('-', '_') }
+    super(Translator::Direction.all_from_to(tl, sl), cache)
   end
 
   def load_form!
@@ -190,15 +199,17 @@ class GoogleTranslator < Translator
     # without faking the user agent, Google Translate will serve non-UTF-8 text
     agent.user_agent_alias = 'Linux Konqueror'
     @form = agent.get('http://www.google.com/translate_t').
-            forms.action('/translate_t').first
-    @lang_list = @form.fields.name('langpair')
+            forms_with(:action => '/translate_t').first
+    @source_list = @form.fields_with(:name => 'sl').last
+    @target_list = @form.fields_with(:name => 'tl').last
   end
 
   def do_translate(text, from, to)
     load_form!
 
-    @lang_list.value = "#{from}|#{to}".sub('_', '-')
-    @form.fields.name('text').value = text
+    @source_list.value = from.sub('_', '-')
+    @target_list.value = to.sub('_', '-')
+    @form.fields_with(:name => 'text').last.value = text
     @form.submit.parser.search('div#result_box').inner_html
   end
 end
@@ -209,23 +220,23 @@ class BabelfishTranslator < Translator
 
   def initialize(cache)
     require 'mechanize'
-    
+
     @form = WWW::Mechanize.new.get('http://babelfish.altavista.com/babelfish/').
-            forms.name('frmTrText').first
-    @lang_list = @form.fields.name('lp')
+            forms_with(:name => 'frmTrText').first
+    @lang_list = @form.fields_with(:name => 'lp').first
     language_pairs = @lang_list.options.map {|o| o.value.split('_')}.
                                             reject {|p| p.empty?}
     super(Translator::Direction.pairs(language_pairs), cache)
   end
 
   def do_translate(text, from, to)
-    if @form.fields.name('trtext').empty?
+    if @form.fields_with(:name => 'trtext').empty?
       @form.add_field!('trtext', text)
     else
-      @form.fields.name('trtext').value = text
+      @form.fields_with(:name => 'trtext').first.value = text
     end
     @lang_list.value = "#{from}_#{to}"
-    @form.submit.parser.search("td.s/div[@style]").inner_html
+    @form.submit.parser.search("div[@id='result']/div[@style]").inner_html
   end
 end
 
@@ -239,8 +250,8 @@ class WorldlingoTranslator < Translator
   end
 
   def translate(text, from, to)
-    response = Irc::Plugins.manager['translator'].bot.httputil.get_response(
-               URI.escape("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}"))
+    response = Irc::Utils.bot.httputil.get_response(URI.escape(
+               "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}"))
     # WorldLingo seems to respond an XML when error occurs
     case response['Content-Type']
     when %r'text/plain'
@@ -252,37 +263,49 @@ class WorldlingoTranslator < Translator
 end
 
 class TranslatorPlugin < Plugin
-  BotConfig.register BotConfigIntegerValue.new('translate.timeout',
+  Config.register Config::IntegerValue.new('translator.timeout',
     :default => 30, :validate => Proc.new{|v| v > 0},
     :desc => _("Number of seconds to wait for the translation service before timeout"))
+  Config.register Config::StringValue.new('translator.destination',
+    :default => "en",
+    :desc => _("Default destination language to be used with translate command"))
+
+  TRANSLATORS = {
+    'nifty' => NiftyTranslator,
+    'excite' => ExciteTranslator,
+    'google_translate' => GoogleTranslator,
+    'babelfish' => BabelfishTranslator,
+    'worldlingo' => WorldlingoTranslator,
+  }
 
   def initialize
     super
-    translator_classes = {
-      'nifty' => NiftyTranslator,
-      'excite' => ExciteTranslator,
-      'google_translate' => GoogleTranslator,
-      'babelfish' => BabelfishTranslator,
-      'worldlingo' => WorldlingoTranslator,
-    }
 
     @translators = {}
-
-    translator_classes.each_pair do |name, c|
+    TRANSLATORS.each_pair do |name, c|
       begin
         @translators[name] = c.new(@registry.sub_registry(name))
-        map "#{name} :from :to *phrase", :action => :cmd_translate
-      rescue
+        map "#{name} :from :to *phrase",
+          :action => :cmd_translate, :thread => true
+      rescue Exception
         warning _("Translator %{name} cannot be used: %{reason}") %
                {:name => name, :reason => $!}
       end
     end
+
+    Config.register Config::ArrayValue.new('translator.default_list',
+      :default => TRANSLATORS.keys,
+      :validate => Proc.new {|l| l.all? {|t| TRANSLATORS.has_key?(t)}},
+      :desc => _("List of translators to try in order when translator name not specified"),
+      :on_change => Proc.new {|bot, v| update_default})
+    update_default
   end
 
   def help(plugin, topic=nil)
-    if @translators.has_key?(topic)
-      translator = @translators[topic]
-      _('%{info}, supported directions of translation: %{directions}') % {
+    if @translators.has_key?(plugin)
+      translator = @translators[plugin]
+      _('%{translator} <from> <to> <phrase> => Look up phrase using %{info}, supported from -> to languages: %{directions}') % {
+        :translator => plugin,
         :info => translator.class::INFO,
         :directions => translator.directions.map do |source, targets|
                          _('%{source} -> %{targets}') %
@@ -290,25 +313,54 @@ class TranslatorPlugin < Plugin
                        end.join(' | ')
       }
     else
-      _('Command: <translator> <from> <to> <phrase>, where <translator> is one of: %{translators}. Use "help translator <translator>" to look up supported from and to languages') %
+      _('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') %
         {:translators => @translators.keys.join(', ')}
     end
   end
 
+  def update_default
+    @default_translators = bot.config['translator.default_list'] & @translators.keys
+  end
+
+  def cmd_translator(m, params)
+    params[:to] = @bot.config['translator.destination'] if params[:to].nil?
+
+    # Use google translate as translator if source language has not been given
+    # and auto-detect it
+    if params[:from].nil?
+      params[:from] = "auto"
+      translator = "google_translate"
+    else
+      translator = @default_translators.find {|t| @translators[t].support?(params[:from], params[:to])}
+    end
+
+    if translator
+      cmd_translate m, params.merge({:translator => translator, :show_provider => true})
+    else
+      m.reply _('None of the default translators (translator.default_list) supports translating from %{source} to %{target}') % {:source => from, :target => to}
+    end
+  end
+
   def cmd_translate(m, params)
     # get the first word of the command
-    tname = m.message[/\A(\w+)\s/, 1]
+    tname = params[:translator] || m.message[/\A(\w+)\s/, 1]
     translator = @translators[tname]
     from, to, phrase = params[:from], params[:to], params[:phrase].to_s
     if translator
       begin
-          translation = Timeout.timeout(@bot.config['translate.timeout']) do
-            translator.translate(phrase, from, to)
-          end
-          m.reply translation
+        translation = Timeout.timeout(@bot.config['translator.timeout']) do
+          translator.translate(phrase, from, to)
+        end
+        m.reply(if params[:show_provider]
+                  _('%{translation} (provided by %{translator})') %
+                    {:translation => translation, :translator => tname}
+                else
+                  translation
+                end)
+
       rescue Translator::UnsupportedDirectionError
-          m.reply _("%{translator} doesn't support translating from %{source} to %{target}") %
-                  {:translator => tname, :source => from, :target => to}
+        m.reply _("%{translator} doesn't support translating from %{source} to %{target}") %
+                {:translator => tname, :source => from, :target => to}
       rescue Translator::NoTranslationError
         m.reply _('%{translator} failed to provide a translation') %
                 {:translator => tname}
@@ -322,4 +374,7 @@ class TranslatorPlugin < Plugin
 end
 
 plugin = TranslatorPlugin.new
-
+plugin.map 'translate [:from] [:to] *phrase',
+           :action => :cmd_translator, :thread => true
+plugin.map 'translator [:from] [:to] *phrase',
+           :action => :cmd_translator, :thread => true