X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=data%2Frbot%2Fplugins%2Fsalut.rb;h=2948b2f37506a94d4caf66451cf764d1a9c63954;hb=3f8710a19b6989cd1c67629a92fd992968579456;hp=4827601948324570af93c22f154523f497444a9e;hpb=d51861faa9607718870cea1acbbc0b2b2c2c7364;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git

diff --git a/data/rbot/plugins/salut.rb b/data/rbot/plugins/salut.rb
index 48276019..2948b2f3 100644
--- a/data/rbot/plugins/salut.rb
+++ b/data/rbot/plugins/salut.rb
@@ -1,30 +1,39 @@
-# vim: set sw=2 et:
+#-- vim:sw=2:et
+#++
+#
+# :title: Salutations plugin for rbot
+#
+# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
+# Copyright:: (C) 2006-2007 Giuseppe Bilotta
+# License:: GPL v2
+#
 # Salutations plugin: respond to salutations
-
-unless Array.respond_to?(:pick_one)
-  debug "Defining the pick_one method for Array"
-  class ::Array
-    def pick_one
-      return nil if self.empty?
-      self[rand(self.length)]
-    end
-  end
-end
-
+#
+# TODO:: allow online editing of salutations
+#
+# TODO:: *REMEMBER* to set @changed to true after edit or changes won't be saved
 
 class SalutPlugin < Plugin
