lib/rbot/load-gettext.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: GetText interface for rbot
   5 #
   6 # Load gettext module and provide fallback in case of failure
   7
   8 class GetTextVersionError < Exception
   9 end
  10
  11 # try to load gettext, or provide fake getttext functions
  12 begin
  13 # workaround for gettext not checking empty LANGUAGE
  14 if ENV["LANGUAGE"] and ENV["LANGUAGE"].empty?
  15   ENV.delete "LANGUAGE"
  16 end
  17
  18   require 'gettext/version'
  19
  20   gettext_version = GetText::VERSION.split('.').map {|n| n.to_i}
  21   class ::Array
  22     include Comparable # for Array#>=
  23   end
  24   unless gettext_version >= [1, 8, 0]
  25     raise GetTextVersionError, "Unsupported ruby-gettext version installed: #{gettext_version.join '.'}; supported versions are 1.8.0 and above"
  26   end
  27
  28   require 'gettext'
  29
  30   include GetText
  31
  32   rbot_locale_path = File.join(Irc::Bot::Config.datadir, "../locale/%{locale}/LC_MESSAGES/%{name}.mo")
  33   if gettext_version < [2, 0, 0]
  34     add_default_locale_path(rbot_locale_path)
  35   else
  36     LocalePath.add_default_rule(rbot_locale_path)
  37   end
  38
  39   if GetText.respond_to? :cached=
  40     GetText.cached = false
  41   elsif TextDomain.respond_to? :cached=
  42     TextDomain.cached = false
  43   else
  44     warning 'This version of ruby-gettext does not support non-cached mode; mo files are not reloaded when setting language'
  45   end
  46
  47   begin
  48     bindtextdomain 'rbot'
  49   rescue NoMethodError => e
  50     error e
  51     warning 'Trying to work around RubyGems/GetText incompatibility'
  52     module ::Gem
  53       def self.all_load_paths
  54         result = []
  55
  56         Gem.path.each do |gemdir|
  57           each_load_path all_partials(gemdir) do |load_path|
  58             result << load_path
  59           end
  60         end
  61
  62         result
  63       end
  64     end
  65     retry
  66   end
  67
  68
  69
  70   module GetText
  71     # patch for ruby-gettext 1.x to cope with anonymous modules used by rbot.
  72     # bound_targets and related methods are not used nor present in 2.x, and
  73     # this patch is not needed
  74     if respond_to? :bound_targets, true
  75       alias :orig_bound_targets :bound_targets
  76
  77       def bound_targets(*a)  # :nodoc:
  78         bt = orig_bound_targets(*a) rescue []
  79         bt.empty? ? orig_bound_targets(Object) : bt
  80       end
  81     end
  82
  83     require 'stringio'
  84
  85     # GetText 2.1.0 does not provide current_textdomain_info,
  86     # so we adapt the one from 1.9.10
  87     # TODO we would _really_ like to have a future-proof version of this,
  88     # but judging by the ruby gettext source code, this isn't going to
  89     # happen anytime soon.
  90     if not respond_to? :current_textdomain_info
  91       # Show the current textdomain information. This function is for debugging.
  92       # * options: options as a Hash.
  93       #   * :with_messages - show informations with messages of the current mo file. Default is false.
  94       #   * :out - An output target. Default is STDOUT.
  95       #   * :with_paths - show the load paths for mo-files.
  96       def current_textdomain_info(options = {})
  97         opts = {:with_messages => false, :with_paths => false, :out => STDOUT}.merge(options)
  98         ret = nil
  99         # this is for 2.1.0
 100         TextDomainManager.each_textdomains(self) {|textdomain, lang|
 101           opts[:out].puts "TextDomain name: #{textdomain.name.inspect}"
 102           opts[:out].puts "TextDomain current locale: #{lang.to_s.inspect}"
 103           opts[:out].puts "TextDomain current mo path: #{textdomain.instance_variable_get(:@locale_path).current_path(lang).inspect}"
 104           if opts[:with_paths]
 105             opts[:out].puts "TextDomain locale file paths:"
 106             textdomain.locale_paths.each do |v|
 107               opts[:out].puts "  #{v}"
 108             end
 109           end
 110           if opts[:with_messages]
 111             opts[:out].puts "The messages in the mo file:"
 112             textdomain.current_mo.each{|k, v|
 113               opts[:out].puts "  \"#{k}\": \"#{v}\""
 114             }
 115           end
 116         }
 117       end
 118     end
 119
 120     # This method is used to output debug information on the GetText
 121     # textdomain, and it's called by the language setting routines
 122     # in rbot
 123     def rbot_gettext_debug
 124       begin
 125         gettext_info = StringIO.new
 126         current_textdomain_info(:out => gettext_info) # fails sometimes
 127       rescue Exception
 128         warning "failed to retrieve textdomain info. maybe an mo file doesn't exist for your locale."
 129         debug $!
 130       ensure
 131         gettext_info.string.each_line { |l| debug l}
 132       end
 133     end
 134   end
 135
 136   log "gettext loaded"
 137
 138 rescue LoadError, GetTextVersionError
 139   warning "failed to load ruby-gettext package: #{$!}; translations are disabled"
 140
 141   # undefine GetText, in case it got defined because the error was caused by a
 142   # wrong version
 143   if defined?(GetText)
 144     Object.module_eval { remove_const("GetText") }
 145   end
 146
 147   # dummy functions that return msg_id without translation
 148   def _(s)
 149     s
 150   end
 151
 152   def N_(s)
 153     s
 154   end
 155
 156   def n_(s_single, s_plural, n)
 157     n > 1 ? s_plural : s_single
 158   end
 159
 160   def Nn_(s_single, s_plural)
 161     n_(s_single, s_plural)
 162   end
 163
 164   def s_(*args)
 165     args[0]
 166   end
 167
 168   def bindtextdomain_to(*args)
 169   end
 170
 171   # the following extension to String#% is from ruby-gettext's string.rb file.
 172   # it needs to be included in the fallback since the source already use this form
 173
 174 =begin
 175   string.rb - Extension for String.
 176
 177   Copyright (C) 2005,2006 Masao Mutoh
 178
 179   You may redistribute it and/or modify it under the same
 180   license terms as Ruby.
 181 =end
 182
 183   # Extension for String class.
 184   #
 185   # String#% method which accept "named argument". The translator can know
 186   # the meaning of the msgids using "named argument" instead of %s/%d style.
 187   class String
 188     alias :_old_format_m :% # :nodoc:
 189
 190     # call-seq:
 191     #  %(arg)
 192     #  %(hash)
 193     #
 194     # Format - Uses str as a format specification, and returns the result of applying it to arg.
 195     # If the format specification contains more than one substitution, then arg must be
 196     # an Array containing the values to be substituted. See Kernel::sprintf for details of the
 197     # format string. This is the default behavior of the String class.
 198     # * arg: an Array or other class except Hash.
 199     # * Returns: formatted String
 200     #
 201     #  (e.g.) "%s, %s" % ["Masao", "Mutoh"]
 202     #
 203     # Also you can use a Hash as the "named argument". This is recommanded way for Ruby-GetText
 204     # because the translators can understand the meanings of the msgids easily.
 205     # * hash: {:key1 => value1, :key2 => value2, ... }
 206     # * Returns: formatted String
 207     #
 208     #  (e.g.) "%{firstname}, %{familyname}" % {:firstname => "Masao", :familyname => "Mutoh"}
 209     def %(args)
 210       if args.kind_of?(Hash)
 211         ret = dup
 212         args.each {|key, value|
 213           ret.gsub!(/\%\{#{key}\}/, value.to_s)
 214         }
 215         ret
 216       else
 217         ret = gsub(/%\{/, '%%{')
 218         begin
 219     ret._old_format_m(args)
 220         rescue ArgumentError
 221     $stderr.puts "  The string:#{ret}"
 222     $stderr.puts "  args:#{args.inspect}"
 223         end
 224       end
 225     end
 226   end
 227 end