2 # Salutations plugin: respond to salutations
\r
3 # TODO allow online editing of salutations
\r
4 # TODO *REMEMBER* to set @changed to true after edit
\r
5 # TODO or changes won't be saved
\r
7 class SalutPlugin < Plugin
\r
8 BotConfig.register BotConfigBooleanValue.new('salut.all_languages',
\r
10 :desc => "Check for a salutation in all languages and not just in the one defined by core.language",
\r
11 :on_change => Proc.new {|bot, v| bot.plugins['salut'].reload}
\r
13 BotConfig.register BotConfigBooleanValue.new('salut.address_only',
\r
15 :desc => "When set to true, the bot will only reply to salutations directed at him",
\r
16 :on_change => Proc.new {|bot, v| bot.plugins['salut'].reload}
\r
21 @salutations = Hash.new
\r
23 @match_langs = Array.new
\r
24 @main_lang_str = nil
\r
32 def set_language(what)
\r
42 @salutations.each { |lang, hash|
\r
47 hash.each { |situation, array|
\r
49 when /^generic-dest$/
\r
59 @match[lang] = Hash.new
\r
60 @match[lang][:in] = Regexp.new("\\b(?:" + ar_in.uniq.map { |txt|
\r
62 }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_in.empty?
\r
63 @match[lang][:out] = Regexp.new("\\b(?:" + ar_out.uniq.map { |txt|
\r
65 }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_out.empty?
\r
66 @match[lang][:both] = Regexp.new("\\b(?:" + ar_both.uniq.map { |txt|
\r
68 }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_both.empty?
\r
69 @match[lang][:dest] = Regexp.new("\\b(?:" + ar_dest.uniq.map { |txt|
\r
71 }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_dest.empty?
\r
73 @punct = /\s*[.,:!;?]?\s*/ # Punctuation
\r
75 # Languages to match for, in order
\r
77 @match_langs << @main_lang if @match.key?(@main_lang)
\r
78 @match_langs << :english if @match.key?(:english)
\r
79 @match.each_key { |key|
\r
86 return if @match.empty?
\r
87 return unless m.kind_of?(PrivMessage)
\r
88 return if m.address? and m.plugin == 'config'
\r
89 to_me = m.address? || m.message =~ /#{Regexp.escape(@bot.nick)}/i
\r
90 if @bot.config['salut.address_only']
\r
94 @match_langs.each { |lang|
\r
95 [:both, :in, :out].each { |k|
\r
96 next unless @match[lang][k]
\r
97 if m.message =~ @match[lang][k]
\r
98 salut = [@match[lang][k], lang, k]
\r
104 return unless salut
\r
105 # If the bot wasn't addressed, we continue only if the match was exact
\r
106 # (apart from space and punctuation) or if @match[:dest] matches too
\r
107 return unless to_me or m.message =~ /^#{@punct}#{salut.first}#{@punct}$/ or m.message =~ @match[salut[1]][:dest]
\r
111 salut_reply(m, salut, :morning)
\r
113 salut_reply(m, salut, :afternoon)
\r
115 salut_reply(m, salut, :evening)
\r
119 def salut_reply(m, salut, time)
\r
122 debug "Replying to #{salut.first} (#{lang} #{k}) in the #{time}"
\r
123 # salut_ar = @salutations[@main_lang].update @salutations[:english].update @salutations[lang]
\r
124 salut_ar = @salutations[lang]
\r
131 debug "Building array ..."
\r
133 rep_ar += salut_ar.fetch("#{time}#{sfx}".to_sym, [])
\r
134 rep_ar += salut_ar.fetch("#{time}".to_sym, []) unless sfx.empty?
\r
135 rep_ar += salut_ar.fetch("generic#{sfx}".to_sym, [])
\r
136 rep_ar += salut_ar.fetch("generic".to_sym, []) unless sfx.empty?
\r
137 debug "Choosing reply in #{rep_ar.inspect} ..."
\r
139 if m.public? # and (m.address? or m =~ /#{Regexp.escape(@bot.nick)}/)
\r
140 choice = @bot.lang.get("hello_X") % m.sourcenick
\r
142 choice = @bot.lang.get("hello") % m.sourcenick
\r
145 choice = rep_ar.pick_one
\r
146 if m.public? and (m.address? or m.message =~ /#{Regexp.escape(@bot.nick)}/)
\r
147 choice += "#{[',',''].pick_one} #{m.sourcenick}"
\r
148 choice += [" :)", " :D", "!", "", "", ""].pick_one
\r
151 debug "Replying #{choice}"
\r
152 m.plainreply choice
\r
157 @main_lang_str = @bot.config['core.language']
\r
158 @main_lang = @main_lang_str.to_sym
\r
159 @all_langs = @bot.config['salut.all_languages']
\r
161 # Get all available languages
\r
162 langs = Dir.new("#{@bot.botclass}/salut").collect {|f|
\r
163 f =~ /salut-([^.]+)/ ? $1 : nil
\r
165 langs.each { |lang|
\r
166 @salutations[lang.to_sym] = load_lang(lang)
\r
170 @salutations[@main_lang] = load_lang(@main_lang_str)
\r
176 def load_lang(lang)
\r
177 dir = "#{@bot.botclass}/salut"
\r
178 if not File.exist?(dir)
\r
181 file = "#{@bot.botclass}/salut/salut-#{lang}"
\r
182 if File.exist?(file)
\r
184 salutations = Hash.new
\r
185 content = YAML::load_file(file)
\r
186 content.each { |key, val|
\r
187 salutations[key.to_sym] = val
\r
191 error "failed to read salutations in #{lang}: #{$!}"
\r
198 return if @salutations.empty?
\r
199 return unless @changed
\r
200 @salutations.each { |lang, val|
\r
202 save_lang(lang, val)
\r
207 def save_lang(lang, val)
\r
208 fn = "#{@bot.botclass}/salut/salut-#{lang}"
\r
209 Utils.safe_save(fn) { |file|
\r
210 file.puts val.to_yaml
\r
216 plugin = SalutPlugin.new
\r