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