-  BotConfig.register BotConfigBooleanValue.new('salut.all_languages',
+  Config.register Config::BooleanValue.new('salut.all_languages',
     :default => true, 
     :desc => "Check for a salutation in all languages and not just in the one defined by core.language",
     :on_change => Proc.new {|bot, v| bot.plugins['salut'].reload}
   )
+  Config.register Config::BooleanValue.new('salut.address_only',
+    :default => true, 
+    :desc => "When set to true, the bot will only reply to salutations directed at him",
+    :on_change => Proc.new {|bot, v| bot.plugins['salut'].reload}
+  )
+
 
   def initialize
     @salutations = Hash.new
-    @match = nil
+    @match = Hash.new
+    @match_langs = Array.new
     @main_lang_str = nil
     @main_lang = nil
     @all_langs = true
+    @changed = false
     super
     reload
   end
@@ -34,13 +43,20 @@ class SalutPlugin < Plugin
   end
 
   def create_match
-    @match = Hash.new
+    @match.clear
+    ar_dest = Array.new
     ar_in = Array.new
     ar_out = Array.new
     ar_both = Array.new
     @salutations.each { |lang, hash|
+      ar_dest.clear
+      ar_in.clear
+      ar_out.clear
+      ar_both.clear
       hash.each { |situation, array|
         case situation.to_s
+        when /^generic-dest$/
+          ar_dest += array
         when /in$/
           ar_in += array
         when /out$/
@@ -49,30 +65,55 @@ class SalutPlugin < Plugin
           ar_both += array
         end
       }
+      @match[lang] = Hash.new
+      @match[lang][:in] = Regexp.new("\\b(?:" + ar_in.uniq.map { |txt|
+        Regexp.escape(txt)
+      }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_in.empty?
+      @match[lang][:out] = Regexp.new("\\b(?:" + ar_out.uniq.map { |txt|
+        Regexp.escape(txt)
+      }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_out.empty?
+      @match[lang][:both] = Regexp.new("\\b(?:" + ar_both.uniq.map { |txt|
+        Regexp.escape(txt)
+      }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_both.empty?
+      @match[lang][:dest] = Regexp.new("\\b(?:" + ar_dest.uniq.map { |txt|
+        Regexp.escape(txt)
+      }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_dest.empty?
     }
-    @match[:in] = Regexp.new("\\b(?:" + ar_in.uniq.map { |txt|
-      Regexp.escape(txt)
-    }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_in.empty?
-    @match[:out] = Regexp.new("\\b(?:" + ar_out.uniq.map { |txt|
-      Regexp.escape(txt)
-    }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_out.empty?
-    @match[:both] = Regexp.new("\\b(?:" + ar_both.uniq.map { |txt|
-      Regexp.escape(txt)
-    }.join('|') + ")\\b", Regexp::IGNORECASE) unless ar_both.empty?
-    debug "Matches: #{@match.inspect}"
+    @punct = /\s*[.,:!;?]?\s*/ # Punctuation
+
+    # Languages to match for, in order
+    @match_langs.clear
+    @match_langs << @main_lang if @match.key?(@main_lang)
+    @match_langs << :english if @match.key?(:english)
+    @match.each_key { |key|
+      @match_langs << key
+    }
+    @match_langs.uniq!
   end
 
   def listen(m)
+    return if @match.empty?
+    return unless m.kind_of?(PrivMessage)
+    return if m.address? and m.plugin == 'config'
+    to_me = m.address? || m.message =~ /#{Regexp.escape(@bot.nick)}/i
+    if @bot.config['salut.address_only']
+      return unless to_me
+    end
     salut = nil
-    [:both, :in, :out].each { |k|
-      next unless @match[k]
-      debug "Checking salutations #{k} (#{@match[k].inspect})"
-      if m.message =~ /^#{@match[k]}/
-        salut = k
-        break
-      end
+    @match_langs.each { |lang|
+      [:both, :in, :out].each { |k|
+        next unless @match[lang][k]
+        if m.message =~ @match[lang][k]
+          salut = [@match[lang][k], lang, k]
+          break
+        end
+      }
+      break if salut
     }
     return unless salut
+    # If the bot wasn't addressed, we continue only if the match was exact
+    # (apart from space and punctuation) or if @match[:dest] matches too
+    return unless to_me or m.message =~ /^#{@punct}#{salut.first}#{@punct}$/ or m.message =~ @match[salut[1]][:dest] 
     h = Time.new.hour
     case h
     when 4...12
@@ -84,8 +125,12 @@ class SalutPlugin < Plugin
     end
   end
 
-  def salut_reply(m, k, time)
-    debug "Replying to #{k} in the #{time}"
+  def salut_reply(m, salut, time)
+    lang = salut[1]
+    k = salut[2]
+    debug "Replying to #{salut.first} (#{lang} #{k}) in the #{time}"
+    # salut_ar = @salutations[@main_lang].update @salutations[:english].update @salutations[lang]
+    salut_ar = @salutations[lang]
     case k
     when :both
       sfx = ""
@@ -94,13 +139,13 @@ class SalutPlugin < Plugin
     end
     debug "Building array ..."
     rep_ar = Array.new
-    rep_ar += @salutations[@main_lang].fetch("#{time}#{sfx}".to_sym, [])
-    rep_ar += @salutations[@main_lang].fetch("#{time}".to_sym, []) unless sfx.empty?
-    rep_ar += @salutations[@main_lang].fetch("generic#{sfx}".to_sym, [])
-    rep_ar += @salutations[@main_lang].fetch("generic".to_sym, []) unless sfx.empty?
+    rep_ar += salut_ar.fetch("#{time}#{sfx}".to_sym, [])
+    rep_ar += salut_ar.fetch("#{time}".to_sym, []) unless sfx.empty?
+    rep_ar += salut_ar.fetch("generic#{sfx}".to_sym, [])
+    rep_ar += salut_ar.fetch("generic".to_sym, []) unless sfx.empty?
     debug "Choosing reply in #{rep_ar.inspect} ..."
     if rep_ar.empty?
-      if m.public? and (m.address? or m =~ /#{Regexp.escape(@bot.nick)}/)
+      if m.public? # and (m.address? or m =~ /#{Regexp.escape(@bot.nick)}/)
         choice = @bot.lang.get("hello_X") % m.sourcenick
       else
         choice = @bot.lang.get("hello") % m.sourcenick
@@ -134,6 +179,7 @@ class SalutPlugin < Plugin
       @salutations[@main_lang] = load_lang(@main_lang_str)
     end
     create_match
+    @changed = false
   end
 
   def load_lang(lang)
@@ -159,15 +205,17 @@ class SalutPlugin < Plugin
 
   def save
     return if @salutations.empty?
+    return unless @changed
     @salutations.each { |lang, val|
       l = lang.to_s
       save_lang(lang, val)
     }
+    @changed = false
   end
 
   def save_lang(lang, val)
-    file = "#{@bot.botclass}/salut/salut-#{lang}"
-    Utils.safe_save(file) { |file|
+    fn = "#{@bot.botclass}/salut/salut-#{lang}"
+    Utils.safe_save(fn) { |file|
       file.puts val.to_yaml
     }
   end