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