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