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   include Comparable # for Array#>=
  22   unless gettext_version >= [1, 8, 0]
  23     raise GetTextVersionError, "Unsupported ruby-gettext version installed: #{gettext_version.join '.'}; supported versions are 1.8.0 and above"
  24   end
  25
  26   require 'gettext'
  27
  28   include GetText
  29
  30   rbot_locale_path = File.join(Irc::Bot::Config.datadir, "../locale/%{locale}/LC_MESSAGES/%{name}.mo")
  31   if gettext_version < [2, 0, 0]
  32     add_default_locale_path(rbot_locale_path)
  33   else
  34     LocalePath.add_default_rule(rbot_locale_path)
  35   end
  36
  37   if GetText.respond_to? :cached=
  38     GetText.cached = false
  39   elsif TextDomain.respond_to? :cached=
  40     TextDomain.cached = false
  41   else
  42     warning 'This version of ruby-gettext does not support non-cached mode; mo files are not reloaded when setting language'
  43   end
  44   bindtextdomain 'rbot'
  45
  46   module GetText
  47     # patch for ruby-gettext 1.x to cope with anonymous modules used by rbot.
  48     # bound_targets and related methods are not used nor present in 2.x, and
  49     # this patch is not needed
  50     if method_defined? :bound_targets
  51       alias :orig_bound_targets :bound_targets
  52
  53       def bound_targets(*a)  # :nodoc:
  54         bt = orig_bound_targets(*a) rescue []
  55         bt.empty? ? orig_bound_targets(Object) : bt
  56       end
  57     end
  58
  59     require 'stringio'
  60
  61     # This method is used to output debug information on the GetText
  62     # textdomain, and it's called by the language setting routines
  63     # in rbot
  64     def rbot_gettext_debug
  65       begin
  66         gettext_info = StringIO.new
  67         current_textdomain_info(:out => gettext_info) # fails sometimes
  68       rescue Exception
  69         warning "gettext failed to set call textdomain info. maybe an mo file doesn't exist for your locale."
  70       ensure
  71         gettext_info.string.each_line { |l| debug l}
  72       end
  73     end
  74   end
  75
  76   log "gettext loaded"
  77
  78 rescue LoadError, GetTextVersionError
  79   warning "failed to load ruby-gettext package: #{$!}; translations are disabled"
  80
  81   # undefine GetText, in case it got defined because the error was caused by a
  82   # wrong version
  83   if defined?(GetText)
  84     Object.module_eval { remove_const("GetText") }
  85   end
  86
  87   # dummy functions that return msg_id without translation
  88   def _(s)
  89     s
  90   end
  91
  92   def N_(s)
  93     s
  94   end
  95
  96   def n_(s_single, s_plural, n)
  97     n > 1 ? s_plural : s_single
  98   end
  99
 100   def Nn_(s_single, s_plural)
 101     n_(s_single, s_plural)
 102   end
 103
 104   def s_(*args)
 105     args[0]
 106   end
 107
 108   def bindtextdomain_to(*args)
 109   end
 110
 111   # the following extension to String#% is from ruby-gettext's string.rb file.
 112   # it needs to be included in the fallback since the source already use this form
 113
 114 =begin
 115   string.rb - Extension for String.
 116
 117   Copyright (C) 2005,2006 Masao Mutoh
 118
 119   You may redistribute it and/or modify it under the same
 120   license terms as Ruby.
 121 =end
 122
 123   # Extension for String class.
 124   #
 125   # String#% method which accept "named argument". The translator can know
 126   # the meaning of the msgids using "named argument" instead of %s/%d style.
 127   class String
 128     alias :_old_format_m :% # :nodoc:
 129
 130     # call-seq:
 131     #  %(arg)
 132     #  %(hash)
 133     #
 134     # Format - Uses str as a format specification, and returns the result of applying it to arg.
 135     # If the format specification contains more than one substitution, then arg must be
 136     # an Array containing the values to be substituted. See Kernel::sprintf for details of the
 137     # format string. This is the default behavior of the String class.
 138     # * arg: an Array or other class except Hash.
 139     # * Returns: formatted String
 140     #
 141     #  (e.g.) "%s, %s" % ["Masao", "Mutoh"]
 142     #
 143     # Also you can use a Hash as the "named argument". This is recommanded way for Ruby-GetText
 144     # because the translators can understand the meanings of the msgids easily.
 145     # * hash: {:key1 => value1, :key2 => value2, ... }
 146     # * Returns: formatted String
 147     #
 148     #  (e.g.) "%{firstname}, %{familyname}" % {:firstname => "Masao", :familyname => "Mutoh"}
 149     def %(args)
 150       if args.kind_of?(Hash)
 151         ret = dup
 152         args.each {|key, value|
 153           ret.gsub!(/\%\{#{key}\}/, value.to_s)
 154         }
 155         ret
 156       else
 157         ret = gsub(/%\{/, '%%{')
 158         begin
 159     ret._old_format_m(args)
 160         rescue ArgumentError
 161     $stderr.puts "  The string:#{ret}"
 162     $stderr.puts "  args:#{args.inspect}"
 163         end
 164       end
 165     end
 166   end
 167 end